ultracart_rest_api_v2_typescript 4.0.181 → 4.0.182

package/.openapi-generator/FILES

@@ -22,6 +22,7 @@ src/apis/StorefrontApi.ts
 src/apis/TaxApi.ts
 src/apis/UserApi.ts
 src/apis/WebhookApi.ts
+src/apis/WorkflowApi.ts
 src/apis/index.ts
 src/index.ts
 src/models/AccountsReceivableRetryConfig.ts
@@ -805,6 +806,19 @@ src/models/WebhookSampleRequest.ts
 src/models/WebhookSampleRequestResponse.ts
 src/models/WebhooksResponse.ts
 src/models/Weight.ts
+src/models/WorkflowAttachment.ts
+src/models/WorkflowAttachmentUploadUrl.ts
+src/models/WorkflowAttachmentUploadUrlResponse.ts
+src/models/WorkflowGroup.ts
+src/models/WorkflowGroupsResponse.ts
+src/models/WorkflowNote.ts
+src/models/WorkflowTask.ts
+src/models/WorkflowTaskHistory.ts
+src/models/WorkflowTaskResponse.ts
+src/models/WorkflowTasksRequest.ts
+src/models/WorkflowTasksResponse.ts
+src/models/WorkflowUser.ts
+src/models/WorkflowUsersResponse.ts
 src/models/index.ts
 src/runtime.ts
 tsconfig.json

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.181
+## ultracart_rest_api_v2_typescript@4.0.182
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.0.181 --save
+npm install ultracart_rest_api_v2_typescript@4.0.182 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.182 | 10/23/2023 | workflow tasks api |
 | 4.0.181 | 10/23/2023 | workflow tasks api |
 | 4.0.180 | 10/16/2023 | CartSettingsPaymentCreditCard - add collect_credit_card_verification_number_minimum |
 | 4.0.179 | 09/28/2023 | dw bi - add aggregation constant of none |

package/dist/apis/WorkflowApi.d.ts

@@ -0,0 +1,256 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import { WorkflowAttachmentUploadUrlResponse, WorkflowGroupsResponse, WorkflowTask, WorkflowTaskResponse, WorkflowTasksRequest, WorkflowTasksResponse, WorkflowUsersResponse } from '../models';
+export interface GetWorkflowAssignmentGroupsRequest {
+    limit?: number;
+    offset?: number;
+}
+export interface GetWorkflowAssignmentUsersRequest {
+    limit?: number;
+    offset?: number;
+}
+export interface GetWorkflowTaskRequest {
+    taskUuid: string;
+}
+export interface GetWorkflowTaskAttachmentUploadUrlRequest {
+    extension: string;
+}
+export interface GetWorkflowTaskByObjectTypeRequest {
+    objectType: string;
+    objectId: string;
+}
+export interface GetWorkflowTasksRequest {
+    workflowTasksQuery: WorkflowTasksRequest;
+    limit?: number;
+    offset?: number;
+    sort?: string;
+}
+export interface InsertWorkflowTaskRequest {
+    workflowTask: WorkflowTask;
+}
+export interface UpdateWorkflowTaskRequest {
+    taskUuid: string;
+    workflowTask: WorkflowTask;
+}
+/**
+ * WorkflowApi - interface
+ *
+ * @export
+ * @interface WorkflowApiInterface
+ */
+export interface WorkflowApiInterface {
+    /**
+     * Retrieve a list of groups that workflow tasks can be assigned to
+     * @summary Retrieve a list of groups that workflow tasks can be assigned to
+     * @param {number} [limit] The maximum number of records to return on this one API call. (Max 200)
+     * @param {number} [offset] Pagination of the record set.  Offset is a zero based index.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApiInterface
+     */
+    getWorkflowAssignmentGroupsRaw(requestParameters: GetWorkflowAssignmentGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowGroupsResponse>>;
+    /**
+     * Retrieve a list of groups that workflow tasks can be assigned to
+     * Retrieve a list of groups that workflow tasks can be assigned to
+     */
+    getWorkflowAssignmentGroups(requestParameters: GetWorkflowAssignmentGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowGroupsResponse>;
+    /**
+     * Retrieve a list of users that workflow tasks can be assigned to
+     * @summary Retrieve a list of users that workflow tasks can be assigned to
+     * @param {number} [limit] The maximum number of records to return on this one API call. (Max 200)
+     * @param {number} [offset] Pagination of the record set.  Offset is a zero based index.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApiInterface
+     */
+    getWorkflowAssignmentUsersRaw(requestParameters: GetWorkflowAssignmentUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowUsersResponse>>;
+    /**
+     * Retrieve a list of users that workflow tasks can be assigned to
+     * Retrieve a list of users that workflow tasks can be assigned to
+     */
+    getWorkflowAssignmentUsers(requestParameters: GetWorkflowAssignmentUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowUsersResponse>;
+    /**
+     * Retrieve a workflow task
+     * @summary Retrieve a workflow task
+     * @param {string} taskUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApiInterface
+     */
+    getWorkflowTaskRaw(requestParameters: GetWorkflowTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowTaskResponse>>;
+    /**
+     * Retrieve a workflow task
+     * Retrieve a workflow task
+     */
+    getWorkflowTask(requestParameters: GetWorkflowTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTaskResponse>;
+    /**
+     * Get a presigned workflow task attachment upload URL
+     * @summary Get a presigned workflow task attachment upload URL
+     * @param {string} extension
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApiInterface
+     */
+    getWorkflowTaskAttachmentUploadUrlRaw(requestParameters: GetWorkflowTaskAttachmentUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowAttachmentUploadUrlResponse>>;
+    /**
+     * Get a presigned workflow task attachment upload URL
+     * Get a presigned workflow task attachment upload URL
+     */
+    getWorkflowTaskAttachmentUploadUrl(requestParameters: GetWorkflowTaskAttachmentUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowAttachmentUploadUrlResponse>;
+    /**
+     * Retrieve a workflow task by object type and id
+     * @summary Retrieve a workflow task by object type and id
+     * @param {string} objectType
+     * @param {string} objectId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApiInterface
+     */
+    getWorkflowTaskByObjectTypeRaw(requestParameters: GetWorkflowTaskByObjectTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowTaskResponse>>;
+    /**
+     * Retrieve a workflow task by object type and id
+     * Retrieve a workflow task by object type and id
+     */
+    getWorkflowTaskByObjectType(requestParameters: GetWorkflowTaskByObjectTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTaskResponse>;
+    /**
+     * Retrieves a set of workflow tasks from the account based on a query object.
+     * @summary Search workflow tasks
+     * @param {WorkflowTasksRequest} workflowTasksQuery Workflow tasks query
+     * @param {number} [limit] The maximum number of records to return on this one API call. (Default 100, Max 500)
+     * @param {number} [offset] Pagination of the record set.  Offset is a zero based index.
+     * @param {string} [sort] The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApiInterface
+     */
+    getWorkflowTasksRaw(requestParameters: GetWorkflowTasksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowTasksResponse>>;
+    /**
+     * Retrieves a set of workflow tasks from the account based on a query object.
+     * Search workflow tasks
+     */
+    getWorkflowTasks(requestParameters: GetWorkflowTasksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTasksResponse>;
+    /**
+     * Insert a workflow task
+     * @summary Insert a workflow task
+     * @param {WorkflowTask} workflowTask workflow task
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApiInterface
+     */
+    insertWorkflowTaskRaw(requestParameters: InsertWorkflowTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowTaskResponse>>;
+    /**
+     * Insert a workflow task
+     * Insert a workflow task
+     */
+    insertWorkflowTask(requestParameters: InsertWorkflowTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTaskResponse>;
+    /**
+     * Update a workflow task
+     * @summary Update a workflow task
+     * @param {string} taskUuid
+     * @param {WorkflowTask} workflowTask Workflow task
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApiInterface
+     */
+    updateWorkflowTaskRaw(requestParameters: UpdateWorkflowTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowTaskResponse>>;
+    /**
+     * Update a workflow task
+     * Update a workflow task
+     */
+    updateWorkflowTask(requestParameters: UpdateWorkflowTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTaskResponse>;
+}
+/**
+ *
+ */
+export declare class WorkflowApi extends runtime.BaseAPI implements WorkflowApiInterface {
+    /**
+     * Retrieve a list of groups that workflow tasks can be assigned to
+     * Retrieve a list of groups that workflow tasks can be assigned to
+     */
+    getWorkflowAssignmentGroupsRaw(requestParameters: GetWorkflowAssignmentGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowGroupsResponse>>;
+    /**
+     * Retrieve a list of groups that workflow tasks can be assigned to
+     * Retrieve a list of groups that workflow tasks can be assigned to
+     */
+    getWorkflowAssignmentGroups(requestParameters?: GetWorkflowAssignmentGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowGroupsResponse>;
+    /**
+     * Retrieve a list of users that workflow tasks can be assigned to
+     * Retrieve a list of users that workflow tasks can be assigned to
+     */
+    getWorkflowAssignmentUsersRaw(requestParameters: GetWorkflowAssignmentUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowUsersResponse>>;
+    /**
+     * Retrieve a list of users that workflow tasks can be assigned to
+     * Retrieve a list of users that workflow tasks can be assigned to
+     */
+    getWorkflowAssignmentUsers(requestParameters?: GetWorkflowAssignmentUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowUsersResponse>;
+    /**
+     * Retrieve a workflow task
+     * Retrieve a workflow task
+     */
+    getWorkflowTaskRaw(requestParameters: GetWorkflowTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowTaskResponse>>;
+    /**
+     * Retrieve a workflow task
+     * Retrieve a workflow task
+     */
+    getWorkflowTask(requestParameters: GetWorkflowTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTaskResponse>;
+    /**
+     * Get a presigned workflow task attachment upload URL
+     * Get a presigned workflow task attachment upload URL
+     */
+    getWorkflowTaskAttachmentUploadUrlRaw(requestParameters: GetWorkflowTaskAttachmentUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowAttachmentUploadUrlResponse>>;
+    /**
+     * Get a presigned workflow task attachment upload URL
+     * Get a presigned workflow task attachment upload URL
+     */
+    getWorkflowTaskAttachmentUploadUrl(requestParameters: GetWorkflowTaskAttachmentUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowAttachmentUploadUrlResponse>;
+    /**
+     * Retrieve a workflow task by object type and id
+     * Retrieve a workflow task by object type and id
+     */
+    getWorkflowTaskByObjectTypeRaw(requestParameters: GetWorkflowTaskByObjectTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowTaskResponse>>;
+    /**
+     * Retrieve a workflow task by object type and id
+     * Retrieve a workflow task by object type and id
+     */
+    getWorkflowTaskByObjectType(requestParameters: GetWorkflowTaskByObjectTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTaskResponse>;
+    /**
+     * Retrieves a set of workflow tasks from the account based on a query object.
+     * Search workflow tasks
+     */
+    getWorkflowTasksRaw(requestParameters: GetWorkflowTasksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowTasksResponse>>;
+    /**
+     * Retrieves a set of workflow tasks from the account based on a query object.
+     * Search workflow tasks
+     */
+    getWorkflowTasks(requestParameters: GetWorkflowTasksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTasksResponse>;
+    /**
+     * Insert a workflow task
+     * Insert a workflow task
+     */
+    insertWorkflowTaskRaw(requestParameters: InsertWorkflowTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowTaskResponse>>;
+    /**
+     * Insert a workflow task
+     * Insert a workflow task
+     */
+    insertWorkflowTask(requestParameters: InsertWorkflowTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTaskResponse>;
+    /**
+     * Update a workflow task
+     * Update a workflow task
+     */
+    updateWorkflowTaskRaw(requestParameters: UpdateWorkflowTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowTaskResponse>>;
+    /**
+     * Update a workflow task
+     * Update a workflow task
+     */
+    updateWorkflowTask(requestParameters: UpdateWorkflowTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTaskResponse>;
+}