Class AccountSettingsAPI

Account Settings API module - /v1/account/settings

Hierarchy

AccountSettingsAPI

Index

Constructors

Properties

Methods

createImage deleteImage get getImages update updateImage

Constructors

constructor

new AccountSettingsAPI(client: AxiosInstance): AccountSettingsAPI
Parameters
- client: AxiosInstance
Returns AccountSettingsAPI
- Defined in javascript/src/account-settings/api.ts:15

Properties

`Private` client

client: AxiosInstance

Methods

createImage

createImage(data: SE.AccountImage): Promise<AxiosResponse<SE.AccountImageResponse, any>>
The createImage method creates an image that can be used in your printed labels.
Parameters
- data: SE.AccountImage
Returns Promise<AxiosResponse<SE.AccountImageResponse, any>>
- Defined in javascript/src/account-settings/api.ts:38

deleteImage

deleteImage(labelImageId: string): Promise<AxiosResponse<void, any>>
The deleteAccountImage method deletes an image by id.
Parameters
- labelImageId: string
Returns Promise<AxiosResponse<void, any>>
- Defined in javascript/src/account-settings/api.ts:59

get

get(): Promise<AxiosResponse<SE.ShipEngineAccountSettings, any>>
The get method retrieves the account settings for a given user.

Returns Promise<AxiosResponse<SE.ShipEngineAccountSettings, any>>
- Defined in javascript/src/account-settings/api.ts:22

getImages

getImages(): Promise<AxiosResponse<SE.AccountImagesResponse, any>>
The getImages method retrieves a list of images for a given user.

Returns Promise<AxiosResponse<SE.AccountImagesResponse, any>>
- Defined in javascript/src/account-settings/api.ts:52

update

update(settings: Partial<SE.ShipEngineAccountSettings>): Promise<AxiosResponse<SE.ShipEngineAccountSettings, any>>
The update method updates specific account settings for a given user.

Params
Partial<ShipEngineAccountSettings> The account settings to update.
Parameters
- settings: Partial<SE.ShipEngineAccountSettings>
Returns Promise<AxiosResponse<SE.ShipEngineAccountSettings, any>>
- Defined in javascript/src/account-settings/api.ts:31

updateImage

updateImage(__namedParameters: SE.UpdateAccountImage): Promise<AxiosResponse<void, any>>
The updateImage method updates specific image data for a given image id.
Parameters
- __namedParameters: SE.UpdateAccountImage
Returns Promise<AxiosResponse<void, any>>
- Defined in javascript/src/account-settings/api.ts:45

Generated using TypeDoc