Function ProfileAvatarsApiFactory

ProfileAvatarsApi - factory interface export

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

  • Parameters

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

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

    • profileAvatarUpload:function
      • profileAvatarUpload(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