pipedrive 30.5.0 → 30.6.0

package/dist/esm/versions/v1/api/lead-fields-api.d.ts

@@ -0,0 +1,95 @@
+/**
+ * Pipedrive API v1
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.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 { GetFieldsResponse } from '../models';
+/**
+ * LeadFieldsApi - axios parameter creator
+ * @export
+ */
+export declare const LeadFieldsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Returns data about all lead fields.
+     * @summary Get all lead fields
+     * @param {number} [start] Pagination start
+     * @param {number} [limit] Items shown per page
+
+     * @throws {RequiredError}
+     */
+    getLeadFields: (start?: number, limit?: number) => Promise<RequestArgs>;
+};
+/**
+ * LeadFieldsApi - functional programming interface
+ * @export
+ */
+export declare const LeadFieldsApiFp: (configuration?: Configuration) => {
+    /**
+     * Returns data about all lead fields.
+     * @summary Get all lead fields
+     * @param {number} [start] Pagination start
+     * @param {number} [limit] Items shown per page
+
+     * @throws {RequiredError}
+     */
+    getLeadFields(start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFieldsResponse>>;
+};
+/**
+ * LeadFieldsApi - factory interface
+ * @export
+ */
+export declare const LeadFieldsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Returns data about all lead fields.
+     * @summary Get all lead fields
+     * @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getLeadFields(requestParameters?: LeadFieldsApiGetLeadFieldsRequest): Promise<GetFieldsResponse>;
+};
+/**
+ * Request parameters for getLeadFields operation in LeadFieldsApi.
+ * @export
+ * @interface LeadFieldsApiGetLeadFieldsRequest
+ */
+export interface LeadFieldsApiGetLeadFieldsRequest {
+    /**
+     * Pagination start
+     * @type {number}
+     * @memberof LeadFieldsApiGetLeadFields
+     */
+    readonly start?: number;
+    /**
+     * Items shown per page
+     * @type {number}
+     * @memberof LeadFieldsApiGetLeadFields
+     */
+    readonly limit?: number;
+}
+/**
+ * LeadFieldsApi - object-oriented interface
+ * @export
+ * @class LeadFieldsApi
+ * @extends {BaseAPI}
+ */
+export declare class LeadFieldsApi extends BaseAPI {
+    /**
+     * Returns data about all lead fields.
+     * @summary Get all lead fields
+     * @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof LeadFieldsApi
+     */
+    getLeadFields(requestParameters?: LeadFieldsApiGetLeadFieldsRequest): Promise<GetFieldsResponse>;
+}

package/dist/esm/versions/v1/api/lead-fields-api.js

@@ -0,0 +1,135 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pipedrive API v1
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.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, setApiKeyToObject, setOAuthToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, BaseAPI } from '../base';
+/**
+ * LeadFieldsApi - axios parameter creator
+ * @export
+ */
+export const LeadFieldsApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Returns data about all lead fields.
+         * @summary Get all lead fields
+         * @param {number} [start] Pagination start
+         * @param {number} [limit] Items shown per page
+
+         * @throws {RequiredError}
+         */
+        getLeadFields: (start, limit) => __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = `/leadFields`;
+            // 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", ["leads:read", "leads:full", "admin"], configuration);
+            if (start !== undefined) {
+                localVarQueryParameter['start'] = start;
+            }
+            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,
+            };
+        }),
+    };
+};
+/**
+ * LeadFieldsApi - functional programming interface
+ * @export
+ */
+export const LeadFieldsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = LeadFieldsApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Returns data about all lead fields.
+         * @summary Get all lead fields
+         * @param {number} [start] Pagination start
+         * @param {number} [limit] Items shown per page
+
+         * @throws {RequiredError}
+         */
+        getLeadFields(start, limit) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeadFields(start, limit);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+    };
+};
+/**
+ * LeadFieldsApi - factory interface
+ * @export
+ */
+export const LeadFieldsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = LeadFieldsApiFp(configuration);
+    return {
+        /**
+         * Returns data about all lead fields.
+         * @summary Get all lead fields
+         * @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getLeadFields(requestParameters = {}) {
+            return localVarFp.getLeadFields(requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * LeadFieldsApi - object-oriented interface
+ * @export
+ * @class LeadFieldsApi
+ * @extends {BaseAPI}
+ */
+export class LeadFieldsApi extends BaseAPI {
+    /**
+     * Returns data about all lead fields.
+     * @summary Get all lead fields
+     * @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof LeadFieldsApi
+     */
+    getLeadFields(requestParameters = {}) {
+        return LeadFieldsApiFp(this.configuration).getLeadFields(requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
+    }
+}

package/dist/esm/versions/v1/api.d.ts

@@ -22,6 +22,7 @@ export * from './api/files-api';
 export * from './api/filters-api';
 export * from './api/goals-api';
 export * from './api/item-search-api';
+export * from './api/lead-fields-api';
 export * from './api/lead-labels-api';
 export * from './api/lead-sources-api';
 export * from './api/leads-api';

package/dist/esm/versions/v1/api.js

@@ -24,6 +24,7 @@ export * from './api/files-api';
 export * from './api/filters-api';
 export * from './api/goals-api';
 export * from './api/item-search-api';
+export * from './api/lead-fields-api';
 export * from './api/lead-labels-api';
 export * from './api/lead-sources-api';
 export * from './api/leads-api';

package/dist/versions/v1/api/lead-fields-api.d.ts

@@ -0,0 +1,95 @@
+/**
+ * Pipedrive API v1
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.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 { GetFieldsResponse } from '../models';
+/**
+ * LeadFieldsApi - axios parameter creator
+ * @export
+ */
+export declare const LeadFieldsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Returns data about all lead fields.
+     * @summary Get all lead fields
+     * @param {number} [start] Pagination start
+     * @param {number} [limit] Items shown per page
+
+     * @throws {RequiredError}
+     */
+    getLeadFields: (start?: number, limit?: number) => Promise<RequestArgs>;
+};
+/**
+ * LeadFieldsApi - functional programming interface
+ * @export
+ */
+export declare const LeadFieldsApiFp: (configuration?: Configuration) => {
+    /**
+     * Returns data about all lead fields.
+     * @summary Get all lead fields
+     * @param {number} [start] Pagination start
+     * @param {number} [limit] Items shown per page
+
+     * @throws {RequiredError}
+     */
+    getLeadFields(start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFieldsResponse>>;
+};
+/**
+ * LeadFieldsApi - factory interface
+ * @export
+ */
+export declare const LeadFieldsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Returns data about all lead fields.
+     * @summary Get all lead fields
+     * @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getLeadFields(requestParameters?: LeadFieldsApiGetLeadFieldsRequest): Promise<GetFieldsResponse>;
+};
+/**
+ * Request parameters for getLeadFields operation in LeadFieldsApi.
+ * @export
+ * @interface LeadFieldsApiGetLeadFieldsRequest
+ */
+export interface LeadFieldsApiGetLeadFieldsRequest {
+    /**
+     * Pagination start
+     * @type {number}
+     * @memberof LeadFieldsApiGetLeadFields
+     */
+    readonly start?: number;
+    /**
+     * Items shown per page
+     * @type {number}
+     * @memberof LeadFieldsApiGetLeadFields
+     */
+    readonly limit?: number;
+}
+/**
+ * LeadFieldsApi - object-oriented interface
+ * @export
+ * @class LeadFieldsApi
+ * @extends {BaseAPI}
+ */
+export declare class LeadFieldsApi extends BaseAPI {
+    /**
+     * Returns data about all lead fields.
+     * @summary Get all lead fields
+     * @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof LeadFieldsApi
+     */
+    getLeadFields(requestParameters?: LeadFieldsApiGetLeadFieldsRequest): Promise<GetFieldsResponse>;
+}

package/dist/versions/v1/api/lead-fields-api.js

@@ -0,0 +1,145 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pipedrive API v1
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LeadFieldsApi = exports.LeadFieldsApiFactory = exports.LeadFieldsApiFp = exports.LeadFieldsApiAxiosParamCreator = void 0;
+const axios_1 = __importDefault(require("axios"));
+// Some imports not used depending on template conditions
+// @ts-ignore
+const common_1 = require("../common");
+// @ts-ignore
+const base_1 = require("../base");
+/**
+ * LeadFieldsApi - axios parameter creator
+ * @export
+ */
+const LeadFieldsApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Returns data about all lead fields.
+         * @summary Get all lead fields
+         * @param {number} [start] Pagination start
+         * @param {number} [limit] Items shown per page
+
+         * @throws {RequiredError}
+         */
+        getLeadFields: (start, limit) => __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = `/leadFields`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.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 (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["leads:read", "leads:full", "admin"], configuration);
+            if (start !== undefined) {
+                localVarQueryParameter['start'] = start;
+            }
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+exports.LeadFieldsApiAxiosParamCreator = LeadFieldsApiAxiosParamCreator;
+/**
+ * LeadFieldsApi - functional programming interface
+ * @export
+ */
+const LeadFieldsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = (0, exports.LeadFieldsApiAxiosParamCreator)(configuration);
+    return {
+        /**
+         * Returns data about all lead fields.
+         * @summary Get all lead fields
+         * @param {number} [start] Pagination start
+         * @param {number} [limit] Items shown per page
+
+         * @throws {RequiredError}
+         */
+        getLeadFields(start, limit) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeadFields(start, limit);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
+    };
+};
+exports.LeadFieldsApiFp = LeadFieldsApiFp;
+/**
+ * LeadFieldsApi - factory interface
+ * @export
+ */
+const LeadFieldsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = (0, exports.LeadFieldsApiFp)(configuration);
+    return {
+        /**
+         * Returns data about all lead fields.
+         * @summary Get all lead fields
+         * @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getLeadFields(requestParameters = {}) {
+            return localVarFp.getLeadFields(requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
+        },
+    };
+};
+exports.LeadFieldsApiFactory = LeadFieldsApiFactory;
+/**
+ * LeadFieldsApi - object-oriented interface
+ * @export
+ * @class LeadFieldsApi
+ * @extends {BaseAPI}
+ */
+class LeadFieldsApi extends base_1.BaseAPI {
+    /**
+     * Returns data about all lead fields.
+     * @summary Get all lead fields
+     * @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof LeadFieldsApi
+     */
+    getLeadFields(requestParameters = {}) {
+        return (0, exports.LeadFieldsApiFp)(this.configuration).getLeadFields(requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
+    }
+}
+exports.LeadFieldsApi = LeadFieldsApi;

package/dist/versions/v1/api.d.ts

@@ -22,6 +22,7 @@ export * from './api/files-api';
 export * from './api/filters-api';
 export * from './api/goals-api';
 export * from './api/item-search-api';
+export * from './api/lead-fields-api';
 export * from './api/lead-labels-api';
 export * from './api/lead-sources-api';
 export * from './api/leads-api';

package/dist/versions/v1/api.js

@@ -40,6 +40,7 @@ __exportStar(require("./api/files-api"), exports);
 __exportStar(require("./api/filters-api"), exports);
 __exportStar(require("./api/goals-api"), exports);
 __exportStar(require("./api/item-search-api"), exports);
+__exportStar(require("./api/lead-fields-api"), exports);
 __exportStar(require("./api/lead-labels-api"), exports);
 __exportStar(require("./api/lead-sources-api"), exports);
 __exportStar(require("./api/leads-api"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pipedrive",
-  "version": "30.5.0",
+  "version": "30.6.0",
   "description": "Pipedrive REST client for NodeJS",
   "license": "MIT",
   "homepage": "https://developers.pipedrive.com",