Skip to content

termsOfServiceUserStatuses.md

Latest commit

 

History

History
104 lines (70 loc) · 3.21 KB

termsOfServiceUserStatuses.md

File metadata and controls

104 lines (70 loc) · 3.21 KB

TermsOfServiceUserStatusesManager

List terms of service user statuses

Retrieves an overview of users and their status for a terms of service, including Whether they have accepted the terms and when.

This operation is performed by calling function getTermsOfServiceUserStatuses.

See the endpoint docs at API Reference.

await client.termsOfServiceUserStatuses.getTermsOfServiceUserStatuses({
  tosId: tos.id,
  userId: user.id,
} satisfies GetTermsOfServiceUserStatusesQueryParams);

Arguments

  • queryParams GetTermsOfServiceUserStatusesQueryParams
    • Query parameters of getTermsOfServiceUserStatuses method
  • optionalsInput GetTermsOfServiceUserStatusesOptionalsInput

Returns

This function returns a value of type TermsOfServiceUserStatuses.

Returns a list of terms of service statuses.

Create terms of service status for new user

Sets the status for a terms of service for a user.

This operation is performed by calling function createTermsOfServiceStatusForUser.

See the endpoint docs at API Reference.

await client.termsOfServiceUserStatuses.createTermsOfServiceStatusForUser({
  tos: new CreateTermsOfServiceStatusForUserRequestBodyTosField({ id: tos.id }),
  user: new CreateTermsOfServiceStatusForUserRequestBodyUserField({
    id: user.id,
  }),
  isAccepted: false,
} satisfies CreateTermsOfServiceStatusForUserRequestBody);

Arguments

  • requestBody CreateTermsOfServiceStatusForUserRequestBody
    • Request body of createTermsOfServiceStatusForUser method
  • optionalsInput CreateTermsOfServiceStatusForUserOptionalsInput

Returns

This function returns a value of type TermsOfServiceUserStatus.

Returns a terms of service status object.

Update terms of service status for existing user

Updates the status for a terms of service for a user.

This operation is performed by calling function updateTermsOfServiceStatusForUserById.

See the endpoint docs at API Reference.

await client.termsOfServiceUserStatuses.updateTermsOfServiceStatusForUserById(
  createdTosUserStatus.id,
  {
    isAccepted: true,
  } satisfies UpdateTermsOfServiceStatusForUserByIdRequestBody,
);

Arguments

  • termsOfServiceUserStatusId string
    • The ID of the terms of service status. Example: "324234"
  • requestBody UpdateTermsOfServiceStatusForUserByIdRequestBody
    • Request body of updateTermsOfServiceStatusForUserById method
  • optionalsInput UpdateTermsOfServiceStatusForUserByIdOptionalsInput

Returns

This function returns a value of type TermsOfServiceUserStatus.

Returns the updated terms of service status object.