Skip to content

Marketplace Offering Terms Of Service

Operations Summary

Method Endpoint Description
GET /api/marketplace-offering-terms-of-service/ List Terms of Service configurations
GET /api/marketplace-offering-terms-of-service/{uuid}/ Retrieve a Terms of Service configuration
POST /api/marketplace-offering-terms-of-service/ Create a Terms of Service configuration
PUT /api/marketplace-offering-terms-of-service/{uuid}/ Update a Terms of Service configuration
PATCH /api/marketplace-offering-terms-of-service/{uuid}/ Partially update a Terms of Service configuration
DELETE /api/marketplace-offering-terms-of-service/{uuid}/ Delete a Terms of Service configuration

List Terms of Service configurations

Returns a paginated list of Terms of Service configurations for offerings. Visibility depends on user permissions: staff/support see all; service providers see their own; regular users see ToS for offerings they have consented to or shared offerings.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-terms-of-service/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_terms_of_service import marketplace_offering_terms_of_service_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_terms_of_service_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_offering_terms_of_service_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceOfferingTermsOfServiceList } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingTermsOfServiceList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
is_active boolean Is active
o array Ordering
offering string Offering URL
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
requires_reconsent boolean Requires reconsent
version string Version

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
offering_uuid string (uuid)
offering_name string
terms_of_service string
terms_of_service_link string (uri)
version string
is_active boolean
requires_reconsent boolean If True, user will be asked to re-consent to the terms of service when the terms of service are updated.
grace_period_days integer Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True.
user_consent any
has_user_consent boolean
created string (date-time)
modified string (date-time)

Retrieve a Terms of Service configuration

Returns the details of a specific Terms of Service configuration.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-terms-of-service/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_terms_of_service import marketplace_offering_terms_of_service_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_terms_of_service_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_terms_of_service_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingTermsOfServiceRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingTermsOfServiceRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
offering_uuid string (uuid)
offering_name string
terms_of_service string
terms_of_service_link string (uri)
version string
is_active boolean
requires_reconsent boolean If True, user will be asked to re-consent to the terms of service when the terms of service are updated.
grace_period_days integer Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True.
user_consent any
has_user_consent boolean
created string (date-time)
modified string (date-time)

Create a Terms of Service configuration

Creates a new Terms of Service configuration for an offering. Only one active ToS configuration is allowed per offering.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-offering-terms-of-service/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_terms_of_service_create_request import OfferingTermsOfServiceCreateRequest # (1)
from waldur_api_client.api.marketplace_offering_terms_of_service import marketplace_offering_terms_of_service_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingTermsOfServiceCreateRequest(
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_offering_terms_of_service_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingTermsOfServiceCreateRequest
  2. API Source: marketplace_offering_terms_of_service_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingTermsOfServiceCreate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingTermsOfServiceCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
offering string (uri) ✓
terms_of_service string
terms_of_service_link string (uri)
version string
is_active boolean
requires_reconsent boolean If True, user will be asked to re-consent to the terms of service when the terms of service are updated.
grace_period_days integer Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True.

201 -

Field Type Description
offering string (uri)
terms_of_service string
terms_of_service_link string (uri)
version string
is_active boolean
requires_reconsent boolean If True, user will be asked to re-consent to the terms of service when the terms of service are updated.
grace_period_days integer Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True.

Update a Terms of Service configuration

Updates an existing Terms of Service configuration. Note that some fields like version and requires_reconsent are protected and cannot be changed after creation.

1
2
3
4
http \
  PUT \
  https://api.example.com/api/marketplace-offering-terms-of-service/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_terms_of_service_request import OfferingTermsOfServiceRequest # (1)
from waldur_api_client.api.marketplace_offering_terms_of_service import marketplace_offering_terms_of_service_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingTermsOfServiceRequest()
response = marketplace_offering_terms_of_service_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingTermsOfServiceRequest
  2. API Source: marketplace_offering_terms_of_service_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingTermsOfServiceUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingTermsOfServiceUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
terms_of_service string
terms_of_service_link string (uri)
is_active boolean
grace_period_days integer Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True.

200 -

Field Type Description
uuid string (uuid)
offering_uuid string (uuid)
offering_name string
terms_of_service string
terms_of_service_link string (uri)
version string
is_active boolean
requires_reconsent boolean If True, user will be asked to re-consent to the terms of service when the terms of service are updated.
grace_period_days integer Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True.
user_consent any
has_user_consent boolean
created string (date-time)
modified string (date-time)

Partially update a Terms of Service configuration

Partially updates an existing Terms of Service configuration.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-offering-terms-of-service/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_offering_terms_of_service_request import PatchedOfferingTermsOfServiceRequest # (1)
from waldur_api_client.api.marketplace_offering_terms_of_service import marketplace_offering_terms_of_service_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOfferingTermsOfServiceRequest()
response = marketplace_offering_terms_of_service_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOfferingTermsOfServiceRequest
  2. API Source: marketplace_offering_terms_of_service_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingTermsOfServicePartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingTermsOfServicePartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
terms_of_service string
terms_of_service_link string (uri)
is_active boolean
grace_period_days integer Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True.

200 -

Field Type Description
uuid string (uuid)
offering_uuid string (uuid)
offering_name string
terms_of_service string
terms_of_service_link string (uri)
version string
is_active boolean
requires_reconsent boolean If True, user will be asked to re-consent to the terms of service when the terms of service are updated.
grace_period_days integer Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True.
user_consent any
has_user_consent boolean
created string (date-time)
modified string (date-time)

Delete a Terms of Service configuration

Deletes a Terms of Service configuration. This is a hard delete and should be used with caution.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-offering-terms-of-service/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_terms_of_service import marketplace_offering_terms_of_service_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_terms_of_service_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_terms_of_service_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingTermsOfServiceDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingTermsOfServiceDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body