Skip to content

Commit b11902d

Browse files
stainless-app[bot]stainless-app[bot]
committed
docs(api): update nature_of_business and qr_code_url field descriptions
1 parent 5af97d6 commit b11902d

22 files changed

Lines changed: 159 additions & 91 deletions

‎.stats.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 190
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

‎lib/lithic/models/card_bulk_order.rb‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ class CardBulkOrder < Lithic::Internal::Type::BaseModel
3636
required :shipping_address, Lithic::Internal::Type::Unknown
3737

3838
# @!attribute shipping_method
39-
# Shipping method for all cards in this bulk order
39+
# Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and
40+
# BULK_EXPRESS are only available with Perfect Plastic Printing
4041
#
4142
# @return [Symbol, Lithic::Models::CardBulkOrder::ShippingMethod]
4243
required :shipping_method, enum: -> { Lithic::CardBulkOrder::ShippingMethod }
@@ -70,19 +71,23 @@ class CardBulkOrder < Lithic::Internal::Type::BaseModel
7071
#
7172
# @param shipping_address [Object] Shipping address for all cards in this bulk order
7273
#
73-
# @param shipping_method [Symbol, Lithic::Models::CardBulkOrder::ShippingMethod] Shipping method for all cards in this bulk order
74+
# @param shipping_method [Symbol, Lithic::Models::CardBulkOrder::ShippingMethod] Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and
7475
#
7576
# @param status [Symbol, Lithic::Models::CardBulkOrder::Status] Status of the bulk order. OPEN indicates the order is accepting cards. LOCKED in
7677
#
7778
# @param updated [Time] An RFC 3339 timestamp for when the bulk order was last updated. UTC time zone
7879

79-
# Shipping method for all cards in this bulk order
80+
# Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and
81+
# BULK_EXPRESS are only available with Perfect Plastic Printing
8082
#
8183
# @see Lithic::Models::CardBulkOrder#shipping_method
8284
module ShippingMethod
8385
extend Lithic::Internal::Type::Enum
8486

8587
BULK_EXPEDITED = :BULK_EXPEDITED
88+
BULK_PRIORITY = :BULK_PRIORITY
89+
BULK_2_DAY = :BULK_2_DAY
90+
BULK_EXPRESS = :BULK_EXPRESS
8691

8792
# @!method self.values
8893
# @return [Array<Symbol>]

‎lib/lithic/models/card_bulk_order_create_params.rb‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ class CardBulkOrderCreateParams < Lithic::Internal::Type::BaseModel
2121
required :shipping_address, Lithic::Internal::Type::Unknown
2222

2323
# @!attribute shipping_method
24-
# Shipping method for all cards in this bulk order
24+
# Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and
25+
# BULK_EXPRESS are only available with Perfect Plastic Printing
2526
#
2627
# @return [Symbol, Lithic::Models::CardBulkOrderCreateParams::ShippingMethod]
2728
required :shipping_method, enum: -> { Lithic::CardBulkOrderCreateParams::ShippingMethod }
@@ -34,15 +35,19 @@ class CardBulkOrderCreateParams < Lithic::Internal::Type::BaseModel
3435
#
3536
# @param shipping_address [Object] Shipping address for all cards in this bulk order
3637
#
37-
# @param shipping_method [Symbol, Lithic::Models::CardBulkOrderCreateParams::ShippingMethod] Shipping method for all cards in this bulk order
38+
# @param shipping_method [Symbol, Lithic::Models::CardBulkOrderCreateParams::ShippingMethod] Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and
3839
#
3940
# @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
4041

41-
# Shipping method for all cards in this bulk order
42+
# Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and
43+
# BULK_EXPRESS are only available with Perfect Plastic Printing
4244
module ShippingMethod
4345
extend Lithic::Internal::Type::Enum
4446

4547
BULK_EXPEDITED = :BULK_EXPEDITED
48+
BULK_PRIORITY = :BULK_PRIORITY
49+
BULK_2_DAY = :BULK_2_DAY
50+
BULK_EXPRESS = :BULK_EXPRESS
4651

4752
# @!method self.values
4853
# @return [Array<Symbol>]

‎lib/lithic/models/card_convert_physical_params.rb‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ class CardConvertPhysicalParams < Lithic::Internal::Type::BaseModel
4747
# tracking
4848
# - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
4949
# or similar international option, with tracking
50-
# - `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
50+
# - `BULK` - Card will be shipped as part of a bulk fulfillment order. The
51+
# shipping method and timeline are inherited from the parent bulk order.
5152
#
5253
# @return [Symbol, Lithic::Models::CardConvertPhysicalParams::ShippingMethod, nil]
5354
optional :shipping_method, enum: -> { Lithic::CardConvertPhysicalParams::ShippingMethod }
@@ -82,12 +83,13 @@ class CardConvertPhysicalParams < Lithic::Internal::Type::BaseModel
8283
# tracking
8384
# - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
8485
# or similar international option, with tracking
85-
# - `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
86+
# - `BULK` - Card will be shipped as part of a bulk fulfillment order. The
87+
# shipping method and timeline are inherited from the parent bulk order.
8688
module ShippingMethod
8789
extend Lithic::Internal::Type::Enum
8890

8991
SHIPPING_METHOD_2_DAY = :"2_DAY"
90-
BULK_EXPEDITED = :BULK_EXPEDITED
92+
BULK = :BULK
9193
EXPEDITED = :EXPEDITED
9294
EXPRESS = :EXPRESS
9395
PRIORITY = :PRIORITY

‎lib/lithic/models/card_create_params.rb‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,8 @@ class CardCreateParams < Lithic::Internal::Type::BaseModel
183183
# tracking
184184
# - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
185185
# or similar international option, with tracking
186-
# - `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
186+
# - `BULK` - Card will be shipped as part of a bulk fulfillment order. The
187+
# shipping method and timeline are inherited from the parent bulk order.
187188
#
188189
# @return [Symbol, Lithic::Models::CardCreateParams::ShippingMethod, nil]
189190
optional :shipping_method, enum: -> { Lithic::CardCreateParams::ShippingMethod }
@@ -369,12 +370,13 @@ module ReplacementSubstatus
369370
# tracking
370371
# - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
371372
# or similar international option, with tracking
372-
# - `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
373+
# - `BULK` - Card will be shipped as part of a bulk fulfillment order. The
374+
# shipping method and timeline are inherited from the parent bulk order.
373375
module ShippingMethod
374376
extend Lithic::Internal::Type::Enum
375377

376378
SHIPPING_METHOD_2_DAY = :"2_DAY"
377-
BULK_EXPEDITED = :BULK_EXPEDITED
379+
BULK = :BULK
378380
EXPEDITED = :EXPEDITED
379381
EXPRESS = :EXPRESS
380382
PRIORITY = :PRIORITY

‎lib/lithic/models/card_reissue_params.rb‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ class CardReissueParams < Lithic::Internal::Type::BaseModel
4747
# tracking
4848
# - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
4949
# or similar international option, with tracking
50-
# - `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
50+
# - `BULK` - Card will be shipped as part of a bulk fulfillment order. The
51+
# shipping method and timeline are inherited from the parent bulk order.
5152
#
5253
# @return [Symbol, Lithic::Models::CardReissueParams::ShippingMethod, nil]
5354
optional :shipping_method, enum: -> { Lithic::CardReissueParams::ShippingMethod }
@@ -82,12 +83,13 @@ class CardReissueParams < Lithic::Internal::Type::BaseModel
8283
# tracking
8384
# - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
8485
# or similar international option, with tracking
85-
# - `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
86+
# - `BULK` - Card will be shipped as part of a bulk fulfillment order. The
87+
# shipping method and timeline are inherited from the parent bulk order.
8688
module ShippingMethod
8789
extend Lithic::Internal::Type::Enum
8890

8991
SHIPPING_METHOD_2_DAY = :"2_DAY"
90-
BULK_EXPEDITED = :BULK_EXPEDITED
92+
BULK = :BULK
9193
EXPEDITED = :EXPEDITED
9294
EXPRESS = :EXPRESS
9395
PRIORITY = :PRIORITY

‎lib/lithic/models/card_renew_params.rb‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ class CardRenewParams < Lithic::Internal::Type::BaseModel
6161
# tracking
6262
# - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
6363
# or similar international option, with tracking
64-
# - `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
64+
# - `BULK` - Card will be shipped as part of a bulk fulfillment order. The
65+
# shipping method and timeline are inherited from the parent bulk order.
6566
#
6667
# @return [Symbol, Lithic::Models::CardRenewParams::ShippingMethod, nil]
6768
optional :shipping_method, enum: -> { Lithic::CardRenewParams::ShippingMethod }
@@ -100,12 +101,13 @@ class CardRenewParams < Lithic::Internal::Type::BaseModel
100101
# tracking
101102
# - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
102103
# or similar international option, with tracking
103-
# - `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
104+
# - `BULK` - Card will be shipped as part of a bulk fulfillment order. The
105+
# shipping method and timeline are inherited from the parent bulk order.
104106
module ShippingMethod
105107
extend Lithic::Internal::Type::Enum
106108

107109
SHIPPING_METHOD_2_DAY = :"2_DAY"
108-
BULK_EXPEDITED = :BULK_EXPEDITED
110+
BULK = :BULK
109111
EXPEDITED = :EXPEDITED
110112
EXPRESS = :EXPRESS
111113
PRIORITY = :PRIORITY

‎lib/lithic/resources/card_bulk_orders.rb‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,19 @@ class CardBulkOrders
66
# Some parameter documentations has been truncated, see
77
# {Lithic::Models::CardBulkOrderCreateParams} for more details.
88
#
9-
# Create a new bulk order for physical card shipments **[BETA]**. Cards can be
10-
# added to the order via the POST /v1/cards endpoint by specifying the
11-
# bulk_order_token. Lock the order via PATCH
12-
# /v1/card_bulk_orders/{bulk_order_token} to prepare for shipment. Please work
13-
# with your Customer Success Manager and card personalization bureau to ensure
14-
# bulk shipping is supported for your program.
9+
# Create a new bulk order for physical card shipments. Cards can be added to the
10+
# order via the POST /v1/cards endpoint by specifying the bulk_order_token. Lock
11+
# the order via PATCH /v1/card_bulk_orders/{bulk_order_token} to prepare for
12+
# shipment. Please work with your Customer Success Manager and card
13+
# personalization bureau to ensure bulk shipping is supported for your program.
1514
#
1615
# @overload create(customer_product_id:, shipping_address:, shipping_method:, request_options: {})
1716
#
1817
# @param customer_product_id [String] Customer-specified product configuration for physical card manufacturing. This m
1918
#
2019
# @param shipping_address [Object] Shipping address for all cards in this bulk order
2120
#
22-
# @param shipping_method [Symbol, Lithic::Models::CardBulkOrderCreateParams::ShippingMethod] Shipping method for all cards in this bulk order
21+
# @param shipping_method [Symbol, Lithic::Models::CardBulkOrderCreateParams::ShippingMethod] Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and
2322
#
2423
# @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
2524
#
@@ -37,7 +36,7 @@ def create(params)
3736
)
3837
end
3938

40-
# Retrieve a specific bulk order by token **[BETA]**
39+
# Retrieve a specific bulk order by token
4140
#
4241
# @overload retrieve(bulk_order_token, request_options: {})
4342
#
@@ -57,8 +56,8 @@ def retrieve(bulk_order_token, params = {})
5756
)
5857
end
5958

60-
# Update a bulk order **[BETA]**. Primarily used to lock the order, preventing
61-
# additional cards from being added
59+
# Update a bulk order. Primarily used to lock the order, preventing additional
60+
# cards from being added
6261
#
6362
# @overload update(bulk_order_token, status:, request_options: {})
6463
#
@@ -85,7 +84,7 @@ def update(bulk_order_token, params)
8584
# Some parameter documentations has been truncated, see
8685
# {Lithic::Models::CardBulkOrderListParams} for more details.
8786
#
88-
# List bulk orders for physical card shipments **[BETA]**
87+
# List bulk orders for physical card shipments
8988
#
9089
# @overload list(begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
9190
#

‎rbi/lithic/models/card_bulk_order.rbi‎

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ module Lithic
2727
sig { returns(T.anything) }
2828
attr_accessor :shipping_address
2929

30-
# Shipping method for all cards in this bulk order
30+
# Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and
31+
# BULK_EXPRESS are only available with Perfect Plastic Printing
3132
sig { returns(Lithic::CardBulkOrder::ShippingMethod::TaggedSymbol) }
3233
attr_accessor :shipping_method
3334

@@ -65,7 +66,8 @@ module Lithic
6566
customer_product_id:,
6667
# Shipping address for all cards in this bulk order
6768
shipping_address:,
68-
# Shipping method for all cards in this bulk order
69+
# Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and
70+
# BULK_EXPRESS are only available with Perfect Plastic Printing
6971
shipping_method:,
7072
# Status of the bulk order. OPEN indicates the order is accepting cards. LOCKED
7173
# indicates the order is finalized and no more cards can be added
@@ -93,7 +95,8 @@ module Lithic
9395
def to_hash
9496
end
9597

96-
# Shipping method for all cards in this bulk order
98+
# Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and
99+
# BULK_EXPRESS are only available with Perfect Plastic Printing
97100
module ShippingMethod
98101
extend Lithic::Internal::Type::Enum
99102

@@ -106,6 +109,21 @@ module Lithic
106109
:BULK_EXPEDITED,
107110
Lithic::CardBulkOrder::ShippingMethod::TaggedSymbol
108111
)
112+
BULK_PRIORITY =
113+
T.let(
114+
:BULK_PRIORITY,
115+
Lithic::CardBulkOrder::ShippingMethod::TaggedSymbol
116+
)
117+
BULK_2_DAY =
118+
T.let(
119+
:BULK_2_DAY,
120+
Lithic::CardBulkOrder::ShippingMethod::TaggedSymbol
121+
)
122+
BULK_EXPRESS =
123+
T.let(
124+
:BULK_EXPRESS,
125+
Lithic::CardBulkOrder::ShippingMethod::TaggedSymbol
126+
)
109127

110128
sig do
111129
override.returns(

‎rbi/lithic/models/card_bulk_order_create_params.rbi‎

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ module Lithic
2020
sig { returns(T.anything) }
2121
attr_accessor :shipping_address
2222

23-
# Shipping method for all cards in this bulk order
23+
# Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and
24+
# BULK_EXPRESS are only available with Perfect Plastic Printing
2425
sig do
2526
returns(Lithic::CardBulkOrderCreateParams::ShippingMethod::OrSymbol)
2627
end
@@ -41,7 +42,8 @@ module Lithic
4142
customer_product_id:,
4243
# Shipping address for all cards in this bulk order
4344
shipping_address:,
44-
# Shipping method for all cards in this bulk order
45+
# Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and
46+
# BULK_EXPRESS are only available with Perfect Plastic Printing
4547
shipping_method:,
4648
request_options: {}
4749
)
@@ -61,7 +63,8 @@ module Lithic
6163
def to_hash
6264
end
6365

64-
# Shipping method for all cards in this bulk order
66+
# Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and
67+
# BULK_EXPRESS are only available with Perfect Plastic Printing
6568
module ShippingMethod
6669
extend Lithic::Internal::Type::Enum
6770

@@ -76,6 +79,21 @@ module Lithic
7679
:BULK_EXPEDITED,
7780
Lithic::CardBulkOrderCreateParams::ShippingMethod::TaggedSymbol
7881
)
82+
BULK_PRIORITY =
83+
T.let(
84+
:BULK_PRIORITY,
85+
Lithic::CardBulkOrderCreateParams::ShippingMethod::TaggedSymbol
86+
)
87+
BULK_2_DAY =
88+
T.let(
89+
:BULK_2_DAY,
90+
Lithic::CardBulkOrderCreateParams::ShippingMethod::TaggedSymbol
91+
)
92+
BULK_EXPRESS =
93+
T.let(
94+
:BULK_EXPRESS,
95+
Lithic::CardBulkOrderCreateParams::ShippingMethod::TaggedSymbol
96+
)
7997

8098
sig do
8199
override.returns(

0 commit comments

Comments
 (0)