@emilgroup/task-sdk 1.9.0 → 1.9.1-beta.0

package/api.ts

@@ -22,6 +22,7 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
 import { AssigneesApi } from './api';
 import { CategoriesApi } from './api';
+import { FiltersApi } from './api';
 import { HealthApi } from './api';
 import { HubSpotApi } from './api';
 import { RemindersApi } from './api';
@@ -32,6 +33,7 @@ import { TasksApi } from './api';
 
 export * from './api/assignees-api';
 export * from './api/categories-api';
+export * from './api/filters-api';
 export * from './api/health-api';
 export * from './api/hub-spot-api';
 export * from './api/reminders-api';

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

@@ -0,0 +1,384 @@
+/**
+ * EMIL TaskService
+ * The EMIL Task API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreateFilterRequestDto } from '../models';
+import { CreateFilterResponseClass } from '../models';
+import { GetFilterResponseClass } from '../models';
+import { ListFiltersResponseClass } from '../models';
+import { UpdateFilterRequestDto } from '../models';
+import { UpdateFilterResponseClass } from '../models';
+/**
+ * FiltersApi - axios parameter creator
+ * @export
+ */
+export declare const FiltersApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create a routing filter targeting a user-group.  **Required Permissions**  \"task-management.task-filters.create\"
+     * @summary Create the filter
+     * @param {CreateFilterRequestDto} createFilterRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createFilter: (createFilterRequestDto: CreateFilterRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete a filter by its code.  **Required Permissions**  \"task-management.task-filters.delete\"
+     * @summary Delete the filter
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteFilter: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Fetch a filter by its code.  **Required Permissions**  \"task-management.task-filters.view\"
+     * @summary Retrieve the filter
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFilter: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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\"
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listFilters: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update a filter (slug, name, description, expression, target group, priority, is_active, is_fallback).  **Required Permissions**  \"task-management.task-filters.update\"
+     * @summary Update the filter
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateFilterRequestDto} updateFilterRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateFilter: (code: string, updateFilterRequestDto: UpdateFilterRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * FiltersApi - functional programming interface
+ * @export
+ */
+export declare const FiltersApiFp: (configuration?: Configuration) => {
+    /**
+     * Create a routing filter targeting a user-group.  **Required Permissions**  \"task-management.task-filters.create\"
+     * @summary Create the filter
+     * @param {CreateFilterRequestDto} createFilterRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createFilter(createFilterRequestDto: CreateFilterRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFilterResponseClass>>;
+    /**
+     * Delete a filter by its code.  **Required Permissions**  \"task-management.task-filters.delete\"
+     * @summary Delete the filter
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteFilter(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Fetch a filter by its code.  **Required Permissions**  \"task-management.task-filters.view\"
+     * @summary Retrieve the filter
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFilter(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFilterResponseClass>>;
+    /**
+     * 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\"
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listFilters(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFiltersResponseClass>>;
+    /**
+     * Update a filter (slug, name, description, expression, target group, priority, is_active, is_fallback).  **Required Permissions**  \"task-management.task-filters.update\"
+     * @summary Update the filter
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateFilterRequestDto} updateFilterRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateFilter(code: string, updateFilterRequestDto: UpdateFilterRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateFilterResponseClass>>;
+};
+/**
+ * FiltersApi - factory interface
+ * @export
+ */
+export declare const FiltersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create a routing filter targeting a user-group.  **Required Permissions**  \"task-management.task-filters.create\"
+     * @summary Create the filter
+     * @param {CreateFilterRequestDto} createFilterRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createFilter(createFilterRequestDto: CreateFilterRequestDto, authorization?: string, options?: any): AxiosPromise<CreateFilterResponseClass>;
+    /**
+     * Delete a filter by its code.  **Required Permissions**  \"task-management.task-filters.delete\"
+     * @summary Delete the filter
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteFilter(code: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * Fetch a filter by its code.  **Required Permissions**  \"task-management.task-filters.view\"
+     * @summary Retrieve the filter
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFilter(code: string, authorization?: string, options?: any): AxiosPromise<GetFilterResponseClass>;
+    /**
+     * 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\"
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listFilters(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListFiltersResponseClass>;
+    /**
+     * Update a filter (slug, name, description, expression, target group, priority, is_active, is_fallback).  **Required Permissions**  \"task-management.task-filters.update\"
+     * @summary Update the filter
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateFilterRequestDto} updateFilterRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateFilter(code: string, updateFilterRequestDto: UpdateFilterRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateFilterResponseClass>;
+};
+/**
+ * Request parameters for createFilter operation in FiltersApi.
+ * @export
+ * @interface FiltersApiCreateFilterRequest
+ */
+export interface FiltersApiCreateFilterRequest {
+    /**
+     *
+     * @type {CreateFilterRequestDto}
+     * @memberof FiltersApiCreateFilter
+     */
+    readonly createFilterRequestDto: CreateFilterRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof FiltersApiCreateFilter
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteFilter operation in FiltersApi.
+ * @export
+ * @interface FiltersApiDeleteFilterRequest
+ */
+export interface FiltersApiDeleteFilterRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof FiltersApiDeleteFilter
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof FiltersApiDeleteFilter
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getFilter operation in FiltersApi.
+ * @export
+ * @interface FiltersApiGetFilterRequest
+ */
+export interface FiltersApiGetFilterRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof FiltersApiGetFilter
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof FiltersApiGetFilter
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listFilters operation in FiltersApi.
+ * @export
+ * @interface FiltersApiListFiltersRequest
+ */
+export interface FiltersApiListFiltersRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof FiltersApiListFilters
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof FiltersApiListFilters
+     */
+    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 FiltersApiListFilters
+     */
+    readonly pageToken?: string;
+    /**
+     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @type {string}
+     * @memberof FiltersApiListFilters
+     */
+    readonly filter?: string;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @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.
+     * @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.
+     * @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.
+     * @type {string}
+     * @memberof FiltersApiListFilters
+     */
+    readonly filters?: string;
+}
+/**
+ * Request parameters for updateFilter operation in FiltersApi.
+ * @export
+ * @interface FiltersApiUpdateFilterRequest
+ */
+export interface FiltersApiUpdateFilterRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof FiltersApiUpdateFilter
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateFilterRequestDto}
+     * @memberof FiltersApiUpdateFilter
+     */
+    readonly updateFilterRequestDto: UpdateFilterRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof FiltersApiUpdateFilter
+     */
+    readonly authorization?: string;
+}
+/**
+ * FiltersApi - object-oriented interface
+ * @export
+ * @class FiltersApi
+ * @extends {BaseAPI}
+ */
+export declare class FiltersApi extends BaseAPI {
+    /**
+     * Create a routing filter targeting a user-group.  **Required Permissions**  \"task-management.task-filters.create\"
+     * @summary Create the filter
+     * @param {FiltersApiCreateFilterRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FiltersApi
+     */
+    createFilter(requestParameters: FiltersApiCreateFilterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateFilterResponseClass, any, {}>>;
+    /**
+     * Delete a filter by its code.  **Required Permissions**  \"task-management.task-filters.delete\"
+     * @summary Delete the filter
+     * @param {FiltersApiDeleteFilterRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FiltersApi
+     */
+    deleteFilter(requestParameters: FiltersApiDeleteFilterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Fetch a filter by its code.  **Required Permissions**  \"task-management.task-filters.view\"
+     * @summary Retrieve the filter
+     * @param {FiltersApiGetFilterRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FiltersApi
+     */
+    getFilter(requestParameters: FiltersApiGetFilterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFilterResponseClass, any, {}>>;
+    /**
+     * 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\"
+     * @summary List filters
+     * @param {FiltersApiListFiltersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FiltersApi
+     */
+    listFilters(requestParameters?: FiltersApiListFiltersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFiltersResponseClass, any, {}>>;
+    /**
+     * Update a filter (slug, name, description, expression, target group, priority, is_active, is_fallback).  **Required Permissions**  \"task-management.task-filters.update\"
+     * @summary Update the filter
+     * @param {FiltersApiUpdateFilterRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FiltersApi
+     */
+    updateFilter(requestParameters: FiltersApiUpdateFilterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateFilterResponseClass, any, {}>>;
+}