pipedrive 32.2.0 → 33.0.0

package/dist/esm/versions/v2/api/project-templates-api.d.ts

@@ -0,0 +1,142 @@
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosInstance } from 'axios';
+import { RequestArgs, BaseAPI } from '../base';
+import { GetProjectTemplateResponse } from '../models';
+import { GetProjectTemplatesResponse } from '../models';
+/**
+ * ProjectTemplatesApi - axios parameter creator
+ * @export
+ */
+export declare const ProjectTemplatesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Returns the details of a specific project template.
+     * @summary Get details of a template
+     * @param {number} id The ID of the project template
+
+     * @throws {RequiredError}
+     */
+    getProjectTemplate: (id: number) => Promise<RequestArgs>;
+    /**
+     * Returns all not deleted project templates.
+     * @summary Get all project templates
+     * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
+
+     * @throws {RequiredError}
+     */
+    getProjectTemplates: (cursor?: string, limit?: number) => Promise<RequestArgs>;
+};
+/**
+ * ProjectTemplatesApi - functional programming interface
+ * @export
+ */
+export declare const ProjectTemplatesApiFp: (configuration?: Configuration) => {
+    /**
+     * Returns the details of a specific project template.
+     * @summary Get details of a template
+     * @param {number} id The ID of the project template
+
+     * @throws {RequiredError}
+     */
+    getProjectTemplate(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProjectTemplateResponse>>;
+    /**
+     * Returns all not deleted project templates.
+     * @summary Get all project templates
+     * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
+
+     * @throws {RequiredError}
+     */
+    getProjectTemplates(cursor?: string, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProjectTemplatesResponse>>;
+};
+/**
+ * ProjectTemplatesApi - factory interface
+ * @export
+ */
+export declare const ProjectTemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Returns the details of a specific project template.
+     * @summary Get details of a template
+     * @param {ProjectTemplatesApiGetProjectTemplateRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getProjectTemplate(requestParameters: ProjectTemplatesApiGetProjectTemplateRequest): Promise<GetProjectTemplateResponse>;
+    /**
+     * Returns all not deleted project templates.
+     * @summary Get all project templates
+     * @param {ProjectTemplatesApiGetProjectTemplatesRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getProjectTemplates(requestParameters?: ProjectTemplatesApiGetProjectTemplatesRequest): Promise<GetProjectTemplatesResponse>;
+};
+/**
+ * Request parameters for getProjectTemplate operation in ProjectTemplatesApi.
+ * @export
+ * @interface ProjectTemplatesApiGetProjectTemplateRequest
+ */
+export interface ProjectTemplatesApiGetProjectTemplateRequest {
+    /**
+     * The ID of the project template
+     * @type {number}
+     * @memberof ProjectTemplatesApiGetProjectTemplate
+     */
+    readonly id: number;
+}
+/**
+ * Request parameters for getProjectTemplates operation in ProjectTemplatesApi.
+ * @export
+ * @interface ProjectTemplatesApiGetProjectTemplatesRequest
+ */
+export interface ProjectTemplatesApiGetProjectTemplatesRequest {
+    /**
+     * For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @type {string}
+     * @memberof ProjectTemplatesApiGetProjectTemplates
+     */
+    readonly cursor?: string;
+    /**
+     * For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
+     * @type {number}
+     * @memberof ProjectTemplatesApiGetProjectTemplates
+     */
+    readonly limit?: number;
+}
+/**
+ * ProjectTemplatesApi - object-oriented interface
+ * @export
+ * @class ProjectTemplatesApi
+ * @extends {BaseAPI}
+ */
+export declare class ProjectTemplatesApi extends BaseAPI {
+    /**
+     * Returns the details of a specific project template.
+     * @summary Get details of a template
+     * @param {ProjectTemplatesApiGetProjectTemplateRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectTemplatesApi
+     */
+    getProjectTemplate(requestParameters: ProjectTemplatesApiGetProjectTemplateRequest): Promise<GetProjectTemplateResponse>;
+    /**
+     * Returns all not deleted project templates.
+     * @summary Get all project templates
+     * @param {ProjectTemplatesApiGetProjectTemplatesRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectTemplatesApi
+     */
+    getProjectTemplates(requestParameters?: ProjectTemplatesApiGetProjectTemplatesRequest): Promise<GetProjectTemplatesResponse>;
+}

package/dist/esm/versions/v2/api/project-templates-api.js

@@ -0,0 +1,203 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, BaseAPI } from '../base';
+/**
+ * ProjectTemplatesApi - axios parameter creator
+ * @export
+ */
+export const ProjectTemplatesApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Returns the details of a specific project template.
+         * @summary Get details of a template
+         * @param {number} id The ID of the project template
+
+         * @throws {RequiredError}
+         */
+        getProjectTemplate: (id) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getProjectTemplate', 'id', id);
+            const localVarPath = `/projectTemplates/{id}`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["projects:read", "projects:full"], configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Returns all not deleted project templates.
+         * @summary Get all project templates
+         * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+         * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
+
+         * @throws {RequiredError}
+         */
+        getProjectTemplates: (cursor, limit) => __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = `/projectTemplates`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["projects:read", "projects:full"], configuration);
+            if (cursor !== undefined) {
+                localVarQueryParameter['cursor'] = cursor;
+            }
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * ProjectTemplatesApi - functional programming interface
+ * @export
+ */
+export const ProjectTemplatesApiFp = function (configuration) {
+    const localVarAxiosParamCreator = ProjectTemplatesApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Returns the details of a specific project template.
+         * @summary Get details of a template
+         * @param {number} id The ID of the project template
+
+         * @throws {RequiredError}
+         */
+        getProjectTemplate(id) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getProjectTemplate(id);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Returns all not deleted project templates.
+         * @summary Get all project templates
+         * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+         * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
+
+         * @throws {RequiredError}
+         */
+        getProjectTemplates(cursor, limit) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getProjectTemplates(cursor, limit);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+    };
+};
+/**
+ * ProjectTemplatesApi - factory interface
+ * @export
+ */
+export const ProjectTemplatesApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = ProjectTemplatesApiFp(configuration);
+    return {
+        /**
+         * Returns the details of a specific project template.
+         * @summary Get details of a template
+         * @param {ProjectTemplatesApiGetProjectTemplateRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getProjectTemplate(requestParameters) {
+            return localVarFp.getProjectTemplate(requestParameters.id).then((request) => request(axios, basePath));
+        },
+        /**
+         * Returns all not deleted project templates.
+         * @summary Get all project templates
+         * @param {ProjectTemplatesApiGetProjectTemplatesRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getProjectTemplates(requestParameters = {}) {
+            return localVarFp.getProjectTemplates(requestParameters.cursor, requestParameters.limit).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * ProjectTemplatesApi - object-oriented interface
+ * @export
+ * @class ProjectTemplatesApi
+ * @extends {BaseAPI}
+ */
+export class ProjectTemplatesApi extends BaseAPI {
+    /**
+     * Returns the details of a specific project template.
+     * @summary Get details of a template
+     * @param {ProjectTemplatesApiGetProjectTemplateRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectTemplatesApi
+     */
+    getProjectTemplate(requestParameters) {
+        return ProjectTemplatesApiFp(this.configuration).getProjectTemplate(requestParameters.id).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Returns all not deleted project templates.
+     * @summary Get all project templates
+     * @param {ProjectTemplatesApiGetProjectTemplatesRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectTemplatesApi
+     */
+    getProjectTemplates(requestParameters = {}) {
+        return ProjectTemplatesApiFp(this.configuration).getProjectTemplates(requestParameters.cursor, requestParameters.limit).then((request) => request(this.axios, this.basePath));
+    }
+}