Skip to content

Commit d925251

Browse files
feat(api): updates (#252)
1 parent 8e6a471 commit d925251

3 files changed

Lines changed: 15 additions & 3 deletions

File tree

.stats.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
configured_endpoints: 82
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb-05f09f77c63744e86cb2b03330b994964f8319c0d69f41f964f9f57de969257c.yml
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb-e0338fed09226882fc7e89ae7249ca67d95217701cba0c91b68c7a6cc102fd7f.yml

src/orb/resources/customers/credits/credits.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,9 @@ def list(
7474
"""
7575
Returns a paginated list of unexpired, non-zero credit blocks for a customer.
7676
77+
Note that `currency` defaults to credits if not specified. To use a real world
78+
currency, set `currency` to an ISO 4217 string.
79+
7780
Args:
7881
currency: The ledger currency or custom pricing unit to use.
7982
@@ -129,6 +132,9 @@ def list_by_external_id(
129132
"""
130133
Returns a paginated list of unexpired, non-zero credit blocks for a customer.
131134
135+
Note that `currency` defaults to credits if not specified. To use a real world
136+
currency, set `currency` to an ISO 4217 string.
137+
132138
Args:
133139
currency: The ledger currency or custom pricing unit to use.
134140
@@ -204,6 +210,9 @@ def list(
204210
"""
205211
Returns a paginated list of unexpired, non-zero credit blocks for a customer.
206212
213+
Note that `currency` defaults to credits if not specified. To use a real world
214+
currency, set `currency` to an ISO 4217 string.
215+
207216
Args:
208217
currency: The ledger currency or custom pricing unit to use.
209218
@@ -259,6 +268,9 @@ def list_by_external_id(
259268
"""
260269
Returns a paginated list of unexpired, non-zero credit blocks for a customer.
261270
271+
Note that `currency` defaults to credits if not specified. To use a real world
272+
currency, set `currency` to an ISO 4217 string.
273+
262274
Args:
263275
currency: The ledger currency or custom pricing unit to use.
264276

src/orb/resources/invoices.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,7 @@ def issue(
307307
"""This endpoint allows an eligible invoice to be issued manually.
308308
309309
This is only
310-
possible with invoices where status is `draft`, `will_auto_issue` is true, and
310+
possible with invoices where status is `draft`, `will_auto_issue` is false, and
311311
an `eligible_to_issue_at` is a time in the past. Issuing an invoice could
312312
possibly trigger side effects, some of which could be customer-visible (e.g.
313313
sending emails, auto-collecting payment, syncing the invoice to external
@@ -718,7 +718,7 @@ async def issue(
718718
"""This endpoint allows an eligible invoice to be issued manually.
719719
720720
This is only
721-
possible with invoices where status is `draft`, `will_auto_issue` is true, and
721+
possible with invoices where status is `draft`, `will_auto_issue` is false, and
722722
an `eligible_to_issue_at` is a time in the past. Issuing an invoice could
723723
possibly trigger side effects, some of which could be customer-visible (e.g.
724724
sending emails, auto-collecting payment, syncing the invoice to external

0 commit comments

Comments
 (0)