Function AvatarsApiAxiosParamCreator

AvatarsApi - axios parameter creator export

  • AvatarsApiAxiosParamCreator(configuration?): {
        avatarGet: ((id: string, avatarType?: AvatarTypeEnum, initials?: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        avatarUpload: ((id: string, avatarType?: AvatarTypeEnum, userId?: string, file?: File, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

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

    • avatarGet: ((id: string, avatarType?: AvatarTypeEnum, initials?: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Retrieve a avatar by id and avatartype

      Throws

        • (id, avatarType?, initials?, userId?, options?): Promise<RequestArgs>

        • 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<RequestArgs>

    • avatarUpload: ((id: string, avatarType?: AvatarTypeEnum, userId?: string, file?: File, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Upload avatar profile image via file

      Throws

        • (id, avatarType?, userId?, file?, options?): Promise<RequestArgs>

        • 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<RequestArgs>

Settings

Member Visibility