# -*- coding: utf-8 -*-

from deprecation import deprecated

from square.api_helper import APIHelper

from square.http.api_response import ApiResponse

from square.api.base_api import BaseApi

from apimatic_core.request_builder import RequestBuilder

from apimatic_core.response_handler import ResponseHandler

from apimatic_core.types.parameter import Parameter

from square.http.http_method_enum import HttpMethodEnum

from apimatic_core.authentication.multiple.single_auth import Single

class LoyaltyApi(BaseApi):

"""A Controller to access Endpoints in the square API."""

def __init__(self, config):

super(LoyaltyApi, self).__init__(config)

def create_loyalty_account(self,

body):

"""Does a POST request to /v2/loyalty/accounts.

Creates a loyalty account. To create a loyalty account, you must

provide the `program_id` and a `mapping` with the `phone_number` of

the buyer.

Args:

body (CreateLoyaltyAccountRequest): 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.

"""

return super().new_api_call_builder.request(

RequestBuilder().server('default')

.path('/v2/loyalty/accounts')

.http_method(HttpMethodEnum.POST)

.header_param(Parameter()

.key('Content-Type')

.value('application/json'))

.body_param(Parameter()

.value(body))

.header_param(Parameter()

.key('accept')

.value('application/json'))

.body_serializer(APIHelper.json_serialize)

.auth(Single('global'))

).response(

ResponseHandler()

.deserializer(APIHelper.json_deserialize)

.is_api_response(True)

.convertor(ApiResponse.create)

).execute()

def search_loyalty_accounts(self,

body):

"""Does a POST request to /v2/loyalty/accounts/search.

Searches for loyalty accounts in a loyalty program.

You can search for a loyalty account using the phone number or

customer ID associated with the account. To return all loyalty

accounts, specify an empty `query` object or omit it entirely.

Search results are sorted by `created_at` in ascending order.

Args:

body (SearchLoyaltyAccountsRequest): 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.

"""

return super().new_api_call_builder.request(

RequestBuilder().server('default')

.path('/v2/loyalty/accounts/search')

.http_method(HttpMethodEnum.POST)

.header_param(Parameter()

.key('Content-Type')

.value('application/json'))

.body_param(Parameter()

.value(body))

.header_param(Parameter()

.key('accept')

.value('application/json'))

.body_serializer(APIHelper.json_serialize)

.auth(Single('global'))

).response(

ResponseHandler()

.deserializer(APIHelper.json_deserialize)

.is_api_response(True)

.convertor(ApiResponse.create)

).execute()

def retrieve_loyalty_account(self,

account_id):

"""Does a GET request to /v2/loyalty/accounts/{account_id}.

Retrieves a loyalty account.

Args:

account_id (str): The ID of the [loyalty

account](entity:LoyaltyAccount) 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.

"""

return super().new_api_call_builder.request(

RequestBuilder().server('default')

.path('/v2/loyalty/accounts/{account_id}')

.http_method(HttpMethodEnum.GET)

.template_param(Parameter()

.key('account_id')

.value(account_id)

.should_encode(True))

.header_param(Parameter()

.key('accept')

.value('application/json'))

.auth(Single('global'))

).response(

ResponseHandler()

.deserializer(APIHelper.json_deserialize)

.is_api_response(True)

.convertor(ApiResponse.create)

).execute()

def accumulate_loyalty_points(self,

account_id,

body):

"""Does a POST request to /v2/loyalty/accounts/{account_id}/accumulate.

Adds points earned from a purchase to a [loyalty

account]($m/LoyaltyAccount).

- If you are using the Orders API to manage orders, provide the

`order_id`. Square reads the order

to compute the points earned from both the base loyalty program and an

associated

[loyalty promotion]($m/LoyaltyPromotion). For purchases that qualify

for multiple accrual

rules, Square computes points based on the accrual rule that grants

the most points.

For purchases that qualify for multiple promotions, Square computes

points based on the most

recently created promotion. A purchase must first qualify for program

points to be eligible for promotion points.

- If you are not using the Orders API to manage orders, provide

`points` with the number of points to add.

You must first perform a client-side computation of the points earned

from the loyalty program and

loyalty promotion. For spend-based and visit-based programs, you can

call [CalculateLoyaltyPoints]($e/Loyalty/CalculateLoyaltyPoints)

to compute the points earned from the base loyalty program. For

information about computing points earned from a loyalty promotion,

see

[Calculating promotion

points](https://developer.squareup.com/docs/loyalty-api/loyalty-promoti

ons#calculate-promotion-points).

Args:

account_id (str): The ID of the target [loyalty

account](entity:LoyaltyAccount).

body (AccumulateLoyaltyPointsRequest): 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.

"""

return super().new_api_call_builder.request(

RequestBuilder().server('default')

.path('/v2/loyalty/accounts/{account_id}/accumulate')

.http_method(HttpMethodEnum.POST)

.template_param(Parameter()

.key('account_id')

.value(account_id)

.should_encode(True))

.header_param(Parameter()

.key('Content-Type')

.value('application/json'))

.body_param(Parameter()

.value(body))

.header_param(Parameter()

.key('accept')

.value('application/json'))

.body_serializer(APIHelper.json_serialize)

.auth(Single('global'))

).response(

ResponseHandler()

.deserializer(APIHelper.json_deserialize)

.is_api_response(True)

.convertor(ApiResponse.create)

).execute()

def adjust_loyalty_points(self,

account_id,

body):

"""Does a POST request to /v2/loyalty/accounts/{account_id}/adjust.

Adds points to or subtracts points from a buyer's account.

Use this endpoint only when you need to manually adjust points.

Otherwise, in your application flow, you call

[AccumulateLoyaltyPoints]($e/Loyalty/AccumulateLoyaltyPoints)

to add points when a buyer pays for the purchase.

Args:

account_id (str): The ID of the target [loyalty

account](entity:LoyaltyAccount).

body (AdjustLoyaltyPointsRequest): 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.

"""

return super().new_api_call_builder.request(

RequestBuilder().server('default')

.path('/v2/loyalty/accounts/{account_id}/adjust')

.http_method(HttpMethodEnum.POST)

.template_param(Parameter()

.key('account_id')

.value(account_id)

.should_encode(True))

.header_param(Parameter()

.key('Content-Type')

.value('application/json'))

.body_param(Parameter()

.value(body))

.header_param(Parameter()

.key('accept')

.value('application/json'))

.body_serializer(APIHelper.json_serialize)

.auth(Single('global'))

).response(

ResponseHandler()

.deserializer(APIHelper.json_deserialize)

.is_api_response(True)

.convertor(ApiResponse.create)

).execute()

def search_loyalty_events(self,

body):

"""Does a POST request to /v2/loyalty/events/search.

Searches for loyalty events.

A Square loyalty program maintains a ledger of events that occur

during the lifetime of a

buyer's loyalty account. Each change in the point balance

(for example, points earned, points redeemed, and points expired) is

recorded in the ledger. Using this endpoint, you can search the ledger

for events.

Search results are sorted by `created_at` in descending order.

Args:

body (SearchLoyaltyEventsRequest): 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.

"""

return super().new_api_call_builder.request(

RequestBuilder().server('default')

.path('/v2/loyalty/events/search')

.http_method(HttpMethodEnum.POST)

.header_param(Parameter()

.key('Content-Type')

.value('application/json'))

.body_param(Parameter()

.value(body))

.header_param(Parameter()

.key('accept')

.value('application/json'))

.body_serializer(APIHelper.json_serialize)

.auth(Single('global'))

).response(

ResponseHandler()

.deserializer(APIHelper.json_deserialize)

.is_api_response(True)

.convertor(ApiResponse.create)

).execute()

@deprecated()

def list_loyalty_programs(self):

"""Does a GET request to /v2/loyalty/programs.

Returns a list of loyalty programs in the seller's account.

Loyalty programs define how buyers can earn points and redeem points

for rewards. Square sellers can have only one loyalty program, which

is created and managed from the Seller Dashboard. For more

information, see [Loyalty Program

Overview](https://developer.squareup.com/docs/loyalty/overview).

Replaced with

[RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram)

when used with the keyword `main`.

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.

"""

return super().new_api_call_builder.request(

RequestBuilder().server('default')

.path('/v2/loyalty/programs')

.http_method(HttpMethodEnum.GET)

.header_param(Parameter()

.key('accept')

.value('application/json'))

.auth(Single('global'))

).response(

ResponseHandler()

.deserializer(APIHelper.json_deserialize)

.is_api_response(True)

.convertor(ApiResponse.create)

).execute()

def retrieve_loyalty_program(self,

program_id):

"""Does a GET request to /v2/loyalty/programs/{program_id}.

Retrieves the loyalty program in a seller's account, specified by the

program ID or the keyword `main`.

Loyalty programs define how buyers can earn points and redeem points

for rewards. Square sellers can have only one loyalty program, which

is created and managed from the Seller Dashboard. For more

information, see [Loyalty Program

Overview](https://developer.squareup.com/docs/loyalty/overview).

Args:

program_id (str): The ID of the loyalty program or the keyword

`main`. Either value can be used to retrieve the single

loyalty program that belongs to the seller.

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.

"""

return super().new_api_call_builder.request(

RequestBuilder().server('default')

.path('/v2/loyalty/programs/{program_id}')

.http_method(HttpMethodEnum.GET)

.template_param(Parameter()

.key('program_id')

.value(program_id)

.should_encode(True))

.header_param(Parameter()

.key('accept')

.value('application/json'))

.auth(Single('global'))

).response(

ResponseHandler()

.deserializer(APIHelper.json_deserialize)

.is_api_response(True)

.convertor(ApiResponse.create)

).execute()

def calculate_loyalty_points(self,

program_id,

body):

"""Does a POST request to /v2/loyalty/programs/{program_id}/calculate.

Calculates the number of points a buyer can earn from a purchase.

Applications might call this endpoint

to display the points to the buyer.

- If you are using the Orders API to manage orders, provide the

`order_id` and (optional) `loyalty_account_id`.

Square reads the order to compute the points earned from the base

loyalty program and an associated

[loyalty promotion]($m/LoyaltyPromotion).

- If you are not using the Orders API to manage orders, provide

`transaction_amount_money` with the

purchase amount. Square uses this amount to calculate the points

earned from the base loyalty program,

but not points earned from a loyalty promotion. For spend-based and

visit-based programs, the `tax_mode`

setting of the accrual rule indicates how taxes should be treated for

loyalty points accrual.

If the purchase qualifies for program points, call

[ListLoyaltyPromotions]($e/Loyalty/ListLoyaltyPromotions) and perform

a client-side computation

to calculate whether the purchase also qualifies for promotion points.

For more information, see

[Calculating promotion

points](https://developer.squareup.com/docs/loyalty-api/loyalty-promoti

ons#calculate-promotion-points).

Args:

program_id (str): The ID of the [loyalty

program](entity:LoyaltyProgram), which defines the rules for

accruing points.

body (CalculateLoyaltyPointsRequest): 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.

"""

return super().new_api_call_builder.request(

RequestBuilder().server('default')

.path('/v2/loyalty/programs/{program_id}/calculate')

.http_method(HttpMethodEnum.POST)

.template_param(Parameter()

.key('program_id')

.value(program_id)

.should_encode(True))

.header_param(Parameter()

.key('Content-Type')

.value('application/json'))

.body_param(Parameter()

.value(body))

.header_param(Parameter()

.key('accept')

.value('application/json'))

.body_serializer(APIHelper.json_serialize)

.auth(Single('global'))

).response(

ResponseHandler()

.deserializer(APIHelper.json_deserialize)

.is_api_response(True)

.convertor(ApiResponse.create)

).execute()

def list_loyalty_promotions(self,

program_id,

status=None,

cursor=None,

limit=None):

"""Does a GET request to /v2/loyalty/programs/{program_id}/promotions.

Lists the loyalty promotions associated with a [loyalty

program]($m/LoyaltyProgram).

Results are sorted by the `created_at` date in descending order

(newest to oldest).

Args:

program_id (str): The ID of the base [loyalty

program](entity:LoyaltyProgram). To get the program ID, call

[RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyPr

ogram) using the `main` keyword.

status (LoyaltyPromotionStatus, optional): The status to filter

the results by. If a status is provided, only loyalty

promotions with the specified status are returned. Otherwise,

all loyalty promotions associated with the loyalty program are

returned.

cursor (str, optional): The cursor returned in the paged response

from the previous call to this endpoint. Provide this cursor

to retrieve the next page of results for your original

request. For more information, see

[Pagination](https://developer.squareup.com/docs/build-basics/c

ommon-api-patterns/pagination).

limit (int, optional): The maximum number of results to return in

a single paged response. The minimum value is 1 and the

maximum value is 30. The default value is 30. For more

information, see

[Pagination](https://developer.squareup.com/docs/build-basics/c

ommon-api-patterns/pagination).

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.

"""

return super().new_api_call_builder.request(

RequestBuilder().server('default')

.path('/v2/loyalty/programs/{program_id}/promotions')

.http_method(HttpMethodEnum.GET)

.template_param(Parameter()

.key('program_id')

.value(program_id)

.should_encode(True))

.query_param(Parameter()

.key('status')

.value(status))

.query_param(Parameter()

.key('cursor')

.value(cursor))

.query_param(Parameter()

.key('limit')

.value(limit))

.header_param(Parameter()

.key('accept')

.value('application/json'))

.auth(Single('global'))

).response(

ResponseHandler()

.deserializer(APIHelper.json_deserialize)

.is_api_response(True)

.convertor(ApiResponse.create)

).execute()

def create_loyalty_promotion(self,

program_id,

body):

"""Does a POST request to /v2/loyalty/programs/{program_id}/promotions.

Creates a loyalty promotion for a [loyalty

program]($m/LoyaltyProgram). A loyalty promotion

enables buyers to earn points in addition to those earned from the

base loyalty program.

This endpoint sets the loyalty promotion to the `ACTIVE` or

`SCHEDULED` status, depending on the

`available_time` setting. A loyalty program can have a maximum of 10

loyalty promotions with an

`ACTIVE` or `SCHEDULED` status.

Args:

program_id (str): The ID of the [loyalty

program](entity:LoyaltyProgram) to associate with the

promotion. To get the program ID, call

[RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyPr

ogram) using the `main` keyword.

body (CreateLoyaltyPromotionRequest): 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.

"""

return super().new_api_call_builder.request(

RequestBuilder().server('default')

.path('/v2/loyalty/programs/{program_id}/promotions')

.http_method(HttpMethodEnum.POST)

.template_param(Parameter()

.key('program_id')

.value(program_id)

.should_encode(True))

.header_param(Parameter()

.key('Content-Type')

.value('application/json'))

.body_param(Parameter()

.value(body))

.header_param(Parameter()

.key('accept')

.value('application/json'))

.body_serializer(APIHelper.json_serialize)

.auth(Single('global'))

).response(

ResponseHandler()

.deserializer(APIHelper.json_deserialize)

.is_api_response(True)

.convertor(ApiResponse.create)

).execute()

def retrieve_loyalty_promotion(self,

promotion_id,

program_id):

"""Does a GET request to /v2/loyalty/programs/{program_id}/promotions/{promotion_id}.

Retrieves a loyalty promotion.

Args:

promotion_id (str): The ID of the [loyalty

promotion](entity:LoyaltyPromotion) to retrieve.

program_id (str): The ID of the base [loyalty

program](entity:LoyaltyProgram). To get the program ID, call

[RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyPr

ogram) using the `main` keyword.

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.

"""

return super().new_api_call_builder.request(

RequestBuilder().server('default')

.path('/v2/loyalty/programs/{program_id}/promotions/{promotion_id}')

.http_method(HttpMethodEnum.GET)

.template_param(Parameter()

.key('promotion_id')

.value(promotion_id)

.should_encode(True))

.template_param(Parameter()

.key('program_id')

.value(program_id)

.should_encode(True))

.header_param(Parameter()

.key('accept')

.value('application/json'))

.auth(Single('global'))

).response(

ResponseHandler()

.deserializer(APIHelper.json_deserialize)

.is_api_response(True)

.convertor(ApiResponse.create)

).execute()

def cancel_loyalty_promotion(self,

promotion_id,

program_id):

"""Does a POST request to /v2/loyalty/programs/{program_id}/promotions/{promotion_id}/cancel.

Cancels a loyalty promotion. Use this endpoint to cancel an `ACTIVE`

promotion earlier than the

end date, cancel an `ACTIVE` promotion when an end date is not

specified, or cancel a `SCHEDULED` promotion.

Because updating a promotion is not supported, you can also use this

endpoint to cancel a promotion before

you create a new one.

This endpoint sets the loyalty promotion to the `CANCELED` state

Args:

promotion_id (str): The ID of the [loyalty

promotion](entity:LoyaltyPromotion) to cancel. You can cancel

a promotion that has an `ACTIVE` or `SCHEDULED` status.

program_id (str): The ID of the base [loyalty

program](entity:LoyaltyProgram).

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.

"""

return super().new_api_call_builder.request(

RequestBuilder().server('default')

.path('/v2/loyalty/programs/{program_id}/promotions/{promotion_id}/cancel')

.http_method(HttpMethodEnum.POST)

.template_param(Parameter()

.key('promotion_id')

.value(promotion_id)

.should_encode(True))

.template_param(Parameter()

.key('program_id')

.value(program_id)

.should_encode(True))

.header_param(Parameter()

.key('accept')

.value('application/json'))

.auth(Single('global'))

).response(

ResponseHandler()

.deserializer(APIHelper.json_deserialize)

.is_api_response(True)

.convertor(ApiResponse.create)

).execute()

def create_loyalty_reward(self,

body):

"""Does a POST request to /v2/loyalty/rewards.

Creates a loyalty reward. In the process, the endpoint does

following:

- Uses the `reward_tier_id` in the request to determine the number of

points

to lock for this reward.

- If the request includes `order_id`, it adds the reward and related

discount to the order.

After a reward is created, the points are locked and

not available for the buyer to redeem another reward.

Args:

body (CreateLoyaltyRewardRequest): 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.

"""

return super().new_api_call_builder.request(

RequestBuilder().server('default')

.path('/v2/loyalty/rewards')

.http_method(HttpMethodEnum.POST)

.header_param(Parameter()

.key('Content-Type')

.value('application/json'))

.body_param(Parameter()

.value(body))

.header_param(Parameter()

.key('accept')

.value('application/json'))

.body_serializer(APIHelper.json_serialize)

.auth(Single('global'))

).response(

ResponseHandler()

.deserializer(APIHelper.json_deserialize)

.is_api_response(True)

.convertor(ApiResponse.create)

).execute()

def search_loyalty_rewards(self,

body):

"""Does a POST request to /v2/loyalty/rewards/search.

Searches for loyalty rewards. This endpoint accepts a request with no

query filters and returns results for all loyalty accounts.

If you include a `query` object, `loyalty_account_id` is required and

`status` is optional.

If you know a reward ID, use the

[RetrieveLoyaltyReward]($e/Loyalty/RetrieveLoyaltyReward) endpoint.

Search results are sorted by `updated_at` in descending order.

Args:

body (SearchLoyaltyRewardsRequest): 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.

"""

return super().new_api_call_builder.request(

RequestBuilder().server('default')

.path('/v2/loyalty/rewards/search')

.http_method(HttpMethodEnum.POST)

.header_param(Parameter()

.key('Content-Type')

.value('application/json'))

.body_param(Parameter()

.value(body))

.header_param(Parameter()

.key('accept')

.value('application/json'))

.body_serializer(APIHelper.json_serialize)

.auth(Single('global'))

).response(

ResponseHandler()

.deserializer(APIHelper.json_deserialize)

.is_api_response(True)

.convertor(ApiResponse.create)

).execute()

def delete_loyalty_reward(self,

reward_id):

"""Does a DELETE request to /v2/loyalty/rewards/{reward_id}.

Deletes a loyalty reward by doing the following:

- Returns the loyalty points back to the loyalty account.

- If an order ID was specified when the reward was created

(see [CreateLoyaltyReward]($e/Loyalty/CreateLoyaltyReward)),

it updates the order by removing the reward and related

discounts.

You cannot delete a reward that has reached the terminal state

(REDEEMED).

Args:

reward_id (str): The ID of the [loyalty

reward](entity:LoyaltyReward) to delete.

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.

"""

return super().new_api_call_builder.request(

RequestBuilder().server('default')

.path('/v2/loyalty/rewards/{reward_id}')

.http_method(HttpMethodEnum.DELETE)

.template_param(Parameter()

.key('reward_id')

.value(reward_id)

.should_encode(True))

.header_param(Parameter()

.key('accept')

.value('application/json'))

.auth(Single('global'))

).response(

ResponseHandler()

.deserializer(APIHelper.json_deserialize)

.is_api_response(True)

.convertor(ApiResponse.create)

).execute()

def retrieve_loyalty_reward(self,

reward_id):

"""Does a GET request to /v2/loyalty/rewards/{reward_id}.

Retrieves a loyalty reward.

Args:

reward_id (str): The ID of the [loyalty

reward](entity:LoyaltyReward) 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.

"""

return super().new_api_call_builder.request(

RequestBuilder().server('default')

.path('/v2/loyalty/rewards/{reward_id}')

.http_method(HttpMethodEnum.GET)

.template_param(Parameter()

.key('reward_id')

.value(reward_id)

.should_encode(True))

.header_param(Parameter()

.key('accept')

.value('application/json'))

.auth(Single('global'))

).response(

ResponseHandler()

.deserializer(APIHelper.json_deserialize)

.is_api_response(True)

.convertor(ApiResponse.create)

).execute()

def redeem_loyalty_reward(self,

reward_id,

body):

"""Does a POST request to /v2/loyalty/rewards/{reward_id}/redeem.

Redeems a loyalty reward.

The endpoint sets the reward to the `REDEEMED` terminal state.

If you are using your own order processing system (not using the

Orders API), you call this endpoint after the buyer paid for the

purchase.

After the reward reaches the terminal state, it cannot be deleted.

In other words, points used for the reward cannot be returned

to the account.

Args:

reward_id (str): The ID of the [loyalty

reward](entity:LoyaltyReward) to redeem.

body (RedeemLoyaltyRewardRequest): 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.

"""

return super().new_api_call_builder.request(

RequestBuilder().server('default')

.path('/v2/loyalty/rewards/{reward_id}/redeem')

.http_method(HttpMethodEnum.POST)

.template_param(Parameter()

.key('reward_id')

.value(reward_id)

.should_encode(True))

.header_param(Parameter()

.key('Content-Type')

.value('application/json'))

.body_param(Parameter()

.value(body))

.header_param(Parameter()

.key('accept')

.value('application/json'))

.body_serializer(APIHelper.json_serialize)

.auth(Single('global'))

).response(

ResponseHandler()

.deserializer(APIHelper.json_deserialize)

.is_api_response(True)

.convertor(ApiResponse.create)

).execute()