o tBhC@sPddlmZddlmZddlmZddlmZddlm Z GdddeZ dS) ) APIHelper) ApiResponse) FileWrapper)BaseApi)OAuth2cseZdZdZd fdd ZddZddZd d Z  d!d d Zd dZ   d"ddZ ddZ ddZ  d#ddZ ddZddZddZddZZS)$ CatalogApiz3A Controller to access Endpoints in the square API.Ncstt|||dSN)superr__init__)selfconfig call_back __class__m/var/www/html/riverr-enterprise-integrations-main/venv/lib/python3.10/site-packages/square/api/catalog_api.pyr szCatalogApi.__init__c Cd}|j}||7}t|}ddd}|jjj||t|d}t|j|| |}t |j }t |t ur@|d} nd} t||| d} | S)aQDoes a POST request to /v2/catalog/batch-delete. Deletes a set of [CatalogItem]($m/CatalogItem)s based on the provided list of target IDs and returns a set of successfully deleted IDs in the response. Deletion is a cascading event such that all children of the targeted object are also deleted. For example, deleting a CatalogItem will also delete all of its [CatalogItemVariation]($m/CatalogItemVariation) children. `BatchDeleteCatalogObjects` succeeds even if only a portion of the targeted IDs can be deleted. The response will only include IDs that were actually deleted. Args: body (BatchDeleteCatalogObjectsRequest): An object containing the fields to POST for the request. See the corresponding object definition for field details. Returns: ApiResponse: An object with the response value as well as other useful information such as status codes and headers. Success Raises: APIException: When an error occurs while fetching the data from the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request. z/v2/catalog/batch-deleteapplication/jsonacceptz Content-Typeheaders parameterserrorsNbodyrr get_base_urir clean_url http_clientpostjson_serializerapplyexecute_requestjson_deserializetexttypedictgetr r r _url_path_query_builder _query_url_headers_request _responsedecoded_errors_resultrrrbatch_delete_catalog_objectss %      z'CatalogApi.batch_delete_catalog_objectsc Cr)aDoes a POST request to /v2/catalog/batch-retrieve. Returns a set of objects based on the provided ID. Each [CatalogItem]($m/CatalogItem) returned in the set includes all of its child information including: all of its [CatalogItemVariation]($m/CatalogItemVariation) objects, references to its [CatalogModifierList]($m/CatalogModifierList) objects, and the ids of any [CatalogTax]($m/CatalogTax) objects that apply to it. Args: body (BatchRetrieveCatalogObjectsRequest): An object containing the fields to POST for the request. See the corresponding object definition for field details. Returns: ApiResponse: An object with the response value as well as other useful information such as status codes and headers. Success Raises: APIException: When an error occurs while fetching the data from the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request. z/v2/catalog/batch-retrieverrrrNrrr)rrrbatch_retrieve_catalog_objectsNs       z)CatalogApi.batch_retrieve_catalog_objectsc Cr)aDoes a POST request to /v2/catalog/batch-upsert. Creates or updates up to 10,000 target objects based on the provided list of objects. The target objects are grouped into batches and each batch is inserted/updated in an all-or-nothing manner. If an object within a batch is malformed in some way, or violates a database constraint, the entire batch containing that item will be disregarded. However, other batches in the same request may still succeed. Each batch may contain up to 1,000 objects, and batches will be processed in order as long as the total object count for the request (items, variations, modifier lists, discounts, and taxes) is no more than 10,000. Args: body (BatchUpsertCatalogObjectsRequest): An object containing the fields to POST for the request. See the corresponding object definition for field details. Returns: ApiResponse: An object with the response value as well as other useful information such as status codes and headers. Success Raises: APIException: When an error occurs while fetching the data from the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request. z/v2/catalog/batch-upsertrrrrNrrr)rrrbatch_upsert_catalog_objectss '      z'CatalogApi.batch_upsert_catalog_objectscCsd}|j}||7}t|}t|tr|j}|j}n|}d}dt|df|j ||fd}ddi} |jj j || |d} t |j| || } t| j} t| tur[| d } nd} t| | | d }|S) aDoes a POST request to /v2/catalog/images. Uploads an image file to be represented by a [CatalogImage]($m/CatalogImage) object linked to an existing [CatalogObject]($m/CatalogObject) instance. A call to this endpoint can upload an image, link an image to a catalog object, or do both. This `CreateCatalogImage` endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB. Args: request (CreateCatalogImageRequest, optional): TODO: type description here. image_file (typing.BinaryIO, optional): TODO: type description here. Returns: ApiResponse: An object with the response value as well as other useful information such as status codes and headers. Success Raises: APIException: When an error occurs while fetching the data from the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request. z/v2/catalog/imagesz image/jpegNzapplication/json; charset=utf-8)request image_filerr)rfilesrr)r rrr isinstancer file_stream content_typer!namerr rr"r#r$r%r&r'r(r)r r6r7r*r+r,image_file_wrapperimage_file_content_type_filesr-r.r/r0r1r2rrrcreate_catalog_images.!        zCatalogApi.create_catalog_imagec Csd}|j}||7}t|}ddi}|jjj||d}t|j|||}t |j }t |t ur;|d}nd}t |||d} | S)aDoes a GET request to /v2/catalog/info. Retrieves information about the Square Catalog API, such as batch size limits that can be used by the `BatchUpsertCatalogObjects` endpoint. Returns: ApiResponse: An object with the response value as well as other useful information such as status codes and headers. Success Raises: APIException: When an error occurs while fetching the data from the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request. z/v2/catalog/inforrrrNr)r rrrrr(rr"r#r$r%r&r'r) r r*r+r,r-r.r/r0r1r2rrr catalog_info s      zCatalogApi.catalog_infocCsd}|j}||7}|||d}t||}t|}ddi}|jjj||d} t|j| | | } t | j } t | t urG| d} nd} t| | | d} | S) a Does a GET request to /v2/catalog/list. Returns a list of [CatalogObject]($m/CatalogObject)s that includes all objects of a set of desired types (for example, all [CatalogItem]($m/CatalogItem) and [CatalogTax]($m/CatalogTax) objects) in the catalog. The `types` parameter is specified as a comma-separated list of valid [CatalogObject]($m/CatalogObject) types: `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`. __Important:__ ListCatalog does not return deleted catalog items. To retrieve deleted catalog items, use [SearchCatalogObjects]($e/Catalog/SearchCatalogObjects) and set the `include_deleted_objects` attribute value to `true`. Args: cursor (string, optional): The pagination cursor returned in the previous response. Leave unset for an initial request. The page size is currently set to be 100. See [Pagination](https://developer.squareup.com/docs/basics/api101/ pagination) for more information. types (string, optional): An optional case-insensitive, comma-separated list of object types to retrieve. The valid values are defined in the [CatalogObjectType]($m/CatalogObjectType) enum, including `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. If this is unspecified, the operation returns objects of all the types at the version of the Square API used to make the request. catalog_version (long|int, optional): The specific version of the catalog objects to be included in the response. This allows you to retrieve historical versions of objects. The specified version value is matched against the [CatalogObject]($m/CatalogObject)s' `version` attribute. Returns: ApiResponse: An object with the response value as well as other useful information such as status codes and headers. Success Raises: APIException: When an error occurs while fetching the data from the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request. z/v2/catalog/list)cursortypescatalog_versionrrrArNr)r rr append_url_with_query_parametersrrr(rr"r#r$r%r&r'r)r rCrDrEr*r+_query_parametersr,r-r.r/r0r1r2rrr list_catalog5s.6      zCatalogApi.list_catalogc Cr)aDoes a POST request to /v2/catalog/object. Creates or updates the target [CatalogObject]($m/CatalogObject). Args: body (UpsertCatalogObjectRequest): An object containing the fields to POST for the request. See the corresponding object definition for field details. Returns: ApiResponse: An object with the response value as well as other useful information such as status codes and headers. Success Raises: APIException: When an error occurs while fetching the data from the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request. z/v2/catalog/objectrrrrNrrr)rrrupsert_catalog_objects       z CatalogApi.upsert_catalog_objectc Csd}t|d|ddi}|j}||7}t|}ddi}|jjj||d}t|j|| |}t |j }t |t urF|d} nd } t||| d } | S) aDoes a DELETE request to /v2/catalog/object/{object_id}. Deletes a single [CatalogObject]($m/CatalogObject) based on the provided ID and returns the set of successfully deleted IDs in the response. Deletion is a cascading event such that all children of the targeted object are also deleted. For example, deleting a [CatalogItem]($m/CatalogItem) will also delete all of its [CatalogItemVariation]($m/CatalogItemVariation) children. Args: object_id (string): The ID of the catalog object to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a catalog item will delete its catalog item variations). Returns: ApiResponse: An object with the response value as well as other useful information such as status codes and headers. Success Raises: APIException: When an error occurs while fetching the data from the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request. /v2/catalog/object/{object_id} object_idTvalueencoderrrArNr)r#append_url_with_template_parametersr rrrdeleterr"r#r$r%r&r'r(r) r rKr*r+r,r-r.r/r0r1r2rrrdelete_catalog_objects$"       z CatalogApi.delete_catalog_objectFcCsd}t|d|ddi}|j}||7}||d}t||}t|}ddi}|jjj||d} t |j| | | } t | j } t | turQ| d } nd } t| | | d } | S) aDoes a GET request to /v2/catalog/object/{object_id}. Returns a single [CatalogItem]($m/CatalogItem) as a [CatalogObject]($m/CatalogObject) based on the provided ID. The returned object includes all of the relevant [CatalogItem]($m/CatalogItem) information including: [CatalogItemVariation]($m/CatalogItemVariation) children, references to its [CatalogModifierList]($m/CatalogModifierList) objects, and the ids of any [CatalogTax]($m/CatalogTax) objects that apply to it. Args: object_id (string): The object ID of any type of catalog objects to be retrieved. include_related_objects (bool, optional): If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a `CatalogItem`, its associated `CatalogCategory`, `CatalogTax`, `CatalogImage` and `CatalogModifierList` objects will be returned in the `related_objects` field of the response. If the `object` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response. Default value: `false` catalog_version (long|int, optional): Requests objects as of a specific version of the catalog. This allows you to retrieve historical versions of objects. The value to retrieve a specific version of an object can be found in the version field of [CatalogObject]($m/CatalogObject)s. Returns: ApiResponse: An object with the response value as well as other useful information such as status codes and headers. Success Raises: APIException: When an error occurs while fetching the data from the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request. rJrKTrL)include_related_objectsrErrrArNr)rrOr rrFrrr(rr"r#r$r%r&r'r)r rKrRrEr*r+rGr,r-r.r/r0r1r2rrrretrieve_catalog_objects20       z"CatalogApi.retrieve_catalog_objectc Cr)aDoes a POST request to /v2/catalog/search. Searches for [CatalogObject]($m/CatalogObject) of any type by matching supported search attribute values, excluding custom attribute values on items or item variations, against one or more of the specified query filters. This (`SearchCatalogObjects`) endpoint differs from the [SearchCatalogItems]($e/Catalog/SearchCatalogItems) endpoint in the following aspects: - `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects. - `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not. - `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does. - The both endpoints have different call conventions, including the query filter formats. Args: body (SearchCatalogObjectsRequest): An object containing the fields to POST for the request. See the corresponding object definition for field details. Returns: ApiResponse: An object with the response value as well as other useful information such as status codes and headers. Success Raises: APIException: When an error occurs while fetching the data from the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request. z/v2/catalog/searchrrrrNrrr)rrrsearch_catalog_objectsI )      z!CatalogApi.search_catalog_objectsc Cr)aDoes a POST request to /v2/catalog/search-catalog-items. Searches for catalog items or item variations by matching supported search attribute values, including custom attribute values, against one or more of the specified query filters. This (`SearchCatalogItems`) endpoint differs from the [SearchCatalogObjects]($e/Catalog/SearchCatalogObjects) endpoint in the following aspects: - `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects` can search for any type of catalog objects. - `SearchCatalogItems` supports the custom attribute query filters to return items or item variations that contain custom attribute values, where `SearchCatalogObjects` does not. - `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted items or item variations, whereas `SearchCatalogObjects` does. - The both endpoints use different call conventions, including the query filter formats. Args: body (SearchCatalogItemsRequest): An object containing the fields to POST for the request. See the corresponding object definition for field details. Returns: ApiResponse: An object with the response value as well as other useful information such as status codes and headers. Success Raises: APIException: When an error occurs while fetching the data from the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request. z /v2/catalog/search-catalog-itemsrrrrNrrr)rrrsearch_catalog_itemsrUzCatalogApi.search_catalog_itemsc Cr)aDoes a POST request to /v2/catalog/update-item-modifier-lists. Updates the [CatalogModifierList]($m/CatalogModifierList) objects that apply to the targeted [CatalogItem]($m/CatalogItem) without having to perform an upsert on the entire item. Args: body (UpdateItemModifierListsRequest): An object containing the fields to POST for the request. See the corresponding object definition for field details. Returns: ApiResponse: An object with the response value as well as other useful information such as status codes and headers. Success Raises: APIException: When an error occurs while fetching the data from the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request. z&/v2/catalog/update-item-modifier-listsrrrrNrrr)rrrupdate_item_modifier_listss       z%CatalogApi.update_item_modifier_listsc Cr)aDoes a POST request to /v2/catalog/update-item-taxes. Updates the [CatalogTax]($m/CatalogTax) objects that apply to the targeted [CatalogItem]($m/CatalogItem) without having to perform an upsert on the entire item. Args: body (UpdateItemTaxesRequest): An object containing the fields to POST for the request. See the corresponding object definition for field details. Returns: ApiResponse: An object with the response value as well as other useful information such as status codes and headers. Success Raises: APIException: When an error occurs while fetching the data from the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request. z/v2/catalog/update-item-taxesrrrrNrrr)rrrupdate_item_taxess       zCatalogApi.update_item_taxesr)NN)NNN)FN)__name__ __module__ __qualname____doc__r r3r4r5r@rBrHrIrQrSrTrVrWrX __classcell__rrrrr s.=8@ E, V0> RAA3rN) square.api_helperrsquare.http.api_responsersquare.utilities.file_wrapperrsquare.api.base_apirsquare.http.auth.o_auth_2rrrrrrs