modern_treasury 0.29.0 → 0.29.2

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 (165) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +19 -0
  3. data/README.md +1 -1
  4. data/lib/modern_treasury/client.rb +12 -0
  5. data/lib/modern_treasury/models/bulk_request.rb +0 -1
  6. data/lib/modern_treasury/models/bulk_request_create_params.rb +149 -6
  7. data/lib/modern_treasury/models/bulk_request_list_params.rb +0 -1
  8. data/lib/modern_treasury/models/bulk_result.rb +0 -1
  9. data/lib/modern_treasury/models/bulk_result_list_params.rb +0 -1
  10. data/lib/modern_treasury/models/case_.rb +318 -0
  11. data/lib/modern_treasury/models/case_list_params.rb +73 -0
  12. data/lib/modern_treasury/models/case_retrieve_params.rb +20 -0
  13. data/lib/modern_treasury/models/child_legal_entity.rb +24 -1
  14. data/lib/modern_treasury/models/child_legal_entity_create.rb +24 -1
  15. data/lib/modern_treasury/models/connection_legal_entity_create_params.rb +26 -1
  16. data/lib/modern_treasury/models/counterparty.rb +8 -1
  17. data/lib/modern_treasury/models/counterparty_create_params.rb +24 -1
  18. data/lib/modern_treasury/models/document.rb +5 -4
  19. data/lib/modern_treasury/models/document_create_params.rb +1 -0
  20. data/lib/modern_treasury/models/document_list_params.rb +5 -4
  21. data/lib/modern_treasury/models/external_account.rb +8 -1
  22. data/lib/modern_treasury/models/internal_account_create_params.rb +2 -2
  23. data/lib/modern_treasury/models/internal_account_update_params.rb +21 -1
  24. data/lib/modern_treasury/models/internal_accounts/balance_report.rb +2 -3
  25. data/lib/modern_treasury/models/internal_accounts/balance_report_create_params.rb +2 -3
  26. data/lib/modern_treasury/models/invoice_update_params.rb +1 -1
  27. data/lib/modern_treasury/models/journal_source_list_params.rb +62 -0
  28. data/lib/modern_treasury/models/journal_source_retrieve_params.rb +20 -0
  29. data/lib/modern_treasury/models/legal_entity.rb +26 -1
  30. data/lib/modern_treasury/models/legal_entity_association.rb +1 -0
  31. data/lib/modern_treasury/models/legal_entity_association_create_params.rb +66 -0
  32. data/lib/modern_treasury/models/legal_entity_association_delete_params.rb +20 -0
  33. data/lib/modern_treasury/models/legal_entity_create_params.rb +22 -1
  34. data/lib/modern_treasury/models/legal_entity_update_params.rb +22 -1
  35. data/lib/modern_treasury/models/legal_entity_update_status_params.rb +46 -0
  36. data/lib/modern_treasury/models/payment_order.rb +90 -2
  37. data/lib/modern_treasury/models/payment_order_create_async_params.rb +70 -1
  38. data/lib/modern_treasury/models/payment_order_create_params.rb +71 -1
  39. data/lib/modern_treasury/models/payment_order_update_params.rb +70 -1
  40. data/lib/modern_treasury/models/payment_reference.rb +3 -1
  41. data/lib/modern_treasury/models/payment_reference_list_params.rb +2 -0
  42. data/lib/modern_treasury/models/return_object.rb +1 -1
  43. data/lib/modern_treasury/models/transaction.rb +6 -7
  44. data/lib/modern_treasury/models/transaction_create_params.rb +3 -3
  45. data/lib/modern_treasury/models/virtual_account_create_params.rb +9 -1
  46. data/lib/modern_treasury/models/virtual_account_setting.rb +57 -0
  47. data/lib/modern_treasury/models/virtual_account_setting_create_params.rb +81 -0
  48. data/lib/modern_treasury/models/virtual_account_setting_list_params.rb +36 -0
  49. data/lib/modern_treasury/models.rb +22 -0
  50. data/lib/modern_treasury/resources/cases.rb +66 -0
  51. data/lib/modern_treasury/resources/internal_accounts.rb +3 -1
  52. data/lib/modern_treasury/resources/journal_sources.rb +67 -0
  53. data/lib/modern_treasury/resources/legal_entities.rb +33 -2
  54. data/lib/modern_treasury/resources/legal_entity_associations.rb +50 -0
  55. data/lib/modern_treasury/resources/payment_orders.rb +9 -3
  56. data/lib/modern_treasury/resources/virtual_account_settings.rb +81 -0
  57. data/lib/modern_treasury/resources/virtual_accounts.rb +3 -1
  58. data/lib/modern_treasury/version.rb +1 -1
  59. data/lib/modern_treasury.rb +14 -0
  60. data/rbi/modern_treasury/client.rbi +9 -0
  61. data/rbi/modern_treasury/models/bulk_request.rbi +0 -5
  62. data/rbi/modern_treasury/models/bulk_request_create_params.rbi +224 -11
  63. data/rbi/modern_treasury/models/bulk_request_list_params.rbi +0 -5
  64. data/rbi/modern_treasury/models/bulk_result.rbi +0 -5
  65. data/rbi/modern_treasury/models/bulk_result_list_params.rbi +0 -5
  66. data/rbi/modern_treasury/models/case_.rbi +521 -0
  67. data/rbi/modern_treasury/models/case_list_params.rbi +145 -0
  68. data/rbi/modern_treasury/models/case_retrieve_params.rbi +38 -0
  69. data/rbi/modern_treasury/models/child_legal_entity.rbi +52 -0
  70. data/rbi/modern_treasury/models/child_legal_entity_create.rbi +55 -0
  71. data/rbi/modern_treasury/models/connection_legal_entity_create_params.rbi +55 -0
  72. data/rbi/modern_treasury/models/counterparty.rbi +6 -0
  73. data/rbi/modern_treasury/models/counterparty_create_params.rbi +55 -0
  74. data/rbi/modern_treasury/models/document.rbi +11 -6
  75. data/rbi/modern_treasury/models/document_create_params.rbi +5 -0
  76. data/rbi/modern_treasury/models/document_list_params.rbi +11 -6
  77. data/rbi/modern_treasury/models/external_account.rbi +6 -0
  78. data/rbi/modern_treasury/models/internal_account_create_params.rbi +6 -6
  79. data/rbi/modern_treasury/models/internal_account_update_params.rbi +52 -0
  80. data/rbi/modern_treasury/models/internal_accounts/balance_report.rbi +4 -6
  81. data/rbi/modern_treasury/models/internal_accounts/balance_report_create_params.rbi +4 -6
  82. data/rbi/modern_treasury/models/invoice_update_params.rbi +2 -2
  83. data/rbi/modern_treasury/models/journal_source_list_params.rbi +104 -0
  84. data/rbi/modern_treasury/models/journal_source_retrieve_params.rbi +38 -0
  85. data/rbi/modern_treasury/models/legal_entity.rbi +52 -0
  86. data/rbi/modern_treasury/models/legal_entity_association_create_params.rbi +128 -0
  87. data/rbi/modern_treasury/models/legal_entity_association_delete_params.rbi +38 -0
  88. data/rbi/modern_treasury/models/legal_entity_create_params.rbi +55 -0
  89. data/rbi/modern_treasury/models/legal_entity_update_params.rbi +55 -0
  90. data/rbi/modern_treasury/models/legal_entity_update_status_params.rbi +96 -0
  91. data/rbi/modern_treasury/models/payment_order.rbi +153 -5
  92. data/rbi/modern_treasury/models/payment_order_create_async_params.rbi +109 -0
  93. data/rbi/modern_treasury/models/payment_order_create_params.rbi +114 -0
  94. data/rbi/modern_treasury/models/payment_order_update_params.rbi +109 -0
  95. data/rbi/modern_treasury/models/payment_reference.rbi +15 -5
  96. data/rbi/modern_treasury/models/payment_reference_list_params.rbi +10 -0
  97. data/rbi/modern_treasury/models/return_object.rbi +5 -5
  98. data/rbi/modern_treasury/models/transaction.rbi +9 -14
  99. data/rbi/modern_treasury/models/transaction_create_params.rbi +6 -6
  100. data/rbi/modern_treasury/models/virtual_account_create_params.rbi +11 -0
  101. data/rbi/modern_treasury/models/virtual_account_setting.rbi +74 -0
  102. data/rbi/modern_treasury/models/virtual_account_setting_create_params.rbi +102 -0
  103. data/rbi/modern_treasury/models/virtual_account_setting_list_params.rbi +64 -0
  104. data/rbi/modern_treasury/models.rbi +28 -0
  105. data/rbi/modern_treasury/resources/cases.rbi +50 -0
  106. data/rbi/modern_treasury/resources/documents.rbi +2 -2
  107. data/rbi/modern_treasury/resources/internal_accounts.rbi +4 -0
  108. data/rbi/modern_treasury/resources/invoices.rbi +1 -1
  109. data/rbi/modern_treasury/resources/journal_sources.rbi +55 -0
  110. data/rbi/modern_treasury/resources/legal_entities.rbi +31 -0
  111. data/rbi/modern_treasury/resources/legal_entity_associations.rbi +42 -0
  112. data/rbi/modern_treasury/resources/payment_orders.rbi +21 -0
  113. data/rbi/modern_treasury/resources/transactions.rbi +3 -3
  114. data/rbi/modern_treasury/resources/virtual_account_settings.rbi +67 -0
  115. data/rbi/modern_treasury/resources/virtual_accounts.rbi +3 -0
  116. data/sig/modern_treasury/client.rbs +6 -0
  117. data/sig/modern_treasury/models/bulk_request.rbs +0 -2
  118. data/sig/modern_treasury/models/bulk_request_create_params.rbs +94 -2
  119. data/sig/modern_treasury/models/bulk_request_list_params.rbs +0 -2
  120. data/sig/modern_treasury/models/bulk_result.rbs +0 -2
  121. data/sig/modern_treasury/models/bulk_result_list_params.rbs +0 -2
  122. data/sig/modern_treasury/models/case_.rbs +266 -0
  123. data/sig/modern_treasury/models/case_list_params.rbs +79 -0
  124. data/sig/modern_treasury/models/case_retrieve_params.rbs +23 -0
  125. data/sig/modern_treasury/models/child_legal_entity.rbs +17 -0
  126. data/sig/modern_treasury/models/child_legal_entity_create.rbs +17 -0
  127. data/sig/modern_treasury/models/connection_legal_entity_create_params.rbs +17 -0
  128. data/sig/modern_treasury/models/counterparty.rbs +5 -0
  129. data/sig/modern_treasury/models/counterparty_create_params.rbs +17 -0
  130. data/sig/modern_treasury/models/document.rbs +2 -0
  131. data/sig/modern_treasury/models/document_create_params.rbs +2 -0
  132. data/sig/modern_treasury/models/document_list_params.rbs +2 -0
  133. data/sig/modern_treasury/models/external_account.rbs +5 -0
  134. data/sig/modern_treasury/models/internal_account_create_params.rbs +3 -3
  135. data/sig/modern_treasury/models/internal_account_update_params.rbs +20 -1
  136. data/sig/modern_treasury/models/journal_source_list_params.rbs +63 -0
  137. data/sig/modern_treasury/models/journal_source_retrieve_params.rbs +23 -0
  138. data/sig/modern_treasury/models/legal_entity.rbs +17 -0
  139. data/sig/modern_treasury/models/legal_entity_association_create_params.rbs +59 -0
  140. data/sig/modern_treasury/models/legal_entity_association_delete_params.rbs +23 -0
  141. data/sig/modern_treasury/models/legal_entity_create_params.rbs +17 -0
  142. data/sig/modern_treasury/models/legal_entity_update_params.rbs +17 -0
  143. data/sig/modern_treasury/models/legal_entity_update_status_params.rbs +43 -0
  144. data/sig/modern_treasury/models/payment_order.rbs +65 -2
  145. data/sig/modern_treasury/models/payment_order_create_async_params.rbs +47 -0
  146. data/sig/modern_treasury/models/payment_order_create_params.rbs +49 -0
  147. data/sig/modern_treasury/models/payment_order_update_params.rbs +47 -0
  148. data/sig/modern_treasury/models/payment_reference.rbs +10 -3
  149. data/sig/modern_treasury/models/payment_reference_list_params.rbs +8 -1
  150. data/sig/modern_treasury/models/return_object.rbs +2 -2
  151. data/sig/modern_treasury/models/transaction.rbs +0 -2
  152. data/sig/modern_treasury/models/virtual_account_create_params.rbs +8 -1
  153. data/sig/modern_treasury/models/virtual_account_setting.rbs +45 -0
  154. data/sig/modern_treasury/models/virtual_account_setting_create_params.rbs +61 -0
  155. data/sig/modern_treasury/models/virtual_account_setting_list_params.rbs +36 -0
  156. data/sig/modern_treasury/models.rbs +22 -0
  157. data/sig/modern_treasury/resources/cases.rbs +21 -0
  158. data/sig/modern_treasury/resources/internal_accounts.rbs +1 -0
  159. data/sig/modern_treasury/resources/journal_sources.rbs +22 -0
  160. data/sig/modern_treasury/resources/legal_entities.rbs +8 -0
  161. data/sig/modern_treasury/resources/legal_entity_associations.rbs +14 -0
  162. data/sig/modern_treasury/resources/payment_orders.rbs +3 -0
  163. data/sig/modern_treasury/resources/virtual_account_settings.rbs +26 -0
  164. data/sig/modern_treasury/resources/virtual_accounts.rbs +1 -0
  165. metadata +44 -2
@@ -0,0 +1,73 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ModernTreasury
4
+ module Models
5
+ # @see ModernTreasury::Resources::Cases#list
6
+ class CaseListParams < ModernTreasury::Internal::Type::BaseModel
7
+ extend ModernTreasury::Internal::Type::RequestParameters::Converter
8
+ include ModernTreasury::Internal::Type::RequestParameters
9
+
10
+ # @!attribute after_cursor
11
+ #
12
+ # @return [String, nil]
13
+ optional :after_cursor, String, nil?: true
14
+
15
+ # @!attribute per_page
16
+ #
17
+ # @return [Integer, nil]
18
+ optional :per_page, Integer
19
+
20
+ # @!attribute status
21
+ # The status of the case.
22
+ #
23
+ # @return [Symbol, ModernTreasury::Models::CaseListParams::Status, nil]
24
+ optional :status, enum: -> { ModernTreasury::CaseListParams::Status }
25
+
26
+ # @!attribute subject_id
27
+ # The ID of the object the case is about.
28
+ #
29
+ # @return [String, nil]
30
+ optional :subject_id, String
31
+
32
+ # @!attribute subject_type
33
+ # The type of the object the case is about.
34
+ #
35
+ # @return [Symbol, ModernTreasury::Models::CaseListParams::SubjectType, nil]
36
+ optional :subject_type, enum: -> { ModernTreasury::CaseListParams::SubjectType }
37
+
38
+ # @!method initialize(after_cursor: nil, per_page: nil, status: nil, subject_id: nil, subject_type: nil, request_options: {})
39
+ # @param after_cursor [String, nil]
40
+ #
41
+ # @param per_page [Integer]
42
+ #
43
+ # @param status [Symbol, ModernTreasury::Models::CaseListParams::Status] The status of the case.
44
+ #
45
+ # @param subject_id [String] The ID of the object the case is about.
46
+ #
47
+ # @param subject_type [Symbol, ModernTreasury::Models::CaseListParams::SubjectType] The type of the object the case is about.
48
+ #
49
+ # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
50
+
51
+ # The status of the case.
52
+ module Status
53
+ extend ModernTreasury::Internal::Type::Enum
54
+
55
+ OPEN = :open
56
+ RESOLVED = :resolved
57
+
58
+ # @!method self.values
59
+ # @return [Array<Symbol>]
60
+ end
61
+
62
+ # The type of the object the case is about.
63
+ module SubjectType
64
+ extend ModernTreasury::Internal::Type::Enum
65
+
66
+ LEGAL_ENTITY = :legal_entity
67
+
68
+ # @!method self.values
69
+ # @return [Array<Symbol>]
70
+ end
71
+ end
72
+ end
73
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ModernTreasury
4
+ module Models
5
+ # @see ModernTreasury::Resources::Cases#retrieve
6
+ class CaseRetrieveParams < 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
@@ -26,6 +26,14 @@ module ModernTreasury
26
26
  # @return [String, nil]
27
27
  required :business_description, String, nil?: true
28
28
 
29
+ # @!attribute business_designation
30
+ # Legal designation associated with the business.
31
+ #
32
+ # @return [Symbol, ModernTreasury::Models::ChildLegalEntity::BusinessDesignation, nil]
33
+ required :business_designation,
34
+ enum: -> { ModernTreasury::ChildLegalEntity::BusinessDesignation },
35
+ nil?: true
36
+
29
37
  # @!attribute business_name
30
38
  # The business's legal business name.
31
39
  #
@@ -299,7 +307,7 @@ module ModernTreasury
299
307
  # @return [String, nil]
300
308
  required :website, String, nil?: true
301
309
 
302
- # @!method initialize(id:, addresses:, bank_settings:, business_description:, business_name:, citizenship_country:, compliance_details:, country_of_incorporation:, created_at:, date_formed:, date_of_birth:, discarded_at:, documents:, doing_business_as_names:, email:, expected_activity_volume:, external_id:, first_name:, identifications:, industry_classifications:, intended_use:, last_name:, legal_entity_associations:, legal_entity_type:, legal_structure:, listed_exchange:, live_mode:, metadata:, middle_name:, object:, operating_jurisdictions:, phone_numbers:, politically_exposed_person:, preferred_name:, prefix:, primary_social_media_sites:, regulators:, risk_rating:, service_provider_legal_entity_id:, status:, suffix:, terms_of_use:, third_party_verification:, third_party_verifications:, ticker_symbol:, updated_at:, wealth_and_employment_details:, website:)
310
+ # @!method initialize(id:, addresses:, bank_settings:, business_description:, business_designation:, business_name:, citizenship_country:, compliance_details:, country_of_incorporation:, created_at:, date_formed:, date_of_birth:, discarded_at:, documents:, doing_business_as_names:, email:, expected_activity_volume:, external_id:, first_name:, identifications:, industry_classifications:, intended_use:, last_name:, legal_entity_associations:, legal_entity_type:, legal_structure:, listed_exchange:, live_mode:, metadata:, middle_name:, object:, operating_jurisdictions:, phone_numbers:, politically_exposed_person:, preferred_name:, prefix:, primary_social_media_sites:, regulators:, risk_rating:, service_provider_legal_entity_id:, status:, suffix:, terms_of_use:, third_party_verification:, third_party_verifications:, ticker_symbol:, updated_at:, wealth_and_employment_details:, website:)
303
311
  # Some parameter documentations has been truncated, see
304
312
  # {ModernTreasury::Models::ChildLegalEntity} for more details.
305
313
  #
@@ -311,6 +319,8 @@ module ModernTreasury
311
319
  #
312
320
  # @param business_description [String, nil] A description of the business.
313
321
  #
322
+ # @param business_designation [Symbol, ModernTreasury::Models::ChildLegalEntity::BusinessDesignation, nil] Legal designation associated with the business.
323
+ #
314
324
  # @param business_name [String, nil] The business's legal business name.
315
325
  #
316
326
  # @param citizenship_country [String, nil] The country of citizenship for an individual.
@@ -530,6 +540,19 @@ module ModernTreasury
530
540
  end
531
541
  end
532
542
 
543
+ # Legal designation associated with the business.
544
+ #
545
+ # @see ModernTreasury::Models::ChildLegalEntity#business_designation
546
+ module BusinessDesignation
547
+ extend ModernTreasury::Internal::Type::Enum
548
+
549
+ EXEMPT_FINANCIAL_INSTITUTION = :exempt_financial_institution
550
+ NON_OPERATING_BUSINESS = :non_operating_business
551
+
552
+ # @!method self.values
553
+ # @return [Array<Symbol>]
554
+ end
555
+
533
556
  class Identification < ModernTreasury::Internal::Type::BaseModel
534
557
  # @!attribute id
535
558
  #
@@ -21,6 +21,14 @@ module ModernTreasury
21
21
  # @return [String, nil]
22
22
  optional :business_description, String, nil?: true
23
23
 
24
+ # @!attribute business_designation
25
+ # Legal designation associated with the business.
26
+ #
27
+ # @return [Symbol, ModernTreasury::Models::ChildLegalEntityCreate::BusinessDesignation, nil]
28
+ optional :business_designation,
29
+ enum: -> { ModernTreasury::ChildLegalEntityCreate::BusinessDesignation },
30
+ nil?: true
31
+
24
32
  # @!attribute business_name
25
33
  # The business's legal business name.
26
34
  #
@@ -281,7 +289,7 @@ module ModernTreasury
281
289
  # @return [String, nil]
282
290
  optional :website, String, nil?: true
283
291
 
284
- # @!method initialize(addresses: nil, bank_settings: nil, business_description: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, connection_id: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, documents: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, external_id: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_entity_associations: nil, legal_entity_type: nil, legal_structure: nil, listed_exchange: nil, metadata: nil, middle_name: nil, operating_jurisdictions: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, primary_social_media_sites: nil, regulators: nil, risk_rating: nil, service_provider_legal_entity_id: nil, suffix: nil, terms_of_use: nil, third_party_verification: nil, third_party_verifications: nil, ticker_symbol: nil, wealth_and_employment_details: nil, website: nil)
292
+ # @!method initialize(addresses: nil, bank_settings: nil, business_description: nil, business_designation: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, connection_id: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, documents: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, external_id: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_entity_associations: nil, legal_entity_type: nil, legal_structure: nil, listed_exchange: nil, metadata: nil, middle_name: nil, operating_jurisdictions: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, primary_social_media_sites: nil, regulators: nil, risk_rating: nil, service_provider_legal_entity_id: nil, suffix: nil, terms_of_use: nil, third_party_verification: nil, third_party_verifications: nil, ticker_symbol: nil, wealth_and_employment_details: nil, website: nil)
285
293
  # Some parameter documentations has been truncated, see
286
294
  # {ModernTreasury::Models::ChildLegalEntityCreate} for more details.
287
295
  #
@@ -291,6 +299,8 @@ module ModernTreasury
291
299
  #
292
300
  # @param business_description [String, nil] A description of the business.
293
301
  #
302
+ # @param business_designation [Symbol, ModernTreasury::Models::ChildLegalEntityCreate::BusinessDesignation, nil] Legal designation associated with the business.
303
+ #
294
304
  # @param business_name [String, nil] The business's legal business name.
295
305
  #
296
306
  # @param citizenship_country [String, nil] The country of citizenship for an individual.
@@ -369,6 +379,19 @@ module ModernTreasury
369
379
  #
370
380
  # @param website [String, nil] The entity's primary website URL.
371
381
 
382
+ # Legal designation associated with the business.
383
+ #
384
+ # @see ModernTreasury::Models::ChildLegalEntityCreate#business_designation
385
+ module BusinessDesignation
386
+ extend ModernTreasury::Internal::Type::Enum
387
+
388
+ EXEMPT_FINANCIAL_INSTITUTION = :exempt_financial_institution
389
+ NON_OPERATING_BUSINESS = :non_operating_business
390
+
391
+ # @!method self.values
392
+ # @return [Array<Symbol>]
393
+ end
394
+
372
395
  class Document < ModernTreasury::Internal::Type::BaseModel
373
396
  # @!attribute document_type
374
397
  # A category given to the document, can be `null`.
@@ -53,6 +53,16 @@ module ModernTreasury
53
53
  # @return [String, nil]
54
54
  optional :business_description, String, nil?: true
55
55
 
56
+ # @!attribute business_designation
57
+ # Legal designation associated with the business.
58
+ #
59
+ # @return [Symbol, ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity::BusinessDesignation, nil]
60
+ optional :business_designation,
61
+ enum: -> {
62
+ ModernTreasury::ConnectionLegalEntityCreateParams::LegalEntity::BusinessDesignation
63
+ },
64
+ nil?: true
65
+
56
66
  # @!attribute business_name
57
67
  # The business's legal business name.
58
68
  #
@@ -316,7 +326,7 @@ module ModernTreasury
316
326
  # @return [String, nil]
317
327
  optional :website, String, nil?: true
318
328
 
319
- # @!method initialize(addresses: nil, bank_settings: nil, business_description: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, connection_id: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, documents: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, external_id: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_entity_associations: nil, legal_entity_type: nil, legal_structure: nil, listed_exchange: nil, metadata: nil, middle_name: nil, operating_jurisdictions: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, primary_social_media_sites: nil, regulators: nil, risk_rating: nil, service_provider_legal_entity_id: nil, suffix: nil, terms_of_use: nil, third_party_verification: nil, third_party_verifications: nil, ticker_symbol: nil, wealth_and_employment_details: nil, website: nil)
329
+ # @!method initialize(addresses: nil, bank_settings: nil, business_description: nil, business_designation: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, connection_id: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, documents: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, external_id: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_entity_associations: nil, legal_entity_type: nil, legal_structure: nil, listed_exchange: nil, metadata: nil, middle_name: nil, operating_jurisdictions: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, primary_social_media_sites: nil, regulators: nil, risk_rating: nil, service_provider_legal_entity_id: nil, suffix: nil, terms_of_use: nil, third_party_verification: nil, third_party_verifications: nil, ticker_symbol: nil, wealth_and_employment_details: nil, website: nil)
320
330
  # Some parameter documentations has been truncated, see
321
331
  # {ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity} for
322
332
  # more details.
@@ -329,6 +339,8 @@ module ModernTreasury
329
339
  #
330
340
  # @param business_description [String, nil] A description of the business.
331
341
  #
342
+ # @param business_designation [Symbol, ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity::BusinessDesignation, nil] Legal designation associated with the business.
343
+ #
332
344
  # @param business_name [String, nil] The business's legal business name.
333
345
  #
334
346
  # @param citizenship_country [String, nil] The country of citizenship for an individual.
@@ -407,6 +419,19 @@ module ModernTreasury
407
419
  #
408
420
  # @param website [String, nil] The entity's primary website URL.
409
421
 
422
+ # Legal designation associated with the business.
423
+ #
424
+ # @see ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity#business_designation
425
+ module BusinessDesignation
426
+ extend ModernTreasury::Internal::Type::Enum
427
+
428
+ EXEMPT_FINANCIAL_INSTITUTION = :exempt_financial_institution
429
+ NON_OPERATING_BUSINESS = :non_operating_business
430
+
431
+ # @!method self.values
432
+ # @return [Array<Symbol>]
433
+ end
434
+
410
435
  class Document < ModernTreasury::Internal::Type::BaseModel
411
436
  # @!attribute document_type
412
437
  # A category given to the document, can be `null`.
@@ -137,6 +137,11 @@ module ModernTreasury
137
137
  # @return [Symbol, ModernTreasury::Models::ExternalAccountType, nil]
138
138
  optional :account_type, enum: -> { ModernTreasury::ExternalAccountType }
139
139
 
140
+ # @!attribute card_id
141
+ #
142
+ # @return [String, nil]
143
+ optional :card_id, String, nil?: true
144
+
140
145
  # @!attribute contact_details
141
146
  #
142
147
  # @return [Array<ModernTreasury::Models::ContactDetail>, nil]
@@ -231,7 +236,7 @@ module ModernTreasury
231
236
  # @return [Symbol, ModernTreasury::Models::Counterparty::Account::VerificationStatus, nil]
232
237
  optional :verification_status, enum: -> { ModernTreasury::Counterparty::Account::VerificationStatus }
233
238
 
234
- # @!method initialize(id: nil, account_details: nil, account_type: nil, contact_details: nil, created_at: nil, discarded_at: nil, external_id: nil, ledger_account_id: nil, live_mode: nil, metadata: nil, name: nil, object: nil, party_address: nil, party_name: nil, party_type: nil, routing_details: nil, updated_at: nil, verification_source: nil, verification_status: nil)
239
+ # @!method initialize(id: nil, account_details: nil, account_type: nil, card_id: nil, contact_details: nil, created_at: nil, discarded_at: nil, external_id: nil, ledger_account_id: nil, live_mode: nil, metadata: nil, name: nil, object: nil, party_address: nil, party_name: nil, party_type: nil, routing_details: nil, updated_at: nil, verification_source: nil, verification_status: nil)
235
240
  # Some parameter documentations has been truncated, see
236
241
  # {ModernTreasury::Models::Counterparty::Account} for more details.
237
242
  #
@@ -241,6 +246,8 @@ module ModernTreasury
241
246
  #
242
247
  # @param account_type [Symbol, ModernTreasury::Models::ExternalAccountType] Can be `checking`, `savings` or `other`.
243
248
  #
249
+ # @param card_id [String, nil]
250
+ #
244
251
  # @param contact_details [Array<ModernTreasury::Models::ContactDetail>]
245
252
  #
246
253
  # @param created_at [Time]
@@ -445,6 +445,14 @@ module ModernTreasury
445
445
  # @return [String, nil]
446
446
  optional :business_description, String, nil?: true
447
447
 
448
+ # @!attribute business_designation
449
+ # Legal designation associated with the business.
450
+ #
451
+ # @return [Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::BusinessDesignation, nil]
452
+ optional :business_designation,
453
+ enum: -> { ModernTreasury::CounterpartyCreateParams::LegalEntity::BusinessDesignation },
454
+ nil?: true
455
+
448
456
  # @!attribute business_name
449
457
  # The business's legal business name.
450
458
  #
@@ -701,7 +709,7 @@ module ModernTreasury
701
709
  # @return [String, nil]
702
710
  optional :website, String, nil?: true
703
711
 
704
- # @!method initialize(legal_entity_type:, addresses: nil, bank_settings: nil, business_description: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, connection_id: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, documents: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, external_id: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_entity_associations: nil, legal_structure: nil, listed_exchange: nil, metadata: nil, middle_name: nil, operating_jurisdictions: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, primary_social_media_sites: nil, regulators: nil, risk_rating: nil, service_provider_legal_entity_id: nil, suffix: nil, terms_of_use: nil, third_party_verification: nil, third_party_verifications: nil, ticker_symbol: nil, wealth_and_employment_details: nil, website: nil)
712
+ # @!method initialize(legal_entity_type:, addresses: nil, bank_settings: nil, business_description: nil, business_designation: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, connection_id: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, documents: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, external_id: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_entity_associations: nil, legal_structure: nil, listed_exchange: nil, metadata: nil, middle_name: nil, operating_jurisdictions: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, primary_social_media_sites: nil, regulators: nil, risk_rating: nil, service_provider_legal_entity_id: nil, suffix: nil, terms_of_use: nil, third_party_verification: nil, third_party_verifications: nil, ticker_symbol: nil, wealth_and_employment_details: nil, website: nil)
705
713
  # Some parameter documentations has been truncated, see
706
714
  # {ModernTreasury::Models::CounterpartyCreateParams::LegalEntity} for more
707
715
  # details.
@@ -714,6 +722,8 @@ module ModernTreasury
714
722
  #
715
723
  # @param business_description [String, nil] A description of the business.
716
724
  #
725
+ # @param business_designation [Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::BusinessDesignation, nil] Legal designation associated with the business.
726
+ #
717
727
  # @param business_name [String, nil] The business's legal business name.
718
728
  #
719
729
  # @param citizenship_country [String, nil] The country of citizenship for an individual.
@@ -803,6 +813,19 @@ module ModernTreasury
803
813
  # @return [Array<Symbol>]
804
814
  end
805
815
 
816
+ # Legal designation associated with the business.
817
+ #
818
+ # @see ModernTreasury::Models::CounterpartyCreateParams::LegalEntity#business_designation
819
+ module BusinessDesignation
820
+ extend ModernTreasury::Internal::Type::Enum
821
+
822
+ EXEMPT_FINANCIAL_INSTITUTION = :exempt_financial_institution
823
+ NON_OPERATING_BUSINESS = :non_operating_business
824
+
825
+ # @!method self.values
826
+ # @return [Array<Symbol>]
827
+ end
828
+
806
829
  class Document < ModernTreasury::Internal::Type::BaseModel
807
830
  # @!attribute document_type
808
831
  # A category given to the document, can be `null`.
@@ -33,8 +33,8 @@ module ModernTreasury
33
33
 
34
34
  # @!attribute documentable_type
35
35
  # The type of the associated object. Currently can be one of `payment_order`,
36
- # `transaction`, `expected_payment`, `counterparty`, `organization`, `case`,
37
- # `internal_account`, `decision`, or `external_account`.
36
+ # `transaction`, `expected_payment`, `return`, `legal_entity`, `counterparty`,
37
+ # `organization`, `case`, `internal_account`, `decision`, or `external_account`.
38
38
  #
39
39
  # @return [Symbol, ModernTreasury::Models::Document::DocumentableType, nil]
40
40
  required :documentable_type, enum: -> { ModernTreasury::Document::DocumentableType }, nil?: true
@@ -94,8 +94,8 @@ module ModernTreasury
94
94
  # @param updated_at [Time]
95
95
 
96
96
  # The type of the associated object. Currently can be one of `payment_order`,
97
- # `transaction`, `expected_payment`, `counterparty`, `organization`, `case`,
98
- # `internal_account`, `decision`, or `external_account`.
97
+ # `transaction`, `expected_payment`, `return`, `legal_entity`, `counterparty`,
98
+ # `organization`, `case`, `internal_account`, `decision`, or `external_account`.
99
99
  #
100
100
  # @see ModernTreasury::Models::Document#documentable_type
101
101
  module DocumentableType
@@ -111,6 +111,7 @@ module ModernTreasury
111
111
  LEGAL_ENTITY = :legal_entity
112
112
  ORGANIZATION = :organization
113
113
  PAYMENT_ORDER = :payment_order
114
+ RETURN = :return
114
115
  TRANSACTION = :transaction
115
116
 
116
117
  # @!method self.values
@@ -53,6 +53,7 @@ module ModernTreasury
53
53
  LEGAL_ENTITY = :legal_entity
54
54
  ORGANIZATION = :organization
55
55
  PAYMENT_ORDER = :payment_order
56
+ RETURN = :return
56
57
  TRANSACTION = :transaction
57
58
 
58
59
  # @!method self.values
@@ -20,8 +20,8 @@ module ModernTreasury
20
20
 
21
21
  # @!attribute documentable_type
22
22
  # The type of the associated object. Currently can be one of `payment_order`,
23
- # `transaction`, `expected_payment`, `counterparty`, `organization`, `case`,
24
- # `internal_account`, `decision`, or `external_account`.
23
+ # `transaction`, `expected_payment`, `return`, `legal_entity`, `counterparty`,
24
+ # `organization`, `case`, `internal_account`, `decision`, or `external_account`.
25
25
  #
26
26
  # @return [Symbol, ModernTreasury::Models::DocumentListParams::DocumentableType, nil]
27
27
  optional :documentable_type, enum: -> { ModernTreasury::DocumentListParams::DocumentableType }
@@ -46,8 +46,8 @@ module ModernTreasury
46
46
  # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
47
47
 
48
48
  # The type of the associated object. Currently can be one of `payment_order`,
49
- # `transaction`, `expected_payment`, `counterparty`, `organization`, `case`,
50
- # `internal_account`, `decision`, or `external_account`.
49
+ # `transaction`, `expected_payment`, `return`, `legal_entity`, `counterparty`,
50
+ # `organization`, `case`, `internal_account`, `decision`, or `external_account`.
51
51
  module DocumentableType
52
52
  extend ModernTreasury::Internal::Type::Enum
53
53
 
@@ -61,6 +61,7 @@ module ModernTreasury
61
61
  LEGAL_ENTITY = :legal_entity
62
62
  ORGANIZATION = :organization
63
63
  PAYMENT_ORDER = :payment_order
64
+ RETURN = :return
64
65
  TRANSACTION = :transaction
65
66
 
66
67
  # @!method self.values
@@ -20,6 +20,11 @@ module ModernTreasury
20
20
  # @return [Symbol, ModernTreasury::Models::ExternalAccountType]
21
21
  required :account_type, enum: -> { ModernTreasury::ExternalAccountType }
22
22
 
23
+ # @!attribute card_id
24
+ #
25
+ # @return [String, nil]
26
+ required :card_id, String, nil?: true
27
+
23
28
  # @!attribute contact_details
24
29
  #
25
30
  # @return [Array<ModernTreasury::Models::ContactDetail>]
@@ -119,7 +124,7 @@ module ModernTreasury
119
124
  # @return [Symbol, ModernTreasury::Models::ExternalAccount::VerificationStatus]
120
125
  required :verification_status, enum: -> { ModernTreasury::ExternalAccount::VerificationStatus }
121
126
 
122
- # @!method initialize(id:, account_details:, account_type:, contact_details:, counterparty_id:, created_at:, discarded_at:, external_id:, ledger_account_id:, live_mode:, metadata:, name:, object:, party_address:, party_name:, party_type:, routing_details:, updated_at:, verification_source:, verification_status:)
127
+ # @!method initialize(id:, account_details:, account_type:, card_id:, contact_details:, counterparty_id:, created_at:, discarded_at:, external_id:, ledger_account_id:, live_mode:, metadata:, name:, object:, party_address:, party_name:, party_type:, routing_details:, updated_at:, verification_source:, verification_status:)
123
128
  # Some parameter documentations has been truncated, see
124
129
  # {ModernTreasury::Models::ExternalAccount} for more details.
125
130
  #
@@ -129,6 +134,8 @@ module ModernTreasury
129
134
  #
130
135
  # @param account_type [Symbol, ModernTreasury::Models::ExternalAccountType] Can be `checking`, `savings` or `other`.
131
136
  #
137
+ # @param card_id [String, nil]
138
+ #
132
139
  # @param contact_details [Array<ModernTreasury::Models::ContactDetail>]
133
140
  #
134
141
  # @param counterparty_id [String, nil]
@@ -358,10 +358,10 @@ module ModernTreasury
358
358
  module RequestedAccountNumberType
359
359
  extend ModernTreasury::Internal::Type::Enum
360
360
 
361
+ BASE_ADDRESS = :base_address
361
362
  ETHEREUM_ADDRESS = :ethereum_address
362
- SOLANA_ADDRESS = :solana_address
363
363
  POLYGON_ADDRESS = :polygon_address
364
- BASE_ADDRESS = :base_address
364
+ SOLANA_ADDRESS = :solana_address
365
365
 
366
366
  # @!method self.values
367
367
  # @return [Array<Symbol>]
@@ -55,7 +55,14 @@ module ModernTreasury
55
55
  # @return [String, nil]
56
56
  optional :parent_account_id, String
57
57
 
58
- # @!method initialize(id:, contra_ledger_account_id: nil, counterparty_id: nil, external_id: nil, ledger_account_id: nil, metadata: nil, name: nil, parent_account_id: nil, request_options: {})
58
+ # @!attribute status
59
+ # Requests closure of the internal account. The resulting status may be `closed`
60
+ # for vendors that close synchronously.
61
+ #
62
+ # @return [Symbol, ModernTreasury::Models::InternalAccountUpdateParams::Status, nil]
63
+ optional :status, enum: -> { ModernTreasury::InternalAccountUpdateParams::Status }
64
+
65
+ # @!method initialize(id:, contra_ledger_account_id: nil, counterparty_id: nil, external_id: nil, ledger_account_id: nil, metadata: nil, name: nil, parent_account_id: nil, status: nil, request_options: {})
59
66
  # Some parameter documentations has been truncated, see
60
67
  # {ModernTreasury::Models::InternalAccountUpdateParams} for more details.
61
68
  #
@@ -75,7 +82,20 @@ module ModernTreasury
75
82
  #
76
83
  # @param parent_account_id [String] The parent internal account for this account.
77
84
  #
85
+ # @param status [Symbol, ModernTreasury::Models::InternalAccountUpdateParams::Status] Requests closure of the internal account. The resulting status may be `closed` f
86
+ #
78
87
  # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
88
+
89
+ # Requests closure of the internal account. The resulting status may be `closed`
90
+ # for vendors that close synchronously.
91
+ module Status
92
+ extend ModernTreasury::Internal::Type::Enum
93
+
94
+ PENDING_CLOSURE = :pending_closure
95
+
96
+ # @!method self.values
97
+ # @return [Array<Symbol>]
98
+ end
79
99
  end
80
100
  end
81
101
  end
@@ -187,9 +187,8 @@ module ModernTreasury
187
187
 
188
188
  # @!attribute vendor_code_type
189
189
  # The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`,
190
- # `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
191
- # `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `silvergate`, `swift`, or
192
- # `us_bank`.
190
+ # `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dwolla`, `evolve`,
191
+ # `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `silvergate`, `swift`, or `us_bank`.
193
192
  #
194
193
  # @return [String, nil]
195
194
  required :vendor_code_type, String, nil?: true
@@ -90,9 +90,8 @@ module ModernTreasury
90
90
 
91
91
  # @!attribute vendor_code_type
92
92
  # The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`,
93
- # `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
94
- # `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `silvergate`, `swift`, or
95
- # `us_bank`.
93
+ # `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dwolla`, `evolve`,
94
+ # `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `silvergate`, `swift`, or `us_bank`.
96
95
  #
97
96
  # @return [String, nil]
98
97
  required :vendor_code_type, String, nil?: true
@@ -174,7 +174,7 @@ module ModernTreasury
174
174
  # @!attribute status
175
175
  # Invoice status must be updated in a `PATCH` request that does not modify any
176
176
  # other invoice attributes. Valid state transitions are `draft` to `unpaid`,
177
- # `draft` or `unpaid` to `voided`, and `draft` or `unpaid` to `paid`.
177
+ # `draft`, `unpaid` or `paid` to `voided`, and `draft` or `unpaid` to `paid`.
178
178
  #
179
179
  # @return [String, nil]
180
180
  optional :status, String
@@ -0,0 +1,62 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ModernTreasury
4
+ module Models
5
+ # @see ModernTreasury::Resources::JournalSources#list
6
+ class JournalSourceListParams < ModernTreasury::Internal::Type::BaseModel
7
+ extend ModernTreasury::Internal::Type::RequestParameters::Converter
8
+ include ModernTreasury::Internal::Type::RequestParameters
9
+
10
+ # @!attribute journal_entry_id
11
+ # The ID of the journal entry
12
+ #
13
+ # @return [String, nil]
14
+ optional :journal_entry_id, String
15
+
16
+ # @!attribute journal_report_id
17
+ # The ID of the journal report
18
+ #
19
+ # @return [String, nil]
20
+ optional :journal_report_id, String
21
+
22
+ # @!attribute page
23
+ # Page number for pagination
24
+ #
25
+ # @return [Integer, nil]
26
+ optional :page, Integer
27
+
28
+ # @!attribute per_page
29
+ # Number of items per page
30
+ #
31
+ # @return [Integer, nil]
32
+ optional :per_page, Integer
33
+
34
+ # @!attribute source_id
35
+ # The ID of the source object
36
+ #
37
+ # @return [String, nil]
38
+ optional :source_id, String
39
+
40
+ # @!attribute source_type
41
+ # The type of the source object
42
+ #
43
+ # @return [String, nil]
44
+ optional :source_type, String
45
+
46
+ # @!method initialize(journal_entry_id: nil, journal_report_id: nil, page: nil, per_page: nil, source_id: nil, source_type: nil, request_options: {})
47
+ # @param journal_entry_id [String] The ID of the journal entry
48
+ #
49
+ # @param journal_report_id [String] The ID of the journal report
50
+ #
51
+ # @param page [Integer] Page number for pagination
52
+ #
53
+ # @param per_page [Integer] Number of items per page
54
+ #
55
+ # @param source_id [String] The ID of the source object
56
+ #
57
+ # @param source_type [String] The type of the source object
58
+ #
59
+ # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ModernTreasury
4
+ module Models
5
+ # @see ModernTreasury::Resources::JournalSources#retrieve
6
+ class JournalSourceRetrieveParams < 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