@emilgroup/task-sdk-node 1.0.3 → 1.1.0

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

@@ -0,0 +1,393 @@
+/**
+ * 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 { CreateCategoryRequestDto } from '../models';
+import { CreateCategoryResponseClass } from '../models';
+import { GetCategoryResponseClass } from '../models';
+import { ListCategoriesResponseClass } from '../models';
+import { PatchCategoryRequestDto } from '../models';
+import { PatchCategoryResponseClass } from '../models';
+/**
+ * CategoriesApi - axios parameter creator
+ * @export
+ */
+export declare const CategoriesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create a category.  **Required Permissions**  \"task-management.tasks.create\"
+     * @summary Create the category
+     * @param {CreateCategoryRequestDto} createCategoryRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCategory: (createCategoryRequestDto: CreateCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will delete a task category by code.  **Required Permissions**  \"task-management.tasks.delete\"
+     * @summary Delete the category
+     * @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}
+     */
+    deleteCategory: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get category by code.  **Required Permissions**  \"task-management.tasks.view\"
+     * @summary Retrieve the category
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [expand] Expand to fetch additional information about the category.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCategory: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves a list of categories.  **Required Permissions**  \"task-management.tasks.view\"
+     * @summary List categories
+     * @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.&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: 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 {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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCategories: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will partially update a category by code with the provided fields.  **Required Permissions**  \"task-management.tasks.update\"
+     * @summary Update the category
+     * @param {string} code
+     * @param {PatchCategoryRequestDto} patchCategoryRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchCategory: (code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * CategoriesApi - functional programming interface
+ * @export
+ */
+export declare const CategoriesApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create a category.  **Required Permissions**  \"task-management.tasks.create\"
+     * @summary Create the category
+     * @param {CreateCategoryRequestDto} createCategoryRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCategory(createCategoryRequestDto: CreateCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCategoryResponseClass>>;
+    /**
+     * This will delete a task category by code.  **Required Permissions**  \"task-management.tasks.delete\"
+     * @summary Delete the category
+     * @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}
+     */
+    deleteCategory(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Get category by code.  **Required Permissions**  \"task-management.tasks.view\"
+     * @summary Retrieve the category
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [expand] Expand to fetch additional information about the category.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCategory(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCategoryResponseClass>>;
+    /**
+     * Retrieves a list of categories.  **Required Permissions**  \"task-management.tasks.view\"
+     * @summary List categories
+     * @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.&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: 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 {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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCategories(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCategoriesResponseClass>>;
+    /**
+     * This will partially update a category by code with the provided fields.  **Required Permissions**  \"task-management.tasks.update\"
+     * @summary Update the category
+     * @param {string} code
+     * @param {PatchCategoryRequestDto} patchCategoryRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchCategory(code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchCategoryResponseClass>>;
+};
+/**
+ * CategoriesApi - factory interface
+ * @export
+ */
+export declare const CategoriesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create a category.  **Required Permissions**  \"task-management.tasks.create\"
+     * @summary Create the category
+     * @param {CreateCategoryRequestDto} createCategoryRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCategory(createCategoryRequestDto: CreateCategoryRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCategoryResponseClass>;
+    /**
+     * This will delete a task category by code.  **Required Permissions**  \"task-management.tasks.delete\"
+     * @summary Delete the category
+     * @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}
+     */
+    deleteCategory(code: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * Get category by code.  **Required Permissions**  \"task-management.tasks.view\"
+     * @summary Retrieve the category
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [expand] Expand to fetch additional information about the category.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCategory(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetCategoryResponseClass>;
+    /**
+     * Retrieves a list of categories.  **Required Permissions**  \"task-management.tasks.view\"
+     * @summary List categories
+     * @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.&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: 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 {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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCategories(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCategoriesResponseClass>;
+    /**
+     * This will partially update a category by code with the provided fields.  **Required Permissions**  \"task-management.tasks.update\"
+     * @summary Update the category
+     * @param {string} code
+     * @param {PatchCategoryRequestDto} patchCategoryRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchCategory(code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options?: any): AxiosPromise<PatchCategoryResponseClass>;
+};
+/**
+ * Request parameters for createCategory operation in CategoriesApi.
+ * @export
+ * @interface CategoriesApiCreateCategoryRequest
+ */
+export interface CategoriesApiCreateCategoryRequest {
+    /**
+     *
+     * @type {CreateCategoryRequestDto}
+     * @memberof CategoriesApiCreateCategory
+     */
+    readonly createCategoryRequestDto: CreateCategoryRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CategoriesApiCreateCategory
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteCategory operation in CategoriesApi.
+ * @export
+ * @interface CategoriesApiDeleteCategoryRequest
+ */
+export interface CategoriesApiDeleteCategoryRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof CategoriesApiDeleteCategory
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CategoriesApiDeleteCategory
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getCategory operation in CategoriesApi.
+ * @export
+ * @interface CategoriesApiGetCategoryRequest
+ */
+export interface CategoriesApiGetCategoryRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CategoriesApiGetCategory
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CategoriesApiGetCategory
+     */
+    readonly authorization?: string;
+    /**
+     * Expand to fetch additional information about the category.
+     * @type {string}
+     * @memberof CategoriesApiGetCategory
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for listCategories operation in CategoriesApi.
+ * @export
+ * @interface CategoriesApiListCategoriesRequest
+ */
+export interface CategoriesApiListCategoriesRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CategoriesApiListCategories
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof CategoriesApiListCategories
+     */
+    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 CategoriesApiListCategories
+     */
+    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, slug, name, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof CategoriesApiListCategories
+     */
+    readonly filter?: string;
+    /**
+     * 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 CategoriesApiListCategories
+     */
+    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 CategoriesApiListCategories
+     */
+    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;
+     * @type {string}
+     * @memberof CategoriesApiListCategories
+     */
+    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, slug, name, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof CategoriesApiListCategories
+     */
+    readonly filters?: string;
+}
+/**
+ * Request parameters for patchCategory operation in CategoriesApi.
+ * @export
+ * @interface CategoriesApiPatchCategoryRequest
+ */
+export interface CategoriesApiPatchCategoryRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CategoriesApiPatchCategory
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {PatchCategoryRequestDto}
+     * @memberof CategoriesApiPatchCategory
+     */
+    readonly patchCategoryRequestDto: PatchCategoryRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CategoriesApiPatchCategory
+     */
+    readonly authorization?: string;
+}
+/**
+ * CategoriesApi - object-oriented interface
+ * @export
+ * @class CategoriesApi
+ * @extends {BaseAPI}
+ */
+export declare class CategoriesApi extends BaseAPI {
+    /**
+     * This will create a category.  **Required Permissions**  \"task-management.tasks.create\"
+     * @summary Create the category
+     * @param {CategoriesApiCreateCategoryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CategoriesApi
+     */
+    createCategory(requestParameters: CategoriesApiCreateCategoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCategoryResponseClass, any, {}>>;
+    /**
+     * This will delete a task category by code.  **Required Permissions**  \"task-management.tasks.delete\"
+     * @summary Delete the category
+     * @param {CategoriesApiDeleteCategoryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CategoriesApi
+     */
+    deleteCategory(requestParameters: CategoriesApiDeleteCategoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Get category by code.  **Required Permissions**  \"task-management.tasks.view\"
+     * @summary Retrieve the category
+     * @param {CategoriesApiGetCategoryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CategoriesApi
+     */
+    getCategory(requestParameters: CategoriesApiGetCategoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCategoryResponseClass, any, {}>>;
+    /**
+     * Retrieves a list of categories.  **Required Permissions**  \"task-management.tasks.view\"
+     * @summary List categories
+     * @param {CategoriesApiListCategoriesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CategoriesApi
+     */
+    listCategories(requestParameters?: CategoriesApiListCategoriesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCategoriesResponseClass, any, {}>>;
+    /**
+     * This will partially update a category by code with the provided fields.  **Required Permissions**  \"task-management.tasks.update\"
+     * @summary Update the category
+     * @param {CategoriesApiPatchCategoryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CategoriesApi
+     */
+    patchCategory(requestParameters: CategoriesApiPatchCategoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchCategoryResponseClass, any, {}>>;
+}