Function AvatarsApiFactory

AvatarsApi - factory interface export

  • AvatarsApiFactory(configuration?, basePath?, axios?): {
        avatarGet(id: string, avatarType?: AvatarTypeEnum, initials?: string, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        avatarUpload(id: string, avatarType?: AvatarTypeEnum, userId?: string, file?: File, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

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

    • avatarGet:function
      • avatarGet(id, avatarType?, initials?, userId?, options?): AxiosPromise<void>

      • 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 AxiosPromise<void>

        Throws

    • avatarUpload:function
      • avatarUpload(id, avatarType?, userId?, file?, options?): AxiosPromise<void>

      • 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 AxiosPromise<void>

        Throws

Settings

Member Visibility