Account

Methods

TypeScript
Python
Rust

List Account Service Keys

TypeScript

photon.account.listAccountServiceKeys(input?: ListAccountServiceKeysInput, options?: RequestOptions): Promise<ListAccountServiceKeysOutput>

GET /v1/account/service-keysList connected applications

TypeScript

photon.account.listAuthorizedApplications(input?: ListAuthorizedApplicationsInput, options?: RequestOptions): Promise<ListAuthorizedApplicationsOutput>

GET /v1/account/oauth/authorized-applicationsGet the authenticated account

TypeScript

photon.account.get(input?: GetAccountInput, options?: RequestOptions): Promise<GetAccountOutput>

GET /v1/accountCreate an Account Service Key

TypeScript

photon.account.createAccountServiceKey(input: CreateAccountServiceKeyInput, options?: RequestOptions): Promise<CreateAccountServiceKeyOutput>

POST /v1/account/service-keysCreate a profile picture upload

TypeScript

photon.account.createProfilePictureUpload(input: CreateAccountProfilePictureUploadInput, options?: RequestOptions): Promise<CreateAccountProfilePictureUploadOutput>

POST /v1/account/profile-picture/uploadsStart a phone number verification

TypeScript

photon.account.startPhoneVerification(input: StartAccountPhoneVerificationInput, options?: RequestOptions): Promise<StartAccountPhoneVerificationOutput>

POST /v1/account/phone/verificationsCommit a profile picture

TypeScript

photon.account.commitProfilePicture(input: CommitAccountProfilePictureInput, options?: RequestOptions): Promise<CommitAccountProfilePictureOutput>

PUT /v1/account/profile-pictureConfirm a phone number verification

TypeScript

photon.account.confirmPhoneVerification(input: ConfirmAccountPhoneVerificationInput, options?: RequestOptions): Promise<ConfirmAccountPhoneVerificationOutput>

PUT /v1/account/phoneUpdate the authenticated account

TypeScript

photon.account.update(input: UpdateAccountInput, options?: RequestOptions): Promise<UpdateAccountOutput>

PATCH /v1/accountDelete the authenticated account

TypeScript

photon.account.delete(input?: DeleteAccountInput, options?: RequestOptions): Promise<DeleteAccountOutput>

DELETE /v1/accountRemove a profile picture

TypeScript

photon.account.resetProfilePicture(input: ResetAccountProfilePictureInput, options?: RequestOptions): Promise<ResetAccountProfilePictureOutput>

DELETE /v1/account/profile-pictureRevoke an Account Service Key

TypeScript

photon.account.revokeAccountServiceKey(input: RevokeAccountServiceKeyInput, options?: RequestOptions): Promise<RevokeAccountServiceKeyOutput>

DELETE /v1/account/service-keys/{serviceKeyId}Revoke a connected application

TypeScript

photon.account.revokeAuthorizedApplication(input: RevokeAuthorizedApplicationInput, options?: RequestOptions): Promise<RevokeAuthorizedApplicationOutput>

DELETE /v1/account/oauth/authorized-applications/{applicationId}

List Account Service Keys

Python

photon.account.list_account_service_keys(input: ListAccountServiceKeysInput | None = None) -> models.ListAccountServiceKeysResponse

GET /v1/account/service-keysList connected applications

Python

photon.account.list_authorized_applications(input: ListAuthorizedApplicationsInput | None = None) -> models.ListAuthorizedApplicationsResponse

GET /v1/account/oauth/authorized-applicationsGet the authenticated account

Python

photon.account.get(input: GetAccountInput | None = None) -> models.Account

GET /v1/accountCreate an Account Service Key

Python

photon.account.create_account_service_key(input: CreateAccountServiceKeyInput) -> models.CreateAccountServiceKeyResponse

POST /v1/account/service-keysCreate a profile picture upload

Python

photon.account.create_profile_picture_upload(input: CreateAccountProfilePictureUploadInput) -> models.ProfilePictureUpload

POST /v1/account/profile-picture/uploadsStart a phone number verification

Python

photon.account.start_phone_verification(input: StartAccountPhoneVerificationInput) -> models.StartAccountPhoneVerificationResponse

POST /v1/account/phone/verificationsCommit a profile picture

Python

photon.account.commit_profile_picture(input: CommitAccountProfilePictureInput) -> models.Account

PUT /v1/account/profile-pictureConfirm a phone number verification

Python

photon.account.confirm_phone_verification(input: ConfirmAccountPhoneVerificationInput) -> models.Account

PUT /v1/account/phoneUpdate the authenticated account

Python

photon.account.update(input: UpdateAccountInput) -> models.Account

PATCH /v1/accountDelete the authenticated account

Python

photon.account.delete(input: DeleteAccountInput | None = None) -> models.Account

DELETE /v1/accountRemove a profile picture

Python

photon.account.reset_profile_picture(input: ResetAccountProfilePictureInput) -> models.Account

DELETE /v1/account/profile-pictureRevoke an Account Service Key

Python

photon.account.revoke_account_service_key(input: RevokeAccountServiceKeyInput) -> models.RevokeAccountServiceKeyResponse

DELETE /v1/account/service-keys/{serviceKeyId}Revoke a connected application

Python

photon.account.revoke_authorized_application(input: RevokeAuthorizedApplicationInput) -> None

DELETE /v1/account/oauth/authorized-applications/{applicationId}

List Account Service Keys

Rust

client.list_account_service_keys().await -> Result<ResponseValue<types::ListAccountServiceKeysResponse>, Error<ListAccountServiceKeysError>>

GET /v1/account/service-keysList connected applications

Rust

client.list_authorized_applications(params: Option<ListAuthorizedApplicationsParams>).await -> Result<ResponseValue<types::ListAuthorizedApplicationsResponse>, Error<ListAuthorizedApplicationsError>>

GET /v1/account/oauth/authorized-applicationsGet the authenticated account

Rust

client.get_account().await -> Result<ResponseValue<types::Account>, Error<GetAccountError>>

GET /v1/accountCreate an Account Service Key

Rust

client.create_account_service_key(idempotency_key: String, body: &types::CreateAccountServiceKeyRequest).await -> Result<ResponseValue<types::CreateAccountServiceKeyResponse>, Error<CreateAccountServiceKeyError>>

POST /v1/account/service-keysCreate a profile picture upload

Rust

client.create_account_profile_picture_upload(body: &types::ProfilePictureUploadRequest).await -> Result<ResponseValue<types::ProfilePictureUpload>, Error<CreateAccountProfilePictureUploadError>>

POST /v1/account/profile-picture/uploadsStart a phone number verification

Rust

client.start_account_phone_verification(body: &types::StartAccountPhoneVerificationRequest).await -> Result<ResponseValue<types::StartAccountPhoneVerificationResponse>, Error<StartAccountPhoneVerificationError>>

POST /v1/account/phone/verificationsCommit a profile picture

Rust

client.commit_account_profile_picture(idempotency_key: String, body: &types::CommitAccountProfilePictureRequest).await -> Result<ResponseValue<types::Account>, Error<CommitAccountProfilePictureError>>

PUT /v1/account/profile-pictureConfirm a phone number verification

Rust

client.confirm_account_phone_verification(body: &types::ConfirmAccountPhoneVerificationRequest).await -> Result<ResponseValue<types::Account>, Error<ConfirmAccountPhoneVerificationError>>

PUT /v1/account/phoneUpdate the authenticated account

Rust

client.update_account(idempotency_key: String, body: &types::UpdateAccountRequest).await -> Result<ResponseValue<types::Account>, Error<UpdateAccountError>>

PATCH /v1/accountDelete the authenticated account

Rust

client.delete_account().await -> Result<ResponseValue<types::Account>, Error<DeleteAccountError>>

DELETE /v1/accountRemove a profile picture

Rust

client.reset_account_profile_picture(idempotency_key: String).await -> Result<ResponseValue<types::Account>, Error<ResetAccountProfilePictureError>>

DELETE /v1/account/profile-pictureRevoke an Account Service Key

Rust

client.revoke_account_service_key(idempotency_key: String, service_key_id: String).await -> Result<ResponseValue<types::RevokeAccountServiceKeyResponse>, Error<RevokeAccountServiceKeyError>>

DELETE /v1/account/service-keys/{serviceKeyId}Revoke a connected application

Rust

client.revoke_authorized_application(application_id: String).await -> Result<ResponseValue<()>, Error<RevokeAuthorizedApplicationError>>

DELETE /v1/account/oauth/authorized-applications/{applicationId}

Models

ListAccountServiceKeysResponse

array of AccountServiceKey

required

ListAuthorizedApplicationsResponse

array of AuthorizedApplication

required

One page of applications authorized by the authenticated user.

ListAuthorizedApplicationsResponseListMetadata

required

Pagination cursors to pass as after or before in the next list request.

string

required

string (date-time) | null

required

string (date-time) | null

required

string (email)

required

string | null

required

string | null

required

string | null

required

string (date-time) | null

required

string (uri)

required

string (date-time) | null

required

CreateAccountServiceKeyResponse

string

required

AccountServiceKey

required

ProfilePictureUpload

string (date-time)

required

ProfilePictureUploadFormFields

required

string

required

string (uri)

required

StartAccountPhoneVerificationResponse

"sms"

required

string (date-time)

required

string (date-time)

required

RevokeAccountServiceKeyResponse

AccountServiceKey

required

Get started

Guides

Reference

SDK reference

Account

Methods

Models

ListAccountServiceKeysResponse

ListAuthorizedApplicationsResponse

Account

CreateAccountServiceKeyResponse

ProfilePictureUpload

StartAccountPhoneVerificationResponse

RevokeAccountServiceKeyResponse

​Methods

​Models

​ListAccountServiceKeysResponse

​ListAuthorizedApplicationsResponse

​Account

​CreateAccountServiceKeyResponse

​ProfilePictureUpload

​StartAccountPhoneVerificationResponse

​RevokeAccountServiceKeyResponse

Methods

Models

ListAccountServiceKeysResponse

ListAuthorizedApplicationsResponse

Account

CreateAccountServiceKeyResponse

ProfilePictureUpload

StartAccountPhoneVerificationResponse

RevokeAccountServiceKeyResponse