pipedrive 32.2.0 → 33.0.0

package/dist/esm/versions/v2/api/projects-api.js

@@ -0,0 +1,829 @@
+/* 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, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, BaseAPI } from '../base';
+/**
+ * ProjectsApi - axios parameter creator
+ * @export
+ */
+export const ProjectsApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Adds a new project. Custom fields should be wrapped in the `custom_fields` object.
+         * @summary Add a project
+         * @param {AddProjectRequest} AddProjectRequest
+
+         * @throws {RequiredError}
+         */
+        addProject: (AddProjectRequest) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'AddProjectRequest' is not null or undefined
+            assertParamExists('addProject', 'AddProjectRequest', AddProjectRequest);
+            const localVarPath = `/projects`;
+            // 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: 'POST' }, 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:full"], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            localVarRequestOptions.data = serializeDataIfNeeded(AddProjectRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Archives a project.
+         * @summary Archive a project
+         * @param {number} id The ID of the project
+
+         * @throws {RequiredError}
+         */
+        archiveProject: (id) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('archiveProject', 'id', id);
+            const localVarPath = `/projects/{id}/archive`
+                .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: 'POST' }, 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: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,
+            };
+        }),
+        /**
+         * Marks a project as deleted.
+         * @summary Delete a project
+         * @param {number} id The ID of the project
+
+         * @throws {RequiredError}
+         */
+        deleteProject: (id) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('deleteProject', 'id', id);
+            const localVarPath = `/projects/{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: 'DELETE' }, 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: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 archived projects.
+         * @summary Get all archived projects
+         * @param {number} [filter_id] If supplied, only projects matching the specified filter are returned
+         * @param {string} [status] If supplied, includes only projects with the specified statuses. Possible values are `open`, `completed`, `canceled` and `deleted`. By default `deleted` projects are not returned.
+         * @param {number} [phase_id] If supplied, only projects in the specified phase are returned
+         * @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.
+         * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+         * @throws {RequiredError}
+         */
+        getArchivedProjects: (filter_id, status, phase_id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = `/projects/archived`;
+            // 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 (filter_id !== undefined) {
+                localVarQueryParameter['filter_id'] = filter_id;
+            }
+            if (status !== undefined) {
+                localVarQueryParameter['status'] = status;
+            }
+            if (phase_id !== undefined) {
+                localVarQueryParameter['phase_id'] = phase_id;
+            }
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            if (cursor !== undefined) {
+                localVarQueryParameter['cursor'] = cursor;
+            }
+            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 the details of a specific project. Custom fields appear as keys inside the `custom_fields` object.
+         * @summary Get details of a project
+         * @param {number} id The ID of the project
+
+         * @throws {RequiredError}
+         */
+        getProject: (id) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getProject', 'id', id);
+            const localVarPath = `/projects/{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,
+            };
+        }),
+        /**
+         * Lists updates about field values of a project.
+         * @summary List updates about project field values
+         * @param {number} id The ID of the project
+         * @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.
+         * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+         * @throws {RequiredError}
+         */
+        getProjectChangelog: (id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getProjectChangelog', 'id', id);
+            const localVarPath = `/projects/{id}/changelog`
+                .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);
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            if (cursor !== undefined) {
+                localVarQueryParameter['cursor'] = cursor;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Lists the users permitted to access a project.
+         * @summary List permitted users
+         * @param {number} id The ID of the project
+
+         * @throws {RequiredError}
+         */
+        getProjectUsers: (id) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getProjectUsers', 'id', id);
+            const localVarPath = `/projects/{id}/permittedUsers`
+                .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 non-archived projects.
+         * @summary Get all projects
+         * @param {number} [filter_id] If supplied, only projects matching the specified filter are returned
+         * @param {string} [status] If supplied, includes only projects with the specified statuses. Possible values are `open`, `completed`, `canceled` and `deleted`. By default `deleted` projects are not returned.
+         * @param {number} [phase_id] If supplied, only projects in the specified phase are returned
+         * @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.
+         * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+         * @throws {RequiredError}
+         */
+        getProjects: (filter_id, status, phase_id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = `/projects`;
+            // 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 (filter_id !== undefined) {
+                localVarQueryParameter['filter_id'] = filter_id;
+            }
+            if (status !== undefined) {
+                localVarQueryParameter['status'] = status;
+            }
+            if (phase_id !== undefined) {
+                localVarQueryParameter['phase_id'] = phase_id;
+            }
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            if (cursor !== undefined) {
+                localVarQueryParameter['cursor'] = cursor;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Searches all projects by title, description, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found projects can be filtered by person ID or organization ID.
+         * @summary Search projects
+         * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
+         * @param {'custom_fields' | 'notes' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
+         * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
+         * @param {number} [person_id] Will filter projects by the provided person ID
+         * @param {number} [organization_id] Will filter projects by the provided organization ID
+         * @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.
+         * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+         * @throws {RequiredError}
+         */
+        searchProjects: (term, fields, exact_match, person_id, organization_id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'term' is not null or undefined
+            assertParamExists('searchProjects', 'term', term);
+            const localVarPath = `/projects/search`;
+            // 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", "search:read"], configuration);
+            if (term !== undefined) {
+                localVarQueryParameter['term'] = term;
+            }
+            if (fields !== undefined) {
+                localVarQueryParameter['fields'] = fields;
+            }
+            if (exact_match !== undefined) {
+                localVarQueryParameter['exact_match'] = exact_match;
+            }
+            if (person_id !== undefined) {
+                localVarQueryParameter['person_id'] = person_id;
+            }
+            if (organization_id !== undefined) {
+                localVarQueryParameter['organization_id'] = organization_id;
+            }
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            if (cursor !== undefined) {
+                localVarQueryParameter['cursor'] = cursor;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Updates the properties of a project.
+         * @summary Update a project
+         * @param {number} id The ID of the project
+         * @param {UpdateProjectRequest} [UpdateProjectRequest]
+
+         * @throws {RequiredError}
+         */
+        updateProject: (id, UpdateProjectRequest) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('updateProject', 'id', id);
+            const localVarPath = `/projects/{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: 'PATCH' }, 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:full"], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            localVarRequestOptions.data = serializeDataIfNeeded(UpdateProjectRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * ProjectsApi - functional programming interface
+ * @export
+ */
+export const ProjectsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = ProjectsApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Adds a new project. Custom fields should be wrapped in the `custom_fields` object.
+         * @summary Add a project
+         * @param {AddProjectRequest} AddProjectRequest
+
+         * @throws {RequiredError}
+         */
+        addProject(AddProjectRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addProject(AddProjectRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Archives a project.
+         * @summary Archive a project
+         * @param {number} id The ID of the project
+
+         * @throws {RequiredError}
+         */
+        archiveProject(id) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.archiveProject(id);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Marks a project as deleted.
+         * @summary Delete a project
+         * @param {number} id The ID of the project
+
+         * @throws {RequiredError}
+         */
+        deleteProject(id) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteProject(id);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Returns all archived projects.
+         * @summary Get all archived projects
+         * @param {number} [filter_id] If supplied, only projects matching the specified filter are returned
+         * @param {string} [status] If supplied, includes only projects with the specified statuses. Possible values are &#x60;open&#x60;, &#x60;completed&#x60;, &#x60;canceled&#x60; and &#x60;deleted&#x60;. By default &#x60;deleted&#x60; projects are not returned.
+         * @param {number} [phase_id] If supplied, only projects in the specified phase are returned
+         * @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.
+         * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+         * @throws {RequiredError}
+         */
+        getArchivedProjects(filter_id, status, phase_id, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getArchivedProjects(filter_id, status, phase_id, limit, cursor);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Returns the details of a specific project. Custom fields appear as keys inside the `custom_fields` object.
+         * @summary Get details of a project
+         * @param {number} id The ID of the project
+
+         * @throws {RequiredError}
+         */
+        getProject(id) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getProject(id);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Lists updates about field values of a project.
+         * @summary List updates about project field values
+         * @param {number} id The ID of the project
+         * @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.
+         * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+         * @throws {RequiredError}
+         */
+        getProjectChangelog(id, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getProjectChangelog(id, limit, cursor);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Lists the users permitted to access a project.
+         * @summary List permitted users
+         * @param {number} id The ID of the project
+
+         * @throws {RequiredError}
+         */
+        getProjectUsers(id) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getProjectUsers(id);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Returns all non-archived projects.
+         * @summary Get all projects
+         * @param {number} [filter_id] If supplied, only projects matching the specified filter are returned
+         * @param {string} [status] If supplied, includes only projects with the specified statuses. Possible values are &#x60;open&#x60;, &#x60;completed&#x60;, &#x60;canceled&#x60; and &#x60;deleted&#x60;. By default &#x60;deleted&#x60; projects are not returned.
+         * @param {number} [phase_id] If supplied, only projects in the specified phase are returned
+         * @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.
+         * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+         * @throws {RequiredError}
+         */
+        getProjects(filter_id, status, phase_id, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getProjects(filter_id, status, phase_id, limit, cursor);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Searches all projects by title, description, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found projects can be filtered by person ID or organization ID.
+         * @summary Search projects
+         * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
+         * @param {'custom_fields' | 'notes' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
+         * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
+         * @param {number} [person_id] Will filter projects by the provided person ID
+         * @param {number} [organization_id] Will filter projects by the provided organization ID
+         * @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.
+         * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+         * @throws {RequiredError}
+         */
+        searchProjects(term, fields, exact_match, person_id, organization_id, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.searchProjects(term, fields, exact_match, person_id, organization_id, limit, cursor);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Updates the properties of a project.
+         * @summary Update a project
+         * @param {number} id The ID of the project
+         * @param {UpdateProjectRequest} [UpdateProjectRequest]
+
+         * @throws {RequiredError}
+         */
+        updateProject(id, UpdateProjectRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updateProject(id, UpdateProjectRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+    };
+};
+/**
+ * ProjectsApi - factory interface
+ * @export
+ */
+export const ProjectsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = ProjectsApiFp(configuration);
+    return {
+        /**
+         * Adds a new project. Custom fields should be wrapped in the `custom_fields` object.
+         * @summary Add a project
+         * @param {ProjectsApiAddProjectRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        addProject(requestParameters) {
+            return localVarFp.addProject(requestParameters.AddProjectRequest).then((request) => request(axios, basePath));
+        },
+        /**
+         * Archives a project.
+         * @summary Archive a project
+         * @param {ProjectsApiArchiveProjectRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        archiveProject(requestParameters) {
+            return localVarFp.archiveProject(requestParameters.id).then((request) => request(axios, basePath));
+        },
+        /**
+         * Marks a project as deleted.
+         * @summary Delete a project
+         * @param {ProjectsApiDeleteProjectRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        deleteProject(requestParameters) {
+            return localVarFp.deleteProject(requestParameters.id).then((request) => request(axios, basePath));
+        },
+        /**
+         * Returns all archived projects.
+         * @summary Get all archived projects
+         * @param {ProjectsApiGetArchivedProjectsRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getArchivedProjects(requestParameters = {}) {
+            return localVarFp.getArchivedProjects(requestParameters.filter_id, requestParameters.status, requestParameters.phase_id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
+        /**
+         * Returns the details of a specific project. Custom fields appear as keys inside the `custom_fields` object.
+         * @summary Get details of a project
+         * @param {ProjectsApiGetProjectRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getProject(requestParameters) {
+            return localVarFp.getProject(requestParameters.id).then((request) => request(axios, basePath));
+        },
+        /**
+         * Lists updates about field values of a project.
+         * @summary List updates about project field values
+         * @param {ProjectsApiGetProjectChangelogRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getProjectChangelog(requestParameters) {
+            return localVarFp.getProjectChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
+        /**
+         * Lists the users permitted to access a project.
+         * @summary List permitted users
+         * @param {ProjectsApiGetProjectUsersRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getProjectUsers(requestParameters) {
+            return localVarFp.getProjectUsers(requestParameters.id).then((request) => request(axios, basePath));
+        },
+        /**
+         * Returns all non-archived projects.
+         * @summary Get all projects
+         * @param {ProjectsApiGetProjectsRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getProjects(requestParameters = {}) {
+            return localVarFp.getProjects(requestParameters.filter_id, requestParameters.status, requestParameters.phase_id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
+        /**
+         * Searches all projects by title, description, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found projects can be filtered by person ID or organization ID.
+         * @summary Search projects
+         * @param {ProjectsApiSearchProjectsRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        searchProjects(requestParameters) {
+            return localVarFp.searchProjects(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.person_id, requestParameters.organization_id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
+        /**
+         * Updates the properties of a project.
+         * @summary Update a project
+         * @param {ProjectsApiUpdateProjectRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        updateProject(requestParameters) {
+            return localVarFp.updateProject(requestParameters.id, requestParameters.UpdateProjectRequest).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * ProjectsApi - object-oriented interface
+ * @export
+ * @class ProjectsApi
+ * @extends {BaseAPI}
+ */
+export class ProjectsApi extends BaseAPI {
+    /**
+     * Adds a new project. Custom fields should be wrapped in the `custom_fields` object.
+     * @summary Add a project
+     * @param {ProjectsApiAddProjectRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectsApi
+     */
+    addProject(requestParameters) {
+        return ProjectsApiFp(this.configuration).addProject(requestParameters.AddProjectRequest).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Archives a project.
+     * @summary Archive a project
+     * @param {ProjectsApiArchiveProjectRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectsApi
+     */
+    archiveProject(requestParameters) {
+        return ProjectsApiFp(this.configuration).archiveProject(requestParameters.id).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Marks a project as deleted.
+     * @summary Delete a project
+     * @param {ProjectsApiDeleteProjectRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectsApi
+     */
+    deleteProject(requestParameters) {
+        return ProjectsApiFp(this.configuration).deleteProject(requestParameters.id).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Returns all archived projects.
+     * @summary Get all archived projects
+     * @param {ProjectsApiGetArchivedProjectsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectsApi
+     */
+    getArchivedProjects(requestParameters = {}) {
+        return ProjectsApiFp(this.configuration).getArchivedProjects(requestParameters.filter_id, requestParameters.status, requestParameters.phase_id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Returns the details of a specific project. Custom fields appear as keys inside the `custom_fields` object.
+     * @summary Get details of a project
+     * @param {ProjectsApiGetProjectRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectsApi
+     */
+    getProject(requestParameters) {
+        return ProjectsApiFp(this.configuration).getProject(requestParameters.id).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Lists updates about field values of a project.
+     * @summary List updates about project field values
+     * @param {ProjectsApiGetProjectChangelogRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectsApi
+     */
+    getProjectChangelog(requestParameters) {
+        return ProjectsApiFp(this.configuration).getProjectChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Lists the users permitted to access a project.
+     * @summary List permitted users
+     * @param {ProjectsApiGetProjectUsersRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectsApi
+     */
+    getProjectUsers(requestParameters) {
+        return ProjectsApiFp(this.configuration).getProjectUsers(requestParameters.id).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Returns all non-archived projects.
+     * @summary Get all projects
+     * @param {ProjectsApiGetProjectsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectsApi
+     */
+    getProjects(requestParameters = {}) {
+        return ProjectsApiFp(this.configuration).getProjects(requestParameters.filter_id, requestParameters.status, requestParameters.phase_id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Searches all projects by title, description, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found projects can be filtered by person ID or organization ID.
+     * @summary Search projects
+     * @param {ProjectsApiSearchProjectsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectsApi
+     */
+    searchProjects(requestParameters) {
+        return ProjectsApiFp(this.configuration).searchProjects(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.person_id, requestParameters.organization_id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Updates the properties of a project.
+     * @summary Update a project
+     * @param {ProjectsApiUpdateProjectRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectsApi
+     */
+    updateProject(requestParameters) {
+        return ProjectsApiFp(this.configuration).updateProject(requestParameters.id, requestParameters.UpdateProjectRequest).then((request) => request(this.axios, this.basePath));
+    }
+}