increase 1.347.0 → 1.349.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 (124) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/account_create_params.rb +15 -15
  4. data/lib/increase/models/ach_prenotification_create_params.rb +2 -2
  5. data/lib/increase/models/ach_transfer.rb +2 -2
  6. data/lib/increase/models/ach_transfer_create_params.rb +1 -24
  7. data/lib/increase/models/balance_lookup.rb +49 -1
  8. data/lib/increase/models/beneficial_owner_update_params.rb +9 -1
  9. data/lib/increase/models/card.rb +43 -1
  10. data/lib/increase/models/card_create_params.rb +42 -1
  11. data/lib/increase/models/card_dispute.rb +1 -1
  12. data/lib/increase/models/card_dispute_list_params.rb +1 -1
  13. data/lib/increase/models/card_payment.rb +18 -1
  14. data/lib/increase/models/check_transfer.rb +13 -1
  15. data/lib/increase/models/check_transfer_create_params.rb +25 -13
  16. data/lib/increase/models/entity.rb +315 -5
  17. data/lib/increase/models/entity_update_params.rb +754 -1
  18. data/lib/increase/models/event.rb +12 -0
  19. data/lib/increase/models/event_list_params.rb +12 -0
  20. data/lib/increase/models/event_subscription.rb +12 -0
  21. data/lib/increase/models/event_subscription_create_params.rb +12 -0
  22. data/lib/increase/models/file.rb +7 -6
  23. data/lib/increase/models/inbound_ach_transfer.rb +6 -6
  24. data/lib/increase/models/inbound_check_deposit.rb +5 -2
  25. data/lib/increase/models/inbound_fednow_transfer.rb +18 -1
  26. data/lib/increase/models/pending_transaction.rb +25 -8
  27. data/lib/increase/models/pending_transaction_list_params.rb +1 -1
  28. data/lib/increase/models/physical_card_create_params.rb +6 -3
  29. data/lib/increase/models/real_time_decision.rb +18 -1
  30. data/lib/increase/models/real_time_payments_transfer.rb +30 -19
  31. data/lib/increase/models/real_time_payments_transfer_create_params.rb +12 -1
  32. data/lib/increase/models/simulations/card_dispute_action_params.rb +30 -1
  33. data/lib/increase/models/simulations/entity_update_validation_params.rb +3 -0
  34. data/lib/increase/models/simulations/inbound_check_deposit_adjustment_params.rb +8 -11
  35. data/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb +18 -18
  36. data/lib/increase/models/transaction.rb +5 -2
  37. data/lib/increase/models/unwrap_webhook_event.rb +12 -0
  38. data/lib/increase/models/wire_transfer_create_params.rb +100 -42
  39. data/lib/increase/resources/ach_prenotifications.rb +1 -1
  40. data/lib/increase/resources/ach_transfers.rb +1 -4
  41. data/lib/increase/resources/beneficial_owners.rb +3 -1
  42. data/lib/increase/resources/cards.rb +5 -1
  43. data/lib/increase/resources/physical_cards.rb +2 -1
  44. data/lib/increase/resources/real_time_payments_transfers.rb +5 -1
  45. data/lib/increase/resources/simulations/inbound_check_deposits.rb +4 -1
  46. data/lib/increase/version.rb +1 -1
  47. data/rbi/increase/models/account_create_params.rbi +37 -21
  48. data/rbi/increase/models/ach_prenotification_create_params.rbi +2 -2
  49. data/rbi/increase/models/ach_transfer.rbi +2 -2
  50. data/rbi/increase/models/ach_transfer_create_params.rbi +0 -59
  51. data/rbi/increase/models/balance_lookup.rbi +48 -0
  52. data/rbi/increase/models/beneficial_owner_update_params.rbi +11 -0
  53. data/rbi/increase/models/card.rbi +63 -0
  54. data/rbi/increase/models/card_create_params.rbi +65 -0
  55. data/rbi/increase/models/card_dispute.rbi +1 -1
  56. data/rbi/increase/models/card_dispute_list_params.rbi +1 -1
  57. data/rbi/increase/models/card_payment.rbi +16 -0
  58. data/rbi/increase/models/check_transfer.rbi +15 -0
  59. data/rbi/increase/models/check_transfer_create_params.rbi +26 -12
  60. data/rbi/increase/models/entity.rbi +552 -3
  61. data/rbi/increase/models/entity_update_params.rbi +1326 -3
  62. data/rbi/increase/models/event.rbi +28 -0
  63. data/rbi/increase/models/event_list_params.rbi +28 -0
  64. data/rbi/increase/models/event_subscription.rbi +28 -0
  65. data/rbi/increase/models/event_subscription_create_params.rbi +28 -0
  66. data/rbi/increase/models/file.rbi +7 -6
  67. data/rbi/increase/models/inbound_ach_transfer.rbi +6 -6
  68. data/rbi/increase/models/inbound_check_deposit.rbi +4 -2
  69. data/rbi/increase/models/inbound_fednow_transfer.rbi +16 -0
  70. data/rbi/increase/models/pending_transaction.rbi +23 -7
  71. data/rbi/increase/models/pending_transaction_list_params.rbi +1 -1
  72. data/rbi/increase/models/physical_card_create_params.rbi +6 -3
  73. data/rbi/increase/models/real_time_decision.rbi +16 -0
  74. data/rbi/increase/models/real_time_payments_transfer.rbi +29 -18
  75. data/rbi/increase/models/real_time_payments_transfer_create_params.rbi +15 -0
  76. data/rbi/increase/models/simulations/card_dispute_action_params.rbi +60 -0
  77. data/rbi/increase/models/simulations/entity_update_validation_params.rbi +7 -0
  78. data/rbi/increase/models/simulations/inbound_check_deposit_adjustment_params.rbi +8 -23
  79. data/rbi/increase/models/simulations/real_time_payments_transfer_complete_params.rbi +18 -18
  80. data/rbi/increase/models/transaction.rbi +4 -2
  81. data/rbi/increase/models/unwrap_webhook_event.rbi +28 -0
  82. data/rbi/increase/models/wire_transfer_create_params.rbi +146 -62
  83. data/rbi/increase/resources/ach_prenotifications.rbi +1 -1
  84. data/rbi/increase/resources/ach_transfers.rbi +0 -4
  85. data/rbi/increase/resources/beneficial_owners.rbi +3 -0
  86. data/rbi/increase/resources/cards.rbi +4 -0
  87. data/rbi/increase/resources/physical_cards.rbi +2 -1
  88. data/rbi/increase/resources/real_time_payments_transfers.rbi +4 -0
  89. data/rbi/increase/resources/simulations/inbound_check_deposits.rbi +4 -1
  90. data/sig/increase/models/account_create_params.rbs +20 -12
  91. data/sig/increase/models/ach_transfer_create_params.rbs +1 -24
  92. data/sig/increase/models/balance_lookup.rbs +30 -0
  93. data/sig/increase/models/beneficial_owner_update_params.rbs +7 -0
  94. data/sig/increase/models/card.rbs +19 -0
  95. data/sig/increase/models/card_create_params.rbs +25 -0
  96. data/sig/increase/models/card_dispute.rbs +1 -1
  97. data/sig/increase/models/card_dispute_list_params.rbs +1 -1
  98. data/sig/increase/models/card_payment.rbs +5 -0
  99. data/sig/increase/models/check_transfer.rbs +9 -0
  100. data/sig/increase/models/check_transfer_create_params.rbs +7 -0
  101. data/sig/increase/models/entity.rbs +248 -5
  102. data/sig/increase/models/entity_update_params.rbs +585 -3
  103. data/sig/increase/models/event.rbs +16 -0
  104. data/sig/increase/models/event_list_params.rbs +16 -0
  105. data/sig/increase/models/event_subscription.rbs +16 -0
  106. data/sig/increase/models/event_subscription_create_params.rbs +16 -0
  107. data/sig/increase/models/inbound_ach_transfer.rbs +2 -2
  108. data/sig/increase/models/inbound_fednow_transfer.rbs +10 -0
  109. data/sig/increase/models/pending_transaction.rbs +6 -1
  110. data/sig/increase/models/pending_transaction_list_params.rbs +1 -1
  111. data/sig/increase/models/real_time_decision.rbs +5 -0
  112. data/sig/increase/models/real_time_payments_transfer.rbs +23 -18
  113. data/sig/increase/models/real_time_payments_transfer_create_params.rbs +7 -0
  114. data/sig/increase/models/simulations/card_dispute_action_params.rbs +23 -0
  115. data/sig/increase/models/simulations/entity_update_validation_params.rbs +4 -0
  116. data/sig/increase/models/simulations/inbound_check_deposit_adjustment_params.rbs +1 -15
  117. data/sig/increase/models/simulations/real_time_payments_transfer_complete_params.rbs +18 -18
  118. data/sig/increase/models/unwrap_webhook_event.rbs +16 -0
  119. data/sig/increase/models/wire_transfer_create_params.rbs +78 -32
  120. data/sig/increase/resources/ach_transfers.rbs +0 -1
  121. data/sig/increase/resources/beneficial_owners.rbs +1 -0
  122. data/sig/increase/resources/cards.rbs +1 -0
  123. data/sig/increase/resources/real_time_payments_transfers.rbs +1 -0
  124. metadata +2 -2
@@ -848,13 +848,27 @@ module Increase
848
848
  # @return [Increase::Models::EntityUpdateParams::Trust::Address, nil]
849
849
  optional :address, -> { Increase::EntityUpdateParams::Trust::Address }
850
850
 
851
+ # @!attribute grantor
852
+ # The grantor of the trust. If you specify this parameter, the trust's existing
853
+ # grantor will be archived and replaced with the grantor you provide.
854
+ #
855
+ # @return [Increase::Models::EntityUpdateParams::Trust::Grantor, nil]
856
+ optional :grantor, -> { Increase::EntityUpdateParams::Trust::Grantor }
857
+
851
858
  # @!attribute name
852
859
  # The legal name of the trust.
853
860
  #
854
861
  # @return [String, nil]
855
862
  optional :name, String
856
863
 
857
- # @!method initialize(address: nil, name: nil)
864
+ # @!attribute trustees
865
+ # The trustees of the trust. If you specify this parameter, the trust's existing
866
+ # trustees will be archived and replaced with the trustees you provide.
867
+ #
868
+ # @return [Array<Increase::Models::EntityUpdateParams::Trust::Trustee>, nil]
869
+ optional :trustees, -> { Increase::Internal::Type::ArrayOf[Increase::EntityUpdateParams::Trust::Trustee] }
870
+
871
+ # @!method initialize(address: nil, grantor: nil, name: nil, trustees: nil)
858
872
  # Details of the trust entity to update. If you specify this parameter and the
859
873
  # entity is not a trust, the request will fail.
860
874
  #
@@ -862,7 +876,15 @@ module Increase
862
876
  # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
863
877
  # are disallowed.
864
878
  #
879
+ # @param grantor [Increase::Models::EntityUpdateParams::Trust::Grantor]
880
+ # The grantor of the trust. If you specify this parameter, the trust's existing
881
+ # grantor will be archived and replaced with the grantor you provide.
882
+ #
865
883
  # @param name [String] The legal name of the trust.
884
+ #
885
+ # @param trustees [Array<Increase::Models::EntityUpdateParams::Trust::Trustee>]
886
+ # The trustees of the trust. If you specify this parameter, the trust's existing
887
+ # trustees will be archived and replaced with the trustees you provide.
866
888
 
867
889
  # @see Increase::Models::EntityUpdateParams::Trust#address
868
890
  class Address < Increase::Internal::Type::BaseModel
@@ -913,6 +935,737 @@ module Increase
913
935
  #
914
936
  # @param line2 [String] The second line of the address. This might be the floor or room number.
915
937
  end
938
+
939
+ # @see Increase::Models::EntityUpdateParams::Trust#grantor
940
+ class Grantor < Increase::Internal::Type::BaseModel
941
+ # @!attribute address
942
+ # The grantor's physical address. Mail receiving locations like PO Boxes and PMB's
943
+ # are disallowed.
944
+ #
945
+ # @return [Increase::Models::EntityUpdateParams::Trust::Grantor::Address]
946
+ required :address, -> { Increase::EntityUpdateParams::Trust::Grantor::Address }
947
+
948
+ # @!attribute date_of_birth
949
+ # The grantor's date of birth in YYYY-MM-DD format.
950
+ #
951
+ # @return [Date]
952
+ required :date_of_birth, Date
953
+
954
+ # @!attribute identification
955
+ # A means of verifying the person's identity.
956
+ #
957
+ # @return [Increase::Models::EntityUpdateParams::Trust::Grantor::Identification]
958
+ required :identification, -> { Increase::EntityUpdateParams::Trust::Grantor::Identification }
959
+
960
+ # @!attribute name
961
+ # The grantor's legal name.
962
+ #
963
+ # @return [String]
964
+ required :name, String
965
+
966
+ # @!attribute confirmed_no_us_tax_id
967
+ # The identification method for an individual can only be a passport, driver's
968
+ # license, or other document if you've confirmed the individual does not have a US
969
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
970
+ # Number).
971
+ #
972
+ # @return [Boolean, nil]
973
+ optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
974
+
975
+ # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil)
976
+ # The grantor of the trust. If you specify this parameter, the trust's existing
977
+ # grantor will be archived and replaced with the grantor you provide.
978
+ #
979
+ # @param address [Increase::Models::EntityUpdateParams::Trust::Grantor::Address]
980
+ # The grantor's physical address. Mail receiving locations like PO Boxes and PMB's
981
+ # are disallowed.
982
+ #
983
+ # @param date_of_birth [Date] The grantor's date of birth in YYYY-MM-DD format.
984
+ #
985
+ # @param identification [Increase::Models::EntityUpdateParams::Trust::Grantor::Identification]
986
+ # A means of verifying the person's identity.
987
+ #
988
+ # @param name [String] The grantor's legal name.
989
+ #
990
+ # @param confirmed_no_us_tax_id [Boolean]
991
+ # The identification method for an individual can only be a passport, driver's
992
+ # license, or other document if you've confirmed the individual does not have a US
993
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
994
+ # Number).
995
+
996
+ # @see Increase::Models::EntityUpdateParams::Trust::Grantor#address
997
+ class Address < Increase::Internal::Type::BaseModel
998
+ # @!attribute city
999
+ # The city, district, town, or village of the address.
1000
+ #
1001
+ # @return [String]
1002
+ required :city, String
1003
+
1004
+ # @!attribute country
1005
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1006
+ #
1007
+ # Defaults to `US`.
1008
+ #
1009
+ # @return [String]
1010
+ required :country, String
1011
+
1012
+ # @!attribute line1
1013
+ # The first line of the address. This is usually the street number and street.
1014
+ #
1015
+ # @return [String]
1016
+ required :line1, String
1017
+
1018
+ # @!attribute line2
1019
+ # The second line of the address. This might be the floor or room number.
1020
+ #
1021
+ # @return [String, nil]
1022
+ optional :line2, String
1023
+
1024
+ # @!attribute state
1025
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1026
+ # state, province, or region of the address. Required in certain countries.
1027
+ #
1028
+ # @return [String, nil]
1029
+ optional :state, String
1030
+
1031
+ # @!attribute zip
1032
+ # The ZIP or postal code of the address. Required in certain countries.
1033
+ #
1034
+ # @return [String, nil]
1035
+ optional :zip, String
1036
+
1037
+ # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
1038
+ # The grantor's physical address. Mail receiving locations like PO Boxes and PMB's
1039
+ # are disallowed.
1040
+ #
1041
+ # @param city [String] The city, district, town, or village of the address.
1042
+ #
1043
+ # @param country [String]
1044
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1045
+ #
1046
+ # Defaults to `US`.
1047
+ #
1048
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
1049
+ #
1050
+ # @param line2 [String] The second line of the address. This might be the floor or room number.
1051
+ #
1052
+ # @param state [String]
1053
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1054
+ # state, province, or region of the address. Required in certain countries.
1055
+ #
1056
+ # @param zip [String] The ZIP or postal code of the address. Required in certain countries.
1057
+ end
1058
+
1059
+ # @see Increase::Models::EntityUpdateParams::Trust::Grantor#identification
1060
+ class Identification < Increase::Internal::Type::BaseModel
1061
+ # @!attribute method_
1062
+ # A method that can be used to verify the individual's identity.
1063
+ #
1064
+ # Defaults to `social_security_number`.
1065
+ #
1066
+ # @return [Symbol, Increase::Models::EntityUpdateParams::Trust::Grantor::Identification::Method]
1067
+ required :method_,
1068
+ enum: -> { Increase::EntityUpdateParams::Trust::Grantor::Identification::Method },
1069
+ api_name: :method
1070
+
1071
+ # @!attribute number
1072
+ # An identification number that can be used to verify the individual's identity,
1073
+ # such as a social security number. For Social Security Numbers and Individual
1074
+ # Taxpayer Identification Numbers, submit nine digits with no dashes or other
1075
+ # separators. When testing in sandbox, use one of our
1076
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
1077
+ #
1078
+ # @return [String]
1079
+ required :number, String
1080
+
1081
+ # @!attribute drivers_license
1082
+ # Information about the United States driver's license used for identification.
1083
+ # Required if `method` is equal to `drivers_license`.
1084
+ #
1085
+ # @return [Increase::Models::EntityUpdateParams::Trust::Grantor::Identification::DriversLicense, nil]
1086
+ optional :drivers_license,
1087
+ -> { Increase::EntityUpdateParams::Trust::Grantor::Identification::DriversLicense }
1088
+
1089
+ # @!attribute other
1090
+ # Information about the identification document provided. Required if `method` is
1091
+ # equal to `other`.
1092
+ #
1093
+ # @return [Increase::Models::EntityUpdateParams::Trust::Grantor::Identification::Other, nil]
1094
+ optional :other, -> { Increase::EntityUpdateParams::Trust::Grantor::Identification::Other }
1095
+
1096
+ # @!attribute passport
1097
+ # Information about the passport used for identification. Required if `method` is
1098
+ # equal to `passport`.
1099
+ #
1100
+ # @return [Increase::Models::EntityUpdateParams::Trust::Grantor::Identification::Passport, nil]
1101
+ optional :passport, -> { Increase::EntityUpdateParams::Trust::Grantor::Identification::Passport }
1102
+
1103
+ # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
1104
+ # A means of verifying the person's identity.
1105
+ #
1106
+ # @param method_ [Symbol, Increase::Models::EntityUpdateParams::Trust::Grantor::Identification::Method]
1107
+ # A method that can be used to verify the individual's identity.
1108
+ #
1109
+ # Defaults to `social_security_number`.
1110
+ #
1111
+ # @param number [String]
1112
+ # An identification number that can be used to verify the individual's identity,
1113
+ # such as a social security number. For Social Security Numbers and Individual
1114
+ # Taxpayer Identification Numbers, submit nine digits with no dashes or other
1115
+ # separators. When testing in sandbox, use one of our
1116
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
1117
+ #
1118
+ # @param drivers_license [Increase::Models::EntityUpdateParams::Trust::Grantor::Identification::DriversLicense]
1119
+ # Information about the United States driver's license used for identification.
1120
+ # Required if `method` is equal to `drivers_license`.
1121
+ #
1122
+ # @param other [Increase::Models::EntityUpdateParams::Trust::Grantor::Identification::Other]
1123
+ # Information about the identification document provided. Required if `method` is
1124
+ # equal to `other`.
1125
+ #
1126
+ # @param passport [Increase::Models::EntityUpdateParams::Trust::Grantor::Identification::Passport]
1127
+ # Information about the passport used for identification. Required if `method` is
1128
+ # equal to `passport`.
1129
+
1130
+ # A method that can be used to verify the individual's identity.
1131
+ #
1132
+ # Defaults to `social_security_number`.
1133
+ #
1134
+ # @see Increase::Models::EntityUpdateParams::Trust::Grantor::Identification#method_
1135
+ module Method
1136
+ extend Increase::Internal::Type::Enum
1137
+
1138
+ # A social security number.
1139
+ SOCIAL_SECURITY_NUMBER = :social_security_number
1140
+
1141
+ # An individual taxpayer identification number (ITIN).
1142
+ INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
1143
+
1144
+ # A passport number.
1145
+ PASSPORT = :passport
1146
+
1147
+ # A driver's license number.
1148
+ DRIVERS_LICENSE = :drivers_license
1149
+
1150
+ # Another identifying document.
1151
+ OTHER = :other
1152
+
1153
+ # @!method self.values
1154
+ # @return [Array<Symbol>]
1155
+ end
1156
+
1157
+ # @see Increase::Models::EntityUpdateParams::Trust::Grantor::Identification#drivers_license
1158
+ class DriversLicense < Increase::Internal::Type::BaseModel
1159
+ # @!attribute expiration_date
1160
+ # The driver's license's expiration date in YYYY-MM-DD format.
1161
+ #
1162
+ # @return [Date]
1163
+ required :expiration_date, Date
1164
+
1165
+ # @!attribute file_id
1166
+ # The identifier of the File containing the front of the driver's license.
1167
+ #
1168
+ # @return [String]
1169
+ required :file_id, String
1170
+
1171
+ # @!attribute state
1172
+ # The state that issued the provided driver's license.
1173
+ #
1174
+ # @return [String]
1175
+ required :state, String
1176
+
1177
+ # @!attribute back_file_id
1178
+ # The identifier of the File containing the back of the driver's license.
1179
+ #
1180
+ # @return [String, nil]
1181
+ optional :back_file_id, String
1182
+
1183
+ # @!method initialize(expiration_date:, file_id:, state:, back_file_id: nil)
1184
+ # Information about the United States driver's license used for identification.
1185
+ # Required if `method` is equal to `drivers_license`.
1186
+ #
1187
+ # @param expiration_date [Date] The driver's license's expiration date in YYYY-MM-DD format.
1188
+ #
1189
+ # @param file_id [String] The identifier of the File containing the front of the driver's license.
1190
+ #
1191
+ # @param state [String] The state that issued the provided driver's license.
1192
+ #
1193
+ # @param back_file_id [String] The identifier of the File containing the back of the driver's license.
1194
+ end
1195
+
1196
+ # @see Increase::Models::EntityUpdateParams::Trust::Grantor::Identification#other
1197
+ class Other < Increase::Internal::Type::BaseModel
1198
+ # @!attribute country
1199
+ # The two-character ISO 3166-1 code representing the country that issued the
1200
+ # document (e.g., `US`).
1201
+ #
1202
+ # @return [String]
1203
+ required :country, String
1204
+
1205
+ # @!attribute description
1206
+ # A description of the document submitted.
1207
+ #
1208
+ # @return [String]
1209
+ required :description, String
1210
+
1211
+ # @!attribute file_id
1212
+ # The identifier of the File containing the front of the document.
1213
+ #
1214
+ # @return [String]
1215
+ required :file_id, String
1216
+
1217
+ # @!attribute back_file_id
1218
+ # The identifier of the File containing the back of the document. Not every
1219
+ # document has a reverse side.
1220
+ #
1221
+ # @return [String, nil]
1222
+ optional :back_file_id, String
1223
+
1224
+ # @!attribute expiration_date
1225
+ # The document's expiration date in YYYY-MM-DD format.
1226
+ #
1227
+ # @return [Date, nil]
1228
+ optional :expiration_date, Date
1229
+
1230
+ # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil)
1231
+ # Information about the identification document provided. Required if `method` is
1232
+ # equal to `other`.
1233
+ #
1234
+ # @param country [String]
1235
+ # The two-character ISO 3166-1 code representing the country that issued the
1236
+ # document (e.g., `US`).
1237
+ #
1238
+ # @param description [String] A description of the document submitted.
1239
+ #
1240
+ # @param file_id [String] The identifier of the File containing the front of the document.
1241
+ #
1242
+ # @param back_file_id [String]
1243
+ # The identifier of the File containing the back of the document. Not every
1244
+ # document has a reverse side.
1245
+ #
1246
+ # @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
1247
+ end
1248
+
1249
+ # @see Increase::Models::EntityUpdateParams::Trust::Grantor::Identification#passport
1250
+ class Passport < Increase::Internal::Type::BaseModel
1251
+ # @!attribute country
1252
+ # The two-character ISO 3166-1 code representing the country that issued the
1253
+ # document (e.g., `US`).
1254
+ #
1255
+ # @return [String]
1256
+ required :country, String
1257
+
1258
+ # @!attribute expiration_date
1259
+ # The passport's expiration date in YYYY-MM-DD format.
1260
+ #
1261
+ # @return [Date]
1262
+ required :expiration_date, Date
1263
+
1264
+ # @!attribute file_id
1265
+ # The identifier of the File containing the passport.
1266
+ #
1267
+ # @return [String]
1268
+ required :file_id, String
1269
+
1270
+ # @!method initialize(country:, expiration_date:, file_id:)
1271
+ # Information about the passport used for identification. Required if `method` is
1272
+ # equal to `passport`.
1273
+ #
1274
+ # @param country [String]
1275
+ # The two-character ISO 3166-1 code representing the country that issued the
1276
+ # document (e.g., `US`).
1277
+ #
1278
+ # @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
1279
+ #
1280
+ # @param file_id [String] The identifier of the File containing the passport.
1281
+ end
1282
+ end
1283
+ end
1284
+
1285
+ class Trustee < Increase::Internal::Type::BaseModel
1286
+ # @!attribute structure
1287
+ # The structure of the trustee.
1288
+ #
1289
+ # @return [Symbol, Increase::Models::EntityUpdateParams::Trust::Trustee::Structure]
1290
+ required :structure, enum: -> { Increase::EntityUpdateParams::Trust::Trustee::Structure }
1291
+
1292
+ # @!attribute individual
1293
+ # Details of the individual trustee. Within the trustee object, this is required
1294
+ # if `structure` is equal to `individual`.
1295
+ #
1296
+ # @return [Increase::Models::EntityUpdateParams::Trust::Trustee::Individual, nil]
1297
+ optional :individual, -> { Increase::EntityUpdateParams::Trust::Trustee::Individual }
1298
+
1299
+ # @!method initialize(structure:, individual: nil)
1300
+ # @param structure [Symbol, Increase::Models::EntityUpdateParams::Trust::Trustee::Structure]
1301
+ # The structure of the trustee.
1302
+ #
1303
+ # @param individual [Increase::Models::EntityUpdateParams::Trust::Trustee::Individual]
1304
+ # Details of the individual trustee. Within the trustee object, this is required
1305
+ # if `structure` is equal to `individual`.
1306
+
1307
+ # The structure of the trustee.
1308
+ #
1309
+ # @see Increase::Models::EntityUpdateParams::Trust::Trustee#structure
1310
+ module Structure
1311
+ extend Increase::Internal::Type::Enum
1312
+
1313
+ # The trustee is an individual.
1314
+ INDIVIDUAL = :individual
1315
+
1316
+ # @!method self.values
1317
+ # @return [Array<Symbol>]
1318
+ end
1319
+
1320
+ # @see Increase::Models::EntityUpdateParams::Trust::Trustee#individual
1321
+ class Individual < Increase::Internal::Type::BaseModel
1322
+ # @!attribute address
1323
+ # The individual's physical address. Mail receiving locations like PO Boxes and
1324
+ # PMB's are disallowed.
1325
+ #
1326
+ # @return [Increase::Models::EntityUpdateParams::Trust::Trustee::Individual::Address]
1327
+ required :address, -> { Increase::EntityUpdateParams::Trust::Trustee::Individual::Address }
1328
+
1329
+ # @!attribute date_of_birth
1330
+ # The person's date of birth in YYYY-MM-DD format.
1331
+ #
1332
+ # @return [Date]
1333
+ required :date_of_birth, Date
1334
+
1335
+ # @!attribute identification
1336
+ # A means of verifying the person's identity.
1337
+ #
1338
+ # @return [Increase::Models::EntityUpdateParams::Trust::Trustee::Individual::Identification]
1339
+ required :identification, -> { Increase::EntityUpdateParams::Trust::Trustee::Individual::Identification }
1340
+
1341
+ # @!attribute name
1342
+ # The person's legal name.
1343
+ #
1344
+ # @return [String]
1345
+ required :name, String
1346
+
1347
+ # @!attribute confirmed_no_us_tax_id
1348
+ # The identification method for an individual can only be a passport, driver's
1349
+ # license, or other document if you've confirmed the individual does not have a US
1350
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
1351
+ # Number).
1352
+ #
1353
+ # @return [Boolean, nil]
1354
+ optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
1355
+
1356
+ # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil)
1357
+ # Details of the individual trustee. Within the trustee object, this is required
1358
+ # if `structure` is equal to `individual`.
1359
+ #
1360
+ # @param address [Increase::Models::EntityUpdateParams::Trust::Trustee::Individual::Address]
1361
+ # The individual's physical address. Mail receiving locations like PO Boxes and
1362
+ # PMB's are disallowed.
1363
+ #
1364
+ # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
1365
+ #
1366
+ # @param identification [Increase::Models::EntityUpdateParams::Trust::Trustee::Individual::Identification]
1367
+ # A means of verifying the person's identity.
1368
+ #
1369
+ # @param name [String] The person's legal name.
1370
+ #
1371
+ # @param confirmed_no_us_tax_id [Boolean]
1372
+ # The identification method for an individual can only be a passport, driver's
1373
+ # license, or other document if you've confirmed the individual does not have a US
1374
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
1375
+ # Number).
1376
+
1377
+ # @see Increase::Models::EntityUpdateParams::Trust::Trustee::Individual#address
1378
+ class Address < Increase::Internal::Type::BaseModel
1379
+ # @!attribute city
1380
+ # The city, district, town, or village of the address.
1381
+ #
1382
+ # @return [String]
1383
+ required :city, String
1384
+
1385
+ # @!attribute country
1386
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1387
+ #
1388
+ # Defaults to `US`.
1389
+ #
1390
+ # @return [String]
1391
+ required :country, String
1392
+
1393
+ # @!attribute line1
1394
+ # The first line of the address. This is usually the street number and street.
1395
+ #
1396
+ # @return [String]
1397
+ required :line1, String
1398
+
1399
+ # @!attribute line2
1400
+ # The second line of the address. This might be the floor or room number.
1401
+ #
1402
+ # @return [String, nil]
1403
+ optional :line2, String
1404
+
1405
+ # @!attribute state
1406
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1407
+ # state, province, or region of the address. Required in certain countries.
1408
+ #
1409
+ # @return [String, nil]
1410
+ optional :state, String
1411
+
1412
+ # @!attribute zip
1413
+ # The ZIP or postal code of the address. Required in certain countries.
1414
+ #
1415
+ # @return [String, nil]
1416
+ optional :zip, String
1417
+
1418
+ # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
1419
+ # The individual's physical address. Mail receiving locations like PO Boxes and
1420
+ # PMB's are disallowed.
1421
+ #
1422
+ # @param city [String] The city, district, town, or village of the address.
1423
+ #
1424
+ # @param country [String]
1425
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1426
+ #
1427
+ # Defaults to `US`.
1428
+ #
1429
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
1430
+ #
1431
+ # @param line2 [String] The second line of the address. This might be the floor or room number.
1432
+ #
1433
+ # @param state [String]
1434
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1435
+ # state, province, or region of the address. Required in certain countries.
1436
+ #
1437
+ # @param zip [String] The ZIP or postal code of the address. Required in certain countries.
1438
+ end
1439
+
1440
+ # @see Increase::Models::EntityUpdateParams::Trust::Trustee::Individual#identification
1441
+ class Identification < Increase::Internal::Type::BaseModel
1442
+ # @!attribute method_
1443
+ # A method that can be used to verify the individual's identity.
1444
+ #
1445
+ # Defaults to `social_security_number`.
1446
+ #
1447
+ # @return [Symbol, Increase::Models::EntityUpdateParams::Trust::Trustee::Individual::Identification::Method]
1448
+ required :method_,
1449
+ enum: -> {
1450
+ Increase::EntityUpdateParams::Trust::Trustee::Individual::Identification::Method
1451
+ },
1452
+ api_name: :method
1453
+
1454
+ # @!attribute number
1455
+ # An identification number that can be used to verify the individual's identity,
1456
+ # such as a social security number. For Social Security Numbers and Individual
1457
+ # Taxpayer Identification Numbers, submit nine digits with no dashes or other
1458
+ # separators. When testing in sandbox, use one of our
1459
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
1460
+ #
1461
+ # @return [String]
1462
+ required :number, String
1463
+
1464
+ # @!attribute drivers_license
1465
+ # Information about the United States driver's license used for identification.
1466
+ # Required if `method` is equal to `drivers_license`.
1467
+ #
1468
+ # @return [Increase::Models::EntityUpdateParams::Trust::Trustee::Individual::Identification::DriversLicense, nil]
1469
+ optional :drivers_license,
1470
+ -> { Increase::EntityUpdateParams::Trust::Trustee::Individual::Identification::DriversLicense }
1471
+
1472
+ # @!attribute other
1473
+ # Information about the identification document provided. Required if `method` is
1474
+ # equal to `other`.
1475
+ #
1476
+ # @return [Increase::Models::EntityUpdateParams::Trust::Trustee::Individual::Identification::Other, nil]
1477
+ optional :other, -> { Increase::EntityUpdateParams::Trust::Trustee::Individual::Identification::Other }
1478
+
1479
+ # @!attribute passport
1480
+ # Information about the passport used for identification. Required if `method` is
1481
+ # equal to `passport`.
1482
+ #
1483
+ # @return [Increase::Models::EntityUpdateParams::Trust::Trustee::Individual::Identification::Passport, nil]
1484
+ optional :passport,
1485
+ -> { Increase::EntityUpdateParams::Trust::Trustee::Individual::Identification::Passport }
1486
+
1487
+ # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
1488
+ # A means of verifying the person's identity.
1489
+ #
1490
+ # @param method_ [Symbol, Increase::Models::EntityUpdateParams::Trust::Trustee::Individual::Identification::Method]
1491
+ # A method that can be used to verify the individual's identity.
1492
+ #
1493
+ # Defaults to `social_security_number`.
1494
+ #
1495
+ # @param number [String]
1496
+ # An identification number that can be used to verify the individual's identity,
1497
+ # such as a social security number. For Social Security Numbers and Individual
1498
+ # Taxpayer Identification Numbers, submit nine digits with no dashes or other
1499
+ # separators. When testing in sandbox, use one of our
1500
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
1501
+ #
1502
+ # @param drivers_license [Increase::Models::EntityUpdateParams::Trust::Trustee::Individual::Identification::DriversLicense]
1503
+ # Information about the United States driver's license used for identification.
1504
+ # Required if `method` is equal to `drivers_license`.
1505
+ #
1506
+ # @param other [Increase::Models::EntityUpdateParams::Trust::Trustee::Individual::Identification::Other]
1507
+ # Information about the identification document provided. Required if `method` is
1508
+ # equal to `other`.
1509
+ #
1510
+ # @param passport [Increase::Models::EntityUpdateParams::Trust::Trustee::Individual::Identification::Passport]
1511
+ # Information about the passport used for identification. Required if `method` is
1512
+ # equal to `passport`.
1513
+
1514
+ # A method that can be used to verify the individual's identity.
1515
+ #
1516
+ # Defaults to `social_security_number`.
1517
+ #
1518
+ # @see Increase::Models::EntityUpdateParams::Trust::Trustee::Individual::Identification#method_
1519
+ module Method
1520
+ extend Increase::Internal::Type::Enum
1521
+
1522
+ # A social security number.
1523
+ SOCIAL_SECURITY_NUMBER = :social_security_number
1524
+
1525
+ # An individual taxpayer identification number (ITIN).
1526
+ INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
1527
+
1528
+ # A passport number.
1529
+ PASSPORT = :passport
1530
+
1531
+ # A driver's license number.
1532
+ DRIVERS_LICENSE = :drivers_license
1533
+
1534
+ # Another identifying document.
1535
+ OTHER = :other
1536
+
1537
+ # @!method self.values
1538
+ # @return [Array<Symbol>]
1539
+ end
1540
+
1541
+ # @see Increase::Models::EntityUpdateParams::Trust::Trustee::Individual::Identification#drivers_license
1542
+ class DriversLicense < Increase::Internal::Type::BaseModel
1543
+ # @!attribute expiration_date
1544
+ # The driver's license's expiration date in YYYY-MM-DD format.
1545
+ #
1546
+ # @return [Date]
1547
+ required :expiration_date, Date
1548
+
1549
+ # @!attribute file_id
1550
+ # The identifier of the File containing the front of the driver's license.
1551
+ #
1552
+ # @return [String]
1553
+ required :file_id, String
1554
+
1555
+ # @!attribute state
1556
+ # The state that issued the provided driver's license.
1557
+ #
1558
+ # @return [String]
1559
+ required :state, String
1560
+
1561
+ # @!attribute back_file_id
1562
+ # The identifier of the File containing the back of the driver's license.
1563
+ #
1564
+ # @return [String, nil]
1565
+ optional :back_file_id, String
1566
+
1567
+ # @!method initialize(expiration_date:, file_id:, state:, back_file_id: nil)
1568
+ # Information about the United States driver's license used for identification.
1569
+ # Required if `method` is equal to `drivers_license`.
1570
+ #
1571
+ # @param expiration_date [Date] The driver's license's expiration date in YYYY-MM-DD format.
1572
+ #
1573
+ # @param file_id [String] The identifier of the File containing the front of the driver's license.
1574
+ #
1575
+ # @param state [String] The state that issued the provided driver's license.
1576
+ #
1577
+ # @param back_file_id [String] The identifier of the File containing the back of the driver's license.
1578
+ end
1579
+
1580
+ # @see Increase::Models::EntityUpdateParams::Trust::Trustee::Individual::Identification#other
1581
+ class Other < Increase::Internal::Type::BaseModel
1582
+ # @!attribute country
1583
+ # The two-character ISO 3166-1 code representing the country that issued the
1584
+ # document (e.g., `US`).
1585
+ #
1586
+ # @return [String]
1587
+ required :country, String
1588
+
1589
+ # @!attribute description
1590
+ # A description of the document submitted.
1591
+ #
1592
+ # @return [String]
1593
+ required :description, String
1594
+
1595
+ # @!attribute file_id
1596
+ # The identifier of the File containing the front of the document.
1597
+ #
1598
+ # @return [String]
1599
+ required :file_id, String
1600
+
1601
+ # @!attribute back_file_id
1602
+ # The identifier of the File containing the back of the document. Not every
1603
+ # document has a reverse side.
1604
+ #
1605
+ # @return [String, nil]
1606
+ optional :back_file_id, String
1607
+
1608
+ # @!attribute expiration_date
1609
+ # The document's expiration date in YYYY-MM-DD format.
1610
+ #
1611
+ # @return [Date, nil]
1612
+ optional :expiration_date, Date
1613
+
1614
+ # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil)
1615
+ # Information about the identification document provided. Required if `method` is
1616
+ # equal to `other`.
1617
+ #
1618
+ # @param country [String]
1619
+ # The two-character ISO 3166-1 code representing the country that issued the
1620
+ # document (e.g., `US`).
1621
+ #
1622
+ # @param description [String] A description of the document submitted.
1623
+ #
1624
+ # @param file_id [String] The identifier of the File containing the front of the document.
1625
+ #
1626
+ # @param back_file_id [String]
1627
+ # The identifier of the File containing the back of the document. Not every
1628
+ # document has a reverse side.
1629
+ #
1630
+ # @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
1631
+ end
1632
+
1633
+ # @see Increase::Models::EntityUpdateParams::Trust::Trustee::Individual::Identification#passport
1634
+ class Passport < Increase::Internal::Type::BaseModel
1635
+ # @!attribute country
1636
+ # The two-character ISO 3166-1 code representing the country that issued the
1637
+ # document (e.g., `US`).
1638
+ #
1639
+ # @return [String]
1640
+ required :country, String
1641
+
1642
+ # @!attribute expiration_date
1643
+ # The passport's expiration date in YYYY-MM-DD format.
1644
+ #
1645
+ # @return [Date]
1646
+ required :expiration_date, Date
1647
+
1648
+ # @!attribute file_id
1649
+ # The identifier of the File containing the passport.
1650
+ #
1651
+ # @return [String]
1652
+ required :file_id, String
1653
+
1654
+ # @!method initialize(country:, expiration_date:, file_id:)
1655
+ # Information about the passport used for identification. Required if `method` is
1656
+ # equal to `passport`.
1657
+ #
1658
+ # @param country [String]
1659
+ # The two-character ISO 3166-1 code representing the country that issued the
1660
+ # document (e.g., `US`).
1661
+ #
1662
+ # @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
1663
+ #
1664
+ # @param file_id [String] The identifier of the File containing the passport.
1665
+ end
1666
+ end
1667
+ end
1668
+ end
916
1669
  end
917
1670
  end
918
1671
  end