o tBhV<@sDddlmZddlmZddlmZddlmZGdddeZdS)) APIHelper) ApiResponse)BaseApi)OAuth2csfeZdZdZdfdd Z     dddZddZd d Zd d Zd dZ ddZ ddZ Z S) GiftCardsApiz3A Controller to access Endpoints in the square API.Ncstt|||dSN)superr__init__)selfconfig call_back __class__p/var/www/html/riverr-enterprise-integrations-main/venv/lib/python3.10/site-packages/square/api/gift_cards_api.pyr szGiftCardsApi.__init__cCsd}|j}||7}|||||d}t||}t|} ddi} |jjj| | d} t|j| | | } t | j } t | t urI| d}nd}t| | |d}|S) aQDoes a GET request to /v2/gift-cards. Lists all gift cards. You can specify optional filters to retrieve a subset of the gift cards. Args: mtype (string, optional): If a [type]($m/GiftCardType) is provided, the endpoint returns gift cards of the specified type. Otherwise, the endpoint returns gift cards of all types. state (string, optional): If a [state]($m/GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state. Otherwise, the endpoint returns the gift cards of all states. limit (int, optional): If a limit is provided, the endpoint returns only the specified number of results per page. The maximum value is 50. The default value is 30. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-a pis/pagination). cursor (string, optional): A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. If a cursor is not provided, the endpoint returns the first page of the results. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-a pis/pagination). customer_id (string, optional): If a customer ID is provided, the endpoint returns only the gift cards linked to the specified customer. 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/gift-cards)typestatelimitcursor customer_idacceptapplication/jsonheaderserrorsNbodyr)r get_base_urir append_url_with_query_parameters clean_url http_clientgetrapplyexecute_requestjson_deserializetextrdictr)r mtyperrrr _url_path_query_builder_query_parameters _query_url_headers_request _responsedecoded_errors_resultrrrlist_gift_cardss22      zGiftCardsApi.list_gift_cardsc Cd}|j}||7}t|}ddd}|jjj||t|d}t|j|| |}t |j }t |t ur@|d} nd} t||| d} | S)a Does a POST request to /v2/gift-cards. Creates a digital gift card or registers a physical (plastic) gift card. You must activate the gift card before it can be used for payment. For more information, see [Selling gift cards](https://developer.squareup.com/docs/gift-cards/using-gift-cards- api#selling-square-gift-cards). Args: body (CreateGiftCardRequest): 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. rrrz Content-Typer parametersrNrr rrr r!postjson_serializerr#r$r%r&rr'r"r r rr)r*r,r-r.r/r0r1r2rrrcreate_gift_cardds       zGiftCardsApi.create_gift_cardc Cr4)aDoes a POST request to /v2/gift-cards/from-gan. Retrieves a gift card using the gift card account number (GAN). Args: body (RetrieveGiftCardFromGANRequest): 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/gift-cards/from-ganrr5r6rNrr8r;rrrretrieve_gift_card_from_gans       z(GiftCardsApi.retrieve_gift_card_from_ganc Cr4)a5Does a POST request to /v2/gift-cards/from-nonce. Retrieves a gift card using a secure payment token that represents the gift card. Args: body (RetrieveGiftCardFromNonceRequest): 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/gift-cards/from-noncerr5r6rNrr8r;rrrretrieve_gift_card_from_nonces       z*GiftCardsApi.retrieve_gift_card_from_noncec Cd}t|d|ddi}|j}||7}t|}ddd}|jjj||t|d}t |j|| |}t |j } t | turK| d} nd } t|| | d } | S) aDoes a POST request to /v2/gift-cards/{gift_card_id}/link-customer. Links a customer to a gift card, which is also referred to as adding a card on file. Args: gift_card_id (string): The ID of the gift card to be linked. body (LinkCustomerToGiftCardRequest): 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/gift-cards/{gift_card_id}/link-customer gift_card_idTvalueencoderr5r6rNrr#append_url_with_template_parametersr rr r!r9r:rr#r$r%r&rr'r"r r r@rr)r*r,r-r.r/r0r1r2rrrlink_customer_to_gift_card&       z'GiftCardsApi.link_customer_to_gift_cardc Cr?) aDoes a POST request to /v2/gift-cards/{gift_card_id}/unlink-customer. Unlinks a customer from a gift card, which is also referred to as removing a card on file. Args: gift_card_id (string): The ID of the gift card to be unlinked. body (UnlinkCustomerFromGiftCardRequest): 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/gift-cards/{gift_card_id}/unlink-customerr@TrArr5r6rNrrDrFrrrunlink_customer_from_gift_card0rHz+GiftCardsApi.unlink_customer_from_gift_cardc Csd}t|d|ddi}|j}||7}t|}ddi}|jjj||d}t|j|| |}t |j }t |t urF|d} nd } t||| d } | S) alDoes a GET request to /v2/gift-cards/{id}. Retrieves a gift card using its ID. Args: id (string): The ID of the gift card to retrieve. 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/gift-cards/{id}idTrArrrrNr)rrEr rr r!r"rr#r$r%r&rr'r) r rJr)r*r,r-r.r/r0r1r2rrrretrieve_gift_cardfs$       zGiftCardsApi.retrieve_gift_cardr)NNNNN) __name__ __module__ __qualname____doc__r r3r<r=r>rGrIrK __classcell__rrr rr s T50166rN) square.api_helperrsquare.http.api_responsersquare.api.base_apirsquare.http.auth.o_auth_2rrrrrrs