schematichq 1.5.4 → 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 +13 -1
- data/WASM_VERSION +1 -1
- data/lib/schematic/accounts/client.rb +0 -271
- data/lib/schematic/billing/client.rb +447 -0
- data/lib/schematic/billing/types/count_billing_invoices_params.rb +28 -0
- data/lib/schematic/billing/types/count_billing_invoices_request.rb +27 -0
- data/lib/schematic/billing/types/count_billing_invoices_response.rb +13 -0
- data/lib/schematic/billing/types/create_payment_method_request_body.rb +2 -0
- data/lib/schematic/billing/types/finalize_native_invoice_response.rb +13 -0
- data/lib/schematic/{accounts/types/delete_environment_response.rb → billing/types/get_billing_invoice_response.rb} +3 -3
- data/lib/schematic/billing/types/get_company_native_subscription_response.rb +13 -0
- data/lib/schematic/billing/types/list_billing_invoices_params.rb +28 -0
- data/lib/schematic/billing/types/list_billing_invoices_request.rb +27 -0
- data/lib/schematic/billing/types/list_billing_invoices_response.rb +13 -0
- data/lib/schematic/billing/types/mark_billing_invoice_paid_response.rb +13 -0
- data/lib/schematic/billing/types/mark_invoice_paid_request_body.rb +19 -0
- data/lib/schematic/billing/types/void_native_invoice_response.rb +13 -0
- 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/features/client.rb +0 -2
- data/lib/schematic/internal/iterators/cursor_item_iterator.rb +2 -2
- data/lib/schematic/internal/iterators/cursor_page_iterator.rb +11 -2
- data/lib/schematic/internal/iterators/item_iterator.rb +11 -2
- data/lib/schematic/internal/iterators/offset_item_iterator.rb +2 -2
- data/lib/schematic/internal/iterators/offset_page_iterator.rb +15 -6
- data/lib/schematic/internal/types/model.rb +17 -1
- 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/client.rb +61 -5
- data/lib/schematic/plans/types/list_custom_plan_billings_params.rb +4 -0
- data/lib/schematic/plans/types/list_custom_plan_billings_request.rb +4 -0
- data/lib/schematic/plans/types/preview_publish_plan_version_response.rb +13 -0
- data/lib/schematic/plans/types/retry_custom_plan_billing_request_body.rb +2 -0
- data/lib/schematic/types/amendment_proration_lands_on.rb +13 -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 +65 -0
- data/lib/schematic/types/billing_invoice_line_response_data.rb +31 -0
- data/lib/schematic/types/billing_invoice_response_data.rb +51 -0
- data/lib/schematic/types/billing_invoice_settlement_response_data.rb +17 -0
- data/lib/schematic/types/billing_invoice_tax_id_response_data.rb +11 -0
- data/lib/schematic/types/billing_invoice_terms_response_data.rb +21 -0
- data/lib/schematic/types/billing_native_subscription_change_response_data.rb +15 -0
- data/lib/schematic/types/billing_native_subscription_line_response_data.rb +47 -0
- data/lib/schematic/types/billing_native_subscription_response_data.rb +31 -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/billing_statement_line_response_data.rb +21 -0
- data/lib/schematic/types/billing_statement_response_data.rb +19 -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/charge_timing.rb +12 -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/collector.rb +13 -0
- data/lib/schematic/types/company_billing_profile_response_data.rb +12 -0
- data/lib/schematic/types/company_credit_balance.rb +4 -0
- data/lib/schematic/types/create_billing_plan_credit_grant_request_body.rb +2 -0
- data/lib/schematic/types/create_flag_request_body.rb +1 -1
- data/lib/schematic/types/create_or_update_flag_request_body.rb +1 -1
- data/lib/schematic/types/credit_spend_policy.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/event_body_inference.rb +4 -0
- data/lib/schematic/types/flag_detail_response_data.rb +1 -1
- data/lib/schematic/types/flag_in_plan_response_data.rb +1 -1
- data/lib/schematic/types/flag_response_data.rb +1 -1
- data/lib/schematic/types/invoice_collection_state.rb +17 -0
- data/lib/schematic/types/invoice_document_state.rb +14 -0
- data/lib/schematic/types/invoice_line_kind.rb +15 -0
- data/lib/schematic/types/line_kind.rb +13 -0
- data/lib/schematic/types/payment_gating.rb +12 -0
- 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/preflight_event_quantities_request_body.rb +13 -0
- data/lib/schematic/types/preflight_request_body.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 +45 -0
- data/lib/schematic/types/publish_preview_pay_in_advance_response_data.rb +15 -0
- data/lib/schematic/types/publish_preview_payment_method_response_data.rb +15 -0
- data/lib/schematic/types/publish_preview_proration_line_response_data.rb +19 -0
- data/lib/schematic/types/publish_preview_response_data.rb +55 -0
- data/lib/schematic/types/renewal_policy.rb +13 -0
- data/lib/schematic/types/rulesengine_credit_spend_policy.rb +2 -0
- data/lib/schematic/types/subscription_change_action.rb +14 -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/wasm/rulesengine.wasm +0 -0
- data/lib/schematic.rb +71 -18
- data/reference.md +1148 -506
- metadata +68 -15
- 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/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/plans/types/publish_plan_version_request_body.rb +0 -47
- 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,7 +67,7 @@ client.accounts.list_account_members(
|
|
|
74
67
|
<dl>
|
|
75
68
|
<dd>
|
|
76
69
|
|
|
77
|
-
**
|
|
70
|
+
**api_key_id:** `String`
|
|
78
71
|
|
|
79
72
|
</dd>
|
|
80
73
|
</dl>
|
|
@@ -82,23 +75,47 @@ client.accounts.list_account_members(
|
|
|
82
75
|
<dl>
|
|
83
76
|
<dd>
|
|
84
77
|
|
|
85
|
-
**
|
|
78
|
+
**request_options:** `Schematic::RequestOptions`
|
|
86
79
|
|
|
87
80
|
</dd>
|
|
88
81
|
</dl>
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
89
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>
|
|
90
91
|
<dl>
|
|
91
92
|
<dd>
|
|
92
93
|
|
|
93
|
-
|
|
94
|
-
|
|
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>
|
|
95
107
|
</dd>
|
|
96
108
|
</dl>
|
|
97
109
|
|
|
110
|
+
#### ⚙️ Parameters
|
|
111
|
+
|
|
98
112
|
<dl>
|
|
99
113
|
<dd>
|
|
100
114
|
|
|
101
|
-
|
|
115
|
+
<dl>
|
|
116
|
+
<dd>
|
|
117
|
+
|
|
118
|
+
**api_key_id:** `String`
|
|
102
119
|
|
|
103
120
|
</dd>
|
|
104
121
|
</dl>
|
|
@@ -106,15 +123,47 @@ client.accounts.list_account_members(
|
|
|
106
123
|
<dl>
|
|
107
124
|
<dd>
|
|
108
125
|
|
|
109
|
-
**
|
|
126
|
+
**request_options:** `Schematic::RequestOptions`
|
|
110
127
|
|
|
111
128
|
</dd>
|
|
112
129
|
</dl>
|
|
130
|
+
</dd>
|
|
131
|
+
</dl>
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
</dd>
|
|
135
|
+
</dl>
|
|
136
|
+
</details>
|
|
113
137
|
|
|
138
|
+
<details><summary><code>client.<a href="/lib/schematic/client.rb">post_environments</a>() -> </code></summary>
|
|
114
139
|
<dl>
|
|
115
140
|
<dd>
|
|
116
141
|
|
|
117
|
-
|
|
142
|
+
#### 🔌 Usage
|
|
143
|
+
|
|
144
|
+
<dl>
|
|
145
|
+
<dd>
|
|
146
|
+
|
|
147
|
+
<dl>
|
|
148
|
+
<dd>
|
|
149
|
+
|
|
150
|
+
```ruby
|
|
151
|
+
client.post_environments
|
|
152
|
+
```
|
|
153
|
+
</dd>
|
|
154
|
+
</dl>
|
|
155
|
+
</dd>
|
|
156
|
+
</dl>
|
|
157
|
+
|
|
158
|
+
#### ⚙️ Parameters
|
|
159
|
+
|
|
160
|
+
<dl>
|
|
161
|
+
<dd>
|
|
162
|
+
|
|
163
|
+
<dl>
|
|
164
|
+
<dd>
|
|
165
|
+
|
|
166
|
+
**request_options:** `Schematic::RequestOptions`
|
|
118
167
|
|
|
119
168
|
</dd>
|
|
120
169
|
</dl>
|
|
@@ -126,7 +175,7 @@ client.accounts.list_account_members(
|
|
|
126
175
|
</dl>
|
|
127
176
|
</details>
|
|
128
177
|
|
|
129
|
-
<details><summary><code>client
|
|
178
|
+
<details><summary><code>client.<a href="/lib/schematic/client.rb">put_environments_environment_id</a>(environment_id:) -> </code></summary>
|
|
130
179
|
<dl>
|
|
131
180
|
<dd>
|
|
132
181
|
|
|
@@ -139,7 +188,7 @@ client.accounts.list_account_members(
|
|
|
139
188
|
<dd>
|
|
140
189
|
|
|
141
190
|
```ruby
|
|
142
|
-
client.
|
|
191
|
+
client.put_environments_environment_id(environment_id: "environment_id")
|
|
143
192
|
```
|
|
144
193
|
</dd>
|
|
145
194
|
</dl>
|
|
@@ -154,7 +203,7 @@ client.accounts.get_account_member(account_member_id: "account_member_id")
|
|
|
154
203
|
<dl>
|
|
155
204
|
<dd>
|
|
156
205
|
|
|
157
|
-
**
|
|
206
|
+
**environment_id:** `String`
|
|
158
207
|
|
|
159
208
|
</dd>
|
|
160
209
|
</dl>
|
|
@@ -162,7 +211,7 @@ client.accounts.get_account_member(account_member_id: "account_member_id")
|
|
|
162
211
|
<dl>
|
|
163
212
|
<dd>
|
|
164
213
|
|
|
165
|
-
**request_options:** `Schematic::
|
|
214
|
+
**request_options:** `Schematic::RequestOptions`
|
|
166
215
|
|
|
167
216
|
</dd>
|
|
168
217
|
</dl>
|
|
@@ -174,7 +223,7 @@ client.accounts.get_account_member(account_member_id: "account_member_id")
|
|
|
174
223
|
</dl>
|
|
175
224
|
</details>
|
|
176
225
|
|
|
177
|
-
<details><summary><code>client
|
|
226
|
+
<details><summary><code>client.<a href="/lib/schematic/client.rb">delete_environments_environment_id</a>(environment_id:) -> </code></summary>
|
|
178
227
|
<dl>
|
|
179
228
|
<dd>
|
|
180
229
|
|
|
@@ -187,13 +236,7 @@ client.accounts.get_account_member(account_member_id: "account_member_id")
|
|
|
187
236
|
<dd>
|
|
188
237
|
|
|
189
238
|
```ruby
|
|
190
|
-
client.
|
|
191
|
-
ids: ["ids"],
|
|
192
|
-
q: "q",
|
|
193
|
-
role: "admin",
|
|
194
|
-
limit: 1000000,
|
|
195
|
-
offset: 1000000
|
|
196
|
-
)
|
|
239
|
+
client.delete_environments_environment_id(environment_id: "environment_id")
|
|
197
240
|
```
|
|
198
241
|
</dd>
|
|
199
242
|
</dl>
|
|
@@ -208,7 +251,7 @@ client.accounts.count_account_members(
|
|
|
208
251
|
<dl>
|
|
209
252
|
<dd>
|
|
210
253
|
|
|
211
|
-
**
|
|
254
|
+
**environment_id:** `String`
|
|
212
255
|
|
|
213
256
|
</dd>
|
|
214
257
|
</dl>
|
|
@@ -216,39 +259,47 @@ client.accounts.count_account_members(
|
|
|
216
259
|
<dl>
|
|
217
260
|
<dd>
|
|
218
261
|
|
|
219
|
-
**
|
|
262
|
+
**request_options:** `Schematic::RequestOptions`
|
|
220
263
|
|
|
221
264
|
</dd>
|
|
222
265
|
</dl>
|
|
266
|
+
</dd>
|
|
267
|
+
</dl>
|
|
223
268
|
|
|
224
|
-
<dl>
|
|
225
|
-
<dd>
|
|
226
269
|
|
|
227
|
-
**role:** `Schematic::Types::AccountMemberRole` — Filter by member role
|
|
228
|
-
|
|
229
270
|
</dd>
|
|
230
271
|
</dl>
|
|
272
|
+
</details>
|
|
231
273
|
|
|
274
|
+
<details><summary><code>client.<a href="/lib/schematic/client.rb">get_credit_ledger</a>() -> </code></summary>
|
|
232
275
|
<dl>
|
|
233
276
|
<dd>
|
|
234
277
|
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
</dd>
|
|
238
|
-
</dl>
|
|
278
|
+
#### 🔌 Usage
|
|
239
279
|
|
|
240
280
|
<dl>
|
|
241
281
|
<dd>
|
|
242
282
|
|
|
243
|
-
|
|
244
|
-
|
|
283
|
+
<dl>
|
|
284
|
+
<dd>
|
|
285
|
+
|
|
286
|
+
```ruby
|
|
287
|
+
client.get_credit_ledger
|
|
288
|
+
```
|
|
289
|
+
</dd>
|
|
290
|
+
</dl>
|
|
245
291
|
</dd>
|
|
246
292
|
</dl>
|
|
247
293
|
|
|
294
|
+
#### ⚙️ Parameters
|
|
295
|
+
|
|
248
296
|
<dl>
|
|
249
297
|
<dd>
|
|
250
298
|
|
|
251
|
-
|
|
299
|
+
<dl>
|
|
300
|
+
<dd>
|
|
301
|
+
|
|
302
|
+
**request_options:** `Schematic::RequestOptions`
|
|
252
303
|
|
|
253
304
|
</dd>
|
|
254
305
|
</dl>
|
|
@@ -260,7 +311,8 @@ client.accounts.count_account_members(
|
|
|
260
311
|
</dl>
|
|
261
312
|
</details>
|
|
262
313
|
|
|
263
|
-
|
|
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>
|
|
264
316
|
<dl>
|
|
265
317
|
<dd>
|
|
266
318
|
|
|
@@ -273,9 +325,10 @@ client.accounts.count_account_members(
|
|
|
273
325
|
<dd>
|
|
274
326
|
|
|
275
327
|
```ruby
|
|
276
|
-
client.accounts.
|
|
277
|
-
|
|
278
|
-
|
|
328
|
+
client.accounts.list_account_members(
|
|
329
|
+
ids: ["ids"],
|
|
330
|
+
q: "q",
|
|
331
|
+
role: "admin",
|
|
279
332
|
limit: 1000000,
|
|
280
333
|
offset: 1000000
|
|
281
334
|
)
|
|
@@ -293,7 +346,7 @@ client.accounts.list_api_keys(
|
|
|
293
346
|
<dl>
|
|
294
347
|
<dd>
|
|
295
348
|
|
|
296
|
-
**
|
|
349
|
+
**ids:** `String`
|
|
297
350
|
|
|
298
351
|
</dd>
|
|
299
352
|
</dl>
|
|
@@ -301,7 +354,15 @@ client.accounts.list_api_keys(
|
|
|
301
354
|
<dl>
|
|
302
355
|
<dd>
|
|
303
356
|
|
|
304
|
-
**
|
|
357
|
+
**q:** `String` — Search filter
|
|
358
|
+
|
|
359
|
+
</dd>
|
|
360
|
+
</dl>
|
|
361
|
+
|
|
362
|
+
<dl>
|
|
363
|
+
<dd>
|
|
364
|
+
|
|
365
|
+
**role:** `Schematic::Types::AccountMemberRole` — Filter by member role
|
|
305
366
|
|
|
306
367
|
</dd>
|
|
307
368
|
</dl>
|
|
@@ -337,7 +398,7 @@ client.accounts.list_api_keys(
|
|
|
337
398
|
</dl>
|
|
338
399
|
</details>
|
|
339
400
|
|
|
340
|
-
<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>
|
|
341
402
|
<dl>
|
|
342
403
|
<dd>
|
|
343
404
|
|
|
@@ -350,7 +411,7 @@ client.accounts.list_api_keys(
|
|
|
350
411
|
<dd>
|
|
351
412
|
|
|
352
413
|
```ruby
|
|
353
|
-
client.accounts.
|
|
414
|
+
client.accounts.get_account_member(account_member_id: "account_member_id")
|
|
354
415
|
```
|
|
355
416
|
</dd>
|
|
356
417
|
</dl>
|
|
@@ -365,7 +426,7 @@ client.accounts.create_api_key(name: "name")
|
|
|
365
426
|
<dl>
|
|
366
427
|
<dd>
|
|
367
428
|
|
|
368
|
-
**
|
|
429
|
+
**account_member_id:** `String` — account_member_id
|
|
369
430
|
|
|
370
431
|
</dd>
|
|
371
432
|
</dl>
|
|
@@ -373,79 +434,85 @@ client.accounts.create_api_key(name: "name")
|
|
|
373
434
|
<dl>
|
|
374
435
|
<dd>
|
|
375
436
|
|
|
376
|
-
**
|
|
437
|
+
**request_options:** `Schematic::Accounts::RequestOptions`
|
|
377
438
|
|
|
378
439
|
</dd>
|
|
379
440
|
</dl>
|
|
441
|
+
</dd>
|
|
442
|
+
</dl>
|
|
380
443
|
|
|
381
|
-
<dl>
|
|
382
|
-
<dd>
|
|
383
444
|
|
|
384
|
-
**name:** `String`
|
|
385
|
-
|
|
386
445
|
</dd>
|
|
387
446
|
</dl>
|
|
447
|
+
</details>
|
|
388
448
|
|
|
449
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">count_account_members</a>() -> Schematic::Accounts::Types::CountAccountMembersResponse</code></summary>
|
|
389
450
|
<dl>
|
|
390
451
|
<dd>
|
|
391
452
|
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
</dd>
|
|
395
|
-
</dl>
|
|
453
|
+
#### 🔌 Usage
|
|
396
454
|
|
|
397
455
|
<dl>
|
|
398
456
|
<dd>
|
|
399
457
|
|
|
400
|
-
**readonly:** `Internal::Types::Boolean`
|
|
401
|
-
|
|
402
|
-
</dd>
|
|
403
|
-
</dl>
|
|
404
|
-
|
|
405
458
|
<dl>
|
|
406
459
|
<dd>
|
|
407
460
|
|
|
408
|
-
|
|
409
|
-
|
|
461
|
+
```ruby
|
|
462
|
+
client.accounts.count_account_members(
|
|
463
|
+
ids: ["ids"],
|
|
464
|
+
q: "q",
|
|
465
|
+
role: "admin",
|
|
466
|
+
limit: 1000000,
|
|
467
|
+
offset: 1000000
|
|
468
|
+
)
|
|
469
|
+
```
|
|
410
470
|
</dd>
|
|
411
471
|
</dl>
|
|
412
472
|
</dd>
|
|
413
473
|
</dl>
|
|
414
474
|
|
|
475
|
+
#### ⚙️ Parameters
|
|
415
476
|
|
|
416
|
-
</dd>
|
|
417
|
-
</dl>
|
|
418
|
-
</details>
|
|
419
|
-
|
|
420
|
-
<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>
|
|
421
477
|
<dl>
|
|
422
478
|
<dd>
|
|
423
479
|
|
|
424
|
-
#### 🔌 Usage
|
|
425
|
-
|
|
426
480
|
<dl>
|
|
427
481
|
<dd>
|
|
428
482
|
|
|
483
|
+
**ids:** `String`
|
|
484
|
+
|
|
485
|
+
</dd>
|
|
486
|
+
</dl>
|
|
487
|
+
|
|
429
488
|
<dl>
|
|
430
489
|
<dd>
|
|
431
490
|
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
```
|
|
491
|
+
**q:** `String` — Search filter
|
|
492
|
+
|
|
435
493
|
</dd>
|
|
436
494
|
</dl>
|
|
495
|
+
|
|
496
|
+
<dl>
|
|
497
|
+
<dd>
|
|
498
|
+
|
|
499
|
+
**role:** `Schematic::Types::AccountMemberRole` — Filter by member role
|
|
500
|
+
|
|
437
501
|
</dd>
|
|
438
502
|
</dl>
|
|
439
503
|
|
|
440
|
-
#### ⚙️ Parameters
|
|
441
|
-
|
|
442
504
|
<dl>
|
|
443
505
|
<dd>
|
|
444
506
|
|
|
507
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
508
|
+
|
|
509
|
+
</dd>
|
|
510
|
+
</dl>
|
|
511
|
+
|
|
445
512
|
<dl>
|
|
446
513
|
<dd>
|
|
447
514
|
|
|
448
|
-
**
|
|
515
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
449
516
|
|
|
450
517
|
</dd>
|
|
451
518
|
</dl>
|
|
@@ -465,7 +532,7 @@ client.accounts.get_api_key(api_key_id: "api_key_id")
|
|
|
465
532
|
</dl>
|
|
466
533
|
</details>
|
|
467
534
|
|
|
468
|
-
<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>
|
|
469
536
|
<dl>
|
|
470
537
|
<dd>
|
|
471
538
|
|
|
@@ -478,7 +545,12 @@ client.accounts.get_api_key(api_key_id: "api_key_id")
|
|
|
478
545
|
<dd>
|
|
479
546
|
|
|
480
547
|
```ruby
|
|
481
|
-
client.accounts.
|
|
548
|
+
client.accounts.list_api_keys(
|
|
549
|
+
environment_id: "environment_id",
|
|
550
|
+
require_environment: true,
|
|
551
|
+
limit: 1000000,
|
|
552
|
+
offset: 1000000
|
|
553
|
+
)
|
|
482
554
|
```
|
|
483
555
|
</dd>
|
|
484
556
|
</dl>
|
|
@@ -493,7 +565,7 @@ client.accounts.update_api_key(api_key_id: "api_key_id")
|
|
|
493
565
|
<dl>
|
|
494
566
|
<dd>
|
|
495
567
|
|
|
496
|
-
**
|
|
568
|
+
**environment_id:** `String`
|
|
497
569
|
|
|
498
570
|
</dd>
|
|
499
571
|
</dl>
|
|
@@ -501,7 +573,7 @@ client.accounts.update_api_key(api_key_id: "api_key_id")
|
|
|
501
573
|
<dl>
|
|
502
574
|
<dd>
|
|
503
575
|
|
|
504
|
-
**
|
|
576
|
+
**require_environment:** `Internal::Types::Boolean`
|
|
505
577
|
|
|
506
578
|
</dd>
|
|
507
579
|
</dl>
|
|
@@ -509,7 +581,7 @@ client.accounts.update_api_key(api_key_id: "api_key_id")
|
|
|
509
581
|
<dl>
|
|
510
582
|
<dd>
|
|
511
583
|
|
|
512
|
-
**
|
|
584
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
513
585
|
|
|
514
586
|
</dd>
|
|
515
587
|
</dl>
|
|
@@ -517,7 +589,7 @@ client.accounts.update_api_key(api_key_id: "api_key_id")
|
|
|
517
589
|
<dl>
|
|
518
590
|
<dd>
|
|
519
591
|
|
|
520
|
-
**
|
|
592
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
521
593
|
|
|
522
594
|
</dd>
|
|
523
595
|
</dl>
|
|
@@ -537,7 +609,7 @@ client.accounts.update_api_key(api_key_id: "api_key_id")
|
|
|
537
609
|
</dl>
|
|
538
610
|
</details>
|
|
539
611
|
|
|
540
|
-
<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>
|
|
541
613
|
<dl>
|
|
542
614
|
<dd>
|
|
543
615
|
|
|
@@ -550,7 +622,7 @@ client.accounts.update_api_key(api_key_id: "api_key_id")
|
|
|
550
622
|
<dd>
|
|
551
623
|
|
|
552
624
|
```ruby
|
|
553
|
-
client.accounts.
|
|
625
|
+
client.accounts.get_api_key(api_key_id: "api_key_id")
|
|
554
626
|
```
|
|
555
627
|
</dd>
|
|
556
628
|
</dl>
|
|
@@ -986,7 +1058,7 @@ client.accounts.list_environments(
|
|
|
986
1058
|
</dl>
|
|
987
1059
|
</details>
|
|
988
1060
|
|
|
989
|
-
<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>
|
|
990
1062
|
<dl>
|
|
991
1063
|
<dd>
|
|
992
1064
|
|
|
@@ -999,10 +1071,7 @@ client.accounts.list_environments(
|
|
|
999
1071
|
<dd>
|
|
1000
1072
|
|
|
1001
1073
|
```ruby
|
|
1002
|
-
client.accounts.
|
|
1003
|
-
environment_type: "development",
|
|
1004
|
-
name: "name"
|
|
1005
|
-
)
|
|
1074
|
+
client.accounts.get_environment(environment_id: "environment_id")
|
|
1006
1075
|
```
|
|
1007
1076
|
</dd>
|
|
1008
1077
|
</dl>
|
|
@@ -1017,15 +1086,7 @@ client.accounts.create_environment(
|
|
|
1017
1086
|
<dl>
|
|
1018
1087
|
<dd>
|
|
1019
1088
|
|
|
1020
|
-
**
|
|
1021
|
-
|
|
1022
|
-
</dd>
|
|
1023
|
-
</dl>
|
|
1024
|
-
|
|
1025
|
-
<dl>
|
|
1026
|
-
<dd>
|
|
1027
|
-
|
|
1028
|
-
**name:** `String`
|
|
1089
|
+
**environment_id:** `String` — environment_id
|
|
1029
1090
|
|
|
1030
1091
|
</dd>
|
|
1031
1092
|
</dl>
|
|
@@ -1045,7 +1106,7 @@ client.accounts.create_environment(
|
|
|
1045
1106
|
</dl>
|
|
1046
1107
|
</details>
|
|
1047
1108
|
|
|
1048
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">
|
|
1109
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">get_onboarding_state</a>() -> Schematic::Accounts::Types::GetOnboardingStateResponse</code></summary>
|
|
1049
1110
|
<dl>
|
|
1050
1111
|
<dd>
|
|
1051
1112
|
|
|
@@ -1058,7 +1119,7 @@ client.accounts.create_environment(
|
|
|
1058
1119
|
<dd>
|
|
1059
1120
|
|
|
1060
1121
|
```ruby
|
|
1061
|
-
client.accounts.
|
|
1122
|
+
client.accounts.get_onboarding_state
|
|
1062
1123
|
```
|
|
1063
1124
|
</dd>
|
|
1064
1125
|
</dl>
|
|
@@ -1073,14 +1134,6 @@ client.accounts.get_environment(environment_id: "environment_id")
|
|
|
1073
1134
|
<dl>
|
|
1074
1135
|
<dd>
|
|
1075
1136
|
|
|
1076
|
-
**environment_id:** `String` — environment_id
|
|
1077
|
-
|
|
1078
|
-
</dd>
|
|
1079
|
-
</dl>
|
|
1080
|
-
|
|
1081
|
-
<dl>
|
|
1082
|
-
<dd>
|
|
1083
|
-
|
|
1084
1137
|
**request_options:** `Schematic::Accounts::RequestOptions`
|
|
1085
1138
|
|
|
1086
1139
|
</dd>
|
|
@@ -1093,7 +1146,7 @@ client.accounts.get_environment(environment_id: "environment_id")
|
|
|
1093
1146
|
</dl>
|
|
1094
1147
|
</details>
|
|
1095
1148
|
|
|
1096
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">
|
|
1149
|
+
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">update_onboarding_state</a>(request) -> Schematic::Accounts::Types::UpdateOnboardingStateResponse</code></summary>
|
|
1097
1150
|
<dl>
|
|
1098
1151
|
<dd>
|
|
1099
1152
|
|
|
@@ -1106,7 +1159,7 @@ client.accounts.get_environment(environment_id: "environment_id")
|
|
|
1106
1159
|
<dd>
|
|
1107
1160
|
|
|
1108
1161
|
```ruby
|
|
1109
|
-
client.accounts.
|
|
1162
|
+
client.accounts.update_onboarding_state
|
|
1110
1163
|
```
|
|
1111
1164
|
</dd>
|
|
1112
1165
|
</dl>
|
|
@@ -1121,167 +1174,7 @@ client.accounts.update_environment(environment_id: "environment_id")
|
|
|
1121
1174
|
<dl>
|
|
1122
1175
|
<dd>
|
|
1123
1176
|
|
|
1124
|
-
**
|
|
1125
|
-
|
|
1126
|
-
</dd>
|
|
1127
|
-
</dl>
|
|
1128
|
-
|
|
1129
|
-
<dl>
|
|
1130
|
-
<dd>
|
|
1131
|
-
|
|
1132
|
-
**environment_type:** `Schematic::Types::EnvironmentType`
|
|
1133
|
-
|
|
1134
|
-
</dd>
|
|
1135
|
-
</dl>
|
|
1136
|
-
|
|
1137
|
-
<dl>
|
|
1138
|
-
<dd>
|
|
1139
|
-
|
|
1140
|
-
**name:** `String`
|
|
1141
|
-
|
|
1142
|
-
</dd>
|
|
1143
|
-
</dl>
|
|
1144
|
-
|
|
1145
|
-
<dl>
|
|
1146
|
-
<dd>
|
|
1147
|
-
|
|
1148
|
-
**require_context_signature:** `Internal::Types::Boolean`
|
|
1149
|
-
|
|
1150
|
-
</dd>
|
|
1151
|
-
</dl>
|
|
1152
|
-
|
|
1153
|
-
<dl>
|
|
1154
|
-
<dd>
|
|
1155
|
-
|
|
1156
|
-
**request_options:** `Schematic::Accounts::RequestOptions`
|
|
1157
|
-
|
|
1158
|
-
</dd>
|
|
1159
|
-
</dl>
|
|
1160
|
-
</dd>
|
|
1161
|
-
</dl>
|
|
1162
|
-
|
|
1163
|
-
|
|
1164
|
-
</dd>
|
|
1165
|
-
</dl>
|
|
1166
|
-
</details>
|
|
1167
|
-
|
|
1168
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">delete_environment</a>(environment_id:) -> Schematic::Accounts::Types::DeleteEnvironmentResponse</code></summary>
|
|
1169
|
-
<dl>
|
|
1170
|
-
<dd>
|
|
1171
|
-
|
|
1172
|
-
#### 🔌 Usage
|
|
1173
|
-
|
|
1174
|
-
<dl>
|
|
1175
|
-
<dd>
|
|
1176
|
-
|
|
1177
|
-
<dl>
|
|
1178
|
-
<dd>
|
|
1179
|
-
|
|
1180
|
-
```ruby
|
|
1181
|
-
client.accounts.delete_environment(environment_id: "environment_id")
|
|
1182
|
-
```
|
|
1183
|
-
</dd>
|
|
1184
|
-
</dl>
|
|
1185
|
-
</dd>
|
|
1186
|
-
</dl>
|
|
1187
|
-
|
|
1188
|
-
#### ⚙️ Parameters
|
|
1189
|
-
|
|
1190
|
-
<dl>
|
|
1191
|
-
<dd>
|
|
1192
|
-
|
|
1193
|
-
<dl>
|
|
1194
|
-
<dd>
|
|
1195
|
-
|
|
1196
|
-
**environment_id:** `String` — environment_id
|
|
1197
|
-
|
|
1198
|
-
</dd>
|
|
1199
|
-
</dl>
|
|
1200
|
-
|
|
1201
|
-
<dl>
|
|
1202
|
-
<dd>
|
|
1203
|
-
|
|
1204
|
-
**request_options:** `Schematic::Accounts::RequestOptions`
|
|
1205
|
-
|
|
1206
|
-
</dd>
|
|
1207
|
-
</dl>
|
|
1208
|
-
</dd>
|
|
1209
|
-
</dl>
|
|
1210
|
-
|
|
1211
|
-
|
|
1212
|
-
</dd>
|
|
1213
|
-
</dl>
|
|
1214
|
-
</details>
|
|
1215
|
-
|
|
1216
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">get_onboarding_state</a>() -> Schematic::Accounts::Types::GetOnboardingStateResponse</code></summary>
|
|
1217
|
-
<dl>
|
|
1218
|
-
<dd>
|
|
1219
|
-
|
|
1220
|
-
#### 🔌 Usage
|
|
1221
|
-
|
|
1222
|
-
<dl>
|
|
1223
|
-
<dd>
|
|
1224
|
-
|
|
1225
|
-
<dl>
|
|
1226
|
-
<dd>
|
|
1227
|
-
|
|
1228
|
-
```ruby
|
|
1229
|
-
client.accounts.get_onboarding_state
|
|
1230
|
-
```
|
|
1231
|
-
</dd>
|
|
1232
|
-
</dl>
|
|
1233
|
-
</dd>
|
|
1234
|
-
</dl>
|
|
1235
|
-
|
|
1236
|
-
#### ⚙️ Parameters
|
|
1237
|
-
|
|
1238
|
-
<dl>
|
|
1239
|
-
<dd>
|
|
1240
|
-
|
|
1241
|
-
<dl>
|
|
1242
|
-
<dd>
|
|
1243
|
-
|
|
1244
|
-
**request_options:** `Schematic::Accounts::RequestOptions`
|
|
1245
|
-
|
|
1246
|
-
</dd>
|
|
1247
|
-
</dl>
|
|
1248
|
-
</dd>
|
|
1249
|
-
</dl>
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
</dd>
|
|
1253
|
-
</dl>
|
|
1254
|
-
</details>
|
|
1255
|
-
|
|
1256
|
-
<details><summary><code>client.accounts.<a href="/lib/schematic/accounts/client.rb">update_onboarding_state</a>(request) -> Schematic::Accounts::Types::UpdateOnboardingStateResponse</code></summary>
|
|
1257
|
-
<dl>
|
|
1258
|
-
<dd>
|
|
1259
|
-
|
|
1260
|
-
#### 🔌 Usage
|
|
1261
|
-
|
|
1262
|
-
<dl>
|
|
1263
|
-
<dd>
|
|
1264
|
-
|
|
1265
|
-
<dl>
|
|
1266
|
-
<dd>
|
|
1267
|
-
|
|
1268
|
-
```ruby
|
|
1269
|
-
client.accounts.update_onboarding_state
|
|
1270
|
-
```
|
|
1271
|
-
</dd>
|
|
1272
|
-
</dl>
|
|
1273
|
-
</dd>
|
|
1274
|
-
</dl>
|
|
1275
|
-
|
|
1276
|
-
#### ⚙️ Parameters
|
|
1277
|
-
|
|
1278
|
-
<dl>
|
|
1279
|
-
<dd>
|
|
1280
|
-
|
|
1281
|
-
<dl>
|
|
1282
|
-
<dd>
|
|
1283
|
-
|
|
1284
|
-
**country:** `String`
|
|
1177
|
+
**country:** `String`
|
|
1285
1178
|
|
|
1286
1179
|
</dd>
|
|
1287
1180
|
</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>
|
|
@@ -3839,29 +3740,624 @@ client.billing.count_billing_products(
|
|
|
3839
3740
|
<dl>
|
|
3840
3741
|
<dd>
|
|
3841
3742
|
|
|
3842
|
-
```ruby
|
|
3843
|
-
client.billing.list_company_billing_profiles(
|
|
3844
|
-
company_id: "company_id",
|
|
3845
|
-
is_default: true,
|
|
3846
|
-
provider_type: "metronome",
|
|
3847
|
-
limit: 1000000,
|
|
3848
|
-
offset: 1000000
|
|
3849
|
-
)
|
|
3850
|
-
```
|
|
3743
|
+
```ruby
|
|
3744
|
+
client.billing.list_company_billing_profiles(
|
|
3745
|
+
company_id: "company_id",
|
|
3746
|
+
is_default: true,
|
|
3747
|
+
provider_type: "metronome",
|
|
3748
|
+
limit: 1000000,
|
|
3749
|
+
offset: 1000000
|
|
3750
|
+
)
|
|
3751
|
+
```
|
|
3752
|
+
</dd>
|
|
3753
|
+
</dl>
|
|
3754
|
+
</dd>
|
|
3755
|
+
</dl>
|
|
3756
|
+
|
|
3757
|
+
#### ⚙️ Parameters
|
|
3758
|
+
|
|
3759
|
+
<dl>
|
|
3760
|
+
<dd>
|
|
3761
|
+
|
|
3762
|
+
<dl>
|
|
3763
|
+
<dd>
|
|
3764
|
+
|
|
3765
|
+
**company_id:** `String`
|
|
3766
|
+
|
|
3767
|
+
</dd>
|
|
3768
|
+
</dl>
|
|
3769
|
+
|
|
3770
|
+
<dl>
|
|
3771
|
+
<dd>
|
|
3772
|
+
|
|
3773
|
+
**is_default:** `Internal::Types::Boolean`
|
|
3774
|
+
|
|
3775
|
+
</dd>
|
|
3776
|
+
</dl>
|
|
3777
|
+
|
|
3778
|
+
<dl>
|
|
3779
|
+
<dd>
|
|
3780
|
+
|
|
3781
|
+
**provider_type:** `Schematic::Types::BillingProviderType`
|
|
3782
|
+
|
|
3783
|
+
</dd>
|
|
3784
|
+
</dl>
|
|
3785
|
+
|
|
3786
|
+
<dl>
|
|
3787
|
+
<dd>
|
|
3788
|
+
|
|
3789
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
3790
|
+
|
|
3791
|
+
</dd>
|
|
3792
|
+
</dl>
|
|
3793
|
+
|
|
3794
|
+
<dl>
|
|
3795
|
+
<dd>
|
|
3796
|
+
|
|
3797
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
3798
|
+
|
|
3799
|
+
</dd>
|
|
3800
|
+
</dl>
|
|
3801
|
+
|
|
3802
|
+
<dl>
|
|
3803
|
+
<dd>
|
|
3804
|
+
|
|
3805
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
3806
|
+
|
|
3807
|
+
</dd>
|
|
3808
|
+
</dl>
|
|
3809
|
+
</dd>
|
|
3810
|
+
</dl>
|
|
3811
|
+
|
|
3812
|
+
|
|
3813
|
+
</dd>
|
|
3814
|
+
</dl>
|
|
3815
|
+
</details>
|
|
3816
|
+
|
|
3817
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">update_company_billing_profile</a>(billing_profile_id:, request) -> Schematic::Billing::Types::UpdateCompanyBillingProfileResponse</code></summary>
|
|
3818
|
+
<dl>
|
|
3819
|
+
<dd>
|
|
3820
|
+
|
|
3821
|
+
#### 🔌 Usage
|
|
3822
|
+
|
|
3823
|
+
<dl>
|
|
3824
|
+
<dd>
|
|
3825
|
+
|
|
3826
|
+
<dl>
|
|
3827
|
+
<dd>
|
|
3828
|
+
|
|
3829
|
+
```ruby
|
|
3830
|
+
client.billing.update_company_billing_profile(
|
|
3831
|
+
billing_profile_id: "billing_profile_id",
|
|
3832
|
+
collection_method: "charge_automatically"
|
|
3833
|
+
)
|
|
3834
|
+
```
|
|
3835
|
+
</dd>
|
|
3836
|
+
</dl>
|
|
3837
|
+
</dd>
|
|
3838
|
+
</dl>
|
|
3839
|
+
|
|
3840
|
+
#### ⚙️ Parameters
|
|
3841
|
+
|
|
3842
|
+
<dl>
|
|
3843
|
+
<dd>
|
|
3844
|
+
|
|
3845
|
+
<dl>
|
|
3846
|
+
<dd>
|
|
3847
|
+
|
|
3848
|
+
**billing_profile_id:** `String` — billing_profile_id
|
|
3849
|
+
|
|
3850
|
+
</dd>
|
|
3851
|
+
</dl>
|
|
3852
|
+
|
|
3853
|
+
<dl>
|
|
3854
|
+
<dd>
|
|
3855
|
+
|
|
3856
|
+
**collection_method:** `Schematic::Types::BillingCollectionMethod`
|
|
3857
|
+
|
|
3858
|
+
</dd>
|
|
3859
|
+
</dl>
|
|
3860
|
+
|
|
3861
|
+
<dl>
|
|
3862
|
+
<dd>
|
|
3863
|
+
|
|
3864
|
+
**days_until_due:** `Integer`
|
|
3865
|
+
|
|
3866
|
+
</dd>
|
|
3867
|
+
</dl>
|
|
3868
|
+
|
|
3869
|
+
<dl>
|
|
3870
|
+
<dd>
|
|
3871
|
+
|
|
3872
|
+
**is_default:** `Internal::Types::Boolean`
|
|
3873
|
+
|
|
3874
|
+
</dd>
|
|
3875
|
+
</dl>
|
|
3876
|
+
|
|
3877
|
+
<dl>
|
|
3878
|
+
<dd>
|
|
3879
|
+
|
|
3880
|
+
**name:** `String`
|
|
3881
|
+
|
|
3882
|
+
</dd>
|
|
3883
|
+
</dl>
|
|
3884
|
+
|
|
3885
|
+
<dl>
|
|
3886
|
+
<dd>
|
|
3887
|
+
|
|
3888
|
+
**payment_method_id:** `String`
|
|
3889
|
+
|
|
3890
|
+
</dd>
|
|
3891
|
+
</dl>
|
|
3892
|
+
|
|
3893
|
+
<dl>
|
|
3894
|
+
<dd>
|
|
3895
|
+
|
|
3896
|
+
**proration_behavior:** `Schematic::Types::ProrationBehavior`
|
|
3897
|
+
|
|
3898
|
+
</dd>
|
|
3899
|
+
</dl>
|
|
3900
|
+
|
|
3901
|
+
<dl>
|
|
3902
|
+
<dd>
|
|
3903
|
+
|
|
3904
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
3905
|
+
|
|
3906
|
+
</dd>
|
|
3907
|
+
</dl>
|
|
3908
|
+
</dd>
|
|
3909
|
+
</dl>
|
|
3910
|
+
|
|
3911
|
+
|
|
3912
|
+
</dd>
|
|
3913
|
+
</dl>
|
|
3914
|
+
</details>
|
|
3915
|
+
|
|
3916
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">get_billing_settings</a>() -> Schematic::Billing::Types::GetBillingSettingsResponse</code></summary>
|
|
3917
|
+
<dl>
|
|
3918
|
+
<dd>
|
|
3919
|
+
|
|
3920
|
+
#### 🔌 Usage
|
|
3921
|
+
|
|
3922
|
+
<dl>
|
|
3923
|
+
<dd>
|
|
3924
|
+
|
|
3925
|
+
<dl>
|
|
3926
|
+
<dd>
|
|
3927
|
+
|
|
3928
|
+
```ruby
|
|
3929
|
+
client.billing.get_billing_settings
|
|
3930
|
+
```
|
|
3931
|
+
</dd>
|
|
3932
|
+
</dl>
|
|
3933
|
+
</dd>
|
|
3934
|
+
</dl>
|
|
3935
|
+
|
|
3936
|
+
#### ⚙️ Parameters
|
|
3937
|
+
|
|
3938
|
+
<dl>
|
|
3939
|
+
<dd>
|
|
3940
|
+
|
|
3941
|
+
<dl>
|
|
3942
|
+
<dd>
|
|
3943
|
+
|
|
3944
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
3945
|
+
|
|
3946
|
+
</dd>
|
|
3947
|
+
</dl>
|
|
3948
|
+
</dd>
|
|
3949
|
+
</dl>
|
|
3950
|
+
|
|
3951
|
+
|
|
3952
|
+
</dd>
|
|
3953
|
+
</dl>
|
|
3954
|
+
</details>
|
|
3955
|
+
|
|
3956
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">update_billing_settings</a>(request) -> Schematic::Billing::Types::UpdateBillingSettingsResponse</code></summary>
|
|
3957
|
+
<dl>
|
|
3958
|
+
<dd>
|
|
3959
|
+
|
|
3960
|
+
#### 🔌 Usage
|
|
3961
|
+
|
|
3962
|
+
<dl>
|
|
3963
|
+
<dd>
|
|
3964
|
+
|
|
3965
|
+
<dl>
|
|
3966
|
+
<dd>
|
|
3967
|
+
|
|
3968
|
+
```ruby
|
|
3969
|
+
client.billing.update_billing_settings
|
|
3970
|
+
```
|
|
3971
|
+
</dd>
|
|
3972
|
+
</dl>
|
|
3973
|
+
</dd>
|
|
3974
|
+
</dl>
|
|
3975
|
+
|
|
3976
|
+
#### ⚙️ Parameters
|
|
3977
|
+
|
|
3978
|
+
<dl>
|
|
3979
|
+
<dd>
|
|
3980
|
+
|
|
3981
|
+
<dl>
|
|
3982
|
+
<dd>
|
|
3983
|
+
|
|
3984
|
+
**default_provider_type:** `Schematic::Types::BillingProviderType`
|
|
3985
|
+
|
|
3986
|
+
</dd>
|
|
3987
|
+
</dl>
|
|
3988
|
+
|
|
3989
|
+
<dl>
|
|
3990
|
+
<dd>
|
|
3991
|
+
|
|
3992
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
3993
|
+
|
|
3994
|
+
</dd>
|
|
3995
|
+
</dl>
|
|
3996
|
+
</dd>
|
|
3997
|
+
</dl>
|
|
3998
|
+
|
|
3999
|
+
|
|
4000
|
+
</dd>
|
|
4001
|
+
</dl>
|
|
4002
|
+
</details>
|
|
4003
|
+
|
|
4004
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">upsert_billing_subscription</a>(request) -> Schematic::Billing::Types::UpsertBillingSubscriptionResponse</code></summary>
|
|
4005
|
+
<dl>
|
|
4006
|
+
<dd>
|
|
4007
|
+
|
|
4008
|
+
#### 🔌 Usage
|
|
4009
|
+
|
|
4010
|
+
<dl>
|
|
4011
|
+
<dd>
|
|
4012
|
+
|
|
4013
|
+
<dl>
|
|
4014
|
+
<dd>
|
|
4015
|
+
|
|
4016
|
+
```ruby
|
|
4017
|
+
client.billing.upsert_billing_subscription(
|
|
4018
|
+
cancel_at_period_end: true,
|
|
4019
|
+
currency: "aed",
|
|
4020
|
+
customer_external_id: "customer_external_id",
|
|
4021
|
+
discounts: [{
|
|
4022
|
+
coupon_external_id: "coupon_external_id",
|
|
4023
|
+
external_id: "external_id",
|
|
4024
|
+
is_active: true,
|
|
4025
|
+
started_at: "2024-01-15T09:30:00Z"
|
|
4026
|
+
}],
|
|
4027
|
+
expired_at: "2024-01-15T09:30:00Z",
|
|
4028
|
+
product_external_ids: [{
|
|
4029
|
+
currency: "aed",
|
|
4030
|
+
interval: "interval",
|
|
4031
|
+
price: 1000000,
|
|
4032
|
+
price_external_id: "price_external_id",
|
|
4033
|
+
product_external_id: "product_external_id",
|
|
4034
|
+
quantity: 1000000,
|
|
4035
|
+
usage_type: "licensed"
|
|
4036
|
+
}],
|
|
4037
|
+
subscription_external_id: "subscription_external_id",
|
|
4038
|
+
total_price: 1000000
|
|
4039
|
+
)
|
|
4040
|
+
```
|
|
4041
|
+
</dd>
|
|
4042
|
+
</dl>
|
|
4043
|
+
</dd>
|
|
4044
|
+
</dl>
|
|
4045
|
+
|
|
4046
|
+
#### ⚙️ Parameters
|
|
4047
|
+
|
|
4048
|
+
<dl>
|
|
4049
|
+
<dd>
|
|
4050
|
+
|
|
4051
|
+
<dl>
|
|
4052
|
+
<dd>
|
|
4053
|
+
|
|
4054
|
+
**application_id:** `String`
|
|
4055
|
+
|
|
4056
|
+
</dd>
|
|
4057
|
+
</dl>
|
|
4058
|
+
|
|
4059
|
+
<dl>
|
|
4060
|
+
<dd>
|
|
4061
|
+
|
|
4062
|
+
**cancel_at:** `Integer`
|
|
4063
|
+
|
|
4064
|
+
</dd>
|
|
4065
|
+
</dl>
|
|
4066
|
+
|
|
4067
|
+
<dl>
|
|
4068
|
+
<dd>
|
|
4069
|
+
|
|
4070
|
+
**cancel_at_period_end:** `Internal::Types::Boolean`
|
|
4071
|
+
|
|
4072
|
+
</dd>
|
|
4073
|
+
</dl>
|
|
4074
|
+
|
|
4075
|
+
<dl>
|
|
4076
|
+
<dd>
|
|
4077
|
+
|
|
4078
|
+
**company_id:** `String`
|
|
4079
|
+
|
|
4080
|
+
</dd>
|
|
4081
|
+
</dl>
|
|
4082
|
+
|
|
4083
|
+
<dl>
|
|
4084
|
+
<dd>
|
|
4085
|
+
|
|
4086
|
+
**currency:** `Schematic::Types::Currency`
|
|
4087
|
+
|
|
4088
|
+
</dd>
|
|
4089
|
+
</dl>
|
|
4090
|
+
|
|
4091
|
+
<dl>
|
|
4092
|
+
<dd>
|
|
4093
|
+
|
|
4094
|
+
**customer_external_id:** `String`
|
|
4095
|
+
|
|
4096
|
+
</dd>
|
|
4097
|
+
</dl>
|
|
4098
|
+
|
|
4099
|
+
<dl>
|
|
4100
|
+
<dd>
|
|
4101
|
+
|
|
4102
|
+
**default_payment_method_external_id:** `String`
|
|
4103
|
+
|
|
4104
|
+
</dd>
|
|
4105
|
+
</dl>
|
|
4106
|
+
|
|
4107
|
+
<dl>
|
|
4108
|
+
<dd>
|
|
4109
|
+
|
|
4110
|
+
**default_payment_method_id:** `String`
|
|
4111
|
+
|
|
4112
|
+
</dd>
|
|
4113
|
+
</dl>
|
|
4114
|
+
|
|
4115
|
+
<dl>
|
|
4116
|
+
<dd>
|
|
4117
|
+
|
|
4118
|
+
**discounts:** `Internal::Types::Array[Schematic::Types::BillingSubscriptionDiscount]`
|
|
4119
|
+
|
|
4120
|
+
</dd>
|
|
4121
|
+
</dl>
|
|
4122
|
+
|
|
4123
|
+
<dl>
|
|
4124
|
+
<dd>
|
|
4125
|
+
|
|
4126
|
+
**expired_at:** `String`
|
|
4127
|
+
|
|
4128
|
+
</dd>
|
|
4129
|
+
</dl>
|
|
4130
|
+
|
|
4131
|
+
<dl>
|
|
4132
|
+
<dd>
|
|
4133
|
+
|
|
4134
|
+
**interval:** `String`
|
|
4135
|
+
|
|
4136
|
+
</dd>
|
|
4137
|
+
</dl>
|
|
4138
|
+
|
|
4139
|
+
<dl>
|
|
4140
|
+
<dd>
|
|
4141
|
+
|
|
4142
|
+
**metadata:** `Internal::Types::Hash[String, Object]`
|
|
4143
|
+
|
|
4144
|
+
</dd>
|
|
4145
|
+
</dl>
|
|
4146
|
+
|
|
4147
|
+
<dl>
|
|
4148
|
+
<dd>
|
|
4149
|
+
|
|
4150
|
+
**period_end:** `Integer`
|
|
4151
|
+
|
|
4152
|
+
</dd>
|
|
4153
|
+
</dl>
|
|
4154
|
+
|
|
4155
|
+
<dl>
|
|
4156
|
+
<dd>
|
|
4157
|
+
|
|
4158
|
+
**period_start:** `Integer`
|
|
4159
|
+
|
|
4160
|
+
</dd>
|
|
4161
|
+
</dl>
|
|
4162
|
+
|
|
4163
|
+
<dl>
|
|
4164
|
+
<dd>
|
|
4165
|
+
|
|
4166
|
+
**product_external_ids:** `Internal::Types::Array[Schematic::Types::BillingProductPricing]`
|
|
4167
|
+
|
|
4168
|
+
</dd>
|
|
4169
|
+
</dl>
|
|
4170
|
+
|
|
4171
|
+
<dl>
|
|
4172
|
+
<dd>
|
|
4173
|
+
|
|
4174
|
+
**provider_type:** `Schematic::Types::BillingProviderType`
|
|
4175
|
+
|
|
4176
|
+
</dd>
|
|
4177
|
+
</dl>
|
|
4178
|
+
|
|
4179
|
+
<dl>
|
|
4180
|
+
<dd>
|
|
4181
|
+
|
|
4182
|
+
**started_at:** `String`
|
|
4183
|
+
|
|
4184
|
+
</dd>
|
|
4185
|
+
</dl>
|
|
4186
|
+
|
|
4187
|
+
<dl>
|
|
4188
|
+
<dd>
|
|
4189
|
+
|
|
4190
|
+
**status:** `String`
|
|
4191
|
+
|
|
4192
|
+
</dd>
|
|
4193
|
+
</dl>
|
|
4194
|
+
|
|
4195
|
+
<dl>
|
|
4196
|
+
<dd>
|
|
4197
|
+
|
|
4198
|
+
**subscription_external_id:** `String`
|
|
4199
|
+
|
|
4200
|
+
</dd>
|
|
4201
|
+
</dl>
|
|
4202
|
+
|
|
4203
|
+
<dl>
|
|
4204
|
+
<dd>
|
|
4205
|
+
|
|
4206
|
+
**total_price:** `Integer`
|
|
4207
|
+
|
|
4208
|
+
</dd>
|
|
4209
|
+
</dl>
|
|
4210
|
+
|
|
4211
|
+
<dl>
|
|
4212
|
+
<dd>
|
|
4213
|
+
|
|
4214
|
+
**trial_end:** `Integer`
|
|
4215
|
+
|
|
4216
|
+
</dd>
|
|
4217
|
+
</dl>
|
|
4218
|
+
|
|
4219
|
+
<dl>
|
|
4220
|
+
<dd>
|
|
4221
|
+
|
|
4222
|
+
**trial_end_setting:** `Schematic::Types::BillingSubscriptionTrialEndSetting`
|
|
4223
|
+
|
|
4224
|
+
</dd>
|
|
4225
|
+
</dl>
|
|
4226
|
+
|
|
4227
|
+
<dl>
|
|
4228
|
+
<dd>
|
|
4229
|
+
|
|
4230
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
4231
|
+
|
|
4232
|
+
</dd>
|
|
4233
|
+
</dl>
|
|
4234
|
+
</dd>
|
|
4235
|
+
</dl>
|
|
4236
|
+
|
|
4237
|
+
|
|
4238
|
+
</dd>
|
|
4239
|
+
</dl>
|
|
4240
|
+
</details>
|
|
4241
|
+
|
|
4242
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">get_company_native_subscription</a>(company_id:) -> Schematic::Billing::Types::GetCompanyNativeSubscriptionResponse</code></summary>
|
|
4243
|
+
<dl>
|
|
4244
|
+
<dd>
|
|
4245
|
+
|
|
4246
|
+
#### 🔌 Usage
|
|
4247
|
+
|
|
4248
|
+
<dl>
|
|
4249
|
+
<dd>
|
|
4250
|
+
|
|
4251
|
+
<dl>
|
|
4252
|
+
<dd>
|
|
4253
|
+
|
|
4254
|
+
```ruby
|
|
4255
|
+
client.billing.get_company_native_subscription(company_id: "company_id")
|
|
4256
|
+
```
|
|
4257
|
+
</dd>
|
|
4258
|
+
</dl>
|
|
4259
|
+
</dd>
|
|
4260
|
+
</dl>
|
|
4261
|
+
|
|
4262
|
+
#### ⚙️ Parameters
|
|
4263
|
+
|
|
4264
|
+
<dl>
|
|
4265
|
+
<dd>
|
|
4266
|
+
|
|
4267
|
+
<dl>
|
|
4268
|
+
<dd>
|
|
4269
|
+
|
|
4270
|
+
**company_id:** `String` — company_id
|
|
4271
|
+
|
|
4272
|
+
</dd>
|
|
4273
|
+
</dl>
|
|
4274
|
+
|
|
4275
|
+
<dl>
|
|
4276
|
+
<dd>
|
|
4277
|
+
|
|
4278
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
4279
|
+
|
|
4280
|
+
</dd>
|
|
4281
|
+
</dl>
|
|
4282
|
+
</dd>
|
|
4283
|
+
</dl>
|
|
4284
|
+
|
|
4285
|
+
|
|
4286
|
+
</dd>
|
|
4287
|
+
</dl>
|
|
4288
|
+
</details>
|
|
4289
|
+
|
|
4290
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">list_billing_invoices</a>() -> Schematic::Billing::Types::ListBillingInvoicesResponse</code></summary>
|
|
4291
|
+
<dl>
|
|
4292
|
+
<dd>
|
|
4293
|
+
|
|
4294
|
+
#### 🔌 Usage
|
|
4295
|
+
|
|
4296
|
+
<dl>
|
|
4297
|
+
<dd>
|
|
4298
|
+
|
|
4299
|
+
<dl>
|
|
4300
|
+
<dd>
|
|
4301
|
+
|
|
4302
|
+
```ruby
|
|
4303
|
+
client.billing.list_billing_invoices(
|
|
4304
|
+
company_id: "company_id",
|
|
4305
|
+
contract_id: "contract_id",
|
|
4306
|
+
document_state: "credited",
|
|
4307
|
+
past_due: true,
|
|
4308
|
+
provider_type: "metronome",
|
|
4309
|
+
q: "q",
|
|
4310
|
+
status: "draft",
|
|
4311
|
+
limit: 1000000,
|
|
4312
|
+
offset: 1000000
|
|
4313
|
+
)
|
|
4314
|
+
```
|
|
4315
|
+
</dd>
|
|
4316
|
+
</dl>
|
|
4317
|
+
</dd>
|
|
4318
|
+
</dl>
|
|
4319
|
+
|
|
4320
|
+
#### ⚙️ Parameters
|
|
4321
|
+
|
|
4322
|
+
<dl>
|
|
4323
|
+
<dd>
|
|
4324
|
+
|
|
4325
|
+
<dl>
|
|
4326
|
+
<dd>
|
|
4327
|
+
|
|
4328
|
+
**company_id:** `String`
|
|
4329
|
+
|
|
4330
|
+
</dd>
|
|
4331
|
+
</dl>
|
|
4332
|
+
|
|
4333
|
+
<dl>
|
|
4334
|
+
<dd>
|
|
4335
|
+
|
|
4336
|
+
**contract_id:** `String`
|
|
4337
|
+
|
|
3851
4338
|
</dd>
|
|
3852
4339
|
</dl>
|
|
4340
|
+
|
|
4341
|
+
<dl>
|
|
4342
|
+
<dd>
|
|
4343
|
+
|
|
4344
|
+
**document_state:** `Schematic::Types::InvoiceDocumentState`
|
|
4345
|
+
|
|
3853
4346
|
</dd>
|
|
3854
4347
|
</dl>
|
|
3855
4348
|
|
|
3856
|
-
#### ⚙️ Parameters
|
|
3857
|
-
|
|
3858
4349
|
<dl>
|
|
3859
4350
|
<dd>
|
|
3860
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
|
+
|
|
3861
4357
|
<dl>
|
|
3862
4358
|
<dd>
|
|
3863
4359
|
|
|
3864
|
-
**
|
|
4360
|
+
**provider_type:** `Schematic::Types::BillingProviderType` — Only invoices from this billing provider. Leave empty for invoices from Schematic and Stripe.
|
|
3865
4361
|
|
|
3866
4362
|
</dd>
|
|
3867
4363
|
</dl>
|
|
@@ -3869,7 +4365,7 @@ client.billing.list_company_billing_profiles(
|
|
|
3869
4365
|
<dl>
|
|
3870
4366
|
<dd>
|
|
3871
4367
|
|
|
3872
|
-
**
|
|
4368
|
+
**q:** `String` — Search by invoice number, provider invoice ID or company name.
|
|
3873
4369
|
|
|
3874
4370
|
</dd>
|
|
3875
4371
|
</dl>
|
|
@@ -3877,7 +4373,7 @@ client.billing.list_company_billing_profiles(
|
|
|
3877
4373
|
<dl>
|
|
3878
4374
|
<dd>
|
|
3879
4375
|
|
|
3880
|
-
**
|
|
4376
|
+
**status:** `Schematic::Types::InvoiceStatus`
|
|
3881
4377
|
|
|
3882
4378
|
</dd>
|
|
3883
4379
|
</dl>
|
|
@@ -3913,7 +4409,7 @@ client.billing.list_company_billing_profiles(
|
|
|
3913
4409
|
</dl>
|
|
3914
4410
|
</details>
|
|
3915
4411
|
|
|
3916
|
-
<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>
|
|
3917
4413
|
<dl>
|
|
3918
4414
|
<dd>
|
|
3919
4415
|
|
|
@@ -3926,10 +4422,7 @@ client.billing.list_company_billing_profiles(
|
|
|
3926
4422
|
<dd>
|
|
3927
4423
|
|
|
3928
4424
|
```ruby
|
|
3929
|
-
client.billing.
|
|
3930
|
-
billing_profile_id: "billing_profile_id",
|
|
3931
|
-
collection_method: "charge_automatically"
|
|
3932
|
-
)
|
|
4425
|
+
client.billing.get_billing_invoice(invoice_id: "invoice_id")
|
|
3933
4426
|
```
|
|
3934
4427
|
</dd>
|
|
3935
4428
|
</dl>
|
|
@@ -3944,7 +4437,7 @@ client.billing.update_company_billing_profile(
|
|
|
3944
4437
|
<dl>
|
|
3945
4438
|
<dd>
|
|
3946
4439
|
|
|
3947
|
-
**
|
|
4440
|
+
**invoice_id:** `String` — invoice_id
|
|
3948
4441
|
|
|
3949
4442
|
</dd>
|
|
3950
4443
|
</dl>
|
|
@@ -3952,47 +4445,47 @@ client.billing.update_company_billing_profile(
|
|
|
3952
4445
|
<dl>
|
|
3953
4446
|
<dd>
|
|
3954
4447
|
|
|
3955
|
-
**
|
|
4448
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
3956
4449
|
|
|
3957
4450
|
</dd>
|
|
3958
4451
|
</dl>
|
|
4452
|
+
</dd>
|
|
4453
|
+
</dl>
|
|
3959
4454
|
|
|
3960
|
-
<dl>
|
|
3961
|
-
<dd>
|
|
3962
4455
|
|
|
3963
|
-
**days_until_due:** `Integer`
|
|
3964
|
-
|
|
3965
4456
|
</dd>
|
|
3966
4457
|
</dl>
|
|
4458
|
+
</details>
|
|
3967
4459
|
|
|
4460
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">export_native_invoice</a>(invoice_id:) -> String</code></summary>
|
|
3968
4461
|
<dl>
|
|
3969
4462
|
<dd>
|
|
3970
4463
|
|
|
3971
|
-
|
|
3972
|
-
|
|
3973
|
-
</dd>
|
|
3974
|
-
</dl>
|
|
4464
|
+
#### 🔌 Usage
|
|
3975
4465
|
|
|
3976
4466
|
<dl>
|
|
3977
4467
|
<dd>
|
|
3978
4468
|
|
|
3979
|
-
**name:** `String`
|
|
3980
|
-
|
|
3981
|
-
</dd>
|
|
3982
|
-
</dl>
|
|
3983
|
-
|
|
3984
4469
|
<dl>
|
|
3985
4470
|
<dd>
|
|
3986
4471
|
|
|
3987
|
-
|
|
3988
|
-
|
|
4472
|
+
```ruby
|
|
4473
|
+
client.billing.export_native_invoice(invoice_id: "invoice_id")
|
|
4474
|
+
```
|
|
4475
|
+
</dd>
|
|
4476
|
+
</dl>
|
|
3989
4477
|
</dd>
|
|
3990
4478
|
</dl>
|
|
3991
4479
|
|
|
4480
|
+
#### ⚙️ Parameters
|
|
4481
|
+
|
|
3992
4482
|
<dl>
|
|
3993
4483
|
<dd>
|
|
3994
4484
|
|
|
3995
|
-
|
|
4485
|
+
<dl>
|
|
4486
|
+
<dd>
|
|
4487
|
+
|
|
4488
|
+
**invoice_id:** `String` — invoice_id
|
|
3996
4489
|
|
|
3997
4490
|
</dd>
|
|
3998
4491
|
</dl>
|
|
@@ -4012,7 +4505,7 @@ client.billing.update_company_billing_profile(
|
|
|
4012
4505
|
</dl>
|
|
4013
4506
|
</details>
|
|
4014
4507
|
|
|
4015
|
-
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">
|
|
4508
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">finalize_native_invoice</a>(invoice_id:) -> Schematic::Billing::Types::FinalizeNativeInvoiceResponse</code></summary>
|
|
4016
4509
|
<dl>
|
|
4017
4510
|
<dd>
|
|
4018
4511
|
|
|
@@ -4025,7 +4518,7 @@ client.billing.update_company_billing_profile(
|
|
|
4025
4518
|
<dd>
|
|
4026
4519
|
|
|
4027
4520
|
```ruby
|
|
4028
|
-
client.billing.
|
|
4521
|
+
client.billing.finalize_native_invoice(invoice_id: "invoice_id")
|
|
4029
4522
|
```
|
|
4030
4523
|
</dd>
|
|
4031
4524
|
</dl>
|
|
@@ -4040,6 +4533,14 @@ client.billing.get_billing_settings
|
|
|
4040
4533
|
<dl>
|
|
4041
4534
|
<dd>
|
|
4042
4535
|
|
|
4536
|
+
**invoice_id:** `String` — invoice_id
|
|
4537
|
+
|
|
4538
|
+
</dd>
|
|
4539
|
+
</dl>
|
|
4540
|
+
|
|
4541
|
+
<dl>
|
|
4542
|
+
<dd>
|
|
4543
|
+
|
|
4043
4544
|
**request_options:** `Schematic::Billing::RequestOptions`
|
|
4044
4545
|
|
|
4045
4546
|
</dd>
|
|
@@ -4052,7 +4553,7 @@ client.billing.get_billing_settings
|
|
|
4052
4553
|
</dl>
|
|
4053
4554
|
</details>
|
|
4054
4555
|
|
|
4055
|
-
<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>
|
|
4056
4557
|
<dl>
|
|
4057
4558
|
<dd>
|
|
4058
4559
|
|
|
@@ -4065,7 +4566,10 @@ client.billing.get_billing_settings
|
|
|
4065
4566
|
<dd>
|
|
4066
4567
|
|
|
4067
4568
|
```ruby
|
|
4068
|
-
client.billing.
|
|
4569
|
+
client.billing.mark_billing_invoice_paid(
|
|
4570
|
+
invoice_id: "invoice_id",
|
|
4571
|
+
idempotency_key: "idempotency_key"
|
|
4572
|
+
)
|
|
4069
4573
|
```
|
|
4070
4574
|
</dd>
|
|
4071
4575
|
</dl>
|
|
@@ -4080,7 +4584,39 @@ client.billing.update_billing_settings
|
|
|
4080
4584
|
<dl>
|
|
4081
4585
|
<dd>
|
|
4082
4586
|
|
|
4083
|
-
**
|
|
4587
|
+
**invoice_id:** `String` — invoice_id
|
|
4588
|
+
|
|
4589
|
+
</dd>
|
|
4590
|
+
</dl>
|
|
4591
|
+
|
|
4592
|
+
<dl>
|
|
4593
|
+
<dd>
|
|
4594
|
+
|
|
4595
|
+
**amount:** `Integer` — Amount paid, in minor units of the invoice's currency. Leave empty to mark the whole remaining amount as paid.
|
|
4596
|
+
|
|
4597
|
+
</dd>
|
|
4598
|
+
</dl>
|
|
4599
|
+
|
|
4600
|
+
<dl>
|
|
4601
|
+
<dd>
|
|
4602
|
+
|
|
4603
|
+
**idempotency_key:** `String` — A retry with the same key records the payment once.
|
|
4604
|
+
|
|
4605
|
+
</dd>
|
|
4606
|
+
</dl>
|
|
4607
|
+
|
|
4608
|
+
<dl>
|
|
4609
|
+
<dd>
|
|
4610
|
+
|
|
4611
|
+
**reference:** `String` — A note that identifies the payment, such as a bank transfer reference.
|
|
4612
|
+
|
|
4613
|
+
</dd>
|
|
4614
|
+
</dl>
|
|
4615
|
+
|
|
4616
|
+
<dl>
|
|
4617
|
+
<dd>
|
|
4618
|
+
|
|
4619
|
+
**settled_at:** `String` — When the payment arrived. Defaults to now, and cannot be in the future.
|
|
4084
4620
|
|
|
4085
4621
|
</dd>
|
|
4086
4622
|
</dl>
|
|
@@ -4100,7 +4636,7 @@ client.billing.update_billing_settings
|
|
|
4100
4636
|
</dl>
|
|
4101
4637
|
</details>
|
|
4102
4638
|
|
|
4103
|
-
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">
|
|
4639
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">download_native_invoice_pdf</a>(invoice_id:) -> String</code></summary>
|
|
4104
4640
|
<dl>
|
|
4105
4641
|
<dd>
|
|
4106
4642
|
|
|
@@ -4113,29 +4649,7 @@ client.billing.update_billing_settings
|
|
|
4113
4649
|
<dd>
|
|
4114
4650
|
|
|
4115
4651
|
```ruby
|
|
4116
|
-
client.billing.
|
|
4117
|
-
cancel_at_period_end: true,
|
|
4118
|
-
currency: "aed",
|
|
4119
|
-
customer_external_id: "customer_external_id",
|
|
4120
|
-
discounts: [{
|
|
4121
|
-
coupon_external_id: "coupon_external_id",
|
|
4122
|
-
external_id: "external_id",
|
|
4123
|
-
is_active: true,
|
|
4124
|
-
started_at: "2024-01-15T09:30:00Z"
|
|
4125
|
-
}],
|
|
4126
|
-
expired_at: "2024-01-15T09:30:00Z",
|
|
4127
|
-
product_external_ids: [{
|
|
4128
|
-
currency: "aed",
|
|
4129
|
-
interval: "interval",
|
|
4130
|
-
price: 1000000,
|
|
4131
|
-
price_external_id: "price_external_id",
|
|
4132
|
-
product_external_id: "product_external_id",
|
|
4133
|
-
quantity: 1000000,
|
|
4134
|
-
usage_type: "licensed"
|
|
4135
|
-
}],
|
|
4136
|
-
subscription_external_id: "subscription_external_id",
|
|
4137
|
-
total_price: 1000000
|
|
4138
|
-
)
|
|
4652
|
+
client.billing.download_native_invoice_pdf(invoice_id: "invoice_id")
|
|
4139
4653
|
```
|
|
4140
4654
|
</dd>
|
|
4141
4655
|
</dl>
|
|
@@ -4150,7 +4664,7 @@ client.billing.upsert_billing_subscription(
|
|
|
4150
4664
|
<dl>
|
|
4151
4665
|
<dd>
|
|
4152
4666
|
|
|
4153
|
-
**
|
|
4667
|
+
**invoice_id:** `String` — invoice_id
|
|
4154
4668
|
|
|
4155
4669
|
</dd>
|
|
4156
4670
|
</dl>
|
|
@@ -4158,55 +4672,47 @@ client.billing.upsert_billing_subscription(
|
|
|
4158
4672
|
<dl>
|
|
4159
4673
|
<dd>
|
|
4160
4674
|
|
|
4161
|
-
**
|
|
4675
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
4162
4676
|
|
|
4163
4677
|
</dd>
|
|
4164
4678
|
</dl>
|
|
4679
|
+
</dd>
|
|
4680
|
+
</dl>
|
|
4165
4681
|
|
|
4166
|
-
<dl>
|
|
4167
|
-
<dd>
|
|
4168
4682
|
|
|
4169
|
-
**cancel_at_period_end:** `Internal::Types::Boolean`
|
|
4170
|
-
|
|
4171
4683
|
</dd>
|
|
4172
4684
|
</dl>
|
|
4685
|
+
</details>
|
|
4173
4686
|
|
|
4687
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">void_native_invoice</a>(invoice_id:) -> Schematic::Billing::Types::VoidNativeInvoiceResponse</code></summary>
|
|
4174
4688
|
<dl>
|
|
4175
4689
|
<dd>
|
|
4176
4690
|
|
|
4177
|
-
|
|
4178
|
-
|
|
4179
|
-
</dd>
|
|
4180
|
-
</dl>
|
|
4691
|
+
#### 🔌 Usage
|
|
4181
4692
|
|
|
4182
4693
|
<dl>
|
|
4183
4694
|
<dd>
|
|
4184
4695
|
|
|
4185
|
-
**currency:** `Schematic::Types::Currency`
|
|
4186
|
-
|
|
4187
|
-
</dd>
|
|
4188
|
-
</dl>
|
|
4189
|
-
|
|
4190
4696
|
<dl>
|
|
4191
4697
|
<dd>
|
|
4192
4698
|
|
|
4193
|
-
|
|
4194
|
-
|
|
4699
|
+
```ruby
|
|
4700
|
+
client.billing.void_native_invoice(invoice_id: "invoice_id")
|
|
4701
|
+
```
|
|
4702
|
+
</dd>
|
|
4703
|
+
</dl>
|
|
4195
4704
|
</dd>
|
|
4196
4705
|
</dl>
|
|
4197
4706
|
|
|
4707
|
+
#### ⚙️ Parameters
|
|
4708
|
+
|
|
4198
4709
|
<dl>
|
|
4199
4710
|
<dd>
|
|
4200
4711
|
|
|
4201
|
-
**default_payment_method_external_id:** `String`
|
|
4202
|
-
|
|
4203
|
-
</dd>
|
|
4204
|
-
</dl>
|
|
4205
|
-
|
|
4206
4712
|
<dl>
|
|
4207
4713
|
<dd>
|
|
4208
4714
|
|
|
4209
|
-
**
|
|
4715
|
+
**invoice_id:** `String` — invoice_id
|
|
4210
4716
|
|
|
4211
4717
|
</dd>
|
|
4212
4718
|
</dl>
|
|
@@ -4214,47 +4720,57 @@ client.billing.upsert_billing_subscription(
|
|
|
4214
4720
|
<dl>
|
|
4215
4721
|
<dd>
|
|
4216
4722
|
|
|
4217
|
-
**
|
|
4723
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
4218
4724
|
|
|
4219
4725
|
</dd>
|
|
4220
4726
|
</dl>
|
|
4727
|
+
</dd>
|
|
4728
|
+
</dl>
|
|
4221
4729
|
|
|
4222
|
-
<dl>
|
|
4223
|
-
<dd>
|
|
4224
4730
|
|
|
4225
|
-
**expired_at:** `String`
|
|
4226
|
-
|
|
4227
4731
|
</dd>
|
|
4228
4732
|
</dl>
|
|
4733
|
+
</details>
|
|
4229
4734
|
|
|
4735
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">count_billing_invoices</a>() -> Schematic::Billing::Types::CountBillingInvoicesResponse</code></summary>
|
|
4230
4736
|
<dl>
|
|
4231
4737
|
<dd>
|
|
4232
4738
|
|
|
4233
|
-
|
|
4234
|
-
|
|
4235
|
-
</dd>
|
|
4236
|
-
</dl>
|
|
4739
|
+
#### 🔌 Usage
|
|
4237
4740
|
|
|
4238
4741
|
<dl>
|
|
4239
4742
|
<dd>
|
|
4240
4743
|
|
|
4241
|
-
**metadata:** `Internal::Types::Hash[String, Object]`
|
|
4242
|
-
|
|
4243
|
-
</dd>
|
|
4244
|
-
</dl>
|
|
4245
|
-
|
|
4246
4744
|
<dl>
|
|
4247
4745
|
<dd>
|
|
4248
4746
|
|
|
4249
|
-
|
|
4250
|
-
|
|
4747
|
+
```ruby
|
|
4748
|
+
client.billing.count_billing_invoices(
|
|
4749
|
+
company_id: "company_id",
|
|
4750
|
+
contract_id: "contract_id",
|
|
4751
|
+
document_state: "credited",
|
|
4752
|
+
past_due: true,
|
|
4753
|
+
provider_type: "metronome",
|
|
4754
|
+
q: "q",
|
|
4755
|
+
status: "draft",
|
|
4756
|
+
limit: 1000000,
|
|
4757
|
+
offset: 1000000
|
|
4758
|
+
)
|
|
4759
|
+
```
|
|
4760
|
+
</dd>
|
|
4761
|
+
</dl>
|
|
4251
4762
|
</dd>
|
|
4252
4763
|
</dl>
|
|
4253
4764
|
|
|
4765
|
+
#### ⚙️ Parameters
|
|
4766
|
+
|
|
4254
4767
|
<dl>
|
|
4255
4768
|
<dd>
|
|
4256
4769
|
|
|
4257
|
-
|
|
4770
|
+
<dl>
|
|
4771
|
+
<dd>
|
|
4772
|
+
|
|
4773
|
+
**company_id:** `String`
|
|
4258
4774
|
|
|
4259
4775
|
</dd>
|
|
4260
4776
|
</dl>
|
|
@@ -4262,7 +4778,7 @@ client.billing.upsert_billing_subscription(
|
|
|
4262
4778
|
<dl>
|
|
4263
4779
|
<dd>
|
|
4264
4780
|
|
|
4265
|
-
**
|
|
4781
|
+
**contract_id:** `String`
|
|
4266
4782
|
|
|
4267
4783
|
</dd>
|
|
4268
4784
|
</dl>
|
|
@@ -4270,7 +4786,7 @@ client.billing.upsert_billing_subscription(
|
|
|
4270
4786
|
<dl>
|
|
4271
4787
|
<dd>
|
|
4272
4788
|
|
|
4273
|
-
**
|
|
4789
|
+
**document_state:** `Schematic::Types::InvoiceDocumentState`
|
|
4274
4790
|
|
|
4275
4791
|
</dd>
|
|
4276
4792
|
</dl>
|
|
@@ -4278,7 +4794,7 @@ client.billing.upsert_billing_subscription(
|
|
|
4278
4794
|
<dl>
|
|
4279
4795
|
<dd>
|
|
4280
4796
|
|
|
4281
|
-
**
|
|
4797
|
+
**past_due:** `Internal::Types::Boolean` — Only open invoices with an amount left to pay whose due date has passed.
|
|
4282
4798
|
|
|
4283
4799
|
</dd>
|
|
4284
4800
|
</dl>
|
|
@@ -4286,7 +4802,7 @@ client.billing.upsert_billing_subscription(
|
|
|
4286
4802
|
<dl>
|
|
4287
4803
|
<dd>
|
|
4288
4804
|
|
|
4289
|
-
**
|
|
4805
|
+
**provider_type:** `Schematic::Types::BillingProviderType` — Only invoices from this billing provider. Leave empty for invoices from Schematic and Stripe.
|
|
4290
4806
|
|
|
4291
4807
|
</dd>
|
|
4292
4808
|
</dl>
|
|
@@ -4294,7 +4810,7 @@ client.billing.upsert_billing_subscription(
|
|
|
4294
4810
|
<dl>
|
|
4295
4811
|
<dd>
|
|
4296
4812
|
|
|
4297
|
-
**
|
|
4813
|
+
**q:** `String` — Search by invoice number, provider invoice ID or company name.
|
|
4298
4814
|
|
|
4299
4815
|
</dd>
|
|
4300
4816
|
</dl>
|
|
@@ -4302,7 +4818,7 @@ client.billing.upsert_billing_subscription(
|
|
|
4302
4818
|
<dl>
|
|
4303
4819
|
<dd>
|
|
4304
4820
|
|
|
4305
|
-
**
|
|
4821
|
+
**status:** `Schematic::Types::InvoiceStatus`
|
|
4306
4822
|
|
|
4307
4823
|
</dd>
|
|
4308
4824
|
</dl>
|
|
@@ -4310,7 +4826,7 @@ client.billing.upsert_billing_subscription(
|
|
|
4310
4826
|
<dl>
|
|
4311
4827
|
<dd>
|
|
4312
4828
|
|
|
4313
|
-
**
|
|
4829
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
4314
4830
|
|
|
4315
4831
|
</dd>
|
|
4316
4832
|
</dl>
|
|
@@ -4318,7 +4834,7 @@ client.billing.upsert_billing_subscription(
|
|
|
4318
4834
|
<dl>
|
|
4319
4835
|
<dd>
|
|
4320
4836
|
|
|
4321
|
-
**
|
|
4837
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
4322
4838
|
|
|
4323
4839
|
</dd>
|
|
4324
4840
|
</dl>
|
|
@@ -7042,7 +7558,7 @@ client.credits.create_credit_spend_policy(billing_credit_id: "billing_credit_id"
|
|
|
7042
7558
|
<dl>
|
|
7043
7559
|
<dd>
|
|
7044
7560
|
|
|
7045
|
-
**company_id:** `String` — The company the cap applies
|
|
7561
|
+
**company_id:** `String` — The company the cap applies in. Alone, it caps the whole company. With user_id, it caps that user's spend in this company. Required with user_id when the user belongs to more than one company.
|
|
7046
7562
|
|
|
7047
7563
|
</dd>
|
|
7048
7564
|
</dl>
|
|
@@ -7066,7 +7582,7 @@ client.credits.create_credit_spend_policy(billing_credit_id: "billing_credit_id"
|
|
|
7066
7582
|
<dl>
|
|
7067
7583
|
<dd>
|
|
7068
7584
|
|
|
7069
|
-
**user_id:** `String` — The user the cap applies to.
|
|
7585
|
+
**user_id:** `String` — The user the cap applies to. The user must belong to company_id, and with no company_id, to exactly one company.
|
|
7070
7586
|
|
|
7071
7587
|
</dd>
|
|
7072
7588
|
</dl>
|
|
@@ -7082,7 +7598,7 @@ client.credits.create_credit_spend_policy(billing_credit_id: "billing_credit_id"
|
|
|
7082
7598
|
<dl>
|
|
7083
7599
|
<dd>
|
|
7084
7600
|
|
|
7085
|
-
**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.
|
|
7086
7602
|
|
|
7087
7603
|
</dd>
|
|
7088
7604
|
</dl>
|
|
@@ -7469,6 +7985,7 @@ client.credits.list_credit_event_ledger(
|
|
|
7469
7985
|
end_time: "end_time",
|
|
7470
7986
|
event_type: "adjustment",
|
|
7471
7987
|
feature_id: "feature_id",
|
|
7988
|
+
source_event_id: "source_event_id",
|
|
7472
7989
|
start_time: "start_time",
|
|
7473
7990
|
limit: 1000000,
|
|
7474
7991
|
offset: 1000000
|
|
@@ -7511,39 +8028,95 @@ client.credits.list_credit_event_ledger(
|
|
|
7511
8028
|
<dl>
|
|
7512
8029
|
<dd>
|
|
7513
8030
|
|
|
7514
|
-
**event_type:** `Schematic::Types::CreditEventType`
|
|
8031
|
+
**event_type:** `Schematic::Types::CreditEventType`
|
|
8032
|
+
|
|
8033
|
+
</dd>
|
|
8034
|
+
</dl>
|
|
8035
|
+
|
|
8036
|
+
<dl>
|
|
8037
|
+
<dd>
|
|
8038
|
+
|
|
8039
|
+
**feature_id:** `String`
|
|
8040
|
+
|
|
8041
|
+
</dd>
|
|
8042
|
+
</dl>
|
|
8043
|
+
|
|
8044
|
+
<dl>
|
|
8045
|
+
<dd>
|
|
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
|
+
|
|
8055
|
+
**start_time:** `String`
|
|
8056
|
+
|
|
8057
|
+
</dd>
|
|
8058
|
+
</dl>
|
|
8059
|
+
|
|
8060
|
+
<dl>
|
|
8061
|
+
<dd>
|
|
8062
|
+
|
|
8063
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
8064
|
+
|
|
8065
|
+
</dd>
|
|
8066
|
+
</dl>
|
|
8067
|
+
|
|
8068
|
+
<dl>
|
|
8069
|
+
<dd>
|
|
8070
|
+
|
|
8071
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
8072
|
+
|
|
8073
|
+
</dd>
|
|
8074
|
+
</dl>
|
|
8075
|
+
|
|
8076
|
+
<dl>
|
|
8077
|
+
<dd>
|
|
8078
|
+
|
|
8079
|
+
**request_options:** `Schematic::Credits::RequestOptions`
|
|
7515
8080
|
|
|
7516
8081
|
</dd>
|
|
7517
8082
|
</dl>
|
|
8083
|
+
</dd>
|
|
8084
|
+
</dl>
|
|
7518
8085
|
|
|
7519
|
-
<dl>
|
|
7520
|
-
<dd>
|
|
7521
8086
|
|
|
7522
|
-
**feature_id:** `String`
|
|
7523
|
-
|
|
7524
8087
|
</dd>
|
|
7525
8088
|
</dl>
|
|
8089
|
+
</details>
|
|
7526
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>
|
|
7527
8092
|
<dl>
|
|
7528
8093
|
<dd>
|
|
7529
8094
|
|
|
7530
|
-
|
|
7531
|
-
|
|
7532
|
-
</dd>
|
|
7533
|
-
</dl>
|
|
8095
|
+
#### 🔌 Usage
|
|
7534
8096
|
|
|
7535
8097
|
<dl>
|
|
7536
8098
|
<dd>
|
|
7537
8099
|
|
|
7538
|
-
|
|
7539
|
-
|
|
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>
|
|
7540
8108
|
</dd>
|
|
7541
8109
|
</dl>
|
|
7542
8110
|
|
|
8111
|
+
#### ⚙️ Parameters
|
|
8112
|
+
|
|
7543
8113
|
<dl>
|
|
7544
8114
|
<dd>
|
|
7545
8115
|
|
|
7546
|
-
|
|
8116
|
+
<dl>
|
|
8117
|
+
<dd>
|
|
8118
|
+
|
|
8119
|
+
**ledger_entry_id:** `String` — ledger_entry_id
|
|
7547
8120
|
|
|
7548
8121
|
</dd>
|
|
7549
8122
|
</dl>
|
|
@@ -7582,6 +8155,7 @@ client.credits.count_credit_event_ledger(
|
|
|
7582
8155
|
end_time: "end_time",
|
|
7583
8156
|
event_type: "adjustment",
|
|
7584
8157
|
feature_id: "feature_id",
|
|
8158
|
+
source_event_id: "source_event_id",
|
|
7585
8159
|
start_time: "start_time",
|
|
7586
8160
|
limit: 1000000,
|
|
7587
8161
|
offset: 1000000
|
|
@@ -7640,6 +8214,14 @@ client.credits.count_credit_event_ledger(
|
|
|
7640
8214
|
<dl>
|
|
7641
8215
|
<dd>
|
|
7642
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
|
+
|
|
7643
8225
|
**start_time:** `String`
|
|
7644
8226
|
|
|
7645
8227
|
</dd>
|
|
@@ -8522,6 +9104,94 @@ client.catalogs.remove_plan(
|
|
|
8522
9104
|
</dl>
|
|
8523
9105
|
|
|
8524
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
|
+
|
|
8525
9195
|
</dd>
|
|
8526
9196
|
</dl>
|
|
8527
9197
|
</details>
|
|
@@ -9298,7 +9968,7 @@ client.companies.list_companies(
|
|
|
9298
9968
|
<dl>
|
|
9299
9969
|
<dd>
|
|
9300
9970
|
|
|
9301
|
-
**without_feature_override_for:** `String` — Filter out companies that
|
|
9971
|
+
**without_feature_override_for:** `String` — Filter out companies that have an unexpired company override for the specified feature ID
|
|
9302
9972
|
|
|
9303
9973
|
</dd>
|
|
9304
9974
|
</dl>
|
|
@@ -9694,7 +10364,7 @@ client.companies.count_companies(
|
|
|
9694
10364
|
<dl>
|
|
9695
10365
|
<dd>
|
|
9696
10366
|
|
|
9697
|
-
**without_feature_override_for:** `String` — Filter out companies that
|
|
10367
|
+
**without_feature_override_for:** `String` — Filter out companies that have an unexpired company override for the specified feature ID
|
|
9698
10368
|
|
|
9699
10369
|
</dd>
|
|
9700
10370
|
</dl>
|
|
@@ -15657,7 +16327,9 @@ client.plans.update_company_plans(
|
|
|
15657
16327
|
client.plans.list_custom_plan_billings(
|
|
15658
16328
|
company_id: "company_id",
|
|
15659
16329
|
plan_id: "plan_id",
|
|
16330
|
+
plan_version_id: "plan_version_id",
|
|
15660
16331
|
plan_billing_source: "amendment",
|
|
16332
|
+
plan_billing_sources: ["amendment"],
|
|
15661
16333
|
status: "active",
|
|
15662
16334
|
statuses: ["active"],
|
|
15663
16335
|
limit: 1000000,
|
|
@@ -15693,7 +16365,23 @@ client.plans.list_custom_plan_billings(
|
|
|
15693
16365
|
<dl>
|
|
15694
16366
|
<dd>
|
|
15695
16367
|
|
|
15696
|
-
**
|
|
16368
|
+
**plan_version_id:** `String` — Filter by the plan version the billing record was created for
|
|
16369
|
+
|
|
16370
|
+
</dd>
|
|
16371
|
+
</dl>
|
|
16372
|
+
|
|
16373
|
+
<dl>
|
|
16374
|
+
<dd>
|
|
16375
|
+
|
|
16376
|
+
**plan_billing_source:** `Schematic::Types::PlanBillingSource` — Filter by the flow that created the billing record: custom_plan for a first publish, amendment for a republish, manage_plan for a standard plan assigned by invoice. Defaults to custom_plan unless plan_billing_sources is set.
|
|
16377
|
+
|
|
16378
|
+
</dd>
|
|
16379
|
+
</dl>
|
|
16380
|
+
|
|
16381
|
+
<dl>
|
|
16382
|
+
<dd>
|
|
16383
|
+
|
|
16384
|
+
**plan_billing_sources:** `Schematic::Types::PlanBillingSource` — Filter by multiple billing sources. Takes precedence over plan_billing_source.
|
|
15697
16385
|
|
|
15698
16386
|
</dd>
|
|
15699
16387
|
</dl>
|
|
@@ -15885,6 +16573,14 @@ client.plans.retry_custom_plan_billing(
|
|
|
15885
16573
|
<dl>
|
|
15886
16574
|
<dd>
|
|
15887
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
|
+
|
|
15888
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.
|
|
15889
16585
|
|
|
15890
16586
|
</dd>
|
|
@@ -17195,55 +17891,7 @@ client.plans.publish_plan_version(
|
|
|
17195
17891
|
<dl>
|
|
17196
17892
|
<dd>
|
|
17197
17893
|
|
|
17198
|
-
**
|
|
17199
|
-
|
|
17200
|
-
</dd>
|
|
17201
|
-
</dl>
|
|
17202
|
-
|
|
17203
|
-
<dl>
|
|
17204
|
-
<dd>
|
|
17205
|
-
|
|
17206
|
-
**address:** `Schematic::Types::CustomerBillingAddress`
|
|
17207
|
-
|
|
17208
|
-
</dd>
|
|
17209
|
-
</dl>
|
|
17210
|
-
|
|
17211
|
-
<dl>
|
|
17212
|
-
<dd>
|
|
17213
|
-
|
|
17214
|
-
**billing_cycle_anchor:** `String` — The date the subscription's billing period renews on. Only honored on a first publish that starts a subscription.
|
|
17215
|
-
|
|
17216
|
-
</dd>
|
|
17217
|
-
</dl>
|
|
17218
|
-
|
|
17219
|
-
<dl>
|
|
17220
|
-
<dd>
|
|
17221
|
-
|
|
17222
|
-
**billing_start_date:** `String` — The date the contract term starts. A past date backdates the subscription so the first invoice covers the term from this date to the renewal date. Requires billing_cycle_anchor. Only honored on a first publish that starts a subscription.
|
|
17223
|
-
|
|
17224
|
-
</dd>
|
|
17225
|
-
</dl>
|
|
17226
|
-
|
|
17227
|
-
<dl>
|
|
17228
|
-
<dd>
|
|
17229
|
-
|
|
17230
|
-
**collection_method:** `Schematic::Types::BillingCollectionMethod` — How the invoice a custom-plan republish raises today is collected. send_invoice (the default) issues it for the company to pay; charge_automatically charges the default payment method straight away. Only accepted on a custom-plan republish with migration_strategy immediate and proration_behavior always_invoice.
|
|
17231
|
-
|
|
17232
|
-
</dd>
|
|
17233
|
-
</dl>
|
|
17234
|
-
|
|
17235
|
-
<dl>
|
|
17236
|
-
<dd>
|
|
17237
|
-
|
|
17238
|
-
**coupon_external_id:** `String` — A Stripe coupon to apply. On a custom-plan republish it discounts the amendment invoice and is only used when that invoice is raised today; it must exist in Stripe. It is attached to the subscription, so a repeating or forever coupon also discounts the renewals that follow.
|
|
17239
|
-
|
|
17240
|
-
</dd>
|
|
17241
|
-
</dl>
|
|
17242
|
-
|
|
17243
|
-
<dl>
|
|
17244
|
-
<dd>
|
|
17245
|
-
|
|
17246
|
-
**custom_field_values:** `Internal::Types::Array[Schematic::Types::CheckoutFieldValue]`
|
|
17894
|
+
**request:** `Schematic::Types::PublishPlanVersionRequestBody`
|
|
17247
17895
|
|
|
17248
17896
|
</dd>
|
|
17249
17897
|
</dl>
|
|
@@ -17251,79 +17899,51 @@ client.plans.publish_plan_version(
|
|
|
17251
17899
|
<dl>
|
|
17252
17900
|
<dd>
|
|
17253
17901
|
|
|
17254
|
-
**
|
|
17902
|
+
**request_options:** `Schematic::Plans::RequestOptions`
|
|
17255
17903
|
|
|
17256
17904
|
</dd>
|
|
17257
17905
|
</dl>
|
|
17258
|
-
|
|
17259
|
-
<dl>
|
|
17260
|
-
<dd>
|
|
17261
|
-
|
|
17262
|
-
**days_until_due:** `Integer` — Payment terms in days. On a custom-plan republish they apply to the amendment invoice only, leave the subscription's renewal terms unchanged, and are only used when that invoice is raised today and sent rather than charged. Defaults to the subscription's terms.
|
|
17263
|
-
|
|
17264
17906
|
</dd>
|
|
17265
17907
|
</dl>
|
|
17266
17908
|
|
|
17267
|
-
<dl>
|
|
17268
|
-
<dd>
|
|
17269
17909
|
|
|
17270
|
-
**excluded_company_ids:** `Internal::Types::Array[String]`
|
|
17271
|
-
|
|
17272
17910
|
</dd>
|
|
17273
17911
|
</dl>
|
|
17912
|
+
</details>
|
|
17274
17913
|
|
|
17914
|
+
<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>
|
|
17275
17915
|
<dl>
|
|
17276
17916
|
<dd>
|
|
17277
17917
|
|
|
17278
|
-
|
|
17279
|
-
|
|
17280
|
-
</dd>
|
|
17281
|
-
</dl>
|
|
17918
|
+
#### 🔌 Usage
|
|
17282
17919
|
|
|
17283
17920
|
<dl>
|
|
17284
17921
|
<dd>
|
|
17285
17922
|
|
|
17286
|
-
**phone:** `String`
|
|
17287
|
-
|
|
17288
|
-
</dd>
|
|
17289
|
-
</dl>
|
|
17290
|
-
|
|
17291
17923
|
<dl>
|
|
17292
17924
|
<dd>
|
|
17293
17925
|
|
|
17294
|
-
|
|
17295
|
-
|
|
17926
|
+
```ruby
|
|
17927
|
+
client.plans.preview_publish_plan_version(
|
|
17928
|
+
plan_version_id: "plan_version_id",
|
|
17929
|
+
excluded_company_ids: ["excluded_company_ids"],
|
|
17930
|
+
migration_strategy: "end_of_billing_period"
|
|
17931
|
+
)
|
|
17932
|
+
```
|
|
17296
17933
|
</dd>
|
|
17297
17934
|
</dl>
|
|
17298
|
-
|
|
17299
|
-
<dl>
|
|
17300
|
-
<dd>
|
|
17301
|
-
|
|
17302
|
-
**proration_behavior:** `Schematic::Types::MigrationProrationBehavior` — How Stripe handles the price difference when companies are migrated. With migration_strategy immediate, omitted means create_prorations. With end_of_billing_period only none is accepted and means the same as omitting it: the change lands on the renewal boundary, so there is nothing to prorate. With scheduled any value is accepted and omitted means none. Not accepted with leave.
|
|
17303
|
-
|
|
17304
17935
|
</dd>
|
|
17305
17936
|
</dl>
|
|
17306
17937
|
|
|
17307
|
-
|
|
17308
|
-
<dd>
|
|
17309
|
-
|
|
17310
|
-
**require_no_migration:** `Internal::Types::Boolean` — Refuse the publish if any company would be migrated onto the new version
|
|
17311
|
-
|
|
17312
|
-
</dd>
|
|
17313
|
-
</dl>
|
|
17938
|
+
#### ⚙️ Parameters
|
|
17314
17939
|
|
|
17315
17940
|
<dl>
|
|
17316
17941
|
<dd>
|
|
17317
17942
|
|
|
17318
|
-
**scheduled_at:** `String` — When every company moves, for migration_strategy scheduled. Must be in the future; the migration runs within about a minute of this time. Not accepted with other strategies.
|
|
17319
|
-
|
|
17320
|
-
</dd>
|
|
17321
|
-
</dl>
|
|
17322
|
-
|
|
17323
17943
|
<dl>
|
|
17324
17944
|
<dd>
|
|
17325
17945
|
|
|
17326
|
-
**
|
|
17946
|
+
**plan_version_id:** `String` — plan_version_id
|
|
17327
17947
|
|
|
17328
17948
|
</dd>
|
|
17329
17949
|
</dl>
|
|
@@ -17331,7 +17951,7 @@ client.plans.publish_plan_version(
|
|
|
17331
17951
|
<dl>
|
|
17332
17952
|
<dd>
|
|
17333
17953
|
|
|
17334
|
-
**
|
|
17954
|
+
**request:** `Schematic::Types::PublishPlanVersionRequestBody`
|
|
17335
17955
|
|
|
17336
17956
|
</dd>
|
|
17337
17957
|
</dl>
|
|
@@ -17919,6 +18539,14 @@ client.planbundle.create_custom_plan_bundle(
|
|
|
17919
18539
|
<dl>
|
|
17920
18540
|
<dd>
|
|
17921
18541
|
|
|
18542
|
+
**renewal_policy:** `Schematic::Types::RenewalPolicy`
|
|
18543
|
+
|
|
18544
|
+
</dd>
|
|
18545
|
+
</dl>
|
|
18546
|
+
|
|
18547
|
+
<dl>
|
|
18548
|
+
<dd>
|
|
18549
|
+
|
|
17922
18550
|
**request_options:** `Schematic::Planbundle::RequestOptions`
|
|
17923
18551
|
|
|
17924
18552
|
</dd>
|
|
@@ -17999,6 +18627,14 @@ client.planbundle.create_plan_bundle(
|
|
|
17999
18627
|
<dl>
|
|
18000
18628
|
<dd>
|
|
18001
18629
|
|
|
18630
|
+
**renewal_policy:** `Schematic::Types::RenewalPolicy`
|
|
18631
|
+
|
|
18632
|
+
</dd>
|
|
18633
|
+
</dl>
|
|
18634
|
+
|
|
18635
|
+
<dl>
|
|
18636
|
+
<dd>
|
|
18637
|
+
|
|
18002
18638
|
**request_options:** `Schematic::Planbundle::RequestOptions`
|
|
18003
18639
|
|
|
18004
18640
|
</dd>
|
|
@@ -18095,6 +18731,14 @@ client.planbundle.update_plan_bundle(
|
|
|
18095
18731
|
<dl>
|
|
18096
18732
|
<dd>
|
|
18097
18733
|
|
|
18734
|
+
**renewal_policy:** `Schematic::Types::RenewalPolicy`
|
|
18735
|
+
|
|
18736
|
+
</dd>
|
|
18737
|
+
</dl>
|
|
18738
|
+
|
|
18739
|
+
<dl>
|
|
18740
|
+
<dd>
|
|
18741
|
+
|
|
18098
18742
|
**request_options:** `Schematic::Planbundle::RequestOptions`
|
|
18099
18743
|
|
|
18100
18744
|
</dd>
|
|
@@ -18973,7 +19617,7 @@ client.features.list_features(
|
|
|
18973
19617
|
<dl>
|
|
18974
19618
|
<dd>
|
|
18975
19619
|
|
|
18976
|
-
**without_company_override_for:** `String` — Filter out features that
|
|
19620
|
+
**without_company_override_for:** `String` — Filter out features that have an unexpired company override for the specified company ID
|
|
18977
19621
|
|
|
18978
19622
|
</dd>
|
|
18979
19623
|
</dl>
|
|
@@ -19642,7 +20286,7 @@ client.features.count_features(
|
|
|
19642
20286
|
<dl>
|
|
19643
20287
|
<dd>
|
|
19644
20288
|
|
|
19645
|
-
**without_company_override_for:** `String` — Filter out features that
|
|
20289
|
+
**without_company_override_for:** `String` — Filter out features that have an unexpired company override for the specified company ID
|
|
19646
20290
|
|
|
19647
20291
|
</dd>
|
|
19648
20292
|
</dl>
|
|
@@ -19786,7 +20430,6 @@ client.features.list_flags(
|
|
|
19786
20430
|
|
|
19787
20431
|
```ruby
|
|
19788
20432
|
client.features.create_flag(
|
|
19789
|
-
default_value: true,
|
|
19790
20433
|
description: "description",
|
|
19791
20434
|
flag_type: "boolean",
|
|
19792
20435
|
key: "key",
|
|
@@ -19889,7 +20532,6 @@ client.features.get_flag(flag_id: "flag_id")
|
|
|
19889
20532
|
```ruby
|
|
19890
20533
|
client.features.update_flag(
|
|
19891
20534
|
flag_id: "flag_id",
|
|
19892
|
-
default_value: true,
|
|
19893
20535
|
description: "description",
|
|
19894
20536
|
flag_type: "boolean",
|
|
19895
20537
|
key: "key",
|
|
@@ -20160,7 +20802,7 @@ client.features.check_and_reserve_flag(key: "key")
|
|
|
20160
20802
|
<dl>
|
|
20161
20803
|
<dd>
|
|
20162
20804
|
|
|
20163
|
-
**expires_at:** `String` — When the hold lapses if no track event settles it; defaults to one minute from now and may be at most one hour out. The unspent hold is refunded on expiry
|
|
20805
|
+
**expires_at:** `String` — When the hold lapses if no track or inference event settles it; defaults to one minute from now and may be at most one hour out. The unspent hold is refunded on expiry
|
|
20164
20806
|
|
|
20165
20807
|
</dd>
|
|
20166
20808
|
</dl>
|
|
@@ -20176,7 +20818,7 @@ client.features.check_and_reserve_flag(key: "key")
|
|
|
20176
20818
|
<dl>
|
|
20177
20819
|
<dd>
|
|
20178
20820
|
|
|
20179
|
-
**preflight:** `Schematic::Types::PreflightRequestBody` — Hypothetical usage to evaluate the flag against. When credit_cost names the entitlement's credit, that cost is what gets held; otherwise the hold is the entitlement's consumption rate times quantity, or, when quantity is omitted, times the usage stated here
|
|
20821
|
+
**preflight:** `Schematic::Types::PreflightRequestBody` — Hypothetical usage to evaluate the flag against. When credit_cost names the entitlement's credit, that cost is what gets held; otherwise, when event_quantities names the entitlement's event subtype, the hold is that event priced at the entitlement's consumption rate and quantity rates, and quantity is ignored; otherwise the hold is the entitlement's consumption rate times quantity, or, when quantity is omitted, times the usage stated here
|
|
20180
20822
|
|
|
20181
20823
|
</dd>
|
|
20182
20824
|
</dl>
|
|
@@ -20184,7 +20826,7 @@ client.features.check_and_reserve_flag(key: "key")
|
|
|
20184
20826
|
<dl>
|
|
20185
20827
|
<dd>
|
|
20186
20828
|
|
|
20187
|
-
**quantity:** `Float` — Units of the feature the operation will consume. Sets the hold size together with the entitlement's consumption rate, and is echoed back on the reservation for the settling track event. When it is omitted the units come from preflight.event_usage.quantity, if that event subtype is the entitlement's, else from preflight.usage, else 1
|
|
20829
|
+
**quantity:** `Float` — Units of the feature the operation will consume. Sets the hold size together with the entitlement's consumption rate, and is echoed back on the reservation for the settling track event. When it is omitted the units come from preflight.event_usage.quantity, if that event subtype is the entitlement's, else from preflight.usage, else 1. Ignored when preflight.event_quantities names the entitlement's event subtype, whose quantity is used instead
|
|
20188
20830
|
|
|
20189
20831
|
</dd>
|
|
20190
20832
|
</dl>
|