increase 1.288.0 → 1.290.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.
@@ -645,6 +645,34 @@ module Increase
645
645
  end
646
646
  attr_writer :address
647
647
 
648
+ # The identification method for an individual can only be a passport, driver's
649
+ # license, or other document if you've confirmed the individual does not have a US
650
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
651
+ # Number).
652
+ sig { returns(T.nilable(T::Boolean)) }
653
+ attr_reader :confirmed_no_us_tax_id
654
+
655
+ sig { params(confirmed_no_us_tax_id: T::Boolean).void }
656
+ attr_writer :confirmed_no_us_tax_id
657
+
658
+ # A means of verifying the person's identity.
659
+ sig do
660
+ returns(
661
+ T.nilable(
662
+ Increase::EntityUpdateParams::NaturalPerson::Identification
663
+ )
664
+ )
665
+ end
666
+ attr_reader :identification
667
+
668
+ sig do
669
+ params(
670
+ identification:
671
+ Increase::EntityUpdateParams::NaturalPerson::Identification::OrHash
672
+ ).void
673
+ end
674
+ attr_writer :identification
675
+
648
676
  # The legal name of the natural person.
649
677
  sig { returns(T.nilable(String)) }
650
678
  attr_reader :name
@@ -658,6 +686,9 @@ module Increase
658
686
  params(
659
687
  address:
660
688
  Increase::EntityUpdateParams::NaturalPerson::Address::OrHash,
689
+ confirmed_no_us_tax_id: T::Boolean,
690
+ identification:
691
+ Increase::EntityUpdateParams::NaturalPerson::Identification::OrHash,
661
692
  name: String
662
693
  ).returns(T.attached_class)
663
694
  end
@@ -665,6 +696,13 @@ module Increase
665
696
  # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
666
697
  # are disallowed.
667
698
  address: nil,
699
+ # The identification method for an individual can only be a passport, driver's
700
+ # license, or other document if you've confirmed the individual does not have a US
701
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
702
+ # Number).
703
+ confirmed_no_us_tax_id: nil,
704
+ # A means of verifying the person's identity.
705
+ identification: nil,
668
706
  # The legal name of the natural person.
669
707
  name: nil
670
708
  )
@@ -674,6 +712,9 @@ module Increase
674
712
  override.returns(
675
713
  {
676
714
  address: Increase::EntityUpdateParams::NaturalPerson::Address,
715
+ confirmed_no_us_tax_id: T::Boolean,
716
+ identification:
717
+ Increase::EntityUpdateParams::NaturalPerson::Identification,
677
718
  name: String
678
719
  }
679
720
  )
@@ -768,6 +809,389 @@ module Increase
768
809
  def to_hash
769
810
  end
770
811
  end
812
+
813
+ class Identification < Increase::Internal::Type::BaseModel
814
+ OrHash =
815
+ T.type_alias do
816
+ T.any(
817
+ Increase::EntityUpdateParams::NaturalPerson::Identification,
818
+ Increase::Internal::AnyHash
819
+ )
820
+ end
821
+
822
+ # A method that can be used to verify the individual's identity.
823
+ sig do
824
+ returns(
825
+ Increase::EntityUpdateParams::NaturalPerson::Identification::Method::OrSymbol
826
+ )
827
+ end
828
+ attr_accessor :method_
829
+
830
+ # An identification number that can be used to verify the individual's identity,
831
+ # such as a social security number.
832
+ sig { returns(String) }
833
+ attr_accessor :number
834
+
835
+ # Information about the United States driver's license used for identification.
836
+ # Required if `method` is equal to `drivers_license`.
837
+ sig do
838
+ returns(
839
+ T.nilable(
840
+ Increase::EntityUpdateParams::NaturalPerson::Identification::DriversLicense
841
+ )
842
+ )
843
+ end
844
+ attr_reader :drivers_license
845
+
846
+ sig do
847
+ params(
848
+ drivers_license:
849
+ Increase::EntityUpdateParams::NaturalPerson::Identification::DriversLicense::OrHash
850
+ ).void
851
+ end
852
+ attr_writer :drivers_license
853
+
854
+ # Information about the identification document provided. Required if `method` is
855
+ # equal to `other`.
856
+ sig do
857
+ returns(
858
+ T.nilable(
859
+ Increase::EntityUpdateParams::NaturalPerson::Identification::Other
860
+ )
861
+ )
862
+ end
863
+ attr_reader :other
864
+
865
+ sig do
866
+ params(
867
+ other:
868
+ Increase::EntityUpdateParams::NaturalPerson::Identification::Other::OrHash
869
+ ).void
870
+ end
871
+ attr_writer :other
872
+
873
+ # Information about the passport used for identification. Required if `method` is
874
+ # equal to `passport`.
875
+ sig do
876
+ returns(
877
+ T.nilable(
878
+ Increase::EntityUpdateParams::NaturalPerson::Identification::Passport
879
+ )
880
+ )
881
+ end
882
+ attr_reader :passport
883
+
884
+ sig do
885
+ params(
886
+ passport:
887
+ Increase::EntityUpdateParams::NaturalPerson::Identification::Passport::OrHash
888
+ ).void
889
+ end
890
+ attr_writer :passport
891
+
892
+ # A means of verifying the person's identity.
893
+ sig do
894
+ params(
895
+ method_:
896
+ Increase::EntityUpdateParams::NaturalPerson::Identification::Method::OrSymbol,
897
+ number: String,
898
+ drivers_license:
899
+ Increase::EntityUpdateParams::NaturalPerson::Identification::DriversLicense::OrHash,
900
+ other:
901
+ Increase::EntityUpdateParams::NaturalPerson::Identification::Other::OrHash,
902
+ passport:
903
+ Increase::EntityUpdateParams::NaturalPerson::Identification::Passport::OrHash
904
+ ).returns(T.attached_class)
905
+ end
906
+ def self.new(
907
+ # A method that can be used to verify the individual's identity.
908
+ method_:,
909
+ # An identification number that can be used to verify the individual's identity,
910
+ # such as a social security number.
911
+ number:,
912
+ # Information about the United States driver's license used for identification.
913
+ # Required if `method` is equal to `drivers_license`.
914
+ drivers_license: nil,
915
+ # Information about the identification document provided. Required if `method` is
916
+ # equal to `other`.
917
+ other: nil,
918
+ # Information about the passport used for identification. Required if `method` is
919
+ # equal to `passport`.
920
+ passport: nil
921
+ )
922
+ end
923
+
924
+ sig do
925
+ override.returns(
926
+ {
927
+ method_:
928
+ Increase::EntityUpdateParams::NaturalPerson::Identification::Method::OrSymbol,
929
+ number: String,
930
+ drivers_license:
931
+ Increase::EntityUpdateParams::NaturalPerson::Identification::DriversLicense,
932
+ other:
933
+ Increase::EntityUpdateParams::NaturalPerson::Identification::Other,
934
+ passport:
935
+ Increase::EntityUpdateParams::NaturalPerson::Identification::Passport
936
+ }
937
+ )
938
+ end
939
+ def to_hash
940
+ end
941
+
942
+ # A method that can be used to verify the individual's identity.
943
+ module Method
944
+ extend Increase::Internal::Type::Enum
945
+
946
+ TaggedSymbol =
947
+ T.type_alias do
948
+ T.all(
949
+ Symbol,
950
+ Increase::EntityUpdateParams::NaturalPerson::Identification::Method
951
+ )
952
+ end
953
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
954
+
955
+ # A social security number.
956
+ SOCIAL_SECURITY_NUMBER =
957
+ T.let(
958
+ :social_security_number,
959
+ Increase::EntityUpdateParams::NaturalPerson::Identification::Method::TaggedSymbol
960
+ )
961
+
962
+ # An individual taxpayer identification number (ITIN).
963
+ INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
964
+ T.let(
965
+ :individual_taxpayer_identification_number,
966
+ Increase::EntityUpdateParams::NaturalPerson::Identification::Method::TaggedSymbol
967
+ )
968
+
969
+ # A passport number.
970
+ PASSPORT =
971
+ T.let(
972
+ :passport,
973
+ Increase::EntityUpdateParams::NaturalPerson::Identification::Method::TaggedSymbol
974
+ )
975
+
976
+ # A driver's license number.
977
+ DRIVERS_LICENSE =
978
+ T.let(
979
+ :drivers_license,
980
+ Increase::EntityUpdateParams::NaturalPerson::Identification::Method::TaggedSymbol
981
+ )
982
+
983
+ # Another identifying document.
984
+ OTHER =
985
+ T.let(
986
+ :other,
987
+ Increase::EntityUpdateParams::NaturalPerson::Identification::Method::TaggedSymbol
988
+ )
989
+
990
+ sig do
991
+ override.returns(
992
+ T::Array[
993
+ Increase::EntityUpdateParams::NaturalPerson::Identification::Method::TaggedSymbol
994
+ ]
995
+ )
996
+ end
997
+ def self.values
998
+ end
999
+ end
1000
+
1001
+ class DriversLicense < Increase::Internal::Type::BaseModel
1002
+ OrHash =
1003
+ T.type_alias do
1004
+ T.any(
1005
+ Increase::EntityUpdateParams::NaturalPerson::Identification::DriversLicense,
1006
+ Increase::Internal::AnyHash
1007
+ )
1008
+ end
1009
+
1010
+ # The driver's license's expiration date in YYYY-MM-DD format.
1011
+ sig { returns(Date) }
1012
+ attr_accessor :expiration_date
1013
+
1014
+ # The identifier of the File containing the front of the driver's license.
1015
+ sig { returns(String) }
1016
+ attr_accessor :file_id
1017
+
1018
+ # The state that issued the provided driver's license.
1019
+ sig { returns(String) }
1020
+ attr_accessor :state
1021
+
1022
+ # The identifier of the File containing the back of the driver's license.
1023
+ sig { returns(T.nilable(String)) }
1024
+ attr_reader :back_file_id
1025
+
1026
+ sig { params(back_file_id: String).void }
1027
+ attr_writer :back_file_id
1028
+
1029
+ # Information about the United States driver's license used for identification.
1030
+ # Required if `method` is equal to `drivers_license`.
1031
+ sig do
1032
+ params(
1033
+ expiration_date: Date,
1034
+ file_id: String,
1035
+ state: String,
1036
+ back_file_id: String
1037
+ ).returns(T.attached_class)
1038
+ end
1039
+ def self.new(
1040
+ # The driver's license's expiration date in YYYY-MM-DD format.
1041
+ expiration_date:,
1042
+ # The identifier of the File containing the front of the driver's license.
1043
+ file_id:,
1044
+ # The state that issued the provided driver's license.
1045
+ state:,
1046
+ # The identifier of the File containing the back of the driver's license.
1047
+ back_file_id: nil
1048
+ )
1049
+ end
1050
+
1051
+ sig do
1052
+ override.returns(
1053
+ {
1054
+ expiration_date: Date,
1055
+ file_id: String,
1056
+ state: String,
1057
+ back_file_id: String
1058
+ }
1059
+ )
1060
+ end
1061
+ def to_hash
1062
+ end
1063
+ end
1064
+
1065
+ class Other < Increase::Internal::Type::BaseModel
1066
+ OrHash =
1067
+ T.type_alias do
1068
+ T.any(
1069
+ Increase::EntityUpdateParams::NaturalPerson::Identification::Other,
1070
+ Increase::Internal::AnyHash
1071
+ )
1072
+ end
1073
+
1074
+ # The two-character ISO 3166-1 code representing the country that issued the
1075
+ # document (e.g., `US`).
1076
+ sig { returns(String) }
1077
+ attr_accessor :country
1078
+
1079
+ # A description of the document submitted.
1080
+ sig { returns(String) }
1081
+ attr_accessor :description
1082
+
1083
+ # The identifier of the File containing the front of the document.
1084
+ sig { returns(String) }
1085
+ attr_accessor :file_id
1086
+
1087
+ # The identifier of the File containing the back of the document. Not every
1088
+ # document has a reverse side.
1089
+ sig { returns(T.nilable(String)) }
1090
+ attr_reader :back_file_id
1091
+
1092
+ sig { params(back_file_id: String).void }
1093
+ attr_writer :back_file_id
1094
+
1095
+ # The document's expiration date in YYYY-MM-DD format.
1096
+ sig { returns(T.nilable(Date)) }
1097
+ attr_reader :expiration_date
1098
+
1099
+ sig { params(expiration_date: Date).void }
1100
+ attr_writer :expiration_date
1101
+
1102
+ # Information about the identification document provided. Required if `method` is
1103
+ # equal to `other`.
1104
+ sig do
1105
+ params(
1106
+ country: String,
1107
+ description: String,
1108
+ file_id: String,
1109
+ back_file_id: String,
1110
+ expiration_date: Date
1111
+ ).returns(T.attached_class)
1112
+ end
1113
+ def self.new(
1114
+ # The two-character ISO 3166-1 code representing the country that issued the
1115
+ # document (e.g., `US`).
1116
+ country:,
1117
+ # A description of the document submitted.
1118
+ description:,
1119
+ # The identifier of the File containing the front of the document.
1120
+ file_id:,
1121
+ # The identifier of the File containing the back of the document. Not every
1122
+ # document has a reverse side.
1123
+ back_file_id: nil,
1124
+ # The document's expiration date in YYYY-MM-DD format.
1125
+ expiration_date: nil
1126
+ )
1127
+ end
1128
+
1129
+ sig do
1130
+ override.returns(
1131
+ {
1132
+ country: String,
1133
+ description: String,
1134
+ file_id: String,
1135
+ back_file_id: String,
1136
+ expiration_date: Date
1137
+ }
1138
+ )
1139
+ end
1140
+ def to_hash
1141
+ end
1142
+ end
1143
+
1144
+ class Passport < Increase::Internal::Type::BaseModel
1145
+ OrHash =
1146
+ T.type_alias do
1147
+ T.any(
1148
+ Increase::EntityUpdateParams::NaturalPerson::Identification::Passport,
1149
+ Increase::Internal::AnyHash
1150
+ )
1151
+ end
1152
+
1153
+ # The two-character ISO 3166-1 code representing the country that issued the
1154
+ # document (e.g., `US`).
1155
+ sig { returns(String) }
1156
+ attr_accessor :country
1157
+
1158
+ # The passport's expiration date in YYYY-MM-DD format.
1159
+ sig { returns(Date) }
1160
+ attr_accessor :expiration_date
1161
+
1162
+ # The identifier of the File containing the passport.
1163
+ sig { returns(String) }
1164
+ attr_accessor :file_id
1165
+
1166
+ # Information about the passport used for identification. Required if `method` is
1167
+ # equal to `passport`.
1168
+ sig do
1169
+ params(
1170
+ country: String,
1171
+ expiration_date: Date,
1172
+ file_id: String
1173
+ ).returns(T.attached_class)
1174
+ end
1175
+ def self.new(
1176
+ # The two-character ISO 3166-1 code representing the country that issued the
1177
+ # document (e.g., `US`).
1178
+ country:,
1179
+ # The passport's expiration date in YYYY-MM-DD format.
1180
+ expiration_date:,
1181
+ # The identifier of the File containing the passport.
1182
+ file_id:
1183
+ )
1184
+ end
1185
+
1186
+ sig do
1187
+ override.returns(
1188
+ { country: String, expiration_date: Date, file_id: String }
1189
+ )
1190
+ end
1191
+ def to_hash
1192
+ end
1193
+ end
1194
+ end
771
1195
  end
772
1196
 
773
1197
  class RiskRating < Increase::Internal::Type::BaseModel
@@ -62,18 +62,6 @@ module Increase
62
62
  end
63
63
  attr_writer :account_verification_letter
64
64
 
65
- # Options for the created export. Required if `category` is equal to
66
- # `balance_csv`.
67
- sig { returns(T.nilable(Increase::ExportCreateParams::BalanceCsv)) }
68
- attr_reader :balance_csv
69
-
70
- sig do
71
- params(
72
- balance_csv: Increase::ExportCreateParams::BalanceCsv::OrHash
73
- ).void
74
- end
75
- attr_writer :balance_csv
76
-
77
65
  # Options for the created export. Required if `category` is equal to
78
66
  # `bookkeeping_account_balance_csv`.
79
67
  sig do
@@ -172,7 +160,6 @@ module Increase
172
160
  Increase::ExportCreateParams::AccountStatementOfx::OrHash,
173
161
  account_verification_letter:
174
162
  Increase::ExportCreateParams::AccountVerificationLetter::OrHash,
175
- balance_csv: Increase::ExportCreateParams::BalanceCsv::OrHash,
176
163
  bookkeeping_account_balance_csv:
177
164
  Increase::ExportCreateParams::BookkeepingAccountBalanceCsv::OrHash,
178
165
  daily_account_balance_csv:
@@ -199,9 +186,6 @@ module Increase
199
186
  # `account_verification_letter`.
200
187
  account_verification_letter: nil,
201
188
  # Options for the created export. Required if `category` is equal to
202
- # `balance_csv`.
203
- balance_csv: nil,
204
- # Options for the created export. Required if `category` is equal to
205
189
  # `bookkeeping_account_balance_csv`.
206
190
  bookkeeping_account_balance_csv: nil,
207
191
  # Options for the created export. Required if `category` is equal to
@@ -234,7 +218,6 @@ module Increase
234
218
  Increase::ExportCreateParams::AccountStatementOfx,
235
219
  account_verification_letter:
236
220
  Increase::ExportCreateParams::AccountVerificationLetter,
237
- balance_csv: Increase::ExportCreateParams::BalanceCsv,
238
221
  bookkeeping_account_balance_csv:
239
222
  Increase::ExportCreateParams::BookkeepingAccountBalanceCsv,
240
223
  daily_account_balance_csv:
@@ -557,147 +540,6 @@ module Increase
557
540
  end
558
541
  end
559
542
 
560
- class BalanceCsv < Increase::Internal::Type::BaseModel
561
- OrHash =
562
- T.type_alias do
563
- T.any(
564
- Increase::ExportCreateParams::BalanceCsv,
565
- Increase::Internal::AnyHash
566
- )
567
- end
568
-
569
- # Filter exported Balances to the specified Account.
570
- sig { returns(T.nilable(String)) }
571
- attr_reader :account_id
572
-
573
- sig { params(account_id: String).void }
574
- attr_writer :account_id
575
-
576
- # Filter results by time range on the `created_at` attribute.
577
- sig do
578
- returns(
579
- T.nilable(Increase::ExportCreateParams::BalanceCsv::CreatedAt)
580
- )
581
- end
582
- attr_reader :created_at
583
-
584
- sig do
585
- params(
586
- created_at:
587
- Increase::ExportCreateParams::BalanceCsv::CreatedAt::OrHash
588
- ).void
589
- end
590
- attr_writer :created_at
591
-
592
- # Options for the created export. Required if `category` is equal to
593
- # `balance_csv`.
594
- sig do
595
- params(
596
- account_id: String,
597
- created_at:
598
- Increase::ExportCreateParams::BalanceCsv::CreatedAt::OrHash
599
- ).returns(T.attached_class)
600
- end
601
- def self.new(
602
- # Filter exported Balances to the specified Account.
603
- account_id: nil,
604
- # Filter results by time range on the `created_at` attribute.
605
- created_at: nil
606
- )
607
- end
608
-
609
- sig do
610
- override.returns(
611
- {
612
- account_id: String,
613
- created_at: Increase::ExportCreateParams::BalanceCsv::CreatedAt
614
- }
615
- )
616
- end
617
- def to_hash
618
- end
619
-
620
- class CreatedAt < Increase::Internal::Type::BaseModel
621
- OrHash =
622
- T.type_alias do
623
- T.any(
624
- Increase::ExportCreateParams::BalanceCsv::CreatedAt,
625
- Increase::Internal::AnyHash
626
- )
627
- end
628
-
629
- # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
630
- # timestamp.
631
- sig { returns(T.nilable(Time)) }
632
- attr_reader :after
633
-
634
- sig { params(after: Time).void }
635
- attr_writer :after
636
-
637
- # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
638
- # timestamp.
639
- sig { returns(T.nilable(Time)) }
640
- attr_reader :before
641
-
642
- sig { params(before: Time).void }
643
- attr_writer :before
644
-
645
- # Return results on or after this
646
- # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
647
- sig { returns(T.nilable(Time)) }
648
- attr_reader :on_or_after
649
-
650
- sig { params(on_or_after: Time).void }
651
- attr_writer :on_or_after
652
-
653
- # Return results on or before this
654
- # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
655
- sig { returns(T.nilable(Time)) }
656
- attr_reader :on_or_before
657
-
658
- sig { params(on_or_before: Time).void }
659
- attr_writer :on_or_before
660
-
661
- # Filter results by time range on the `created_at` attribute.
662
- sig do
663
- params(
664
- after: Time,
665
- before: Time,
666
- on_or_after: Time,
667
- on_or_before: Time
668
- ).returns(T.attached_class)
669
- end
670
- def self.new(
671
- # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
672
- # timestamp.
673
- after: nil,
674
- # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
675
- # timestamp.
676
- before: nil,
677
- # Return results on or after this
678
- # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
679
- on_or_after: nil,
680
- # Return results on or before this
681
- # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
682
- on_or_before: nil
683
- )
684
- end
685
-
686
- sig do
687
- override.returns(
688
- {
689
- after: Time,
690
- before: Time,
691
- on_or_after: Time,
692
- on_or_before: Time
693
- }
694
- )
695
- end
696
- def to_hash
697
- end
698
- end
699
- end
700
-
701
543
  class BookkeepingAccountBalanceCsv < Increase::Internal::Type::BaseModel
702
544
  OrHash =
703
545
  T.type_alias do
@@ -13,7 +13,6 @@ module Increase
13
13
  Increase::ExportCreateParams::AccountStatementOfx::OrHash,
14
14
  account_verification_letter:
15
15
  Increase::ExportCreateParams::AccountVerificationLetter::OrHash,
16
- balance_csv: Increase::ExportCreateParams::BalanceCsv::OrHash,
17
16
  bookkeeping_account_balance_csv:
18
17
  Increase::ExportCreateParams::BookkeepingAccountBalanceCsv::OrHash,
19
18
  daily_account_balance_csv:
@@ -40,9 +39,6 @@ module Increase
40
39
  # `account_verification_letter`.
41
40
  account_verification_letter: nil,
42
41
  # Options for the created export. Required if `category` is equal to
43
- # `balance_csv`.
44
- balance_csv: nil,
45
- # Options for the created export. Required if `category` is equal to
46
42
  # `bookkeeping_account_balance_csv`.
47
43
  bookkeeping_account_balance_csv: nil,
48
44
  # Options for the created export. Required if `category` is equal to