1065 lines
44 KiB
Python
1065 lines
44 KiB
Python
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
|
|
|
|
from .basesdk import BaseSDK
|
|
from autumn_sdk import errors, models, utils
|
|
from autumn_sdk._hooks import HookContext
|
|
from autumn_sdk.types import OptionalNullable, UNSET
|
|
from autumn_sdk.utils.unmarshal_json_response import unmarshal_json_response
|
|
from typing import List, Mapping, Optional, Union
|
|
|
|
|
|
class Entities(BaseSDK):
|
|
def create(
|
|
self,
|
|
*,
|
|
feature_id: str,
|
|
customer_id: str,
|
|
entity_id: str,
|
|
name: OptionalNullable[str] = UNSET,
|
|
billing_controls: Optional[
|
|
Union[
|
|
models.CreateEntityBillingControlsRequest,
|
|
models.CreateEntityBillingControlsRequestTypedDict,
|
|
]
|
|
] = None,
|
|
customer_data: Optional[
|
|
Union[models.CustomerData, models.CustomerDataTypedDict]
|
|
] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> models.CreateEntityResponse:
|
|
r"""Creates an entity for a customer and feature, then returns the entity with balances and subscriptions.
|
|
|
|
Use entities when usage and access must be scoped to sub-resources (for example seats, projects, or workspaces) instead of only the customer.
|
|
|
|
:param feature_id: The ID of the feature this entity is associated with
|
|
:param customer_id: The ID of the customer to create the entity for.
|
|
:param entity_id: The ID of the entity.
|
|
:param name: The name of the entity
|
|
:param billing_controls: Billing controls for the entity.
|
|
:param customer_data: Customer details to set when creating a customer
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = models.CreateEntityParams(
|
|
name=name,
|
|
feature_id=feature_id,
|
|
billing_controls=utils.get_pydantic_model(
|
|
billing_controls, Optional[models.CreateEntityBillingControlsRequest]
|
|
),
|
|
customer_data=utils.get_pydantic_model(
|
|
customer_data, Optional[models.CustomerData]
|
|
),
|
|
customer_id=customer_id,
|
|
entity_id=entity_id,
|
|
)
|
|
|
|
req = self._build_request(
|
|
method="POST",
|
|
path="/v1/entities.create",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=True,
|
|
request_has_path_params=False,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=models.CreateEntityGlobals(
|
|
x_api_version=self.sdk_configuration.globals.x_api_version,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
get_serialized_body=lambda: utils.serialize_request_body(
|
|
request, False, False, "json", models.CreateEntityParams
|
|
),
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["429", "500", "502", "503", "504"])
|
|
|
|
http_res = self.do_request(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="createEntity",
|
|
oauth2_scopes=None,
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(models.CreateEntityResponse, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.AutumnDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.AutumnDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.AutumnDefaultError("Unexpected response received", http_res)
|
|
|
|
async def create_async(
|
|
self,
|
|
*,
|
|
feature_id: str,
|
|
customer_id: str,
|
|
entity_id: str,
|
|
name: OptionalNullable[str] = UNSET,
|
|
billing_controls: Optional[
|
|
Union[
|
|
models.CreateEntityBillingControlsRequest,
|
|
models.CreateEntityBillingControlsRequestTypedDict,
|
|
]
|
|
] = None,
|
|
customer_data: Optional[
|
|
Union[models.CustomerData, models.CustomerDataTypedDict]
|
|
] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> models.CreateEntityResponse:
|
|
r"""Creates an entity for a customer and feature, then returns the entity with balances and subscriptions.
|
|
|
|
Use entities when usage and access must be scoped to sub-resources (for example seats, projects, or workspaces) instead of only the customer.
|
|
|
|
:param feature_id: The ID of the feature this entity is associated with
|
|
:param customer_id: The ID of the customer to create the entity for.
|
|
:param entity_id: The ID of the entity.
|
|
:param name: The name of the entity
|
|
:param billing_controls: Billing controls for the entity.
|
|
:param customer_data: Customer details to set when creating a customer
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = models.CreateEntityParams(
|
|
name=name,
|
|
feature_id=feature_id,
|
|
billing_controls=utils.get_pydantic_model(
|
|
billing_controls, Optional[models.CreateEntityBillingControlsRequest]
|
|
),
|
|
customer_data=utils.get_pydantic_model(
|
|
customer_data, Optional[models.CustomerData]
|
|
),
|
|
customer_id=customer_id,
|
|
entity_id=entity_id,
|
|
)
|
|
|
|
req = self._build_request_async(
|
|
method="POST",
|
|
path="/v1/entities.create",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=True,
|
|
request_has_path_params=False,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=models.CreateEntityGlobals(
|
|
x_api_version=self.sdk_configuration.globals.x_api_version,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
get_serialized_body=lambda: utils.serialize_request_body(
|
|
request, False, False, "json", models.CreateEntityParams
|
|
),
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["429", "500", "502", "503", "504"])
|
|
|
|
http_res = await self.do_request_async(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="createEntity",
|
|
oauth2_scopes=None,
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(models.CreateEntityResponse, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.AutumnDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.AutumnDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.AutumnDefaultError("Unexpected response received", http_res)
|
|
|
|
def get(
|
|
self,
|
|
*,
|
|
entity_id: str,
|
|
customer_id: Optional[str] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> models.GetEntityResponse:
|
|
r"""Fetches an entity by its ID.
|
|
|
|
Use this to read one entity's current state. Pass customerId when you want to scope the lookup to a specific customer.
|
|
|
|
:param entity_id: The ID of the entity.
|
|
:param customer_id: The ID of the customer to create the entity for.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = models.GetEntityParams(
|
|
customer_id=customer_id,
|
|
entity_id=entity_id,
|
|
)
|
|
|
|
req = self._build_request(
|
|
method="POST",
|
|
path="/v1/entities.get",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=True,
|
|
request_has_path_params=False,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=models.GetEntityGlobals(
|
|
x_api_version=self.sdk_configuration.globals.x_api_version,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
get_serialized_body=lambda: utils.serialize_request_body(
|
|
request, False, False, "json", models.GetEntityParams
|
|
),
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["429", "500", "502", "503", "504"])
|
|
|
|
http_res = self.do_request(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="getEntity",
|
|
oauth2_scopes=None,
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(models.GetEntityResponse, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.AutumnDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.AutumnDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.AutumnDefaultError("Unexpected response received", http_res)
|
|
|
|
async def get_async(
|
|
self,
|
|
*,
|
|
entity_id: str,
|
|
customer_id: Optional[str] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> models.GetEntityResponse:
|
|
r"""Fetches an entity by its ID.
|
|
|
|
Use this to read one entity's current state. Pass customerId when you want to scope the lookup to a specific customer.
|
|
|
|
:param entity_id: The ID of the entity.
|
|
:param customer_id: The ID of the customer to create the entity for.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = models.GetEntityParams(
|
|
customer_id=customer_id,
|
|
entity_id=entity_id,
|
|
)
|
|
|
|
req = self._build_request_async(
|
|
method="POST",
|
|
path="/v1/entities.get",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=True,
|
|
request_has_path_params=False,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=models.GetEntityGlobals(
|
|
x_api_version=self.sdk_configuration.globals.x_api_version,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
get_serialized_body=lambda: utils.serialize_request_body(
|
|
request, False, False, "json", models.GetEntityParams
|
|
),
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["429", "500", "502", "503", "504"])
|
|
|
|
http_res = await self.do_request_async(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="getEntity",
|
|
oauth2_scopes=None,
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(models.GetEntityResponse, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.AutumnDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.AutumnDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.AutumnDefaultError("Unexpected response received", http_res)
|
|
|
|
def list(
|
|
self,
|
|
*,
|
|
start_cursor: Optional[str] = "",
|
|
limit: Optional[int] = 50,
|
|
plans: Optional[
|
|
Union[List[models.ListEntitiesPlan], List[models.ListEntitiesPlanTypedDict]]
|
|
] = None,
|
|
subscription_status: Optional[models.ListEntitiesSubscriptionStatus] = None,
|
|
search: Optional[str] = None,
|
|
processors: Optional[List[models.ListEntitiesProcessor]] = None,
|
|
customer_id: Optional[str] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> models.ListEntitiesResponse:
|
|
r"""Lists entities across the organization with pagination and optional filters.
|
|
|
|
Use this to page through entities globally, including filtering by plans inherited from parent customers or attached directly to entities.
|
|
|
|
:param start_cursor: Opaque pagination cursor. Empty string (default) requests the first page; use next_cursor from a prior response for subsequent pages.
|
|
:param limit: Number of items to return. Default 50, hard ceiling 5000.
|
|
:param plans: Filter by plan ID and version. Returns entities with active subscriptions to this plan, including plans inherited from the parent customer.
|
|
:param subscription_status: Filter customer products used for entity hydration and plan matching. Defaults to active and scheduled.
|
|
:param search: Search entities by id or name.
|
|
:param processors: Filter by parent customer processor type (stripe, revenuecat, vercel).
|
|
:param customer_id: Restrict the response to entities owned by this customer id. Use to bulk-fetch all entities for one customer in a single paginated call instead of iterating entities.get.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = models.ListEntitiesParams(
|
|
start_cursor=start_cursor,
|
|
limit=limit,
|
|
plans=utils.get_pydantic_model(
|
|
plans, Optional[List[models.ListEntitiesPlan]]
|
|
),
|
|
subscription_status=subscription_status,
|
|
search=search,
|
|
processors=processors,
|
|
customer_id=customer_id,
|
|
)
|
|
|
|
req = self._build_request(
|
|
method="POST",
|
|
path="/v1/entities.list",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=True,
|
|
request_has_path_params=False,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=models.ListEntitiesGlobals(
|
|
x_api_version=self.sdk_configuration.globals.x_api_version,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
get_serialized_body=lambda: utils.serialize_request_body(
|
|
request, False, False, "json", models.ListEntitiesParams
|
|
),
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["429", "500", "502", "503", "504"])
|
|
|
|
http_res = self.do_request(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="listEntities",
|
|
oauth2_scopes=None,
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(models.ListEntitiesResponse, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.AutumnDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.AutumnDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.AutumnDefaultError("Unexpected response received", http_res)
|
|
|
|
async def list_async(
|
|
self,
|
|
*,
|
|
start_cursor: Optional[str] = "",
|
|
limit: Optional[int] = 50,
|
|
plans: Optional[
|
|
Union[List[models.ListEntitiesPlan], List[models.ListEntitiesPlanTypedDict]]
|
|
] = None,
|
|
subscription_status: Optional[models.ListEntitiesSubscriptionStatus] = None,
|
|
search: Optional[str] = None,
|
|
processors: Optional[List[models.ListEntitiesProcessor]] = None,
|
|
customer_id: Optional[str] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> models.ListEntitiesResponse:
|
|
r"""Lists entities across the organization with pagination and optional filters.
|
|
|
|
Use this to page through entities globally, including filtering by plans inherited from parent customers or attached directly to entities.
|
|
|
|
:param start_cursor: Opaque pagination cursor. Empty string (default) requests the first page; use next_cursor from a prior response for subsequent pages.
|
|
:param limit: Number of items to return. Default 50, hard ceiling 5000.
|
|
:param plans: Filter by plan ID and version. Returns entities with active subscriptions to this plan, including plans inherited from the parent customer.
|
|
:param subscription_status: Filter customer products used for entity hydration and plan matching. Defaults to active and scheduled.
|
|
:param search: Search entities by id or name.
|
|
:param processors: Filter by parent customer processor type (stripe, revenuecat, vercel).
|
|
:param customer_id: Restrict the response to entities owned by this customer id. Use to bulk-fetch all entities for one customer in a single paginated call instead of iterating entities.get.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = models.ListEntitiesParams(
|
|
start_cursor=start_cursor,
|
|
limit=limit,
|
|
plans=utils.get_pydantic_model(
|
|
plans, Optional[List[models.ListEntitiesPlan]]
|
|
),
|
|
subscription_status=subscription_status,
|
|
search=search,
|
|
processors=processors,
|
|
customer_id=customer_id,
|
|
)
|
|
|
|
req = self._build_request_async(
|
|
method="POST",
|
|
path="/v1/entities.list",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=True,
|
|
request_has_path_params=False,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=models.ListEntitiesGlobals(
|
|
x_api_version=self.sdk_configuration.globals.x_api_version,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
get_serialized_body=lambda: utils.serialize_request_body(
|
|
request, False, False, "json", models.ListEntitiesParams
|
|
),
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["429", "500", "502", "503", "504"])
|
|
|
|
http_res = await self.do_request_async(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="listEntities",
|
|
oauth2_scopes=None,
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(models.ListEntitiesResponse, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.AutumnDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.AutumnDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.AutumnDefaultError("Unexpected response received", http_res)
|
|
|
|
def update(
|
|
self,
|
|
*,
|
|
entity_id: str,
|
|
customer_id: Optional[str] = None,
|
|
billing_controls: Optional[
|
|
Union[
|
|
models.UpdateEntityBillingControlsRequest,
|
|
models.UpdateEntityBillingControlsRequestTypedDict,
|
|
]
|
|
] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> models.UpdateEntityResponse:
|
|
r"""Updates an existing entity and returns the refreshed entity object.
|
|
|
|
Use this to change entity billing controls or other mutable entity fields after the entity has already been created.
|
|
|
|
:param entity_id: The ID of the entity.
|
|
:param customer_id: The ID of the customer that owns the entity.
|
|
:param billing_controls: Billing controls to replace on the entity.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = models.UpdateEntityParams(
|
|
customer_id=customer_id,
|
|
entity_id=entity_id,
|
|
billing_controls=utils.get_pydantic_model(
|
|
billing_controls, Optional[models.UpdateEntityBillingControlsRequest]
|
|
),
|
|
)
|
|
|
|
req = self._build_request(
|
|
method="POST",
|
|
path="/v1/entities.update",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=True,
|
|
request_has_path_params=False,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=models.UpdateEntityGlobals(
|
|
x_api_version=self.sdk_configuration.globals.x_api_version,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
get_serialized_body=lambda: utils.serialize_request_body(
|
|
request, False, False, "json", models.UpdateEntityParams
|
|
),
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["429", "500", "502", "503", "504"])
|
|
|
|
http_res = self.do_request(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="updateEntity",
|
|
oauth2_scopes=None,
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(models.UpdateEntityResponse, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.AutumnDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.AutumnDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.AutumnDefaultError("Unexpected response received", http_res)
|
|
|
|
async def update_async(
|
|
self,
|
|
*,
|
|
entity_id: str,
|
|
customer_id: Optional[str] = None,
|
|
billing_controls: Optional[
|
|
Union[
|
|
models.UpdateEntityBillingControlsRequest,
|
|
models.UpdateEntityBillingControlsRequestTypedDict,
|
|
]
|
|
] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> models.UpdateEntityResponse:
|
|
r"""Updates an existing entity and returns the refreshed entity object.
|
|
|
|
Use this to change entity billing controls or other mutable entity fields after the entity has already been created.
|
|
|
|
:param entity_id: The ID of the entity.
|
|
:param customer_id: The ID of the customer that owns the entity.
|
|
:param billing_controls: Billing controls to replace on the entity.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = models.UpdateEntityParams(
|
|
customer_id=customer_id,
|
|
entity_id=entity_id,
|
|
billing_controls=utils.get_pydantic_model(
|
|
billing_controls, Optional[models.UpdateEntityBillingControlsRequest]
|
|
),
|
|
)
|
|
|
|
req = self._build_request_async(
|
|
method="POST",
|
|
path="/v1/entities.update",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=True,
|
|
request_has_path_params=False,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=models.UpdateEntityGlobals(
|
|
x_api_version=self.sdk_configuration.globals.x_api_version,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
get_serialized_body=lambda: utils.serialize_request_body(
|
|
request, False, False, "json", models.UpdateEntityParams
|
|
),
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["429", "500", "502", "503", "504"])
|
|
|
|
http_res = await self.do_request_async(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="updateEntity",
|
|
oauth2_scopes=None,
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(models.UpdateEntityResponse, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.AutumnDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.AutumnDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.AutumnDefaultError("Unexpected response received", http_res)
|
|
|
|
def delete(
|
|
self,
|
|
*,
|
|
entity_id: str,
|
|
customer_id: Optional[str] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> models.DeleteEntityResponse:
|
|
r"""Deletes an entity by entity ID.
|
|
|
|
Use this when the underlying resource is removed and you no longer want entity-scoped balances or subscriptions tracked for it.
|
|
|
|
:param entity_id: The ID of the entity.
|
|
:param customer_id: The ID of the customer.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = models.DeleteEntityParams(
|
|
customer_id=customer_id,
|
|
entity_id=entity_id,
|
|
)
|
|
|
|
req = self._build_request(
|
|
method="POST",
|
|
path="/v1/entities.delete",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=True,
|
|
request_has_path_params=False,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=models.DeleteEntityGlobals(
|
|
x_api_version=self.sdk_configuration.globals.x_api_version,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
get_serialized_body=lambda: utils.serialize_request_body(
|
|
request, False, False, "json", models.DeleteEntityParams
|
|
),
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["429", "500", "502", "503", "504"])
|
|
|
|
http_res = self.do_request(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="deleteEntity",
|
|
oauth2_scopes=None,
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(models.DeleteEntityResponse, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.AutumnDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = utils.stream_to_text(http_res)
|
|
raise errors.AutumnDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.AutumnDefaultError("Unexpected response received", http_res)
|
|
|
|
async def delete_async(
|
|
self,
|
|
*,
|
|
entity_id: str,
|
|
customer_id: Optional[str] = None,
|
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
|
server_url: Optional[str] = None,
|
|
timeout_ms: Optional[int] = None,
|
|
http_headers: Optional[Mapping[str, str]] = None,
|
|
) -> models.DeleteEntityResponse:
|
|
r"""Deletes an entity by entity ID.
|
|
|
|
Use this when the underlying resource is removed and you no longer want entity-scoped balances or subscriptions tracked for it.
|
|
|
|
:param entity_id: The ID of the entity.
|
|
:param customer_id: The ID of the customer.
|
|
:param retries: Override the default retry configuration for this method
|
|
:param server_url: Override the default server URL for this method
|
|
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
|
:param http_headers: Additional headers to set or replace on requests.
|
|
"""
|
|
base_url = None
|
|
url_variables = None
|
|
if timeout_ms is None:
|
|
timeout_ms = self.sdk_configuration.timeout_ms
|
|
|
|
if server_url is not None:
|
|
base_url = server_url
|
|
else:
|
|
base_url = self._get_url(base_url, url_variables)
|
|
|
|
request = models.DeleteEntityParams(
|
|
customer_id=customer_id,
|
|
entity_id=entity_id,
|
|
)
|
|
|
|
req = self._build_request_async(
|
|
method="POST",
|
|
path="/v1/entities.delete",
|
|
base_url=base_url,
|
|
url_variables=url_variables,
|
|
request=request,
|
|
request_body_required=True,
|
|
request_has_path_params=False,
|
|
request_has_query_params=True,
|
|
user_agent_header="user-agent",
|
|
accept_header_value="application/json",
|
|
http_headers=http_headers,
|
|
_globals=models.DeleteEntityGlobals(
|
|
x_api_version=self.sdk_configuration.globals.x_api_version,
|
|
),
|
|
security=self.sdk_configuration.security,
|
|
get_serialized_body=lambda: utils.serialize_request_body(
|
|
request, False, False, "json", models.DeleteEntityParams
|
|
),
|
|
allow_empty_value=None,
|
|
timeout_ms=timeout_ms,
|
|
)
|
|
|
|
if retries == UNSET:
|
|
if self.sdk_configuration.retry_config is not UNSET:
|
|
retries = self.sdk_configuration.retry_config
|
|
|
|
retry_config = None
|
|
if isinstance(retries, utils.RetryConfig):
|
|
retry_config = (retries, ["429", "500", "502", "503", "504"])
|
|
|
|
http_res = await self.do_request_async(
|
|
hook_ctx=HookContext(
|
|
config=self.sdk_configuration,
|
|
base_url=base_url or "",
|
|
operation_id="deleteEntity",
|
|
oauth2_scopes=None,
|
|
security_source=self.sdk_configuration.security,
|
|
),
|
|
request=req,
|
|
is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
|
|
retry_config=retry_config,
|
|
)
|
|
|
|
if utils.match_response(http_res, "200", "application/json"):
|
|
return unmarshal_json_response(models.DeleteEntityResponse, http_res)
|
|
if utils.match_response(http_res, "4XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.AutumnDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
if utils.match_response(http_res, "5XX", "*"):
|
|
http_res_text = await utils.stream_to_text_async(http_res)
|
|
raise errors.AutumnDefaultError(
|
|
"API error occurred", http_res, http_res_text
|
|
)
|
|
|
|
raise errors.AutumnDefaultError("Unexpected response received", http_res)
|