schematichq 1.5.7 → 1.5.8
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.
- checksums.yaml +4 -4
- data/.fern/metadata.json +4 -4
- data/.fern/replay.lock +7 -1
- data/lib/schematic/accesstokens/client.rb +1 -1
- data/lib/schematic/accounts/client.rb +15 -15
- data/lib/schematic/billing/client.rb +432 -37
- data/lib/schematic/billing/types/charge_native_invoice_response.rb +15 -0
- data/lib/schematic/billing/types/create_billing_subscription_request_body.rb +4 -0
- data/lib/schematic/billing/types/delete_contract_document_response.rb +15 -0
- data/lib/schematic/billing/types/get_company_contract_response.rb +15 -0
- data/lib/schematic/billing/types/get_company_upcoming_invoices_response.rb +15 -0
- data/lib/schematic/billing/types/move_to_default_plan_response.rb +15 -0
- data/lib/schematic/billing/types/reissue_native_invoice_link_response.rb +15 -0
- data/lib/schematic/billing/types/revoke_native_invoice_link_response.rb +15 -0
- data/lib/schematic/billing/types/update_billing_settings_request_body.rb +4 -0
- data/lib/schematic/billing/types/update_company_billing_profile_request_body.rb +6 -0
- data/lib/schematic/billing/types/upload_contract_document_request.rb +11 -0
- data/lib/schematic/billing/types/upload_contract_document_response.rb +15 -0
- data/lib/schematic/catalogs/client.rb +16 -16
- data/lib/schematic/catalogs/types/update_catalog_configuration_request_body.rb +2 -0
- data/lib/schematic/checkout/client.rb +98 -9
- data/lib/schematic/checkout/types/pause_subscription_request.rb +15 -0
- data/lib/schematic/checkout/types/pause_subscription_response.rb +15 -0
- data/lib/schematic/checkout/types/resume_subscription_request.rb +13 -0
- data/lib/schematic/checkout/types/resume_subscription_response.rb +15 -0
- data/lib/schematic/client.rb +7 -196
- data/lib/schematic/companies/client.rb +140 -44
- data/lib/schematic/companies/types/get_billing_entity_settings_response.rb +15 -0
- data/lib/schematic/companies/types/list_users_params.rb +4 -0
- data/lib/schematic/companies/types/list_users_request.rb +4 -0
- data/lib/schematic/companies/types/update_billing_entity_settings_request_body.rb +13 -0
- data/lib/schematic/companies/types/update_billing_entity_settings_response.rb +15 -0
- data/lib/schematic/components/client.rb +8 -8
- data/lib/schematic/componentspublic/client.rb +1 -1
- data/lib/schematic/credits/client.rb +41 -41
- data/lib/schematic/customplangrouprollouts/client.rb +258 -0
- data/lib/schematic/customplangrouprollouts/types/copy_custom_plan_request_body.rb +15 -0
- data/lib/schematic/customplangrouprollouts/types/copy_custom_plan_response.rb +15 -0
- data/lib/schematic/customplangrouprollouts/types/get_group_rollout_response.rb +15 -0
- data/lib/schematic/customplangrouprollouts/types/list_group_rollouts_params.rb +14 -0
- data/lib/schematic/customplangrouprollouts/types/list_group_rollouts_request.rb +11 -0
- data/lib/schematic/customplangrouprollouts/types/list_group_rollouts_response.rb +15 -0
- data/lib/schematic/customplangrouprollouts/types/preview_group_rollout_params.rb +16 -0
- data/lib/schematic/customplangrouprollouts/types/preview_group_rollout_request.rb +15 -0
- data/lib/schematic/customplangrouprollouts/types/preview_group_rollout_response.rb +15 -0
- data/lib/schematic/customplangrouprollouts/types/start_group_rollout_request_body.rb +17 -0
- data/lib/schematic/customplangrouprollouts/types/start_group_rollout_response.rb +15 -0
- data/lib/schematic/dataexports/client.rb +4 -4
- data/lib/schematic/entitlements/client.rb +28 -28
- data/lib/schematic/entitlements/types/create_billing_linked_plan_entitlement_request_body.rb +2 -0
- data/lib/schematic/entitlements/types/create_company_override_request_body.rb +2 -0
- data/lib/schematic/entitlements/types/create_plan_entitlement_request_body.rb +2 -0
- data/lib/schematic/entitlements/types/update_company_override_request_body.rb +2 -0
- data/lib/schematic/entitlements/types/update_plan_entitlement_request_body.rb +2 -0
- data/lib/schematic/errors/response_error.rb +4 -2
- data/lib/schematic/events/client.rb +213 -9
- data/lib/schematic/events/types/create_account_inference_cost_rate_request_body.rb +19 -0
- data/lib/schematic/events/types/create_account_inference_cost_rate_response.rb +15 -0
- data/lib/schematic/events/types/delete_account_inference_cost_rate_response.rb +15 -0
- data/lib/schematic/events/types/list_account_inference_cost_rates_params.rb +20 -0
- data/lib/schematic/events/types/list_account_inference_cost_rates_request.rb +17 -0
- data/lib/schematic/events/types/list_account_inference_cost_rates_response.rb +15 -0
- data/lib/schematic/events/types/update_account_inference_cost_rate_request_body.rb +13 -0
- data/lib/schematic/events/types/update_account_inference_cost_rate_response.rb +15 -0
- data/lib/schematic/features/client.rb +18 -18
- data/lib/schematic/insights/client.rb +6 -6
- data/lib/schematic/integrationsapi/client.rb +14 -14
- data/lib/schematic/internal/http/raw_client.rb +1 -1
- data/lib/schematic/licenses/client.rb +3 -3
- data/lib/schematic/planbundle/client.rb +3 -3
- data/lib/schematic/plangroups/client.rb +3 -3
- data/lib/schematic/planmigrations/client.rb +11 -11
- data/lib/schematic/plans/client.rb +20 -20
- data/lib/schematic/scheduledcheckout/client.rb +4 -4
- data/lib/schematic/types/account_inference_cost_rate_response_data.rb +29 -0
- data/lib/schematic/types/billing_invoice_billing_details_response_data.rb +2 -0
- data/lib/schematic/types/billing_invoice_detail_response_data.rb +2 -0
- data/lib/schematic/types/billing_moved_to_default_plan_response_data.rb +15 -0
- data/lib/schematic/types/billing_settings_response_data.rb +4 -0
- data/lib/schematic/types/billing_subscription_pause_behavior.rb +15 -0
- data/lib/schematic/types/billing_subscription_response_data.rb +6 -0
- data/lib/schematic/types/billing_subscription_view.rb +6 -0
- data/lib/schematic/types/billing_upcoming_invoice_response_data.rb +43 -0
- data/lib/schematic/types/billing_upcoming_invoices_response_data.rb +13 -0
- data/lib/schematic/types/catalog_configuration_response_data.rb +2 -0
- data/lib/schematic/types/catalog_plan_response_data.rb +4 -0
- data/lib/schematic/types/catalog_response_data.rb +2 -0
- data/lib/schematic/types/checkout_subscription.rb +6 -0
- data/lib/schematic/types/company_billing_entity_settings_response_data.rb +15 -0
- data/lib/schematic/types/company_billing_entity_subscription_response_data.rb +10 -0
- data/lib/schematic/types/company_billing_profile_contract_response_data.rb +55 -0
- data/lib/schematic/types/company_billing_profile_document_response_data.rb +15 -0
- data/lib/schematic/types/company_override_response_data.rb +2 -0
- data/lib/schematic/types/company_subscription_response_data.rb +10 -0
- data/lib/schematic/types/contract_billing_details_request_body.rb +19 -0
- data/lib/schematic/types/contract_postpaid_credit_response_data.rb +23 -0
- data/lib/schematic/types/contract_postpaid_response_data.rb +15 -0
- data/lib/schematic/types/create_entitlement_in_bundle_request_body.rb +2 -0
- data/lib/schematic/types/create_entitlement_req_common.rb +2 -0
- data/lib/schematic/types/credit_burn_breakdown_line.rb +4 -0
- data/lib/schematic/types/credit_model_rate.rb +17 -0
- data/lib/schematic/types/custom_plan_billing_response_data.rb +2 -0
- data/lib/schematic/types/group_rollout_change_response_data.rb +13 -0
- data/lib/schematic/types/group_rollout_changes_response_data.rb +23 -0
- data/lib/schematic/types/group_rollout_company_response_data.rb +15 -0
- data/lib/schematic/types/group_rollout_company_result_response_data.rb +19 -0
- data/lib/schematic/types/group_rollout_preview_response_data.rb +19 -0
- data/lib/schematic/types/group_rollout_response_data.rb +25 -0
- data/lib/schematic/types/group_rollout_versions_request_body.rb +13 -0
- data/lib/schematic/types/manage_plan_request.rb +2 -0
- data/lib/schematic/types/plan_change_action.rb +1 -0
- data/lib/schematic/types/plan_entitlement_response_data.rb +2 -0
- data/lib/schematic/types/publish_plan_version_request_body.rb +4 -0
- data/lib/schematic/types/publish_preview_response_data.rb +4 -0
- data/lib/schematic/types/stripe_integration_config.rb +2 -0
- data/lib/schematic/types/update_entitlement_req_common.rb +2 -0
- data/lib/schematic/version.rb +1 -1
- data/lib/schematic/webhooks/client.rb +10 -10
- data/lib/schematic.rb +66 -5
- data/reference.md +2146 -1054
- metadata +57 -2
data/reference.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# Reference
|
|
2
|
-
<details><summary><code>client.<a href="/lib/schematic/client.rb">
|
|
2
|
+
<details><summary><code>client.<a href="/lib/schematic/client.rb">get_credit_ledger</a>() -> </code></summary>
|
|
3
3
|
<dl>
|
|
4
4
|
<dd>
|
|
5
5
|
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
<dd>
|
|
13
13
|
|
|
14
14
|
```ruby
|
|
15
|
-
client.
|
|
15
|
+
client.get_credit_ledger
|
|
16
16
|
```
|
|
17
17
|
</dd>
|
|
18
18
|
</dl>
|
|
@@ -39,7 +39,8 @@ client.post_api_keys
|
|
|
39
39
|
</dl>
|
|
40
40
|
</details>
|
|
41
41
|
|
|
42
|
-
|
|
42
|
+
## accounts
|
|
43
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">list_account_members</a>() -> Schematic::Accounts::Types::ListAccountMembersResponse</code></summary>
|
|
43
44
|
<dl>
|
|
44
45
|
<dd>
|
|
45
46
|
|
|
@@ -52,7 +53,13 @@ client.post_api_keys
|
|
|
52
53
|
<dd>
|
|
53
54
|
|
|
54
55
|
```ruby
|
|
55
|
-
client.
|
|
56
|
+
client.accounts.list_account_members(
|
|
57
|
+
ids: ["ids"],
|
|
58
|
+
q: "q",
|
|
59
|
+
role: "admin",
|
|
60
|
+
limit: 1000000,
|
|
61
|
+
offset: 1000000
|
|
62
|
+
)
|
|
56
63
|
```
|
|
57
64
|
</dd>
|
|
58
65
|
</dl>
|
|
@@ -67,7 +74,7 @@ client.put_api_keys_api_key_id(api_key_id: "api_key_id")
|
|
|
67
74
|
<dl>
|
|
68
75
|
<dd>
|
|
69
76
|
|
|
70
|
-
**
|
|
77
|
+
**ids:** `String`
|
|
71
78
|
|
|
72
79
|
</dd>
|
|
73
80
|
</dl>
|
|
@@ -75,47 +82,15 @@ client.put_api_keys_api_key_id(api_key_id: "api_key_id")
|
|
|
75
82
|
<dl>
|
|
76
83
|
<dd>
|
|
77
84
|
|
|
78
|
-
**
|
|
85
|
+
**q:** `String` — Search filter
|
|
79
86
|
|
|
80
87
|
</dd>
|
|
81
88
|
</dl>
|
|
82
|
-
</dd>
|
|
83
|
-
</dl>
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
</dd>
|
|
87
|
-
</dl>
|
|
88
|
-
</details>
|
|
89
|
-
|
|
90
|
-
<details><summary><code>client.<a href="/lib/schematic/client.rb">delete_api_keys_api_key_id</a>(api_key_id:) -> </code></summary>
|
|
91
|
-
<dl>
|
|
92
|
-
<dd>
|
|
93
|
-
|
|
94
|
-
#### 🔌 Usage
|
|
95
|
-
|
|
96
|
-
<dl>
|
|
97
|
-
<dd>
|
|
98
|
-
|
|
99
|
-
<dl>
|
|
100
|
-
<dd>
|
|
101
|
-
|
|
102
|
-
```ruby
|
|
103
|
-
client.delete_api_keys_api_key_id(api_key_id: "api_key_id")
|
|
104
|
-
```
|
|
105
|
-
</dd>
|
|
106
|
-
</dl>
|
|
107
|
-
</dd>
|
|
108
|
-
</dl>
|
|
109
|
-
|
|
110
|
-
#### ⚙️ Parameters
|
|
111
|
-
|
|
112
|
-
<dl>
|
|
113
|
-
<dd>
|
|
114
89
|
|
|
115
90
|
<dl>
|
|
116
91
|
<dd>
|
|
117
92
|
|
|
118
|
-
**
|
|
93
|
+
**role:** `Schematic::Types::AccountMemberRole` — Filter by member role
|
|
119
94
|
|
|
120
95
|
</dd>
|
|
121
96
|
</dl>
|
|
@@ -123,47 +98,23 @@ client.delete_api_keys_api_key_id(api_key_id: "api_key_id")
|
|
|
123
98
|
<dl>
|
|
124
99
|
<dd>
|
|
125
100
|
|
|
126
|
-
**
|
|
101
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
127
102
|
|
|
128
103
|
</dd>
|
|
129
104
|
</dl>
|
|
130
|
-
</dd>
|
|
131
|
-
</dl>
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
</dd>
|
|
135
|
-
</dl>
|
|
136
|
-
</details>
|
|
137
|
-
|
|
138
|
-
<details><summary><code>client.<a href="/lib/schematic/client.rb">post_environments</a>() -> </code></summary>
|
|
139
|
-
<dl>
|
|
140
|
-
<dd>
|
|
141
|
-
|
|
142
|
-
#### 🔌 Usage
|
|
143
|
-
|
|
144
|
-
<dl>
|
|
145
|
-
<dd>
|
|
146
105
|
|
|
147
106
|
<dl>
|
|
148
107
|
<dd>
|
|
149
108
|
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
```
|
|
153
|
-
</dd>
|
|
154
|
-
</dl>
|
|
109
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
110
|
+
|
|
155
111
|
</dd>
|
|
156
112
|
</dl>
|
|
157
113
|
|
|
158
|
-
#### ⚙️ Parameters
|
|
159
|
-
|
|
160
|
-
<dl>
|
|
161
|
-
<dd>
|
|
162
|
-
|
|
163
114
|
<dl>
|
|
164
115
|
<dd>
|
|
165
116
|
|
|
166
|
-
**request_options:** `Schematic::RequestOptions`
|
|
117
|
+
**request_options:** `Schematic::Accounts::RequestOptions`
|
|
167
118
|
|
|
168
119
|
</dd>
|
|
169
120
|
</dl>
|
|
@@ -175,7 +126,7 @@ client.post_environments
|
|
|
175
126
|
</dl>
|
|
176
127
|
</details>
|
|
177
128
|
|
|
178
|
-
<details><summary><code>client.<a href="/lib/schematic/client.rb">
|
|
129
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">get_account_member</a>(account_member_id:) -> Schematic::Accounts::Types::GetAccountMemberResponse</code></summary>
|
|
179
130
|
<dl>
|
|
180
131
|
<dd>
|
|
181
132
|
|
|
@@ -188,7 +139,7 @@ client.post_environments
|
|
|
188
139
|
<dd>
|
|
189
140
|
|
|
190
141
|
```ruby
|
|
191
|
-
client.
|
|
142
|
+
client.accounts.get_account_member(account_member_id: "account_member_id")
|
|
192
143
|
```
|
|
193
144
|
</dd>
|
|
194
145
|
</dl>
|
|
@@ -203,7 +154,7 @@ client.put_environments_environment_id(environment_id: "environment_id")
|
|
|
203
154
|
<dl>
|
|
204
155
|
<dd>
|
|
205
156
|
|
|
206
|
-
**
|
|
157
|
+
**account_member_id:** `String` — account_member_id
|
|
207
158
|
|
|
208
159
|
</dd>
|
|
209
160
|
</dl>
|
|
@@ -211,7 +162,7 @@ client.put_environments_environment_id(environment_id: "environment_id")
|
|
|
211
162
|
<dl>
|
|
212
163
|
<dd>
|
|
213
164
|
|
|
214
|
-
**request_options:** `Schematic::RequestOptions`
|
|
165
|
+
**request_options:** `Schematic::Accounts::RequestOptions`
|
|
215
166
|
|
|
216
167
|
</dd>
|
|
217
168
|
</dl>
|
|
@@ -223,7 +174,7 @@ client.put_environments_environment_id(environment_id: "environment_id")
|
|
|
223
174
|
</dl>
|
|
224
175
|
</details>
|
|
225
176
|
|
|
226
|
-
<details><summary><code>client.<a href="/lib/schematic/client.rb">
|
|
177
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">count_account_members</a>() -> Schematic::Accounts::Types::CountAccountMembersResponse</code></summary>
|
|
227
178
|
<dl>
|
|
228
179
|
<dd>
|
|
229
180
|
|
|
@@ -236,7 +187,13 @@ client.put_environments_environment_id(environment_id: "environment_id")
|
|
|
236
187
|
<dd>
|
|
237
188
|
|
|
238
189
|
```ruby
|
|
239
|
-
client.
|
|
190
|
+
client.accounts.count_account_members(
|
|
191
|
+
ids: ["ids"],
|
|
192
|
+
q: "q",
|
|
193
|
+
role: "admin",
|
|
194
|
+
limit: 1000000,
|
|
195
|
+
offset: 1000000
|
|
196
|
+
)
|
|
240
197
|
```
|
|
241
198
|
</dd>
|
|
242
199
|
</dl>
|
|
@@ -251,7 +208,7 @@ client.delete_environments_environment_id(environment_id: "environment_id")
|
|
|
251
208
|
<dl>
|
|
252
209
|
<dd>
|
|
253
210
|
|
|
254
|
-
**
|
|
211
|
+
**ids:** `String`
|
|
255
212
|
|
|
256
213
|
</dd>
|
|
257
214
|
</dl>
|
|
@@ -259,47 +216,39 @@ client.delete_environments_environment_id(environment_id: "environment_id")
|
|
|
259
216
|
<dl>
|
|
260
217
|
<dd>
|
|
261
218
|
|
|
262
|
-
**
|
|
219
|
+
**q:** `String` — Search filter
|
|
263
220
|
|
|
264
221
|
</dd>
|
|
265
222
|
</dl>
|
|
266
|
-
</dd>
|
|
267
|
-
</dl>
|
|
268
223
|
|
|
224
|
+
<dl>
|
|
225
|
+
<dd>
|
|
269
226
|
|
|
227
|
+
**role:** `Schematic::Types::AccountMemberRole` — Filter by member role
|
|
228
|
+
|
|
270
229
|
</dd>
|
|
271
230
|
</dl>
|
|
272
|
-
</details>
|
|
273
231
|
|
|
274
|
-
<details><summary><code>client.<a href="/lib/schematic/client.rb">get_credit_ledger</a>() -> </code></summary>
|
|
275
232
|
<dl>
|
|
276
233
|
<dd>
|
|
277
234
|
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
235
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
236
|
+
|
|
237
|
+
</dd>
|
|
238
|
+
</dl>
|
|
282
239
|
|
|
283
240
|
<dl>
|
|
284
241
|
<dd>
|
|
285
242
|
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
```
|
|
289
|
-
</dd>
|
|
290
|
-
</dl>
|
|
243
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
244
|
+
|
|
291
245
|
</dd>
|
|
292
246
|
</dl>
|
|
293
247
|
|
|
294
|
-
#### ⚙️ Parameters
|
|
295
|
-
|
|
296
|
-
<dl>
|
|
297
|
-
<dd>
|
|
298
|
-
|
|
299
248
|
<dl>
|
|
300
249
|
<dd>
|
|
301
250
|
|
|
302
|
-
**request_options:** `Schematic::RequestOptions`
|
|
251
|
+
**request_options:** `Schematic::Accounts::RequestOptions`
|
|
303
252
|
|
|
304
253
|
</dd>
|
|
305
254
|
</dl>
|
|
@@ -311,8 +260,7 @@ client.get_credit_ledger
|
|
|
311
260
|
</dl>
|
|
312
261
|
</details>
|
|
313
262
|
|
|
314
|
-
|
|
315
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">list_account_members</a>() -> Schematic::Accounts::Types::ListAccountMembersResponse</code></summary>
|
|
263
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">list_api_keys</a>() -> Schematic::Accounts::Types::ListApiKeysResponse</code></summary>
|
|
316
264
|
<dl>
|
|
317
265
|
<dd>
|
|
318
266
|
|
|
@@ -325,10 +273,9 @@ client.get_credit_ledger
|
|
|
325
273
|
<dd>
|
|
326
274
|
|
|
327
275
|
```ruby
|
|
328
|
-
client.accounts.
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
role: "admin",
|
|
276
|
+
client.accounts.list_api_keys(
|
|
277
|
+
environment_id: "environment_id",
|
|
278
|
+
require_environment: true,
|
|
332
279
|
limit: 1000000,
|
|
333
280
|
offset: 1000000
|
|
334
281
|
)
|
|
@@ -346,15 +293,7 @@ client.accounts.list_account_members(
|
|
|
346
293
|
<dl>
|
|
347
294
|
<dd>
|
|
348
295
|
|
|
349
|
-
**
|
|
350
|
-
|
|
351
|
-
</dd>
|
|
352
|
-
</dl>
|
|
353
|
-
|
|
354
|
-
<dl>
|
|
355
|
-
<dd>
|
|
356
|
-
|
|
357
|
-
**q:** `String` — Search filter
|
|
296
|
+
**environment_id:** `String`
|
|
358
297
|
|
|
359
298
|
</dd>
|
|
360
299
|
</dl>
|
|
@@ -362,7 +301,7 @@ client.accounts.list_account_members(
|
|
|
362
301
|
<dl>
|
|
363
302
|
<dd>
|
|
364
303
|
|
|
365
|
-
**
|
|
304
|
+
**require_environment:** `Internal::Types::Boolean`
|
|
366
305
|
|
|
367
306
|
</dd>
|
|
368
307
|
</dl>
|
|
@@ -398,7 +337,7 @@ client.accounts.list_account_members(
|
|
|
398
337
|
</dl>
|
|
399
338
|
</details>
|
|
400
339
|
|
|
401
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">
|
|
340
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">get_api_key</a>(api_key_id:) -> Schematic::Accounts::Types::GetApiKeyResponse</code></summary>
|
|
402
341
|
<dl>
|
|
403
342
|
<dd>
|
|
404
343
|
|
|
@@ -411,7 +350,7 @@ client.accounts.list_account_members(
|
|
|
411
350
|
<dd>
|
|
412
351
|
|
|
413
352
|
```ruby
|
|
414
|
-
client.accounts.
|
|
353
|
+
client.accounts.get_api_key(api_key_id: "api_key_id")
|
|
415
354
|
```
|
|
416
355
|
</dd>
|
|
417
356
|
</dl>
|
|
@@ -426,7 +365,7 @@ client.accounts.get_account_member(account_member_id: "account_member_id")
|
|
|
426
365
|
<dl>
|
|
427
366
|
<dd>
|
|
428
367
|
|
|
429
|
-
**
|
|
368
|
+
**api_key_id:** `String` — api_key_id
|
|
430
369
|
|
|
431
370
|
</dd>
|
|
432
371
|
</dl>
|
|
@@ -446,7 +385,7 @@ client.accounts.get_account_member(account_member_id: "account_member_id")
|
|
|
446
385
|
</dl>
|
|
447
386
|
</details>
|
|
448
387
|
|
|
449
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">
|
|
388
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">count_api_keys</a>() -> Schematic::Accounts::Types::CountApiKeysResponse</code></summary>
|
|
450
389
|
<dl>
|
|
451
390
|
<dd>
|
|
452
391
|
|
|
@@ -459,10 +398,9 @@ client.accounts.get_account_member(account_member_id: "account_member_id")
|
|
|
459
398
|
<dd>
|
|
460
399
|
|
|
461
400
|
```ruby
|
|
462
|
-
client.accounts.
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
role: "admin",
|
|
401
|
+
client.accounts.count_api_keys(
|
|
402
|
+
environment_id: "environment_id",
|
|
403
|
+
require_environment: true,
|
|
466
404
|
limit: 1000000,
|
|
467
405
|
offset: 1000000
|
|
468
406
|
)
|
|
@@ -480,15 +418,7 @@ client.accounts.count_account_members(
|
|
|
480
418
|
<dl>
|
|
481
419
|
<dd>
|
|
482
420
|
|
|
483
|
-
**
|
|
484
|
-
|
|
485
|
-
</dd>
|
|
486
|
-
</dl>
|
|
487
|
-
|
|
488
|
-
<dl>
|
|
489
|
-
<dd>
|
|
490
|
-
|
|
491
|
-
**q:** `String` — Search filter
|
|
421
|
+
**environment_id:** `String`
|
|
492
422
|
|
|
493
423
|
</dd>
|
|
494
424
|
</dl>
|
|
@@ -496,7 +426,7 @@ client.accounts.count_account_members(
|
|
|
496
426
|
<dl>
|
|
497
427
|
<dd>
|
|
498
428
|
|
|
499
|
-
**
|
|
429
|
+
**require_environment:** `Internal::Types::Boolean`
|
|
500
430
|
|
|
501
431
|
</dd>
|
|
502
432
|
</dl>
|
|
@@ -532,7 +462,7 @@ client.accounts.count_account_members(
|
|
|
532
462
|
</dl>
|
|
533
463
|
</details>
|
|
534
464
|
|
|
535
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">
|
|
465
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">list_audit_logs</a>() -> Schematic::Accounts::Types::ListAuditLogsResponse</code></summary>
|
|
536
466
|
<dl>
|
|
537
467
|
<dd>
|
|
538
468
|
|
|
@@ -545,9 +475,13 @@ client.accounts.count_account_members(
|
|
|
545
475
|
<dd>
|
|
546
476
|
|
|
547
477
|
```ruby
|
|
548
|
-
client.accounts.
|
|
478
|
+
client.accounts.list_audit_logs(
|
|
479
|
+
actor_type: "api_key",
|
|
480
|
+
company_id: "company_id",
|
|
481
|
+
end_time: "2024-01-15T09:30:00Z",
|
|
549
482
|
environment_id: "environment_id",
|
|
550
|
-
|
|
483
|
+
q: "q",
|
|
484
|
+
start_time: "2024-01-15T09:30:00Z",
|
|
551
485
|
limit: 1000000,
|
|
552
486
|
offset: 1000000
|
|
553
487
|
)
|
|
@@ -565,6 +499,30 @@ client.accounts.list_api_keys(
|
|
|
565
499
|
<dl>
|
|
566
500
|
<dd>
|
|
567
501
|
|
|
502
|
+
**actor_type:** `Schematic::Types::ActorType`
|
|
503
|
+
|
|
504
|
+
</dd>
|
|
505
|
+
</dl>
|
|
506
|
+
|
|
507
|
+
<dl>
|
|
508
|
+
<dd>
|
|
509
|
+
|
|
510
|
+
**company_id:** `String`
|
|
511
|
+
|
|
512
|
+
</dd>
|
|
513
|
+
</dl>
|
|
514
|
+
|
|
515
|
+
<dl>
|
|
516
|
+
<dd>
|
|
517
|
+
|
|
518
|
+
**end_time:** `String`
|
|
519
|
+
|
|
520
|
+
</dd>
|
|
521
|
+
</dl>
|
|
522
|
+
|
|
523
|
+
<dl>
|
|
524
|
+
<dd>
|
|
525
|
+
|
|
568
526
|
**environment_id:** `String`
|
|
569
527
|
|
|
570
528
|
</dd>
|
|
@@ -573,7 +531,15 @@ client.accounts.list_api_keys(
|
|
|
573
531
|
<dl>
|
|
574
532
|
<dd>
|
|
575
533
|
|
|
576
|
-
**
|
|
534
|
+
**q:** `String`
|
|
535
|
+
|
|
536
|
+
</dd>
|
|
537
|
+
</dl>
|
|
538
|
+
|
|
539
|
+
<dl>
|
|
540
|
+
<dd>
|
|
541
|
+
|
|
542
|
+
**start_time:** `String`
|
|
577
543
|
|
|
578
544
|
</dd>
|
|
579
545
|
</dl>
|
|
@@ -609,7 +575,7 @@ client.accounts.list_api_keys(
|
|
|
609
575
|
</dl>
|
|
610
576
|
</details>
|
|
611
577
|
|
|
612
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">
|
|
578
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">get_audit_log</a>(audit_log_id:) -> Schematic::Accounts::Types::GetAuditLogResponse</code></summary>
|
|
613
579
|
<dl>
|
|
614
580
|
<dd>
|
|
615
581
|
|
|
@@ -622,7 +588,7 @@ client.accounts.list_api_keys(
|
|
|
622
588
|
<dd>
|
|
623
589
|
|
|
624
590
|
```ruby
|
|
625
|
-
client.accounts.
|
|
591
|
+
client.accounts.get_audit_log(audit_log_id: "audit_log_id")
|
|
626
592
|
```
|
|
627
593
|
</dd>
|
|
628
594
|
</dl>
|
|
@@ -637,7 +603,7 @@ client.accounts.get_api_key(api_key_id: "api_key_id")
|
|
|
637
603
|
<dl>
|
|
638
604
|
<dd>
|
|
639
605
|
|
|
640
|
-
**
|
|
606
|
+
**audit_log_id:** `String` — audit_log_id
|
|
641
607
|
|
|
642
608
|
</dd>
|
|
643
609
|
</dl>
|
|
@@ -657,7 +623,7 @@ client.accounts.get_api_key(api_key_id: "api_key_id")
|
|
|
657
623
|
</dl>
|
|
658
624
|
</details>
|
|
659
625
|
|
|
660
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">
|
|
626
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">count_audit_logs</a>() -> Schematic::Accounts::Types::CountAuditLogsResponse</code></summary>
|
|
661
627
|
<dl>
|
|
662
628
|
<dd>
|
|
663
629
|
|
|
@@ -670,9 +636,13 @@ client.accounts.get_api_key(api_key_id: "api_key_id")
|
|
|
670
636
|
<dd>
|
|
671
637
|
|
|
672
638
|
```ruby
|
|
673
|
-
client.accounts.
|
|
639
|
+
client.accounts.count_audit_logs(
|
|
640
|
+
actor_type: "api_key",
|
|
641
|
+
company_id: "company_id",
|
|
642
|
+
end_time: "2024-01-15T09:30:00Z",
|
|
674
643
|
environment_id: "environment_id",
|
|
675
|
-
|
|
644
|
+
q: "q",
|
|
645
|
+
start_time: "2024-01-15T09:30:00Z",
|
|
676
646
|
limit: 1000000,
|
|
677
647
|
offset: 1000000
|
|
678
648
|
)
|
|
@@ -690,7 +660,7 @@ client.accounts.count_api_keys(
|
|
|
690
660
|
<dl>
|
|
691
661
|
<dd>
|
|
692
662
|
|
|
693
|
-
**
|
|
663
|
+
**actor_type:** `Schematic::Types::ActorType`
|
|
694
664
|
|
|
695
665
|
</dd>
|
|
696
666
|
</dl>
|
|
@@ -698,7 +668,7 @@ client.accounts.count_api_keys(
|
|
|
698
668
|
<dl>
|
|
699
669
|
<dd>
|
|
700
670
|
|
|
701
|
-
**
|
|
671
|
+
**company_id:** `String`
|
|
702
672
|
|
|
703
673
|
</dd>
|
|
704
674
|
</dl>
|
|
@@ -706,7 +676,7 @@ client.accounts.count_api_keys(
|
|
|
706
676
|
<dl>
|
|
707
677
|
<dd>
|
|
708
678
|
|
|
709
|
-
**
|
|
679
|
+
**end_time:** `String`
|
|
710
680
|
|
|
711
681
|
</dd>
|
|
712
682
|
</dl>
|
|
@@ -714,7 +684,7 @@ client.accounts.count_api_keys(
|
|
|
714
684
|
<dl>
|
|
715
685
|
<dd>
|
|
716
686
|
|
|
717
|
-
**
|
|
687
|
+
**environment_id:** `String`
|
|
718
688
|
|
|
719
689
|
</dd>
|
|
720
690
|
</dl>
|
|
@@ -722,268 +692,26 @@ client.accounts.count_api_keys(
|
|
|
722
692
|
<dl>
|
|
723
693
|
<dd>
|
|
724
694
|
|
|
725
|
-
**
|
|
695
|
+
**q:** `String`
|
|
726
696
|
|
|
727
697
|
</dd>
|
|
728
698
|
</dl>
|
|
729
|
-
</dd>
|
|
730
|
-
</dl>
|
|
731
699
|
|
|
700
|
+
<dl>
|
|
701
|
+
<dd>
|
|
732
702
|
|
|
703
|
+
**start_time:** `String`
|
|
704
|
+
|
|
733
705
|
</dd>
|
|
734
706
|
</dl>
|
|
735
|
-
</details>
|
|
736
707
|
|
|
737
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">list_audit_logs</a>() -> Schematic::Accounts::Types::ListAuditLogsResponse</code></summary>
|
|
738
708
|
<dl>
|
|
739
709
|
<dd>
|
|
740
710
|
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
<dl>
|
|
747
|
-
<dd>
|
|
748
|
-
|
|
749
|
-
```ruby
|
|
750
|
-
client.accounts.list_audit_logs(
|
|
751
|
-
actor_type: "api_key",
|
|
752
|
-
company_id: "company_id",
|
|
753
|
-
end_time: "2024-01-15T09:30:00Z",
|
|
754
|
-
environment_id: "environment_id",
|
|
755
|
-
q: "q",
|
|
756
|
-
start_time: "2024-01-15T09:30:00Z",
|
|
757
|
-
limit: 1000000,
|
|
758
|
-
offset: 1000000
|
|
759
|
-
)
|
|
760
|
-
```
|
|
761
|
-
</dd>
|
|
762
|
-
</dl>
|
|
763
|
-
</dd>
|
|
764
|
-
</dl>
|
|
765
|
-
|
|
766
|
-
#### ⚙️ Parameters
|
|
767
|
-
|
|
768
|
-
<dl>
|
|
769
|
-
<dd>
|
|
770
|
-
|
|
771
|
-
<dl>
|
|
772
|
-
<dd>
|
|
773
|
-
|
|
774
|
-
**actor_type:** `Schematic::Types::ActorType`
|
|
775
|
-
|
|
776
|
-
</dd>
|
|
777
|
-
</dl>
|
|
778
|
-
|
|
779
|
-
<dl>
|
|
780
|
-
<dd>
|
|
781
|
-
|
|
782
|
-
**company_id:** `String`
|
|
783
|
-
|
|
784
|
-
</dd>
|
|
785
|
-
</dl>
|
|
786
|
-
|
|
787
|
-
<dl>
|
|
788
|
-
<dd>
|
|
789
|
-
|
|
790
|
-
**end_time:** `String`
|
|
791
|
-
|
|
792
|
-
</dd>
|
|
793
|
-
</dl>
|
|
794
|
-
|
|
795
|
-
<dl>
|
|
796
|
-
<dd>
|
|
797
|
-
|
|
798
|
-
**environment_id:** `String`
|
|
799
|
-
|
|
800
|
-
</dd>
|
|
801
|
-
</dl>
|
|
802
|
-
|
|
803
|
-
<dl>
|
|
804
|
-
<dd>
|
|
805
|
-
|
|
806
|
-
**q:** `String`
|
|
807
|
-
|
|
808
|
-
</dd>
|
|
809
|
-
</dl>
|
|
810
|
-
|
|
811
|
-
<dl>
|
|
812
|
-
<dd>
|
|
813
|
-
|
|
814
|
-
**start_time:** `String`
|
|
815
|
-
|
|
816
|
-
</dd>
|
|
817
|
-
</dl>
|
|
818
|
-
|
|
819
|
-
<dl>
|
|
820
|
-
<dd>
|
|
821
|
-
|
|
822
|
-
**limit:** `Integer` — Page limit (default 100)
|
|
823
|
-
|
|
824
|
-
</dd>
|
|
825
|
-
</dl>
|
|
826
|
-
|
|
827
|
-
<dl>
|
|
828
|
-
<dd>
|
|
829
|
-
|
|
830
|
-
**offset:** `Integer` — Page offset (default 0)
|
|
831
|
-
|
|
832
|
-
</dd>
|
|
833
|
-
</dl>
|
|
834
|
-
|
|
835
|
-
<dl>
|
|
836
|
-
<dd>
|
|
837
|
-
|
|
838
|
-
**request_options:** `Schematic::Accounts::RequestOptions`
|
|
839
|
-
|
|
840
|
-
</dd>
|
|
841
|
-
</dl>
|
|
842
|
-
</dd>
|
|
843
|
-
</dl>
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
</dd>
|
|
847
|
-
</dl>
|
|
848
|
-
</details>
|
|
849
|
-
|
|
850
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">get_audit_log</a>(audit_log_id:) -> Schematic::Accounts::Types::GetAuditLogResponse</code></summary>
|
|
851
|
-
<dl>
|
|
852
|
-
<dd>
|
|
853
|
-
|
|
854
|
-
#### 🔌 Usage
|
|
855
|
-
|
|
856
|
-
<dl>
|
|
857
|
-
<dd>
|
|
858
|
-
|
|
859
|
-
<dl>
|
|
860
|
-
<dd>
|
|
861
|
-
|
|
862
|
-
```ruby
|
|
863
|
-
client.accounts.get_audit_log(audit_log_id: "audit_log_id")
|
|
864
|
-
```
|
|
865
|
-
</dd>
|
|
866
|
-
</dl>
|
|
867
|
-
</dd>
|
|
868
|
-
</dl>
|
|
869
|
-
|
|
870
|
-
#### ⚙️ Parameters
|
|
871
|
-
|
|
872
|
-
<dl>
|
|
873
|
-
<dd>
|
|
874
|
-
|
|
875
|
-
<dl>
|
|
876
|
-
<dd>
|
|
877
|
-
|
|
878
|
-
**audit_log_id:** `String` — audit_log_id
|
|
879
|
-
|
|
880
|
-
</dd>
|
|
881
|
-
</dl>
|
|
882
|
-
|
|
883
|
-
<dl>
|
|
884
|
-
<dd>
|
|
885
|
-
|
|
886
|
-
**request_options:** `Schematic::Accounts::RequestOptions`
|
|
887
|
-
|
|
888
|
-
</dd>
|
|
889
|
-
</dl>
|
|
890
|
-
</dd>
|
|
891
|
-
</dl>
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
</dd>
|
|
895
|
-
</dl>
|
|
896
|
-
</details>
|
|
897
|
-
|
|
898
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">count_audit_logs</a>() -> Schematic::Accounts::Types::CountAuditLogsResponse</code></summary>
|
|
899
|
-
<dl>
|
|
900
|
-
<dd>
|
|
901
|
-
|
|
902
|
-
#### 🔌 Usage
|
|
903
|
-
|
|
904
|
-
<dl>
|
|
905
|
-
<dd>
|
|
906
|
-
|
|
907
|
-
<dl>
|
|
908
|
-
<dd>
|
|
909
|
-
|
|
910
|
-
```ruby
|
|
911
|
-
client.accounts.count_audit_logs(
|
|
912
|
-
actor_type: "api_key",
|
|
913
|
-
company_id: "company_id",
|
|
914
|
-
end_time: "2024-01-15T09:30:00Z",
|
|
915
|
-
environment_id: "environment_id",
|
|
916
|
-
q: "q",
|
|
917
|
-
start_time: "2024-01-15T09:30:00Z",
|
|
918
|
-
limit: 1000000,
|
|
919
|
-
offset: 1000000
|
|
920
|
-
)
|
|
921
|
-
```
|
|
922
|
-
</dd>
|
|
923
|
-
</dl>
|
|
924
|
-
</dd>
|
|
925
|
-
</dl>
|
|
926
|
-
|
|
927
|
-
#### ⚙️ Parameters
|
|
928
|
-
|
|
929
|
-
<dl>
|
|
930
|
-
<dd>
|
|
931
|
-
|
|
932
|
-
<dl>
|
|
933
|
-
<dd>
|
|
934
|
-
|
|
935
|
-
**actor_type:** `Schematic::Types::ActorType`
|
|
936
|
-
|
|
937
|
-
</dd>
|
|
938
|
-
</dl>
|
|
939
|
-
|
|
940
|
-
<dl>
|
|
941
|
-
<dd>
|
|
942
|
-
|
|
943
|
-
**company_id:** `String`
|
|
944
|
-
|
|
945
|
-
</dd>
|
|
946
|
-
</dl>
|
|
947
|
-
|
|
948
|
-
<dl>
|
|
949
|
-
<dd>
|
|
950
|
-
|
|
951
|
-
**end_time:** `String`
|
|
952
|
-
|
|
953
|
-
</dd>
|
|
954
|
-
</dl>
|
|
955
|
-
|
|
956
|
-
<dl>
|
|
957
|
-
<dd>
|
|
958
|
-
|
|
959
|
-
**environment_id:** `String`
|
|
960
|
-
|
|
961
|
-
</dd>
|
|
962
|
-
</dl>
|
|
963
|
-
|
|
964
|
-
<dl>
|
|
965
|
-
<dd>
|
|
966
|
-
|
|
967
|
-
**q:** `String`
|
|
968
|
-
|
|
969
|
-
</dd>
|
|
970
|
-
</dl>
|
|
971
|
-
|
|
972
|
-
<dl>
|
|
973
|
-
<dd>
|
|
974
|
-
|
|
975
|
-
**start_time:** `String`
|
|
976
|
-
|
|
977
|
-
</dd>
|
|
978
|
-
</dl>
|
|
979
|
-
|
|
980
|
-
<dl>
|
|
981
|
-
<dd>
|
|
982
|
-
|
|
983
|
-
**limit:** `Integer` — Page limit (default 100)
|
|
984
|
-
|
|
985
|
-
</dd>
|
|
986
|
-
</dl>
|
|
711
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
712
|
+
|
|
713
|
+
</dd>
|
|
714
|
+
</dl>
|
|
987
715
|
|
|
988
716
|
<dl>
|
|
989
717
|
<dd>
|
|
@@ -3871,7 +3599,7 @@ client.billing.update_company_billing_profile(
|
|
|
3871
3599
|
<dl>
|
|
3872
3600
|
<dd>
|
|
3873
3601
|
|
|
3874
|
-
**
|
|
3602
|
+
**billing_details:** `Schematic::Types::ContractBillingDetailsRequestBody`
|
|
3875
3603
|
|
|
3876
3604
|
</dd>
|
|
3877
3605
|
</dl>
|
|
@@ -3879,7 +3607,7 @@ client.billing.update_company_billing_profile(
|
|
|
3879
3607
|
<dl>
|
|
3880
3608
|
<dd>
|
|
3881
3609
|
|
|
3882
|
-
**
|
|
3610
|
+
**collection_method:** `Schematic::Types::BillingCollectionMethod`
|
|
3883
3611
|
|
|
3884
3612
|
</dd>
|
|
3885
3613
|
</dl>
|
|
@@ -3887,7 +3615,7 @@ client.billing.update_company_billing_profile(
|
|
|
3887
3615
|
<dl>
|
|
3888
3616
|
<dd>
|
|
3889
3617
|
|
|
3890
|
-
**
|
|
3618
|
+
**collector:** `Schematic::Types::Collector`
|
|
3891
3619
|
|
|
3892
3620
|
</dd>
|
|
3893
3621
|
</dl>
|
|
@@ -3895,7 +3623,7 @@ client.billing.update_company_billing_profile(
|
|
|
3895
3623
|
<dl>
|
|
3896
3624
|
<dd>
|
|
3897
3625
|
|
|
3898
|
-
**
|
|
3626
|
+
**currency:** `Schematic::Types::Currency`
|
|
3899
3627
|
|
|
3900
3628
|
</dd>
|
|
3901
3629
|
</dl>
|
|
@@ -3903,7 +3631,7 @@ client.billing.update_company_billing_profile(
|
|
|
3903
3631
|
<dl>
|
|
3904
3632
|
<dd>
|
|
3905
3633
|
|
|
3906
|
-
**
|
|
3634
|
+
**days_until_due:** `Integer`
|
|
3907
3635
|
|
|
3908
3636
|
</dd>
|
|
3909
3637
|
</dl>
|
|
@@ -3911,7 +3639,7 @@ client.billing.update_company_billing_profile(
|
|
|
3911
3639
|
<dl>
|
|
3912
3640
|
<dd>
|
|
3913
3641
|
|
|
3914
|
-
**
|
|
3642
|
+
**gating_days:** `Integer`
|
|
3915
3643
|
|
|
3916
3644
|
</dd>
|
|
3917
3645
|
</dl>
|
|
@@ -3919,7 +3647,23 @@ client.billing.update_company_billing_profile(
|
|
|
3919
3647
|
<dl>
|
|
3920
3648
|
<dd>
|
|
3921
3649
|
|
|
3922
|
-
**
|
|
3650
|
+
**is_default:** `Internal::Types::Boolean`
|
|
3651
|
+
|
|
3652
|
+
</dd>
|
|
3653
|
+
</dl>
|
|
3654
|
+
|
|
3655
|
+
<dl>
|
|
3656
|
+
<dd>
|
|
3657
|
+
|
|
3658
|
+
**name:** `String`
|
|
3659
|
+
|
|
3660
|
+
</dd>
|
|
3661
|
+
</dl>
|
|
3662
|
+
|
|
3663
|
+
<dl>
|
|
3664
|
+
<dd>
|
|
3665
|
+
|
|
3666
|
+
**overdraft_limit:** `Integer`
|
|
3923
3667
|
|
|
3924
3668
|
</dd>
|
|
3925
3669
|
</dl>
|
|
@@ -3951,6 +3695,209 @@ client.billing.update_company_billing_profile(
|
|
|
3951
3695
|
<dl>
|
|
3952
3696
|
<dd>
|
|
3953
3697
|
|
|
3698
|
+
**purchase_order:** `String`
|
|
3699
|
+
|
|
3700
|
+
</dd>
|
|
3701
|
+
</dl>
|
|
3702
|
+
|
|
3703
|
+
<dl>
|
|
3704
|
+
<dd>
|
|
3705
|
+
|
|
3706
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
3707
|
+
|
|
3708
|
+
</dd>
|
|
3709
|
+
</dl>
|
|
3710
|
+
</dd>
|
|
3711
|
+
</dl>
|
|
3712
|
+
|
|
3713
|
+
|
|
3714
|
+
</dd>
|
|
3715
|
+
</dl>
|
|
3716
|
+
</details>
|
|
3717
|
+
|
|
3718
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">get_company_contract</a>(billing_profile_id:) -> Schematic::Billing::Types::GetCompanyContractResponse</code></summary>
|
|
3719
|
+
<dl>
|
|
3720
|
+
<dd>
|
|
3721
|
+
|
|
3722
|
+
#### 🔌 Usage
|
|
3723
|
+
|
|
3724
|
+
<dl>
|
|
3725
|
+
<dd>
|
|
3726
|
+
|
|
3727
|
+
<dl>
|
|
3728
|
+
<dd>
|
|
3729
|
+
|
|
3730
|
+
```ruby
|
|
3731
|
+
client.billing.get_company_contract(billing_profile_id: "billing_profile_id")
|
|
3732
|
+
```
|
|
3733
|
+
</dd>
|
|
3734
|
+
</dl>
|
|
3735
|
+
</dd>
|
|
3736
|
+
</dl>
|
|
3737
|
+
|
|
3738
|
+
#### ⚙️ Parameters
|
|
3739
|
+
|
|
3740
|
+
<dl>
|
|
3741
|
+
<dd>
|
|
3742
|
+
|
|
3743
|
+
<dl>
|
|
3744
|
+
<dd>
|
|
3745
|
+
|
|
3746
|
+
**billing_profile_id:** `String` — billing_profile_id
|
|
3747
|
+
|
|
3748
|
+
</dd>
|
|
3749
|
+
</dl>
|
|
3750
|
+
|
|
3751
|
+
<dl>
|
|
3752
|
+
<dd>
|
|
3753
|
+
|
|
3754
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
3755
|
+
|
|
3756
|
+
</dd>
|
|
3757
|
+
</dl>
|
|
3758
|
+
</dd>
|
|
3759
|
+
</dl>
|
|
3760
|
+
|
|
3761
|
+
|
|
3762
|
+
</dd>
|
|
3763
|
+
</dl>
|
|
3764
|
+
</details>
|
|
3765
|
+
|
|
3766
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">download_contract_document</a>(billing_profile_id:) -> String</code></summary>
|
|
3767
|
+
<dl>
|
|
3768
|
+
<dd>
|
|
3769
|
+
|
|
3770
|
+
#### 🔌 Usage
|
|
3771
|
+
|
|
3772
|
+
<dl>
|
|
3773
|
+
<dd>
|
|
3774
|
+
|
|
3775
|
+
<dl>
|
|
3776
|
+
<dd>
|
|
3777
|
+
|
|
3778
|
+
```ruby
|
|
3779
|
+
client.billing.download_contract_document(billing_profile_id: "billing_profile_id")
|
|
3780
|
+
```
|
|
3781
|
+
</dd>
|
|
3782
|
+
</dl>
|
|
3783
|
+
</dd>
|
|
3784
|
+
</dl>
|
|
3785
|
+
|
|
3786
|
+
#### ⚙️ Parameters
|
|
3787
|
+
|
|
3788
|
+
<dl>
|
|
3789
|
+
<dd>
|
|
3790
|
+
|
|
3791
|
+
<dl>
|
|
3792
|
+
<dd>
|
|
3793
|
+
|
|
3794
|
+
**billing_profile_id:** `String` — billing_profile_id
|
|
3795
|
+
|
|
3796
|
+
</dd>
|
|
3797
|
+
</dl>
|
|
3798
|
+
|
|
3799
|
+
<dl>
|
|
3800
|
+
<dd>
|
|
3801
|
+
|
|
3802
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
3803
|
+
|
|
3804
|
+
</dd>
|
|
3805
|
+
</dl>
|
|
3806
|
+
</dd>
|
|
3807
|
+
</dl>
|
|
3808
|
+
|
|
3809
|
+
|
|
3810
|
+
</dd>
|
|
3811
|
+
</dl>
|
|
3812
|
+
</details>
|
|
3813
|
+
|
|
3814
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">upload_contract_document</a>(billing_profile_id:, request) -> Schematic::Billing::Types::UploadContractDocumentResponse</code></summary>
|
|
3815
|
+
<dl>
|
|
3816
|
+
<dd>
|
|
3817
|
+
|
|
3818
|
+
#### 🔌 Usage
|
|
3819
|
+
|
|
3820
|
+
<dl>
|
|
3821
|
+
<dd>
|
|
3822
|
+
|
|
3823
|
+
<dl>
|
|
3824
|
+
<dd>
|
|
3825
|
+
|
|
3826
|
+
```ruby
|
|
3827
|
+
client.billing.upload_contract_document(
|
|
3828
|
+
billing_profile_id: "billing_profile_id",
|
|
3829
|
+
file: "/path/to/your/file"
|
|
3830
|
+
)
|
|
3831
|
+
```
|
|
3832
|
+
</dd>
|
|
3833
|
+
</dl>
|
|
3834
|
+
</dd>
|
|
3835
|
+
</dl>
|
|
3836
|
+
|
|
3837
|
+
#### ⚙️ Parameters
|
|
3838
|
+
|
|
3839
|
+
<dl>
|
|
3840
|
+
<dd>
|
|
3841
|
+
|
|
3842
|
+
<dl>
|
|
3843
|
+
<dd>
|
|
3844
|
+
|
|
3845
|
+
**billing_profile_id:** `String` — billing_profile_id
|
|
3846
|
+
|
|
3847
|
+
</dd>
|
|
3848
|
+
</dl>
|
|
3849
|
+
|
|
3850
|
+
<dl>
|
|
3851
|
+
<dd>
|
|
3852
|
+
|
|
3853
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
3854
|
+
|
|
3855
|
+
</dd>
|
|
3856
|
+
</dl>
|
|
3857
|
+
</dd>
|
|
3858
|
+
</dl>
|
|
3859
|
+
|
|
3860
|
+
|
|
3861
|
+
</dd>
|
|
3862
|
+
</dl>
|
|
3863
|
+
</details>
|
|
3864
|
+
|
|
3865
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">delete_contract_document</a>(billing_profile_id:) -> Schematic::Billing::Types::DeleteContractDocumentResponse</code></summary>
|
|
3866
|
+
<dl>
|
|
3867
|
+
<dd>
|
|
3868
|
+
|
|
3869
|
+
#### 🔌 Usage
|
|
3870
|
+
|
|
3871
|
+
<dl>
|
|
3872
|
+
<dd>
|
|
3873
|
+
|
|
3874
|
+
<dl>
|
|
3875
|
+
<dd>
|
|
3876
|
+
|
|
3877
|
+
```ruby
|
|
3878
|
+
client.billing.delete_contract_document(billing_profile_id: "billing_profile_id")
|
|
3879
|
+
```
|
|
3880
|
+
</dd>
|
|
3881
|
+
</dl>
|
|
3882
|
+
</dd>
|
|
3883
|
+
</dl>
|
|
3884
|
+
|
|
3885
|
+
#### ⚙️ Parameters
|
|
3886
|
+
|
|
3887
|
+
<dl>
|
|
3888
|
+
<dd>
|
|
3889
|
+
|
|
3890
|
+
<dl>
|
|
3891
|
+
<dd>
|
|
3892
|
+
|
|
3893
|
+
**billing_profile_id:** `String` — billing_profile_id
|
|
3894
|
+
|
|
3895
|
+
</dd>
|
|
3896
|
+
</dl>
|
|
3897
|
+
|
|
3898
|
+
<dl>
|
|
3899
|
+
<dd>
|
|
3900
|
+
|
|
3954
3901
|
**request_options:** `Schematic::Billing::RequestOptions`
|
|
3955
3902
|
|
|
3956
3903
|
</dd>
|
|
@@ -4031,6 +3978,14 @@ client.billing.update_billing_settings
|
|
|
4031
3978
|
<dl>
|
|
4032
3979
|
<dd>
|
|
4033
3980
|
|
|
3981
|
+
**default_collector:** `Schematic::Types::Collector`
|
|
3982
|
+
|
|
3983
|
+
</dd>
|
|
3984
|
+
</dl>
|
|
3985
|
+
|
|
3986
|
+
<dl>
|
|
3987
|
+
<dd>
|
|
3988
|
+
|
|
4034
3989
|
**default_provider_type:** `Schematic::Types::BillingProviderType`
|
|
4035
3990
|
|
|
4036
3991
|
</dd>
|
|
@@ -4039,6 +3994,14 @@ client.billing.update_billing_settings
|
|
|
4039
3994
|
<dl>
|
|
4040
3995
|
<dd>
|
|
4041
3996
|
|
|
3997
|
+
**invoice_reply_to_email:** `String` — Where a payer's reply to an invoice email goes. Schematic sends no invoice email until it is set. Send null to clear it.
|
|
3998
|
+
|
|
3999
|
+
</dd>
|
|
4000
|
+
</dl>
|
|
4001
|
+
|
|
4002
|
+
<dl>
|
|
4003
|
+
<dd>
|
|
4004
|
+
|
|
4042
4005
|
**request_options:** `Schematic::Billing::RequestOptions`
|
|
4043
4006
|
|
|
4044
4007
|
</dd>
|
|
@@ -4197,6 +4160,22 @@ client.billing.upsert_billing_subscription(
|
|
|
4197
4160
|
<dl>
|
|
4198
4161
|
<dd>
|
|
4199
4162
|
|
|
4163
|
+
**pause_behavior:** `Schematic::Types::BillingSubscriptionPauseBehavior` — How the provider treats invoices while payment collection is paused. Omit it to keep the current pause, send null to clear it, or send a behavior to set one.
|
|
4164
|
+
|
|
4165
|
+
</dd>
|
|
4166
|
+
</dl>
|
|
4167
|
+
|
|
4168
|
+
<dl>
|
|
4169
|
+
<dd>
|
|
4170
|
+
|
|
4171
|
+
**pause_resumes_at:** `Integer`
|
|
4172
|
+
|
|
4173
|
+
</dd>
|
|
4174
|
+
</dl>
|
|
4175
|
+
|
|
4176
|
+
<dl>
|
|
4177
|
+
<dd>
|
|
4178
|
+
|
|
4200
4179
|
**period_end:** `Integer`
|
|
4201
4180
|
|
|
4202
4181
|
</dd>
|
|
@@ -4337,7 +4316,7 @@ client.billing.get_company_native_subscription(company_id: "company_id")
|
|
|
4337
4316
|
</dl>
|
|
4338
4317
|
</details>
|
|
4339
4318
|
|
|
4340
|
-
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">
|
|
4319
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">move_to_default_plan</a>(company_id:) -> Schematic::Billing::Types::MoveToDefaultPlanResponse</code></summary>
|
|
4341
4320
|
<dl>
|
|
4342
4321
|
<dd>
|
|
4343
4322
|
|
|
@@ -4350,17 +4329,7 @@ client.billing.get_company_native_subscription(company_id: "company_id")
|
|
|
4350
4329
|
<dd>
|
|
4351
4330
|
|
|
4352
4331
|
```ruby
|
|
4353
|
-
client.billing.
|
|
4354
|
-
company_id: "company_id",
|
|
4355
|
-
contract_id: "contract_id",
|
|
4356
|
-
document_state: "credited",
|
|
4357
|
-
past_due: true,
|
|
4358
|
-
provider_type: "metronome",
|
|
4359
|
-
q: "q",
|
|
4360
|
-
status: "draft",
|
|
4361
|
-
limit: 1000000,
|
|
4362
|
-
offset: 1000000
|
|
4363
|
-
)
|
|
4332
|
+
client.billing.move_to_default_plan(company_id: "company_id")
|
|
4364
4333
|
```
|
|
4365
4334
|
</dd>
|
|
4366
4335
|
</dl>
|
|
@@ -4375,7 +4344,7 @@ client.billing.list_billing_invoices(
|
|
|
4375
4344
|
<dl>
|
|
4376
4345
|
<dd>
|
|
4377
4346
|
|
|
4378
|
-
**company_id:** `String`
|
|
4347
|
+
**company_id:** `String` — company_id
|
|
4379
4348
|
|
|
4380
4349
|
</dd>
|
|
4381
4350
|
</dl>
|
|
@@ -4383,12 +4352,118 @@ client.billing.list_billing_invoices(
|
|
|
4383
4352
|
<dl>
|
|
4384
4353
|
<dd>
|
|
4385
4354
|
|
|
4386
|
-
**
|
|
4355
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
4387
4356
|
|
|
4388
4357
|
</dd>
|
|
4389
4358
|
</dl>
|
|
4359
|
+
</dd>
|
|
4360
|
+
</dl>
|
|
4390
4361
|
|
|
4391
|
-
|
|
4362
|
+
|
|
4363
|
+
</dd>
|
|
4364
|
+
</dl>
|
|
4365
|
+
</details>
|
|
4366
|
+
|
|
4367
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">get_company_upcoming_invoices</a>(company_id:) -> Schematic::Billing::Types::GetCompanyUpcomingInvoicesResponse</code></summary>
|
|
4368
|
+
<dl>
|
|
4369
|
+
<dd>
|
|
4370
|
+
|
|
4371
|
+
#### 🔌 Usage
|
|
4372
|
+
|
|
4373
|
+
<dl>
|
|
4374
|
+
<dd>
|
|
4375
|
+
|
|
4376
|
+
<dl>
|
|
4377
|
+
<dd>
|
|
4378
|
+
|
|
4379
|
+
```ruby
|
|
4380
|
+
client.billing.get_company_upcoming_invoices(company_id: "company_id")
|
|
4381
|
+
```
|
|
4382
|
+
</dd>
|
|
4383
|
+
</dl>
|
|
4384
|
+
</dd>
|
|
4385
|
+
</dl>
|
|
4386
|
+
|
|
4387
|
+
#### ⚙️ Parameters
|
|
4388
|
+
|
|
4389
|
+
<dl>
|
|
4390
|
+
<dd>
|
|
4391
|
+
|
|
4392
|
+
<dl>
|
|
4393
|
+
<dd>
|
|
4394
|
+
|
|
4395
|
+
**company_id:** `String` — company_id
|
|
4396
|
+
|
|
4397
|
+
</dd>
|
|
4398
|
+
</dl>
|
|
4399
|
+
|
|
4400
|
+
<dl>
|
|
4401
|
+
<dd>
|
|
4402
|
+
|
|
4403
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
4404
|
+
|
|
4405
|
+
</dd>
|
|
4406
|
+
</dl>
|
|
4407
|
+
</dd>
|
|
4408
|
+
</dl>
|
|
4409
|
+
|
|
4410
|
+
|
|
4411
|
+
</dd>
|
|
4412
|
+
</dl>
|
|
4413
|
+
</details>
|
|
4414
|
+
|
|
4415
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">list_billing_invoices</a>() -> Schematic::Billing::Types::ListBillingInvoicesResponse</code></summary>
|
|
4416
|
+
<dl>
|
|
4417
|
+
<dd>
|
|
4418
|
+
|
|
4419
|
+
#### 🔌 Usage
|
|
4420
|
+
|
|
4421
|
+
<dl>
|
|
4422
|
+
<dd>
|
|
4423
|
+
|
|
4424
|
+
<dl>
|
|
4425
|
+
<dd>
|
|
4426
|
+
|
|
4427
|
+
```ruby
|
|
4428
|
+
client.billing.list_billing_invoices(
|
|
4429
|
+
company_id: "company_id",
|
|
4430
|
+
contract_id: "contract_id",
|
|
4431
|
+
document_state: "credited",
|
|
4432
|
+
past_due: true,
|
|
4433
|
+
provider_type: "metronome",
|
|
4434
|
+
q: "q",
|
|
4435
|
+
status: "draft",
|
|
4436
|
+
limit: 1000000,
|
|
4437
|
+
offset: 1000000
|
|
4438
|
+
)
|
|
4439
|
+
```
|
|
4440
|
+
</dd>
|
|
4441
|
+
</dl>
|
|
4442
|
+
</dd>
|
|
4443
|
+
</dl>
|
|
4444
|
+
|
|
4445
|
+
#### ⚙️ Parameters
|
|
4446
|
+
|
|
4447
|
+
<dl>
|
|
4448
|
+
<dd>
|
|
4449
|
+
|
|
4450
|
+
<dl>
|
|
4451
|
+
<dd>
|
|
4452
|
+
|
|
4453
|
+
**company_id:** `String`
|
|
4454
|
+
|
|
4455
|
+
</dd>
|
|
4456
|
+
</dl>
|
|
4457
|
+
|
|
4458
|
+
<dl>
|
|
4459
|
+
<dd>
|
|
4460
|
+
|
|
4461
|
+
**contract_id:** `String`
|
|
4462
|
+
|
|
4463
|
+
</dd>
|
|
4464
|
+
</dl>
|
|
4465
|
+
|
|
4466
|
+
<dl>
|
|
4392
4467
|
<dd>
|
|
4393
4468
|
|
|
4394
4469
|
**document_state:** `Schematic::Types::InvoiceDocumentState`
|
|
@@ -4503,6 +4578,54 @@ client.billing.get_billing_invoice(invoice_id: "invoice_id")
|
|
|
4503
4578
|
</dl>
|
|
4504
4579
|
|
|
4505
4580
|
|
|
4581
|
+
</dd>
|
|
4582
|
+
</dl>
|
|
4583
|
+
</details>
|
|
4584
|
+
|
|
4585
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">charge_native_invoice</a>(invoice_id:) -> Schematic::Billing::Types::ChargeNativeInvoiceResponse</code></summary>
|
|
4586
|
+
<dl>
|
|
4587
|
+
<dd>
|
|
4588
|
+
|
|
4589
|
+
#### 🔌 Usage
|
|
4590
|
+
|
|
4591
|
+
<dl>
|
|
4592
|
+
<dd>
|
|
4593
|
+
|
|
4594
|
+
<dl>
|
|
4595
|
+
<dd>
|
|
4596
|
+
|
|
4597
|
+
```ruby
|
|
4598
|
+
client.billing.charge_native_invoice(invoice_id: "invoice_id")
|
|
4599
|
+
```
|
|
4600
|
+
</dd>
|
|
4601
|
+
</dl>
|
|
4602
|
+
</dd>
|
|
4603
|
+
</dl>
|
|
4604
|
+
|
|
4605
|
+
#### ⚙️ Parameters
|
|
4606
|
+
|
|
4607
|
+
<dl>
|
|
4608
|
+
<dd>
|
|
4609
|
+
|
|
4610
|
+
<dl>
|
|
4611
|
+
<dd>
|
|
4612
|
+
|
|
4613
|
+
**invoice_id:** `String` — invoice_id
|
|
4614
|
+
|
|
4615
|
+
</dd>
|
|
4616
|
+
</dl>
|
|
4617
|
+
|
|
4618
|
+
<dl>
|
|
4619
|
+
<dd>
|
|
4620
|
+
|
|
4621
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
4622
|
+
|
|
4623
|
+
</dd>
|
|
4624
|
+
</dl>
|
|
4625
|
+
</dd>
|
|
4626
|
+
</dl>
|
|
4627
|
+
|
|
4628
|
+
|
|
4506
4629
|
</dd>
|
|
4507
4630
|
</dl>
|
|
4508
4631
|
</details>
|
|
@@ -4599,6 +4722,102 @@ client.billing.finalize_native_invoice(invoice_id: "invoice_id")
|
|
|
4599
4722
|
</dl>
|
|
4600
4723
|
|
|
4601
4724
|
|
|
4725
|
+
</dd>
|
|
4726
|
+
</dl>
|
|
4727
|
+
</details>
|
|
4728
|
+
|
|
4729
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">reissue_native_invoice_link</a>(invoice_id:) -> Schematic::Billing::Types::ReissueNativeInvoiceLinkResponse</code></summary>
|
|
4730
|
+
<dl>
|
|
4731
|
+
<dd>
|
|
4732
|
+
|
|
4733
|
+
#### 🔌 Usage
|
|
4734
|
+
|
|
4735
|
+
<dl>
|
|
4736
|
+
<dd>
|
|
4737
|
+
|
|
4738
|
+
<dl>
|
|
4739
|
+
<dd>
|
|
4740
|
+
|
|
4741
|
+
```ruby
|
|
4742
|
+
client.billing.reissue_native_invoice_link(invoice_id: "invoice_id")
|
|
4743
|
+
```
|
|
4744
|
+
</dd>
|
|
4745
|
+
</dl>
|
|
4746
|
+
</dd>
|
|
4747
|
+
</dl>
|
|
4748
|
+
|
|
4749
|
+
#### ⚙️ Parameters
|
|
4750
|
+
|
|
4751
|
+
<dl>
|
|
4752
|
+
<dd>
|
|
4753
|
+
|
|
4754
|
+
<dl>
|
|
4755
|
+
<dd>
|
|
4756
|
+
|
|
4757
|
+
**invoice_id:** `String` — invoice_id
|
|
4758
|
+
|
|
4759
|
+
</dd>
|
|
4760
|
+
</dl>
|
|
4761
|
+
|
|
4762
|
+
<dl>
|
|
4763
|
+
<dd>
|
|
4764
|
+
|
|
4765
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
4766
|
+
|
|
4767
|
+
</dd>
|
|
4768
|
+
</dl>
|
|
4769
|
+
</dd>
|
|
4770
|
+
</dl>
|
|
4771
|
+
|
|
4772
|
+
|
|
4773
|
+
</dd>
|
|
4774
|
+
</dl>
|
|
4775
|
+
</details>
|
|
4776
|
+
|
|
4777
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">revoke_native_invoice_link</a>(invoice_id:) -> Schematic::Billing::Types::RevokeNativeInvoiceLinkResponse</code></summary>
|
|
4778
|
+
<dl>
|
|
4779
|
+
<dd>
|
|
4780
|
+
|
|
4781
|
+
#### 🔌 Usage
|
|
4782
|
+
|
|
4783
|
+
<dl>
|
|
4784
|
+
<dd>
|
|
4785
|
+
|
|
4786
|
+
<dl>
|
|
4787
|
+
<dd>
|
|
4788
|
+
|
|
4789
|
+
```ruby
|
|
4790
|
+
client.billing.revoke_native_invoice_link(invoice_id: "invoice_id")
|
|
4791
|
+
```
|
|
4792
|
+
</dd>
|
|
4793
|
+
</dl>
|
|
4794
|
+
</dd>
|
|
4795
|
+
</dl>
|
|
4796
|
+
|
|
4797
|
+
#### ⚙️ Parameters
|
|
4798
|
+
|
|
4799
|
+
<dl>
|
|
4800
|
+
<dd>
|
|
4801
|
+
|
|
4802
|
+
<dl>
|
|
4803
|
+
<dd>
|
|
4804
|
+
|
|
4805
|
+
**invoice_id:** `String` — invoice_id
|
|
4806
|
+
|
|
4807
|
+
</dd>
|
|
4808
|
+
</dl>
|
|
4809
|
+
|
|
4810
|
+
<dl>
|
|
4811
|
+
<dd>
|
|
4812
|
+
|
|
4813
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
4814
|
+
|
|
4815
|
+
</dd>
|
|
4816
|
+
</dl>
|
|
4817
|
+
</dd>
|
|
4818
|
+
</dl>
|
|
4819
|
+
|
|
4820
|
+
|
|
4602
4821
|
</dd>
|
|
4603
4822
|
</dl>
|
|
4604
4823
|
</details>
|
|
@@ -8710,6 +8929,14 @@ client.catalogs.update_configuration(catalog_id: "catalog_id")
|
|
|
8710
8929
|
<dl>
|
|
8711
8930
|
<dd>
|
|
8712
8931
|
|
|
8932
|
+
**custom_plan_id:** `String`
|
|
8933
|
+
|
|
8934
|
+
</dd>
|
|
8935
|
+
</dl>
|
|
8936
|
+
|
|
8937
|
+
<dl>
|
|
8938
|
+
<dd>
|
|
8939
|
+
|
|
8713
8940
|
**custom_plan_price_text:** `String`
|
|
8714
8941
|
|
|
8715
8942
|
</dd>
|
|
@@ -9791,7 +10018,7 @@ client.checkout.cancel_subscription(company_id: "company_id")
|
|
|
9791
10018
|
</dl>
|
|
9792
10019
|
</details>
|
|
9793
10020
|
|
|
9794
|
-
<details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">
|
|
10021
|
+
<details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">pause_subscription</a>(request) -> Schematic::Checkout::Types::PauseSubscriptionResponse</code></summary>
|
|
9795
10022
|
<dl>
|
|
9796
10023
|
<dd>
|
|
9797
10024
|
|
|
@@ -9804,7 +10031,10 @@ client.checkout.cancel_subscription(company_id: "company_id")
|
|
|
9804
10031
|
<dd>
|
|
9805
10032
|
|
|
9806
10033
|
```ruby
|
|
9807
|
-
client.checkout.
|
|
10034
|
+
client.checkout.pause_subscription(
|
|
10035
|
+
company_id: "company_id",
|
|
10036
|
+
months: 1000000
|
|
10037
|
+
)
|
|
9808
10038
|
```
|
|
9809
10039
|
</dd>
|
|
9810
10040
|
</dl>
|
|
@@ -9819,7 +10049,7 @@ client.checkout.update_customer_subscription_trial_end(subscription_id: "subscri
|
|
|
9819
10049
|
<dl>
|
|
9820
10050
|
<dd>
|
|
9821
10051
|
|
|
9822
|
-
**
|
|
10052
|
+
**company_id:** `String`
|
|
9823
10053
|
|
|
9824
10054
|
</dd>
|
|
9825
10055
|
</dl>
|
|
@@ -9827,7 +10057,127 @@ client.checkout.update_customer_subscription_trial_end(subscription_id: "subscri
|
|
|
9827
10057
|
<dl>
|
|
9828
10058
|
<dd>
|
|
9829
10059
|
|
|
9830
|
-
**
|
|
10060
|
+
**months:** `Integer` — How many months to pause for, counted from the end of the current billing period. Between 1 and 6.
|
|
10061
|
+
|
|
10062
|
+
</dd>
|
|
10063
|
+
</dl>
|
|
10064
|
+
|
|
10065
|
+
<dl>
|
|
10066
|
+
<dd>
|
|
10067
|
+
|
|
10068
|
+
**subscription_external_id:** `String` — The payment provider's ID for the subscription to pause. Required when the company has more than one subscription; otherwise defaults to its only one.
|
|
10069
|
+
|
|
10070
|
+
</dd>
|
|
10071
|
+
</dl>
|
|
10072
|
+
|
|
10073
|
+
<dl>
|
|
10074
|
+
<dd>
|
|
10075
|
+
|
|
10076
|
+
**request_options:** `Schematic::Checkout::RequestOptions`
|
|
10077
|
+
|
|
10078
|
+
</dd>
|
|
10079
|
+
</dl>
|
|
10080
|
+
</dd>
|
|
10081
|
+
</dl>
|
|
10082
|
+
|
|
10083
|
+
|
|
10084
|
+
</dd>
|
|
10085
|
+
</dl>
|
|
10086
|
+
</details>
|
|
10087
|
+
|
|
10088
|
+
<details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">resume_subscription</a>(request) -> Schematic::Checkout::Types::ResumeSubscriptionResponse</code></summary>
|
|
10089
|
+
<dl>
|
|
10090
|
+
<dd>
|
|
10091
|
+
|
|
10092
|
+
#### 🔌 Usage
|
|
10093
|
+
|
|
10094
|
+
<dl>
|
|
10095
|
+
<dd>
|
|
10096
|
+
|
|
10097
|
+
<dl>
|
|
10098
|
+
<dd>
|
|
10099
|
+
|
|
10100
|
+
```ruby
|
|
10101
|
+
client.checkout.resume_subscription(company_id: "company_id")
|
|
10102
|
+
```
|
|
10103
|
+
</dd>
|
|
10104
|
+
</dl>
|
|
10105
|
+
</dd>
|
|
10106
|
+
</dl>
|
|
10107
|
+
|
|
10108
|
+
#### ⚙️ Parameters
|
|
10109
|
+
|
|
10110
|
+
<dl>
|
|
10111
|
+
<dd>
|
|
10112
|
+
|
|
10113
|
+
<dl>
|
|
10114
|
+
<dd>
|
|
10115
|
+
|
|
10116
|
+
**company_id:** `String`
|
|
10117
|
+
|
|
10118
|
+
</dd>
|
|
10119
|
+
</dl>
|
|
10120
|
+
|
|
10121
|
+
<dl>
|
|
10122
|
+
<dd>
|
|
10123
|
+
|
|
10124
|
+
**subscription_external_id:** `String` — The payment provider's ID for the subscription to resume. Required when the company has more than one subscription; otherwise defaults to its only one.
|
|
10125
|
+
|
|
10126
|
+
</dd>
|
|
10127
|
+
</dl>
|
|
10128
|
+
|
|
10129
|
+
<dl>
|
|
10130
|
+
<dd>
|
|
10131
|
+
|
|
10132
|
+
**request_options:** `Schematic::Checkout::RequestOptions`
|
|
10133
|
+
|
|
10134
|
+
</dd>
|
|
10135
|
+
</dl>
|
|
10136
|
+
</dd>
|
|
10137
|
+
</dl>
|
|
10138
|
+
|
|
10139
|
+
|
|
10140
|
+
</dd>
|
|
10141
|
+
</dl>
|
|
10142
|
+
</details>
|
|
10143
|
+
|
|
10144
|
+
<details><summary><code>client.checkout.<a href="/lib/schematic/checkout/client.rb">update_customer_subscription_trial_end</a>(subscription_id:, request) -> Schematic::Checkout::Types::UpdateCustomerSubscriptionTrialEndResponse</code></summary>
|
|
10145
|
+
<dl>
|
|
10146
|
+
<dd>
|
|
10147
|
+
|
|
10148
|
+
#### 🔌 Usage
|
|
10149
|
+
|
|
10150
|
+
<dl>
|
|
10151
|
+
<dd>
|
|
10152
|
+
|
|
10153
|
+
<dl>
|
|
10154
|
+
<dd>
|
|
10155
|
+
|
|
10156
|
+
```ruby
|
|
10157
|
+
client.checkout.update_customer_subscription_trial_end(subscription_id: "subscription_id")
|
|
10158
|
+
```
|
|
10159
|
+
</dd>
|
|
10160
|
+
</dl>
|
|
10161
|
+
</dd>
|
|
10162
|
+
</dl>
|
|
10163
|
+
|
|
10164
|
+
#### ⚙️ Parameters
|
|
10165
|
+
|
|
10166
|
+
<dl>
|
|
10167
|
+
<dd>
|
|
10168
|
+
|
|
10169
|
+
<dl>
|
|
10170
|
+
<dd>
|
|
10171
|
+
|
|
10172
|
+
**subscription_id:** `String` — subscription_id
|
|
10173
|
+
|
|
10174
|
+
</dd>
|
|
10175
|
+
</dl>
|
|
10176
|
+
|
|
10177
|
+
<dl>
|
|
10178
|
+
<dd>
|
|
10179
|
+
|
|
10180
|
+
**trial_end:** `String`
|
|
9831
10181
|
|
|
9832
10182
|
</dd>
|
|
9833
10183
|
</dl>
|
|
@@ -10772,6 +11122,110 @@ client.companies.get_company_billing_entity(company_id: "company_id")
|
|
|
10772
11122
|
</dl>
|
|
10773
11123
|
|
|
10774
11124
|
|
|
11125
|
+
</dd>
|
|
11126
|
+
</dl>
|
|
11127
|
+
</details>
|
|
11128
|
+
|
|
11129
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">get_billing_entity_settings</a>(company_id:) -> Schematic::Companies::Types::GetBillingEntitySettingsResponse</code></summary>
|
|
11130
|
+
<dl>
|
|
11131
|
+
<dd>
|
|
11132
|
+
|
|
11133
|
+
#### 🔌 Usage
|
|
11134
|
+
|
|
11135
|
+
<dl>
|
|
11136
|
+
<dd>
|
|
11137
|
+
|
|
11138
|
+
<dl>
|
|
11139
|
+
<dd>
|
|
11140
|
+
|
|
11141
|
+
```ruby
|
|
11142
|
+
client.companies.get_billing_entity_settings(company_id: "company_id")
|
|
11143
|
+
```
|
|
11144
|
+
</dd>
|
|
11145
|
+
</dl>
|
|
11146
|
+
</dd>
|
|
11147
|
+
</dl>
|
|
11148
|
+
|
|
11149
|
+
#### ⚙️ Parameters
|
|
11150
|
+
|
|
11151
|
+
<dl>
|
|
11152
|
+
<dd>
|
|
11153
|
+
|
|
11154
|
+
<dl>
|
|
11155
|
+
<dd>
|
|
11156
|
+
|
|
11157
|
+
**company_id:** `String` — company_id
|
|
11158
|
+
|
|
11159
|
+
</dd>
|
|
11160
|
+
</dl>
|
|
11161
|
+
|
|
11162
|
+
<dl>
|
|
11163
|
+
<dd>
|
|
11164
|
+
|
|
11165
|
+
**request_options:** `Schematic::Companies::RequestOptions`
|
|
11166
|
+
|
|
11167
|
+
</dd>
|
|
11168
|
+
</dl>
|
|
11169
|
+
</dd>
|
|
11170
|
+
</dl>
|
|
11171
|
+
|
|
11172
|
+
|
|
11173
|
+
</dd>
|
|
11174
|
+
</dl>
|
|
11175
|
+
</details>
|
|
11176
|
+
|
|
11177
|
+
<details><summary><code>client.companies.<a href="/lib/schematic/companies/client.rb">update_billing_entity_settings</a>(company_id:, request) -> Schematic::Companies::Types::UpdateBillingEntitySettingsResponse</code></summary>
|
|
11178
|
+
<dl>
|
|
11179
|
+
<dd>
|
|
11180
|
+
|
|
11181
|
+
#### 🔌 Usage
|
|
11182
|
+
|
|
11183
|
+
<dl>
|
|
11184
|
+
<dd>
|
|
11185
|
+
|
|
11186
|
+
<dl>
|
|
11187
|
+
<dd>
|
|
11188
|
+
|
|
11189
|
+
```ruby
|
|
11190
|
+
client.companies.update_billing_entity_settings(company_id: "company_id")
|
|
11191
|
+
```
|
|
11192
|
+
</dd>
|
|
11193
|
+
</dl>
|
|
11194
|
+
</dd>
|
|
11195
|
+
</dl>
|
|
11196
|
+
|
|
11197
|
+
#### ⚙️ Parameters
|
|
11198
|
+
|
|
11199
|
+
<dl>
|
|
11200
|
+
<dd>
|
|
11201
|
+
|
|
11202
|
+
<dl>
|
|
11203
|
+
<dd>
|
|
11204
|
+
|
|
11205
|
+
**company_id:** `String` — company_id
|
|
11206
|
+
|
|
11207
|
+
</dd>
|
|
11208
|
+
</dl>
|
|
11209
|
+
|
|
11210
|
+
<dl>
|
|
11211
|
+
<dd>
|
|
11212
|
+
|
|
11213
|
+
**children_may_change_plan:** `Internal::Types::Boolean` — Whether the companies this company pays for may change their own plan and add-ons in components. The change is billed to this company. When false, they may only cancel.
|
|
11214
|
+
|
|
11215
|
+
</dd>
|
|
11216
|
+
</dl>
|
|
11217
|
+
|
|
11218
|
+
<dl>
|
|
11219
|
+
<dd>
|
|
11220
|
+
|
|
11221
|
+
**request_options:** `Schematic::Companies::RequestOptions`
|
|
11222
|
+
|
|
11223
|
+
</dd>
|
|
11224
|
+
</dl>
|
|
11225
|
+
</dd>
|
|
11226
|
+
</dl>
|
|
11227
|
+
|
|
11228
|
+
|
|
10775
11229
|
</dd>
|
|
10776
11230
|
</dl>
|
|
10777
11231
|
</details>
|
|
@@ -12607,6 +13061,8 @@ client.companies.list_users(
|
|
|
12607
13061
|
ids: ["ids"],
|
|
12608
13062
|
plan_id: "plan_id",
|
|
12609
13063
|
q: "q",
|
|
13064
|
+
sort_order_column: "sort_order_column",
|
|
13065
|
+
sort_order_direction: "asc",
|
|
12610
13066
|
limit: 1000000,
|
|
12611
13067
|
offset: 1000000
|
|
12612
13068
|
)
|
|
@@ -12656,6 +13112,22 @@ client.companies.list_users(
|
|
|
12656
13112
|
<dl>
|
|
12657
13113
|
<dd>
|
|
12658
13114
|
|
|
13115
|
+
**sort_order_column:** `String` — Column to sort by (e.g. name, created_at, last_seen_at)
|
|
13116
|
+
|
|
13117
|
+
</dd>
|
|
13118
|
+
</dl>
|
|
13119
|
+
|
|
13120
|
+
<dl>
|
|
13121
|
+
<dd>
|
|
13122
|
+
|
|
13123
|
+
**sort_order_direction:** `Schematic::Types::SortDirection` — Direction to sort by (asc or desc)
|
|
13124
|
+
|
|
13125
|
+
</dd>
|
|
13126
|
+
</dl>
|
|
13127
|
+
|
|
13128
|
+
<dl>
|
|
13129
|
+
<dd>
|
|
13130
|
+
|
|
12659
13131
|
**limit:** `Integer` — Page limit (default 100)
|
|
12660
13132
|
|
|
12661
13133
|
</dd>
|
|
@@ -13278,6 +13750,14 @@ client.entitlements.create_company_override(
|
|
|
13278
13750
|
<dl>
|
|
13279
13751
|
<dd>
|
|
13280
13752
|
|
|
13753
|
+
**model_rates:** `Internal::Types::Array[Schematic::Types::CreditModelRate]` — Per-model rate overrides for inference features, keyed by provider and model. Each entry is a complete rate card: its consumption_rate and quantity_rates replace the entitlement's credit_consumption_rate and quantity_rates for events from that provider and model. An event matches an entry by exact model name first, then by its model name without a trailing snapshot date (claude-sonnet-4-5-20250929 matches claude-sonnet-4-5). Models with no entry burn at the entitlement's own rates. Omit to leave the overrides as they are; send null to clear them.
|
|
13754
|
+
|
|
13755
|
+
</dd>
|
|
13756
|
+
</dl>
|
|
13757
|
+
|
|
13758
|
+
<dl>
|
|
13759
|
+
<dd>
|
|
13760
|
+
|
|
13281
13761
|
**note:** `String`
|
|
13282
13762
|
|
|
13283
13763
|
</dd>
|
|
@@ -13465,6 +13945,14 @@ client.entitlements.update_company_override(
|
|
|
13465
13945
|
<dl>
|
|
13466
13946
|
<dd>
|
|
13467
13947
|
|
|
13948
|
+
**model_rates:** `Internal::Types::Array[Schematic::Types::CreditModelRate]` — Per-model rate overrides for inference features, keyed by provider and model. Each entry is a complete rate card: its consumption_rate and quantity_rates replace the entitlement's credit_consumption_rate and quantity_rates for events from that provider and model. An event matches an entry by exact model name first, then by its model name without a trailing snapshot date (claude-sonnet-4-5-20250929 matches claude-sonnet-4-5). Models with no entry burn at the entitlement's own rates. Omit to leave the overrides as they are; send null to clear them.
|
|
13949
|
+
|
|
13950
|
+
</dd>
|
|
13951
|
+
</dl>
|
|
13952
|
+
|
|
13953
|
+
<dl>
|
|
13954
|
+
<dd>
|
|
13955
|
+
|
|
13468
13956
|
**note:** `String`
|
|
13469
13957
|
|
|
13470
13958
|
</dd>
|
|
@@ -14679,6 +15167,14 @@ client.entitlements.create_plan_entitlement(
|
|
|
14679
15167
|
<dl>
|
|
14680
15168
|
<dd>
|
|
14681
15169
|
|
|
15170
|
+
**model_rates:** `Internal::Types::Array[Schematic::Types::CreditModelRate]` — Per-model rate overrides for inference features, keyed by provider and model. Each entry is a complete rate card: its consumption_rate and quantity_rates replace the entitlement's credit_consumption_rate and quantity_rates for events from that provider and model. An event matches an entry by exact model name first, then by its model name without a trailing snapshot date (claude-sonnet-4-5-20250929 matches claude-sonnet-4-5). Models with no entry burn at the entitlement's own rates. Omit to leave the overrides as they are; send null to clear them.
|
|
15171
|
+
|
|
15172
|
+
</dd>
|
|
15173
|
+
</dl>
|
|
15174
|
+
|
|
15175
|
+
<dl>
|
|
15176
|
+
<dd>
|
|
15177
|
+
|
|
14682
15178
|
**monthly_metered_price_id:** `String`
|
|
14683
15179
|
|
|
14684
15180
|
</dd>
|
|
@@ -15066,7 +15562,7 @@ client.entitlements.update_plan_entitlement(
|
|
|
15066
15562
|
<dl>
|
|
15067
15563
|
<dd>
|
|
15068
15564
|
|
|
15069
|
-
**
|
|
15565
|
+
**model_rates:** `Internal::Types::Array[Schematic::Types::CreditModelRate]` — Per-model rate overrides for inference features, keyed by provider and model. Each entry is a complete rate card: its consumption_rate and quantity_rates replace the entitlement's credit_consumption_rate and quantity_rates for events from that provider and model. An event matches an entry by exact model name first, then by its model name without a trailing snapshot date (claude-sonnet-4-5-20250929 matches claude-sonnet-4-5). Models with no entry burn at the entitlement's own rates. Omit to leave the overrides as they are; send null to clear them.
|
|
15070
15566
|
|
|
15071
15567
|
</dd>
|
|
15072
15568
|
</dl>
|
|
@@ -15074,7 +15570,15 @@ client.entitlements.update_plan_entitlement(
|
|
|
15074
15570
|
<dl>
|
|
15075
15571
|
<dd>
|
|
15076
15572
|
|
|
15077
|
-
**
|
|
15573
|
+
**monthly_metered_price_id:** `String`
|
|
15574
|
+
|
|
15575
|
+
</dd>
|
|
15576
|
+
</dl>
|
|
15577
|
+
|
|
15578
|
+
<dl>
|
|
15579
|
+
<dd>
|
|
15580
|
+
|
|
15581
|
+
**monthly_price_tiers:** `Internal::Types::Array[Schematic::Types::CreatePriceTierRequestBody]`
|
|
15078
15582
|
|
|
15079
15583
|
</dd>
|
|
15080
15584
|
</dl>
|
|
@@ -15456,6 +15960,14 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
|
|
|
15456
15960
|
<dl>
|
|
15457
15961
|
<dd>
|
|
15458
15962
|
|
|
15963
|
+
**model_rates:** `Internal::Types::Array[Schematic::Types::CreditModelRate]` — Per-model rate overrides for inference features, keyed by provider and model. Each entry is a complete rate card: its consumption_rate and quantity_rates replace the entitlement's credit_consumption_rate and quantity_rates for events from that provider and model. An event matches an entry by exact model name first, then by its model name without a trailing snapshot date (claude-sonnet-4-5-20250929 matches claude-sonnet-4-5). Models with no entry burn at the entitlement's own rates. Omit to leave the overrides as they are; send null to clear them.
|
|
15964
|
+
|
|
15965
|
+
</dd>
|
|
15966
|
+
</dl>
|
|
15967
|
+
|
|
15968
|
+
<dl>
|
|
15969
|
+
<dd>
|
|
15970
|
+
|
|
15459
15971
|
**monthly_metered_price_id:** `String`
|
|
15460
15972
|
|
|
15461
15973
|
</dd>
|
|
@@ -16717,7 +17229,774 @@ client.plans.retry_custom_plan_billing(
|
|
|
16717
17229
|
<dl>
|
|
16718
17230
|
<dd>
|
|
16719
17231
|
|
|
16720
|
-
**prorate_first_period:** `Internal::Types::Boolean` — When true, the partial period between the subscription starting and its renewal date is billed pro rata straight away. When false that period is free and no invoice is raised until the renewal date. Only applies alongside billing_cycle_anchor. Defaults to true.
|
|
17232
|
+
**prorate_first_period:** `Internal::Types::Boolean` — When true, the partial period between the subscription starting and its renewal date is billed pro rata straight away. When false that period is free and no invoice is raised until the renewal date. Only applies alongside billing_cycle_anchor. Defaults to true.
|
|
17233
|
+
|
|
17234
|
+
</dd>
|
|
17235
|
+
</dl>
|
|
17236
|
+
|
|
17237
|
+
<dl>
|
|
17238
|
+
<dd>
|
|
17239
|
+
|
|
17240
|
+
**send_invoice:** `Internal::Types::Boolean` — Whether Stripe emails the invoice when it is finalized. Defaults to true.
|
|
17241
|
+
|
|
17242
|
+
</dd>
|
|
17243
|
+
</dl>
|
|
17244
|
+
|
|
17245
|
+
<dl>
|
|
17246
|
+
<dd>
|
|
17247
|
+
|
|
17248
|
+
**request_options:** `Schematic::Plans::RequestOptions`
|
|
17249
|
+
|
|
17250
|
+
</dd>
|
|
17251
|
+
</dl>
|
|
17252
|
+
</dd>
|
|
17253
|
+
</dl>
|
|
17254
|
+
|
|
17255
|
+
|
|
17256
|
+
</dd>
|
|
17257
|
+
</dl>
|
|
17258
|
+
</details>
|
|
17259
|
+
|
|
17260
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">create_custom_plan</a>(request) -> Schematic::Plans::Types::CreateCustomPlanResponse</code></summary>
|
|
17261
|
+
<dl>
|
|
17262
|
+
<dd>
|
|
17263
|
+
|
|
17264
|
+
#### 🔌 Usage
|
|
17265
|
+
|
|
17266
|
+
<dl>
|
|
17267
|
+
<dd>
|
|
17268
|
+
|
|
17269
|
+
<dl>
|
|
17270
|
+
<dd>
|
|
17271
|
+
|
|
17272
|
+
```ruby
|
|
17273
|
+
client.plans.create_custom_plan(
|
|
17274
|
+
company_id: "company_id",
|
|
17275
|
+
name: "name"
|
|
17276
|
+
)
|
|
17277
|
+
```
|
|
17278
|
+
</dd>
|
|
17279
|
+
</dl>
|
|
17280
|
+
</dd>
|
|
17281
|
+
</dl>
|
|
17282
|
+
|
|
17283
|
+
#### ⚙️ Parameters
|
|
17284
|
+
|
|
17285
|
+
<dl>
|
|
17286
|
+
<dd>
|
|
17287
|
+
|
|
17288
|
+
<dl>
|
|
17289
|
+
<dd>
|
|
17290
|
+
|
|
17291
|
+
**company_id:** `String`
|
|
17292
|
+
|
|
17293
|
+
</dd>
|
|
17294
|
+
</dl>
|
|
17295
|
+
|
|
17296
|
+
<dl>
|
|
17297
|
+
<dd>
|
|
17298
|
+
|
|
17299
|
+
**copied_from_plan_id:** `String`
|
|
17300
|
+
|
|
17301
|
+
</dd>
|
|
17302
|
+
</dl>
|
|
17303
|
+
|
|
17304
|
+
<dl>
|
|
17305
|
+
<dd>
|
|
17306
|
+
|
|
17307
|
+
**copied_price_id:** `String`
|
|
17308
|
+
|
|
17309
|
+
</dd>
|
|
17310
|
+
</dl>
|
|
17311
|
+
|
|
17312
|
+
<dl>
|
|
17313
|
+
<dd>
|
|
17314
|
+
|
|
17315
|
+
**description:** `String`
|
|
17316
|
+
|
|
17317
|
+
</dd>
|
|
17318
|
+
</dl>
|
|
17319
|
+
|
|
17320
|
+
<dl>
|
|
17321
|
+
<dd>
|
|
17322
|
+
|
|
17323
|
+
**icon:** `Schematic::Types::PlanIcon`
|
|
17324
|
+
|
|
17325
|
+
</dd>
|
|
17326
|
+
</dl>
|
|
17327
|
+
|
|
17328
|
+
<dl>
|
|
17329
|
+
<dd>
|
|
17330
|
+
|
|
17331
|
+
**name:** `String`
|
|
17332
|
+
|
|
17333
|
+
</dd>
|
|
17334
|
+
</dl>
|
|
17335
|
+
|
|
17336
|
+
<dl>
|
|
17337
|
+
<dd>
|
|
17338
|
+
|
|
17339
|
+
**request_options:** `Schematic::Plans::RequestOptions`
|
|
17340
|
+
|
|
17341
|
+
</dd>
|
|
17342
|
+
</dl>
|
|
17343
|
+
</dd>
|
|
17344
|
+
</dl>
|
|
17345
|
+
|
|
17346
|
+
|
|
17347
|
+
</dd>
|
|
17348
|
+
</dl>
|
|
17349
|
+
</details>
|
|
17350
|
+
|
|
17351
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">list_plans</a>() -> Schematic::Plans::Types::ListPlansResponse</code></summary>
|
|
17352
|
+
<dl>
|
|
17353
|
+
<dd>
|
|
17354
|
+
|
|
17355
|
+
#### 🔌 Usage
|
|
17356
|
+
|
|
17357
|
+
<dl>
|
|
17358
|
+
<dd>
|
|
17359
|
+
|
|
17360
|
+
<dl>
|
|
17361
|
+
<dd>
|
|
17362
|
+
|
|
17363
|
+
```ruby
|
|
17364
|
+
client.plans.list_plans(
|
|
17365
|
+
company_id: "company_id",
|
|
17366
|
+
company_scoped_only: true,
|
|
17367
|
+
exclude_company_scoped: true,
|
|
17368
|
+
exclude_unused: true,
|
|
17369
|
+
for_fallback_plan: true,
|
|
17370
|
+
for_initial_plan: true,
|
|
17371
|
+
for_trial_expiry_plan: true,
|
|
17372
|
+
has_product_id: true,
|
|
17373
|
+
ids: ["ids"],
|
|
17374
|
+
include_draft_versions: true,
|
|
17375
|
+
plan_type: "plan",
|
|
17376
|
+
q: "q",
|
|
17377
|
+
scoped_to_company_id: "scoped_to_company_id",
|
|
17378
|
+
with_entitlements: true,
|
|
17379
|
+
with_published_version: true,
|
|
17380
|
+
without_entitlement_for_include_drafts: true,
|
|
17381
|
+
without_entitlement_for: "without_entitlement_for",
|
|
17382
|
+
without_paid_product_id: true,
|
|
17383
|
+
limit: 1000000,
|
|
17384
|
+
offset: 1000000
|
|
17385
|
+
)
|
|
17386
|
+
```
|
|
17387
|
+
</dd>
|
|
17388
|
+
</dl>
|
|
17389
|
+
</dd>
|
|
17390
|
+
</dl>
|
|
17391
|
+
|
|
17392
|
+
#### ⚙️ Parameters
|
|
17393
|
+
|
|
17394
|
+
<dl>
|
|
17395
|
+
<dd>
|
|
17396
|
+
|
|
17397
|
+
<dl>
|
|
17398
|
+
<dd>
|
|
17399
|
+
|
|
17400
|
+
**company_id:** `String`
|
|
17401
|
+
|
|
17402
|
+
</dd>
|
|
17403
|
+
</dl>
|
|
17404
|
+
|
|
17405
|
+
<dl>
|
|
17406
|
+
<dd>
|
|
17407
|
+
|
|
17408
|
+
**company_scoped_only:** `Internal::Types::Boolean` — Only return plans that are scoped to a company (custom plans assigned to a company)
|
|
17409
|
+
|
|
17410
|
+
</dd>
|
|
17411
|
+
</dl>
|
|
17412
|
+
|
|
17413
|
+
<dl>
|
|
17414
|
+
<dd>
|
|
17415
|
+
|
|
17416
|
+
**exclude_company_scoped:** `Internal::Types::Boolean` — Exclude plans that are scoped to a company (custom plans assigned to a company)
|
|
17417
|
+
|
|
17418
|
+
</dd>
|
|
17419
|
+
</dl>
|
|
17420
|
+
|
|
17421
|
+
<dl>
|
|
17422
|
+
<dd>
|
|
17423
|
+
|
|
17424
|
+
**exclude_unused:** `Internal::Types::Boolean` — Exclude plans that nothing is using: no company is on the plan and it has no draft version
|
|
17425
|
+
|
|
17426
|
+
</dd>
|
|
17427
|
+
</dl>
|
|
17428
|
+
|
|
17429
|
+
<dl>
|
|
17430
|
+
<dd>
|
|
17431
|
+
|
|
17432
|
+
**for_fallback_plan:** `Internal::Types::Boolean` — Filter for plans valid as fallback plans (not linked to billing)
|
|
17433
|
+
|
|
17434
|
+
</dd>
|
|
17435
|
+
</dl>
|
|
17436
|
+
|
|
17437
|
+
<dl>
|
|
17438
|
+
<dd>
|
|
17439
|
+
|
|
17440
|
+
**for_initial_plan:** `Internal::Types::Boolean` — Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial)
|
|
17441
|
+
|
|
17442
|
+
</dd>
|
|
17443
|
+
</dl>
|
|
17444
|
+
|
|
17445
|
+
<dl>
|
|
17446
|
+
<dd>
|
|
17447
|
+
|
|
17448
|
+
**for_trial_expiry_plan:** `Internal::Types::Boolean` — Filter for plans valid as trial expiry plans (not linked to billing or free)
|
|
17449
|
+
|
|
17450
|
+
</dd>
|
|
17451
|
+
</dl>
|
|
17452
|
+
|
|
17453
|
+
<dl>
|
|
17454
|
+
<dd>
|
|
17455
|
+
|
|
17456
|
+
**has_product_id:** `Internal::Types::Boolean` — Filter out plans that do not have a billing product ID
|
|
17457
|
+
|
|
17458
|
+
</dd>
|
|
17459
|
+
</dl>
|
|
17460
|
+
|
|
17461
|
+
<dl>
|
|
17462
|
+
<dd>
|
|
17463
|
+
|
|
17464
|
+
**ids:** `String`
|
|
17465
|
+
|
|
17466
|
+
</dd>
|
|
17467
|
+
</dl>
|
|
17468
|
+
|
|
17469
|
+
<dl>
|
|
17470
|
+
<dd>
|
|
17471
|
+
|
|
17472
|
+
**include_draft_versions:** `Internal::Types::Boolean` — Include billing settings from draft versions for plans which have draft version
|
|
17473
|
+
|
|
17474
|
+
</dd>
|
|
17475
|
+
</dl>
|
|
17476
|
+
|
|
17477
|
+
<dl>
|
|
17478
|
+
<dd>
|
|
17479
|
+
|
|
17480
|
+
**plan_type:** `Schematic::Types::PlanType` — Filter by plan type
|
|
17481
|
+
|
|
17482
|
+
</dd>
|
|
17483
|
+
</dl>
|
|
17484
|
+
|
|
17485
|
+
<dl>
|
|
17486
|
+
<dd>
|
|
17487
|
+
|
|
17488
|
+
**q:** `String`
|
|
17489
|
+
|
|
17490
|
+
</dd>
|
|
17491
|
+
</dl>
|
|
17492
|
+
|
|
17493
|
+
<dl>
|
|
17494
|
+
<dd>
|
|
17495
|
+
|
|
17496
|
+
**scoped_to_company_id:** `String` — Filter plans scoped to a specific company (custom plans)
|
|
17497
|
+
|
|
17498
|
+
</dd>
|
|
17499
|
+
</dl>
|
|
17500
|
+
|
|
17501
|
+
<dl>
|
|
17502
|
+
<dd>
|
|
17503
|
+
|
|
17504
|
+
**with_entitlements:** `Internal::Types::Boolean` — Include each plan's entitlements in the response
|
|
17505
|
+
|
|
17506
|
+
</dd>
|
|
17507
|
+
</dl>
|
|
17508
|
+
|
|
17509
|
+
<dl>
|
|
17510
|
+
<dd>
|
|
17511
|
+
|
|
17512
|
+
**with_published_version:** `Internal::Types::Boolean` — Only return plans that have a published version
|
|
17513
|
+
|
|
17514
|
+
</dd>
|
|
17515
|
+
</dl>
|
|
17516
|
+
|
|
17517
|
+
<dl>
|
|
17518
|
+
<dd>
|
|
17519
|
+
|
|
17520
|
+
**without_entitlement_for_include_drafts:** `Internal::Types::Boolean` — With without_entitlement_for, also treat an entitlement on a plan's draft version as existing
|
|
17521
|
+
|
|
17522
|
+
</dd>
|
|
17523
|
+
</dl>
|
|
17524
|
+
|
|
17525
|
+
<dl>
|
|
17526
|
+
<dd>
|
|
17527
|
+
|
|
17528
|
+
**without_entitlement_for:** `String` — Filter out plans that already have a plan entitlement for the specified feature ID
|
|
17529
|
+
|
|
17530
|
+
</dd>
|
|
17531
|
+
</dl>
|
|
17532
|
+
|
|
17533
|
+
<dl>
|
|
17534
|
+
<dd>
|
|
17535
|
+
|
|
17536
|
+
**without_paid_product_id:** `Internal::Types::Boolean` — Filter out plans that have a paid billing product ID
|
|
17537
|
+
|
|
17538
|
+
</dd>
|
|
17539
|
+
</dl>
|
|
17540
|
+
|
|
17541
|
+
<dl>
|
|
17542
|
+
<dd>
|
|
17543
|
+
|
|
17544
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
17545
|
+
|
|
17546
|
+
</dd>
|
|
17547
|
+
</dl>
|
|
17548
|
+
|
|
17549
|
+
<dl>
|
|
17550
|
+
<dd>
|
|
17551
|
+
|
|
17552
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
17553
|
+
|
|
17554
|
+
</dd>
|
|
17555
|
+
</dl>
|
|
17556
|
+
|
|
17557
|
+
<dl>
|
|
17558
|
+
<dd>
|
|
17559
|
+
|
|
17560
|
+
**request_options:** `Schematic::Plans::RequestOptions`
|
|
17561
|
+
|
|
17562
|
+
</dd>
|
|
17563
|
+
</dl>
|
|
17564
|
+
</dd>
|
|
17565
|
+
</dl>
|
|
17566
|
+
|
|
17567
|
+
|
|
17568
|
+
</dd>
|
|
17569
|
+
</dl>
|
|
17570
|
+
</details>
|
|
17571
|
+
|
|
17572
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">create_plan</a>(request) -> Schematic::Plans::Types::CreatePlanResponse</code></summary>
|
|
17573
|
+
<dl>
|
|
17574
|
+
<dd>
|
|
17575
|
+
|
|
17576
|
+
#### 🔌 Usage
|
|
17577
|
+
|
|
17578
|
+
<dl>
|
|
17579
|
+
<dd>
|
|
17580
|
+
|
|
17581
|
+
<dl>
|
|
17582
|
+
<dd>
|
|
17583
|
+
|
|
17584
|
+
```ruby
|
|
17585
|
+
client.plans.create_plan(
|
|
17586
|
+
name: "name",
|
|
17587
|
+
plan_type: "plan"
|
|
17588
|
+
)
|
|
17589
|
+
```
|
|
17590
|
+
</dd>
|
|
17591
|
+
</dl>
|
|
17592
|
+
</dd>
|
|
17593
|
+
</dl>
|
|
17594
|
+
|
|
17595
|
+
#### ⚙️ Parameters
|
|
17596
|
+
|
|
17597
|
+
<dl>
|
|
17598
|
+
<dd>
|
|
17599
|
+
|
|
17600
|
+
<dl>
|
|
17601
|
+
<dd>
|
|
17602
|
+
|
|
17603
|
+
**request:** `Schematic::Types::CreatePlanRequestBody`
|
|
17604
|
+
|
|
17605
|
+
</dd>
|
|
17606
|
+
</dl>
|
|
17607
|
+
|
|
17608
|
+
<dl>
|
|
17609
|
+
<dd>
|
|
17610
|
+
|
|
17611
|
+
**request_options:** `Schematic::Plans::RequestOptions`
|
|
17612
|
+
|
|
17613
|
+
</dd>
|
|
17614
|
+
</dl>
|
|
17615
|
+
</dd>
|
|
17616
|
+
</dl>
|
|
17617
|
+
|
|
17618
|
+
|
|
17619
|
+
</dd>
|
|
17620
|
+
</dl>
|
|
17621
|
+
</details>
|
|
17622
|
+
|
|
17623
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">get_plan</a>(plan_id:) -> Schematic::Plans::Types::GetPlanResponse</code></summary>
|
|
17624
|
+
<dl>
|
|
17625
|
+
<dd>
|
|
17626
|
+
|
|
17627
|
+
#### 🔌 Usage
|
|
17628
|
+
|
|
17629
|
+
<dl>
|
|
17630
|
+
<dd>
|
|
17631
|
+
|
|
17632
|
+
<dl>
|
|
17633
|
+
<dd>
|
|
17634
|
+
|
|
17635
|
+
```ruby
|
|
17636
|
+
client.plans.get_plan(
|
|
17637
|
+
plan_id: "plan_id",
|
|
17638
|
+
plan_version_id: "plan_version_id"
|
|
17639
|
+
)
|
|
17640
|
+
```
|
|
17641
|
+
</dd>
|
|
17642
|
+
</dl>
|
|
17643
|
+
</dd>
|
|
17644
|
+
</dl>
|
|
17645
|
+
|
|
17646
|
+
#### ⚙️ Parameters
|
|
17647
|
+
|
|
17648
|
+
<dl>
|
|
17649
|
+
<dd>
|
|
17650
|
+
|
|
17651
|
+
<dl>
|
|
17652
|
+
<dd>
|
|
17653
|
+
|
|
17654
|
+
**plan_id:** `String` — plan_id
|
|
17655
|
+
|
|
17656
|
+
</dd>
|
|
17657
|
+
</dl>
|
|
17658
|
+
|
|
17659
|
+
<dl>
|
|
17660
|
+
<dd>
|
|
17661
|
+
|
|
17662
|
+
**plan_version_id:** `String` — Fetch billing settings for a specific plan version
|
|
17663
|
+
|
|
17664
|
+
</dd>
|
|
17665
|
+
</dl>
|
|
17666
|
+
|
|
17667
|
+
<dl>
|
|
17668
|
+
<dd>
|
|
17669
|
+
|
|
17670
|
+
**request_options:** `Schematic::Plans::RequestOptions`
|
|
17671
|
+
|
|
17672
|
+
</dd>
|
|
17673
|
+
</dl>
|
|
17674
|
+
</dd>
|
|
17675
|
+
</dl>
|
|
17676
|
+
|
|
17677
|
+
|
|
17678
|
+
</dd>
|
|
17679
|
+
</dl>
|
|
17680
|
+
</details>
|
|
17681
|
+
|
|
17682
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">update_plan</a>(plan_id:, request) -> Schematic::Plans::Types::UpdatePlanResponse</code></summary>
|
|
17683
|
+
<dl>
|
|
17684
|
+
<dd>
|
|
17685
|
+
|
|
17686
|
+
#### 🔌 Usage
|
|
17687
|
+
|
|
17688
|
+
<dl>
|
|
17689
|
+
<dd>
|
|
17690
|
+
|
|
17691
|
+
<dl>
|
|
17692
|
+
<dd>
|
|
17693
|
+
|
|
17694
|
+
```ruby
|
|
17695
|
+
client.plans.update_plan(
|
|
17696
|
+
plan_id: "plan_id",
|
|
17697
|
+
name: "name"
|
|
17698
|
+
)
|
|
17699
|
+
```
|
|
17700
|
+
</dd>
|
|
17701
|
+
</dl>
|
|
17702
|
+
</dd>
|
|
17703
|
+
</dl>
|
|
17704
|
+
|
|
17705
|
+
#### ⚙️ Parameters
|
|
17706
|
+
|
|
17707
|
+
<dl>
|
|
17708
|
+
<dd>
|
|
17709
|
+
|
|
17710
|
+
<dl>
|
|
17711
|
+
<dd>
|
|
17712
|
+
|
|
17713
|
+
**plan_id:** `String` — plan_id
|
|
17714
|
+
|
|
17715
|
+
</dd>
|
|
17716
|
+
</dl>
|
|
17717
|
+
|
|
17718
|
+
<dl>
|
|
17719
|
+
<dd>
|
|
17720
|
+
|
|
17721
|
+
**request:** `Schematic::Types::UpdatePlanRequestBody`
|
|
17722
|
+
|
|
17723
|
+
</dd>
|
|
17724
|
+
</dl>
|
|
17725
|
+
|
|
17726
|
+
<dl>
|
|
17727
|
+
<dd>
|
|
17728
|
+
|
|
17729
|
+
**request_options:** `Schematic::Plans::RequestOptions`
|
|
17730
|
+
|
|
17731
|
+
</dd>
|
|
17732
|
+
</dl>
|
|
17733
|
+
</dd>
|
|
17734
|
+
</dl>
|
|
17735
|
+
|
|
17736
|
+
|
|
17737
|
+
</dd>
|
|
17738
|
+
</dl>
|
|
17739
|
+
</details>
|
|
17740
|
+
|
|
17741
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">delete_plan</a>(plan_id:) -> Schematic::Plans::Types::DeletePlanResponse</code></summary>
|
|
17742
|
+
<dl>
|
|
17743
|
+
<dd>
|
|
17744
|
+
|
|
17745
|
+
#### 🔌 Usage
|
|
17746
|
+
|
|
17747
|
+
<dl>
|
|
17748
|
+
<dd>
|
|
17749
|
+
|
|
17750
|
+
<dl>
|
|
17751
|
+
<dd>
|
|
17752
|
+
|
|
17753
|
+
```ruby
|
|
17754
|
+
client.plans.delete_plan(plan_id: "plan_id")
|
|
17755
|
+
```
|
|
17756
|
+
</dd>
|
|
17757
|
+
</dl>
|
|
17758
|
+
</dd>
|
|
17759
|
+
</dl>
|
|
17760
|
+
|
|
17761
|
+
#### ⚙️ Parameters
|
|
17762
|
+
|
|
17763
|
+
<dl>
|
|
17764
|
+
<dd>
|
|
17765
|
+
|
|
17766
|
+
<dl>
|
|
17767
|
+
<dd>
|
|
17768
|
+
|
|
17769
|
+
**plan_id:** `String` — plan_id
|
|
17770
|
+
|
|
17771
|
+
</dd>
|
|
17772
|
+
</dl>
|
|
17773
|
+
|
|
17774
|
+
<dl>
|
|
17775
|
+
<dd>
|
|
17776
|
+
|
|
17777
|
+
**request_options:** `Schematic::Plans::RequestOptions`
|
|
17778
|
+
|
|
17779
|
+
</dd>
|
|
17780
|
+
</dl>
|
|
17781
|
+
</dd>
|
|
17782
|
+
</dl>
|
|
17783
|
+
|
|
17784
|
+
|
|
17785
|
+
</dd>
|
|
17786
|
+
</dl>
|
|
17787
|
+
</details>
|
|
17788
|
+
|
|
17789
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">upsert_billing_product_plan</a>(plan_id:, request) -> Schematic::Plans::Types::UpsertBillingProductPlanResponse</code></summary>
|
|
17790
|
+
<dl>
|
|
17791
|
+
<dd>
|
|
17792
|
+
|
|
17793
|
+
#### 🔌 Usage
|
|
17794
|
+
|
|
17795
|
+
<dl>
|
|
17796
|
+
<dd>
|
|
17797
|
+
|
|
17798
|
+
<dl>
|
|
17799
|
+
<dd>
|
|
17800
|
+
|
|
17801
|
+
```ruby
|
|
17802
|
+
client.plans.upsert_billing_product_plan(
|
|
17803
|
+
plan_id: "plan_id",
|
|
17804
|
+
charge_type: "free",
|
|
17805
|
+
is_trialable: true
|
|
17806
|
+
)
|
|
17807
|
+
```
|
|
17808
|
+
</dd>
|
|
17809
|
+
</dl>
|
|
17810
|
+
</dd>
|
|
17811
|
+
</dl>
|
|
17812
|
+
|
|
17813
|
+
#### ⚙️ Parameters
|
|
17814
|
+
|
|
17815
|
+
<dl>
|
|
17816
|
+
<dd>
|
|
17817
|
+
|
|
17818
|
+
<dl>
|
|
17819
|
+
<dd>
|
|
17820
|
+
|
|
17821
|
+
**plan_id:** `String` — plan_id
|
|
17822
|
+
|
|
17823
|
+
</dd>
|
|
17824
|
+
</dl>
|
|
17825
|
+
|
|
17826
|
+
<dl>
|
|
17827
|
+
<dd>
|
|
17828
|
+
|
|
17829
|
+
**request:** `Schematic::Types::UpsertBillingProductRequestBody`
|
|
17830
|
+
|
|
17831
|
+
</dd>
|
|
17832
|
+
</dl>
|
|
17833
|
+
|
|
17834
|
+
<dl>
|
|
17835
|
+
<dd>
|
|
17836
|
+
|
|
17837
|
+
**request_options:** `Schematic::Plans::RequestOptions`
|
|
17838
|
+
|
|
17839
|
+
</dd>
|
|
17840
|
+
</dl>
|
|
17841
|
+
</dd>
|
|
17842
|
+
</dl>
|
|
17843
|
+
|
|
17844
|
+
|
|
17845
|
+
</dd>
|
|
17846
|
+
</dl>
|
|
17847
|
+
</details>
|
|
17848
|
+
|
|
17849
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">upsert_plan_for_billing_product</a>(request) -> Schematic::Plans::Types::UpsertPlanForBillingProductResponse</code></summary>
|
|
17850
|
+
<dl>
|
|
17851
|
+
<dd>
|
|
17852
|
+
|
|
17853
|
+
#### 🔌 Usage
|
|
17854
|
+
|
|
17855
|
+
<dl>
|
|
17856
|
+
<dd>
|
|
17857
|
+
|
|
17858
|
+
<dl>
|
|
17859
|
+
<dd>
|
|
17860
|
+
|
|
17861
|
+
```ruby
|
|
17862
|
+
client.plans.upsert_plan_for_billing_product(
|
|
17863
|
+
billing_provider: "metronome",
|
|
17864
|
+
external_resource_id: "external_resource_id",
|
|
17865
|
+
name: "name",
|
|
17866
|
+
plan_type: "plan"
|
|
17867
|
+
)
|
|
17868
|
+
```
|
|
17869
|
+
</dd>
|
|
17870
|
+
</dl>
|
|
17871
|
+
</dd>
|
|
17872
|
+
</dl>
|
|
17873
|
+
|
|
17874
|
+
#### ⚙️ Parameters
|
|
17875
|
+
|
|
17876
|
+
<dl>
|
|
17877
|
+
<dd>
|
|
17878
|
+
|
|
17879
|
+
<dl>
|
|
17880
|
+
<dd>
|
|
17881
|
+
|
|
17882
|
+
**billing_provider:** `Schematic::Types::BillingProviderType`
|
|
17883
|
+
|
|
17884
|
+
</dd>
|
|
17885
|
+
</dl>
|
|
17886
|
+
|
|
17887
|
+
<dl>
|
|
17888
|
+
<dd>
|
|
17889
|
+
|
|
17890
|
+
**description:** `String`
|
|
17891
|
+
|
|
17892
|
+
</dd>
|
|
17893
|
+
</dl>
|
|
17894
|
+
|
|
17895
|
+
<dl>
|
|
17896
|
+
<dd>
|
|
17897
|
+
|
|
17898
|
+
**external_resource_id:** `String`
|
|
17899
|
+
|
|
17900
|
+
</dd>
|
|
17901
|
+
</dl>
|
|
17902
|
+
|
|
17903
|
+
<dl>
|
|
17904
|
+
<dd>
|
|
17905
|
+
|
|
17906
|
+
**external_resource_version:** `String`
|
|
17907
|
+
|
|
17908
|
+
</dd>
|
|
17909
|
+
</dl>
|
|
17910
|
+
|
|
17911
|
+
<dl>
|
|
17912
|
+
<dd>
|
|
17913
|
+
|
|
17914
|
+
**icon:** `Schematic::Types::PlanIcon`
|
|
17915
|
+
|
|
17916
|
+
</dd>
|
|
17917
|
+
</dl>
|
|
17918
|
+
|
|
17919
|
+
<dl>
|
|
17920
|
+
<dd>
|
|
17921
|
+
|
|
17922
|
+
**name:** `String`
|
|
17923
|
+
|
|
17924
|
+
</dd>
|
|
17925
|
+
</dl>
|
|
17926
|
+
|
|
17927
|
+
<dl>
|
|
17928
|
+
<dd>
|
|
17929
|
+
|
|
17930
|
+
**plan_type:** `Schematic::Types::PlanType`
|
|
17931
|
+
|
|
17932
|
+
</dd>
|
|
17933
|
+
</dl>
|
|
17934
|
+
|
|
17935
|
+
<dl>
|
|
17936
|
+
<dd>
|
|
17937
|
+
|
|
17938
|
+
**request_options:** `Schematic::Plans::RequestOptions`
|
|
17939
|
+
|
|
17940
|
+
</dd>
|
|
17941
|
+
</dl>
|
|
17942
|
+
</dd>
|
|
17943
|
+
</dl>
|
|
17944
|
+
|
|
17945
|
+
|
|
17946
|
+
</dd>
|
|
17947
|
+
</dl>
|
|
17948
|
+
</details>
|
|
17949
|
+
|
|
17950
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">list_billing_product_match_companies</a>() -> Schematic::Plans::Types::ListBillingProductMatchCompaniesResponse</code></summary>
|
|
17951
|
+
<dl>
|
|
17952
|
+
<dd>
|
|
17953
|
+
|
|
17954
|
+
#### 🔌 Usage
|
|
17955
|
+
|
|
17956
|
+
<dl>
|
|
17957
|
+
<dd>
|
|
17958
|
+
|
|
17959
|
+
<dl>
|
|
17960
|
+
<dd>
|
|
17961
|
+
|
|
17962
|
+
```ruby
|
|
17963
|
+
client.plans.list_billing_product_match_companies(
|
|
17964
|
+
plan_id: "plan_id",
|
|
17965
|
+
q: "q",
|
|
17966
|
+
limit: 1000000,
|
|
17967
|
+
offset: 1000000
|
|
17968
|
+
)
|
|
17969
|
+
```
|
|
17970
|
+
</dd>
|
|
17971
|
+
</dl>
|
|
17972
|
+
</dd>
|
|
17973
|
+
</dl>
|
|
17974
|
+
|
|
17975
|
+
#### ⚙️ Parameters
|
|
17976
|
+
|
|
17977
|
+
<dl>
|
|
17978
|
+
<dd>
|
|
17979
|
+
|
|
17980
|
+
<dl>
|
|
17981
|
+
<dd>
|
|
17982
|
+
|
|
17983
|
+
**plan_id:** `String` — The plan ID to find billing product match companies for
|
|
17984
|
+
|
|
17985
|
+
</dd>
|
|
17986
|
+
</dl>
|
|
17987
|
+
|
|
17988
|
+
<dl>
|
|
17989
|
+
<dd>
|
|
17990
|
+
|
|
17991
|
+
**q:** `String` — Search for companies by name, keys or string traits
|
|
17992
|
+
|
|
17993
|
+
</dd>
|
|
17994
|
+
</dl>
|
|
17995
|
+
|
|
17996
|
+
<dl>
|
|
17997
|
+
<dd>
|
|
17998
|
+
|
|
17999
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
16721
18000
|
|
|
16722
18001
|
</dd>
|
|
16723
18002
|
</dl>
|
|
@@ -16725,7 +18004,7 @@ client.plans.retry_custom_plan_billing(
|
|
|
16725
18004
|
<dl>
|
|
16726
18005
|
<dd>
|
|
16727
18006
|
|
|
16728
|
-
**
|
|
18007
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
16729
18008
|
|
|
16730
18009
|
</dd>
|
|
16731
18010
|
</dl>
|
|
@@ -16745,7 +18024,7 @@ client.plans.retry_custom_plan_billing(
|
|
|
16745
18024
|
</dl>
|
|
16746
18025
|
</details>
|
|
16747
18026
|
|
|
16748
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">
|
|
18027
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">count_billing_product_match_companies</a>() -> Schematic::Plans::Types::CountBillingProductMatchCompaniesResponse</code></summary>
|
|
16749
18028
|
<dl>
|
|
16750
18029
|
<dd>
|
|
16751
18030
|
|
|
@@ -16758,9 +18037,11 @@ client.plans.retry_custom_plan_billing(
|
|
|
16758
18037
|
<dd>
|
|
16759
18038
|
|
|
16760
18039
|
```ruby
|
|
16761
|
-
client.plans.
|
|
16762
|
-
|
|
16763
|
-
|
|
18040
|
+
client.plans.count_billing_product_match_companies(
|
|
18041
|
+
plan_id: "plan_id",
|
|
18042
|
+
q: "q",
|
|
18043
|
+
limit: 1000000,
|
|
18044
|
+
offset: 1000000
|
|
16764
18045
|
)
|
|
16765
18046
|
```
|
|
16766
18047
|
</dd>
|
|
@@ -16776,23 +18057,7 @@ client.plans.create_custom_plan(
|
|
|
16776
18057
|
<dl>
|
|
16777
18058
|
<dd>
|
|
16778
18059
|
|
|
16779
|
-
**
|
|
16780
|
-
|
|
16781
|
-
</dd>
|
|
16782
|
-
</dl>
|
|
16783
|
-
|
|
16784
|
-
<dl>
|
|
16785
|
-
<dd>
|
|
16786
|
-
|
|
16787
|
-
**copied_from_plan_id:** `String`
|
|
16788
|
-
|
|
16789
|
-
</dd>
|
|
16790
|
-
</dl>
|
|
16791
|
-
|
|
16792
|
-
<dl>
|
|
16793
|
-
<dd>
|
|
16794
|
-
|
|
16795
|
-
**copied_price_id:** `String`
|
|
18060
|
+
**plan_id:** `String` — The plan ID to find billing product match companies for
|
|
16796
18061
|
|
|
16797
18062
|
</dd>
|
|
16798
18063
|
</dl>
|
|
@@ -16800,7 +18065,7 @@ client.plans.create_custom_plan(
|
|
|
16800
18065
|
<dl>
|
|
16801
18066
|
<dd>
|
|
16802
18067
|
|
|
16803
|
-
**
|
|
18068
|
+
**q:** `String` — Search for companies by name, keys or string traits
|
|
16804
18069
|
|
|
16805
18070
|
</dd>
|
|
16806
18071
|
</dl>
|
|
@@ -16808,7 +18073,7 @@ client.plans.create_custom_plan(
|
|
|
16808
18073
|
<dl>
|
|
16809
18074
|
<dd>
|
|
16810
18075
|
|
|
16811
|
-
**
|
|
18076
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
16812
18077
|
|
|
16813
18078
|
</dd>
|
|
16814
18079
|
</dl>
|
|
@@ -16816,7 +18081,7 @@ client.plans.create_custom_plan(
|
|
|
16816
18081
|
<dl>
|
|
16817
18082
|
<dd>
|
|
16818
18083
|
|
|
16819
|
-
**
|
|
18084
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
16820
18085
|
|
|
16821
18086
|
</dd>
|
|
16822
18087
|
</dl>
|
|
@@ -16836,7 +18101,7 @@ client.plans.create_custom_plan(
|
|
|
16836
18101
|
</dl>
|
|
16837
18102
|
</details>
|
|
16838
18103
|
|
|
16839
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">
|
|
18104
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">count_plans</a>() -> Schematic::Plans::Types::CountPlansResponse</code></summary>
|
|
16840
18105
|
<dl>
|
|
16841
18106
|
<dd>
|
|
16842
18107
|
|
|
@@ -16849,7 +18114,7 @@ client.plans.create_custom_plan(
|
|
|
16849
18114
|
<dd>
|
|
16850
18115
|
|
|
16851
18116
|
```ruby
|
|
16852
|
-
client.plans.
|
|
18117
|
+
client.plans.count_plans(
|
|
16853
18118
|
company_id: "company_id",
|
|
16854
18119
|
company_scoped_only: true,
|
|
16855
18120
|
exclude_company_scoped: true,
|
|
@@ -17057,58 +18322,7 @@ client.plans.list_plans(
|
|
|
17057
18322
|
</dl>
|
|
17058
18323
|
</details>
|
|
17059
18324
|
|
|
17060
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">
|
|
17061
|
-
<dl>
|
|
17062
|
-
<dd>
|
|
17063
|
-
|
|
17064
|
-
#### 🔌 Usage
|
|
17065
|
-
|
|
17066
|
-
<dl>
|
|
17067
|
-
<dd>
|
|
17068
|
-
|
|
17069
|
-
<dl>
|
|
17070
|
-
<dd>
|
|
17071
|
-
|
|
17072
|
-
```ruby
|
|
17073
|
-
client.plans.create_plan(
|
|
17074
|
-
name: "name",
|
|
17075
|
-
plan_type: "plan"
|
|
17076
|
-
)
|
|
17077
|
-
```
|
|
17078
|
-
</dd>
|
|
17079
|
-
</dl>
|
|
17080
|
-
</dd>
|
|
17081
|
-
</dl>
|
|
17082
|
-
|
|
17083
|
-
#### ⚙️ Parameters
|
|
17084
|
-
|
|
17085
|
-
<dl>
|
|
17086
|
-
<dd>
|
|
17087
|
-
|
|
17088
|
-
<dl>
|
|
17089
|
-
<dd>
|
|
17090
|
-
|
|
17091
|
-
**request:** `Schematic::Types::CreatePlanRequestBody`
|
|
17092
|
-
|
|
17093
|
-
</dd>
|
|
17094
|
-
</dl>
|
|
17095
|
-
|
|
17096
|
-
<dl>
|
|
17097
|
-
<dd>
|
|
17098
|
-
|
|
17099
|
-
**request_options:** `Schematic::Plans::RequestOptions`
|
|
17100
|
-
|
|
17101
|
-
</dd>
|
|
17102
|
-
</dl>
|
|
17103
|
-
</dd>
|
|
17104
|
-
</dl>
|
|
17105
|
-
|
|
17106
|
-
|
|
17107
|
-
</dd>
|
|
17108
|
-
</dl>
|
|
17109
|
-
</details>
|
|
17110
|
-
|
|
17111
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">get_plan</a>(plan_id:) -> Schematic::Plans::Types::GetPlanResponse</code></summary>
|
|
18325
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">list_plan_issues</a>() -> Schematic::Plans::Types::ListPlanIssuesResponse</code></summary>
|
|
17112
18326
|
<dl>
|
|
17113
18327
|
<dd>
|
|
17114
18328
|
|
|
@@ -17121,7 +18335,7 @@ client.plans.create_plan(
|
|
|
17121
18335
|
<dd>
|
|
17122
18336
|
|
|
17123
18337
|
```ruby
|
|
17124
|
-
client.plans.
|
|
18338
|
+
client.plans.list_plan_issues(
|
|
17125
18339
|
plan_id: "plan_id",
|
|
17126
18340
|
plan_version_id: "plan_version_id"
|
|
17127
18341
|
)
|
|
@@ -17139,7 +18353,7 @@ client.plans.get_plan(
|
|
|
17139
18353
|
<dl>
|
|
17140
18354
|
<dd>
|
|
17141
18355
|
|
|
17142
|
-
**plan_id:** `String`
|
|
18356
|
+
**plan_id:** `String`
|
|
17143
18357
|
|
|
17144
18358
|
</dd>
|
|
17145
18359
|
</dl>
|
|
@@ -17147,7 +18361,7 @@ client.plans.get_plan(
|
|
|
17147
18361
|
<dl>
|
|
17148
18362
|
<dd>
|
|
17149
18363
|
|
|
17150
|
-
**plan_version_id:** `String`
|
|
18364
|
+
**plan_version_id:** `String`
|
|
17151
18365
|
|
|
17152
18366
|
</dd>
|
|
17153
18367
|
</dl>
|
|
@@ -17167,7 +18381,7 @@ client.plans.get_plan(
|
|
|
17167
18381
|
</dl>
|
|
17168
18382
|
</details>
|
|
17169
18383
|
|
|
17170
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">
|
|
18384
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">delete_plan_version</a>(plan_version_id:) -> Schematic::Plans::Types::DeletePlanVersionResponse</code></summary>
|
|
17171
18385
|
<dl>
|
|
17172
18386
|
<dd>
|
|
17173
18387
|
|
|
@@ -17180,9 +18394,9 @@ client.plans.get_plan(
|
|
|
17180
18394
|
<dd>
|
|
17181
18395
|
|
|
17182
18396
|
```ruby
|
|
17183
|
-
client.plans.
|
|
17184
|
-
|
|
17185
|
-
|
|
18397
|
+
client.plans.delete_plan_version(
|
|
18398
|
+
plan_version_id: "plan_version_id",
|
|
18399
|
+
promote_archived_version: true
|
|
17186
18400
|
)
|
|
17187
18401
|
```
|
|
17188
18402
|
</dd>
|
|
@@ -17198,63 +18412,15 @@ client.plans.update_plan(
|
|
|
17198
18412
|
<dl>
|
|
17199
18413
|
<dd>
|
|
17200
18414
|
|
|
17201
|
-
**
|
|
17202
|
-
|
|
17203
|
-
</dd>
|
|
17204
|
-
</dl>
|
|
17205
|
-
|
|
17206
|
-
<dl>
|
|
17207
|
-
<dd>
|
|
17208
|
-
|
|
17209
|
-
**request:** `Schematic::Types::UpdatePlanRequestBody`
|
|
17210
|
-
|
|
17211
|
-
</dd>
|
|
17212
|
-
</dl>
|
|
17213
|
-
|
|
17214
|
-
<dl>
|
|
17215
|
-
<dd>
|
|
17216
|
-
|
|
17217
|
-
**request_options:** `Schematic::Plans::RequestOptions`
|
|
18415
|
+
**plan_version_id:** `String` — plan_version_id
|
|
17218
18416
|
|
|
17219
18417
|
</dd>
|
|
17220
18418
|
</dl>
|
|
17221
|
-
</dd>
|
|
17222
|
-
</dl>
|
|
17223
|
-
|
|
17224
|
-
|
|
17225
|
-
</dd>
|
|
17226
|
-
</dl>
|
|
17227
|
-
</details>
|
|
17228
|
-
|
|
17229
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">delete_plan</a>(plan_id:) -> Schematic::Plans::Types::DeletePlanResponse</code></summary>
|
|
17230
|
-
<dl>
|
|
17231
|
-
<dd>
|
|
17232
|
-
|
|
17233
|
-
#### 🔌 Usage
|
|
17234
|
-
|
|
17235
|
-
<dl>
|
|
17236
|
-
<dd>
|
|
17237
|
-
|
|
17238
|
-
<dl>
|
|
17239
|
-
<dd>
|
|
17240
|
-
|
|
17241
|
-
```ruby
|
|
17242
|
-
client.plans.delete_plan(plan_id: "plan_id")
|
|
17243
|
-
```
|
|
17244
|
-
</dd>
|
|
17245
|
-
</dl>
|
|
17246
|
-
</dd>
|
|
17247
|
-
</dl>
|
|
17248
|
-
|
|
17249
|
-
#### ⚙️ Parameters
|
|
17250
|
-
|
|
17251
|
-
<dl>
|
|
17252
|
-
<dd>
|
|
17253
18419
|
|
|
17254
18420
|
<dl>
|
|
17255
18421
|
<dd>
|
|
17256
18422
|
|
|
17257
|
-
**
|
|
18423
|
+
**promote_archived_version:** `Internal::Types::Boolean`
|
|
17258
18424
|
|
|
17259
18425
|
</dd>
|
|
17260
18426
|
</dl>
|
|
@@ -17274,7 +18440,7 @@ client.plans.delete_plan(plan_id: "plan_id")
|
|
|
17274
18440
|
</dl>
|
|
17275
18441
|
</details>
|
|
17276
18442
|
|
|
17277
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">
|
|
18443
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">get_plan_version_diff</a>(plan_version_id:) -> Schematic::Plans::Types::GetPlanVersionDiffResponse</code></summary>
|
|
17278
18444
|
<dl>
|
|
17279
18445
|
<dd>
|
|
17280
18446
|
|
|
@@ -17287,10 +18453,9 @@ client.plans.delete_plan(plan_id: "plan_id")
|
|
|
17287
18453
|
<dd>
|
|
17288
18454
|
|
|
17289
18455
|
```ruby
|
|
17290
|
-
client.plans.
|
|
17291
|
-
|
|
17292
|
-
|
|
17293
|
-
is_trialable: true
|
|
18456
|
+
client.plans.get_plan_version_diff(
|
|
18457
|
+
plan_version_id: "plan_version_id",
|
|
18458
|
+
against: "against"
|
|
17294
18459
|
)
|
|
17295
18460
|
```
|
|
17296
18461
|
</dd>
|
|
@@ -17306,7 +18471,7 @@ client.plans.upsert_billing_product_plan(
|
|
|
17306
18471
|
<dl>
|
|
17307
18472
|
<dd>
|
|
17308
18473
|
|
|
17309
|
-
**
|
|
18474
|
+
**plan_version_id:** `String` — plan_version_id
|
|
17310
18475
|
|
|
17311
18476
|
</dd>
|
|
17312
18477
|
</dl>
|
|
@@ -17314,7 +18479,7 @@ client.plans.upsert_billing_product_plan(
|
|
|
17314
18479
|
<dl>
|
|
17315
18480
|
<dd>
|
|
17316
18481
|
|
|
17317
|
-
**
|
|
18482
|
+
**against:** `String` — The version to compare against. Defaults to the plan's published version.
|
|
17318
18483
|
|
|
17319
18484
|
</dd>
|
|
17320
18485
|
</dl>
|
|
@@ -17334,7 +18499,7 @@ client.plans.upsert_billing_product_plan(
|
|
|
17334
18499
|
</dl>
|
|
17335
18500
|
</details>
|
|
17336
18501
|
|
|
17337
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">
|
|
18502
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">publish_plan_version</a>(plan_version_id:, request) -> Schematic::Plans::Types::PublishPlanVersionResponse</code></summary>
|
|
17338
18503
|
<dl>
|
|
17339
18504
|
<dd>
|
|
17340
18505
|
|
|
@@ -17347,11 +18512,10 @@ client.plans.upsert_billing_product_plan(
|
|
|
17347
18512
|
<dd>
|
|
17348
18513
|
|
|
17349
18514
|
```ruby
|
|
17350
|
-
client.plans.
|
|
17351
|
-
|
|
17352
|
-
|
|
17353
|
-
|
|
17354
|
-
plan_type: "plan"
|
|
18515
|
+
client.plans.publish_plan_version(
|
|
18516
|
+
plan_version_id: "plan_version_id",
|
|
18517
|
+
excluded_company_ids: ["excluded_company_ids"],
|
|
18518
|
+
migration_strategy: "end_of_billing_period"
|
|
17355
18519
|
)
|
|
17356
18520
|
```
|
|
17357
18521
|
</dd>
|
|
@@ -17367,47 +18531,7 @@ client.plans.upsert_plan_for_billing_product(
|
|
|
17367
18531
|
<dl>
|
|
17368
18532
|
<dd>
|
|
17369
18533
|
|
|
17370
|
-
**
|
|
17371
|
-
|
|
17372
|
-
</dd>
|
|
17373
|
-
</dl>
|
|
17374
|
-
|
|
17375
|
-
<dl>
|
|
17376
|
-
<dd>
|
|
17377
|
-
|
|
17378
|
-
**description:** `String`
|
|
17379
|
-
|
|
17380
|
-
</dd>
|
|
17381
|
-
</dl>
|
|
17382
|
-
|
|
17383
|
-
<dl>
|
|
17384
|
-
<dd>
|
|
17385
|
-
|
|
17386
|
-
**external_resource_id:** `String`
|
|
17387
|
-
|
|
17388
|
-
</dd>
|
|
17389
|
-
</dl>
|
|
17390
|
-
|
|
17391
|
-
<dl>
|
|
17392
|
-
<dd>
|
|
17393
|
-
|
|
17394
|
-
**external_resource_version:** `String`
|
|
17395
|
-
|
|
17396
|
-
</dd>
|
|
17397
|
-
</dl>
|
|
17398
|
-
|
|
17399
|
-
<dl>
|
|
17400
|
-
<dd>
|
|
17401
|
-
|
|
17402
|
-
**icon:** `Schematic::Types::PlanIcon`
|
|
17403
|
-
|
|
17404
|
-
</dd>
|
|
17405
|
-
</dl>
|
|
17406
|
-
|
|
17407
|
-
<dl>
|
|
17408
|
-
<dd>
|
|
17409
|
-
|
|
17410
|
-
**name:** `String`
|
|
18534
|
+
**plan_version_id:** `String` — plan_version_id
|
|
17411
18535
|
|
|
17412
18536
|
</dd>
|
|
17413
18537
|
</dl>
|
|
@@ -17415,7 +18539,7 @@ client.plans.upsert_plan_for_billing_product(
|
|
|
17415
18539
|
<dl>
|
|
17416
18540
|
<dd>
|
|
17417
18541
|
|
|
17418
|
-
**
|
|
18542
|
+
**request:** `Schematic::Types::PublishPlanVersionRequestBody`
|
|
17419
18543
|
|
|
17420
18544
|
</dd>
|
|
17421
18545
|
</dl>
|
|
@@ -17435,7 +18559,7 @@ client.plans.upsert_plan_for_billing_product(
|
|
|
17435
18559
|
</dl>
|
|
17436
18560
|
</details>
|
|
17437
18561
|
|
|
17438
|
-
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">
|
|
18562
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">preview_publish_plan_version</a>(plan_version_id:, request) -> Schematic::Plans::Types::PreviewPublishPlanVersionResponse</code></summary>
|
|
17439
18563
|
<dl>
|
|
17440
18564
|
<dd>
|
|
17441
18565
|
|
|
@@ -17448,43 +18572,26 @@ client.plans.upsert_plan_for_billing_product(
|
|
|
17448
18572
|
<dd>
|
|
17449
18573
|
|
|
17450
18574
|
```ruby
|
|
17451
|
-
client.plans.
|
|
17452
|
-
|
|
17453
|
-
|
|
17454
|
-
|
|
17455
|
-
|
|
17456
|
-
|
|
17457
|
-
```
|
|
17458
|
-
</dd>
|
|
17459
|
-
</dl>
|
|
17460
|
-
</dd>
|
|
17461
|
-
</dl>
|
|
17462
|
-
|
|
17463
|
-
#### ⚙️ Parameters
|
|
17464
|
-
|
|
17465
|
-
<dl>
|
|
17466
|
-
<dd>
|
|
17467
|
-
|
|
17468
|
-
<dl>
|
|
17469
|
-
<dd>
|
|
17470
|
-
|
|
17471
|
-
**plan_id:** `String` — The plan ID to find billing product match companies for
|
|
17472
|
-
|
|
18575
|
+
client.plans.preview_publish_plan_version(
|
|
18576
|
+
plan_version_id: "plan_version_id",
|
|
18577
|
+
excluded_company_ids: ["excluded_company_ids"],
|
|
18578
|
+
migration_strategy: "end_of_billing_period"
|
|
18579
|
+
)
|
|
18580
|
+
```
|
|
17473
18581
|
</dd>
|
|
17474
18582
|
</dl>
|
|
18583
|
+
</dd>
|
|
18584
|
+
</dl>
|
|
18585
|
+
|
|
18586
|
+
#### ⚙️ Parameters
|
|
17475
18587
|
|
|
17476
18588
|
<dl>
|
|
17477
18589
|
<dd>
|
|
17478
18590
|
|
|
17479
|
-
**q:** `String` — Search for companies by name, keys or string traits
|
|
17480
|
-
|
|
17481
|
-
</dd>
|
|
17482
|
-
</dl>
|
|
17483
|
-
|
|
17484
18591
|
<dl>
|
|
17485
18592
|
<dd>
|
|
17486
18593
|
|
|
17487
|
-
**
|
|
18594
|
+
**plan_version_id:** `String` — plan_version_id
|
|
17488
18595
|
|
|
17489
18596
|
</dd>
|
|
17490
18597
|
</dl>
|
|
@@ -17492,7 +18599,7 @@ client.plans.list_billing_product_match_companies(
|
|
|
17492
18599
|
<dl>
|
|
17493
18600
|
<dd>
|
|
17494
18601
|
|
|
17495
|
-
**
|
|
18602
|
+
**request:** `Schematic::Types::PublishPlanVersionRequestBody`
|
|
17496
18603
|
|
|
17497
18604
|
</dd>
|
|
17498
18605
|
</dl>
|
|
@@ -17512,7 +18619,8 @@ client.plans.list_billing_product_match_companies(
|
|
|
17512
18619
|
</dl>
|
|
17513
18620
|
</details>
|
|
17514
18621
|
|
|
17515
|
-
|
|
18622
|
+
## components
|
|
18623
|
+
<details><summary><code>client.components.<a href="/lib/schematic/components/client.rb">list_components</a>() -> Schematic::Components::Types::ListComponentsResponse</code></summary>
|
|
17516
18624
|
<dl>
|
|
17517
18625
|
<dd>
|
|
17518
18626
|
|
|
@@ -17525,8 +18633,7 @@ client.plans.list_billing_product_match_companies(
|
|
|
17525
18633
|
<dd>
|
|
17526
18634
|
|
|
17527
18635
|
```ruby
|
|
17528
|
-
client.
|
|
17529
|
-
plan_id: "plan_id",
|
|
18636
|
+
client.components.list_components(
|
|
17530
18637
|
q: "q",
|
|
17531
18638
|
limit: 1000000,
|
|
17532
18639
|
offset: 1000000
|
|
@@ -17545,15 +18652,7 @@ client.plans.count_billing_product_match_companies(
|
|
|
17545
18652
|
<dl>
|
|
17546
18653
|
<dd>
|
|
17547
18654
|
|
|
17548
|
-
**
|
|
17549
|
-
|
|
17550
|
-
</dd>
|
|
17551
|
-
</dl>
|
|
17552
|
-
|
|
17553
|
-
<dl>
|
|
17554
|
-
<dd>
|
|
17555
|
-
|
|
17556
|
-
**q:** `String` — Search for companies by name, keys or string traits
|
|
18655
|
+
**q:** `String`
|
|
17557
18656
|
|
|
17558
18657
|
</dd>
|
|
17559
18658
|
</dl>
|
|
@@ -17577,7 +18676,7 @@ client.plans.count_billing_product_match_companies(
|
|
|
17577
18676
|
<dl>
|
|
17578
18677
|
<dd>
|
|
17579
18678
|
|
|
17580
|
-
**request_options:** `Schematic::
|
|
18679
|
+
**request_options:** `Schematic::Components::RequestOptions`
|
|
17581
18680
|
|
|
17582
18681
|
</dd>
|
|
17583
18682
|
</dl>
|
|
@@ -17589,7 +18688,7 @@ client.plans.count_billing_product_match_companies(
|
|
|
17589
18688
|
</dl>
|
|
17590
18689
|
</details>
|
|
17591
18690
|
|
|
17592
|
-
<details><summary><code>client.
|
|
18691
|
+
<details><summary><code>client.components.<a href="/lib/schematic/components/client.rb">create_component</a>(request) -> Schematic::Components::Types::CreateComponentResponse</code></summary>
|
|
17593
18692
|
<dl>
|
|
17594
18693
|
<dd>
|
|
17595
18694
|
|
|
@@ -17602,27 +18701,9 @@ client.plans.count_billing_product_match_companies(
|
|
|
17602
18701
|
<dd>
|
|
17603
18702
|
|
|
17604
18703
|
```ruby
|
|
17605
|
-
client.
|
|
17606
|
-
|
|
17607
|
-
|
|
17608
|
-
exclude_company_scoped: true,
|
|
17609
|
-
exclude_unused: true,
|
|
17610
|
-
for_fallback_plan: true,
|
|
17611
|
-
for_initial_plan: true,
|
|
17612
|
-
for_trial_expiry_plan: true,
|
|
17613
|
-
has_product_id: true,
|
|
17614
|
-
ids: ["ids"],
|
|
17615
|
-
include_draft_versions: true,
|
|
17616
|
-
plan_type: "plan",
|
|
17617
|
-
q: "q",
|
|
17618
|
-
scoped_to_company_id: "scoped_to_company_id",
|
|
17619
|
-
with_entitlements: true,
|
|
17620
|
-
with_published_version: true,
|
|
17621
|
-
without_entitlement_for_include_drafts: true,
|
|
17622
|
-
without_entitlement_for: "without_entitlement_for",
|
|
17623
|
-
without_paid_product_id: true,
|
|
17624
|
-
limit: 1000000,
|
|
17625
|
-
offset: 1000000
|
|
18704
|
+
client.components.create_component(
|
|
18705
|
+
entity_type: "billing",
|
|
18706
|
+
name: "name"
|
|
17626
18707
|
)
|
|
17627
18708
|
```
|
|
17628
18709
|
</dd>
|
|
@@ -17638,7 +18719,7 @@ client.plans.count_plans(
|
|
|
17638
18719
|
<dl>
|
|
17639
18720
|
<dd>
|
|
17640
18721
|
|
|
17641
|
-
**
|
|
18722
|
+
**ast:** `Internal::Types::Hash[String, Float]`
|
|
17642
18723
|
|
|
17643
18724
|
</dd>
|
|
17644
18725
|
</dl>
|
|
@@ -17646,7 +18727,7 @@ client.plans.count_plans(
|
|
|
17646
18727
|
<dl>
|
|
17647
18728
|
<dd>
|
|
17648
18729
|
|
|
17649
|
-
**
|
|
18730
|
+
**entity_type:** `Schematic::Types::ComponentEntityType`
|
|
17650
18731
|
|
|
17651
18732
|
</dd>
|
|
17652
18733
|
</dl>
|
|
@@ -17654,7 +18735,7 @@ client.plans.count_plans(
|
|
|
17654
18735
|
<dl>
|
|
17655
18736
|
<dd>
|
|
17656
18737
|
|
|
17657
|
-
**
|
|
18738
|
+
**name:** `String`
|
|
17658
18739
|
|
|
17659
18740
|
</dd>
|
|
17660
18741
|
</dl>
|
|
@@ -17662,55 +18743,47 @@ client.plans.count_plans(
|
|
|
17662
18743
|
<dl>
|
|
17663
18744
|
<dd>
|
|
17664
18745
|
|
|
17665
|
-
**
|
|
18746
|
+
**request_options:** `Schematic::Components::RequestOptions`
|
|
17666
18747
|
|
|
17667
18748
|
</dd>
|
|
17668
18749
|
</dl>
|
|
18750
|
+
</dd>
|
|
18751
|
+
</dl>
|
|
17669
18752
|
|
|
17670
|
-
<dl>
|
|
17671
|
-
<dd>
|
|
17672
18753
|
|
|
17673
|
-
**for_fallback_plan:** `Internal::Types::Boolean` — Filter for plans valid as fallback plans (not linked to billing)
|
|
17674
|
-
|
|
17675
18754
|
</dd>
|
|
17676
18755
|
</dl>
|
|
18756
|
+
</details>
|
|
17677
18757
|
|
|
18758
|
+
<details><summary><code>client.components.<a href="/lib/schematic/components/client.rb">get_component</a>(component_id:) -> Schematic::Components::Types::GetComponentResponse</code></summary>
|
|
17678
18759
|
<dl>
|
|
17679
18760
|
<dd>
|
|
17680
18761
|
|
|
17681
|
-
|
|
17682
|
-
|
|
17683
|
-
</dd>
|
|
17684
|
-
</dl>
|
|
18762
|
+
#### 🔌 Usage
|
|
17685
18763
|
|
|
17686
18764
|
<dl>
|
|
17687
18765
|
<dd>
|
|
17688
18766
|
|
|
17689
|
-
**for_trial_expiry_plan:** `Internal::Types::Boolean` — Filter for plans valid as trial expiry plans (not linked to billing or free)
|
|
17690
|
-
|
|
17691
|
-
</dd>
|
|
17692
|
-
</dl>
|
|
17693
|
-
|
|
17694
18767
|
<dl>
|
|
17695
18768
|
<dd>
|
|
17696
18769
|
|
|
17697
|
-
|
|
17698
|
-
|
|
18770
|
+
```ruby
|
|
18771
|
+
client.components.get_component(component_id: "component_id")
|
|
18772
|
+
```
|
|
17699
18773
|
</dd>
|
|
17700
18774
|
</dl>
|
|
18775
|
+
</dd>
|
|
18776
|
+
</dl>
|
|
18777
|
+
|
|
18778
|
+
#### ⚙️ Parameters
|
|
17701
18779
|
|
|
17702
18780
|
<dl>
|
|
17703
18781
|
<dd>
|
|
17704
18782
|
|
|
17705
|
-
**ids:** `String`
|
|
17706
|
-
|
|
17707
|
-
</dd>
|
|
17708
|
-
</dl>
|
|
17709
|
-
|
|
17710
18783
|
<dl>
|
|
17711
18784
|
<dd>
|
|
17712
18785
|
|
|
17713
|
-
**
|
|
18786
|
+
**component_id:** `String` — component_id
|
|
17714
18787
|
|
|
17715
18788
|
</dd>
|
|
17716
18789
|
</dl>
|
|
@@ -17718,47 +18791,47 @@ client.plans.count_plans(
|
|
|
17718
18791
|
<dl>
|
|
17719
18792
|
<dd>
|
|
17720
18793
|
|
|
17721
|
-
**
|
|
18794
|
+
**request_options:** `Schematic::Components::RequestOptions`
|
|
17722
18795
|
|
|
17723
18796
|
</dd>
|
|
17724
18797
|
</dl>
|
|
18798
|
+
</dd>
|
|
18799
|
+
</dl>
|
|
17725
18800
|
|
|
17726
|
-
<dl>
|
|
17727
|
-
<dd>
|
|
17728
18801
|
|
|
17729
|
-
**q:** `String`
|
|
17730
|
-
|
|
17731
18802
|
</dd>
|
|
17732
18803
|
</dl>
|
|
18804
|
+
</details>
|
|
17733
18805
|
|
|
18806
|
+
<details><summary><code>client.components.<a href="/lib/schematic/components/client.rb">update_component</a>(component_id:, request) -> Schematic::Components::Types::UpdateComponentResponse</code></summary>
|
|
17734
18807
|
<dl>
|
|
17735
18808
|
<dd>
|
|
17736
18809
|
|
|
17737
|
-
|
|
17738
|
-
|
|
17739
|
-
</dd>
|
|
17740
|
-
</dl>
|
|
18810
|
+
#### 🔌 Usage
|
|
17741
18811
|
|
|
17742
18812
|
<dl>
|
|
17743
18813
|
<dd>
|
|
17744
18814
|
|
|
17745
|
-
**with_entitlements:** `Internal::Types::Boolean` — Include each plan's entitlements in the response
|
|
17746
|
-
|
|
17747
|
-
</dd>
|
|
17748
|
-
</dl>
|
|
17749
|
-
|
|
17750
18815
|
<dl>
|
|
17751
18816
|
<dd>
|
|
17752
18817
|
|
|
17753
|
-
|
|
17754
|
-
|
|
18818
|
+
```ruby
|
|
18819
|
+
client.components.update_component(component_id: "component_id")
|
|
18820
|
+
```
|
|
17755
18821
|
</dd>
|
|
17756
18822
|
</dl>
|
|
18823
|
+
</dd>
|
|
18824
|
+
</dl>
|
|
18825
|
+
|
|
18826
|
+
#### ⚙️ Parameters
|
|
17757
18827
|
|
|
17758
18828
|
<dl>
|
|
17759
18829
|
<dd>
|
|
17760
18830
|
|
|
17761
|
-
|
|
18831
|
+
<dl>
|
|
18832
|
+
<dd>
|
|
18833
|
+
|
|
18834
|
+
**component_id:** `String` — component_id
|
|
17762
18835
|
|
|
17763
18836
|
</dd>
|
|
17764
18837
|
</dl>
|
|
@@ -17766,7 +18839,7 @@ client.plans.count_plans(
|
|
|
17766
18839
|
<dl>
|
|
17767
18840
|
<dd>
|
|
17768
18841
|
|
|
17769
|
-
**
|
|
18842
|
+
**ast:** `Internal::Types::Hash[String, Float]`
|
|
17770
18843
|
|
|
17771
18844
|
</dd>
|
|
17772
18845
|
</dl>
|
|
@@ -17774,7 +18847,7 @@ client.plans.count_plans(
|
|
|
17774
18847
|
<dl>
|
|
17775
18848
|
<dd>
|
|
17776
18849
|
|
|
17777
|
-
**
|
|
18850
|
+
**entity_type:** `Schematic::Types::ComponentEntityType`
|
|
17778
18851
|
|
|
17779
18852
|
</dd>
|
|
17780
18853
|
</dl>
|
|
@@ -17782,7 +18855,7 @@ client.plans.count_plans(
|
|
|
17782
18855
|
<dl>
|
|
17783
18856
|
<dd>
|
|
17784
18857
|
|
|
17785
|
-
**
|
|
18858
|
+
**name:** `String`
|
|
17786
18859
|
|
|
17787
18860
|
</dd>
|
|
17788
18861
|
</dl>
|
|
@@ -17790,7 +18863,7 @@ client.plans.count_plans(
|
|
|
17790
18863
|
<dl>
|
|
17791
18864
|
<dd>
|
|
17792
18865
|
|
|
17793
|
-
**
|
|
18866
|
+
**state:** `Schematic::Types::ComponentState`
|
|
17794
18867
|
|
|
17795
18868
|
</dd>
|
|
17796
18869
|
</dl>
|
|
@@ -17798,7 +18871,7 @@ client.plans.count_plans(
|
|
|
17798
18871
|
<dl>
|
|
17799
18872
|
<dd>
|
|
17800
18873
|
|
|
17801
|
-
**request_options:** `Schematic::
|
|
18874
|
+
**request_options:** `Schematic::Components::RequestOptions`
|
|
17802
18875
|
|
|
17803
18876
|
</dd>
|
|
17804
18877
|
</dl>
|
|
@@ -17810,7 +18883,7 @@ client.plans.count_plans(
|
|
|
17810
18883
|
</dl>
|
|
17811
18884
|
</details>
|
|
17812
18885
|
|
|
17813
|
-
<details><summary><code>client.
|
|
18886
|
+
<details><summary><code>client.components.<a href="/lib/schematic/components/client.rb">delete_component</a>(component_id:) -> Schematic::Components::Types::DeleteComponentResponse</code></summary>
|
|
17814
18887
|
<dl>
|
|
17815
18888
|
<dd>
|
|
17816
18889
|
|
|
@@ -17823,10 +18896,7 @@ client.plans.count_plans(
|
|
|
17823
18896
|
<dd>
|
|
17824
18897
|
|
|
17825
18898
|
```ruby
|
|
17826
|
-
client.
|
|
17827
|
-
plan_id: "plan_id",
|
|
17828
|
-
plan_version_id: "plan_version_id"
|
|
17829
|
-
)
|
|
18899
|
+
client.components.delete_component(component_id: "component_id")
|
|
17830
18900
|
```
|
|
17831
18901
|
</dd>
|
|
17832
18902
|
</dl>
|
|
@@ -17841,15 +18911,7 @@ client.plans.list_plan_issues(
|
|
|
17841
18911
|
<dl>
|
|
17842
18912
|
<dd>
|
|
17843
18913
|
|
|
17844
|
-
**
|
|
17845
|
-
|
|
17846
|
-
</dd>
|
|
17847
|
-
</dl>
|
|
17848
|
-
|
|
17849
|
-
<dl>
|
|
17850
|
-
<dd>
|
|
17851
|
-
|
|
17852
|
-
**plan_version_id:** `String`
|
|
18914
|
+
**component_id:** `String` — component_id
|
|
17853
18915
|
|
|
17854
18916
|
</dd>
|
|
17855
18917
|
</dl>
|
|
@@ -17857,7 +18919,7 @@ client.plans.list_plan_issues(
|
|
|
17857
18919
|
<dl>
|
|
17858
18920
|
<dd>
|
|
17859
18921
|
|
|
17860
|
-
**request_options:** `Schematic::
|
|
18922
|
+
**request_options:** `Schematic::Components::RequestOptions`
|
|
17861
18923
|
|
|
17862
18924
|
</dd>
|
|
17863
18925
|
</dl>
|
|
@@ -17869,7 +18931,7 @@ client.plans.list_plan_issues(
|
|
|
17869
18931
|
</dl>
|
|
17870
18932
|
</details>
|
|
17871
18933
|
|
|
17872
|
-
<details><summary><code>client.
|
|
18934
|
+
<details><summary><code>client.components.<a href="/lib/schematic/components/client.rb">bind_catalog</a>(component_id:, request) -> Schematic::Components::Types::BindCatalogResponse</code></summary>
|
|
17873
18935
|
<dl>
|
|
17874
18936
|
<dd>
|
|
17875
18937
|
|
|
@@ -17882,10 +18944,7 @@ client.plans.list_plan_issues(
|
|
|
17882
18944
|
<dd>
|
|
17883
18945
|
|
|
17884
18946
|
```ruby
|
|
17885
|
-
client.
|
|
17886
|
-
plan_version_id: "plan_version_id",
|
|
17887
|
-
promote_archived_version: true
|
|
17888
|
-
)
|
|
18947
|
+
client.components.bind_catalog(component_id: "component_id")
|
|
17889
18948
|
```
|
|
17890
18949
|
</dd>
|
|
17891
18950
|
</dl>
|
|
@@ -17900,7 +18959,7 @@ client.plans.delete_plan_version(
|
|
|
17900
18959
|
<dl>
|
|
17901
18960
|
<dd>
|
|
17902
18961
|
|
|
17903
|
-
**
|
|
18962
|
+
**component_id:** `String` — component_id
|
|
17904
18963
|
|
|
17905
18964
|
</dd>
|
|
17906
18965
|
</dl>
|
|
@@ -17908,7 +18967,7 @@ client.plans.delete_plan_version(
|
|
|
17908
18967
|
<dl>
|
|
17909
18968
|
<dd>
|
|
17910
18969
|
|
|
17911
|
-
**
|
|
18970
|
+
**catalog_id:** `String`
|
|
17912
18971
|
|
|
17913
18972
|
</dd>
|
|
17914
18973
|
</dl>
|
|
@@ -17916,7 +18975,7 @@ client.plans.delete_plan_version(
|
|
|
17916
18975
|
<dl>
|
|
17917
18976
|
<dd>
|
|
17918
18977
|
|
|
17919
|
-
**request_options:** `Schematic::
|
|
18978
|
+
**request_options:** `Schematic::Components::RequestOptions`
|
|
17920
18979
|
|
|
17921
18980
|
</dd>
|
|
17922
18981
|
</dl>
|
|
@@ -17928,7 +18987,7 @@ client.plans.delete_plan_version(
|
|
|
17928
18987
|
</dl>
|
|
17929
18988
|
</details>
|
|
17930
18989
|
|
|
17931
|
-
<details><summary><code>client.
|
|
18990
|
+
<details><summary><code>client.components.<a href="/lib/schematic/components/client.rb">count_components</a>() -> Schematic::Components::Types::CountComponentsResponse</code></summary>
|
|
17932
18991
|
<dl>
|
|
17933
18992
|
<dd>
|
|
17934
18993
|
|
|
@@ -17941,9 +19000,10 @@ client.plans.delete_plan_version(
|
|
|
17941
19000
|
<dd>
|
|
17942
19001
|
|
|
17943
19002
|
```ruby
|
|
17944
|
-
client.
|
|
17945
|
-
|
|
17946
|
-
|
|
19003
|
+
client.components.count_components(
|
|
19004
|
+
q: "q",
|
|
19005
|
+
limit: 1000000,
|
|
19006
|
+
offset: 1000000
|
|
17947
19007
|
)
|
|
17948
19008
|
```
|
|
17949
19009
|
</dd>
|
|
@@ -17959,7 +19019,7 @@ client.plans.get_plan_version_diff(
|
|
|
17959
19019
|
<dl>
|
|
17960
19020
|
<dd>
|
|
17961
19021
|
|
|
17962
|
-
**
|
|
19022
|
+
**q:** `String`
|
|
17963
19023
|
|
|
17964
19024
|
</dd>
|
|
17965
19025
|
</dl>
|
|
@@ -17967,7 +19027,7 @@ client.plans.get_plan_version_diff(
|
|
|
17967
19027
|
<dl>
|
|
17968
19028
|
<dd>
|
|
17969
19029
|
|
|
17970
|
-
**
|
|
19030
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
17971
19031
|
|
|
17972
19032
|
</dd>
|
|
17973
19033
|
</dl>
|
|
@@ -17975,7 +19035,15 @@ client.plans.get_plan_version_diff(
|
|
|
17975
19035
|
<dl>
|
|
17976
19036
|
<dd>
|
|
17977
19037
|
|
|
17978
|
-
**
|
|
19038
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
19039
|
+
|
|
19040
|
+
</dd>
|
|
19041
|
+
</dl>
|
|
19042
|
+
|
|
19043
|
+
<dl>
|
|
19044
|
+
<dd>
|
|
19045
|
+
|
|
19046
|
+
**request_options:** `Schematic::Components::RequestOptions`
|
|
17979
19047
|
|
|
17980
19048
|
</dd>
|
|
17981
19049
|
</dl>
|
|
@@ -17987,7 +19055,7 @@ client.plans.get_plan_version_diff(
|
|
|
17987
19055
|
</dl>
|
|
17988
19056
|
</details>
|
|
17989
19057
|
|
|
17990
|
-
<details><summary><code>client.
|
|
19058
|
+
<details><summary><code>client.components.<a href="/lib/schematic/components/client.rb">preview_component_data</a>() -> Schematic::Components::Types::PreviewComponentDataResponse</code></summary>
|
|
17991
19059
|
<dl>
|
|
17992
19060
|
<dd>
|
|
17993
19061
|
|
|
@@ -18000,10 +19068,9 @@ client.plans.get_plan_version_diff(
|
|
|
18000
19068
|
<dd>
|
|
18001
19069
|
|
|
18002
19070
|
```ruby
|
|
18003
|
-
client.
|
|
18004
|
-
|
|
18005
|
-
|
|
18006
|
-
migration_strategy: "end_of_billing_period"
|
|
19071
|
+
client.components.preview_component_data(
|
|
19072
|
+
company_id: "company_id",
|
|
19073
|
+
component_id: "component_id"
|
|
18007
19074
|
)
|
|
18008
19075
|
```
|
|
18009
19076
|
</dd>
|
|
@@ -18019,7 +19086,7 @@ client.plans.publish_plan_version(
|
|
|
18019
19086
|
<dl>
|
|
18020
19087
|
<dd>
|
|
18021
19088
|
|
|
18022
|
-
**
|
|
19089
|
+
**company_id:** `String`
|
|
18023
19090
|
|
|
18024
19091
|
</dd>
|
|
18025
19092
|
</dl>
|
|
@@ -18027,7 +19094,7 @@ client.plans.publish_plan_version(
|
|
|
18027
19094
|
<dl>
|
|
18028
19095
|
<dd>
|
|
18029
19096
|
|
|
18030
|
-
**
|
|
19097
|
+
**component_id:** `String`
|
|
18031
19098
|
|
|
18032
19099
|
</dd>
|
|
18033
19100
|
</dl>
|
|
@@ -18035,7 +19102,7 @@ client.plans.publish_plan_version(
|
|
|
18035
19102
|
<dl>
|
|
18036
19103
|
<dd>
|
|
18037
19104
|
|
|
18038
|
-
**request_options:** `Schematic::
|
|
19105
|
+
**request_options:** `Schematic::Components::RequestOptions`
|
|
18039
19106
|
|
|
18040
19107
|
</dd>
|
|
18041
19108
|
</dl>
|
|
@@ -18047,7 +19114,8 @@ client.plans.publish_plan_version(
|
|
|
18047
19114
|
</dl>
|
|
18048
19115
|
</details>
|
|
18049
19116
|
|
|
18050
|
-
|
|
19117
|
+
## planbundle
|
|
19118
|
+
<details><summary><code>client.planbundle.<a href="/lib/schematic/planbundle/client.rb">create_custom_plan_bundle</a>(request) -> Schematic::Planbundle::Types::CreateCustomPlanBundleResponse</code></summary>
|
|
18051
19119
|
<dl>
|
|
18052
19120
|
<dd>
|
|
18053
19121
|
|
|
@@ -18060,10 +19128,18 @@ client.plans.publish_plan_version(
|
|
|
18060
19128
|
<dd>
|
|
18061
19129
|
|
|
18062
19130
|
```ruby
|
|
18063
|
-
client.
|
|
18064
|
-
|
|
18065
|
-
|
|
18066
|
-
|
|
19131
|
+
client.planbundle.create_custom_plan_bundle(
|
|
19132
|
+
billing_product: {
|
|
19133
|
+
charge_type: "free",
|
|
19134
|
+
is_trialable: true
|
|
19135
|
+
},
|
|
19136
|
+
entitlements: [{
|
|
19137
|
+
action: "create"
|
|
19138
|
+
}],
|
|
19139
|
+
plan: {
|
|
19140
|
+
company_id: "company_id",
|
|
19141
|
+
name: "name"
|
|
19142
|
+
}
|
|
18067
19143
|
)
|
|
18068
19144
|
```
|
|
18069
19145
|
</dd>
|
|
@@ -18079,7 +19155,31 @@ client.plans.preview_publish_plan_version(
|
|
|
18079
19155
|
<dl>
|
|
18080
19156
|
<dd>
|
|
18081
19157
|
|
|
18082
|
-
**
|
|
19158
|
+
**billing_product:** `Schematic::Types::UpsertBillingProductRequestBody`
|
|
19159
|
+
|
|
19160
|
+
</dd>
|
|
19161
|
+
</dl>
|
|
19162
|
+
|
|
19163
|
+
<dl>
|
|
19164
|
+
<dd>
|
|
19165
|
+
|
|
19166
|
+
**credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
|
|
19167
|
+
|
|
19168
|
+
</dd>
|
|
19169
|
+
</dl>
|
|
19170
|
+
|
|
19171
|
+
<dl>
|
|
19172
|
+
<dd>
|
|
19173
|
+
|
|
19174
|
+
**entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
|
|
19175
|
+
|
|
19176
|
+
</dd>
|
|
19177
|
+
</dl>
|
|
19178
|
+
|
|
19179
|
+
<dl>
|
|
19180
|
+
<dd>
|
|
19181
|
+
|
|
19182
|
+
**plan:** `Schematic::Types::CreateCustomPlanBundlePlanRequestBody`
|
|
18083
19183
|
|
|
18084
19184
|
</dd>
|
|
18085
19185
|
</dl>
|
|
@@ -18087,7 +19187,7 @@ client.plans.preview_publish_plan_version(
|
|
|
18087
19187
|
<dl>
|
|
18088
19188
|
<dd>
|
|
18089
19189
|
|
|
18090
|
-
**
|
|
19190
|
+
**renewal_policy:** `Schematic::Types::RenewalPolicy`
|
|
18091
19191
|
|
|
18092
19192
|
</dd>
|
|
18093
19193
|
</dl>
|
|
@@ -18095,7 +19195,7 @@ client.plans.preview_publish_plan_version(
|
|
|
18095
19195
|
<dl>
|
|
18096
19196
|
<dd>
|
|
18097
19197
|
|
|
18098
|
-
**request_options:** `Schematic::
|
|
19198
|
+
**request_options:** `Schematic::Planbundle::RequestOptions`
|
|
18099
19199
|
|
|
18100
19200
|
</dd>
|
|
18101
19201
|
</dl>
|
|
@@ -18107,8 +19207,7 @@ client.plans.preview_publish_plan_version(
|
|
|
18107
19207
|
</dl>
|
|
18108
19208
|
</details>
|
|
18109
19209
|
|
|
18110
|
-
|
|
18111
|
-
<details><summary><code>client.components.<a href="/lib/schematic/components/client.rb">list_components</a>() -> Schematic::Components::Types::ListComponentsResponse</code></summary>
|
|
19210
|
+
<details><summary><code>client.planbundle.<a href="/lib/schematic/planbundle/client.rb">create_plan_bundle</a>(request) -> Schematic::Planbundle::Types::CreatePlanBundleResponse</code></summary>
|
|
18112
19211
|
<dl>
|
|
18113
19212
|
<dd>
|
|
18114
19213
|
|
|
@@ -18121,10 +19220,14 @@ client.plans.preview_publish_plan_version(
|
|
|
18121
19220
|
<dd>
|
|
18122
19221
|
|
|
18123
19222
|
```ruby
|
|
18124
|
-
client.
|
|
18125
|
-
|
|
18126
|
-
|
|
18127
|
-
|
|
19223
|
+
client.planbundle.create_plan_bundle(
|
|
19224
|
+
entitlements: [{
|
|
19225
|
+
action: "create"
|
|
19226
|
+
}],
|
|
19227
|
+
plan: {
|
|
19228
|
+
name: "name",
|
|
19229
|
+
plan_type: "plan"
|
|
19230
|
+
}
|
|
18128
19231
|
)
|
|
18129
19232
|
```
|
|
18130
19233
|
</dd>
|
|
@@ -18140,7 +19243,7 @@ client.components.list_components(
|
|
|
18140
19243
|
<dl>
|
|
18141
19244
|
<dd>
|
|
18142
19245
|
|
|
18143
|
-
**
|
|
19246
|
+
**billing_product:** `Schematic::Types::UpsertBillingProductRequestBody`
|
|
18144
19247
|
|
|
18145
19248
|
</dd>
|
|
18146
19249
|
</dl>
|
|
@@ -18148,7 +19251,7 @@ client.components.list_components(
|
|
|
18148
19251
|
<dl>
|
|
18149
19252
|
<dd>
|
|
18150
19253
|
|
|
18151
|
-
**
|
|
19254
|
+
**credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
|
|
18152
19255
|
|
|
18153
19256
|
</dd>
|
|
18154
19257
|
</dl>
|
|
@@ -18156,7 +19259,7 @@ client.components.list_components(
|
|
|
18156
19259
|
<dl>
|
|
18157
19260
|
<dd>
|
|
18158
19261
|
|
|
18159
|
-
**
|
|
19262
|
+
**entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
|
|
18160
19263
|
|
|
18161
19264
|
</dd>
|
|
18162
19265
|
</dl>
|
|
@@ -18164,7 +19267,23 @@ client.components.list_components(
|
|
|
18164
19267
|
<dl>
|
|
18165
19268
|
<dd>
|
|
18166
19269
|
|
|
18167
|
-
**
|
|
19270
|
+
**plan:** `Schematic::Types::CreatePlanRequestBody`
|
|
19271
|
+
|
|
19272
|
+
</dd>
|
|
19273
|
+
</dl>
|
|
19274
|
+
|
|
19275
|
+
<dl>
|
|
19276
|
+
<dd>
|
|
19277
|
+
|
|
19278
|
+
**renewal_policy:** `Schematic::Types::RenewalPolicy`
|
|
19279
|
+
|
|
19280
|
+
</dd>
|
|
19281
|
+
</dl>
|
|
19282
|
+
|
|
19283
|
+
<dl>
|
|
19284
|
+
<dd>
|
|
19285
|
+
|
|
19286
|
+
**request_options:** `Schematic::Planbundle::RequestOptions`
|
|
18168
19287
|
|
|
18169
19288
|
</dd>
|
|
18170
19289
|
</dl>
|
|
@@ -18176,7 +19295,7 @@ client.components.list_components(
|
|
|
18176
19295
|
</dl>
|
|
18177
19296
|
</details>
|
|
18178
19297
|
|
|
18179
|
-
<details><summary><code>client.
|
|
19298
|
+
<details><summary><code>client.planbundle.<a href="/lib/schematic/planbundle/client.rb">update_plan_bundle</a>(plan_id:, request) -> Schematic::Planbundle::Types::UpdatePlanBundleResponse</code></summary>
|
|
18180
19299
|
<dl>
|
|
18181
19300
|
<dd>
|
|
18182
19301
|
|
|
@@ -18189,9 +19308,14 @@ client.components.list_components(
|
|
|
18189
19308
|
<dd>
|
|
18190
19309
|
|
|
18191
19310
|
```ruby
|
|
18192
|
-
client.
|
|
18193
|
-
|
|
18194
|
-
|
|
19311
|
+
client.planbundle.update_plan_bundle(
|
|
19312
|
+
plan_id: "plan_id",
|
|
19313
|
+
entitlements: [{
|
|
19314
|
+
action: "create"
|
|
19315
|
+
}],
|
|
19316
|
+
plan: {
|
|
19317
|
+
name: "name"
|
|
19318
|
+
}
|
|
18195
19319
|
)
|
|
18196
19320
|
```
|
|
18197
19321
|
</dd>
|
|
@@ -18207,7 +19331,7 @@ client.components.create_component(
|
|
|
18207
19331
|
<dl>
|
|
18208
19332
|
<dd>
|
|
18209
19333
|
|
|
18210
|
-
**
|
|
19334
|
+
**plan_id:** `String` — plan_id
|
|
18211
19335
|
|
|
18212
19336
|
</dd>
|
|
18213
19337
|
</dl>
|
|
@@ -18215,7 +19339,7 @@ client.components.create_component(
|
|
|
18215
19339
|
<dl>
|
|
18216
19340
|
<dd>
|
|
18217
19341
|
|
|
18218
|
-
**
|
|
19342
|
+
**billing_product:** `Schematic::Types::UpsertBillingProductRequestBody`
|
|
18219
19343
|
|
|
18220
19344
|
</dd>
|
|
18221
19345
|
</dl>
|
|
@@ -18223,7 +19347,7 @@ client.components.create_component(
|
|
|
18223
19347
|
<dl>
|
|
18224
19348
|
<dd>
|
|
18225
19349
|
|
|
18226
|
-
**
|
|
19350
|
+
**credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
|
|
18227
19351
|
|
|
18228
19352
|
</dd>
|
|
18229
19353
|
</dl>
|
|
@@ -18231,47 +19355,31 @@ client.components.create_component(
|
|
|
18231
19355
|
<dl>
|
|
18232
19356
|
<dd>
|
|
18233
19357
|
|
|
18234
|
-
**
|
|
19358
|
+
**entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
|
|
18235
19359
|
|
|
18236
19360
|
</dd>
|
|
18237
19361
|
</dl>
|
|
18238
|
-
</dd>
|
|
18239
|
-
</dl>
|
|
18240
19362
|
|
|
18241
|
-
|
|
18242
|
-
</dd>
|
|
18243
|
-
</dl>
|
|
18244
|
-
</details>
|
|
18245
|
-
|
|
18246
|
-
<details><summary><code>client.components.<a href="/lib/schematic/components/client.rb">get_component</a>(component_id:) -> Schematic::Components::Types::GetComponentResponse</code></summary>
|
|
18247
19363
|
<dl>
|
|
18248
19364
|
<dd>
|
|
18249
19365
|
|
|
18250
|
-
|
|
18251
|
-
|
|
18252
|
-
|
|
18253
|
-
|
|
19366
|
+
**plan:** `Schematic::Types::UpdatePlanRequestBody`
|
|
19367
|
+
|
|
19368
|
+
</dd>
|
|
19369
|
+
</dl>
|
|
18254
19370
|
|
|
18255
19371
|
<dl>
|
|
18256
19372
|
<dd>
|
|
18257
19373
|
|
|
18258
|
-
|
|
18259
|
-
|
|
18260
|
-
```
|
|
18261
|
-
</dd>
|
|
18262
|
-
</dl>
|
|
19374
|
+
**plan_version_id:** `String`
|
|
19375
|
+
|
|
18263
19376
|
</dd>
|
|
18264
19377
|
</dl>
|
|
18265
19378
|
|
|
18266
|
-
#### ⚙️ Parameters
|
|
18267
|
-
|
|
18268
|
-
<dl>
|
|
18269
|
-
<dd>
|
|
18270
|
-
|
|
18271
19379
|
<dl>
|
|
18272
19380
|
<dd>
|
|
18273
19381
|
|
|
18274
|
-
**
|
|
19382
|
+
**renewal_policy:** `Schematic::Types::RenewalPolicy`
|
|
18275
19383
|
|
|
18276
19384
|
</dd>
|
|
18277
19385
|
</dl>
|
|
@@ -18279,7 +19387,7 @@ client.components.get_component(component_id: "component_id")
|
|
|
18279
19387
|
<dl>
|
|
18280
19388
|
<dd>
|
|
18281
19389
|
|
|
18282
|
-
**request_options:** `Schematic::
|
|
19390
|
+
**request_options:** `Schematic::Planbundle::RequestOptions`
|
|
18283
19391
|
|
|
18284
19392
|
</dd>
|
|
18285
19393
|
</dl>
|
|
@@ -18291,7 +19399,8 @@ client.components.get_component(component_id: "component_id")
|
|
|
18291
19399
|
</dl>
|
|
18292
19400
|
</details>
|
|
18293
19401
|
|
|
18294
|
-
|
|
19402
|
+
## customplangrouprollouts
|
|
19403
|
+
<details><summary><code>client.customplangrouprollouts.<a href="/lib/schematic/customplangrouprollouts/client.rb">list_group_rollouts</a>() -> Schematic::Customplangrouprollouts::Types::ListGroupRolloutsResponse</code></summary>
|
|
18295
19404
|
<dl>
|
|
18296
19405
|
<dd>
|
|
18297
19406
|
|
|
@@ -18304,7 +19413,7 @@ client.components.get_component(component_id: "component_id")
|
|
|
18304
19413
|
<dd>
|
|
18305
19414
|
|
|
18306
19415
|
```ruby
|
|
18307
|
-
client.
|
|
19416
|
+
client.customplangrouprollouts.list_group_rollouts(plan_id: "plan_id")
|
|
18308
19417
|
```
|
|
18309
19418
|
</dd>
|
|
18310
19419
|
</dl>
|
|
@@ -18319,7 +19428,7 @@ client.components.update_component(component_id: "component_id")
|
|
|
18319
19428
|
<dl>
|
|
18320
19429
|
<dd>
|
|
18321
19430
|
|
|
18322
|
-
**
|
|
19431
|
+
**plan_id:** `String`
|
|
18323
19432
|
|
|
18324
19433
|
</dd>
|
|
18325
19434
|
</dl>
|
|
@@ -18327,31 +19436,47 @@ client.components.update_component(component_id: "component_id")
|
|
|
18327
19436
|
<dl>
|
|
18328
19437
|
<dd>
|
|
18329
19438
|
|
|
18330
|
-
**
|
|
19439
|
+
**request_options:** `Schematic::Customplangrouprollouts::RequestOptions`
|
|
18331
19440
|
|
|
18332
19441
|
</dd>
|
|
18333
19442
|
</dl>
|
|
19443
|
+
</dd>
|
|
19444
|
+
</dl>
|
|
18334
19445
|
|
|
18335
|
-
<dl>
|
|
18336
|
-
<dd>
|
|
18337
19446
|
|
|
18338
|
-
**entity_type:** `Schematic::Types::ComponentEntityType`
|
|
18339
|
-
|
|
18340
19447
|
</dd>
|
|
18341
19448
|
</dl>
|
|
19449
|
+
</details>
|
|
18342
19450
|
|
|
19451
|
+
<details><summary><code>client.customplangrouprollouts.<a href="/lib/schematic/customplangrouprollouts/client.rb">get_group_rollout</a>(custom_plan_group_rollout_id:) -> Schematic::Customplangrouprollouts::Types::GetGroupRolloutResponse</code></summary>
|
|
18343
19452
|
<dl>
|
|
18344
19453
|
<dd>
|
|
18345
19454
|
|
|
18346
|
-
|
|
18347
|
-
|
|
19455
|
+
#### 🔌 Usage
|
|
19456
|
+
|
|
19457
|
+
<dl>
|
|
19458
|
+
<dd>
|
|
19459
|
+
|
|
19460
|
+
<dl>
|
|
19461
|
+
<dd>
|
|
19462
|
+
|
|
19463
|
+
```ruby
|
|
19464
|
+
client.customplangrouprollouts.get_group_rollout(custom_plan_group_rollout_id: "custom_plan_group_rollout_id")
|
|
19465
|
+
```
|
|
19466
|
+
</dd>
|
|
19467
|
+
</dl>
|
|
18348
19468
|
</dd>
|
|
18349
19469
|
</dl>
|
|
18350
19470
|
|
|
19471
|
+
#### ⚙️ Parameters
|
|
19472
|
+
|
|
18351
19473
|
<dl>
|
|
18352
19474
|
<dd>
|
|
18353
19475
|
|
|
18354
|
-
|
|
19476
|
+
<dl>
|
|
19477
|
+
<dd>
|
|
19478
|
+
|
|
19479
|
+
**custom_plan_group_rollout_id:** `String` — custom_plan_group_rollout_id
|
|
18355
19480
|
|
|
18356
19481
|
</dd>
|
|
18357
19482
|
</dl>
|
|
@@ -18359,7 +19484,7 @@ client.components.update_component(component_id: "component_id")
|
|
|
18359
19484
|
<dl>
|
|
18360
19485
|
<dd>
|
|
18361
19486
|
|
|
18362
|
-
**request_options:** `Schematic::
|
|
19487
|
+
**request_options:** `Schematic::Customplangrouprollouts::RequestOptions`
|
|
18363
19488
|
|
|
18364
19489
|
</dd>
|
|
18365
19490
|
</dl>
|
|
@@ -18371,7 +19496,7 @@ client.components.update_component(component_id: "component_id")
|
|
|
18371
19496
|
</dl>
|
|
18372
19497
|
</details>
|
|
18373
19498
|
|
|
18374
|
-
<details><summary><code>client.
|
|
19499
|
+
<details><summary><code>client.customplangrouprollouts.<a href="/lib/schematic/customplangrouprollouts/client.rb">copy_custom_plan</a>(plan_id:, request) -> Schematic::Customplangrouprollouts::Types::CopyCustomPlanResponse</code></summary>
|
|
18375
19500
|
<dl>
|
|
18376
19501
|
<dd>
|
|
18377
19502
|
|
|
@@ -18384,7 +19509,10 @@ client.components.update_component(component_id: "component_id")
|
|
|
18384
19509
|
<dd>
|
|
18385
19510
|
|
|
18386
19511
|
```ruby
|
|
18387
|
-
client.
|
|
19512
|
+
client.customplangrouprollouts.copy_custom_plan(
|
|
19513
|
+
plan_id: "plan_id",
|
|
19514
|
+
company_id: "company_id"
|
|
19515
|
+
)
|
|
18388
19516
|
```
|
|
18389
19517
|
</dd>
|
|
18390
19518
|
</dl>
|
|
@@ -18399,7 +19527,7 @@ client.components.delete_component(component_id: "component_id")
|
|
|
18399
19527
|
<dl>
|
|
18400
19528
|
<dd>
|
|
18401
19529
|
|
|
18402
|
-
**
|
|
19530
|
+
**plan_id:** `String` — plan_id
|
|
18403
19531
|
|
|
18404
19532
|
</dd>
|
|
18405
19533
|
</dl>
|
|
@@ -18407,7 +19535,23 @@ client.components.delete_component(component_id: "component_id")
|
|
|
18407
19535
|
<dl>
|
|
18408
19536
|
<dd>
|
|
18409
19537
|
|
|
18410
|
-
**
|
|
19538
|
+
**company_id:** `String` — The company the copy is for, such as a location the plan's company pays for.
|
|
19539
|
+
|
|
19540
|
+
</dd>
|
|
19541
|
+
</dl>
|
|
19542
|
+
|
|
19543
|
+
<dl>
|
|
19544
|
+
<dd>
|
|
19545
|
+
|
|
19546
|
+
**name:** `String` — The copy's name. Defaults to the source plan's.
|
|
19547
|
+
|
|
19548
|
+
</dd>
|
|
19549
|
+
</dl>
|
|
19550
|
+
|
|
19551
|
+
<dl>
|
|
19552
|
+
<dd>
|
|
19553
|
+
|
|
19554
|
+
**request_options:** `Schematic::Customplangrouprollouts::RequestOptions`
|
|
18411
19555
|
|
|
18412
19556
|
</dd>
|
|
18413
19557
|
</dl>
|
|
@@ -18419,7 +19563,7 @@ client.components.delete_component(component_id: "component_id")
|
|
|
18419
19563
|
</dl>
|
|
18420
19564
|
</details>
|
|
18421
19565
|
|
|
18422
|
-
<details><summary><code>client.
|
|
19566
|
+
<details><summary><code>client.customplangrouprollouts.<a href="/lib/schematic/customplangrouprollouts/client.rb">preview_group_rollout</a>(plan_id:) -> Schematic::Customplangrouprollouts::Types::PreviewGroupRolloutResponse</code></summary>
|
|
18423
19567
|
<dl>
|
|
18424
19568
|
<dd>
|
|
18425
19569
|
|
|
@@ -18432,7 +19576,11 @@ client.components.delete_component(component_id: "component_id")
|
|
|
18432
19576
|
<dd>
|
|
18433
19577
|
|
|
18434
19578
|
```ruby
|
|
18435
|
-
client.
|
|
19579
|
+
client.customplangrouprollouts.preview_group_rollout(
|
|
19580
|
+
plan_id: "plan_id",
|
|
19581
|
+
from_plan_version_id: "from_plan_version_id",
|
|
19582
|
+
to_plan_version_id: "to_plan_version_id"
|
|
19583
|
+
)
|
|
18436
19584
|
```
|
|
18437
19585
|
</dd>
|
|
18438
19586
|
</dl>
|
|
@@ -18447,7 +19595,7 @@ client.components.bind_catalog(component_id: "component_id")
|
|
|
18447
19595
|
<dl>
|
|
18448
19596
|
<dd>
|
|
18449
19597
|
|
|
18450
|
-
**
|
|
19598
|
+
**plan_id:** `String` — plan_id
|
|
18451
19599
|
|
|
18452
19600
|
</dd>
|
|
18453
19601
|
</dl>
|
|
@@ -18455,7 +19603,7 @@ client.components.bind_catalog(component_id: "component_id")
|
|
|
18455
19603
|
<dl>
|
|
18456
19604
|
<dd>
|
|
18457
19605
|
|
|
18458
|
-
**
|
|
19606
|
+
**from_plan_version_id:** `String`
|
|
18459
19607
|
|
|
18460
19608
|
</dd>
|
|
18461
19609
|
</dl>
|
|
@@ -18463,7 +19611,15 @@ client.components.bind_catalog(component_id: "component_id")
|
|
|
18463
19611
|
<dl>
|
|
18464
19612
|
<dd>
|
|
18465
19613
|
|
|
18466
|
-
**
|
|
19614
|
+
**to_plan_version_id:** `String`
|
|
19615
|
+
|
|
19616
|
+
</dd>
|
|
19617
|
+
</dl>
|
|
19618
|
+
|
|
19619
|
+
<dl>
|
|
19620
|
+
<dd>
|
|
19621
|
+
|
|
19622
|
+
**request_options:** `Schematic::Customplangrouprollouts::RequestOptions`
|
|
18467
19623
|
|
|
18468
19624
|
</dd>
|
|
18469
19625
|
</dl>
|
|
@@ -18475,7 +19631,7 @@ client.components.bind_catalog(component_id: "component_id")
|
|
|
18475
19631
|
</dl>
|
|
18476
19632
|
</details>
|
|
18477
19633
|
|
|
18478
|
-
<details><summary><code>client.
|
|
19634
|
+
<details><summary><code>client.customplangrouprollouts.<a href="/lib/schematic/customplangrouprollouts/client.rb">start_group_rollout</a>(plan_id:, request) -> Schematic::Customplangrouprollouts::Types::StartGroupRolloutResponse</code></summary>
|
|
18479
19635
|
<dl>
|
|
18480
19636
|
<dd>
|
|
18481
19637
|
|
|
@@ -18488,10 +19644,9 @@ client.components.bind_catalog(component_id: "component_id")
|
|
|
18488
19644
|
<dd>
|
|
18489
19645
|
|
|
18490
19646
|
```ruby
|
|
18491
|
-
client.
|
|
18492
|
-
|
|
18493
|
-
|
|
18494
|
-
offset: 1000000
|
|
19647
|
+
client.customplangrouprollouts.start_group_rollout(
|
|
19648
|
+
plan_id: "plan_id",
|
|
19649
|
+
excluded_company_ids: ["excluded_company_ids"]
|
|
18495
19650
|
)
|
|
18496
19651
|
```
|
|
18497
19652
|
</dd>
|
|
@@ -18507,7 +19662,7 @@ client.components.count_components(
|
|
|
18507
19662
|
<dl>
|
|
18508
19663
|
<dd>
|
|
18509
19664
|
|
|
18510
|
-
**
|
|
19665
|
+
**plan_id:** `String` — plan_id
|
|
18511
19666
|
|
|
18512
19667
|
</dd>
|
|
18513
19668
|
</dl>
|
|
@@ -18515,7 +19670,7 @@ client.components.count_components(
|
|
|
18515
19670
|
<dl>
|
|
18516
19671
|
<dd>
|
|
18517
19672
|
|
|
18518
|
-
**
|
|
19673
|
+
**excluded_company_ids:** `Internal::Types::Array[String]` — Companies the payer pays for whose custom plans keep their current version.
|
|
18519
19674
|
|
|
18520
19675
|
</dd>
|
|
18521
19676
|
</dl>
|
|
@@ -18523,7 +19678,7 @@ client.components.count_components(
|
|
|
18523
19678
|
<dl>
|
|
18524
19679
|
<dd>
|
|
18525
19680
|
|
|
18526
|
-
**
|
|
19681
|
+
**from_plan_version_id:** `String`
|
|
18527
19682
|
|
|
18528
19683
|
</dd>
|
|
18529
19684
|
</dl>
|
|
@@ -18531,7 +19686,15 @@ client.components.count_components(
|
|
|
18531
19686
|
<dl>
|
|
18532
19687
|
<dd>
|
|
18533
19688
|
|
|
18534
|
-
**
|
|
19689
|
+
**to_plan_version_id:** `String`
|
|
19690
|
+
|
|
19691
|
+
</dd>
|
|
19692
|
+
</dl>
|
|
19693
|
+
|
|
19694
|
+
<dl>
|
|
19695
|
+
<dd>
|
|
19696
|
+
|
|
19697
|
+
**request_options:** `Schematic::Customplangrouprollouts::RequestOptions`
|
|
18535
19698
|
|
|
18536
19699
|
</dd>
|
|
18537
19700
|
</dl>
|
|
@@ -18543,7 +19706,8 @@ client.components.count_components(
|
|
|
18543
19706
|
</dl>
|
|
18544
19707
|
</details>
|
|
18545
19708
|
|
|
18546
|
-
|
|
19709
|
+
## dataexports
|
|
19710
|
+
<details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">list_data_exports</a>() -> Schematic::Dataexports::Types::ListDataExportsResponse</code></summary>
|
|
18547
19711
|
<dl>
|
|
18548
19712
|
<dd>
|
|
18549
19713
|
|
|
@@ -18556,9 +19720,11 @@ client.components.count_components(
|
|
|
18556
19720
|
<dd>
|
|
18557
19721
|
|
|
18558
19722
|
```ruby
|
|
18559
|
-
client.
|
|
18560
|
-
|
|
18561
|
-
|
|
19723
|
+
client.dataexports.list_data_exports(
|
|
19724
|
+
export_type: "audit-log",
|
|
19725
|
+
status: "failure",
|
|
19726
|
+
limit: 1000000,
|
|
19727
|
+
offset: 1000000
|
|
18562
19728
|
)
|
|
18563
19729
|
```
|
|
18564
19730
|
</dd>
|
|
@@ -18574,7 +19740,7 @@ client.components.preview_component_data(
|
|
|
18574
19740
|
<dl>
|
|
18575
19741
|
<dd>
|
|
18576
19742
|
|
|
18577
|
-
**
|
|
19743
|
+
**export_type:** `Schematic::Types::DataExportType`
|
|
18578
19744
|
|
|
18579
19745
|
</dd>
|
|
18580
19746
|
</dl>
|
|
@@ -18582,7 +19748,7 @@ client.components.preview_component_data(
|
|
|
18582
19748
|
<dl>
|
|
18583
19749
|
<dd>
|
|
18584
19750
|
|
|
18585
|
-
**
|
|
19751
|
+
**status:** `Schematic::Types::DataExportStatus`
|
|
18586
19752
|
|
|
18587
19753
|
</dd>
|
|
18588
19754
|
</dl>
|
|
@@ -18590,7 +19756,23 @@ client.components.preview_component_data(
|
|
|
18590
19756
|
<dl>
|
|
18591
19757
|
<dd>
|
|
18592
19758
|
|
|
18593
|
-
**
|
|
19759
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
19760
|
+
|
|
19761
|
+
</dd>
|
|
19762
|
+
</dl>
|
|
19763
|
+
|
|
19764
|
+
<dl>
|
|
19765
|
+
<dd>
|
|
19766
|
+
|
|
19767
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
19768
|
+
|
|
19769
|
+
</dd>
|
|
19770
|
+
</dl>
|
|
19771
|
+
|
|
19772
|
+
<dl>
|
|
19773
|
+
<dd>
|
|
19774
|
+
|
|
19775
|
+
**request_options:** `Schematic::Dataexports::RequestOptions`
|
|
18594
19776
|
|
|
18595
19777
|
</dd>
|
|
18596
19778
|
</dl>
|
|
@@ -18602,8 +19784,7 @@ client.components.preview_component_data(
|
|
|
18602
19784
|
</dl>
|
|
18603
19785
|
</details>
|
|
18604
19786
|
|
|
18605
|
-
|
|
18606
|
-
<details><summary><code>client.planbundle.<a href="/lib/schematic/planbundle/client.rb">create_custom_plan_bundle</a>(request) -> Schematic::Planbundle::Types::CreateCustomPlanBundleResponse</code></summary>
|
|
19787
|
+
<details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">create_data_export</a>(request) -> Schematic::Dataexports::Types::CreateDataExportResponse</code></summary>
|
|
18607
19788
|
<dl>
|
|
18608
19789
|
<dd>
|
|
18609
19790
|
|
|
@@ -18616,18 +19797,9 @@ client.components.preview_component_data(
|
|
|
18616
19797
|
<dd>
|
|
18617
19798
|
|
|
18618
19799
|
```ruby
|
|
18619
|
-
client.
|
|
18620
|
-
|
|
18621
|
-
|
|
18622
|
-
is_trialable: true
|
|
18623
|
-
},
|
|
18624
|
-
entitlements: [{
|
|
18625
|
-
action: "create"
|
|
18626
|
-
}],
|
|
18627
|
-
plan: {
|
|
18628
|
-
company_id: "company_id",
|
|
18629
|
-
name: "name"
|
|
18630
|
-
}
|
|
19800
|
+
client.dataexports.create_data_export(
|
|
19801
|
+
export_type: "audit-log",
|
|
19802
|
+
output_file_type: "csv"
|
|
18631
19803
|
)
|
|
18632
19804
|
```
|
|
18633
19805
|
</dd>
|
|
@@ -18643,23 +19815,7 @@ client.planbundle.create_custom_plan_bundle(
|
|
|
18643
19815
|
<dl>
|
|
18644
19816
|
<dd>
|
|
18645
19817
|
|
|
18646
|
-
**
|
|
18647
|
-
|
|
18648
|
-
</dd>
|
|
18649
|
-
</dl>
|
|
18650
|
-
|
|
18651
|
-
<dl>
|
|
18652
|
-
<dd>
|
|
18653
|
-
|
|
18654
|
-
**credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
|
|
18655
|
-
|
|
18656
|
-
</dd>
|
|
18657
|
-
</dl>
|
|
18658
|
-
|
|
18659
|
-
<dl>
|
|
18660
|
-
<dd>
|
|
18661
|
-
|
|
18662
|
-
**entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
|
|
19818
|
+
**export_type:** `Schematic::Types::DataExportType`
|
|
18663
19819
|
|
|
18664
19820
|
</dd>
|
|
18665
19821
|
</dl>
|
|
@@ -18667,7 +19823,7 @@ client.planbundle.create_custom_plan_bundle(
|
|
|
18667
19823
|
<dl>
|
|
18668
19824
|
<dd>
|
|
18669
19825
|
|
|
18670
|
-
**
|
|
19826
|
+
**metadata:** `Schematic::Types::DataExportMetadata`
|
|
18671
19827
|
|
|
18672
19828
|
</dd>
|
|
18673
19829
|
</dl>
|
|
@@ -18675,7 +19831,7 @@ client.planbundle.create_custom_plan_bundle(
|
|
|
18675
19831
|
<dl>
|
|
18676
19832
|
<dd>
|
|
18677
19833
|
|
|
18678
|
-
**
|
|
19834
|
+
**output_file_type:** `Schematic::Types::DataExportOutputFileType`
|
|
18679
19835
|
|
|
18680
19836
|
</dd>
|
|
18681
19837
|
</dl>
|
|
@@ -18683,7 +19839,7 @@ client.planbundle.create_custom_plan_bundle(
|
|
|
18683
19839
|
<dl>
|
|
18684
19840
|
<dd>
|
|
18685
19841
|
|
|
18686
|
-
**request_options:** `Schematic::
|
|
19842
|
+
**request_options:** `Schematic::Dataexports::RequestOptions`
|
|
18687
19843
|
|
|
18688
19844
|
</dd>
|
|
18689
19845
|
</dl>
|
|
@@ -18695,7 +19851,7 @@ client.planbundle.create_custom_plan_bundle(
|
|
|
18695
19851
|
</dl>
|
|
18696
19852
|
</details>
|
|
18697
19853
|
|
|
18698
|
-
<details><summary><code>client.
|
|
19854
|
+
<details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">get_data_export</a>(data_export_id:) -> Schematic::Dataexports::Types::GetDataExportResponse</code></summary>
|
|
18699
19855
|
<dl>
|
|
18700
19856
|
<dd>
|
|
18701
19857
|
|
|
@@ -18708,15 +19864,7 @@ client.planbundle.create_custom_plan_bundle(
|
|
|
18708
19864
|
<dd>
|
|
18709
19865
|
|
|
18710
19866
|
```ruby
|
|
18711
|
-
client.
|
|
18712
|
-
entitlements: [{
|
|
18713
|
-
action: "create"
|
|
18714
|
-
}],
|
|
18715
|
-
plan: {
|
|
18716
|
-
name: "name",
|
|
18717
|
-
plan_type: "plan"
|
|
18718
|
-
}
|
|
18719
|
-
)
|
|
19867
|
+
client.dataexports.get_data_export(data_export_id: "data_export_id")
|
|
18720
19868
|
```
|
|
18721
19869
|
</dd>
|
|
18722
19870
|
</dl>
|
|
@@ -18731,39 +19879,7 @@ client.planbundle.create_plan_bundle(
|
|
|
18731
19879
|
<dl>
|
|
18732
19880
|
<dd>
|
|
18733
19881
|
|
|
18734
|
-
**
|
|
18735
|
-
|
|
18736
|
-
</dd>
|
|
18737
|
-
</dl>
|
|
18738
|
-
|
|
18739
|
-
<dl>
|
|
18740
|
-
<dd>
|
|
18741
|
-
|
|
18742
|
-
**credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
|
|
18743
|
-
|
|
18744
|
-
</dd>
|
|
18745
|
-
</dl>
|
|
18746
|
-
|
|
18747
|
-
<dl>
|
|
18748
|
-
<dd>
|
|
18749
|
-
|
|
18750
|
-
**entitlements:** `Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody]`
|
|
18751
|
-
|
|
18752
|
-
</dd>
|
|
18753
|
-
</dl>
|
|
18754
|
-
|
|
18755
|
-
<dl>
|
|
18756
|
-
<dd>
|
|
18757
|
-
|
|
18758
|
-
**plan:** `Schematic::Types::CreatePlanRequestBody`
|
|
18759
|
-
|
|
18760
|
-
</dd>
|
|
18761
|
-
</dl>
|
|
18762
|
-
|
|
18763
|
-
<dl>
|
|
18764
|
-
<dd>
|
|
18765
|
-
|
|
18766
|
-
**renewal_policy:** `Schematic::Types::RenewalPolicy`
|
|
19882
|
+
**data_export_id:** `String` — data_export_id
|
|
18767
19883
|
|
|
18768
19884
|
</dd>
|
|
18769
19885
|
</dl>
|
|
@@ -18771,7 +19887,7 @@ client.planbundle.create_plan_bundle(
|
|
|
18771
19887
|
<dl>
|
|
18772
19888
|
<dd>
|
|
18773
19889
|
|
|
18774
|
-
**request_options:** `Schematic::
|
|
19890
|
+
**request_options:** `Schematic::Dataexports::RequestOptions`
|
|
18775
19891
|
|
|
18776
19892
|
</dd>
|
|
18777
19893
|
</dl>
|
|
@@ -18783,7 +19899,7 @@ client.planbundle.create_plan_bundle(
|
|
|
18783
19899
|
</dl>
|
|
18784
19900
|
</details>
|
|
18785
19901
|
|
|
18786
|
-
<details><summary><code>client.
|
|
19902
|
+
<details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">get_data_export_artifact</a>(data_export_id:) -> String</code></summary>
|
|
18787
19903
|
<dl>
|
|
18788
19904
|
<dd>
|
|
18789
19905
|
|
|
@@ -18796,15 +19912,7 @@ client.planbundle.create_plan_bundle(
|
|
|
18796
19912
|
<dd>
|
|
18797
19913
|
|
|
18798
19914
|
```ruby
|
|
18799
|
-
client.
|
|
18800
|
-
plan_id: "plan_id",
|
|
18801
|
-
entitlements: [{
|
|
18802
|
-
action: "create"
|
|
18803
|
-
}],
|
|
18804
|
-
plan: {
|
|
18805
|
-
name: "name"
|
|
18806
|
-
}
|
|
18807
|
-
)
|
|
19915
|
+
client.dataexports.get_data_export_artifact(data_export_id: "data_export_id")
|
|
18808
19916
|
```
|
|
18809
19917
|
</dd>
|
|
18810
19918
|
</dl>
|
|
@@ -18819,7 +19927,7 @@ client.planbundle.update_plan_bundle(
|
|
|
18819
19927
|
<dl>
|
|
18820
19928
|
<dd>
|
|
18821
19929
|
|
|
18822
|
-
**
|
|
19930
|
+
**data_export_id:** `String` — data_export_id
|
|
18823
19931
|
|
|
18824
19932
|
</dd>
|
|
18825
19933
|
</dl>
|
|
@@ -18827,47 +19935,50 @@ client.planbundle.update_plan_bundle(
|
|
|
18827
19935
|
<dl>
|
|
18828
19936
|
<dd>
|
|
18829
19937
|
|
|
18830
|
-
**
|
|
19938
|
+
**request_options:** `Schematic::Dataexports::RequestOptions`
|
|
18831
19939
|
|
|
18832
19940
|
</dd>
|
|
18833
19941
|
</dl>
|
|
19942
|
+
</dd>
|
|
19943
|
+
</dl>
|
|
18834
19944
|
|
|
18835
|
-
<dl>
|
|
18836
|
-
<dd>
|
|
18837
19945
|
|
|
18838
|
-
**credit_grants:** `Internal::Types::Array[Schematic::Types::PlanBundleCreditGrantRequestBody]`
|
|
18839
|
-
|
|
18840
19946
|
</dd>
|
|
18841
19947
|
</dl>
|
|
19948
|
+
</details>
|
|
18842
19949
|
|
|
19950
|
+
## events
|
|
19951
|
+
<details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">create_event_batch</a>(request) -> Schematic::Events::Types::CreateEventBatchResponse</code></summary>
|
|
18843
19952
|
<dl>
|
|
18844
19953
|
<dd>
|
|
18845
19954
|
|
|
18846
|
-
|
|
18847
|
-
|
|
18848
|
-
</dd>
|
|
18849
|
-
</dl>
|
|
19955
|
+
#### 🔌 Usage
|
|
18850
19956
|
|
|
18851
19957
|
<dl>
|
|
18852
19958
|
<dd>
|
|
18853
19959
|
|
|
18854
|
-
**plan:** `Schematic::Types::UpdatePlanRequestBody`
|
|
18855
|
-
|
|
18856
|
-
</dd>
|
|
18857
|
-
</dl>
|
|
18858
|
-
|
|
18859
19960
|
<dl>
|
|
18860
19961
|
<dd>
|
|
18861
19962
|
|
|
18862
|
-
|
|
18863
|
-
|
|
19963
|
+
```ruby
|
|
19964
|
+
client.events.create_event_batch(events: [{
|
|
19965
|
+
event_type: "flag_check"
|
|
19966
|
+
}])
|
|
19967
|
+
```
|
|
19968
|
+
</dd>
|
|
19969
|
+
</dl>
|
|
18864
19970
|
</dd>
|
|
18865
19971
|
</dl>
|
|
18866
19972
|
|
|
19973
|
+
#### ⚙️ Parameters
|
|
19974
|
+
|
|
18867
19975
|
<dl>
|
|
18868
19976
|
<dd>
|
|
18869
19977
|
|
|
18870
|
-
|
|
19978
|
+
<dl>
|
|
19979
|
+
<dd>
|
|
19980
|
+
|
|
19981
|
+
**events:** `Internal::Types::Array[Schematic::Types::CreateEventRequestBody]`
|
|
18871
19982
|
|
|
18872
19983
|
</dd>
|
|
18873
19984
|
</dl>
|
|
@@ -18875,7 +19986,7 @@ client.planbundle.update_plan_bundle(
|
|
|
18875
19986
|
<dl>
|
|
18876
19987
|
<dd>
|
|
18877
19988
|
|
|
18878
|
-
**request_options:** `Schematic::
|
|
19989
|
+
**request_options:** `Schematic::Events::RequestOptions`
|
|
18879
19990
|
|
|
18880
19991
|
</dd>
|
|
18881
19992
|
</dl>
|
|
@@ -18887,8 +19998,7 @@ client.planbundle.update_plan_bundle(
|
|
|
18887
19998
|
</dl>
|
|
18888
19999
|
</details>
|
|
18889
20000
|
|
|
18890
|
-
|
|
18891
|
-
<details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">list_data_exports</a>() -> Schematic::Dataexports::Types::ListDataExportsResponse</code></summary>
|
|
20001
|
+
<details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">get_event_summaries</a>() -> Schematic::Events::Types::GetEventSummariesResponse</code></summary>
|
|
18892
20002
|
<dl>
|
|
18893
20003
|
<dd>
|
|
18894
20004
|
|
|
@@ -18901,9 +20011,9 @@ client.planbundle.update_plan_bundle(
|
|
|
18901
20011
|
<dd>
|
|
18902
20012
|
|
|
18903
20013
|
```ruby
|
|
18904
|
-
client.
|
|
18905
|
-
|
|
18906
|
-
|
|
20014
|
+
client.events.get_event_summaries(
|
|
20015
|
+
q: "q",
|
|
20016
|
+
event_subtypes: ["event_subtypes"],
|
|
18907
20017
|
limit: 1000000,
|
|
18908
20018
|
offset: 1000000
|
|
18909
20019
|
)
|
|
@@ -18921,7 +20031,7 @@ client.dataexports.list_data_exports(
|
|
|
18921
20031
|
<dl>
|
|
18922
20032
|
<dd>
|
|
18923
20033
|
|
|
18924
|
-
**
|
|
20034
|
+
**q:** `String`
|
|
18925
20035
|
|
|
18926
20036
|
</dd>
|
|
18927
20037
|
</dl>
|
|
@@ -18929,7 +20039,7 @@ client.dataexports.list_data_exports(
|
|
|
18929
20039
|
<dl>
|
|
18930
20040
|
<dd>
|
|
18931
20041
|
|
|
18932
|
-
**
|
|
20042
|
+
**event_subtypes:** `String`
|
|
18933
20043
|
|
|
18934
20044
|
</dd>
|
|
18935
20045
|
</dl>
|
|
@@ -18953,7 +20063,7 @@ client.dataexports.list_data_exports(
|
|
|
18953
20063
|
<dl>
|
|
18954
20064
|
<dd>
|
|
18955
20065
|
|
|
18956
|
-
**request_options:** `Schematic::
|
|
20066
|
+
**request_options:** `Schematic::Events::RequestOptions`
|
|
18957
20067
|
|
|
18958
20068
|
</dd>
|
|
18959
20069
|
</dl>
|
|
@@ -18965,7 +20075,7 @@ client.dataexports.list_data_exports(
|
|
|
18965
20075
|
</dl>
|
|
18966
20076
|
</details>
|
|
18967
20077
|
|
|
18968
|
-
<details><summary><code>client.
|
|
20078
|
+
<details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">list_events</a>() -> Schematic::Events::Types::ListEventsResponse</code></summary>
|
|
18969
20079
|
<dl>
|
|
18970
20080
|
<dd>
|
|
18971
20081
|
|
|
@@ -18978,9 +20088,15 @@ client.dataexports.list_data_exports(
|
|
|
18978
20088
|
<dd>
|
|
18979
20089
|
|
|
18980
20090
|
```ruby
|
|
18981
|
-
client.
|
|
18982
|
-
|
|
18983
|
-
|
|
20091
|
+
client.events.list_events(
|
|
20092
|
+
company_id: "company_id",
|
|
20093
|
+
event_subtype: "event_subtype",
|
|
20094
|
+
event_types: ["flag_check"],
|
|
20095
|
+
flag_id: "flag_id",
|
|
20096
|
+
idempotency_key: "idempotency_key",
|
|
20097
|
+
user_id: "user_id",
|
|
20098
|
+
limit: 1000000,
|
|
20099
|
+
offset: 1000000
|
|
18984
20100
|
)
|
|
18985
20101
|
```
|
|
18986
20102
|
</dd>
|
|
@@ -18996,7 +20112,7 @@ client.dataexports.create_data_export(
|
|
|
18996
20112
|
<dl>
|
|
18997
20113
|
<dd>
|
|
18998
20114
|
|
|
18999
|
-
**
|
|
20115
|
+
**company_id:** `String`
|
|
19000
20116
|
|
|
19001
20117
|
</dd>
|
|
19002
20118
|
</dl>
|
|
@@ -19004,7 +20120,7 @@ client.dataexports.create_data_export(
|
|
|
19004
20120
|
<dl>
|
|
19005
20121
|
<dd>
|
|
19006
20122
|
|
|
19007
|
-
**
|
|
20123
|
+
**event_subtype:** `String`
|
|
19008
20124
|
|
|
19009
20125
|
</dd>
|
|
19010
20126
|
</dl>
|
|
@@ -19012,7 +20128,7 @@ client.dataexports.create_data_export(
|
|
|
19012
20128
|
<dl>
|
|
19013
20129
|
<dd>
|
|
19014
20130
|
|
|
19015
|
-
**
|
|
20131
|
+
**event_types:** `Schematic::Types::EventType`
|
|
19016
20132
|
|
|
19017
20133
|
</dd>
|
|
19018
20134
|
</dl>
|
|
@@ -19020,47 +20136,39 @@ client.dataexports.create_data_export(
|
|
|
19020
20136
|
<dl>
|
|
19021
20137
|
<dd>
|
|
19022
20138
|
|
|
19023
|
-
**
|
|
20139
|
+
**flag_id:** `String`
|
|
19024
20140
|
|
|
19025
20141
|
</dd>
|
|
19026
20142
|
</dl>
|
|
19027
|
-
</dd>
|
|
19028
|
-
</dl>
|
|
19029
20143
|
|
|
20144
|
+
<dl>
|
|
20145
|
+
<dd>
|
|
19030
20146
|
|
|
20147
|
+
**idempotency_key:** `String`
|
|
20148
|
+
|
|
19031
20149
|
</dd>
|
|
19032
20150
|
</dl>
|
|
19033
|
-
</details>
|
|
19034
20151
|
|
|
19035
|
-
<details><summary><code>client.dataexports.<a href="/lib/schematic/dataexports/client.rb">get_data_export</a>(data_export_id:) -> Schematic::Dataexports::Types::GetDataExportResponse</code></summary>
|
|
19036
20152
|
<dl>
|
|
19037
20153
|
<dd>
|
|
19038
20154
|
|
|
19039
|
-
|
|
19040
|
-
|
|
19041
|
-
|
|
19042
|
-
|
|
20155
|
+
**user_id:** `String`
|
|
20156
|
+
|
|
20157
|
+
</dd>
|
|
20158
|
+
</dl>
|
|
19043
20159
|
|
|
19044
20160
|
<dl>
|
|
19045
20161
|
<dd>
|
|
19046
20162
|
|
|
19047
|
-
|
|
19048
|
-
|
|
19049
|
-
```
|
|
19050
|
-
</dd>
|
|
19051
|
-
</dl>
|
|
20163
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
20164
|
+
|
|
19052
20165
|
</dd>
|
|
19053
20166
|
</dl>
|
|
19054
20167
|
|
|
19055
|
-
#### ⚙️ Parameters
|
|
19056
|
-
|
|
19057
|
-
<dl>
|
|
19058
|
-
<dd>
|
|
19059
|
-
|
|
19060
20168
|
<dl>
|
|
19061
20169
|
<dd>
|
|
19062
20170
|
|
|
19063
|
-
**
|
|
20171
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
19064
20172
|
|
|
19065
20173
|
</dd>
|
|
19066
20174
|
</dl>
|
|
@@ -19068,7 +20176,7 @@ client.dataexports.get_data_export(data_export_id: "data_export_id")
|
|
|
19068
20176
|
<dl>
|
|
19069
20177
|
<dd>
|
|
19070
20178
|
|
|
19071
|
-
**request_options:** `Schematic::
|
|
20179
|
+
**request_options:** `Schematic::Events::RequestOptions`
|
|
19072
20180
|
|
|
19073
20181
|
</dd>
|
|
19074
20182
|
</dl>
|
|
@@ -19080,7 +20188,7 @@ client.dataexports.get_data_export(data_export_id: "data_export_id")
|
|
|
19080
20188
|
</dl>
|
|
19081
20189
|
</details>
|
|
19082
20190
|
|
|
19083
|
-
<details><summary><code>client.
|
|
20191
|
+
<details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">create_event</a>(request) -> Schematic::Events::Types::CreateEventResponse</code></summary>
|
|
19084
20192
|
<dl>
|
|
19085
20193
|
<dd>
|
|
19086
20194
|
|
|
@@ -19093,7 +20201,7 @@ client.dataexports.get_data_export(data_export_id: "data_export_id")
|
|
|
19093
20201
|
<dd>
|
|
19094
20202
|
|
|
19095
20203
|
```ruby
|
|
19096
|
-
client.
|
|
20204
|
+
client.events.create_event(event_type: "flag_check")
|
|
19097
20205
|
```
|
|
19098
20206
|
</dd>
|
|
19099
20207
|
</dl>
|
|
@@ -19108,7 +20216,7 @@ client.dataexports.get_data_export_artifact(data_export_id: "data_export_id")
|
|
|
19108
20216
|
<dl>
|
|
19109
20217
|
<dd>
|
|
19110
20218
|
|
|
19111
|
-
**
|
|
20219
|
+
**request:** `Schematic::Types::CreateEventRequestBody`
|
|
19112
20220
|
|
|
19113
20221
|
</dd>
|
|
19114
20222
|
</dl>
|
|
@@ -19116,7 +20224,7 @@ client.dataexports.get_data_export_artifact(data_export_id: "data_export_id")
|
|
|
19116
20224
|
<dl>
|
|
19117
20225
|
<dd>
|
|
19118
20226
|
|
|
19119
|
-
**request_options:** `Schematic::
|
|
20227
|
+
**request_options:** `Schematic::Events::RequestOptions`
|
|
19120
20228
|
|
|
19121
20229
|
</dd>
|
|
19122
20230
|
</dl>
|
|
@@ -19128,8 +20236,7 @@ client.dataexports.get_data_export_artifact(data_export_id: "data_export_id")
|
|
|
19128
20236
|
</dl>
|
|
19129
20237
|
</details>
|
|
19130
20238
|
|
|
19131
|
-
|
|
19132
|
-
<details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">create_event_batch</a>(request) -> Schematic::Events::Types::CreateEventBatchResponse</code></summary>
|
|
20239
|
+
<details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">get_event</a>(event_id:) -> Schematic::Events::Types::GetEventResponse</code></summary>
|
|
19133
20240
|
<dl>
|
|
19134
20241
|
<dd>
|
|
19135
20242
|
|
|
@@ -19142,9 +20249,7 @@ client.dataexports.get_data_export_artifact(data_export_id: "data_export_id")
|
|
|
19142
20249
|
<dd>
|
|
19143
20250
|
|
|
19144
20251
|
```ruby
|
|
19145
|
-
client.events.
|
|
19146
|
-
event_type: "flag_check"
|
|
19147
|
-
}])
|
|
20252
|
+
client.events.get_event(event_id: "event_id")
|
|
19148
20253
|
```
|
|
19149
20254
|
</dd>
|
|
19150
20255
|
</dl>
|
|
@@ -19159,7 +20264,7 @@ client.events.create_event_batch(events: [{
|
|
|
19159
20264
|
<dl>
|
|
19160
20265
|
<dd>
|
|
19161
20266
|
|
|
19162
|
-
**
|
|
20267
|
+
**event_id:** `String` — event_id
|
|
19163
20268
|
|
|
19164
20269
|
</dd>
|
|
19165
20270
|
</dl>
|
|
@@ -19179,7 +20284,7 @@ client.events.create_event_batch(events: [{
|
|
|
19179
20284
|
</dl>
|
|
19180
20285
|
</details>
|
|
19181
20286
|
|
|
19182
|
-
<details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">
|
|
20287
|
+
<details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">list_account_inference_cost_rates</a>() -> Schematic::Events::Types::ListAccountInferenceCostRatesResponse</code></summary>
|
|
19183
20288
|
<dl>
|
|
19184
20289
|
<dd>
|
|
19185
20290
|
|
|
@@ -19192,9 +20297,9 @@ client.events.create_event_batch(events: [{
|
|
|
19192
20297
|
<dd>
|
|
19193
20298
|
|
|
19194
20299
|
```ruby
|
|
19195
|
-
client.events.
|
|
19196
|
-
|
|
19197
|
-
|
|
20300
|
+
client.events.list_account_inference_cost_rates(
|
|
20301
|
+
provider: "provider",
|
|
20302
|
+
response_model: "response_model",
|
|
19198
20303
|
limit: 1000000,
|
|
19199
20304
|
offset: 1000000
|
|
19200
20305
|
)
|
|
@@ -19212,7 +20317,7 @@ client.events.get_event_summaries(
|
|
|
19212
20317
|
<dl>
|
|
19213
20318
|
<dd>
|
|
19214
20319
|
|
|
19215
|
-
**
|
|
20320
|
+
**provider:** `String`
|
|
19216
20321
|
|
|
19217
20322
|
</dd>
|
|
19218
20323
|
</dl>
|
|
@@ -19220,7 +20325,7 @@ client.events.get_event_summaries(
|
|
|
19220
20325
|
<dl>
|
|
19221
20326
|
<dd>
|
|
19222
20327
|
|
|
19223
|
-
**
|
|
20328
|
+
**response_model:** `String`
|
|
19224
20329
|
|
|
19225
20330
|
</dd>
|
|
19226
20331
|
</dl>
|
|
@@ -19256,7 +20361,7 @@ client.events.get_event_summaries(
|
|
|
19256
20361
|
</dl>
|
|
19257
20362
|
</details>
|
|
19258
20363
|
|
|
19259
|
-
<details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">
|
|
20364
|
+
<details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">create_account_inference_cost_rate</a>(request) -> Schematic::Events::Types::CreateAccountInferenceCostRateResponse</code></summary>
|
|
19260
20365
|
<dl>
|
|
19261
20366
|
<dd>
|
|
19262
20367
|
|
|
@@ -19269,15 +20374,13 @@ client.events.get_event_summaries(
|
|
|
19269
20374
|
<dd>
|
|
19270
20375
|
|
|
19271
20376
|
```ruby
|
|
19272
|
-
client.events.
|
|
19273
|
-
|
|
19274
|
-
|
|
19275
|
-
|
|
19276
|
-
|
|
19277
|
-
|
|
19278
|
-
|
|
19279
|
-
limit: 1000000,
|
|
19280
|
-
offset: 1000000
|
|
20377
|
+
client.events.create_account_inference_cost_rate(
|
|
20378
|
+
provider: "provider",
|
|
20379
|
+
rates: {
|
|
20380
|
+
key: 1.1
|
|
20381
|
+
},
|
|
20382
|
+
response_model: "response_model",
|
|
20383
|
+
starting_at: "2024-01-15T09:30:00Z"
|
|
19281
20384
|
)
|
|
19282
20385
|
```
|
|
19283
20386
|
</dd>
|
|
@@ -19293,31 +20396,7 @@ client.events.list_events(
|
|
|
19293
20396
|
<dl>
|
|
19294
20397
|
<dd>
|
|
19295
20398
|
|
|
19296
|
-
**
|
|
19297
|
-
|
|
19298
|
-
</dd>
|
|
19299
|
-
</dl>
|
|
19300
|
-
|
|
19301
|
-
<dl>
|
|
19302
|
-
<dd>
|
|
19303
|
-
|
|
19304
|
-
**event_subtype:** `String`
|
|
19305
|
-
|
|
19306
|
-
</dd>
|
|
19307
|
-
</dl>
|
|
19308
|
-
|
|
19309
|
-
<dl>
|
|
19310
|
-
<dd>
|
|
19311
|
-
|
|
19312
|
-
**event_types:** `Schematic::Types::EventType`
|
|
19313
|
-
|
|
19314
|
-
</dd>
|
|
19315
|
-
</dl>
|
|
19316
|
-
|
|
19317
|
-
<dl>
|
|
19318
|
-
<dd>
|
|
19319
|
-
|
|
19320
|
-
**flag_id:** `String`
|
|
20399
|
+
**currency:** `String` — Three-letter currency code the rates are in, matched against the event's currency. Defaults to usd.
|
|
19321
20400
|
|
|
19322
20401
|
</dd>
|
|
19323
20402
|
</dl>
|
|
@@ -19325,7 +20404,7 @@ client.events.list_events(
|
|
|
19325
20404
|
<dl>
|
|
19326
20405
|
<dd>
|
|
19327
20406
|
|
|
19328
|
-
**
|
|
20407
|
+
**provider:** `String` — Provider the event reports, such as anthropic or openai. Matched case-insensitively.
|
|
19329
20408
|
|
|
19330
20409
|
</dd>
|
|
19331
20410
|
</dl>
|
|
@@ -19333,7 +20412,7 @@ client.events.list_events(
|
|
|
19333
20412
|
<dl>
|
|
19334
20413
|
<dd>
|
|
19335
20414
|
|
|
19336
|
-
**
|
|
20415
|
+
**rates:** `Internal::Types::Hash[String, Float]` — Cost of a single token in the row's currency, keyed by input_tokens, cached_input_tokens, cache_creation_input_tokens and output_tokens. input_tokens prices only the input left after the cached and cache-creation subsets, and output_tokens includes reasoning.
|
|
19337
20416
|
|
|
19338
20417
|
</dd>
|
|
19339
20418
|
</dl>
|
|
@@ -19341,7 +20420,7 @@ client.events.list_events(
|
|
|
19341
20420
|
<dl>
|
|
19342
20421
|
<dd>
|
|
19343
20422
|
|
|
19344
|
-
**
|
|
20423
|
+
**response_model:** `String` — Model the response reports. A dated snapshot such as claude-sonnet-4-5-20250929 falls back to the undated name when the sheet has no row for the dated one.
|
|
19345
20424
|
|
|
19346
20425
|
</dd>
|
|
19347
20426
|
</dl>
|
|
@@ -19349,7 +20428,7 @@ client.events.list_events(
|
|
|
19349
20428
|
<dl>
|
|
19350
20429
|
<dd>
|
|
19351
20430
|
|
|
19352
|
-
**
|
|
20431
|
+
**starting_at:** `String` — When the rate takes effect. It applies to events captured from then until the next row for the same provider, model and currency.
|
|
19353
20432
|
|
|
19354
20433
|
</dd>
|
|
19355
20434
|
</dl>
|
|
@@ -19369,7 +20448,7 @@ client.events.list_events(
|
|
|
19369
20448
|
</dl>
|
|
19370
20449
|
</details>
|
|
19371
20450
|
|
|
19372
|
-
<details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">
|
|
20451
|
+
<details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">update_account_inference_cost_rate</a>(inference_rate_sheet_id:, request) -> Schematic::Events::Types::UpdateAccountInferenceCostRateResponse</code></summary>
|
|
19373
20452
|
<dl>
|
|
19374
20453
|
<dd>
|
|
19375
20454
|
|
|
@@ -19382,7 +20461,12 @@ client.events.list_events(
|
|
|
19382
20461
|
<dd>
|
|
19383
20462
|
|
|
19384
20463
|
```ruby
|
|
19385
|
-
client.events.
|
|
20464
|
+
client.events.update_account_inference_cost_rate(
|
|
20465
|
+
inference_rate_sheet_id: "inference_rate_sheet_id",
|
|
20466
|
+
rates: {
|
|
20467
|
+
key: 1.1
|
|
20468
|
+
}
|
|
20469
|
+
)
|
|
19386
20470
|
```
|
|
19387
20471
|
</dd>
|
|
19388
20472
|
</dl>
|
|
@@ -19397,7 +20481,15 @@ client.events.create_event(event_type: "flag_check")
|
|
|
19397
20481
|
<dl>
|
|
19398
20482
|
<dd>
|
|
19399
20483
|
|
|
19400
|
-
**
|
|
20484
|
+
**inference_rate_sheet_id:** `String` — inference_rate_sheet_id
|
|
20485
|
+
|
|
20486
|
+
</dd>
|
|
20487
|
+
</dl>
|
|
20488
|
+
|
|
20489
|
+
<dl>
|
|
20490
|
+
<dd>
|
|
20491
|
+
|
|
20492
|
+
**rates:** `Internal::Types::Hash[String, Float]` — Cost of a single token in the row's currency, keyed by input_tokens, cached_input_tokens, cache_creation_input_tokens and output_tokens. input_tokens prices only the input left after the cached and cache-creation subsets, and output_tokens includes reasoning.
|
|
19401
20493
|
|
|
19402
20494
|
</dd>
|
|
19403
20495
|
</dl>
|
|
@@ -19417,7 +20509,7 @@ client.events.create_event(event_type: "flag_check")
|
|
|
19417
20509
|
</dl>
|
|
19418
20510
|
</details>
|
|
19419
20511
|
|
|
19420
|
-
<details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">
|
|
20512
|
+
<details><summary><code>client.events.<a href="/lib/schematic/events/client.rb">delete_account_inference_cost_rate</a>(inference_rate_sheet_id:) -> Schematic::Events::Types::DeleteAccountInferenceCostRateResponse</code></summary>
|
|
19421
20513
|
<dl>
|
|
19422
20514
|
<dd>
|
|
19423
20515
|
|
|
@@ -19430,7 +20522,7 @@ client.events.create_event(event_type: "flag_check")
|
|
|
19430
20522
|
<dd>
|
|
19431
20523
|
|
|
19432
20524
|
```ruby
|
|
19433
|
-
client.events.
|
|
20525
|
+
client.events.delete_account_inference_cost_rate(inference_rate_sheet_id: "inference_rate_sheet_id")
|
|
19434
20526
|
```
|
|
19435
20527
|
</dd>
|
|
19436
20528
|
</dl>
|
|
@@ -19445,7 +20537,7 @@ client.events.get_event(event_id: "event_id")
|
|
|
19445
20537
|
<dl>
|
|
19446
20538
|
<dd>
|
|
19447
20539
|
|
|
19448
|
-
**
|
|
20540
|
+
**inference_rate_sheet_id:** `String` — inference_rate_sheet_id
|
|
19449
20541
|
|
|
19450
20542
|
</dd>
|
|
19451
20543
|
</dl>
|