def GetOrderNotes(self, order: str, headers: dict = {}) -> Response:
"""Get order notes.
Args:
order (str): String of the order number.
Returns:
Response: HTTPX response object
"""
url = f"{self.instance}/s/{self.site}/dw/shop/v20_4/{self.base}/{order}/notes"
return Endpoint.GET(self, url=url, headers=headers)
def GetBasket(self, basket_id: str, headers=None) -> Response:
"""Get a basket.
Args:
basket_id (str): The unique identifier for the basket.
headers (dict, optional): Additional headers to inject. Defaults to None.
Returns:
Response: Response to request.
"""
url = f"{self.instance}/s/{self.site}/dw/shop/v20_4/{self.base}/{basket_id}"
return Endpoint.GET(self, url, headers=headers)
def GetSiteInformation(self, site: str = None, headers: dict = {}):
"""Get a Commerce Cloud order
Arguments:
order {str} -- String of the order number
Returns:
Response -- HTTPX response object
"""
self.site = site or self.site
headers.update({"x-dw-client-id": self.client.client_id})
url = f"{self.instance}/s/{self.site}/dw/shop/v20_4/{self.base}"
return Endpoint.GET(self, url, headers=headers)
def GetCodeVersions(self, headers: dict = None) -> Response:
"""Get Code Versions on Commerce Cloud Instance.
[extended_summary]
Args:
headers (dict, optional): Key value pairs for headers added to request. Defaults to None.
Returns:
Response: HTTPX response object.
"""
url = f"{self.instance}/s/{self.site}/dw/data/v20_4/{self.base}"
return Endpoint.GET(self, url, headers=headers)
def Search(self, params: dict, headers: dict = {}, **kwargs) -> Response:
"""Get Products by Search query.
[extended_summary]
Args:
params (dict): Dictionary for the query param key value pairs.
headers (dict, optional): Key value pairs for headers added to request. Defaults to None.
Returns:
Response: HTTPX response object.
"""
headers.update({"x-dw-client-id": self.client.client_id})
url = f"{self.instance}/s/{self.site}/dw/shop/v20_4/{self.base}"
return Endpoint.GET(self, url, params=params, headers=headers)
def GetContentAsset(self,
library_id: str,
content_id: str,
headers: dict = None) -> Response:
"""Get Content Asset by Content ID inside of a Library.
Args:
library_id (str): Content Library.
content_id (str): Content Asset name.
headers (dict, optional): Key value pairs for headers added to request. Defaults to None.
Returns:
Response: HTTPX response object.
"""
url = f"{self.instance}/s/{self.site}/dw/data/v20_4/{self.base}/{library_id}/content/{content_id}"
return Endpoint.GET(self, url, headers=headers)
def GetCodeVersion(self,
code_version_id: str,
headers: dict = None) -> Response:
"""Get Code Version on Commerce Cloud Instance.
Args:
code_version_id (str): Code Version to get information about.
headers (dict, optional): Key value pairs for headers added to request. Defaults to None.
Returns:
Response: HTTPX response object.
"""
url = (
f"{self.instance}/s/{self.site}/dw/data/v20_4/{self.base}/{code_version_id}"
)
return Endpoint.GET(self, url, headers=headers)
def GetJobExecution(self,
job_id: str,
id: str,
headers: dict = None) -> Response:
"""Get Job Execution information by Execution ID for Job ID.
[extended_summary]
Args:
job_id (str): Job ID to get information about.
id (str): Execution ID to get information about.
headers (dict, optional): Key value pairs for headers added to request. Defaults to None.
Returns:
Response: HTTPX response object.
"""
url = f"{self.instance}/s/{self.site}/dw/data/v20_4/{self.base}/{job_id}/executions/{id}"
return Endpoint.GET(self, url, headers=headers)
def GetCustomObject(self,
object_type: str,
key: str,
headers: dict = None) -> Response:
"""Get Custom Object by Key.
[extended_summary]
Args:
object_type (str): Object type to get information about.
key (str): Object key to get information about.
headers (dict, optional): Key value pairs for headers added to request. Defaults to None.
Returns:
Response: HTTPX response object.
"""
url = f"{self.instance}/s/{self.site}/dw/data/v20_4/{self.base}/{object_type}/{key}"
return Endpoint.GET(self, url, headers=headers)
