Skip to content

Commit 7514c59

Browse files
stainless-app[bot]stainless-app[bot]
committed
docs(api): update nature_of_business and qr_code_url parameter descriptions
1 parent 812f595 commit 7514c59

File tree

9 files changed

+78
-66
lines changed

9 files changed

+78
-66
lines changed

‎.stats.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 189
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-8b222de46ecf164a1d6e47c5e677d6e1772c7b1726d0574d9322305c9af4eec6.yml
3-
openapi_spec_hash: f573dc729467c8c592750677f45a3ea4
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-eb2cf51467f505a1d29c3ca40b9595ecbf6d6a3743f53bc42a52c8135a252ff0.yml
3+
openapi_spec_hash: 2fbd71b69d71138b3e54432a38d759ed
44
config_hash: edbdfefeb0d3d927c2f9fe3402793215

‎src/lithic/resources/card_bulk_orders.py‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -47,30 +47,30 @@ def create(
4747
*,
4848
customer_product_id: str,
4949
shipping_address: object,
50-
shipping_method: Literal["BULK_EXPEDITED"],
50+
shipping_method: Literal["BULK_EXPEDITED", "BULK_PRIORITY", "BULK_2_DAY", "BULK_EXPRESS"],
5151
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
5252
# The extra values given here take precedence over values defined on the client or passed to this method.
5353
extra_headers: Headers | None = None,
5454
extra_query: Query | None = None,
5555
extra_body: Body | None = None,
5656
timeout: float | httpx.Timeout | None | NotGiven = not_given,
5757
) -> CardBulkOrder:
58-
"""Create a new bulk order for physical card shipments **[BETA]**.
58+
"""Create a new bulk order for physical card shipments.
5959
60-
Cards can be
61-
added to the order via the POST /v1/cards endpoint by specifying the
62-
bulk_order_token. Lock the order via PATCH
63-
/v1/card_bulk_orders/{bulk_order_token} to prepare for shipment. Please work
64-
with your Customer Success Manager and card personalization bureau to ensure
65-
bulk shipping is supported for your program.
60+
Cards can be added to the
61+
order via the POST /v1/cards endpoint by specifying the bulk_order_token. Lock
62+
the order via PATCH /v1/card_bulk_orders/{bulk_order_token} to prepare for
63+
shipment. Please work with your Customer Success Manager and card
64+
personalization bureau to ensure bulk shipping is supported for your program.
6665
6766
Args:
6867
customer_product_id: Customer-specified product configuration for physical card manufacturing. This
6968
must be configured with Lithic before use
7069
7170
shipping_address: Shipping address for all cards in this bulk order
7271
73-
shipping_method: Shipping method for all cards in this bulk order
72+
shipping_method: Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and
73+
BULK_EXPRESS are only available with Perfect Plastic Printing
7474
7575
extra_headers: Send extra headers
7676
@@ -108,7 +108,7 @@ def retrieve(
108108
timeout: float | httpx.Timeout | None | NotGiven = not_given,
109109
) -> CardBulkOrder:
110110
"""
111-
Retrieve a specific bulk order by token **[BETA]**
111+
Retrieve a specific bulk order by token
112112
113113
Args:
114114
extra_headers: Send extra headers
@@ -141,10 +141,10 @@ def update(
141141
extra_body: Body | None = None,
142142
timeout: float | httpx.Timeout | None | NotGiven = not_given,
143143
) -> CardBulkOrder:
144-
"""Update a bulk order **[BETA]**.
144+
"""Update a bulk order.
145145
146-
Primarily used to lock the order, preventing
147-
additional cards from being added
146+
Primarily used to lock the order, preventing additional
147+
cards from being added
148148
149149
Args:
150150
status: Status to update the bulk order to. Use LOCKED to finalize the order
@@ -184,7 +184,7 @@ def list(
184184
timeout: float | httpx.Timeout | None | NotGiven = not_given,
185185
) -> SyncCursorPage[CardBulkOrder]:
186186
"""
187-
List bulk orders for physical card shipments **[BETA]**
187+
List bulk orders for physical card shipments
188188
189189
Args:
190190
begin: Date string in RFC 3339 format. Only entries created after the specified time
@@ -257,30 +257,30 @@ async def create(
257257
*,
258258
customer_product_id: str,
259259
shipping_address: object,
260-
shipping_method: Literal["BULK_EXPEDITED"],
260+
shipping_method: Literal["BULK_EXPEDITED", "BULK_PRIORITY", "BULK_2_DAY", "BULK_EXPRESS"],
261261
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
262262
# The extra values given here take precedence over values defined on the client or passed to this method.
263263
extra_headers: Headers | None = None,
264264
extra_query: Query | None = None,
265265
extra_body: Body | None = None,
266266
timeout: float | httpx.Timeout | None | NotGiven = not_given,
267267
) -> CardBulkOrder:
268-
"""Create a new bulk order for physical card shipments **[BETA]**.
268+
"""Create a new bulk order for physical card shipments.
269269
270-
Cards can be
271-
added to the order via the POST /v1/cards endpoint by specifying the
272-
bulk_order_token. Lock the order via PATCH
273-
/v1/card_bulk_orders/{bulk_order_token} to prepare for shipment. Please work
274-
with your Customer Success Manager and card personalization bureau to ensure
275-
bulk shipping is supported for your program.
270+
Cards can be added to the
271+
order via the POST /v1/cards endpoint by specifying the bulk_order_token. Lock
272+
the order via PATCH /v1/card_bulk_orders/{bulk_order_token} to prepare for
273+
shipment. Please work with your Customer Success Manager and card
274+
personalization bureau to ensure bulk shipping is supported for your program.
276275
277276
Args:
278277
customer_product_id: Customer-specified product configuration for physical card manufacturing. This
279278
must be configured with Lithic before use
280279
281280
shipping_address: Shipping address for all cards in this bulk order
282281
283-
shipping_method: Shipping method for all cards in this bulk order
282+
shipping_method: Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and
283+
BULK_EXPRESS are only available with Perfect Plastic Printing
284284
285285
extra_headers: Send extra headers
286286
@@ -318,7 +318,7 @@ async def retrieve(
318318
timeout: float | httpx.Timeout | None | NotGiven = not_given,
319319
) -> CardBulkOrder:
320320
"""
321-
Retrieve a specific bulk order by token **[BETA]**
321+
Retrieve a specific bulk order by token
322322
323323
Args:
324324
extra_headers: Send extra headers
@@ -351,10 +351,10 @@ async def update(
351351
extra_body: Body | None = None,
352352
timeout: float | httpx.Timeout | None | NotGiven = not_given,
353353
) -> CardBulkOrder:
354-
"""Update a bulk order **[BETA]**.
354+
"""Update a bulk order.
355355
356-
Primarily used to lock the order, preventing
357-
additional cards from being added
356+
Primarily used to lock the order, preventing additional
357+
cards from being added
358358
359359
Args:
360360
status: Status to update the bulk order to. Use LOCKED to finalize the order
@@ -396,7 +396,7 @@ def list(
396396
timeout: float | httpx.Timeout | None | NotGiven = not_given,
397397
) -> AsyncPaginator[CardBulkOrder, AsyncCursorPage[CardBulkOrder]]:
398398
"""
399-
List bulk orders for physical card shipments **[BETA]**
399+
List bulk orders for physical card shipments
400400
401401
Args:
402402
begin: Date string in RFC 3339 format. Only entries created after the specified time

‎src/lithic/resources/cards/cards.py‎

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ def create(
124124
| Omit = omit,
125125
shipping_address: ShippingAddress | Omit = omit,
126126
shipping_method: Literal[
127-
"2_DAY", "BULK_EXPEDITED", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"
127+
"2_DAY", "BULK", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"
128128
]
129129
| Omit = omit,
130130
spend_limit: int | Omit = omit,
@@ -254,7 +254,8 @@ def create(
254254
tracking
255255
- `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
256256
or similar international option, with tracking
257-
- `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
257+
- `BULK` - Card will be shipped as part of a bulk fulfillment order. The
258+
shipping method and timeline are inherited from the parent bulk order.
258259
259260
spend_limit: Amount (in cents) to limit approved authorizations (e.g. 100000 would be a
260261
$1,000 limit). Transaction requests above the spend limit will be declined. Note
@@ -595,7 +596,7 @@ def convert_physical(
595596
carrier: Carrier | Omit = omit,
596597
product_id: str | Omit = omit,
597598
shipping_method: Literal[
598-
"2_DAY", "BULK_EXPEDITED", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"
599+
"2_DAY", "BULK", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"
599600
]
600601
| Omit = omit,
601602
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -641,7 +642,8 @@ def convert_physical(
641642
tracking
642643
- `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
643644
or similar international option, with tracking
644-
- `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
645+
- `BULK` - Card will be shipped as part of a bulk fulfillment order. The
646+
shipping method and timeline are inherited from the parent bulk order.
645647
646648
extra_headers: Send extra headers
647649
@@ -940,7 +942,7 @@ def reissue(
940942
product_id: str | Omit = omit,
941943
shipping_address: ShippingAddress | Omit = omit,
942944
shipping_method: Literal[
943-
"2_DAY", "BULK_EXPEDITED", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"
945+
"2_DAY", "BULK", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"
944946
]
945947
| Omit = omit,
946948
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -981,7 +983,8 @@ def reissue(
981983
tracking
982984
- `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
983985
or similar international option, with tracking
984-
- `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
986+
- `BULK` - Card will be shipped as part of a bulk fulfillment order. The
987+
shipping method and timeline are inherited from the parent bulk order.
985988
986989
extra_headers: Send extra headers
987990
@@ -1020,7 +1023,7 @@ def renew(
10201023
exp_year: str | Omit = omit,
10211024
product_id: str | Omit = omit,
10221025
shipping_method: Literal[
1023-
"2_DAY", "BULK_EXPEDITED", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"
1026+
"2_DAY", "BULK", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"
10241027
]
10251028
| Omit = omit,
10261029
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -1071,7 +1074,8 @@ def renew(
10711074
tracking
10721075
- `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
10731076
or similar international option, with tracking
1074-
- `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
1077+
- `BULK` - Card will be shipped as part of a bulk fulfillment order. The
1078+
shipping method and timeline are inherited from the parent bulk order.
10751079
10761080
extra_headers: Send extra headers
10771081
@@ -1306,7 +1310,7 @@ async def create(
13061310
| Omit = omit,
13071311
shipping_address: ShippingAddress | Omit = omit,
13081312
shipping_method: Literal[
1309-
"2_DAY", "BULK_EXPEDITED", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"
1313+
"2_DAY", "BULK", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"
13101314
]
13111315
| Omit = omit,
13121316
spend_limit: int | Omit = omit,
@@ -1436,7 +1440,8 @@ async def create(
14361440
tracking
14371441
- `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
14381442
or similar international option, with tracking
1439-
- `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
1443+
- `BULK` - Card will be shipped as part of a bulk fulfillment order. The
1444+
shipping method and timeline are inherited from the parent bulk order.
14401445
14411446
spend_limit: Amount (in cents) to limit approved authorizations (e.g. 100000 would be a
14421447
$1,000 limit). Transaction requests above the spend limit will be declined. Note
@@ -1777,7 +1782,7 @@ async def convert_physical(
17771782
carrier: Carrier | Omit = omit,
17781783
product_id: str | Omit = omit,
17791784
shipping_method: Literal[
1780-
"2_DAY", "BULK_EXPEDITED", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"
1785+
"2_DAY", "BULK", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"
17811786
]
17821787
| Omit = omit,
17831788
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -1823,7 +1828,8 @@ async def convert_physical(
18231828
tracking
18241829
- `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
18251830
or similar international option, with tracking
1826-
- `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
1831+
- `BULK` - Card will be shipped as part of a bulk fulfillment order. The
1832+
shipping method and timeline are inherited from the parent bulk order.
18271833
18281834
extra_headers: Send extra headers
18291835
@@ -2122,7 +2128,7 @@ async def reissue(
21222128
product_id: str | Omit = omit,
21232129
shipping_address: ShippingAddress | Omit = omit,
21242130
shipping_method: Literal[
2125-
"2_DAY", "BULK_EXPEDITED", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"
2131+
"2_DAY", "BULK", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"
21262132
]
21272133
| Omit = omit,
21282134
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -2163,7 +2169,8 @@ async def reissue(
21632169
tracking
21642170
- `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
21652171
or similar international option, with tracking
2166-
- `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
2172+
- `BULK` - Card will be shipped as part of a bulk fulfillment order. The
2173+
shipping method and timeline are inherited from the parent bulk order.
21672174
21682175
extra_headers: Send extra headers
21692176
@@ -2202,7 +2209,7 @@ async def renew(
22022209
exp_year: str | Omit = omit,
22032210
product_id: str | Omit = omit,
22042211
shipping_method: Literal[
2205-
"2_DAY", "BULK_EXPEDITED", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"
2212+
"2_DAY", "BULK", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"
22062213
]
22072214
| Omit = omit,
22082215
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -2253,7 +2260,8 @@ async def renew(
22532260
tracking
22542261
- `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
22552262
or similar international option, with tracking
2256-
- `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
2263+
- `BULK` - Card will be shipped as part of a bulk fulfillment order. The
2264+
shipping method and timeline are inherited from the parent bulk order.
22572265
22582266
extra_headers: Send extra headers
22592267

‎src/lithic/types/card_bulk_order.py‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,12 @@ class CardBulkOrder(BaseModel):
3030
shipping_address: object
3131
"""Shipping address for all cards in this bulk order"""
3232

33-
shipping_method: Literal["BULK_EXPEDITED"]
34-
"""Shipping method for all cards in this bulk order"""
33+
shipping_method: Literal["BULK_EXPEDITED", "BULK_PRIORITY", "BULK_2_DAY", "BULK_EXPRESS"]
34+
"""Shipping method for all cards in this bulk order.
35+
36+
BULK_PRIORITY, BULK_2_DAY, and BULK_EXPRESS are only available with Perfect
37+
Plastic Printing
38+
"""
3539

3640
status: Literal["OPEN", "LOCKED"]
3741
"""Status of the bulk order.

‎src/lithic/types/card_bulk_order_create_params.py‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,9 @@ class CardBulkOrderCreateParams(TypedDict, total=False):
1717
shipping_address: Required[object]
1818
"""Shipping address for all cards in this bulk order"""
1919

20-
shipping_method: Required[Literal["BULK_EXPEDITED"]]
21-
"""Shipping method for all cards in this bulk order"""
20+
shipping_method: Required[Literal["BULK_EXPEDITED", "BULK_PRIORITY", "BULK_2_DAY", "BULK_EXPRESS"]]
21+
"""Shipping method for all cards in this bulk order.
22+
23+
BULK_PRIORITY, BULK_2_DAY, and BULK_EXPRESS are only available with Perfect
24+
Plastic Printing
25+
"""

‎src/lithic/types/card_convert_physical_params.py‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,7 @@ class CardConvertPhysicalParams(TypedDict, total=False):
2424
to cards of type `PHYSICAL`. This must be configured with Lithic before use.
2525
"""
2626

27-
shipping_method: Literal[
28-
"2_DAY", "BULK_EXPEDITED", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"
29-
]
27+
shipping_method: Literal["2_DAY", "BULK", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"]
3028
"""Shipping method for the card.
3129
3230
Only applies to cards of type PHYSICAL. Use of options besides `STANDARD`
@@ -43,5 +41,6 @@ class CardConvertPhysicalParams(TypedDict, total=False):
4341
tracking
4442
- `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
4543
or similar international option, with tracking
46-
- `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
44+
- `BULK` - Card will be shipped as part of a bulk fulfillment order. The
45+
shipping method and timeline are inherited from the parent bulk order.
4746
"""

‎src/lithic/types/card_create_params.py‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -165,9 +165,7 @@ class CardCreateParams(TypedDict, total=False):
165165

166166
shipping_address: ShippingAddress
167167

168-
shipping_method: Literal[
169-
"2_DAY", "BULK_EXPEDITED", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"
170-
]
168+
shipping_method: Literal["2_DAY", "BULK", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"]
171169
"""Shipping method for the card.
172170
173171
Only applies to cards of type PHYSICAL. Use of options besides `STANDARD`
@@ -184,7 +182,8 @@ class CardCreateParams(TypedDict, total=False):
184182
tracking
185183
- `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
186184
or similar international option, with tracking
187-
- `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
185+
- `BULK` - Card will be shipped as part of a bulk fulfillment order. The
186+
shipping method and timeline are inherited from the parent bulk order.
188187
"""
189188

190189
spend_limit: int

‎src/lithic/types/card_reissue_params.py‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,7 @@ class CardReissueParams(TypedDict, total=False):
2424
shipping_address: ShippingAddress
2525
"""If omitted, the previous shipping address will be used."""
2626

27-
shipping_method: Literal[
28-
"2_DAY", "BULK_EXPEDITED", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"
29-
]
27+
shipping_method: Literal["2_DAY", "BULK", "EXPEDITED", "EXPRESS", "PRIORITY", "STANDARD", "STANDARD_WITH_TRACKING"]
3028
"""Shipping method for the card.
3129
3230
Only applies to cards of type PHYSICAL. Use of options besides `STANDARD`
@@ -43,5 +41,6 @@ class CardReissueParams(TypedDict, total=False):
4341
tracking
4442
- `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
4543
or similar international option, with tracking
46-
- `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
44+
- `BULK` - Card will be shipped as part of a bulk fulfillment order. The
45+
shipping method and timeline are inherited from the parent bulk order.
4746
"""

0 commit comments

Comments
 (0)