voltaria_sdk 2.34.5
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.
- checksums.yaml +7 -0
- data/.rubocop.yml +69 -0
- data/README.md +202 -0
- data/Rakefile +20 -0
- data/custom.gemspec.rb +16 -0
- data/lib/voltaria/accounts/client.rb +168 -0
- data/lib/voltaria/accounts/types/get_client_account_request.rb +12 -0
- data/lib/voltaria/accounts/types/list_client_account_fields_request.rb +11 -0
- data/lib/voltaria/accounts/types/list_client_accounts_request.rb +14 -0
- data/lib/voltaria/accounts/types/partner_client_account_create_request.rb +23 -0
- data/lib/voltaria/accounts/types/partner_client_account_create_request_status.rb +14 -0
- data/lib/voltaria/client.rb +74 -0
- data/lib/voltaria/clients/client.rb +557 -0
- data/lib/voltaria/clients/types/approve_onboarding_request.rb +11 -0
- data/lib/voltaria/clients/types/client_create_payload.rb +16 -0
- data/lib/voltaria/clients/types/client_data_create_payload.rb +12 -0
- data/lib/voltaria/clients/types/client_user_invite_request.rb +16 -0
- data/lib/voltaria/clients/types/delete_client_request.rb +11 -0
- data/lib/voltaria/clients/types/get_client_by_id_request.rb +11 -0
- data/lib/voltaria/clients/types/get_limit_request_request.rb +11 -0
- data/lib/voltaria/clients/types/limit_request_create_payload.rb +14 -0
- data/lib/voltaria/clients/types/limit_request_create_payload_requested_limit.rb +15 -0
- data/lib/voltaria/clients/types/list_client_checklist_summaries_request.rb +13 -0
- data/lib/voltaria/clients/types/list_client_waivers_request.rb +15 -0
- data/lib/voltaria/clients/types/list_clients_request.rb +14 -0
- data/lib/voltaria/clients/types/list_limit_requests_request.rb +15 -0
- data/lib/voltaria/clients/types/list_onboarding_clients_request.rb +12 -0
- data/lib/voltaria/clients/types/reject_onboarding_request.rb +11 -0
- data/lib/voltaria/documents/client.rb +221 -0
- data/lib/voltaria/documents/types/delete_document_request.rb +11 -0
- data/lib/voltaria/documents/types/document_create_payload.rb +14 -0
- data/lib/voltaria/documents/types/get_document_by_id_request.rb +11 -0
- data/lib/voltaria/documents/types/list_documents_request.rb +18 -0
- data/lib/voltaria/drawdowns/client.rb +141 -0
- data/lib/voltaria/drawdowns/types/drawdown_create_payload.rb +12 -0
- data/lib/voltaria/drawdowns/types/drawdown_create_payload_amount.rb +15 -0
- data/lib/voltaria/drawdowns/types/list_drawdown_checklists_request.rb +15 -0
- data/lib/voltaria/drawdowns/types/list_drawdowns_request.rb +14 -0
- data/lib/voltaria/environment.rb +8 -0
- data/lib/voltaria/errors/api_error.rb +8 -0
- data/lib/voltaria/errors/client_error.rb +17 -0
- data/lib/voltaria/errors/redirect_error.rb +8 -0
- data/lib/voltaria/errors/response_error.rb +42 -0
- data/lib/voltaria/errors/server_error.rb +11 -0
- data/lib/voltaria/errors/timeout_error.rb +8 -0
- data/lib/voltaria/installments/client.rb +292 -0
- data/lib/voltaria/installments/types/delete_installment_request.rb +11 -0
- data/lib/voltaria/installments/types/get_installment_by_id_request.rb +11 -0
- data/lib/voltaria/installments/types/installment_create_payload.rb +12 -0
- data/lib/voltaria/installments/types/installment_edit_payload.rb +13 -0
- data/lib/voltaria/installments/types/installment_edit_payload_amount.rb +15 -0
- data/lib/voltaria/installments/types/list_installments_request.rb +16 -0
- data/lib/voltaria/installments/types/list_payment_promises_request.rb +16 -0
- data/lib/voltaria/installments/types/payment_promise_create_payload.rb +14 -0
- data/lib/voltaria/installments/types/payment_promise_create_payload_amount.rb +15 -0
- data/lib/voltaria/internal/errors/constraint_error.rb +10 -0
- data/lib/voltaria/internal/errors/type_error.rb +10 -0
- data/lib/voltaria/internal/http/base_request.rb +51 -0
- data/lib/voltaria/internal/http/raw_client.rb +214 -0
- data/lib/voltaria/internal/iterators/cursor_item_iterator.rb +28 -0
- data/lib/voltaria/internal/iterators/cursor_page_iterator.rb +51 -0
- data/lib/voltaria/internal/iterators/item_iterator.rb +59 -0
- data/lib/voltaria/internal/iterators/offset_item_iterator.rb +30 -0
- data/lib/voltaria/internal/iterators/offset_page_iterator.rb +83 -0
- data/lib/voltaria/internal/json/request.rb +41 -0
- data/lib/voltaria/internal/json/serializable.rb +25 -0
- data/lib/voltaria/internal/multipart/multipart_encoder.rb +141 -0
- data/lib/voltaria/internal/multipart/multipart_form_data.rb +78 -0
- data/lib/voltaria/internal/multipart/multipart_form_data_part.rb +51 -0
- data/lib/voltaria/internal/multipart/multipart_request.rb +40 -0
- data/lib/voltaria/internal/types/array.rb +47 -0
- data/lib/voltaria/internal/types/boolean.rb +34 -0
- data/lib/voltaria/internal/types/enum.rb +56 -0
- data/lib/voltaria/internal/types/hash.rb +36 -0
- data/lib/voltaria/internal/types/model/field.rb +38 -0
- data/lib/voltaria/internal/types/model.rb +208 -0
- data/lib/voltaria/internal/types/type.rb +35 -0
- data/lib/voltaria/internal/types/union.rb +161 -0
- data/lib/voltaria/internal/types/unknown.rb +15 -0
- data/lib/voltaria/internal/types/utils.rb +116 -0
- data/lib/voltaria/investors/client.rb +312 -0
- data/lib/voltaria/investors/types/investor_get_client_request.rb +11 -0
- data/lib/voltaria/investors/types/investor_get_installment_request.rb +11 -0
- data/lib/voltaria/investors/types/investor_get_loan_request.rb +11 -0
- data/lib/voltaria/investors/types/investor_list_clients_request.rb +14 -0
- data/lib/voltaria/investors/types/investor_list_installments_request.rb +16 -0
- data/lib/voltaria/investors/types/investor_list_loans_request.rb +15 -0
- data/lib/voltaria/investors/types/investor_list_repayments_request.rb +17 -0
- data/lib/voltaria/loans/client.rb +271 -0
- data/lib/voltaria/loans/types/bulk_loan_create_payload.rb +11 -0
- data/lib/voltaria/loans/types/delete_loan_request.rb +11 -0
- data/lib/voltaria/loans/types/get_bulk_loan_status_request.rb +11 -0
- data/lib/voltaria/loans/types/get_loan_by_id_request.rb +11 -0
- data/lib/voltaria/loans/types/list_loans_request.rb +15 -0
- data/lib/voltaria/loans/types/loan_create_payload.rb +17 -0
- data/lib/voltaria/loans/types/loan_create_payload_amount.rb +15 -0
- data/lib/voltaria/loans/types/loan_default_payload.rb +13 -0
- data/lib/voltaria/loans/types/loan_default_payload_sold_amount.rb +15 -0
- data/lib/voltaria/partners/client.rb +129 -0
- data/lib/voltaria/partners/types/list_partner_waterfalls_request.rb +14 -0
- data/lib/voltaria/partners/types/partner_data_create_payload.rb +11 -0
- data/lib/voltaria/prefix_routing.rb +80 -0
- data/lib/voltaria/repayments/client.rb +183 -0
- data/lib/voltaria/repayments/types/bulk_repayment_create_payload.rb +11 -0
- data/lib/voltaria/repayments/types/get_bulk_repayment_status_request.rb +11 -0
- data/lib/voltaria/repayments/types/list_repayment_logs_request.rb +17 -0
- data/lib/voltaria/repayments/types/repayment_create_payload.rb +17 -0
- data/lib/voltaria/repayments/types/repayment_create_payload_amount.rb +15 -0
- data/lib/voltaria/sandbox/client.rb +124 -0
- data/lib/voltaria/sandbox/types/client_update_sandbox.rb +13 -0
- data/lib/voltaria/sandbox/types/client_update_sandbox_limit.rb +15 -0
- data/lib/voltaria/sandbox/types/loan_update_sandbox.rb +12 -0
- data/lib/voltaria/sandbox/types/webhook_test_sandbox.rb +12 -0
- data/lib/voltaria/types/account_address.rb +14 -0
- data/lib/voltaria/types/account_holder_type_enum.rb +12 -0
- data/lib/voltaria/types/account_status_enum.rb +13 -0
- data/lib/voltaria/types/available_document_categories_response.rb +9 -0
- data/lib/voltaria/types/available_funding.rb +15 -0
- data/lib/voltaria/types/bulk_loan_item_payload.rb +15 -0
- data/lib/voltaria/types/bulk_loan_item_payload_amount.rb +13 -0
- data/lib/voltaria/types/bulk_loan_item_result.rb +15 -0
- data/lib/voltaria/types/bulk_loan_result.rb +13 -0
- data/lib/voltaria/types/bulk_loan_task_response.rb +11 -0
- data/lib/voltaria/types/bulk_loan_task_status.rb +14 -0
- data/lib/voltaria/types/bulk_repayment_item_payload.rb +15 -0
- data/lib/voltaria/types/bulk_repayment_item_payload_amount.rb +13 -0
- data/lib/voltaria/types/bulk_repayment_item_result.rb +15 -0
- data/lib/voltaria/types/bulk_repayment_result.rb +13 -0
- data/lib/voltaria/types/bulk_repayment_task_response.rb +11 -0
- data/lib/voltaria/types/bulk_repayment_task_status.rb +14 -0
- data/lib/voltaria/types/checklist_summary_partner_response.rb +14 -0
- data/lib/voltaria/types/checklist_type_enum.rb +12 -0
- data/lib/voltaria/types/client_account_response.rb +21 -0
- data/lib/voltaria/types/client_base_info.rb +13 -0
- data/lib/voltaria/types/client_data_response.rb +12 -0
- data/lib/voltaria/types/client_investor_response.rb +17 -0
- data/lib/voltaria/types/client_limit_response.rb +16 -0
- data/lib/voltaria/types/client_response.rb +19 -0
- data/lib/voltaria/types/client_status_enum.rb +18 -0
- data/lib/voltaria/types/client_type_enum.rb +12 -0
- data/lib/voltaria/types/client_user_response.rb +24 -0
- data/lib/voltaria/types/client_user_status_enum.rb +13 -0
- data/lib/voltaria/types/currency_enum.rb +16 -0
- data/lib/voltaria/types/currency_field_spec.rb +10 -0
- data/lib/voltaria/types/document_response.rb +20 -0
- data/lib/voltaria/types/drawdown_checklist_response.rb +16 -0
- data/lib/voltaria/types/drawdown_response.rb +15 -0
- data/lib/voltaria/types/drawdown_status_enum.rb +13 -0
- data/lib/voltaria/types/http_validation_error.rb +9 -0
- data/lib/voltaria/types/installment_response.rb +24 -0
- data/lib/voltaria/types/installment_response_with_client_info.rb +25 -0
- data/lib/voltaria/types/installment_status_enum.rb +19 -0
- data/lib/voltaria/types/jurisdiction_enum.rb +13 -0
- data/lib/voltaria/types/kyc_status_enum.rb +14 -0
- data/lib/voltaria/types/limit_request_response.rb +16 -0
- data/lib/voltaria/types/limit_request_status_enum.rb +13 -0
- data/lib/voltaria/types/loan_installment_create_payload.rb +10 -0
- data/lib/voltaria/types/loan_installment_create_payload_amount.rb +13 -0
- data/lib/voltaria/types/loan_installment_response.rb +15 -0
- data/lib/voltaria/types/loan_investor_response.rb +27 -0
- data/lib/voltaria/types/loan_payment_status_enum.rb +12 -0
- data/lib/voltaria/types/loan_response_with_client_info.rb +26 -0
- data/lib/voltaria/types/loan_response_with_installments.rb +26 -0
- data/lib/voltaria/types/loan_status_enum.rb +21 -0
- data/lib/voltaria/types/paginated_response_checklist_summary_partner_response.rb +16 -0
- data/lib/voltaria/types/paginated_response_client_account_response.rb +16 -0
- data/lib/voltaria/types/paginated_response_client_investor_response.rb +16 -0
- data/lib/voltaria/types/paginated_response_client_response.rb +16 -0
- data/lib/voltaria/types/paginated_response_document_response.rb +16 -0
- data/lib/voltaria/types/paginated_response_drawdown_checklist_response.rb +16 -0
- data/lib/voltaria/types/paginated_response_drawdown_response.rb +16 -0
- data/lib/voltaria/types/paginated_response_installment_response_with_client_info.rb +16 -0
- data/lib/voltaria/types/paginated_response_limit_request_response.rb +16 -0
- data/lib/voltaria/types/paginated_response_loan_investor_response.rb +16 -0
- data/lib/voltaria/types/paginated_response_loan_response_with_client_info.rb +16 -0
- data/lib/voltaria/types/paginated_response_payment_promise_response.rb +16 -0
- data/lib/voltaria/types/paginated_response_repayment_response_with_client_info.rb +16 -0
- data/lib/voltaria/types/paginated_response_waiver_response.rb +16 -0
- data/lib/voltaria/types/paginated_response_waterfall_response.rb +16 -0
- data/lib/voltaria/types/paginated_response_webhook_log_response.rb +16 -0
- data/lib/voltaria/types/paginated_response_webhook_subscription_response.rb +16 -0
- data/lib/voltaria/types/partner_data_response.rb +11 -0
- data/lib/voltaria/types/payment_promise_response.rb +19 -0
- data/lib/voltaria/types/payment_promise_status_enum.rb +14 -0
- data/lib/voltaria/types/repayment_response.rb +21 -0
- data/lib/voltaria/types/repayment_response_with_client_info.rb +22 -0
- data/lib/voltaria/types/role_response.rb +11 -0
- data/lib/voltaria/types/validation_error.rb +13 -0
- data/lib/voltaria/types/validation_error_loc_item.rb +12 -0
- data/lib/voltaria/types/waiver_response.rb +18 -0
- data/lib/voltaria/types/waiver_status_enum.rb +14 -0
- data/lib/voltaria/types/waterfall_response.rb +19 -0
- data/lib/voltaria/types/waterfall_status_enum.rb +12 -0
- data/lib/voltaria/types/webhook_event_type_enum.rb +15 -0
- data/lib/voltaria/types/webhook_log_response.rb +19 -0
- data/lib/voltaria/types/webhook_log_response_request_body.rb +13 -0
- data/lib/voltaria/types/webhook_status_enum.rb +13 -0
- data/lib/voltaria/types/webhook_subscription_response.rb +17 -0
- data/lib/voltaria/version.rb +5 -0
- data/lib/voltaria/webhooks/client.rb +241 -0
- data/lib/voltaria/webhooks/types/delete_webhook_subscription_request.rb +11 -0
- data/lib/voltaria/webhooks/types/get_webhook_subscription_request.rb +11 -0
- data/lib/voltaria/webhooks/types/list_webhook_logs_request.rb +13 -0
- data/lib/voltaria/webhooks/types/list_webhook_subscriptions_request.rb +13 -0
- data/lib/voltaria/webhooks/types/webhook_create_payload.rb +16 -0
- data/lib/voltaria/webhooks/types/webhook_update_payload.rb +17 -0
- data/lib/voltaria.rb +205 -0
- data/reference.md +5135 -0
- metadata +250 -0
data/reference.md
ADDED
|
@@ -0,0 +1,5135 @@
|
|
|
1
|
+
# Reference
|
|
2
|
+
## Clients
|
|
3
|
+
<details><summary><code>client.clients.<a href="/lib/voltaria/clients/client.rb">list_clients</a>() -> Voltaria::Types::PaginatedResponseClientResponse</code></summary>
|
|
4
|
+
<dl>
|
|
5
|
+
<dd>
|
|
6
|
+
|
|
7
|
+
#### 📝 Description
|
|
8
|
+
|
|
9
|
+
<dl>
|
|
10
|
+
<dd>
|
|
11
|
+
|
|
12
|
+
<dl>
|
|
13
|
+
<dd>
|
|
14
|
+
|
|
15
|
+
Retrieve a list of all clients associated with your partner account.
|
|
16
|
+
</dd>
|
|
17
|
+
</dl>
|
|
18
|
+
</dd>
|
|
19
|
+
</dl>
|
|
20
|
+
|
|
21
|
+
#### 🔌 Usage
|
|
22
|
+
|
|
23
|
+
<dl>
|
|
24
|
+
<dd>
|
|
25
|
+
|
|
26
|
+
<dl>
|
|
27
|
+
<dd>
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
client.clients.list_clients
|
|
31
|
+
```
|
|
32
|
+
</dd>
|
|
33
|
+
</dl>
|
|
34
|
+
</dd>
|
|
35
|
+
</dl>
|
|
36
|
+
|
|
37
|
+
#### ⚙️ Parameters
|
|
38
|
+
|
|
39
|
+
<dl>
|
|
40
|
+
<dd>
|
|
41
|
+
|
|
42
|
+
<dl>
|
|
43
|
+
<dd>
|
|
44
|
+
|
|
45
|
+
**page:** `Integer`
|
|
46
|
+
|
|
47
|
+
</dd>
|
|
48
|
+
</dl>
|
|
49
|
+
|
|
50
|
+
<dl>
|
|
51
|
+
<dd>
|
|
52
|
+
|
|
53
|
+
**page_size:** `Integer`
|
|
54
|
+
|
|
55
|
+
</dd>
|
|
56
|
+
</dl>
|
|
57
|
+
|
|
58
|
+
<dl>
|
|
59
|
+
<dd>
|
|
60
|
+
|
|
61
|
+
**order_by:** `String` — Field to order the results by, e.g., 'created_at:desc,updated_at:asc'
|
|
62
|
+
|
|
63
|
+
</dd>
|
|
64
|
+
</dl>
|
|
65
|
+
|
|
66
|
+
<dl>
|
|
67
|
+
<dd>
|
|
68
|
+
|
|
69
|
+
**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: id, name, correlation_id, company_number, status. Supported operators: is, in, not_in, contains, not_contains, like, not_like, ilike, not_ilike, gt, gte, lt, lte, starts_with, ends_with, is_null, is_not_null.
|
|
70
|
+
|
|
71
|
+
</dd>
|
|
72
|
+
</dl>
|
|
73
|
+
|
|
74
|
+
<dl>
|
|
75
|
+
<dd>
|
|
76
|
+
|
|
77
|
+
**request_options:** `Voltaria::Clients::RequestOptions`
|
|
78
|
+
|
|
79
|
+
</dd>
|
|
80
|
+
</dl>
|
|
81
|
+
</dd>
|
|
82
|
+
</dl>
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
</dd>
|
|
86
|
+
</dl>
|
|
87
|
+
</details>
|
|
88
|
+
|
|
89
|
+
<details><summary><code>client.clients.<a href="/lib/voltaria/clients/client.rb">create_client</a>(request) -> Voltaria::Types::ClientResponse</code></summary>
|
|
90
|
+
<dl>
|
|
91
|
+
<dd>
|
|
92
|
+
|
|
93
|
+
#### 📝 Description
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dd>
|
|
97
|
+
|
|
98
|
+
<dl>
|
|
99
|
+
<dd>
|
|
100
|
+
|
|
101
|
+
Create a new client under your partner account. The client will remain in a pending state until reviewed by Winyield.
|
|
102
|
+
</dd>
|
|
103
|
+
</dl>
|
|
104
|
+
</dd>
|
|
105
|
+
</dl>
|
|
106
|
+
|
|
107
|
+
#### 🔌 Usage
|
|
108
|
+
|
|
109
|
+
<dl>
|
|
110
|
+
<dd>
|
|
111
|
+
|
|
112
|
+
<dl>
|
|
113
|
+
<dd>
|
|
114
|
+
|
|
115
|
+
```ruby
|
|
116
|
+
client.clients.create_client(
|
|
117
|
+
name: "ACME Corp",
|
|
118
|
+
jurisdiction: "eu"
|
|
119
|
+
)
|
|
120
|
+
```
|
|
121
|
+
</dd>
|
|
122
|
+
</dl>
|
|
123
|
+
</dd>
|
|
124
|
+
</dl>
|
|
125
|
+
|
|
126
|
+
#### ⚙️ Parameters
|
|
127
|
+
|
|
128
|
+
<dl>
|
|
129
|
+
<dd>
|
|
130
|
+
|
|
131
|
+
<dl>
|
|
132
|
+
<dd>
|
|
133
|
+
|
|
134
|
+
**correlation_id:** `String` — The correlation ID you provided at the creation of the client
|
|
135
|
+
|
|
136
|
+
</dd>
|
|
137
|
+
</dl>
|
|
138
|
+
|
|
139
|
+
<dl>
|
|
140
|
+
<dd>
|
|
141
|
+
|
|
142
|
+
**name:** `String` — The name of the client
|
|
143
|
+
|
|
144
|
+
</dd>
|
|
145
|
+
</dl>
|
|
146
|
+
|
|
147
|
+
<dl>
|
|
148
|
+
<dd>
|
|
149
|
+
|
|
150
|
+
**type:** `Voltaria::Types::ClientTypeEnum` — The type of the client, must be one of `individual`,`corporate`. Default is `corporate` if not provided.
|
|
151
|
+
|
|
152
|
+
</dd>
|
|
153
|
+
</dl>
|
|
154
|
+
|
|
155
|
+
<dl>
|
|
156
|
+
<dd>
|
|
157
|
+
|
|
158
|
+
**jurisdiction:** `Voltaria::Types::JurisdictionEnum` — The jurisdiction of the client, must be one of `eu`, `us`, `uk`
|
|
159
|
+
|
|
160
|
+
</dd>
|
|
161
|
+
</dl>
|
|
162
|
+
|
|
163
|
+
<dl>
|
|
164
|
+
<dd>
|
|
165
|
+
|
|
166
|
+
**company_number:** `String` — The company number of the client if type is `corporate`
|
|
167
|
+
|
|
168
|
+
</dd>
|
|
169
|
+
</dl>
|
|
170
|
+
|
|
171
|
+
<dl>
|
|
172
|
+
<dd>
|
|
173
|
+
|
|
174
|
+
**data:** `Internal::Types::Hash[String, Object]` — Additional data associated with the client
|
|
175
|
+
|
|
176
|
+
</dd>
|
|
177
|
+
</dl>
|
|
178
|
+
|
|
179
|
+
<dl>
|
|
180
|
+
<dd>
|
|
181
|
+
|
|
182
|
+
**request_options:** `Voltaria::Clients::RequestOptions`
|
|
183
|
+
|
|
184
|
+
</dd>
|
|
185
|
+
</dl>
|
|
186
|
+
</dd>
|
|
187
|
+
</dl>
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
</dd>
|
|
191
|
+
</dl>
|
|
192
|
+
</details>
|
|
193
|
+
|
|
194
|
+
<details><summary><code>client.clients.<a href="/lib/voltaria/clients/client.rb">create_client_data</a>(request) -> Voltaria::Types::ClientDataResponse</code></summary>
|
|
195
|
+
<dl>
|
|
196
|
+
<dd>
|
|
197
|
+
|
|
198
|
+
#### 📝 Description
|
|
199
|
+
|
|
200
|
+
<dl>
|
|
201
|
+
<dd>
|
|
202
|
+
|
|
203
|
+
<dl>
|
|
204
|
+
<dd>
|
|
205
|
+
|
|
206
|
+
Upload supplementary client information, such as bank account balance, accounting figures, or other relevant details.
|
|
207
|
+
</dd>
|
|
208
|
+
</dl>
|
|
209
|
+
</dd>
|
|
210
|
+
</dl>
|
|
211
|
+
|
|
212
|
+
#### 🔌 Usage
|
|
213
|
+
|
|
214
|
+
<dl>
|
|
215
|
+
<dd>
|
|
216
|
+
|
|
217
|
+
<dl>
|
|
218
|
+
<dd>
|
|
219
|
+
|
|
220
|
+
```ruby
|
|
221
|
+
client.clients.create_client_data(
|
|
222
|
+
client_id: "client_123",
|
|
223
|
+
data: {}
|
|
224
|
+
)
|
|
225
|
+
```
|
|
226
|
+
</dd>
|
|
227
|
+
</dl>
|
|
228
|
+
</dd>
|
|
229
|
+
</dl>
|
|
230
|
+
|
|
231
|
+
#### ⚙️ Parameters
|
|
232
|
+
|
|
233
|
+
<dl>
|
|
234
|
+
<dd>
|
|
235
|
+
|
|
236
|
+
<dl>
|
|
237
|
+
<dd>
|
|
238
|
+
|
|
239
|
+
**client_id:** `String`
|
|
240
|
+
|
|
241
|
+
</dd>
|
|
242
|
+
</dl>
|
|
243
|
+
|
|
244
|
+
<dl>
|
|
245
|
+
<dd>
|
|
246
|
+
|
|
247
|
+
**data:** `Internal::Types::Hash[String, Object]`
|
|
248
|
+
|
|
249
|
+
</dd>
|
|
250
|
+
</dl>
|
|
251
|
+
|
|
252
|
+
<dl>
|
|
253
|
+
<dd>
|
|
254
|
+
|
|
255
|
+
**request_options:** `Voltaria::Clients::RequestOptions`
|
|
256
|
+
|
|
257
|
+
</dd>
|
|
258
|
+
</dl>
|
|
259
|
+
</dd>
|
|
260
|
+
</dl>
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
</dd>
|
|
264
|
+
</dl>
|
|
265
|
+
</details>
|
|
266
|
+
|
|
267
|
+
<details><summary><code>client.clients.<a href="/lib/voltaria/clients/client.rb">list_limit_requests</a>() -> Voltaria::Types::PaginatedResponseLimitRequestResponse</code></summary>
|
|
268
|
+
<dl>
|
|
269
|
+
<dd>
|
|
270
|
+
|
|
271
|
+
#### 📝 Description
|
|
272
|
+
|
|
273
|
+
<dl>
|
|
274
|
+
<dd>
|
|
275
|
+
|
|
276
|
+
<dl>
|
|
277
|
+
<dd>
|
|
278
|
+
|
|
279
|
+
Retrieve a list of all limit requests associated with your partner account.
|
|
280
|
+
</dd>
|
|
281
|
+
</dl>
|
|
282
|
+
</dd>
|
|
283
|
+
</dl>
|
|
284
|
+
|
|
285
|
+
#### 🔌 Usage
|
|
286
|
+
|
|
287
|
+
<dl>
|
|
288
|
+
<dd>
|
|
289
|
+
|
|
290
|
+
<dl>
|
|
291
|
+
<dd>
|
|
292
|
+
|
|
293
|
+
```ruby
|
|
294
|
+
client.clients.list_limit_requests
|
|
295
|
+
```
|
|
296
|
+
</dd>
|
|
297
|
+
</dl>
|
|
298
|
+
</dd>
|
|
299
|
+
</dl>
|
|
300
|
+
|
|
301
|
+
#### ⚙️ Parameters
|
|
302
|
+
|
|
303
|
+
<dl>
|
|
304
|
+
<dd>
|
|
305
|
+
|
|
306
|
+
<dl>
|
|
307
|
+
<dd>
|
|
308
|
+
|
|
309
|
+
**client_id:** `String` — Filter by client ID
|
|
310
|
+
|
|
311
|
+
</dd>
|
|
312
|
+
</dl>
|
|
313
|
+
|
|
314
|
+
<dl>
|
|
315
|
+
<dd>
|
|
316
|
+
|
|
317
|
+
**page:** `Integer`
|
|
318
|
+
|
|
319
|
+
</dd>
|
|
320
|
+
</dl>
|
|
321
|
+
|
|
322
|
+
<dl>
|
|
323
|
+
<dd>
|
|
324
|
+
|
|
325
|
+
**page_size:** `Integer`
|
|
326
|
+
|
|
327
|
+
</dd>
|
|
328
|
+
</dl>
|
|
329
|
+
|
|
330
|
+
<dl>
|
|
331
|
+
<dd>
|
|
332
|
+
|
|
333
|
+
**order_by:** `String` — Field to order the results by, e.g., 'created_at:desc,updated_at:asc'
|
|
334
|
+
|
|
335
|
+
</dd>
|
|
336
|
+
</dl>
|
|
337
|
+
|
|
338
|
+
<dl>
|
|
339
|
+
<dd>
|
|
340
|
+
|
|
341
|
+
**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: id, client_id. Supported operators: is, in, not_in, contains, not_contains, like, not_like, ilike, not_ilike, gt, gte, lt, lte, starts_with, ends_with, is_null, is_not_null.
|
|
342
|
+
|
|
343
|
+
</dd>
|
|
344
|
+
</dl>
|
|
345
|
+
|
|
346
|
+
<dl>
|
|
347
|
+
<dd>
|
|
348
|
+
|
|
349
|
+
**request_options:** `Voltaria::Clients::RequestOptions`
|
|
350
|
+
|
|
351
|
+
</dd>
|
|
352
|
+
</dl>
|
|
353
|
+
</dd>
|
|
354
|
+
</dl>
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
</dd>
|
|
358
|
+
</dl>
|
|
359
|
+
</details>
|
|
360
|
+
|
|
361
|
+
<details><summary><code>client.clients.<a href="/lib/voltaria/clients/client.rb">create_limit_request</a>(request) -> Voltaria::Types::LimitRequestResponse</code></summary>
|
|
362
|
+
<dl>
|
|
363
|
+
<dd>
|
|
364
|
+
|
|
365
|
+
#### 📝 Description
|
|
366
|
+
|
|
367
|
+
<dl>
|
|
368
|
+
<dd>
|
|
369
|
+
|
|
370
|
+
<dl>
|
|
371
|
+
<dd>
|
|
372
|
+
|
|
373
|
+
Create a limit review request for a client. The request will remain in a pending state until reviewed by Winyield.
|
|
374
|
+
</dd>
|
|
375
|
+
</dl>
|
|
376
|
+
</dd>
|
|
377
|
+
</dl>
|
|
378
|
+
|
|
379
|
+
#### 🔌 Usage
|
|
380
|
+
|
|
381
|
+
<dl>
|
|
382
|
+
<dd>
|
|
383
|
+
|
|
384
|
+
<dl>
|
|
385
|
+
<dd>
|
|
386
|
+
|
|
387
|
+
```ruby
|
|
388
|
+
client.clients.create_limit_request(
|
|
389
|
+
client_id: "client_1234567890abcdef",
|
|
390
|
+
requested_limit: 1.1,
|
|
391
|
+
reason: "Need more credit for business expansion"
|
|
392
|
+
)
|
|
393
|
+
```
|
|
394
|
+
</dd>
|
|
395
|
+
</dl>
|
|
396
|
+
</dd>
|
|
397
|
+
</dl>
|
|
398
|
+
|
|
399
|
+
#### ⚙️ Parameters
|
|
400
|
+
|
|
401
|
+
<dl>
|
|
402
|
+
<dd>
|
|
403
|
+
|
|
404
|
+
<dl>
|
|
405
|
+
<dd>
|
|
406
|
+
|
|
407
|
+
**client_id:** `String` — The ID of the client for which the limit request is being created
|
|
408
|
+
|
|
409
|
+
</dd>
|
|
410
|
+
</dl>
|
|
411
|
+
|
|
412
|
+
<dl>
|
|
413
|
+
<dd>
|
|
414
|
+
|
|
415
|
+
**requested_limit:** `Voltaria::Clients::Types::LimitRequestCreatePayloadRequestedLimit` — The requested credit limit amount
|
|
416
|
+
|
|
417
|
+
</dd>
|
|
418
|
+
</dl>
|
|
419
|
+
|
|
420
|
+
<dl>
|
|
421
|
+
<dd>
|
|
422
|
+
|
|
423
|
+
**reason:** `String` — The reason for the limit request
|
|
424
|
+
|
|
425
|
+
</dd>
|
|
426
|
+
</dl>
|
|
427
|
+
|
|
428
|
+
<dl>
|
|
429
|
+
<dd>
|
|
430
|
+
|
|
431
|
+
**waiver_request:** `Internal::Types::Boolean` — Whether a special waiver is requested alongside this limit request
|
|
432
|
+
|
|
433
|
+
</dd>
|
|
434
|
+
</dl>
|
|
435
|
+
|
|
436
|
+
<dl>
|
|
437
|
+
<dd>
|
|
438
|
+
|
|
439
|
+
**request_options:** `Voltaria::Clients::RequestOptions`
|
|
440
|
+
|
|
441
|
+
</dd>
|
|
442
|
+
</dl>
|
|
443
|
+
</dd>
|
|
444
|
+
</dl>
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
</dd>
|
|
448
|
+
</dl>
|
|
449
|
+
</details>
|
|
450
|
+
|
|
451
|
+
<details><summary><code>client.clients.<a href="/lib/voltaria/clients/client.rb">get_limit_request</a>(request_id) -> Voltaria::Types::LimitRequestResponse</code></summary>
|
|
452
|
+
<dl>
|
|
453
|
+
<dd>
|
|
454
|
+
|
|
455
|
+
#### 📝 Description
|
|
456
|
+
|
|
457
|
+
<dl>
|
|
458
|
+
<dd>
|
|
459
|
+
|
|
460
|
+
<dl>
|
|
461
|
+
<dd>
|
|
462
|
+
|
|
463
|
+
Retrieve a specific limit request by its ID.
|
|
464
|
+
</dd>
|
|
465
|
+
</dl>
|
|
466
|
+
</dd>
|
|
467
|
+
</dl>
|
|
468
|
+
|
|
469
|
+
#### 🔌 Usage
|
|
470
|
+
|
|
471
|
+
<dl>
|
|
472
|
+
<dd>
|
|
473
|
+
|
|
474
|
+
<dl>
|
|
475
|
+
<dd>
|
|
476
|
+
|
|
477
|
+
```ruby
|
|
478
|
+
client.clients.get_limit_request(request_id: "request_id")
|
|
479
|
+
```
|
|
480
|
+
</dd>
|
|
481
|
+
</dl>
|
|
482
|
+
</dd>
|
|
483
|
+
</dl>
|
|
484
|
+
|
|
485
|
+
#### ⚙️ Parameters
|
|
486
|
+
|
|
487
|
+
<dl>
|
|
488
|
+
<dd>
|
|
489
|
+
|
|
490
|
+
<dl>
|
|
491
|
+
<dd>
|
|
492
|
+
|
|
493
|
+
**request_id:** `String`
|
|
494
|
+
|
|
495
|
+
</dd>
|
|
496
|
+
</dl>
|
|
497
|
+
|
|
498
|
+
<dl>
|
|
499
|
+
<dd>
|
|
500
|
+
|
|
501
|
+
**request_options:** `Voltaria::Clients::RequestOptions`
|
|
502
|
+
|
|
503
|
+
</dd>
|
|
504
|
+
</dl>
|
|
505
|
+
</dd>
|
|
506
|
+
</dl>
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
</dd>
|
|
510
|
+
</dl>
|
|
511
|
+
</details>
|
|
512
|
+
|
|
513
|
+
<details><summary><code>client.clients.<a href="/lib/voltaria/clients/client.rb">list_onboarding_clients</a>() -> Voltaria::Types::PaginatedResponseClientResponse</code></summary>
|
|
514
|
+
<dl>
|
|
515
|
+
<dd>
|
|
516
|
+
|
|
517
|
+
#### 📝 Description
|
|
518
|
+
|
|
519
|
+
<dl>
|
|
520
|
+
<dd>
|
|
521
|
+
|
|
522
|
+
<dl>
|
|
523
|
+
<dd>
|
|
524
|
+
|
|
525
|
+
Retrieve all clients that have self-registered via the portal and are awaiting partner approval.
|
|
526
|
+
</dd>
|
|
527
|
+
</dl>
|
|
528
|
+
</dd>
|
|
529
|
+
</dl>
|
|
530
|
+
|
|
531
|
+
#### 🔌 Usage
|
|
532
|
+
|
|
533
|
+
<dl>
|
|
534
|
+
<dd>
|
|
535
|
+
|
|
536
|
+
<dl>
|
|
537
|
+
<dd>
|
|
538
|
+
|
|
539
|
+
```ruby
|
|
540
|
+
client.clients.list_onboarding_clients
|
|
541
|
+
```
|
|
542
|
+
</dd>
|
|
543
|
+
</dl>
|
|
544
|
+
</dd>
|
|
545
|
+
</dl>
|
|
546
|
+
|
|
547
|
+
#### ⚙️ Parameters
|
|
548
|
+
|
|
549
|
+
<dl>
|
|
550
|
+
<dd>
|
|
551
|
+
|
|
552
|
+
<dl>
|
|
553
|
+
<dd>
|
|
554
|
+
|
|
555
|
+
**page:** `Integer`
|
|
556
|
+
|
|
557
|
+
</dd>
|
|
558
|
+
</dl>
|
|
559
|
+
|
|
560
|
+
<dl>
|
|
561
|
+
<dd>
|
|
562
|
+
|
|
563
|
+
**page_size:** `Integer`
|
|
564
|
+
|
|
565
|
+
</dd>
|
|
566
|
+
</dl>
|
|
567
|
+
|
|
568
|
+
<dl>
|
|
569
|
+
<dd>
|
|
570
|
+
|
|
571
|
+
**request_options:** `Voltaria::Clients::RequestOptions`
|
|
572
|
+
|
|
573
|
+
</dd>
|
|
574
|
+
</dl>
|
|
575
|
+
</dd>
|
|
576
|
+
</dl>
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
</dd>
|
|
580
|
+
</dl>
|
|
581
|
+
</details>
|
|
582
|
+
|
|
583
|
+
<details><summary><code>client.clients.<a href="/lib/voltaria/clients/client.rb">approve_onboarding</a>(client_id) -> Voltaria::Types::ClientResponse</code></summary>
|
|
584
|
+
<dl>
|
|
585
|
+
<dd>
|
|
586
|
+
|
|
587
|
+
#### 📝 Description
|
|
588
|
+
|
|
589
|
+
<dl>
|
|
590
|
+
<dd>
|
|
591
|
+
|
|
592
|
+
<dl>
|
|
593
|
+
<dd>
|
|
594
|
+
|
|
595
|
+
Accept a self-onboarded client. The client status moves to 'pending' and the owner's portal account is activated so they can begin submitting documents.
|
|
596
|
+
</dd>
|
|
597
|
+
</dl>
|
|
598
|
+
</dd>
|
|
599
|
+
</dl>
|
|
600
|
+
|
|
601
|
+
#### 🔌 Usage
|
|
602
|
+
|
|
603
|
+
<dl>
|
|
604
|
+
<dd>
|
|
605
|
+
|
|
606
|
+
<dl>
|
|
607
|
+
<dd>
|
|
608
|
+
|
|
609
|
+
```ruby
|
|
610
|
+
client.clients.approve_onboarding(client_id: "client_id")
|
|
611
|
+
```
|
|
612
|
+
</dd>
|
|
613
|
+
</dl>
|
|
614
|
+
</dd>
|
|
615
|
+
</dl>
|
|
616
|
+
|
|
617
|
+
#### ⚙️ Parameters
|
|
618
|
+
|
|
619
|
+
<dl>
|
|
620
|
+
<dd>
|
|
621
|
+
|
|
622
|
+
<dl>
|
|
623
|
+
<dd>
|
|
624
|
+
|
|
625
|
+
**client_id:** `String`
|
|
626
|
+
|
|
627
|
+
</dd>
|
|
628
|
+
</dl>
|
|
629
|
+
|
|
630
|
+
<dl>
|
|
631
|
+
<dd>
|
|
632
|
+
|
|
633
|
+
**request_options:** `Voltaria::Clients::RequestOptions`
|
|
634
|
+
|
|
635
|
+
</dd>
|
|
636
|
+
</dl>
|
|
637
|
+
</dd>
|
|
638
|
+
</dl>
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
</dd>
|
|
642
|
+
</dl>
|
|
643
|
+
</details>
|
|
644
|
+
|
|
645
|
+
<details><summary><code>client.clients.<a href="/lib/voltaria/clients/client.rb">reject_onboarding</a>(client_id) -> Voltaria::Types::ClientResponse</code></summary>
|
|
646
|
+
<dl>
|
|
647
|
+
<dd>
|
|
648
|
+
|
|
649
|
+
#### 📝 Description
|
|
650
|
+
|
|
651
|
+
<dl>
|
|
652
|
+
<dd>
|
|
653
|
+
|
|
654
|
+
<dl>
|
|
655
|
+
<dd>
|
|
656
|
+
|
|
657
|
+
Reject a self-onboarded client. The client record is kept with 'rejected' status for audit history and is not deleted.
|
|
658
|
+
</dd>
|
|
659
|
+
</dl>
|
|
660
|
+
</dd>
|
|
661
|
+
</dl>
|
|
662
|
+
|
|
663
|
+
#### 🔌 Usage
|
|
664
|
+
|
|
665
|
+
<dl>
|
|
666
|
+
<dd>
|
|
667
|
+
|
|
668
|
+
<dl>
|
|
669
|
+
<dd>
|
|
670
|
+
|
|
671
|
+
```ruby
|
|
672
|
+
client.clients.reject_onboarding(client_id: "client_id")
|
|
673
|
+
```
|
|
674
|
+
</dd>
|
|
675
|
+
</dl>
|
|
676
|
+
</dd>
|
|
677
|
+
</dl>
|
|
678
|
+
|
|
679
|
+
#### ⚙️ Parameters
|
|
680
|
+
|
|
681
|
+
<dl>
|
|
682
|
+
<dd>
|
|
683
|
+
|
|
684
|
+
<dl>
|
|
685
|
+
<dd>
|
|
686
|
+
|
|
687
|
+
**client_id:** `String`
|
|
688
|
+
|
|
689
|
+
</dd>
|
|
690
|
+
</dl>
|
|
691
|
+
|
|
692
|
+
<dl>
|
|
693
|
+
<dd>
|
|
694
|
+
|
|
695
|
+
**request_options:** `Voltaria::Clients::RequestOptions`
|
|
696
|
+
|
|
697
|
+
</dd>
|
|
698
|
+
</dl>
|
|
699
|
+
</dd>
|
|
700
|
+
</dl>
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
</dd>
|
|
704
|
+
</dl>
|
|
705
|
+
</details>
|
|
706
|
+
|
|
707
|
+
<details><summary><code>client.clients.<a href="/lib/voltaria/clients/client.rb">add_client_portal_user</a>(client_id, request) -> Voltaria::Types::ClientUserResponse</code></summary>
|
|
708
|
+
<dl>
|
|
709
|
+
<dd>
|
|
710
|
+
|
|
711
|
+
#### 📝 Description
|
|
712
|
+
|
|
713
|
+
<dl>
|
|
714
|
+
<dd>
|
|
715
|
+
|
|
716
|
+
<dl>
|
|
717
|
+
<dd>
|
|
718
|
+
|
|
719
|
+
Invite a new user to a client's portal account. The invited user will receive an email with a one-time link to set their password. Partner can assign any role: 'owner', 'admin', or 'viewer'.
|
|
720
|
+
</dd>
|
|
721
|
+
</dl>
|
|
722
|
+
</dd>
|
|
723
|
+
</dl>
|
|
724
|
+
|
|
725
|
+
#### 🔌 Usage
|
|
726
|
+
|
|
727
|
+
<dl>
|
|
728
|
+
<dd>
|
|
729
|
+
|
|
730
|
+
<dl>
|
|
731
|
+
<dd>
|
|
732
|
+
|
|
733
|
+
```ruby
|
|
734
|
+
client.clients.add_client_portal_user(
|
|
735
|
+
client_id: "client_id",
|
|
736
|
+
first_name: "first_name",
|
|
737
|
+
last_name: "last_name",
|
|
738
|
+
email: "email",
|
|
739
|
+
role_type: "role_type"
|
|
740
|
+
)
|
|
741
|
+
```
|
|
742
|
+
</dd>
|
|
743
|
+
</dl>
|
|
744
|
+
</dd>
|
|
745
|
+
</dl>
|
|
746
|
+
|
|
747
|
+
#### ⚙️ Parameters
|
|
748
|
+
|
|
749
|
+
<dl>
|
|
750
|
+
<dd>
|
|
751
|
+
|
|
752
|
+
<dl>
|
|
753
|
+
<dd>
|
|
754
|
+
|
|
755
|
+
**client_id:** `String`
|
|
756
|
+
|
|
757
|
+
</dd>
|
|
758
|
+
</dl>
|
|
759
|
+
|
|
760
|
+
<dl>
|
|
761
|
+
<dd>
|
|
762
|
+
|
|
763
|
+
**first_name:** `String`
|
|
764
|
+
|
|
765
|
+
</dd>
|
|
766
|
+
</dl>
|
|
767
|
+
|
|
768
|
+
<dl>
|
|
769
|
+
<dd>
|
|
770
|
+
|
|
771
|
+
**last_name:** `String`
|
|
772
|
+
|
|
773
|
+
</dd>
|
|
774
|
+
</dl>
|
|
775
|
+
|
|
776
|
+
<dl>
|
|
777
|
+
<dd>
|
|
778
|
+
|
|
779
|
+
**email:** `String`
|
|
780
|
+
|
|
781
|
+
</dd>
|
|
782
|
+
</dl>
|
|
783
|
+
|
|
784
|
+
<dl>
|
|
785
|
+
<dd>
|
|
786
|
+
|
|
787
|
+
**phone:** `String`
|
|
788
|
+
|
|
789
|
+
</dd>
|
|
790
|
+
</dl>
|
|
791
|
+
|
|
792
|
+
<dl>
|
|
793
|
+
<dd>
|
|
794
|
+
|
|
795
|
+
**role_type:** `String`
|
|
796
|
+
|
|
797
|
+
</dd>
|
|
798
|
+
</dl>
|
|
799
|
+
|
|
800
|
+
<dl>
|
|
801
|
+
<dd>
|
|
802
|
+
|
|
803
|
+
**request_options:** `Voltaria::Clients::RequestOptions`
|
|
804
|
+
|
|
805
|
+
</dd>
|
|
806
|
+
</dl>
|
|
807
|
+
</dd>
|
|
808
|
+
</dl>
|
|
809
|
+
|
|
810
|
+
|
|
811
|
+
</dd>
|
|
812
|
+
</dl>
|
|
813
|
+
</details>
|
|
814
|
+
|
|
815
|
+
<details><summary><code>client.clients.<a href="/lib/voltaria/clients/client.rb">list_client_waivers</a>(client_id) -> Voltaria::Types::PaginatedResponseWaiverResponse</code></summary>
|
|
816
|
+
<dl>
|
|
817
|
+
<dd>
|
|
818
|
+
|
|
819
|
+
#### 📝 Description
|
|
820
|
+
|
|
821
|
+
<dl>
|
|
822
|
+
<dd>
|
|
823
|
+
|
|
824
|
+
<dl>
|
|
825
|
+
<dd>
|
|
826
|
+
|
|
827
|
+
Retrieve all waivers associated with a specific client.
|
|
828
|
+
</dd>
|
|
829
|
+
</dl>
|
|
830
|
+
</dd>
|
|
831
|
+
</dl>
|
|
832
|
+
|
|
833
|
+
#### 🔌 Usage
|
|
834
|
+
|
|
835
|
+
<dl>
|
|
836
|
+
<dd>
|
|
837
|
+
|
|
838
|
+
<dl>
|
|
839
|
+
<dd>
|
|
840
|
+
|
|
841
|
+
```ruby
|
|
842
|
+
client.clients.list_client_waivers(client_id: "client_id")
|
|
843
|
+
```
|
|
844
|
+
</dd>
|
|
845
|
+
</dl>
|
|
846
|
+
</dd>
|
|
847
|
+
</dl>
|
|
848
|
+
|
|
849
|
+
#### ⚙️ Parameters
|
|
850
|
+
|
|
851
|
+
<dl>
|
|
852
|
+
<dd>
|
|
853
|
+
|
|
854
|
+
<dl>
|
|
855
|
+
<dd>
|
|
856
|
+
|
|
857
|
+
**client_id:** `String`
|
|
858
|
+
|
|
859
|
+
</dd>
|
|
860
|
+
</dl>
|
|
861
|
+
|
|
862
|
+
<dl>
|
|
863
|
+
<dd>
|
|
864
|
+
|
|
865
|
+
**page:** `Integer`
|
|
866
|
+
|
|
867
|
+
</dd>
|
|
868
|
+
</dl>
|
|
869
|
+
|
|
870
|
+
<dl>
|
|
871
|
+
<dd>
|
|
872
|
+
|
|
873
|
+
**page_size:** `Integer`
|
|
874
|
+
|
|
875
|
+
</dd>
|
|
876
|
+
</dl>
|
|
877
|
+
|
|
878
|
+
<dl>
|
|
879
|
+
<dd>
|
|
880
|
+
|
|
881
|
+
**order_by:** `String` — Field to order the results by, e.g., 'created_at:desc'
|
|
882
|
+
|
|
883
|
+
</dd>
|
|
884
|
+
</dl>
|
|
885
|
+
|
|
886
|
+
<dl>
|
|
887
|
+
<dd>
|
|
888
|
+
|
|
889
|
+
**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: id, client_id, status. Supported operators: is, in, not_in, contains, not_contains, like, not_like, ilike, not_ilike, gt, gte, lt, lte, starts_with, ends_with, is_null, is_not_null.
|
|
890
|
+
|
|
891
|
+
</dd>
|
|
892
|
+
</dl>
|
|
893
|
+
|
|
894
|
+
<dl>
|
|
895
|
+
<dd>
|
|
896
|
+
|
|
897
|
+
**request_options:** `Voltaria::Clients::RequestOptions`
|
|
898
|
+
|
|
899
|
+
</dd>
|
|
900
|
+
</dl>
|
|
901
|
+
</dd>
|
|
902
|
+
</dl>
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
</dd>
|
|
906
|
+
</dl>
|
|
907
|
+
</details>
|
|
908
|
+
|
|
909
|
+
<details><summary><code>client.clients.<a href="/lib/voltaria/clients/client.rb">get_client_by_id</a>(client_id) -> Voltaria::Types::ClientResponse</code></summary>
|
|
910
|
+
<dl>
|
|
911
|
+
<dd>
|
|
912
|
+
|
|
913
|
+
#### 📝 Description
|
|
914
|
+
|
|
915
|
+
<dl>
|
|
916
|
+
<dd>
|
|
917
|
+
|
|
918
|
+
<dl>
|
|
919
|
+
<dd>
|
|
920
|
+
|
|
921
|
+
Retrieve detailed information for a specific client using their client ID.
|
|
922
|
+
</dd>
|
|
923
|
+
</dl>
|
|
924
|
+
</dd>
|
|
925
|
+
</dl>
|
|
926
|
+
|
|
927
|
+
#### 🔌 Usage
|
|
928
|
+
|
|
929
|
+
<dl>
|
|
930
|
+
<dd>
|
|
931
|
+
|
|
932
|
+
<dl>
|
|
933
|
+
<dd>
|
|
934
|
+
|
|
935
|
+
```ruby
|
|
936
|
+
client.clients.get_client_by_id(client_id: "client_id")
|
|
937
|
+
```
|
|
938
|
+
</dd>
|
|
939
|
+
</dl>
|
|
940
|
+
</dd>
|
|
941
|
+
</dl>
|
|
942
|
+
|
|
943
|
+
#### ⚙️ Parameters
|
|
944
|
+
|
|
945
|
+
<dl>
|
|
946
|
+
<dd>
|
|
947
|
+
|
|
948
|
+
<dl>
|
|
949
|
+
<dd>
|
|
950
|
+
|
|
951
|
+
**client_id:** `String`
|
|
952
|
+
|
|
953
|
+
</dd>
|
|
954
|
+
</dl>
|
|
955
|
+
|
|
956
|
+
<dl>
|
|
957
|
+
<dd>
|
|
958
|
+
|
|
959
|
+
**request_options:** `Voltaria::Clients::RequestOptions`
|
|
960
|
+
|
|
961
|
+
</dd>
|
|
962
|
+
</dl>
|
|
963
|
+
</dd>
|
|
964
|
+
</dl>
|
|
965
|
+
|
|
966
|
+
|
|
967
|
+
</dd>
|
|
968
|
+
</dl>
|
|
969
|
+
</details>
|
|
970
|
+
|
|
971
|
+
<details><summary><code>client.clients.<a href="/lib/voltaria/clients/client.rb">delete_client</a>(client_id) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
972
|
+
<dl>
|
|
973
|
+
<dd>
|
|
974
|
+
|
|
975
|
+
#### 📝 Description
|
|
976
|
+
|
|
977
|
+
<dl>
|
|
978
|
+
<dd>
|
|
979
|
+
|
|
980
|
+
<dl>
|
|
981
|
+
<dd>
|
|
982
|
+
|
|
983
|
+
Delete a client by ID. Only clients with 'pending' status can be deleted. All client's loans must also be in 'pending' status.
|
|
984
|
+
</dd>
|
|
985
|
+
</dl>
|
|
986
|
+
</dd>
|
|
987
|
+
</dl>
|
|
988
|
+
|
|
989
|
+
#### 🔌 Usage
|
|
990
|
+
|
|
991
|
+
<dl>
|
|
992
|
+
<dd>
|
|
993
|
+
|
|
994
|
+
<dl>
|
|
995
|
+
<dd>
|
|
996
|
+
|
|
997
|
+
```ruby
|
|
998
|
+
client.clients.delete_client(client_id: "client_id")
|
|
999
|
+
```
|
|
1000
|
+
</dd>
|
|
1001
|
+
</dl>
|
|
1002
|
+
</dd>
|
|
1003
|
+
</dl>
|
|
1004
|
+
|
|
1005
|
+
#### ⚙️ Parameters
|
|
1006
|
+
|
|
1007
|
+
<dl>
|
|
1008
|
+
<dd>
|
|
1009
|
+
|
|
1010
|
+
<dl>
|
|
1011
|
+
<dd>
|
|
1012
|
+
|
|
1013
|
+
**client_id:** `String`
|
|
1014
|
+
|
|
1015
|
+
</dd>
|
|
1016
|
+
</dl>
|
|
1017
|
+
|
|
1018
|
+
<dl>
|
|
1019
|
+
<dd>
|
|
1020
|
+
|
|
1021
|
+
**request_options:** `Voltaria::Clients::RequestOptions`
|
|
1022
|
+
|
|
1023
|
+
</dd>
|
|
1024
|
+
</dl>
|
|
1025
|
+
</dd>
|
|
1026
|
+
</dl>
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
</dd>
|
|
1030
|
+
</dl>
|
|
1031
|
+
</details>
|
|
1032
|
+
|
|
1033
|
+
<details><summary><code>client.clients.<a href="/lib/voltaria/clients/client.rb">list_client_checklist_summaries</a>(client_id) -> Voltaria::Types::PaginatedResponseChecklistSummaryPartnerResponse</code></summary>
|
|
1034
|
+
<dl>
|
|
1035
|
+
<dd>
|
|
1036
|
+
|
|
1037
|
+
#### 📝 Description
|
|
1038
|
+
|
|
1039
|
+
<dl>
|
|
1040
|
+
<dd>
|
|
1041
|
+
|
|
1042
|
+
<dl>
|
|
1043
|
+
<dd>
|
|
1044
|
+
|
|
1045
|
+
Retrieve the checklist summaries for one of your clients, including the AI description and item completion counts.
|
|
1046
|
+
</dd>
|
|
1047
|
+
</dl>
|
|
1048
|
+
</dd>
|
|
1049
|
+
</dl>
|
|
1050
|
+
|
|
1051
|
+
#### 🔌 Usage
|
|
1052
|
+
|
|
1053
|
+
<dl>
|
|
1054
|
+
<dd>
|
|
1055
|
+
|
|
1056
|
+
<dl>
|
|
1057
|
+
<dd>
|
|
1058
|
+
|
|
1059
|
+
```ruby
|
|
1060
|
+
client.clients.list_client_checklist_summaries(client_id: "client_id")
|
|
1061
|
+
```
|
|
1062
|
+
</dd>
|
|
1063
|
+
</dl>
|
|
1064
|
+
</dd>
|
|
1065
|
+
</dl>
|
|
1066
|
+
|
|
1067
|
+
#### ⚙️ Parameters
|
|
1068
|
+
|
|
1069
|
+
<dl>
|
|
1070
|
+
<dd>
|
|
1071
|
+
|
|
1072
|
+
<dl>
|
|
1073
|
+
<dd>
|
|
1074
|
+
|
|
1075
|
+
**client_id:** `String`
|
|
1076
|
+
|
|
1077
|
+
</dd>
|
|
1078
|
+
</dl>
|
|
1079
|
+
|
|
1080
|
+
<dl>
|
|
1081
|
+
<dd>
|
|
1082
|
+
|
|
1083
|
+
**page:** `Integer`
|
|
1084
|
+
|
|
1085
|
+
</dd>
|
|
1086
|
+
</dl>
|
|
1087
|
+
|
|
1088
|
+
<dl>
|
|
1089
|
+
<dd>
|
|
1090
|
+
|
|
1091
|
+
**page_size:** `Integer`
|
|
1092
|
+
|
|
1093
|
+
</dd>
|
|
1094
|
+
</dl>
|
|
1095
|
+
|
|
1096
|
+
<dl>
|
|
1097
|
+
<dd>
|
|
1098
|
+
|
|
1099
|
+
**request_options:** `Voltaria::Clients::RequestOptions`
|
|
1100
|
+
|
|
1101
|
+
</dd>
|
|
1102
|
+
</dl>
|
|
1103
|
+
</dd>
|
|
1104
|
+
</dl>
|
|
1105
|
+
|
|
1106
|
+
|
|
1107
|
+
</dd>
|
|
1108
|
+
</dl>
|
|
1109
|
+
</details>
|
|
1110
|
+
|
|
1111
|
+
## Sandbox
|
|
1112
|
+
<details><summary><code>client.sandbox.<a href="/lib/voltaria/sandbox/client.rb">update_client</a>(client_id, request) -> Voltaria::Types::ClientResponse</code></summary>
|
|
1113
|
+
<dl>
|
|
1114
|
+
<dd>
|
|
1115
|
+
|
|
1116
|
+
#### 📝 Description
|
|
1117
|
+
|
|
1118
|
+
<dl>
|
|
1119
|
+
<dd>
|
|
1120
|
+
|
|
1121
|
+
<dl>
|
|
1122
|
+
<dd>
|
|
1123
|
+
|
|
1124
|
+
Update an existing client's status or credit limit using their client ID.
|
|
1125
|
+
</dd>
|
|
1126
|
+
</dl>
|
|
1127
|
+
</dd>
|
|
1128
|
+
</dl>
|
|
1129
|
+
|
|
1130
|
+
#### 🔌 Usage
|
|
1131
|
+
|
|
1132
|
+
<dl>
|
|
1133
|
+
<dd>
|
|
1134
|
+
|
|
1135
|
+
<dl>
|
|
1136
|
+
<dd>
|
|
1137
|
+
|
|
1138
|
+
```ruby
|
|
1139
|
+
client.sandbox.update_client(client_id: "client_id")
|
|
1140
|
+
```
|
|
1141
|
+
</dd>
|
|
1142
|
+
</dl>
|
|
1143
|
+
</dd>
|
|
1144
|
+
</dl>
|
|
1145
|
+
|
|
1146
|
+
#### ⚙️ Parameters
|
|
1147
|
+
|
|
1148
|
+
<dl>
|
|
1149
|
+
<dd>
|
|
1150
|
+
|
|
1151
|
+
<dl>
|
|
1152
|
+
<dd>
|
|
1153
|
+
|
|
1154
|
+
**client_id:** `String`
|
|
1155
|
+
|
|
1156
|
+
</dd>
|
|
1157
|
+
</dl>
|
|
1158
|
+
|
|
1159
|
+
<dl>
|
|
1160
|
+
<dd>
|
|
1161
|
+
|
|
1162
|
+
**status:** `Voltaria::Types::ClientStatusEnum` — The status of the client. One of the following: `active, rejected, deactivated, pending, pending_onboarding, pre_approved, deleted, inactive`
|
|
1163
|
+
|
|
1164
|
+
</dd>
|
|
1165
|
+
</dl>
|
|
1166
|
+
|
|
1167
|
+
<dl>
|
|
1168
|
+
<dd>
|
|
1169
|
+
|
|
1170
|
+
**limit:** `Voltaria::Sandbox::Types::ClientUpdateSandboxLimit` — The limit to set for the client. This will override the existing limit.
|
|
1171
|
+
|
|
1172
|
+
</dd>
|
|
1173
|
+
</dl>
|
|
1174
|
+
|
|
1175
|
+
<dl>
|
|
1176
|
+
<dd>
|
|
1177
|
+
|
|
1178
|
+
**request_options:** `Voltaria::Sandbox::RequestOptions`
|
|
1179
|
+
|
|
1180
|
+
</dd>
|
|
1181
|
+
</dl>
|
|
1182
|
+
</dd>
|
|
1183
|
+
</dl>
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
</dd>
|
|
1187
|
+
</dl>
|
|
1188
|
+
</details>
|
|
1189
|
+
|
|
1190
|
+
<details><summary><code>client.sandbox.<a href="/lib/voltaria/sandbox/client.rb">update_loan</a>(loan_id, request) -> Voltaria::Types::LoanResponseWithInstallments</code></summary>
|
|
1191
|
+
<dl>
|
|
1192
|
+
<dd>
|
|
1193
|
+
|
|
1194
|
+
#### 📝 Description
|
|
1195
|
+
|
|
1196
|
+
<dl>
|
|
1197
|
+
<dd>
|
|
1198
|
+
|
|
1199
|
+
<dl>
|
|
1200
|
+
<dd>
|
|
1201
|
+
|
|
1202
|
+
Update the status of a specific loan using its unique loan ID.
|
|
1203
|
+
</dd>
|
|
1204
|
+
</dl>
|
|
1205
|
+
</dd>
|
|
1206
|
+
</dl>
|
|
1207
|
+
|
|
1208
|
+
#### 🔌 Usage
|
|
1209
|
+
|
|
1210
|
+
<dl>
|
|
1211
|
+
<dd>
|
|
1212
|
+
|
|
1213
|
+
<dl>
|
|
1214
|
+
<dd>
|
|
1215
|
+
|
|
1216
|
+
```ruby
|
|
1217
|
+
client.sandbox.update_loan(loan_id: "loan_id")
|
|
1218
|
+
```
|
|
1219
|
+
</dd>
|
|
1220
|
+
</dl>
|
|
1221
|
+
</dd>
|
|
1222
|
+
</dl>
|
|
1223
|
+
|
|
1224
|
+
#### ⚙️ Parameters
|
|
1225
|
+
|
|
1226
|
+
<dl>
|
|
1227
|
+
<dd>
|
|
1228
|
+
|
|
1229
|
+
<dl>
|
|
1230
|
+
<dd>
|
|
1231
|
+
|
|
1232
|
+
**loan_id:** `String`
|
|
1233
|
+
|
|
1234
|
+
</dd>
|
|
1235
|
+
</dl>
|
|
1236
|
+
|
|
1237
|
+
<dl>
|
|
1238
|
+
<dd>
|
|
1239
|
+
|
|
1240
|
+
**status:** `Voltaria::Types::LoanStatusEnum` — The status of the client. One of the following: `pending, overdue, active, default, sold, restructured, repaid, pre_approved, rejected, deleted, inactive`
|
|
1241
|
+
|
|
1242
|
+
</dd>
|
|
1243
|
+
</dl>
|
|
1244
|
+
|
|
1245
|
+
<dl>
|
|
1246
|
+
<dd>
|
|
1247
|
+
|
|
1248
|
+
**request_options:** `Voltaria::Sandbox::RequestOptions`
|
|
1249
|
+
|
|
1250
|
+
</dd>
|
|
1251
|
+
</dl>
|
|
1252
|
+
</dd>
|
|
1253
|
+
</dl>
|
|
1254
|
+
|
|
1255
|
+
|
|
1256
|
+
</dd>
|
|
1257
|
+
</dl>
|
|
1258
|
+
</details>
|
|
1259
|
+
|
|
1260
|
+
<details><summary><code>client.sandbox.<a href="/lib/voltaria/sandbox/client.rb">webhook_test</a>(request) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
1261
|
+
<dl>
|
|
1262
|
+
<dd>
|
|
1263
|
+
|
|
1264
|
+
#### 📝 Description
|
|
1265
|
+
|
|
1266
|
+
<dl>
|
|
1267
|
+
<dd>
|
|
1268
|
+
|
|
1269
|
+
<dl>
|
|
1270
|
+
<dd>
|
|
1271
|
+
|
|
1272
|
+
Test a webhook subscription by ID or trigger all by event type.
|
|
1273
|
+
</dd>
|
|
1274
|
+
</dl>
|
|
1275
|
+
</dd>
|
|
1276
|
+
</dl>
|
|
1277
|
+
|
|
1278
|
+
#### 🔌 Usage
|
|
1279
|
+
|
|
1280
|
+
<dl>
|
|
1281
|
+
<dd>
|
|
1282
|
+
|
|
1283
|
+
<dl>
|
|
1284
|
+
<dd>
|
|
1285
|
+
|
|
1286
|
+
```ruby
|
|
1287
|
+
client.sandbox.webhook_test(event_type: "loan.updated")
|
|
1288
|
+
```
|
|
1289
|
+
</dd>
|
|
1290
|
+
</dl>
|
|
1291
|
+
</dd>
|
|
1292
|
+
</dl>
|
|
1293
|
+
|
|
1294
|
+
#### ⚙️ Parameters
|
|
1295
|
+
|
|
1296
|
+
<dl>
|
|
1297
|
+
<dd>
|
|
1298
|
+
|
|
1299
|
+
<dl>
|
|
1300
|
+
<dd>
|
|
1301
|
+
|
|
1302
|
+
**webhook_id:** `String` — The ID of the webhook subscription. Only this webhook will be triggered if provided.
|
|
1303
|
+
|
|
1304
|
+
</dd>
|
|
1305
|
+
</dl>
|
|
1306
|
+
|
|
1307
|
+
<dl>
|
|
1308
|
+
<dd>
|
|
1309
|
+
|
|
1310
|
+
**event_type:** `Voltaria::Types::WebhookEventTypeEnum` — Event type to trigger for the test. All subscriptions for this event type will be triggered if webhook_id is not provided.Possible values: loan_updated, installment_updated, client_updated, client_limit_updated, partner_limit_updated
|
|
1311
|
+
|
|
1312
|
+
</dd>
|
|
1313
|
+
</dl>
|
|
1314
|
+
|
|
1315
|
+
<dl>
|
|
1316
|
+
<dd>
|
|
1317
|
+
|
|
1318
|
+
**request_options:** `Voltaria::Sandbox::RequestOptions`
|
|
1319
|
+
|
|
1320
|
+
</dd>
|
|
1321
|
+
</dl>
|
|
1322
|
+
</dd>
|
|
1323
|
+
</dl>
|
|
1324
|
+
|
|
1325
|
+
|
|
1326
|
+
</dd>
|
|
1327
|
+
</dl>
|
|
1328
|
+
</details>
|
|
1329
|
+
|
|
1330
|
+
## Accounts
|
|
1331
|
+
<details><summary><code>client.accounts.<a href="/lib/voltaria/accounts/client.rb">list_client_account_fields</a>(client_id) -> Internal::Types::Hash[String, Voltaria::Types::CurrencyFieldSpec]</code></summary>
|
|
1332
|
+
<dl>
|
|
1333
|
+
<dd>
|
|
1334
|
+
|
|
1335
|
+
#### 📝 Description
|
|
1336
|
+
|
|
1337
|
+
<dl>
|
|
1338
|
+
<dd>
|
|
1339
|
+
|
|
1340
|
+
<dl>
|
|
1341
|
+
<dd>
|
|
1342
|
+
|
|
1343
|
+
Return the required and optional bank account fields for each supported currency. Fetch once and cache; use it to build the create-account request.
|
|
1344
|
+
</dd>
|
|
1345
|
+
</dl>
|
|
1346
|
+
</dd>
|
|
1347
|
+
</dl>
|
|
1348
|
+
|
|
1349
|
+
#### 🔌 Usage
|
|
1350
|
+
|
|
1351
|
+
<dl>
|
|
1352
|
+
<dd>
|
|
1353
|
+
|
|
1354
|
+
<dl>
|
|
1355
|
+
<dd>
|
|
1356
|
+
|
|
1357
|
+
```ruby
|
|
1358
|
+
client.accounts.list_client_account_fields(client_id: "client_id")
|
|
1359
|
+
```
|
|
1360
|
+
</dd>
|
|
1361
|
+
</dl>
|
|
1362
|
+
</dd>
|
|
1363
|
+
</dl>
|
|
1364
|
+
|
|
1365
|
+
#### ⚙️ Parameters
|
|
1366
|
+
|
|
1367
|
+
<dl>
|
|
1368
|
+
<dd>
|
|
1369
|
+
|
|
1370
|
+
<dl>
|
|
1371
|
+
<dd>
|
|
1372
|
+
|
|
1373
|
+
**client_id:** `String`
|
|
1374
|
+
|
|
1375
|
+
</dd>
|
|
1376
|
+
</dl>
|
|
1377
|
+
|
|
1378
|
+
<dl>
|
|
1379
|
+
<dd>
|
|
1380
|
+
|
|
1381
|
+
**request_options:** `Voltaria::Accounts::RequestOptions`
|
|
1382
|
+
|
|
1383
|
+
</dd>
|
|
1384
|
+
</dl>
|
|
1385
|
+
</dd>
|
|
1386
|
+
</dl>
|
|
1387
|
+
|
|
1388
|
+
|
|
1389
|
+
</dd>
|
|
1390
|
+
</dl>
|
|
1391
|
+
</details>
|
|
1392
|
+
|
|
1393
|
+
<details><summary><code>client.accounts.<a href="/lib/voltaria/accounts/client.rb">list_client_accounts</a>(client_id) -> Voltaria::Types::PaginatedResponseClientAccountResponse</code></summary>
|
|
1394
|
+
<dl>
|
|
1395
|
+
<dd>
|
|
1396
|
+
|
|
1397
|
+
#### 📝 Description
|
|
1398
|
+
|
|
1399
|
+
<dl>
|
|
1400
|
+
<dd>
|
|
1401
|
+
|
|
1402
|
+
<dl>
|
|
1403
|
+
<dd>
|
|
1404
|
+
|
|
1405
|
+
Retrieve all bank accounts for one of your clients.
|
|
1406
|
+
</dd>
|
|
1407
|
+
</dl>
|
|
1408
|
+
</dd>
|
|
1409
|
+
</dl>
|
|
1410
|
+
|
|
1411
|
+
#### 🔌 Usage
|
|
1412
|
+
|
|
1413
|
+
<dl>
|
|
1414
|
+
<dd>
|
|
1415
|
+
|
|
1416
|
+
<dl>
|
|
1417
|
+
<dd>
|
|
1418
|
+
|
|
1419
|
+
```ruby
|
|
1420
|
+
client.accounts.list_client_accounts(client_id: "client_id")
|
|
1421
|
+
```
|
|
1422
|
+
</dd>
|
|
1423
|
+
</dl>
|
|
1424
|
+
</dd>
|
|
1425
|
+
</dl>
|
|
1426
|
+
|
|
1427
|
+
#### ⚙️ Parameters
|
|
1428
|
+
|
|
1429
|
+
<dl>
|
|
1430
|
+
<dd>
|
|
1431
|
+
|
|
1432
|
+
<dl>
|
|
1433
|
+
<dd>
|
|
1434
|
+
|
|
1435
|
+
**client_id:** `String`
|
|
1436
|
+
|
|
1437
|
+
</dd>
|
|
1438
|
+
</dl>
|
|
1439
|
+
|
|
1440
|
+
<dl>
|
|
1441
|
+
<dd>
|
|
1442
|
+
|
|
1443
|
+
**page:** `Integer`
|
|
1444
|
+
|
|
1445
|
+
</dd>
|
|
1446
|
+
</dl>
|
|
1447
|
+
|
|
1448
|
+
<dl>
|
|
1449
|
+
<dd>
|
|
1450
|
+
|
|
1451
|
+
**page_size:** `Integer`
|
|
1452
|
+
|
|
1453
|
+
</dd>
|
|
1454
|
+
</dl>
|
|
1455
|
+
|
|
1456
|
+
<dl>
|
|
1457
|
+
<dd>
|
|
1458
|
+
|
|
1459
|
+
**order_by:** `String`
|
|
1460
|
+
|
|
1461
|
+
</dd>
|
|
1462
|
+
</dl>
|
|
1463
|
+
|
|
1464
|
+
<dl>
|
|
1465
|
+
<dd>
|
|
1466
|
+
|
|
1467
|
+
**request_options:** `Voltaria::Accounts::RequestOptions`
|
|
1468
|
+
|
|
1469
|
+
</dd>
|
|
1470
|
+
</dl>
|
|
1471
|
+
</dd>
|
|
1472
|
+
</dl>
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
</dd>
|
|
1476
|
+
</dl>
|
|
1477
|
+
</details>
|
|
1478
|
+
|
|
1479
|
+
<details><summary><code>client.accounts.<a href="/lib/voltaria/accounts/client.rb">create_client_account</a>(client_id, request) -> Voltaria::Types::ClientAccountResponse</code></summary>
|
|
1480
|
+
<dl>
|
|
1481
|
+
<dd>
|
|
1482
|
+
|
|
1483
|
+
#### 📝 Description
|
|
1484
|
+
|
|
1485
|
+
<dl>
|
|
1486
|
+
<dd>
|
|
1487
|
+
|
|
1488
|
+
<dl>
|
|
1489
|
+
<dd>
|
|
1490
|
+
|
|
1491
|
+
Create a bank account for one of your clients. The account is registered with the payment provider immediately. Use the `status` field to create it as `active` (default; demotes any existing active account in the same currency to `passive`) or `passive`.
|
|
1492
|
+
</dd>
|
|
1493
|
+
</dl>
|
|
1494
|
+
</dd>
|
|
1495
|
+
</dl>
|
|
1496
|
+
|
|
1497
|
+
#### 🔌 Usage
|
|
1498
|
+
|
|
1499
|
+
<dl>
|
|
1500
|
+
<dd>
|
|
1501
|
+
|
|
1502
|
+
<dl>
|
|
1503
|
+
<dd>
|
|
1504
|
+
|
|
1505
|
+
```ruby
|
|
1506
|
+
client.accounts.create_client_account(
|
|
1507
|
+
client_id: "client_id",
|
|
1508
|
+
account_holder_name: "Acme Ltd",
|
|
1509
|
+
account_holder_type: "business",
|
|
1510
|
+
currency: "gbp",
|
|
1511
|
+
sort_code: "40-47-84",
|
|
1512
|
+
account_number: "12345678"
|
|
1513
|
+
)
|
|
1514
|
+
```
|
|
1515
|
+
</dd>
|
|
1516
|
+
</dl>
|
|
1517
|
+
</dd>
|
|
1518
|
+
</dl>
|
|
1519
|
+
|
|
1520
|
+
#### ⚙️ Parameters
|
|
1521
|
+
|
|
1522
|
+
<dl>
|
|
1523
|
+
<dd>
|
|
1524
|
+
|
|
1525
|
+
<dl>
|
|
1526
|
+
<dd>
|
|
1527
|
+
|
|
1528
|
+
**client_id:** `String`
|
|
1529
|
+
|
|
1530
|
+
</dd>
|
|
1531
|
+
</dl>
|
|
1532
|
+
|
|
1533
|
+
<dl>
|
|
1534
|
+
<dd>
|
|
1535
|
+
|
|
1536
|
+
**account_holder_name:** `String` — Full name of the account holder.
|
|
1537
|
+
|
|
1538
|
+
</dd>
|
|
1539
|
+
</dl>
|
|
1540
|
+
|
|
1541
|
+
<dl>
|
|
1542
|
+
<dd>
|
|
1543
|
+
|
|
1544
|
+
**label:** `String` — Optional label / nickname for the account (max 50 characters).
|
|
1545
|
+
|
|
1546
|
+
</dd>
|
|
1547
|
+
</dl>
|
|
1548
|
+
|
|
1549
|
+
<dl>
|
|
1550
|
+
<dd>
|
|
1551
|
+
|
|
1552
|
+
**account_holder_type:** `Voltaria::Types::AccountHolderTypeEnum` — Account holder type. One of: `business`, `private`.
|
|
1553
|
+
|
|
1554
|
+
</dd>
|
|
1555
|
+
</dl>
|
|
1556
|
+
|
|
1557
|
+
<dl>
|
|
1558
|
+
<dd>
|
|
1559
|
+
|
|
1560
|
+
**currency:** `Voltaria::Types::CurrencyEnum` — ISO 4217 currency code. Use `/accounts/fields` to get required fields per currency.
|
|
1561
|
+
|
|
1562
|
+
</dd>
|
|
1563
|
+
</dl>
|
|
1564
|
+
|
|
1565
|
+
<dl>
|
|
1566
|
+
<dd>
|
|
1567
|
+
|
|
1568
|
+
**sort_code:** `String` — Sort code (required for GBP).
|
|
1569
|
+
|
|
1570
|
+
</dd>
|
|
1571
|
+
</dl>
|
|
1572
|
+
|
|
1573
|
+
<dl>
|
|
1574
|
+
<dd>
|
|
1575
|
+
|
|
1576
|
+
**account_number:** `String` — Account number (required for GBP and USD).
|
|
1577
|
+
|
|
1578
|
+
</dd>
|
|
1579
|
+
</dl>
|
|
1580
|
+
|
|
1581
|
+
<dl>
|
|
1582
|
+
<dd>
|
|
1583
|
+
|
|
1584
|
+
**iban:** `String` — IBAN (required for EUR, CZK, PLN).
|
|
1585
|
+
|
|
1586
|
+
</dd>
|
|
1587
|
+
</dl>
|
|
1588
|
+
|
|
1589
|
+
<dl>
|
|
1590
|
+
<dd>
|
|
1591
|
+
|
|
1592
|
+
**bic:** `String` — BIC / SWIFT code (optional for EUR).
|
|
1593
|
+
|
|
1594
|
+
</dd>
|
|
1595
|
+
</dl>
|
|
1596
|
+
|
|
1597
|
+
<dl>
|
|
1598
|
+
<dd>
|
|
1599
|
+
|
|
1600
|
+
**routing_number:** `String` — ABA routing number (required for USD).
|
|
1601
|
+
|
|
1602
|
+
</dd>
|
|
1603
|
+
</dl>
|
|
1604
|
+
|
|
1605
|
+
<dl>
|
|
1606
|
+
<dd>
|
|
1607
|
+
|
|
1608
|
+
**account_type:** `String` — Account type (required for USD). E.g. `checking` or `savings`.
|
|
1609
|
+
|
|
1610
|
+
</dd>
|
|
1611
|
+
</dl>
|
|
1612
|
+
|
|
1613
|
+
<dl>
|
|
1614
|
+
<dd>
|
|
1615
|
+
|
|
1616
|
+
**address:** `Voltaria::Types::AccountAddress` — Account holder address (required for USD).
|
|
1617
|
+
|
|
1618
|
+
</dd>
|
|
1619
|
+
</dl>
|
|
1620
|
+
|
|
1621
|
+
<dl>
|
|
1622
|
+
<dd>
|
|
1623
|
+
|
|
1624
|
+
**status:** `Voltaria::Accounts::Types::PartnerClientAccountCreateRequestStatus` — Account status. `active` demotes any existing active account in the same currency to `passive`; `passive` is added as a backup. Defaults to `active`.
|
|
1625
|
+
|
|
1626
|
+
</dd>
|
|
1627
|
+
</dl>
|
|
1628
|
+
|
|
1629
|
+
<dl>
|
|
1630
|
+
<dd>
|
|
1631
|
+
|
|
1632
|
+
**request_options:** `Voltaria::Accounts::RequestOptions`
|
|
1633
|
+
|
|
1634
|
+
</dd>
|
|
1635
|
+
</dl>
|
|
1636
|
+
</dd>
|
|
1637
|
+
</dl>
|
|
1638
|
+
|
|
1639
|
+
|
|
1640
|
+
</dd>
|
|
1641
|
+
</dl>
|
|
1642
|
+
</details>
|
|
1643
|
+
|
|
1644
|
+
<details><summary><code>client.accounts.<a href="/lib/voltaria/accounts/client.rb">get_client_account</a>(client_id, account_id) -> Voltaria::Types::ClientAccountResponse</code></summary>
|
|
1645
|
+
<dl>
|
|
1646
|
+
<dd>
|
|
1647
|
+
|
|
1648
|
+
#### 📝 Description
|
|
1649
|
+
|
|
1650
|
+
<dl>
|
|
1651
|
+
<dd>
|
|
1652
|
+
|
|
1653
|
+
<dl>
|
|
1654
|
+
<dd>
|
|
1655
|
+
|
|
1656
|
+
Retrieve a specific bank account for one of your clients.
|
|
1657
|
+
</dd>
|
|
1658
|
+
</dl>
|
|
1659
|
+
</dd>
|
|
1660
|
+
</dl>
|
|
1661
|
+
|
|
1662
|
+
#### 🔌 Usage
|
|
1663
|
+
|
|
1664
|
+
<dl>
|
|
1665
|
+
<dd>
|
|
1666
|
+
|
|
1667
|
+
<dl>
|
|
1668
|
+
<dd>
|
|
1669
|
+
|
|
1670
|
+
```ruby
|
|
1671
|
+
client.accounts.get_client_account(
|
|
1672
|
+
client_id: "client_id",
|
|
1673
|
+
account_id: "account_id"
|
|
1674
|
+
)
|
|
1675
|
+
```
|
|
1676
|
+
</dd>
|
|
1677
|
+
</dl>
|
|
1678
|
+
</dd>
|
|
1679
|
+
</dl>
|
|
1680
|
+
|
|
1681
|
+
#### ⚙️ Parameters
|
|
1682
|
+
|
|
1683
|
+
<dl>
|
|
1684
|
+
<dd>
|
|
1685
|
+
|
|
1686
|
+
<dl>
|
|
1687
|
+
<dd>
|
|
1688
|
+
|
|
1689
|
+
**client_id:** `String`
|
|
1690
|
+
|
|
1691
|
+
</dd>
|
|
1692
|
+
</dl>
|
|
1693
|
+
|
|
1694
|
+
<dl>
|
|
1695
|
+
<dd>
|
|
1696
|
+
|
|
1697
|
+
**account_id:** `String`
|
|
1698
|
+
|
|
1699
|
+
</dd>
|
|
1700
|
+
</dl>
|
|
1701
|
+
|
|
1702
|
+
<dl>
|
|
1703
|
+
<dd>
|
|
1704
|
+
|
|
1705
|
+
**request_options:** `Voltaria::Accounts::RequestOptions`
|
|
1706
|
+
|
|
1707
|
+
</dd>
|
|
1708
|
+
</dl>
|
|
1709
|
+
</dd>
|
|
1710
|
+
</dl>
|
|
1711
|
+
|
|
1712
|
+
|
|
1713
|
+
</dd>
|
|
1714
|
+
</dl>
|
|
1715
|
+
</details>
|
|
1716
|
+
|
|
1717
|
+
## Documents
|
|
1718
|
+
<details><summary><code>client.documents.<a href="/lib/voltaria/documents/client.rb">list_documents</a>() -> Voltaria::Types::PaginatedResponseDocumentResponse</code></summary>
|
|
1719
|
+
<dl>
|
|
1720
|
+
<dd>
|
|
1721
|
+
|
|
1722
|
+
#### 📝 Description
|
|
1723
|
+
|
|
1724
|
+
<dl>
|
|
1725
|
+
<dd>
|
|
1726
|
+
|
|
1727
|
+
<dl>
|
|
1728
|
+
<dd>
|
|
1729
|
+
|
|
1730
|
+
Retrieve all documents linked to a client.
|
|
1731
|
+
</dd>
|
|
1732
|
+
</dl>
|
|
1733
|
+
</dd>
|
|
1734
|
+
</dl>
|
|
1735
|
+
|
|
1736
|
+
#### 🔌 Usage
|
|
1737
|
+
|
|
1738
|
+
<dl>
|
|
1739
|
+
<dd>
|
|
1740
|
+
|
|
1741
|
+
<dl>
|
|
1742
|
+
<dd>
|
|
1743
|
+
|
|
1744
|
+
```ruby
|
|
1745
|
+
client.documents.list_documents
|
|
1746
|
+
```
|
|
1747
|
+
</dd>
|
|
1748
|
+
</dl>
|
|
1749
|
+
</dd>
|
|
1750
|
+
</dl>
|
|
1751
|
+
|
|
1752
|
+
#### ⚙️ Parameters
|
|
1753
|
+
|
|
1754
|
+
<dl>
|
|
1755
|
+
<dd>
|
|
1756
|
+
|
|
1757
|
+
<dl>
|
|
1758
|
+
<dd>
|
|
1759
|
+
|
|
1760
|
+
**client_id:** `String`
|
|
1761
|
+
|
|
1762
|
+
</dd>
|
|
1763
|
+
</dl>
|
|
1764
|
+
|
|
1765
|
+
<dl>
|
|
1766
|
+
<dd>
|
|
1767
|
+
|
|
1768
|
+
**loan_id:** `String`
|
|
1769
|
+
|
|
1770
|
+
</dd>
|
|
1771
|
+
</dl>
|
|
1772
|
+
|
|
1773
|
+
<dl>
|
|
1774
|
+
<dd>
|
|
1775
|
+
|
|
1776
|
+
**installment_id:** `String`
|
|
1777
|
+
|
|
1778
|
+
</dd>
|
|
1779
|
+
</dl>
|
|
1780
|
+
|
|
1781
|
+
<dl>
|
|
1782
|
+
<dd>
|
|
1783
|
+
|
|
1784
|
+
**waterfall_id:** `String`
|
|
1785
|
+
|
|
1786
|
+
</dd>
|
|
1787
|
+
</dl>
|
|
1788
|
+
|
|
1789
|
+
<dl>
|
|
1790
|
+
<dd>
|
|
1791
|
+
|
|
1792
|
+
**page:** `Integer`
|
|
1793
|
+
|
|
1794
|
+
</dd>
|
|
1795
|
+
</dl>
|
|
1796
|
+
|
|
1797
|
+
<dl>
|
|
1798
|
+
<dd>
|
|
1799
|
+
|
|
1800
|
+
**page_size:** `Integer`
|
|
1801
|
+
|
|
1802
|
+
</dd>
|
|
1803
|
+
</dl>
|
|
1804
|
+
|
|
1805
|
+
<dl>
|
|
1806
|
+
<dd>
|
|
1807
|
+
|
|
1808
|
+
**order_by:** `String` — Field to order the results by, e.g., 'created_at:desc,updated_at:asc'
|
|
1809
|
+
|
|
1810
|
+
</dd>
|
|
1811
|
+
</dl>
|
|
1812
|
+
|
|
1813
|
+
<dl>
|
|
1814
|
+
<dd>
|
|
1815
|
+
|
|
1816
|
+
**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: id, client_id, loan_id, installment_id, waterfall_id, category, file_name, document_date, folder_path. Supported operators: is, in, not_in, contains, not_contains, like, not_like, ilike, not_ilike, gt, gte, lt, lte, starts_with, ends_with, is_null, is_not_null.
|
|
1817
|
+
|
|
1818
|
+
</dd>
|
|
1819
|
+
</dl>
|
|
1820
|
+
|
|
1821
|
+
<dl>
|
|
1822
|
+
<dd>
|
|
1823
|
+
|
|
1824
|
+
**request_options:** `Voltaria::Documents::RequestOptions`
|
|
1825
|
+
|
|
1826
|
+
</dd>
|
|
1827
|
+
</dl>
|
|
1828
|
+
</dd>
|
|
1829
|
+
</dl>
|
|
1830
|
+
|
|
1831
|
+
|
|
1832
|
+
</dd>
|
|
1833
|
+
</dl>
|
|
1834
|
+
</details>
|
|
1835
|
+
|
|
1836
|
+
<details><summary><code>client.documents.<a href="/lib/voltaria/documents/client.rb">upload_document</a>(request) -> Voltaria::Types::DocumentResponse</code></summary>
|
|
1837
|
+
<dl>
|
|
1838
|
+
<dd>
|
|
1839
|
+
|
|
1840
|
+
#### 📝 Description
|
|
1841
|
+
|
|
1842
|
+
<dl>
|
|
1843
|
+
<dd>
|
|
1844
|
+
|
|
1845
|
+
<dl>
|
|
1846
|
+
<dd>
|
|
1847
|
+
|
|
1848
|
+
Upload a new document related to a client or loan, such as financial statements or KYC files.
|
|
1849
|
+
</dd>
|
|
1850
|
+
</dl>
|
|
1851
|
+
</dd>
|
|
1852
|
+
</dl>
|
|
1853
|
+
|
|
1854
|
+
#### 🔌 Usage
|
|
1855
|
+
|
|
1856
|
+
<dl>
|
|
1857
|
+
<dd>
|
|
1858
|
+
|
|
1859
|
+
<dl>
|
|
1860
|
+
<dd>
|
|
1861
|
+
|
|
1862
|
+
```ruby
|
|
1863
|
+
client.documents.upload_document
|
|
1864
|
+
```
|
|
1865
|
+
</dd>
|
|
1866
|
+
</dl>
|
|
1867
|
+
</dd>
|
|
1868
|
+
</dl>
|
|
1869
|
+
|
|
1870
|
+
#### ⚙️ Parameters
|
|
1871
|
+
|
|
1872
|
+
<dl>
|
|
1873
|
+
<dd>
|
|
1874
|
+
|
|
1875
|
+
<dl>
|
|
1876
|
+
<dd>
|
|
1877
|
+
|
|
1878
|
+
**client_id:** `String`
|
|
1879
|
+
|
|
1880
|
+
</dd>
|
|
1881
|
+
</dl>
|
|
1882
|
+
|
|
1883
|
+
<dl>
|
|
1884
|
+
<dd>
|
|
1885
|
+
|
|
1886
|
+
**loan_id:** `String`
|
|
1887
|
+
|
|
1888
|
+
</dd>
|
|
1889
|
+
</dl>
|
|
1890
|
+
|
|
1891
|
+
<dl>
|
|
1892
|
+
<dd>
|
|
1893
|
+
|
|
1894
|
+
**installment_id:** `String`
|
|
1895
|
+
|
|
1896
|
+
</dd>
|
|
1897
|
+
</dl>
|
|
1898
|
+
|
|
1899
|
+
<dl>
|
|
1900
|
+
<dd>
|
|
1901
|
+
|
|
1902
|
+
**waterfall_id:** `String`
|
|
1903
|
+
|
|
1904
|
+
</dd>
|
|
1905
|
+
</dl>
|
|
1906
|
+
|
|
1907
|
+
<dl>
|
|
1908
|
+
<dd>
|
|
1909
|
+
|
|
1910
|
+
**request_options:** `Voltaria::Documents::RequestOptions`
|
|
1911
|
+
|
|
1912
|
+
</dd>
|
|
1913
|
+
</dl>
|
|
1914
|
+
</dd>
|
|
1915
|
+
</dl>
|
|
1916
|
+
|
|
1917
|
+
|
|
1918
|
+
</dd>
|
|
1919
|
+
</dl>
|
|
1920
|
+
</details>
|
|
1921
|
+
|
|
1922
|
+
<details><summary><code>client.documents.<a href="/lib/voltaria/documents/client.rb">get_available_document_categories</a>() -> Voltaria::Types::AvailableDocumentCategoriesResponse</code></summary>
|
|
1923
|
+
<dl>
|
|
1924
|
+
<dd>
|
|
1925
|
+
|
|
1926
|
+
#### 📝 Description
|
|
1927
|
+
|
|
1928
|
+
<dl>
|
|
1929
|
+
<dd>
|
|
1930
|
+
|
|
1931
|
+
<dl>
|
|
1932
|
+
<dd>
|
|
1933
|
+
|
|
1934
|
+
Retrieve all available document categories.
|
|
1935
|
+
</dd>
|
|
1936
|
+
</dl>
|
|
1937
|
+
</dd>
|
|
1938
|
+
</dl>
|
|
1939
|
+
|
|
1940
|
+
#### 🔌 Usage
|
|
1941
|
+
|
|
1942
|
+
<dl>
|
|
1943
|
+
<dd>
|
|
1944
|
+
|
|
1945
|
+
<dl>
|
|
1946
|
+
<dd>
|
|
1947
|
+
|
|
1948
|
+
```ruby
|
|
1949
|
+
client.documents.get_available_document_categories
|
|
1950
|
+
```
|
|
1951
|
+
</dd>
|
|
1952
|
+
</dl>
|
|
1953
|
+
</dd>
|
|
1954
|
+
</dl>
|
|
1955
|
+
|
|
1956
|
+
#### ⚙️ Parameters
|
|
1957
|
+
|
|
1958
|
+
<dl>
|
|
1959
|
+
<dd>
|
|
1960
|
+
|
|
1961
|
+
<dl>
|
|
1962
|
+
<dd>
|
|
1963
|
+
|
|
1964
|
+
**request_options:** `Voltaria::Documents::RequestOptions`
|
|
1965
|
+
|
|
1966
|
+
</dd>
|
|
1967
|
+
</dl>
|
|
1968
|
+
</dd>
|
|
1969
|
+
</dl>
|
|
1970
|
+
|
|
1971
|
+
|
|
1972
|
+
</dd>
|
|
1973
|
+
</dl>
|
|
1974
|
+
</details>
|
|
1975
|
+
|
|
1976
|
+
<details><summary><code>client.documents.<a href="/lib/voltaria/documents/client.rb">get_document_by_id</a>(document_id) -> Voltaria::Types::DocumentResponse</code></summary>
|
|
1977
|
+
<dl>
|
|
1978
|
+
<dd>
|
|
1979
|
+
|
|
1980
|
+
#### 📝 Description
|
|
1981
|
+
|
|
1982
|
+
<dl>
|
|
1983
|
+
<dd>
|
|
1984
|
+
|
|
1985
|
+
<dl>
|
|
1986
|
+
<dd>
|
|
1987
|
+
|
|
1988
|
+
Retrieve details for a specific document using its document ID.
|
|
1989
|
+
</dd>
|
|
1990
|
+
</dl>
|
|
1991
|
+
</dd>
|
|
1992
|
+
</dl>
|
|
1993
|
+
|
|
1994
|
+
#### 🔌 Usage
|
|
1995
|
+
|
|
1996
|
+
<dl>
|
|
1997
|
+
<dd>
|
|
1998
|
+
|
|
1999
|
+
<dl>
|
|
2000
|
+
<dd>
|
|
2001
|
+
|
|
2002
|
+
```ruby
|
|
2003
|
+
client.documents.get_document_by_id(document_id: "document_id")
|
|
2004
|
+
```
|
|
2005
|
+
</dd>
|
|
2006
|
+
</dl>
|
|
2007
|
+
</dd>
|
|
2008
|
+
</dl>
|
|
2009
|
+
|
|
2010
|
+
#### ⚙️ Parameters
|
|
2011
|
+
|
|
2012
|
+
<dl>
|
|
2013
|
+
<dd>
|
|
2014
|
+
|
|
2015
|
+
<dl>
|
|
2016
|
+
<dd>
|
|
2017
|
+
|
|
2018
|
+
**document_id:** `String`
|
|
2019
|
+
|
|
2020
|
+
</dd>
|
|
2021
|
+
</dl>
|
|
2022
|
+
|
|
2023
|
+
<dl>
|
|
2024
|
+
<dd>
|
|
2025
|
+
|
|
2026
|
+
**request_options:** `Voltaria::Documents::RequestOptions`
|
|
2027
|
+
|
|
2028
|
+
</dd>
|
|
2029
|
+
</dl>
|
|
2030
|
+
</dd>
|
|
2031
|
+
</dl>
|
|
2032
|
+
|
|
2033
|
+
|
|
2034
|
+
</dd>
|
|
2035
|
+
</dl>
|
|
2036
|
+
</details>
|
|
2037
|
+
|
|
2038
|
+
<details><summary><code>client.documents.<a href="/lib/voltaria/documents/client.rb">delete_document</a>(document_id) -> </code></summary>
|
|
2039
|
+
<dl>
|
|
2040
|
+
<dd>
|
|
2041
|
+
|
|
2042
|
+
#### 📝 Description
|
|
2043
|
+
|
|
2044
|
+
<dl>
|
|
2045
|
+
<dd>
|
|
2046
|
+
|
|
2047
|
+
<dl>
|
|
2048
|
+
<dd>
|
|
2049
|
+
|
|
2050
|
+
Delete a specific document by using its document ID.
|
|
2051
|
+
</dd>
|
|
2052
|
+
</dl>
|
|
2053
|
+
</dd>
|
|
2054
|
+
</dl>
|
|
2055
|
+
|
|
2056
|
+
#### 🔌 Usage
|
|
2057
|
+
|
|
2058
|
+
<dl>
|
|
2059
|
+
<dd>
|
|
2060
|
+
|
|
2061
|
+
<dl>
|
|
2062
|
+
<dd>
|
|
2063
|
+
|
|
2064
|
+
```ruby
|
|
2065
|
+
client.documents.delete_document(document_id: "document_id")
|
|
2066
|
+
```
|
|
2067
|
+
</dd>
|
|
2068
|
+
</dl>
|
|
2069
|
+
</dd>
|
|
2070
|
+
</dl>
|
|
2071
|
+
|
|
2072
|
+
#### ⚙️ Parameters
|
|
2073
|
+
|
|
2074
|
+
<dl>
|
|
2075
|
+
<dd>
|
|
2076
|
+
|
|
2077
|
+
<dl>
|
|
2078
|
+
<dd>
|
|
2079
|
+
|
|
2080
|
+
**document_id:** `String`
|
|
2081
|
+
|
|
2082
|
+
</dd>
|
|
2083
|
+
</dl>
|
|
2084
|
+
|
|
2085
|
+
<dl>
|
|
2086
|
+
<dd>
|
|
2087
|
+
|
|
2088
|
+
**request_options:** `Voltaria::Documents::RequestOptions`
|
|
2089
|
+
|
|
2090
|
+
</dd>
|
|
2091
|
+
</dl>
|
|
2092
|
+
</dd>
|
|
2093
|
+
</dl>
|
|
2094
|
+
|
|
2095
|
+
|
|
2096
|
+
</dd>
|
|
2097
|
+
</dl>
|
|
2098
|
+
</details>
|
|
2099
|
+
|
|
2100
|
+
## Investors
|
|
2101
|
+
<details><summary><code>client.investors.<a href="/lib/voltaria/investors/client.rb">investor_list_clients</a>() -> Voltaria::Types::PaginatedResponseClientInvestorResponse</code></summary>
|
|
2102
|
+
<dl>
|
|
2103
|
+
<dd>
|
|
2104
|
+
|
|
2105
|
+
#### 📝 Description
|
|
2106
|
+
|
|
2107
|
+
<dl>
|
|
2108
|
+
<dd>
|
|
2109
|
+
|
|
2110
|
+
<dl>
|
|
2111
|
+
<dd>
|
|
2112
|
+
|
|
2113
|
+
Retrieve all clients with at least one loan funded by this investor.
|
|
2114
|
+
</dd>
|
|
2115
|
+
</dl>
|
|
2116
|
+
</dd>
|
|
2117
|
+
</dl>
|
|
2118
|
+
|
|
2119
|
+
#### 🔌 Usage
|
|
2120
|
+
|
|
2121
|
+
<dl>
|
|
2122
|
+
<dd>
|
|
2123
|
+
|
|
2124
|
+
<dl>
|
|
2125
|
+
<dd>
|
|
2126
|
+
|
|
2127
|
+
```ruby
|
|
2128
|
+
client.investors.investor_list_clients
|
|
2129
|
+
```
|
|
2130
|
+
</dd>
|
|
2131
|
+
</dl>
|
|
2132
|
+
</dd>
|
|
2133
|
+
</dl>
|
|
2134
|
+
|
|
2135
|
+
#### ⚙️ Parameters
|
|
2136
|
+
|
|
2137
|
+
<dl>
|
|
2138
|
+
<dd>
|
|
2139
|
+
|
|
2140
|
+
<dl>
|
|
2141
|
+
<dd>
|
|
2142
|
+
|
|
2143
|
+
**page:** `Integer`
|
|
2144
|
+
|
|
2145
|
+
</dd>
|
|
2146
|
+
</dl>
|
|
2147
|
+
|
|
2148
|
+
<dl>
|
|
2149
|
+
<dd>
|
|
2150
|
+
|
|
2151
|
+
**page_size:** `Integer`
|
|
2152
|
+
|
|
2153
|
+
</dd>
|
|
2154
|
+
</dl>
|
|
2155
|
+
|
|
2156
|
+
<dl>
|
|
2157
|
+
<dd>
|
|
2158
|
+
|
|
2159
|
+
**order_by:** `String`
|
|
2160
|
+
|
|
2161
|
+
</dd>
|
|
2162
|
+
</dl>
|
|
2163
|
+
|
|
2164
|
+
<dl>
|
|
2165
|
+
<dd>
|
|
2166
|
+
|
|
2167
|
+
**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: id, name, correlation_id, company_number, status. Supported operators: is, in, not_in, contains, not_contains, like, not_like, ilike, not_ilike, gt, gte, lt, lte, starts_with, ends_with, is_null, is_not_null.
|
|
2168
|
+
|
|
2169
|
+
</dd>
|
|
2170
|
+
</dl>
|
|
2171
|
+
|
|
2172
|
+
<dl>
|
|
2173
|
+
<dd>
|
|
2174
|
+
|
|
2175
|
+
**request_options:** `Voltaria::Investors::RequestOptions`
|
|
2176
|
+
|
|
2177
|
+
</dd>
|
|
2178
|
+
</dl>
|
|
2179
|
+
</dd>
|
|
2180
|
+
</dl>
|
|
2181
|
+
|
|
2182
|
+
|
|
2183
|
+
</dd>
|
|
2184
|
+
</dl>
|
|
2185
|
+
</details>
|
|
2186
|
+
|
|
2187
|
+
<details><summary><code>client.investors.<a href="/lib/voltaria/investors/client.rb">investor_get_client</a>(client_id) -> Voltaria::Types::ClientInvestorResponse</code></summary>
|
|
2188
|
+
<dl>
|
|
2189
|
+
<dd>
|
|
2190
|
+
|
|
2191
|
+
#### 📝 Description
|
|
2192
|
+
|
|
2193
|
+
<dl>
|
|
2194
|
+
<dd>
|
|
2195
|
+
|
|
2196
|
+
<dl>
|
|
2197
|
+
<dd>
|
|
2198
|
+
|
|
2199
|
+
Retrieve a specific client that has a loan funded by this investor.
|
|
2200
|
+
</dd>
|
|
2201
|
+
</dl>
|
|
2202
|
+
</dd>
|
|
2203
|
+
</dl>
|
|
2204
|
+
|
|
2205
|
+
#### 🔌 Usage
|
|
2206
|
+
|
|
2207
|
+
<dl>
|
|
2208
|
+
<dd>
|
|
2209
|
+
|
|
2210
|
+
<dl>
|
|
2211
|
+
<dd>
|
|
2212
|
+
|
|
2213
|
+
```ruby
|
|
2214
|
+
client.investors.investor_get_client(client_id: "client_id")
|
|
2215
|
+
```
|
|
2216
|
+
</dd>
|
|
2217
|
+
</dl>
|
|
2218
|
+
</dd>
|
|
2219
|
+
</dl>
|
|
2220
|
+
|
|
2221
|
+
#### ⚙️ Parameters
|
|
2222
|
+
|
|
2223
|
+
<dl>
|
|
2224
|
+
<dd>
|
|
2225
|
+
|
|
2226
|
+
<dl>
|
|
2227
|
+
<dd>
|
|
2228
|
+
|
|
2229
|
+
**client_id:** `String`
|
|
2230
|
+
|
|
2231
|
+
</dd>
|
|
2232
|
+
</dl>
|
|
2233
|
+
|
|
2234
|
+
<dl>
|
|
2235
|
+
<dd>
|
|
2236
|
+
|
|
2237
|
+
**request_options:** `Voltaria::Investors::RequestOptions`
|
|
2238
|
+
|
|
2239
|
+
</dd>
|
|
2240
|
+
</dl>
|
|
2241
|
+
</dd>
|
|
2242
|
+
</dl>
|
|
2243
|
+
|
|
2244
|
+
|
|
2245
|
+
</dd>
|
|
2246
|
+
</dl>
|
|
2247
|
+
</details>
|
|
2248
|
+
|
|
2249
|
+
<details><summary><code>client.investors.<a href="/lib/voltaria/investors/client.rb">investor_list_loans</a>() -> Voltaria::Types::PaginatedResponseLoanInvestorResponse</code></summary>
|
|
2250
|
+
<dl>
|
|
2251
|
+
<dd>
|
|
2252
|
+
|
|
2253
|
+
#### 📝 Description
|
|
2254
|
+
|
|
2255
|
+
<dl>
|
|
2256
|
+
<dd>
|
|
2257
|
+
|
|
2258
|
+
<dl>
|
|
2259
|
+
<dd>
|
|
2260
|
+
|
|
2261
|
+
Retrieve all loans funded by the current investor.
|
|
2262
|
+
</dd>
|
|
2263
|
+
</dl>
|
|
2264
|
+
</dd>
|
|
2265
|
+
</dl>
|
|
2266
|
+
|
|
2267
|
+
#### 🔌 Usage
|
|
2268
|
+
|
|
2269
|
+
<dl>
|
|
2270
|
+
<dd>
|
|
2271
|
+
|
|
2272
|
+
<dl>
|
|
2273
|
+
<dd>
|
|
2274
|
+
|
|
2275
|
+
```ruby
|
|
2276
|
+
client.investors.investor_list_loans
|
|
2277
|
+
```
|
|
2278
|
+
</dd>
|
|
2279
|
+
</dl>
|
|
2280
|
+
</dd>
|
|
2281
|
+
</dl>
|
|
2282
|
+
|
|
2283
|
+
#### ⚙️ Parameters
|
|
2284
|
+
|
|
2285
|
+
<dl>
|
|
2286
|
+
<dd>
|
|
2287
|
+
|
|
2288
|
+
<dl>
|
|
2289
|
+
<dd>
|
|
2290
|
+
|
|
2291
|
+
**page:** `Integer`
|
|
2292
|
+
|
|
2293
|
+
</dd>
|
|
2294
|
+
</dl>
|
|
2295
|
+
|
|
2296
|
+
<dl>
|
|
2297
|
+
<dd>
|
|
2298
|
+
|
|
2299
|
+
**page_size:** `Integer`
|
|
2300
|
+
|
|
2301
|
+
</dd>
|
|
2302
|
+
</dl>
|
|
2303
|
+
|
|
2304
|
+
<dl>
|
|
2305
|
+
<dd>
|
|
2306
|
+
|
|
2307
|
+
**client_id:** `String`
|
|
2308
|
+
|
|
2309
|
+
</dd>
|
|
2310
|
+
</dl>
|
|
2311
|
+
|
|
2312
|
+
<dl>
|
|
2313
|
+
<dd>
|
|
2314
|
+
|
|
2315
|
+
**order_by:** `String`
|
|
2316
|
+
|
|
2317
|
+
</dd>
|
|
2318
|
+
</dl>
|
|
2319
|
+
|
|
2320
|
+
<dl>
|
|
2321
|
+
<dd>
|
|
2322
|
+
|
|
2323
|
+
**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: id, partner_id, client_id, status, loan_date, currency, partner.name, client.name. Supported operators: is, in, not_in, contains, not_contains, like, not_like, ilike, not_ilike, gt, gte, lt, lte, starts_with, ends_with, is_null, is_not_null.
|
|
2324
|
+
|
|
2325
|
+
</dd>
|
|
2326
|
+
</dl>
|
|
2327
|
+
|
|
2328
|
+
<dl>
|
|
2329
|
+
<dd>
|
|
2330
|
+
|
|
2331
|
+
**request_options:** `Voltaria::Investors::RequestOptions`
|
|
2332
|
+
|
|
2333
|
+
</dd>
|
|
2334
|
+
</dl>
|
|
2335
|
+
</dd>
|
|
2336
|
+
</dl>
|
|
2337
|
+
|
|
2338
|
+
|
|
2339
|
+
</dd>
|
|
2340
|
+
</dl>
|
|
2341
|
+
</details>
|
|
2342
|
+
|
|
2343
|
+
<details><summary><code>client.investors.<a href="/lib/voltaria/investors/client.rb">investor_get_loan</a>(loan_id) -> Voltaria::Types::LoanResponseWithInstallments</code></summary>
|
|
2344
|
+
<dl>
|
|
2345
|
+
<dd>
|
|
2346
|
+
|
|
2347
|
+
#### 📝 Description
|
|
2348
|
+
|
|
2349
|
+
<dl>
|
|
2350
|
+
<dd>
|
|
2351
|
+
|
|
2352
|
+
<dl>
|
|
2353
|
+
<dd>
|
|
2354
|
+
|
|
2355
|
+
Retrieve a specific loan funded by the current investor, with its installments.
|
|
2356
|
+
</dd>
|
|
2357
|
+
</dl>
|
|
2358
|
+
</dd>
|
|
2359
|
+
</dl>
|
|
2360
|
+
|
|
2361
|
+
#### 🔌 Usage
|
|
2362
|
+
|
|
2363
|
+
<dl>
|
|
2364
|
+
<dd>
|
|
2365
|
+
|
|
2366
|
+
<dl>
|
|
2367
|
+
<dd>
|
|
2368
|
+
|
|
2369
|
+
```ruby
|
|
2370
|
+
client.investors.investor_get_loan(loan_id: "loan_id")
|
|
2371
|
+
```
|
|
2372
|
+
</dd>
|
|
2373
|
+
</dl>
|
|
2374
|
+
</dd>
|
|
2375
|
+
</dl>
|
|
2376
|
+
|
|
2377
|
+
#### ⚙️ Parameters
|
|
2378
|
+
|
|
2379
|
+
<dl>
|
|
2380
|
+
<dd>
|
|
2381
|
+
|
|
2382
|
+
<dl>
|
|
2383
|
+
<dd>
|
|
2384
|
+
|
|
2385
|
+
**loan_id:** `String`
|
|
2386
|
+
|
|
2387
|
+
</dd>
|
|
2388
|
+
</dl>
|
|
2389
|
+
|
|
2390
|
+
<dl>
|
|
2391
|
+
<dd>
|
|
2392
|
+
|
|
2393
|
+
**request_options:** `Voltaria::Investors::RequestOptions`
|
|
2394
|
+
|
|
2395
|
+
</dd>
|
|
2396
|
+
</dl>
|
|
2397
|
+
</dd>
|
|
2398
|
+
</dl>
|
|
2399
|
+
|
|
2400
|
+
|
|
2401
|
+
</dd>
|
|
2402
|
+
</dl>
|
|
2403
|
+
</details>
|
|
2404
|
+
|
|
2405
|
+
<details><summary><code>client.investors.<a href="/lib/voltaria/investors/client.rb">investor_list_installments</a>() -> Voltaria::Types::PaginatedResponseInstallmentResponseWithClientInfo</code></summary>
|
|
2406
|
+
<dl>
|
|
2407
|
+
<dd>
|
|
2408
|
+
|
|
2409
|
+
#### 📝 Description
|
|
2410
|
+
|
|
2411
|
+
<dl>
|
|
2412
|
+
<dd>
|
|
2413
|
+
|
|
2414
|
+
<dl>
|
|
2415
|
+
<dd>
|
|
2416
|
+
|
|
2417
|
+
Retrieve all installments for loans funded by the current investor.
|
|
2418
|
+
</dd>
|
|
2419
|
+
</dl>
|
|
2420
|
+
</dd>
|
|
2421
|
+
</dl>
|
|
2422
|
+
|
|
2423
|
+
#### 🔌 Usage
|
|
2424
|
+
|
|
2425
|
+
<dl>
|
|
2426
|
+
<dd>
|
|
2427
|
+
|
|
2428
|
+
<dl>
|
|
2429
|
+
<dd>
|
|
2430
|
+
|
|
2431
|
+
```ruby
|
|
2432
|
+
client.investors.investor_list_installments
|
|
2433
|
+
```
|
|
2434
|
+
</dd>
|
|
2435
|
+
</dl>
|
|
2436
|
+
</dd>
|
|
2437
|
+
</dl>
|
|
2438
|
+
|
|
2439
|
+
#### ⚙️ Parameters
|
|
2440
|
+
|
|
2441
|
+
<dl>
|
|
2442
|
+
<dd>
|
|
2443
|
+
|
|
2444
|
+
<dl>
|
|
2445
|
+
<dd>
|
|
2446
|
+
|
|
2447
|
+
**page:** `Integer`
|
|
2448
|
+
|
|
2449
|
+
</dd>
|
|
2450
|
+
</dl>
|
|
2451
|
+
|
|
2452
|
+
<dl>
|
|
2453
|
+
<dd>
|
|
2454
|
+
|
|
2455
|
+
**page_size:** `Integer`
|
|
2456
|
+
|
|
2457
|
+
</dd>
|
|
2458
|
+
</dl>
|
|
2459
|
+
|
|
2460
|
+
<dl>
|
|
2461
|
+
<dd>
|
|
2462
|
+
|
|
2463
|
+
**client_id:** `String`
|
|
2464
|
+
|
|
2465
|
+
</dd>
|
|
2466
|
+
</dl>
|
|
2467
|
+
|
|
2468
|
+
<dl>
|
|
2469
|
+
<dd>
|
|
2470
|
+
|
|
2471
|
+
**loan_id:** `String`
|
|
2472
|
+
|
|
2473
|
+
</dd>
|
|
2474
|
+
</dl>
|
|
2475
|
+
|
|
2476
|
+
<dl>
|
|
2477
|
+
<dd>
|
|
2478
|
+
|
|
2479
|
+
**order_by:** `String`
|
|
2480
|
+
|
|
2481
|
+
</dd>
|
|
2482
|
+
</dl>
|
|
2483
|
+
|
|
2484
|
+
<dl>
|
|
2485
|
+
<dd>
|
|
2486
|
+
|
|
2487
|
+
**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: id, client_id, loan_id, status, client.name, expected_repayment_at. Supported operators: is, in, not_in, contains, not_contains, like, not_like, ilike, not_ilike, gt, gte, lt, lte, starts_with, ends_with, is_null, is_not_null.
|
|
2488
|
+
|
|
2489
|
+
</dd>
|
|
2490
|
+
</dl>
|
|
2491
|
+
|
|
2492
|
+
<dl>
|
|
2493
|
+
<dd>
|
|
2494
|
+
|
|
2495
|
+
**request_options:** `Voltaria::Investors::RequestOptions`
|
|
2496
|
+
|
|
2497
|
+
</dd>
|
|
2498
|
+
</dl>
|
|
2499
|
+
</dd>
|
|
2500
|
+
</dl>
|
|
2501
|
+
|
|
2502
|
+
|
|
2503
|
+
</dd>
|
|
2504
|
+
</dl>
|
|
2505
|
+
</details>
|
|
2506
|
+
|
|
2507
|
+
<details><summary><code>client.investors.<a href="/lib/voltaria/investors/client.rb">investor_get_installment</a>(installment_id) -> Voltaria::Types::InstallmentResponse</code></summary>
|
|
2508
|
+
<dl>
|
|
2509
|
+
<dd>
|
|
2510
|
+
|
|
2511
|
+
#### 📝 Description
|
|
2512
|
+
|
|
2513
|
+
<dl>
|
|
2514
|
+
<dd>
|
|
2515
|
+
|
|
2516
|
+
<dl>
|
|
2517
|
+
<dd>
|
|
2518
|
+
|
|
2519
|
+
Retrieve a specific installment for a loan funded by the current investor.
|
|
2520
|
+
</dd>
|
|
2521
|
+
</dl>
|
|
2522
|
+
</dd>
|
|
2523
|
+
</dl>
|
|
2524
|
+
|
|
2525
|
+
#### 🔌 Usage
|
|
2526
|
+
|
|
2527
|
+
<dl>
|
|
2528
|
+
<dd>
|
|
2529
|
+
|
|
2530
|
+
<dl>
|
|
2531
|
+
<dd>
|
|
2532
|
+
|
|
2533
|
+
```ruby
|
|
2534
|
+
client.investors.investor_get_installment(installment_id: "installment_id")
|
|
2535
|
+
```
|
|
2536
|
+
</dd>
|
|
2537
|
+
</dl>
|
|
2538
|
+
</dd>
|
|
2539
|
+
</dl>
|
|
2540
|
+
|
|
2541
|
+
#### ⚙️ Parameters
|
|
2542
|
+
|
|
2543
|
+
<dl>
|
|
2544
|
+
<dd>
|
|
2545
|
+
|
|
2546
|
+
<dl>
|
|
2547
|
+
<dd>
|
|
2548
|
+
|
|
2549
|
+
**installment_id:** `String`
|
|
2550
|
+
|
|
2551
|
+
</dd>
|
|
2552
|
+
</dl>
|
|
2553
|
+
|
|
2554
|
+
<dl>
|
|
2555
|
+
<dd>
|
|
2556
|
+
|
|
2557
|
+
**request_options:** `Voltaria::Investors::RequestOptions`
|
|
2558
|
+
|
|
2559
|
+
</dd>
|
|
2560
|
+
</dl>
|
|
2561
|
+
</dd>
|
|
2562
|
+
</dl>
|
|
2563
|
+
|
|
2564
|
+
|
|
2565
|
+
</dd>
|
|
2566
|
+
</dl>
|
|
2567
|
+
</details>
|
|
2568
|
+
|
|
2569
|
+
<details><summary><code>client.investors.<a href="/lib/voltaria/investors/client.rb">investor_list_repayments</a>() -> Voltaria::Types::PaginatedResponseRepaymentResponseWithClientInfo</code></summary>
|
|
2570
|
+
<dl>
|
|
2571
|
+
<dd>
|
|
2572
|
+
|
|
2573
|
+
#### 📝 Description
|
|
2574
|
+
|
|
2575
|
+
<dl>
|
|
2576
|
+
<dd>
|
|
2577
|
+
|
|
2578
|
+
<dl>
|
|
2579
|
+
<dd>
|
|
2580
|
+
|
|
2581
|
+
Retrieve all repayment logs for loans funded by the current investor.
|
|
2582
|
+
</dd>
|
|
2583
|
+
</dl>
|
|
2584
|
+
</dd>
|
|
2585
|
+
</dl>
|
|
2586
|
+
|
|
2587
|
+
#### 🔌 Usage
|
|
2588
|
+
|
|
2589
|
+
<dl>
|
|
2590
|
+
<dd>
|
|
2591
|
+
|
|
2592
|
+
<dl>
|
|
2593
|
+
<dd>
|
|
2594
|
+
|
|
2595
|
+
```ruby
|
|
2596
|
+
client.investors.investor_list_repayments
|
|
2597
|
+
```
|
|
2598
|
+
</dd>
|
|
2599
|
+
</dl>
|
|
2600
|
+
</dd>
|
|
2601
|
+
</dl>
|
|
2602
|
+
|
|
2603
|
+
#### ⚙️ Parameters
|
|
2604
|
+
|
|
2605
|
+
<dl>
|
|
2606
|
+
<dd>
|
|
2607
|
+
|
|
2608
|
+
<dl>
|
|
2609
|
+
<dd>
|
|
2610
|
+
|
|
2611
|
+
**client_id:** `String`
|
|
2612
|
+
|
|
2613
|
+
</dd>
|
|
2614
|
+
</dl>
|
|
2615
|
+
|
|
2616
|
+
<dl>
|
|
2617
|
+
<dd>
|
|
2618
|
+
|
|
2619
|
+
**loan_id:** `String`
|
|
2620
|
+
|
|
2621
|
+
</dd>
|
|
2622
|
+
</dl>
|
|
2623
|
+
|
|
2624
|
+
<dl>
|
|
2625
|
+
<dd>
|
|
2626
|
+
|
|
2627
|
+
**installment_id:** `String`
|
|
2628
|
+
|
|
2629
|
+
</dd>
|
|
2630
|
+
</dl>
|
|
2631
|
+
|
|
2632
|
+
<dl>
|
|
2633
|
+
<dd>
|
|
2634
|
+
|
|
2635
|
+
**page:** `Integer`
|
|
2636
|
+
|
|
2637
|
+
</dd>
|
|
2638
|
+
</dl>
|
|
2639
|
+
|
|
2640
|
+
<dl>
|
|
2641
|
+
<dd>
|
|
2642
|
+
|
|
2643
|
+
**page_size:** `Integer`
|
|
2644
|
+
|
|
2645
|
+
</dd>
|
|
2646
|
+
</dl>
|
|
2647
|
+
|
|
2648
|
+
<dl>
|
|
2649
|
+
<dd>
|
|
2650
|
+
|
|
2651
|
+
**order_by:** `String`
|
|
2652
|
+
|
|
2653
|
+
</dd>
|
|
2654
|
+
</dl>
|
|
2655
|
+
|
|
2656
|
+
<dl>
|
|
2657
|
+
<dd>
|
|
2658
|
+
|
|
2659
|
+
**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: id, client_id, loan_id, installment_id, created_at, client.name, client.correlation_id. Supported operators: is, in, not_in, contains, not_contains, like, not_like, ilike, not_ilike, gt, gte, lt, lte, starts_with, ends_with, is_null, is_not_null.
|
|
2660
|
+
|
|
2661
|
+
</dd>
|
|
2662
|
+
</dl>
|
|
2663
|
+
|
|
2664
|
+
<dl>
|
|
2665
|
+
<dd>
|
|
2666
|
+
|
|
2667
|
+
**request_options:** `Voltaria::Investors::RequestOptions`
|
|
2668
|
+
|
|
2669
|
+
</dd>
|
|
2670
|
+
</dl>
|
|
2671
|
+
</dd>
|
|
2672
|
+
</dl>
|
|
2673
|
+
|
|
2674
|
+
|
|
2675
|
+
</dd>
|
|
2676
|
+
</dl>
|
|
2677
|
+
</details>
|
|
2678
|
+
|
|
2679
|
+
## Installments
|
|
2680
|
+
<details><summary><code>client.installments.<a href="/lib/voltaria/installments/client.rb">list_installments</a>() -> Voltaria::Types::PaginatedResponseInstallmentResponseWithClientInfo</code></summary>
|
|
2681
|
+
<dl>
|
|
2682
|
+
<dd>
|
|
2683
|
+
|
|
2684
|
+
#### 📝 Description
|
|
2685
|
+
|
|
2686
|
+
<dl>
|
|
2687
|
+
<dd>
|
|
2688
|
+
|
|
2689
|
+
<dl>
|
|
2690
|
+
<dd>
|
|
2691
|
+
|
|
2692
|
+
Retrieve a list of all loan installments under your partner account. Supports optional filtering by loan or client.
|
|
2693
|
+
</dd>
|
|
2694
|
+
</dl>
|
|
2695
|
+
</dd>
|
|
2696
|
+
</dl>
|
|
2697
|
+
|
|
2698
|
+
#### 🔌 Usage
|
|
2699
|
+
|
|
2700
|
+
<dl>
|
|
2701
|
+
<dd>
|
|
2702
|
+
|
|
2703
|
+
<dl>
|
|
2704
|
+
<dd>
|
|
2705
|
+
|
|
2706
|
+
```ruby
|
|
2707
|
+
client.installments.list_installments
|
|
2708
|
+
```
|
|
2709
|
+
</dd>
|
|
2710
|
+
</dl>
|
|
2711
|
+
</dd>
|
|
2712
|
+
</dl>
|
|
2713
|
+
|
|
2714
|
+
#### ⚙️ Parameters
|
|
2715
|
+
|
|
2716
|
+
<dl>
|
|
2717
|
+
<dd>
|
|
2718
|
+
|
|
2719
|
+
<dl>
|
|
2720
|
+
<dd>
|
|
2721
|
+
|
|
2722
|
+
**page:** `Integer`
|
|
2723
|
+
|
|
2724
|
+
</dd>
|
|
2725
|
+
</dl>
|
|
2726
|
+
|
|
2727
|
+
<dl>
|
|
2728
|
+
<dd>
|
|
2729
|
+
|
|
2730
|
+
**page_size:** `Integer`
|
|
2731
|
+
|
|
2732
|
+
</dd>
|
|
2733
|
+
</dl>
|
|
2734
|
+
|
|
2735
|
+
<dl>
|
|
2736
|
+
<dd>
|
|
2737
|
+
|
|
2738
|
+
**client_id:** `String`
|
|
2739
|
+
|
|
2740
|
+
</dd>
|
|
2741
|
+
</dl>
|
|
2742
|
+
|
|
2743
|
+
<dl>
|
|
2744
|
+
<dd>
|
|
2745
|
+
|
|
2746
|
+
**loan_id:** `String`
|
|
2747
|
+
|
|
2748
|
+
</dd>
|
|
2749
|
+
</dl>
|
|
2750
|
+
|
|
2751
|
+
<dl>
|
|
2752
|
+
<dd>
|
|
2753
|
+
|
|
2754
|
+
**order_by:** `String` — Field to order the results by, e.g., 'created_at:desc,updated_at:asc'
|
|
2755
|
+
|
|
2756
|
+
</dd>
|
|
2757
|
+
</dl>
|
|
2758
|
+
|
|
2759
|
+
<dl>
|
|
2760
|
+
<dd>
|
|
2761
|
+
|
|
2762
|
+
**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: id, client_id, loan_id, status, client.name, expected_repayment_at. Supported operators: is, in, not_in, contains, not_contains, like, not_like, ilike, not_ilike, gt, gte, lt, lte, starts_with, ends_with, is_null, is_not_null.
|
|
2763
|
+
|
|
2764
|
+
</dd>
|
|
2765
|
+
</dl>
|
|
2766
|
+
|
|
2767
|
+
<dl>
|
|
2768
|
+
<dd>
|
|
2769
|
+
|
|
2770
|
+
**request_options:** `Voltaria::Installments::RequestOptions`
|
|
2771
|
+
|
|
2772
|
+
</dd>
|
|
2773
|
+
</dl>
|
|
2774
|
+
</dd>
|
|
2775
|
+
</dl>
|
|
2776
|
+
|
|
2777
|
+
|
|
2778
|
+
</dd>
|
|
2779
|
+
</dl>
|
|
2780
|
+
</details>
|
|
2781
|
+
|
|
2782
|
+
<details><summary><code>client.installments.<a href="/lib/voltaria/installments/client.rb">add_installment</a>(request) -> Internal::Types::Array[Voltaria::Types::InstallmentResponse]</code></summary>
|
|
2783
|
+
<dl>
|
|
2784
|
+
<dd>
|
|
2785
|
+
|
|
2786
|
+
#### 📝 Description
|
|
2787
|
+
|
|
2788
|
+
<dl>
|
|
2789
|
+
<dd>
|
|
2790
|
+
|
|
2791
|
+
<dl>
|
|
2792
|
+
<dd>
|
|
2793
|
+
|
|
2794
|
+
Add new installments to a loan with its specific loan ID. This endpoint is available to select partners and will trigger the recalculation of the IRR and interest amounts for all installments of the loan.
|
|
2795
|
+
</dd>
|
|
2796
|
+
</dl>
|
|
2797
|
+
</dd>
|
|
2798
|
+
</dl>
|
|
2799
|
+
|
|
2800
|
+
#### 🔌 Usage
|
|
2801
|
+
|
|
2802
|
+
<dl>
|
|
2803
|
+
<dd>
|
|
2804
|
+
|
|
2805
|
+
<dl>
|
|
2806
|
+
<dd>
|
|
2807
|
+
|
|
2808
|
+
```ruby
|
|
2809
|
+
client.installments.add_installment(
|
|
2810
|
+
loan_id: "loan_12345",
|
|
2811
|
+
installments: [{
|
|
2812
|
+
expected_repayment_at: "2025-12-01",
|
|
2813
|
+
amount: "1000.00"
|
|
2814
|
+
}, {
|
|
2815
|
+
expected_repayment_at: "2026-01-01",
|
|
2816
|
+
amount: "1000.00"
|
|
2817
|
+
}]
|
|
2818
|
+
)
|
|
2819
|
+
```
|
|
2820
|
+
</dd>
|
|
2821
|
+
</dl>
|
|
2822
|
+
</dd>
|
|
2823
|
+
</dl>
|
|
2824
|
+
|
|
2825
|
+
#### ⚙️ Parameters
|
|
2826
|
+
|
|
2827
|
+
<dl>
|
|
2828
|
+
<dd>
|
|
2829
|
+
|
|
2830
|
+
<dl>
|
|
2831
|
+
<dd>
|
|
2832
|
+
|
|
2833
|
+
**loan_id:** `String` — The loan ID to add the installments to
|
|
2834
|
+
|
|
2835
|
+
</dd>
|
|
2836
|
+
</dl>
|
|
2837
|
+
|
|
2838
|
+
<dl>
|
|
2839
|
+
<dd>
|
|
2840
|
+
|
|
2841
|
+
**installments:** `Internal::Types::Array[Voltaria::Types::LoanInstallmentCreatePayload]` — List of installments to add to the loan
|
|
2842
|
+
|
|
2843
|
+
</dd>
|
|
2844
|
+
</dl>
|
|
2845
|
+
|
|
2846
|
+
<dl>
|
|
2847
|
+
<dd>
|
|
2848
|
+
|
|
2849
|
+
**request_options:** `Voltaria::Installments::RequestOptions`
|
|
2850
|
+
|
|
2851
|
+
</dd>
|
|
2852
|
+
</dl>
|
|
2853
|
+
</dd>
|
|
2854
|
+
</dl>
|
|
2855
|
+
|
|
2856
|
+
|
|
2857
|
+
</dd>
|
|
2858
|
+
</dl>
|
|
2859
|
+
</details>
|
|
2860
|
+
|
|
2861
|
+
<details><summary><code>client.installments.<a href="/lib/voltaria/installments/client.rb">list_payment_promises</a>() -> Voltaria::Types::PaginatedResponsePaymentPromiseResponse</code></summary>
|
|
2862
|
+
<dl>
|
|
2863
|
+
<dd>
|
|
2864
|
+
|
|
2865
|
+
#### 📝 Description
|
|
2866
|
+
|
|
2867
|
+
<dl>
|
|
2868
|
+
<dd>
|
|
2869
|
+
|
|
2870
|
+
<dl>
|
|
2871
|
+
<dd>
|
|
2872
|
+
|
|
2873
|
+
Retrieve a list of payment promises recorded for installments under your partner account. Supports optional filtering by loan or client.
|
|
2874
|
+
</dd>
|
|
2875
|
+
</dl>
|
|
2876
|
+
</dd>
|
|
2877
|
+
</dl>
|
|
2878
|
+
|
|
2879
|
+
#### 🔌 Usage
|
|
2880
|
+
|
|
2881
|
+
<dl>
|
|
2882
|
+
<dd>
|
|
2883
|
+
|
|
2884
|
+
<dl>
|
|
2885
|
+
<dd>
|
|
2886
|
+
|
|
2887
|
+
```ruby
|
|
2888
|
+
client.installments.list_payment_promises
|
|
2889
|
+
```
|
|
2890
|
+
</dd>
|
|
2891
|
+
</dl>
|
|
2892
|
+
</dd>
|
|
2893
|
+
</dl>
|
|
2894
|
+
|
|
2895
|
+
#### ⚙️ Parameters
|
|
2896
|
+
|
|
2897
|
+
<dl>
|
|
2898
|
+
<dd>
|
|
2899
|
+
|
|
2900
|
+
<dl>
|
|
2901
|
+
<dd>
|
|
2902
|
+
|
|
2903
|
+
**page:** `Integer`
|
|
2904
|
+
|
|
2905
|
+
</dd>
|
|
2906
|
+
</dl>
|
|
2907
|
+
|
|
2908
|
+
<dl>
|
|
2909
|
+
<dd>
|
|
2910
|
+
|
|
2911
|
+
**page_size:** `Integer`
|
|
2912
|
+
|
|
2913
|
+
</dd>
|
|
2914
|
+
</dl>
|
|
2915
|
+
|
|
2916
|
+
<dl>
|
|
2917
|
+
<dd>
|
|
2918
|
+
|
|
2919
|
+
**order_by:** `String` — Field to order the results by, e.g., 'created_at:desc,updated_at:asc'
|
|
2920
|
+
|
|
2921
|
+
</dd>
|
|
2922
|
+
</dl>
|
|
2923
|
+
|
|
2924
|
+
<dl>
|
|
2925
|
+
<dd>
|
|
2926
|
+
|
|
2927
|
+
**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: id, installment_id, status, promised_date, created_at. Supported operators: is, in, not_in, contains, not_contains, like, not_like, ilike, not_ilike, gt, gte, lt, lte, starts_with, ends_with, is_null, is_not_null.
|
|
2928
|
+
|
|
2929
|
+
</dd>
|
|
2930
|
+
</dl>
|
|
2931
|
+
|
|
2932
|
+
<dl>
|
|
2933
|
+
<dd>
|
|
2934
|
+
|
|
2935
|
+
**loan_id:** `String`
|
|
2936
|
+
|
|
2937
|
+
</dd>
|
|
2938
|
+
</dl>
|
|
2939
|
+
|
|
2940
|
+
<dl>
|
|
2941
|
+
<dd>
|
|
2942
|
+
|
|
2943
|
+
**client_id:** `String`
|
|
2944
|
+
|
|
2945
|
+
</dd>
|
|
2946
|
+
</dl>
|
|
2947
|
+
|
|
2948
|
+
<dl>
|
|
2949
|
+
<dd>
|
|
2950
|
+
|
|
2951
|
+
**request_options:** `Voltaria::Installments::RequestOptions`
|
|
2952
|
+
|
|
2953
|
+
</dd>
|
|
2954
|
+
</dl>
|
|
2955
|
+
</dd>
|
|
2956
|
+
</dl>
|
|
2957
|
+
|
|
2958
|
+
|
|
2959
|
+
</dd>
|
|
2960
|
+
</dl>
|
|
2961
|
+
</details>
|
|
2962
|
+
|
|
2963
|
+
<details><summary><code>client.installments.<a href="/lib/voltaria/installments/client.rb">create_payment_promise</a>(request) -> Voltaria::Types::PaymentPromiseResponse</code></summary>
|
|
2964
|
+
<dl>
|
|
2965
|
+
<dd>
|
|
2966
|
+
|
|
2967
|
+
#### 📝 Description
|
|
2968
|
+
|
|
2969
|
+
<dl>
|
|
2970
|
+
<dd>
|
|
2971
|
+
|
|
2972
|
+
<dl>
|
|
2973
|
+
<dd>
|
|
2974
|
+
|
|
2975
|
+
Record a payment promise made by a client for one of their installments. The promised date must be today or in the future.
|
|
2976
|
+
</dd>
|
|
2977
|
+
</dl>
|
|
2978
|
+
</dd>
|
|
2979
|
+
</dl>
|
|
2980
|
+
|
|
2981
|
+
#### 🔌 Usage
|
|
2982
|
+
|
|
2983
|
+
<dl>
|
|
2984
|
+
<dd>
|
|
2985
|
+
|
|
2986
|
+
<dl>
|
|
2987
|
+
<dd>
|
|
2988
|
+
|
|
2989
|
+
```ruby
|
|
2990
|
+
client.installments.create_payment_promise(
|
|
2991
|
+
installment_id: "inst_12345",
|
|
2992
|
+
amount: 1.1,
|
|
2993
|
+
promised_date: "2026-05-15"
|
|
2994
|
+
)
|
|
2995
|
+
```
|
|
2996
|
+
</dd>
|
|
2997
|
+
</dl>
|
|
2998
|
+
</dd>
|
|
2999
|
+
</dl>
|
|
3000
|
+
|
|
3001
|
+
#### ⚙️ Parameters
|
|
3002
|
+
|
|
3003
|
+
<dl>
|
|
3004
|
+
<dd>
|
|
3005
|
+
|
|
3006
|
+
<dl>
|
|
3007
|
+
<dd>
|
|
3008
|
+
|
|
3009
|
+
**installment_id:** `String` — The ID of the installment this promise relates to
|
|
3010
|
+
|
|
3011
|
+
</dd>
|
|
3012
|
+
</dl>
|
|
3013
|
+
|
|
3014
|
+
<dl>
|
|
3015
|
+
<dd>
|
|
3016
|
+
|
|
3017
|
+
**amount:** `Voltaria::Installments::Types::PaymentPromiseCreatePayloadAmount` — The amount the client has promised to pay (must be > 0)
|
|
3018
|
+
|
|
3019
|
+
</dd>
|
|
3020
|
+
</dl>
|
|
3021
|
+
|
|
3022
|
+
<dl>
|
|
3023
|
+
<dd>
|
|
3024
|
+
|
|
3025
|
+
**promised_date:** `String` — The date the client has committed to pay by (today or future)
|
|
3026
|
+
|
|
3027
|
+
</dd>
|
|
3028
|
+
</dl>
|
|
3029
|
+
|
|
3030
|
+
<dl>
|
|
3031
|
+
<dd>
|
|
3032
|
+
|
|
3033
|
+
**notes:** `String` — Optional notes captured during the collections interaction
|
|
3034
|
+
|
|
3035
|
+
</dd>
|
|
3036
|
+
</dl>
|
|
3037
|
+
|
|
3038
|
+
<dl>
|
|
3039
|
+
<dd>
|
|
3040
|
+
|
|
3041
|
+
**request_options:** `Voltaria::Installments::RequestOptions`
|
|
3042
|
+
|
|
3043
|
+
</dd>
|
|
3044
|
+
</dl>
|
|
3045
|
+
</dd>
|
|
3046
|
+
</dl>
|
|
3047
|
+
|
|
3048
|
+
|
|
3049
|
+
</dd>
|
|
3050
|
+
</dl>
|
|
3051
|
+
</details>
|
|
3052
|
+
|
|
3053
|
+
<details><summary><code>client.installments.<a href="/lib/voltaria/installments/client.rb">get_installment_by_id</a>(installment_id) -> Voltaria::Types::InstallmentResponse</code></summary>
|
|
3054
|
+
<dl>
|
|
3055
|
+
<dd>
|
|
3056
|
+
|
|
3057
|
+
#### 📝 Description
|
|
3058
|
+
|
|
3059
|
+
<dl>
|
|
3060
|
+
<dd>
|
|
3061
|
+
|
|
3062
|
+
<dl>
|
|
3063
|
+
<dd>
|
|
3064
|
+
|
|
3065
|
+
Retrieve detailed information for a specific installment using its installment ID.
|
|
3066
|
+
</dd>
|
|
3067
|
+
</dl>
|
|
3068
|
+
</dd>
|
|
3069
|
+
</dl>
|
|
3070
|
+
|
|
3071
|
+
#### 🔌 Usage
|
|
3072
|
+
|
|
3073
|
+
<dl>
|
|
3074
|
+
<dd>
|
|
3075
|
+
|
|
3076
|
+
<dl>
|
|
3077
|
+
<dd>
|
|
3078
|
+
|
|
3079
|
+
```ruby
|
|
3080
|
+
client.installments.get_installment_by_id(installment_id: "installment_id")
|
|
3081
|
+
```
|
|
3082
|
+
</dd>
|
|
3083
|
+
</dl>
|
|
3084
|
+
</dd>
|
|
3085
|
+
</dl>
|
|
3086
|
+
|
|
3087
|
+
#### ⚙️ Parameters
|
|
3088
|
+
|
|
3089
|
+
<dl>
|
|
3090
|
+
<dd>
|
|
3091
|
+
|
|
3092
|
+
<dl>
|
|
3093
|
+
<dd>
|
|
3094
|
+
|
|
3095
|
+
**installment_id:** `String`
|
|
3096
|
+
|
|
3097
|
+
</dd>
|
|
3098
|
+
</dl>
|
|
3099
|
+
|
|
3100
|
+
<dl>
|
|
3101
|
+
<dd>
|
|
3102
|
+
|
|
3103
|
+
**request_options:** `Voltaria::Installments::RequestOptions`
|
|
3104
|
+
|
|
3105
|
+
</dd>
|
|
3106
|
+
</dl>
|
|
3107
|
+
</dd>
|
|
3108
|
+
</dl>
|
|
3109
|
+
|
|
3110
|
+
|
|
3111
|
+
</dd>
|
|
3112
|
+
</dl>
|
|
3113
|
+
</details>
|
|
3114
|
+
|
|
3115
|
+
<details><summary><code>client.installments.<a href="/lib/voltaria/installments/client.rb">edit_installment</a>(installment_id, request) -> Voltaria::Types::InstallmentResponse</code></summary>
|
|
3116
|
+
<dl>
|
|
3117
|
+
<dd>
|
|
3118
|
+
|
|
3119
|
+
#### 📝 Description
|
|
3120
|
+
|
|
3121
|
+
<dl>
|
|
3122
|
+
<dd>
|
|
3123
|
+
|
|
3124
|
+
<dl>
|
|
3125
|
+
<dd>
|
|
3126
|
+
|
|
3127
|
+
Update an installment's amount and expected repayment date with its specific installment ID. This endpoint is available to select partners and will trigger the recalculation of the IRR and interest amounts for all installments of the loan.
|
|
3128
|
+
</dd>
|
|
3129
|
+
</dl>
|
|
3130
|
+
</dd>
|
|
3131
|
+
</dl>
|
|
3132
|
+
|
|
3133
|
+
#### 🔌 Usage
|
|
3134
|
+
|
|
3135
|
+
<dl>
|
|
3136
|
+
<dd>
|
|
3137
|
+
|
|
3138
|
+
<dl>
|
|
3139
|
+
<dd>
|
|
3140
|
+
|
|
3141
|
+
```ruby
|
|
3142
|
+
client.installments.edit_installment(
|
|
3143
|
+
installment_id: "installment_id",
|
|
3144
|
+
amount: 1.1,
|
|
3145
|
+
expected_repayment_at: "2025-12-01"
|
|
3146
|
+
)
|
|
3147
|
+
```
|
|
3148
|
+
</dd>
|
|
3149
|
+
</dl>
|
|
3150
|
+
</dd>
|
|
3151
|
+
</dl>
|
|
3152
|
+
|
|
3153
|
+
#### ⚙️ Parameters
|
|
3154
|
+
|
|
3155
|
+
<dl>
|
|
3156
|
+
<dd>
|
|
3157
|
+
|
|
3158
|
+
<dl>
|
|
3159
|
+
<dd>
|
|
3160
|
+
|
|
3161
|
+
**installment_id:** `String`
|
|
3162
|
+
|
|
3163
|
+
</dd>
|
|
3164
|
+
</dl>
|
|
3165
|
+
|
|
3166
|
+
<dl>
|
|
3167
|
+
<dd>
|
|
3168
|
+
|
|
3169
|
+
**amount:** `Voltaria::Installments::Types::InstallmentEditPayloadAmount` — The new amount for the installment
|
|
3170
|
+
|
|
3171
|
+
</dd>
|
|
3172
|
+
</dl>
|
|
3173
|
+
|
|
3174
|
+
<dl>
|
|
3175
|
+
<dd>
|
|
3176
|
+
|
|
3177
|
+
**expected_repayment_at:** `String` — The new expected repayment date
|
|
3178
|
+
|
|
3179
|
+
</dd>
|
|
3180
|
+
</dl>
|
|
3181
|
+
|
|
3182
|
+
<dl>
|
|
3183
|
+
<dd>
|
|
3184
|
+
|
|
3185
|
+
**request_options:** `Voltaria::Installments::RequestOptions`
|
|
3186
|
+
|
|
3187
|
+
</dd>
|
|
3188
|
+
</dl>
|
|
3189
|
+
</dd>
|
|
3190
|
+
</dl>
|
|
3191
|
+
|
|
3192
|
+
|
|
3193
|
+
</dd>
|
|
3194
|
+
</dl>
|
|
3195
|
+
</details>
|
|
3196
|
+
|
|
3197
|
+
<details><summary><code>client.installments.<a href="/lib/voltaria/installments/client.rb">delete_installment</a>(installment_id) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
3198
|
+
<dl>
|
|
3199
|
+
<dd>
|
|
3200
|
+
|
|
3201
|
+
#### 📝 Description
|
|
3202
|
+
|
|
3203
|
+
<dl>
|
|
3204
|
+
<dd>
|
|
3205
|
+
|
|
3206
|
+
<dl>
|
|
3207
|
+
<dd>
|
|
3208
|
+
|
|
3209
|
+
Delete an installment with its specific installment ID. This endpoint is available to select partners and will trigger the recalculation of the IRR and interest amounts for all installments of the loan.
|
|
3210
|
+
</dd>
|
|
3211
|
+
</dl>
|
|
3212
|
+
</dd>
|
|
3213
|
+
</dl>
|
|
3214
|
+
|
|
3215
|
+
#### 🔌 Usage
|
|
3216
|
+
|
|
3217
|
+
<dl>
|
|
3218
|
+
<dd>
|
|
3219
|
+
|
|
3220
|
+
<dl>
|
|
3221
|
+
<dd>
|
|
3222
|
+
|
|
3223
|
+
```ruby
|
|
3224
|
+
client.installments.delete_installment(installment_id: "installment_id")
|
|
3225
|
+
```
|
|
3226
|
+
</dd>
|
|
3227
|
+
</dl>
|
|
3228
|
+
</dd>
|
|
3229
|
+
</dl>
|
|
3230
|
+
|
|
3231
|
+
#### ⚙️ Parameters
|
|
3232
|
+
|
|
3233
|
+
<dl>
|
|
3234
|
+
<dd>
|
|
3235
|
+
|
|
3236
|
+
<dl>
|
|
3237
|
+
<dd>
|
|
3238
|
+
|
|
3239
|
+
**installment_id:** `String`
|
|
3240
|
+
|
|
3241
|
+
</dd>
|
|
3242
|
+
</dl>
|
|
3243
|
+
|
|
3244
|
+
<dl>
|
|
3245
|
+
<dd>
|
|
3246
|
+
|
|
3247
|
+
**request_options:** `Voltaria::Installments::RequestOptions`
|
|
3248
|
+
|
|
3249
|
+
</dd>
|
|
3250
|
+
</dl>
|
|
3251
|
+
</dd>
|
|
3252
|
+
</dl>
|
|
3253
|
+
|
|
3254
|
+
|
|
3255
|
+
</dd>
|
|
3256
|
+
</dl>
|
|
3257
|
+
</details>
|
|
3258
|
+
|
|
3259
|
+
## Loans
|
|
3260
|
+
<details><summary><code>client.loans.<a href="/lib/voltaria/loans/client.rb">list_loans</a>() -> Voltaria::Types::PaginatedResponseLoanResponseWithClientInfo</code></summary>
|
|
3261
|
+
<dl>
|
|
3262
|
+
<dd>
|
|
3263
|
+
|
|
3264
|
+
#### 📝 Description
|
|
3265
|
+
|
|
3266
|
+
<dl>
|
|
3267
|
+
<dd>
|
|
3268
|
+
|
|
3269
|
+
<dl>
|
|
3270
|
+
<dd>
|
|
3271
|
+
|
|
3272
|
+
Retrieve all loans associated with your partner account. Supports optional filtering by client ID.
|
|
3273
|
+
</dd>
|
|
3274
|
+
</dl>
|
|
3275
|
+
</dd>
|
|
3276
|
+
</dl>
|
|
3277
|
+
|
|
3278
|
+
#### 🔌 Usage
|
|
3279
|
+
|
|
3280
|
+
<dl>
|
|
3281
|
+
<dd>
|
|
3282
|
+
|
|
3283
|
+
<dl>
|
|
3284
|
+
<dd>
|
|
3285
|
+
|
|
3286
|
+
```ruby
|
|
3287
|
+
client.loans.list_loans
|
|
3288
|
+
```
|
|
3289
|
+
</dd>
|
|
3290
|
+
</dl>
|
|
3291
|
+
</dd>
|
|
3292
|
+
</dl>
|
|
3293
|
+
|
|
3294
|
+
#### ⚙️ Parameters
|
|
3295
|
+
|
|
3296
|
+
<dl>
|
|
3297
|
+
<dd>
|
|
3298
|
+
|
|
3299
|
+
<dl>
|
|
3300
|
+
<dd>
|
|
3301
|
+
|
|
3302
|
+
**page:** `Integer`
|
|
3303
|
+
|
|
3304
|
+
</dd>
|
|
3305
|
+
</dl>
|
|
3306
|
+
|
|
3307
|
+
<dl>
|
|
3308
|
+
<dd>
|
|
3309
|
+
|
|
3310
|
+
**page_size:** `Integer`
|
|
3311
|
+
|
|
3312
|
+
</dd>
|
|
3313
|
+
</dl>
|
|
3314
|
+
|
|
3315
|
+
<dl>
|
|
3316
|
+
<dd>
|
|
3317
|
+
|
|
3318
|
+
**client_id:** `String`
|
|
3319
|
+
|
|
3320
|
+
</dd>
|
|
3321
|
+
</dl>
|
|
3322
|
+
|
|
3323
|
+
<dl>
|
|
3324
|
+
<dd>
|
|
3325
|
+
|
|
3326
|
+
**order_by:** `String` — Field to order the results by, e.g., 'created_at:desc,updated_at:asc'
|
|
3327
|
+
|
|
3328
|
+
</dd>
|
|
3329
|
+
</dl>
|
|
3330
|
+
|
|
3331
|
+
<dl>
|
|
3332
|
+
<dd>
|
|
3333
|
+
|
|
3334
|
+
**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: id, client_id, status, client.name, correlation_id. Supported operators: is, in, not_in, contains, not_contains, like, not_like, ilike, not_ilike, gt, gte, lt, lte, starts_with, ends_with, is_null, is_not_null.
|
|
3335
|
+
|
|
3336
|
+
</dd>
|
|
3337
|
+
</dl>
|
|
3338
|
+
|
|
3339
|
+
<dl>
|
|
3340
|
+
<dd>
|
|
3341
|
+
|
|
3342
|
+
**request_options:** `Voltaria::Loans::RequestOptions`
|
|
3343
|
+
|
|
3344
|
+
</dd>
|
|
3345
|
+
</dl>
|
|
3346
|
+
</dd>
|
|
3347
|
+
</dl>
|
|
3348
|
+
|
|
3349
|
+
|
|
3350
|
+
</dd>
|
|
3351
|
+
</dl>
|
|
3352
|
+
</details>
|
|
3353
|
+
|
|
3354
|
+
<details><summary><code>client.loans.<a href="/lib/voltaria/loans/client.rb">create_loan</a>(request) -> Voltaria::Types::LoanResponseWithInstallments</code></summary>
|
|
3355
|
+
<dl>
|
|
3356
|
+
<dd>
|
|
3357
|
+
|
|
3358
|
+
#### 📝 Description
|
|
3359
|
+
|
|
3360
|
+
<dl>
|
|
3361
|
+
<dd>
|
|
3362
|
+
|
|
3363
|
+
<dl>
|
|
3364
|
+
<dd>
|
|
3365
|
+
|
|
3366
|
+
Create a new loan for an approved client with an active credit limit.
|
|
3367
|
+
</dd>
|
|
3368
|
+
</dl>
|
|
3369
|
+
</dd>
|
|
3370
|
+
</dl>
|
|
3371
|
+
|
|
3372
|
+
#### 🔌 Usage
|
|
3373
|
+
|
|
3374
|
+
<dl>
|
|
3375
|
+
<dd>
|
|
3376
|
+
|
|
3377
|
+
<dl>
|
|
3378
|
+
<dd>
|
|
3379
|
+
|
|
3380
|
+
```ruby
|
|
3381
|
+
client.loans.create_loan(
|
|
3382
|
+
client_id: "client_ACME",
|
|
3383
|
+
currency: "eur",
|
|
3384
|
+
amount: 1.1,
|
|
3385
|
+
installments: [{
|
|
3386
|
+
expected_repayment_at: "2025-12-01",
|
|
3387
|
+
amount: 1.1
|
|
3388
|
+
}]
|
|
3389
|
+
)
|
|
3390
|
+
```
|
|
3391
|
+
</dd>
|
|
3392
|
+
</dl>
|
|
3393
|
+
</dd>
|
|
3394
|
+
</dl>
|
|
3395
|
+
|
|
3396
|
+
#### ⚙️ Parameters
|
|
3397
|
+
|
|
3398
|
+
<dl>
|
|
3399
|
+
<dd>
|
|
3400
|
+
|
|
3401
|
+
<dl>
|
|
3402
|
+
<dd>
|
|
3403
|
+
|
|
3404
|
+
**client_id:** `String` — The ID of the client for this loan
|
|
3405
|
+
|
|
3406
|
+
</dd>
|
|
3407
|
+
</dl>
|
|
3408
|
+
|
|
3409
|
+
<dl>
|
|
3410
|
+
<dd>
|
|
3411
|
+
|
|
3412
|
+
**currency:** `Voltaria::Types::CurrencyEnum` — The currency of the loan, must be one of the supported currencies: eur, gbp, usd, czk, pln, isk
|
|
3413
|
+
|
|
3414
|
+
</dd>
|
|
3415
|
+
</dl>
|
|
3416
|
+
|
|
3417
|
+
<dl>
|
|
3418
|
+
<dd>
|
|
3419
|
+
|
|
3420
|
+
**amount:** `Voltaria::Loans::Types::LoanCreatePayloadAmount` — The amount of the loan
|
|
3421
|
+
|
|
3422
|
+
</dd>
|
|
3423
|
+
</dl>
|
|
3424
|
+
|
|
3425
|
+
<dl>
|
|
3426
|
+
<dd>
|
|
3427
|
+
|
|
3428
|
+
**correlation_id:** `String` — The correlation ID you provided at the creation of the loan
|
|
3429
|
+
|
|
3430
|
+
</dd>
|
|
3431
|
+
</dl>
|
|
3432
|
+
|
|
3433
|
+
<dl>
|
|
3434
|
+
<dd>
|
|
3435
|
+
|
|
3436
|
+
**loan_date:** `String` — Please provide the loan_date if it differs from the loan creation time (created_at). Otherwise, it will be automatically set.
|
|
3437
|
+
|
|
3438
|
+
</dd>
|
|
3439
|
+
</dl>
|
|
3440
|
+
|
|
3441
|
+
<dl>
|
|
3442
|
+
<dd>
|
|
3443
|
+
|
|
3444
|
+
**installments:** `Internal::Types::Array[Voltaria::Types::LoanInstallmentCreatePayload]` — List of installments for the loan, each with a due date and amount
|
|
3445
|
+
|
|
3446
|
+
</dd>
|
|
3447
|
+
</dl>
|
|
3448
|
+
|
|
3449
|
+
<dl>
|
|
3450
|
+
<dd>
|
|
3451
|
+
|
|
3452
|
+
**data:** `Internal::Types::Hash[String, Object]` — Additional data related to the loan
|
|
3453
|
+
|
|
3454
|
+
</dd>
|
|
3455
|
+
</dl>
|
|
3456
|
+
|
|
3457
|
+
<dl>
|
|
3458
|
+
<dd>
|
|
3459
|
+
|
|
3460
|
+
**request_options:** `Voltaria::Loans::RequestOptions`
|
|
3461
|
+
|
|
3462
|
+
</dd>
|
|
3463
|
+
</dl>
|
|
3464
|
+
</dd>
|
|
3465
|
+
</dl>
|
|
3466
|
+
|
|
3467
|
+
|
|
3468
|
+
</dd>
|
|
3469
|
+
</dl>
|
|
3470
|
+
</details>
|
|
3471
|
+
|
|
3472
|
+
<details><summary><code>client.loans.<a href="/lib/voltaria/loans/client.rb">get_loan_by_id</a>(loan_id) -> Voltaria::Types::LoanResponseWithInstallments</code></summary>
|
|
3473
|
+
<dl>
|
|
3474
|
+
<dd>
|
|
3475
|
+
|
|
3476
|
+
#### 📝 Description
|
|
3477
|
+
|
|
3478
|
+
<dl>
|
|
3479
|
+
<dd>
|
|
3480
|
+
|
|
3481
|
+
<dl>
|
|
3482
|
+
<dd>
|
|
3483
|
+
|
|
3484
|
+
Retrieve detailed information about a specific loan by its loan ID.
|
|
3485
|
+
</dd>
|
|
3486
|
+
</dl>
|
|
3487
|
+
</dd>
|
|
3488
|
+
</dl>
|
|
3489
|
+
|
|
3490
|
+
#### 🔌 Usage
|
|
3491
|
+
|
|
3492
|
+
<dl>
|
|
3493
|
+
<dd>
|
|
3494
|
+
|
|
3495
|
+
<dl>
|
|
3496
|
+
<dd>
|
|
3497
|
+
|
|
3498
|
+
```ruby
|
|
3499
|
+
client.loans.get_loan_by_id(loan_id: "loan_id")
|
|
3500
|
+
```
|
|
3501
|
+
</dd>
|
|
3502
|
+
</dl>
|
|
3503
|
+
</dd>
|
|
3504
|
+
</dl>
|
|
3505
|
+
|
|
3506
|
+
#### ⚙️ Parameters
|
|
3507
|
+
|
|
3508
|
+
<dl>
|
|
3509
|
+
<dd>
|
|
3510
|
+
|
|
3511
|
+
<dl>
|
|
3512
|
+
<dd>
|
|
3513
|
+
|
|
3514
|
+
**loan_id:** `String`
|
|
3515
|
+
|
|
3516
|
+
</dd>
|
|
3517
|
+
</dl>
|
|
3518
|
+
|
|
3519
|
+
<dl>
|
|
3520
|
+
<dd>
|
|
3521
|
+
|
|
3522
|
+
**request_options:** `Voltaria::Loans::RequestOptions`
|
|
3523
|
+
|
|
3524
|
+
</dd>
|
|
3525
|
+
</dl>
|
|
3526
|
+
</dd>
|
|
3527
|
+
</dl>
|
|
3528
|
+
|
|
3529
|
+
|
|
3530
|
+
</dd>
|
|
3531
|
+
</dl>
|
|
3532
|
+
</details>
|
|
3533
|
+
|
|
3534
|
+
<details><summary><code>client.loans.<a href="/lib/voltaria/loans/client.rb">delete_loan</a>(loan_id) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
3535
|
+
<dl>
|
|
3536
|
+
<dd>
|
|
3537
|
+
|
|
3538
|
+
#### 📝 Description
|
|
3539
|
+
|
|
3540
|
+
<dl>
|
|
3541
|
+
<dd>
|
|
3542
|
+
|
|
3543
|
+
<dl>
|
|
3544
|
+
<dd>
|
|
3545
|
+
|
|
3546
|
+
Delete a loan by ID. Only loans with 'pending' status can be deleted.
|
|
3547
|
+
</dd>
|
|
3548
|
+
</dl>
|
|
3549
|
+
</dd>
|
|
3550
|
+
</dl>
|
|
3551
|
+
|
|
3552
|
+
#### 🔌 Usage
|
|
3553
|
+
|
|
3554
|
+
<dl>
|
|
3555
|
+
<dd>
|
|
3556
|
+
|
|
3557
|
+
<dl>
|
|
3558
|
+
<dd>
|
|
3559
|
+
|
|
3560
|
+
```ruby
|
|
3561
|
+
client.loans.delete_loan(loan_id: "loan_id")
|
|
3562
|
+
```
|
|
3563
|
+
</dd>
|
|
3564
|
+
</dl>
|
|
3565
|
+
</dd>
|
|
3566
|
+
</dl>
|
|
3567
|
+
|
|
3568
|
+
#### ⚙️ Parameters
|
|
3569
|
+
|
|
3570
|
+
<dl>
|
|
3571
|
+
<dd>
|
|
3572
|
+
|
|
3573
|
+
<dl>
|
|
3574
|
+
<dd>
|
|
3575
|
+
|
|
3576
|
+
**loan_id:** `String`
|
|
3577
|
+
|
|
3578
|
+
</dd>
|
|
3579
|
+
</dl>
|
|
3580
|
+
|
|
3581
|
+
<dl>
|
|
3582
|
+
<dd>
|
|
3583
|
+
|
|
3584
|
+
**request_options:** `Voltaria::Loans::RequestOptions`
|
|
3585
|
+
|
|
3586
|
+
</dd>
|
|
3587
|
+
</dl>
|
|
3588
|
+
</dd>
|
|
3589
|
+
</dl>
|
|
3590
|
+
|
|
3591
|
+
|
|
3592
|
+
</dd>
|
|
3593
|
+
</dl>
|
|
3594
|
+
</details>
|
|
3595
|
+
|
|
3596
|
+
<details><summary><code>client.loans.<a href="/lib/voltaria/loans/client.rb">create_bulk_loans</a>(request) -> Voltaria::Types::BulkLoanTaskResponse</code></summary>
|
|
3597
|
+
<dl>
|
|
3598
|
+
<dd>
|
|
3599
|
+
|
|
3600
|
+
#### 📝 Description
|
|
3601
|
+
|
|
3602
|
+
<dl>
|
|
3603
|
+
<dd>
|
|
3604
|
+
|
|
3605
|
+
<dl>
|
|
3606
|
+
<dd>
|
|
3607
|
+
|
|
3608
|
+
Create multiple loans in a single request. Processing happens asynchronously. Returns a task ID for tracking progress.
|
|
3609
|
+
</dd>
|
|
3610
|
+
</dl>
|
|
3611
|
+
</dd>
|
|
3612
|
+
</dl>
|
|
3613
|
+
|
|
3614
|
+
#### 🔌 Usage
|
|
3615
|
+
|
|
3616
|
+
<dl>
|
|
3617
|
+
<dd>
|
|
3618
|
+
|
|
3619
|
+
<dl>
|
|
3620
|
+
<dd>
|
|
3621
|
+
|
|
3622
|
+
```ruby
|
|
3623
|
+
client.loans.create_bulk_loans(loans: [{
|
|
3624
|
+
client_id: "client_123",
|
|
3625
|
+
currency: "eur",
|
|
3626
|
+
amount: "50000.00",
|
|
3627
|
+
correlation_id: "LOAN_001",
|
|
3628
|
+
loan_date: "2023-05-01",
|
|
3629
|
+
installments: [{
|
|
3630
|
+
expected_repayment_at: "2023-06-01",
|
|
3631
|
+
amount: "26000.00"
|
|
3632
|
+
}, {
|
|
3633
|
+
expected_repayment_at: "2023-07-01",
|
|
3634
|
+
amount: "26000.00"
|
|
3635
|
+
}],
|
|
3636
|
+
data: {}
|
|
3637
|
+
}])
|
|
3638
|
+
```
|
|
3639
|
+
</dd>
|
|
3640
|
+
</dl>
|
|
3641
|
+
</dd>
|
|
3642
|
+
</dl>
|
|
3643
|
+
|
|
3644
|
+
#### ⚙️ Parameters
|
|
3645
|
+
|
|
3646
|
+
<dl>
|
|
3647
|
+
<dd>
|
|
3648
|
+
|
|
3649
|
+
<dl>
|
|
3650
|
+
<dd>
|
|
3651
|
+
|
|
3652
|
+
**loans:** `Internal::Types::Array[Voltaria::Types::BulkLoanItemPayload]` — List of loans to create (max 1000)
|
|
3653
|
+
|
|
3654
|
+
</dd>
|
|
3655
|
+
</dl>
|
|
3656
|
+
|
|
3657
|
+
<dl>
|
|
3658
|
+
<dd>
|
|
3659
|
+
|
|
3660
|
+
**request_options:** `Voltaria::Loans::RequestOptions`
|
|
3661
|
+
|
|
3662
|
+
</dd>
|
|
3663
|
+
</dl>
|
|
3664
|
+
</dd>
|
|
3665
|
+
</dl>
|
|
3666
|
+
|
|
3667
|
+
|
|
3668
|
+
</dd>
|
|
3669
|
+
</dl>
|
|
3670
|
+
</details>
|
|
3671
|
+
|
|
3672
|
+
<details><summary><code>client.loans.<a href="/lib/voltaria/loans/client.rb">get_bulk_loan_status</a>(task_id) -> Voltaria::Types::BulkLoanTaskStatus</code></summary>
|
|
3673
|
+
<dl>
|
|
3674
|
+
<dd>
|
|
3675
|
+
|
|
3676
|
+
#### 📝 Description
|
|
3677
|
+
|
|
3678
|
+
<dl>
|
|
3679
|
+
<dd>
|
|
3680
|
+
|
|
3681
|
+
<dl>
|
|
3682
|
+
<dd>
|
|
3683
|
+
|
|
3684
|
+
Check the status of a bulk loan creation task and retrieve results when completed.
|
|
3685
|
+
</dd>
|
|
3686
|
+
</dl>
|
|
3687
|
+
</dd>
|
|
3688
|
+
</dl>
|
|
3689
|
+
|
|
3690
|
+
#### 🔌 Usage
|
|
3691
|
+
|
|
3692
|
+
<dl>
|
|
3693
|
+
<dd>
|
|
3694
|
+
|
|
3695
|
+
<dl>
|
|
3696
|
+
<dd>
|
|
3697
|
+
|
|
3698
|
+
```ruby
|
|
3699
|
+
client.loans.get_bulk_loan_status(task_id: "task_id")
|
|
3700
|
+
```
|
|
3701
|
+
</dd>
|
|
3702
|
+
</dl>
|
|
3703
|
+
</dd>
|
|
3704
|
+
</dl>
|
|
3705
|
+
|
|
3706
|
+
#### ⚙️ Parameters
|
|
3707
|
+
|
|
3708
|
+
<dl>
|
|
3709
|
+
<dd>
|
|
3710
|
+
|
|
3711
|
+
<dl>
|
|
3712
|
+
<dd>
|
|
3713
|
+
|
|
3714
|
+
**task_id:** `String`
|
|
3715
|
+
|
|
3716
|
+
</dd>
|
|
3717
|
+
</dl>
|
|
3718
|
+
|
|
3719
|
+
<dl>
|
|
3720
|
+
<dd>
|
|
3721
|
+
|
|
3722
|
+
**request_options:** `Voltaria::Loans::RequestOptions`
|
|
3723
|
+
|
|
3724
|
+
</dd>
|
|
3725
|
+
</dl>
|
|
3726
|
+
</dd>
|
|
3727
|
+
</dl>
|
|
3728
|
+
|
|
3729
|
+
|
|
3730
|
+
</dd>
|
|
3731
|
+
</dl>
|
|
3732
|
+
</details>
|
|
3733
|
+
|
|
3734
|
+
<details><summary><code>client.loans.<a href="/lib/voltaria/loans/client.rb">set_loan_default</a>(loan_id, request) -> Voltaria::Types::LoanResponseWithInstallments</code></summary>
|
|
3735
|
+
<dl>
|
|
3736
|
+
<dd>
|
|
3737
|
+
|
|
3738
|
+
#### 📝 Description
|
|
3739
|
+
|
|
3740
|
+
<dl>
|
|
3741
|
+
<dd>
|
|
3742
|
+
|
|
3743
|
+
<dl>
|
|
3744
|
+
<dd>
|
|
3745
|
+
|
|
3746
|
+
Mark a loan as defaulted, recording the default date and the amount recovered from selling it. Defaults the loan's active and overdue installments and updates the loan status accordingly.
|
|
3747
|
+
</dd>
|
|
3748
|
+
</dl>
|
|
3749
|
+
</dd>
|
|
3750
|
+
</dl>
|
|
3751
|
+
|
|
3752
|
+
#### 🔌 Usage
|
|
3753
|
+
|
|
3754
|
+
<dl>
|
|
3755
|
+
<dd>
|
|
3756
|
+
|
|
3757
|
+
<dl>
|
|
3758
|
+
<dd>
|
|
3759
|
+
|
|
3760
|
+
```ruby
|
|
3761
|
+
client.loans.set_loan_default(
|
|
3762
|
+
loan_id: "loan_id",
|
|
3763
|
+
default_date: "2026-06-23",
|
|
3764
|
+
sold_amount: 1.1
|
|
3765
|
+
)
|
|
3766
|
+
```
|
|
3767
|
+
</dd>
|
|
3768
|
+
</dl>
|
|
3769
|
+
</dd>
|
|
3770
|
+
</dl>
|
|
3771
|
+
|
|
3772
|
+
#### ⚙️ Parameters
|
|
3773
|
+
|
|
3774
|
+
<dl>
|
|
3775
|
+
<dd>
|
|
3776
|
+
|
|
3777
|
+
<dl>
|
|
3778
|
+
<dd>
|
|
3779
|
+
|
|
3780
|
+
**loan_id:** `String`
|
|
3781
|
+
|
|
3782
|
+
</dd>
|
|
3783
|
+
</dl>
|
|
3784
|
+
|
|
3785
|
+
<dl>
|
|
3786
|
+
<dd>
|
|
3787
|
+
|
|
3788
|
+
**default_date:** `String` — Date the loan is marked as defaulted.
|
|
3789
|
+
|
|
3790
|
+
</dd>
|
|
3791
|
+
</dl>
|
|
3792
|
+
|
|
3793
|
+
<dl>
|
|
3794
|
+
<dd>
|
|
3795
|
+
|
|
3796
|
+
**sold_amount:** `Voltaria::Loans::Types::LoanDefaultPayloadSoldAmount` — Amount recovered when the defaulted loan is sold.
|
|
3797
|
+
|
|
3798
|
+
</dd>
|
|
3799
|
+
</dl>
|
|
3800
|
+
|
|
3801
|
+
<dl>
|
|
3802
|
+
<dd>
|
|
3803
|
+
|
|
3804
|
+
**request_options:** `Voltaria::Loans::RequestOptions`
|
|
3805
|
+
|
|
3806
|
+
</dd>
|
|
3807
|
+
</dl>
|
|
3808
|
+
</dd>
|
|
3809
|
+
</dl>
|
|
3810
|
+
|
|
3811
|
+
|
|
3812
|
+
</dd>
|
|
3813
|
+
</dl>
|
|
3814
|
+
</details>
|
|
3815
|
+
|
|
3816
|
+
## Partners
|
|
3817
|
+
<details><summary><code>client.partners.<a href="/lib/voltaria/partners/client.rb">get_available_funding</a>() -> Internal::Types::Array[Voltaria::Types::AvailableFunding]</code></summary>
|
|
3818
|
+
<dl>
|
|
3819
|
+
<dd>
|
|
3820
|
+
|
|
3821
|
+
#### 📝 Description
|
|
3822
|
+
|
|
3823
|
+
<dl>
|
|
3824
|
+
<dd>
|
|
3825
|
+
|
|
3826
|
+
<dl>
|
|
3827
|
+
<dd>
|
|
3828
|
+
|
|
3829
|
+
Use this endpoint to check the available funding capacity in your dedicated lending account before initiating a new loan or submitting a drawdown request.
|
|
3830
|
+
</dd>
|
|
3831
|
+
</dl>
|
|
3832
|
+
</dd>
|
|
3833
|
+
</dl>
|
|
3834
|
+
|
|
3835
|
+
#### 🔌 Usage
|
|
3836
|
+
|
|
3837
|
+
<dl>
|
|
3838
|
+
<dd>
|
|
3839
|
+
|
|
3840
|
+
<dl>
|
|
3841
|
+
<dd>
|
|
3842
|
+
|
|
3843
|
+
```ruby
|
|
3844
|
+
client.partners.get_available_funding
|
|
3845
|
+
```
|
|
3846
|
+
</dd>
|
|
3847
|
+
</dl>
|
|
3848
|
+
</dd>
|
|
3849
|
+
</dl>
|
|
3850
|
+
|
|
3851
|
+
#### ⚙️ Parameters
|
|
3852
|
+
|
|
3853
|
+
<dl>
|
|
3854
|
+
<dd>
|
|
3855
|
+
|
|
3856
|
+
<dl>
|
|
3857
|
+
<dd>
|
|
3858
|
+
|
|
3859
|
+
**request_options:** `Voltaria::Partners::RequestOptions`
|
|
3860
|
+
|
|
3861
|
+
</dd>
|
|
3862
|
+
</dl>
|
|
3863
|
+
</dd>
|
|
3864
|
+
</dl>
|
|
3865
|
+
|
|
3866
|
+
|
|
3867
|
+
</dd>
|
|
3868
|
+
</dl>
|
|
3869
|
+
</details>
|
|
3870
|
+
|
|
3871
|
+
<details><summary><code>client.partners.<a href="/lib/voltaria/partners/client.rb">create_partner_data</a>(request) -> Voltaria::Types::PartnerDataResponse</code></summary>
|
|
3872
|
+
<dl>
|
|
3873
|
+
<dd>
|
|
3874
|
+
|
|
3875
|
+
#### 📝 Description
|
|
3876
|
+
|
|
3877
|
+
<dl>
|
|
3878
|
+
<dd>
|
|
3879
|
+
|
|
3880
|
+
<dl>
|
|
3881
|
+
<dd>
|
|
3882
|
+
|
|
3883
|
+
Upload supplementary partner information, such as bank account balance, accounting figures, or other relevant details.
|
|
3884
|
+
</dd>
|
|
3885
|
+
</dl>
|
|
3886
|
+
</dd>
|
|
3887
|
+
</dl>
|
|
3888
|
+
|
|
3889
|
+
#### 🔌 Usage
|
|
3890
|
+
|
|
3891
|
+
<dl>
|
|
3892
|
+
<dd>
|
|
3893
|
+
|
|
3894
|
+
<dl>
|
|
3895
|
+
<dd>
|
|
3896
|
+
|
|
3897
|
+
```ruby
|
|
3898
|
+
client.partners.create_partner_data(data: {})
|
|
3899
|
+
```
|
|
3900
|
+
</dd>
|
|
3901
|
+
</dl>
|
|
3902
|
+
</dd>
|
|
3903
|
+
</dl>
|
|
3904
|
+
|
|
3905
|
+
#### ⚙️ Parameters
|
|
3906
|
+
|
|
3907
|
+
<dl>
|
|
3908
|
+
<dd>
|
|
3909
|
+
|
|
3910
|
+
<dl>
|
|
3911
|
+
<dd>
|
|
3912
|
+
|
|
3913
|
+
**data:** `Internal::Types::Hash[String, Object]`
|
|
3914
|
+
|
|
3915
|
+
</dd>
|
|
3916
|
+
</dl>
|
|
3917
|
+
|
|
3918
|
+
<dl>
|
|
3919
|
+
<dd>
|
|
3920
|
+
|
|
3921
|
+
**request_options:** `Voltaria::Partners::RequestOptions`
|
|
3922
|
+
|
|
3923
|
+
</dd>
|
|
3924
|
+
</dl>
|
|
3925
|
+
</dd>
|
|
3926
|
+
</dl>
|
|
3927
|
+
|
|
3928
|
+
|
|
3929
|
+
</dd>
|
|
3930
|
+
</dl>
|
|
3931
|
+
</details>
|
|
3932
|
+
|
|
3933
|
+
<details><summary><code>client.partners.<a href="/lib/voltaria/partners/client.rb">list_partner_waterfalls</a>() -> Voltaria::Types::PaginatedResponseWaterfallResponse</code></summary>
|
|
3934
|
+
<dl>
|
|
3935
|
+
<dd>
|
|
3936
|
+
|
|
3937
|
+
#### 📝 Description
|
|
3938
|
+
|
|
3939
|
+
<dl>
|
|
3940
|
+
<dd>
|
|
3941
|
+
|
|
3942
|
+
<dl>
|
|
3943
|
+
<dd>
|
|
3944
|
+
|
|
3945
|
+
Use this endpoint to get the list of waterfalls for your dedicated lending account.
|
|
3946
|
+
</dd>
|
|
3947
|
+
</dl>
|
|
3948
|
+
</dd>
|
|
3949
|
+
</dl>
|
|
3950
|
+
|
|
3951
|
+
#### 🔌 Usage
|
|
3952
|
+
|
|
3953
|
+
<dl>
|
|
3954
|
+
<dd>
|
|
3955
|
+
|
|
3956
|
+
<dl>
|
|
3957
|
+
<dd>
|
|
3958
|
+
|
|
3959
|
+
```ruby
|
|
3960
|
+
client.partners.list_partner_waterfalls
|
|
3961
|
+
```
|
|
3962
|
+
</dd>
|
|
3963
|
+
</dl>
|
|
3964
|
+
</dd>
|
|
3965
|
+
</dl>
|
|
3966
|
+
|
|
3967
|
+
#### ⚙️ Parameters
|
|
3968
|
+
|
|
3969
|
+
<dl>
|
|
3970
|
+
<dd>
|
|
3971
|
+
|
|
3972
|
+
<dl>
|
|
3973
|
+
<dd>
|
|
3974
|
+
|
|
3975
|
+
**page:** `Integer`
|
|
3976
|
+
|
|
3977
|
+
</dd>
|
|
3978
|
+
</dl>
|
|
3979
|
+
|
|
3980
|
+
<dl>
|
|
3981
|
+
<dd>
|
|
3982
|
+
|
|
3983
|
+
**page_size:** `Integer`
|
|
3984
|
+
|
|
3985
|
+
</dd>
|
|
3986
|
+
</dl>
|
|
3987
|
+
|
|
3988
|
+
<dl>
|
|
3989
|
+
<dd>
|
|
3990
|
+
|
|
3991
|
+
**order_by:** `String` — Field to order the results by, e.g., 'created_at:desc,updated_at:asc'
|
|
3992
|
+
|
|
3993
|
+
</dd>
|
|
3994
|
+
</dl>
|
|
3995
|
+
|
|
3996
|
+
<dl>
|
|
3997
|
+
<dd>
|
|
3998
|
+
|
|
3999
|
+
**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: id, name, date, status, created_at, updated_at. Supported operators: is, in, not_in, contains, not_contains, like, not_like, ilike, not_ilike, gt, gte, lt, lte, starts_with, ends_with, is_null, is_not_null.
|
|
4000
|
+
|
|
4001
|
+
</dd>
|
|
4002
|
+
</dl>
|
|
4003
|
+
|
|
4004
|
+
<dl>
|
|
4005
|
+
<dd>
|
|
4006
|
+
|
|
4007
|
+
**request_options:** `Voltaria::Partners::RequestOptions`
|
|
4008
|
+
|
|
4009
|
+
</dd>
|
|
4010
|
+
</dl>
|
|
4011
|
+
</dd>
|
|
4012
|
+
</dl>
|
|
4013
|
+
|
|
4014
|
+
|
|
4015
|
+
</dd>
|
|
4016
|
+
</dl>
|
|
4017
|
+
</details>
|
|
4018
|
+
|
|
4019
|
+
## Webhooks
|
|
4020
|
+
<details><summary><code>client.webhooks.<a href="/lib/voltaria/webhooks/client.rb">list_webhook_subscriptions</a>() -> Voltaria::Types::PaginatedResponseWebhookSubscriptionResponse</code></summary>
|
|
4021
|
+
<dl>
|
|
4022
|
+
<dd>
|
|
4023
|
+
|
|
4024
|
+
#### 📝 Description
|
|
4025
|
+
|
|
4026
|
+
<dl>
|
|
4027
|
+
<dd>
|
|
4028
|
+
|
|
4029
|
+
<dl>
|
|
4030
|
+
<dd>
|
|
4031
|
+
|
|
4032
|
+
List all webhook subscriptions for your partner account.
|
|
4033
|
+
</dd>
|
|
4034
|
+
</dl>
|
|
4035
|
+
</dd>
|
|
4036
|
+
</dl>
|
|
4037
|
+
|
|
4038
|
+
#### 🔌 Usage
|
|
4039
|
+
|
|
4040
|
+
<dl>
|
|
4041
|
+
<dd>
|
|
4042
|
+
|
|
4043
|
+
<dl>
|
|
4044
|
+
<dd>
|
|
4045
|
+
|
|
4046
|
+
```ruby
|
|
4047
|
+
client.webhooks.list_webhook_subscriptions
|
|
4048
|
+
```
|
|
4049
|
+
</dd>
|
|
4050
|
+
</dl>
|
|
4051
|
+
</dd>
|
|
4052
|
+
</dl>
|
|
4053
|
+
|
|
4054
|
+
#### ⚙️ Parameters
|
|
4055
|
+
|
|
4056
|
+
<dl>
|
|
4057
|
+
<dd>
|
|
4058
|
+
|
|
4059
|
+
<dl>
|
|
4060
|
+
<dd>
|
|
4061
|
+
|
|
4062
|
+
**page:** `Integer`
|
|
4063
|
+
|
|
4064
|
+
</dd>
|
|
4065
|
+
</dl>
|
|
4066
|
+
|
|
4067
|
+
<dl>
|
|
4068
|
+
<dd>
|
|
4069
|
+
|
|
4070
|
+
**page_size:** `Integer`
|
|
4071
|
+
|
|
4072
|
+
</dd>
|
|
4073
|
+
</dl>
|
|
4074
|
+
|
|
4075
|
+
<dl>
|
|
4076
|
+
<dd>
|
|
4077
|
+
|
|
4078
|
+
**event_type:** `Voltaria::Types::WebhookEventTypeEnum`
|
|
4079
|
+
|
|
4080
|
+
</dd>
|
|
4081
|
+
</dl>
|
|
4082
|
+
|
|
4083
|
+
<dl>
|
|
4084
|
+
<dd>
|
|
4085
|
+
|
|
4086
|
+
**request_options:** `Voltaria::Webhooks::RequestOptions`
|
|
4087
|
+
|
|
4088
|
+
</dd>
|
|
4089
|
+
</dl>
|
|
4090
|
+
</dd>
|
|
4091
|
+
</dl>
|
|
4092
|
+
|
|
4093
|
+
|
|
4094
|
+
</dd>
|
|
4095
|
+
</dl>
|
|
4096
|
+
</details>
|
|
4097
|
+
|
|
4098
|
+
<details><summary><code>client.webhooks.<a href="/lib/voltaria/webhooks/client.rb">create_webhook_subscription</a>(request) -> Voltaria::Types::WebhookSubscriptionResponse</code></summary>
|
|
4099
|
+
<dl>
|
|
4100
|
+
<dd>
|
|
4101
|
+
|
|
4102
|
+
#### 📝 Description
|
|
4103
|
+
|
|
4104
|
+
<dl>
|
|
4105
|
+
<dd>
|
|
4106
|
+
|
|
4107
|
+
<dl>
|
|
4108
|
+
<dd>
|
|
4109
|
+
|
|
4110
|
+
Create a new webhook subscription for a specific event type.
|
|
4111
|
+
</dd>
|
|
4112
|
+
</dl>
|
|
4113
|
+
</dd>
|
|
4114
|
+
</dl>
|
|
4115
|
+
|
|
4116
|
+
#### 🔌 Usage
|
|
4117
|
+
|
|
4118
|
+
<dl>
|
|
4119
|
+
<dd>
|
|
4120
|
+
|
|
4121
|
+
<dl>
|
|
4122
|
+
<dd>
|
|
4123
|
+
|
|
4124
|
+
```ruby
|
|
4125
|
+
client.webhooks.create_webhook_subscription(
|
|
4126
|
+
url: "https://example.com/webhooks",
|
|
4127
|
+
description: "Loan update event",
|
|
4128
|
+
event_type: "loan.updated",
|
|
4129
|
+
secret: "whsec_f3o9p8h7g6j5k4l3m2n1o0p9i8u7y6t5",
|
|
4130
|
+
retry_: false,
|
|
4131
|
+
status: "active"
|
|
4132
|
+
)
|
|
4133
|
+
```
|
|
4134
|
+
</dd>
|
|
4135
|
+
</dl>
|
|
4136
|
+
</dd>
|
|
4137
|
+
</dl>
|
|
4138
|
+
|
|
4139
|
+
#### ⚙️ Parameters
|
|
4140
|
+
|
|
4141
|
+
<dl>
|
|
4142
|
+
<dd>
|
|
4143
|
+
|
|
4144
|
+
<dl>
|
|
4145
|
+
<dd>
|
|
4146
|
+
|
|
4147
|
+
**url:** `String` — The URL to send webhooks to
|
|
4148
|
+
|
|
4149
|
+
</dd>
|
|
4150
|
+
</dl>
|
|
4151
|
+
|
|
4152
|
+
<dl>
|
|
4153
|
+
<dd>
|
|
4154
|
+
|
|
4155
|
+
**description:** `String` — Optional description of this webhook endpoint
|
|
4156
|
+
|
|
4157
|
+
</dd>
|
|
4158
|
+
</dl>
|
|
4159
|
+
|
|
4160
|
+
<dl>
|
|
4161
|
+
<dd>
|
|
4162
|
+
|
|
4163
|
+
**event_type:** `Voltaria::Types::WebhookEventTypeEnum` — Event type to subscribe toPossible values: loan_updated, installment_updated, client_updated, client_limit_updated, partner_limit_updated
|
|
4164
|
+
|
|
4165
|
+
</dd>
|
|
4166
|
+
</dl>
|
|
4167
|
+
|
|
4168
|
+
<dl>
|
|
4169
|
+
<dd>
|
|
4170
|
+
|
|
4171
|
+
**secret:** `String` — Secret for signing webhook payloads
|
|
4172
|
+
|
|
4173
|
+
</dd>
|
|
4174
|
+
</dl>
|
|
4175
|
+
|
|
4176
|
+
<dl>
|
|
4177
|
+
<dd>
|
|
4178
|
+
|
|
4179
|
+
**retry_:** `Internal::Types::Boolean` — Whether to retry failed webhooks
|
|
4180
|
+
|
|
4181
|
+
</dd>
|
|
4182
|
+
</dl>
|
|
4183
|
+
|
|
4184
|
+
<dl>
|
|
4185
|
+
<dd>
|
|
4186
|
+
|
|
4187
|
+
**status:** `Voltaria::Types::WebhookStatusEnum` — Status of the webhook subscription. Defaults to 'active'.Possible values: active, paused, disabled
|
|
4188
|
+
|
|
4189
|
+
</dd>
|
|
4190
|
+
</dl>
|
|
4191
|
+
|
|
4192
|
+
<dl>
|
|
4193
|
+
<dd>
|
|
4194
|
+
|
|
4195
|
+
**request_options:** `Voltaria::Webhooks::RequestOptions`
|
|
4196
|
+
|
|
4197
|
+
</dd>
|
|
4198
|
+
</dl>
|
|
4199
|
+
</dd>
|
|
4200
|
+
</dl>
|
|
4201
|
+
|
|
4202
|
+
|
|
4203
|
+
</dd>
|
|
4204
|
+
</dl>
|
|
4205
|
+
</details>
|
|
4206
|
+
|
|
4207
|
+
<details><summary><code>client.webhooks.<a href="/lib/voltaria/webhooks/client.rb">get_webhook_subscription</a>(webhook_id) -> Voltaria::Types::WebhookSubscriptionResponse</code></summary>
|
|
4208
|
+
<dl>
|
|
4209
|
+
<dd>
|
|
4210
|
+
|
|
4211
|
+
#### 📝 Description
|
|
4212
|
+
|
|
4213
|
+
<dl>
|
|
4214
|
+
<dd>
|
|
4215
|
+
|
|
4216
|
+
<dl>
|
|
4217
|
+
<dd>
|
|
4218
|
+
|
|
4219
|
+
Retrieve details for a specific webhook subscription with its webhook ID.
|
|
4220
|
+
</dd>
|
|
4221
|
+
</dl>
|
|
4222
|
+
</dd>
|
|
4223
|
+
</dl>
|
|
4224
|
+
|
|
4225
|
+
#### 🔌 Usage
|
|
4226
|
+
|
|
4227
|
+
<dl>
|
|
4228
|
+
<dd>
|
|
4229
|
+
|
|
4230
|
+
<dl>
|
|
4231
|
+
<dd>
|
|
4232
|
+
|
|
4233
|
+
```ruby
|
|
4234
|
+
client.webhooks.get_webhook_subscription(webhook_id: "webhook_id")
|
|
4235
|
+
```
|
|
4236
|
+
</dd>
|
|
4237
|
+
</dl>
|
|
4238
|
+
</dd>
|
|
4239
|
+
</dl>
|
|
4240
|
+
|
|
4241
|
+
#### ⚙️ Parameters
|
|
4242
|
+
|
|
4243
|
+
<dl>
|
|
4244
|
+
<dd>
|
|
4245
|
+
|
|
4246
|
+
<dl>
|
|
4247
|
+
<dd>
|
|
4248
|
+
|
|
4249
|
+
**webhook_id:** `String`
|
|
4250
|
+
|
|
4251
|
+
</dd>
|
|
4252
|
+
</dl>
|
|
4253
|
+
|
|
4254
|
+
<dl>
|
|
4255
|
+
<dd>
|
|
4256
|
+
|
|
4257
|
+
**request_options:** `Voltaria::Webhooks::RequestOptions`
|
|
4258
|
+
|
|
4259
|
+
</dd>
|
|
4260
|
+
</dl>
|
|
4261
|
+
</dd>
|
|
4262
|
+
</dl>
|
|
4263
|
+
|
|
4264
|
+
|
|
4265
|
+
</dd>
|
|
4266
|
+
</dl>
|
|
4267
|
+
</details>
|
|
4268
|
+
|
|
4269
|
+
<details><summary><code>client.webhooks.<a href="/lib/voltaria/webhooks/client.rb">update_webhook_subscription</a>(webhook_id, request) -> Voltaria::Types::WebhookSubscriptionResponse</code></summary>
|
|
4270
|
+
<dl>
|
|
4271
|
+
<dd>
|
|
4272
|
+
|
|
4273
|
+
#### 📝 Description
|
|
4274
|
+
|
|
4275
|
+
<dl>
|
|
4276
|
+
<dd>
|
|
4277
|
+
|
|
4278
|
+
<dl>
|
|
4279
|
+
<dd>
|
|
4280
|
+
|
|
4281
|
+
Update a webhook subscription with its specific webhook ID.
|
|
4282
|
+
</dd>
|
|
4283
|
+
</dl>
|
|
4284
|
+
</dd>
|
|
4285
|
+
</dl>
|
|
4286
|
+
|
|
4287
|
+
#### 🔌 Usage
|
|
4288
|
+
|
|
4289
|
+
<dl>
|
|
4290
|
+
<dd>
|
|
4291
|
+
|
|
4292
|
+
<dl>
|
|
4293
|
+
<dd>
|
|
4294
|
+
|
|
4295
|
+
```ruby
|
|
4296
|
+
client.webhooks.update_webhook_subscription(
|
|
4297
|
+
webhook_id: "webhook_id",
|
|
4298
|
+
url: "https://example.com/webhooks/v2",
|
|
4299
|
+
description: "Updated webhook endpoint",
|
|
4300
|
+
event_type: "installment.updated",
|
|
4301
|
+
status: "paused",
|
|
4302
|
+
retry_: true,
|
|
4303
|
+
secret: "whsec_updated_secret_here"
|
|
4304
|
+
)
|
|
4305
|
+
```
|
|
4306
|
+
</dd>
|
|
4307
|
+
</dl>
|
|
4308
|
+
</dd>
|
|
4309
|
+
</dl>
|
|
4310
|
+
|
|
4311
|
+
#### ⚙️ Parameters
|
|
4312
|
+
|
|
4313
|
+
<dl>
|
|
4314
|
+
<dd>
|
|
4315
|
+
|
|
4316
|
+
<dl>
|
|
4317
|
+
<dd>
|
|
4318
|
+
|
|
4319
|
+
**webhook_id:** `String`
|
|
4320
|
+
|
|
4321
|
+
</dd>
|
|
4322
|
+
</dl>
|
|
4323
|
+
|
|
4324
|
+
<dl>
|
|
4325
|
+
<dd>
|
|
4326
|
+
|
|
4327
|
+
**url:** `String` — The URL to send webhooks to
|
|
4328
|
+
|
|
4329
|
+
</dd>
|
|
4330
|
+
</dl>
|
|
4331
|
+
|
|
4332
|
+
<dl>
|
|
4333
|
+
<dd>
|
|
4334
|
+
|
|
4335
|
+
**description:** `String` — Description of this webhook endpoint
|
|
4336
|
+
|
|
4337
|
+
</dd>
|
|
4338
|
+
</dl>
|
|
4339
|
+
|
|
4340
|
+
<dl>
|
|
4341
|
+
<dd>
|
|
4342
|
+
|
|
4343
|
+
**event_type:** `Voltaria::Types::WebhookEventTypeEnum` — Event type to subscribe toPossible values: loan_updated, installment_updated, client_updated, client_limit_updated, partner_limit_updated
|
|
4344
|
+
|
|
4345
|
+
</dd>
|
|
4346
|
+
</dl>
|
|
4347
|
+
|
|
4348
|
+
<dl>
|
|
4349
|
+
<dd>
|
|
4350
|
+
|
|
4351
|
+
**status:** `Voltaria::Types::WebhookStatusEnum` — Status of the webhook subscriptionPossible values: active, paused, disabled
|
|
4352
|
+
|
|
4353
|
+
</dd>
|
|
4354
|
+
</dl>
|
|
4355
|
+
|
|
4356
|
+
<dl>
|
|
4357
|
+
<dd>
|
|
4358
|
+
|
|
4359
|
+
**retry_:** `Internal::Types::Boolean` — Whether to retry failed webhooks
|
|
4360
|
+
|
|
4361
|
+
</dd>
|
|
4362
|
+
</dl>
|
|
4363
|
+
|
|
4364
|
+
<dl>
|
|
4365
|
+
<dd>
|
|
4366
|
+
|
|
4367
|
+
**secret:** `String` — Secret for signing webhook payloads
|
|
4368
|
+
|
|
4369
|
+
</dd>
|
|
4370
|
+
</dl>
|
|
4371
|
+
|
|
4372
|
+
<dl>
|
|
4373
|
+
<dd>
|
|
4374
|
+
|
|
4375
|
+
**request_options:** `Voltaria::Webhooks::RequestOptions`
|
|
4376
|
+
|
|
4377
|
+
</dd>
|
|
4378
|
+
</dl>
|
|
4379
|
+
</dd>
|
|
4380
|
+
</dl>
|
|
4381
|
+
|
|
4382
|
+
|
|
4383
|
+
</dd>
|
|
4384
|
+
</dl>
|
|
4385
|
+
</details>
|
|
4386
|
+
|
|
4387
|
+
<details><summary><code>client.webhooks.<a href="/lib/voltaria/webhooks/client.rb">delete_webhook_subscription</a>(webhook_id) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
4388
|
+
<dl>
|
|
4389
|
+
<dd>
|
|
4390
|
+
|
|
4391
|
+
#### 📝 Description
|
|
4392
|
+
|
|
4393
|
+
<dl>
|
|
4394
|
+
<dd>
|
|
4395
|
+
|
|
4396
|
+
<dl>
|
|
4397
|
+
<dd>
|
|
4398
|
+
|
|
4399
|
+
Delete a specific webhook subscription.
|
|
4400
|
+
</dd>
|
|
4401
|
+
</dl>
|
|
4402
|
+
</dd>
|
|
4403
|
+
</dl>
|
|
4404
|
+
|
|
4405
|
+
#### 🔌 Usage
|
|
4406
|
+
|
|
4407
|
+
<dl>
|
|
4408
|
+
<dd>
|
|
4409
|
+
|
|
4410
|
+
<dl>
|
|
4411
|
+
<dd>
|
|
4412
|
+
|
|
4413
|
+
```ruby
|
|
4414
|
+
client.webhooks.delete_webhook_subscription(webhook_id: "webhook_id")
|
|
4415
|
+
```
|
|
4416
|
+
</dd>
|
|
4417
|
+
</dl>
|
|
4418
|
+
</dd>
|
|
4419
|
+
</dl>
|
|
4420
|
+
|
|
4421
|
+
#### ⚙️ Parameters
|
|
4422
|
+
|
|
4423
|
+
<dl>
|
|
4424
|
+
<dd>
|
|
4425
|
+
|
|
4426
|
+
<dl>
|
|
4427
|
+
<dd>
|
|
4428
|
+
|
|
4429
|
+
**webhook_id:** `String`
|
|
4430
|
+
|
|
4431
|
+
</dd>
|
|
4432
|
+
</dl>
|
|
4433
|
+
|
|
4434
|
+
<dl>
|
|
4435
|
+
<dd>
|
|
4436
|
+
|
|
4437
|
+
**request_options:** `Voltaria::Webhooks::RequestOptions`
|
|
4438
|
+
|
|
4439
|
+
</dd>
|
|
4440
|
+
</dl>
|
|
4441
|
+
</dd>
|
|
4442
|
+
</dl>
|
|
4443
|
+
|
|
4444
|
+
|
|
4445
|
+
</dd>
|
|
4446
|
+
</dl>
|
|
4447
|
+
</details>
|
|
4448
|
+
|
|
4449
|
+
<details><summary><code>client.webhooks.<a href="/lib/voltaria/webhooks/client.rb">list_webhook_logs</a>() -> Voltaria::Types::PaginatedResponseWebhookLogResponse</code></summary>
|
|
4450
|
+
<dl>
|
|
4451
|
+
<dd>
|
|
4452
|
+
|
|
4453
|
+
#### 📝 Description
|
|
4454
|
+
|
|
4455
|
+
<dl>
|
|
4456
|
+
<dd>
|
|
4457
|
+
|
|
4458
|
+
<dl>
|
|
4459
|
+
<dd>
|
|
4460
|
+
|
|
4461
|
+
Retrieve all webhook logs linked to your partner account.
|
|
4462
|
+
</dd>
|
|
4463
|
+
</dl>
|
|
4464
|
+
</dd>
|
|
4465
|
+
</dl>
|
|
4466
|
+
|
|
4467
|
+
#### 🔌 Usage
|
|
4468
|
+
|
|
4469
|
+
<dl>
|
|
4470
|
+
<dd>
|
|
4471
|
+
|
|
4472
|
+
<dl>
|
|
4473
|
+
<dd>
|
|
4474
|
+
|
|
4475
|
+
```ruby
|
|
4476
|
+
client.webhooks.list_webhook_logs
|
|
4477
|
+
```
|
|
4478
|
+
</dd>
|
|
4479
|
+
</dl>
|
|
4480
|
+
</dd>
|
|
4481
|
+
</dl>
|
|
4482
|
+
|
|
4483
|
+
#### ⚙️ Parameters
|
|
4484
|
+
|
|
4485
|
+
<dl>
|
|
4486
|
+
<dd>
|
|
4487
|
+
|
|
4488
|
+
<dl>
|
|
4489
|
+
<dd>
|
|
4490
|
+
|
|
4491
|
+
**webhook_id:** `String`
|
|
4492
|
+
|
|
4493
|
+
</dd>
|
|
4494
|
+
</dl>
|
|
4495
|
+
|
|
4496
|
+
<dl>
|
|
4497
|
+
<dd>
|
|
4498
|
+
|
|
4499
|
+
**page:** `Integer`
|
|
4500
|
+
|
|
4501
|
+
</dd>
|
|
4502
|
+
</dl>
|
|
4503
|
+
|
|
4504
|
+
<dl>
|
|
4505
|
+
<dd>
|
|
4506
|
+
|
|
4507
|
+
**page_size:** `Integer`
|
|
4508
|
+
|
|
4509
|
+
</dd>
|
|
4510
|
+
</dl>
|
|
4511
|
+
|
|
4512
|
+
<dl>
|
|
4513
|
+
<dd>
|
|
4514
|
+
|
|
4515
|
+
**request_options:** `Voltaria::Webhooks::RequestOptions`
|
|
4516
|
+
|
|
4517
|
+
</dd>
|
|
4518
|
+
</dl>
|
|
4519
|
+
</dd>
|
|
4520
|
+
</dl>
|
|
4521
|
+
|
|
4522
|
+
|
|
4523
|
+
</dd>
|
|
4524
|
+
</dl>
|
|
4525
|
+
</details>
|
|
4526
|
+
|
|
4527
|
+
## Repayments
|
|
4528
|
+
<details><summary><code>client.repayments.<a href="/lib/voltaria/repayments/client.rb">list_repayment_logs</a>() -> Voltaria::Types::PaginatedResponseRepaymentResponseWithClientInfo</code></summary>
|
|
4529
|
+
<dl>
|
|
4530
|
+
<dd>
|
|
4531
|
+
|
|
4532
|
+
#### 📝 Description
|
|
4533
|
+
|
|
4534
|
+
<dl>
|
|
4535
|
+
<dd>
|
|
4536
|
+
|
|
4537
|
+
<dl>
|
|
4538
|
+
<dd>
|
|
4539
|
+
|
|
4540
|
+
Retrieve all repayments made under your partner account. Supports filtering by client, loan, or installments.
|
|
4541
|
+
</dd>
|
|
4542
|
+
</dl>
|
|
4543
|
+
</dd>
|
|
4544
|
+
</dl>
|
|
4545
|
+
|
|
4546
|
+
#### 🔌 Usage
|
|
4547
|
+
|
|
4548
|
+
<dl>
|
|
4549
|
+
<dd>
|
|
4550
|
+
|
|
4551
|
+
<dl>
|
|
4552
|
+
<dd>
|
|
4553
|
+
|
|
4554
|
+
```ruby
|
|
4555
|
+
client.repayments.list_repayment_logs
|
|
4556
|
+
```
|
|
4557
|
+
</dd>
|
|
4558
|
+
</dl>
|
|
4559
|
+
</dd>
|
|
4560
|
+
</dl>
|
|
4561
|
+
|
|
4562
|
+
#### ⚙️ Parameters
|
|
4563
|
+
|
|
4564
|
+
<dl>
|
|
4565
|
+
<dd>
|
|
4566
|
+
|
|
4567
|
+
<dl>
|
|
4568
|
+
<dd>
|
|
4569
|
+
|
|
4570
|
+
**client_id:** `String`
|
|
4571
|
+
|
|
4572
|
+
</dd>
|
|
4573
|
+
</dl>
|
|
4574
|
+
|
|
4575
|
+
<dl>
|
|
4576
|
+
<dd>
|
|
4577
|
+
|
|
4578
|
+
**loan_id:** `String`
|
|
4579
|
+
|
|
4580
|
+
</dd>
|
|
4581
|
+
</dl>
|
|
4582
|
+
|
|
4583
|
+
<dl>
|
|
4584
|
+
<dd>
|
|
4585
|
+
|
|
4586
|
+
**installment_id:** `String`
|
|
4587
|
+
|
|
4588
|
+
</dd>
|
|
4589
|
+
</dl>
|
|
4590
|
+
|
|
4591
|
+
<dl>
|
|
4592
|
+
<dd>
|
|
4593
|
+
|
|
4594
|
+
**page:** `Integer`
|
|
4595
|
+
|
|
4596
|
+
</dd>
|
|
4597
|
+
</dl>
|
|
4598
|
+
|
|
4599
|
+
<dl>
|
|
4600
|
+
<dd>
|
|
4601
|
+
|
|
4602
|
+
**page_size:** `Integer`
|
|
4603
|
+
|
|
4604
|
+
</dd>
|
|
4605
|
+
</dl>
|
|
4606
|
+
|
|
4607
|
+
<dl>
|
|
4608
|
+
<dd>
|
|
4609
|
+
|
|
4610
|
+
**order_by:** `String` — Field to order the results by, e.g., 'created_at:desc,updated_at:asc'
|
|
4611
|
+
|
|
4612
|
+
</dd>
|
|
4613
|
+
</dl>
|
|
4614
|
+
|
|
4615
|
+
<dl>
|
|
4616
|
+
<dd>
|
|
4617
|
+
|
|
4618
|
+
**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: id, client_id, loan_id, installment_id, created_at, client.name, client.correlation_id. Supported operators: is, in, not_in, contains, not_contains, like, not_like, ilike, not_ilike, gt, gte, lt, lte, starts_with, ends_with, is_null, is_not_null.
|
|
4619
|
+
|
|
4620
|
+
</dd>
|
|
4621
|
+
</dl>
|
|
4622
|
+
|
|
4623
|
+
<dl>
|
|
4624
|
+
<dd>
|
|
4625
|
+
|
|
4626
|
+
**request_options:** `Voltaria::Repayments::RequestOptions`
|
|
4627
|
+
|
|
4628
|
+
</dd>
|
|
4629
|
+
</dl>
|
|
4630
|
+
</dd>
|
|
4631
|
+
</dl>
|
|
4632
|
+
|
|
4633
|
+
|
|
4634
|
+
</dd>
|
|
4635
|
+
</dl>
|
|
4636
|
+
</details>
|
|
4637
|
+
|
|
4638
|
+
<details><summary><code>client.repayments.<a href="/lib/voltaria/repayments/client.rb">create_repayment</a>(request) -> Voltaria::Types::RepaymentResponse</code></summary>
|
|
4639
|
+
<dl>
|
|
4640
|
+
<dd>
|
|
4641
|
+
|
|
4642
|
+
#### 📝 Description
|
|
4643
|
+
|
|
4644
|
+
<dl>
|
|
4645
|
+
<dd>
|
|
4646
|
+
|
|
4647
|
+
<dl>
|
|
4648
|
+
<dd>
|
|
4649
|
+
|
|
4650
|
+
Create a new repayment log for an installment. Requires the installment ID, loan ID or loan correlation ID.
|
|
4651
|
+
</dd>
|
|
4652
|
+
</dl>
|
|
4653
|
+
</dd>
|
|
4654
|
+
</dl>
|
|
4655
|
+
|
|
4656
|
+
#### 🔌 Usage
|
|
4657
|
+
|
|
4658
|
+
<dl>
|
|
4659
|
+
<dd>
|
|
4660
|
+
|
|
4661
|
+
<dl>
|
|
4662
|
+
<dd>
|
|
4663
|
+
|
|
4664
|
+
```ruby
|
|
4665
|
+
client.repayments.create_repayment(amount: 1.1)
|
|
4666
|
+
```
|
|
4667
|
+
</dd>
|
|
4668
|
+
</dl>
|
|
4669
|
+
</dd>
|
|
4670
|
+
</dl>
|
|
4671
|
+
|
|
4672
|
+
#### ⚙️ Parameters
|
|
4673
|
+
|
|
4674
|
+
<dl>
|
|
4675
|
+
<dd>
|
|
4676
|
+
|
|
4677
|
+
<dl>
|
|
4678
|
+
<dd>
|
|
4679
|
+
|
|
4680
|
+
**installment_id:** `String` — ID of the installment
|
|
4681
|
+
|
|
4682
|
+
</dd>
|
|
4683
|
+
</dl>
|
|
4684
|
+
|
|
4685
|
+
<dl>
|
|
4686
|
+
<dd>
|
|
4687
|
+
|
|
4688
|
+
**loan_id:** `String` — ID of the associated Loan
|
|
4689
|
+
|
|
4690
|
+
</dd>
|
|
4691
|
+
</dl>
|
|
4692
|
+
|
|
4693
|
+
<dl>
|
|
4694
|
+
<dd>
|
|
4695
|
+
|
|
4696
|
+
**correlation_id:** `String` — Correlation ID of associated loan
|
|
4697
|
+
|
|
4698
|
+
</dd>
|
|
4699
|
+
</dl>
|
|
4700
|
+
|
|
4701
|
+
<dl>
|
|
4702
|
+
<dd>
|
|
4703
|
+
|
|
4704
|
+
**amount:** `Voltaria::Repayments::Types::RepaymentCreatePayloadAmount` — The amount of payment made for installment
|
|
4705
|
+
|
|
4706
|
+
</dd>
|
|
4707
|
+
</dl>
|
|
4708
|
+
|
|
4709
|
+
<dl>
|
|
4710
|
+
<dd>
|
|
4711
|
+
|
|
4712
|
+
**repayment_date:** `String` — Please provide the repayment_date if it differs from the time you log this repayment. Otherwise, it will be automatically set.
|
|
4713
|
+
|
|
4714
|
+
</dd>
|
|
4715
|
+
</dl>
|
|
4716
|
+
|
|
4717
|
+
<dl>
|
|
4718
|
+
<dd>
|
|
4719
|
+
|
|
4720
|
+
**data:** `Internal::Types::Hash[String, Object]` — Additional metadata related to the repayment
|
|
4721
|
+
|
|
4722
|
+
</dd>
|
|
4723
|
+
</dl>
|
|
4724
|
+
|
|
4725
|
+
<dl>
|
|
4726
|
+
<dd>
|
|
4727
|
+
|
|
4728
|
+
**is_early_settlement:** `Internal::Types::Boolean` — Indicates if this repayment is for early settlement
|
|
4729
|
+
|
|
4730
|
+
</dd>
|
|
4731
|
+
</dl>
|
|
4732
|
+
|
|
4733
|
+
<dl>
|
|
4734
|
+
<dd>
|
|
4735
|
+
|
|
4736
|
+
**request_options:** `Voltaria::Repayments::RequestOptions`
|
|
4737
|
+
|
|
4738
|
+
</dd>
|
|
4739
|
+
</dl>
|
|
4740
|
+
</dd>
|
|
4741
|
+
</dl>
|
|
4742
|
+
|
|
4743
|
+
|
|
4744
|
+
</dd>
|
|
4745
|
+
</dl>
|
|
4746
|
+
</details>
|
|
4747
|
+
|
|
4748
|
+
<details><summary><code>client.repayments.<a href="/lib/voltaria/repayments/client.rb">create_bulk_repayments</a>(request) -> Voltaria::Types::BulkRepaymentTaskResponse</code></summary>
|
|
4749
|
+
<dl>
|
|
4750
|
+
<dd>
|
|
4751
|
+
|
|
4752
|
+
#### 📝 Description
|
|
4753
|
+
|
|
4754
|
+
<dl>
|
|
4755
|
+
<dd>
|
|
4756
|
+
|
|
4757
|
+
<dl>
|
|
4758
|
+
<dd>
|
|
4759
|
+
|
|
4760
|
+
Initiate processing of up to 10000 repayment logs. Returns task_id for tracking progress.
|
|
4761
|
+
</dd>
|
|
4762
|
+
</dl>
|
|
4763
|
+
</dd>
|
|
4764
|
+
</dl>
|
|
4765
|
+
|
|
4766
|
+
#### 🔌 Usage
|
|
4767
|
+
|
|
4768
|
+
<dl>
|
|
4769
|
+
<dd>
|
|
4770
|
+
|
|
4771
|
+
<dl>
|
|
4772
|
+
<dd>
|
|
4773
|
+
|
|
4774
|
+
```ruby
|
|
4775
|
+
client.repayments.create_bulk_repayments(repayments: [{
|
|
4776
|
+
amount: "1000.00",
|
|
4777
|
+
repayment_date: "2023-10-01T12:00:00Z",
|
|
4778
|
+
data: {},
|
|
4779
|
+
installment_id: "installment_123"
|
|
4780
|
+
}, {
|
|
4781
|
+
amount: "500.50",
|
|
4782
|
+
data: {},
|
|
4783
|
+
loan_id: "loan_456"
|
|
4784
|
+
}, {
|
|
4785
|
+
amount: "750.00",
|
|
4786
|
+
repayment_date: "2023-09-30T15:30:00Z",
|
|
4787
|
+
correlation_id: "LOAN-789"
|
|
4788
|
+
}])
|
|
4789
|
+
```
|
|
4790
|
+
</dd>
|
|
4791
|
+
</dl>
|
|
4792
|
+
</dd>
|
|
4793
|
+
</dl>
|
|
4794
|
+
|
|
4795
|
+
#### ⚙️ Parameters
|
|
4796
|
+
|
|
4797
|
+
<dl>
|
|
4798
|
+
<dd>
|
|
4799
|
+
|
|
4800
|
+
<dl>
|
|
4801
|
+
<dd>
|
|
4802
|
+
|
|
4803
|
+
**repayments:** `Internal::Types::Array[Voltaria::Types::BulkRepaymentItemPayload]` — List of repayments to create (max 10000)
|
|
4804
|
+
|
|
4805
|
+
</dd>
|
|
4806
|
+
</dl>
|
|
4807
|
+
|
|
4808
|
+
<dl>
|
|
4809
|
+
<dd>
|
|
4810
|
+
|
|
4811
|
+
**request_options:** `Voltaria::Repayments::RequestOptions`
|
|
4812
|
+
|
|
4813
|
+
</dd>
|
|
4814
|
+
</dl>
|
|
4815
|
+
</dd>
|
|
4816
|
+
</dl>
|
|
4817
|
+
|
|
4818
|
+
|
|
4819
|
+
</dd>
|
|
4820
|
+
</dl>
|
|
4821
|
+
</details>
|
|
4822
|
+
|
|
4823
|
+
<details><summary><code>client.repayments.<a href="/lib/voltaria/repayments/client.rb">get_bulk_repayment_status</a>(task_id) -> Voltaria::Types::BulkRepaymentTaskStatus</code></summary>
|
|
4824
|
+
<dl>
|
|
4825
|
+
<dd>
|
|
4826
|
+
|
|
4827
|
+
#### 📝 Description
|
|
4828
|
+
|
|
4829
|
+
<dl>
|
|
4830
|
+
<dd>
|
|
4831
|
+
|
|
4832
|
+
<dl>
|
|
4833
|
+
<dd>
|
|
4834
|
+
|
|
4835
|
+
Check the progress and results of a bulk repayment processing task.
|
|
4836
|
+
</dd>
|
|
4837
|
+
</dl>
|
|
4838
|
+
</dd>
|
|
4839
|
+
</dl>
|
|
4840
|
+
|
|
4841
|
+
#### 🔌 Usage
|
|
4842
|
+
|
|
4843
|
+
<dl>
|
|
4844
|
+
<dd>
|
|
4845
|
+
|
|
4846
|
+
<dl>
|
|
4847
|
+
<dd>
|
|
4848
|
+
|
|
4849
|
+
```ruby
|
|
4850
|
+
client.repayments.get_bulk_repayment_status(task_id: "task_id")
|
|
4851
|
+
```
|
|
4852
|
+
</dd>
|
|
4853
|
+
</dl>
|
|
4854
|
+
</dd>
|
|
4855
|
+
</dl>
|
|
4856
|
+
|
|
4857
|
+
#### ⚙️ Parameters
|
|
4858
|
+
|
|
4859
|
+
<dl>
|
|
4860
|
+
<dd>
|
|
4861
|
+
|
|
4862
|
+
<dl>
|
|
4863
|
+
<dd>
|
|
4864
|
+
|
|
4865
|
+
**task_id:** `String`
|
|
4866
|
+
|
|
4867
|
+
</dd>
|
|
4868
|
+
</dl>
|
|
4869
|
+
|
|
4870
|
+
<dl>
|
|
4871
|
+
<dd>
|
|
4872
|
+
|
|
4873
|
+
**request_options:** `Voltaria::Repayments::RequestOptions`
|
|
4874
|
+
|
|
4875
|
+
</dd>
|
|
4876
|
+
</dl>
|
|
4877
|
+
</dd>
|
|
4878
|
+
</dl>
|
|
4879
|
+
|
|
4880
|
+
|
|
4881
|
+
</dd>
|
|
4882
|
+
</dl>
|
|
4883
|
+
</details>
|
|
4884
|
+
|
|
4885
|
+
## Drawdowns
|
|
4886
|
+
<details><summary><code>client.drawdowns.<a href="/lib/voltaria/drawdowns/client.rb">list_drawdowns</a>() -> Voltaria::Types::PaginatedResponseDrawdownResponse</code></summary>
|
|
4887
|
+
<dl>
|
|
4888
|
+
<dd>
|
|
4889
|
+
|
|
4890
|
+
#### 📝 Description
|
|
4891
|
+
|
|
4892
|
+
<dl>
|
|
4893
|
+
<dd>
|
|
4894
|
+
|
|
4895
|
+
<dl>
|
|
4896
|
+
<dd>
|
|
4897
|
+
|
|
4898
|
+
Retrieve a list of drawdowns.
|
|
4899
|
+
</dd>
|
|
4900
|
+
</dl>
|
|
4901
|
+
</dd>
|
|
4902
|
+
</dl>
|
|
4903
|
+
|
|
4904
|
+
#### 🔌 Usage
|
|
4905
|
+
|
|
4906
|
+
<dl>
|
|
4907
|
+
<dd>
|
|
4908
|
+
|
|
4909
|
+
<dl>
|
|
4910
|
+
<dd>
|
|
4911
|
+
|
|
4912
|
+
```ruby
|
|
4913
|
+
client.drawdowns.list_drawdowns
|
|
4914
|
+
```
|
|
4915
|
+
</dd>
|
|
4916
|
+
</dl>
|
|
4917
|
+
</dd>
|
|
4918
|
+
</dl>
|
|
4919
|
+
|
|
4920
|
+
#### ⚙️ Parameters
|
|
4921
|
+
|
|
4922
|
+
<dl>
|
|
4923
|
+
<dd>
|
|
4924
|
+
|
|
4925
|
+
<dl>
|
|
4926
|
+
<dd>
|
|
4927
|
+
|
|
4928
|
+
**page:** `Integer`
|
|
4929
|
+
|
|
4930
|
+
</dd>
|
|
4931
|
+
</dl>
|
|
4932
|
+
|
|
4933
|
+
<dl>
|
|
4934
|
+
<dd>
|
|
4935
|
+
|
|
4936
|
+
**page_size:** `Integer`
|
|
4937
|
+
|
|
4938
|
+
</dd>
|
|
4939
|
+
</dl>
|
|
4940
|
+
|
|
4941
|
+
<dl>
|
|
4942
|
+
<dd>
|
|
4943
|
+
|
|
4944
|
+
**order_by:** `String` — Field to order the results by, e.g., 'created_at:desc,updated_at:asc'
|
|
4945
|
+
|
|
4946
|
+
</dd>
|
|
4947
|
+
</dl>
|
|
4948
|
+
|
|
4949
|
+
<dl>
|
|
4950
|
+
<dd>
|
|
4951
|
+
|
|
4952
|
+
**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: . Supported operators: is, in, not_in, contains, not_contains, like, not_like, ilike, not_ilike, gt, gte, lt, lte, starts_with, ends_with, is_null, is_not_null.
|
|
4953
|
+
|
|
4954
|
+
</dd>
|
|
4955
|
+
</dl>
|
|
4956
|
+
|
|
4957
|
+
<dl>
|
|
4958
|
+
<dd>
|
|
4959
|
+
|
|
4960
|
+
**request_options:** `Voltaria::Drawdowns::RequestOptions`
|
|
4961
|
+
|
|
4962
|
+
</dd>
|
|
4963
|
+
</dl>
|
|
4964
|
+
</dd>
|
|
4965
|
+
</dl>
|
|
4966
|
+
|
|
4967
|
+
|
|
4968
|
+
</dd>
|
|
4969
|
+
</dl>
|
|
4970
|
+
</details>
|
|
4971
|
+
|
|
4972
|
+
<details><summary><code>client.drawdowns.<a href="/lib/voltaria/drawdowns/client.rb">create_drawdown_request</a>(request) -> Voltaria::Types::DrawdownResponse</code></summary>
|
|
4973
|
+
<dl>
|
|
4974
|
+
<dd>
|
|
4975
|
+
|
|
4976
|
+
#### 📝 Description
|
|
4977
|
+
|
|
4978
|
+
<dl>
|
|
4979
|
+
<dd>
|
|
4980
|
+
|
|
4981
|
+
<dl>
|
|
4982
|
+
<dd>
|
|
4983
|
+
|
|
4984
|
+
Create a new drawdown request.
|
|
4985
|
+
</dd>
|
|
4986
|
+
</dl>
|
|
4987
|
+
</dd>
|
|
4988
|
+
</dl>
|
|
4989
|
+
|
|
4990
|
+
#### 🔌 Usage
|
|
4991
|
+
|
|
4992
|
+
<dl>
|
|
4993
|
+
<dd>
|
|
4994
|
+
|
|
4995
|
+
<dl>
|
|
4996
|
+
<dd>
|
|
4997
|
+
|
|
4998
|
+
```ruby
|
|
4999
|
+
client.drawdowns.create_drawdown_request(amount: 1.1)
|
|
5000
|
+
```
|
|
5001
|
+
</dd>
|
|
5002
|
+
</dl>
|
|
5003
|
+
</dd>
|
|
5004
|
+
</dl>
|
|
5005
|
+
|
|
5006
|
+
#### ⚙️ Parameters
|
|
5007
|
+
|
|
5008
|
+
<dl>
|
|
5009
|
+
<dd>
|
|
5010
|
+
|
|
5011
|
+
<dl>
|
|
5012
|
+
<dd>
|
|
5013
|
+
|
|
5014
|
+
**amount:** `Voltaria::Drawdowns::Types::DrawdownCreatePayloadAmount` — The amount for the drawdown.
|
|
5015
|
+
|
|
5016
|
+
</dd>
|
|
5017
|
+
</dl>
|
|
5018
|
+
|
|
5019
|
+
<dl>
|
|
5020
|
+
<dd>
|
|
5021
|
+
|
|
5022
|
+
**drawdown_date:** `String` — The date for the drawdown. If not provided, defaults to the current date and time.
|
|
5023
|
+
|
|
5024
|
+
</dd>
|
|
5025
|
+
</dl>
|
|
5026
|
+
|
|
5027
|
+
<dl>
|
|
5028
|
+
<dd>
|
|
5029
|
+
|
|
5030
|
+
**request_options:** `Voltaria::Drawdowns::RequestOptions`
|
|
5031
|
+
|
|
5032
|
+
</dd>
|
|
5033
|
+
</dl>
|
|
5034
|
+
</dd>
|
|
5035
|
+
</dl>
|
|
5036
|
+
|
|
5037
|
+
|
|
5038
|
+
</dd>
|
|
5039
|
+
</dl>
|
|
5040
|
+
</details>
|
|
5041
|
+
|
|
5042
|
+
<details><summary><code>client.drawdowns.<a href="/lib/voltaria/drawdowns/client.rb">list_drawdown_checklists</a>(drawdown_id) -> Voltaria::Types::PaginatedResponseDrawdownChecklistResponse</code></summary>
|
|
5043
|
+
<dl>
|
|
5044
|
+
<dd>
|
|
5045
|
+
|
|
5046
|
+
#### 📝 Description
|
|
5047
|
+
|
|
5048
|
+
<dl>
|
|
5049
|
+
<dd>
|
|
5050
|
+
|
|
5051
|
+
<dl>
|
|
5052
|
+
<dd>
|
|
5053
|
+
|
|
5054
|
+
Retrieve all checklist items for a specific drawdown
|
|
5055
|
+
</dd>
|
|
5056
|
+
</dl>
|
|
5057
|
+
</dd>
|
|
5058
|
+
</dl>
|
|
5059
|
+
|
|
5060
|
+
#### 🔌 Usage
|
|
5061
|
+
|
|
5062
|
+
<dl>
|
|
5063
|
+
<dd>
|
|
5064
|
+
|
|
5065
|
+
<dl>
|
|
5066
|
+
<dd>
|
|
5067
|
+
|
|
5068
|
+
```ruby
|
|
5069
|
+
client.drawdowns.list_drawdown_checklists(drawdown_id: "drawdown_id")
|
|
5070
|
+
```
|
|
5071
|
+
</dd>
|
|
5072
|
+
</dl>
|
|
5073
|
+
</dd>
|
|
5074
|
+
</dl>
|
|
5075
|
+
|
|
5076
|
+
#### ⚙️ Parameters
|
|
5077
|
+
|
|
5078
|
+
<dl>
|
|
5079
|
+
<dd>
|
|
5080
|
+
|
|
5081
|
+
<dl>
|
|
5082
|
+
<dd>
|
|
5083
|
+
|
|
5084
|
+
**drawdown_id:** `String`
|
|
5085
|
+
|
|
5086
|
+
</dd>
|
|
5087
|
+
</dl>
|
|
5088
|
+
|
|
5089
|
+
<dl>
|
|
5090
|
+
<dd>
|
|
5091
|
+
|
|
5092
|
+
**page:** `Integer`
|
|
5093
|
+
|
|
5094
|
+
</dd>
|
|
5095
|
+
</dl>
|
|
5096
|
+
|
|
5097
|
+
<dl>
|
|
5098
|
+
<dd>
|
|
5099
|
+
|
|
5100
|
+
**page_size:** `Integer`
|
|
5101
|
+
|
|
5102
|
+
</dd>
|
|
5103
|
+
</dl>
|
|
5104
|
+
|
|
5105
|
+
<dl>
|
|
5106
|
+
<dd>
|
|
5107
|
+
|
|
5108
|
+
**order_by:** `String` — Field to order the results by, e.g., 'created_at:desc,updated_at:asc'
|
|
5109
|
+
|
|
5110
|
+
</dd>
|
|
5111
|
+
</dl>
|
|
5112
|
+
|
|
5113
|
+
<dl>
|
|
5114
|
+
<dd>
|
|
5115
|
+
|
|
5116
|
+
**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: . Supported operators: is, in, not_in, contains, not_contains, like, not_like, ilike, not_ilike, gt, gte, lt, lte, starts_with, ends_with, is_null, is_not_null.
|
|
5117
|
+
|
|
5118
|
+
</dd>
|
|
5119
|
+
</dl>
|
|
5120
|
+
|
|
5121
|
+
<dl>
|
|
5122
|
+
<dd>
|
|
5123
|
+
|
|
5124
|
+
**request_options:** `Voltaria::Drawdowns::RequestOptions`
|
|
5125
|
+
|
|
5126
|
+
</dd>
|
|
5127
|
+
</dl>
|
|
5128
|
+
</dd>
|
|
5129
|
+
</dl>
|
|
5130
|
+
|
|
5131
|
+
|
|
5132
|
+
</dd>
|
|
5133
|
+
</dl>
|
|
5134
|
+
</details>
|
|
5135
|
+
|