increase 1.363.0 → 1.365.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 (115) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/client.rb +8 -0
  4. data/lib/increase/models/account_number.rb +51 -81
  5. data/lib/increase/models/account_number_create_params.rb +41 -75
  6. data/lib/increase/models/account_number_list_params.rb +39 -39
  7. data/lib/increase/models/account_number_update_params.rb +48 -79
  8. data/lib/increase/models/ach_transfer.rb +9 -2
  9. data/lib/increase/models/ach_transfer_create_params.rb +31 -50
  10. data/lib/increase/models/card_create_params.rb +10 -3
  11. data/lib/increase/models/card_payment.rb +6 -0
  12. data/lib/increase/models/card_update_params.rb +21 -11
  13. data/lib/increase/models/checkbook.rb +352 -0
  14. data/lib/increase/models/checkbook_check.rb +100 -0
  15. data/lib/increase/models/checkbook_check_list_params.rb +61 -0
  16. data/lib/increase/models/checkbook_check_retrieve_params.rb +22 -0
  17. data/lib/increase/models/checkbook_check_stop_params.rb +22 -0
  18. data/lib/increase/models/checkbook_create_params.rb +111 -0
  19. data/lib/increase/models/checkbook_list_params.rb +104 -0
  20. data/lib/increase/models/checkbook_retrieve_params.rb +22 -0
  21. data/lib/increase/models/checkbook_stop_params.rb +22 -0
  22. data/lib/increase/models/declined_transaction.rb +10 -1
  23. data/lib/increase/models/entity.rb +1 -65
  24. data/lib/increase/models/entity_create_params.rb +1 -65
  25. data/lib/increase/models/entity_update_params.rb +1 -57
  26. data/lib/increase/models/fednow_transfer.rb +10 -1
  27. data/lib/increase/models/inbound_ach_transfer.rb +6 -6
  28. data/lib/increase/models/inbound_check_deposit.rb +12 -1
  29. data/lib/increase/models/real_time_decision.rb +65 -1
  30. data/lib/increase/models/simulations/checkbook_mail_params.rb +24 -0
  31. data/lib/increase/models/transaction.rb +24 -2
  32. data/lib/increase/models.rb +18 -0
  33. data/lib/increase/resources/account_numbers.rb +19 -16
  34. data/lib/increase/resources/ach_transfers.rb +14 -22
  35. data/lib/increase/resources/cards.rb +7 -2
  36. data/lib/increase/resources/checkbook_checks.rb +90 -0
  37. data/lib/increase/resources/checkbooks.rb +127 -0
  38. data/lib/increase/resources/entities.rb +2 -12
  39. data/lib/increase/resources/simulations/checkbooks.rb +38 -0
  40. data/lib/increase/resources/simulations.rb +4 -0
  41. data/lib/increase/version.rb +1 -1
  42. data/lib/increase.rb +13 -0
  43. data/rbi/increase/client.rbi +6 -0
  44. data/rbi/increase/models/account_number.rbi +86 -173
  45. data/rbi/increase/models/account_number_create_params.rbi +87 -165
  46. data/rbi/increase/models/account_number_list_params.rbi +106 -105
  47. data/rbi/increase/models/account_number_update_params.rbi +105 -190
  48. data/rbi/increase/models/ach_transfer.rbi +8 -2
  49. data/rbi/increase/models/ach_transfer_create_params.rbi +30 -54
  50. data/rbi/increase/models/card_create_params.rbi +9 -3
  51. data/rbi/increase/models/card_payment.rbi +14 -0
  52. data/rbi/increase/models/card_update_params.rbi +26 -18
  53. data/rbi/increase/models/checkbook.rbi +507 -0
  54. data/rbi/increase/models/checkbook_check.rbi +142 -0
  55. data/rbi/increase/models/checkbook_check_list_params.rbi +96 -0
  56. data/rbi/increase/models/checkbook_check_retrieve_params.rbi +46 -0
  57. data/rbi/increase/models/checkbook_check_stop_params.rbi +43 -0
  58. data/rbi/increase/models/checkbook_create_params.rbi +178 -0
  59. data/rbi/increase/models/checkbook_list_params.rbi +198 -0
  60. data/rbi/increase/models/checkbook_retrieve_params.rbi +40 -0
  61. data/rbi/increase/models/checkbook_stop_params.rbi +40 -0
  62. data/rbi/increase/models/declined_transaction.rbi +8 -0
  63. data/rbi/increase/models/entity.rbi +0 -97
  64. data/rbi/increase/models/entity_create_params.rbi +0 -119
  65. data/rbi/increase/models/entity_update_params.rbi +0 -108
  66. data/rbi/increase/models/fednow_transfer.rbi +8 -0
  67. data/rbi/increase/models/inbound_ach_transfer.rbi +6 -6
  68. data/rbi/increase/models/inbound_check_deposit.rbi +10 -0
  69. data/rbi/increase/models/real_time_decision.rbi +134 -3
  70. data/rbi/increase/models/simulations/checkbook_mail_params.rbi +45 -0
  71. data/rbi/increase/models/transaction.rbi +30 -0
  72. data/rbi/increase/models.rbi +18 -0
  73. data/rbi/increase/resources/account_numbers.rbi +24 -19
  74. data/rbi/increase/resources/ach_transfers.rbi +14 -22
  75. data/rbi/increase/resources/cards.rbi +6 -2
  76. data/rbi/increase/resources/checkbook_checks.rbi +69 -0
  77. data/rbi/increase/resources/checkbooks.rbi +96 -0
  78. data/rbi/increase/resources/entities.rbi +0 -11
  79. data/rbi/increase/resources/simulations/checkbooks.rbi +30 -0
  80. data/rbi/increase/resources/simulations.rbi +3 -0
  81. data/sig/increase/client.rbs +4 -0
  82. data/sig/increase/models/account_number.rbs +34 -66
  83. data/sig/increase/models/account_number_create_params.rbs +30 -64
  84. data/sig/increase/models/account_number_list_params.rbs +44 -44
  85. data/sig/increase/models/account_number_update_params.rbs +39 -77
  86. data/sig/increase/models/ach_transfer_create_params.rbs +9 -18
  87. data/sig/increase/models/card_payment.rbs +8 -0
  88. data/sig/increase/models/card_update_params.rbs +7 -11
  89. data/sig/increase/models/checkbook.rbs +272 -0
  90. data/sig/increase/models/checkbook_check.rbs +76 -0
  91. data/sig/increase/models/checkbook_check_list_params.rbs +56 -0
  92. data/sig/increase/models/checkbook_check_retrieve_params.rbs +24 -0
  93. data/sig/increase/models/checkbook_check_stop_params.rbs +24 -0
  94. data/sig/increase/models/checkbook_create_params.rbs +90 -0
  95. data/sig/increase/models/checkbook_list_params.rbs +97 -0
  96. data/sig/increase/models/checkbook_retrieve_params.rbs +23 -0
  97. data/sig/increase/models/checkbook_stop_params.rbs +23 -0
  98. data/sig/increase/models/declined_transaction.rbs +5 -0
  99. data/sig/increase/models/entity.rbs +0 -46
  100. data/sig/increase/models/entity_create_params.rbs +0 -55
  101. data/sig/increase/models/entity_update_params.rbs +0 -48
  102. data/sig/increase/models/fednow_transfer.rbs +5 -0
  103. data/sig/increase/models/inbound_check_deposit.rbs +5 -0
  104. data/sig/increase/models/real_time_decision.rbs +69 -3
  105. data/sig/increase/models/simulations/checkbook_mail_params.rbs +25 -0
  106. data/sig/increase/models/transaction.rbs +22 -1
  107. data/sig/increase/models.rbs +18 -0
  108. data/sig/increase/resources/account_numbers.rbs +5 -5
  109. data/sig/increase/resources/ach_transfers.rbs +2 -3
  110. data/sig/increase/resources/checkbook_checks.rbs +26 -0
  111. data/sig/increase/resources/checkbooks.rbs +33 -0
  112. data/sig/increase/resources/entities.rbs +0 -3
  113. data/sig/increase/resources/simulations/checkbooks.rbs +14 -0
  114. data/sig/increase/resources/simulations.rbs +2 -0
  115. metadata +41 -2
@@ -3,10 +3,10 @@ module Increase
3
3
  type account_number_update_params =
4
4
  {
5
5
  account_number_id: String,
6
- inbound_ach: Increase::AccountNumberUpdateParams::InboundACH,
7
- inbound_checks: Increase::AccountNumberUpdateParams::InboundChecks,
6
+ inbound_ach_debits: Increase::Models::AccountNumberUpdateParams::inbound_ach_debits,
8
7
  name: String,
9
- status: Increase::Models::AccountNumberUpdateParams::status
8
+ status: Increase::Models::AccountNumberUpdateParams::status,
9
+ unregistered_inbound_checks: Increase::Models::AccountNumberUpdateParams::unregistered_inbound_checks
10
10
  }
11
11
  & Increase::Internal::Type::request_parameters
12
12
 
@@ -16,17 +16,11 @@ module Increase
16
16
 
17
17
  attr_accessor account_number_id: String
18
18
 
19
- attr_reader inbound_ach: Increase::AccountNumberUpdateParams::InboundACH?
20
-
21
- def inbound_ach=: (
22
- Increase::AccountNumberUpdateParams::InboundACH
23
- ) -> Increase::AccountNumberUpdateParams::InboundACH
19
+ attr_reader inbound_ach_debits: Increase::Models::AccountNumberUpdateParams::inbound_ach_debits?
24
20
 
25
- attr_reader inbound_checks: Increase::AccountNumberUpdateParams::InboundChecks?
26
-
27
- def inbound_checks=: (
28
- Increase::AccountNumberUpdateParams::InboundChecks
29
- ) -> Increase::AccountNumberUpdateParams::InboundChecks
21
+ def inbound_ach_debits=: (
22
+ Increase::Models::AccountNumberUpdateParams::inbound_ach_debits
23
+ ) -> Increase::Models::AccountNumberUpdateParams::inbound_ach_debits
30
24
 
31
25
  attr_reader name: String?
32
26
 
@@ -38,88 +32,42 @@ module Increase
38
32
  Increase::Models::AccountNumberUpdateParams::status
39
33
  ) -> Increase::Models::AccountNumberUpdateParams::status
40
34
 
35
+ attr_reader unregistered_inbound_checks: Increase::Models::AccountNumberUpdateParams::unregistered_inbound_checks?
36
+
37
+ def unregistered_inbound_checks=: (
38
+ Increase::Models::AccountNumberUpdateParams::unregistered_inbound_checks
39
+ ) -> Increase::Models::AccountNumberUpdateParams::unregistered_inbound_checks
40
+
41
41
  def initialize: (
42
42
  account_number_id: String,
43
- ?inbound_ach: Increase::AccountNumberUpdateParams::InboundACH,
44
- ?inbound_checks: Increase::AccountNumberUpdateParams::InboundChecks,
43
+ ?inbound_ach_debits: Increase::Models::AccountNumberUpdateParams::inbound_ach_debits,
45
44
  ?name: String,
46
45
  ?status: Increase::Models::AccountNumberUpdateParams::status,
46
+ ?unregistered_inbound_checks: Increase::Models::AccountNumberUpdateParams::unregistered_inbound_checks,
47
47
  ?request_options: Increase::request_opts
48
48
  ) -> void
49
49
 
50
50
  def to_hash: -> {
51
51
  account_number_id: String,
52
- inbound_ach: Increase::AccountNumberUpdateParams::InboundACH,
53
- inbound_checks: Increase::AccountNumberUpdateParams::InboundChecks,
52
+ inbound_ach_debits: Increase::Models::AccountNumberUpdateParams::inbound_ach_debits,
54
53
  name: String,
55
54
  status: Increase::Models::AccountNumberUpdateParams::status,
55
+ unregistered_inbound_checks: Increase::Models::AccountNumberUpdateParams::unregistered_inbound_checks,
56
56
  request_options: Increase::RequestOptions
57
57
  }
58
58
 
59
- type inbound_ach =
60
- {
61
- debit_status: Increase::Models::AccountNumberUpdateParams::InboundACH::debit_status
62
- }
63
-
64
- class InboundACH < Increase::Internal::Type::BaseModel
65
- attr_reader debit_status: Increase::Models::AccountNumberUpdateParams::InboundACH::debit_status?
66
-
67
- def debit_status=: (
68
- Increase::Models::AccountNumberUpdateParams::InboundACH::debit_status
69
- ) -> Increase::Models::AccountNumberUpdateParams::InboundACH::debit_status
70
-
71
- def initialize: (
72
- ?debit_status: Increase::Models::AccountNumberUpdateParams::InboundACH::debit_status
73
- ) -> void
74
-
75
- def to_hash: -> {
76
- debit_status: Increase::Models::AccountNumberUpdateParams::InboundACH::debit_status
77
- }
78
-
79
- type debit_status = :allowed | :blocked
80
-
81
- module DebitStatus
82
- extend Increase::Internal::Type::Enum
83
-
84
- # ACH Debits are allowed.
85
- ALLOWED: :allowed
86
-
87
- # ACH Debits are blocked. Received debits will be declined and returned with code `R20` (non-transaction account).
88
- BLOCKED: :blocked
89
-
90
- def self?.values: -> ::Array[Increase::Models::AccountNumberUpdateParams::InboundACH::debit_status]
91
- end
92
- end
93
-
94
- type inbound_checks =
95
- {
96
- status: Increase::Models::AccountNumberUpdateParams::InboundChecks::status
97
- }
98
-
99
- class InboundChecks < Increase::Internal::Type::BaseModel
100
- attr_accessor status: Increase::Models::AccountNumberUpdateParams::InboundChecks::status
101
-
102
- def initialize: (
103
- status: Increase::Models::AccountNumberUpdateParams::InboundChecks::status
104
- ) -> void
59
+ type inbound_ach_debits = :allowed | :blocked
105
60
 
106
- def to_hash: -> {
107
- status: Increase::Models::AccountNumberUpdateParams::InboundChecks::status
108
- }
109
-
110
- type status = :allowed | :check_transfers_only
111
-
112
- module Status
113
- extend Increase::Internal::Type::Enum
61
+ module InboundACHDebits
62
+ extend Increase::Internal::Type::Enum
114
63
 
115
- # Checks with this Account Number will be processed even if they are not associated with a Check Transfer.
116
- ALLOWED: :allowed
64
+ # ACH Debits are allowed.
65
+ ALLOWED: :allowed
117
66
 
118
- # Checks with this Account Number will be processed only if they can be matched to an existing Check Transfer.
119
- CHECK_TRANSFERS_ONLY: :check_transfers_only
67
+ # ACH Debits are blocked. Received debits will be declined and returned with code `R20` (non-transaction account).
68
+ BLOCKED: :blocked
120
69
 
121
- def self?.values: -> ::Array[Increase::Models::AccountNumberUpdateParams::InboundChecks::status]
122
- end
70
+ def self?.values: -> ::Array[Increase::Models::AccountNumberUpdateParams::inbound_ach_debits]
123
71
  end
124
72
 
125
73
  type status = :active | :disabled | :canceled
@@ -138,6 +86,20 @@ module Increase
138
86
 
139
87
  def self?.values: -> ::Array[Increase::Models::AccountNumberUpdateParams::status]
140
88
  end
89
+
90
+ type unregistered_inbound_checks = :allowed | :blocked
91
+
92
+ module UnregisteredInboundChecks
93
+ extend Increase::Internal::Type::Enum
94
+
95
+ # Accept all Inbound Check Deposits, even if they are not associated with a Check Transfer or Checkbook Check.
96
+ ALLOWED: :allowed
97
+
98
+ # Only accept Inbound Check Deposits if they can be matched to a Check Transfer or Checkbook Check.
99
+ BLOCKED: :blocked
100
+
101
+ def self?.values: -> ::Array[Increase::Models::AccountNumberUpdateParams::unregistered_inbound_checks]
102
+ end
141
103
  end
142
104
  end
143
105
  end
@@ -4,18 +4,17 @@ module Increase
4
4
  {
5
5
  account_id: String,
6
6
  amount: Integer,
7
- statement_descriptor: String,
7
+ company_name: String,
8
+ individual_name: String,
8
9
  account_number: String,
9
10
  addenda: Increase::ACHTransferCreateParams::Addenda,
10
11
  company_descriptive_date: String,
11
12
  company_discretionary_data: String,
12
13
  company_entry_description: String,
13
- company_name: String,
14
14
  destination_account_holder: Increase::Models::ACHTransferCreateParams::destination_account_holder,
15
15
  external_account_id: String,
16
16
  funding: Increase::Models::ACHTransferCreateParams::funding,
17
17
  individual_id: String,
18
- individual_name: String,
19
18
  preferred_effective_date: Increase::ACHTransferCreateParams::PreferredEffectiveDate,
20
19
  require_approval: bool,
21
20
  routing_number: String,
@@ -31,7 +30,9 @@ module Increase
31
30
 
32
31
  attr_accessor amount: Integer
33
32
 
34
- attr_accessor statement_descriptor: String
33
+ attr_accessor company_name: String
34
+
35
+ attr_accessor individual_name: String
35
36
 
36
37
  attr_reader account_number: String?
37
38
 
@@ -55,10 +56,6 @@ module Increase
55
56
 
56
57
  def company_entry_description=: (String) -> String
57
58
 
58
- attr_reader company_name: String?
59
-
60
- def company_name=: (String) -> String
61
-
62
59
  attr_reader destination_account_holder: Increase::Models::ACHTransferCreateParams::destination_account_holder?
63
60
 
64
61
  def destination_account_holder=: (
@@ -79,10 +76,6 @@ module Increase
79
76
 
80
77
  def individual_id=: (String) -> String
81
78
 
82
- attr_reader individual_name: String?
83
-
84
- def individual_name=: (String) -> String
85
-
86
79
  attr_reader preferred_effective_date: Increase::ACHTransferCreateParams::PreferredEffectiveDate?
87
80
 
88
81
  def preferred_effective_date=: (
@@ -106,18 +99,17 @@ module Increase
106
99
  def initialize: (
107
100
  account_id: String,
108
101
  amount: Integer,
109
- statement_descriptor: String,
102
+ company_name: String,
103
+ individual_name: String,
110
104
  ?account_number: String,
111
105
  ?addenda: Increase::ACHTransferCreateParams::Addenda,
112
106
  ?company_descriptive_date: String,
113
107
  ?company_discretionary_data: String,
114
108
  ?company_entry_description: String,
115
- ?company_name: String,
116
109
  ?destination_account_holder: Increase::Models::ACHTransferCreateParams::destination_account_holder,
117
110
  ?external_account_id: String,
118
111
  ?funding: Increase::Models::ACHTransferCreateParams::funding,
119
112
  ?individual_id: String,
120
- ?individual_name: String,
121
113
  ?preferred_effective_date: Increase::ACHTransferCreateParams::PreferredEffectiveDate,
122
114
  ?require_approval: bool,
123
115
  ?routing_number: String,
@@ -128,18 +120,17 @@ module Increase
128
120
  def to_hash: -> {
129
121
  account_id: String,
130
122
  amount: Integer,
131
- statement_descriptor: String,
123
+ company_name: String,
124
+ individual_name: String,
132
125
  account_number: String,
133
126
  addenda: Increase::ACHTransferCreateParams::Addenda,
134
127
  company_descriptive_date: String,
135
128
  company_discretionary_data: String,
136
129
  company_entry_description: String,
137
- company_name: String,
138
130
  destination_account_holder: Increase::Models::ACHTransferCreateParams::destination_account_holder,
139
131
  external_account_id: String,
140
132
  funding: Increase::Models::ACHTransferCreateParams::funding,
141
133
  individual_id: String,
142
- individual_name: String,
143
134
  preferred_effective_date: Increase::ACHTransferCreateParams::PreferredEffectiveDate,
144
135
  require_approval: bool,
145
136
  routing_number: String,
@@ -6826,6 +6826,7 @@ module Increase
6826
6826
  | :electric_vehicle_charging_level_1_110_volt
6827
6827
  | :electric_vehicle_charging_level_2_240_volt
6828
6828
  | :electric_vehicle_charging_level_3_480_volt
6829
+ | :diesel_1_off_road_non_taxable
6829
6830
  | :renewable_diesel_r95_or_greater_off_road_non_taxable
6830
6831
  | :biodiesel_blend_1_off_road_non_taxable
6831
6832
  | :biodiesel_blend_75_off_road_non_taxable
@@ -7108,6 +7109,9 @@ module Increase
7108
7109
  # Electric vehicle charging level 3 480 volt
7109
7110
  ELECTRIC_VEHICLE_CHARGING_LEVEL_3_480_VOLT: :electric_vehicle_charging_level_3_480_volt
7110
7111
 
7112
+ # Diesel 1 off-road non-taxable
7113
+ DIESEL_1_OFF_ROAD_NON_TAXABLE: :diesel_1_off_road_non_taxable
7114
+
7111
7115
  # Renewable diesel R95 or greater off-road non-taxable
7112
7116
  RENEWABLE_DIESEL_R95_OR_GREATER_OFF_ROAD_NON_TAXABLE: :renewable_diesel_r95_or_greater_off_road_non_taxable
7113
7117
 
@@ -9023,6 +9027,7 @@ module Increase
9023
9027
  | :electric_vehicle_charging_level_1_110_volt
9024
9028
  | :electric_vehicle_charging_level_2_240_volt
9025
9029
  | :electric_vehicle_charging_level_3_480_volt
9030
+ | :diesel_1_off_road_non_taxable
9026
9031
  | :renewable_diesel_r95_or_greater_off_road_non_taxable
9027
9032
  | :biodiesel_blend_1_off_road_non_taxable
9028
9033
  | :biodiesel_blend_75_off_road_non_taxable
@@ -9305,6 +9310,9 @@ module Increase
9305
9310
  # Electric vehicle charging level 3 480 volt
9306
9311
  ELECTRIC_VEHICLE_CHARGING_LEVEL_3_480_VOLT: :electric_vehicle_charging_level_3_480_volt
9307
9312
 
9313
+ # Diesel 1 off-road non-taxable
9314
+ DIESEL_1_OFF_ROAD_NON_TAXABLE: :diesel_1_off_road_non_taxable
9315
+
9308
9316
  # Renewable diesel R95 or greater off-road non-taxable
9309
9317
  RENEWABLE_DIESEL_R95_OR_GREATER_OFF_ROAD_NON_TAXABLE: :renewable_diesel_r95_or_greater_off_road_non_taxable
9310
9318
 
@@ -498,31 +498,27 @@ module Increase
498
498
  end
499
499
 
500
500
  type digital_wallet =
501
- { digital_card_profile_id: String, email: String, phone: String }
501
+ { digital_card_profile_id: String, email: String?, phone: String? }
502
502
 
503
503
  class DigitalWallet < Increase::Internal::Type::BaseModel
504
504
  attr_reader digital_card_profile_id: String?
505
505
 
506
506
  def digital_card_profile_id=: (String) -> String
507
507
 
508
- attr_reader email: String?
508
+ attr_accessor email: String?
509
509
 
510
- def email=: (String) -> String
511
-
512
- attr_reader phone: String?
513
-
514
- def phone=: (String) -> String
510
+ attr_accessor phone: String?
515
511
 
516
512
  def initialize: (
517
513
  ?digital_card_profile_id: String,
518
- ?email: String,
519
- ?phone: String
514
+ ?email: String?,
515
+ ?phone: String?
520
516
  ) -> void
521
517
 
522
518
  def to_hash: -> {
523
519
  digital_card_profile_id: String,
524
- email: String,
525
- phone: String
520
+ email: String?,
521
+ phone: String?
526
522
  }
527
523
  end
528
524
 
@@ -0,0 +1,272 @@
1
+ module Increase
2
+ module Models
3
+ type checkbook =
4
+ {
5
+ id: String,
6
+ account_number_id: String,
7
+ created_at: Time,
8
+ idempotency_key: String?,
9
+ mailing_address: Increase::Checkbook::MailingAddress,
10
+ payer: ::Array[Increase::Checkbook::Payer],
11
+ return_address: Increase::Checkbook::ReturnAddress,
12
+ status: Increase::Models::Checkbook::status,
13
+ style: Increase::Models::Checkbook::style,
14
+ tracking_updates: ::Array[Increase::Checkbook::TrackingUpdate],
15
+ type: Increase::Models::Checkbook::type_
16
+ }
17
+
18
+ class Checkbook < Increase::Internal::Type::BaseModel
19
+ attr_accessor id: String
20
+
21
+ attr_accessor account_number_id: String
22
+
23
+ attr_accessor created_at: Time
24
+
25
+ attr_accessor idempotency_key: String?
26
+
27
+ attr_accessor mailing_address: Increase::Checkbook::MailingAddress
28
+
29
+ attr_accessor payer: ::Array[Increase::Checkbook::Payer]
30
+
31
+ attr_accessor return_address: Increase::Checkbook::ReturnAddress
32
+
33
+ attr_accessor status: Increase::Models::Checkbook::status
34
+
35
+ attr_accessor style: Increase::Models::Checkbook::style
36
+
37
+ attr_accessor tracking_updates: ::Array[Increase::Checkbook::TrackingUpdate]
38
+
39
+ attr_accessor type: Increase::Models::Checkbook::type_
40
+
41
+ def initialize: (
42
+ id: String,
43
+ account_number_id: String,
44
+ created_at: Time,
45
+ idempotency_key: String?,
46
+ mailing_address: Increase::Checkbook::MailingAddress,
47
+ payer: ::Array[Increase::Checkbook::Payer],
48
+ return_address: Increase::Checkbook::ReturnAddress,
49
+ status: Increase::Models::Checkbook::status,
50
+ style: Increase::Models::Checkbook::style,
51
+ tracking_updates: ::Array[Increase::Checkbook::TrackingUpdate],
52
+ type: Increase::Models::Checkbook::type_
53
+ ) -> void
54
+
55
+ def to_hash: -> {
56
+ id: String,
57
+ account_number_id: String,
58
+ created_at: Time,
59
+ idempotency_key: String?,
60
+ mailing_address: Increase::Checkbook::MailingAddress,
61
+ payer: ::Array[Increase::Checkbook::Payer],
62
+ return_address: Increase::Checkbook::ReturnAddress,
63
+ status: Increase::Models::Checkbook::status,
64
+ style: Increase::Models::Checkbook::style,
65
+ tracking_updates: ::Array[Increase::Checkbook::TrackingUpdate],
66
+ type: Increase::Models::Checkbook::type_
67
+ }
68
+
69
+ type mailing_address =
70
+ {
71
+ city: String,
72
+ :line1 => String,
73
+ :line2 => String?,
74
+ name: String,
75
+ postal_code: String,
76
+ state: String
77
+ }
78
+
79
+ class MailingAddress < Increase::Internal::Type::BaseModel
80
+ attr_accessor city: String
81
+
82
+ attr_accessor line1: String
83
+
84
+ attr_accessor line2: String?
85
+
86
+ attr_accessor name: String
87
+
88
+ attr_accessor postal_code: String
89
+
90
+ attr_accessor state: String
91
+
92
+ def initialize: (
93
+ city: String,
94
+ line1: String,
95
+ line2: String?,
96
+ name: String,
97
+ postal_code: String,
98
+ state: String
99
+ ) -> void
100
+
101
+ def to_hash: -> {
102
+ city: String,
103
+ :line1 => String,
104
+ :line2 => String?,
105
+ name: String,
106
+ postal_code: String,
107
+ state: String
108
+ }
109
+ end
110
+
111
+ type payer = { contents: String }
112
+
113
+ class Payer < Increase::Internal::Type::BaseModel
114
+ attr_accessor contents: String
115
+
116
+ def initialize: (contents: String) -> void
117
+
118
+ def to_hash: -> { contents: String }
119
+ end
120
+
121
+ type return_address =
122
+ {
123
+ city: String,
124
+ :line1 => String,
125
+ :line2 => String?,
126
+ name: String,
127
+ postal_code: String,
128
+ state: String
129
+ }
130
+
131
+ class ReturnAddress < Increase::Internal::Type::BaseModel
132
+ attr_accessor city: String
133
+
134
+ attr_accessor line1: String
135
+
136
+ attr_accessor line2: String?
137
+
138
+ attr_accessor name: String
139
+
140
+ attr_accessor postal_code: String
141
+
142
+ attr_accessor state: String
143
+
144
+ def initialize: (
145
+ city: String,
146
+ line1: String,
147
+ line2: String?,
148
+ name: String,
149
+ postal_code: String,
150
+ state: String
151
+ ) -> void
152
+
153
+ def to_hash: -> {
154
+ city: String,
155
+ :line1 => String,
156
+ :line2 => String?,
157
+ name: String,
158
+ postal_code: String,
159
+ state: String
160
+ }
161
+ end
162
+
163
+ type status = :pending_submission | :pending_mailing | :mailed | :stopped
164
+
165
+ module Status
166
+ extend Increase::Internal::Type::Enum
167
+
168
+ # The Checkbook is pending submission to the printer.
169
+ PENDING_SUBMISSION: :pending_submission
170
+
171
+ # The Checkbook has been submitted to the printer and is pending mailing.
172
+ PENDING_MAILING: :pending_mailing
173
+
174
+ # The Checkbook has been mailed.
175
+ MAILED: :mailed
176
+
177
+ # The Checkbook has been stopped and its checks can no longer be deposited.
178
+ STOPPED: :stopped
179
+
180
+ def self?.values: -> ::Array[Increase::Models::Checkbook::status]
181
+ end
182
+
183
+ type style = :three_ring_binder | :folder
184
+
185
+ module Style
186
+ extend Increase::Internal::Type::Enum
187
+
188
+ # A half-inch three-ring binder holding 75 pages of checks with 3 checks per page.
189
+ THREE_RING_BINDER: :three_ring_binder
190
+
191
+ # A folder holding 15 pages of checks with 3 checks per page.
192
+ FOLDER: :folder
193
+
194
+ def self?.values: -> ::Array[Increase::Models::Checkbook::style]
195
+ end
196
+
197
+ type tracking_update =
198
+ {
199
+ category: Increase::Models::Checkbook::TrackingUpdate::category,
200
+ country: String,
201
+ created_at: Time,
202
+ postal_code: String
203
+ }
204
+
205
+ class TrackingUpdate < Increase::Internal::Type::BaseModel
206
+ attr_accessor category: Increase::Models::Checkbook::TrackingUpdate::category
207
+
208
+ attr_accessor country: String
209
+
210
+ attr_accessor created_at: Time
211
+
212
+ attr_accessor postal_code: String
213
+
214
+ def initialize: (
215
+ category: Increase::Models::Checkbook::TrackingUpdate::category,
216
+ country: String,
217
+ created_at: Time,
218
+ postal_code: String
219
+ ) -> void
220
+
221
+ def to_hash: -> {
222
+ category: Increase::Models::Checkbook::TrackingUpdate::category,
223
+ country: String,
224
+ created_at: Time,
225
+ postal_code: String
226
+ }
227
+
228
+ type category =
229
+ :in_transit
230
+ | :processed_for_delivery
231
+ | :delivered
232
+ | :delivery_issue
233
+ | :returning_to_sender
234
+ | :returned_to_sender
235
+
236
+ module Category
237
+ extend Increase::Internal::Type::Enum
238
+
239
+ # The checkbook is in transit.
240
+ IN_TRANSIT: :in_transit
241
+
242
+ # The checkbook has been processed for delivery.
243
+ PROCESSED_FOR_DELIVERY: :processed_for_delivery
244
+
245
+ # The checkbook has been delivered. Note that some couriers track delivery status based on driver location data rather than an explicit scan. While uncommon, a single checkbook may have more than one delivered event.
246
+ DELIVERED: :delivered
247
+
248
+ # There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the checkbook will be rerouted to the return address.
249
+ DELIVERY_ISSUE: :delivery_issue
250
+
251
+ # The checkbook has been rerouted to the return address.
252
+ RETURNING_TO_SENDER: :returning_to_sender
253
+
254
+ # The checkbook has been delivered to the return address.
255
+ RETURNED_TO_SENDER: :returned_to_sender
256
+
257
+ def self?.values: -> ::Array[Increase::Models::Checkbook::TrackingUpdate::category]
258
+ end
259
+ end
260
+
261
+ type type_ = :checkbook
262
+
263
+ module Type
264
+ extend Increase::Internal::Type::Enum
265
+
266
+ CHECKBOOK: :checkbook
267
+
268
+ def self?.values: -> ::Array[Increase::Models::Checkbook::type_]
269
+ end
270
+ end
271
+ end
272
+ end
@@ -0,0 +1,76 @@
1
+ module Increase
2
+ module Models
3
+ type checkbook_check =
4
+ {
5
+ id: String,
6
+ check_number: Integer,
7
+ checkbook_id: String,
8
+ created_at: Time,
9
+ status: Increase::Models::CheckbookCheck::status,
10
+ type: Increase::Models::CheckbookCheck::type_
11
+ }
12
+
13
+ class CheckbookCheck < Increase::Internal::Type::BaseModel
14
+ attr_accessor id: String
15
+
16
+ attr_accessor check_number: Integer
17
+
18
+ attr_accessor checkbook_id: String
19
+
20
+ attr_accessor created_at: Time
21
+
22
+ attr_accessor status: Increase::Models::CheckbookCheck::status
23
+
24
+ attr_accessor type: Increase::Models::CheckbookCheck::type_
25
+
26
+ def initialize: (
27
+ id: String,
28
+ check_number: Integer,
29
+ checkbook_id: String,
30
+ created_at: Time,
31
+ status: Increase::Models::CheckbookCheck::status,
32
+ type: Increase::Models::CheckbookCheck::type_
33
+ ) -> void
34
+
35
+ def to_hash: -> {
36
+ id: String,
37
+ check_number: Integer,
38
+ checkbook_id: String,
39
+ created_at: Time,
40
+ status: Increase::Models::CheckbookCheck::status,
41
+ type: Increase::Models::CheckbookCheck::type_
42
+ }
43
+
44
+ type status =
45
+ :pending_deposit | :deposited | :stopped | :requires_attention
46
+
47
+ module Status
48
+ extend Increase::Internal::Type::Enum
49
+
50
+ # The check has not yet been deposited.
51
+ PENDING_DEPOSIT: :pending_deposit
52
+
53
+ # The check has been deposited.
54
+ DEPOSITED: :deposited
55
+
56
+ # The check has been stopped and can no longer be deposited.
57
+ STOPPED: :stopped
58
+
59
+ # The check requires attention from an Increase operator.
60
+ REQUIRES_ATTENTION: :requires_attention
61
+
62
+ def self?.values: -> ::Array[Increase::Models::CheckbookCheck::status]
63
+ end
64
+
65
+ type type_ = :checkbook_check
66
+
67
+ module Type
68
+ extend Increase::Internal::Type::Enum
69
+
70
+ CHECKBOOK_CHECK: :checkbook_check
71
+
72
+ def self?.values: -> ::Array[Increase::Models::CheckbookCheck::type_]
73
+ end
74
+ end
75
+ end
76
+ end