Class: Lithic::Models::TransferLimitsResponse::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/lithic/models/transfer_limits_response.rb

Defined Under Namespace

Classes: DailyLimit, MonthlyLimit, ProgramLimitPerTransaction

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(limit:, amount_originated: nil) ⇒ Object

Debit limits

Parameters:

  • limit (Integer)

    The limit amount

  • amount_originated (Integer) (defaults to: nil)

    Amount originated towards limit



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
# File 'lib/lithic/models/transfer_limits_response.rb', line 23

class Data < Lithic::Internal::Type::BaseModel
  # @!attribute company_id
  #   Company ID
  #
  #   @return [String]
  required :company_id, String

  # @!attribute daily_limit
  #   Daily limits with progress
  #
  #   @return [Lithic::Models::TransferLimitsResponse::Data::DailyLimit]
  required :daily_limit, -> { Lithic::TransferLimitsResponse::Data::DailyLimit }

  # @!attribute date
  #   The date for the limit view (ISO format)
  #
  #   @return [Date]
  required :date, Date

  # @!attribute is_fbo
  #   Whether the company is a FBO; based on the company ID prefix
  #
  #   @return [Boolean]
  required :is_fbo, Lithic::Internal::Type::Boolean

  # @!attribute monthly_limit
  #   Monthly limits with progress
  #
  #   @return [Lithic::Models::TransferLimitsResponse::Data::MonthlyLimit]
  required :monthly_limit, -> { Lithic::TransferLimitsResponse::Data::MonthlyLimit }

  # @!attribute program_limit_per_transaction
  #   Program transaction limits
  #
  #   @return [Lithic::Models::TransferLimitsResponse::Data::ProgramLimitPerTransaction]
  required :program_limit_per_transaction,
           -> { Lithic::TransferLimitsResponse::Data::ProgramLimitPerTransaction }

  # @!method initialize(company_id:, daily_limit:, date:, is_fbo:, monthly_limit:, program_limit_per_transaction:)
  #   @param company_id [String] Company ID
  #
  #   @param daily_limit [Lithic::Models::TransferLimitsResponse::Data::DailyLimit] Daily limits with progress
  #
  #   @param date [Date] The date for the limit view (ISO format)
  #
  #   @param is_fbo [Boolean] Whether the company is a FBO; based on the company ID prefix
  #
  #   @param monthly_limit [Lithic::Models::TransferLimitsResponse::Data::MonthlyLimit] Monthly limits with progress
  #
  #   @param program_limit_per_transaction [Lithic::Models::TransferLimitsResponse::Data::ProgramLimitPerTransaction] Program transaction limits

  # @see Lithic::Models::TransferLimitsResponse::Data#daily_limit
  class DailyLimit < Lithic::Internal::Type::BaseModel
    # @!attribute credit
    #   Credit limits
    #
    #   @return [Lithic::Models::TransferLimitsResponse::Data::DailyLimit::Credit]
    required :credit, -> { Lithic::TransferLimitsResponse::Data::DailyLimit::Credit }

    # @!attribute debit
    #   Debit limits
    #
    #   @return [Lithic::Models::TransferLimitsResponse::Data::DailyLimit::Debit]
    required :debit, -> { Lithic::TransferLimitsResponse::Data::DailyLimit::Debit }

    # @!method initialize(credit:, debit:)
    #   Daily limits with progress
    #
    #   @param credit [Lithic::Models::TransferLimitsResponse::Data::DailyLimit::Credit] Credit limits
    #
    #   @param debit [Lithic::Models::TransferLimitsResponse::Data::DailyLimit::Debit] Debit limits

    # @see Lithic::Models::TransferLimitsResponse::Data::DailyLimit#credit
    class Credit < Lithic::Internal::Type::BaseModel
      # @!attribute limit
      #   The limit amount
      #
      #   @return [Integer]
      required :limit, Integer

      # @!attribute amount_originated
      #   Amount originated towards limit
      #
      #   @return [Integer, nil]
      optional :amount_originated, Integer

      # @!method initialize(limit:, amount_originated: nil)
      #   Credit limits
      #
      #   @param limit [Integer] The limit amount
      #
      #   @param amount_originated [Integer] Amount originated towards limit
    end

    # @see Lithic::Models::TransferLimitsResponse::Data::DailyLimit#debit
    class Debit < Lithic::Internal::Type::BaseModel
      # @!attribute limit
      #   The limit amount
      #
      #   @return [Integer]
      required :limit, Integer

      # @!attribute amount_originated
      #   Amount originated towards limit
      #
      #   @return [Integer, nil]
      optional :amount_originated, Integer

      # @!method initialize(limit:, amount_originated: nil)
      #   Debit limits
      #
      #   @param limit [Integer] The limit amount
      #
      #   @param amount_originated [Integer] Amount originated towards limit
    end
  end

  # @see Lithic::Models::TransferLimitsResponse::Data#monthly_limit
  class MonthlyLimit < Lithic::Internal::Type::BaseModel
    # @!attribute credit
    #   Credit limits
    #
    #   @return [Lithic::Models::TransferLimitsResponse::Data::MonthlyLimit::Credit]
    required :credit, -> { Lithic::TransferLimitsResponse::Data::MonthlyLimit::Credit }

    # @!attribute debit
    #   Debit limits
    #
    #   @return [Lithic::Models::TransferLimitsResponse::Data::MonthlyLimit::Debit]
    required :debit, -> { Lithic::TransferLimitsResponse::Data::MonthlyLimit::Debit }

    # @!method initialize(credit:, debit:)
    #   Monthly limits with progress
    #
    #   @param credit [Lithic::Models::TransferLimitsResponse::Data::MonthlyLimit::Credit] Credit limits
    #
    #   @param debit [Lithic::Models::TransferLimitsResponse::Data::MonthlyLimit::Debit] Debit limits

    # @see Lithic::Models::TransferLimitsResponse::Data::MonthlyLimit#credit
    class Credit < Lithic::Internal::Type::BaseModel
      # @!attribute limit
      #   The limit amount
      #
      #   @return [Integer]
      required :limit, Integer

      # @!attribute amount_originated
      #   Amount originated towards limit
      #
      #   @return [Integer, nil]
      optional :amount_originated, Integer

      # @!method initialize(limit:, amount_originated: nil)
      #   Credit limits
      #
      #   @param limit [Integer] The limit amount
      #
      #   @param amount_originated [Integer] Amount originated towards limit
    end

    # @see Lithic::Models::TransferLimitsResponse::Data::MonthlyLimit#debit
    class Debit < Lithic::Internal::Type::BaseModel
      # @!attribute limit
      #   The limit amount
      #
      #   @return [Integer]
      required :limit, Integer

      # @!attribute amount_originated
      #   Amount originated towards limit
      #
      #   @return [Integer, nil]
      optional :amount_originated, Integer

      # @!method initialize(limit:, amount_originated: nil)
      #   Debit limits
      #
      #   @param limit [Integer] The limit amount
      #
      #   @param amount_originated [Integer] Amount originated towards limit
    end
  end

  # @see Lithic::Models::TransferLimitsResponse::Data#program_limit_per_transaction
  class ProgramLimitPerTransaction < Lithic::Internal::Type::BaseModel
    # @!attribute credit
    #   Credit limits
    #
    #   @return [Lithic::Models::TransferLimitsResponse::Data::ProgramLimitPerTransaction::Credit]
    required :credit, -> { Lithic::TransferLimitsResponse::Data::ProgramLimitPerTransaction::Credit }

    # @!attribute debit
    #   Debit limits
    #
    #   @return [Lithic::Models::TransferLimitsResponse::Data::ProgramLimitPerTransaction::Debit]
    required :debit, -> { Lithic::TransferLimitsResponse::Data::ProgramLimitPerTransaction::Debit }

    # @!method initialize(credit:, debit:)
    #   Program transaction limits
    #
    #   @param credit [Lithic::Models::TransferLimitsResponse::Data::ProgramLimitPerTransaction::Credit] Credit limits
    #
    #   @param debit [Lithic::Models::TransferLimitsResponse::Data::ProgramLimitPerTransaction::Debit] Debit limits

    # @see Lithic::Models::TransferLimitsResponse::Data::ProgramLimitPerTransaction#credit
    class Credit < Lithic::Internal::Type::BaseModel
      # @!attribute limit
      #   The limit amount
      #
      #   @return [Integer]
      required :limit, Integer

      # @!attribute amount_originated
      #   Amount originated towards limit
      #
      #   @return [Integer, nil]
      optional :amount_originated, Integer

      # @!method initialize(limit:, amount_originated: nil)
      #   Credit limits
      #
      #   @param limit [Integer] The limit amount
      #
      #   @param amount_originated [Integer] Amount originated towards limit
    end

    # @see Lithic::Models::TransferLimitsResponse::Data::ProgramLimitPerTransaction#debit
    class Debit < Lithic::Internal::Type::BaseModel
      # @!attribute limit
      #   The limit amount
      #
      #   @return [Integer]
      required :limit, Integer

      # @!attribute amount_originated
      #   Amount originated towards limit
      #
      #   @return [Integer, nil]
      optional :amount_originated, Integer

      # @!method initialize(limit:, amount_originated: nil)
      #   Debit limits
      #
      #   @param limit [Integer] The limit amount
      #
      #   @param amount_originated [Integer] Amount originated towards limit
    end
  end
end

Instance Attribute Details

#company_idString

Company ID

Returns:

  • (String)


28
# File 'lib/lithic/models/transfer_limits_response.rb', line 28

required :company_id, String

#daily_limitLithic::Models::TransferLimitsResponse::Data::DailyLimit

Daily limits with progress



34
# File 'lib/lithic/models/transfer_limits_response.rb', line 34

required :daily_limit, -> { Lithic::TransferLimitsResponse::Data::DailyLimit }

#dateDate

The date for the limit view (ISO format)

Returns:

  • (Date)


40
# File 'lib/lithic/models/transfer_limits_response.rb', line 40

required :date, Date

#is_fboBoolean

Whether the company is a FBO; based on the company ID prefix

Returns:

  • (Boolean)


46
# File 'lib/lithic/models/transfer_limits_response.rb', line 46

required :is_fbo, Lithic::Internal::Type::Boolean

#monthly_limitLithic::Models::TransferLimitsResponse::Data::MonthlyLimit

Monthly limits with progress



52
# File 'lib/lithic/models/transfer_limits_response.rb', line 52

required :monthly_limit, -> { Lithic::TransferLimitsResponse::Data::MonthlyLimit }

#program_limit_per_transactionLithic::Models::TransferLimitsResponse::Data::ProgramLimitPerTransaction

Program transaction limits



58
59
# File 'lib/lithic/models/transfer_limits_response.rb', line 58

required :program_limit_per_transaction,
-> { Lithic::TransferLimitsResponse::Data::ProgramLimitPerTransaction }