voltaria_sdk 2.41.0 → 2.43.0

data/lib/voltaria.rb

@@ -45,6 +45,7 @@ require_relative "voltaria/loans/types/loan_create_payload_amount"
 require_relative "voltaria/loans/types/loan_default_payload_sold_amount"
 require_relative "voltaria/recoveries/types/recovery_create_payload_amount"
 require_relative "voltaria/repayments/types/repayment_create_payload_amount"
+require_relative "voltaria/tasks/types/task_partner_status_update_payload_status"
 require_relative "voltaria/drawdowns/types/drawdown_create_payload_amount"
 require_relative "voltaria/types/account_address"
 require_relative "voltaria/types/account_holder_type_enum"
@@ -68,6 +69,7 @@ require_relative "voltaria/types/bulk_repayment_task_response"
 require_relative "voltaria/types/bulk_repayment_task_status"
 require_relative "voltaria/types/checklist_type_enum"
 require_relative "voltaria/types/checklist_summary_partner_response"
+require_relative "voltaria/types/cop_status_enum"
 require_relative "voltaria/types/client_account_response"
 require_relative "voltaria/types/client_status_enum"
 require_relative "voltaria/types/client_type_enum"
@@ -108,6 +110,7 @@ require_relative "voltaria/types/loan_response_with_client_info"
 require_relative "voltaria/types/loan_response_with_installments"
 require_relative "voltaria/types/loan_review_request_status_enum"
 require_relative "voltaria/types/loan_review_request_response"
+require_relative "voltaria/types/note_response"
 require_relative "voltaria/types/paginated_response_checklist_summary_partner_response"
 require_relative "voltaria/types/paginated_response_client_account_response"
 require_relative "voltaria/types/paginated_response_client_investor_response"
@@ -123,6 +126,7 @@ require_relative "voltaria/types/paginated_response_limit_request_response"
 require_relative "voltaria/types/paginated_response_loan_investor_response"
 require_relative "voltaria/types/paginated_response_loan_response_with_client_info"
 require_relative "voltaria/types/paginated_response_loan_review_request_response"
+require_relative "voltaria/types/paginated_response_note_response"
 require_relative "voltaria/types/payment_promise_status_enum"
 require_relative "voltaria/types/payment_promise_response"
 require_relative "voltaria/types/paginated_response_payment_promise_response"
@@ -130,6 +134,13 @@ require_relative "voltaria/types/recovery_response"
 require_relative "voltaria/types/paginated_response_recovery_response"
 require_relative "voltaria/types/repayment_response_with_client_info"
 require_relative "voltaria/types/paginated_response_repayment_response_with_client_info"
+require_relative "voltaria/types/task_priority_enum"
+require_relative "voltaria/types/task_status_enum"
+require_relative "voltaria/types/task_partner_response"
+require_relative "voltaria/types/paginated_response_task_partner_response"
+require_relative "voltaria/types/task_public_actor_type_enum"
+require_relative "voltaria/types/task_partner_status_history_response"
+require_relative "voltaria/types/paginated_response_task_partner_status_history_response"
 require_relative "voltaria/types/waiver_status_enum"
 require_relative "voltaria/types/waiver_response"
 require_relative "voltaria/types/paginated_response_waiver_response"
@@ -226,6 +237,14 @@ require_relative "voltaria/repayments/types/list_repayment_logs_request"
 require_relative "voltaria/repayments/types/repayment_create_payload"
 require_relative "voltaria/repayments/types/bulk_repayment_create_payload"
 require_relative "voltaria/repayments/types/get_bulk_repayment_status_request"
+require_relative "voltaria/tasks/client"
+require_relative "voltaria/tasks/types/list_tasks_request"
+require_relative "voltaria/tasks/types/task_partner_create_payload"
+require_relative "voltaria/tasks/types/get_task_request"
+require_relative "voltaria/tasks/types/task_partner_status_update_payload"
+require_relative "voltaria/tasks/types/list_task_status_history_request"
+require_relative "voltaria/tasks/types/list_task_notes_request"
+require_relative "voltaria/tasks/types/task_note_create_payload"
 require_relative "voltaria/drawdowns/client"
 require_relative "voltaria/drawdowns/types/list_drawdowns_request"
 require_relative "voltaria/drawdowns/types/drawdown_create_payload"

data/reference.md

@@ -5772,6 +5772,639 @@ client.repayments.get_bulk_repayment_status(task_id: "task_id")
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Tasks
+<details><summary><code>client.tasks.<a href="/lib/voltaria/tasks/client.rb">list_tasks</a>() -> Voltaria::Types::PaginatedResponseTaskPartnerResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Paginated list of the tasks shared with your partner account, optionally filtered by status or by the client, loan, installment or waterfall they relate to.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.tasks.list_tasks
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**status:** `Voltaria::Types::TaskStatusEnum` — Filter by task status.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**client_id:** `String` — Filter by client.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**loan_id:** `String` — Filter by loan.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**installment_id:** `String` — Filter by installment.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**waterfall_id:** `String` — Filter by waterfall.
+    
+</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., 'due_at:asc,created_at:desc'.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: id, status, priority, due_at, created_at, client_id, loan_id, installment_id, waterfall_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.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Voltaria::Tasks::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.tasks.<a href="/lib/voltaria/tasks/client.rb">create_task</a>(request) -> Voltaria::Types::TaskPartnerResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Open a task for your partner account. Any entity you link to it must belong to you.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.tasks.create_task(title: "Send updated bank statement")
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**title:** `String` — Short title of the task.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**description:** `String` — Optional longer description of what needs to be done.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**priority:** `Voltaria::Types::TaskPriorityEnum` — Task priority. One of the following: low, medium, high, urgent
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**due_at:** `String` — Optional due date for the task.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**client_id:** `String` — Client this task relates to. Must belong to your partner account.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**loan_id:** `String` — Loan this task relates to. Must belong to your partner account.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**installment_id:** `String` — Installment this task relates to. Must belong to your partner account.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**waterfall_id:** `String` — Waterfall this task relates to. Must belong to your partner account.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Voltaria::Tasks::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.tasks.<a href="/lib/voltaria/tasks/client.rb">get_task</a>(task_id) -> Voltaria::Types::TaskPartnerResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve one of your tasks by its ID.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.tasks.get_task(task_id: "task_id")
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**task_id:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Voltaria::Tasks::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.tasks.<a href="/lib/voltaria/tasks/client.rb">update_task_status</a>(task_id, request) -> Voltaria::Types::TaskPartnerResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Move one of your tasks to another status. Status is the only field you can change. Requires a signed-in user — API keys cannot change a task.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.tasks.update_task_status(
+  task_id: "task_id",
+  status: "active"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**task_id:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**status:** `Voltaria::Tasks::Types::TaskPartnerStatusUpdatePayloadStatus` — The new status of the task. One of the following: active, in_progress, blocked, done. You can move a task to any of these at any time, so one closed by mistake can be reopened. Every change is kept in the task's status history.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Voltaria::Tasks::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.tasks.<a href="/lib/voltaria/tasks/client.rb">list_task_status_history</a>(task_id) -> Voltaria::Types::PaginatedResponseTaskPartnerStatusHistoryResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+The status transitions of one of your tasks, and whether each one was made by your team or by Voltaria support.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.tasks.list_task_status_history(task_id: "task_id")
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**task_id:** `String` 
+    
+</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:asc'. Defaults to 'created_at:desc'.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Voltaria::Tasks::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.tasks.<a href="/lib/voltaria/tasks/client.rb">list_task_notes</a>(task_id) -> Voltaria::Types::PaginatedResponseNoteResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Notes exchanged with Voltaria on one of your tasks.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.tasks.list_task_notes(task_id: "task_id")
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**task_id:** `String` 
+    
+</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'. Defaults to 'created_at:desc'.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**q:** `String` — Query string for filtering. Format: "field:operator:value;...". Supported fields: id, loan_id, installment_id, 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.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Voltaria::Tasks::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.tasks.<a href="/lib/voltaria/tasks/client.rb">create_task_note</a>(task_id, request) -> Voltaria::Types::NoteResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Add a note to one of your tasks. Requires a signed-in user — API keys cannot write notes, because a note needs an author.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.tasks.create_task_note(
+  task_id: "task_id",
+  content: "Statement uploaded, please re-check."
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**task_id:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**content:** `String` — The note content.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Voltaria::Tasks::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>