@emilgroup/task-sdk-node 1.7.1-beta.3 → 1.7.1-beta.31

package/.openapi-generator/FILES

@@ -17,6 +17,7 @@ common.ts
 configuration.ts
 git_push.sh
 index.ts
+models/add-secondary-link-response-class.ts
 models/assignee-class.ts
 models/category-class.ts
 models/create-category-request-dto.ts
@@ -31,6 +32,11 @@ models/create-status-request-dto.ts
 models/create-status-response-class.ts
 models/create-task-request-dto.ts
 models/create-task-response-class.ts
+models/dry-run-filter-clause-class.ts
+models/dry-run-filter-request-dto.ts
+models/dry-run-filter-response-class.ts
+models/entity-ref-class.ts
+models/entity-ref-dto.ts
 models/filter-class.ts
 models/get-category-response-class.ts
 models/get-filter-response-class.ts
@@ -60,6 +66,8 @@ models/patch-status-response-class.ts
 models/patch-task-request-dto.ts
 models/patch-task-response-class.ts
 models/reminder-class.ts
+models/remove-secondary-link-response-class.ts
+models/secondary-link-class.ts
 models/status-class.ts
 models/task-class.ts
 models/update-filter-request-dto.ts

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/task-sdk-node@1.7.1-beta.3 --save
+npm install @emilgroup/task-sdk-node@1.7.1-beta.31 --save
 ```
 or 
 ```
-yarn add @emilgroup/task-sdk-node@1.7.1-beta.3
+yarn add @emilgroup/task-sdk-node@1.7.1-beta.31
 ```
 
 And then you can import `TasksApi`.

package/api/filters-api.ts

@@ -25,6 +25,10 @@ import { CreateFilterRequestDto } from '../models';
 // @ts-ignore
 import { CreateFilterResponseClass } from '../models';
 // @ts-ignore
+import { DryRunFilterRequestDto } from '../models';
+// @ts-ignore
+import { DryRunFilterResponseClass } from '../models';
+// @ts-ignore
 import { GetFilterResponseClass } from '../models';
 // @ts-ignore
 import { ListFiltersResponseClass } from '../models';
@@ -134,6 +138,53 @@ export const FiltersApiAxiosParamCreator = function (configuration?: Configurati
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Test a candidate filter expression against a specific task without saving a filter.  **Required Permissions**  \"task-management.task-filters.create\"
+         * @summary Create the filter dry-run
+         * @param {DryRunFilterRequestDto} dryRunFilterRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        dryRunFilter: async (dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'dryRunFilterRequestDto' is not null or undefined
+            assertParamExists('dryRunFilter', 'dryRunFilterRequestDto', dryRunFilterRequestDto)
+            const localVarPath = `/taskservice/v1/filters/dry-run`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(dryRunFilterRequestDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Fetch a filter by its code.  **Required Permissions**  \"task-management.task-filters.view\"
          * @summary Retrieve the filter
@@ -180,16 +231,16 @@ export const FiltersApiAxiosParamCreator = function (configuration?: Configurati
             };
         },
         /**
-         * Returns a list of filters you have previously created.        The filters are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"task-management.task-filters.view\"
+         * Retrieves a list of routing filters.  **Required Permissions**  \"task-management.task-filters.view\"
          * @summary List filters
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @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.
-         * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
-         * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
-         * @param {string} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
-         * @param {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+         * @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, targetUserGroupCode, isActive, isFallback, priority&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: 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, priority&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 {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, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -340,6 +391,18 @@ export const FiltersApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.deleteFilter(code, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Test a candidate filter expression against a specific task without saving a filter.  **Required Permissions**  \"task-management.task-filters.create\"
+         * @summary Create the filter dry-run
+         * @param {DryRunFilterRequestDto} dryRunFilterRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async dryRunFilter(dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DryRunFilterResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.dryRunFilter(dryRunFilterRequestDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * Fetch a filter by its code.  **Required Permissions**  \"task-management.task-filters.view\"
          * @summary Retrieve the filter
@@ -353,16 +416,16 @@ export const FiltersApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * Returns a list of filters you have previously created.        The filters are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"task-management.task-filters.view\"
+         * Retrieves a list of routing filters.  **Required Permissions**  \"task-management.task-filters.view\"
          * @summary List filters
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @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.
-         * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
-         * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
-         * @param {string} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
-         * @param {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+         * @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, targetUserGroupCode, isActive, isFallback, priority&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: 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, priority&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 {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, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -415,6 +478,17 @@ export const FiltersApiFactory = function (configuration?: Configuration, basePa
         deleteFilter(code: string, authorization?: string, options?: any): AxiosPromise<void> {
             return localVarFp.deleteFilter(code, authorization, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Test a candidate filter expression against a specific task without saving a filter.  **Required Permissions**  \"task-management.task-filters.create\"
+         * @summary Create the filter dry-run
+         * @param {DryRunFilterRequestDto} dryRunFilterRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        dryRunFilter(dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options?: any): AxiosPromise<DryRunFilterResponseClass> {
+            return localVarFp.dryRunFilter(dryRunFilterRequestDto, authorization, options).then((request) => request(axios, basePath));
+        },
         /**
          * Fetch a filter by its code.  **Required Permissions**  \"task-management.task-filters.view\"
          * @summary Retrieve the filter
@@ -427,16 +501,16 @@ export const FiltersApiFactory = function (configuration?: Configuration, basePa
             return localVarFp.getFilter(code, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns a list of filters you have previously created.        The filters are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"task-management.task-filters.view\"
+         * Retrieves a list of routing filters.  **Required Permissions**  \"task-management.task-filters.view\"
          * @summary List filters
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @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.
-         * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
-         * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
-         * @param {string} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
-         * @param {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+         * @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, targetUserGroupCode, isActive, isFallback, priority&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: 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, priority&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 {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, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -500,6 +574,27 @@ export interface FiltersApiDeleteFilterRequest {
     readonly authorization?: string
 }
 
+/**
+ * Request parameters for dryRunFilter operation in FiltersApi.
+ * @export
+ * @interface FiltersApiDryRunFilterRequest
+ */
+export interface FiltersApiDryRunFilterRequest {
+    /**
+     * 
+     * @type {DryRunFilterRequestDto}
+     * @memberof FiltersApiDryRunFilter
+     */
+    readonly dryRunFilterRequestDto: DryRunFilterRequestDto
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof FiltersApiDryRunFilter
+     */
+    readonly authorization?: string
+}
+
 /**
  * Request parameters for getFilter operation in FiltersApi.
  * @export
@@ -549,35 +644,35 @@ export interface FiltersApiListFiltersRequest {
     readonly pageToken?: string
 
     /**
-     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * 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, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
      * @type {string}
      * @memberof FiltersApiListFilters
      */
     readonly filter?: string
 
     /**
-     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * 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: name, slug&lt;/i&gt;
      * @type {string}
      * @memberof FiltersApiListFilters
      */
     readonly search?: string
 
     /**
-     * The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * 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, priority&lt;/i&gt;
      * @type {string}
      * @memberof FiltersApiListFilters
      */
     readonly order?: string
 
     /**
-     * Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * 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;       
      * @type {string}
      * @memberof FiltersApiListFilters
      */
     readonly expand?: string
 
     /**
-     * Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * 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, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
      * @type {string}
      * @memberof FiltersApiListFilters
      */
@@ -643,6 +738,18 @@ export class FiltersApi extends BaseAPI {
         return FiltersApiFp(this.configuration).deleteFilter(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Test a candidate filter expression against a specific task without saving a filter.  **Required Permissions**  \"task-management.task-filters.create\"
+     * @summary Create the filter dry-run
+     * @param {FiltersApiDryRunFilterRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FiltersApi
+     */
+    public dryRunFilter(requestParameters: FiltersApiDryRunFilterRequest, options?: AxiosRequestConfig) {
+        return FiltersApiFp(this.configuration).dryRunFilter(requestParameters.dryRunFilterRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Fetch a filter by its code.  **Required Permissions**  \"task-management.task-filters.view\"
      * @summary Retrieve the filter
@@ -656,7 +763,7 @@ export class FiltersApi extends BaseAPI {
     }
 
     /**
-     * Returns a list of filters you have previously created.        The filters are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"task-management.task-filters.view\"
+     * Retrieves a list of routing filters.  **Required Permissions**  \"task-management.task-filters.view\"
      * @summary List filters
      * @param {FiltersApiListFiltersRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.