AvatarsApi - functional programming interface export

  • Parameters

    Returns {
        avatarGet(id: string, avatarType?: AvatarTypeEnum, initials?: string, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        avatarUpload(id: string, avatarType?: AvatarTypeEnum, userId?: string, file?: File, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    }

    • avatarGet:function
      • 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<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • avatarUpload:function
      • 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<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>