modern_treasury 0.29.3 → 0.31.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 (107) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +25 -0
  3. data/README.md +1 -1
  4. data/lib/modern_treasury/client.rb +4 -0
  5. data/lib/modern_treasury/models/account_detail.rb +8 -6
  6. data/lib/modern_treasury/models/account_detail_create_params.rb +8 -6
  7. data/lib/modern_treasury/models/bulk_request_create_params.rb +2 -2
  8. data/lib/modern_treasury/models/child_legal_entity.rb +5 -209
  9. data/lib/modern_treasury/models/child_legal_entity_create.rb +2 -2
  10. data/lib/modern_treasury/models/connection_legal_entity_create_params.rb +2 -2
  11. data/lib/modern_treasury/models/counterparty_create_params.rb +3 -3
  12. data/lib/modern_treasury/models/document.rb +7 -9
  13. data/lib/modern_treasury/models/document_create_params.rb +0 -2
  14. data/lib/modern_treasury/models/document_list_params.rb +7 -9
  15. data/lib/modern_treasury/models/external_account_create_params.rb +1 -1
  16. data/lib/modern_treasury/models/identification.rb +209 -0
  17. data/lib/modern_treasury/models/identification_create_params.rb +231 -0
  18. data/lib/modern_treasury/models/identification_retrieve_params.rb +20 -0
  19. data/lib/modern_treasury/models/identification_update_params.rb +176 -0
  20. data/lib/modern_treasury/models/incoming_payment_detail.rb +1 -1
  21. data/lib/modern_treasury/models/incoming_payment_detail_create_async_params.rb +3 -14
  22. data/lib/modern_treasury/models/internal_account_create_params.rb +1 -0
  23. data/lib/modern_treasury/models/legal_entity.rb +5 -209
  24. data/lib/modern_treasury/models/legal_entity_create_params.rb +2 -2
  25. data/lib/modern_treasury/models/legal_entity_update_params.rb +2 -2
  26. data/lib/modern_treasury/models/payment_order_create_async_params.rb +1 -1
  27. data/lib/modern_treasury/models/payment_order_create_params.rb +1 -3
  28. data/lib/modern_treasury/models/payment_order_subtype.rb +1 -0
  29. data/lib/modern_treasury/models/payment_order_update_params.rb +1 -1
  30. data/lib/modern_treasury/models/virtual_account.rb +9 -1
  31. data/lib/modern_treasury/models/virtual_account_create_params.rb +17 -7
  32. data/lib/modern_treasury/models/virtual_account_list_params.rb +9 -1
  33. data/lib/modern_treasury/models.rb +8 -0
  34. data/lib/modern_treasury/resources/account_details.rb +1 -1
  35. data/lib/modern_treasury/resources/documents.rb +1 -1
  36. data/lib/modern_treasury/resources/identifications.rb +106 -0
  37. data/lib/modern_treasury/resources/incoming_payment_details.rb +1 -1
  38. data/lib/modern_treasury/resources/legal_entities.rb +2 -2
  39. data/lib/modern_treasury/resources/virtual_accounts.rb +6 -2
  40. data/lib/modern_treasury/version.rb +1 -1
  41. data/lib/modern_treasury.rb +5 -0
  42. data/rbi/modern_treasury/client.rbi +3 -0
  43. data/rbi/modern_treasury/models/account_detail.rbi +14 -11
  44. data/rbi/modern_treasury/models/account_detail_create_params.rbi +14 -11
  45. data/rbi/modern_treasury/models/bulk_request_create_params.rbi +10 -10
  46. data/rbi/modern_treasury/models/child_legal_entity.rbi +5 -654
  47. data/rbi/modern_treasury/models/child_legal_entity_create.rbi +2 -2
  48. data/rbi/modern_treasury/models/connection_legal_entity_create_params.rbi +2 -2
  49. data/rbi/modern_treasury/models/counterparty_create_params.rbi +7 -7
  50. data/rbi/modern_treasury/models/document.rbi +9 -19
  51. data/rbi/modern_treasury/models/document_create_params.rbi +0 -10
  52. data/rbi/modern_treasury/models/document_list_params.rbi +9 -19
  53. data/rbi/modern_treasury/models/external_account_create_params.rbi +5 -5
  54. data/rbi/modern_treasury/models/identification.rbi +346 -0
  55. data/rbi/modern_treasury/models/identification_create_params.rbi +768 -0
  56. data/rbi/modern_treasury/models/identification_retrieve_params.rbi +38 -0
  57. data/rbi/modern_treasury/models/identification_update_params.rbi +632 -0
  58. data/rbi/modern_treasury/models/incoming_payment_detail.rbi +5 -5
  59. data/rbi/modern_treasury/models/incoming_payment_detail_create_async_params.rbi +4 -50
  60. data/rbi/modern_treasury/models/internal_account_create_params.rbi +5 -0
  61. data/rbi/modern_treasury/models/legal_entity.rbi +5 -649
  62. data/rbi/modern_treasury/models/legal_entity_create_params.rbi +2 -2
  63. data/rbi/modern_treasury/models/legal_entity_update_params.rbi +2 -2
  64. data/rbi/modern_treasury/models/payment_order_create_async_params.rbi +5 -5
  65. data/rbi/modern_treasury/models/payment_order_create_params.rbi +5 -15
  66. data/rbi/modern_treasury/models/payment_order_subtype.rbi +2 -0
  67. data/rbi/modern_treasury/models/payment_order_update_params.rbi +5 -5
  68. data/rbi/modern_treasury/models/virtual_account.rbi +8 -0
  69. data/rbi/modern_treasury/models/virtual_account_create_params.rbi +22 -11
  70. data/rbi/modern_treasury/models/virtual_account_list_params.rbi +11 -0
  71. data/rbi/modern_treasury/models.rbi +11 -0
  72. data/rbi/modern_treasury/resources/account_details.rbi +3 -2
  73. data/rbi/modern_treasury/resources/documents.rbi +3 -3
  74. data/rbi/modern_treasury/resources/identifications.rbi +94 -0
  75. data/rbi/modern_treasury/resources/incoming_payment_details.rbi +1 -2
  76. data/rbi/modern_treasury/resources/legal_entities.rbi +2 -2
  77. data/rbi/modern_treasury/resources/virtual_accounts.rbi +6 -0
  78. data/sig/modern_treasury/client.rbs +2 -0
  79. data/sig/modern_treasury/models/account_detail.rbs +3 -3
  80. data/sig/modern_treasury/models/account_detail_create_params.rbs +3 -3
  81. data/sig/modern_treasury/models/bulk_request_create_params.rbs +6 -6
  82. data/sig/modern_treasury/models/child_legal_entity.rbs +4 -282
  83. data/sig/modern_treasury/models/counterparty_create_params.rbs +3 -3
  84. data/sig/modern_treasury/models/document.rbs +0 -4
  85. data/sig/modern_treasury/models/document_create_params.rbs +0 -4
  86. data/sig/modern_treasury/models/document_list_params.rbs +0 -4
  87. data/sig/modern_treasury/models/external_account_create_params.rbs +3 -3
  88. data/sig/modern_treasury/models/identification.rbs +281 -0
  89. data/sig/modern_treasury/models/identification_create_params.rbs +323 -0
  90. data/sig/modern_treasury/models/identification_retrieve_params.rbs +23 -0
  91. data/sig/modern_treasury/models/identification_update_params.rbs +268 -0
  92. data/sig/modern_treasury/models/incoming_payment_detail.rbs +3 -3
  93. data/sig/modern_treasury/models/incoming_payment_detail_create_async_params.rbs +6 -17
  94. data/sig/modern_treasury/models/internal_account_create_params.rbs +6 -1
  95. data/sig/modern_treasury/models/legal_entity.rbs +4 -282
  96. data/sig/modern_treasury/models/payment_order_create_async_params.rbs +3 -3
  97. data/sig/modern_treasury/models/payment_order_create_params.rbs +3 -7
  98. data/sig/modern_treasury/models/payment_order_subtype.rbs +2 -0
  99. data/sig/modern_treasury/models/payment_order_update_params.rbs +3 -3
  100. data/sig/modern_treasury/models/virtual_account.rbs +5 -0
  101. data/sig/modern_treasury/models/virtual_account_create_params.rbs +8 -3
  102. data/sig/modern_treasury/models/virtual_account_list_params.rbs +7 -0
  103. data/sig/modern_treasury/models.rbs +8 -0
  104. data/sig/modern_treasury/resources/identifications.rbs +33 -0
  105. data/sig/modern_treasury/resources/incoming_payment_details.rbs +1 -1
  106. data/sig/modern_treasury/resources/virtual_accounts.rbs +2 -0
  107. metadata +17 -2
@@ -0,0 +1,209 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ModernTreasury
4
+ module Models
5
+ # @see ModernTreasury::Resources::Identifications#create
6
+ class Identification < ModernTreasury::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ #
9
+ # @return [String]
10
+ required :id, String
11
+
12
+ # @!attribute created_at
13
+ #
14
+ # @return [Time]
15
+ required :created_at, Time
16
+
17
+ # @!attribute discarded_at
18
+ #
19
+ # @return [Time, nil]
20
+ required :discarded_at, Time, nil?: true
21
+
22
+ # @!attribute documents
23
+ #
24
+ # @return [Array<ModernTreasury::Models::Document>]
25
+ required :documents, -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Document] }
26
+
27
+ # @!attribute expiration_date
28
+ # The date when the Identification is no longer considered valid by the issuing
29
+ # authority.
30
+ #
31
+ # @return [Date, nil]
32
+ required :expiration_date, Date, nil?: true
33
+
34
+ # @!attribute id_type
35
+ # The type of ID number.
36
+ #
37
+ # @return [Symbol, ModernTreasury::Models::Identification::IDType]
38
+ required :id_type, enum: -> { ModernTreasury::Identification::IDType }
39
+
40
+ # @!attribute issuing_country
41
+ # The ISO 3166-1 alpha-2 country code of the country that issued the
42
+ # identification
43
+ #
44
+ # @return [String, nil]
45
+ required :issuing_country, String, nil?: true
46
+
47
+ # @!attribute issuing_region
48
+ # The region in which the identifcation was issued.
49
+ #
50
+ # @return [String, nil]
51
+ required :issuing_region, String, nil?: true
52
+
53
+ # @!attribute live_mode
54
+ # This field will be true if this object exists in the live environment or false
55
+ # if it exists in the test environment.
56
+ #
57
+ # @return [Boolean]
58
+ required :live_mode, ModernTreasury::Internal::Type::Boolean
59
+
60
+ # @!attribute object
61
+ #
62
+ # @return [String]
63
+ required :object, String
64
+
65
+ # @!attribute updated_at
66
+ #
67
+ # @return [Time]
68
+ required :updated_at, Time
69
+
70
+ # @!method initialize(id:, created_at:, discarded_at:, documents:, expiration_date:, id_type:, issuing_country:, issuing_region:, live_mode:, object:, updated_at:)
71
+ # Some parameter documentations has been truncated, see
72
+ # {ModernTreasury::Models::Identification} for more details.
73
+ #
74
+ # @param id [String]
75
+ #
76
+ # @param created_at [Time]
77
+ #
78
+ # @param discarded_at [Time, nil]
79
+ #
80
+ # @param documents [Array<ModernTreasury::Models::Document>]
81
+ #
82
+ # @param expiration_date [Date, nil] The date when the Identification is no longer considered valid by the issuing au
83
+ #
84
+ # @param id_type [Symbol, ModernTreasury::Models::Identification::IDType] The type of ID number.
85
+ #
86
+ # @param issuing_country [String, nil] The ISO 3166-1 alpha-2 country code of the country that issued the identificatio
87
+ #
88
+ # @param issuing_region [String, nil] The region in which the identifcation was issued.
89
+ #
90
+ # @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
91
+ #
92
+ # @param object [String]
93
+ #
94
+ # @param updated_at [Time]
95
+
96
+ # The type of ID number.
97
+ #
98
+ # @see ModernTreasury::Models::Identification#id_type
99
+ module IDType
100
+ extend ModernTreasury::Internal::Type::Enum
101
+
102
+ AR_CUIL = :ar_cuil
103
+ AR_CUIT = :ar_cuit
104
+ AT_ATIN = :at_atin
105
+ AT_VAT = :at_vat
106
+ AU_ABN = :au_abn
107
+ AU_TFN = :au_tfn
108
+ BE_ENT = :be_ent
109
+ BE_NRN = :be_nrn
110
+ BR_CNPJ = :br_cnpj
111
+ BR_CPF = :br_cpf
112
+ CA_BN = :ca_bn
113
+ CA_SIN = :ca_sin
114
+ CH_AHV = :ch_ahv
115
+ CH_UID = :ch_uid
116
+ CL_RUN = :cl_run
117
+ CL_RUT = :cl_rut
118
+ CO_CEDULAS = :co_cedulas
119
+ CO_NIT = :co_nit
120
+ CY_TIN = :cy_tin
121
+ CZ_ICO = :cz_ico
122
+ CZ_RC = :cz_rc
123
+ DE_STID = :de_stid
124
+ DE_STNR = :de_stnr
125
+ DE_VAT = :de_vat
126
+ DK_CPR = :dk_cpr
127
+ DK_CVR = :dk_cvr
128
+ DRIVERS_LICENSE = :drivers_license
129
+ EE_IK = :ee_ik
130
+ EE_RK = :ee_rk
131
+ ES_NIE = :es_nie
132
+ ES_NIF = :es_nif
133
+ FI_HETU = :fi_hetu
134
+ FI_YTJ = :fi_ytj
135
+ FR_NIF = :fr_nif
136
+ FR_SIREN = :fr_siren
137
+ FR_VAT = :fr_vat
138
+ GB_NINO = :gb_nino
139
+ GB_UTR = :gb_utr
140
+ GB_VAT = :gb_vat
141
+ GENERIC_INTERNATIONAL = :generic_international
142
+ GR_VAT = :gr_vat
143
+ HK_BRN = :hk_brn
144
+ HK_HKID = :hk_hkid
145
+ HN_ID = :hn_id
146
+ HN_RTN = :hn_rtn
147
+ HR_OIB = :hr_oib
148
+ HU_ADJ = :hu_adj
149
+ HU_ANUM = :hu_anum
150
+ IE_PPS = :ie_pps
151
+ IE_TRN = :ie_trn
152
+ IN_LEI = :in_lei
153
+ IS_KNT = :is_knt
154
+ IT_CF = :it_cf
155
+ IT_PIVA = :it_piva
156
+ JP_HB = :jp_hb
157
+ JP_MN = :jp_mn
158
+ KR_BRN = :kr_brn
159
+ KR_CRN = :kr_crn
160
+ KR_RRN = :kr_rrn
161
+ LI_PEID = :li_peid
162
+ LT_AK = :lt_ak
163
+ LT_JAK = :lt_jak
164
+ LU_MTC = :lu_mtc
165
+ LU_VAT = :lu_vat
166
+ LV_PK = :lv_pk
167
+ LV_RN = :lv_rn
168
+ MT_TIN = :mt_tin
169
+ MT_VAT = :mt_vat
170
+ MX_CURP = :mx_curp
171
+ MX_INE = :mx_ine
172
+ MX_RFC = :mx_rfc
173
+ NATIONAL_ID = :national_id
174
+ NL_BSN = :nl_bsn
175
+ NL_BTW = :nl_btw
176
+ NL_RSIN = :nl_rsin
177
+ NO_FDN = :no_fdn
178
+ NO_MVA = :no_mva
179
+ NO_ORGNR = :no_orgnr
180
+ NZ_IRD = :nz_ird
181
+ PASSPORT = :passport
182
+ PL_NIP = :pl_nip
183
+ PL_PESEL = :pl_pesel
184
+ PT_NIF = :pt_nif
185
+ RO_CNP = :ro_cnp
186
+ RO_CUI = :ro_cui
187
+ SA_TIN = :sa_tin
188
+ SA_VAT = :sa_vat
189
+ SE_ORGNR = :se_orgnr
190
+ SE_PNMR = :se_pnmr
191
+ SG_FIN = :sg_fin
192
+ SG_NRIC = :sg_nric
193
+ SG_UEN = :sg_uen
194
+ SI_DAV = :si_dav
195
+ SI_TIN = :si_tin
196
+ SK_ICO = :sk_ico
197
+ SK_RC = :sk_rc
198
+ US_EIN = :us_ein
199
+ US_ITIN = :us_itin
200
+ US_SSN = :us_ssn
201
+ UY_RUT = :uy_rut
202
+ VN_TIN = :vn_tin
203
+
204
+ # @!method self.values
205
+ # @return [Array<Symbol>]
206
+ end
207
+ end
208
+ end
209
+ end
@@ -0,0 +1,231 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ModernTreasury
4
+ module Models
5
+ # @see ModernTreasury::Resources::Identifications#create
6
+ class IdentificationCreateParams < ModernTreasury::Internal::Type::BaseModel
7
+ extend ModernTreasury::Internal::Type::RequestParameters::Converter
8
+ include ModernTreasury::Internal::Type::RequestParameters
9
+
10
+ # @!attribute id_number
11
+ # The ID number of identification document.
12
+ #
13
+ # @return [String]
14
+ required :id_number, String
15
+
16
+ # @!attribute id_type
17
+ # The type of ID number.
18
+ #
19
+ # @return [Symbol, ModernTreasury::Models::IdentificationCreateParams::IDType]
20
+ required :id_type, enum: -> { ModernTreasury::IdentificationCreateParams::IDType }
21
+
22
+ # @!attribute legal_entity_id
23
+ # The ID of the Legal Entity the identification belongs to.
24
+ #
25
+ # @return [String]
26
+ required :legal_entity_id, String
27
+
28
+ # @!attribute documents
29
+ # A list of documents to attach to the identification.
30
+ #
31
+ # @return [Array<ModernTreasury::Models::IdentificationCreateParams::Document>, nil]
32
+ optional :documents,
33
+ -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::IdentificationCreateParams::Document] }
34
+
35
+ # @!attribute expiration_date
36
+ # The date when the Identification is no longer considered valid by the issuing
37
+ # authority.
38
+ #
39
+ # @return [Date, nil]
40
+ optional :expiration_date, Date, nil?: true
41
+
42
+ # @!attribute issuing_country
43
+ # The ISO 3166-1 alpha-2 country code of the country that issued the
44
+ # identification
45
+ #
46
+ # @return [String, nil]
47
+ optional :issuing_country, String, nil?: true
48
+
49
+ # @!attribute issuing_region
50
+ # The region in which the identifcation was issued.
51
+ #
52
+ # @return [String, nil]
53
+ optional :issuing_region, String, nil?: true
54
+
55
+ # @!method initialize(id_number:, id_type:, legal_entity_id:, documents: nil, expiration_date: nil, issuing_country: nil, issuing_region: nil, request_options: {})
56
+ # Some parameter documentations has been truncated, see
57
+ # {ModernTreasury::Models::IdentificationCreateParams} for more details.
58
+ #
59
+ # @param id_number [String] The ID number of identification document.
60
+ #
61
+ # @param id_type [Symbol, ModernTreasury::Models::IdentificationCreateParams::IDType] The type of ID number.
62
+ #
63
+ # @param legal_entity_id [String] The ID of the Legal Entity the identification belongs to.
64
+ #
65
+ # @param documents [Array<ModernTreasury::Models::IdentificationCreateParams::Document>] A list of documents to attach to the identification.
66
+ #
67
+ # @param expiration_date [Date, nil] The date when the Identification is no longer considered valid by the issuing au
68
+ #
69
+ # @param issuing_country [String, nil] The ISO 3166-1 alpha-2 country code of the country that issued the identificatio
70
+ #
71
+ # @param issuing_region [String, nil] The region in which the identifcation was issued.
72
+ #
73
+ # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
74
+
75
+ # The type of ID number.
76
+ module IDType
77
+ extend ModernTreasury::Internal::Type::Enum
78
+
79
+ AR_CUIL = :ar_cuil
80
+ AR_CUIT = :ar_cuit
81
+ AT_ATIN = :at_atin
82
+ AT_VAT = :at_vat
83
+ AU_ABN = :au_abn
84
+ AU_TFN = :au_tfn
85
+ BE_ENT = :be_ent
86
+ BE_NRN = :be_nrn
87
+ BR_CNPJ = :br_cnpj
88
+ BR_CPF = :br_cpf
89
+ CA_BN = :ca_bn
90
+ CA_SIN = :ca_sin
91
+ CH_AHV = :ch_ahv
92
+ CH_UID = :ch_uid
93
+ CL_RUN = :cl_run
94
+ CL_RUT = :cl_rut
95
+ CO_CEDULAS = :co_cedulas
96
+ CO_NIT = :co_nit
97
+ CY_TIN = :cy_tin
98
+ CZ_ICO = :cz_ico
99
+ CZ_RC = :cz_rc
100
+ DE_STID = :de_stid
101
+ DE_STNR = :de_stnr
102
+ DE_VAT = :de_vat
103
+ DK_CPR = :dk_cpr
104
+ DK_CVR = :dk_cvr
105
+ DRIVERS_LICENSE = :drivers_license
106
+ EE_IK = :ee_ik
107
+ EE_RK = :ee_rk
108
+ ES_NIE = :es_nie
109
+ ES_NIF = :es_nif
110
+ FI_HETU = :fi_hetu
111
+ FI_YTJ = :fi_ytj
112
+ FR_NIF = :fr_nif
113
+ FR_SIREN = :fr_siren
114
+ FR_VAT = :fr_vat
115
+ GB_NINO = :gb_nino
116
+ GB_UTR = :gb_utr
117
+ GB_VAT = :gb_vat
118
+ GENERIC_INTERNATIONAL = :generic_international
119
+ GR_VAT = :gr_vat
120
+ HK_BRN = :hk_brn
121
+ HK_HKID = :hk_hkid
122
+ HN_ID = :hn_id
123
+ HN_RTN = :hn_rtn
124
+ HR_OIB = :hr_oib
125
+ HU_ADJ = :hu_adj
126
+ HU_ANUM = :hu_anum
127
+ IE_PPS = :ie_pps
128
+ IE_TRN = :ie_trn
129
+ IN_LEI = :in_lei
130
+ IS_KNT = :is_knt
131
+ IT_CF = :it_cf
132
+ IT_PIVA = :it_piva
133
+ JP_HB = :jp_hb
134
+ JP_MN = :jp_mn
135
+ KR_BRN = :kr_brn
136
+ KR_CRN = :kr_crn
137
+ KR_RRN = :kr_rrn
138
+ LI_PEID = :li_peid
139
+ LT_AK = :lt_ak
140
+ LT_JAK = :lt_jak
141
+ LU_MTC = :lu_mtc
142
+ LU_VAT = :lu_vat
143
+ LV_PK = :lv_pk
144
+ LV_RN = :lv_rn
145
+ MT_TIN = :mt_tin
146
+ MT_VAT = :mt_vat
147
+ MX_CURP = :mx_curp
148
+ MX_INE = :mx_ine
149
+ MX_RFC = :mx_rfc
150
+ NATIONAL_ID = :national_id
151
+ NL_BSN = :nl_bsn
152
+ NL_BTW = :nl_btw
153
+ NL_RSIN = :nl_rsin
154
+ NO_FDN = :no_fdn
155
+ NO_MVA = :no_mva
156
+ NO_ORGNR = :no_orgnr
157
+ NZ_IRD = :nz_ird
158
+ PASSPORT = :passport
159
+ PL_NIP = :pl_nip
160
+ PL_PESEL = :pl_pesel
161
+ PT_NIF = :pt_nif
162
+ RO_CNP = :ro_cnp
163
+ RO_CUI = :ro_cui
164
+ SA_TIN = :sa_tin
165
+ SA_VAT = :sa_vat
166
+ SE_ORGNR = :se_orgnr
167
+ SE_PNMR = :se_pnmr
168
+ SG_FIN = :sg_fin
169
+ SG_NRIC = :sg_nric
170
+ SG_UEN = :sg_uen
171
+ SI_DAV = :si_dav
172
+ SI_TIN = :si_tin
173
+ SK_ICO = :sk_ico
174
+ SK_RC = :sk_rc
175
+ US_EIN = :us_ein
176
+ US_ITIN = :us_itin
177
+ US_SSN = :us_ssn
178
+ UY_RUT = :uy_rut
179
+ VN_TIN = :vn_tin
180
+
181
+ # @!method self.values
182
+ # @return [Array<Symbol>]
183
+ end
184
+
185
+ class Document < ModernTreasury::Internal::Type::BaseModel
186
+ # @!attribute document_type
187
+ # A category given to the document, can be `null`.
188
+ #
189
+ # @return [Symbol, ModernTreasury::Models::IdentificationCreateParams::Document::DocumentType]
190
+ required :document_type, enum: -> { ModernTreasury::IdentificationCreateParams::Document::DocumentType }
191
+
192
+ # @!attribute file_data
193
+ # Base64-encoded file content for the document.
194
+ #
195
+ # @return [String]
196
+ required :file_data, String
197
+
198
+ # @!attribute filename
199
+ # The original filename of the document.
200
+ #
201
+ # @return [String, nil]
202
+ optional :filename, String
203
+
204
+ # @!method initialize(document_type:, file_data:, filename: nil)
205
+ # @param document_type [Symbol, ModernTreasury::Models::IdentificationCreateParams::Document::DocumentType] A category given to the document, can be `null`.
206
+ #
207
+ # @param file_data [String] Base64-encoded file content for the document.
208
+ #
209
+ # @param filename [String] The original filename of the document.
210
+
211
+ # A category given to the document, can be `null`.
212
+ #
213
+ # @see ModernTreasury::Models::IdentificationCreateParams::Document#document_type
214
+ module DocumentType
215
+ extend ModernTreasury::Internal::Type::Enum
216
+
217
+ ARTICLES_OF_INCORPORATION = :articles_of_incorporation
218
+ CERTIFICATE_OF_GOOD_STANDING = :certificate_of_good_standing
219
+ EIN_LETTER = :ein_letter
220
+ GENERIC = :generic
221
+ IDENTIFICATION_BACK = :identification_back
222
+ IDENTIFICATION_FRONT = :identification_front
223
+ PROOF_OF_ADDRESS = :proof_of_address
224
+
225
+ # @!method self.values
226
+ # @return [Array<Symbol>]
227
+ end
228
+ end
229
+ end
230
+ end
231
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ModernTreasury
4
+ module Models
5
+ # @see ModernTreasury::Resources::Identifications#retrieve
6
+ class IdentificationRetrieveParams < ModernTreasury::Internal::Type::BaseModel
7
+ extend ModernTreasury::Internal::Type::RequestParameters::Converter
8
+ include ModernTreasury::Internal::Type::RequestParameters
9
+
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
15
+ # @!method initialize(id:, request_options: {})
16
+ # @param id [String]
17
+ # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,176 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ModernTreasury
4
+ module Models
5
+ # @see ModernTreasury::Resources::Identifications#update
6
+ class IdentificationUpdateParams < ModernTreasury::Internal::Type::BaseModel
7
+ extend ModernTreasury::Internal::Type::RequestParameters::Converter
8
+ include ModernTreasury::Internal::Type::RequestParameters
9
+
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
15
+ # @!attribute expiration_date
16
+ # The date when the Identification is no longer considered valid by the issuing
17
+ # authority.
18
+ #
19
+ # @return [Date, nil]
20
+ optional :expiration_date, Date, nil?: true
21
+
22
+ # @!attribute id_number
23
+ # The ID number of identification document.
24
+ #
25
+ # @return [String, nil]
26
+ optional :id_number, String
27
+
28
+ # @!attribute id_type
29
+ # The type of ID number.
30
+ #
31
+ # @return [Symbol, ModernTreasury::Models::IdentificationUpdateParams::IDType, nil]
32
+ optional :id_type, enum: -> { ModernTreasury::IdentificationUpdateParams::IDType }
33
+
34
+ # @!attribute issuing_country
35
+ # The ISO 3166-1 alpha-2 country code of the country that issued the
36
+ # identification
37
+ #
38
+ # @return [String, nil]
39
+ optional :issuing_country, String, nil?: true
40
+
41
+ # @!attribute issuing_region
42
+ # The region in which the identifcation was issued.
43
+ #
44
+ # @return [String, nil]
45
+ optional :issuing_region, String, nil?: true
46
+
47
+ # @!method initialize(id:, expiration_date: nil, id_number: nil, id_type: nil, issuing_country: nil, issuing_region: nil, request_options: {})
48
+ # Some parameter documentations has been truncated, see
49
+ # {ModernTreasury::Models::IdentificationUpdateParams} for more details.
50
+ #
51
+ # @param id [String]
52
+ #
53
+ # @param expiration_date [Date, nil] The date when the Identification is no longer considered valid by the issuing au
54
+ #
55
+ # @param id_number [String] The ID number of identification document.
56
+ #
57
+ # @param id_type [Symbol, ModernTreasury::Models::IdentificationUpdateParams::IDType] The type of ID number.
58
+ #
59
+ # @param issuing_country [String, nil] The ISO 3166-1 alpha-2 country code of the country that issued the identificatio
60
+ #
61
+ # @param issuing_region [String, nil] The region in which the identifcation was issued.
62
+ #
63
+ # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
64
+
65
+ # The type of ID number.
66
+ module IDType
67
+ extend ModernTreasury::Internal::Type::Enum
68
+
69
+ AR_CUIL = :ar_cuil
70
+ AR_CUIT = :ar_cuit
71
+ AT_ATIN = :at_atin
72
+ AT_VAT = :at_vat
73
+ AU_ABN = :au_abn
74
+ AU_TFN = :au_tfn
75
+ BE_ENT = :be_ent
76
+ BE_NRN = :be_nrn
77
+ BR_CNPJ = :br_cnpj
78
+ BR_CPF = :br_cpf
79
+ CA_BN = :ca_bn
80
+ CA_SIN = :ca_sin
81
+ CH_AHV = :ch_ahv
82
+ CH_UID = :ch_uid
83
+ CL_RUN = :cl_run
84
+ CL_RUT = :cl_rut
85
+ CO_CEDULAS = :co_cedulas
86
+ CO_NIT = :co_nit
87
+ CY_TIN = :cy_tin
88
+ CZ_ICO = :cz_ico
89
+ CZ_RC = :cz_rc
90
+ DE_STID = :de_stid
91
+ DE_STNR = :de_stnr
92
+ DE_VAT = :de_vat
93
+ DK_CPR = :dk_cpr
94
+ DK_CVR = :dk_cvr
95
+ DRIVERS_LICENSE = :drivers_license
96
+ EE_IK = :ee_ik
97
+ EE_RK = :ee_rk
98
+ ES_NIE = :es_nie
99
+ ES_NIF = :es_nif
100
+ FI_HETU = :fi_hetu
101
+ FI_YTJ = :fi_ytj
102
+ FR_NIF = :fr_nif
103
+ FR_SIREN = :fr_siren
104
+ FR_VAT = :fr_vat
105
+ GB_NINO = :gb_nino
106
+ GB_UTR = :gb_utr
107
+ GB_VAT = :gb_vat
108
+ GENERIC_INTERNATIONAL = :generic_international
109
+ GR_VAT = :gr_vat
110
+ HK_BRN = :hk_brn
111
+ HK_HKID = :hk_hkid
112
+ HN_ID = :hn_id
113
+ HN_RTN = :hn_rtn
114
+ HR_OIB = :hr_oib
115
+ HU_ADJ = :hu_adj
116
+ HU_ANUM = :hu_anum
117
+ IE_PPS = :ie_pps
118
+ IE_TRN = :ie_trn
119
+ IN_LEI = :in_lei
120
+ IS_KNT = :is_knt
121
+ IT_CF = :it_cf
122
+ IT_PIVA = :it_piva
123
+ JP_HB = :jp_hb
124
+ JP_MN = :jp_mn
125
+ KR_BRN = :kr_brn
126
+ KR_CRN = :kr_crn
127
+ KR_RRN = :kr_rrn
128
+ LI_PEID = :li_peid
129
+ LT_AK = :lt_ak
130
+ LT_JAK = :lt_jak
131
+ LU_MTC = :lu_mtc
132
+ LU_VAT = :lu_vat
133
+ LV_PK = :lv_pk
134
+ LV_RN = :lv_rn
135
+ MT_TIN = :mt_tin
136
+ MT_VAT = :mt_vat
137
+ MX_CURP = :mx_curp
138
+ MX_INE = :mx_ine
139
+ MX_RFC = :mx_rfc
140
+ NATIONAL_ID = :national_id
141
+ NL_BSN = :nl_bsn
142
+ NL_BTW = :nl_btw
143
+ NL_RSIN = :nl_rsin
144
+ NO_FDN = :no_fdn
145
+ NO_MVA = :no_mva
146
+ NO_ORGNR = :no_orgnr
147
+ NZ_IRD = :nz_ird
148
+ PASSPORT = :passport
149
+ PL_NIP = :pl_nip
150
+ PL_PESEL = :pl_pesel
151
+ PT_NIF = :pt_nif
152
+ RO_CNP = :ro_cnp
153
+ RO_CUI = :ro_cui
154
+ SA_TIN = :sa_tin
155
+ SA_VAT = :sa_vat
156
+ SE_ORGNR = :se_orgnr
157
+ SE_PNMR = :se_pnmr
158
+ SG_FIN = :sg_fin
159
+ SG_NRIC = :sg_nric
160
+ SG_UEN = :sg_uen
161
+ SI_DAV = :si_dav
162
+ SI_TIN = :si_tin
163
+ SK_ICO = :sk_ico
164
+ SK_RC = :sk_rc
165
+ US_EIN = :us_ein
166
+ US_ITIN = :us_itin
167
+ US_SSN = :us_ssn
168
+ UY_RUT = :uy_rut
169
+ VN_TIN = :vn_tin
170
+
171
+ # @!method self.values
172
+ # @return [Array<Symbol>]
173
+ end
174
+ end
175
+ end
176
+ end
@@ -284,6 +284,7 @@ module ModernTreasury
284
284
  module OriginatingAccountNumberType
285
285
  extend ModernTreasury::Internal::Type::Enum
286
286
 
287
+ ARBITRUM_ADDRESS = :arbitrum_address
287
288
  AU_NUMBER = :au_number
288
289
  BASE_ADDRESS = :base_address
289
290
  CARD_TOKEN = :card_token
@@ -298,7 +299,6 @@ module ModernTreasury
298
299
  POLYGON_ADDRESS = :polygon_address
299
300
  SG_NUMBER = :sg_number
300
301
  SOLANA_ADDRESS = :solana_address
301
- WALLET_ADDRESS = :wallet_address
302
302
 
303
303
  # @!method self.values
304
304
  # @return [Array<Symbol>]
@@ -42,8 +42,8 @@ module ModernTreasury
42
42
  # @!attribute direction
43
43
  # One of `credit`, `debit`.
44
44
  #
45
- # @return [Symbol, ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Direction, nil]
46
- optional :direction, enum: -> { ModernTreasury::IncomingPaymentDetailCreateAsyncParams::Direction }
45
+ # @return [Symbol, ModernTreasury::Models::TransactionDirection, nil]
46
+ optional :direction, enum: -> { ModernTreasury::TransactionDirection }
47
47
 
48
48
  # @!attribute internal_account_id
49
49
  # The ID of one of your internal accounts.
@@ -86,7 +86,7 @@ module ModernTreasury
86
86
  #
87
87
  # @param description [String, nil] Defaults to a random description.
88
88
  #
89
- # @param direction [Symbol, ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Direction] One of `credit`, `debit`.
89
+ # @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `credit`, `debit`.
90
90
  #
91
91
  # @param internal_account_id [String] The ID of one of your internal accounts.
92
92
  #
@@ -98,17 +98,6 @@ module ModernTreasury
98
98
  #
99
99
  # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
100
100
 
101
- # One of `credit`, `debit`.
102
- module Direction
103
- extend ModernTreasury::Internal::Type::Enum
104
-
105
- CREDIT = :credit
106
- DEBIT = :debit
107
-
108
- # @!method self.values
109
- # @return [Array<Symbol>]
110
- end
111
-
112
101
  # One of `ach`, `wire`, `check`.
113
102
  module Type
114
103
  extend ModernTreasury::Internal::Type::Enum
@@ -358,6 +358,7 @@ module ModernTreasury
358
358
  module RequestedAccountNumberType
359
359
  extend ModernTreasury::Internal::Type::Enum
360
360
 
361
+ ARBITRUM_ADDRESS = :arbitrum_address
361
362
  BASE_ADDRESS = :base_address
362
363
  ETHEREUM_ADDRESS = :ethereum_address
363
364
  POLYGON_ADDRESS = :polygon_address