schematichq 1.5.5 → 1.5.6
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/accounts/client.rb +0 -271
- data/lib/schematic/billing/client.rb +40 -16
- data/lib/schematic/billing/types/{count_native_invoices_params.rb → count_billing_invoices_params.rb} +9 -1
- data/lib/schematic/billing/types/{count_native_invoices_request.rb → count_billing_invoices_request.rb} +9 -1
- data/lib/schematic/billing/types/{count_native_invoices_response.rb → count_billing_invoices_response.rb} +2 -2
- data/lib/schematic/billing/types/create_payment_method_request_body.rb +2 -0
- data/lib/schematic/billing/types/{get_native_invoice_response.rb → get_billing_invoice_response.rb} +1 -1
- data/lib/schematic/billing/types/{list_native_invoices_params.rb → list_billing_invoices_params.rb} +9 -1
- data/lib/schematic/billing/types/{list_native_invoices_request.rb → list_billing_invoices_request.rb} +9 -1
- data/lib/schematic/billing/types/{list_native_invoices_response.rb → list_billing_invoices_response.rb} +2 -2
- data/lib/schematic/billing/types/{mark_native_invoice_paid_response.rb → mark_billing_invoice_paid_response.rb} +1 -1
- data/lib/schematic/catalogs/client.rb +82 -0
- data/lib/schematic/{accounts/types/create_api_key_response.rb → catalogs/types/get_public_catalog_by_id_response.rb} +3 -3
- data/lib/schematic/{accounts/types/delete_api_key_response.rb → catalogs/types/get_public_catalog_response.rb} +3 -3
- data/lib/schematic/client.rb +195 -1
- data/lib/schematic/credits/client.rb +48 -0
- data/lib/schematic/credits/types/count_credit_event_ledger_params.rb +2 -0
- data/lib/schematic/credits/types/count_credit_event_ledger_request.rb +2 -0
- data/lib/schematic/{accounts/types/create_environment_response.rb → credits/types/get_credit_event_ledger_entry_response.rb} +3 -3
- data/lib/schematic/credits/types/list_credit_event_ledger_params.rb +2 -0
- data/lib/schematic/credits/types/list_credit_event_ledger_request.rb +2 -0
- data/lib/schematic/planbundle/types/create_custom_plan_bundle_request_body.rb +2 -0
- data/lib/schematic/planbundle/types/create_plan_bundle_request_body.rb +2 -0
- data/lib/schematic/planbundle/types/update_plan_bundle_request_body.rb +2 -0
- data/lib/schematic/plans/types/retry_custom_plan_billing_request_body.rb +2 -0
- data/lib/schematic/types/billing_invoice_address_response_data.rb +19 -0
- data/lib/schematic/types/billing_invoice_billing_details_response_data.rb +15 -0
- data/lib/schematic/types/billing_invoice_detail_response_data.rb +20 -4
- data/lib/schematic/types/billing_invoice_line_response_data.rb +5 -1
- data/lib/schematic/types/billing_invoice_response_data.rb +12 -4
- data/lib/schematic/types/billing_invoice_settlement_response_data.rb +1 -1
- data/lib/schematic/types/billing_invoice_tax_id_response_data.rb +11 -0
- data/lib/schematic/types/billing_invoice_terms_response_data.rb +2 -0
- data/lib/schematic/types/billing_plan_credit_grant_response_data.rb +2 -0
- data/lib/schematic/types/billing_plan_credit_grant_warning_tier_response_data.rb +13 -0
- data/lib/schematic/types/catalog_bundle_currency_price_response_data.rb +13 -0
- data/lib/schematic/types/catalog_capabilities_response_data.rb +11 -0
- data/lib/schematic/types/catalog_credit_bundle_response_data.rb +39 -0
- data/lib/schematic/types/catalog_credit_grant_response_data.rb +29 -0
- data/lib/schematic/types/catalog_currency_prices_response_data.rb +17 -0
- data/lib/schematic/types/catalog_custom_plan_cta_response_data.rb +13 -0
- data/lib/schematic/types/catalog_detail_response_data.rb +23 -0
- data/lib/schematic/types/catalog_entitlement_response_data.rb +61 -0
- data/lib/schematic/types/catalog_plan_entitlement_response_data.rb +63 -0
- data/lib/schematic/types/catalog_plan_response_data.rb +41 -0
- data/lib/schematic/types/catalog_price_response_data.rb +29 -0
- data/lib/schematic/types/catalog_price_tier_response_data.rb +17 -0
- data/lib/schematic/types/checkout_charge_timing.rb +13 -0
- data/lib/schematic/types/checkout_problem_code.rb +4 -0
- data/lib/schematic/types/create_billing_plan_credit_grant_request_body.rb +2 -0
- data/lib/schematic/types/credit_spend_window_unit.rb +2 -0
- data/lib/schematic/types/custom_plan_billing_response_data.rb +2 -0
- data/lib/schematic/types/entitlement_type.rb +1 -0
- data/lib/schematic/types/event_body.rb +3 -3
- data/lib/schematic/types/payment_method_billing_details_request_body.rb +13 -0
- data/lib/schematic/types/plan_credit_grant_warning_tier_request_body.rb +11 -0
- data/lib/schematic/types/plan_version_migration_preview_company_response_data.rb +2 -0
- data/lib/schematic/types/plan_version_migration_preview_note_response_data.rb +13 -0
- data/lib/schematic/types/plan_version_response_data.rb +2 -0
- data/lib/schematic/types/preview_subscription_finance_response_data.rb +6 -0
- data/lib/schematic/types/preview_subscription_proration_line_response_data.rb +21 -0
- data/lib/schematic/types/preview_subscription_proration_response_data.rb +21 -0
- data/lib/schematic/types/proration_line_kind.rb +12 -0
- data/lib/schematic/types/public_catalog_response_data.rb +29 -0
- data/lib/schematic/types/publish_plan_version_request_body.rb +2 -0
- data/lib/schematic/types/publish_preview_response_data.rb +2 -0
- data/lib/schematic/types/renewal_policy.rb +13 -0
- data/lib/schematic/types/update_billing_plan_credit_grant_request_body.rb +2 -0
- data/lib/schematic/types/webhook_request_type.rb +1 -0
- data/lib/schematic/version.rb +1 -1
- data/lib/schematic.rb +38 -22
- data/reference.md +434 -275
- metadata +38 -22
- data/lib/schematic/accounts/types/create_api_key_request_body.rb +0 -19
- data/lib/schematic/accounts/types/create_environment_request_body.rb +0 -13
- data/lib/schematic/accounts/types/delete_environment_response.rb +0 -13
- data/lib/schematic/accounts/types/update_api_key_request_body.rb +0 -17
- data/lib/schematic/accounts/types/update_api_key_response.rb +0 -13
- data/lib/schematic/accounts/types/update_environment_request_body.rb +0 -17
- data/lib/schematic/accounts/types/update_environment_response.rb +0 -13
- data/lib/schematic/types/api_key_create_response_data.rb +0 -33
- data/lib/schematic/types/environment_detail_response_data.rb +0 -21
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">post_api_keys</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.post_api_keys
|
|
16
16
|
```
|
|
17
17
|
</dd>
|
|
18
18
|
</dl>
|
|
@@ -39,8 +39,7 @@ client.get_credit_ledger
|
|
|
39
39
|
</dl>
|
|
40
40
|
</details>
|
|
41
41
|
|
|
42
|
-
|
|
43
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">list_account_members</a>() -> Schematic::Accounts::Types::ListAccountMembersResponse</code></summary>
|
|
42
|
+
<details><summary><code>client.<a href="/lib/schematic/client.rb">put_api_keys_api_key_id</a>(api_key_id:) -> </code></summary>
|
|
44
43
|
<dl>
|
|
45
44
|
<dd>
|
|
46
45
|
|
|
@@ -53,13 +52,7 @@ client.get_credit_ledger
|
|
|
53
52
|
<dd>
|
|
54
53
|
|
|
55
54
|
```ruby
|
|
56
|
-
client.
|
|
57
|
-
ids: ["ids"],
|
|
58
|
-
q: "q",
|
|
59
|
-
role: "admin",
|
|
60
|
-
limit: 1000000,
|
|
61
|
-
offset: 1000000
|
|
62
|
-
)
|
|
55
|
+
client.put_api_keys_api_key_id(api_key_id: "api_key_id")
|
|
63
56
|
```
|
|
64
57
|
</dd>
|
|
65
58
|
</dl>
|
|
@@ -74,15 +67,7 @@ client.accounts.list_account_members(
|
|
|
74
67
|
<dl>
|
|
75
68
|
<dd>
|
|
76
69
|
|
|
77
|
-
**
|
|
78
|
-
|
|
79
|
-
</dd>
|
|
80
|
-
</dl>
|
|
81
|
-
|
|
82
|
-
<dl>
|
|
83
|
-
<dd>
|
|
84
|
-
|
|
85
|
-
**q:** `String` — Search filter
|
|
70
|
+
**api_key_id:** `String`
|
|
86
71
|
|
|
87
72
|
</dd>
|
|
88
73
|
</dl>
|
|
@@ -90,31 +75,7 @@ client.accounts.list_account_members(
|
|
|
90
75
|
<dl>
|
|
91
76
|
<dd>
|
|
92
77
|
|
|
93
|
-
**
|
|
94
|
-
|
|
95
|
-
</dd>
|
|
96
|
-
</dl>
|
|
97
|
-
|
|
98
|
-
<dl>
|
|
99
|
-
<dd>
|
|
100
|
-
|
|
101
|
-
**limit:** `Integer` — Page limit (default 100)
|
|
102
|
-
|
|
103
|
-
</dd>
|
|
104
|
-
</dl>
|
|
105
|
-
|
|
106
|
-
<dl>
|
|
107
|
-
<dd>
|
|
108
|
-
|
|
109
|
-
**offset:** `Integer` — Page offset (default 0)
|
|
110
|
-
|
|
111
|
-
</dd>
|
|
112
|
-
</dl>
|
|
113
|
-
|
|
114
|
-
<dl>
|
|
115
|
-
<dd>
|
|
116
|
-
|
|
117
|
-
**request_options:** `Schematic::Accounts::RequestOptions`
|
|
78
|
+
**request_options:** `Schematic::RequestOptions`
|
|
118
79
|
|
|
119
80
|
</dd>
|
|
120
81
|
</dl>
|
|
@@ -126,7 +87,7 @@ client.accounts.list_account_members(
|
|
|
126
87
|
</dl>
|
|
127
88
|
</details>
|
|
128
89
|
|
|
129
|
-
<details><summary><code>client
|
|
90
|
+
<details><summary><code>client.<a href="/lib/schematic/client.rb">delete_api_keys_api_key_id</a>(api_key_id:) -> </code></summary>
|
|
130
91
|
<dl>
|
|
131
92
|
<dd>
|
|
132
93
|
|
|
@@ -139,7 +100,7 @@ client.accounts.list_account_members(
|
|
|
139
100
|
<dd>
|
|
140
101
|
|
|
141
102
|
```ruby
|
|
142
|
-
client.
|
|
103
|
+
client.delete_api_keys_api_key_id(api_key_id: "api_key_id")
|
|
143
104
|
```
|
|
144
105
|
</dd>
|
|
145
106
|
</dl>
|
|
@@ -154,7 +115,7 @@ client.accounts.get_account_member(account_member_id: "account_member_id")
|
|
|
154
115
|
<dl>
|
|
155
116
|
<dd>
|
|
156
117
|
|
|
157
|
-
**
|
|
118
|
+
**api_key_id:** `String`
|
|
158
119
|
|
|
159
120
|
</dd>
|
|
160
121
|
</dl>
|
|
@@ -162,7 +123,7 @@ client.accounts.get_account_member(account_member_id: "account_member_id")
|
|
|
162
123
|
<dl>
|
|
163
124
|
<dd>
|
|
164
125
|
|
|
165
|
-
**request_options:** `Schematic::
|
|
126
|
+
**request_options:** `Schematic::RequestOptions`
|
|
166
127
|
|
|
167
128
|
</dd>
|
|
168
129
|
</dl>
|
|
@@ -174,7 +135,7 @@ client.accounts.get_account_member(account_member_id: "account_member_id")
|
|
|
174
135
|
</dl>
|
|
175
136
|
</details>
|
|
176
137
|
|
|
177
|
-
<details><summary><code>client
|
|
138
|
+
<details><summary><code>client.<a href="/lib/schematic/client.rb">post_environments</a>() -> </code></summary>
|
|
178
139
|
<dl>
|
|
179
140
|
<dd>
|
|
180
141
|
|
|
@@ -187,13 +148,7 @@ client.accounts.get_account_member(account_member_id: "account_member_id")
|
|
|
187
148
|
<dd>
|
|
188
149
|
|
|
189
150
|
```ruby
|
|
190
|
-
client.
|
|
191
|
-
ids: ["ids"],
|
|
192
|
-
q: "q",
|
|
193
|
-
role: "admin",
|
|
194
|
-
limit: 1000000,
|
|
195
|
-
offset: 1000000
|
|
196
|
-
)
|
|
151
|
+
client.post_environments
|
|
197
152
|
```
|
|
198
153
|
</dd>
|
|
199
154
|
</dl>
|
|
@@ -208,39 +163,47 @@ client.accounts.count_account_members(
|
|
|
208
163
|
<dl>
|
|
209
164
|
<dd>
|
|
210
165
|
|
|
211
|
-
**
|
|
166
|
+
**request_options:** `Schematic::RequestOptions`
|
|
212
167
|
|
|
213
168
|
</dd>
|
|
214
169
|
</dl>
|
|
170
|
+
</dd>
|
|
171
|
+
</dl>
|
|
215
172
|
|
|
216
|
-
<dl>
|
|
217
|
-
<dd>
|
|
218
173
|
|
|
219
|
-
**q:** `String` — Search filter
|
|
220
|
-
|
|
221
174
|
</dd>
|
|
222
175
|
</dl>
|
|
176
|
+
</details>
|
|
223
177
|
|
|
178
|
+
<details><summary><code>client.<a href="/lib/schematic/client.rb">put_environments_environment_id</a>(environment_id:) -> </code></summary>
|
|
224
179
|
<dl>
|
|
225
180
|
<dd>
|
|
226
181
|
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
</dd>
|
|
230
|
-
</dl>
|
|
182
|
+
#### 🔌 Usage
|
|
231
183
|
|
|
232
184
|
<dl>
|
|
233
185
|
<dd>
|
|
234
186
|
|
|
235
|
-
|
|
236
|
-
|
|
187
|
+
<dl>
|
|
188
|
+
<dd>
|
|
189
|
+
|
|
190
|
+
```ruby
|
|
191
|
+
client.put_environments_environment_id(environment_id: "environment_id")
|
|
192
|
+
```
|
|
193
|
+
</dd>
|
|
194
|
+
</dl>
|
|
237
195
|
</dd>
|
|
238
196
|
</dl>
|
|
239
197
|
|
|
198
|
+
#### ⚙️ Parameters
|
|
199
|
+
|
|
240
200
|
<dl>
|
|
241
201
|
<dd>
|
|
242
202
|
|
|
243
|
-
|
|
203
|
+
<dl>
|
|
204
|
+
<dd>
|
|
205
|
+
|
|
206
|
+
**environment_id:** `String`
|
|
244
207
|
|
|
245
208
|
</dd>
|
|
246
209
|
</dl>
|
|
@@ -248,7 +211,7 @@ client.accounts.count_account_members(
|
|
|
248
211
|
<dl>
|
|
249
212
|
<dd>
|
|
250
213
|
|
|
251
|
-
**request_options:** `Schematic::
|
|
214
|
+
**request_options:** `Schematic::RequestOptions`
|
|
252
215
|
|
|
253
216
|
</dd>
|
|
254
217
|
</dl>
|
|
@@ -260,7 +223,7 @@ client.accounts.count_account_members(
|
|
|
260
223
|
</dl>
|
|
261
224
|
</details>
|
|
262
225
|
|
|
263
|
-
<details><summary><code>client
|
|
226
|
+
<details><summary><code>client.<a href="/lib/schematic/client.rb">delete_environments_environment_id</a>(environment_id:) -> </code></summary>
|
|
264
227
|
<dl>
|
|
265
228
|
<dd>
|
|
266
229
|
|
|
@@ -273,12 +236,7 @@ client.accounts.count_account_members(
|
|
|
273
236
|
<dd>
|
|
274
237
|
|
|
275
238
|
```ruby
|
|
276
|
-
client.
|
|
277
|
-
environment_id: "environment_id",
|
|
278
|
-
require_environment: true,
|
|
279
|
-
limit: 1000000,
|
|
280
|
-
offset: 1000000
|
|
281
|
-
)
|
|
239
|
+
client.delete_environments_environment_id(environment_id: "environment_id")
|
|
282
240
|
```
|
|
283
241
|
</dd>
|
|
284
242
|
</dl>
|
|
@@ -301,31 +259,47 @@ client.accounts.list_api_keys(
|
|
|
301
259
|
<dl>
|
|
302
260
|
<dd>
|
|
303
261
|
|
|
304
|
-
**
|
|
262
|
+
**request_options:** `Schematic::RequestOptions`
|
|
305
263
|
|
|
306
264
|
</dd>
|
|
307
265
|
</dl>
|
|
266
|
+
</dd>
|
|
267
|
+
</dl>
|
|
308
268
|
|
|
309
|
-
<dl>
|
|
310
|
-
<dd>
|
|
311
269
|
|
|
312
|
-
**limit:** `Integer` — Page limit (default 100)
|
|
313
|
-
|
|
314
270
|
</dd>
|
|
315
271
|
</dl>
|
|
272
|
+
</details>
|
|
316
273
|
|
|
274
|
+
<details><summary><code>client.<a href="/lib/schematic/client.rb">get_credit_ledger</a>() -> </code></summary>
|
|
317
275
|
<dl>
|
|
318
276
|
<dd>
|
|
319
277
|
|
|
320
|
-
|
|
321
|
-
|
|
278
|
+
#### 🔌 Usage
|
|
279
|
+
|
|
280
|
+
<dl>
|
|
281
|
+
<dd>
|
|
282
|
+
|
|
283
|
+
<dl>
|
|
284
|
+
<dd>
|
|
285
|
+
|
|
286
|
+
```ruby
|
|
287
|
+
client.get_credit_ledger
|
|
288
|
+
```
|
|
322
289
|
</dd>
|
|
323
290
|
</dl>
|
|
291
|
+
</dd>
|
|
292
|
+
</dl>
|
|
293
|
+
|
|
294
|
+
#### ⚙️ Parameters
|
|
324
295
|
|
|
325
296
|
<dl>
|
|
326
297
|
<dd>
|
|
327
298
|
|
|
328
|
-
|
|
299
|
+
<dl>
|
|
300
|
+
<dd>
|
|
301
|
+
|
|
302
|
+
**request_options:** `Schematic::RequestOptions`
|
|
329
303
|
|
|
330
304
|
</dd>
|
|
331
305
|
</dl>
|
|
@@ -337,7 +311,8 @@ client.accounts.list_api_keys(
|
|
|
337
311
|
</dl>
|
|
338
312
|
</details>
|
|
339
313
|
|
|
340
|
-
|
|
314
|
+
## accounts
|
|
315
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">list_account_members</a>() -> Schematic::Accounts::Types::ListAccountMembersResponse</code></summary>
|
|
341
316
|
<dl>
|
|
342
317
|
<dd>
|
|
343
318
|
|
|
@@ -350,7 +325,13 @@ client.accounts.list_api_keys(
|
|
|
350
325
|
<dd>
|
|
351
326
|
|
|
352
327
|
```ruby
|
|
353
|
-
client.accounts.
|
|
328
|
+
client.accounts.list_account_members(
|
|
329
|
+
ids: ["ids"],
|
|
330
|
+
q: "q",
|
|
331
|
+
role: "admin",
|
|
332
|
+
limit: 1000000,
|
|
333
|
+
offset: 1000000
|
|
334
|
+
)
|
|
354
335
|
```
|
|
355
336
|
</dd>
|
|
356
337
|
</dl>
|
|
@@ -365,7 +346,7 @@ client.accounts.create_api_key(name: "name")
|
|
|
365
346
|
<dl>
|
|
366
347
|
<dd>
|
|
367
348
|
|
|
368
|
-
**
|
|
349
|
+
**ids:** `String`
|
|
369
350
|
|
|
370
351
|
</dd>
|
|
371
352
|
</dl>
|
|
@@ -373,7 +354,7 @@ client.accounts.create_api_key(name: "name")
|
|
|
373
354
|
<dl>
|
|
374
355
|
<dd>
|
|
375
356
|
|
|
376
|
-
**
|
|
357
|
+
**q:** `String` — Search filter
|
|
377
358
|
|
|
378
359
|
</dd>
|
|
379
360
|
</dl>
|
|
@@ -381,7 +362,7 @@ client.accounts.create_api_key(name: "name")
|
|
|
381
362
|
<dl>
|
|
382
363
|
<dd>
|
|
383
364
|
|
|
384
|
-
**
|
|
365
|
+
**role:** `Schematic::Types::AccountMemberRole` — Filter by member role
|
|
385
366
|
|
|
386
367
|
</dd>
|
|
387
368
|
</dl>
|
|
@@ -389,7 +370,7 @@ client.accounts.create_api_key(name: "name")
|
|
|
389
370
|
<dl>
|
|
390
371
|
<dd>
|
|
391
372
|
|
|
392
|
-
**
|
|
373
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
393
374
|
|
|
394
375
|
</dd>
|
|
395
376
|
</dl>
|
|
@@ -397,7 +378,7 @@ client.accounts.create_api_key(name: "name")
|
|
|
397
378
|
<dl>
|
|
398
379
|
<dd>
|
|
399
380
|
|
|
400
|
-
**
|
|
381
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
401
382
|
|
|
402
383
|
</dd>
|
|
403
384
|
</dl>
|
|
@@ -417,7 +398,7 @@ client.accounts.create_api_key(name: "name")
|
|
|
417
398
|
</dl>
|
|
418
399
|
</details>
|
|
419
400
|
|
|
420
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">
|
|
401
|
+
<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>
|
|
421
402
|
<dl>
|
|
422
403
|
<dd>
|
|
423
404
|
|
|
@@ -430,7 +411,7 @@ client.accounts.create_api_key(name: "name")
|
|
|
430
411
|
<dd>
|
|
431
412
|
|
|
432
413
|
```ruby
|
|
433
|
-
client.accounts.
|
|
414
|
+
client.accounts.get_account_member(account_member_id: "account_member_id")
|
|
434
415
|
```
|
|
435
416
|
</dd>
|
|
436
417
|
</dl>
|
|
@@ -445,7 +426,7 @@ client.accounts.get_api_key(api_key_id: "api_key_id")
|
|
|
445
426
|
<dl>
|
|
446
427
|
<dd>
|
|
447
428
|
|
|
448
|
-
**
|
|
429
|
+
**account_member_id:** `String` — account_member_id
|
|
449
430
|
|
|
450
431
|
</dd>
|
|
451
432
|
</dl>
|
|
@@ -465,7 +446,7 @@ client.accounts.get_api_key(api_key_id: "api_key_id")
|
|
|
465
446
|
</dl>
|
|
466
447
|
</details>
|
|
467
448
|
|
|
468
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">
|
|
449
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">count_account_members</a>() -> Schematic::Accounts::Types::CountAccountMembersResponse</code></summary>
|
|
469
450
|
<dl>
|
|
470
451
|
<dd>
|
|
471
452
|
|
|
@@ -478,7 +459,13 @@ client.accounts.get_api_key(api_key_id: "api_key_id")
|
|
|
478
459
|
<dd>
|
|
479
460
|
|
|
480
461
|
```ruby
|
|
481
|
-
client.accounts.
|
|
462
|
+
client.accounts.count_account_members(
|
|
463
|
+
ids: ["ids"],
|
|
464
|
+
q: "q",
|
|
465
|
+
role: "admin",
|
|
466
|
+
limit: 1000000,
|
|
467
|
+
offset: 1000000
|
|
468
|
+
)
|
|
482
469
|
```
|
|
483
470
|
</dd>
|
|
484
471
|
</dl>
|
|
@@ -493,15 +480,7 @@ client.accounts.update_api_key(api_key_id: "api_key_id")
|
|
|
493
480
|
<dl>
|
|
494
481
|
<dd>
|
|
495
482
|
|
|
496
|
-
**
|
|
497
|
-
|
|
498
|
-
</dd>
|
|
499
|
-
</dl>
|
|
500
|
-
|
|
501
|
-
<dl>
|
|
502
|
-
<dd>
|
|
503
|
-
|
|
504
|
-
**description:** `String`
|
|
483
|
+
**ids:** `String`
|
|
505
484
|
|
|
506
485
|
</dd>
|
|
507
486
|
</dl>
|
|
@@ -509,7 +488,7 @@ client.accounts.update_api_key(api_key_id: "api_key_id")
|
|
|
509
488
|
<dl>
|
|
510
489
|
<dd>
|
|
511
490
|
|
|
512
|
-
**
|
|
491
|
+
**q:** `String` — Search filter
|
|
513
492
|
|
|
514
493
|
</dd>
|
|
515
494
|
</dl>
|
|
@@ -517,7 +496,7 @@ client.accounts.update_api_key(api_key_id: "api_key_id")
|
|
|
517
496
|
<dl>
|
|
518
497
|
<dd>
|
|
519
498
|
|
|
520
|
-
**
|
|
499
|
+
**role:** `Schematic::Types::AccountMemberRole` — Filter by member role
|
|
521
500
|
|
|
522
501
|
</dd>
|
|
523
502
|
</dl>
|
|
@@ -525,47 +504,15 @@ client.accounts.update_api_key(api_key_id: "api_key_id")
|
|
|
525
504
|
<dl>
|
|
526
505
|
<dd>
|
|
527
506
|
|
|
528
|
-
**
|
|
507
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
529
508
|
|
|
530
509
|
</dd>
|
|
531
510
|
</dl>
|
|
532
|
-
</dd>
|
|
533
|
-
</dl>
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
</dd>
|
|
537
|
-
</dl>
|
|
538
|
-
</details>
|
|
539
|
-
|
|
540
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">delete_api_key</a>(api_key_id:) -> Schematic::Accounts::Types::DeleteApiKeyResponse</code></summary>
|
|
541
|
-
<dl>
|
|
542
|
-
<dd>
|
|
543
|
-
|
|
544
|
-
#### 🔌 Usage
|
|
545
|
-
|
|
546
|
-
<dl>
|
|
547
|
-
<dd>
|
|
548
|
-
|
|
549
|
-
<dl>
|
|
550
|
-
<dd>
|
|
551
|
-
|
|
552
|
-
```ruby
|
|
553
|
-
client.accounts.delete_api_key(api_key_id: "api_key_id")
|
|
554
|
-
```
|
|
555
|
-
</dd>
|
|
556
|
-
</dl>
|
|
557
|
-
</dd>
|
|
558
|
-
</dl>
|
|
559
|
-
|
|
560
|
-
#### ⚙️ Parameters
|
|
561
|
-
|
|
562
|
-
<dl>
|
|
563
|
-
<dd>
|
|
564
511
|
|
|
565
512
|
<dl>
|
|
566
513
|
<dd>
|
|
567
514
|
|
|
568
|
-
**
|
|
515
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
569
516
|
|
|
570
517
|
</dd>
|
|
571
518
|
</dl>
|
|
@@ -585,7 +532,7 @@ client.accounts.delete_api_key(api_key_id: "api_key_id")
|
|
|
585
532
|
</dl>
|
|
586
533
|
</details>
|
|
587
534
|
|
|
588
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">
|
|
535
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">list_api_keys</a>() -> Schematic::Accounts::Types::ListApiKeysResponse</code></summary>
|
|
589
536
|
<dl>
|
|
590
537
|
<dd>
|
|
591
538
|
|
|
@@ -598,7 +545,7 @@ client.accounts.delete_api_key(api_key_id: "api_key_id")
|
|
|
598
545
|
<dd>
|
|
599
546
|
|
|
600
547
|
```ruby
|
|
601
|
-
client.accounts.
|
|
548
|
+
client.accounts.list_api_keys(
|
|
602
549
|
environment_id: "environment_id",
|
|
603
550
|
require_environment: true,
|
|
604
551
|
limit: 1000000,
|
|
@@ -662,7 +609,7 @@ client.accounts.count_api_keys(
|
|
|
662
609
|
</dl>
|
|
663
610
|
</details>
|
|
664
611
|
|
|
665
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">
|
|
612
|
+
<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>
|
|
666
613
|
<dl>
|
|
667
614
|
<dd>
|
|
668
615
|
|
|
@@ -675,15 +622,7 @@ client.accounts.count_api_keys(
|
|
|
675
622
|
<dd>
|
|
676
623
|
|
|
677
624
|
```ruby
|
|
678
|
-
client.accounts.
|
|
679
|
-
actor_type: "api_key",
|
|
680
|
-
end_time: "2024-01-15T09:30:00Z",
|
|
681
|
-
environment_id: "environment_id",
|
|
682
|
-
q: "q",
|
|
683
|
-
start_time: "2024-01-15T09:30:00Z",
|
|
684
|
-
limit: 1000000,
|
|
685
|
-
offset: 1000000
|
|
686
|
-
)
|
|
625
|
+
client.accounts.get_api_key(api_key_id: "api_key_id")
|
|
687
626
|
```
|
|
688
627
|
</dd>
|
|
689
628
|
</dl>
|
|
@@ -698,15 +637,7 @@ client.accounts.list_audit_logs(
|
|
|
698
637
|
<dl>
|
|
699
638
|
<dd>
|
|
700
639
|
|
|
701
|
-
**
|
|
702
|
-
|
|
703
|
-
</dd>
|
|
704
|
-
</dl>
|
|
705
|
-
|
|
706
|
-
<dl>
|
|
707
|
-
<dd>
|
|
708
|
-
|
|
709
|
-
**end_time:** `String`
|
|
640
|
+
**api_key_id:** `String` — api_key_id
|
|
710
641
|
|
|
711
642
|
</dd>
|
|
712
643
|
</dl>
|
|
@@ -714,87 +645,76 @@ client.accounts.list_audit_logs(
|
|
|
714
645
|
<dl>
|
|
715
646
|
<dd>
|
|
716
647
|
|
|
717
|
-
**
|
|
648
|
+
**request_options:** `Schematic::Accounts::RequestOptions`
|
|
718
649
|
|
|
719
650
|
</dd>
|
|
720
651
|
</dl>
|
|
721
|
-
|
|
722
|
-
<dl>
|
|
723
|
-
<dd>
|
|
724
|
-
|
|
725
|
-
**q:** `String`
|
|
726
|
-
|
|
727
652
|
</dd>
|
|
728
653
|
</dl>
|
|
729
654
|
|
|
730
|
-
<dl>
|
|
731
|
-
<dd>
|
|
732
655
|
|
|
733
|
-
**start_time:** `String`
|
|
734
|
-
|
|
735
656
|
</dd>
|
|
736
657
|
</dl>
|
|
658
|
+
</details>
|
|
737
659
|
|
|
660
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">count_api_keys</a>() -> Schematic::Accounts::Types::CountApiKeysResponse</code></summary>
|
|
738
661
|
<dl>
|
|
739
662
|
<dd>
|
|
740
663
|
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
</dd>
|
|
744
|
-
</dl>
|
|
664
|
+
#### 🔌 Usage
|
|
745
665
|
|
|
746
666
|
<dl>
|
|
747
667
|
<dd>
|
|
748
668
|
|
|
749
|
-
**offset:** `Integer` — Page offset (default 0)
|
|
750
|
-
|
|
751
|
-
</dd>
|
|
752
|
-
</dl>
|
|
753
|
-
|
|
754
669
|
<dl>
|
|
755
670
|
<dd>
|
|
756
671
|
|
|
757
|
-
|
|
758
|
-
|
|
672
|
+
```ruby
|
|
673
|
+
client.accounts.count_api_keys(
|
|
674
|
+
environment_id: "environment_id",
|
|
675
|
+
require_environment: true,
|
|
676
|
+
limit: 1000000,
|
|
677
|
+
offset: 1000000
|
|
678
|
+
)
|
|
679
|
+
```
|
|
759
680
|
</dd>
|
|
760
681
|
</dl>
|
|
761
682
|
</dd>
|
|
762
683
|
</dl>
|
|
763
684
|
|
|
685
|
+
#### ⚙️ Parameters
|
|
764
686
|
|
|
765
|
-
</dd>
|
|
766
|
-
</dl>
|
|
767
|
-
</details>
|
|
768
|
-
|
|
769
|
-
<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>
|
|
770
687
|
<dl>
|
|
771
688
|
<dd>
|
|
772
689
|
|
|
773
|
-
#### 🔌 Usage
|
|
774
|
-
|
|
775
690
|
<dl>
|
|
776
691
|
<dd>
|
|
777
692
|
|
|
693
|
+
**environment_id:** `String`
|
|
694
|
+
|
|
695
|
+
</dd>
|
|
696
|
+
</dl>
|
|
697
|
+
|
|
778
698
|
<dl>
|
|
779
699
|
<dd>
|
|
780
700
|
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
```
|
|
784
|
-
</dd>
|
|
785
|
-
</dl>
|
|
701
|
+
**require_environment:** `Internal::Types::Boolean`
|
|
702
|
+
|
|
786
703
|
</dd>
|
|
787
704
|
</dl>
|
|
788
705
|
|
|
789
|
-
#### ⚙️ Parameters
|
|
790
|
-
|
|
791
706
|
<dl>
|
|
792
707
|
<dd>
|
|
793
708
|
|
|
709
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
710
|
+
|
|
711
|
+
</dd>
|
|
712
|
+
</dl>
|
|
713
|
+
|
|
794
714
|
<dl>
|
|
795
715
|
<dd>
|
|
796
716
|
|
|
797
|
-
**
|
|
717
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
798
718
|
|
|
799
719
|
</dd>
|
|
800
720
|
</dl>
|
|
@@ -814,7 +734,7 @@ client.accounts.get_audit_log(audit_log_id: "audit_log_id")
|
|
|
814
734
|
</dl>
|
|
815
735
|
</details>
|
|
816
736
|
|
|
817
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">
|
|
737
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">list_audit_logs</a>() -> Schematic::Accounts::Types::ListAuditLogsResponse</code></summary>
|
|
818
738
|
<dl>
|
|
819
739
|
<dd>
|
|
820
740
|
|
|
@@ -827,7 +747,7 @@ client.accounts.get_audit_log(audit_log_id: "audit_log_id")
|
|
|
827
747
|
<dd>
|
|
828
748
|
|
|
829
749
|
```ruby
|
|
830
|
-
client.accounts.
|
|
750
|
+
client.accounts.list_audit_logs(
|
|
831
751
|
actor_type: "api_key",
|
|
832
752
|
end_time: "2024-01-15T09:30:00Z",
|
|
833
753
|
environment_id: "environment_id",
|
|
@@ -918,7 +838,7 @@ client.accounts.count_audit_logs(
|
|
|
918
838
|
</dl>
|
|
919
839
|
</details>
|
|
920
840
|
|
|
921
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">
|
|
841
|
+
<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>
|
|
922
842
|
<dl>
|
|
923
843
|
<dd>
|
|
924
844
|
|
|
@@ -931,11 +851,7 @@ client.accounts.count_audit_logs(
|
|
|
931
851
|
<dd>
|
|
932
852
|
|
|
933
853
|
```ruby
|
|
934
|
-
client.accounts.
|
|
935
|
-
ids: ["ids"],
|
|
936
|
-
limit: 1000000,
|
|
937
|
-
offset: 1000000
|
|
938
|
-
)
|
|
854
|
+
client.accounts.get_audit_log(audit_log_id: "audit_log_id")
|
|
939
855
|
```
|
|
940
856
|
</dd>
|
|
941
857
|
</dl>
|
|
@@ -950,23 +866,7 @@ client.accounts.list_environments(
|
|
|
950
866
|
<dl>
|
|
951
867
|
<dd>
|
|
952
868
|
|
|
953
|
-
**
|
|
954
|
-
|
|
955
|
-
</dd>
|
|
956
|
-
</dl>
|
|
957
|
-
|
|
958
|
-
<dl>
|
|
959
|
-
<dd>
|
|
960
|
-
|
|
961
|
-
**limit:** `Integer` — Page limit (default 100)
|
|
962
|
-
|
|
963
|
-
</dd>
|
|
964
|
-
</dl>
|
|
965
|
-
|
|
966
|
-
<dl>
|
|
967
|
-
<dd>
|
|
968
|
-
|
|
969
|
-
**offset:** `Integer` — Page offset (default 0)
|
|
869
|
+
**audit_log_id:** `String` — audit_log_id
|
|
970
870
|
|
|
971
871
|
</dd>
|
|
972
872
|
</dl>
|
|
@@ -986,7 +886,7 @@ client.accounts.list_environments(
|
|
|
986
886
|
</dl>
|
|
987
887
|
</details>
|
|
988
888
|
|
|
989
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">
|
|
889
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">count_audit_logs</a>() -> Schematic::Accounts::Types::CountAuditLogsResponse</code></summary>
|
|
990
890
|
<dl>
|
|
991
891
|
<dd>
|
|
992
892
|
|
|
@@ -999,9 +899,14 @@ client.accounts.list_environments(
|
|
|
999
899
|
<dd>
|
|
1000
900
|
|
|
1001
901
|
```ruby
|
|
1002
|
-
client.accounts.
|
|
1003
|
-
|
|
1004
|
-
|
|
902
|
+
client.accounts.count_audit_logs(
|
|
903
|
+
actor_type: "api_key",
|
|
904
|
+
end_time: "2024-01-15T09:30:00Z",
|
|
905
|
+
environment_id: "environment_id",
|
|
906
|
+
q: "q",
|
|
907
|
+
start_time: "2024-01-15T09:30:00Z",
|
|
908
|
+
limit: 1000000,
|
|
909
|
+
offset: 1000000
|
|
1005
910
|
)
|
|
1006
911
|
```
|
|
1007
912
|
</dd>
|
|
@@ -1017,7 +922,7 @@ client.accounts.create_environment(
|
|
|
1017
922
|
<dl>
|
|
1018
923
|
<dd>
|
|
1019
924
|
|
|
1020
|
-
**
|
|
925
|
+
**actor_type:** `Schematic::Types::ActorType`
|
|
1021
926
|
|
|
1022
927
|
</dd>
|
|
1023
928
|
</dl>
|
|
@@ -1025,7 +930,7 @@ client.accounts.create_environment(
|
|
|
1025
930
|
<dl>
|
|
1026
931
|
<dd>
|
|
1027
932
|
|
|
1028
|
-
**
|
|
933
|
+
**end_time:** `String`
|
|
1029
934
|
|
|
1030
935
|
</dd>
|
|
1031
936
|
</dl>
|
|
@@ -1033,47 +938,39 @@ client.accounts.create_environment(
|
|
|
1033
938
|
<dl>
|
|
1034
939
|
<dd>
|
|
1035
940
|
|
|
1036
|
-
**
|
|
941
|
+
**environment_id:** `String`
|
|
1037
942
|
|
|
1038
943
|
</dd>
|
|
1039
944
|
</dl>
|
|
1040
|
-
</dd>
|
|
1041
|
-
</dl>
|
|
1042
945
|
|
|
946
|
+
<dl>
|
|
947
|
+
<dd>
|
|
1043
948
|
|
|
949
|
+
**q:** `String`
|
|
950
|
+
|
|
1044
951
|
</dd>
|
|
1045
952
|
</dl>
|
|
1046
|
-
</details>
|
|
1047
953
|
|
|
1048
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">get_environment</a>(environment_id:) -> Schematic::Accounts::Types::GetEnvironmentResponse</code></summary>
|
|
1049
954
|
<dl>
|
|
1050
955
|
<dd>
|
|
1051
956
|
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
957
|
+
**start_time:** `String`
|
|
958
|
+
|
|
959
|
+
</dd>
|
|
960
|
+
</dl>
|
|
1056
961
|
|
|
1057
962
|
<dl>
|
|
1058
963
|
<dd>
|
|
1059
964
|
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
```
|
|
1063
|
-
</dd>
|
|
1064
|
-
</dl>
|
|
965
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
966
|
+
|
|
1065
967
|
</dd>
|
|
1066
968
|
</dl>
|
|
1067
969
|
|
|
1068
|
-
#### ⚙️ Parameters
|
|
1069
|
-
|
|
1070
|
-
<dl>
|
|
1071
|
-
<dd>
|
|
1072
|
-
|
|
1073
970
|
<dl>
|
|
1074
971
|
<dd>
|
|
1075
972
|
|
|
1076
|
-
**
|
|
973
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
1077
974
|
|
|
1078
975
|
</dd>
|
|
1079
976
|
</dl>
|
|
@@ -1093,7 +990,7 @@ client.accounts.get_environment(environment_id: "environment_id")
|
|
|
1093
990
|
</dl>
|
|
1094
991
|
</details>
|
|
1095
992
|
|
|
1096
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">
|
|
993
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">list_environments</a>() -> Schematic::Accounts::Types::ListEnvironmentsResponse</code></summary>
|
|
1097
994
|
<dl>
|
|
1098
995
|
<dd>
|
|
1099
996
|
|
|
@@ -1106,7 +1003,11 @@ client.accounts.get_environment(environment_id: "environment_id")
|
|
|
1106
1003
|
<dd>
|
|
1107
1004
|
|
|
1108
1005
|
```ruby
|
|
1109
|
-
client.accounts.
|
|
1006
|
+
client.accounts.list_environments(
|
|
1007
|
+
ids: ["ids"],
|
|
1008
|
+
limit: 1000000,
|
|
1009
|
+
offset: 1000000
|
|
1010
|
+
)
|
|
1110
1011
|
```
|
|
1111
1012
|
</dd>
|
|
1112
1013
|
</dl>
|
|
@@ -1121,15 +1022,7 @@ client.accounts.update_environment(environment_id: "environment_id")
|
|
|
1121
1022
|
<dl>
|
|
1122
1023
|
<dd>
|
|
1123
1024
|
|
|
1124
|
-
**
|
|
1125
|
-
|
|
1126
|
-
</dd>
|
|
1127
|
-
</dl>
|
|
1128
|
-
|
|
1129
|
-
<dl>
|
|
1130
|
-
<dd>
|
|
1131
|
-
|
|
1132
|
-
**environment_type:** `Schematic::Types::EnvironmentType`
|
|
1025
|
+
**ids:** `String`
|
|
1133
1026
|
|
|
1134
1027
|
</dd>
|
|
1135
1028
|
</dl>
|
|
@@ -1137,7 +1030,7 @@ client.accounts.update_environment(environment_id: "environment_id")
|
|
|
1137
1030
|
<dl>
|
|
1138
1031
|
<dd>
|
|
1139
1032
|
|
|
1140
|
-
**
|
|
1033
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
1141
1034
|
|
|
1142
1035
|
</dd>
|
|
1143
1036
|
</dl>
|
|
@@ -1145,7 +1038,7 @@ client.accounts.update_environment(environment_id: "environment_id")
|
|
|
1145
1038
|
<dl>
|
|
1146
1039
|
<dd>
|
|
1147
1040
|
|
|
1148
|
-
**
|
|
1041
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
1149
1042
|
|
|
1150
1043
|
</dd>
|
|
1151
1044
|
</dl>
|
|
@@ -1165,7 +1058,7 @@ client.accounts.update_environment(environment_id: "environment_id")
|
|
|
1165
1058
|
</dl>
|
|
1166
1059
|
</details>
|
|
1167
1060
|
|
|
1168
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">
|
|
1061
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">get_environment</a>(environment_id:) -> Schematic::Accounts::Types::GetEnvironmentResponse</code></summary>
|
|
1169
1062
|
<dl>
|
|
1170
1063
|
<dd>
|
|
1171
1064
|
|
|
@@ -1178,7 +1071,7 @@ client.accounts.update_environment(environment_id: "environment_id")
|
|
|
1178
1071
|
<dd>
|
|
1179
1072
|
|
|
1180
1073
|
```ruby
|
|
1181
|
-
client.accounts.
|
|
1074
|
+
client.accounts.get_environment(environment_id: "environment_id")
|
|
1182
1075
|
```
|
|
1183
1076
|
</dd>
|
|
1184
1077
|
</dl>
|
|
@@ -2653,6 +2546,14 @@ client.billing.upsert_payment_method(
|
|
|
2653
2546
|
<dl>
|
|
2654
2547
|
<dd>
|
|
2655
2548
|
|
|
2549
|
+
**customer_billing_details:** `Schematic::Types::PaymentMethodBillingDetailsRequestBody`
|
|
2550
|
+
|
|
2551
|
+
</dd>
|
|
2552
|
+
</dl>
|
|
2553
|
+
|
|
2554
|
+
<dl>
|
|
2555
|
+
<dd>
|
|
2556
|
+
|
|
2656
2557
|
**customer_external_id:** `String`
|
|
2657
2558
|
|
|
2658
2559
|
</dd>
|
|
@@ -4386,7 +4287,7 @@ client.billing.get_company_native_subscription(company_id: "company_id")
|
|
|
4386
4287
|
</dl>
|
|
4387
4288
|
</details>
|
|
4388
4289
|
|
|
4389
|
-
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">
|
|
4290
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">list_billing_invoices</a>() -> Schematic::Billing::Types::ListBillingInvoicesResponse</code></summary>
|
|
4390
4291
|
<dl>
|
|
4391
4292
|
<dd>
|
|
4392
4293
|
|
|
@@ -4399,10 +4300,14 @@ client.billing.get_company_native_subscription(company_id: "company_id")
|
|
|
4399
4300
|
<dd>
|
|
4400
4301
|
|
|
4401
4302
|
```ruby
|
|
4402
|
-
client.billing.
|
|
4303
|
+
client.billing.list_billing_invoices(
|
|
4403
4304
|
company_id: "company_id",
|
|
4404
4305
|
contract_id: "contract_id",
|
|
4405
4306
|
document_state: "credited",
|
|
4307
|
+
past_due: true,
|
|
4308
|
+
provider_type: "metronome",
|
|
4309
|
+
q: "q",
|
|
4310
|
+
status: "draft",
|
|
4406
4311
|
limit: 1000000,
|
|
4407
4312
|
offset: 1000000
|
|
4408
4313
|
)
|
|
@@ -4444,6 +4349,38 @@ client.billing.list_native_invoices(
|
|
|
4444
4349
|
<dl>
|
|
4445
4350
|
<dd>
|
|
4446
4351
|
|
|
4352
|
+
**past_due:** `Internal::Types::Boolean` — Only open invoices with an amount left to pay whose due date has passed.
|
|
4353
|
+
|
|
4354
|
+
</dd>
|
|
4355
|
+
</dl>
|
|
4356
|
+
|
|
4357
|
+
<dl>
|
|
4358
|
+
<dd>
|
|
4359
|
+
|
|
4360
|
+
**provider_type:** `Schematic::Types::BillingProviderType` — Only invoices from this billing provider. Leave empty for invoices from Schematic and Stripe.
|
|
4361
|
+
|
|
4362
|
+
</dd>
|
|
4363
|
+
</dl>
|
|
4364
|
+
|
|
4365
|
+
<dl>
|
|
4366
|
+
<dd>
|
|
4367
|
+
|
|
4368
|
+
**q:** `String` — Search by invoice number, provider invoice ID or company name.
|
|
4369
|
+
|
|
4370
|
+
</dd>
|
|
4371
|
+
</dl>
|
|
4372
|
+
|
|
4373
|
+
<dl>
|
|
4374
|
+
<dd>
|
|
4375
|
+
|
|
4376
|
+
**status:** `Schematic::Types::InvoiceStatus`
|
|
4377
|
+
|
|
4378
|
+
</dd>
|
|
4379
|
+
</dl>
|
|
4380
|
+
|
|
4381
|
+
<dl>
|
|
4382
|
+
<dd>
|
|
4383
|
+
|
|
4447
4384
|
**limit:** `Integer` — Page limit (default 100)
|
|
4448
4385
|
|
|
4449
4386
|
</dd>
|
|
@@ -4472,7 +4409,7 @@ client.billing.list_native_invoices(
|
|
|
4472
4409
|
</dl>
|
|
4473
4410
|
</details>
|
|
4474
4411
|
|
|
4475
|
-
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">
|
|
4412
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">get_billing_invoice</a>(invoice_id:) -> Schematic::Billing::Types::GetBillingInvoiceResponse</code></summary>
|
|
4476
4413
|
<dl>
|
|
4477
4414
|
<dd>
|
|
4478
4415
|
|
|
@@ -4485,7 +4422,7 @@ client.billing.list_native_invoices(
|
|
|
4485
4422
|
<dd>
|
|
4486
4423
|
|
|
4487
4424
|
```ruby
|
|
4488
|
-
client.billing.
|
|
4425
|
+
client.billing.get_billing_invoice(invoice_id: "invoice_id")
|
|
4489
4426
|
```
|
|
4490
4427
|
</dd>
|
|
4491
4428
|
</dl>
|
|
@@ -4616,7 +4553,7 @@ client.billing.finalize_native_invoice(invoice_id: "invoice_id")
|
|
|
4616
4553
|
</dl>
|
|
4617
4554
|
</details>
|
|
4618
4555
|
|
|
4619
|
-
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">
|
|
4556
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">mark_billing_invoice_paid</a>(invoice_id:, request) -> Schematic::Billing::Types::MarkBillingInvoicePaidResponse</code></summary>
|
|
4620
4557
|
<dl>
|
|
4621
4558
|
<dd>
|
|
4622
4559
|
|
|
@@ -4629,7 +4566,7 @@ client.billing.finalize_native_invoice(invoice_id: "invoice_id")
|
|
|
4629
4566
|
<dd>
|
|
4630
4567
|
|
|
4631
4568
|
```ruby
|
|
4632
|
-
client.billing.
|
|
4569
|
+
client.billing.mark_billing_invoice_paid(
|
|
4633
4570
|
invoice_id: "invoice_id",
|
|
4634
4571
|
idempotency_key: "idempotency_key"
|
|
4635
4572
|
)
|
|
@@ -4795,7 +4732,7 @@ client.billing.void_native_invoice(invoice_id: "invoice_id")
|
|
|
4795
4732
|
</dl>
|
|
4796
4733
|
</details>
|
|
4797
4734
|
|
|
4798
|
-
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">
|
|
4735
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">count_billing_invoices</a>() -> Schematic::Billing::Types::CountBillingInvoicesResponse</code></summary>
|
|
4799
4736
|
<dl>
|
|
4800
4737
|
<dd>
|
|
4801
4738
|
|
|
@@ -4808,10 +4745,14 @@ client.billing.void_native_invoice(invoice_id: "invoice_id")
|
|
|
4808
4745
|
<dd>
|
|
4809
4746
|
|
|
4810
4747
|
```ruby
|
|
4811
|
-
client.billing.
|
|
4748
|
+
client.billing.count_billing_invoices(
|
|
4812
4749
|
company_id: "company_id",
|
|
4813
4750
|
contract_id: "contract_id",
|
|
4814
4751
|
document_state: "credited",
|
|
4752
|
+
past_due: true,
|
|
4753
|
+
provider_type: "metronome",
|
|
4754
|
+
q: "q",
|
|
4755
|
+
status: "draft",
|
|
4815
4756
|
limit: 1000000,
|
|
4816
4757
|
offset: 1000000
|
|
4817
4758
|
)
|
|
@@ -4853,6 +4794,38 @@ client.billing.count_native_invoices(
|
|
|
4853
4794
|
<dl>
|
|
4854
4795
|
<dd>
|
|
4855
4796
|
|
|
4797
|
+
**past_due:** `Internal::Types::Boolean` — Only open invoices with an amount left to pay whose due date has passed.
|
|
4798
|
+
|
|
4799
|
+
</dd>
|
|
4800
|
+
</dl>
|
|
4801
|
+
|
|
4802
|
+
<dl>
|
|
4803
|
+
<dd>
|
|
4804
|
+
|
|
4805
|
+
**provider_type:** `Schematic::Types::BillingProviderType` — Only invoices from this billing provider. Leave empty for invoices from Schematic and Stripe.
|
|
4806
|
+
|
|
4807
|
+
</dd>
|
|
4808
|
+
</dl>
|
|
4809
|
+
|
|
4810
|
+
<dl>
|
|
4811
|
+
<dd>
|
|
4812
|
+
|
|
4813
|
+
**q:** `String` — Search by invoice number, provider invoice ID or company name.
|
|
4814
|
+
|
|
4815
|
+
</dd>
|
|
4816
|
+
</dl>
|
|
4817
|
+
|
|
4818
|
+
<dl>
|
|
4819
|
+
<dd>
|
|
4820
|
+
|
|
4821
|
+
**status:** `Schematic::Types::InvoiceStatus`
|
|
4822
|
+
|
|
4823
|
+
</dd>
|
|
4824
|
+
</dl>
|
|
4825
|
+
|
|
4826
|
+
<dl>
|
|
4827
|
+
<dd>
|
|
4828
|
+
|
|
4856
4829
|
**limit:** `Integer` — Page limit (default 100)
|
|
4857
4830
|
|
|
4858
4831
|
</dd>
|
|
@@ -7625,7 +7598,7 @@ client.credits.create_credit_spend_policy(billing_credit_id: "billing_credit_id"
|
|
|
7625
7598
|
<dl>
|
|
7626
7599
|
<dd>
|
|
7627
7600
|
|
|
7628
|
-
**window_unit:** `Schematic::Types::CreditSpendWindowUnit` — The window that window_amount applies to: one UTC hour
|
|
7601
|
+
**window_unit:** `Schematic::Types::CreditSpendWindowUnit` — The window that window_amount applies to: one UTC hour, one UTC day, one week from Monday 00:00 UTC, one calendar month from the 1st 00:00 UTC, or the company's current billing period. billing_period applies to company policies only, and a company without an active subscription falls back to the calendar month. Required with window_amount.
|
|
7629
7602
|
|
|
7630
7603
|
</dd>
|
|
7631
7604
|
</dl>
|
|
@@ -8012,6 +7985,7 @@ client.credits.list_credit_event_ledger(
|
|
|
8012
7985
|
end_time: "end_time",
|
|
8013
7986
|
event_type: "adjustment",
|
|
8014
7987
|
feature_id: "feature_id",
|
|
7988
|
+
source_event_id: "source_event_id",
|
|
8015
7989
|
start_time: "start_time",
|
|
8016
7990
|
limit: 1000000,
|
|
8017
7991
|
offset: 1000000
|
|
@@ -8070,6 +8044,14 @@ client.credits.list_credit_event_ledger(
|
|
|
8070
8044
|
<dl>
|
|
8071
8045
|
<dd>
|
|
8072
8046
|
|
|
8047
|
+
**source_event_id:** `String` — Return only entries drawn by this track or inference event. Pass the event ID that POST /events returned for it.
|
|
8048
|
+
|
|
8049
|
+
</dd>
|
|
8050
|
+
</dl>
|
|
8051
|
+
|
|
8052
|
+
<dl>
|
|
8053
|
+
<dd>
|
|
8054
|
+
|
|
8073
8055
|
**start_time:** `String`
|
|
8074
8056
|
|
|
8075
8057
|
</dd>
|
|
@@ -8102,6 +8084,54 @@ client.credits.list_credit_event_ledger(
|
|
|
8102
8084
|
</dl>
|
|
8103
8085
|
|
|
8104
8086
|
|
|
8087
|
+
</dd>
|
|
8088
|
+
</dl>
|
|
8089
|
+
</details>
|
|
8090
|
+
|
|
8091
|
+
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">get_credit_event_ledger_entry</a>(ledger_entry_id:) -> Schematic::Credits::Types::GetCreditEventLedgerEntryResponse</code></summary>
|
|
8092
|
+
<dl>
|
|
8093
|
+
<dd>
|
|
8094
|
+
|
|
8095
|
+
#### 🔌 Usage
|
|
8096
|
+
|
|
8097
|
+
<dl>
|
|
8098
|
+
<dd>
|
|
8099
|
+
|
|
8100
|
+
<dl>
|
|
8101
|
+
<dd>
|
|
8102
|
+
|
|
8103
|
+
```ruby
|
|
8104
|
+
client.credits.get_credit_event_ledger_entry(ledger_entry_id: "ledger_entry_id")
|
|
8105
|
+
```
|
|
8106
|
+
</dd>
|
|
8107
|
+
</dl>
|
|
8108
|
+
</dd>
|
|
8109
|
+
</dl>
|
|
8110
|
+
|
|
8111
|
+
#### ⚙️ Parameters
|
|
8112
|
+
|
|
8113
|
+
<dl>
|
|
8114
|
+
<dd>
|
|
8115
|
+
|
|
8116
|
+
<dl>
|
|
8117
|
+
<dd>
|
|
8118
|
+
|
|
8119
|
+
**ledger_entry_id:** `String` — ledger_entry_id
|
|
8120
|
+
|
|
8121
|
+
</dd>
|
|
8122
|
+
</dl>
|
|
8123
|
+
|
|
8124
|
+
<dl>
|
|
8125
|
+
<dd>
|
|
8126
|
+
|
|
8127
|
+
**request_options:** `Schematic::Credits::RequestOptions`
|
|
8128
|
+
|
|
8129
|
+
</dd>
|
|
8130
|
+
</dl>
|
|
8131
|
+
</dd>
|
|
8132
|
+
</dl>
|
|
8133
|
+
|
|
8134
|
+
|
|
8105
8135
|
</dd>
|
|
8106
8136
|
</dl>
|
|
8107
8137
|
</details>
|
|
@@ -8125,6 +8155,7 @@ client.credits.count_credit_event_ledger(
|
|
|
8125
8155
|
end_time: "end_time",
|
|
8126
8156
|
event_type: "adjustment",
|
|
8127
8157
|
feature_id: "feature_id",
|
|
8158
|
+
source_event_id: "source_event_id",
|
|
8128
8159
|
start_time: "start_time",
|
|
8129
8160
|
limit: 1000000,
|
|
8130
8161
|
offset: 1000000
|
|
@@ -8183,6 +8214,14 @@ client.credits.count_credit_event_ledger(
|
|
|
8183
8214
|
<dl>
|
|
8184
8215
|
<dd>
|
|
8185
8216
|
|
|
8217
|
+
**source_event_id:** `String` — Return only entries drawn by this track or inference event. Pass the event ID that POST /events returned for it.
|
|
8218
|
+
|
|
8219
|
+
</dd>
|
|
8220
|
+
</dl>
|
|
8221
|
+
|
|
8222
|
+
<dl>
|
|
8223
|
+
<dd>
|
|
8224
|
+
|
|
8186
8225
|
**start_time:** `String`
|
|
8187
8226
|
|
|
8188
8227
|
</dd>
|
|
@@ -9065,6 +9104,94 @@ client.catalogs.remove_plan(
|
|
|
9065
9104
|
</dl>
|
|
9066
9105
|
|
|
9067
9106
|
|
|
9107
|
+
</dd>
|
|
9108
|
+
</dl>
|
|
9109
|
+
</details>
|
|
9110
|
+
|
|
9111
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">get_public_catalog</a>() -> Schematic::Catalogs::Types::GetPublicCatalogResponse</code></summary>
|
|
9112
|
+
<dl>
|
|
9113
|
+
<dd>
|
|
9114
|
+
|
|
9115
|
+
#### 🔌 Usage
|
|
9116
|
+
|
|
9117
|
+
<dl>
|
|
9118
|
+
<dd>
|
|
9119
|
+
|
|
9120
|
+
<dl>
|
|
9121
|
+
<dd>
|
|
9122
|
+
|
|
9123
|
+
```ruby
|
|
9124
|
+
client.catalogs.get_public_catalog
|
|
9125
|
+
```
|
|
9126
|
+
</dd>
|
|
9127
|
+
</dl>
|
|
9128
|
+
</dd>
|
|
9129
|
+
</dl>
|
|
9130
|
+
|
|
9131
|
+
#### ⚙️ Parameters
|
|
9132
|
+
|
|
9133
|
+
<dl>
|
|
9134
|
+
<dd>
|
|
9135
|
+
|
|
9136
|
+
<dl>
|
|
9137
|
+
<dd>
|
|
9138
|
+
|
|
9139
|
+
**request_options:** `Schematic::Catalogs::RequestOptions`
|
|
9140
|
+
|
|
9141
|
+
</dd>
|
|
9142
|
+
</dl>
|
|
9143
|
+
</dd>
|
|
9144
|
+
</dl>
|
|
9145
|
+
|
|
9146
|
+
|
|
9147
|
+
</dd>
|
|
9148
|
+
</dl>
|
|
9149
|
+
</details>
|
|
9150
|
+
|
|
9151
|
+
<details><summary><code>client.catalogs.<a href="/lib/schematic/catalogs/client.rb">get_public_catalog_by_id</a>(catalog_id:) -> Schematic::Catalogs::Types::GetPublicCatalogByIdResponse</code></summary>
|
|
9152
|
+
<dl>
|
|
9153
|
+
<dd>
|
|
9154
|
+
|
|
9155
|
+
#### 🔌 Usage
|
|
9156
|
+
|
|
9157
|
+
<dl>
|
|
9158
|
+
<dd>
|
|
9159
|
+
|
|
9160
|
+
<dl>
|
|
9161
|
+
<dd>
|
|
9162
|
+
|
|
9163
|
+
```ruby
|
|
9164
|
+
client.catalogs.get_public_catalog_by_id(catalog_id: "catalog_id")
|
|
9165
|
+
```
|
|
9166
|
+
</dd>
|
|
9167
|
+
</dl>
|
|
9168
|
+
</dd>
|
|
9169
|
+
</dl>
|
|
9170
|
+
|
|
9171
|
+
#### ⚙️ Parameters
|
|
9172
|
+
|
|
9173
|
+
<dl>
|
|
9174
|
+
<dd>
|
|
9175
|
+
|
|
9176
|
+
<dl>
|
|
9177
|
+
<dd>
|
|
9178
|
+
|
|
9179
|
+
**catalog_id:** `String` — catalog_id
|
|
9180
|
+
|
|
9181
|
+
</dd>
|
|
9182
|
+
</dl>
|
|
9183
|
+
|
|
9184
|
+
<dl>
|
|
9185
|
+
<dd>
|
|
9186
|
+
|
|
9187
|
+
**request_options:** `Schematic::Catalogs::RequestOptions`
|
|
9188
|
+
|
|
9189
|
+
</dd>
|
|
9190
|
+
</dl>
|
|
9191
|
+
</dd>
|
|
9192
|
+
</dl>
|
|
9193
|
+
|
|
9194
|
+
|
|
9068
9195
|
</dd>
|
|
9069
9196
|
</dl>
|
|
9070
9197
|
</details>
|
|
@@ -16446,6 +16573,14 @@ client.plans.retry_custom_plan_billing(
|
|
|
16446
16573
|
<dl>
|
|
16447
16574
|
<dd>
|
|
16448
16575
|
|
|
16576
|
+
**end_date:** `String` — When a plan that doesn't renew ends. Moved back to the last renewal on or before it. When omitted, the end date set at finalize is reissued. Only honored when the retry creates a subscription.
|
|
16577
|
+
|
|
16578
|
+
</dd>
|
|
16579
|
+
</dl>
|
|
16580
|
+
|
|
16581
|
+
<dl>
|
|
16582
|
+
<dd>
|
|
16583
|
+
|
|
16449
16584
|
**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.
|
|
16450
16585
|
|
|
16451
16586
|
</dd>
|
|
@@ -18404,6 +18539,14 @@ client.planbundle.create_custom_plan_bundle(
|
|
|
18404
18539
|
<dl>
|
|
18405
18540
|
<dd>
|
|
18406
18541
|
|
|
18542
|
+
**renewal_policy:** `Schematic::Types::RenewalPolicy`
|
|
18543
|
+
|
|
18544
|
+
</dd>
|
|
18545
|
+
</dl>
|
|
18546
|
+
|
|
18547
|
+
<dl>
|
|
18548
|
+
<dd>
|
|
18549
|
+
|
|
18407
18550
|
**request_options:** `Schematic::Planbundle::RequestOptions`
|
|
18408
18551
|
|
|
18409
18552
|
</dd>
|
|
@@ -18484,6 +18627,14 @@ client.planbundle.create_plan_bundle(
|
|
|
18484
18627
|
<dl>
|
|
18485
18628
|
<dd>
|
|
18486
18629
|
|
|
18630
|
+
**renewal_policy:** `Schematic::Types::RenewalPolicy`
|
|
18631
|
+
|
|
18632
|
+
</dd>
|
|
18633
|
+
</dl>
|
|
18634
|
+
|
|
18635
|
+
<dl>
|
|
18636
|
+
<dd>
|
|
18637
|
+
|
|
18487
18638
|
**request_options:** `Schematic::Planbundle::RequestOptions`
|
|
18488
18639
|
|
|
18489
18640
|
</dd>
|
|
@@ -18580,6 +18731,14 @@ client.planbundle.update_plan_bundle(
|
|
|
18580
18731
|
<dl>
|
|
18581
18732
|
<dd>
|
|
18582
18733
|
|
|
18734
|
+
**renewal_policy:** `Schematic::Types::RenewalPolicy`
|
|
18735
|
+
|
|
18736
|
+
</dd>
|
|
18737
|
+
</dl>
|
|
18738
|
+
|
|
18739
|
+
<dl>
|
|
18740
|
+
<dd>
|
|
18741
|
+
|
|
18583
18742
|
**request_options:** `Schematic::Planbundle::RequestOptions`
|
|
18584
18743
|
|
|
18585
18744
|
</dd>
|