Skip to content

termsOfServices.md

Latest commit

 

History

History
125 lines (81 loc) · 3.29 KB

termsOfServices.md

File metadata and controls

125 lines (81 loc) · 3.29 KB

TermsOfServicesManager

List terms of services

Returns the current terms of service text and settings for the enterprise.

This operation is performed by calling function getTermsOfService.

See the endpoint docs at API Reference.

await client.termsOfServices.getTermsOfService();

Arguments

  • queryParams GetTermsOfServiceQueryParams
    • Query parameters of getTermsOfService method
  • headersInput GetTermsOfServiceHeadersInput
    • Headers of getTermsOfService method
  • cancellationToken undefined | CancellationToken
    • Token used for request cancellation.

Returns

This function returns a value of type TermsOfServices.

Returns a collection of terms of service text and settings for the enterprise.

Create terms of service

Creates a terms of service for a given enterprise and type of user.

This operation is performed by calling function createTermsOfService.

See the endpoint docs at API Reference.

await client.termsOfServices.createTermsOfService({
  status: 'disabled' as CreateTermsOfServiceRequestBodyStatusField,
  tosType: 'managed' as CreateTermsOfServiceRequestBodyTosTypeField,
  text: 'Test TOS',
} satisfies CreateTermsOfServiceRequestBody);

Arguments

  • requestBody CreateTermsOfServiceRequestBody
    • Request body of createTermsOfService method
  • optionalsInput CreateTermsOfServiceOptionalsInput

Returns

This function returns a value of type TermsOfService.

Returns a new task object.

Get terms of service

Fetches a specific terms of service.

This operation is performed by calling function getTermsOfServiceById.

See the endpoint docs at API Reference.

Currently we don't have an example for calling getTermsOfServiceById in integration tests

Arguments

  • termsOfServiceId string
    • The ID of the terms of service. Example: "324234"
  • optionalsInput GetTermsOfServiceByIdOptionalsInput

Returns

This function returns a value of type TermsOfService.

Returns a terms of service object.

Update terms of service

Updates a specific terms of service.

This operation is performed by calling function updateTermsOfServiceById.

See the endpoint docs at API Reference.

await client.termsOfServices.updateTermsOfServiceById(tos.id, {
  status: 'disabled' as UpdateTermsOfServiceByIdRequestBodyStatusField,
  text: 'TOS',
} satisfies UpdateTermsOfServiceByIdRequestBody);

Arguments

  • termsOfServiceId string
    • The ID of the terms of service. Example: "324234"
  • requestBody UpdateTermsOfServiceByIdRequestBody
    • Request body of updateTermsOfServiceById method
  • optionalsInput UpdateTermsOfServiceByIdOptionalsInput

Returns

This function returns a value of type TermsOfService.

Returns an updated terms of service object.