# Tasks ## Overview ### Available Operations * [listTasks](#listtasks) - List tasks * [getTaskResult](#gettaskresult) - Get task processing result * [getTask](#gettask) - Get a task * [downloadTaskExport](#downloadtaskexport) - Download task export file * [updateTaskStatus](#updatetaskstatus) - Update task status ## listTasks Use when listing or searching async tasks (e.g. admin queue view). Returns list with optional filtering. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.tasks.listTasks(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { tasksListTasks } from "@flexprice/sdk/funcs/tasks-list-tasks.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await tasksListTasks(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("tasksListTasks failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [models.ListTasksRequest](../../sdk/models/list-tasks-request.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ListTasksResponse](../../sdk/models/list-tasks-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## getTaskResult Use when fetching the outcome of a completed task (e.g. export URL or error message). Call after task status is complete. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.tasks.getTaskResult(""); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { tasksGetTaskResult } from "@flexprice/sdk/funcs/tasks-get-task-result.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await tasksGetTaskResult(flexprice, ""); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("tasksGetTaskResult failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `workflowId` | *string* | :heavy_check_mark: | Workflow ID | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ModelsTemporalWorkflowResult](../../sdk/models/models-temporal-workflow-result.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400, 404 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## getTask Use when checking task status or progress (e.g. polling after create). Returns task by ID. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.tasks.getTask(""); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { tasksGetTask } from "@flexprice/sdk/funcs/tasks-get-task.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await tasksGetTask(flexprice, ""); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("tasksGetTask failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Task ID | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.TaskResponse](../../sdk/models/task-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400, 404 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## downloadTaskExport Use when letting a user download an exported file (e.g. report or data export). Returns a presigned URL; supports FlexPrice or customer-owned S3. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.tasks.downloadTaskExport(""); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { tasksDownloadTaskExport } from "@flexprice/sdk/funcs/tasks-download-task-export.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await tasksDownloadTaskExport(flexprice, ""); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("tasksDownloadTaskExport failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Task ID | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[{ [k: string]: string }](../../models/.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400, 404 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## updateTaskStatus Use when updating task status (e.g. marking complete or failed from a worker). Typically called by backend processors. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.tasks.updateTaskStatus("", { taskStatus: "PROCESSING", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { tasksUpdateTaskStatus } from "@flexprice/sdk/funcs/tasks-update-task-status.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await tasksUpdateTaskStatus(flexprice, "", { taskStatus: "PROCESSING", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("tasksUpdateTaskStatus failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Task ID | | `body` | [models.UpdateTaskStatusRequest](../../sdk/models/update-task-status-request.md) | :heavy_check_mark: | Status update | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.SuccessResponse](../../sdk/models/success-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400, 404 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* |