Rewards

SDK Reference · Resource

Rewards

Inspect and claim account rewards.

list()claim()

method

list()

List account rewards

Returns referral and campaign rewards earned by the authenticated account, ordered from newest to oldest.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.rewards.list(options: RewardsListOptions = {}): Promise<RewardsListResponse>

Parameters

Name	Type	Requirement	Description
level	string	Optional	* `standard` - Standard * `silver` - Silver * `gold` - Gold * `diamond` - Diamond
limit	number	Optional	Number of results to return per page.
offset	number	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
userEmail	string	Optional	—
userId	string	Optional	—
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.rewards.list();

Returns

PaginatedRewardList

The operation completed successfully.

typePaginatedRewardList4fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Optional

—

previous

string

Optional

—

results

Reward[]

Required

—

typeReward8fields

FieldTypeRequirementDescription

id

string

Optional

—

email

string

Required

—

created

string

Required

—

balance

number

Optional

—

data

number

Optional

The amount of data in bytes.

status

RewardStatusEnum

Optional

After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package's data or proxies. * `pending` - Pending * `paid` - Paid * `review` - Review * `cancelled` - Cancelled

enumRewardStatusEnum0fields

* `pending` - Pending * `paid` - Paid * `review` - Review * `cancelled` - Cancelled

No fields.

description

string

Optional

Description of the reward, used to include payout details.

level

LevelEnum

Optional

—

enumLevelEnum0fields

* `standard` - Standard * `silver` - Silver * `gold` - Gold * `diamond` - Diamond

No fields.

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.rewards.listWithResponse(options): Promise<ApiResponse<RewardsListResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.rewards.list(*, level: RewardsListLevel | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, user_email: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedRewardList

Asyncawait async_client.rewards.list(*, level: RewardsListLevel | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, user_email: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedRewardList

Parameters

Name	Type	Requirement	Description
level	str	Optional	* `standard` - Standard * `silver` - Silver * `gold` - Gold * `diamond` - Diamond
limit	int	Optional	Number of results to return per page.
offset	int	Optional	The initial index from which to return the results.
ordering	str	Optional	Which field to use when ordering the results.
user_email	str	Optional	—
user_id	str	Optional	—
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.rewards.list()

Async example

result = await async_client.rewards.list()

Returns

PaginatedRewardList

The operation completed successfully.

classPaginatedRewardList4fields

FieldTypeRequirementDescription

count

int

Required

—

results

list[Reward]

Required

—

classReward8fields

FieldTypeRequirementDescription

email

str

Required

—

created

datetime.datetime

Required

—

id

str

Optional

—

balance

int

Optional

—

data

int

Optional

The amount of data in bytes.

status

RewardStatusEnum

Optional

* `pending` - Pending * `paid` - Paid * `review` - Review * `cancelled` - Cancelled

enumRewardStatusEnum0fields

No fields.

description

str

Optional

Description of the reward, used to include payout details.

level

LevelEnum

Optional

* `standard` - Standard * `silver` - Silver * `gold` - Gold * `diamond` - Diamond

enumLevelEnum0fields

No fields.

next_

None | str

Optional

—

previous

None | str

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.rewards.list_with_response(*, level: RewardsListLevel | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, user_email: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[PaginatedRewardList]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->rewards()->list($level = null, $limit = null, $offset = null, $ordering = null, $userEmail = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

Parameters

Name	Type	Requirement	Description
level	string	Optional	* `standard` - Standard * `silver` - Silver * `gold` - Gold * `diamond` - Diamond
limit	int	Optional	Number of results to return per page.
offset	int	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
userEmail	string	Optional	—
userId	string	Optional	—
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->rewards()->list();

Returns

PaginatedRewardList

The operation completed successfully.

classPaginatedRewardList4fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

| [optional]

previous

string

Required

| [optional]

results

[Reward[]](Reward.md)

Required

|

classReward8fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

email

string

Required

| [readonly]

created

DateTime

Required

| [readonly]

balance

int

Required

| [optional]

data

int

Optional

The amount of data in bytes.

status

RewardStatusEnum

Optional

After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package's data or proxies. * `pending` - Pending * `paid` - Paid * `review` - Review * `cancelled` - Cancelled

enumRewardStatusEnum0fields

* `pending` - Pending * `paid` - Paid * `review` - Review * `cancelled` - Cancelled

No fields.

description

string

Optional

Description of the reward, used to include payout details.

level

LevelEnum

Required

| [optional]

enumLevelEnum0fields

* `standard` - Standard * `silver` - Silver * `gold` - Gold * `diamond` - Diamond

No fields.

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->rewards()->listWithResponse($level = null, $limit = null, $offset = null, $ordering = null, $userEmail = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->rewards()->listWithHttpInfo($level = null, $limit = null, $offset = null, $ordering = null, $userEmail = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns the OpenAPI Generator response tuple.

• $client->rewards()->listAsync($level = null, $limit = null, $offset = null, $ordering = null, $userEmail = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns a Guzzle promise for the decoded result.

• $client->rewards()->listAsyncWithHttpInfo($level = null, $limit = null, $offset = null, $ordering = null, $userEmail = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns a Guzzle promise for the response tuple.

• $client->rewards()->listRequest($level = null, $limit = null, $offset = null, $ordering = null, $userEmail = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Builds the PSR-7 request without sending it.

method

claim()

Claim available rewards

Moves an eligible reward balance or data reward into the customer account. Minimum claim thresholds and reward state are validated.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.rewards.claim(options: RewardsClaimOptions): Promise<RewardsClaimResponse>

Parameters

Name	Type	Requirement	Description
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	RewardClaimRequestRequest	Required	—

Example

const result = await client.rewards.claim({
  body: {
    "type": "{type}"
  }
});

Returns

void

No response body

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.rewards.claimWithResponse(options): Promise<ApiResponse<RewardsClaimResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.rewards.claim(*, body: RewardClaimRequest, accept_language: str | Unset=UNSET) -> None

Asyncawait async_client.rewards.claim(*, body: RewardClaimRequest, accept_language: str | Unset=UNSET) -> None

Parameters

Name	Type	Requirement	Description
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	RewardClaimRequestRequest	Required	—

Example

result = client.rewards.claim(
        body=models.RewardClaimRequestRequest.from_dict({'type': '{type}'}),
    )

Async example

result = await async_client.rewards.claim(
        body=models.RewardClaimRequestRequest.from_dict({'type': '{type}'}),
    )

Returns

None

No response body

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.rewards.claim_with_response(*, body: RewardClaimRequest, accept_language: str | Unset=UNSET) -> ApiResponse[None]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->rewards()->claim($rewardClaimRequest, $acceptLanguage = null, string $contentType = self::contentTypes['claim'][0])

Parameters

Name	Type	Requirement	Description
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
rewardClaimRequest	RewardClaimRequest	Required	—

Example

$result = $client->rewards()->claim(
    rewardClaimRequest: new Dto\RewardClaimRequest([
        'type' => '{type}',
    ]),
);

Returns

void

No response body

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->rewards()->claimWithResponse($rewardClaimRequest, $acceptLanguage = null, string $contentType = self::contentTypes['claim'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->rewards()->claimWithHttpInfo($rewardClaimRequest, $acceptLanguage = null, string $contentType = self::contentTypes['claim'][0])

  Returns the OpenAPI Generator response tuple.

• $client->rewards()->claimAsync($rewardClaimRequest, $acceptLanguage = null, string $contentType = self::contentTypes['claim'][0])

  Returns a Guzzle promise for the decoded result.

• $client->rewards()->claimAsyncWithHttpInfo($rewardClaimRequest, $acceptLanguage = null, string $contentType = self::contentTypes['claim'][0])

  Returns a Guzzle promise for the response tuple.

• $client->rewards()->claimRequest($rewardClaimRequest, $acceptLanguage = null, string $contentType = self::contentTypes['claim'][0])

  Builds the PSR-7 request without sending it.