@emilgroup/task-sdk-node 1.0.3 → 1.1.0

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

@@ -0,0 +1,375 @@
+/**
+ * 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 { CreateStatusRequestDto } from '../models';
+import { CreateStatusResponseClass } from '../models';
+import { GetStatusResponseClass } from '../models';
+import { ListStatusesResponseClass } from '../models';
+import { PatchStatusRequestDto } from '../models';
+import { PatchStatusResponseClass } from '../models';
+/**
+ * StatusesApi - axios parameter creator
+ * @export
+ */
+export declare const StatusesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create a status.  **Required Permissions**  \"task-management.tasks.create\"
+     * @summary Create the status
+     * @param {CreateStatusRequestDto} createStatusRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createStatus: (createStatusRequestDto: CreateStatusRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will delete status.  **Required Permissions**  \"task-management.tasks.delete\"
+     * @summary Delete the status
+     * @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}
+     */
+    deleteStatus: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get status by code.  **Required Permissions**  \"task-management.tasks.view\"
+     * @summary Retrieve the status
+     * @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 status.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStatus: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves a list of statuses.  **Required Permissions**  \"task-management.tasks.view\"
+     * @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, 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: 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, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will partially update a status by code with the provided fields.  **Required Permissions**  \"task-management.tasks.update\"
+     * @summary Update the status
+     * @param {string} code
+     * @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}
+     */
+    patchStatus: (code: string, patchStatusRequestDto: PatchStatusRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * StatusesApi - functional programming interface
+ * @export
+ */
+export declare const StatusesApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create a status.  **Required Permissions**  \"task-management.tasks.create\"
+     * @summary Create the status
+     * @param {CreateStatusRequestDto} createStatusRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createStatus(createStatusRequestDto: CreateStatusRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateStatusResponseClass>>;
+    /**
+     * This will delete status.  **Required Permissions**  \"task-management.tasks.delete\"
+     * @summary Delete the status
+     * @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}
+     */
+    deleteStatus(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Get status by code.  **Required Permissions**  \"task-management.tasks.view\"
+     * @summary Retrieve the status
+     * @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 status.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStatus(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStatusResponseClass>>;
+    /**
+     * Retrieves a list of statuses.  **Required Permissions**  \"task-management.tasks.view\"
+     * @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, 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: 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, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListStatusesResponseClass>>;
+    /**
+     * This will partially update a status by code with the provided fields.  **Required Permissions**  \"task-management.tasks.update\"
+     * @summary Update the status
+     * @param {string} code
+     * @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}
+     */
+    patchStatus(code: string, patchStatusRequestDto: PatchStatusRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchStatusResponseClass>>;
+};
+/**
+ * StatusesApi - factory interface
+ * @export
+ */
+export declare const StatusesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create a status.  **Required Permissions**  \"task-management.tasks.create\"
+     * @summary Create the status
+     * @param {CreateStatusRequestDto} createStatusRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createStatus(createStatusRequestDto: CreateStatusRequestDto, authorization?: string, options?: any): AxiosPromise<CreateStatusResponseClass>;
+    /**
+     * This will delete status.  **Required Permissions**  \"task-management.tasks.delete\"
+     * @summary Delete the status
+     * @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}
+     */
+    deleteStatus(code: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * Get status by code.  **Required Permissions**  \"task-management.tasks.view\"
+     * @summary Retrieve the status
+     * @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 status.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStatus(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetStatusResponseClass>;
+    /**
+     * Retrieves a list of statuses.  **Required Permissions**  \"task-management.tasks.view\"
+     * @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, 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: 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, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListStatusesResponseClass>;
+    /**
+     * This will partially update a status by code with the provided fields.  **Required Permissions**  \"task-management.tasks.update\"
+     * @summary Update the status
+     * @param {string} code
+     * @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}
+     */
+    patchStatus(code: string, patchStatusRequestDto: PatchStatusRequestDto, authorization?: string, options?: any): AxiosPromise<PatchStatusResponseClass>;
+};
+/**
+ * Request parameters for createStatus operation in StatusesApi.
+ * @export
+ * @interface StatusesApiCreateStatusRequest
+ */
+export interface StatusesApiCreateStatusRequest {
+    /**
+     *
+     * @type {CreateStatusRequestDto}
+     * @memberof StatusesApiCreateStatus
+     */
+    readonly createStatusRequestDto: CreateStatusRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof StatusesApiCreateStatus
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteStatus operation in StatusesApi.
+ * @export
+ * @interface StatusesApiDeleteStatusRequest
+ */
+export interface StatusesApiDeleteStatusRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof StatusesApiDeleteStatus
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof StatusesApiDeleteStatus
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getStatus operation in StatusesApi.
+ * @export
+ * @interface StatusesApiGetStatusRequest
+ */
+export interface StatusesApiGetStatusRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof StatusesApiGetStatus
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof StatusesApiGetStatus
+     */
+    readonly authorization?: string;
+    /**
+     * Expand to fetch additional information about the status.
+     * @type {string}
+     * @memberof StatusesApiGetStatus
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for listStatuses operation in StatusesApi.
+ * @export
+ * @interface StatusesApiListStatusesRequest
+ */
+export interface StatusesApiListStatusesRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof StatusesApiListStatuses
+     */
+    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, 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, slug, name, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof StatusesApiListStatuses
+     */
+    readonly filters?: 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: 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
+     */
+    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 StatusesApiListStatuses
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for patchStatus operation in StatusesApi.
+ * @export
+ * @interface StatusesApiPatchStatusRequest
+ */
+export interface StatusesApiPatchStatusRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof StatusesApiPatchStatus
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {PatchStatusRequestDto}
+     * @memberof StatusesApiPatchStatus
+     */
+    readonly patchStatusRequestDto: PatchStatusRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof StatusesApiPatchStatus
+     */
+    readonly authorization?: string;
+}
+/**
+ * StatusesApi - object-oriented interface
+ * @export
+ * @class StatusesApi
+ * @extends {BaseAPI}
+ */
+export declare class StatusesApi extends BaseAPI {
+    /**
+     * This will create a status.  **Required Permissions**  \"task-management.tasks.create\"
+     * @summary Create the status
+     * @param {StatusesApiCreateStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StatusesApi
+     */
+    createStatus(requestParameters: StatusesApiCreateStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateStatusResponseClass, any, {}>>;
+    /**
+     * This will delete status.  **Required Permissions**  \"task-management.tasks.delete\"
+     * @summary Delete the status
+     * @param {StatusesApiDeleteStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StatusesApi
+     */
+    deleteStatus(requestParameters: StatusesApiDeleteStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Get status by code.  **Required Permissions**  \"task-management.tasks.view\"
+     * @summary Retrieve the status
+     * @param {StatusesApiGetStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StatusesApi
+     */
+    getStatus(requestParameters: StatusesApiGetStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStatusResponseClass, any, {}>>;
+    /**
+     * Retrieves a list of statuses.  **Required Permissions**  \"task-management.tasks.view\"
+     * @summary List statuses
+     * @param {StatusesApiListStatusesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StatusesApi
+     */
+    listStatuses(requestParameters?: StatusesApiListStatusesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListStatusesResponseClass, any, {}>>;
+    /**
+     * This will partially update a status by code with the provided fields.  **Required Permissions**  \"task-management.tasks.update\"
+     * @summary Update the status
+     * @param {StatusesApiPatchStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StatusesApi
+     */
+    patchStatus(requestParameters: StatusesApiPatchStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchStatusResponseClass, any, {}>>;
+}