Skip to content

TermsOfServiceUserStatuses.md

Latest commit

 

History

History
98 lines (59 loc) · 3.32 KB

TermsOfServiceUserStatuses.md

File metadata and controls

98 lines (59 loc) · 3.32 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.

try await client.termsOfServiceUserStatuses.getTermsOfServiceUserStatuses(queryParams: GetTermsOfServiceUserStatusesQueryParams(tosId: tos.id, userId: user.id))

Arguments

  • queryParams GetTermsOfServiceUserStatusesQueryParams
    • Query parameters of getTermsOfServiceUserStatuses method
  • headers GetTermsOfServiceUserStatusesHeaders
    • Headers of getTermsOfServiceUserStatuses method

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.

try await client.termsOfServiceUserStatuses.createTermsOfServiceStatusForUser(requestBody: CreateTermsOfServiceStatusForUserRequestBody(tos: CreateTermsOfServiceStatusForUserRequestBodyTosField(id: tos.id), user: CreateTermsOfServiceStatusForUserRequestBodyUserField(id: user.id), isAccepted: false))

Arguments

  • requestBody CreateTermsOfServiceStatusForUserRequestBody
    • Request body of createTermsOfServiceStatusForUser method
  • headers CreateTermsOfServiceStatusForUserHeaders
    • Headers of createTermsOfServiceStatusForUser method

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.

try await client.termsOfServiceUserStatuses.updateTermsOfServiceStatusForUserById(termsOfServiceUserStatusId: createdTosUserStatus.id, requestBody: UpdateTermsOfServiceStatusForUserByIdRequestBody(isAccepted: true))

Arguments

  • termsOfServiceUserStatusId String
    • The ID of the terms of service status. Example: "324234"
  • requestBody UpdateTermsOfServiceStatusForUserByIdRequestBody
    • Request body of updateTermsOfServiceStatusForUserById method
  • headers UpdateTermsOfServiceStatusForUserByIdHeaders
    • Headers of updateTermsOfServiceStatusForUserById method

Returns

This function returns a value of type TermsOfServiceUserStatus.

Returns the updated terms of service status object.