lithic 0.9.0 → 0.11.0

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.
Files changed (83) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +68 -0
  3. data/README.md +1 -1
  4. data/lib/lithic/internal/util.rb +22 -7
  5. data/lib/lithic/models/account_holder_create_params.rb +2 -1
  6. data/lib/lithic/models/account_holder_update_params.rb +2 -1
  7. data/lib/lithic/models/account_holder_updated_webhook_event.rb +2 -1
  8. data/lib/lithic/models/auth_rules/backtest_stats.rb +9 -1
  9. data/lib/lithic/models/auth_rules/conditional_authorization_action_parameters.rb +41 -0
  10. data/lib/lithic/models/auth_rules/report_stats.rb +46 -81
  11. data/lib/lithic/models/auth_rules/rule_feature.rb +1 -1
  12. data/lib/lithic/models/auth_rules/v2_list_results_response.rb +36 -4
  13. data/lib/lithic/models/auth_rules/v2_retrieve_report_response.rb +4 -531
  14. data/lib/lithic/models/card_authorization_approval_request_webhook_event.rb +112 -30
  15. data/lib/lithic/models/card_bulk_order.rb +8 -3
  16. data/lib/lithic/models/card_bulk_order_create_params.rb +8 -3
  17. data/lib/lithic/models/card_convert_physical_params.rb +5 -3
  18. data/lib/lithic/models/card_create_params.rb +5 -3
  19. data/lib/lithic/models/card_reissue_params.rb +5 -3
  20. data/lib/lithic/models/card_renew_params.rb +5 -3
  21. data/lib/lithic/models/carrier.rb +7 -2
  22. data/lib/lithic/models/financial_account.rb +1 -0
  23. data/lib/lithic/models/financial_account_update_status_params.rb +1 -0
  24. data/lib/lithic/models/financial_accounts/statement.rb +11 -4
  25. data/lib/lithic/models/instance_financial_account_type.rb +1 -0
  26. data/lib/lithic/models/kyb.rb +2 -1
  27. data/lib/lithic/models/parsed_webhook_event.rb +2 -1
  28. data/lib/lithic/models/payment.rb +14 -1
  29. data/lib/lithic/models/payment_create_params.rb +13 -1
  30. data/lib/lithic/models/transaction.rb +93 -4
  31. data/lib/lithic/resources/card_bulk_orders.rb +10 -11
  32. data/lib/lithic/version.rb +1 -1
  33. data/lib/lithic.rb +1 -1
  34. data/rbi/lithic/internal/util.rbi +8 -0
  35. data/rbi/lithic/models/account_holder_create_params.rbi +4 -2
  36. data/rbi/lithic/models/account_holder_update_params.rbi +4 -2
  37. data/rbi/lithic/models/account_holder_updated_webhook_event.rbi +4 -2
  38. data/rbi/lithic/models/auth_rules/backtest_stats.rbi +11 -3
  39. data/rbi/lithic/models/auth_rules/conditional_authorization_action_parameters.rbi +86 -0
  40. data/rbi/lithic/models/auth_rules/report_stats.rbi +73 -177
  41. data/rbi/lithic/models/auth_rules/rule_feature.rbi +1 -1
  42. data/rbi/lithic/models/auth_rules/v2_list_results_response.rbi +38 -6
  43. data/rbi/lithic/models/auth_rules/v2_retrieve_report_response.rbi +3 -1721
  44. data/rbi/lithic/models/card_authorization_approval_request_webhook_event.rbi +194 -82
  45. data/rbi/lithic/models/card_bulk_order.rbi +21 -3
  46. data/rbi/lithic/models/card_bulk_order_create_params.rbi +21 -3
  47. data/rbi/lithic/models/card_convert_physical_params.rbi +8 -5
  48. data/rbi/lithic/models/card_create_params.rbi +8 -8
  49. data/rbi/lithic/models/card_reissue_params.rbi +8 -8
  50. data/rbi/lithic/models/card_renew_params.rbi +8 -8
  51. data/rbi/lithic/models/carrier.rbi +6 -2
  52. data/rbi/lithic/models/financial_account.rbi +5 -0
  53. data/rbi/lithic/models/financial_account_update_status_params.rbi +5 -0
  54. data/rbi/lithic/models/financial_accounts/statement.rbi +15 -6
  55. data/rbi/lithic/models/instance_financial_account_type.rbi +5 -0
  56. data/rbi/lithic/models/kyb.rbi +4 -2
  57. data/rbi/lithic/models/parsed_webhook_event.rbi +4 -2
  58. data/rbi/lithic/models/payment.rbi +10 -0
  59. data/rbi/lithic/models/payment_create_params.rbi +13 -3
  60. data/rbi/lithic/models/transaction.rbi +146 -4
  61. data/rbi/lithic/resources/card_bulk_orders.rbi +11 -11
  62. data/rbi/lithic/resources/cards.rbi +8 -4
  63. data/sig/lithic/internal/util.rbs +4 -0
  64. data/sig/lithic/models/auth_rules/backtest_stats.rbs +8 -3
  65. data/sig/lithic/models/auth_rules/conditional_authorization_action_parameters.rbs +14 -0
  66. data/sig/lithic/models/auth_rules/report_stats.rbs +34 -70
  67. data/sig/lithic/models/auth_rules/v2_list_results_response.rbs +29 -9
  68. data/sig/lithic/models/auth_rules/v2_retrieve_report_response.rbs +4 -667
  69. data/sig/lithic/models/card_authorization_approval_request_webhook_event.rbs +89 -45
  70. data/sig/lithic/models/card_bulk_order.rbs +5 -1
  71. data/sig/lithic/models/card_bulk_order_create_params.rbs +5 -1
  72. data/sig/lithic/models/card_convert_physical_params.rbs +2 -2
  73. data/sig/lithic/models/card_create_params.rbs +2 -2
  74. data/sig/lithic/models/card_reissue_params.rbs +2 -2
  75. data/sig/lithic/models/card_renew_params.rbs +2 -2
  76. data/sig/lithic/models/financial_account.rbs +2 -0
  77. data/sig/lithic/models/financial_account_update_status_params.rbs +2 -0
  78. data/sig/lithic/models/financial_accounts/statement.rbs +16 -7
  79. data/sig/lithic/models/instance_financial_account_type.rbs +2 -0
  80. data/sig/lithic/models/payment.rbs +5 -0
  81. data/sig/lithic/models/payment_create_params.rbs +8 -3
  82. data/sig/lithic/models/transaction.rbs +75 -4
  83. metadata +2 -2
@@ -90,9 +90,10 @@ module Lithic
90
90
  required :event_type, const: :"card_authorization.approval_request"
91
91
 
92
92
  # @!attribute merchant
93
+ # Merchant information including full location details.
93
94
  #
94
- # @return [Lithic::Models::Merchant]
95
- required :merchant, -> { Lithic::Merchant }
95
+ # @return [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Merchant]
96
+ required :merchant, -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Merchant }
96
97
 
97
98
  # @!attribute merchant_amount
98
99
  # @deprecated
@@ -114,6 +115,16 @@ module Lithic
114
115
  # @return [String]
115
116
  required :merchant_currency, String
116
117
 
118
+ # @!attribute service_location
119
+ # Where the cardholder received the service, when different from the card acceptor
120
+ # location. This is populated from network data elements such as Mastercard DE-122
121
+ # SE1 SF9-14 and Visa F34 DS02.
122
+ #
123
+ # @return [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::ServiceLocation, nil]
124
+ required :service_location,
125
+ -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::ServiceLocation },
126
+ nil?: true
127
+
117
128
  # @!attribute settled_amount
118
129
  # @deprecated
119
130
  #
@@ -232,7 +243,7 @@ module Lithic
232
243
  # @return [Time, nil]
233
244
  optional :ttl, Time
234
245
 
235
- # @!method initialize(token:, acquirer_fee:, amount:, amounts:, authorization_amount:, avs:, card:, cardholder_currency:, cash_amount:, created:, merchant:, merchant_amount:, merchant_currency:, settled_amount:, status:, transaction_initiator:, account_type: nil, cardholder_authentication: nil, cashback: nil, conversion_rate: nil, event_token: nil, fleet_info: nil, latest_challenge: nil, network: nil, network_risk_score: nil, network_specific_data: nil, pos: nil, token_info: nil, ttl: nil, event_type: :"card_authorization.approval_request")
246
+ # @!method initialize(token:, acquirer_fee:, amount:, amounts:, authorization_amount:, avs:, card:, cardholder_currency:, cash_amount:, created:, merchant:, merchant_amount:, merchant_currency:, service_location:, settled_amount:, status:, transaction_initiator:, account_type: nil, cardholder_authentication: nil, cashback: nil, conversion_rate: nil, event_token: nil, fleet_info: nil, latest_challenge: nil, network: nil, network_risk_score: nil, network_specific_data: nil, pos: nil, token_info: nil, ttl: nil, event_type: :"card_authorization.approval_request")
236
247
  # Some parameter documentations has been truncated, see
237
248
  # {Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent} for more details.
238
249
  #
@@ -256,12 +267,14 @@ module Lithic
256
267
  #
257
268
  # @param created [Time] Date and time when the transaction first occurred in UTC.
258
269
  #
259
- # @param merchant [Lithic::Models::Merchant]
270
+ # @param merchant [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Merchant] Merchant information including full location details.
260
271
  #
261
272
  # @param merchant_amount [Integer] Deprecated, use `amounts`. The amount that the merchant will receive, denominate
262
273
  #
263
274
  # @param merchant_currency [String] 3-character alphabetic ISO 4217 code for the local currency of the transaction.
264
275
  #
276
+ # @param service_location [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::ServiceLocation, nil] Where the cardholder received the service, when different from the card acceptor
277
+ #
265
278
  # @param settled_amount [Integer] Deprecated, use `amounts`. Amount (in cents) of the transaction that has been se
266
279
  #
267
280
  # @param status [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Status] The type of authorization request that this request is for. Note that `CREDIT_AU
@@ -481,27 +494,20 @@ module Lithic
481
494
  # @!attribute token
482
495
  # Globally unique identifier for the card.
483
496
  #
484
- # @return [String, nil]
485
- optional :token, String
486
-
487
- # @!attribute hostname
488
- # Hostname of card’s locked merchant (will be empty if not applicable)
489
- #
490
- # @return [String, nil]
491
- optional :hostname, String
497
+ # @return [String]
498
+ required :token, String
492
499
 
493
500
  # @!attribute last_four
494
501
  # Last four digits of the card number
495
502
  #
496
- # @return [String, nil]
497
- optional :last_four, String
503
+ # @return [String]
504
+ required :last_four, String
498
505
 
499
506
  # @!attribute memo
500
- # Customizable name to identify the card. We recommend against using this field to
501
- # store JSON data as it can cause unexpected behavior.
507
+ # Customizable name to identify the card
502
508
  #
503
- # @return [String, nil]
504
- optional :memo, String
509
+ # @return [String]
510
+ required :memo, String
505
511
 
506
512
  # @!attribute spend_limit
507
513
  # Amount (in cents) to limit approved authorizations. Purchase requests above the
@@ -513,29 +519,29 @@ module Lithic
513
519
  # charges (i.e., when a merchant sends a clearing message without a prior
514
520
  # authorization).
515
521
  #
516
- # @return [Integer, nil]
517
- optional :spend_limit, Integer
522
+ # @return [Integer]
523
+ required :spend_limit, Integer
518
524
 
519
525
  # @!attribute spend_limit_duration
520
526
  # Note that to support recurring monthly payments, which can occur on different
521
527
  # day every month, the time window we consider for MONTHLY velocity starts 6 days
522
528
  # after the current calendar date one month prior.
523
529
  #
524
- # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Card::SpendLimitDuration, nil]
525
- optional :spend_limit_duration,
530
+ # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Card::SpendLimitDuration]
531
+ required :spend_limit_duration,
526
532
  enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Card::SpendLimitDuration }
527
533
 
528
534
  # @!attribute state
529
535
  #
530
- # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Card::State, nil]
531
- optional :state, enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Card::State }
536
+ # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Card::State]
537
+ required :state, enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Card::State }
532
538
 
533
539
  # @!attribute type
534
540
  #
535
- # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Card::Type, nil]
536
- optional :type, enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Card::Type }
541
+ # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Card::Type]
542
+ required :type, enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Card::Type }
537
543
 
538
- # @!method initialize(token: nil, hostname: nil, last_four: nil, memo: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, type: nil)
544
+ # @!method initialize(token:, last_four:, memo:, spend_limit:, spend_limit_duration:, state:, type:)
539
545
  # Some parameter documentations has been truncated, see
540
546
  # {Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Card} for more
541
547
  # details.
@@ -544,11 +550,9 @@ module Lithic
544
550
  #
545
551
  # @param token [String] Globally unique identifier for the card.
546
552
  #
547
- # @param hostname [String] Hostname of card’s locked merchant (will be empty if not applicable)
548
- #
549
553
  # @param last_four [String] Last four digits of the card number
550
554
  #
551
- # @param memo [String] Customizable name to identify the card. We recommend against using this field to
555
+ # @param memo [String] Customizable name to identify the card
552
556
  #
553
557
  # @param spend_limit [Integer] Amount (in cents) to limit approved authorizations. Purchase requests above the
554
558
  #
@@ -605,6 +609,84 @@ module Lithic
605
609
  end
606
610
  end
607
611
 
612
+ # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent#merchant
613
+ class Merchant < Lithic::Models::Merchant
614
+ # @!attribute phone_number
615
+ # Phone number of card acceptor.
616
+ #
617
+ # @return [String, nil]
618
+ required :phone_number, String, nil?: true
619
+
620
+ # @!attribute postal_code
621
+ # Postal code of card acceptor.
622
+ #
623
+ # @return [String, nil]
624
+ required :postal_code, String, nil?: true
625
+
626
+ # @!attribute street_address
627
+ # Street address of card acceptor.
628
+ #
629
+ # @return [String, nil]
630
+ required :street_address, String, nil?: true
631
+
632
+ # @!method initialize(phone_number:, postal_code:, street_address:)
633
+ # Merchant information including full location details.
634
+ #
635
+ # @param phone_number [String, nil] Phone number of card acceptor.
636
+ #
637
+ # @param postal_code [String, nil] Postal code of card acceptor.
638
+ #
639
+ # @param street_address [String, nil] Street address of card acceptor.
640
+ end
641
+
642
+ # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent#service_location
643
+ class ServiceLocation < Lithic::Internal::Type::BaseModel
644
+ # @!attribute city
645
+ # City of service location.
646
+ #
647
+ # @return [String, nil]
648
+ required :city, String, nil?: true
649
+
650
+ # @!attribute country
651
+ # Country code of service location, ISO 3166-1 alpha-3.
652
+ #
653
+ # @return [String, nil]
654
+ required :country, String, nil?: true
655
+
656
+ # @!attribute postal_code
657
+ # Postal code of service location.
658
+ #
659
+ # @return [String, nil]
660
+ required :postal_code, String, nil?: true
661
+
662
+ # @!attribute state
663
+ # State/province code of service location, ISO 3166-2.
664
+ #
665
+ # @return [String, nil]
666
+ required :state, String, nil?: true
667
+
668
+ # @!attribute street_address
669
+ # Street address of service location.
670
+ #
671
+ # @return [String, nil]
672
+ required :street_address, String, nil?: true
673
+
674
+ # @!method initialize(city:, country:, postal_code:, state:, street_address:)
675
+ # Where the cardholder received the service, when different from the card acceptor
676
+ # location. This is populated from network data elements such as Mastercard DE-122
677
+ # SE1 SF9-14 and Visa F34 DS02.
678
+ #
679
+ # @param city [String, nil] City of service location.
680
+ #
681
+ # @param country [String, nil] Country code of service location, ISO 3166-1 alpha-3.
682
+ #
683
+ # @param postal_code [String, nil] Postal code of service location.
684
+ #
685
+ # @param state [String, nil] State/province code of service location, ISO 3166-2.
686
+ #
687
+ # @param street_address [String, nil] Street address of service location.
688
+ end
689
+
608
690
  # The type of authorization request that this request is for. Note that
609
691
  # `CREDIT_AUTHORIZATION` and `FINANCIAL_CREDIT_AUTHORIZATION` is only available to
610
692
  # users with credit decisioning via ASA enabled.
@@ -36,7 +36,8 @@ module Lithic
36
36
  required :shipping_address, Lithic::Internal::Type::Unknown
37
37
 
38
38
  # @!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
40
41
  #
41
42
  # @return [Symbol, Lithic::Models::CardBulkOrder::ShippingMethod]
42
43
  required :shipping_method, enum: -> { Lithic::CardBulkOrder::ShippingMethod }
@@ -70,19 +71,23 @@ module Lithic
70
71
  #
71
72
  # @param shipping_address [Object] Shipping address for all cards in this bulk order
72
73
  #
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
74
75
  #
75
76
  # @param status [Symbol, Lithic::Models::CardBulkOrder::Status] Status of the bulk order. OPEN indicates the order is accepting cards. LOCKED in
76
77
  #
77
78
  # @param updated [Time] An RFC 3339 timestamp for when the bulk order was last updated. UTC time zone
78
79
 
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
80
82
  #
81
83
  # @see Lithic::Models::CardBulkOrder#shipping_method
82
84
  module ShippingMethod
83
85
  extend Lithic::Internal::Type::Enum
84
86
 
85
87
  BULK_EXPEDITED = :BULK_EXPEDITED
88
+ BULK_PRIORITY = :BULK_PRIORITY
89
+ BULK_2_DAY = :BULK_2_DAY
90
+ BULK_EXPRESS = :BULK_EXPRESS
86
91
 
87
92
  # @!method self.values
88
93
  # @return [Array<Symbol>]
@@ -21,7 +21,8 @@ module Lithic
21
21
  required :shipping_address, Lithic::Internal::Type::Unknown
22
22
 
23
23
  # @!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
25
26
  #
26
27
  # @return [Symbol, Lithic::Models::CardBulkOrderCreateParams::ShippingMethod]
27
28
  required :shipping_method, enum: -> { Lithic::CardBulkOrderCreateParams::ShippingMethod }
@@ -34,15 +35,19 @@ module Lithic
34
35
  #
35
36
  # @param shipping_address [Object] Shipping address for all cards in this bulk order
36
37
  #
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
38
39
  #
39
40
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
40
41
 
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
42
44
  module ShippingMethod
43
45
  extend Lithic::Internal::Type::Enum
44
46
 
45
47
  BULK_EXPEDITED = :BULK_EXPEDITED
48
+ BULK_PRIORITY = :BULK_PRIORITY
49
+ BULK_2_DAY = :BULK_2_DAY
50
+ BULK_EXPRESS = :BULK_EXPRESS
46
51
 
47
52
  # @!method self.values
48
53
  # @return [Array<Symbol>]
@@ -47,7 +47,8 @@ module Lithic
47
47
  # tracking
48
48
  # - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
49
49
  # 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.
51
52
  #
52
53
  # @return [Symbol, Lithic::Models::CardConvertPhysicalParams::ShippingMethod, nil]
53
54
  optional :shipping_method, enum: -> { Lithic::CardConvertPhysicalParams::ShippingMethod }
@@ -82,12 +83,13 @@ module Lithic
82
83
  # tracking
83
84
  # - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
84
85
  # 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.
86
88
  module ShippingMethod
87
89
  extend Lithic::Internal::Type::Enum
88
90
 
89
91
  SHIPPING_METHOD_2_DAY = :"2_DAY"
90
- BULK_EXPEDITED = :BULK_EXPEDITED
92
+ BULK = :BULK
91
93
  EXPEDITED = :EXPEDITED
92
94
  EXPRESS = :EXPRESS
93
95
  PRIORITY = :PRIORITY
@@ -183,7 +183,8 @@ module Lithic
183
183
  # tracking
184
184
  # - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
185
185
  # 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.
187
188
  #
188
189
  # @return [Symbol, Lithic::Models::CardCreateParams::ShippingMethod, nil]
189
190
  optional :shipping_method, enum: -> { Lithic::CardCreateParams::ShippingMethod }
@@ -369,12 +370,13 @@ module Lithic
369
370
  # tracking
370
371
  # - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
371
372
  # 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.
373
375
  module ShippingMethod
374
376
  extend Lithic::Internal::Type::Enum
375
377
 
376
378
  SHIPPING_METHOD_2_DAY = :"2_DAY"
377
- BULK_EXPEDITED = :BULK_EXPEDITED
379
+ BULK = :BULK
378
380
  EXPEDITED = :EXPEDITED
379
381
  EXPRESS = :EXPRESS
380
382
  PRIORITY = :PRIORITY
@@ -47,7 +47,8 @@ module Lithic
47
47
  # tracking
48
48
  # - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
49
49
  # 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.
51
52
  #
52
53
  # @return [Symbol, Lithic::Models::CardReissueParams::ShippingMethod, nil]
53
54
  optional :shipping_method, enum: -> { Lithic::CardReissueParams::ShippingMethod }
@@ -82,12 +83,13 @@ module Lithic
82
83
  # tracking
83
84
  # - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
84
85
  # 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.
86
88
  module ShippingMethod
87
89
  extend Lithic::Internal::Type::Enum
88
90
 
89
91
  SHIPPING_METHOD_2_DAY = :"2_DAY"
90
- BULK_EXPEDITED = :BULK_EXPEDITED
92
+ BULK = :BULK
91
93
  EXPEDITED = :EXPEDITED
92
94
  EXPRESS = :EXPRESS
93
95
  PRIORITY = :PRIORITY
@@ -61,7 +61,8 @@ module Lithic
61
61
  # tracking
62
62
  # - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
63
63
  # 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.
65
66
  #
66
67
  # @return [Symbol, Lithic::Models::CardRenewParams::ShippingMethod, nil]
67
68
  optional :shipping_method, enum: -> { Lithic::CardRenewParams::ShippingMethod }
@@ -100,12 +101,13 @@ module Lithic
100
101
  # tracking
101
102
  # - `EXPEDITED` - FedEx or UPS depending on card manufacturer, Standard Overnight
102
103
  # 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.
104
106
  module ShippingMethod
105
107
  extend Lithic::Internal::Type::Enum
106
108
 
107
109
  SHIPPING_METHOD_2_DAY = :"2_DAY"
108
- BULK_EXPEDITED = :BULK_EXPEDITED
110
+ BULK = :BULK
109
111
  EXPEDITED = :EXPEDITED
110
112
  EXPRESS = :EXPRESS
111
113
  PRIORITY = :PRIORITY
@@ -4,13 +4,18 @@ module Lithic
4
4
  module Models
5
5
  class Carrier < Lithic::Internal::Type::BaseModel
6
6
  # @!attribute qr_code_url
7
- # QR code url to display on the card carrier
7
+ # QR code URL to display on the card carrier. The `qr_code_url` field requires
8
+ # your domain to be allowlisted by Lithic before use. Contact Support to configure
9
+ # your QR code domain
8
10
  #
9
11
  # @return [String, nil]
10
12
  optional :qr_code_url, String
11
13
 
12
14
  # @!method initialize(qr_code_url: nil)
13
- # @param qr_code_url [String] QR code url to display on the card carrier
15
+ # Some parameter documentations has been truncated, see {Lithic::Models::Carrier}
16
+ # for more details.
17
+ #
18
+ # @param qr_code_url [String] QR code URL to display on the card carrier. The `qr_code_url` field requires you
14
19
  end
15
20
  end
16
21
  end
@@ -203,6 +203,7 @@ module Lithic
203
203
  COLLECTION = :COLLECTION
204
204
  PROGRAM_BANK_ACCOUNTS_PAYABLE = :PROGRAM_BANK_ACCOUNTS_PAYABLE
205
205
  EARLY_DIRECT_DEPOSIT_FLOAT = :EARLY_DIRECT_DEPOSIT_FLOAT
206
+ PROVISIONAL_CREDIT_ACCOUNT = :PROVISIONAL_CREDIT_ACCOUNT
206
207
 
207
208
  # @!method self.values
208
209
  # @return [Array<Symbol>]
@@ -63,6 +63,7 @@ module Lithic
63
63
  BANK_REQUEST = :BANK_REQUEST
64
64
  CHARGED_OFF_DELINQUENT = :CHARGED_OFF_DELINQUENT
65
65
  INTEREST_AND_FEES_PAUSED = :INTEREST_AND_FEES_PAUSED
66
+ DELINQUENT = :DELINQUENT
66
67
 
67
68
  # @!method self.values
68
69
  # @return [Array<Symbol>]
@@ -42,8 +42,8 @@ module Lithic
42
42
  # @!attribute credit_product_token
43
43
  # Globally unique identifier for a credit product
44
44
  #
45
- # @return [String]
46
- required :credit_product_token, String
45
+ # @return [String, nil]
46
+ required :credit_product_token, String, nil?: true
47
47
 
48
48
  # @!attribute days_in_billing_cycle
49
49
  # Number of days in the billing cycle
@@ -132,7 +132,12 @@ module Lithic
132
132
  # @return [Lithic::Models::FinancialAccounts::Statement::PayoffDetails, nil]
133
133
  optional :payoff_details, -> { Lithic::FinancialAccounts::Statement::PayoffDetails }, nil?: true
134
134
 
135
- # @!method initialize(token:, account_standing:, amount_due:, available_credit:, created:, credit_limit:, credit_product_token:, days_in_billing_cycle:, ending_balance:, financial_account_token:, payment_due_date:, period_totals:, starting_balance:, statement_end_date:, statement_start_date:, statement_type:, updated:, ytd_totals:, interest_details: nil, next_payment_due_date: nil, next_statement_end_date: nil, payoff_details: nil)
135
+ # @!attribute statement_totals
136
+ #
137
+ # @return [Lithic::Models::StatementTotals, nil]
138
+ optional :statement_totals, -> { Lithic::StatementTotals }
139
+
140
+ # @!method initialize(token:, account_standing:, amount_due:, available_credit:, created:, credit_limit:, credit_product_token:, days_in_billing_cycle:, ending_balance:, financial_account_token:, payment_due_date:, period_totals:, starting_balance:, statement_end_date:, statement_start_date:, statement_type:, updated:, ytd_totals:, interest_details: nil, next_payment_due_date: nil, next_statement_end_date: nil, payoff_details: nil, statement_totals: nil)
136
141
  # Some parameter documentations has been truncated, see
137
142
  # {Lithic::Models::FinancialAccounts::Statement} for more details.
138
143
  #
@@ -148,7 +153,7 @@ module Lithic
148
153
  #
149
154
  # @param credit_limit [Integer] This is the maximum credit balance extended by the lender in cents
150
155
  #
151
- # @param credit_product_token [String] Globally unique identifier for a credit product
156
+ # @param credit_product_token [String, nil] Globally unique identifier for a credit product
152
157
  #
153
158
  # @param days_in_billing_cycle [Integer] Number of days in the billing cycle
154
159
  #
@@ -179,6 +184,8 @@ module Lithic
179
184
  # @param next_statement_end_date [Date] Date when the next billing period will end
180
185
  #
181
186
  # @param payoff_details [Lithic::Models::FinancialAccounts::Statement::PayoffDetails, nil] Details on number and size of payments to pay off balance
187
+ #
188
+ # @param statement_totals [Lithic::Models::StatementTotals]
182
189
 
183
190
  # @see Lithic::Models::FinancialAccounts::Statement#account_standing
184
191
  class AccountStanding < Lithic::Internal::Type::BaseModel
@@ -17,6 +17,7 @@ module Lithic
17
17
  COLLECTION = :COLLECTION
18
18
  PROGRAM_BANK_ACCOUNTS_PAYABLE = :PROGRAM_BANK_ACCOUNTS_PAYABLE
19
19
  EARLY_DIRECT_DEPOSIT_FLOAT = :EARLY_DIRECT_DEPOSIT_FLOAT
20
+ PROVISIONAL_CREDIT_ACCOUNT = :PROVISIONAL_CREDIT_ACCOUNT
20
21
 
21
22
  # @!method self.values
22
23
  # @return [Array<Symbol>]
@@ -37,7 +37,8 @@ module Lithic
37
37
 
38
38
  # @!attribute nature_of_business
39
39
  # Short description of the company's line of business (i.e., what does the company
40
- # do?).
40
+ # do?). Values longer than 255 characters will be truncated before KYB
41
+ # verification
41
42
  #
42
43
  # @return [String]
43
44
  required :nature_of_business, String
@@ -170,7 +170,8 @@ module Lithic
170
170
 
171
171
  # @!attribute nature_of_business
172
172
  # Short description of the company's line of business (i.e., what does the company
173
- # do?).
173
+ # do?). Values longer than 255 characters will be truncated before KYB
174
+ # verification
174
175
  #
175
176
  # @return [String, nil]
176
177
  optional :nature_of_business, String
@@ -514,6 +514,13 @@ module Lithic
514
514
  # @return [String, nil]
515
515
  optional :company_id, String, nil?: true
516
516
 
517
+ # @!attribute override_company_name
518
+ # Value to override the configured company name with. Can only be used if allowed
519
+ # to override
520
+ #
521
+ # @return [String, nil]
522
+ optional :override_company_name, String, nil?: true
523
+
517
524
  # @!attribute receipt_routing_number
518
525
  # Receipt routing number
519
526
  #
@@ -538,7 +545,11 @@ module Lithic
538
545
  # @return [Array<String>, nil]
539
546
  optional :trace_numbers, Lithic::Internal::Type::ArrayOf[String]
540
547
 
541
- # @!method initialize(sec_code:, ach_hold_period: nil, addenda: nil, company_id: nil, receipt_routing_number: nil, retries: nil, return_reason_code: nil, trace_numbers: nil)
548
+ # @!method initialize(sec_code:, ach_hold_period: nil, addenda: nil, company_id: nil, override_company_name: nil, receipt_routing_number: nil, retries: nil, return_reason_code: nil, trace_numbers: nil)
549
+ # Some parameter documentations has been truncated, see
550
+ # {Lithic::Models::Payment::MethodAttributes::ACHMethodAttributes} for more
551
+ # details.
552
+ #
542
553
  # @param sec_code [Symbol, Lithic::Models::Payment::MethodAttributes::ACHMethodAttributes::SecCode] SEC code for ACH transaction
543
554
  #
544
555
  # @param ach_hold_period [Integer, nil] Number of days the ACH transaction is on hold
@@ -547,6 +558,8 @@ module Lithic
547
558
  #
548
559
  # @param company_id [String, nil] Company ID for the ACH transaction
549
560
  #
561
+ # @param override_company_name [String, nil] Value to override the configured company name with. Can only be used if allowed
562
+ #
550
563
  # @param receipt_routing_number [String, nil] Receipt routing number
551
564
  #
552
565
  # @param retries [Integer, nil] Number of retries attempted
@@ -113,12 +113,24 @@ module Lithic
113
113
  # @return [String, nil]
114
114
  optional :addenda, String, nil?: true
115
115
 
116
- # @!method initialize(sec_code:, ach_hold_period: nil, addenda: nil)
116
+ # @!attribute override_company_name
117
+ # Value to override the configured company name with. Can only be used if allowed
118
+ # to override
119
+ #
120
+ # @return [String, nil]
121
+ optional :override_company_name, String, nil?: true
122
+
123
+ # @!method initialize(sec_code:, ach_hold_period: nil, addenda: nil, override_company_name: nil)
124
+ # Some parameter documentations has been truncated, see
125
+ # {Lithic::Models::PaymentCreateParams::MethodAttributes} for more details.
126
+ #
117
127
  # @param sec_code [Symbol, Lithic::Models::PaymentCreateParams::MethodAttributes::SecCode]
118
128
  #
119
129
  # @param ach_hold_period [Integer] Number of days to hold the ACH payment
120
130
  #
121
131
  # @param addenda [String, nil]
132
+ #
133
+ # @param override_company_name [String, nil] Value to override the configured company name with. Can only be used if allowed
122
134
 
123
135
  # @see Lithic::Models::PaymentCreateParams::MethodAttributes#sec_code
124
136
  module SecCode