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

package/api/statuses-api.ts

@@ -29,9 +29,9 @@ import { GetStatusResponseClass } from '../models';
 // @ts-ignore
 import { ListStatusesResponseClass } from '../models';
 // @ts-ignore
-import { UpdateStatusRequestDto } from '../models';
+import { PatchStatusRequestDto } from '../models';
 // @ts-ignore
-import { UpdateStatusResponseClass } from '../models';
+import { PatchStatusResponseClass } from '../models';
 // URLSearchParams not necessarily used
 // @ts-ignore
 import { URL, URLSearchParams } from 'url';
@@ -43,7 +43,7 @@ const FormData = require('form-data');
 export const StatusesApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * This will create status.
+         * This will create a status.
          * @summary Create the status
          * @param {CreateStatusRequestDto} createStatusRequestDto 
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -135,7 +135,7 @@ export const StatusesApiAxiosParamCreator = function (configuration?: Configurat
             };
         },
         /**
-         * This will get status.
+         * Get status by code.
          * @summary Retrieve the status
          * @param {string} code 
          * @param {string} expand 
@@ -190,14 +190,15 @@ export const StatusesApiAxiosParamCreator = function (configuration?: Configurat
          * Retrieves a list of statuses.
          * @summary List statuses
          * @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.<br/>           <br/>           <i>Allowed values: id, code, createdAt</i>
-         * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, createdAt</i>
-         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: createdAt</i>
+         * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>           <br/>           <i>Allowed values: id, code, slug, name, createdAt, updatedAt</i>
+         * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, slug, name, createdAt, updatedAt</i>
+         * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.<br/>           <br/>           <i>Searchable fields: id, code, name, slug</i>
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: id, createdAt, updatedAt, name, slug</i>
          * @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.<br/>       <br/>       
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listStatuses: async (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listStatuses: async (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             const localVarPath = `/taskservice/v1/statuses`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -224,6 +225,10 @@ export const StatusesApiAxiosParamCreator = function (configuration?: Configurat
                 localVarQueryParameter['filters'] = filters;
             }
 
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
             if (order !== undefined) {
                 localVarQueryParameter['order'] = order;
             }
@@ -248,19 +253,19 @@ export const StatusesApiAxiosParamCreator = function (configuration?: Configurat
             };
         },
         /**
-         * This will update status.
+         * This will partially update a status by code with the provided fields.
          * @summary Update the status
          * @param {string} code 
-         * @param {UpdateStatusRequestDto} updateStatusRequestDto 
+         * @param {PatchStatusRequestDto} patchStatusRequestDto 
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        updateStatus: async (code: string, updateStatusRequestDto: UpdateStatusRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        patchStatus: async (code: string, patchStatusRequestDto: PatchStatusRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'code' is not null or undefined
-            assertParamExists('updateStatus', 'code', code)
-            // verify required parameter 'updateStatusRequestDto' is not null or undefined
-            assertParamExists('updateStatus', 'updateStatusRequestDto', updateStatusRequestDto)
+            assertParamExists('patchStatus', 'code', code)
+            // verify required parameter 'patchStatusRequestDto' is not null or undefined
+            assertParamExists('patchStatus', 'patchStatusRequestDto', patchStatusRequestDto)
             const localVarPath = `/taskservice/v1/statuses/{code}`
                 .replace(`{${"code"}}`, encodeURIComponent(String(code)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -272,7 +277,7 @@ export const StatusesApiAxiosParamCreator = function (configuration?: Configurat
                 baseAccessToken = configuration.accessToken;
             }
 
-            const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
+            const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
             const localVarHeaderParameter = {} as any;
             const localVarQueryParameter = {} as any;
 
@@ -291,7 +296,7 @@ export const StatusesApiAxiosParamCreator = function (configuration?: Configurat
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
-            localVarRequestOptions.data = serializeDataIfNeeded(updateStatusRequestDto, localVarRequestOptions, configuration)
+            localVarRequestOptions.data = serializeDataIfNeeded(patchStatusRequestDto, localVarRequestOptions, configuration)
 
             return {
                 url: toPathString(localVarUrlObj),
@@ -309,7 +314,7 @@ export const StatusesApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = StatusesApiAxiosParamCreator(configuration)
     return {
         /**
-         * This will create status.
+         * This will create a status.
          * @summary Create the status
          * @param {CreateStatusRequestDto} createStatusRequestDto 
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -333,7 +338,7 @@ export const StatusesApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * This will get status.
+         * Get status by code.
          * @summary Retrieve the status
          * @param {string} code 
          * @param {string} expand 
@@ -349,28 +354,29 @@ export const StatusesApiFp = function(configuration?: Configuration) {
          * Retrieves a list of statuses.
          * @summary List statuses
          * @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, 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, 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: createdAt&lt;/i&gt;
+         * @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, slug, name, createdAt, updatedAt&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, slug, name, createdAt, updatedAt&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: id, code, name, slug&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, name, slug&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;       
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listStatuses(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListStatusesResponseClass>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listStatuses(authorization, filter, filters, order, expand, options);
+        async listStatuses(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListStatusesResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listStatuses(authorization, filter, filters, search, order, expand, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * This will update status.
+         * This will partially update a status by code with the provided fields.
          * @summary Update the status
          * @param {string} code 
-         * @param {UpdateStatusRequestDto} updateStatusRequestDto 
+         * @param {PatchStatusRequestDto} patchStatusRequestDto 
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async updateStatus(code: string, updateStatusRequestDto: UpdateStatusRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateStatusResponseClass>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.updateStatus(code, updateStatusRequestDto, authorization, options);
+        async patchStatus(code: string, patchStatusRequestDto: PatchStatusRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchStatusResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.patchStatus(code, patchStatusRequestDto, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
     }
@@ -384,7 +390,7 @@ export const StatusesApiFactory = function (configuration?: Configuration, baseP
     const localVarFp = StatusesApiFp(configuration)
     return {
         /**
-         * This will create status.
+         * This will create a status.
          * @summary Create the status
          * @param {CreateStatusRequestDto} createStatusRequestDto 
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -406,7 +412,7 @@ export const StatusesApiFactory = function (configuration?: Configuration, baseP
             return localVarFp.deleteStatus(code, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * This will get status.
+         * Get status by code.
          * @summary Retrieve the status
          * @param {string} code 
          * @param {string} expand 
@@ -421,27 +427,28 @@ export const StatusesApiFactory = function (configuration?: Configuration, baseP
          * Retrieves a list of statuses.
          * @summary List statuses
          * @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, 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, 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: createdAt&lt;/i&gt;
+         * @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, slug, name, createdAt, updatedAt&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, slug, name, createdAt, updatedAt&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: id, code, name, slug&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, name, slug&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;       
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listStatuses(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListStatusesResponseClass> {
-            return localVarFp.listStatuses(authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
+        listStatuses(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListStatusesResponseClass> {
+            return localVarFp.listStatuses(authorization, filter, filters, search, order, expand, options).then((request) => request(axios, basePath));
         },
         /**
-         * This will update status.
+         * This will partially update a status by code with the provided fields.
          * @summary Update the status
          * @param {string} code 
-         * @param {UpdateStatusRequestDto} updateStatusRequestDto 
+         * @param {PatchStatusRequestDto} patchStatusRequestDto 
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        updateStatus(code: string, updateStatusRequestDto: UpdateStatusRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateStatusResponseClass> {
-            return localVarFp.updateStatus(code, updateStatusRequestDto, authorization, options).then((request) => request(axios, basePath));
+        patchStatus(code: string, patchStatusRequestDto: PatchStatusRequestDto, authorization?: string, options?: any): AxiosPromise<PatchStatusResponseClass> {
+            return localVarFp.patchStatus(code, patchStatusRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -530,21 +537,28 @@ export interface StatusesApiListStatusesRequest {
     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, createdAt&lt;/i&gt;
+     * 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, slug, name, createdAt, updatedAt&lt;/i&gt;
      * @type {string}
      * @memberof StatusesApiListStatuses
      */
     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, createdAt&lt;/i&gt;
+     * 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, slug, name, createdAt, updatedAt&lt;/i&gt;
      * @type {string}
      * @memberof StatusesApiListStatuses
      */
     readonly filters?: 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: 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: id, code, name, slug&lt;/i&gt;
+     * @type {string}
+     * @memberof StatusesApiListStatuses
+     */
+    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, updatedAt, name, slug&lt;/i&gt;
      * @type {string}
      * @memberof StatusesApiListStatuses
      */
@@ -559,29 +573,29 @@ export interface StatusesApiListStatusesRequest {
 }
 
 /**
- * Request parameters for updateStatus operation in StatusesApi.
+ * Request parameters for patchStatus operation in StatusesApi.
  * @export
- * @interface StatusesApiUpdateStatusRequest
+ * @interface StatusesApiPatchStatusRequest
  */
-export interface StatusesApiUpdateStatusRequest {
+export interface StatusesApiPatchStatusRequest {
     /**
      * 
      * @type {string}
-     * @memberof StatusesApiUpdateStatus
+     * @memberof StatusesApiPatchStatus
      */
     readonly code: string
 
     /**
      * 
-     * @type {UpdateStatusRequestDto}
-     * @memberof StatusesApiUpdateStatus
+     * @type {PatchStatusRequestDto}
+     * @memberof StatusesApiPatchStatus
      */
-    readonly updateStatusRequestDto: UpdateStatusRequestDto
+    readonly patchStatusRequestDto: PatchStatusRequestDto
 
     /**
      * Bearer Token: provided by the login endpoint under the name accessToken.
      * @type {string}
-     * @memberof StatusesApiUpdateStatus
+     * @memberof StatusesApiPatchStatus
      */
     readonly authorization?: string
 }
@@ -594,7 +608,7 @@ export interface StatusesApiUpdateStatusRequest {
  */
 export class StatusesApi extends BaseAPI {
     /**
-     * This will create status.
+     * This will create a status.
      * @summary Create the status
      * @param {StatusesApiCreateStatusRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -618,7 +632,7 @@ export class StatusesApi extends BaseAPI {
     }
 
     /**
-     * This will get status.
+     * Get status by code.
      * @summary Retrieve the status
      * @param {StatusesApiGetStatusRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -638,18 +652,18 @@ export class StatusesApi extends BaseAPI {
      * @memberof StatusesApi
      */
     public listStatuses(requestParameters: StatusesApiListStatusesRequest = {}, options?: AxiosRequestConfig) {
-        return StatusesApiFp(this.configuration).listStatuses(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
+        return StatusesApiFp(this.configuration).listStatuses(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**
-     * This will update status.
+     * This will partially update a status by code with the provided fields.
      * @summary Update the status
-     * @param {StatusesApiUpdateStatusRequest} requestParameters Request parameters.
+     * @param {StatusesApiPatchStatusRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof StatusesApi
      */
-    public updateStatus(requestParameters: StatusesApiUpdateStatusRequest, options?: AxiosRequestConfig) {
-        return StatusesApiFp(this.configuration).updateStatus(requestParameters.code, requestParameters.updateStatusRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    public patchStatus(requestParameters: StatusesApiPatchStatusRequest, options?: AxiosRequestConfig) {
+        return StatusesApiFp(this.configuration).patchStatus(requestParameters.code, requestParameters.patchStatusRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
     }
 }