lithic 0.1.0.pre.alpha.38 → 0.1.0.pre.alpha.40

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 (122) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +19 -0
  3. data/README.md +1 -1
  4. data/lib/lithic/client.rb +4 -0
  5. data/lib/lithic/models/account.rb +88 -1
  6. data/lib/lithic/models/account_update_params.rb +86 -1
  7. data/lib/lithic/models/aggregate_balance.rb +1 -0
  8. data/lib/lithic/models/aggregate_balance_list_params.rb +1 -0
  9. data/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb +4 -10
  10. data/lib/lithic/models/auth_rules/velocity_limit_params.rb +3 -25
  11. data/lib/lithic/models/auth_rules/velocity_limit_params_period_window.rb +238 -16
  12. data/lib/lithic/models/balance.rb +1 -0
  13. data/lib/lithic/models/balance_list_params.rb +1 -0
  14. data/lib/lithic/models/card_create_params.rb +90 -1
  15. data/lib/lithic/models/card_program.rb +10 -1
  16. data/lib/lithic/models/card_update_params.rb +98 -1
  17. data/lib/lithic/models/cards/balance_list_response.rb +1 -0
  18. data/lib/lithic/models/event.rb +2 -0
  19. data/lib/lithic/models/event_list_params.rb +2 -0
  20. data/lib/lithic/models/event_subscription.rb +2 -0
  21. data/lib/lithic/models/events/subscription_create_params.rb +2 -0
  22. data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +2 -0
  23. data/lib/lithic/models/events/subscription_update_params.rb +2 -0
  24. data/lib/lithic/models/external_resource.rb +34 -0
  25. data/lib/lithic/models/external_resource_type.rb +18 -0
  26. data/lib/lithic/models/financial_account_list_params.rb +1 -0
  27. data/lib/lithic/models/financial_accounts/balance_list_response.rb +1 -0
  28. data/lib/lithic/models/management_operation_create_params.rb +30 -1
  29. data/lib/lithic/models/management_operation_transaction.rb +22 -1
  30. data/lib/lithic/models/network_program.rb +41 -0
  31. data/lib/lithic/models/network_program_list_params.rb +43 -0
  32. data/lib/lithic/models/network_program_retrieve_params.rb +14 -0
  33. data/lib/lithic/models/non_pci_card.rb +88 -1
  34. data/lib/lithic/models/payment_simulate_action_params.rb +1 -0
  35. data/lib/lithic/models/reports/settlement/network_total_list_response.rb +16 -6
  36. data/lib/lithic/models/reports/settlement/network_total_retrieve_response.rb +16 -6
  37. data/lib/lithic/models/transaction.rb +31 -20
  38. data/lib/lithic/models.rb +10 -0
  39. data/lib/lithic/resources/accounts.rb +5 -1
  40. data/lib/lithic/resources/cards.rb +12 -2
  41. data/lib/lithic/resources/management_operations.rb +13 -1
  42. data/lib/lithic/resources/network_programs.rb +64 -0
  43. data/lib/lithic/version.rb +1 -1
  44. data/lib/lithic.rb +6 -0
  45. data/rbi/lithic/client.rbi +3 -0
  46. data/rbi/lithic/models/account.rbi +131 -0
  47. data/rbi/lithic/models/account_update_params.rbi +159 -0
  48. data/rbi/lithic/models/aggregate_balance.rbi +5 -0
  49. data/rbi/lithic/models/aggregate_balance_list_params.rbi +5 -0
  50. data/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi +6 -15
  51. data/rbi/lithic/models/auth_rules/velocity_limit_params.rbi +18 -25
  52. data/rbi/lithic/models/auth_rules/velocity_limit_params_period_window.rbi +527 -31
  53. data/rbi/lithic/models/balance.rbi +2 -0
  54. data/rbi/lithic/models/balance_list_params.rbi +5 -0
  55. data/rbi/lithic/models/card_create_params.rbi +190 -0
  56. data/rbi/lithic/models/card_program.rbi +13 -0
  57. data/rbi/lithic/models/card_update_params.rbi +168 -0
  58. data/rbi/lithic/models/cards/balance_list_response.rbi +5 -0
  59. data/rbi/lithic/models/event.rbi +10 -0
  60. data/rbi/lithic/models/event_list_params.rbi +10 -0
  61. data/rbi/lithic/models/event_subscription.rbi +10 -0
  62. data/rbi/lithic/models/events/subscription_create_params.rbi +10 -0
  63. data/rbi/lithic/models/events/subscription_send_simulated_example_params.rbi +10 -0
  64. data/rbi/lithic/models/events/subscription_update_params.rbi +10 -0
  65. data/rbi/lithic/models/external_resource.rbi +57 -0
  66. data/rbi/lithic/models/external_resource_type.rbi +26 -0
  67. data/rbi/lithic/models/financial_account_list_params.rbi +5 -0
  68. data/rbi/lithic/models/financial_accounts/balance_list_response.rbi +5 -0
  69. data/rbi/lithic/models/management_operation_create_params.rbi +59 -0
  70. data/rbi/lithic/models/management_operation_transaction.rbi +15 -0
  71. data/rbi/lithic/models/network_program.rbi +61 -0
  72. data/rbi/lithic/models/network_program_list_params.rbi +72 -0
  73. data/rbi/lithic/models/network_program_retrieve_params.rbi +27 -0
  74. data/rbi/lithic/models/non_pci_card.rbi +133 -3
  75. data/rbi/lithic/models/payment_simulate_action_params.rbi +5 -0
  76. data/rbi/lithic/models/reports/settlement/network_total_list_response.rbi +21 -6
  77. data/rbi/lithic/models/reports/settlement/network_total_retrieve_response.rbi +21 -6
  78. data/rbi/lithic/models/transaction.rbi +23 -31
  79. data/rbi/lithic/models.rbi +10 -0
  80. data/rbi/lithic/resources/accounts.rbi +32 -0
  81. data/rbi/lithic/resources/cards.rbi +70 -0
  82. data/rbi/lithic/resources/management_operations.rbi +4 -0
  83. data/rbi/lithic/resources/network_programs.rbi +48 -0
  84. data/sig/lithic/client.rbs +2 -0
  85. data/sig/lithic/models/account.rbs +41 -0
  86. data/sig/lithic/models/account_update_params.rbs +41 -0
  87. data/sig/lithic/models/aggregate_balance.rbs +2 -1
  88. data/sig/lithic/models/aggregate_balance_list_params.rbs +2 -1
  89. data/sig/lithic/models/auth_rules/velocity_limit_params.rbs +4 -14
  90. data/sig/lithic/models/auth_rules/velocity_limit_params_period_window.rbs +212 -7
  91. data/sig/lithic/models/balance.rbs +2 -1
  92. data/sig/lithic/models/balance_list_params.rbs +2 -1
  93. data/sig/lithic/models/card_create_params.rbs +47 -0
  94. data/sig/lithic/models/card_program.rbs +7 -0
  95. data/sig/lithic/models/card_update_params.rbs +55 -1
  96. data/sig/lithic/models/cards/balance_list_response.rbs +2 -1
  97. data/sig/lithic/models/event.rbs +4 -0
  98. data/sig/lithic/models/event_list_params.rbs +4 -0
  99. data/sig/lithic/models/event_subscription.rbs +4 -0
  100. data/sig/lithic/models/events/subscription_create_params.rbs +4 -0
  101. data/sig/lithic/models/events/subscription_send_simulated_example_params.rbs +4 -0
  102. data/sig/lithic/models/events/subscription_update_params.rbs +4 -0
  103. data/sig/lithic/models/external_resource.rbs +32 -0
  104. data/sig/lithic/models/external_resource_type.rbs +16 -0
  105. data/sig/lithic/models/financial_account_list_params.rbs +2 -1
  106. data/sig/lithic/models/financial_accounts/balance_list_response.rbs +2 -1
  107. data/sig/lithic/models/management_operation_create_params.rbs +20 -0
  108. data/sig/lithic/models/management_operation_transaction.rbs +5 -0
  109. data/sig/lithic/models/network_program.rbs +35 -0
  110. data/sig/lithic/models/network_program_list_params.rbs +38 -0
  111. data/sig/lithic/models/network_program_retrieve_params.rbs +15 -0
  112. data/sig/lithic/models/non_pci_card.rbs +55 -3
  113. data/sig/lithic/models/payment_simulate_action_params.rbs +2 -0
  114. data/sig/lithic/models/reports/settlement/network_total_list_response.rbs +7 -1
  115. data/sig/lithic/models/reports/settlement/network_total_retrieve_response.rbs +7 -1
  116. data/sig/lithic/models/transaction.rbs +2 -6
  117. data/sig/lithic/models.rbs +10 -0
  118. data/sig/lithic/resources/accounts.rbs +2 -0
  119. data/sig/lithic/resources/cards.rbs +5 -0
  120. data/sig/lithic/resources/management_operations.rbs +1 -0
  121. data/sig/lithic/resources/network_programs.rbs +19 -0
  122. metadata +20 -2
@@ -3,25 +3,247 @@
3
3
  module Lithic
4
4
  module Models
5
5
  module AuthRules
6
- # The window of time to calculate Spend Velocity over.
7
- #
8
- # - `DAY`: Velocity over the current day since midnight Eastern Time.
9
- # - `WEEK`: Velocity over the current week since 00:00 / 12 AM on Monday in
10
- # Eastern Time.
11
- # - `MONTH`: Velocity over the current month since 00:00 / 12 AM on the first of
12
- # the month in Eastern Time.
13
- # - `YEAR`: Velocity over the current year since 00:00 / 12 AM on January 1st in
14
- # Eastern Time.
6
+ # The size of the trailing window to calculate Spend Velocity over in seconds. The
7
+ # minimum value is 10 seconds, and the maximum value is 2678400 seconds (31 days).
15
8
  module VelocityLimitParamsPeriodWindow
16
- extend Lithic::Internal::Type::Enum
9
+ extend Lithic::Internal::Type::Union
17
10
 
18
- DAY = :DAY
19
- WEEK = :WEEK
20
- MONTH = :MONTH
21
- YEAR = :YEAR
11
+ # The size of the trailing window to calculate Spend Velocity over in seconds. The minimum value is 10 seconds, and the maximum value is 2678400 seconds (31 days).
12
+ variant Integer
22
13
 
23
- # @!method self.values
24
- # @return [Array<Symbol>]
14
+ # The window of time to calculate Spend Velocity over.
15
+ #
16
+ # * `DAY`: Velocity over the current day since midnight Eastern Time.
17
+ # * `WEEK`: Velocity over the current week since 00:00 / 12 AM on Monday in Eastern Time.
18
+ # * `MONTH`: Velocity over the current month since 00:00 / 12 AM on the first of the month in Eastern Time.
19
+ # * `YEAR`: Velocity over the current year since 00:00 / 12 AM on January 1st in Eastern Time.
20
+ variant enum: -> { Lithic::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindow }
21
+
22
+ variant -> { Lithic::AuthRules::VelocityLimitParamsPeriodWindow::TrailingWindowObject }
23
+
24
+ # Velocity over the current day since 00:00 / 12 AM in Eastern Time
25
+ variant -> { Lithic::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowDay }
26
+
27
+ # Velocity over the current week since 00:00 / 12 AM in Eastern Time on specified `day_of_week`
28
+ variant -> { Lithic::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowWeek }
29
+
30
+ # Velocity over the current month since 00:00 / 12 AM in Eastern Time on specified `day_of_month`.
31
+ variant -> { Lithic::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowMonth }
32
+
33
+ # Velocity over the current year since 00:00 / 12 AM in Eastern Time on specified `month` and `day_of_month`. This validates the month and day of the year to start from is a real date. In the event that February 29th is selected, in non-leap years, the window will start from February 28th.
34
+ variant -> { Lithic::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowYear }
35
+
36
+ # The window of time to calculate Spend Velocity over.
37
+ #
38
+ # - `DAY`: Velocity over the current day since midnight Eastern Time.
39
+ # - `WEEK`: Velocity over the current week since 00:00 / 12 AM on Monday in
40
+ # Eastern Time.
41
+ # - `MONTH`: Velocity over the current month since 00:00 / 12 AM on the first of
42
+ # the month in Eastern Time.
43
+ # - `YEAR`: Velocity over the current year since 00:00 / 12 AM on January 1st in
44
+ # Eastern Time.
45
+ module FixedWindow
46
+ extend Lithic::Internal::Type::Enum
47
+
48
+ DAY = :DAY
49
+ WEEK = :WEEK
50
+ MONTH = :MONTH
51
+ YEAR = :YEAR
52
+
53
+ # @!method self.values
54
+ # @return [Array<Symbol>]
55
+ end
56
+
57
+ class TrailingWindowObject < Lithic::Internal::Type::BaseModel
58
+ # @!attribute duration
59
+ # The size of the trailing window to calculate Spend Velocity over in seconds. The
60
+ # minimum value is 10 seconds, and the maximum value is 2678400 seconds (31 days).
61
+ #
62
+ # @return [Integer, nil]
63
+ optional :duration, Integer
64
+
65
+ # @!attribute type
66
+ #
67
+ # @return [Symbol, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::TrailingWindowObject::Type, nil]
68
+ optional :type,
69
+ enum: -> { Lithic::AuthRules::VelocityLimitParamsPeriodWindow::TrailingWindowObject::Type }
70
+
71
+ # @!method initialize(duration: nil, type: nil)
72
+ # Some parameter documentations has been truncated, see
73
+ # {Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::TrailingWindowObject}
74
+ # for more details.
75
+ #
76
+ # @param duration [Integer] The size of the trailing window to calculate Spend Velocity over in seconds. The
77
+ #
78
+ # @param type [Symbol, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::TrailingWindowObject::Type]
79
+
80
+ # @see Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::TrailingWindowObject#type
81
+ module Type
82
+ extend Lithic::Internal::Type::Enum
83
+
84
+ CUSTOM = :CUSTOM
85
+
86
+ # @!method self.values
87
+ # @return [Array<Symbol>]
88
+ end
89
+ end
90
+
91
+ class FixedWindowDay < Lithic::Internal::Type::BaseModel
92
+ # @!attribute type
93
+ #
94
+ # @return [Symbol, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowDay::Type, nil]
95
+ optional :type,
96
+ enum: -> {
97
+ Lithic::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowDay::Type
98
+ }
99
+
100
+ # @!method initialize(type: nil)
101
+ # Velocity over the current day since 00:00 / 12 AM in Eastern Time
102
+ #
103
+ # @param type [Symbol, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowDay::Type]
104
+
105
+ # @see Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowDay#type
106
+ module Type
107
+ extend Lithic::Internal::Type::Enum
108
+
109
+ DAY = :DAY
110
+
111
+ # @!method self.values
112
+ # @return [Array<Symbol>]
113
+ end
114
+ end
115
+
116
+ class FixedWindowWeek < Lithic::Internal::Type::BaseModel
117
+ # @!attribute day_of_week
118
+ # The day of the week to start the week from. Following ISO-8601, 1 is Monday and
119
+ # 7 is Sunday. Defaults to Monday if not specified.
120
+ #
121
+ # @return [Integer, nil]
122
+ optional :day_of_week, Integer
123
+
124
+ # @!attribute type
125
+ #
126
+ # @return [Symbol, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowWeek::Type, nil]
127
+ optional :type,
128
+ enum: -> {
129
+ Lithic::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowWeek::Type
130
+ }
131
+
132
+ # @!method initialize(day_of_week: nil, type: nil)
133
+ # Some parameter documentations has been truncated, see
134
+ # {Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowWeek}
135
+ # for more details.
136
+ #
137
+ # Velocity over the current week since 00:00 / 12 AM in Eastern Time on specified
138
+ # `day_of_week`
139
+ #
140
+ # @param day_of_week [Integer] The day of the week to start the week from. Following ISO-8601, 1 is Monday and
141
+ #
142
+ # @param type [Symbol, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowWeek::Type]
143
+
144
+ # @see Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowWeek#type
145
+ module Type
146
+ extend Lithic::Internal::Type::Enum
147
+
148
+ WEEK = :WEEK
149
+
150
+ # @!method self.values
151
+ # @return [Array<Symbol>]
152
+ end
153
+ end
154
+
155
+ class FixedWindowMonth < Lithic::Internal::Type::BaseModel
156
+ # @!attribute day_of_month
157
+ # The day of the month to start from. Accepts values from 1 to 31, and will reset
158
+ # at the end of the month if the day exceeds the number of days in the month.
159
+ # Defaults to the 1st of the month if not specified.
160
+ #
161
+ # @return [Integer, nil]
162
+ optional :day_of_month, Integer
163
+
164
+ # @!attribute type
165
+ #
166
+ # @return [Symbol, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowMonth::Type, nil]
167
+ optional :type,
168
+ enum: -> {
169
+ Lithic::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowMonth::Type
170
+ }
171
+
172
+ # @!method initialize(day_of_month: nil, type: nil)
173
+ # Some parameter documentations has been truncated, see
174
+ # {Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowMonth}
175
+ # for more details.
176
+ #
177
+ # Velocity over the current month since 00:00 / 12 AM in Eastern Time on specified
178
+ # `day_of_month`.
179
+ #
180
+ # @param day_of_month [Integer] The day of the month to start from. Accepts values from 1 to 31, and will reset
181
+ #
182
+ # @param type [Symbol, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowMonth::Type]
183
+
184
+ # @see Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowMonth#type
185
+ module Type
186
+ extend Lithic::Internal::Type::Enum
187
+
188
+ MONTH = :MONTH
189
+
190
+ # @!method self.values
191
+ # @return [Array<Symbol>]
192
+ end
193
+ end
194
+
195
+ class FixedWindowYear < Lithic::Internal::Type::BaseModel
196
+ # @!attribute day_of_month
197
+ # The day of the month to start from. Defaults to the 1st of the month if not
198
+ # specified.
199
+ #
200
+ # @return [Integer, nil]
201
+ optional :day_of_month, Integer
202
+
203
+ # @!attribute month
204
+ # The month to start from. 1 is January and 12 is December. Defaults to January if
205
+ # not specified.
206
+ #
207
+ # @return [Integer, nil]
208
+ optional :month, Integer
209
+
210
+ # @!attribute type
211
+ #
212
+ # @return [Symbol, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowYear::Type, nil]
213
+ optional :type,
214
+ enum: -> {
215
+ Lithic::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowYear::Type
216
+ }
217
+
218
+ # @!method initialize(day_of_month: nil, month: nil, type: nil)
219
+ # Some parameter documentations has been truncated, see
220
+ # {Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowYear}
221
+ # for more details.
222
+ #
223
+ # Velocity over the current year since 00:00 / 12 AM in Eastern Time on specified
224
+ # `month` and `day_of_month`. This validates the month and day of the year to
225
+ # start from is a real date. In the event that February 29th is selected, in
226
+ # non-leap years, the window will start from February 28th.
227
+ #
228
+ # @param day_of_month [Integer] The day of the month to start from. Defaults to the 1st of the month if not spec
229
+ #
230
+ # @param month [Integer] The month to start from. 1 is January and 12 is December. Defaults to January if
231
+ #
232
+ # @param type [Symbol, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowYear::Type]
233
+
234
+ # @see Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowYear#type
235
+ module Type
236
+ extend Lithic::Internal::Type::Enum
237
+
238
+ YEAR = :YEAR
239
+
240
+ # @!method self.values
241
+ # @return [Array<Symbol>]
242
+ end
243
+ end
244
+
245
+ # @!method self.variants
246
+ # @return [Array(Integer, Symbol, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindow, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::TrailingWindowObject, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowDay, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowWeek, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowMonth, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow::FixedWindowYear)]
25
247
  end
26
248
  end
27
249
  end
@@ -103,6 +103,7 @@ module Lithic
103
103
  ISSUING = :ISSUING
104
104
  OPERATING = :OPERATING
105
105
  RESERVE = :RESERVE
106
+ SECURITY = :SECURITY
106
107
 
107
108
  # @!method self.values
108
109
  # @return [Array<Symbol>]
@@ -53,6 +53,7 @@ module Lithic
53
53
  ISSUING = :ISSUING
54
54
  OPERATING = :OPERATING
55
55
  RESERVE = :RESERVE
56
+ SECURITY = :SECURITY
56
57
 
57
58
  # @!method self.values
58
59
  # @return [Array<Symbol>]
@@ -108,6 +108,13 @@ module Lithic
108
108
  # @return [String, nil]
109
109
  optional :replacement_account_token, String
110
110
 
111
+ # @!attribute replacement_comment
112
+ # Additional context or information related to the card that this card will
113
+ # replace.
114
+ #
115
+ # @return [String, nil]
116
+ optional :replacement_comment, String
117
+
111
118
  # @!attribute replacement_for
112
119
  # Globally unique identifier for the card that this card will replace. If the card
113
120
  # type is `PHYSICAL` it will be replaced by a `PHYSICAL` card. If the card type is
@@ -116,6 +123,38 @@ module Lithic
116
123
  # @return [String, nil]
117
124
  optional :replacement_for, String
118
125
 
126
+ # @!attribute replacement_substatus
127
+ # Card state substatus values for the card that this card will replace:
128
+ #
129
+ # - `LOST` - The physical card is no longer in the cardholder's possession due to
130
+ # being lost or never received by the cardholder.
131
+ # - `COMPROMISED` - Card information has been exposed, potentially leading to
132
+ # unauthorized access. This may involve physical card theft, cloning, or online
133
+ # data breaches.
134
+ # - `DAMAGED` - The physical card is not functioning properly, such as having chip
135
+ # failures or a demagnetized magnetic stripe.
136
+ # - `END_USER_REQUEST` - The cardholder requested the closure of the card for
137
+ # reasons unrelated to fraud or damage, such as switching to a different product
138
+ # or closing the account.
139
+ # - `ISSUER_REQUEST` - The issuer closed the card for reasons unrelated to fraud
140
+ # or damage, such as account inactivity, product or policy changes, or
141
+ # technology upgrades.
142
+ # - `NOT_ACTIVE` - The card hasn’t had any transaction activity for a specified
143
+ # period, applicable to statuses like `PAUSED` or `CLOSED`.
144
+ # - `SUSPICIOUS_ACTIVITY` - The card has one or more suspicious transactions or
145
+ # activities that require review. This can involve prompting the cardholder to
146
+ # confirm legitimate use or report confirmed fraud.
147
+ # - `INTERNAL_REVIEW` - The card is temporarily paused pending further internal
148
+ # review.
149
+ # - `EXPIRED` - The card has expired and has been closed without being reissued.
150
+ # - `UNDELIVERABLE` - The card cannot be delivered to the cardholder and has been
151
+ # returned.
152
+ # - `OTHER` - The reason for the status does not fall into any of the above
153
+ # categories. A comment should be provided to specify the reason.
154
+ #
155
+ # @return [Symbol, Lithic::Models::CardCreateParams::ReplacementSubstatus, nil]
156
+ optional :replacement_substatus, enum: -> { Lithic::CardCreateParams::ReplacementSubstatus }
157
+
119
158
  # @!attribute shipping_address
120
159
  #
121
160
  # @return [Lithic::Models::ShippingAddress, nil]
@@ -178,7 +217,7 @@ module Lithic
178
217
  # @return [Symbol, Lithic::Models::CardCreateParams::State, nil]
179
218
  optional :state, enum: -> { Lithic::CardCreateParams::State }
180
219
 
181
- # @!method initialize(type:, account_token: nil, card_program_token: nil, carrier: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, memo: nil, pin: nil, product_id: nil, replacement_account_token: nil, replacement_for: nil, shipping_address: nil, shipping_method: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, request_options: {})
220
+ # @!method initialize(type:, account_token: nil, card_program_token: nil, carrier: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, memo: nil, pin: nil, product_id: nil, replacement_account_token: nil, replacement_comment: nil, replacement_for: nil, replacement_substatus: nil, shipping_address: nil, shipping_method: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, request_options: {})
182
221
  # Some parameter documentations has been truncated, see
183
222
  # {Lithic::Models::CardCreateParams} for more details.
184
223
  #
@@ -204,8 +243,12 @@ module Lithic
204
243
  #
205
244
  # @param replacement_account_token [String] Restricted field limited to select use cases. Lithic will reach out directly if
206
245
  #
246
+ # @param replacement_comment [String] Additional context or information related to the card that this card will replac
247
+ #
207
248
  # @param replacement_for [String] Globally unique identifier for the card that this card will replace. If the card
208
249
  #
250
+ # @param replacement_substatus [Symbol, Lithic::Models::CardCreateParams::ReplacementSubstatus] Card state substatus values for the card that this card will replace:
251
+ #
209
252
  # @param shipping_address [Lithic::Models::ShippingAddress]
210
253
  #
211
254
  # @param shipping_method [Symbol, Lithic::Models::CardCreateParams::ShippingMethod] Shipping method for the card. Only applies to cards of type PHYSICAL.
@@ -248,6 +291,52 @@ module Lithic
248
291
  # @return [Array<Symbol>]
249
292
  end
250
293
 
294
+ # Card state substatus values for the card that this card will replace:
295
+ #
296
+ # - `LOST` - The physical card is no longer in the cardholder's possession due to
297
+ # being lost or never received by the cardholder.
298
+ # - `COMPROMISED` - Card information has been exposed, potentially leading to
299
+ # unauthorized access. This may involve physical card theft, cloning, or online
300
+ # data breaches.
301
+ # - `DAMAGED` - The physical card is not functioning properly, such as having chip
302
+ # failures or a demagnetized magnetic stripe.
303
+ # - `END_USER_REQUEST` - The cardholder requested the closure of the card for
304
+ # reasons unrelated to fraud or damage, such as switching to a different product
305
+ # or closing the account.
306
+ # - `ISSUER_REQUEST` - The issuer closed the card for reasons unrelated to fraud
307
+ # or damage, such as account inactivity, product or policy changes, or
308
+ # technology upgrades.
309
+ # - `NOT_ACTIVE` - The card hasn’t had any transaction activity for a specified
310
+ # period, applicable to statuses like `PAUSED` or `CLOSED`.
311
+ # - `SUSPICIOUS_ACTIVITY` - The card has one or more suspicious transactions or
312
+ # activities that require review. This can involve prompting the cardholder to
313
+ # confirm legitimate use or report confirmed fraud.
314
+ # - `INTERNAL_REVIEW` - The card is temporarily paused pending further internal
315
+ # review.
316
+ # - `EXPIRED` - The card has expired and has been closed without being reissued.
317
+ # - `UNDELIVERABLE` - The card cannot be delivered to the cardholder and has been
318
+ # returned.
319
+ # - `OTHER` - The reason for the status does not fall into any of the above
320
+ # categories. A comment should be provided to specify the reason.
321
+ module ReplacementSubstatus
322
+ extend Lithic::Internal::Type::Enum
323
+
324
+ LOST = :LOST
325
+ COMPROMISED = :COMPROMISED
326
+ DAMAGED = :DAMAGED
327
+ END_USER_REQUEST = :END_USER_REQUEST
328
+ ISSUER_REQUEST = :ISSUER_REQUEST
329
+ NOT_ACTIVE = :NOT_ACTIVE
330
+ SUSPICIOUS_ACTIVITY = :SUSPICIOUS_ACTIVITY
331
+ INTERNAL_REVIEW = :INTERNAL_REVIEW
332
+ EXPIRED = :EXPIRED
333
+ UNDELIVERABLE = :UNDELIVERABLE
334
+ OTHER = :OTHER
335
+
336
+ # @!method self.values
337
+ # @return [Array<Symbol>]
338
+ end
339
+
251
340
  # Shipping method for the card. Only applies to cards of type PHYSICAL. Use of
252
341
  # options besides `STANDARD` require additional permissions.
253
342
  #
@@ -34,6 +34,13 @@ module Lithic
34
34
  # @return [String]
35
35
  required :pan_range_start, String
36
36
 
37
+ # @!attribute account_level_management_enabled
38
+ # Whether the card program is participating in Account Level Management. Currently
39
+ # applicable to Visa card programs only.
40
+ #
41
+ # @return [Boolean, nil]
42
+ optional :account_level_management_enabled, Lithic::Internal::Type::Boolean
43
+
37
44
  # @!attribute cardholder_currency
38
45
  # 3-character alphabetic ISO 4217 code for the currency of the cardholder.
39
46
  #
@@ -47,7 +54,7 @@ module Lithic
47
54
  # @return [Array<String>, nil]
48
55
  optional :settlement_currencies, Lithic::Internal::Type::ArrayOf[String]
49
56
 
50
- # @!method initialize(token:, created:, name:, pan_range_end:, pan_range_start:, cardholder_currency: nil, settlement_currencies: nil)
57
+ # @!method initialize(token:, created:, name:, pan_range_end:, pan_range_start:, account_level_management_enabled: nil, cardholder_currency: nil, settlement_currencies: nil)
51
58
  # Some parameter documentations has been truncated, see
52
59
  # {Lithic::Models::CardProgram} for more details.
53
60
  #
@@ -61,6 +68,8 @@ module Lithic
61
68
  #
62
69
  # @param pan_range_start [String] The first digits of the card number that this card program starts with.
63
70
  #
71
+ # @param account_level_management_enabled [Boolean] Whether the card program is participating in Account Level Management. Currently
72
+ #
64
73
  # @param cardholder_currency [String] 3-character alphabetic ISO 4217 code for the currency of the cardholder.
65
74
  #
66
75
  # @param settlement_currencies [Array<String>] List of 3-character alphabetic ISO 4217 codes for the currencies that the card p
@@ -7,6 +7,12 @@ module Lithic
7
7
  extend Lithic::Internal::Type::RequestParameters::Converter
8
8
  include Lithic::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute comment
11
+ # Additional context or information related to the card.
12
+ #
13
+ # @return [String, nil]
14
+ optional :comment, String
15
+
10
16
  # @!attribute digital_card_art_token
11
17
  # Specifies the digital card art to be displayed in the user’s digital wallet
12
18
  # after tokenization. This artwork must be approved by Mastercard and configured
@@ -22,6 +28,13 @@ module Lithic
22
28
  # @return [String, nil]
23
29
  optional :memo, String
24
30
 
31
+ # @!attribute network_program_token
32
+ # Globally unique identifier for the card's network program. Currently applicable
33
+ # to Visa cards participating in Account Level Management only.
34
+ #
35
+ # @return [String, nil]
36
+ optional :network_program_token, String
37
+
25
38
  # @!attribute pin
26
39
  # Encrypted PIN block (in base64). Only applies to cards of type `PHYSICAL` and
27
40
  # `VIRTUAL`. Changing PIN also resets PIN status to `OK`. See
@@ -77,14 +90,50 @@ module Lithic
77
90
  # @return [Symbol, Lithic::Models::CardUpdateParams::State, nil]
78
91
  optional :state, enum: -> { Lithic::CardUpdateParams::State }
79
92
 
80
- # @!method initialize(digital_card_art_token: nil, memo: nil, pin: nil, pin_status: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, request_options: {})
93
+ # @!attribute substatus
94
+ # Card state substatus values:
95
+ #
96
+ # - `LOST` - The physical card is no longer in the cardholder's possession due to
97
+ # being lost or never received by the cardholder.
98
+ # - `COMPROMISED` - Card information has been exposed, potentially leading to
99
+ # unauthorized access. This may involve physical card theft, cloning, or online
100
+ # data breaches.
101
+ # - `DAMAGED` - The physical card is not functioning properly, such as having chip
102
+ # failures or a demagnetized magnetic stripe.
103
+ # - `END_USER_REQUEST` - The cardholder requested the closure of the card for
104
+ # reasons unrelated to fraud or damage, such as switching to a different product
105
+ # or closing the account.
106
+ # - `ISSUER_REQUEST` - The issuer closed the card for reasons unrelated to fraud
107
+ # or damage, such as account inactivity, product or policy changes, or
108
+ # technology upgrades.
109
+ # - `NOT_ACTIVE` - The card hasn’t had any transaction activity for a specified
110
+ # period, applicable to statuses like `PAUSED` or `CLOSED`.
111
+ # - `SUSPICIOUS_ACTIVITY` - The card has one or more suspicious transactions or
112
+ # activities that require review. This can involve prompting the cardholder to
113
+ # confirm legitimate use or report confirmed fraud.
114
+ # - `INTERNAL_REVIEW` - The card is temporarily paused pending further internal
115
+ # review.
116
+ # - `EXPIRED` - The card has expired and has been closed without being reissued.
117
+ # - `UNDELIVERABLE` - The card cannot be delivered to the cardholder and has been
118
+ # returned.
119
+ # - `OTHER` - The reason for the status does not fall into any of the above
120
+ # categories. A comment should be provided to specify the reason.
121
+ #
122
+ # @return [Symbol, Lithic::Models::CardUpdateParams::Substatus, nil]
123
+ optional :substatus, enum: -> { Lithic::CardUpdateParams::Substatus }
124
+
125
+ # @!method initialize(comment: nil, digital_card_art_token: nil, memo: nil, network_program_token: nil, pin: nil, pin_status: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, substatus: nil, request_options: {})
81
126
  # Some parameter documentations has been truncated, see
82
127
  # {Lithic::Models::CardUpdateParams} for more details.
83
128
  #
129
+ # @param comment [String] Additional context or information related to the card.
130
+ #
84
131
  # @param digital_card_art_token [String] Specifies the digital card art to be displayed in the user’s digital wallet afte
85
132
  #
86
133
  # @param memo [String] Friendly name to identify the card.
87
134
  #
135
+ # @param network_program_token [String] Globally unique identifier for the card's network program. Currently applicable
136
+ #
88
137
  # @param pin [String] Encrypted PIN block (in base64). Only applies to cards of type `PHYSICAL` and `V
89
138
  #
90
139
  # @param pin_status [Symbol, Lithic::Models::CardUpdateParams::PinStatus] Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
@@ -95,6 +144,8 @@ module Lithic
95
144
  #
96
145
  # @param state [Symbol, Lithic::Models::CardUpdateParams::State] Card state values:
97
146
  #
147
+ # @param substatus [Symbol, Lithic::Models::CardUpdateParams::Substatus] Card state substatus values:
148
+ #
98
149
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
99
150
 
100
151
  # Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
@@ -126,6 +177,52 @@ module Lithic
126
177
  # @!method self.values
127
178
  # @return [Array<Symbol>]
128
179
  end
180
+
181
+ # Card state substatus values:
182
+ #
183
+ # - `LOST` - The physical card is no longer in the cardholder's possession due to
184
+ # being lost or never received by the cardholder.
185
+ # - `COMPROMISED` - Card information has been exposed, potentially leading to
186
+ # unauthorized access. This may involve physical card theft, cloning, or online
187
+ # data breaches.
188
+ # - `DAMAGED` - The physical card is not functioning properly, such as having chip
189
+ # failures or a demagnetized magnetic stripe.
190
+ # - `END_USER_REQUEST` - The cardholder requested the closure of the card for
191
+ # reasons unrelated to fraud or damage, such as switching to a different product
192
+ # or closing the account.
193
+ # - `ISSUER_REQUEST` - The issuer closed the card for reasons unrelated to fraud
194
+ # or damage, such as account inactivity, product or policy changes, or
195
+ # technology upgrades.
196
+ # - `NOT_ACTIVE` - The card hasn’t had any transaction activity for a specified
197
+ # period, applicable to statuses like `PAUSED` or `CLOSED`.
198
+ # - `SUSPICIOUS_ACTIVITY` - The card has one or more suspicious transactions or
199
+ # activities that require review. This can involve prompting the cardholder to
200
+ # confirm legitimate use or report confirmed fraud.
201
+ # - `INTERNAL_REVIEW` - The card is temporarily paused pending further internal
202
+ # review.
203
+ # - `EXPIRED` - The card has expired and has been closed without being reissued.
204
+ # - `UNDELIVERABLE` - The card cannot be delivered to the cardholder and has been
205
+ # returned.
206
+ # - `OTHER` - The reason for the status does not fall into any of the above
207
+ # categories. A comment should be provided to specify the reason.
208
+ module Substatus
209
+ extend Lithic::Internal::Type::Enum
210
+
211
+ LOST = :LOST
212
+ COMPROMISED = :COMPROMISED
213
+ DAMAGED = :DAMAGED
214
+ END_USER_REQUEST = :END_USER_REQUEST
215
+ ISSUER_REQUEST = :ISSUER_REQUEST
216
+ NOT_ACTIVE = :NOT_ACTIVE
217
+ SUSPICIOUS_ACTIVITY = :SUSPICIOUS_ACTIVITY
218
+ INTERNAL_REVIEW = :INTERNAL_REVIEW
219
+ EXPIRED = :EXPIRED
220
+ UNDELIVERABLE = :UNDELIVERABLE
221
+ OTHER = :OTHER
222
+
223
+ # @!method self.values
224
+ # @return [Array<Symbol>]
225
+ end
129
226
  end
130
227
  end
131
228
  end
@@ -104,6 +104,7 @@ module Lithic
104
104
  ISSUING = :ISSUING
105
105
  OPERATING = :OPERATING
106
106
  RESERVE = :RESERVE
107
+ SECURITY = :SECURITY
107
108
 
108
109
  # @!method self.values
109
110
  # @return [Array<Symbol>]
@@ -137,6 +137,8 @@ module Lithic
137
137
  LOAN_TAPE_UPDATED = :"loan_tape.updated"
138
138
  MANAGEMENT_OPERATION_CREATED = :"management_operation.created"
139
139
  MANAGEMENT_OPERATION_UPDATED = :"management_operation.updated"
140
+ NETWORK_TOTAL_CREATED = :"network_total.created"
141
+ NETWORK_TOTAL_UPDATED = :"network_total.updated"
140
142
  PAYMENT_TRANSACTION_CREATED = :"payment_transaction.created"
141
143
  PAYMENT_TRANSACTION_UPDATED = :"payment_transaction.updated"
142
144
  INTERNAL_TRANSACTION_CREATED = :"internal_transaction.created"
@@ -108,6 +108,8 @@ module Lithic
108
108
  LOAN_TAPE_UPDATED = :"loan_tape.updated"
109
109
  MANAGEMENT_OPERATION_CREATED = :"management_operation.created"
110
110
  MANAGEMENT_OPERATION_UPDATED = :"management_operation.updated"
111
+ NETWORK_TOTAL_CREATED = :"network_total.created"
112
+ NETWORK_TOTAL_UPDATED = :"network_total.updated"
111
113
  PAYMENT_TRANSACTION_CREATED = :"payment_transaction.created"
112
114
  PAYMENT_TRANSACTION_UPDATED = :"payment_transaction.updated"
113
115
  INTERNAL_TRANSACTION_CREATED = :"internal_transaction.created"
@@ -81,6 +81,8 @@ module Lithic
81
81
  LOAN_TAPE_UPDATED = :"loan_tape.updated"
82
82
  MANAGEMENT_OPERATION_CREATED = :"management_operation.created"
83
83
  MANAGEMENT_OPERATION_UPDATED = :"management_operation.updated"
84
+ NETWORK_TOTAL_CREATED = :"network_total.created"
85
+ NETWORK_TOTAL_UPDATED = :"network_total.updated"
84
86
  PAYMENT_TRANSACTION_CREATED = :"payment_transaction.created"
85
87
  PAYMENT_TRANSACTION_UPDATED = :"payment_transaction.updated"
86
88
  INTERNAL_TRANSACTION_CREATED = :"internal_transaction.created"
@@ -85,6 +85,8 @@ module Lithic
85
85
  LOAN_TAPE_UPDATED = :"loan_tape.updated"
86
86
  MANAGEMENT_OPERATION_CREATED = :"management_operation.created"
87
87
  MANAGEMENT_OPERATION_UPDATED = :"management_operation.updated"
88
+ NETWORK_TOTAL_CREATED = :"network_total.created"
89
+ NETWORK_TOTAL_UPDATED = :"network_total.updated"
88
90
  PAYMENT_TRANSACTION_CREATED = :"payment_transaction.created"
89
91
  PAYMENT_TRANSACTION_UPDATED = :"payment_transaction.updated"
90
92
  INTERNAL_TRANSACTION_CREATED = :"internal_transaction.created"
@@ -55,6 +55,8 @@ module Lithic
55
55
  LOAN_TAPE_UPDATED = :"loan_tape.updated"
56
56
  MANAGEMENT_OPERATION_CREATED = :"management_operation.created"
57
57
  MANAGEMENT_OPERATION_UPDATED = :"management_operation.updated"
58
+ NETWORK_TOTAL_CREATED = :"network_total.created"
59
+ NETWORK_TOTAL_UPDATED = :"network_total.updated"
58
60
  PAYMENT_TRANSACTION_CREATED = :"payment_transaction.created"
59
61
  PAYMENT_TRANSACTION_UPDATED = :"payment_transaction.updated"
60
62
  INTERNAL_TRANSACTION_CREATED = :"internal_transaction.created"
@@ -85,6 +85,8 @@ module Lithic
85
85
  LOAN_TAPE_UPDATED = :"loan_tape.updated"
86
86
  MANAGEMENT_OPERATION_CREATED = :"management_operation.created"
87
87
  MANAGEMENT_OPERATION_UPDATED = :"management_operation.updated"
88
+ NETWORK_TOTAL_CREATED = :"network_total.created"
89
+ NETWORK_TOTAL_UPDATED = :"network_total.updated"
88
90
  PAYMENT_TRANSACTION_CREATED = :"payment_transaction.created"
89
91
  PAYMENT_TRANSACTION_UPDATED = :"payment_transaction.updated"
90
92
  INTERNAL_TRANSACTION_CREATED = :"internal_transaction.created"