increase 1.148.0 → 1.149.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4c41e4dd48a1bc48968ea62c5a717aca4594f54bf1eca203bdb945c4c8f2d5a5
4
- data.tar.gz: af00b5e55da301a90beabc86cb4ac7e1e52b11fe0c75d5ac29f21947af6d746d
3
+ metadata.gz: 6c21387d0150b35a6889315886f4fe7511a7feadf3d373b4630533152d5778cd
4
+ data.tar.gz: 0fd863d3600aa7920b8edb7d997d605a6d36980453848bfce2581e1dd3829a06
5
5
  SHA512:
6
- metadata.gz: b69f640821a9fffb58a3e6f45336401a4ad4f7732be2e1f12a4fa379191f9a2cdf3447bfcc00cbdd7473378b3c8a16fcec6964abb8b21b99fc4e30c97975bb6c
7
- data.tar.gz: 428f4b38018118df51a438149ca96d28b44d27b2c7840aa1e178ac7c9fc9905f5a6c60a7d6e0216442d0771133406f5922c9a011565cd291eefe2ae530eaf53a
6
+ metadata.gz: 1da092ff6d55d92655f9974b8d71bb3de6b7cb5a2d73f2ed79a630d57154cbd0a9c3be445f3a0e838171ae9ac73b84324e7472fc4a3e6e18c081a1003967627a
7
+ data.tar.gz: 90d06146d8b6603caedf59516ba984f07b64b328ffcf40cfcfa288a1f2a1d19321b333444280def07c3e4323503b85dad95024e7fc421bf2184c28c5c7ed992f
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.149.0 (2025-11-24)
4
+
5
+ Full Changelog: [v1.148.0...v1.149.0](https://github.com/Increase/increase-ruby/compare/v1.148.0...v1.149.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([d27029d](https://github.com/Increase/increase-ruby/commit/d27029d6e3d7ba98ea5c378f9734487164820732))
10
+
3
11
  ## 1.148.0 (2025-11-24)
4
12
 
5
13
  Full Changelog: [v1.147.0...v1.148.0](https://github.com/Increase/increase-ruby/compare/v1.147.0...v1.148.0)
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 "increase", "~> 1.148.0"
18
+ gem "increase", "~> 1.149.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -475,6 +475,12 @@ module Increase
475
475
  # @return [String, nil]
476
476
  required :attachment_file_id, String, nil?: true
477
477
 
478
+ # @!attribute check_voucher_image_file_id
479
+ # The ID of the file for the check voucher image.
480
+ #
481
+ # @return [String, nil]
482
+ required :check_voucher_image_file_id, String, nil?: true
483
+
478
484
  # @!attribute mailing_address
479
485
  # Details for where Increase will mail the check.
480
486
  #
@@ -536,7 +542,7 @@ module Increase
536
542
  required :tracking_updates,
537
543
  -> { Increase::Internal::Type::ArrayOf[Increase::CheckTransfer::PhysicalCheck::TrackingUpdate] }
538
544
 
539
- # @!method initialize(attachment_file_id:, mailing_address:, memo:, note:, payer:, recipient_name:, return_address:, shipping_method:, signature_text:, tracking_updates:)
545
+ # @!method initialize(attachment_file_id:, check_voucher_image_file_id:, mailing_address:, memo:, note:, payer:, recipient_name:, return_address:, shipping_method:, signature_text:, tracking_updates:)
540
546
  # Some parameter documentations has been truncated, see
541
547
  # {Increase::Models::CheckTransfer::PhysicalCheck} for more details.
542
548
  #
@@ -545,6 +551,8 @@ module Increase
545
551
  #
546
552
  # @param attachment_file_id [String, nil] The ID of the file for the check attachment.
547
553
  #
554
+ # @param check_voucher_image_file_id [String, nil] The ID of the file for the check voucher image.
555
+ #
548
556
  # @param mailing_address [Increase::Models::CheckTransfer::PhysicalCheck::MailingAddress] Details for where Increase will mail the check.
549
557
  #
550
558
  # @param memo [String, nil] The descriptor that will be printed on the memo field on the check.
@@ -160,6 +160,14 @@ module Increase
160
160
  # @return [String, nil]
161
161
  optional :attachment_file_id, String
162
162
 
163
+ # @!attribute check_voucher_image_file_id
164
+ # The ID of a File to be used as the check voucher image. This must have
165
+ # `purpose: check_voucher_image`. For details on pricing and restrictions, see
166
+ # https://increase.com/documentation/originating-checks#printing-checks .
167
+ #
168
+ # @return [String, nil]
169
+ optional :check_voucher_image_file_id, String
170
+
163
171
  # @!attribute note
164
172
  # The descriptor that will be printed on the letter included with the check.
165
173
  #
@@ -197,7 +205,7 @@ module Increase
197
205
  # @return [String, nil]
198
206
  optional :signature_text, String
199
207
 
200
- # @!method initialize(mailing_address:, memo:, recipient_name:, attachment_file_id: nil, note: nil, payer: nil, return_address: nil, shipping_method: nil, signature_text: nil)
208
+ # @!method initialize(mailing_address:, memo:, recipient_name:, attachment_file_id: nil, check_voucher_image_file_id: nil, note: nil, payer: nil, return_address: nil, shipping_method: nil, signature_text: nil)
201
209
  # Some parameter documentations has been truncated, see
202
210
  # {Increase::Models::CheckTransferCreateParams::PhysicalCheck} for more details.
203
211
  #
@@ -213,6 +221,8 @@ module Increase
213
221
  #
214
222
  # @param attachment_file_id [String] The ID of a File to be attached to the check. This must have `purpose: check_att
215
223
  #
224
+ # @param check_voucher_image_file_id [String] The ID of a File to be used as the check voucher image. This must have `purpose:
225
+ #
216
226
  # @param note [String] The descriptor that will be printed on the letter included with the check.
217
227
  #
218
228
  # @param payer [Array<Increase::Models::CheckTransferCreateParams::PhysicalCheck::Payer>] The payer of the check. This will be printed on the top-left portion of the chec
@@ -135,6 +135,9 @@ module Increase
135
135
  # A document to be printed on an additional page and mailed with a check that you've requested Increase print.
136
136
  CHECK_ATTACHMENT = :check_attachment
137
137
 
138
+ # An image to be used as the check voucher image, which is printed in the middle of the trifold area of a check. This must be a 2550x1100 pixel PNG.
139
+ CHECK_VOUCHER_IMAGE = :check_voucher_image
140
+
138
141
  # A scanned mail item sent to Increase.
139
142
  INBOUND_MAIL_ITEM = :inbound_mail_item
140
143
 
@@ -58,6 +58,9 @@ module Increase
58
58
  # A document to be printed on an additional page and mailed with a check that you've requested Increase print.
59
59
  CHECK_ATTACHMENT = :check_attachment
60
60
 
61
+ # An image to be used as the check voucher image, which is printed in the middle of the trifold area of a check. This must be a 2550x1100 pixel PNG.
62
+ CHECK_VOUCHER_IMAGE = :check_voucher_image
63
+
61
64
  # IRS Form SS-4.
62
65
  FORM_SS_4 = :form_ss_4
63
66
 
@@ -137,6 +137,9 @@ module Increase
137
137
  # A document to be printed on an additional page and mailed with a check that you've requested Increase print.
138
138
  CHECK_ATTACHMENT = :check_attachment
139
139
 
140
+ # An image to be used as the check voucher image, which is printed in the middle of the trifold area of a check. This must be a 2550x1100 pixel PNG.
141
+ CHECK_VOUCHER_IMAGE = :check_voucher_image
142
+
140
143
  # A scanned mail item sent to Increase.
141
144
  INBOUND_MAIL_ITEM = :inbound_mail_item
142
145
 
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.148.0"
4
+ VERSION = "1.149.0"
5
5
  end
@@ -786,6 +786,10 @@ module Increase
786
786
  sig { returns(T.nilable(String)) }
787
787
  attr_accessor :attachment_file_id
788
788
 
789
+ # The ID of the file for the check voucher image.
790
+ sig { returns(T.nilable(String)) }
791
+ attr_accessor :check_voucher_image_file_id
792
+
789
793
  # Details for where Increase will mail the check.
790
794
  sig { returns(Increase::CheckTransfer::PhysicalCheck::MailingAddress) }
791
795
  attr_reader :mailing_address
@@ -861,6 +865,7 @@ module Increase
861
865
  sig do
862
866
  params(
863
867
  attachment_file_id: T.nilable(String),
868
+ check_voucher_image_file_id: T.nilable(String),
864
869
  mailing_address:
865
870
  Increase::CheckTransfer::PhysicalCheck::MailingAddress::OrHash,
866
871
  memo: T.nilable(String),
@@ -886,6 +891,8 @@ module Increase
886
891
  def self.new(
887
892
  # The ID of the file for the check attachment.
888
893
  attachment_file_id:,
894
+ # The ID of the file for the check voucher image.
895
+ check_voucher_image_file_id:,
889
896
  # Details for where Increase will mail the check.
890
897
  mailing_address:,
891
898
  # The descriptor that will be printed on the memo field on the check.
@@ -913,6 +920,7 @@ module Increase
913
920
  override.returns(
914
921
  {
915
922
  attachment_file_id: T.nilable(String),
923
+ check_voucher_image_file_id: T.nilable(String),
916
924
  mailing_address:
917
925
  Increase::CheckTransfer::PhysicalCheck::MailingAddress,
918
926
  memo: T.nilable(String),
@@ -301,6 +301,15 @@ module Increase
301
301
  sig { params(attachment_file_id: String).void }
302
302
  attr_writer :attachment_file_id
303
303
 
304
+ # The ID of a File to be used as the check voucher image. This must have
305
+ # `purpose: check_voucher_image`. For details on pricing and restrictions, see
306
+ # https://increase.com/documentation/originating-checks#printing-checks .
307
+ sig { returns(T.nilable(String)) }
308
+ attr_reader :check_voucher_image_file_id
309
+
310
+ sig { params(check_voucher_image_file_id: String).void }
311
+ attr_writer :check_voucher_image_file_id
312
+
304
313
  # The descriptor that will be printed on the letter included with the check.
305
314
  sig { returns(T.nilable(String)) }
306
315
  attr_reader :note
@@ -389,6 +398,7 @@ module Increase
389
398
  memo: String,
390
399
  recipient_name: String,
391
400
  attachment_file_id: String,
401
+ check_voucher_image_file_id: String,
392
402
  note: String,
393
403
  payer:
394
404
  T::Array[
@@ -412,6 +422,10 @@ module Increase
412
422
  # `purpose: check_attachment`. For details on pricing and restrictions, see
413
423
  # https://increase.com/documentation/originating-checks#printing-checks .
414
424
  attachment_file_id: nil,
425
+ # The ID of a File to be used as the check voucher image. This must have
426
+ # `purpose: check_voucher_image`. For details on pricing and restrictions, see
427
+ # https://increase.com/documentation/originating-checks#printing-checks .
428
+ check_voucher_image_file_id: nil,
415
429
  # The descriptor that will be printed on the letter included with the check.
416
430
  note: nil,
417
431
  # The payer of the check. This will be printed on the top-left portion of the
@@ -439,6 +453,7 @@ module Increase
439
453
  memo: String,
440
454
  recipient_name: String,
441
455
  attachment_file_id: String,
456
+ check_voucher_image_file_id: String,
442
457
  note: String,
443
458
  payer:
444
459
  T::Array[
@@ -174,6 +174,10 @@ module Increase
174
174
  CHECK_ATTACHMENT =
175
175
  T.let(:check_attachment, Increase::File::Purpose::TaggedSymbol)
176
176
 
177
+ # An image to be used as the check voucher image, which is printed in the middle of the trifold area of a check. This must be a 2550x1100 pixel PNG.
178
+ CHECK_VOUCHER_IMAGE =
179
+ T.let(:check_voucher_image, Increase::File::Purpose::TaggedSymbol)
180
+
177
181
  # A scanned mail item sent to Increase.
178
182
  INBOUND_MAIL_ITEM =
179
183
  T.let(:inbound_mail_item, Increase::File::Purpose::TaggedSymbol)
@@ -105,6 +105,13 @@ module Increase
105
105
  Increase::FileCreateParams::Purpose::TaggedSymbol
106
106
  )
107
107
 
108
+ # An image to be used as the check voucher image, which is printed in the middle of the trifold area of a check. This must be a 2550x1100 pixel PNG.
109
+ CHECK_VOUCHER_IMAGE =
110
+ T.let(
111
+ :check_voucher_image,
112
+ Increase::FileCreateParams::Purpose::TaggedSymbol
113
+ )
114
+
108
115
  # IRS Form SS-4.
109
116
  FORM_SS_4 =
110
117
  T.let(:form_ss_4, Increase::FileCreateParams::Purpose::TaggedSymbol)
@@ -269,6 +269,13 @@ module Increase
269
269
  Increase::FileListParams::Purpose::In::TaggedSymbol
270
270
  )
271
271
 
272
+ # An image to be used as the check voucher image, which is printed in the middle of the trifold area of a check. This must be a 2550x1100 pixel PNG.
273
+ CHECK_VOUCHER_IMAGE =
274
+ T.let(
275
+ :check_voucher_image,
276
+ Increase::FileListParams::Purpose::In::TaggedSymbol
277
+ )
278
+
272
279
  # A scanned mail item sent to Increase.
273
280
  INBOUND_MAIL_ITEM =
274
281
  T.let(
@@ -304,6 +304,7 @@ module Increase
304
304
  type physical_check =
305
305
  {
306
306
  attachment_file_id: String?,
307
+ check_voucher_image_file_id: String?,
307
308
  mailing_address: Increase::CheckTransfer::PhysicalCheck::MailingAddress,
308
309
  memo: String?,
309
310
  note: String?,
@@ -318,6 +319,8 @@ module Increase
318
319
  class PhysicalCheck < Increase::Internal::Type::BaseModel
319
320
  attr_accessor attachment_file_id: String?
320
321
 
322
+ attr_accessor check_voucher_image_file_id: String?
323
+
321
324
  attr_accessor mailing_address: Increase::CheckTransfer::PhysicalCheck::MailingAddress
322
325
 
323
326
  attr_accessor memo: String?
@@ -338,6 +341,7 @@ module Increase
338
341
 
339
342
  def initialize: (
340
343
  attachment_file_id: String?,
344
+ check_voucher_image_file_id: String?,
341
345
  mailing_address: Increase::CheckTransfer::PhysicalCheck::MailingAddress,
342
346
  memo: String?,
343
347
  note: String?,
@@ -351,6 +355,7 @@ module Increase
351
355
 
352
356
  def to_hash: -> {
353
357
  attachment_file_id: String?,
358
+ check_voucher_image_file_id: String?,
354
359
  mailing_address: Increase::CheckTransfer::PhysicalCheck::MailingAddress,
355
360
  memo: String?,
356
361
  note: String?,
@@ -119,6 +119,7 @@ module Increase
119
119
  memo: String,
120
120
  recipient_name: String,
121
121
  attachment_file_id: String,
122
+ check_voucher_image_file_id: String,
122
123
  note: String,
123
124
  payer: ::Array[Increase::CheckTransferCreateParams::PhysicalCheck::Payer],
124
125
  return_address: Increase::CheckTransferCreateParams::PhysicalCheck::ReturnAddress,
@@ -137,6 +138,10 @@ module Increase
137
138
 
138
139
  def attachment_file_id=: (String) -> String
139
140
 
141
+ attr_reader check_voucher_image_file_id: String?
142
+
143
+ def check_voucher_image_file_id=: (String) -> String
144
+
140
145
  attr_reader note: String?
141
146
 
142
147
  def note=: (String) -> String
@@ -168,6 +173,7 @@ module Increase
168
173
  memo: String,
169
174
  recipient_name: String,
170
175
  ?attachment_file_id: String,
176
+ ?check_voucher_image_file_id: String,
171
177
  ?note: String,
172
178
  ?payer: ::Array[Increase::CheckTransferCreateParams::PhysicalCheck::Payer],
173
179
  ?return_address: Increase::CheckTransferCreateParams::PhysicalCheck::ReturnAddress,
@@ -180,6 +186,7 @@ module Increase
180
186
  memo: String,
181
187
  recipient_name: String,
182
188
  attachment_file_id: String,
189
+ check_voucher_image_file_id: String,
183
190
  note: String,
184
191
  payer: ::Array[Increase::CheckTransferCreateParams::PhysicalCheck::Payer],
185
192
  return_address: Increase::CheckTransferCreateParams::PhysicalCheck::ReturnAddress,
@@ -78,6 +78,7 @@ module Increase
78
78
  | :processed_check_image_back
79
79
  | :mailed_check_image
80
80
  | :check_attachment
81
+ | :check_voucher_image
81
82
  | :inbound_mail_item
82
83
  | :form_1099_int
83
84
  | :form_1099_misc
@@ -126,6 +127,9 @@ module Increase
126
127
  # A document to be printed on an additional page and mailed with a check that you've requested Increase print.
127
128
  CHECK_ATTACHMENT: :check_attachment
128
129
 
130
+ # An image to be used as the check voucher image, which is printed in the middle of the trifold area of a check. This must be a 2550x1100 pixel PNG.
131
+ CHECK_VOUCHER_IMAGE: :check_voucher_image
132
+
129
133
  # A scanned mail item sent to Increase.
130
134
  INBOUND_MAIL_ITEM: :inbound_mail_item
131
135
 
@@ -40,6 +40,7 @@ module Increase
40
40
  | :check_image_back
41
41
  | :mailed_check_image
42
42
  | :check_attachment
43
+ | :check_voucher_image
43
44
  | :form_ss_4
44
45
  | :identity_document
45
46
  | :loan_application_supplemental_document
@@ -72,6 +73,9 @@ module Increase
72
73
  # A document to be printed on an additional page and mailed with a check that you've requested Increase print.
73
74
  CHECK_ATTACHMENT: :check_attachment
74
75
 
76
+ # An image to be used as the check voucher image, which is printed in the middle of the trifold area of a check. This must be a 2550x1100 pixel PNG.
77
+ CHECK_VOUCHER_IMAGE: :check_voucher_image
78
+
75
79
  # IRS Form SS-4.
76
80
  FORM_SS_4: :form_ss_4
77
81
 
@@ -117,6 +117,7 @@ module Increase
117
117
  | :processed_check_image_back
118
118
  | :mailed_check_image
119
119
  | :check_attachment
120
+ | :check_voucher_image
120
121
  | :inbound_mail_item
121
122
  | :form_1099_int
122
123
  | :form_1099_misc
@@ -165,6 +166,9 @@ module Increase
165
166
  # A document to be printed on an additional page and mailed with a check that you've requested Increase print.
166
167
  CHECK_ATTACHMENT: :check_attachment
167
168
 
169
+ # An image to be used as the check voucher image, which is printed in the middle of the trifold area of a check. This must be a 2550x1100 pixel PNG.
170
+ CHECK_VOUCHER_IMAGE: :check_voucher_image
171
+
168
172
  # A scanned mail item sent to Increase.
169
173
  INBOUND_MAIL_ITEM: :inbound_mail_item
170
174
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: increase
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.148.0
4
+ version: 1.149.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Increase