MembershipService

Index

Constructors

• constructor

Properties

• httpRequest

Methods

• organizationInfo
• organizationUserActivate
• organizationUserCreate
• organizationUserDeactivate
• organizationUserInfo
• organizationUserList
• organizationUserRemove
• userOrganizationBatchCreate

Constructors

constructor

• new MembershipService(httpRequest: BaseHttpRequest): MembershipService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns MembershipService

Properties

publicreadonlyhttpRequest

httpRequest: BaseHttpRequest

Methods

publicorganizationInfo

• organizationInfo(): CancelablePromise<{ data?: GetOrganizationResponse }>

• Get organization information Retrieves information about the organization the user is in.

  @throws

  ApiError

  ---

  Returns CancelablePromise<{ data?: GetOrganizationResponse }>

  any OK

publicorganizationUserActivate

• organizationUserActivate(__namedParameters: { requestBody?: { user_id: string } }): CancelablePromise<void>

• Activate a user Bot-compatible Activates a user in an organization.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody?: { user_id: string } }

  Returns CancelablePromise<void>

  void

publicorganizationUserCreate

• organizationUserCreate(__namedParameters: { requestBody?: { language?: en | ko; msg?: string; tel?: string; timezone?: string; user_email: string; user_name: string } }): CancelablePromise<{ data?: { user?: GetOrganizationUserResponse } }>

• Create a user Creates a user in the organization.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody?: { language?: en | ko; msg?: string; tel?: string; timezone?: string; user_email: string; user_name: string } }

  Returns CancelablePromise<{ data?: { user?: GetOrganizationUserResponse } }>

  any Successfully created the user.

publicorganizationUserDeactivate

• organizationUserDeactivate(__namedParameters: { requestBody?: { user_id: string } }): CancelablePromise<void>

• Deactivate a user Bot-compatible Deactivates a user in the organization.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody?: { user_id: string } }

  Returns CancelablePromise<void>

  void

publicorganizationUserInfo

• organizationUserInfo(): CancelablePromise<{ data?: { user?: GetOrganizationUserResponse } }>

• Get user information Retrieves information of a user in the organization.

  @throws

  ApiError

  ---

  Returns CancelablePromise<{ data?: { user?: GetOrganizationUserResponse } }>

  any Successfully retrieved the user information.

publicorganizationUserList

• organizationUserList(__namedParameters: { cnt: number; filtersMembershipStatus?: active | inactive; keyword?: string; page?: number; teamId?: string; wsId?: string }): CancelablePromise<{ data?: { total_rows?: number; users?: GetOrganizationUserResponse[] } }>

• Get user list Bot-compatible Retrieves a list of users in the organization.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { cnt: number; filtersMembershipStatus?: active | inactive; keyword?: string; page?: number; teamId?: string; wsId?: string }

  Returns CancelablePromise<{ data?: { total_rows?: number; users?: GetOrganizationUserResponse[] } }>

  any Successfully retrieved the user list from the organization.

publicorganizationUserRemove

• organizationUserRemove(__namedParameters: { requestBody?: { user_id: string } }): CancelablePromise<{ data?: DelCompanyUserResponse }>

• Delete a user Bot-compatible Deletes a user from the organization.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody?: { user_id: string } }

  Returns CancelablePromise<{ data?: DelCompanyUserResponse }>

  any Successfully deleted the user.

publicuserOrganizationBatchCreate

• userOrganizationBatchCreate(__namedParameters: { requestBody: AddCompanyUserListParam }): CancelablePromise<any>

• @deprecated

  Create guest accounts Invites multiple users as guests to the organization.

  Calling this endpoint to create a user will not trigger an event notification for subscribers to the user creation event.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: AddCompanyUserListParam }

  Returns CancelablePromise<any>

  any Successfully created the guest accounts.