Authorization

SDK Reference · Resource

Authorization

Sign in, create accounts, recover access, and refresh access tokens.

login()loginWithGoogle()verifyOtp()recoverPassword()refresh()signup()

method

login()

Sign in with email or username

Checks account credentials and returns an access token plus a refresh token. Send the access token as `Authorization: Bearer `.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.authorization.login(options: AuthorizationLoginOptions): Promise<AuthorizationLoginResponse>

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	LoginRequestRequest	Required	—

Example

const result = await client.authorization.login({
  body: {
    "password": "Correct-Horse-Battery-Staple-42"
  }
});

Returns

TokenPairResponse

The operation completed successfully.

typeTokenPairResponse2fields

FieldTypeRequirementDescription

token

string

Required

Short-lived access token used in the Authorization header.

refresh

string

Required

Long-lived token used to request a new access token.

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• 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.authorization.loginWithResponse(options): Promise<ApiResponse<AuthorizationLoginResponse>>

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

Signature

Syncclient.authorization.login(*, body: LoginRequest, accept_language: str | Unset=UNSET) -> TokenPairResponse | OTPChallenge

Asyncawait async_client.authorization.login(*, body: LoginRequest, accept_language: str | Unset=UNSET) -> TokenPairResponse | OTPChallenge

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	LoginRequestRequest	Required	—

Example

result = client.authorization.login(
        body=models.LoginRequestRequest.from_dict({'password': 'Correct-Horse-Battery-Staple-42'}),
    )

Async example

result = await async_client.authorization.login(
        body=models.LoginRequestRequest.from_dict({'password': 'Correct-Horse-Battery-Staple-42'}),
    )

Returns

TokenPairResponse | OTPChallenge

The operation completed successfully.

classTokenPairResponse2fields

FieldTypeRequirementDescription

token

str

Required

Short-lived access token used in the Authorization header.

refresh

str

Required

Long-lived token used to request a new access token.

classOTPChallenge3fields

FieldTypeRequirementDescription

status

str

Required

—

challenge

str

Required

—

expires_in

int

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.authorization.login_with_response(*, body: LoginRequest, accept_language: str | Unset=UNSET) -> ApiResponse[TokenPairResponse | OTPChallenge]

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

Signature

Sync$client->authorization()->login($loginRequest, $acceptLanguage = null, string $contentType = self::contentTypes['login'][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.
loginRequest	LoginRequest	Required	—

Example

$result = $client->authorization()->login(
    loginRequest: new Dto\LoginRequest([
        'password' => 'Correct-Horse-Battery-Staple-42',
    ]),
);

Returns

TokenPairResponse

The operation completed successfully.

classTokenPairResponse2fields

FieldTypeRequirementDescription

token

string

Required

Short-lived access token used in the Authorization header. |

refresh

string

Required

Long-lived token used to request a new access token. |

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• 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->authorization()->loginWithResponse($loginRequest, $acceptLanguage = null, string $contentType = self::contentTypes['login'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->authorization()->loginWithHttpInfo($loginRequest, $acceptLanguage = null, string $contentType = self::contentTypes['login'][0])

  Returns the OpenAPI Generator response tuple.

• $client->authorization()->loginAsync($loginRequest, $acceptLanguage = null, string $contentType = self::contentTypes['login'][0])

  Returns a Guzzle promise for the decoded result.

• $client->authorization()->loginAsyncWithHttpInfo($loginRequest, $acceptLanguage = null, string $contentType = self::contentTypes['login'][0])

  Returns a Guzzle promise for the response tuple.

• $client->authorization()->loginRequest($loginRequest, $acceptLanguage = null, string $contentType = self::contentTypes['login'][0])

  Builds the PSR-7 request without sending it.

method

loginWithGoogle()

Sign in with Google

Verifies a Google ID token, creates or links the matching customer account when needed, and returns an API token pair.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.authorization.loginWithGoogle(options: AuthorizationLoginWithGoogleOptions): Promise<AuthorizationLoginWithGoogleResponse>

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	GoogleAuthRequest	Required	—

Example

const result = await client.authorization.loginWithGoogle({
  body: {
    "credential": "{credential}"
  }
});

Returns

TokenPairResponse

The operation completed successfully.

typeTokenPairResponse2fields

FieldTypeRequirementDescription

token

string

Required

Short-lived access token used in the Authorization header.

refresh

string

Required

Long-lived token used to request a new access token.

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are 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.authorization.loginWithGoogleWithResponse(options): Promise<ApiResponse<AuthorizationLoginWithGoogleResponse>>

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

Signature

Syncclient.authorization.login_with_google(*, body: GoogleAuthRequest, accept_language: str | Unset=UNSET) -> TokenPairResponse | OTPChallenge

Asyncawait async_client.authorization.login_with_google(*, body: GoogleAuthRequest, accept_language: str | Unset=UNSET) -> TokenPairResponse | OTPChallenge

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	GoogleAuthRequest	Required	—

Example

result = client.authorization.login_with_google(
        body=models.GoogleAuthRequest.from_dict({'credential': '{credential}'}),
    )

Async example

result = await async_client.authorization.login_with_google(
        body=models.GoogleAuthRequest.from_dict({'credential': '{credential}'}),
    )

Returns

TokenPairResponse | OTPChallenge

The operation completed successfully.

classTokenPairResponse2fields

FieldTypeRequirementDescription

token

str

Required

Short-lived access token used in the Authorization header.

refresh

str

Required

Long-lived token used to request a new access token.

classOTPChallenge3fields

FieldTypeRequirementDescription

status

str

Required

—

challenge

str

Required

—

expires_in

int

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are 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.authorization.login_with_google_with_response(*, body: GoogleAuthRequest, accept_language: str | Unset=UNSET) -> ApiResponse[TokenPairResponse | OTPChallenge]

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

Signature

Sync$client->authorization()->loginWithGoogle($googleAuthRequest, $acceptLanguage = null, string $contentType = self::contentTypes['loginWithGoogle'][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.
googleAuthRequest	GoogleAuthRequest	Required	—

Example

$result = $client->authorization()->loginWithGoogle(
    googleAuthRequest: new Dto\GoogleAuthRequest([
        'credential' => '{credential}',
    ]),
);

Returns

TokenPairResponse

The operation completed successfully.

classTokenPairResponse2fields

FieldTypeRequirementDescription

token

string

Required

Short-lived access token used in the Authorization header. |

refresh

string

Required

Long-lived token used to request a new access token. |

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are 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->authorization()->loginWithGoogleWithResponse($googleAuthRequest, $acceptLanguage = null, string $contentType = self::contentTypes['loginWithGoogle'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->authorization()->loginWithGoogleWithHttpInfo($googleAuthRequest, $acceptLanguage = null, string $contentType = self::contentTypes['loginWithGoogle'][0])

  Returns the OpenAPI Generator response tuple.

• $client->authorization()->loginWithGoogleAsync($googleAuthRequest, $acceptLanguage = null, string $contentType = self::contentTypes['loginWithGoogle'][0])

  Returns a Guzzle promise for the decoded result.

• $client->authorization()->loginWithGoogleAsyncWithHttpInfo($googleAuthRequest, $acceptLanguage = null, string $contentType = self::contentTypes['loginWithGoogle'][0])

  Returns a Guzzle promise for the response tuple.

• $client->authorization()->loginWithGoogleRequest($googleAuthRequest, $acceptLanguage = null, string $contentType = self::contentTypes['loginWithGoogle'][0])

  Builds the PSR-7 request without sending it.

method

verifyOtp()

Complete two-factor sign-in

Exchanges a single-use sign-in challenge and authenticator code for account tokens.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.authorization.verifyOtp(options: AuthorizationVerifyOtpOptions): Promise<AuthorizationVerifyOtpResponse>

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	VerifyOTPRequest	Required	—

Example

const result = await client.authorization.verifyOtp({
  body: {
    "challenge": "{challenge}",
    "code": "{code}"
  }
});

Returns

TokenPairResponse

The operation completed successfully.

typeTokenPairResponse2fields

FieldTypeRequirementDescription

token

string

Required

Short-lived access token used in the Authorization header.

refresh

string

Required

Long-lived token used to request a new access token.

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• 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.authorization.verifyOtpWithResponse(options): Promise<ApiResponse<AuthorizationVerifyOtpResponse>>

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

Signature

Syncclient.authorization.verify_otp(*, body: VerifyOTPRequest, accept_language: str | Unset=UNSET) -> TokenPairResponse

Asyncawait async_client.authorization.verify_otp(*, body: VerifyOTPRequest, accept_language: str | Unset=UNSET) -> TokenPairResponse

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	VerifyOTPRequest	Required	—

Example

result = client.authorization.verify_otp(
        body=models.VerifyOTPRequest.from_dict({'challenge': '{challenge}', 'code': '{code}'}),
    )

Async example

result = await async_client.authorization.verify_otp(
        body=models.VerifyOTPRequest.from_dict({'challenge': '{challenge}', 'code': '{code}'}),
    )

Returns

TokenPairResponse

The operation completed successfully.

classTokenPairResponse2fields

FieldTypeRequirementDescription

token

str

Required

Short-lived access token used in the Authorization header.

refresh

str

Required

Long-lived token used to request a new access token.

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.authorization.verify_otp_with_response(*, body: VerifyOTPRequest, accept_language: str | Unset=UNSET) -> ApiResponse[TokenPairResponse]

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

Signature

Sync$client->authorization()->verifyOtp($verifyOTPRequest, $acceptLanguage = null, string $contentType = self::contentTypes['verifyOtp'][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.
verifyOTPRequest	VerifyOTPRequest	Required	—

Example

$result = $client->authorization()->verifyOtp(
    verifyOTPRequest: new Dto\VerifyOTPRequest([
        'challenge' => '{challenge}',
        'code' => '{code}',
    ]),
);

Returns

TokenPairResponse

The operation completed successfully.

classTokenPairResponse2fields

FieldTypeRequirementDescription

token

string

Required

Short-lived access token used in the Authorization header. |

refresh

string

Required

Long-lived token used to request a new access token. |

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• 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->authorization()->verifyOtpWithResponse($verifyOTPRequest, $acceptLanguage = null, string $contentType = self::contentTypes['verifyOtp'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->authorization()->verifyOtpWithHttpInfo($verifyOTPRequest, $acceptLanguage = null, string $contentType = self::contentTypes['verifyOtp'][0])

  Returns the OpenAPI Generator response tuple.

• $client->authorization()->verifyOtpAsync($verifyOTPRequest, $acceptLanguage = null, string $contentType = self::contentTypes['verifyOtp'][0])

  Returns a Guzzle promise for the decoded result.

• $client->authorization()->verifyOtpAsyncWithHttpInfo($verifyOTPRequest, $acceptLanguage = null, string $contentType = self::contentTypes['verifyOtp'][0])

  Returns a Guzzle promise for the response tuple.

• $client->authorization()->verifyOtpRequest($verifyOTPRequest, $acceptLanguage = null, string $contentType = self::contentTypes['verifyOtp'][0])

  Builds the PSR-7 request without sending it.

method

recoverPassword()

Send a password recovery email

Validates the anti-bot token and sends account recovery instructions to the supplied email address.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.authorization.recoverPassword(options: AuthorizationRecoverPasswordOptions): Promise<AuthorizationRecoverPasswordResponse>

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	RecoverPasswordRequest	Required	—

Example

const result = await client.authorization.recoverPassword({
  body: {
    "email": "[email protected]",
    "token": "{token}"
  }
});

Returns

PasswordRecoveryResponse

The operation completed successfully.

typePasswordRecoveryResponse2fields

FieldTypeRequirementDescription

message

string

Required

—

email

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• 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.authorization.recoverPasswordWithResponse(options): Promise<ApiResponse<AuthorizationRecoverPasswordResponse>>

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

Signature

Syncclient.authorization.recover_password(*, body: RecoverPasswordRequest, accept_language: str | Unset=UNSET) -> PasswordRecoveryResponse

Asyncawait async_client.authorization.recover_password(*, body: RecoverPasswordRequest, accept_language: str | Unset=UNSET) -> PasswordRecoveryResponse

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	RecoverPasswordRequest	Required	—

Example

result = client.authorization.recover_password(
        body=models.RecoverPasswordRequest.from_dict({'email': '[email protected]', 'token': '{token}'}),
    )

Async example

result = await async_client.authorization.recover_password(
        body=models.RecoverPasswordRequest.from_dict({'email': '[email protected]', 'token': '{token}'}),
    )

Returns

PasswordRecoveryResponse

The operation completed successfully.

classPasswordRecoveryResponse2fields

FieldTypeRequirementDescription

message

str

Required

—

email

str

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.authorization.recover_password_with_response(*, body: RecoverPasswordRequest, accept_language: str | Unset=UNSET) -> ApiResponse[PasswordRecoveryResponse]

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

Signature

Sync$client->authorization()->recoverPassword($recoverPasswordRequest, $acceptLanguage = null, string $contentType = self::contentTypes['recoverPassword'][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.
recoverPasswordRequest	RecoverPasswordRequest	Required	—

Example

$result = $client->authorization()->recoverPassword(
    recoverPasswordRequest: new Dto\RecoverPasswordRequest([
        'email' => '[email protected]',
        'token' => '{token}',
    ]),
);

Returns

PasswordRecoveryResponse

The operation completed successfully.

classPasswordRecoveryResponse2fields

FieldTypeRequirementDescription

message

string

Required

|

email

string

Required

|

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• 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->authorization()->recoverPasswordWithResponse($recoverPasswordRequest, $acceptLanguage = null, string $contentType = self::contentTypes['recoverPassword'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->authorization()->recoverPasswordWithHttpInfo($recoverPasswordRequest, $acceptLanguage = null, string $contentType = self::contentTypes['recoverPassword'][0])

  Returns the OpenAPI Generator response tuple.

• $client->authorization()->recoverPasswordAsync($recoverPasswordRequest, $acceptLanguage = null, string $contentType = self::contentTypes['recoverPassword'][0])

  Returns a Guzzle promise for the decoded result.

• $client->authorization()->recoverPasswordAsyncWithHttpInfo($recoverPasswordRequest, $acceptLanguage = null, string $contentType = self::contentTypes['recoverPassword'][0])

  Returns a Guzzle promise for the response tuple.

• $client->authorization()->recoverPasswordRequest($recoverPasswordRequest, $acceptLanguage = null, string $contentType = self::contentTypes['recoverPassword'][0])

  Builds the PSR-7 request without sending it.

method

refresh()

Refresh an access token

Uses a valid refresh token to issue a new short-lived access token for the same account session.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.authorization.refresh(options: AuthorizationRefreshOptions): Promise<AuthorizationRefreshResponse>

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	TokenRefreshRequestRequest	Required	—

Example

const result = await client.authorization.refresh({
  body: {
    "refresh": "{refresh}"
  }
});

Returns

TokenRefreshResponse

The operation completed successfully.

typeTokenRefreshResponse1field

FieldTypeRequirementDescription

access

string

Required

New access token for the same account session.

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: "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.authorization.refreshWithResponse(options): Promise<ApiResponse<AuthorizationRefreshResponse>>

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

Signature

Syncclient.authorization.refresh(*, body: TokenRefreshRequest, accept_language: str | Unset=UNSET) -> TokenRefreshResponse

Asyncawait async_client.authorization.refresh(*, body: TokenRefreshRequest, accept_language: str | Unset=UNSET) -> TokenRefreshResponse

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	TokenRefreshRequestRequest	Required	—

Example

result = client.authorization.refresh(
        body=models.TokenRefreshRequestRequest.from_dict({'refresh': '{refresh}'}),
    )

Async example

result = await async_client.authorization.refresh(
        body=models.TokenRefreshRequestRequest.from_dict({'refresh': '{refresh}'}),
    )

Returns

TokenRefreshResponse

The operation completed successfully.

classTokenRefreshResponse1field

FieldTypeRequirementDescription

access

str

Required

New access token for the same account session.

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.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.authorization.refresh_with_response(*, body: TokenRefreshRequest, accept_language: str | Unset=UNSET) -> ApiResponse[TokenRefreshResponse]

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

Signature

Sync$client->authorization()->refresh($tokenRefreshRequest, $acceptLanguage = null, string $contentType = self::contentTypes['refresh'][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.
tokenRefreshRequest	TokenRefreshRequest	Required	—

Example

$result = $client->authorization()->refresh(
    tokenRefreshRequest: new Dto\TokenRefreshRequest([
        'refresh' => '{refresh}',
    ]),
);

Returns

TokenRefreshResponse

The operation completed successfully.

classTokenRefreshResponse1field

FieldTypeRequirementDescription

access

string

Required

New access token for the same account session. |

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::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->authorization()->refreshWithResponse($tokenRefreshRequest, $acceptLanguage = null, string $contentType = self::contentTypes['refresh'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->authorization()->refreshWithHttpInfo($tokenRefreshRequest, $acceptLanguage = null, string $contentType = self::contentTypes['refresh'][0])

  Returns the OpenAPI Generator response tuple.

• $client->authorization()->refreshAsync($tokenRefreshRequest, $acceptLanguage = null, string $contentType = self::contentTypes['refresh'][0])

  Returns a Guzzle promise for the decoded result.

• $client->authorization()->refreshAsyncWithHttpInfo($tokenRefreshRequest, $acceptLanguage = null, string $contentType = self::contentTypes['refresh'][0])

  Returns a Guzzle promise for the response tuple.

• $client->authorization()->refreshRequest($tokenRefreshRequest, $acceptLanguage = null, string $contentType = self::contentTypes['refresh'][0])

  Builds the PSR-7 request without sending it.

method

signup()

Create a customer account

Creates an account after validating the email, password, and Cloudflare Turnstile token. Referral and affiliate codes are optional.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.authorization.signup(options: AuthorizationSignupOptions): Promise<AuthorizationSignupResponse>

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	SignUpRequest	Required	—

Example

const result = await client.authorization.signup({
  body: {
    "email": "[email protected]",
    "password": "Correct-Horse-Battery-Staple-42",
    "token": "{token}"
  }
});

Returns

TokenPairResponse

The resource or action result was created successfully.

typeTokenPairResponse2fields

FieldTypeRequirementDescription

token

string

Required

Short-lived access token used in the Authorization header.

refresh

string

Required

Long-lived token used to request a new access token.

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are 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.authorization.signupWithResponse(options): Promise<ApiResponse<AuthorizationSignupResponse>>

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

Signature

Syncclient.authorization.signup(*, body: SignUpRequest, accept_language: str | Unset=UNSET) -> TokenPairResponse

Asyncawait async_client.authorization.signup(*, body: SignUpRequest, accept_language: str | Unset=UNSET) -> TokenPairResponse

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	SignUpRequest	Required	—

Example

result = client.authorization.signup(
        body=models.SignUpRequest.from_dict({'email': '[email protected]', 'password': 'Correct-Horse-Battery-Staple-42', 'token': '{token}'}),
    )

Async example

result = await async_client.authorization.signup(
        body=models.SignUpRequest.from_dict({'email': '[email protected]', 'password': 'Correct-Horse-Battery-Staple-42', 'token': '{token}'}),
    )

Returns

TokenPairResponse

The resource or action result was created successfully.

classTokenPairResponse2fields

FieldTypeRequirementDescription

token

str

Required

Short-lived access token used in the Authorization header.

refresh

str

Required

Long-lived token used to request a new access token.

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are 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.authorization.signup_with_response(*, body: SignUpRequest, accept_language: str | Unset=UNSET) -> ApiResponse[TokenPairResponse]

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

Signature

Sync$client->authorization()->signup($signUpRequest, $acceptLanguage = null, string $contentType = self::contentTypes['signup'][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.
signUpRequest	SignUpRequest	Required	—

Example

$result = $client->authorization()->signup(
    signUpRequest: new Dto\SignUpRequest([
        'email' => '[email protected]',
        'password' => 'Correct-Horse-Battery-Staple-42',
        'token' => '{token}',
    ]),
);

Returns

TokenPairResponse

The resource or action result was created successfully.

classTokenPairResponse2fields

FieldTypeRequirementDescription

token

string

Required

Short-lived access token used in the Authorization header. |

refresh

string

Required

Long-lived token used to request a new access token. |

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are 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->authorization()->signupWithResponse($signUpRequest, $acceptLanguage = null, string $contentType = self::contentTypes['signup'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->authorization()->signupWithHttpInfo($signUpRequest, $acceptLanguage = null, string $contentType = self::contentTypes['signup'][0])

  Returns the OpenAPI Generator response tuple.

• $client->authorization()->signupAsync($signUpRequest, $acceptLanguage = null, string $contentType = self::contentTypes['signup'][0])

  Returns a Guzzle promise for the decoded result.

• $client->authorization()->signupAsyncWithHttpInfo($signUpRequest, $acceptLanguage = null, string $contentType = self::contentTypes['signup'][0])

  Returns a Guzzle promise for the response tuple.

• $client->authorization()->signupRequest($signUpRequest, $acceptLanguage = null, string $contentType = self::contentTypes['signup'][0])

  Builds the PSR-7 request without sending it.