Class AvatarsApi

AvatarsApi - object-oriented interface export AvatarsApi

Hierarchy (view full)

BaseAPI
- AvatarsApi

Index

Constructors

Properties

axios basePath configuration

Methods

avatarGet avatarUpload

Constructors

constructor

new AvatarsApi(configuration?, basePath?, axios?): AvatarsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns AvatarsApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

avatarGet

avatarGet(id, avatarType?, initials?, userId?, options?): Promise<AxiosResponse<void, any>>
summary Retrieve a avatar by id and avatartype
Parameters
- id: string
  The id of the record you wish to retrieve
- OptionalavatarType: AvatarTypeEnum
  avatar type contact simpleContarct paymentCycle profile
- Optionalinitials: string
- OptionaluserId: string
  The user id to operate on their behalf (tenants only)
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof AvatarsApi
- Defined in src/api/api.ts:15425

avatarUpload

avatarUpload(id, avatarType?, userId?, file?, options?): Promise<AxiosResponse<void, any>>
summary Upload avatar profile image via file
Parameters
- id: string
  The id of the record you wish to retrieve
- OptionalavatarType: AvatarTypeEnum
  avatar type contact simpleContarct paymentCycle profile
- OptionaluserId: string
  The user id to operate on their behalf (tenants only)
- Optionalfile: File
  avatar image
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof AvatarsApi
- Defined in src/api/api.ts:15440