modern_treasury 0.10.0 → 0.12.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 (173) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +40 -0
  3. data/README.md +10 -1
  4. data/lib/modern_treasury/client.rb +12 -0
  5. data/lib/modern_treasury/internal/transport/pooled_net_requester.rb +12 -10
  6. data/lib/modern_treasury/internal/util.rb +7 -2
  7. data/lib/modern_treasury/models/bulk_request_create_params.rb +146 -2
  8. data/lib/modern_treasury/models/child_legal_entity.rb +609 -0
  9. data/lib/modern_treasury/models/child_legal_entity_create.rb +63 -1
  10. data/lib/modern_treasury/models/connection_legal_entity.rb +2 -0
  11. data/lib/modern_treasury/models/connection_legal_entity_create_params.rb +54 -63
  12. data/lib/modern_treasury/models/connection_legal_entity_list_params.rb +2 -0
  13. data/lib/modern_treasury/models/counterparty_create_params.rb +54 -59
  14. data/lib/modern_treasury/models/expected_payment.rb +69 -1
  15. data/lib/modern_treasury/models/expected_payment_create_params.rb +65 -1
  16. data/lib/modern_treasury/models/expected_payment_update_params.rb +65 -1
  17. data/lib/modern_treasury/models/hold_create_params.rb +74 -0
  18. data/lib/modern_treasury/models/hold_create_response.rb +143 -0
  19. data/lib/modern_treasury/models/hold_list_params.rb +89 -0
  20. data/lib/modern_treasury/models/hold_list_response.rb +143 -0
  21. data/lib/modern_treasury/models/hold_retrieve_params.rb +14 -0
  22. data/lib/modern_treasury/models/hold_retrieve_response.rb +143 -0
  23. data/lib/modern_treasury/models/hold_update_params.rb +40 -0
  24. data/lib/modern_treasury/models/hold_update_response.rb +143 -0
  25. data/lib/modern_treasury/models/incoming_payment_detail.rb +5 -0
  26. data/lib/modern_treasury/models/incoming_payment_detail_create_async_params.rb +5 -0
  27. data/lib/modern_treasury/models/incoming_payment_detail_list_params.rb +5 -0
  28. data/lib/modern_treasury/models/internal_account.rb +10 -1
  29. data/lib/modern_treasury/models/internal_account_request_closure_params.rb +14 -0
  30. data/lib/modern_treasury/models/internal_account_update_params.rb +9 -1
  31. data/lib/modern_treasury/models/invoice.rb +2 -0
  32. data/lib/modern_treasury/models/invoice_create_params.rb +1 -19
  33. data/lib/modern_treasury/models/invoice_update_params.rb +1 -19
  34. data/lib/modern_treasury/models/journal_entry_list_params.rb +38 -0
  35. data/lib/modern_treasury/models/journal_entry_retrieve_params.rb +14 -0
  36. data/lib/modern_treasury/models/journal_report_list_params.rb +14 -0
  37. data/lib/modern_treasury/models/journal_report_retrieve_params.rb +14 -0
  38. data/lib/modern_treasury/models/journal_report_update_params.rb +26 -0
  39. data/lib/modern_treasury/models/ledger_entry.rb +10 -1
  40. data/lib/modern_treasury/models/ledger_entry_create_request.rb +10 -1
  41. data/lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb +10 -1
  42. data/lib/modern_treasury/models/legal_entity.rb +61 -11
  43. data/lib/modern_treasury/models/legal_entity_association.rb +3 -559
  44. data/lib/modern_treasury/models/legal_entity_association_inline_create.rb +60 -0
  45. data/lib/modern_treasury/models/legal_entity_create_params.rb +54 -59
  46. data/lib/modern_treasury/models/legal_entity_update_params.rb +51 -1
  47. data/lib/modern_treasury/models/payment_order.rb +5 -1
  48. data/lib/modern_treasury/models/payment_order_subtype.rb +0 -1
  49. data/lib/modern_treasury/models/payment_reference.rb +5 -1
  50. data/lib/modern_treasury/models/return_object.rb +6 -1
  51. data/lib/modern_treasury/models/transaction.rb +2 -1
  52. data/lib/modern_treasury/models.rb +24 -0
  53. data/lib/modern_treasury/resources/expected_payments.rb +18 -2
  54. data/lib/modern_treasury/resources/holds.rb +126 -0
  55. data/lib/modern_treasury/resources/internal_accounts.rb +23 -1
  56. data/lib/modern_treasury/resources/invoices.rb +2 -10
  57. data/lib/modern_treasury/resources/journal_entries.rb +60 -0
  58. data/lib/modern_treasury/resources/journal_reports.rb +78 -0
  59. data/lib/modern_treasury/resources/ledger_accounts.rb +3 -3
  60. data/lib/modern_treasury/resources/ledger_transactions.rb +5 -2
  61. data/lib/modern_treasury/resources/legal_entities.rb +27 -3
  62. data/lib/modern_treasury/version.rb +1 -1
  63. data/lib/modern_treasury.rb +20 -0
  64. data/manifest.yaml +1 -0
  65. data/rbi/modern_treasury/client.rbi +9 -0
  66. data/rbi/modern_treasury/models/bulk_request_create_params.rbi +272 -0
  67. data/rbi/modern_treasury/models/child_legal_entity.rbi +969 -0
  68. data/rbi/modern_treasury/models/child_legal_entity_create.rbi +78 -0
  69. data/rbi/modern_treasury/models/connection_legal_entity.rbi +10 -0
  70. data/rbi/modern_treasury/models/connection_legal_entity_create_params.rbi +61 -135
  71. data/rbi/modern_treasury/models/connection_legal_entity_list_params.rbi +10 -0
  72. data/rbi/modern_treasury/models/counterparty_create_params.rbi +61 -135
  73. data/rbi/modern_treasury/models/expected_payment.rbi +136 -0
  74. data/rbi/modern_treasury/models/expected_payment_create_params.rbi +136 -0
  75. data/rbi/modern_treasury/models/expected_payment_update_params.rbi +136 -0
  76. data/rbi/modern_treasury/models/hold_create_params.rbi +125 -0
  77. data/rbi/modern_treasury/models/hold_create_response.rbi +232 -0
  78. data/rbi/modern_treasury/models/hold_list_params.rbi +150 -0
  79. data/rbi/modern_treasury/models/hold_list_response.rbi +225 -0
  80. data/rbi/modern_treasury/models/hold_retrieve_params.rbi +32 -0
  81. data/rbi/modern_treasury/models/hold_retrieve_response.rbi +234 -0
  82. data/rbi/modern_treasury/models/hold_update_params.rbi +79 -0
  83. data/rbi/modern_treasury/models/hold_update_response.rbi +232 -0
  84. data/rbi/modern_treasury/models/incoming_payment_detail.rbi +25 -0
  85. data/rbi/modern_treasury/models/incoming_payment_detail_create_async_params.rbi +25 -0
  86. data/rbi/modern_treasury/models/incoming_payment_detail_list_params.rbi +25 -0
  87. data/rbi/modern_treasury/models/internal_account.rbi +10 -0
  88. data/rbi/modern_treasury/models/internal_account_request_closure_params.rbi +32 -0
  89. data/rbi/modern_treasury/models/internal_account_update_params.rbi +11 -0
  90. data/rbi/modern_treasury/models/invoice_create_params.rbi +0 -20
  91. data/rbi/modern_treasury/models/invoice_update_params.rbi +0 -20
  92. data/rbi/modern_treasury/models/journal_entry_list_params.rbi +68 -0
  93. data/rbi/modern_treasury/models/journal_entry_retrieve_params.rbi +32 -0
  94. data/rbi/modern_treasury/models/journal_report_list_params.rbi +32 -0
  95. data/rbi/modern_treasury/models/journal_report_retrieve_params.rbi +32 -0
  96. data/rbi/modern_treasury/models/journal_report_update_params.rbi +52 -0
  97. data/rbi/modern_treasury/models/ledger_entry.rbi +10 -0
  98. data/rbi/modern_treasury/models/ledger_entry_create_request.rbi +13 -0
  99. data/rbi/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbi +10 -0
  100. data/rbi/modern_treasury/models/legal_entity.rbi +67 -15
  101. data/rbi/modern_treasury/models/legal_entity_association.rbi +4 -962
  102. data/rbi/modern_treasury/models/legal_entity_association_inline_create.rbi +130 -0
  103. data/rbi/modern_treasury/models/legal_entity_create_params.rbi +61 -134
  104. data/rbi/modern_treasury/models/legal_entity_update_params.rbi +58 -0
  105. data/rbi/modern_treasury/models/payment_order.rbi +22 -2
  106. data/rbi/modern_treasury/models/payment_order_subtype.rbi +0 -1
  107. data/rbi/modern_treasury/models/payment_reference.rbi +22 -2
  108. data/rbi/modern_treasury/models/return_object.rbi +24 -2
  109. data/rbi/modern_treasury/models/transaction.rbi +7 -2
  110. data/rbi/modern_treasury/models.rbi +28 -0
  111. data/rbi/modern_treasury/resources/expected_payments.rbi +44 -0
  112. data/rbi/modern_treasury/resources/holds.rbi +108 -0
  113. data/rbi/modern_treasury/resources/internal_accounts.rbi +17 -0
  114. data/rbi/modern_treasury/resources/invoices.rbi +0 -16
  115. data/rbi/modern_treasury/resources/journal_entries.rbi +46 -0
  116. data/rbi/modern_treasury/resources/journal_reports.rbi +51 -0
  117. data/rbi/modern_treasury/resources/ledger_accounts.rbi +3 -3
  118. data/rbi/modern_treasury/resources/ledger_transactions.rbi +3 -2
  119. data/rbi/modern_treasury/resources/legal_entities.rbi +41 -1
  120. data/sig/modern_treasury/client.rbs +6 -0
  121. data/sig/modern_treasury/models/bulk_request_create_params.rbs +84 -0
  122. data/sig/modern_treasury/models/child_legal_entity.rbs +469 -0
  123. data/sig/modern_treasury/models/child_legal_entity_create.rbs +39 -0
  124. data/sig/modern_treasury/models/connection_legal_entity.rbs +4 -1
  125. data/sig/modern_treasury/models/connection_legal_entity_create_params.rbs +38 -60
  126. data/sig/modern_treasury/models/connection_legal_entity_list_params.rbs +4 -1
  127. data/sig/modern_treasury/models/counterparty_create_params.rbs +38 -60
  128. data/sig/modern_treasury/models/expected_payment.rbs +42 -0
  129. data/sig/modern_treasury/models/expected_payment_create_params.rbs +42 -0
  130. data/sig/modern_treasury/models/expected_payment_update_params.rbs +42 -0
  131. data/sig/modern_treasury/models/hold_create_params.rbs +66 -0
  132. data/sig/modern_treasury/models/hold_create_response.rbs +108 -0
  133. data/sig/modern_treasury/models/hold_list_params.rbs +76 -0
  134. data/sig/modern_treasury/models/hold_list_response.rbs +108 -0
  135. data/sig/modern_treasury/models/hold_retrieve_params.rbs +15 -0
  136. data/sig/modern_treasury/models/hold_retrieve_response.rbs +108 -0
  137. data/sig/modern_treasury/models/hold_update_params.rbs +41 -0
  138. data/sig/modern_treasury/models/hold_update_response.rbs +108 -0
  139. data/sig/modern_treasury/models/incoming_payment_detail.rbs +10 -0
  140. data/sig/modern_treasury/models/incoming_payment_detail_create_async_params.rbs +10 -0
  141. data/sig/modern_treasury/models/incoming_payment_detail_list_params.rbs +10 -0
  142. data/sig/modern_treasury/models/internal_account.rbs +5 -0
  143. data/sig/modern_treasury/models/internal_account_request_closure_params.rbs +15 -0
  144. data/sig/modern_treasury/models/internal_account_update_params.rbs +7 -0
  145. data/sig/modern_treasury/models/invoice_create_params.rbs +0 -10
  146. data/sig/modern_treasury/models/invoice_update_params.rbs +0 -10
  147. data/sig/modern_treasury/models/journal_entry_list_params.rbs +36 -0
  148. data/sig/modern_treasury/models/journal_entry_retrieve_params.rbs +15 -0
  149. data/sig/modern_treasury/models/journal_report_list_params.rbs +15 -0
  150. data/sig/modern_treasury/models/journal_report_retrieve_params.rbs +15 -0
  151. data/sig/modern_treasury/models/journal_report_update_params.rbs +32 -0
  152. data/sig/modern_treasury/models/ledger_entry.rbs +5 -0
  153. data/sig/modern_treasury/models/ledger_entry_create_request.rbs +7 -0
  154. data/sig/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbs +5 -0
  155. data/sig/modern_treasury/models/legal_entity.rbs +38 -8
  156. data/sig/modern_treasury/models/legal_entity_association.rbs +4 -435
  157. data/sig/modern_treasury/models/legal_entity_association_inline_create.rbs +59 -0
  158. data/sig/modern_treasury/models/legal_entity_create_params.rbs +38 -60
  159. data/sig/modern_treasury/models/legal_entity_update_params.rbs +34 -0
  160. data/sig/modern_treasury/models/payment_order.rbs +10 -2
  161. data/sig/modern_treasury/models/payment_order_subtype.rbs +0 -2
  162. data/sig/modern_treasury/models/payment_reference.rbs +10 -2
  163. data/sig/modern_treasury/models/return_object.rbs +12 -2
  164. data/sig/modern_treasury/models/transaction.rbs +4 -2
  165. data/sig/modern_treasury/models.rbs +24 -0
  166. data/sig/modern_treasury/resources/expected_payments.rbs +8 -0
  167. data/sig/modern_treasury/resources/holds.rbs +38 -0
  168. data/sig/modern_treasury/resources/internal_accounts.rbs +6 -0
  169. data/sig/modern_treasury/resources/invoices.rbs +0 -4
  170. data/sig/modern_treasury/resources/journal_entries.rbs +19 -0
  171. data/sig/modern_treasury/resources/journal_reports.rbs +21 -0
  172. data/sig/modern_treasury/resources/legal_entities.rbs +13 -1
  173. metadata +59 -2
@@ -0,0 +1,143 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ModernTreasury
4
+ module Models
5
+ # @see ModernTreasury::Resources::Holds#list
6
+ class HoldListResponse < 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 object
18
+ # The type of object
19
+ #
20
+ # @return [Symbol, ModernTreasury::Models::HoldListResponse::Object]
21
+ required :object, enum: -> { ModernTreasury::Models::HoldListResponse::Object }
22
+
23
+ # @!attribute status
24
+ # The status of the hold
25
+ #
26
+ # @return [Symbol, ModernTreasury::Models::HoldListResponse::Status]
27
+ required :status, enum: -> { ModernTreasury::Models::HoldListResponse::Status }
28
+
29
+ # @!attribute target_id
30
+ # The ID of the target being held
31
+ #
32
+ # @return [String]
33
+ required :target_id, String
34
+
35
+ # @!attribute target_type
36
+ # The type of target being held
37
+ #
38
+ # @return [Symbol, ModernTreasury::Models::HoldListResponse::TargetType]
39
+ required :target_type, enum: -> { ModernTreasury::Models::HoldListResponse::TargetType }
40
+
41
+ # @!attribute updated_at
42
+ #
43
+ # @return [Time]
44
+ required :updated_at, Time
45
+
46
+ # @!attribute live_mode
47
+ # This field will be true if this object exists in the live environment or false
48
+ # if it exists in the test environment.
49
+ #
50
+ # @return [Boolean, nil]
51
+ optional :live_mode, ModernTreasury::Internal::Type::Boolean
52
+
53
+ # @!attribute metadata
54
+ # Additional metadata for the hold
55
+ #
56
+ # @return [Hash{Symbol=>String}, nil]
57
+ optional :metadata, ModernTreasury::Internal::Type::HashOf[String], nil?: true
58
+
59
+ # @!attribute reason
60
+ # The reason for the hold
61
+ #
62
+ # @return [String, nil]
63
+ optional :reason, String, nil?: true
64
+
65
+ # @!attribute resolution
66
+ # The resolution of the hold
67
+ #
68
+ # @return [String, nil]
69
+ optional :resolution, String, nil?: true
70
+
71
+ # @!attribute resolved_at
72
+ # When the hold was resolved
73
+ #
74
+ # @return [Time, nil]
75
+ optional :resolved_at, Time, nil?: true
76
+
77
+ # @!method initialize(id:, created_at:, object:, status:, target_id:, target_type:, updated_at:, live_mode: nil, metadata: nil, reason: nil, resolution: nil, resolved_at: nil)
78
+ # Some parameter documentations has been truncated, see
79
+ # {ModernTreasury::Models::HoldListResponse} for more details.
80
+ #
81
+ # @param id [String]
82
+ #
83
+ # @param created_at [Time]
84
+ #
85
+ # @param object [Symbol, ModernTreasury::Models::HoldListResponse::Object] The type of object
86
+ #
87
+ # @param status [Symbol, ModernTreasury::Models::HoldListResponse::Status] The status of the hold
88
+ #
89
+ # @param target_id [String] The ID of the target being held
90
+ #
91
+ # @param target_type [Symbol, ModernTreasury::Models::HoldListResponse::TargetType] The type of target being held
92
+ #
93
+ # @param updated_at [Time]
94
+ #
95
+ # @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
96
+ #
97
+ # @param metadata [Hash{Symbol=>String}, nil] Additional metadata for the hold
98
+ #
99
+ # @param reason [String, nil] The reason for the hold
100
+ #
101
+ # @param resolution [String, nil] The resolution of the hold
102
+ #
103
+ # @param resolved_at [Time, nil] When the hold was resolved
104
+
105
+ # The type of object
106
+ #
107
+ # @see ModernTreasury::Models::HoldListResponse#object
108
+ module Object
109
+ extend ModernTreasury::Internal::Type::Enum
110
+
111
+ HOLD = :hold
112
+
113
+ # @!method self.values
114
+ # @return [Array<Symbol>]
115
+ end
116
+
117
+ # The status of the hold
118
+ #
119
+ # @see ModernTreasury::Models::HoldListResponse#status
120
+ module Status
121
+ extend ModernTreasury::Internal::Type::Enum
122
+
123
+ ACTIVE = :active
124
+ RESOLVED = :resolved
125
+
126
+ # @!method self.values
127
+ # @return [Array<Symbol>]
128
+ end
129
+
130
+ # The type of target being held
131
+ #
132
+ # @see ModernTreasury::Models::HoldListResponse#target_type
133
+ module TargetType
134
+ extend ModernTreasury::Internal::Type::Enum
135
+
136
+ PAYMENT_ORDER = :payment_order
137
+
138
+ # @!method self.values
139
+ # @return [Array<Symbol>]
140
+ end
141
+ end
142
+ end
143
+ end
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ModernTreasury
4
+ module Models
5
+ # @see ModernTreasury::Resources::Holds#retrieve
6
+ class HoldRetrieveParams < ModernTreasury::Internal::Type::BaseModel
7
+ extend ModernTreasury::Internal::Type::RequestParameters::Converter
8
+ include ModernTreasury::Internal::Type::RequestParameters
9
+
10
+ # @!method initialize(request_options: {})
11
+ # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,143 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ModernTreasury
4
+ module Models
5
+ # @see ModernTreasury::Resources::Holds#retrieve
6
+ class HoldRetrieveResponse < 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 object
18
+ # The type of object
19
+ #
20
+ # @return [Symbol, ModernTreasury::Models::HoldRetrieveResponse::Object]
21
+ required :object, enum: -> { ModernTreasury::Models::HoldRetrieveResponse::Object }
22
+
23
+ # @!attribute status
24
+ # The status of the hold
25
+ #
26
+ # @return [Symbol, ModernTreasury::Models::HoldRetrieveResponse::Status]
27
+ required :status, enum: -> { ModernTreasury::Models::HoldRetrieveResponse::Status }
28
+
29
+ # @!attribute target_id
30
+ # The ID of the target being held
31
+ #
32
+ # @return [String]
33
+ required :target_id, String
34
+
35
+ # @!attribute target_type
36
+ # The type of target being held
37
+ #
38
+ # @return [Symbol, ModernTreasury::Models::HoldRetrieveResponse::TargetType]
39
+ required :target_type, enum: -> { ModernTreasury::Models::HoldRetrieveResponse::TargetType }
40
+
41
+ # @!attribute updated_at
42
+ #
43
+ # @return [Time]
44
+ required :updated_at, Time
45
+
46
+ # @!attribute live_mode
47
+ # This field will be true if this object exists in the live environment or false
48
+ # if it exists in the test environment.
49
+ #
50
+ # @return [Boolean, nil]
51
+ optional :live_mode, ModernTreasury::Internal::Type::Boolean
52
+
53
+ # @!attribute metadata
54
+ # Additional metadata for the hold
55
+ #
56
+ # @return [Hash{Symbol=>String}, nil]
57
+ optional :metadata, ModernTreasury::Internal::Type::HashOf[String], nil?: true
58
+
59
+ # @!attribute reason
60
+ # The reason for the hold
61
+ #
62
+ # @return [String, nil]
63
+ optional :reason, String, nil?: true
64
+
65
+ # @!attribute resolution
66
+ # The resolution of the hold
67
+ #
68
+ # @return [String, nil]
69
+ optional :resolution, String, nil?: true
70
+
71
+ # @!attribute resolved_at
72
+ # When the hold was resolved
73
+ #
74
+ # @return [Time, nil]
75
+ optional :resolved_at, Time, nil?: true
76
+
77
+ # @!method initialize(id:, created_at:, object:, status:, target_id:, target_type:, updated_at:, live_mode: nil, metadata: nil, reason: nil, resolution: nil, resolved_at: nil)
78
+ # Some parameter documentations has been truncated, see
79
+ # {ModernTreasury::Models::HoldRetrieveResponse} for more details.
80
+ #
81
+ # @param id [String]
82
+ #
83
+ # @param created_at [Time]
84
+ #
85
+ # @param object [Symbol, ModernTreasury::Models::HoldRetrieveResponse::Object] The type of object
86
+ #
87
+ # @param status [Symbol, ModernTreasury::Models::HoldRetrieveResponse::Status] The status of the hold
88
+ #
89
+ # @param target_id [String] The ID of the target being held
90
+ #
91
+ # @param target_type [Symbol, ModernTreasury::Models::HoldRetrieveResponse::TargetType] The type of target being held
92
+ #
93
+ # @param updated_at [Time]
94
+ #
95
+ # @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
96
+ #
97
+ # @param metadata [Hash{Symbol=>String}, nil] Additional metadata for the hold
98
+ #
99
+ # @param reason [String, nil] The reason for the hold
100
+ #
101
+ # @param resolution [String, nil] The resolution of the hold
102
+ #
103
+ # @param resolved_at [Time, nil] When the hold was resolved
104
+
105
+ # The type of object
106
+ #
107
+ # @see ModernTreasury::Models::HoldRetrieveResponse#object
108
+ module Object
109
+ extend ModernTreasury::Internal::Type::Enum
110
+
111
+ HOLD = :hold
112
+
113
+ # @!method self.values
114
+ # @return [Array<Symbol>]
115
+ end
116
+
117
+ # The status of the hold
118
+ #
119
+ # @see ModernTreasury::Models::HoldRetrieveResponse#status
120
+ module Status
121
+ extend ModernTreasury::Internal::Type::Enum
122
+
123
+ ACTIVE = :active
124
+ RESOLVED = :resolved
125
+
126
+ # @!method self.values
127
+ # @return [Array<Symbol>]
128
+ end
129
+
130
+ # The type of target being held
131
+ #
132
+ # @see ModernTreasury::Models::HoldRetrieveResponse#target_type
133
+ module TargetType
134
+ extend ModernTreasury::Internal::Type::Enum
135
+
136
+ PAYMENT_ORDER = :payment_order
137
+
138
+ # @!method self.values
139
+ # @return [Array<Symbol>]
140
+ end
141
+ end
142
+ end
143
+ end
@@ -0,0 +1,40 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ModernTreasury
4
+ module Models
5
+ # @see ModernTreasury::Resources::Holds#update
6
+ class HoldUpdateParams < ModernTreasury::Internal::Type::BaseModel
7
+ extend ModernTreasury::Internal::Type::RequestParameters::Converter
8
+ include ModernTreasury::Internal::Type::RequestParameters
9
+
10
+ # @!attribute status
11
+ # The new status of the hold
12
+ #
13
+ # @return [Symbol, ModernTreasury::Models::HoldUpdateParams::Status]
14
+ required :status, enum: -> { ModernTreasury::HoldUpdateParams::Status }
15
+
16
+ # @!attribute resolution
17
+ # The resolution of the hold
18
+ #
19
+ # @return [String, nil]
20
+ optional :resolution, String, nil?: true
21
+
22
+ # @!method initialize(status:, resolution: nil, request_options: {})
23
+ # @param status [Symbol, ModernTreasury::Models::HoldUpdateParams::Status] The new status of the hold
24
+ #
25
+ # @param resolution [String, nil] The resolution of the hold
26
+ #
27
+ # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
28
+
29
+ # The new status of the hold
30
+ module Status
31
+ extend ModernTreasury::Internal::Type::Enum
32
+
33
+ RESOLVED = :resolved
34
+
35
+ # @!method self.values
36
+ # @return [Array<Symbol>]
37
+ end
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,143 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ModernTreasury
4
+ module Models
5
+ # @see ModernTreasury::Resources::Holds#update
6
+ class HoldUpdateResponse < 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 object
18
+ # The type of object
19
+ #
20
+ # @return [Symbol, ModernTreasury::Models::HoldUpdateResponse::Object]
21
+ required :object, enum: -> { ModernTreasury::Models::HoldUpdateResponse::Object }
22
+
23
+ # @!attribute status
24
+ # The status of the hold
25
+ #
26
+ # @return [Symbol, ModernTreasury::Models::HoldUpdateResponse::Status]
27
+ required :status, enum: -> { ModernTreasury::Models::HoldUpdateResponse::Status }
28
+
29
+ # @!attribute target_id
30
+ # The ID of the target being held
31
+ #
32
+ # @return [String]
33
+ required :target_id, String
34
+
35
+ # @!attribute target_type
36
+ # The type of target being held
37
+ #
38
+ # @return [Symbol, ModernTreasury::Models::HoldUpdateResponse::TargetType]
39
+ required :target_type, enum: -> { ModernTreasury::Models::HoldUpdateResponse::TargetType }
40
+
41
+ # @!attribute updated_at
42
+ #
43
+ # @return [Time]
44
+ required :updated_at, Time
45
+
46
+ # @!attribute live_mode
47
+ # This field will be true if this object exists in the live environment or false
48
+ # if it exists in the test environment.
49
+ #
50
+ # @return [Boolean, nil]
51
+ optional :live_mode, ModernTreasury::Internal::Type::Boolean
52
+
53
+ # @!attribute metadata
54
+ # Additional metadata for the hold
55
+ #
56
+ # @return [Hash{Symbol=>String}, nil]
57
+ optional :metadata, ModernTreasury::Internal::Type::HashOf[String], nil?: true
58
+
59
+ # @!attribute reason
60
+ # The reason for the hold
61
+ #
62
+ # @return [String, nil]
63
+ optional :reason, String, nil?: true
64
+
65
+ # @!attribute resolution
66
+ # The resolution of the hold
67
+ #
68
+ # @return [String, nil]
69
+ optional :resolution, String, nil?: true
70
+
71
+ # @!attribute resolved_at
72
+ # When the hold was resolved
73
+ #
74
+ # @return [Time, nil]
75
+ optional :resolved_at, Time, nil?: true
76
+
77
+ # @!method initialize(id:, created_at:, object:, status:, target_id:, target_type:, updated_at:, live_mode: nil, metadata: nil, reason: nil, resolution: nil, resolved_at: nil)
78
+ # Some parameter documentations has been truncated, see
79
+ # {ModernTreasury::Models::HoldUpdateResponse} for more details.
80
+ #
81
+ # @param id [String]
82
+ #
83
+ # @param created_at [Time]
84
+ #
85
+ # @param object [Symbol, ModernTreasury::Models::HoldUpdateResponse::Object] The type of object
86
+ #
87
+ # @param status [Symbol, ModernTreasury::Models::HoldUpdateResponse::Status] The status of the hold
88
+ #
89
+ # @param target_id [String] The ID of the target being held
90
+ #
91
+ # @param target_type [Symbol, ModernTreasury::Models::HoldUpdateResponse::TargetType] The type of target being held
92
+ #
93
+ # @param updated_at [Time]
94
+ #
95
+ # @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
96
+ #
97
+ # @param metadata [Hash{Symbol=>String}, nil] Additional metadata for the hold
98
+ #
99
+ # @param reason [String, nil] The reason for the hold
100
+ #
101
+ # @param resolution [String, nil] The resolution of the hold
102
+ #
103
+ # @param resolved_at [Time, nil] When the hold was resolved
104
+
105
+ # The type of object
106
+ #
107
+ # @see ModernTreasury::Models::HoldUpdateResponse#object
108
+ module Object
109
+ extend ModernTreasury::Internal::Type::Enum
110
+
111
+ HOLD = :hold
112
+
113
+ # @!method self.values
114
+ # @return [Array<Symbol>]
115
+ end
116
+
117
+ # The status of the hold
118
+ #
119
+ # @see ModernTreasury::Models::HoldUpdateResponse#status
120
+ module Status
121
+ extend ModernTreasury::Internal::Type::Enum
122
+
123
+ ACTIVE = :active
124
+ RESOLVED = :resolved
125
+
126
+ # @!method self.values
127
+ # @return [Array<Symbol>]
128
+ end
129
+
130
+ # The type of target being held
131
+ #
132
+ # @see ModernTreasury::Models::HoldUpdateResponse#target_type
133
+ module TargetType
134
+ extend ModernTreasury::Internal::Type::Enum
135
+
136
+ PAYMENT_ORDER = :payment_order
137
+
138
+ # @!method self.values
139
+ # @return [Array<Symbol>]
140
+ end
141
+ end
142
+ end
143
+ end
@@ -323,16 +323,21 @@ module ModernTreasury
323
323
  ACH = :ach
324
324
  AU_BECS = :au_becs
325
325
  BACS = :bacs
326
+ BASE = :base
326
327
  BOOK = :book
327
328
  CHECK = :check
328
329
  EFT = :eft
330
+ ETHEREUM = :ethereum
329
331
  INTERAC = :interac
330
332
  NEFT = :neft
331
333
  NZ_BECS = :nz_becs
334
+ POLYGON = :polygon
332
335
  RTP = :rtp
333
336
  SEPA = :sepa
334
337
  SIGNET = :signet
338
+ SOLANA = :solana
335
339
  WIRE = :wire
340
+ ZENGIN = :zengin
336
341
 
337
342
  # @!method self.values
338
343
  # @return [Array<Symbol>]
@@ -107,16 +107,21 @@ module ModernTreasury
107
107
  ACH = :ach
108
108
  AU_BECS = :au_becs
109
109
  BACS = :bacs
110
+ BASE = :base
110
111
  BOOK = :book
111
112
  CHECK = :check
112
113
  EFT = :eft
114
+ ETHEREUM = :ethereum
113
115
  INTERAC = :interac
114
116
  NEFT = :neft
115
117
  NZ_BECS = :nz_becs
118
+ POLYGON = :polygon
116
119
  RTP = :rtp
117
120
  SEPA = :sepa
118
121
  SIGNET = :signet
122
+ SOLANA = :solana
119
123
  WIRE = :wire
124
+ ZENGIN = :zengin
120
125
 
121
126
  # @!method self.values
122
127
  # @return [Array<Symbol>]
@@ -111,16 +111,21 @@ module ModernTreasury
111
111
  ACH = :ach
112
112
  AU_BECS = :au_becs
113
113
  BACS = :bacs
114
+ BASE = :base
114
115
  BOOK = :book
115
116
  CHECK = :check
116
117
  EFT = :eft
118
+ ETHEREUM = :ethereum
117
119
  INTERAC = :interac
118
120
  NEFT = :neft
119
121
  NZ_BECS = :nz_becs
122
+ POLYGON = :polygon
120
123
  RTP = :rtp
121
124
  SEPA = :sepa
122
125
  SIGNET = :signet
126
+ SOLANA = :solana
123
127
  WIRE = :wire
128
+ ZENGIN = :zengin
124
129
 
125
130
  # @!method self.values
126
131
  # @return [Array<Symbol>]
@@ -35,6 +35,13 @@ module ModernTreasury
35
35
  # @return [ModernTreasury::Models::Connection]
36
36
  required :connection, -> { ModernTreasury::Connection }
37
37
 
38
+ # @!attribute contra_ledger_account_id
39
+ # If the internal account links to a contra ledger account in Modern Treasury, the
40
+ # id of the contra ledger account will be populated here.
41
+ #
42
+ # @return [String, nil]
43
+ required :contra_ledger_account_id, String, nil?: true
44
+
38
45
  # @!attribute counterparty_id
39
46
  # The Counterparty associated to this account.
40
47
  #
@@ -137,7 +144,7 @@ module ModernTreasury
137
144
  # @return [String, nil]
138
145
  required :vendor_id, String, nil?: true
139
146
 
140
- # @!method initialize(id:, account_capabilities:, account_details:, account_type:, connection:, counterparty_id:, created_at:, currency:, ledger_account_id:, legal_entity_id:, live_mode:, metadata:, name:, object:, parent_account_id:, party_address:, party_name:, party_type:, routing_details:, status:, updated_at:, vendor_id:)
147
+ # @!method initialize(id:, account_capabilities:, account_details:, account_type:, connection:, contra_ledger_account_id:, counterparty_id:, created_at:, currency:, ledger_account_id:, legal_entity_id:, live_mode:, metadata:, name:, object:, parent_account_id:, party_address:, party_name:, party_type:, routing_details:, status:, updated_at:, vendor_id:)
141
148
  # Some parameter documentations has been truncated, see
142
149
  # {ModernTreasury::Models::InternalAccount} for more details.
143
150
  #
@@ -151,6 +158,8 @@ module ModernTreasury
151
158
  #
152
159
  # @param connection [ModernTreasury::Models::Connection] Specifies which financial institution the accounts belong to.
153
160
  #
161
+ # @param contra_ledger_account_id [String, nil] If the internal account links to a contra ledger account in Modern Treasury, the
162
+ #
154
163
  # @param counterparty_id [String, nil] The Counterparty associated to this account.
155
164
  #
156
165
  # @param created_at [Time]
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ModernTreasury
4
+ module Models
5
+ # @see ModernTreasury::Resources::InternalAccounts#request_closure
6
+ class InternalAccountRequestClosureParams < ModernTreasury::Internal::Type::BaseModel
7
+ extend ModernTreasury::Internal::Type::RequestParameters::Converter
8
+ include ModernTreasury::Internal::Type::RequestParameters
9
+
10
+ # @!method initialize(request_options: {})
11
+ # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
12
+ end
13
+ end
14
+ end
@@ -7,6 +7,12 @@ module ModernTreasury
7
7
  extend ModernTreasury::Internal::Type::RequestParameters::Converter
8
8
  include ModernTreasury::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute contra_ledger_account_id
11
+ # The Contra Ledger Account associated to this account.
12
+ #
13
+ # @return [String, nil]
14
+ optional :contra_ledger_account_id, String
15
+
10
16
  # @!attribute counterparty_id
11
17
  # The Counterparty associated to this account.
12
18
  #
@@ -38,10 +44,12 @@ module ModernTreasury
38
44
  # @return [String, nil]
39
45
  optional :parent_account_id, String
40
46
 
41
- # @!method initialize(counterparty_id: nil, ledger_account_id: nil, metadata: nil, name: nil, parent_account_id: nil, request_options: {})
47
+ # @!method initialize(contra_ledger_account_id: nil, counterparty_id: nil, ledger_account_id: nil, metadata: nil, name: nil, parent_account_id: nil, request_options: {})
42
48
  # Some parameter documentations has been truncated, see
43
49
  # {ModernTreasury::Models::InternalAccountUpdateParams} for more details.
44
50
  #
51
+ # @param contra_ledger_account_id [String] The Contra Ledger Account associated to this account.
52
+ #
45
53
  # @param counterparty_id [String] The Counterparty associated to this account.
46
54
  #
47
55
  # @param ledger_account_id [String] The Ledger Account associated to this account.
@@ -108,6 +108,8 @@ module ModernTreasury
108
108
  required :invoicer_name, String, nil?: true
109
109
 
110
110
  # @!attribute ledger_account_settlement_id
111
+ # @deprecated
112
+ #
111
113
  # The ledger account settlement object linked to the invoice.
112
114
  #
113
115
  # @return [String, nil]
@@ -74,14 +74,6 @@ module ModernTreasury
74
74
  # @return [String, nil]
75
75
  optional :fallback_payment_method, String, nil?: true
76
76
 
77
- # @!attribute ingest_ledger_entries
78
- # Whether to ingest the ledger_entries to populate the invoice line items. If this
79
- # is false, then a line item must be provided. If this is true, line_items must be
80
- # empty. Ignored if ledger_account_settlement_id is empty.
81
- #
82
- # @return [Boolean, nil]
83
- optional :ingest_ledger_entries, ModernTreasury::Internal::Type::Boolean, nil?: true
84
-
85
77
  # @!attribute invoice_line_items
86
78
  # An array of invoice line items. The API supports a maximum of 50 invoice line
87
79
  # items per invoice. If a greater number of invoice line items is required, please
@@ -100,12 +92,6 @@ module ModernTreasury
100
92
  # @return [ModernTreasury::Models::InvoiceCreateParams::InvoicerAddress, nil]
101
93
  optional :invoicer_address, -> { ModernTreasury::InvoiceCreateParams::InvoicerAddress }, nil?: true
102
94
 
103
- # @!attribute ledger_account_settlement_id
104
- # The ID of the virtual account the invoice should be paid to.
105
- #
106
- # @return [String, nil]
107
- optional :ledger_account_settlement_id, String, nil?: true
108
-
109
95
  # @!attribute metadata
110
96
  # Additional data represented as key-value pairs. Both the key and value must be
111
97
  # strings.
@@ -188,7 +174,7 @@ module ModernTreasury
188
174
  # @return [String, nil]
189
175
  optional :virtual_account_id, String, nil?: true
190
176
 
191
- # @!method initialize(counterparty_id:, due_date:, originating_account_id:, auto_advance: nil, contact_details: nil, counterparty_billing_address: nil, counterparty_shipping_address: nil, currency: nil, description: nil, fallback_payment_method: nil, ingest_ledger_entries: nil, invoice_line_items: nil, invoicer_address: nil, ledger_account_settlement_id: nil, metadata: nil, notification_email_addresses: nil, notifications_enabled: nil, payment_effective_date: nil, payment_method: nil, payment_type: nil, receiving_account_id: nil, recipient_email: nil, recipient_name: nil, remind_after_overdue_days: nil, virtual_account_id: nil, request_options: {})
177
+ # @!method initialize(counterparty_id:, due_date:, originating_account_id:, auto_advance: nil, contact_details: nil, counterparty_billing_address: nil, counterparty_shipping_address: nil, currency: nil, description: nil, fallback_payment_method: nil, invoice_line_items: nil, invoicer_address: nil, metadata: nil, notification_email_addresses: nil, notifications_enabled: nil, payment_effective_date: nil, payment_method: nil, payment_type: nil, receiving_account_id: nil, recipient_email: nil, recipient_name: nil, remind_after_overdue_days: nil, virtual_account_id: nil, request_options: {})
192
178
  # Some parameter documentations has been truncated, see
193
179
  # {ModernTreasury::Models::InvoiceCreateParams} for more details.
194
180
  #
@@ -212,14 +198,10 @@ module ModernTreasury
212
198
  #
213
199
  # @param fallback_payment_method [String, nil] When payment_method is automatic, the fallback payment method to use when an aut
214
200
  #
215
- # @param ingest_ledger_entries [Boolean, nil] Whether to ingest the ledger_entries to populate the invoice line items. If this
216
- #
217
201
  # @param invoice_line_items [Array<ModernTreasury::Models::InvoiceCreateParams::InvoiceLineItem>, nil] An array of invoice line items. The API supports a maximum of 50 invoice line it
218
202
  #
219
203
  # @param invoicer_address [ModernTreasury::Models::InvoiceCreateParams::InvoicerAddress, nil] The invoice issuer's business address.
220
204
  #
221
- # @param ledger_account_settlement_id [String, nil] The ID of the virtual account the invoice should be paid to.
222
- #
223
205
  # @param metadata [Hash{Symbol=>String}, nil] Additional data represented as key-value pairs. Both the key and value must be s
224
206
  #
225
207
  # @param notification_email_addresses [Array<String>, nil] Emails in addition to the counterparty email to send invoice status notification