@emilgroup/task-sdk-node 1.0.1-beta.1 → 1.0.1-beta.10

package/dist/api/tasks-api.d.ts

@@ -16,8 +16,8 @@ import { CreateTaskRequestDto } from '../models';
 import { CreateTaskResponseClass } from '../models';
 import { GetTaskResponseClass } from '../models';
 import { ListTasksResponseClass } from '../models';
-import { UpdateTaskRequestDto } from '../models';
-import { UpdateTaskResponseClass } from '../models';
+import { PatchTaskRequestDto } from '../models';
+import { PatchTaskResponseClass } from '../models';
 /**
  * TasksApi - axios parameter creator
  * @export
@@ -33,7 +33,7 @@ export declare const TasksApiAxiosParamCreator: (configuration?: Configuration)
      */
     createTask: (createTaskRequestDto: CreateTaskRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * This will delete task.
+     * This will delete a task by code.
      * @summary Delete the task
      * @param {string} code Unique identifier for the object.
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -42,7 +42,7 @@ export declare const TasksApiAxiosParamCreator: (configuration?: Configuration)
      */
     deleteTask: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * This will get task.
+     * This will get a task by code.
      * @summary Retrieve the task
      * @param {string} code
      * @param {string} expand
@@ -55,24 +55,27 @@ export declare const TasksApiAxiosParamCreator: (configuration?: Configuration)
      * Retrieves a list of tasks.
      * @summary List tasks
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
-     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
-     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
-     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: category, status, priority&lt;i&gt;
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {string} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: subject, description&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt, updatedAt, assignee, reporter, dueDate&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: categories, status&lt;i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listTasks: (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    listTasks: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * This will update task.
+     * This will partially update a task by code with the provided fields.
      * @summary Update the task
      * @param {string} code
-     * @param {UpdateTaskRequestDto} updateTaskRequestDto
+     * @param {PatchTaskRequestDto} patchTaskRequestDto
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updateTask: (code: string, updateTaskRequestDto: UpdateTaskRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    patchTask: (code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * TasksApi - functional programming interface
@@ -89,7 +92,7 @@ export declare const TasksApiFp: (configuration?: Configuration) => {
      */
     createTask(createTaskRequestDto: CreateTaskRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTaskResponseClass>>;
     /**
-     * This will delete task.
+     * This will delete a task by code.
      * @summary Delete the task
      * @param {string} code Unique identifier for the object.
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -98,7 +101,7 @@ export declare const TasksApiFp: (configuration?: Configuration) => {
      */
     deleteTask(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * This will get task.
+     * This will get a task by code.
      * @summary Retrieve the task
      * @param {string} code
      * @param {string} expand
@@ -111,24 +114,27 @@ export declare const TasksApiFp: (configuration?: Configuration) => {
      * Retrieves a list of tasks.
      * @summary List tasks
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
-     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
-     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
-     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: category, status, priority&lt;i&gt;
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {string} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: subject, description&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt, updatedAt, assignee, reporter, dueDate&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: categories, status&lt;i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listTasks(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTasksResponseClass>>;
+    listTasks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTasksResponseClass>>;
     /**
-     * This will update task.
+     * This will partially update a task by code with the provided fields.
      * @summary Update the task
      * @param {string} code
-     * @param {UpdateTaskRequestDto} updateTaskRequestDto
+     * @param {PatchTaskRequestDto} patchTaskRequestDto
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updateTask(code: string, updateTaskRequestDto: UpdateTaskRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateTaskResponseClass>>;
+    patchTask(code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchTaskResponseClass>>;
 };
 /**
  * TasksApi - factory interface
@@ -145,7 +151,7 @@ export declare const TasksApiFactory: (configuration?: Configuration, basePath?:
      */
     createTask(createTaskRequestDto: CreateTaskRequestDto, authorization?: string, options?: any): AxiosPromise<CreateTaskResponseClass>;
     /**
-     * This will delete task.
+     * This will delete a task by code.
      * @summary Delete the task
      * @param {string} code Unique identifier for the object.
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -154,7 +160,7 @@ export declare const TasksApiFactory: (configuration?: Configuration, basePath?:
      */
     deleteTask(code: string, authorization?: string, options?: any): AxiosPromise<void>;
     /**
-     * This will get task.
+     * This will get a task by code.
      * @summary Retrieve the task
      * @param {string} code
      * @param {string} expand
@@ -167,24 +173,27 @@ export declare const TasksApiFactory: (configuration?: Configuration, basePath?:
      * Retrieves a list of tasks.
      * @summary List tasks
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
-     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
-     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
-     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: category, status, priority&lt;i&gt;
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {string} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: subject, description&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt, updatedAt, assignee, reporter, dueDate&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: categories, status&lt;i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listTasks(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListTasksResponseClass>;
+    listTasks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTasksResponseClass>;
     /**
-     * This will update task.
+     * This will partially update a task by code with the provided fields.
      * @summary Update the task
      * @param {string} code
-     * @param {UpdateTaskRequestDto} updateTaskRequestDto
+     * @param {PatchTaskRequestDto} patchTaskRequestDto
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updateTask(code: string, updateTaskRequestDto: UpdateTaskRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateTaskResponseClass>;
+    patchTask(code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: any): AxiosPromise<PatchTaskResponseClass>;
 };
 /**
  * Request parameters for createTask operation in TasksApi.
@@ -262,52 +271,70 @@ export interface TasksApiListTasksRequest {
      */
     readonly authorization?: string;
     /**
-     * Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof TasksApiListTasks
+     */
+    readonly pageSize?: number;
+    /**
+     * A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @type {string}
+     * @memberof TasksApiListTasks
+     */
+    readonly pageToken?: string;
+    /**
+     * Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
      * @type {string}
      * @memberof TasksApiListTasks
      */
     readonly filter?: string;
     /**
-     * Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
+     * Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: subject, description&lt;/i&gt;
      * @type {string}
      * @memberof TasksApiListTasks
      */
-    readonly filters?: string;
+    readonly search?: string;
     /**
-     * Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
+     * Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt, updatedAt, assignee, reporter, dueDate&lt;/i&gt;
      * @type {string}
      * @memberof TasksApiListTasks
      */
     readonly order?: string;
     /**
-     * Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: category, status, priority&lt;i&gt;
+     * Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: categories, status&lt;i&gt;
      * @type {string}
      * @memberof TasksApiListTasks
      */
     readonly expand?: string;
+    /**
+     * Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
+     * @type {string}
+     * @memberof TasksApiListTasks
+     */
+    readonly filters?: string;
 }
 /**
- * Request parameters for updateTask operation in TasksApi.
+ * Request parameters for patchTask operation in TasksApi.
  * @export
- * @interface TasksApiUpdateTaskRequest
+ * @interface TasksApiPatchTaskRequest
  */
-export interface TasksApiUpdateTaskRequest {
+export interface TasksApiPatchTaskRequest {
     /**
      *
      * @type {string}
-     * @memberof TasksApiUpdateTask
+     * @memberof TasksApiPatchTask
      */
     readonly code: string;
     /**
      *
-     * @type {UpdateTaskRequestDto}
-     * @memberof TasksApiUpdateTask
+     * @type {PatchTaskRequestDto}
+     * @memberof TasksApiPatchTask
      */
-    readonly updateTaskRequestDto: UpdateTaskRequestDto;
+    readonly patchTaskRequestDto: PatchTaskRequestDto;
     /**
      * Bearer Token: provided by the login endpoint under the name accessToken.
      * @type {string}
-     * @memberof TasksApiUpdateTask
+     * @memberof TasksApiPatchTask
      */
     readonly authorization?: string;
 }
@@ -328,7 +355,7 @@ export declare class TasksApi extends BaseAPI {
      */
     createTask(requestParameters: TasksApiCreateTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTaskResponseClass, any, {}>>;
     /**
-     * This will delete task.
+     * This will delete a task by code.
      * @summary Delete the task
      * @param {TasksApiDeleteTaskRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -337,7 +364,7 @@ export declare class TasksApi extends BaseAPI {
      */
     deleteTask(requestParameters: TasksApiDeleteTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
-     * This will get task.
+     * This will get a task by code.
      * @summary Retrieve the task
      * @param {TasksApiGetTaskRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -355,12 +382,12 @@ export declare class TasksApi extends BaseAPI {
      */
     listTasks(requestParameters?: TasksApiListTasksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTasksResponseClass, any, {}>>;
     /**
-     * This will update task.
+     * This will partially update a task by code with the provided fields.
      * @summary Update the task
-     * @param {TasksApiUpdateTaskRequest} requestParameters Request parameters.
+     * @param {TasksApiPatchTaskRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof TasksApi
      */
-    updateTask(requestParameters: TasksApiUpdateTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateTaskResponseClass, any, {}>>;
+    patchTask(requestParameters: TasksApiPatchTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchTaskResponseClass, any, {}>>;
 }