voltaria_sdk 2.34.7 → 2.35.0

data/reference.md

@@ -700,6 +700,100 @@ client.clients.reject_onboarding(client_id: "client_id")
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.clients.<a href="/lib/voltaria/clients/client.rb">list_client_portal_users</a>(client_id) -> Voltaria::Types::PaginatedResponseClientUserResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Paginated list of portal users belonging to a client.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.clients.list_client_portal_users(client_id: "client_id")
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**client_id:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**page:** `Integer` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**page_size:** `Integer` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**order_by:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: id, email, status, first_name, last_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.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Voltaria::Clients::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -1557,7 +1651,293 @@ client.accounts.create_client_account(
 <dl>
 <dd>
 
-**currency:** `Voltaria::Types::CurrencyEnum` — ISO 4217 currency code. Use `/accounts/fields` to get required fields per currency.
+**currency:** `Voltaria::Types::CurrencyEnum` — ISO 4217 currency code. Use `/accounts/fields` to get required fields per currency.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**sort_code:** `String` — Sort code (required for GBP).
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**account_number:** `String` — Account number (required for GBP and USD).
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**iban:** `String` — IBAN (required for EUR, CZK, PLN).
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**bic:** `String` — BIC / SWIFT code (optional for EUR).
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**routing_number:** `String` — ABA routing number (required for USD).
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**account_type:** `String` — Account type (required for USD). E.g. `checking` or `savings`.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**address:** `Voltaria::Types::AccountAddress` — Account holder address (required for USD).
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**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`.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Voltaria::Accounts::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<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>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve a specific bank account for one of your clients.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.accounts.get_client_account(
+  client_id: "client_id",
+  account_id: "account_id"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**client_id:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**account_id:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Voltaria::Accounts::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+## Collections
+<details><summary><code>client.collections.<a href="/lib/voltaria/collections/client.rb">list_collection_actions</a>() -> Voltaria::Types::PaginatedResponseCollectionActionResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve all collection actions configured for your partner account.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.collections.list_collection_actions
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**page:** `Integer` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**page_size:** `Integer` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**order_by:** `String` — Field to order the results by, e.g., 'created_at:desc,updated_at:asc'
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: id, name, action_type, is_active, timing. 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.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Voltaria::Collections::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.collections.<a href="/lib/voltaria/collections/client.rb">list_collection_action_logs</a>() -> Voltaria::Types::PaginatedResponseCollectionActionLogResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve collection action logs for your partner account. Supports filtering by client, loan, installment, status, or action type.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.collections.list_collection_action_logs
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**client_id:** `String` 
     
 </dd>
 </dl>
@@ -1565,7 +1945,7 @@ client.accounts.create_client_account(
 <dl>
 <dd>
 
-**sort_code:** `String` — Sort code (required for GBP).
+**loan_id:** `String` 
     
 </dd>
 </dl>
@@ -1573,7 +1953,7 @@ client.accounts.create_client_account(
 <dl>
 <dd>
 
-**account_number:** `String` — Account number (required for GBP and USD).
+**installment_id:** `String` 
     
 </dd>
 </dl>
@@ -1581,7 +1961,7 @@ client.accounts.create_client_account(
 <dl>
 <dd>
 
-**iban:** `String` — IBAN (required for EUR, CZK, PLN).
+**status:** `Voltaria::Types::CollectionActionStatusEnum` 
     
 </dd>
 </dl>
@@ -1589,7 +1969,7 @@ client.accounts.create_client_account(
 <dl>
 <dd>
 
-**bic:** `String` — BIC / SWIFT code (optional for EUR).
+**action_type:** `Voltaria::Types::CollectionActionTypeEnum` 
     
 </dd>
 </dl>
@@ -1597,7 +1977,7 @@ client.accounts.create_client_account(
 <dl>
 <dd>
 
-**routing_number:** `String` — ABA routing number (required for USD).
+**page:** `Integer` 
     
 </dd>
 </dl>
@@ -1605,7 +1985,7 @@ client.accounts.create_client_account(
 <dl>
 <dd>
 
-**account_type:** `String` — Account type (required for USD). E.g. `checking` or `savings`.
+**page_size:** `Integer` 
     
 </dd>
 </dl>
@@ -1613,7 +1993,7 @@ client.accounts.create_client_account(
 <dl>
 <dd>
 
-**address:** `Voltaria::Types::AccountAddress` — Account holder address (required for USD).
+**order_by:** `String` — Field to order the results by, e.g., 'created_at:desc,updated_at:asc'
     
 </dd>
 </dl>
@@ -1621,7 +2001,7 @@ client.accounts.create_client_account(
 <dl>
 <dd>
 
-**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`.
+**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: id, collection_action_id, action_type, status, client_id, loan_id, installment_id, scheduled_for. 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.
     
 </dd>
 </dl>
@@ -1629,7 +2009,7 @@ client.accounts.create_client_account(
 <dl>
 <dd>
 
-**request_options:** `Voltaria::Accounts::RequestOptions` 
+**request_options:** `Voltaria::Collections::RequestOptions` 
     
 </dd>
 </dl>
@@ -1641,7 +2021,7 @@ client.accounts.create_client_account(
 </dl>
 </details>
 
-<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>
+<details><summary><code>client.collections.<a href="/lib/voltaria/collections/client.rb">update_collection_action_log</a>(log_id, request) -> Voltaria::Types::CollectionActionLogResponse</code></summary>
 <dl>
 <dd>
 
@@ -1653,7 +2033,7 @@ client.accounts.create_client_account(
 <dl>
 <dd>
 
-Retrieve a specific bank account for one of your clients.
+Update the status and notes of a collection action log.
 </dd>
 </dl>
 </dd>
@@ -1668,9 +2048,9 @@ Retrieve a specific bank account for one of your clients.
 <dd>
 
 ```ruby
-client.accounts.get_client_account(
-  client_id: "client_id",
-  account_id: "account_id"
+client.collections.update_collection_action_log(
+  log_id: "log_id",
+  status: "completed"
 )
 ```
 </dd>
@@ -1686,7 +2066,7 @@ client.accounts.get_client_account(
 <dl>
 <dd>
 
-**client_id:** `String` 
+**log_id:** `String` 
     
 </dd>
 </dl>
@@ -1694,7 +2074,7 @@ client.accounts.get_client_account(
 <dl>
 <dd>
 
-**account_id:** `String` 
+**status:** `Voltaria::Collections::Types::CollectionActionLogUpdatePayloadStatus` — The updated status of the action: 'completed' or 'failed'
     
 </dd>
 </dl>
@@ -1702,7 +2082,15 @@ client.accounts.get_client_account(
 <dl>
 <dd>
 
-**request_options:** `Voltaria::Accounts::RequestOptions` 
+**notes:** `String` — Notes about this action
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Voltaria::Collections::RequestOptions` 
     
 </dd>
 </dl>
@@ -3257,6 +3645,240 @@ client.installments.delete_installment(installment_id: "installment_id")
 </details>
 
 ## Loans
+<details><summary><code>client.loans.<a href="/lib/voltaria/loans/client.rb">list_loan_review_requests</a>() -> Voltaria::Types::PaginatedResponseLoanReviewRequestResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+List loan review requests for your partner account, optionally filtered by loan ID or client ID.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.loans.list_loan_review_requests
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**loan_id:** `String` — Filter by loan ID
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**client_id:** `String` — Filter by client ID
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**page:** `Integer` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**page_size:** `Integer` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**order_by:** `String` — Field to order the results by, e.g., 'created_at:desc,updated_at:asc'
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: id, loan_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.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Voltaria::Loans::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.loans.<a href="/lib/voltaria/loans/client.rb">create_loan_review_request</a>(request) -> Voltaria::Types::LoanReviewRequestResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Ask Voltaria to review a not-yet-disbursed (pending or pre-approved) loan before disbursement.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.loans.create_loan_review_request(loan_id: "loan_1234567890abcdef")
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**loan_id:** `String` — The ID of the loan to be reviewed. Must be a not-yet-disbursed (pending or pre-approved) loan belonging to the current partner
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**notes:** `String` — Optional note from the requester explaining the review request
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Voltaria::Loans::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.loans.<a href="/lib/voltaria/loans/client.rb">get_loan_review_request</a>(request_id) -> Voltaria::Types::LoanReviewRequestResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve a specific loan review request by its ID.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.loans.get_loan_review_request(request_id: "request_id")
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request_id:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Voltaria::Loans::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.loans.<a href="/lib/voltaria/loans/client.rb">list_loans</a>() -> Voltaria::Types::PaginatedResponseLoanResponseWithClientInfo</code></summary>
 <dl>
 <dd>