UserService

Index

Constructors

• constructor

Properties

• httpRequest

Methods

• presenceStatusUpdate
• presenceSyncInfo
• presenceSyncUpdate
• userInfo
• userInfoUpdate

Constructors

constructor

• new UserService(httpRequest: BaseHttpRequest): UserService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns UserService

Properties

publicreadonlyhttpRequest

httpRequest: BaseHttpRequest

Methods

publicpresenceStatusUpdate

• presenceStatusUpdate(__namedParameters: { requestBody?: { do_not_disturb_duration?: string; mode?: on | do_not_disturb | absence } }): CancelablePromise<{ do_not_disturb_duration?: string; do_not_disturb_started_at?: string; is_online?: boolean; mode?: on | do_not_disturb | absence; user_id?: string }>

• Update the user presence Updates the authorizing user's presence status.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody?: { do_not_disturb_duration?: string; mode?: on | do_not_disturb | absence } }

  Returns CancelablePromise<{ do_not_disturb_duration?: string; do_not_disturb_started_at?: string; is_online?: boolean; mode?: on | do_not_disturb | absence; user_id?: string }>

  any Successfully updated the user's presence status.

publicpresenceSyncInfo

• presenceSyncInfo(): CancelablePromise<{ data?: UserPresenceSyncStatusResponse }>

• Get the user's presence sync setting Whether or not a /api/presence.status.update request can update the user's presence sync setting for your app. In UI, users can view or change this setting in User Settings > Connected apps.

  @throws

  ApiError

  ---

  Returns CancelablePromise<{ data?: UserPresenceSyncStatusResponse }>

  any Successfully retrieved the presence sync setting of the user.

publicpresenceSyncUpdate

• presenceSyncUpdate(__namedParameters: { requestBody?: { is_presence_sync_on?: boolean } }): CancelablePromise<{ data?: UserPresenceSyncStatusResponse }>

• Toggle presence sync Set whether to allow your app to update the authorizing user's presence status via API.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody?: { is_presence_sync_on?: boolean } }

  Returns CancelablePromise<{ data?: UserPresenceSyncStatusResponse }>

  any Successfully updated the presence sync setting of the app.

publicuserInfo

• userInfo(): CancelablePromise<{ data?: GetUserInfoResponse }>

• Get user information Retrieves the authorizing user's basic account information.

  @throws

  ApiError

  ---

  Returns CancelablePromise<{ data?: GetUserInfoResponse }>

  any Successfully retrieved the user's account information.

publicuserInfoUpdate

• userInfoUpdate(__namedParameters: { requestBody?: { department?: string; is_update_all_profile?: boolean; msg?: string; tel?: string; update_fields?: string[]; user_name?: string } }): CancelablePromise<{ data?: GetUserInfoResponse }>

• Update the user's profile Updates the authorizing user's profile.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody?: { department?: string; is_update_all_profile?: boolean; msg?: string; tel?: string; update_fields?: string[]; user_name?: string } }

  Returns CancelablePromise<{ data?: GetUserInfoResponse }>

  any Successfully updated the user profile.