Skip to content

Commit 2fe328d

Browse files
stainless-app[bot]stainless-app[bot]
committed
docs(api): update natureOfBusiness and qrCodeUrl parameter descriptions
1 parent 5feba92 commit 2fe328d

12 files changed

Lines changed: 146 additions & 72 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

‎lithic-java-core/src/main/kotlin/com/lithic/api/models/CardBulkOrder.kt‎

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,8 @@ private constructor(
116116
fun _shippingAddress(): JsonValue = shippingAddress
117117

118118
/**
119-
* Shipping method for all cards in this bulk order
119+
* Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and BULK_EXPRESS
120+
* are only available with Perfect Plastic Printing
120121
*
121122
* @throws LithicInvalidDataException if the JSON field has an unexpected type or is
122123
* unexpectedly missing or null (e.g. if the server responded with an unexpected value).
@@ -330,7 +331,10 @@ private constructor(
330331
this.shippingAddress = shippingAddress
331332
}
332333

333-
/** Shipping method for all cards in this bulk order */
334+
/**
335+
* Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and
336+
* BULK_EXPRESS are only available with Perfect Plastic Printing
337+
*/
334338
fun shippingMethod(shippingMethod: ShippingMethod) =
335339
shippingMethod(JsonField.of(shippingMethod))
336340

@@ -463,7 +467,10 @@ private constructor(
463467
(status.asKnown().getOrNull()?.validity() ?: 0) +
464468
(if (updated.asKnown().isPresent) 1 else 0)
465469

466-
/** Shipping method for all cards in this bulk order */
470+
/**
471+
* Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and BULK_EXPRESS
472+
* are only available with Perfect Plastic Printing
473+
*/
467474
class ShippingMethod @JsonCreator private constructor(private val value: JsonField<String>) :
468475
Enum {
469476

@@ -481,12 +488,21 @@ private constructor(
481488

482489
@JvmField val BULK_EXPEDITED = of("BULK_EXPEDITED")
483490

491+
@JvmField val BULK_PRIORITY = of("BULK_PRIORITY")
492+
493+
@JvmField val BULK_2_DAY = of("BULK_2_DAY")
494+
495+
@JvmField val BULK_EXPRESS = of("BULK_EXPRESS")
496+
484497
@JvmStatic fun of(value: String) = ShippingMethod(JsonField.of(value))
485498
}
486499

487500
/** An enum containing [ShippingMethod]'s known values. */
488501
enum class Known {
489-
BULK_EXPEDITED
502+
BULK_EXPEDITED,
503+
BULK_PRIORITY,
504+
BULK_2_DAY,
505+
BULK_EXPRESS,
490506
}
491507

492508
/**
@@ -500,6 +516,9 @@ private constructor(
500516
*/
501517
enum class Value {
502518
BULK_EXPEDITED,
519+
BULK_PRIORITY,
520+
BULK_2_DAY,
521+
BULK_EXPRESS,
503522
/**
504523
* An enum member indicating that [ShippingMethod] was instantiated with an unknown
505524
* value.
@@ -517,6 +536,9 @@ private constructor(
517536
fun value(): Value =
518537
when (this) {
519538
BULK_EXPEDITED -> Value.BULK_EXPEDITED
539+
BULK_PRIORITY -> Value.BULK_PRIORITY
540+
BULK_2_DAY -> Value.BULK_2_DAY
541+
BULK_EXPRESS -> Value.BULK_EXPRESS
520542
else -> Value._UNKNOWN
521543
}
522544

@@ -532,6 +554,9 @@ private constructor(
532554
fun known(): Known =
533555
when (this) {
534556
BULK_EXPEDITED -> Known.BULK_EXPEDITED
557+
BULK_PRIORITY -> Known.BULK_PRIORITY
558+
BULK_2_DAY -> Known.BULK_2_DAY
559+
BULK_EXPRESS -> Known.BULK_EXPRESS
535560
else -> throw LithicInvalidDataException("Unknown ShippingMethod: $value")
536561
}
537562

‎lithic-java-core/src/main/kotlin/com/lithic/api/models/CardBulkOrderCreateParams.kt‎

Lines changed: 37 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ import java.util.Objects
2121
import kotlin.jvm.optionals.getOrNull
2222

2323
/**
24-
* Create a new bulk order for physical card shipments **[BETA]**. Cards can be added to the order
25-
* via the POST /v1/cards endpoint by specifying the bulk_order_token. Lock the order via PATCH
24+
* Create a new bulk order for physical card shipments. Cards can be added to the order via the POST
25+
* /v1/cards endpoint by specifying the bulk_order_token. Lock the order via PATCH
2626
* /v1/card_bulk_orders/{bulk_order_token} to prepare for shipment. Please work with your Customer
2727
* Success Manager and card personalization bureau to ensure bulk shipping is supported for your
2828
* program.
@@ -54,7 +54,8 @@ private constructor(
5454
fun _shippingAddress(): JsonValue = body._shippingAddress()
5555

5656
/**
57-
* Shipping method for all cards in this bulk order
57+
* Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and BULK_EXPRESS
58+
* are only available with Perfect Plastic Printing
5859
*
5960
* @throws LithicInvalidDataException if the JSON field has an unexpected type or is
6061
* unexpectedly missing or null (e.g. if the server responded with an unexpected value).
@@ -150,7 +151,10 @@ private constructor(
150151
body.shippingAddress(shippingAddress)
151152
}
152153

153-
/** Shipping method for all cards in this bulk order */
154+
/**
155+
* Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and
156+
* BULK_EXPRESS are only available with Perfect Plastic Printing
157+
*/
154158
fun shippingMethod(shippingMethod: ShippingMethod) = apply {
155159
body.shippingMethod(shippingMethod)
156160
}
@@ -360,7 +364,8 @@ private constructor(
360364
fun _shippingAddress(): JsonValue = shippingAddress
361365

362366
/**
363-
* Shipping method for all cards in this bulk order
367+
* Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and
368+
* BULK_EXPRESS are only available with Perfect Plastic Printing
364369
*
365370
* @throws LithicInvalidDataException if the JSON field has an unexpected type or is
366371
* unexpectedly missing or null (e.g. if the server responded with an unexpected value).
@@ -453,7 +458,10 @@ private constructor(
453458
this.shippingAddress = shippingAddress
454459
}
455460

456-
/** Shipping method for all cards in this bulk order */
461+
/**
462+
* Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and
463+
* BULK_EXPRESS are only available with Perfect Plastic Printing
464+
*/
457465
fun shippingMethod(shippingMethod: ShippingMethod) =
458466
shippingMethod(JsonField.of(shippingMethod))
459467

@@ -563,7 +571,10 @@ private constructor(
563571
"CreateBulkOrderRequest{customerProductId=$customerProductId, shippingAddress=$shippingAddress, shippingMethod=$shippingMethod, additionalProperties=$additionalProperties}"
564572
}
565573

566-
/** Shipping method for all cards in this bulk order */
574+
/**
575+
* Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and BULK_EXPRESS
576+
* are only available with Perfect Plastic Printing
577+
*/
567578
class ShippingMethod @JsonCreator private constructor(private val value: JsonField<String>) :
568579
Enum {
569580

@@ -581,12 +592,21 @@ private constructor(
581592

582593
@JvmField val BULK_EXPEDITED = of("BULK_EXPEDITED")
583594

595+
@JvmField val BULK_PRIORITY = of("BULK_PRIORITY")
596+
597+
@JvmField val BULK_2_DAY = of("BULK_2_DAY")
598+
599+
@JvmField val BULK_EXPRESS = of("BULK_EXPRESS")
600+
584601
@JvmStatic fun of(value: String) = ShippingMethod(JsonField.of(value))
585602
}
586603

587604
/** An enum containing [ShippingMethod]'s known values. */
588605
enum class Known {
589-
BULK_EXPEDITED
606+
BULK_EXPEDITED,
607+
BULK_PRIORITY,
608+
BULK_2_DAY,
609+
BULK_EXPRESS,
590610
}
591611

592612
/**
@@ -600,6 +620,9 @@ private constructor(
600620
*/
601621
enum class Value {
602622
BULK_EXPEDITED,
623+
BULK_PRIORITY,
624+
BULK_2_DAY,
625+
BULK_EXPRESS,
603626
/**
604627
* An enum member indicating that [ShippingMethod] was instantiated with an unknown
605628
* value.
@@ -617,6 +640,9 @@ private constructor(
617640
fun value(): Value =
618641
when (this) {
619642
BULK_EXPEDITED -> Value.BULK_EXPEDITED
643+
BULK_PRIORITY -> Value.BULK_PRIORITY
644+
BULK_2_DAY -> Value.BULK_2_DAY
645+
BULK_EXPRESS -> Value.BULK_EXPRESS
620646
else -> Value._UNKNOWN
621647
}
622648

@@ -632,6 +658,9 @@ private constructor(
632658
fun known(): Known =
633659
when (this) {
634660
BULK_EXPEDITED -> Known.BULK_EXPEDITED
661+
BULK_PRIORITY -> Known.BULK_PRIORITY
662+
BULK_2_DAY -> Known.BULK_2_DAY
663+
BULK_EXPRESS -> Known.BULK_EXPRESS
635664
else -> throw LithicInvalidDataException("Unknown ShippingMethod: $value")
636665
}
637666

‎lithic-java-core/src/main/kotlin/com/lithic/api/models/CardBulkOrderListParams.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import java.util.Objects
1111
import java.util.Optional
1212
import kotlin.jvm.optionals.getOrNull
1313

14-
/** List bulk orders for physical card shipments **[BETA]** */
14+
/** List bulk orders for physical card shipments */
1515
class CardBulkOrderListParams
1616
private constructor(
1717
private val begin: OffsetDateTime?,

‎lithic-java-core/src/main/kotlin/com/lithic/api/models/CardBulkOrderRetrieveParams.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import java.util.Objects
99
import java.util.Optional
1010
import kotlin.jvm.optionals.getOrNull
1111

12-
/** Retrieve a specific bulk order by token **[BETA]** */
12+
/** Retrieve a specific bulk order by token */
1313
class CardBulkOrderRetrieveParams
1414
private constructor(
1515
private val bulkOrderToken: String?,

‎lithic-java-core/src/main/kotlin/com/lithic/api/models/CardBulkOrderUpdateParams.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ import java.util.Optional
2222
import kotlin.jvm.optionals.getOrNull
2323

2424
/**
25-
* Update a bulk order **[BETA]**. Primarily used to lock the order, preventing additional cards
26-
* from being added
25+
* Update a bulk order. Primarily used to lock the order, preventing additional cards from being
26+
* added
2727
*/
2828
class CardBulkOrderUpdateParams
2929
private constructor(

‎lithic-java-core/src/main/kotlin/com/lithic/api/models/CardConvertPhysicalParams.kt‎

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,8 @@ private constructor(
7878
* * `2_DAY` - FedEx or UPS depending on card manufacturer, 2-day shipping, with tracking
7979
* * `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight or similar
8080
* international option, with tracking
81-
* * `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
81+
* * `BULK` - Card will be shipped as part of a bulk fulfillment order. The shipping method and
82+
* timeline are inherited from the parent bulk order.
8283
*
8384
* @throws LithicInvalidDataException if the JSON field has an unexpected type (e.g. if the
8485
* server responded with an unexpected value).
@@ -224,7 +225,8 @@ private constructor(
224225
* * `2_DAY` - FedEx or UPS depending on card manufacturer, 2-day shipping, with tracking
225226
* * `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight or
226227
* similar international option, with tracking
227-
* * `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
228+
* * `BULK` - Card will be shipped as part of a bulk fulfillment order. The shipping method
229+
* and timeline are inherited from the parent bulk order.
228230
*/
229231
fun shippingMethod(shippingMethod: ShippingMethod) = apply {
230232
body.shippingMethod(shippingMethod)
@@ -453,7 +455,8 @@ private constructor(
453455
* * `2_DAY` - FedEx or UPS depending on card manufacturer, 2-day shipping, with tracking
454456
* * `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight or
455457
* similar international option, with tracking
456-
* * `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
458+
* * `BULK` - Card will be shipped as part of a bulk fulfillment order. The shipping method
459+
* and timeline are inherited from the parent bulk order.
457460
*
458461
* @throws LithicInvalidDataException if the JSON field has an unexpected type (e.g. if the
459462
* server responded with an unexpected value).
@@ -594,7 +597,8 @@ private constructor(
594597
* tracking
595598
* * `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight or
596599
* similar international option, with tracking
597-
* * `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
600+
* * `BULK` - Card will be shipped as part of a bulk fulfillment order. The shipping
601+
* method and timeline are inherited from the parent bulk order.
598602
*/
599603
fun shippingMethod(shippingMethod: ShippingMethod) =
600604
shippingMethod(JsonField.of(shippingMethod))
@@ -720,7 +724,8 @@ private constructor(
720724
* * `2_DAY` - FedEx or UPS depending on card manufacturer, 2-day shipping, with tracking
721725
* * `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight or similar
722726
* international option, with tracking
723-
* * `BULK_EXPEDITED` - Bulk shipment with Expedited shipping
727+
* * `BULK` - Card will be shipped as part of a bulk fulfillment order. The shipping method and
728+
* timeline are inherited from the parent bulk order.
724729
*/
725730
class ShippingMethod @JsonCreator private constructor(private val value: JsonField<String>) :
726731
Enum {
@@ -739,7 +744,7 @@ private constructor(
739744

740745
@JvmField val _2_DAY = of("2_DAY")
741746

742-
@JvmField val BULK_EXPEDITED = of("BULK_EXPEDITED")
747+
@JvmField val BULK = of("BULK")
743748

744749
@JvmField val EXPEDITED = of("EXPEDITED")
745750

@@ -757,7 +762,7 @@ private constructor(
757762
/** An enum containing [ShippingMethod]'s known values. */
758763
enum class Known {
759764
_2_DAY,
760-
BULK_EXPEDITED,
765+
BULK,
761766
EXPEDITED,
762767
EXPRESS,
763768
PRIORITY,
@@ -776,7 +781,7 @@ private constructor(
776781
*/
777782
enum class Value {
778783
_2_DAY,
779-
BULK_EXPEDITED,
784+
BULK,
780785
EXPEDITED,
781786
EXPRESS,
782787
PRIORITY,
@@ -799,7 +804,7 @@ private constructor(
799804
fun value(): Value =
800805
when (this) {
801806
_2_DAY -> Value._2_DAY
802-
BULK_EXPEDITED -> Value.BULK_EXPEDITED
807+
BULK -> Value.BULK
803808
EXPEDITED -> Value.EXPEDITED
804809
EXPRESS -> Value.EXPRESS
805810
PRIORITY -> Value.PRIORITY
@@ -820,7 +825,7 @@ private constructor(
820825
fun known(): Known =
821826
when (this) {
822827
_2_DAY -> Known._2_DAY
823-
BULK_EXPEDITED -> Known.BULK_EXPEDITED
828+
BULK -> Known.BULK
824829
EXPEDITED -> Known.EXPEDITED
825830
EXPRESS -> Known.EXPRESS
826831
PRIORITY -> Known.PRIORITY

0 commit comments

Comments
 (0)