lithic 0.1.0.pre.alpha.39 → 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 (98) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -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/external_resource.rb +34 -0
  19. data/lib/lithic/models/external_resource_type.rb +18 -0
  20. data/lib/lithic/models/financial_account_list_params.rb +1 -0
  21. data/lib/lithic/models/financial_accounts/balance_list_response.rb +1 -0
  22. data/lib/lithic/models/management_operation_create_params.rb +30 -1
  23. data/lib/lithic/models/management_operation_transaction.rb +22 -1
  24. data/lib/lithic/models/network_program.rb +41 -0
  25. data/lib/lithic/models/network_program_list_params.rb +43 -0
  26. data/lib/lithic/models/network_program_retrieve_params.rb +14 -0
  27. data/lib/lithic/models/non_pci_card.rb +88 -1
  28. data/lib/lithic/models/payment_simulate_action_params.rb +1 -0
  29. data/lib/lithic/models/transaction.rb +31 -20
  30. data/lib/lithic/models.rb +10 -0
  31. data/lib/lithic/resources/accounts.rb +5 -1
  32. data/lib/lithic/resources/cards.rb +12 -2
  33. data/lib/lithic/resources/management_operations.rb +13 -1
  34. data/lib/lithic/resources/network_programs.rb +64 -0
  35. data/lib/lithic/version.rb +1 -1
  36. data/lib/lithic.rb +6 -0
  37. data/rbi/lithic/client.rbi +3 -0
  38. data/rbi/lithic/models/account.rbi +131 -0
  39. data/rbi/lithic/models/account_update_params.rbi +159 -0
  40. data/rbi/lithic/models/aggregate_balance.rbi +5 -0
  41. data/rbi/lithic/models/aggregate_balance_list_params.rbi +5 -0
  42. data/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi +6 -15
  43. data/rbi/lithic/models/auth_rules/velocity_limit_params.rbi +18 -25
  44. data/rbi/lithic/models/auth_rules/velocity_limit_params_period_window.rbi +527 -31
  45. data/rbi/lithic/models/balance.rbi +2 -0
  46. data/rbi/lithic/models/balance_list_params.rbi +5 -0
  47. data/rbi/lithic/models/card_create_params.rbi +190 -0
  48. data/rbi/lithic/models/card_program.rbi +13 -0
  49. data/rbi/lithic/models/card_update_params.rbi +168 -0
  50. data/rbi/lithic/models/cards/balance_list_response.rbi +5 -0
  51. data/rbi/lithic/models/external_resource.rbi +57 -0
  52. data/rbi/lithic/models/external_resource_type.rbi +26 -0
  53. data/rbi/lithic/models/financial_account_list_params.rbi +5 -0
  54. data/rbi/lithic/models/financial_accounts/balance_list_response.rbi +5 -0
  55. data/rbi/lithic/models/management_operation_create_params.rbi +59 -0
  56. data/rbi/lithic/models/management_operation_transaction.rbi +15 -0
  57. data/rbi/lithic/models/network_program.rbi +61 -0
  58. data/rbi/lithic/models/network_program_list_params.rbi +72 -0
  59. data/rbi/lithic/models/network_program_retrieve_params.rbi +27 -0
  60. data/rbi/lithic/models/non_pci_card.rbi +133 -3
  61. data/rbi/lithic/models/payment_simulate_action_params.rbi +5 -0
  62. data/rbi/lithic/models/transaction.rbi +23 -31
  63. data/rbi/lithic/models.rbi +10 -0
  64. data/rbi/lithic/resources/accounts.rbi +32 -0
  65. data/rbi/lithic/resources/cards.rbi +70 -0
  66. data/rbi/lithic/resources/management_operations.rbi +4 -0
  67. data/rbi/lithic/resources/network_programs.rbi +48 -0
  68. data/sig/lithic/client.rbs +2 -0
  69. data/sig/lithic/models/account.rbs +41 -0
  70. data/sig/lithic/models/account_update_params.rbs +41 -0
  71. data/sig/lithic/models/aggregate_balance.rbs +2 -1
  72. data/sig/lithic/models/aggregate_balance_list_params.rbs +2 -1
  73. data/sig/lithic/models/auth_rules/velocity_limit_params.rbs +4 -14
  74. data/sig/lithic/models/auth_rules/velocity_limit_params_period_window.rbs +212 -7
  75. data/sig/lithic/models/balance.rbs +2 -1
  76. data/sig/lithic/models/balance_list_params.rbs +2 -1
  77. data/sig/lithic/models/card_create_params.rbs +47 -0
  78. data/sig/lithic/models/card_program.rbs +7 -0
  79. data/sig/lithic/models/card_update_params.rbs +55 -1
  80. data/sig/lithic/models/cards/balance_list_response.rbs +2 -1
  81. data/sig/lithic/models/external_resource.rbs +32 -0
  82. data/sig/lithic/models/external_resource_type.rbs +16 -0
  83. data/sig/lithic/models/financial_account_list_params.rbs +2 -1
  84. data/sig/lithic/models/financial_accounts/balance_list_response.rbs +2 -1
  85. data/sig/lithic/models/management_operation_create_params.rbs +20 -0
  86. data/sig/lithic/models/management_operation_transaction.rbs +5 -0
  87. data/sig/lithic/models/network_program.rbs +35 -0
  88. data/sig/lithic/models/network_program_list_params.rbs +38 -0
  89. data/sig/lithic/models/network_program_retrieve_params.rbs +15 -0
  90. data/sig/lithic/models/non_pci_card.rbs +55 -3
  91. data/sig/lithic/models/payment_simulate_action_params.rbs +2 -0
  92. data/sig/lithic/models/transaction.rbs +2 -6
  93. data/sig/lithic/models.rbs +10 -0
  94. data/sig/lithic/resources/accounts.rbs +2 -0
  95. data/sig/lithic/resources/cards.rbs +5 -0
  96. data/sig/lithic/resources/management_operations.rbs +1 -0
  97. data/sig/lithic/resources/network_programs.rbs +19 -0
  98. metadata +20 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 24bcc946862d8309f1d3bcd0073c3d54c40f81bae248f0ca22b06acaacde673a
4
- data.tar.gz: 6e7fc36ec06802ae0602381e4cc0b37b9b2685183ceed95c1e834e6bc34cbcd7
3
+ metadata.gz: 51980dfa96c3fef91b93acbb962e54d8d7ea6f841762d8c141f7d4f2baeecbd6
4
+ data.tar.gz: ff0aa143e8491fd9c1be6e95b98197790211e991f46464df3e2098bd32d78c01
5
5
  SHA512:
6
- metadata.gz: cf1aadf77aa0aa1c0b4f1d8840ef7ca9e83ea44f4aba1a194d9c54d26b3d227f6c4e87769dba814564de27e494167a4db80a47129e351782c20a2a25722e0362
7
- data.tar.gz: 77321cee941eb6dac08e8d43a1d74b4f4413ff7ffc44f5126108b930c93e6e71312f3a64416e4551adb29bb1a1e2c2a85f50afce03e7a75e90c9452d40009f64
6
+ metadata.gz: 03f0b4e72d14b4231a51205809516466cf82f01f31f23d1b7ac5c3485313ee2ddca4c5a3ba099da231ba345d4ece9ac9905f8a5bcbbdd6e4ee5ecf9e5b9522ea
7
+ data.tar.gz: 3075578b09ae44215e69e9eadf56be2f9e3a27d6e64dcfd848c6835981f468c9250866644dfde06770880f6fc6210496b03e1c2d19b1be5328899a03289640cd
data/CHANGELOG.md CHANGED
@@ -1,5 +1,15 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.1.0-alpha.40 (2025-07-15)
4
+
5
+ Full Changelog: [v0.1.0-alpha.39...v0.1.0-alpha.40](https://github.com/lithic-com/lithic-ruby/compare/v0.1.0-alpha.39...v0.1.0-alpha.40)
6
+
7
+ ### Features
8
+
9
+ * **api:** adds Network Programs and Account/Card Sub-statuses ([b5e5077](https://github.com/lithic-com/lithic-ruby/commit/b5e5077794684767a425d31f746cee2ed69d8ba7))
10
+ * **api:** api update ([b8de03e](https://github.com/lithic-com/lithic-ruby/commit/b8de03e418647489f4e34b4a55ca4256f34c52fe))
11
+ * **api:** api update ([72d4aab](https://github.com/lithic-com/lithic-ruby/commit/72d4aabb27fe144144c10899e64c863785d6595b))
12
+
3
13
  ## 0.1.0-alpha.39 (2025-07-03)
4
14
 
5
15
  Full Changelog: [v0.1.0-alpha.38...v0.1.0-alpha.39](https://github.com/lithic-com/lithic-ruby/compare/v0.1.0-alpha.38...v0.1.0-alpha.39)
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "lithic", "~> 0.1.0.pre.alpha.39"
18
+ gem "lithic", "~> 0.1.0.pre.alpha.40"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
data/lib/lithic/client.rb CHANGED
@@ -104,6 +104,9 @@ module Lithic
104
104
  # @return [Lithic::Resources::Fraud]
105
105
  attr_reader :fraud
106
106
 
107
+ # @return [Lithic::Resources::NetworkPrograms]
108
+ attr_reader :network_programs
109
+
107
110
  # Status of api
108
111
  #
109
112
  # @overload api_status(request_options: {})
@@ -205,6 +208,7 @@ module Lithic
205
208
  @management_operations = Lithic::Resources::ManagementOperations.new(client: self)
206
209
  @funding_events = Lithic::Resources::FundingEvents.new(client: self)
207
210
  @fraud = Lithic::Resources::Fraud.new(client: self)
211
+ @network_programs = Lithic::Resources::NetworkPrograms.new(client: self)
208
212
  end
209
213
  end
210
214
  end
@@ -66,13 +66,51 @@ module Lithic
66
66
  # @return [String, nil]
67
67
  optional :cardholder_currency, String
68
68
 
69
+ # @!attribute comment
70
+ # Additional context or information related to the account.
71
+ #
72
+ # @return [String, nil]
73
+ optional :comment, String
74
+
75
+ # @!attribute substatus
76
+ # Account state substatus values:
77
+ #
78
+ # - `FRAUD_IDENTIFIED` - The account has been recognized as being created or used
79
+ # with stolen or fabricated identity information, encompassing both true
80
+ # identity theft and synthetic identities.
81
+ # - `SUSPICIOUS_ACTIVITY` - The account has exhibited suspicious behavior, such as
82
+ # unauthorized access or fraudulent transactions, necessitating further
83
+ # investigation.
84
+ # - `RISK_VIOLATION` - The account has been involved in deliberate misuse by the
85
+ # legitimate account holder. Examples include disputing valid transactions
86
+ # without cause, falsely claiming non-receipt of goods, or engaging in
87
+ # intentional bust-out schemes to exploit account services.
88
+ # - `END_USER_REQUEST` - The account holder has voluntarily requested the closure
89
+ # of the account for personal reasons. This encompasses situations such as
90
+ # bankruptcy, other financial considerations, or the account holder's death.
91
+ # - `ISSUER_REQUEST` - The issuer has initiated the closure of the account due to
92
+ # business strategy, risk management, inactivity, product changes, regulatory
93
+ # concerns, or violations of terms and conditions.
94
+ # - `NOT_ACTIVE` - The account has not had any transactions or payment activity
95
+ # within a specified period. This status applies to accounts that are paused or
96
+ # closed due to inactivity.
97
+ # - `INTERNAL_REVIEW` - The account is temporarily paused pending further internal
98
+ # review. In future implementations, this status may prevent clients from
99
+ # activating the account via APIs until the review is completed.
100
+ # - `OTHER` - The reason for the account's current status does not fall into any
101
+ # of the above categories. A comment should be provided to specify the
102
+ # particular reason.
103
+ #
104
+ # @return [Symbol, Lithic::Models::Account::Substatus, nil]
105
+ optional :substatus, enum: -> { Lithic::Account::Substatus }
106
+
69
107
  # @!attribute verification_address
70
108
  # @deprecated
71
109
  #
72
110
  # @return [Lithic::Models::Account::VerificationAddress, nil]
73
111
  optional :verification_address, -> { Lithic::Account::VerificationAddress }
74
112
 
75
- # @!method initialize(token:, created:, spend_limit:, state:, account_holder: nil, auth_rule_tokens: nil, cardholder_currency: nil, verification_address: nil)
113
+ # @!method initialize(token:, created:, spend_limit:, state:, account_holder: nil, auth_rule_tokens: nil, cardholder_currency: nil, comment: nil, substatus: nil, verification_address: nil)
76
114
  # Some parameter documentations has been truncated, see {Lithic::Models::Account}
77
115
  # for more details.
78
116
  #
@@ -90,6 +128,10 @@ module Lithic
90
128
  #
91
129
  # @param cardholder_currency [String] 3-character alphabetic ISO 4217 code for the currency of the cardholder.
92
130
  #
131
+ # @param comment [String] Additional context or information related to the account.
132
+ #
133
+ # @param substatus [Symbol, Lithic::Models::Account::Substatus] Account state substatus values:
134
+ #
93
135
  # @param verification_address [Lithic::Models::Account::VerificationAddress]
94
136
 
95
137
  # @see Lithic::Models::Account#spend_limit
@@ -191,6 +233,51 @@ module Lithic
191
233
  # @param phone_number [String] Phone number of the individual.
192
234
  end
193
235
 
236
+ # Account state substatus values:
237
+ #
238
+ # - `FRAUD_IDENTIFIED` - The account has been recognized as being created or used
239
+ # with stolen or fabricated identity information, encompassing both true
240
+ # identity theft and synthetic identities.
241
+ # - `SUSPICIOUS_ACTIVITY` - The account has exhibited suspicious behavior, such as
242
+ # unauthorized access or fraudulent transactions, necessitating further
243
+ # investigation.
244
+ # - `RISK_VIOLATION` - The account has been involved in deliberate misuse by the
245
+ # legitimate account holder. Examples include disputing valid transactions
246
+ # without cause, falsely claiming non-receipt of goods, or engaging in
247
+ # intentional bust-out schemes to exploit account services.
248
+ # - `END_USER_REQUEST` - The account holder has voluntarily requested the closure
249
+ # of the account for personal reasons. This encompasses situations such as
250
+ # bankruptcy, other financial considerations, or the account holder's death.
251
+ # - `ISSUER_REQUEST` - The issuer has initiated the closure of the account due to
252
+ # business strategy, risk management, inactivity, product changes, regulatory
253
+ # concerns, or violations of terms and conditions.
254
+ # - `NOT_ACTIVE` - The account has not had any transactions or payment activity
255
+ # within a specified period. This status applies to accounts that are paused or
256
+ # closed due to inactivity.
257
+ # - `INTERNAL_REVIEW` - The account is temporarily paused pending further internal
258
+ # review. In future implementations, this status may prevent clients from
259
+ # activating the account via APIs until the review is completed.
260
+ # - `OTHER` - The reason for the account's current status does not fall into any
261
+ # of the above categories. A comment should be provided to specify the
262
+ # particular reason.
263
+ #
264
+ # @see Lithic::Models::Account#substatus
265
+ module Substatus
266
+ extend Lithic::Internal::Type::Enum
267
+
268
+ FRAUD_IDENTIFIED = :FRAUD_IDENTIFIED
269
+ SUSPICIOUS_ACTIVITY = :SUSPICIOUS_ACTIVITY
270
+ RISK_VIOLATION = :RISK_VIOLATION
271
+ END_USER_REQUEST = :END_USER_REQUEST
272
+ ISSUER_REQUEST = :ISSUER_REQUEST
273
+ NOT_ACTIVE = :NOT_ACTIVE
274
+ INTERNAL_REVIEW = :INTERNAL_REVIEW
275
+ OTHER = :OTHER
276
+
277
+ # @!method self.values
278
+ # @return [Array<Symbol>]
279
+ end
280
+
194
281
  # @deprecated
195
282
  #
196
283
  # @see Lithic::Models::Account#verification_address
@@ -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 account.
12
+ #
13
+ # @return [String, nil]
14
+ optional :comment, String
15
+
10
16
  # @!attribute daily_spend_limit
11
17
  # Amount (in cents) for the account's daily spend limit (e.g. 100000 would be a
12
18
  # $1,000 limit). By default the daily spend limit is set to $1,250.
@@ -39,6 +45,38 @@ module Lithic
39
45
  # @return [Symbol, Lithic::Models::AccountUpdateParams::State, nil]
40
46
  optional :state, enum: -> { Lithic::AccountUpdateParams::State }
41
47
 
48
+ # @!attribute substatus
49
+ # Account state substatus values:
50
+ #
51
+ # - `FRAUD_IDENTIFIED` - The account has been recognized as being created or used
52
+ # with stolen or fabricated identity information, encompassing both true
53
+ # identity theft and synthetic identities.
54
+ # - `SUSPICIOUS_ACTIVITY` - The account has exhibited suspicious behavior, such as
55
+ # unauthorized access or fraudulent transactions, necessitating further
56
+ # investigation.
57
+ # - `RISK_VIOLATION` - The account has been involved in deliberate misuse by the
58
+ # legitimate account holder. Examples include disputing valid transactions
59
+ # without cause, falsely claiming non-receipt of goods, or engaging in
60
+ # intentional bust-out schemes to exploit account services.
61
+ # - `END_USER_REQUEST` - The account holder has voluntarily requested the closure
62
+ # of the account for personal reasons. This encompasses situations such as
63
+ # bankruptcy, other financial considerations, or the account holder's death.
64
+ # - `ISSUER_REQUEST` - The issuer has initiated the closure of the account due to
65
+ # business strategy, risk management, inactivity, product changes, regulatory
66
+ # concerns, or violations of terms and conditions.
67
+ # - `NOT_ACTIVE` - The account has not had any transactions or payment activity
68
+ # within a specified period. This status applies to accounts that are paused or
69
+ # closed due to inactivity.
70
+ # - `INTERNAL_REVIEW` - The account is temporarily paused pending further internal
71
+ # review. In future implementations, this status may prevent clients from
72
+ # activating the account via APIs until the review is completed.
73
+ # - `OTHER` - The reason for the account's current status does not fall into any
74
+ # of the above categories. A comment should be provided to specify the
75
+ # particular reason.
76
+ #
77
+ # @return [Symbol, Lithic::Models::AccountUpdateParams::Substatus, nil]
78
+ optional :substatus, enum: -> { Lithic::AccountUpdateParams::Substatus }
79
+
42
80
  # @!attribute verification_address
43
81
  # @deprecated
44
82
  #
@@ -50,10 +88,12 @@ module Lithic
50
88
  # @return [Lithic::Models::AccountUpdateParams::VerificationAddress, nil]
51
89
  optional :verification_address, -> { Lithic::AccountUpdateParams::VerificationAddress }
52
90
 
53
- # @!method initialize(daily_spend_limit: nil, lifetime_spend_limit: nil, monthly_spend_limit: nil, state: nil, verification_address: nil, request_options: {})
91
+ # @!method initialize(comment: nil, daily_spend_limit: nil, lifetime_spend_limit: nil, monthly_spend_limit: nil, state: nil, substatus: nil, verification_address: nil, request_options: {})
54
92
  # Some parameter documentations has been truncated, see
55
93
  # {Lithic::Models::AccountUpdateParams} for more details.
56
94
  #
95
+ # @param comment [String] Additional context or information related to the account.
96
+ #
57
97
  # @param daily_spend_limit [Integer] Amount (in cents) for the account's daily spend limit (e.g. 100000 would be a $1
58
98
  #
59
99
  # @param lifetime_spend_limit [Integer] Amount (in cents) for the account's lifetime spend limit (e.g. 100000 would be a
@@ -62,6 +102,8 @@ module Lithic
62
102
  #
63
103
  # @param state [Symbol, Lithic::Models::AccountUpdateParams::State] Account states.
64
104
  #
105
+ # @param substatus [Symbol, Lithic::Models::AccountUpdateParams::Substatus] Account state substatus values:
106
+ #
65
107
  # @param verification_address [Lithic::Models::AccountUpdateParams::VerificationAddress] Address used during Address Verification Service (AVS) checks during transaction
66
108
  #
67
109
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
@@ -78,6 +120,49 @@ module Lithic
78
120
  # @return [Array<Symbol>]
79
121
  end
80
122
 
123
+ # Account state substatus values:
124
+ #
125
+ # - `FRAUD_IDENTIFIED` - The account has been recognized as being created or used
126
+ # with stolen or fabricated identity information, encompassing both true
127
+ # identity theft and synthetic identities.
128
+ # - `SUSPICIOUS_ACTIVITY` - The account has exhibited suspicious behavior, such as
129
+ # unauthorized access or fraudulent transactions, necessitating further
130
+ # investigation.
131
+ # - `RISK_VIOLATION` - The account has been involved in deliberate misuse by the
132
+ # legitimate account holder. Examples include disputing valid transactions
133
+ # without cause, falsely claiming non-receipt of goods, or engaging in
134
+ # intentional bust-out schemes to exploit account services.
135
+ # - `END_USER_REQUEST` - The account holder has voluntarily requested the closure
136
+ # of the account for personal reasons. This encompasses situations such as
137
+ # bankruptcy, other financial considerations, or the account holder's death.
138
+ # - `ISSUER_REQUEST` - The issuer has initiated the closure of the account due to
139
+ # business strategy, risk management, inactivity, product changes, regulatory
140
+ # concerns, or violations of terms and conditions.
141
+ # - `NOT_ACTIVE` - The account has not had any transactions or payment activity
142
+ # within a specified period. This status applies to accounts that are paused or
143
+ # closed due to inactivity.
144
+ # - `INTERNAL_REVIEW` - The account is temporarily paused pending further internal
145
+ # review. In future implementations, this status may prevent clients from
146
+ # activating the account via APIs until the review is completed.
147
+ # - `OTHER` - The reason for the account's current status does not fall into any
148
+ # of the above categories. A comment should be provided to specify the
149
+ # particular reason.
150
+ module Substatus
151
+ extend Lithic::Internal::Type::Enum
152
+
153
+ FRAUD_IDENTIFIED = :FRAUD_IDENTIFIED
154
+ SUSPICIOUS_ACTIVITY = :SUSPICIOUS_ACTIVITY
155
+ RISK_VIOLATION = :RISK_VIOLATION
156
+ END_USER_REQUEST = :END_USER_REQUEST
157
+ ISSUER_REQUEST = :ISSUER_REQUEST
158
+ NOT_ACTIVE = :NOT_ACTIVE
159
+ INTERNAL_REVIEW = :INTERNAL_REVIEW
160
+ OTHER = :OTHER
161
+
162
+ # @!method self.values
163
+ # @return [Array<Symbol>]
164
+ end
165
+
81
166
  # @deprecated
82
167
  class VerificationAddress < Lithic::Internal::Type::BaseModel
83
168
  # @!attribute address1
@@ -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>]
@@ -25,6 +25,7 @@ module Lithic
25
25
  ISSUING = :ISSUING
26
26
  OPERATING = :OPERATING
27
27
  RESERVE = :RESERVE
28
+ SECURITY = :SECURITY
28
29
 
29
30
  # @!method self.values
30
31
  # @return [Array<Symbol>]
@@ -56,11 +56,8 @@ module Lithic
56
56
  # fee field in the settlement/cardholder billing currency. This is the amount
57
57
  # the issuer should authorize against unless the issuer is paying the acquirer
58
58
  # fee on behalf of the cardholder.
59
- # - `RISK_SCORE`: Network-provided score assessing risk level associated with a
60
- # given authentication. Scores are on a range of 0-999, with 0 representing the
61
- # lowest risk and 999 representing the highest risk. For Visa transactions,
62
- # where the raw score has a range of 0-99, Lithic will normalize the score by
63
- # multiplying the raw score by 10x.
59
+ # - `RISK_SCORE`: Mastercard only: Assessment by the network of the authentication
60
+ # risk level, with a higher value indicating a higher amount of risk.
64
61
  # - `MESSAGE_CATEGORY`: The category of the authentication being processed.
65
62
  #
66
63
  # @return [Symbol, Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::Attribute, nil]
@@ -113,11 +110,8 @@ module Lithic
113
110
  # fee field in the settlement/cardholder billing currency. This is the amount
114
111
  # the issuer should authorize against unless the issuer is paying the acquirer
115
112
  # fee on behalf of the cardholder.
116
- # - `RISK_SCORE`: Network-provided score assessing risk level associated with a
117
- # given authentication. Scores are on a range of 0-999, with 0 representing the
118
- # lowest risk and 999 representing the highest risk. For Visa transactions,
119
- # where the raw score has a range of 0-99, Lithic will normalize the score by
120
- # multiplying the raw score by 10x.
113
+ # - `RISK_SCORE`: Mastercard only: Assessment by the network of the authentication
114
+ # risk level, with a higher value indicating a higher amount of risk.
121
115
  # - `MESSAGE_CATEGORY`: The category of the authentication being processed.
122
116
  #
123
117
  # @see Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition#attribute
@@ -13,8 +13,8 @@ module Lithic
13
13
  # The size of the trailing window to calculate Spend Velocity over in seconds. The
14
14
  # minimum value is 10 seconds, and the maximum value is 2678400 seconds (31 days).
15
15
  #
16
- # @return [Integer, Symbol, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow]
17
- required :period, union: -> { Lithic::AuthRules::VelocityLimitParams::Period }
16
+ # @return [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]
17
+ required :period, union: -> { Lithic::AuthRules::VelocityLimitParamsPeriodWindow }
18
18
 
19
19
  # @!attribute scope
20
20
  #
@@ -45,7 +45,7 @@ module Lithic
45
45
  #
46
46
  # @param filters [Lithic::Models::AuthRules::VelocityLimitParams::Filters]
47
47
  #
48
- # @param period [Integer, Symbol, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow] The size of the trailing window to calculate Spend Velocity over in seconds. The
48
+ # @param period [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] The size of the trailing window to calculate Spend Velocity over in seconds. The
49
49
  #
50
50
  # @param scope [Symbol, Lithic::Models::AuthRules::VelocityLimitParams::Scope]
51
51
  #
@@ -98,28 +98,6 @@ module Lithic
98
98
  # @param include_mccs [Array<String>, nil] Merchant Category Codes to include in the velocity calculation. Transactions not
99
99
  end
100
100
 
101
- # The size of the trailing window to calculate Spend Velocity over in seconds. The
102
- # minimum value is 10 seconds, and the maximum value is 2678400 seconds (31 days).
103
- #
104
- # @see Lithic::Models::AuthRules::VelocityLimitParams#period
105
- module Period
106
- extend Lithic::Internal::Type::Union
107
-
108
- # 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).
109
- variant Integer
110
-
111
- # The window of time to calculate Spend Velocity over.
112
- #
113
- # * `DAY`: Velocity over the current day since midnight Eastern Time.
114
- # * `WEEK`: Velocity over the current week since 00:00 / 12 AM on Monday in Eastern Time.
115
- # * `MONTH`: Velocity over the current month since 00:00 / 12 AM on the first of the month in Eastern Time.
116
- # * `YEAR`: Velocity over the current year since 00:00 / 12 AM on January 1st in Eastern Time.
117
- variant enum: -> { Lithic::AuthRules::VelocityLimitParamsPeriodWindow }
118
-
119
- # @!method self.variants
120
- # @return [Array(Integer, Symbol, Lithic::Models::AuthRules::VelocityLimitParamsPeriodWindow)]
121
- end
122
-
123
101
  # @see Lithic::Models::AuthRules::VelocityLimitParams#scope
124
102
  module Scope
125
103
  extend Lithic::Internal::Type::Enum
@@ -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