abusezero 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- abusezero/__init__.py +5 -0
- abusezero/client.py +1469 -0
- abusezero/core.py +375 -0
- abusezero/models.py +1064 -0
- abusezero/operations.json +20373 -0
- abusezero/py.typed +0 -0
- abusezero-0.1.0.dist-info/METADATA +158 -0
- abusezero-0.1.0.dist-info/RECORD +10 -0
- abusezero-0.1.0.dist-info/WHEEL +4 -0
- abusezero-0.1.0.dist-info/licenses/LICENSE +279 -0
abusezero/models.py
ADDED
|
@@ -0,0 +1,1064 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
from typing import Any, TypedDict, Required, NotRequired, Literal
|
|
3
|
+
from .core import AbuseZeroError
|
|
4
|
+
|
|
5
|
+
PublicPricingResponsePlansItemPricesMonthVariant0 = TypedDict("PublicPricingResponsePlansItemPricesMonthVariant0", {"amount_cents": Required[int], "credits": Required[int]}, total=False)
|
|
6
|
+
|
|
7
|
+
PublicPricingResponsePlansItemPricesYearVariant0 = TypedDict("PublicPricingResponsePlansItemPricesYearVariant0", {"amount_cents": Required[int], "credits": Required[int]}, total=False)
|
|
8
|
+
|
|
9
|
+
PublicPricingResponsePlansItemPrices = TypedDict("PublicPricingResponsePlansItemPrices", {"month": Required[PublicPricingResponsePlansItemPricesMonthVariant0 | None], "year": Required[PublicPricingResponsePlansItemPricesYearVariant0 | None]}, total=False)
|
|
10
|
+
|
|
11
|
+
PublicPricingResponsePlansItemIncludesTraffic = TypedDict("PublicPricingResponsePlansItemIncludesTraffic", {"rate_per_second": Required[int], "burst": Required[int], "concurrency": Required[int]}, total=False)
|
|
12
|
+
|
|
13
|
+
PublicPricingResponsePlansItemIncludes = TypedDict("PublicPricingResponsePlansItemIncludes", {"protected_benefits": Required[int], "team_seats": Required[int], "data_retention_days": Required[int], "traffic": Required[PublicPricingResponsePlansItemIncludesTraffic]}, total=False)
|
|
14
|
+
|
|
15
|
+
PublicPricingResponsePlansItem = TypedDict("PublicPricingResponsePlansItem", {"object": Required[Literal["plan"]], "plan": Required[Literal["payg", "pro", "scale"]], "name": Required[str], "prices": Required[PublicPricingResponsePlansItemPrices], "includes": Required[PublicPricingResponsePlansItemIncludes]}, total=False)
|
|
16
|
+
|
|
17
|
+
PublicPricingResponseCreditPacks = TypedDict("PublicPricingResponseCreditPacks", {"credits_per_dollar": Required[int], "amounts": Required[list[int]], "custom_amount_step": Required[int], "custom_amount_max": Required[int], "first_purchase_multiplier": Required[int]}, total=False)
|
|
18
|
+
|
|
19
|
+
PublicPricingResponseYearly = TypedDict("PublicPricingResponseYearly", {"rollover_percent": Required[int], "converted_credit_expiry_months": Required[int]}, total=False)
|
|
20
|
+
|
|
21
|
+
PublicPricingResponseEveryPlan = TypedDict("PublicPricingResponseEveryPlan", {"custom_policies": Required[int], "webhook_endpoints": Required[int], "webhook_resends_per_endpoint_per_hour": Required[int], "webhook_deliveries_per_day": Required[int]}, total=False)
|
|
22
|
+
|
|
23
|
+
PublicPricingResponseEnterprise = TypedDict("PublicPricingResponseEnterprise", {"contact": Required[str]}, total=False)
|
|
24
|
+
|
|
25
|
+
PublicPricingResponse = TypedDict("PublicPricingResponse", {"object": Required[Literal["pricing"]], "currency": Required[Literal["USD"]], "credits_per_evaluation": Required[int], "plans": Required[list[PublicPricingResponsePlansItem]], "credit_packs": Required[PublicPricingResponseCreditPacks], "yearly": Required[PublicPricingResponseYearly], "every_plan": Required[PublicPricingResponseEveryPlan], "enterprise": Required[PublicPricingResponseEnterprise], "url": Required[str]}, total=False)
|
|
26
|
+
|
|
27
|
+
PublicPricingQuoteInput = TypedDict("PublicPricingQuoteInput", {"plan": Required[Literal["payg", "pro", "scale"]], "interval": NotRequired[Literal["month", "year"]], "amount": NotRequired[int]}, total=False)
|
|
28
|
+
|
|
29
|
+
PublicPricingQuoteResponse = TypedDict("PublicPricingQuoteResponse", {"object": Required[Literal["price_quote"]], "plan": Required[Literal["payg", "pro", "scale"]], "interval": Required[Literal["month", "year"] | None], "currency": Required[Literal["USD"]], "amount_cents": Required[int], "credits": Required[int], "bonus_credits": Required[int], "total_credits": Required[int]}, total=False)
|
|
30
|
+
|
|
31
|
+
PublicDocsInput = TypedDict("PublicDocsInput", {"cursor": NotRequired[str], "limit": NotRequired[int]}, total=False)
|
|
32
|
+
|
|
33
|
+
PublicDocsResponseDataItem = TypedDict("PublicDocsResponseDataItem", {"object": Required[Literal["docs_page"]], "path": Required[str], "title": Required[str], "description": Required[str | None], "url": Required[str], "updated_at": Required[str]}, total=False)
|
|
34
|
+
|
|
35
|
+
PublicDocsResponse = TypedDict("PublicDocsResponse", {"object": Required[Literal["list"]], "data": Required[list[PublicDocsResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
36
|
+
|
|
37
|
+
PublicDocsSearchInput = TypedDict("PublicDocsSearchInput", {"query": Required[str], "limit": NotRequired[int]}, total=False)
|
|
38
|
+
|
|
39
|
+
PublicDocsSearchResponseDataItem = TypedDict("PublicDocsSearchResponseDataItem", {"object": Required[Literal["docs_page_match"]], "path": Required[str], "title": Required[str], "url": Required[str], "snippet": Required[str], "updated_at": Required[str]}, total=False)
|
|
40
|
+
|
|
41
|
+
PublicDocsSearchResponse = TypedDict("PublicDocsSearchResponse", {"object": Required[Literal["list"]], "data": Required[list[PublicDocsSearchResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
42
|
+
|
|
43
|
+
PublicDocsPageResponse = TypedDict("PublicDocsPageResponse", {"object": Required[Literal["docs_page"]], "path": Required[str], "title": Required[str], "description": Required[str | None], "url": Required[str], "updated_at": Required[str], "markdown": Required[str]}, total=False)
|
|
44
|
+
|
|
45
|
+
PublicHelpInput = TypedDict("PublicHelpInput", {"cursor": NotRequired[str], "limit": NotRequired[int]}, total=False)
|
|
46
|
+
|
|
47
|
+
PublicHelpResponseDataItem = TypedDict("PublicHelpResponseDataItem", {"object": Required[Literal["help_article"]], "path": Required[str], "title": Required[str], "description": Required[str | None], "url": Required[str], "updated_at": Required[str]}, total=False)
|
|
48
|
+
|
|
49
|
+
PublicHelpResponse = TypedDict("PublicHelpResponse", {"object": Required[Literal["list"]], "data": Required[list[PublicHelpResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
50
|
+
|
|
51
|
+
PublicHelpSearchInput = TypedDict("PublicHelpSearchInput", {"query": Required[str], "limit": NotRequired[int]}, total=False)
|
|
52
|
+
|
|
53
|
+
PublicHelpSearchResponseDataItem = TypedDict("PublicHelpSearchResponseDataItem", {"object": Required[Literal["help_article_match"]], "path": Required[str], "title": Required[str], "url": Required[str], "snippet": Required[str], "updated_at": Required[str]}, total=False)
|
|
54
|
+
|
|
55
|
+
PublicHelpSearchResponse = TypedDict("PublicHelpSearchResponse", {"object": Required[Literal["list"]], "data": Required[list[PublicHelpSearchResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
56
|
+
|
|
57
|
+
PublicHelpArticleResponse = TypedDict("PublicHelpArticleResponse", {"object": Required[Literal["help_article"]], "path": Required[str], "title": Required[str], "description": Required[str | None], "url": Required[str], "updated_at": Required[str], "markdown": Required[str]}, total=False)
|
|
58
|
+
|
|
59
|
+
PublicOpenapiResponse = TypedDict("PublicOpenapiResponse", {"object": Required[Literal["openapi"]], "version": Required[str], "document": Required[dict[str, Any]]}, total=False)
|
|
60
|
+
|
|
61
|
+
PublicActionsResponseDataItem = TypedDict("PublicActionsResponseDataItem", {"object": Required[Literal["action"]], "id": Required[str], "summary": Required[str], "method": Required[str], "path": Required[str], "scope": Required[str], "sign_in": Required[bool], "mcp_tool": Required[str | None], "cli_command": Required[str | None], "mutation": Required[bool], "destructive": Required[bool]}, total=False)
|
|
62
|
+
|
|
63
|
+
PublicActionsResponse = TypedDict("PublicActionsResponse", {"object": Required[Literal["list"]], "data": Required[list[PublicActionsResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
64
|
+
|
|
65
|
+
PublicErrorsResponseDataItem = TypedDict("PublicErrorsResponseDataItem", {"object": Required[Literal["error_code"]], "code": Required[str], "status": Required[int], "type": Required[str], "meaning": Required[str], "retryable": Required[bool], "next_step": Required[str], "docs_url": Required[str]}, total=False)
|
|
66
|
+
|
|
67
|
+
PublicErrorsResponse = TypedDict("PublicErrorsResponse", {"object": Required[Literal["list"]], "data": Required[list[PublicErrorsResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
68
|
+
|
|
69
|
+
PublicReasonsResponseDataItem = TypedDict("PublicReasonsResponseDataItem", {"object": Required[Literal["reason_code"]], "code": Required[str], "label": Required[str], "message": Required[str], "meaning": Required[str | None], "docs_url": Required[str]}, total=False)
|
|
70
|
+
|
|
71
|
+
PublicReasonsResponse = TypedDict("PublicReasonsResponse", {"object": Required[Literal["list"]], "data": Required[list[PublicReasonsResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
72
|
+
|
|
73
|
+
PublicWebhookEventsResponseDataItemExample = TypedDict("PublicWebhookEventsResponseDataItemExample", {"object": Required[Literal["event"]], "id": Required[str], "type": Required[str], "api_version": Required[str], "created_at": Required[str], "workspace": Required[str], "data": Required[dict[str, Any]]}, total=False)
|
|
74
|
+
|
|
75
|
+
PublicWebhookEventsResponseDataItem = TypedDict("PublicWebhookEventsResponseDataItem", {"object": Required[Literal["webhook_event_type"]], "type": Required[str], "description": Required[str], "example": Required[PublicWebhookEventsResponseDataItemExample]}, total=False)
|
|
76
|
+
|
|
77
|
+
PublicWebhookEventsResponse = TypedDict("PublicWebhookEventsResponse", {"object": Required[Literal["list"]], "data": Required[list[PublicWebhookEventsResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
78
|
+
|
|
79
|
+
PublicConditionsResponseDataItem = TypedDict("PublicConditionsResponseDataItem", {"object": Required[Literal["condition"]], "key": Required[str], "label": Required[str], "group": Required[str], "type": Required[Literal["number", "string", "boolean"]], "values": NotRequired[list[str]], "min": NotRequired[float], "max": NotRequired[float], "integer": NotRequired[bool]}, total=False)
|
|
80
|
+
|
|
81
|
+
PublicConditionsResponse = TypedDict("PublicConditionsResponse", {"object": Required[Literal["list"]], "data": Required[list[PublicConditionsResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
82
|
+
|
|
83
|
+
PublicGlossaryResponseTermsItem = TypedDict("PublicGlossaryResponseTermsItem", {"term": Required[str], "definition": Required[str]}, total=False)
|
|
84
|
+
|
|
85
|
+
PublicGlossaryResponseFaqItem = TypedDict("PublicGlossaryResponseFaqItem", {"section": Required[str | None], "question": Required[str], "answer": Required[str]}, total=False)
|
|
86
|
+
|
|
87
|
+
PublicGlossaryResponse = TypedDict("PublicGlossaryResponse", {"object": Required[Literal["glossary"]], "terms": Required[list[PublicGlossaryResponseTermsItem]], "faq": Required[list[PublicGlossaryResponseFaqItem]], "url": Required[str], "faq_url": Required[str], "updated_at": Required[str]}, total=False)
|
|
88
|
+
|
|
89
|
+
PublicLegalResponseDataItem = TypedDict("PublicLegalResponseDataItem", {"object": Required[Literal["legal_document"]], "document": Required[str], "title": Required[str], "version": Required[str], "effective_date": Required[str], "url": Required[str], "updated_at": Required[str]}, total=False)
|
|
90
|
+
|
|
91
|
+
PublicLegalResponse = TypedDict("PublicLegalResponse", {"object": Required[Literal["list"]], "data": Required[list[PublicLegalResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
92
|
+
|
|
93
|
+
PublicLegalDocumentResponse = TypedDict("PublicLegalDocumentResponse", {"object": Required[Literal["legal_document"]], "document": Required[str], "title": Required[str], "version": Required[str], "effective_date": Required[str], "url": Required[str], "updated_at": Required[str], "markdown": Required[str]}, total=False)
|
|
94
|
+
|
|
95
|
+
PublicChangelogResponseEntriesItem = TypedDict("PublicChangelogResponseEntriesItem", {"id": Required[str], "title": Required[str], "date": Required[str], "markdown": Required[str]}, total=False)
|
|
96
|
+
|
|
97
|
+
PublicChangelogResponse = TypedDict("PublicChangelogResponse", {"object": Required[Literal["changelog"]], "url": Required[str], "entries": Required[list[PublicChangelogResponseEntriesItem]], "updated_at": Required[str]}, total=False)
|
|
98
|
+
|
|
99
|
+
PublicBlogInput = TypedDict("PublicBlogInput", {"cursor": NotRequired[str], "limit": NotRequired[int]}, total=False)
|
|
100
|
+
|
|
101
|
+
PublicBlogResponseDataItem = TypedDict("PublicBlogResponseDataItem", {"object": Required[Literal["blog_post"]], "slug": Required[str], "title": Required[str], "description": Required[str | None], "url": Required[str], "published_on": Required[str | None], "revised_on": Required[str | None], "authors": Required[list[str]], "tags": Required[list[str]], "updated_at": Required[str]}, total=False)
|
|
102
|
+
|
|
103
|
+
PublicBlogResponse = TypedDict("PublicBlogResponse", {"object": Required[Literal["list"]], "data": Required[list[PublicBlogResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
104
|
+
|
|
105
|
+
PublicBlogPostResponse = TypedDict("PublicBlogPostResponse", {"object": Required[Literal["blog_post"]], "slug": Required[str], "title": Required[str], "description": Required[str | None], "url": Required[str], "published_on": Required[str | None], "revised_on": Required[str | None], "authors": Required[list[str]], "tags": Required[list[str]], "updated_at": Required[str], "markdown": Required[str]}, total=False)
|
|
106
|
+
|
|
107
|
+
PublicVersionsResponseNpm = TypedDict("PublicVersionsResponseNpm", {"package": Required[str], "version": Required[str]}, total=False)
|
|
108
|
+
|
|
109
|
+
PublicVersionsResponseBrowserScript = TypedDict("PublicVersionsResponseBrowserScript", {"version": Required[str], "url": Required[str]}, total=False)
|
|
110
|
+
|
|
111
|
+
PublicVersionsResponseSkillVariant0 = TypedDict("PublicVersionsResponseSkillVariant0", {"version": Required[str], "url": Required[str]}, total=False)
|
|
112
|
+
|
|
113
|
+
PublicVersionsResponse = TypedDict("PublicVersionsResponse", {"object": Required[Literal["versions"]], "api": Required[Literal["v1"]], "npm": Required[PublicVersionsResponseNpm], "browser_script": Required[PublicVersionsResponseBrowserScript], "skill": Required[PublicVersionsResponseSkillVariant0 | None]}, total=False)
|
|
114
|
+
|
|
115
|
+
PublicStatusResponse = TypedDict("PublicStatusResponse", {"object": Required[Literal["service_status"]], "status": Required[Literal["operational", "degraded"]], "checked_at": Required[str]}, total=False)
|
|
116
|
+
|
|
117
|
+
PublicContactsResponseSupport = TypedDict("PublicContactsResponseSupport", {"email": Required[str], "form": Required[str | None], "api": Required[str]}, total=False)
|
|
118
|
+
|
|
119
|
+
PublicContactsResponseSales = TypedDict("PublicContactsResponseSales", {"form": Required[str], "api": Required[str]}, total=False)
|
|
120
|
+
|
|
121
|
+
PublicContactsResponseSecurity = TypedDict("PublicContactsResponseSecurity", {"email": Required[str]}, total=False)
|
|
122
|
+
|
|
123
|
+
PublicContactsResponse = TypedDict("PublicContactsResponse", {"object": Required[Literal["contacts"]], "support": Required[PublicContactsResponseSupport], "sales": Required[PublicContactsResponseSales], "security": Required[PublicContactsResponseSecurity]}, total=False)
|
|
124
|
+
|
|
125
|
+
PublicContactSalesInput = TypedDict("PublicContactSalesInput", {"name": Required[str], "email": Required[str], "message": Required[str]}, total=False)
|
|
126
|
+
|
|
127
|
+
PublicContactSalesResponse = TypedDict("PublicContactSalesResponse", {"object": Required[Literal["sales_request"]], "received": Required[Literal[True]]}, total=False)
|
|
128
|
+
|
|
129
|
+
PublicContactSupportInput = TypedDict("PublicContactSupportInput", {"email": Required[str], "subject": Required[str], "message": Required[str], "topic": Required[Literal["account", "billing", "integration", "dashboard", "other"]], "name": NotRequired[str], "workspace_id": NotRequired[str], "request_id": NotRequired[str]}, total=False)
|
|
130
|
+
|
|
131
|
+
PublicContactSupportResponse = TypedDict("PublicContactSupportResponse", {"object": Required[Literal["support_request"]], "reference": Required[str], "email": Required[str]}, total=False)
|
|
132
|
+
|
|
133
|
+
PublicOnboardingStartInput = TypedDict("PublicOnboardingStartInput", {"workspace_name": Required[str], "plan": Required[Literal["payg", "pro", "scale"]], "interval": NotRequired[Literal["month", "year"]], "credit_pack_dollars": NotRequired[int]}, total=False)
|
|
134
|
+
|
|
135
|
+
PublicOnboardingStartResponse = TypedDict("PublicOnboardingStartResponse", {"object": Required[Literal["onboarding_session"]], "id": Required[str], "approval_url": Required[str], "secret": Required[str], "expires_at": Required[str], "workspace_name": Required[str], "plan": Required[Literal["payg", "pro", "scale"]], "interval": Required[Literal["month", "year"] | None], "credit_pack_dollars": Required[int | None], "amount_cents": Required[int]}, total=False)
|
|
136
|
+
|
|
137
|
+
PublicOnboardingStatusInput = TypedDict("PublicOnboardingStatusInput", {"secret": Required[str], "wait": NotRequired[int]}, total=False)
|
|
138
|
+
|
|
139
|
+
PublicOnboardingStatusResponseSignInVariant0 = TypedDict("PublicOnboardingStatusResponseSignInVariant0", {"token_endpoint": Required[str], "grant_type": Required[str], "client_id": Required[str]}, total=False)
|
|
140
|
+
|
|
141
|
+
PublicOnboardingStatusResponse = TypedDict("PublicOnboardingStatusResponse", {"object": Required[Literal["onboarding_session"]], "id": Required[str], "status": Required[Literal["waiting", "declined", "expired", "ready", "collected"]], "expires_at": Required[str], "workspace": Required[str | None], "sign_in": Required[PublicOnboardingStatusResponseSignInVariant0 | None]}, total=False)
|
|
142
|
+
|
|
143
|
+
WorkspacesListResponseDataItem = TypedDict("WorkspacesListResponseDataItem", {"object": Required[str]}, total=False)
|
|
144
|
+
|
|
145
|
+
WorkspacesListResponse = TypedDict("WorkspacesListResponse", {"object": Required[Literal["list"]], "data": Required[list[WorkspacesListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
146
|
+
|
|
147
|
+
MeGetResponsePersonVariant0 = TypedDict("MeGetResponsePersonVariant0", {"name": Required[str | None], "email": Required[str | None]}, total=False)
|
|
148
|
+
|
|
149
|
+
MeGetResponseAppVariant0 = TypedDict("MeGetResponseAppVariant0", {"id": Required[str], "name": Required[str | None]}, total=False)
|
|
150
|
+
|
|
151
|
+
MeGetResponseApiKeyVariant0 = TypedDict("MeGetResponseApiKeyVariant0", {"id": Required[str], "name": Required[str | None], "type": Required[Literal["secret", "restricted"]]}, total=False)
|
|
152
|
+
|
|
153
|
+
MeGetResponseMachineClientVariant0 = TypedDict("MeGetResponseMachineClientVariant0", {"id": Required[str], "name": Required[str | None]}, total=False)
|
|
154
|
+
|
|
155
|
+
MeGetResponseWorkspaceVariant0 = TypedDict("MeGetResponseWorkspaceVariant0", {"id": Required[str], "name": Required[str | None]}, total=False)
|
|
156
|
+
|
|
157
|
+
MeGetResponse = TypedDict("MeGetResponse", {"object": Required[Literal["connection"]], "credential": Required[Literal["oauth", "machine_client", "api_key"]], "person": Required[MeGetResponsePersonVariant0 | None], "app": Required[MeGetResponseAppVariant0 | None], "api_key": Required[MeGetResponseApiKeyVariant0 | None], "machine_client": Required[MeGetResponseMachineClientVariant0 | None], "workspace": Required[MeGetResponseWorkspaceVariant0 | None], "role": Required[Literal["owner", "admin", "developer", "viewer"] | None], "permissions": Required[list[Literal["manage", "publish", "keys", "reveal", "export", "members", "delete"]]], "scopes": Required[list[Literal["operations:general", "operations:configuration", "operations:management"]]]}, total=False)
|
|
158
|
+
|
|
159
|
+
ApiKeysListInput = TypedDict("ApiKeysListInput", {"cursor": NotRequired[str], "limit": NotRequired[int]}, total=False)
|
|
160
|
+
|
|
161
|
+
ApiKeysListResponseDataItem = TypedDict("ApiKeysListResponseDataItem", {"object": Required[Literal["api_key"]], "id": Required[str], "name": Required[str], "type": Required[Literal["secret", "restricted", "publishable"]], "scopes": Required[list[str]], "prefix": Required[str | None], "last_four": Required[str | None], "value": Required[str | None], "status": Required[Literal["active", "expired", "revoked"]], "replacement_available": Required[bool], "expires_at": Required[str | None], "last_used_at": Required[str | None], "created_at": Required[str | None]}, total=False)
|
|
162
|
+
|
|
163
|
+
ApiKeysListResponse = TypedDict("ApiKeysListResponse", {"object": Required[Literal["list"]], "data": Required[list[ApiKeysListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
164
|
+
|
|
165
|
+
ApiKeysCreateInput = TypedDict("ApiKeysCreateInput", {"name": Required[str], "type": Required[Literal["secret", "restricted"]], "scopes": NotRequired[list[Literal["operations:general", "operations:configuration", "operations:management", "observations:create"]]], "expires_in_days": NotRequired[int | None]}, total=False)
|
|
166
|
+
|
|
167
|
+
ApiKeysCreateResponse = TypedDict("ApiKeysCreateResponse", {"object": Required[Literal["api_key"]], "id": Required[str], "name": Required[str], "type": Required[Literal["secret", "restricted", "publishable"]], "scopes": Required[list[str]], "prefix": Required[str | None], "last_four": Required[str | None], "value": Required[str | None], "status": Required[Literal["active", "expired", "revoked"]], "replacement_available": Required[bool], "expires_at": Required[str | None], "last_used_at": Required[str | None], "created_at": Required[str | None], "secret": Required[str]}, total=False)
|
|
168
|
+
|
|
169
|
+
ApiKeysUpdateInput = TypedDict("ApiKeysUpdateInput", {"name": NotRequired[str], "scopes": NotRequired[list[Literal["operations:general", "operations:configuration", "operations:management", "observations:create"]]], "expires_in_days": NotRequired[int | None]}, total=False)
|
|
170
|
+
|
|
171
|
+
ApiKeysUpdateResponse = TypedDict("ApiKeysUpdateResponse", {"object": Required[Literal["api_key"]], "id": Required[str], "name": Required[str], "type": Required[Literal["secret", "restricted", "publishable"]], "scopes": Required[list[str]], "prefix": Required[str | None], "last_four": Required[str | None], "value": Required[str | None], "status": Required[Literal["active", "expired", "revoked"]], "replacement_available": Required[bool], "expires_at": Required[str | None], "last_used_at": Required[str | None], "created_at": Required[str | None]}, total=False)
|
|
172
|
+
|
|
173
|
+
ApiKeysRollInput = TypedDict("ApiKeysRollInput", {"overlap_hours": Required[Literal[1] | Literal[24] | Literal[168]]}, total=False)
|
|
174
|
+
|
|
175
|
+
ApiKeysRollResponsePrevious = TypedDict("ApiKeysRollResponsePrevious", {"id": Required[str | None], "expires_at": Required[str | None]}, total=False)
|
|
176
|
+
|
|
177
|
+
ApiKeysRollResponse = TypedDict("ApiKeysRollResponse", {"object": Required[Literal["api_key"]], "id": Required[str], "name": Required[str], "type": Required[Literal["secret", "restricted", "publishable"]], "scopes": Required[list[str]], "prefix": Required[str | None], "last_four": Required[str | None], "value": Required[str | None], "status": Required[Literal["active", "expired", "revoked"]], "replacement_available": Required[bool], "expires_at": Required[str | None], "last_used_at": Required[str | None], "created_at": Required[str | None], "secret": Required[str], "previous": Required[ApiKeysRollResponsePrevious]}, total=False)
|
|
178
|
+
|
|
179
|
+
ApiKeysReplacementResponse = TypedDict("ApiKeysReplacementResponse", {"object": Required[Literal["api_key"]], "id": Required[str], "name": Required[str], "type": Required[Literal["secret", "restricted", "publishable"]], "scopes": Required[list[str]], "prefix": Required[str | None], "last_four": Required[str | None], "value": Required[str | None], "status": Required[Literal["active", "expired", "revoked"]], "replacement_available": Required[bool], "expires_at": Required[str | None], "last_used_at": Required[str | None], "created_at": Required[str | None], "secret": Required[str]}, total=False)
|
|
180
|
+
|
|
181
|
+
ApiKeysRevokeResponse = TypedDict("ApiKeysRevokeResponse", {"object": Required[Literal["api_key"]], "id": Required[str], "name": Required[str], "type": Required[Literal["secret", "restricted", "publishable"]], "scopes": Required[list[str]], "prefix": Required[str | None], "last_four": Required[str | None], "value": Required[str | None], "status": Required[Literal["active", "expired", "revoked"]], "replacement_available": Required[bool], "expires_at": Required[str | None], "last_used_at": Required[str | None], "created_at": Required[str | None]}, total=False)
|
|
182
|
+
|
|
183
|
+
MachineClientsListInput = TypedDict("MachineClientsListInput", {"cursor": NotRequired[str], "limit": NotRequired[int], "view": NotRequired[Literal["mine", "everyone"]]}, total=False)
|
|
184
|
+
|
|
185
|
+
MachineClientsListResponseDataItemMemberVariant0 = TypedDict("MachineClientsListResponseDataItemMemberVariant0", {"name": Required[str | None], "email": Required[str | None], "role": Required[Literal["owner", "admin", "developer", "viewer"] | None], "you": Required[bool], "former": Required[bool]}, total=False)
|
|
186
|
+
|
|
187
|
+
MachineClientsListResponseDataItem = TypedDict("MachineClientsListResponseDataItem", {"object": Required[Literal["machine_client"]], "id": Required[str | None], "name": Required[str], "scopes": Required[list[str]], "member": Required[MachineClientsListResponseDataItemMemberVariant0 | None], "created_at": Required[str | None], "last_used_at": Required[str | None]}, total=False)
|
|
188
|
+
|
|
189
|
+
MachineClientsListResponse = TypedDict("MachineClientsListResponse", {"object": Required[Literal["list"]], "data": Required[list[MachineClientsListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
190
|
+
|
|
191
|
+
MachineClientsCreateInput = TypedDict("MachineClientsCreateInput", {"name": Required[str], "scopes": Required[list[Literal["operations:general", "operations:configuration", "operations:management"]]]}, total=False)
|
|
192
|
+
|
|
193
|
+
MachineClientsCreateResponseMemberVariant0 = TypedDict("MachineClientsCreateResponseMemberVariant0", {"name": Required[str | None], "email": Required[str | None], "role": Required[Literal["owner", "admin", "developer", "viewer"] | None], "you": Required[bool], "former": Required[bool]}, total=False)
|
|
194
|
+
|
|
195
|
+
MachineClientsCreateResponse = TypedDict("MachineClientsCreateResponse", {"object": Required[Literal["machine_client"]], "id": Required[str | None], "name": Required[str], "scopes": Required[list[str]], "member": Required[MachineClientsCreateResponseMemberVariant0 | None], "created_at": Required[str | None], "last_used_at": Required[str | None], "secret": Required[str], "token_endpoint": Required[str], "audience": Required[str]}, total=False)
|
|
196
|
+
|
|
197
|
+
MachineClientsRotateSecretResponse = TypedDict("MachineClientsRotateSecretResponse", {"object": Required[Literal["machine_client_secret"]], "id": Required[str | None], "secret": Required[str]}, total=False)
|
|
198
|
+
|
|
199
|
+
MachineClientsRevokeResponse = TypedDict("MachineClientsRevokeResponse", {"object": Required[Literal["deleted"]], "id": Required[str | None], "deleted": Required[Literal[True]]}, total=False)
|
|
200
|
+
|
|
201
|
+
AuthorizedAppsListInput = TypedDict("AuthorizedAppsListInput", {"cursor": NotRequired[str], "limit": NotRequired[int], "view": NotRequired[Literal["mine", "everyone"]]}, total=False)
|
|
202
|
+
|
|
203
|
+
AuthorizedAppsListResponseDataItemMemberVariant0 = TypedDict("AuthorizedAppsListResponseDataItemMemberVariant0", {"name": Required[str | None], "email": Required[str | None], "role": Required[Literal["owner", "admin", "developer", "viewer"] | None], "you": Required[bool], "former": Required[bool]}, total=False)
|
|
204
|
+
|
|
205
|
+
AuthorizedAppsListResponseDataItem = TypedDict("AuthorizedAppsListResponseDataItem", {"object": Required[Literal["authorized_app"]], "id": Required[str | None], "name": Required[str], "trust": Required[Literal["first_party", "verified", "unverified"]], "destination": Required[str | None], "scopes": Required[list[str]], "member": Required[AuthorizedAppsListResponseDataItemMemberVariant0 | None], "approved_at": Required[str | None]}, total=False)
|
|
206
|
+
|
|
207
|
+
AuthorizedAppsListResponse = TypedDict("AuthorizedAppsListResponse", {"object": Required[Literal["list"]], "data": Required[list[AuthorizedAppsListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
208
|
+
|
|
209
|
+
AuthorizedAppsDisconnectResponse = TypedDict("AuthorizedAppsDisconnectResponse", {"object": Required[Literal["deleted"]], "id": Required[str | None], "deleted": Required[Literal[True]]}, total=False)
|
|
210
|
+
|
|
211
|
+
MembersListInput = TypedDict("MembersListInput", {"cursor": NotRequired[str], "limit": NotRequired[int]}, total=False)
|
|
212
|
+
|
|
213
|
+
MembersListResponseDataItem = TypedDict("MembersListResponseDataItem", {"object": Required[Literal["member"]], "id": Required[str | None], "name": Required[str | None], "email": Required[str], "role": Required[Literal["owner", "admin", "developer", "viewer"]], "permissions": Required[list[str]], "invited_at": Required[str | None], "joined_at": Required[str | None], "last_sign_in_at": Required[str | None], "you": Required[bool]}, total=False)
|
|
214
|
+
|
|
215
|
+
MembersListResponse = TypedDict("MembersListResponse", {"object": Required[Literal["list"]], "data": Required[list[MembersListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
216
|
+
|
|
217
|
+
MembersUpdateInput = TypedDict("MembersUpdateInput", {"role": NotRequired[Literal["admin", "developer", "viewer"]], "permissions": NotRequired[list[Literal["manage", "publish", "keys", "reveal", "export", "delete"]]]}, total=False)
|
|
218
|
+
|
|
219
|
+
MembersUpdateResponse = TypedDict("MembersUpdateResponse", {"object": Required[Literal["member"]], "id": Required[str | None], "name": Required[str | None], "email": Required[str], "role": Required[Literal["owner", "admin", "developer", "viewer"]], "permissions": Required[list[str]], "invited_at": Required[str | None], "joined_at": Required[str | None], "last_sign_in_at": Required[str | None], "you": Required[bool]}, total=False)
|
|
220
|
+
|
|
221
|
+
MembersRemoveResponse = TypedDict("MembersRemoveResponse", {"object": Required[Literal["deleted"]], "id": Required[str | None], "deleted": Required[Literal[True]]}, total=False)
|
|
222
|
+
|
|
223
|
+
InvitationsListInput = TypedDict("InvitationsListInput", {"cursor": NotRequired[str], "limit": NotRequired[int]}, total=False)
|
|
224
|
+
|
|
225
|
+
InvitationsListResponseDataItem = TypedDict("InvitationsListResponseDataItem", {"object": Required[Literal["invitation"]], "id": Required[str | None], "email": Required[str], "role": Required[Literal["admin", "developer", "viewer"]], "invited_by": Required[str | None], "status": Required[Literal["pending", "canceled"]], "created_at": Required[str | None], "expires_at": Required[str | None]}, total=False)
|
|
226
|
+
|
|
227
|
+
InvitationsListResponse = TypedDict("InvitationsListResponse", {"object": Required[Literal["list"]], "data": Required[list[InvitationsListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
228
|
+
|
|
229
|
+
InvitationsCreateInput = TypedDict("InvitationsCreateInput", {"email": Required[str], "role": Required[Literal["admin", "developer", "viewer"]]}, total=False)
|
|
230
|
+
|
|
231
|
+
InvitationsCreateResponse = TypedDict("InvitationsCreateResponse", {"object": Required[Literal["invitation"]], "id": Required[str | None], "email": Required[str], "role": Required[Literal["admin", "developer", "viewer"]], "invited_by": Required[str | None], "status": Required[Literal["pending", "canceled"]], "created_at": Required[str | None], "expires_at": Required[str | None]}, total=False)
|
|
232
|
+
|
|
233
|
+
InvitationsResendResponse = TypedDict("InvitationsResendResponse", {"object": Required[Literal["invitation"]], "id": Required[str | None], "email": Required[str], "role": Required[Literal["admin", "developer", "viewer"]], "invited_by": Required[str | None], "status": Required[Literal["pending", "canceled"]], "created_at": Required[str | None], "expires_at": Required[str | None]}, total=False)
|
|
234
|
+
|
|
235
|
+
InvitationsCancelResponse = TypedDict("InvitationsCancelResponse", {"object": Required[Literal["invitation"]], "id": Required[str | None], "email": Required[str], "role": Required[Literal["admin", "developer", "viewer"]], "invited_by": Required[str | None], "status": Required[Literal["pending", "canceled"]], "created_at": Required[str | None], "expires_at": Required[str | None]}, total=False)
|
|
236
|
+
|
|
237
|
+
WorkspaceGetResponseIconVariant0 = TypedDict("WorkspaceGetResponseIconVariant0", {"updated_at": Required[str | None]}, total=False)
|
|
238
|
+
|
|
239
|
+
WorkspaceGetResponseProductTypeVariant0 = TypedDict("WorkspaceGetResponseProductTypeVariant0", {"type": Required[Literal["ai_app", "media_generation", "developer_tool", "b2b_saas", "consumer_app", "marketplace", "game", "other"]], "other": NotRequired[str]}, total=False)
|
|
240
|
+
|
|
241
|
+
WorkspaceGetResponseDataRetention = TypedDict("WorkspaceGetResponseDataRetention", {"evidence_days": Required[int], "max_days": Required[int], "options": Required[list[int]]}, total=False)
|
|
242
|
+
|
|
243
|
+
WorkspaceGetResponse = TypedDict("WorkspaceGetResponse", {"object": Required[Literal["workspace_settings"]], "id": Required[str], "name": Required[str], "icon": Required[WorkspaceGetResponseIconVariant0 | None], "time_zone": Required[str | None], "website": Required[str | None], "product_type": Required[WorkspaceGetResponseProductTypeVariant0 | None], "data_retention": Required[WorkspaceGetResponseDataRetention]}, total=False)
|
|
244
|
+
|
|
245
|
+
WorkspaceUpdateInputProductTypeVariant0 = TypedDict("WorkspaceUpdateInputProductTypeVariant0", {"type": Required[Literal["ai_app", "media_generation", "developer_tool", "b2b_saas", "consumer_app", "marketplace", "game", "other"]], "other": NotRequired[str]}, total=False)
|
|
246
|
+
|
|
247
|
+
WorkspaceUpdateInput = TypedDict("WorkspaceUpdateInput", {"name": NotRequired[str], "website": NotRequired[str | None], "product_type": NotRequired[WorkspaceUpdateInputProductTypeVariant0 | None], "time_zone": NotRequired[str]}, total=False)
|
|
248
|
+
|
|
249
|
+
WorkspaceUpdateResponseIconVariant0 = TypedDict("WorkspaceUpdateResponseIconVariant0", {"updated_at": Required[str | None]}, total=False)
|
|
250
|
+
|
|
251
|
+
WorkspaceUpdateResponseProductTypeVariant0 = TypedDict("WorkspaceUpdateResponseProductTypeVariant0", {"type": Required[Literal["ai_app", "media_generation", "developer_tool", "b2b_saas", "consumer_app", "marketplace", "game", "other"]], "other": NotRequired[str]}, total=False)
|
|
252
|
+
|
|
253
|
+
WorkspaceUpdateResponseDataRetention = TypedDict("WorkspaceUpdateResponseDataRetention", {"evidence_days": Required[int], "max_days": Required[int], "options": Required[list[int]]}, total=False)
|
|
254
|
+
|
|
255
|
+
WorkspaceUpdateResponse = TypedDict("WorkspaceUpdateResponse", {"object": Required[Literal["workspace_settings"]], "id": Required[str], "name": Required[str], "icon": Required[WorkspaceUpdateResponseIconVariant0 | None], "time_zone": Required[str | None], "website": Required[str | None], "product_type": Required[WorkspaceUpdateResponseProductTypeVariant0 | None], "data_retention": Required[WorkspaceUpdateResponseDataRetention]}, total=False)
|
|
256
|
+
|
|
257
|
+
WorkspaceIconUploadInput = TypedDict("WorkspaceIconUploadInput", {"image": Required[str]}, total=False)
|
|
258
|
+
|
|
259
|
+
WorkspaceIconUploadResponse = TypedDict("WorkspaceIconUploadResponse", {"object": Required[Literal["workspace_icon_upload"]], "id": Required[str], "state": Required[Literal["pending", "ready", "failed"]]}, total=False)
|
|
260
|
+
|
|
261
|
+
WorkspaceIconRemoveResponseIconVariant0 = TypedDict("WorkspaceIconRemoveResponseIconVariant0", {"updated_at": Required[str | None]}, total=False)
|
|
262
|
+
|
|
263
|
+
WorkspaceIconRemoveResponseProductTypeVariant0 = TypedDict("WorkspaceIconRemoveResponseProductTypeVariant0", {"type": Required[Literal["ai_app", "media_generation", "developer_tool", "b2b_saas", "consumer_app", "marketplace", "game", "other"]], "other": NotRequired[str]}, total=False)
|
|
264
|
+
|
|
265
|
+
WorkspaceIconRemoveResponseDataRetention = TypedDict("WorkspaceIconRemoveResponseDataRetention", {"evidence_days": Required[int], "max_days": Required[int], "options": Required[list[int]]}, total=False)
|
|
266
|
+
|
|
267
|
+
WorkspaceIconRemoveResponse = TypedDict("WorkspaceIconRemoveResponse", {"object": Required[Literal["workspace_settings"]], "id": Required[str], "name": Required[str], "icon": Required[WorkspaceIconRemoveResponseIconVariant0 | None], "time_zone": Required[str | None], "website": Required[str | None], "product_type": Required[WorkspaceIconRemoveResponseProductTypeVariant0 | None], "data_retention": Required[WorkspaceIconRemoveResponseDataRetention]}, total=False)
|
|
268
|
+
|
|
269
|
+
WorkspaceIconUploadGetResponse = TypedDict("WorkspaceIconUploadGetResponse", {"object": Required[Literal["workspace_icon_upload"]], "id": Required[str], "state": Required[Literal["pending", "ready", "failed"]]}, total=False)
|
|
270
|
+
|
|
271
|
+
WorkspaceRetentionInput = TypedDict("WorkspaceRetentionInput", {"evidence_days": Required[int]}, total=False)
|
|
272
|
+
|
|
273
|
+
WorkspaceRetentionResponseIconVariant0 = TypedDict("WorkspaceRetentionResponseIconVariant0", {"updated_at": Required[str | None]}, total=False)
|
|
274
|
+
|
|
275
|
+
WorkspaceRetentionResponseProductTypeVariant0 = TypedDict("WorkspaceRetentionResponseProductTypeVariant0", {"type": Required[Literal["ai_app", "media_generation", "developer_tool", "b2b_saas", "consumer_app", "marketplace", "game", "other"]], "other": NotRequired[str]}, total=False)
|
|
276
|
+
|
|
277
|
+
WorkspaceRetentionResponseDataRetention = TypedDict("WorkspaceRetentionResponseDataRetention", {"evidence_days": Required[int], "max_days": Required[int], "options": Required[list[int]]}, total=False)
|
|
278
|
+
|
|
279
|
+
WorkspaceRetentionResponse = TypedDict("WorkspaceRetentionResponse", {"object": Required[Literal["workspace_settings"]], "id": Required[str], "name": Required[str], "icon": Required[WorkspaceRetentionResponseIconVariant0 | None], "time_zone": Required[str | None], "website": Required[str | None], "product_type": Required[WorkspaceRetentionResponseProductTypeVariant0 | None], "data_retention": Required[WorkspaceRetentionResponseDataRetention]}, total=False)
|
|
280
|
+
|
|
281
|
+
WorkspaceSetupResponseStepsItem = TypedDict("WorkspaceSetupResponseStepsItem", {"step": Required[Literal["benefit", "server_key", "first_evaluation", "browser_script"]], "done": Required[bool]}, total=False)
|
|
282
|
+
|
|
283
|
+
WorkspaceSetupResponse = TypedDict("WorkspaceSetupResponse", {"object": Required[Literal["setup_progress"]], "steps": Required[list[WorkspaceSetupResponseStepsItem]], "complete": Required[bool], "finished": Required[bool], "dismissed": Required[bool | None]}, total=False)
|
|
284
|
+
|
|
285
|
+
WorkspaceSetupFinishInputProductTypeVariant0 = TypedDict("WorkspaceSetupFinishInputProductTypeVariant0", {"type": Required[Literal["ai_app", "media_generation", "developer_tool", "b2b_saas", "consumer_app", "marketplace", "game", "other"]], "other": NotRequired[str]}, total=False)
|
|
286
|
+
|
|
287
|
+
WorkspaceSetupFinishInput = TypedDict("WorkspaceSetupFinishInput", {"website": NotRequired[str | None], "product_type": NotRequired[WorkspaceSetupFinishInputProductTypeVariant0 | None], "time_zone": NotRequired[str | None]}, total=False)
|
|
288
|
+
|
|
289
|
+
WorkspaceSetupFinishResponseStepsItem = TypedDict("WorkspaceSetupFinishResponseStepsItem", {"step": Required[Literal["benefit", "server_key", "first_evaluation", "browser_script"]], "done": Required[bool]}, total=False)
|
|
290
|
+
|
|
291
|
+
WorkspaceSetupFinishResponse = TypedDict("WorkspaceSetupFinishResponse", {"object": Required[Literal["setup_progress"]], "steps": Required[list[WorkspaceSetupFinishResponseStepsItem]], "complete": Required[bool], "finished": Required[bool], "dismissed": Required[bool | None]}, total=False)
|
|
292
|
+
|
|
293
|
+
WorkspaceSetupDismissResponseStepsItem = TypedDict("WorkspaceSetupDismissResponseStepsItem", {"step": Required[Literal["benefit", "server_key", "first_evaluation", "browser_script"]], "done": Required[bool]}, total=False)
|
|
294
|
+
|
|
295
|
+
WorkspaceSetupDismissResponse = TypedDict("WorkspaceSetupDismissResponse", {"object": Required[Literal["setup_progress"]], "steps": Required[list[WorkspaceSetupDismissResponseStepsItem]], "complete": Required[bool], "finished": Required[bool], "dismissed": Required[bool | None]}, total=False)
|
|
296
|
+
|
|
297
|
+
WorkspaceLeaveResponse = TypedDict("WorkspaceLeaveResponse", {"object": Required[Literal["workspace_left"]], "workspace": Required[str]}, total=False)
|
|
298
|
+
|
|
299
|
+
EvaluationsListInput = TypedDict("EvaluationsListInput", {"cursor": NotRequired[str], "limit": NotRequired[int], "result": NotRequired[Literal["allow", "deny"]], "benefit": NotRequired[str], "query": NotRequired[str], "days": NotRequired[int]}, total=False)
|
|
300
|
+
|
|
301
|
+
EvaluationsListResponseDataItem = TypedDict("EvaluationsListResponseDataItem", {"object": Required[str]}, total=False)
|
|
302
|
+
|
|
303
|
+
EvaluationsListResponse = TypedDict("EvaluationsListResponse", {"object": Required[Literal["list"]], "data": Required[list[EvaluationsListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
304
|
+
|
|
305
|
+
EvaluationsCreateInputSubject = TypedDict("EvaluationsCreateInputSubject", {"external_id": NotRequired[str], "email": Required[str], "email_verified": NotRequired[bool]}, total=False)
|
|
306
|
+
|
|
307
|
+
EvaluationsCreateInputContextVariant0 = TypedDict("EvaluationsCreateInputContextVariant0", {"ip": NotRequired[str | None], "user_agent": NotRequired[str], "session_id": NotRequired[str]}, total=False)
|
|
308
|
+
|
|
309
|
+
EvaluationsCreateInputIdentifiersPayment = TypedDict("EvaluationsCreateInputIdentifiersPayment", {"provider": Required[str], "scope": Required[str], "fingerprint": Required[str]}, total=False)
|
|
310
|
+
|
|
311
|
+
EvaluationsCreateInputIdentifiersPhoneHash = TypedDict("EvaluationsCreateInputIdentifiersPhoneHash", {"algorithm": Required[Literal["hmac-sha256"]], "key_version": Required[str], "value": Required[str]}, total=False)
|
|
312
|
+
|
|
313
|
+
EvaluationsCreateInputIdentifiersCustomItemValueHash = TypedDict("EvaluationsCreateInputIdentifiersCustomItemValueHash", {"algorithm": Required[Literal["hmac-sha256"]], "key_version": Required[str], "value": Required[str]}, total=False)
|
|
314
|
+
|
|
315
|
+
EvaluationsCreateInputIdentifiersCustomItem = TypedDict("EvaluationsCreateInputIdentifiersCustomItem", {"key": Required[str], "value_hash": Required[EvaluationsCreateInputIdentifiersCustomItemValueHash]}, total=False)
|
|
316
|
+
|
|
317
|
+
EvaluationsCreateInputIdentifiers = TypedDict("EvaluationsCreateInputIdentifiers", {"device_id": NotRequired[str], "device_token": NotRequired[str], "browser_cookie_id": NotRequired[str], "payment": NotRequired[EvaluationsCreateInputIdentifiersPayment], "phone_hash": NotRequired[EvaluationsCreateInputIdentifiersPhoneHash], "phone_verified": NotRequired[bool], "custom": NotRequired[list[EvaluationsCreateInputIdentifiersCustomItem]]}, total=False)
|
|
318
|
+
|
|
319
|
+
EvaluationsCreateInputRequest = TypedDict("EvaluationsCreateInputRequest", {"method": Required[str], "url": Required[str], "headers": Required[dict[str, Any]]}, total=False)
|
|
320
|
+
|
|
321
|
+
EvaluationsCreateInput = TypedDict("EvaluationsCreateInput", {"benefit": Required[str], "claim_id": Required[str], "subject": Required[EvaluationsCreateInputSubject], "context": NotRequired[EvaluationsCreateInputContextVariant0 | None], "identifiers": NotRequired[EvaluationsCreateInputIdentifiers], "request": NotRequired[EvaluationsCreateInputRequest]}, total=False)
|
|
322
|
+
|
|
323
|
+
EvaluationsCreateResponseVariant0Risk = TypedDict("EvaluationsCreateResponseVariant0Risk", {"score": Required[float | None], "band": Required[Literal["low", "elevated", "high", "not_assessed"]]}, total=False)
|
|
324
|
+
|
|
325
|
+
EvaluationsCreateResponseVariant0ReasonVariant0 = TypedDict("EvaluationsCreateResponseVariant0ReasonVariant0", {"code": Required[str], "message": Required[str], "rule": NotRequired[str]}, total=False)
|
|
326
|
+
|
|
327
|
+
EvaluationsCreateResponseVariant0OutcomeVariant0 = TypedDict("EvaluationsCreateResponseVariant0OutcomeVariant0", {"state": Required[str], "due_at": Required[str | None]}, total=False)
|
|
328
|
+
|
|
329
|
+
EvaluationsCreateResponseVariant0 = TypedDict("EvaluationsCreateResponseVariant0", {"object": Required[Literal["evaluation"]], "id": Required[str], "result": Required[Literal["allow", "deny"]], "risk": Required[EvaluationsCreateResponseVariant0Risk], "reason": Required[EvaluationsCreateResponseVariant0ReasonVariant0 | None], "outcome": NotRequired[EvaluationsCreateResponseVariant0OutcomeVariant0 | None]}, total=False)
|
|
330
|
+
|
|
331
|
+
EvaluationsCreateResponseVariant1 = TypedDict("EvaluationsCreateResponseVariant1", {"object": Required[Literal["evaluation"]], "status": Required[Literal["skipped"]], "reason": Required[Literal["billing_overdue", "service_inactive", "insufficient_credits", "benefit_paused"]]}, total=False)
|
|
332
|
+
|
|
333
|
+
EvaluationsFiltersInput = TypedDict("EvaluationsFiltersInput", {"days": NotRequired[int]}, total=False)
|
|
334
|
+
|
|
335
|
+
EvaluationsFiltersResponseReasonsItem = TypedDict("EvaluationsFiltersResponseReasonsItem", {"code": Required[str], "label": Required[str]}, total=False)
|
|
336
|
+
|
|
337
|
+
EvaluationsFiltersResponse = TypedDict("EvaluationsFiltersResponse", {"object": Required[Literal["evaluation_filters"]], "days": Required[int | None], "benefits": Required[list[str]], "results": Required[list[Literal["allow", "deny"]]], "reasons": Required[list[EvaluationsFiltersResponseReasonsItem]]}, total=False)
|
|
338
|
+
|
|
339
|
+
EvaluationsGetResponseReasonVariant0 = TypedDict("EvaluationsGetResponseReasonVariant0", {"code": Required[str], "message": Required[str], "rule": NotRequired[str]}, total=False)
|
|
340
|
+
|
|
341
|
+
EvaluationsGetResponseOutcome = TypedDict("EvaluationsGetResponseOutcome", {"state": Required[str | None], "due_at": NotRequired[str | None]}, total=False)
|
|
342
|
+
|
|
343
|
+
EvaluationsGetResponseRisk = TypedDict("EvaluationsGetResponseRisk", {"score": Required[float | None], "band": Required[Literal["low", "elevated", "high", "not_assessed"]]}, total=False)
|
|
344
|
+
|
|
345
|
+
EvaluationsGetResponseInputs = TypedDict("EvaluationsGetResponseInputs", {"email": Required[Literal["received", "missing"]], "ip": Required[Literal["received", "missing"]], "user_id": Required[Literal["received", "missing"]], "phone": Required[Literal["received", "missing"]], "payment": Required[Literal["received", "missing"]], "device": Required[Literal["received", "missing"]], "browser": Required[Literal["received", "missing"]]}, total=False)
|
|
346
|
+
|
|
347
|
+
EvaluationsGetResponsePolicy = TypedDict("EvaluationsGetResponsePolicy", {"id": Required[str | None], "version": Required[float | None]}, total=False)
|
|
348
|
+
|
|
349
|
+
EvaluationsGetResponseAccessListEntryVariant0 = TypedDict("EvaluationsGetResponseAccessListEntryVariant0", {"id": Required[str | None], "kind": Required[Literal["allow", "block"]], "type": Required[str | None], "value": Required[str | None]}, total=False)
|
|
350
|
+
|
|
351
|
+
EvaluationsGetResponse = TypedDict("EvaluationsGetResponse", {"object": Required[Literal["evaluation"]], "id": Required[str], "benefit": Required[str | None], "claim_id": Required[str | None], "result": Required[Literal["allow", "deny"]], "reason": Required[EvaluationsGetResponseReasonVariant0 | None], "outcome": Required[EvaluationsGetResponseOutcome], "policy_version": Required[float | None], "created_at": Required[str | None], "mode": Required[Literal["protect", "observe"]], "observed_result": NotRequired[Literal["allow", "deny"] | None], "risk": Required[EvaluationsGetResponseRisk], "inputs": Required[EvaluationsGetResponseInputs], "browser_data": Required[Literal["collected", "consent_declined", "not_loaded", "blocked", "timed_out", "failed", "site_not_listed", "sdk_outdated", "expired", "not_passed_on", "not_sent"] | None], "policy": Required[EvaluationsGetResponsePolicy], "access_list_entry": Required[EvaluationsGetResponseAccessListEntryVariant0 | None]}, total=False)
|
|
352
|
+
|
|
353
|
+
EvaluationsGraphResponse = TypedDict("EvaluationsGraphResponse", {"object": Required[str]}, total=False)
|
|
354
|
+
|
|
355
|
+
EvaluationsEvidenceResponseReasonVariant0 = TypedDict("EvaluationsEvidenceResponseReasonVariant0", {"code": Required[str], "message": Required[str], "rule": NotRequired[str]}, total=False)
|
|
356
|
+
|
|
357
|
+
EvaluationsEvidenceResponseOutcome = TypedDict("EvaluationsEvidenceResponseOutcome", {"state": Required[str | None], "due_at": NotRequired[str | None]}, total=False)
|
|
358
|
+
|
|
359
|
+
EvaluationsEvidenceResponseRisk = TypedDict("EvaluationsEvidenceResponseRisk", {"score": Required[float | None], "band": Required[Literal["low", "elevated", "high", "not_assessed"]]}, total=False)
|
|
360
|
+
|
|
361
|
+
EvaluationsEvidenceResponseSignalsItem = TypedDict("EvaluationsEvidenceResponseSignalsItem", {"family": Required[Literal["identity", "device", "network", "benefit_history"]], "assessment": Required[Literal["clear", "elevated", "high", "unavailable"]]}, total=False)
|
|
362
|
+
|
|
363
|
+
EvaluationsEvidenceResponseInputs = TypedDict("EvaluationsEvidenceResponseInputs", {"email": Required[Literal["received", "missing"]], "ip": Required[Literal["received", "missing"]], "user_id": Required[Literal["received", "missing"]], "phone": Required[Literal["received", "missing"]], "payment": Required[Literal["received", "missing"]], "device": Required[Literal["received", "missing"]], "browser": Required[Literal["received", "missing"]]}, total=False)
|
|
364
|
+
|
|
365
|
+
EvaluationsEvidenceResponsePolicy = TypedDict("EvaluationsEvidenceResponsePolicy", {"id": Required[str | None], "version": Required[float | None]}, total=False)
|
|
366
|
+
|
|
367
|
+
EvaluationsEvidenceResponseAccessListEntryVariant0 = TypedDict("EvaluationsEvidenceResponseAccessListEntryVariant0", {"id": Required[str | None], "kind": Required[Literal["allow", "block"]], "type": Required[str | None], "value": Required[str | None]}, total=False)
|
|
368
|
+
|
|
369
|
+
EvaluationsEvidenceResponseEvidenceDeviceProfile = TypedDict("EvaluationsEvidenceResponseEvidenceDeviceProfile", {"status": Required[Literal["captured", "not_retained"]], "expires_at": Required[str | None]}, total=False)
|
|
370
|
+
|
|
371
|
+
EvaluationsEvidenceResponseEvidence = TypedDict("EvaluationsEvidenceResponseEvidence", {"request": Required[dict[str, Any] | None], "device_profile": Required[EvaluationsEvidenceResponseEvidenceDeviceProfile]}, total=False)
|
|
372
|
+
|
|
373
|
+
EvaluationsEvidenceResponse = TypedDict("EvaluationsEvidenceResponse", {"object": Required[Literal["evaluation"]], "id": Required[str], "benefit": Required[str | None], "claim_id": Required[str | None], "result": Required[Literal["allow", "deny"]], "reason": Required[EvaluationsEvidenceResponseReasonVariant0 | None], "outcome": Required[EvaluationsEvidenceResponseOutcome], "policy_version": Required[float | None], "created_at": Required[str | None], "mode": Required[Literal["protect", "observe"]], "observed_result": NotRequired[Literal["allow", "deny"] | None], "risk": Required[EvaluationsEvidenceResponseRisk], "signals": Required[list[EvaluationsEvidenceResponseSignalsItem]], "inputs": Required[EvaluationsEvidenceResponseInputs], "browser_data": Required[Literal["collected", "consent_declined", "not_loaded", "blocked", "timed_out", "failed", "site_not_listed", "sdk_outdated", "expired", "not_passed_on", "not_sent"] | None], "policy": Required[EvaluationsEvidenceResponsePolicy], "access_list_entry": Required[EvaluationsEvidenceResponseAccessListEntryVariant0 | None], "evidence": Required[EvaluationsEvidenceResponseEvidence]}, total=False)
|
|
374
|
+
|
|
375
|
+
OutcomesListInput = TypedDict("OutcomesListInput", {"cursor": NotRequired[str], "limit": NotRequired[int]}, total=False)
|
|
376
|
+
|
|
377
|
+
OutcomesListResponseDataItem = TypedDict("OutcomesListResponseDataItem", {"object": Required[str]}, total=False)
|
|
378
|
+
|
|
379
|
+
OutcomesListResponse = TypedDict("OutcomesListResponse", {"object": Required[Literal["list"]], "data": Required[list[OutcomesListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
380
|
+
|
|
381
|
+
OutcomesGetResponse = TypedDict("OutcomesGetResponse", {"object": Required[str]}, total=False)
|
|
382
|
+
|
|
383
|
+
OutcomesReportInput = TypedDict("OutcomesReportInput", {"outcome": Required[Literal["granted", "not_granted", "reversed"]], "reason": NotRequired[str], "external_outcome_id": NotRequired[str]}, total=False)
|
|
384
|
+
|
|
385
|
+
OutcomesReportResponse = TypedDict("OutcomesReportResponse", {"object": Required[str]}, total=False)
|
|
386
|
+
|
|
387
|
+
EvaluationsDryRunInputSubject = TypedDict("EvaluationsDryRunInputSubject", {"external_id": NotRequired[str], "email": Required[str], "email_verified": NotRequired[bool]}, total=False)
|
|
388
|
+
|
|
389
|
+
EvaluationsDryRunInputContextVariant0 = TypedDict("EvaluationsDryRunInputContextVariant0", {"ip": NotRequired[str | None], "user_agent": NotRequired[str], "session_id": NotRequired[str]}, total=False)
|
|
390
|
+
|
|
391
|
+
EvaluationsDryRunInputIdentifiersPayment = TypedDict("EvaluationsDryRunInputIdentifiersPayment", {"provider": Required[str], "scope": Required[str], "fingerprint": Required[str]}, total=False)
|
|
392
|
+
|
|
393
|
+
EvaluationsDryRunInputIdentifiersPhoneHash = TypedDict("EvaluationsDryRunInputIdentifiersPhoneHash", {"algorithm": Required[Literal["hmac-sha256"]], "key_version": Required[str], "value": Required[str]}, total=False)
|
|
394
|
+
|
|
395
|
+
EvaluationsDryRunInputIdentifiersCustomItemValueHash = TypedDict("EvaluationsDryRunInputIdentifiersCustomItemValueHash", {"algorithm": Required[Literal["hmac-sha256"]], "key_version": Required[str], "value": Required[str]}, total=False)
|
|
396
|
+
|
|
397
|
+
EvaluationsDryRunInputIdentifiersCustomItem = TypedDict("EvaluationsDryRunInputIdentifiersCustomItem", {"key": Required[str], "value_hash": Required[EvaluationsDryRunInputIdentifiersCustomItemValueHash]}, total=False)
|
|
398
|
+
|
|
399
|
+
EvaluationsDryRunInputIdentifiers = TypedDict("EvaluationsDryRunInputIdentifiers", {"device_id": NotRequired[str], "device_token": NotRequired[str], "browser_cookie_id": NotRequired[str], "payment": NotRequired[EvaluationsDryRunInputIdentifiersPayment], "phone_hash": NotRequired[EvaluationsDryRunInputIdentifiersPhoneHash], "phone_verified": NotRequired[bool], "custom": NotRequired[list[EvaluationsDryRunInputIdentifiersCustomItem]]}, total=False)
|
|
400
|
+
|
|
401
|
+
EvaluationsDryRunInputRequest = TypedDict("EvaluationsDryRunInputRequest", {"method": Required[str], "url": Required[str], "headers": Required[dict[str, Any]]}, total=False)
|
|
402
|
+
|
|
403
|
+
EvaluationsDryRunInput = TypedDict("EvaluationsDryRunInput", {"benefit": Required[str], "claim_id": Required[str], "subject": Required[EvaluationsDryRunInputSubject], "context": NotRequired[EvaluationsDryRunInputContextVariant0 | None], "identifiers": NotRequired[EvaluationsDryRunInputIdentifiers], "request": NotRequired[EvaluationsDryRunInputRequest]}, total=False)
|
|
404
|
+
|
|
405
|
+
EvaluationsDryRunResponseVariant0Risk = TypedDict("EvaluationsDryRunResponseVariant0Risk", {"score": Required[float | None], "band": Required[Literal["low", "elevated", "high", "not_assessed"]]}, total=False)
|
|
406
|
+
|
|
407
|
+
EvaluationsDryRunResponseVariant0ReasonVariant0 = TypedDict("EvaluationsDryRunResponseVariant0ReasonVariant0", {"code": Required[str], "message": Required[str], "rule": NotRequired[str]}, total=False)
|
|
408
|
+
|
|
409
|
+
EvaluationsDryRunResponseVariant0Inputs = TypedDict("EvaluationsDryRunResponseVariant0Inputs", {"email": Required[Literal["received", "missing"]], "ip": Required[Literal["received", "missing"]], "user_id": Required[Literal["received", "missing"]], "phone": Required[Literal["received", "missing"]], "payment": Required[Literal["received", "missing"]], "device": Required[Literal["received", "missing"]], "browser": Required[Literal["received", "missing"]]}, total=False)
|
|
410
|
+
|
|
411
|
+
EvaluationsDryRunResponseVariant0 = TypedDict("EvaluationsDryRunResponseVariant0", {"object": Required[Literal["evaluation_dry_run"]], "dry_run": Required[Literal[True]], "result": Required[Literal["allow", "deny"]], "risk": Required[EvaluationsDryRunResponseVariant0Risk], "reason": Required[EvaluationsDryRunResponseVariant0ReasonVariant0 | None], "inputs": Required[EvaluationsDryRunResponseVariant0Inputs]}, total=False)
|
|
412
|
+
|
|
413
|
+
EvaluationsDryRunResponseVariant1 = TypedDict("EvaluationsDryRunResponseVariant1", {"object": Required[Literal["evaluation_dry_run"]], "status": Required[Literal["skipped"]], "reason": Required[Literal["billing_overdue", "service_inactive", "insufficient_credits", "benefit_paused"]]}, total=False)
|
|
414
|
+
|
|
415
|
+
SimulationsSequenceInput = TypedDict("SimulationsSequenceInput", {"benefit_id": Required[str], "policy_key": Required[str]}, total=False)
|
|
416
|
+
|
|
417
|
+
SimulationsSequenceResponse = TypedDict("SimulationsSequenceResponse", {"object": Required[str]}, total=False)
|
|
418
|
+
|
|
419
|
+
SimulationsReplayInput = TypedDict("SimulationsReplayInput", {"benefit_id": Required[str], "policy_key": Required[str]}, total=False)
|
|
420
|
+
|
|
421
|
+
SimulationsReplayResponse = TypedDict("SimulationsReplayResponse", {"object": Required[str]}, total=False)
|
|
422
|
+
|
|
423
|
+
BenefitsListInput = TypedDict("BenefitsListInput", {"cursor": NotRequired[str], "limit": NotRequired[int]}, total=False)
|
|
424
|
+
|
|
425
|
+
BenefitsListResponseDataItem = TypedDict("BenefitsListResponseDataItem", {"object": Required[str]}, total=False)
|
|
426
|
+
|
|
427
|
+
BenefitsListResponse = TypedDict("BenefitsListResponse", {"object": Required[Literal["list"]], "data": Required[list[BenefitsListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
428
|
+
|
|
429
|
+
BenefitsCreateInputConfigEligibilityVariant0 = TypedDict("BenefitsCreateInputConfigEligibilityVariant0", {"kind": Required[Literal["once"]]}, total=False)
|
|
430
|
+
|
|
431
|
+
BenefitsCreateInputConfigEligibilityVariant1 = TypedDict("BenefitsCreateInputConfigEligibilityVariant1", {"kind": Required[Literal["calendar"]], "period": Required[Literal["day", "week", "month"]], "timezone": Required[str]}, total=False)
|
|
432
|
+
|
|
433
|
+
BenefitsCreateInputConfigEligibilityVariant2 = TypedDict("BenefitsCreateInputConfigEligibilityVariant2", {"kind": Required[Literal["rolling"]], "days": Required[int]}, total=False)
|
|
434
|
+
|
|
435
|
+
BenefitsCreateInputConfigValue = TypedDict("BenefitsCreateInputConfigValue", {"amount": Required[float], "currency": Required[Literal["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XCG", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWG"]]}, total=False)
|
|
436
|
+
|
|
437
|
+
BenefitsCreateInputConfig = TypedDict("BenefitsCreateInputConfig", {"automation": NotRequired[Literal["allow_safe_automation", "allow_verified_agents", "deny_all_automation"]], "outcome_tracking": NotRequired[Literal["assume_granted", "report_outcome"]], "missing_outcome_behavior": NotRequired[Literal["hold_eligibility", "release_eligibility"]], "eligibility": NotRequired[BenefitsCreateInputConfigEligibilityVariant0 | BenefitsCreateInputConfigEligibilityVariant1 | BenefitsCreateInputConfigEligibilityVariant2], "value": NotRequired[BenefitsCreateInputConfigValue]}, total=False)
|
|
438
|
+
|
|
439
|
+
BenefitsCreateInput = TypedDict("BenefitsCreateInput", {"name": Required[str], "key": Required[str], "config": Required[BenefitsCreateInputConfig], "policy_key": Required[str], "protection_mode": Required[Literal["protect", "observe"]]}, total=False)
|
|
440
|
+
|
|
441
|
+
BenefitsCreateResponse = TypedDict("BenefitsCreateResponse", {"object": Required[str]}, total=False)
|
|
442
|
+
|
|
443
|
+
BenefitsGetResponse = TypedDict("BenefitsGetResponse", {"object": Required[str]}, total=False)
|
|
444
|
+
|
|
445
|
+
BenefitsUpdateInputConfigEligibilityVariant0 = TypedDict("BenefitsUpdateInputConfigEligibilityVariant0", {"kind": Required[Literal["once"]]}, total=False)
|
|
446
|
+
|
|
447
|
+
BenefitsUpdateInputConfigEligibilityVariant1 = TypedDict("BenefitsUpdateInputConfigEligibilityVariant1", {"kind": Required[Literal["calendar"]], "period": Required[Literal["day", "week", "month"]], "timezone": Required[str]}, total=False)
|
|
448
|
+
|
|
449
|
+
BenefitsUpdateInputConfigEligibilityVariant2 = TypedDict("BenefitsUpdateInputConfigEligibilityVariant2", {"kind": Required[Literal["rolling"]], "days": Required[int]}, total=False)
|
|
450
|
+
|
|
451
|
+
BenefitsUpdateInputConfigValue = TypedDict("BenefitsUpdateInputConfigValue", {"amount": Required[float], "currency": Required[Literal["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XCG", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWG"]]}, total=False)
|
|
452
|
+
|
|
453
|
+
BenefitsUpdateInputConfig = TypedDict("BenefitsUpdateInputConfig", {"automation": NotRequired[Literal["allow_safe_automation", "allow_verified_agents", "deny_all_automation"]], "outcome_tracking": NotRequired[Literal["assume_granted", "report_outcome"]], "missing_outcome_behavior": NotRequired[Literal["hold_eligibility", "release_eligibility"]], "eligibility": NotRequired[BenefitsUpdateInputConfigEligibilityVariant0 | BenefitsUpdateInputConfigEligibilityVariant1 | BenefitsUpdateInputConfigEligibilityVariant2], "value": NotRequired[BenefitsUpdateInputConfigValue]}, total=False)
|
|
454
|
+
|
|
455
|
+
BenefitsUpdateInput = TypedDict("BenefitsUpdateInput", {"name": Required[str], "config": Required[BenefitsUpdateInputConfig], "policy_key": Required[str], "protection_mode": Required[Literal["protect", "observe"]], "revision": Required[int]}, total=False)
|
|
456
|
+
|
|
457
|
+
BenefitsUpdateResponse = TypedDict("BenefitsUpdateResponse", {"object": Required[str]}, total=False)
|
|
458
|
+
|
|
459
|
+
BenefitsDeleteResponse = TypedDict("BenefitsDeleteResponse", {"object": Required[Literal["deleted"]], "id": Required[str | None], "deleted": Required[Literal[True]]}, total=False)
|
|
460
|
+
|
|
461
|
+
PoliciesListInput = TypedDict("PoliciesListInput", {"cursor": NotRequired[str], "limit": NotRequired[int]}, total=False)
|
|
462
|
+
|
|
463
|
+
PoliciesListResponseDataItem = TypedDict("PoliciesListResponseDataItem", {"object": Required[str]}, total=False)
|
|
464
|
+
|
|
465
|
+
PoliciesListResponse = TypedDict("PoliciesListResponse", {"object": Required[Literal["list"]], "data": Required[list[PoliciesListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
466
|
+
|
|
467
|
+
PoliciesCreateInputDefinitionRulesItem = TypedDict("PoliciesCreateInputDefinitionRulesItem", {"id": Required[str], "name": Required[str], "result": Required[Literal["allow", "deny"]], "when": Required[Any], "enabled": NotRequired[bool], "note": NotRequired[str]}, total=False)
|
|
468
|
+
|
|
469
|
+
PoliciesCreateInputDefinition = TypedDict("PoliciesCreateInputDefinition", {"base": NotRequired[Literal["balanced", "lenient", "strict"]], "risk_threshold": NotRequired[int | None], "default_result": Required[Literal["allow", "deny"]], "rules": Required[list[PoliciesCreateInputDefinitionRulesItem]]}, total=False)
|
|
470
|
+
|
|
471
|
+
PoliciesCreateInput = TypedDict("PoliciesCreateInput", {"name": Required[str], "key": Required[str], "definition": Required[PoliciesCreateInputDefinition]}, total=False)
|
|
472
|
+
|
|
473
|
+
PoliciesCreateResponse = TypedDict("PoliciesCreateResponse", {"object": Required[str]}, total=False)
|
|
474
|
+
|
|
475
|
+
PoliciesGetResponse = TypedDict("PoliciesGetResponse", {"object": Required[str]}, total=False)
|
|
476
|
+
|
|
477
|
+
PoliciesUpdateInputDefinitionRulesItem = TypedDict("PoliciesUpdateInputDefinitionRulesItem", {"id": Required[str], "name": Required[str], "result": Required[Literal["allow", "deny"]], "when": Required[Any], "enabled": NotRequired[bool], "note": NotRequired[str]}, total=False)
|
|
478
|
+
|
|
479
|
+
PoliciesUpdateInputDefinition = TypedDict("PoliciesUpdateInputDefinition", {"base": NotRequired[Literal["balanced", "lenient", "strict"]], "risk_threshold": NotRequired[int | None], "default_result": Required[Literal["allow", "deny"]], "rules": Required[list[PoliciesUpdateInputDefinitionRulesItem]]}, total=False)
|
|
480
|
+
|
|
481
|
+
PoliciesUpdateInput = TypedDict("PoliciesUpdateInput", {"name": Required[str], "definition": Required[PoliciesUpdateInputDefinition], "revision": Required[int], "restored_from": NotRequired[int]}, total=False)
|
|
482
|
+
|
|
483
|
+
PoliciesUpdateResponse = TypedDict("PoliciesUpdateResponse", {"object": Required[str]}, total=False)
|
|
484
|
+
|
|
485
|
+
PoliciesDeleteResponse = TypedDict("PoliciesDeleteResponse", {"object": Required[Literal["deleted"]], "id": Required[str | None], "deleted": Required[Literal[True]]}, total=False)
|
|
486
|
+
|
|
487
|
+
PoliciesDuplicateInput = TypedDict("PoliciesDuplicateInput", {"name": Required[str], "key": Required[str]}, total=False)
|
|
488
|
+
|
|
489
|
+
PoliciesDuplicateResponse = TypedDict("PoliciesDuplicateResponse", {"object": Required[str]}, total=False)
|
|
490
|
+
|
|
491
|
+
PoliciesVersionsResponseDataItem = TypedDict("PoliciesVersionsResponseDataItem", {"object": Required[str]}, total=False)
|
|
492
|
+
|
|
493
|
+
PoliciesVersionsResponse = TypedDict("PoliciesVersionsResponse", {"object": Required[Literal["list"]], "data": Required[list[PoliciesVersionsResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
494
|
+
|
|
495
|
+
PoliciesVersionResponse = TypedDict("PoliciesVersionResponse", {"object": Required[str]}, total=False)
|
|
496
|
+
|
|
497
|
+
PoliciesSignalsResponseDataItem = TypedDict("PoliciesSignalsResponseDataItem", {"object": Required[str]}, total=False)
|
|
498
|
+
|
|
499
|
+
PoliciesSignalsResponse = TypedDict("PoliciesSignalsResponse", {"object": Required[Literal["list"]], "data": Required[list[PoliciesSignalsResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
500
|
+
|
|
501
|
+
AccessListsListInput = TypedDict("AccessListsListInput", {"cursor": NotRequired[str], "limit": NotRequired[int], "value": NotRequired[str]}, total=False)
|
|
502
|
+
|
|
503
|
+
AccessListsListResponseDataItem = TypedDict("AccessListsListResponseDataItem", {"object": Required[str]}, total=False)
|
|
504
|
+
|
|
505
|
+
AccessListsListResponse = TypedDict("AccessListsListResponse", {"object": Required[Literal["list"]], "data": Required[list[AccessListsListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
506
|
+
|
|
507
|
+
AccessListsCreateInput = TypedDict("AccessListsCreateInput", {"kind": Required[Literal["allow", "block"]], "type": Required[Literal["email", "domain", "ip", "user", "device_id"]], "value": NotRequired[str], "values": NotRequired[list[str]], "benefit_ids": NotRequired[list[str]], "reason": Required[str], "expires_at": NotRequired[str | None], "expires_in_days": NotRequired[int | None]}, total=False)
|
|
508
|
+
|
|
509
|
+
AccessListsCreateResponse = TypedDict("AccessListsCreateResponse", {"object": Required[str]}, total=False)
|
|
510
|
+
|
|
511
|
+
AccessListsGetResponse = TypedDict("AccessListsGetResponse", {"object": Required[str]}, total=False)
|
|
512
|
+
|
|
513
|
+
AccessListsDeleteResponse = TypedDict("AccessListsDeleteResponse", {"object": Required[Literal["deleted"]], "id": Required[str | None], "deleted": Required[Literal[True]]}, total=False)
|
|
514
|
+
|
|
515
|
+
AccessListsUpdateInput = TypedDict("AccessListsUpdateInput", {"kind": NotRequired[Literal["allow", "block"]], "benefit_ids": NotRequired[list[str]], "reason": NotRequired[str], "expires_at": NotRequired[str | None], "expires_in_days": NotRequired[int | None]}, total=False)
|
|
516
|
+
|
|
517
|
+
AccessListsUpdateResponse = TypedDict("AccessListsUpdateResponse", {"object": Required[str]}, total=False)
|
|
518
|
+
|
|
519
|
+
IdentifiersLookupInput = TypedDict("IdentifiersLookupInput", {"value": Required[str]}, total=False)
|
|
520
|
+
|
|
521
|
+
IdentifiersLookupResponseMatchesItemVariant0 = TypedDict("IdentifiersLookupResponseMatchesItemVariant0", {"object": Required[Literal["lookup_match"]], "kind": Required[Literal["evaluation"]], "id": Required[str], "result": Required[Literal["allow", "deny"] | None], "benefit": Required[str | None]}, total=False)
|
|
522
|
+
|
|
523
|
+
IdentifiersLookupResponseMatchesItemVariant1 = TypedDict("IdentifiersLookupResponseMatchesItemVariant1", {"object": Required[Literal["lookup_match"]], "kind": Required[Literal["evaluations"]], "count": Required[int], "capped": Required[bool], "days": Required[Literal[90]]}, total=False)
|
|
524
|
+
|
|
525
|
+
IdentifiersLookupResponseMatchesItemVariant2 = TypedDict("IdentifiersLookupResponseMatchesItemVariant2", {"object": Required[Literal["lookup_match"]], "kind": Required[Literal["claim_history"]], "count": Required[int], "capped": Required[bool]}, total=False)
|
|
526
|
+
|
|
527
|
+
IdentifiersLookupResponseMatchesItemVariant3 = TypedDict("IdentifiersLookupResponseMatchesItemVariant3", {"object": Required[Literal["lookup_match"]], "kind": Required[Literal["benefit"]], "id": Required[str], "key": Required[str], "name": Required[str]}, total=False)
|
|
528
|
+
|
|
529
|
+
IdentifiersLookupResponseMatchesItemVariant4 = TypedDict("IdentifiersLookupResponseMatchesItemVariant4", {"object": Required[Literal["lookup_match"]], "kind": Required[Literal["policy"]], "id": Required[str], "key": Required[str], "name": Required[str]}, total=False)
|
|
530
|
+
|
|
531
|
+
IdentifiersLookupResponseMatchesItemVariant5 = TypedDict("IdentifiersLookupResponseMatchesItemVariant5", {"object": Required[Literal["lookup_match"]], "kind": Required[Literal["protection_level"]], "id": Required[str], "key": Required[str], "name": Required[str]}, total=False)
|
|
532
|
+
|
|
533
|
+
IdentifiersLookupResponseMatchesItemVariant6 = TypedDict("IdentifiersLookupResponseMatchesItemVariant6", {"object": Required[Literal["lookup_match"]], "kind": Required[Literal["access_list_entry"]], "id": Required[str], "list": Required[Literal["allow", "block"]], "type": Required[str]}, total=False)
|
|
534
|
+
|
|
535
|
+
IdentifiersLookupResponseMatchesItemVariant7 = TypedDict("IdentifiersLookupResponseMatchesItemVariant7", {"object": Required[Literal["lookup_match"]], "kind": Required[Literal["api_key"]], "id": Required[str], "name": Required[str]}, total=False)
|
|
536
|
+
|
|
537
|
+
IdentifiersLookupResponseMatchesItemVariant8 = TypedDict("IdentifiersLookupResponseMatchesItemVariant8", {"object": Required[Literal["lookup_match"]], "kind": Required[Literal["webhook_endpoint"]], "id": Required[str], "url": Required[str]}, total=False)
|
|
538
|
+
|
|
539
|
+
IdentifiersLookupResponseMatchesItemVariant9 = TypedDict("IdentifiersLookupResponseMatchesItemVariant9", {"object": Required[Literal["lookup_match"]], "kind": Required[Literal["member"]], "id": Required[str], "email": Required[str]}, total=False)
|
|
540
|
+
|
|
541
|
+
IdentifiersLookupResponseMatchesItemVariant10 = TypedDict("IdentifiersLookupResponseMatchesItemVariant10", {"object": Required[Literal["lookup_match"]], "kind": Required[Literal["import"]], "id": Required[str], "file_name": Required[str | None]}, total=False)
|
|
542
|
+
|
|
543
|
+
IdentifiersLookupResponseMatchesItemVariant11 = TypedDict("IdentifiersLookupResponseMatchesItemVariant11", {"object": Required[Literal["lookup_match"]], "kind": Required[Literal["custom_identifier"]], "id": Required[str], "key": Required[str]}, total=False)
|
|
544
|
+
|
|
545
|
+
IdentifiersLookupResponse = TypedDict("IdentifiersLookupResponse", {"object": Required[Literal["lookup"]], "type": Required[Literal["id", "email", "ip"] | None], "matches": Required[list[IdentifiersLookupResponseMatchesItemVariant0 | IdentifiersLookupResponseMatchesItemVariant1 | IdentifiersLookupResponseMatchesItemVariant2 | IdentifiersLookupResponseMatchesItemVariant3 | IdentifiersLookupResponseMatchesItemVariant4 | IdentifiersLookupResponseMatchesItemVariant5 | IdentifiersLookupResponseMatchesItemVariant6 | IdentifiersLookupResponseMatchesItemVariant7 | IdentifiersLookupResponseMatchesItemVariant8 | IdentifiersLookupResponseMatchesItemVariant9 | IdentifiersLookupResponseMatchesItemVariant10 | IdentifiersLookupResponseMatchesItemVariant11]]}, total=False)
|
|
546
|
+
|
|
547
|
+
CustomIdentifiersListInput = TypedDict("CustomIdentifiersListInput", {"cursor": NotRequired[str], "limit": NotRequired[int]}, total=False)
|
|
548
|
+
|
|
549
|
+
CustomIdentifiersListResponseDataItem = TypedDict("CustomIdentifiersListResponseDataItem", {"object": Required[str]}, total=False)
|
|
550
|
+
|
|
551
|
+
CustomIdentifiersListResponse = TypedDict("CustomIdentifiersListResponse", {"object": Required[Literal["list"]], "data": Required[list[CustomIdentifiersListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
552
|
+
|
|
553
|
+
CustomIdentifiersCreateInput = TypedDict("CustomIdentifiersCreateInput", {"key": Required[str], "key_version": Required[str], "description": Required[str]}, total=False)
|
|
554
|
+
|
|
555
|
+
CustomIdentifiersCreateResponse = TypedDict("CustomIdentifiersCreateResponse", {"object": Required[str]}, total=False)
|
|
556
|
+
|
|
557
|
+
CustomIdentifiersGetResponse = TypedDict("CustomIdentifiersGetResponse", {"object": Required[str]}, total=False)
|
|
558
|
+
|
|
559
|
+
CustomIdentifiersDeleteResponse = TypedDict("CustomIdentifiersDeleteResponse", {"object": Required[Literal["deleted"]], "id": Required[str | None], "deleted": Required[Literal[True]]}, total=False)
|
|
560
|
+
|
|
561
|
+
ImportsListInput = TypedDict("ImportsListInput", {"cursor": NotRequired[str], "limit": NotRequired[int]}, total=False)
|
|
562
|
+
|
|
563
|
+
ImportsListResponseDataItem = TypedDict("ImportsListResponseDataItem", {"object": Required[str]}, total=False)
|
|
564
|
+
|
|
565
|
+
ImportsListResponse = TypedDict("ImportsListResponse", {"object": Required[Literal["list"]], "data": Required[list[ImportsListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
566
|
+
|
|
567
|
+
ImportsCreateInputRowsItemSubject = TypedDict("ImportsCreateInputRowsItemSubject", {"email": Required[str], "external_id": NotRequired[str]}, total=False)
|
|
568
|
+
|
|
569
|
+
ImportsCreateInputRowsItemIdentifiersPayment = TypedDict("ImportsCreateInputRowsItemIdentifiersPayment", {"provider": Required[str], "scope": Required[str], "fingerprint": Required[str]}, total=False)
|
|
570
|
+
|
|
571
|
+
ImportsCreateInputRowsItemIdentifiers = TypedDict("ImportsCreateInputRowsItemIdentifiers", {"payment": NotRequired[ImportsCreateInputRowsItemIdentifiersPayment]}, total=False)
|
|
572
|
+
|
|
573
|
+
ImportsCreateInputRowsItem = TypedDict("ImportsCreateInputRowsItem", {"benefit": NotRequired[str], "subject": Required[ImportsCreateInputRowsItemSubject], "granted_on": NotRequired[str], "granted_time": NotRequired[str], "occurred_at": NotRequired[str], "claim_id": NotRequired[str], "identifiers": NotRequired[ImportsCreateInputRowsItemIdentifiers]}, total=False)
|
|
574
|
+
|
|
575
|
+
ImportsCreateInput = TypedDict("ImportsCreateInput", {"rows": Required[list[ImportsCreateInputRowsItem]], "benefit": NotRequired[str], "time_zone": NotRequired[str], "file_name": NotRequired[str], "confirm": NotRequired[bool]}, total=False)
|
|
576
|
+
|
|
577
|
+
ImportsCreateResponse = TypedDict("ImportsCreateResponse", {"object": Required[str]}, total=False)
|
|
578
|
+
|
|
579
|
+
ImportsCsvInputPayment = TypedDict("ImportsCsvInputPayment", {"provider": Required[str], "scope": Required[str]}, total=False)
|
|
580
|
+
|
|
581
|
+
ImportsCsvInput = TypedDict("ImportsCsvInput", {"benefit": NotRequired[str], "time_zone": NotRequired[str], "file_name": NotRequired[str], "rows": NotRequired[int], "payment": NotRequired[ImportsCsvInputPayment], "confirm": NotRequired[bool]}, total=False)
|
|
582
|
+
|
|
583
|
+
ImportsCsvResponse = TypedDict("ImportsCsvResponse", {"object": Required[str]}, total=False)
|
|
584
|
+
|
|
585
|
+
ImportsGetResponse = TypedDict("ImportsGetResponse", {"object": Required[str]}, total=False)
|
|
586
|
+
|
|
587
|
+
ImportsProblemsInput = TypedDict("ImportsProblemsInput", {"cursor": NotRequired[str], "limit": NotRequired[int]}, total=False)
|
|
588
|
+
|
|
589
|
+
ImportsProblemsResponseDataItem = TypedDict("ImportsProblemsResponseDataItem", {"object": Required[str]}, total=False)
|
|
590
|
+
|
|
591
|
+
ImportsProblemsResponse = TypedDict("ImportsProblemsResponse", {"object": Required[Literal["list"]], "data": Required[list[ImportsProblemsResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
592
|
+
|
|
593
|
+
ImportsProblemsDownloadResponse = TypedDict("ImportsProblemsDownloadResponse", {"object": Required[Literal["import_problems_download"]], "url": Required[str]}, total=False)
|
|
594
|
+
|
|
595
|
+
ImportsConfirmResponse = TypedDict("ImportsConfirmResponse", {"object": Required[str]}, total=False)
|
|
596
|
+
|
|
597
|
+
ImportsDiscardResponse = TypedDict("ImportsDiscardResponse", {"object": Required[str]}, total=False)
|
|
598
|
+
|
|
599
|
+
ImportsFixRowInputCells = TypedDict("ImportsFixRowInputCells", {"email": NotRequired[str], "benefit": NotRequired[str], "granted_on": NotRequired[str], "granted_time": NotRequired[str], "occurred_at": NotRequired[str], "user_id": NotRequired[str], "claim_id": NotRequired[str], "payment_fingerprint": NotRequired[str]}, total=False)
|
|
600
|
+
|
|
601
|
+
ImportsFixRowInput = TypedDict("ImportsFixRowInput", {"row": Required[int], "cells": Required[ImportsFixRowInputCells]}, total=False)
|
|
602
|
+
|
|
603
|
+
ImportsFixRowResponse = TypedDict("ImportsFixRowResponse", {"object": Required[Literal["import_row"]], "import": Required[str], "row": Required[int], "state": Required[Literal["ready", "present", "attention", "skipped"]], "kind": Required[str | None], "field": Required[str | None]}, total=False)
|
|
604
|
+
|
|
605
|
+
ImportsSkipRowInput = TypedDict("ImportsSkipRowInput", {"row": Required[int]}, total=False)
|
|
606
|
+
|
|
607
|
+
ImportsSkipRowResponse = TypedDict("ImportsSkipRowResponse", {"object": Required[str]}, total=False)
|
|
608
|
+
|
|
609
|
+
ExportsListInput = TypedDict("ExportsListInput", {"cursor": NotRequired[str], "limit": NotRequired[int]}, total=False)
|
|
610
|
+
|
|
611
|
+
ExportsListResponseDataItem = TypedDict("ExportsListResponseDataItem", {"object": Required[str]}, total=False)
|
|
612
|
+
|
|
613
|
+
ExportsListResponse = TypedDict("ExportsListResponse", {"object": Required[Literal["list"]], "data": Required[list[ExportsListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
614
|
+
|
|
615
|
+
ExportsCreateInput = TypedDict("ExportsCreateInput", {"days": NotRequired[int], "include_evidence": NotRequired[bool]}, total=False)
|
|
616
|
+
|
|
617
|
+
ExportsCreateResponse = TypedDict("ExportsCreateResponse", {"object": Required[str], "id": Required[str], "status": Required[str], "status_url": Required[str]}, total=False)
|
|
618
|
+
|
|
619
|
+
ExportsGetResponse = TypedDict("ExportsGetResponse", {"object": Required[str]}, total=False)
|
|
620
|
+
|
|
621
|
+
ExportsDownloadResponse = TypedDict("ExportsDownloadResponse", {"object": Required[str]}, total=False)
|
|
622
|
+
|
|
623
|
+
WorkspaceExportsCreateInput = TypedDict("WorkspaceExportsCreateInput", {"password": Required[str], "encryption": NotRequired[Literal["standard", "aes256"]]}, total=False)
|
|
624
|
+
|
|
625
|
+
WorkspaceExportsCreateResponseExportVariant0 = TypedDict("WorkspaceExportsCreateResponseExportVariant0", {"id": Required[str], "state": Required[Literal["building", "complete", "expired", "failed", "deleted"]], "requested_by_you": Required[bool], "requested_at": Required[str | None], "completed_at": Required[str | None], "expires_at": Required[str | None], "parts": Required[int | None], "bytes": Required[int | None], "can_delete": Required[bool]}, total=False)
|
|
626
|
+
|
|
627
|
+
WorkspaceExportsCreateResponse = TypedDict("WorkspaceExportsCreateResponse", {"object": Required[Literal["workspace_export_status"]], "export": Required[WorkspaceExportsCreateResponseExportVariant0 | None], "next_allowed_at": Required[str | None]}, total=False)
|
|
628
|
+
|
|
629
|
+
WorkspaceExportsStatusResponseExportVariant0 = TypedDict("WorkspaceExportsStatusResponseExportVariant0", {"id": Required[str], "state": Required[Literal["building", "complete", "expired", "failed", "deleted"]], "requested_by_you": Required[bool], "requested_at": Required[str | None], "completed_at": Required[str | None], "expires_at": Required[str | None], "parts": Required[int | None], "bytes": Required[int | None], "can_delete": Required[bool]}, total=False)
|
|
630
|
+
|
|
631
|
+
WorkspaceExportsStatusResponse = TypedDict("WorkspaceExportsStatusResponse", {"object": Required[Literal["workspace_export_status"]], "export": Required[WorkspaceExportsStatusResponseExportVariant0 | None], "next_allowed_at": Required[str | None]}, total=False)
|
|
632
|
+
|
|
633
|
+
WorkspaceExportsDownloadResponsePartsItem = TypedDict("WorkspaceExportsDownloadResponsePartsItem", {"part": Required[int], "bytes": Required[int], "file_name": Required[str], "url": Required[str]}, total=False)
|
|
634
|
+
|
|
635
|
+
WorkspaceExportsDownloadResponse = TypedDict("WorkspaceExportsDownloadResponse", {"object": Required[Literal["workspace_export_download"]], "id": Required[str], "expires_at": Required[str | None], "links_expire_at": Required[str | None], "parts": Required[list[WorkspaceExportsDownloadResponsePartsItem]]}, total=False)
|
|
636
|
+
|
|
637
|
+
WorkspaceExportsDeleteResponseExportVariant0 = TypedDict("WorkspaceExportsDeleteResponseExportVariant0", {"id": Required[str], "state": Required[Literal["building", "complete", "expired", "failed", "deleted"]], "requested_by_you": Required[bool], "requested_at": Required[str | None], "completed_at": Required[str | None], "expires_at": Required[str | None], "parts": Required[int | None], "bytes": Required[int | None], "can_delete": Required[bool]}, total=False)
|
|
638
|
+
|
|
639
|
+
WorkspaceExportsDeleteResponse = TypedDict("WorkspaceExportsDeleteResponse", {"object": Required[Literal["workspace_export_status"]], "export": Required[WorkspaceExportsDeleteResponseExportVariant0 | None], "next_allowed_at": Required[str | None]}, total=False)
|
|
640
|
+
|
|
641
|
+
DeletionsDryRunInputSelectorVariant0 = TypedDict("DeletionsDryRunInputSelectorVariant0", {"kind": Required[Literal["subject"]], "user": Required[str], "email": Required[bool]}, total=False)
|
|
642
|
+
|
|
643
|
+
DeletionsDryRunInputSelectorVariant1 = TypedDict("DeletionsDryRunInputSelectorVariant1", {"kind": Required[Literal["workspace"]]}, total=False)
|
|
644
|
+
|
|
645
|
+
DeletionsDryRunInput = TypedDict("DeletionsDryRunInput", {"selector": Required[DeletionsDryRunInputSelectorVariant0 | DeletionsDryRunInputSelectorVariant1]}, total=False)
|
|
646
|
+
|
|
647
|
+
DeletionsDryRunResponse = TypedDict("DeletionsDryRunResponse", {"object": Required[str]}, total=False)
|
|
648
|
+
|
|
649
|
+
DeletionsListInput = TypedDict("DeletionsListInput", {"cursor": NotRequired[str], "limit": NotRequired[int]}, total=False)
|
|
650
|
+
|
|
651
|
+
DeletionsListResponseDataItem = TypedDict("DeletionsListResponseDataItem", {"object": Required[str]}, total=False)
|
|
652
|
+
|
|
653
|
+
DeletionsListResponse = TypedDict("DeletionsListResponse", {"object": Required[Literal["list"]], "data": Required[list[DeletionsListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
654
|
+
|
|
655
|
+
DeletionsCreateInputSelectorVariant0 = TypedDict("DeletionsCreateInputSelectorVariant0", {"kind": Required[Literal["subject"]], "user": Required[str], "email": Required[bool]}, total=False)
|
|
656
|
+
|
|
657
|
+
DeletionsCreateInputSelectorVariant1 = TypedDict("DeletionsCreateInputSelectorVariant1", {"kind": Required[Literal["workspace"]]}, total=False)
|
|
658
|
+
|
|
659
|
+
DeletionsCreateInput = TypedDict("DeletionsCreateInput", {"selector": Required[DeletionsCreateInputSelectorVariant0 | DeletionsCreateInputSelectorVariant1]}, total=False)
|
|
660
|
+
|
|
661
|
+
DeletionsCreateResponse = TypedDict("DeletionsCreateResponse", {"object": Required[str], "id": Required[str], "status": Required[str], "status_url": Required[str]}, total=False)
|
|
662
|
+
|
|
663
|
+
DeletionsGetResponse = TypedDict("DeletionsGetResponse", {"object": Required[str]}, total=False)
|
|
664
|
+
|
|
665
|
+
AnalyticsListInput = TypedDict("AnalyticsListInput", {"days": NotRequired[int]}, total=False)
|
|
666
|
+
|
|
667
|
+
AnalyticsListResponseDataItem = TypedDict("AnalyticsListResponseDataItem", {"object": Required[str]}, total=False)
|
|
668
|
+
|
|
669
|
+
AnalyticsListResponse = TypedDict("AnalyticsListResponse", {"object": Required[Literal["list"]], "data": Required[list[AnalyticsListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
670
|
+
|
|
671
|
+
OverviewGetResponseEvaluations = TypedDict("OverviewGetResponseEvaluations", {"total": Required[int], "allowed": Required[int], "denied": Required[int], "waiting_for_confirmation": Required[int]}, total=False)
|
|
672
|
+
|
|
673
|
+
OverviewGetResponsePrevious = TypedDict("OverviewGetResponsePrevious", {"total": Required[int], "allowed": Required[int], "denied": Required[int], "waiting_for_confirmation": Required[int]}, total=False)
|
|
674
|
+
|
|
675
|
+
OverviewGetResponseApiRequests = TypedDict("OverviewGetResponseApiRequests", {"total": Required[int], "errors": Required[int]}, total=False)
|
|
676
|
+
|
|
677
|
+
OverviewGetResponseLatestEvaluationsItemReasonVariant0 = TypedDict("OverviewGetResponseLatestEvaluationsItemReasonVariant0", {"code": Required[str], "message": Required[str]}, total=False)
|
|
678
|
+
|
|
679
|
+
OverviewGetResponseLatestEvaluationsItemOutcome = TypedDict("OverviewGetResponseLatestEvaluationsItemOutcome", {"state": Required[str | None]}, total=False)
|
|
680
|
+
|
|
681
|
+
OverviewGetResponseLatestEvaluationsItem = TypedDict("OverviewGetResponseLatestEvaluationsItem", {"object": Required[Literal["evaluation"]], "id": Required[str], "benefit": Required[str], "claim_id": Required[str], "result": Required[Literal["allow", "deny"]], "mode": Required[Literal["protect", "observe"]], "observed_result": Required[Literal["allow", "deny"] | None], "reason": Required[OverviewGetResponseLatestEvaluationsItemReasonVariant0 | None], "outcome": Required[OverviewGetResponseLatestEvaluationsItemOutcome], "policy_version": Required[float | None], "browser_data": Required[Literal["collected", "consent_declined", "not_loaded", "blocked", "timed_out", "failed", "site_not_listed", "sdk_outdated", "expired", "not_passed_on", "not_sent"] | None], "created_at": Required[str | None]}, total=False)
|
|
682
|
+
|
|
683
|
+
OverviewGetResponse = TypedDict("OverviewGetResponse", {"object": Required[Literal["overview"]], "hours": Required[Literal[24]], "evaluations": Required[OverviewGetResponseEvaluations], "previous": Required[OverviewGetResponsePrevious], "api_requests": Required[OverviewGetResponseApiRequests], "last_evaluation_at": Required[str | None], "browser_issue": Required[Literal["not_passed_on", "site_not_listed", "sdk_outdated", "script_missing"] | None], "latest_evaluations": Required[list[OverviewGetResponseLatestEvaluationsItem]]}, total=False)
|
|
684
|
+
|
|
685
|
+
AnalyticsValueInput = TypedDict("AnalyticsValueInput", {"days": NotRequired[int], "currency": NotRequired[Literal["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XCG", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWG"]], "benefit": NotRequired[str]}, total=False)
|
|
686
|
+
|
|
687
|
+
AnalyticsValueResponseBenefitsItemValueVariant0 = TypedDict("AnalyticsValueResponseBenefitsItemValueVariant0", {"amount": Required[float], "currency": Required[str]}, total=False)
|
|
688
|
+
|
|
689
|
+
AnalyticsValueResponseBenefitsItem = TypedDict("AnalyticsValueResponseBenefitsItem", {"benefit": Required[str | None], "value": Required[AnalyticsValueResponseBenefitsItemValueVariant0 | None], "delivered": Required[float], "saved": Required[float]}, total=False)
|
|
690
|
+
|
|
691
|
+
AnalyticsValueResponse = TypedDict("AnalyticsValueResponse", {"object": Required[Literal["benefit_value"]], "currency": Required[str], "from": Required[str], "to": Required[str], "delivered": Required[float], "saved": Required[float], "benefits": Required[list[AnalyticsValueResponseBenefitsItem]]}, total=False)
|
|
692
|
+
|
|
693
|
+
AnalyticsDenialReasonsInput = TypedDict("AnalyticsDenialReasonsInput", {"days": NotRequired[int], "benefit": NotRequired[str]}, total=False)
|
|
694
|
+
|
|
695
|
+
AnalyticsDenialReasonsResponseReasonsItem = TypedDict("AnalyticsDenialReasonsResponseReasonsItem", {"code": Required[str], "label": Required[str], "count": Required[int]}, total=False)
|
|
696
|
+
|
|
697
|
+
AnalyticsDenialReasonsResponse = TypedDict("AnalyticsDenialReasonsResponse", {"object": Required[Literal["denial_reasons"]], "benefit": Required[str | None], "from": Required[str], "to": Required[str], "denied": Required[int], "reasons": Required[list[AnalyticsDenialReasonsResponseReasonsItem]]}, total=False)
|
|
698
|
+
|
|
699
|
+
RequestLogsListInput = TypedDict("RequestLogsListInput", {"cursor": NotRequired[str], "limit": NotRequired[int], "status": NotRequired[Literal["2xx", "4xx", "5xx"]], "key_id": NotRequired[str]}, total=False)
|
|
700
|
+
|
|
701
|
+
RequestLogsListResponseDataItem = TypedDict("RequestLogsListResponseDataItem", {"object": Required[str]}, total=False)
|
|
702
|
+
|
|
703
|
+
RequestLogsListResponse = TypedDict("RequestLogsListResponse", {"object": Required[Literal["list"]], "data": Required[list[RequestLogsListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
704
|
+
|
|
705
|
+
RequestLogsGetResponse = TypedDict("RequestLogsGetResponse", {"object": Required[str]}, total=False)
|
|
706
|
+
|
|
707
|
+
AuditLogsListInput = TypedDict("AuditLogsListInput", {"cursor": NotRequired[str], "limit": NotRequired[int]}, total=False)
|
|
708
|
+
|
|
709
|
+
AuditLogsListResponseDataItem = TypedDict("AuditLogsListResponseDataItem", {"object": Required[str]}, total=False)
|
|
710
|
+
|
|
711
|
+
AuditLogsListResponse = TypedDict("AuditLogsListResponse", {"object": Required[Literal["list"]], "data": Required[list[AuditLogsListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
712
|
+
|
|
713
|
+
AuditLogsGetResponse = TypedDict("AuditLogsGetResponse", {"object": Required[str]}, total=False)
|
|
714
|
+
|
|
715
|
+
AccountStatusGetResponsePlan = TypedDict("AccountStatusGetResponsePlan", {"plan": Required[Literal["payg", "pro", "scale"]], "name": Required[str], "interval": Required[Literal["month", "year"] | None], "enterprise": Required[bool], "renews_at": Required[str | None], "ends_at": Required[str | None]}, total=False)
|
|
716
|
+
|
|
717
|
+
AccountStatusGetResponseCredits = TypedDict("AccountStatusGetResponseCredits", {"available": Required[int], "allowance": Required[int], "pay_as_you_go": Required[int], "per_evaluation": Required[int], "evaluations_left": Required[int], "state": Required[Literal["ok", "low", "exhausted"]]}, total=False)
|
|
718
|
+
|
|
719
|
+
AccountStatusGetResponseLimitsProtectedBenefits = TypedDict("AccountStatusGetResponseLimitsProtectedBenefits", {"used": Required[int], "limit": Required[int]}, total=False)
|
|
720
|
+
|
|
721
|
+
AccountStatusGetResponseLimitsCustomPolicies = TypedDict("AccountStatusGetResponseLimitsCustomPolicies", {"used": Required[int], "limit": Required[int]}, total=False)
|
|
722
|
+
|
|
723
|
+
AccountStatusGetResponseLimitsTeamSeats = TypedDict("AccountStatusGetResponseLimitsTeamSeats", {"used": Required[int], "limit": Required[int]}, total=False)
|
|
724
|
+
|
|
725
|
+
AccountStatusGetResponseLimits = TypedDict("AccountStatusGetResponseLimits", {"protected_benefits": Required[AccountStatusGetResponseLimitsProtectedBenefits], "custom_policies": Required[AccountStatusGetResponseLimitsCustomPolicies], "team_seats": Required[AccountStatusGetResponseLimitsTeamSeats], "retention_days": Required[int], "rate": Required[int]}, total=False)
|
|
726
|
+
|
|
727
|
+
AccountStatusGetResponseAutoReload = TypedDict("AccountStatusGetResponseAutoReload", {"enabled": Required[bool]}, total=False)
|
|
728
|
+
|
|
729
|
+
AccountStatusGetResponse = TypedDict("AccountStatusGetResponse", {"object": Required[Literal["account_status"]], "workspace": Required[str], "plan": Required[AccountStatusGetResponsePlan], "credits": Required[AccountStatusGetResponseCredits], "limits": Required[AccountStatusGetResponseLimits], "auto_reload": Required[AccountStatusGetResponseAutoReload]}, total=False)
|
|
730
|
+
|
|
731
|
+
IntegrationStatusGetResponseApiKeys = TypedDict("IntegrationStatusGetResponseApiKeys", {"state": Required[Literal["ok", "none", "expiring", "refused"]], "next_step": Required[str | None]}, total=False)
|
|
732
|
+
|
|
733
|
+
IntegrationStatusGetResponseBrowserScript = TypedDict("IntegrationStatusGetResponseBrowserScript", {"state": Required[Literal["ok", "not_set_up", "not_passed_on", "site_not_listed", "sdk_outdated", "script_missing"]], "next_step": Required[str | None]}, total=False)
|
|
734
|
+
|
|
735
|
+
IntegrationStatusGetResponseEvaluations = TypedDict("IntegrationStatusGetResponseEvaluations", {"state": Required[Literal["ok", "none_yet", "stopped", "idle"]], "next_step": Required[str | None]}, total=False)
|
|
736
|
+
|
|
737
|
+
IntegrationStatusGetResponseOutcomes = TypedDict("IntegrationStatusGetResponseOutcomes", {"state": Required[Literal["ok", "not_needed", "missing"]], "next_step": Required[str | None]}, total=False)
|
|
738
|
+
|
|
739
|
+
IntegrationStatusGetResponseWebhooks = TypedDict("IntegrationStatusGetResponseWebhooks", {"state": Required[Literal["ok", "not_set_up", "failing", "disabled", "daily_limit", "unavailable"]], "next_step": Required[str | None]}, total=False)
|
|
740
|
+
|
|
741
|
+
IntegrationStatusGetResponseCredits = TypedDict("IntegrationStatusGetResponseCredits", {"state": Required[Literal["ok", "low", "exhausted", "payment_overdue"]], "next_step": Required[str | None]}, total=False)
|
|
742
|
+
|
|
743
|
+
IntegrationStatusGetResponse = TypedDict("IntegrationStatusGetResponse", {"object": Required[Literal["integration_status"]], "status": Required[Literal["ok", "attention"]], "api_keys": Required[IntegrationStatusGetResponseApiKeys], "browser_script": Required[IntegrationStatusGetResponseBrowserScript], "evaluations": Required[IntegrationStatusGetResponseEvaluations], "outcomes": Required[IntegrationStatusGetResponseOutcomes], "webhooks": Required[IntegrationStatusGetResponseWebhooks], "credits": Required[IntegrationStatusGetResponseCredits], "checked_at": Required[str | None]}, total=False)
|
|
744
|
+
|
|
745
|
+
EventsListInput = TypedDict("EventsListInput", {"cursor": NotRequired[str], "limit": NotRequired[int], "wait": NotRequired[int]}, total=False)
|
|
746
|
+
|
|
747
|
+
EventsListResponseDataItemDataVariant0 = TypedDict("EventsListResponseDataItemDataVariant0", {"object": Required[Literal["credits"]], "state": Required[Literal["low"]], "available": Required[int], "evaluations_left": Required[int], "days_left": Required[int | None]}, total=False)
|
|
748
|
+
|
|
749
|
+
EventsListResponseDataItemDataVariant1 = TypedDict("EventsListResponseDataItemDataVariant1", {"object": Required[Literal["credits"]], "state": Required[Literal["exhausted"]], "available": Required[int], "evaluations_left": Required[int], "days_left": Required[None]}, total=False)
|
|
750
|
+
|
|
751
|
+
EventsListResponseDataItemDataVariant2 = TypedDict("EventsListResponseDataItemDataVariant2", {"object": Required[Literal["payment"]], "status": Required[Literal["received"]], "purpose": Required[Literal["subscription", "credits", "auto_reload"]]}, total=False)
|
|
752
|
+
|
|
753
|
+
EventsListResponseDataItemDataVariant3 = TypedDict("EventsListResponseDataItemDataVariant3", {"object": Required[Literal["payment"]], "status": Required[Literal["failed"]], "purpose": Required[Literal["subscription", "credits", "auto_reload"]], "confirmation_required": Required[bool]}, total=False)
|
|
754
|
+
|
|
755
|
+
EventsListResponseDataItemDataVariant4PreviousVariant0 = TypedDict("EventsListResponseDataItemDataVariant4PreviousVariant0", {"plan": Required[Literal["payg", "pro", "scale"]], "name": Required[str], "interval": Required[Literal["month", "year"] | None]}, total=False)
|
|
756
|
+
|
|
757
|
+
EventsListResponseDataItemDataVariant4 = TypedDict("EventsListResponseDataItemDataVariant4", {"plan": Required[Literal["payg", "pro", "scale"]], "name": Required[str], "interval": Required[Literal["month", "year"] | None], "object": Required[Literal["plan"]], "previous": Required[EventsListResponseDataItemDataVariant4PreviousVariant0 | None]}, total=False)
|
|
758
|
+
|
|
759
|
+
EventsListResponseDataItemDataVariant5 = TypedDict("EventsListResponseDataItemDataVariant5", {"object": Required[Literal["workspace"]], "id": Required[str], "status": Required[Literal["suspended"]]}, total=False)
|
|
760
|
+
|
|
761
|
+
EventsListResponseDataItemDataVariant6 = TypedDict("EventsListResponseDataItemDataVariant6", {"object": Required[Literal["api_key"]], "id": Required[str], "name": Required[str], "type": Required[Literal["secret", "restricted"]], "expires_at": Required[str | None], "created_at": Required[str | None]}, total=False)
|
|
762
|
+
|
|
763
|
+
EventsListResponseDataItemDataVariant7 = TypedDict("EventsListResponseDataItemDataVariant7", {"object": Required[Literal["api_key"]], "id": Required[str], "name": Required[str], "type": Required[Literal["secret", "restricted"]], "expires_at": Required[str | None], "created_at": Required[str | None]}, total=False)
|
|
764
|
+
|
|
765
|
+
EventsListResponseDataItemDataVariant8 = TypedDict("EventsListResponseDataItemDataVariant8", {"object": Required[Literal["member"]], "id": Required[str], "name": Required[str | None], "role": Required[Literal["admin", "developer", "viewer"]], "joined_at": Required[str | None]}, total=False)
|
|
766
|
+
|
|
767
|
+
EventsListResponseDataItemDataVariant9OwnerVariant0 = TypedDict("EventsListResponseDataItemDataVariant9OwnerVariant0", {"id": Required[str], "name": Required[str | None]}, total=False)
|
|
768
|
+
|
|
769
|
+
EventsListResponseDataItemDataVariant9NewOwnerVariant0 = TypedDict("EventsListResponseDataItemDataVariant9NewOwnerVariant0", {"id": Required[str], "name": Required[str | None]}, total=False)
|
|
770
|
+
|
|
771
|
+
EventsListResponseDataItemDataVariant9 = TypedDict("EventsListResponseDataItemDataVariant9", {"object": Required[Literal["ownership_transfer"]], "status": Required[Literal["awaiting_owner", "awaiting_new_owner", "completed", "ended"]], "owner": Required[EventsListResponseDataItemDataVariant9OwnerVariant0 | None], "new_owner": Required[EventsListResponseDataItemDataVariant9NewOwnerVariant0 | None]}, total=False)
|
|
772
|
+
|
|
773
|
+
EventsListResponseDataItemDataVariant10 = TypedDict("EventsListResponseDataItemDataVariant10", {"object": Required[Literal["webhook_usage"]], "day": Required[str], "limit": Required[int]}, total=False)
|
|
774
|
+
|
|
775
|
+
EventsListResponseDataItem = TypedDict("EventsListResponseDataItem", {"object": Required[Literal["event"]], "id": Required[str], "type": Required[str], "api_version": Required[Literal["v1"]], "created_at": Required[str | None], "workspace": Required[str], "test": Required[Literal[False]], "data": Required[EventsListResponseDataItemDataVariant0 | EventsListResponseDataItemDataVariant1 | EventsListResponseDataItemDataVariant2 | EventsListResponseDataItemDataVariant3 | EventsListResponseDataItemDataVariant4 | EventsListResponseDataItemDataVariant5 | EventsListResponseDataItemDataVariant6 | EventsListResponseDataItemDataVariant7 | EventsListResponseDataItemDataVariant8 | EventsListResponseDataItemDataVariant9 | EventsListResponseDataItemDataVariant10 | dict[str, Any]]}, total=False)
|
|
776
|
+
|
|
777
|
+
EventsListResponse = TypedDict("EventsListResponse", {"object": Required[Literal["list"]], "data": Required[list[EventsListResponseDataItem]], "next_cursor": Required[str], "has_more": Required[bool]}, total=False)
|
|
778
|
+
|
|
779
|
+
BrowserCollectionGetResponseSitesItem = TypedDict("BrowserCollectionGetResponseSitesItem", {"origin": Required[str], "listed": Required[bool], "first_seen_at": Required[str | None], "last_seen_at": Required[str | None], "sdk_version": Required[str | None]}, total=False)
|
|
780
|
+
|
|
781
|
+
BrowserCollectionGetResponseCoverage = TypedDict("BrowserCollectionGetResponseCoverage", {"days": Required[Literal[7]], "total": Required[int], "collected": Required[int], "consent_declined": Required[int], "not_loaded": Required[int], "blocked": Required[int], "timed_out": Required[int], "failed": Required[int], "site_not_listed": Required[int], "sdk_outdated": Required[int], "expired": Required[int], "not_passed_on": Required[int], "not_sent": Required[int]}, total=False)
|
|
782
|
+
|
|
783
|
+
BrowserCollectionGetResponse = TypedDict("BrowserCollectionGetResponse", {"object": Required[Literal["browser_collection"]], "origins": Required[list[str]], "revision": Required[int], "sites": Required[list[BrowserCollectionGetResponseSitesItem]], "issue": Required[Literal["not_passed_on", "site_not_listed", "sdk_outdated", "script_missing"] | None], "issue_since": Required[str | None], "coverage": Required[BrowserCollectionGetResponseCoverage], "notices": Required[list[Literal["chrome", "edge", "firefox", "safari", "samsung", "opera", "other"]]]}, total=False)
|
|
784
|
+
|
|
785
|
+
BrowserCollectionUpdateInput = TypedDict("BrowserCollectionUpdateInput", {"origins": Required[list[str]], "revision": NotRequired[int]}, total=False)
|
|
786
|
+
|
|
787
|
+
BrowserCollectionUpdateResponseSitesItem = TypedDict("BrowserCollectionUpdateResponseSitesItem", {"origin": Required[str], "listed": Required[bool], "first_seen_at": Required[str | None], "last_seen_at": Required[str | None], "sdk_version": Required[str | None]}, total=False)
|
|
788
|
+
|
|
789
|
+
BrowserCollectionUpdateResponseCoverage = TypedDict("BrowserCollectionUpdateResponseCoverage", {"days": Required[Literal[7]], "total": Required[int], "collected": Required[int], "consent_declined": Required[int], "not_loaded": Required[int], "blocked": Required[int], "timed_out": Required[int], "failed": Required[int], "site_not_listed": Required[int], "sdk_outdated": Required[int], "expired": Required[int], "not_passed_on": Required[int], "not_sent": Required[int]}, total=False)
|
|
790
|
+
|
|
791
|
+
BrowserCollectionUpdateResponse = TypedDict("BrowserCollectionUpdateResponse", {"object": Required[Literal["browser_collection"]], "origins": Required[list[str]], "revision": Required[int], "sites": Required[list[BrowserCollectionUpdateResponseSitesItem]], "issue": Required[Literal["not_passed_on", "site_not_listed", "sdk_outdated", "script_missing"] | None], "issue_since": Required[str | None], "coverage": Required[BrowserCollectionUpdateResponseCoverage], "notices": Required[list[Literal["chrome", "edge", "firefox", "safari", "samsung", "opera", "other"]]]}, total=False)
|
|
792
|
+
|
|
793
|
+
BrowserCollectionScriptResponse = TypedDict("BrowserCollectionScriptResponse", {"object": Required[Literal["browser_script"]], "script": Required[str | None], "sdk_version": Required[str], "publishable_key": Required[str | None]}, total=False)
|
|
794
|
+
|
|
795
|
+
WebhookEndpointsListInput = TypedDict("WebhookEndpointsListInput", {"cursor": NotRequired[str], "limit": NotRequired[int]}, total=False)
|
|
796
|
+
|
|
797
|
+
WebhookEndpointsListResponseDataItem = TypedDict("WebhookEndpointsListResponseDataItem", {"object": Required[str]}, total=False)
|
|
798
|
+
|
|
799
|
+
WebhookEndpointsListResponse = TypedDict("WebhookEndpointsListResponse", {"object": Required[Literal["list"]], "data": Required[list[WebhookEndpointsListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
800
|
+
|
|
801
|
+
WebhookEndpointsCreateInput = TypedDict("WebhookEndpointsCreateInput", {"url": Required[str], "events": Required[list[Literal["evaluation.completed", "evaluation.skipped", "outcome.updated", "access_list_entry.created", "access_list_entry.updated", "access_list_entry.deleted", "import.completed", "export.completed", "data_deletion.completed", "credits.low", "credits.exhausted", "payment.received", "payment.failed", "plan.changed", "workspace.suspended", "api_key.created", "api_key.expiring", "member.joined", "ownership_transfer.updated", "webhook.daily_limit_reached"]]], "benefit_ids": NotRequired[list[str]], "denied_only": NotRequired[bool]}, total=False)
|
|
802
|
+
|
|
803
|
+
WebhookEndpointsCreateResponse = TypedDict("WebhookEndpointsCreateResponse", {"object": Required[Literal["webhook_endpoint"]], "id": Required[str | None], "url": Required[str], "description": Required[None], "events": Required[list[str]], "benefits": Required[list[str | None]], "denied_only": Required[bool], "status": Required[Literal["enabled", "disabled"]], "disabled_reason": Required[Literal["manual", "failures", "benefits_deleted"] | None], "last_success_at": Required[str | None], "revision": Required[int], "created_at": Required[str | None], "updated_at": Required[str | None]}, total=False)
|
|
804
|
+
|
|
805
|
+
WebhookEndpointsGetResponse = TypedDict("WebhookEndpointsGetResponse", {"object": Required[str]}, total=False)
|
|
806
|
+
|
|
807
|
+
WebhookEndpointsUpdateInput = TypedDict("WebhookEndpointsUpdateInput", {"revision": Required[int], "url": NotRequired[str], "events": NotRequired[list[Literal["evaluation.completed", "evaluation.skipped", "outcome.updated", "access_list_entry.created", "access_list_entry.updated", "access_list_entry.deleted", "import.completed", "export.completed", "data_deletion.completed", "credits.low", "credits.exhausted", "payment.received", "payment.failed", "plan.changed", "workspace.suspended", "api_key.created", "api_key.expiring", "member.joined", "ownership_transfer.updated", "webhook.daily_limit_reached"]]], "benefit_ids": NotRequired[list[str]], "denied_only": NotRequired[bool]}, total=False)
|
|
808
|
+
|
|
809
|
+
WebhookEndpointsUpdateResponse = TypedDict("WebhookEndpointsUpdateResponse", {"object": Required[Literal["webhook_endpoint"]], "id": Required[str | None], "url": Required[str], "description": Required[None], "events": Required[list[str]], "benefits": Required[list[str | None]], "denied_only": Required[bool], "status": Required[Literal["enabled", "disabled"]], "disabled_reason": Required[Literal["manual", "failures", "benefits_deleted"] | None], "last_success_at": Required[str | None], "revision": Required[int], "created_at": Required[str | None], "updated_at": Required[str | None]}, total=False)
|
|
810
|
+
|
|
811
|
+
WebhookEndpointsDeleteResponse = TypedDict("WebhookEndpointsDeleteResponse", {"object": Required[Literal["deleted"]], "id": Required[str | None], "deleted": Required[Literal[True]]}, total=False)
|
|
812
|
+
|
|
813
|
+
WebhookEndpointsTestInput = TypedDict("WebhookEndpointsTestInput", {"type": NotRequired[Literal["evaluation.completed", "evaluation.skipped", "outcome.updated", "access_list_entry.created", "access_list_entry.updated", "access_list_entry.deleted", "import.completed", "export.completed", "data_deletion.completed", "credits.low", "credits.exhausted", "payment.received", "payment.failed", "plan.changed", "workspace.suspended", "api_key.created", "api_key.expiring", "member.joined", "ownership_transfer.updated", "webhook.daily_limit_reached", "webhook.test"]]}, total=False)
|
|
814
|
+
|
|
815
|
+
WebhookEndpointsTestResponse = TypedDict("WebhookEndpointsTestResponse", {"object": Required[str]}, total=False)
|
|
816
|
+
|
|
817
|
+
WebhookEndpointsEnableResponse = TypedDict("WebhookEndpointsEnableResponse", {"object": Required[Literal["webhook_endpoint"]], "id": Required[str | None], "url": Required[str], "description": Required[None], "events": Required[list[str]], "benefits": Required[list[str | None]], "denied_only": Required[bool], "status": Required[Literal["enabled", "disabled"]], "disabled_reason": Required[Literal["manual", "failures", "benefits_deleted"] | None], "last_success_at": Required[str | None], "revision": Required[int], "created_at": Required[str | None], "updated_at": Required[str | None]}, total=False)
|
|
818
|
+
|
|
819
|
+
WebhookEndpointsDisableResponse = TypedDict("WebhookEndpointsDisableResponse", {"object": Required[Literal["webhook_endpoint"]], "id": Required[str | None], "url": Required[str], "description": Required[None], "events": Required[list[str]], "benefits": Required[list[str | None]], "denied_only": Required[bool], "status": Required[Literal["enabled", "disabled"]], "disabled_reason": Required[Literal["manual", "failures", "benefits_deleted"] | None], "last_success_at": Required[str | None], "revision": Required[int], "created_at": Required[str | None], "updated_at": Required[str | None]}, total=False)
|
|
820
|
+
|
|
821
|
+
WebhookEndpointsSecretResponse = TypedDict("WebhookEndpointsSecretResponse", {"object": Required[Literal["webhook_signing_secret"]], "endpoint": Required[str | None], "secret": Required[str]}, total=False)
|
|
822
|
+
|
|
823
|
+
WebhookEndpointsRotateSecretResponse = TypedDict("WebhookEndpointsRotateSecretResponse", {"object": Required[Literal["webhook_endpoint"]], "id": Required[str | None], "url": Required[str], "description": Required[None], "events": Required[list[str]], "benefits": Required[list[str | None]], "denied_only": Required[bool], "status": Required[Literal["enabled", "disabled"]], "disabled_reason": Required[Literal["manual", "failures", "benefits_deleted"] | None], "last_success_at": Required[str | None], "revision": Required[int], "created_at": Required[str | None], "updated_at": Required[str | None]}, total=False)
|
|
824
|
+
|
|
825
|
+
WebhookDeliveriesUsageResponse = TypedDict("WebhookDeliveriesUsageResponse", {"object": Required[Literal["webhook_usage"]], "day": Required[str], "deliveries": Required[int], "limit": Required[int], "limit_reached": Required[bool], "resets_at": Required[str | None]}, total=False)
|
|
826
|
+
|
|
827
|
+
WebhookDeliveriesListInput = TypedDict("WebhookDeliveriesListInput", {"cursor": NotRequired[str], "limit": NotRequired[int], "endpoint_id": NotRequired[str], "status": NotRequired[Literal["pending", "succeeded", "failed", "not_sent"]], "type": NotRequired[Literal["evaluation.completed", "evaluation.skipped", "outcome.updated", "access_list_entry.created", "access_list_entry.updated", "access_list_entry.deleted", "import.completed", "export.completed", "data_deletion.completed", "credits.low", "credits.exhausted", "payment.received", "payment.failed", "plan.changed", "workspace.suspended", "api_key.created", "api_key.expiring", "member.joined", "ownership_transfer.updated", "webhook.daily_limit_reached", "webhook.test"]], "event_id": NotRequired[str]}, total=False)
|
|
828
|
+
|
|
829
|
+
WebhookDeliveriesListResponseDataItem = TypedDict("WebhookDeliveriesListResponseDataItem", {"object": Required[str]}, total=False)
|
|
830
|
+
|
|
831
|
+
WebhookDeliveriesListResponse = TypedDict("WebhookDeliveriesListResponse", {"object": Required[Literal["list"]], "data": Required[list[WebhookDeliveriesListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
832
|
+
|
|
833
|
+
WebhookDeliveriesGetResponse = TypedDict("WebhookDeliveriesGetResponse", {"object": Required[str]}, total=False)
|
|
834
|
+
|
|
835
|
+
WebhookDeliveriesResendInput = TypedDict("WebhookDeliveriesResendInput", {"target": NotRequired[Literal["current", "original"]]}, total=False)
|
|
836
|
+
|
|
837
|
+
WebhookDeliveriesResendResponse = TypedDict("WebhookDeliveriesResendResponse", {"object": Required[str]}, total=False)
|
|
838
|
+
|
|
839
|
+
BillingPlanResponseScheduledChangeVariant0 = TypedDict("BillingPlanResponseScheduledChangeVariant0", {"plan": Required[Literal["payg", "pro", "scale"]], "name": Required[str], "interval": Required[Literal["month", "year"] | None], "at": Required[str | None]}, total=False)
|
|
840
|
+
|
|
841
|
+
BillingPlanResponsePayment = TypedDict("BillingPlanResponsePayment", {"state": Required[Literal["ok", "grace", "overdue"]], "due_at": Required[str | None]}, total=False)
|
|
842
|
+
|
|
843
|
+
BillingPlanResponseLimits = TypedDict("BillingPlanResponseLimits", {"protected_benefits": Required[int], "custom_policies": Required[int], "team_seats": Required[int], "retention_days": Required[int], "rate": Required[int]}, total=False)
|
|
844
|
+
|
|
845
|
+
BillingPlanResponseOverLimitVariant0ItemsItem = TypedDict("BillingPlanResponseOverLimitVariant0ItemsItem", {"kind": Required[Literal["benefit", "member"]], "id": Required[str | None], "name": Required[str], "paused": Required[bool], "will_pause": Required[bool]}, total=False)
|
|
846
|
+
|
|
847
|
+
BillingPlanResponseOverLimitVariant0 = TypedDict("BillingPlanResponseOverLimitVariant0", {"state": Required[Literal["grace", "enforced"]], "grace_until": Required[str | None], "items": Required[list[BillingPlanResponseOverLimitVariant0ItemsItem]]}, total=False)
|
|
848
|
+
|
|
849
|
+
BillingPlanResponse = TypedDict("BillingPlanResponse", {"object": Required[Literal["billing_plan"]], "plan": Required[Literal["payg", "pro", "scale"]], "name": Required[str], "interval": Required[Literal["month", "year"] | None], "subscribed": Required[bool], "renews_at": Required[str | None], "ends_at": Required[str | None], "scheduled_change": Required[BillingPlanResponseScheduledChangeVariant0 | None], "enterprise": Required[bool], "payment": Required[BillingPlanResponsePayment], "limits": Required[BillingPlanResponseLimits], "over_limit": Required[BillingPlanResponseOverLimitVariant0 | None]}, total=False)
|
|
850
|
+
|
|
851
|
+
BillingUsageResponseCredits = TypedDict("BillingUsageResponseCredits", {"available": Required[int], "allowance": Required[int], "pay_as_you_go": Required[int], "per_evaluation": Required[int]}, total=False)
|
|
852
|
+
|
|
853
|
+
BillingUsageResponseUsageAbsoluteAllowanceCredits = TypedDict("BillingUsageResponseUsageAbsoluteAllowanceCredits", {"used": Required[int], "total": Required[int]}, total=False)
|
|
854
|
+
|
|
855
|
+
BillingUsageResponseUsageAbsolutePayAsYouGoCredits = TypedDict("BillingUsageResponseUsageAbsolutePayAsYouGoCredits", {"used": Required[int], "total": Required[int]}, total=False)
|
|
856
|
+
|
|
857
|
+
BillingUsageResponseUsageAbsoluteProtectedBenefits = TypedDict("BillingUsageResponseUsageAbsoluteProtectedBenefits", {"used": Required[int], "total": Required[int]}, total=False)
|
|
858
|
+
|
|
859
|
+
BillingUsageResponseUsageAbsoluteTeamSeats = TypedDict("BillingUsageResponseUsageAbsoluteTeamSeats", {"used": Required[int], "total": Required[int]}, total=False)
|
|
860
|
+
|
|
861
|
+
BillingUsageResponseUsageAbsolute = TypedDict("BillingUsageResponseUsageAbsolute", {"allowance_credits": Required[BillingUsageResponseUsageAbsoluteAllowanceCredits], "pay_as_you_go_credits": Required[BillingUsageResponseUsageAbsolutePayAsYouGoCredits], "protected_benefits": Required[BillingUsageResponseUsageAbsoluteProtectedBenefits], "team_seats": Required[BillingUsageResponseUsageAbsoluteTeamSeats]}, total=False)
|
|
862
|
+
|
|
863
|
+
BillingUsageResponseUsageAllowanceVariant0AllowanceCredits = TypedDict("BillingUsageResponseUsageAllowanceVariant0AllowanceCredits", {"used": Required[int], "total": Required[int]}, total=False)
|
|
864
|
+
|
|
865
|
+
BillingUsageResponseUsageAllowanceVariant0PayAsYouGoCredits = TypedDict("BillingUsageResponseUsageAllowanceVariant0PayAsYouGoCredits", {"used": Required[int], "total": Required[int]}, total=False)
|
|
866
|
+
|
|
867
|
+
BillingUsageResponseUsageAllowanceVariant0ProtectedBenefits = TypedDict("BillingUsageResponseUsageAllowanceVariant0ProtectedBenefits", {"used": Required[int], "total": Required[int]}, total=False)
|
|
868
|
+
|
|
869
|
+
BillingUsageResponseUsageAllowanceVariant0TeamSeats = TypedDict("BillingUsageResponseUsageAllowanceVariant0TeamSeats", {"used": Required[int], "total": Required[int]}, total=False)
|
|
870
|
+
|
|
871
|
+
BillingUsageResponseUsageAllowanceVariant0 = TypedDict("BillingUsageResponseUsageAllowanceVariant0", {"allowance_credits": Required[BillingUsageResponseUsageAllowanceVariant0AllowanceCredits], "pay_as_you_go_credits": Required[BillingUsageResponseUsageAllowanceVariant0PayAsYouGoCredits], "protected_benefits": Required[BillingUsageResponseUsageAllowanceVariant0ProtectedBenefits], "team_seats": Required[BillingUsageResponseUsageAllowanceVariant0TeamSeats]}, total=False)
|
|
872
|
+
|
|
873
|
+
BillingUsageResponseUsage = TypedDict("BillingUsageResponseUsage", {"absolute": Required[BillingUsageResponseUsageAbsolute], "allowance": Required[BillingUsageResponseUsageAllowanceVariant0 | None]}, total=False)
|
|
874
|
+
|
|
875
|
+
BillingUsageResponseAutoReload = TypedDict("BillingUsageResponseAutoReload", {"enabled": Required[bool], "capped": Required[bool], "threshold": Required[int | None], "amount_dollars": Required[int | None], "monthly_cap_dollars": Required[int | None]}, total=False)
|
|
876
|
+
|
|
877
|
+
BillingUsageResponse = TypedDict("BillingUsageResponse", {"object": Required[Literal["billing_usage"]], "credits": Required[BillingUsageResponseCredits], "usage": Required[BillingUsageResponseUsage], "auto_reload": Required[BillingUsageResponseAutoReload]}, total=False)
|
|
878
|
+
|
|
879
|
+
BillingCreditHistoryInput = TypedDict("BillingCreditHistoryInput", {"cursor": NotRequired[str], "activity": NotRequired[Literal["evaluations", "webhooks", "plan_credits", "temporary_plan_credits", "enterprise_plan_credits", "purchase", "first_purchase_bonus", "survey_credits", "yearly_conversion", "expired", "ended", "replaced", "enterprise_plan_removed", "refund", "dispute", "adjustment"]], "direction": NotRequired[Literal["added", "used"]], "days": NotRequired[Literal[7] | Literal[30] | Literal[90] | Literal[365]], "from": NotRequired[str], "to": NotRequired[str]}, total=False)
|
|
880
|
+
|
|
881
|
+
BillingCreditHistoryResponseDataItem = TypedDict("BillingCreditHistoryResponseDataItem", {"object": Required[Literal["credit_entry"]], "date": Required[str], "daily_total": Required[bool], "activity": Required[Literal["evaluations", "webhooks", "plan_credits", "temporary_plan_credits", "enterprise_plan_credits", "purchase", "first_purchase_bonus", "survey_credits", "yearly_conversion", "expired", "ended", "replaced", "enterprise_plan_removed", "refund", "dispute", "adjustment"]], "sources": Required[list[Literal["plan", "temporary_plan", "enterprise_plan", "purchased", "bonus", "survey", "converted", "adjustment", "negative_balance"]]], "credits": Required[int], "plans": Required[list[str]], "enterprise_plans": Required[list[str]]}, total=False)
|
|
882
|
+
|
|
883
|
+
BillingCreditHistoryResponse = TypedDict("BillingCreditHistoryResponse", {"object": Required[Literal["list"]], "data": Required[list[BillingCreditHistoryResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
884
|
+
|
|
885
|
+
BillingDailyUsageResponseDaysItemTopBenefitVariant0 = TypedDict("BillingDailyUsageResponseDaysItemTopBenefitVariant0", {"name": Required[str], "evaluations": Required[int]}, total=False)
|
|
886
|
+
|
|
887
|
+
BillingDailyUsageResponseDaysItem = TypedDict("BillingDailyUsageResponseDaysItem", {"day": Required[str], "credits": Required[int], "top_benefit": Required[BillingDailyUsageResponseDaysItemTopBenefitVariant0 | None]}, total=False)
|
|
888
|
+
|
|
889
|
+
BillingDailyUsageResponse = TypedDict("BillingDailyUsageResponse", {"object": Required[Literal["daily_usage"]], "time_zone": Required[str], "days": Required[list[BillingDailyUsageResponseDaysItem]]}, total=False)
|
|
890
|
+
|
|
891
|
+
BillingEnterprisePlansResponseDataItemGrants = TypedDict("BillingEnterprisePlansResponseDataItemGrants", {"credits": Required[int], "credit_cadence": Required[Literal["once", "month", "year"] | None], "credit_expiry": Required[Literal["never", "period_end", "days"] | None], "credit_expiry_days": Required[int | None], "team_seats": Required[int], "protected_benefits": Required[int], "custom_policies": Required[int | None], "rate": Required[int | None], "burst": Required[int | None], "concurrency": Required[int | None], "retention_days": Required[int | None]}, total=False)
|
|
892
|
+
|
|
893
|
+
BillingEnterprisePlansResponseDataItem = TypedDict("BillingEnterprisePlansResponseDataItem", {"object": Required[Literal["enterprise_plan"]], "name": Required[str], "active": Required[bool], "added_at": Required[str | None], "ends_at": Required[str | None], "grants": Required[BillingEnterprisePlansResponseDataItemGrants]}, total=False)
|
|
894
|
+
|
|
895
|
+
BillingEnterprisePlansResponse = TypedDict("BillingEnterprisePlansResponse", {"object": Required[Literal["list"]], "data": Required[list[BillingEnterprisePlansResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
896
|
+
|
|
897
|
+
BillingCodesPreviewInput = TypedDict("BillingCodesPreviewInput", {"code": Required[str]}, total=False)
|
|
898
|
+
|
|
899
|
+
BillingCodesPreviewResponsePlan = TypedDict("BillingCodesPreviewResponsePlan", {"name": Required[str], "description": Required[str | None], "credits": Required[int], "credit_cadence": Required[Literal["once", "month", "year"] | None], "credit_expiry": Required[Literal["never", "period_end", "days"] | None], "credit_expiry_days": Required[int | None], "team_seats": Required[int], "protected_benefits": Required[int], "custom_policies": Required[int | None], "rate": Required[int | None], "burst": Required[int | None], "concurrency": Required[int | None], "retention_days": Required[int | None], "duration_months": Required[int | None]}, total=False)
|
|
900
|
+
|
|
901
|
+
BillingCodesPreviewResponse = TypedDict("BillingCodesPreviewResponse", {"object": Required[Literal["enterprise_plan_code_preview"]], "plan": Required[BillingCodesPreviewResponsePlan]}, total=False)
|
|
902
|
+
|
|
903
|
+
BillingUpcomingResponseDataItem = TypedDict("BillingUpcomingResponseDataItem", {"object": Required[Literal["upcoming_charge"]], "kind": Required[Literal["plan"]], "amount_cents": Required[int], "at": Required[str | None], "payment_method": Required[str | None], "discounted": Required[bool]}, total=False)
|
|
904
|
+
|
|
905
|
+
BillingUpcomingResponse = TypedDict("BillingUpcomingResponse", {"object": Required[Literal["list"]], "data": Required[list[BillingUpcomingResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
906
|
+
|
|
907
|
+
BillingInvoicesInput = TypedDict("BillingInvoicesInput", {"cursor": NotRequired[str]}, total=False)
|
|
908
|
+
|
|
909
|
+
BillingInvoicesResponseDataItemPeriodVariant0 = TypedDict("BillingInvoicesResponseDataItemPeriodVariant0", {"start": Required[str | None], "end": Required[str | None]}, total=False)
|
|
910
|
+
|
|
911
|
+
BillingInvoicesResponseDataItem = TypedDict("BillingInvoicesResponseDataItem", {"object": Required[Literal["invoice"]], "number": Required[str | None], "created_at": Required[str | None], "status": Required[Literal["open", "paid", "void", "uncollectible"]], "description": Required[str], "period": Required[BillingInvoicesResponseDataItemPeriodVariant0 | None], "total_cents": Required[int], "paid_cents": Required[int], "due_cents": Required[int], "refunded_cents": Required[int], "payable": Required[bool], "url": Required[str | None]}, total=False)
|
|
912
|
+
|
|
913
|
+
BillingInvoicesResponse = TypedDict("BillingInvoicesResponse", {"object": Required[Literal["list"]], "data": Required[list[BillingInvoicesResponseDataItem]], "next_cursor": Required[str | None], "outstanding_cents": Required[int | None]}, total=False)
|
|
914
|
+
|
|
915
|
+
BillingPaymentMethodsResponseDataItem = TypedDict("BillingPaymentMethodsResponseDataItem", {"object": Required[Literal["payment_method"]], "id": Required[str | None], "type": Required[Literal["card", "bank_account", "link"]], "brand": Required[str | None], "last4": Required[str | None], "exp_month": Required[int | None], "exp_year": Required[int | None], "label": Required[str], "default": Required[bool], "backup": Required[int | None], "declined": Required[bool], "expired": Required[bool]}, total=False)
|
|
916
|
+
|
|
917
|
+
BillingPaymentMethodsResponse = TypedDict("BillingPaymentMethodsResponse", {"object": Required[Literal["list"]], "data": Required[list[BillingPaymentMethodsResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
918
|
+
|
|
919
|
+
BillingDetailsResponseAddressVariant0 = TypedDict("BillingDetailsResponseAddressVariant0", {"line1": Required[str], "line2": Required[str], "city": Required[str], "state": Required[str], "postal_code": Required[str], "country": Required[str]}, total=False)
|
|
920
|
+
|
|
921
|
+
BillingDetailsResponseTaxIdVariant0 = TypedDict("BillingDetailsResponseTaxIdVariant0", {"type": Required[str], "value": Required[str]}, total=False)
|
|
922
|
+
|
|
923
|
+
BillingDetailsResponse = TypedDict("BillingDetailsResponse", {"object": Required[Literal["billing_details"]], "name": Required[str], "email": Required[str], "uses_account_email": Required[bool], "address": Required[BillingDetailsResponseAddressVariant0 | None], "tax_id": Required[BillingDetailsResponseTaxIdVariant0 | None]}, total=False)
|
|
924
|
+
|
|
925
|
+
BillingDetailsUpdateInputAddress = TypedDict("BillingDetailsUpdateInputAddress", {"line1": Required[str], "line2": Required[str], "city": Required[str], "state": Required[str], "postal_code": Required[str], "country": Required[str | Literal[""]]}, total=False)
|
|
926
|
+
|
|
927
|
+
BillingDetailsUpdateInputTaxIdVariant0 = TypedDict("BillingDetailsUpdateInputTaxIdVariant0", {"type": Required[Literal["eu_vat", "gb_vat", "us_ein", "ca_bn", "au_abn", "in_gst", "ch_vat", "no_vat", "nz_gst", "sg_gst", "ae_trn", "za_vat", "br_cnpj", "mx_rfc", "jp_cn"]], "value": Required[str]}, total=False)
|
|
928
|
+
|
|
929
|
+
BillingDetailsUpdateInput = TypedDict("BillingDetailsUpdateInput", {"name": Required[str], "email": Required[str | Literal[""]], "address": Required[BillingDetailsUpdateInputAddress], "tax_id": Required[BillingDetailsUpdateInputTaxIdVariant0 | None]}, total=False)
|
|
930
|
+
|
|
931
|
+
BillingDetailsUpdateResponseAddressVariant0 = TypedDict("BillingDetailsUpdateResponseAddressVariant0", {"line1": Required[str], "line2": Required[str], "city": Required[str], "state": Required[str], "postal_code": Required[str], "country": Required[str]}, total=False)
|
|
932
|
+
|
|
933
|
+
BillingDetailsUpdateResponseTaxIdVariant0 = TypedDict("BillingDetailsUpdateResponseTaxIdVariant0", {"type": Required[str], "value": Required[str]}, total=False)
|
|
934
|
+
|
|
935
|
+
BillingDetailsUpdateResponse = TypedDict("BillingDetailsUpdateResponse", {"object": Required[Literal["billing_details"]], "name": Required[str], "email": Required[str], "uses_account_email": Required[bool], "address": Required[BillingDetailsUpdateResponseAddressVariant0 | None], "tax_id": Required[BillingDetailsUpdateResponseTaxIdVariant0 | None]}, total=False)
|
|
936
|
+
|
|
937
|
+
BillingPaymentsGetResponse = TypedDict("BillingPaymentsGetResponse", {"object": Required[Literal["billing_payment"]], "id": Required[str | None], "kind": Required[Literal["credit_purchase", "auto_reload", "plan_change", "invoice_payment"]], "status": Required[Literal["succeeded", "pending", "requires_action", "failed", "canceled"]], "payment_page_url": Required[str | None], "credits": Required[int | None], "bonus_credits": Required[int | None], "scheduled": Required[bool]}, total=False)
|
|
938
|
+
|
|
939
|
+
BillingQuotesCreateInput = TypedDict("BillingQuotesCreateInput", {"plan": Required[Literal["payg", "pro", "scale"]], "interval": NotRequired[Literal["month", "year"] | None], "promo_code": NotRequired[str]}, total=False)
|
|
940
|
+
|
|
941
|
+
BillingQuotesCreateResponseNextChargeVariant0 = TypedDict("BillingQuotesCreateResponseNextChargeVariant0", {"amount_cents": Required[int], "at": Required[str | None], "discounted": Required[bool]}, total=False)
|
|
942
|
+
|
|
943
|
+
BillingQuotesCreateResponsePromotionVariant0 = TypedDict("BillingQuotesCreateResponsePromotionVariant0", {"code": Required[str], "amount_cents": Required[int], "full_cents": Required[int], "duration": Required[str]}, total=False)
|
|
944
|
+
|
|
945
|
+
BillingQuotesCreateResponse = TypedDict("BillingQuotesCreateResponse", {"object": Required[Literal["plan_change_quote"]], "id": Required[str | None], "plan": Required[Literal["payg", "pro", "scale"]], "interval": Required[Literal["month", "year"] | None], "direction": Required[Literal["upgrade", "downgrade", "switch"]], "timing": Required[Literal["immediate", "period_end"]], "confirmable": Required[bool], "charge_now_cents": Required[int], "renewal_cents": Required[int], "credits_now": Required[int], "effective_at": Required[str | None], "expires_at": Required[str | None], "next_charge": Required[BillingQuotesCreateResponseNextChargeVariant0 | None], "promotion": Required[BillingQuotesCreateResponsePromotionVariant0 | None]}, total=False)
|
|
946
|
+
|
|
947
|
+
BillingLowCreditAlertUpdateInput = TypedDict("BillingLowCreditAlertUpdateInput", {"credits": Required[int | None]}, total=False)
|
|
948
|
+
|
|
949
|
+
BillingLowCreditAlertUpdateResponse = TypedDict("BillingLowCreditAlertUpdateResponse", {"object": Required[Literal["low_credit_alert"]], "credits": Required[int | None]}, total=False)
|
|
950
|
+
|
|
951
|
+
BillingOverLimitChooseInput = TypedDict("BillingOverLimitChooseInput", {"kind": Required[Literal["benefit", "member"]], "keep_active": Required[str], "pause": Required[str]}, total=False)
|
|
952
|
+
|
|
953
|
+
BillingOverLimitChooseResponse = TypedDict("BillingOverLimitChooseResponse", {"object": Required[Literal["over_limit_choice"]], "status": Required[Literal["chosen", "swapped", "unchanged"]]}, total=False)
|
|
954
|
+
|
|
955
|
+
BillingAutoReloadUpdateInput = TypedDict("BillingAutoReloadUpdateInput", {"enabled": Required[bool], "threshold": Required[int | None], "amount_dollars": Required[int | None], "monthly_cap_dollars": NotRequired[int | None]}, total=False)
|
|
956
|
+
|
|
957
|
+
BillingAutoReloadUpdateResponse = TypedDict("BillingAutoReloadUpdateResponse", {"object": Required[Literal["auto_reload"]], "enabled": Required[bool], "capped": Required[bool], "threshold": Required[int | None], "amount_dollars": Required[int | None], "monthly_cap_dollars": Required[int | None], "spent_this_month_dollars": Required[int]}, total=False)
|
|
958
|
+
|
|
959
|
+
BillingCreditsBuyInput = TypedDict("BillingCreditsBuyInput", {"amount_dollars": Required[int]}, total=False)
|
|
960
|
+
|
|
961
|
+
BillingCreditsBuyResponse = TypedDict("BillingCreditsBuyResponse", {"object": Required[Literal["billing_payment"]], "id": Required[str | None], "kind": Required[Literal["credit_purchase", "auto_reload", "plan_change", "invoice_payment"]], "status": Required[Literal["succeeded", "pending", "requires_action", "failed", "canceled"]], "payment_page_url": Required[str | None], "credits": Required[int | None], "bonus_credits": Required[int | None], "scheduled": Required[bool]}, total=False)
|
|
962
|
+
|
|
963
|
+
BillingCreditsRetryInput = TypedDict("BillingCreditsRetryInput", {"payment_method_id": NotRequired[str]}, total=False)
|
|
964
|
+
|
|
965
|
+
BillingCreditsRetryResponse = TypedDict("BillingCreditsRetryResponse", {"object": Required[Literal["billing_payment"]], "id": Required[str | None], "kind": Required[Literal["credit_purchase", "auto_reload", "plan_change", "invoice_payment"]], "status": Required[Literal["succeeded", "pending", "requires_action", "failed", "canceled"]], "payment_page_url": Required[str | None], "credits": Required[int | None], "bonus_credits": Required[int | None], "scheduled": Required[bool]}, total=False)
|
|
966
|
+
|
|
967
|
+
BillingPlanChangeInput = TypedDict("BillingPlanChangeInput", {"payment_method_id": NotRequired[str]}, total=False)
|
|
968
|
+
|
|
969
|
+
BillingPlanChangeResponse = TypedDict("BillingPlanChangeResponse", {"object": Required[Literal["billing_payment"]], "id": Required[str | None], "kind": Required[Literal["credit_purchase", "auto_reload", "plan_change", "invoice_payment"]], "status": Required[Literal["succeeded", "pending", "requires_action", "failed", "canceled"]], "payment_page_url": Required[str | None], "credits": Required[int | None], "bonus_credits": Required[int | None], "scheduled": Required[bool]}, total=False)
|
|
970
|
+
|
|
971
|
+
BillingDowngradeUndoResponse = TypedDict("BillingDowngradeUndoResponse", {"object": Required[Literal["subscription_change"]], "status": Required[Literal["succeeded", "pending"]]}, total=False)
|
|
972
|
+
|
|
973
|
+
BillingSubscriptionResumeResponse = TypedDict("BillingSubscriptionResumeResponse", {"object": Required[Literal["subscription_change"]], "status": Required[Literal["succeeded", "pending"]]}, total=False)
|
|
974
|
+
|
|
975
|
+
BillingOverduePayInput = TypedDict("BillingOverduePayInput", {"invoice_number": NotRequired[str], "payment_method_id": NotRequired[str]}, total=False)
|
|
976
|
+
|
|
977
|
+
BillingOverduePayResponse = TypedDict("BillingOverduePayResponse", {"object": Required[Literal["billing_payment"]], "id": Required[str | None], "kind": Required[Literal["credit_purchase", "auto_reload", "plan_change", "invoice_payment"]], "status": Required[Literal["succeeded", "pending", "requires_action", "failed", "canceled"]], "payment_page_url": Required[str | None], "credits": Required[int | None], "bonus_credits": Required[int | None], "scheduled": Required[bool]}, total=False)
|
|
978
|
+
|
|
979
|
+
BillingPaymentMethodsDefaultResponseOverdueInvoicesItem = TypedDict("BillingPaymentMethodsDefaultResponseOverdueInvoicesItem", {"number": Required[str | None], "amount_cents": Required[int], "status": Required[Literal["paid", "processing", "requires_action", "failed", "pending"]]}, total=False)
|
|
980
|
+
|
|
981
|
+
BillingPaymentMethodsDefaultResponse = TypedDict("BillingPaymentMethodsDefaultResponse", {"object": Required[Literal["payment_method_change"]], "status": Required[Literal["succeeded", "pending", "failed", "canceled"]], "overdue_invoices": Required[list[BillingPaymentMethodsDefaultResponseOverdueInvoicesItem]]}, total=False)
|
|
982
|
+
|
|
983
|
+
BillingPaymentMethodsMoveInput = TypedDict("BillingPaymentMethodsMoveInput", {"direction": Required[Literal["up", "down"]]}, total=False)
|
|
984
|
+
|
|
985
|
+
BillingPaymentMethodsMoveResponseOverdueInvoicesItem = TypedDict("BillingPaymentMethodsMoveResponseOverdueInvoicesItem", {"number": Required[str | None], "amount_cents": Required[int], "status": Required[Literal["paid", "processing", "requires_action", "failed", "pending"]]}, total=False)
|
|
986
|
+
|
|
987
|
+
BillingPaymentMethodsMoveResponse = TypedDict("BillingPaymentMethodsMoveResponse", {"object": Required[Literal["payment_method_change"]], "status": Required[Literal["succeeded", "pending", "failed", "canceled"]], "overdue_invoices": Required[list[BillingPaymentMethodsMoveResponseOverdueInvoicesItem]]}, total=False)
|
|
988
|
+
|
|
989
|
+
BillingPaymentMethodsRemoveResponseOverdueInvoicesItem = TypedDict("BillingPaymentMethodsRemoveResponseOverdueInvoicesItem", {"number": Required[str | None], "amount_cents": Required[int], "status": Required[Literal["paid", "processing", "requires_action", "failed", "pending"]]}, total=False)
|
|
990
|
+
|
|
991
|
+
BillingPaymentMethodsRemoveResponse = TypedDict("BillingPaymentMethodsRemoveResponse", {"object": Required[Literal["payment_method_change"]], "status": Required[Literal["succeeded", "pending", "failed", "canceled"]], "overdue_invoices": Required[list[BillingPaymentMethodsRemoveResponseOverdueInvoicesItem]]}, total=False)
|
|
992
|
+
|
|
993
|
+
BillingCodesRedeemInput = TypedDict("BillingCodesRedeemInput", {"code": Required[str]}, total=False)
|
|
994
|
+
|
|
995
|
+
BillingCodesRedeemResponse = TypedDict("BillingCodesRedeemResponse", {"object": Required[Literal["enterprise_plan_redemption"]], "status": Required[Literal["redeemed"]], "plan": Required[str | None]}, total=False)
|
|
996
|
+
|
|
997
|
+
BillingApprovalLinksCreateInput = TypedDict("BillingApprovalLinksCreateInput", {"kind": Required[Literal["add_payment_method", "upgrade"]], "plan": NotRequired[Literal["pro", "scale"]], "interval": NotRequired[Literal["month", "year"]]}, total=False)
|
|
998
|
+
|
|
999
|
+
BillingApprovalLinksCreateResponse = TypedDict("BillingApprovalLinksCreateResponse", {"object": Required[Literal["billing_approval_link"]], "id": Required[str], "kind": Required[Literal["add_payment_method", "upgrade"]], "plan": Required[Literal["pro", "scale"] | None], "interval": Required[Literal["month", "year"] | None], "status": Required[Literal["waiting", "completed", "declined", "expired"]], "approval_url": Required[str | None], "expires_at": Required[str | None], "completed_at": Required[str | None]}, total=False)
|
|
1000
|
+
|
|
1001
|
+
BillingApprovalLinksGetResponse = TypedDict("BillingApprovalLinksGetResponse", {"object": Required[Literal["billing_approval_link"]], "id": Required[str], "kind": Required[Literal["add_payment_method", "upgrade"]], "plan": Required[Literal["pro", "scale"] | None], "interval": Required[Literal["month", "year"] | None], "status": Required[Literal["waiting", "completed", "declined", "expired"]], "approval_url": Required[str | None], "expires_at": Required[str | None], "completed_at": Required[str | None]}, total=False)
|
|
1002
|
+
|
|
1003
|
+
AccountUpdateInput = TypedDict("AccountUpdateInput", {"name": Required[str]}, total=False)
|
|
1004
|
+
|
|
1005
|
+
AccountUpdateResponse = TypedDict("AccountUpdateResponse", {"object": Required[Literal["account"]], "name": Required[str]}, total=False)
|
|
1006
|
+
|
|
1007
|
+
AccountEmailPreferencesResponse = TypedDict("AccountEmailPreferencesResponse", {"object": Required[Literal["email_preferences"]], "members_and_invitations": Required[bool], "imports_and_exports": Required[bool], "integration_alerts": Required[bool], "weekly_summary": Required[bool]}, total=False)
|
|
1008
|
+
|
|
1009
|
+
AccountEmailPreferencesUpdateInput = TypedDict("AccountEmailPreferencesUpdateInput", {"members_and_invitations": NotRequired[bool], "imports_and_exports": NotRequired[bool], "integration_alerts": NotRequired[bool], "weekly_summary": NotRequired[bool]}, total=False)
|
|
1010
|
+
|
|
1011
|
+
AccountEmailPreferencesUpdateResponse = TypedDict("AccountEmailPreferencesUpdateResponse", {"object": Required[Literal["email_preferences"]], "members_and_invitations": Required[bool], "imports_and_exports": Required[bool], "integration_alerts": Required[bool], "weekly_summary": Required[bool]}, total=False)
|
|
1012
|
+
|
|
1013
|
+
NotificationsListInput = TypedDict("NotificationsListInput", {"filter": NotRequired[Literal["all", "unread"]], "cursor": NotRequired[str]}, total=False)
|
|
1014
|
+
|
|
1015
|
+
NotificationsListResponseDataItemActionsItem = TypedDict("NotificationsListResponseDataItemActionsItem", {"id": Required[str], "label": Required[str]}, total=False)
|
|
1016
|
+
|
|
1017
|
+
NotificationsListResponseDataItem = TypedDict("NotificationsListResponseDataItem", {"object": Required[Literal["notification"]], "id": Required[str], "workspace": Required[str | None], "kind": Required[str], "title": Required[str], "snippet": Required[str], "unread": Required[bool], "count": Required[int], "updated_at": Required[str | None], "actions": Required[list[NotificationsListResponseDataItemActionsItem]], "resolved": Required[str | None]}, total=False)
|
|
1018
|
+
|
|
1019
|
+
NotificationsListResponse = TypedDict("NotificationsListResponse", {"object": Required[Literal["list"]], "data": Required[list[NotificationsListResponseDataItem]], "next_cursor": Required[str | None], "unread_count": Required[int]}, total=False)
|
|
1020
|
+
|
|
1021
|
+
NotificationsUpdateInput = TypedDict("NotificationsUpdateInput", {"read": Required[bool]}, total=False)
|
|
1022
|
+
|
|
1023
|
+
NotificationsUpdateResponseActionsItem = TypedDict("NotificationsUpdateResponseActionsItem", {"id": Required[str], "label": Required[str]}, total=False)
|
|
1024
|
+
|
|
1025
|
+
NotificationsUpdateResponse = TypedDict("NotificationsUpdateResponse", {"object": Required[Literal["notification"]], "id": Required[str], "workspace": Required[str | None], "kind": Required[str], "title": Required[str], "snippet": Required[str], "unread": Required[bool], "count": Required[int], "updated_at": Required[str | None], "actions": Required[list[NotificationsUpdateResponseActionsItem]], "resolved": Required[str | None], "unread_count": Required[int]}, total=False)
|
|
1026
|
+
|
|
1027
|
+
NotificationsReadAllResponse = TypedDict("NotificationsReadAllResponse", {"object": Required[Literal["notifications_read"]], "unread_count": Required[int]}, total=False)
|
|
1028
|
+
|
|
1029
|
+
NotificationsRunActionInput = TypedDict("NotificationsRunActionInput", {"action": Required[str]}, total=False)
|
|
1030
|
+
|
|
1031
|
+
NotificationsRunActionResponseActionsItem = TypedDict("NotificationsRunActionResponseActionsItem", {"id": Required[str], "label": Required[str]}, total=False)
|
|
1032
|
+
|
|
1033
|
+
NotificationsRunActionResponse = TypedDict("NotificationsRunActionResponse", {"object": Required[Literal["notification"]], "id": Required[str], "workspace": Required[str | None], "kind": Required[str], "title": Required[str], "snippet": Required[str], "unread": Required[bool], "count": Required[int], "updated_at": Required[str | None], "actions": Required[list[NotificationsRunActionResponseActionsItem]], "resolved": Required[str | None], "unread_count": Required[int]}, total=False)
|
|
1034
|
+
|
|
1035
|
+
SupportTicketsCreateInput = TypedDict("SupportTicketsCreateInput", {"subject": Required[str], "message": Required[str], "topic": Required[Literal["account", "billing", "integration", "dashboard", "other"]], "request_id": NotRequired[str]}, total=False)
|
|
1036
|
+
|
|
1037
|
+
SupportTicketsCreateResponse = TypedDict("SupportTicketsCreateResponse", {"object": Required[Literal["support_ticket"]], "id": Required[str], "status": Required[Literal["received", "open", "resolved"]], "created_at": Required[str | None], "updated_at": Required[str | None]}, total=False)
|
|
1038
|
+
|
|
1039
|
+
SupportTicketsListInput = TypedDict("SupportTicketsListInput", {"cursor": NotRequired[str], "limit": NotRequired[int]}, total=False)
|
|
1040
|
+
|
|
1041
|
+
SupportTicketsListResponseDataItem = TypedDict("SupportTicketsListResponseDataItem", {"object": Required[Literal["support_ticket"]], "id": Required[str], "status": Required[Literal["received", "open", "resolved"]], "created_at": Required[str | None], "updated_at": Required[str | None]}, total=False)
|
|
1042
|
+
|
|
1043
|
+
SupportTicketsListResponse = TypedDict("SupportTicketsListResponse", {"object": Required[Literal["list"]], "data": Required[list[SupportTicketsListResponseDataItem]], "next_cursor": Required[str | None]}, total=False)
|
|
1044
|
+
|
|
1045
|
+
FeedbackCreateInput = TypedDict("FeedbackCreateInput", {"message": Required[str], "page": NotRequired[str]}, total=False)
|
|
1046
|
+
|
|
1047
|
+
FeedbackCreateResponse = TypedDict("FeedbackCreateResponse", {"object": Required[Literal["feedback"]], "sent": Required[Literal[True]]}, total=False)
|
|
1048
|
+
|
|
1049
|
+
class Evaluated(EvaluationsCreateResponseVariant0):
|
|
1050
|
+
source: Literal["abusezero"]
|
|
1051
|
+
|
|
1052
|
+
class Skipped(TypedDict):
|
|
1053
|
+
source: Literal["abusezero"]
|
|
1054
|
+
status: Literal["skipped"]
|
|
1055
|
+
reason: str
|
|
1056
|
+
object: NotRequired[str]
|
|
1057
|
+
|
|
1058
|
+
class LocalOutage(TypedDict):
|
|
1059
|
+
source: Literal["local_outage"]
|
|
1060
|
+
claim_id: str
|
|
1061
|
+
result: Literal["allow", "deny"]
|
|
1062
|
+
error: AbuseZeroError
|
|
1063
|
+
|
|
1064
|
+
Evaluation = Evaluated | Skipped | LocalOutage
|