CustomFieldService

Index

Constructors

• constructor

Properties

• httpRequest

Methods

• customfieldAdd
• customfieldDelete
• customfieldList
• customfieldUpdate
• customfieldUserList
• customfieldUserUpdate

Constructors

constructor

• new CustomFieldService(httpRequest: BaseHttpRequest): CustomFieldService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns CustomFieldService

Properties

publicreadonlyhttpRequest

httpRequest: BaseHttpRequest

Methods

publiccustomfieldAdd

• customfieldAdd(__namedParameters: { requestBody: AddCustomFieldParam }): CancelablePromise<{ data?: AddCustomFieldResponse }>

• Add a custom field Bot-compatible Adds a new custom field for user profiles.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: AddCustomFieldParam }

  Returns CancelablePromise<{ data?: AddCustomFieldResponse }>

  any Successfully added the custom field.

publiccustomfieldDelete

• customfieldDelete(__namedParameters: { requestBody: DeleteCustomFieldParam }): CancelablePromise<{ data?: DeleteCustomFieldResponse }>

• Delete custom field Bot-compatible Deletes a custom field for user profiles.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: DeleteCustomFieldParam }

  Returns CancelablePromise<{ data?: DeleteCustomFieldResponse }>

  any Successfully deleted the custom field.

publiccustomfieldList

• customfieldList(): CancelablePromise<{ data?: GetCustomFieldListResponse }>

• List out custom fields Bot-compatible Lists out all registered custom fields.

  @throws

  ApiError

  ---

  Returns CancelablePromise<{ data?: GetCustomFieldListResponse }>

  any Successfully retrieved the custom fields.

publiccustomfieldUpdate

• customfieldUpdate(__namedParameters: { requestBody: UpdateCustomFieldParam }): CancelablePromise<{ data?: UpdateCustomFieldResponse }>

• Update a custom field Bot-compatible Updates an existing custom field.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: UpdateCustomFieldParam }

  Returns CancelablePromise<{ data?: UpdateCustomFieldResponse }>

  any Successfully updated the custom field.

publiccustomfieldUserList

• customfieldUserList(__namedParameters: { userId: string }): CancelablePromise<{ data?: GetUserCustomFieldListResponse }>

• List out a user's custom fields in use Bot-compatible Retrieves the custom fields and their values used in a given user's profile.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { userId: string }

  Returns CancelablePromise<{ data?: GetUserCustomFieldListResponse }>

  any Successfully retrieved the user's custom field data.

publiccustomfieldUserUpdate

• customfieldUserUpdate(__namedParameters: { requestBody: UpdateUserCustomFieldParam }): CancelablePromise<{ data?: UpdateUserCustomFieldResponse }>

• Update a user's custom field data Bot-compatible Updates the values of the custom fields used in a given user's profile.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: UpdateUserCustomFieldParam }

  Returns CancelablePromise<{ data?: UpdateUserCustomFieldResponse }>

  any Successfully updated the user's custom field data.