increase 1.352.0 → 1.353.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 (33) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/beneficial_owner_create_params.rb +3 -0
  4. data/lib/increase/models/beneficial_owner_update_params.rb +3 -0
  5. data/lib/increase/models/card_payment.rb +1174 -2
  6. data/lib/increase/models/check_transfer.rb +15 -9
  7. data/lib/increase/models/entity.rb +18 -0
  8. data/lib/increase/models/entity_beneficial_owner.rb +3 -0
  9. data/lib/increase/models/entity_create_params.rb +3 -0
  10. data/lib/increase/models/transaction.rb +1174 -2
  11. data/lib/increase/models/wire_drawdown_request.rb +3 -3
  12. data/lib/increase/models/wire_drawdown_request_list_params.rb +3 -3
  13. data/lib/increase/version.rb +1 -1
  14. data/rbi/increase/models/beneficial_owner_create_params.rbi +7 -0
  15. data/rbi/increase/models/beneficial_owner_update_params.rbi +7 -0
  16. data/rbi/increase/models/card_payment.rbi +5276 -2964
  17. data/rbi/increase/models/check_transfer.rbi +15 -9
  18. data/rbi/increase/models/entity.rbi +42 -0
  19. data/rbi/increase/models/entity_beneficial_owner.rbi +7 -0
  20. data/rbi/increase/models/entity_create_params.rbi +7 -0
  21. data/rbi/increase/models/transaction.rbi +4647 -2335
  22. data/rbi/increase/models/wire_drawdown_request.rbi +4 -4
  23. data/rbi/increase/models/wire_drawdown_request_list_params.rbi +6 -6
  24. data/sig/increase/models/beneficial_owner_create_params.rbs +4 -0
  25. data/sig/increase/models/beneficial_owner_update_params.rbs +4 -0
  26. data/sig/increase/models/card_payment.rbs +1186 -0
  27. data/sig/increase/models/entity.rbs +24 -0
  28. data/sig/increase/models/entity_beneficial_owner.rbs +4 -0
  29. data/sig/increase/models/entity_create_params.rbs +4 -0
  30. data/sig/increase/models/transaction.rbs +1186 -0
  31. data/sig/increase/models/wire_drawdown_request.rbs +4 -4
  32. data/sig/increase/models/wire_drawdown_request_list_params.rbs +4 -4
  33. metadata +2 -2
@@ -96,8 +96,8 @@ module Increase
96
96
  sig { returns(T.nilable(String)) }
97
97
  attr_accessor :idempotency_key
98
98
 
99
- # If the check has been mailed by Increase, this will contain details of the
100
- # shipment.
99
+ # Once the check has been mailed, this will contain details about the shipment.
100
+ # Only available when `fulfillment_method` is equal to `physical_check`.
101
101
  sig { returns(T.nilable(Increase::CheckTransfer::Mailing)) }
102
102
  attr_reader :mailing
103
103
 
@@ -154,7 +154,9 @@ module Increase
154
154
  end
155
155
  attr_writer :stop_payment_request
156
156
 
157
- # After the transfer is submitted, this will contain supplemental details.
157
+ # Once the check has been submitted to our printer, this will contain details
158
+ # about the submission. Only available when `fulfillment_method` is equal to
159
+ # `physical_check`.
158
160
  sig { returns(T.nilable(Increase::CheckTransfer::Submission)) }
159
161
  attr_reader :submission
160
162
 
@@ -263,8 +265,8 @@ module Increase
263
265
  # Increase and is used to ensure that a request is only processed once. Learn more
264
266
  # about [idempotency](https://increase.com/documentation/idempotency-keys).
265
267
  idempotency_key:,
266
- # If the check has been mailed by Increase, this will contain details of the
267
- # shipment.
268
+ # Once the check has been mailed, this will contain details about the shipment.
269
+ # Only available when `fulfillment_method` is equal to `physical_check`.
268
270
  mailing:,
269
271
  # The ID for the pending transaction representing the transfer. A pending
270
272
  # transaction is created when the transfer
@@ -284,7 +286,9 @@ module Increase
284
286
  # After a stop-payment is requested on the check, this will contain supplemental
285
287
  # details.
286
288
  stop_payment_request:,
287
- # After the transfer is submitted, this will contain supplemental details.
289
+ # Once the check has been submitted to our printer, this will contain details
290
+ # about the submission. Only available when `fulfillment_method` is equal to
291
+ # `physical_check`.
288
292
  submission:,
289
293
  # Details relating to the custom fulfillment you will perform. Will be present if
290
294
  # and only if `fulfillment_method` is equal to `third_party`.
@@ -734,8 +738,8 @@ module Increase
734
738
  sig { returns(Time) }
735
739
  attr_accessor :mailed_at
736
740
 
737
- # If the check has been mailed by Increase, this will contain details of the
738
- # shipment.
741
+ # Once the check has been mailed, this will contain details about the shipment.
742
+ # Only available when `fulfillment_method` is equal to `physical_check`.
739
743
  sig { params(mailed_at: Time).returns(T.attached_class) }
740
744
  def self.new(
741
745
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -1629,7 +1633,9 @@ module Increase
1629
1633
  sig { returns(T.nilable(String)) }
1630
1634
  attr_accessor :tracking_number
1631
1635
 
1632
- # After the transfer is submitted, this will contain supplemental details.
1636
+ # Once the check has been submitted to our printer, this will contain details
1637
+ # about the submission. Only available when `fulfillment_method` is equal to
1638
+ # `physical_check`.
1633
1639
  sig do
1634
1640
  params(
1635
1641
  preview_file_id: T.nilable(String),
@@ -828,6 +828,13 @@ module Increase
828
828
  Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
829
829
  )
830
830
 
831
+ # The last four digits of a social security number.
832
+ SOCIAL_SECURITY_NUMBER_LAST4 =
833
+ T.let(
834
+ :social_security_number_last4,
835
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
836
+ )
837
+
831
838
  # An individual taxpayer identification number (ITIN).
832
839
  INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
833
840
  T.let(
@@ -1585,6 +1592,13 @@ module Increase
1585
1592
  Increase::Entity::Joint::Individual::Identification::Method::TaggedSymbol
1586
1593
  )
1587
1594
 
1595
+ # The last four digits of a social security number.
1596
+ SOCIAL_SECURITY_NUMBER_LAST4 =
1597
+ T.let(
1598
+ :social_security_number_last4,
1599
+ Increase::Entity::Joint::Individual::Identification::Method::TaggedSymbol
1600
+ )
1601
+
1588
1602
  # An individual taxpayer identification number (ITIN).
1589
1603
  INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
1590
1604
  T.let(
@@ -1852,6 +1866,13 @@ module Increase
1852
1866
  Increase::Entity::NaturalPerson::Identification::Method::TaggedSymbol
1853
1867
  )
1854
1868
 
1869
+ # The last four digits of a social security number.
1870
+ SOCIAL_SECURITY_NUMBER_LAST4 =
1871
+ T.let(
1872
+ :social_security_number_last4,
1873
+ Increase::Entity::NaturalPerson::Identification::Method::TaggedSymbol
1874
+ )
1875
+
1855
1876
  # An individual taxpayer identification number (ITIN).
1856
1877
  INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
1857
1878
  T.let(
@@ -2390,6 +2411,13 @@ module Increase
2390
2411
  Increase::Entity::SoleProprietorship::SoleProprietor::Identification::Method::TaggedSymbol
2391
2412
  )
2392
2413
 
2414
+ # The last four digits of a social security number.
2415
+ SOCIAL_SECURITY_NUMBER_LAST4 =
2416
+ T.let(
2417
+ :social_security_number_last4,
2418
+ Increase::Entity::SoleProprietorship::SoleProprietor::Identification::Method::TaggedSymbol
2419
+ )
2420
+
2393
2421
  # An individual taxpayer identification number (ITIN).
2394
2422
  INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
2395
2423
  T.let(
@@ -3086,6 +3114,13 @@ module Increase
3086
3114
  Increase::Entity::Trust::Grantor::Identification::Method::TaggedSymbol
3087
3115
  )
3088
3116
 
3117
+ # The last four digits of a social security number.
3118
+ SOCIAL_SECURITY_NUMBER_LAST4 =
3119
+ T.let(
3120
+ :social_security_number_last4,
3121
+ Increase::Entity::Trust::Grantor::Identification::Method::TaggedSymbol
3122
+ )
3123
+
3089
3124
  # An individual taxpayer identification number (ITIN).
3090
3125
  INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
3091
3126
  T.let(
@@ -3429,6 +3464,13 @@ module Increase
3429
3464
  Increase::Entity::Trust::Trustee::Individual::Identification::Method::TaggedSymbol
3430
3465
  )
3431
3466
 
3467
+ # The last four digits of a social security number.
3468
+ SOCIAL_SECURITY_NUMBER_LAST4 =
3469
+ T.let(
3470
+ :social_security_number_last4,
3471
+ Increase::Entity::Trust::Trustee::Individual::Identification::Method::TaggedSymbol
3472
+ )
3473
+
3432
3474
  # An individual taxpayer identification number (ITIN).
3433
3475
  INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
3434
3476
  T.let(
@@ -351,6 +351,13 @@ module Increase
351
351
  Increase::EntityBeneficialOwner::Individual::Identification::Method::TaggedSymbol
352
352
  )
353
353
 
354
+ # The last four digits of a social security number.
355
+ SOCIAL_SECURITY_NUMBER_LAST4 =
356
+ T.let(
357
+ :social_security_number_last4,
358
+ Increase::EntityBeneficialOwner::Individual::Identification::Method::TaggedSymbol
359
+ )
360
+
354
361
  # An individual taxpayer identification number (ITIN).
355
362
  INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
356
363
  T.let(
@@ -1025,6 +1025,13 @@ module Increase
1025
1025
  Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
1026
1026
  )
1027
1027
 
1028
+ # The last four digits of a social security number.
1029
+ SOCIAL_SECURITY_NUMBER_LAST4 =
1030
+ T.let(
1031
+ :social_security_number_last4,
1032
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
1033
+ )
1034
+
1028
1035
  # An individual taxpayer identification number (ITIN).
1029
1036
  INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
1030
1037
  T.let(