pipedrive 30.6.0 → 30.7.0

package/dist/esm/versions/v2/api/activity-fields-api.d.ts

@@ -0,0 +1,158 @@
+/**
+ * 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 { GetActivityField200Response } from '../models';
+import { GetActivityFields200Response } from '../models';
+/**
+ * ActivityFieldsApi - axios parameter creator
+ * @export
+ */
+export declare const ActivityFieldsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Returns metadata about a specific activity field.
+     * @summary Get one activity field
+     * @param {string} field_code The unique code identifying the field
+     * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+
+     * @throws {RequiredError}
+     */
+    getActivityField: (field_code: string, include_fields?: 'ui_visibility') => Promise<RequestArgs>;
+    /**
+     * Returns metadata about all activity fields in the company.
+     * @summary Get all activity fields
+     * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+     * @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}
+     */
+    getActivityFields: (include_fields?: 'ui_visibility', limit?: number, cursor?: string) => Promise<RequestArgs>;
+};
+/**
+ * ActivityFieldsApi - functional programming interface
+ * @export
+ */
+export declare const ActivityFieldsApiFp: (configuration?: Configuration) => {
+    /**
+     * Returns metadata about a specific activity field.
+     * @summary Get one activity field
+     * @param {string} field_code The unique code identifying the field
+     * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+
+     * @throws {RequiredError}
+     */
+    getActivityField(field_code: string, include_fields?: 'ui_visibility'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivityField200Response>>;
+    /**
+     * Returns metadata about all activity fields in the company.
+     * @summary Get all activity fields
+     * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+     * @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}
+     */
+    getActivityFields(include_fields?: 'ui_visibility', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivityFields200Response>>;
+};
+/**
+ * ActivityFieldsApi - factory interface
+ * @export
+ */
+export declare const ActivityFieldsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Returns metadata about a specific activity field.
+     * @summary Get one activity field
+     * @param {ActivityFieldsApiGetActivityFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getActivityField(requestParameters: ActivityFieldsApiGetActivityFieldRequest): Promise<GetActivityField200Response>;
+    /**
+     * Returns metadata about all activity fields in the company.
+     * @summary Get all activity fields
+     * @param {ActivityFieldsApiGetActivityFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getActivityFields(requestParameters?: ActivityFieldsApiGetActivityFieldsRequest): Promise<GetActivityFields200Response>;
+};
+/**
+ * Request parameters for getActivityField operation in ActivityFieldsApi.
+ * @export
+ * @interface ActivityFieldsApiGetActivityFieldRequest
+ */
+export interface ActivityFieldsApiGetActivityFieldRequest {
+    /**
+     * The unique code identifying the field
+     * @type {string}
+     * @memberof ActivityFieldsApiGetActivityField
+     */
+    readonly field_code: string;
+    /**
+     * Optional comma separated string array of additional data namespaces to include in response
+     * @type {'ui_visibility'}
+     * @memberof ActivityFieldsApiGetActivityField
+     */
+    readonly include_fields?: 'ui_visibility';
+}
+/**
+ * Request parameters for getActivityFields operation in ActivityFieldsApi.
+ * @export
+ * @interface ActivityFieldsApiGetActivityFieldsRequest
+ */
+export interface ActivityFieldsApiGetActivityFieldsRequest {
+    /**
+     * Optional comma separated string array of additional data namespaces to include in response
+     * @type {'ui_visibility'}
+     * @memberof ActivityFieldsApiGetActivityFields
+     */
+    readonly include_fields?: 'ui_visibility';
+    /**
+     * 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 ActivityFieldsApiGetActivityFields
+     */
+    readonly limit?: number;
+    /**
+     * For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @type {string}
+     * @memberof ActivityFieldsApiGetActivityFields
+     */
+    readonly cursor?: string;
+}
+/**
+ * ActivityFieldsApi - object-oriented interface
+ * @export
+ * @class ActivityFieldsApi
+ * @extends {BaseAPI}
+ */
+export declare class ActivityFieldsApi extends BaseAPI {
+    /**
+     * Returns metadata about a specific activity field.
+     * @summary Get one activity field
+     * @param {ActivityFieldsApiGetActivityFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ActivityFieldsApi
+     */
+    getActivityField(requestParameters: ActivityFieldsApiGetActivityFieldRequest): Promise<GetActivityField200Response>;
+    /**
+     * Returns metadata about all activity fields in the company.
+     * @summary Get all activity fields
+     * @param {ActivityFieldsApiGetActivityFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ActivityFieldsApi
+     */
+    getActivityFields(requestParameters?: ActivityFieldsApiGetActivityFieldsRequest): Promise<GetActivityFields200Response>;
+}

package/dist/esm/versions/v2/api/activity-fields-api.js

@@ -0,0 +1,213 @@
+/* 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';
+/**
+ * ActivityFieldsApi - axios parameter creator
+ * @export
+ */
+export const ActivityFieldsApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Returns metadata about a specific activity field.
+         * @summary Get one activity field
+         * @param {string} field_code The unique code identifying the field
+         * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+
+         * @throws {RequiredError}
+         */
+        getActivityField: (field_code, include_fields) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'field_code' is not null or undefined
+            assertParamExists('getActivityField', 'field_code', field_code);
+            const localVarPath = `/activityFields/{field_code}`
+                .replace(`{${"field_code"}}`, encodeURIComponent(String(field_code)));
+            // 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", ["admin"], configuration);
+            if (include_fields !== undefined) {
+                localVarQueryParameter['include_fields'] = include_fields;
+            }
+            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 metadata about all activity fields in the company.
+         * @summary Get all activity fields
+         * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+         * @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}
+         */
+        getActivityFields: (include_fields, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = `/activityFields`;
+            // 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", ["admin"], configuration);
+            if (include_fields !== undefined) {
+                localVarQueryParameter['include_fields'] = include_fields;
+            }
+            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,
+            };
+        }),
+    };
+};
+/**
+ * ActivityFieldsApi - functional programming interface
+ * @export
+ */
+export const ActivityFieldsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = ActivityFieldsApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Returns metadata about a specific activity field.
+         * @summary Get one activity field
+         * @param {string} field_code The unique code identifying the field
+         * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+
+         * @throws {RequiredError}
+         */
+        getActivityField(field_code, include_fields) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getActivityField(field_code, include_fields);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Returns metadata about all activity fields in the company.
+         * @summary Get all activity fields
+         * @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+         * @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}
+         */
+        getActivityFields(include_fields, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getActivityFields(include_fields, limit, cursor);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+    };
+};
+/**
+ * ActivityFieldsApi - factory interface
+ * @export
+ */
+export const ActivityFieldsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = ActivityFieldsApiFp(configuration);
+    return {
+        /**
+         * Returns metadata about a specific activity field.
+         * @summary Get one activity field
+         * @param {ActivityFieldsApiGetActivityFieldRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getActivityField(requestParameters) {
+            return localVarFp.getActivityField(requestParameters.field_code, requestParameters.include_fields).then((request) => request(axios, basePath));
+        },
+        /**
+         * Returns metadata about all activity fields in the company.
+         * @summary Get all activity fields
+         * @param {ActivityFieldsApiGetActivityFieldsRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getActivityFields(requestParameters = {}) {
+            return localVarFp.getActivityFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * ActivityFieldsApi - object-oriented interface
+ * @export
+ * @class ActivityFieldsApi
+ * @extends {BaseAPI}
+ */
+export class ActivityFieldsApi extends BaseAPI {
+    /**
+     * Returns metadata about a specific activity field.
+     * @summary Get one activity field
+     * @param {ActivityFieldsApiGetActivityFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ActivityFieldsApi
+     */
+    getActivityField(requestParameters) {
+        return ActivityFieldsApiFp(this.configuration).getActivityField(requestParameters.field_code, requestParameters.include_fields).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Returns metadata about all activity fields in the company.
+     * @summary Get all activity fields
+     * @param {ActivityFieldsApiGetActivityFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ActivityFieldsApi
+     */
+    getActivityFields(requestParameters = {}) {
+        return ActivityFieldsApiFp(this.configuration).getActivityFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
+}