From 6b36039ea30e63b77002dd53930615a59e535cae Mon Sep 17 00:00:00 2001 From: pipedrive-bot Date: Tue, 2 Dec 2025 09:13:05 +0000 Subject: [PATCH] Build 295 - version-minor --- CHANGELOG.md | 32 + docs/v1.md | 1 + docs/v2.md | 34 + src/versions/v1/api.ts | 1 + src/versions/v1/api/lead-fields-api.ts | 164 ++++ src/versions/v2/api.ts | 5 + src/versions/v2/api/activity-fields-api.ts | 280 ++++++ src/versions/v2/api/deal-fields-api.ts | 880 ++++++++++++++++++ .../v2/api/organization-fields-api.ts | 880 ++++++++++++++++++ src/versions/v2/api/person-fields-api.ts | 880 ++++++++++++++++++ src/versions/v2/api/persons-api.ts | 23 +- src/versions/v2/api/product-fields-api.ts | 880 ++++++++++++++++++ .../add-deal-field-options-request-inner.ts | 29 + ...al-field-options200-response-data-inner.ts | 34 + .../add-deal-field-options200-response.ts | 42 + ...add-deal-field-request-important-fields.ts | 36 + .../add-deal-field-request-options-inner.ts | 29 + .../add-deal-field-request-required-fields.ts | 49 + ...request-ui-visibility-show-in-pipelines.ts | 34 + .../add-deal-field-request-ui-visibility.ts | 49 + .../v2/models/add-deal-field-request.ts | 93 ++ .../v2/models/add-deal-field200-response.ts | 37 + ...nization-field-request-important-fields.ts | 36 + ...anization-field-request-required-fields.ts | 31 + ...t-ui-visibility-show-in-add-deal-dialog.ts | 34 + ...ui-visibility-show-in-add-person-dialog.ts | 34 + ...rganization-field-request-ui-visibility.ts | 52 ++ .../models/add-organization-field-request.ts | 93 ++ .../add-organization-field200-response.ts | 37 + ...d-person-field-request-important-fields.ts | 36 + ...dd-person-field-request-required-fields.ts | 31 + ...t-ui-visibility-show-in-add-deal-dialog.ts | 34 + .../add-person-field-request-ui-visibility.ts | 44 + .../v2/models/add-person-field-request.ts | 93 ++ .../v2/models/add-person-field200-response.ts | 37 + ...add-product-field-request-ui-visibility.ts | 36 + .../v2/models/add-product-field-request.ts | 77 ++ ...delete-deal-field-options-request-inner.ts | 29 + .../delete-deal-field200-response-data.ts | 64 ++ .../models/delete-deal-field200-response.ts | 37 + .../delete-person-field200-response-data.ts | 59 ++ .../models/delete-person-field200-response.ts | 37 + .../models/get-activity-field200-response.ts | 37 + ...vity-fields200-response-additional-data.ts | 29 + ...ds200-response-data-inner-options-inner.ts | 49 + ...200-response-data-inner-subfields-inner.ts | 39 + ...ds200-response-data-inner-ui-visibility.ts | 34 + ...-activity-fields200-response-data-inner.ts | 112 +++ .../models/get-activity-fields200-response.ts | 45 + ...00-response-data-inner-important-fields.ts | 34 + ...200-response-data-inner-required-fields.ts | 47 + ...a-inner-ui-visibility-show-in-pipelines.ts | 34 + ...ds200-response-data-inner-ui-visibility.ts | 47 + .../get-deal-fields200-response-data-inner.ts | 133 +++ .../v2/models/get-deal-fields200-response.ts | 45 + ...ui-visibility-show-in-add-person-dialog.ts | 34 + ...ds200-response-data-inner-ui-visibility.ts | 50 + ...anization-fields200-response-data-inner.ts | 128 +++ .../get-organization-fields200-response.ts | 45 + ...00-response-data-inner-important-fields.ts | 34 + ...200-response-data-inner-required-fields.ts | 29 + ...r-ui-visibility-show-in-add-deal-dialog.ts | 34 + ...ds200-response-data-inner-ui-visibility.ts | 42 + ...et-person-fields200-response-data-inner.ts | 128 +++ .../models/get-person-fields200-response.ts | 45 + src/versions/v2/models/index.ts | 58 ++ ...update-deal-field-options-request-inner.ts | 34 + .../v2/models/update-deal-field-request.ts | 58 ++ .../update-organization-field-request.ts | 58 ++ .../v2/models/update-person-field-request.ts | 58 ++ .../v2/models/update-product-field-request.ts | 42 + 71 files changed, 6980 insertions(+), 5 deletions(-) create mode 100644 src/versions/v1/api/lead-fields-api.ts create mode 100644 src/versions/v2/api/activity-fields-api.ts create mode 100644 src/versions/v2/api/deal-fields-api.ts create mode 100644 src/versions/v2/api/organization-fields-api.ts create mode 100644 src/versions/v2/api/person-fields-api.ts create mode 100644 src/versions/v2/api/product-fields-api.ts create mode 100644 src/versions/v2/models/add-deal-field-options-request-inner.ts create mode 100644 src/versions/v2/models/add-deal-field-options200-response-data-inner.ts create mode 100644 src/versions/v2/models/add-deal-field-options200-response.ts create mode 100644 src/versions/v2/models/add-deal-field-request-important-fields.ts create mode 100644 src/versions/v2/models/add-deal-field-request-options-inner.ts create mode 100644 src/versions/v2/models/add-deal-field-request-required-fields.ts create mode 100644 src/versions/v2/models/add-deal-field-request-ui-visibility-show-in-pipelines.ts create mode 100644 src/versions/v2/models/add-deal-field-request-ui-visibility.ts create mode 100644 src/versions/v2/models/add-deal-field-request.ts create mode 100644 src/versions/v2/models/add-deal-field200-response.ts create mode 100644 src/versions/v2/models/add-organization-field-request-important-fields.ts create mode 100644 src/versions/v2/models/add-organization-field-request-required-fields.ts create mode 100644 src/versions/v2/models/add-organization-field-request-ui-visibility-show-in-add-deal-dialog.ts create mode 100644 src/versions/v2/models/add-organization-field-request-ui-visibility-show-in-add-person-dialog.ts create mode 100644 src/versions/v2/models/add-organization-field-request-ui-visibility.ts create mode 100644 src/versions/v2/models/add-organization-field-request.ts create mode 100644 src/versions/v2/models/add-organization-field200-response.ts create mode 100644 src/versions/v2/models/add-person-field-request-important-fields.ts create mode 100644 src/versions/v2/models/add-person-field-request-required-fields.ts create mode 100644 src/versions/v2/models/add-person-field-request-ui-visibility-show-in-add-deal-dialog.ts create mode 100644 src/versions/v2/models/add-person-field-request-ui-visibility.ts create mode 100644 src/versions/v2/models/add-person-field-request.ts create mode 100644 src/versions/v2/models/add-person-field200-response.ts create mode 100644 src/versions/v2/models/add-product-field-request-ui-visibility.ts create mode 100644 src/versions/v2/models/add-product-field-request.ts create mode 100644 src/versions/v2/models/delete-deal-field-options-request-inner.ts create mode 100644 src/versions/v2/models/delete-deal-field200-response-data.ts create mode 100644 src/versions/v2/models/delete-deal-field200-response.ts create mode 100644 src/versions/v2/models/delete-person-field200-response-data.ts create mode 100644 src/versions/v2/models/delete-person-field200-response.ts create mode 100644 src/versions/v2/models/get-activity-field200-response.ts create mode 100644 src/versions/v2/models/get-activity-fields200-response-additional-data.ts create mode 100644 src/versions/v2/models/get-activity-fields200-response-data-inner-options-inner.ts create mode 100644 src/versions/v2/models/get-activity-fields200-response-data-inner-subfields-inner.ts create mode 100644 src/versions/v2/models/get-activity-fields200-response-data-inner-ui-visibility.ts create mode 100644 src/versions/v2/models/get-activity-fields200-response-data-inner.ts create mode 100644 src/versions/v2/models/get-activity-fields200-response.ts create mode 100644 src/versions/v2/models/get-deal-fields200-response-data-inner-important-fields.ts create mode 100644 src/versions/v2/models/get-deal-fields200-response-data-inner-required-fields.ts create mode 100644 src/versions/v2/models/get-deal-fields200-response-data-inner-ui-visibility-show-in-pipelines.ts create mode 100644 src/versions/v2/models/get-deal-fields200-response-data-inner-ui-visibility.ts create mode 100644 src/versions/v2/models/get-deal-fields200-response-data-inner.ts create mode 100644 src/versions/v2/models/get-deal-fields200-response.ts create mode 100644 src/versions/v2/models/get-organization-fields200-response-data-inner-ui-visibility-show-in-add-person-dialog.ts create mode 100644 src/versions/v2/models/get-organization-fields200-response-data-inner-ui-visibility.ts create mode 100644 src/versions/v2/models/get-organization-fields200-response-data-inner.ts create mode 100644 src/versions/v2/models/get-organization-fields200-response.ts create mode 100644 src/versions/v2/models/get-person-fields200-response-data-inner-important-fields.ts create mode 100644 src/versions/v2/models/get-person-fields200-response-data-inner-required-fields.ts create mode 100644 src/versions/v2/models/get-person-fields200-response-data-inner-ui-visibility-show-in-add-deal-dialog.ts create mode 100644 src/versions/v2/models/get-person-fields200-response-data-inner-ui-visibility.ts create mode 100644 src/versions/v2/models/get-person-fields200-response-data-inner.ts create mode 100644 src/versions/v2/models/get-person-fields200-response.ts create mode 100644 src/versions/v2/models/update-deal-field-options-request-inner.ts create mode 100644 src/versions/v2/models/update-deal-field-request.ts create mode 100644 src/versions/v2/models/update-organization-field-request.ts create mode 100644 src/versions/v2/models/update-person-field-request.ts create mode 100644 src/versions/v2/models/update-product-field-request.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index e383c03c..5d065f12 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,38 @@ The file format of it is based on [Keep a Changelog](http://keepachangelog.com/e For public Changelog covering all changes done to Pipedrive’s API, webhooks and app extensions platforms, see [public Changelog](https://pipedrive.readme.io/docs/changelog) with discussion area in [Developers Community](https://devcommunity.pipedrive.com/c/documentation/changelog/19). ## [Unreleased] +### Added +- Documented the following new v2 endpoints: + - `GET /api/v2/activityFields` + - `GET /api/v2/dealFields` + - `GET /api/v2/organizationFields` + - `GET /api/v2/personFields` + - `GET /api/v2/productFields` + - `GET /api/v2/activityFields/{field_code}` + - `GET /api/v2/dealFields/{field_code}` + - `GET /api/v2/organizationFields/{field_code}` + - `GET /api/v2/personFields/{field_code}` + - `GET /api/v2/productFields/{field_code}` + - `POST /api/v2/dealFields` + - `POST /api/v2/organizationFields` + - `POST /api/v2/personFields` + - `POST /api/v2/productFields` + - `DELETE /api/v2/dealFields/{field_code}` + - `DELETE /api/v2/organizationFields/{field_code}` + - `DELETE /api/v2/personFields/{field_code}` + - `DELETE /api/v2/productFields/{field_code}` + - `POST /api/v2/dealFields/{field_code}/options` + - `POST /api/v2/organizationFields/{field_code}/options` + - `POST /api/v2/personFields/{field_code}/options` + - `POST /api/v2/productFields/{field_code}/options` + - `PATCH /api/v2/dealFields/{field_code}/options` + - `PATCH /api/v2/organizationFields/{field_code}/options` + - `PATCH /api/v2/personFields/{field_code}/options` + - `PATCH /api/v2/productFields/{field_code}/options` + - `DELETE /api/v2/dealFields/{field_code}/options` + - `DELETE /api/v2/organizationFields/{field_code}/options` + - `DELETE /api/v2/personFields/{field_code}/options` + - `DELETE /api/v2/productFields/{field_code}/options` ## [30.4.0] - 2025-11-18 ### Added diff --git a/docs/v1.md b/docs/v1.md index dca16f00..7e5b32bc 100644 --- a/docs/v1.md +++ b/docs/v1.md @@ -89,6 +89,7 @@ GoalsApi | getGoals | **GET** /goals/find | Find goals GoalsApi | updateGoal | **PUT** /goals/{id} | Update existing goal ItemSearchApi | searchItem | **GET** /itemSearch | Perform a search from multiple item types ItemSearchApi | searchItemByField | **GET** /itemSearch/field | Perform a search using a specific field from an item type +LeadFieldsApi | getLeadFields | **GET** /leadFields | Get all lead fields LeadLabelsApi | addLeadLabel | **POST** /leadLabels | Add a lead label LeadLabelsApi | deleteLeadLabel | **DELETE** /leadLabels/{id} | Delete a lead label LeadLabelsApi | getLeadLabels | **GET** /leadLabels | Get all lead labels diff --git a/docs/v2.md b/docs/v2.md index 709c81d1..758410a5 100644 --- a/docs/v2.md +++ b/docs/v2.md @@ -9,6 +9,8 @@ ActivitiesApi | deleteActivity | **DELETE** /activities/{id} | Delete an activit ActivitiesApi | getActivities | **GET** /activities | Get all activities ActivitiesApi | getActivity | **GET** /activities/{id} | Get details of an activity ActivitiesApi | updateActivity | **PATCH** /activities/{id} | Update an activity +ActivityFieldsApi | getActivityField | **GET** /activityFields/{field_code} | Get one activity field +ActivityFieldsApi | getActivityFields | **GET** /activityFields | Get all activity fields BetaApi | convertDealToLead | **POST** /deals/{id}/convert/lead | Convert a deal to a lead (BETA) BetaApi | convertLeadToDeal | **POST** /leads/{id}/convert/deal | Convert a lead to a deal (BETA) BetaApi | deleteInstallment | **DELETE** /deals/{id}/installments/{installment_id} | Delete an installment from a deal @@ -21,6 +23,14 @@ BetaApi | postInstallment | **POST** /deals/{id}/installments | Add an installme BetaApi | updateInstallment | **PATCH** /deals/{id}/installments/{installment_id} | Update an installment added to a deal BetaApi | updateProductImage | **PUT** /products/{id}/images | Update an image for a product BetaApi | uploadProductImage | **POST** /products/{id}/images | Upload an image for a product +DealFieldsApi | addDealField | **POST** /dealFields | Create one deal field +DealFieldsApi | addDealFieldOptions | **POST** /dealFields/{field_code}/options | Add deal field options in bulk +DealFieldsApi | deleteDealField | **DELETE** /dealFields/{field_code} | Delete one deal field +DealFieldsApi | deleteDealFieldOptions | **DELETE** /dealFields/{field_code}/options | Delete deal field options in bulk +DealFieldsApi | getDealField | **GET** /dealFields/{field_code} | Get one deal field +DealFieldsApi | getDealFields | **GET** /dealFields | Get all deal fields +DealFieldsApi | updateDealField | **PATCH** /dealFields/{field_code} | Update one deal field +DealFieldsApi | updateDealFieldOptions | **PATCH** /dealFields/{field_code}/options | Update deal field options in bulk DealsApi | addDeal | **POST** /deals | Add a new deal DealsApi | addDealFollower | **POST** /deals/{id}/followers | Add a follower to a deal DealsApi | addDealProduct | **POST** /deals/{id}/products | Add a product to a deal @@ -54,6 +64,14 @@ ItemSearchApi | searchItemByField | **GET** /itemSearch/field | Perform a search LeadsApi | convertLeadToDeal | **POST** /leads/{id}/convert/deal | Convert a lead to a deal (BETA) LeadsApi | getLeadConversionStatus | **GET** /leads/{id}/convert/status/{conversion_id} | Get Lead conversion status (BETA) LeadsApi | searchLeads | **GET** /leads/search | Search leads +OrganizationFieldsApi | addOrganizationField | **POST** /organizationFields | Create one organization field +OrganizationFieldsApi | addOrganizationFieldOptions | **POST** /organizationFields/{field_code}/options | Add organization field options in bulk +OrganizationFieldsApi | deleteOrganizationField | **DELETE** /organizationFields/{field_code} | Delete one organization field +OrganizationFieldsApi | deleteOrganizationFieldOptions | **DELETE** /organizationFields/{field_code}/options | Delete organization field options in bulk +OrganizationFieldsApi | getOrganizationField | **GET** /organizationFields/{field_code} | Get one organization field +OrganizationFieldsApi | getOrganizationFields | **GET** /organizationFields | Get all organization fields +OrganizationFieldsApi | updateOrganizationField | **PATCH** /organizationFields/{field_code} | Update one organization field +OrganizationFieldsApi | updateOrganizationFieldOptions | **PATCH** /organizationFields/{field_code}/options | Update organization field options in bulk OrganizationsApi | addOrganization | **POST** /organizations | Add a new organization OrganizationsApi | addOrganizationFollower | **POST** /organizations/{id}/followers | Add a follower to an organization OrganizationsApi | deleteOrganization | **DELETE** /organizations/{id} | Delete a organization @@ -64,6 +82,14 @@ OrganizationsApi | getOrganizationFollowersChangelog | **GET** /organizations/{i OrganizationsApi | getOrganizations | **GET** /organizations | Get all organizations OrganizationsApi | searchOrganization | **GET** /organizations/search | Search organizations OrganizationsApi | updateOrganization | **PATCH** /organizations/{id} | Update a organization +PersonFieldsApi | addPersonField | **POST** /personFields | Create one person field +PersonFieldsApi | addPersonFieldOptions | **POST** /personFields/{field_code}/options | Add person field options in bulk +PersonFieldsApi | deletePersonField | **DELETE** /personFields/{field_code} | Delete one person field +PersonFieldsApi | deletePersonFieldOptions | **DELETE** /personFields/{field_code}/options | Delete person field options in bulk +PersonFieldsApi | getPersonField | **GET** /personFields/{field_code} | Get one person field +PersonFieldsApi | getPersonFields | **GET** /personFields | Get all person fields +PersonFieldsApi | updatePersonField | **PATCH** /personFields/{field_code} | Update one person field +PersonFieldsApi | updatePersonFieldOptions | **PATCH** /personFields/{field_code}/options | Update person field options in bulk PersonsApi | addPerson | **POST** /persons | Add a new person PersonsApi | addPersonFollower | **POST** /persons/{id}/followers | Add a follower to a person PersonsApi | deletePerson | **DELETE** /persons/{id} | Delete a person @@ -79,6 +105,14 @@ PipelinesApi | deletePipeline | **DELETE** /pipelines/{id} | Delete a pipeline PipelinesApi | getPipeline | **GET** /pipelines/{id} | Get one pipeline PipelinesApi | getPipelines | **GET** /pipelines | Get all pipelines PipelinesApi | updatePipeline | **PATCH** /pipelines/{id} | Update a pipeline +ProductFieldsApi | addProductField | **POST** /productFields | Create one product field +ProductFieldsApi | addProductFieldOptions | **POST** /productFields/{field_code}/options | Add product field options in bulk +ProductFieldsApi | deleteProductField | **DELETE** /productFields/{field_code} | Delete one product field +ProductFieldsApi | deleteProductFieldOptions | **DELETE** /productFields/{field_code}/options | Delete product field options in bulk +ProductFieldsApi | getProductField | **GET** /productFields/{field_code} | Get one product field +ProductFieldsApi | getProductFields | **GET** /productFields | Get all product fields +ProductFieldsApi | updateProductField | **PATCH** /productFields/{field_code} | Update one product field +ProductFieldsApi | updateProductFieldOptions | **PATCH** /productFields/{field_code}/options | Update product field options in bulk ProductsApi | addProduct | **POST** /products | Add a product ProductsApi | addProductFollower | **POST** /products/{id}/followers | Add a follower to a product ProductsApi | addProductVariation | **POST** /products/{id}/variations | Add a product variation diff --git a/src/versions/v1/api.ts b/src/versions/v1/api.ts index d08836dd..f0f65ace 100644 --- a/src/versions/v1/api.ts +++ b/src/versions/v1/api.ts @@ -27,6 +27,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'; diff --git a/src/versions/v1/api/lead-fields-api.ts b/src/versions/v1/api/lead-fields-api.ts new file mode 100644 index 00000000..cd5211e0 --- /dev/null +++ b/src/versions/v1/api/lead-fields-api.ts @@ -0,0 +1,164 @@ +/* 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. + */ + + +import type { Configuration } from '../configuration'; +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base'; +// @ts-ignore +import { GetFieldsResponse } from '../models'; +/** + * LeadFieldsApi - axios parameter creator + * @export + */ +export const LeadFieldsApiAxiosParamCreator = function (configuration?: 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: async (start?: number, limit?: number, ): Promise => { + 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 = { method: 'GET', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await 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 = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + + +/** + * LeadFieldsApi - functional programming interface + * @export + */ +export const LeadFieldsApiFp = function(configuration?: 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} + */ + async getLeadFields(start?: number, limit?: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getLeadFields(start, limit, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * LeadFieldsApi - factory interface + * @export + */ +export const LeadFieldsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + 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: LeadFieldsApiGetLeadFieldsRequest = {}, ): Promise { + return localVarFp.getLeadFields(requestParameters.start, requestParameters.limit, ).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * 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 class LeadFieldsApi extends BaseAPI { + /** + * Returns data about all lead fields. + * @summary Get all lead fields + * @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof LeadFieldsApi + */ + public getLeadFields(requestParameters: LeadFieldsApiGetLeadFieldsRequest = {}, ) { + return LeadFieldsApiFp(this.configuration).getLeadFields(requestParameters.start, requestParameters.limit, ).then((request) => request(this.axios, this.basePath)); + } +} diff --git a/src/versions/v2/api.ts b/src/versions/v2/api.ts index 9d558e6c..56ca884b 100644 --- a/src/versions/v2/api.ts +++ b/src/versions/v2/api.ts @@ -15,13 +15,18 @@ export * from './api/activities-api'; +export * from './api/activity-fields-api'; export * from './api/beta-api'; +export * from './api/deal-fields-api'; export * from './api/deals-api'; export * from './api/item-search-api'; export * from './api/leads-api'; +export * from './api/organization-fields-api'; export * from './api/organizations-api'; +export * from './api/person-fields-api'; export * from './api/persons-api'; export * from './api/pipelines-api'; +export * from './api/product-fields-api'; export * from './api/products-api'; export * from './api/stages-api'; export * from './api/users-api'; diff --git a/src/versions/v2/api/activity-fields-api.ts b/src/versions/v2/api/activity-fields-api.ts new file mode 100644 index 00000000..597a1648 --- /dev/null +++ b/src/versions/v2/api/activity-fields-api.ts @@ -0,0 +1,280 @@ +/* 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. + */ + + +import type { Configuration } from '../configuration'; +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base'; +// @ts-ignore +import { GetActivityField200Response } from '../models'; +// @ts-ignore +import { GetActivityFields200Response } from '../models'; +/** + * ActivityFieldsApi - axios parameter creator + * @export + */ +export const ActivityFieldsApiAxiosParamCreator = function (configuration?: 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: async (field_code: string, include_fields?: 'ui_visibility', ): Promise => { + // 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 = { method: 'GET', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await 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 = {...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: async (include_fields?: 'ui_visibility', limit?: number, cursor?: string, ): Promise => { + 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 = { method: 'GET', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await 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 = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + + +/** + * ActivityFieldsApi - functional programming interface + * @export + */ +export const ActivityFieldsApiFp = function(configuration?: 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} + */ + async getActivityField(field_code: string, include_fields?: 'ui_visibility', ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await 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} + */ + async getActivityFields(include_fields?: 'ui_visibility', limit?: number, cursor?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getActivityFields(include_fields, limit, cursor, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * ActivityFieldsApi - factory interface + * @export + */ +export const ActivityFieldsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + 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: ActivityFieldsApiGetActivityFieldRequest, ): Promise { + 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: ActivityFieldsApiGetActivityFieldsRequest = {}, ): Promise { + return localVarFp.getActivityFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor, ).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * 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 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 + */ + public getActivityField(requestParameters: ActivityFieldsApiGetActivityFieldRequest, ) { + 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 + */ + public getActivityFields(requestParameters: ActivityFieldsApiGetActivityFieldsRequest = {}, ) { + return ActivityFieldsApiFp(this.configuration).getActivityFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor, ).then((request) => request(this.axios, this.basePath)); + } +} diff --git a/src/versions/v2/api/deal-fields-api.ts b/src/versions/v2/api/deal-fields-api.ts new file mode 100644 index 00000000..35d1c8a5 --- /dev/null +++ b/src/versions/v2/api/deal-fields-api.ts @@ -0,0 +1,880 @@ +/* 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. + */ + + +import type { Configuration } from '../configuration'; +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base'; +// @ts-ignore +import { AddDealField200Response } from '../models'; +// @ts-ignore +import { AddDealFieldOptions200Response } from '../models'; +// @ts-ignore +import { AddDealFieldOptionsRequestInner } from '../models'; +// @ts-ignore +import { AddDealFieldRequest } from '../models'; +// @ts-ignore +import { DeleteDealField200Response } from '../models'; +// @ts-ignore +import { DeleteDealFieldOptionsRequestInner } from '../models'; +// @ts-ignore +import { GetDealFields200Response } from '../models'; +// @ts-ignore +import { UpdateDealFieldOptionsRequestInner } from '../models'; +// @ts-ignore +import { UpdateDealFieldRequest } from '../models'; +/** + * DealFieldsApi - axios parameter creator + * @export + */ +export const DealFieldsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Creates a new deal custom field. + * @summary Create one deal field + * @param {AddDealFieldRequest} AddDealFieldRequest + + * @throws {RequiredError} + */ + addDealField: async (AddDealFieldRequest: AddDealFieldRequest, ): Promise => { + // verify required parameter 'AddDealFieldRequest' is not null or undefined + assertParamExists('addDealField', 'AddDealFieldRequest', AddDealFieldRequest) + const localVarPath = `/dealFields`; + // 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 = { method: 'POST', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["admin"], configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + localVarRequestOptions.data = serializeDataIfNeeded(AddDealFieldRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Adds new options to a deal custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options. + * @summary Add deal field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} AddDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + addDealFieldOptions: async (field_code: string, AddDealFieldOptionsRequestInner: Array, ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('addDealFieldOptions', 'field_code', field_code) + // verify required parameter 'AddDealFieldOptionsRequestInner' is not null or undefined + assertParamExists('addDealFieldOptions', 'AddDealFieldOptionsRequestInner', AddDealFieldOptionsRequestInner) + const localVarPath = `/dealFields/{field_code}/options` + .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 = { method: 'POST', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full", "admin"], configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + localVarRequestOptions.data = serializeDataIfNeeded(AddDealFieldOptionsRequestInner, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Marks a custom field as deleted. + * @summary Delete one deal field + * @param {string} field_code The unique code identifying the field + + * @throws {RequiredError} + */ + deleteDealField: async (field_code: string, ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('deleteDealField', 'field_code', field_code) + const localVarPath = `/dealFields/{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 = { method: 'DELETE', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["admin"], configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Removes existing options from a deal custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options. + * @summary Delete deal field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} DeleteDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + deleteDealFieldOptions: async (field_code: string, DeleteDealFieldOptionsRequestInner: Array, ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('deleteDealFieldOptions', 'field_code', field_code) + // verify required parameter 'DeleteDealFieldOptionsRequestInner' is not null or undefined + assertParamExists('deleteDealFieldOptions', 'DeleteDealFieldOptionsRequestInner', DeleteDealFieldOptionsRequestInner) + const localVarPath = `/dealFields/{field_code}/options` + .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 = { method: 'DELETE', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full", "admin"], configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + localVarRequestOptions.data = serializeDataIfNeeded(DeleteDealFieldOptionsRequestInner, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns metadata about a specific deal field. + * @summary Get one deal field + * @param {string} field_code The unique code identifying the field + * @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [include_fields] Optional comma separated string array of additional data namespaces to include in response + + * @throws {RequiredError} + */ + getDealField: async (field_code: string, include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields', ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('getDealField', 'field_code', field_code) + const localVarPath = `/dealFields/{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 = { method: 'GET', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full", "admin"], configuration) + + if (include_fields !== undefined) { + localVarQueryParameter['include_fields'] = include_fields; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns metadata about all deal fields in the company. + * @summary Get all deal fields + * @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [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} + */ + getDealFields: async (include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields', limit?: number, cursor?: string, ): Promise => { + const localVarPath = `/dealFields`; + // 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 = { method: 'GET', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full", "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 = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Updates a deal custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body. + * @summary Update one deal field + * @param {string} field_code The unique code identifying the field + * @param {UpdateDealFieldRequest} UpdateDealFieldRequest + + * @throws {RequiredError} + */ + updateDealField: async (field_code: string, UpdateDealFieldRequest: UpdateDealFieldRequest, ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('updateDealField', 'field_code', field_code) + // verify required parameter 'UpdateDealFieldRequest' is not null or undefined + assertParamExists('updateDealField', 'UpdateDealFieldRequest', UpdateDealFieldRequest) + const localVarPath = `/dealFields/{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 = { method: 'PATCH', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full", "admin"], configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + localVarRequestOptions.data = serializeDataIfNeeded(UpdateDealFieldRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Updates existing options for a deal custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options. + * @summary Update deal field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} UpdateDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + updateDealFieldOptions: async (field_code: string, UpdateDealFieldOptionsRequestInner: Array, ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('updateDealFieldOptions', 'field_code', field_code) + // verify required parameter 'UpdateDealFieldOptionsRequestInner' is not null or undefined + assertParamExists('updateDealFieldOptions', 'UpdateDealFieldOptionsRequestInner', UpdateDealFieldOptionsRequestInner) + const localVarPath = `/dealFields/{field_code}/options` + .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 = { method: 'PATCH', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full", "admin"], configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + localVarRequestOptions.data = serializeDataIfNeeded(UpdateDealFieldOptionsRequestInner, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + + +/** + * DealFieldsApi - functional programming interface + * @export + */ +export const DealFieldsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = DealFieldsApiAxiosParamCreator(configuration) + return { + /** + * Creates a new deal custom field. + * @summary Create one deal field + * @param {AddDealFieldRequest} AddDealFieldRequest + + * @throws {RequiredError} + */ + async addDealField(AddDealFieldRequest: AddDealFieldRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.addDealField(AddDealFieldRequest, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Adds new options to a deal custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options. + * @summary Add deal field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} AddDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + async addDealFieldOptions(field_code: string, AddDealFieldOptionsRequestInner: Array, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.addDealFieldOptions(field_code, AddDealFieldOptionsRequestInner, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Marks a custom field as deleted. + * @summary Delete one deal field + * @param {string} field_code The unique code identifying the field + + * @throws {RequiredError} + */ + async deleteDealField(field_code: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDealField(field_code, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Removes existing options from a deal custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options. + * @summary Delete deal field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} DeleteDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + async deleteDealFieldOptions(field_code: string, DeleteDealFieldOptionsRequestInner: Array, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDealFieldOptions(field_code, DeleteDealFieldOptionsRequestInner, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Returns metadata about a specific deal field. + * @summary Get one deal field + * @param {string} field_code The unique code identifying the field + * @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [include_fields] Optional comma separated string array of additional data namespaces to include in response + + * @throws {RequiredError} + */ + async getDealField(field_code: string, include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields', ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getDealField(field_code, include_fields, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Returns metadata about all deal fields in the company. + * @summary Get all deal fields + * @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [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} + */ + async getDealFields(include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields', limit?: number, cursor?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getDealFields(include_fields, limit, cursor, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Updates a deal custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body. + * @summary Update one deal field + * @param {string} field_code The unique code identifying the field + * @param {UpdateDealFieldRequest} UpdateDealFieldRequest + + * @throws {RequiredError} + */ + async updateDealField(field_code: string, UpdateDealFieldRequest: UpdateDealFieldRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateDealField(field_code, UpdateDealFieldRequest, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Updates existing options for a deal custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options. + * @summary Update deal field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} UpdateDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + async updateDealFieldOptions(field_code: string, UpdateDealFieldOptionsRequestInner: Array, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateDealFieldOptions(field_code, UpdateDealFieldOptionsRequestInner, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * DealFieldsApi - factory interface + * @export + */ +export const DealFieldsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = DealFieldsApiFp(configuration) + return { + /** + * Creates a new deal custom field. + * @summary Create one deal field + * @param {DealFieldsApiAddDealFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + addDealField(requestParameters: DealFieldsApiAddDealFieldRequest, ): Promise { + return localVarFp.addDealField(requestParameters.AddDealFieldRequest, ).then((request) => request(axios, basePath)); + }, + /** + * Adds new options to a deal custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options. + * @summary Add deal field options in bulk + * @param {DealFieldsApiAddDealFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + addDealFieldOptions(requestParameters: DealFieldsApiAddDealFieldOptionsRequest, ): Promise { + return localVarFp.addDealFieldOptions(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner, ).then((request) => request(axios, basePath)); + }, + /** + * Marks a custom field as deleted. + * @summary Delete one deal field + * @param {DealFieldsApiDeleteDealFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + deleteDealField(requestParameters: DealFieldsApiDeleteDealFieldRequest, ): Promise { + return localVarFp.deleteDealField(requestParameters.field_code, ).then((request) => request(axios, basePath)); + }, + /** + * Removes existing options from a deal custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options. + * @summary Delete deal field options in bulk + * @param {DealFieldsApiDeleteDealFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + deleteDealFieldOptions(requestParameters: DealFieldsApiDeleteDealFieldOptionsRequest, ): Promise { + return localVarFp.deleteDealFieldOptions(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner, ).then((request) => request(axios, basePath)); + }, + /** + * Returns metadata about a specific deal field. + * @summary Get one deal field + * @param {DealFieldsApiGetDealFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + getDealField(requestParameters: DealFieldsApiGetDealFieldRequest, ): Promise { + return localVarFp.getDealField(requestParameters.field_code, requestParameters.include_fields, ).then((request) => request(axios, basePath)); + }, + /** + * Returns metadata about all deal fields in the company. + * @summary Get all deal fields + * @param {DealFieldsApiGetDealFieldsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + getDealFields(requestParameters: DealFieldsApiGetDealFieldsRequest = {}, ): Promise { + return localVarFp.getDealFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor, ).then((request) => request(axios, basePath)); + }, + /** + * Updates a deal custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body. + * @summary Update one deal field + * @param {DealFieldsApiUpdateDealFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + updateDealField(requestParameters: DealFieldsApiUpdateDealFieldRequest, ): Promise { + return localVarFp.updateDealField(requestParameters.field_code, requestParameters.UpdateDealFieldRequest, ).then((request) => request(axios, basePath)); + }, + /** + * Updates existing options for a deal custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options. + * @summary Update deal field options in bulk + * @param {DealFieldsApiUpdateDealFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + updateDealFieldOptions(requestParameters: DealFieldsApiUpdateDealFieldOptionsRequest, ): Promise { + return localVarFp.updateDealFieldOptions(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner, ).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for addDealField operation in DealFieldsApi. + * @export + * @interface DealFieldsApiAddDealFieldRequest + */ +export interface DealFieldsApiAddDealFieldRequest { + /** + * + * @type {AddDealFieldRequest} + * @memberof DealFieldsApiAddDealField + */ + readonly AddDealFieldRequest: AddDealFieldRequest +} + +/** + * Request parameters for addDealFieldOptions operation in DealFieldsApi. + * @export + * @interface DealFieldsApiAddDealFieldOptionsRequest + */ +export interface DealFieldsApiAddDealFieldOptionsRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof DealFieldsApiAddDealFieldOptions + */ + readonly field_code: string + + /** + * + * @type {Array} + * @memberof DealFieldsApiAddDealFieldOptions + */ + readonly AddDealFieldOptionsRequestInner: Array +} + +/** + * Request parameters for deleteDealField operation in DealFieldsApi. + * @export + * @interface DealFieldsApiDeleteDealFieldRequest + */ +export interface DealFieldsApiDeleteDealFieldRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof DealFieldsApiDeleteDealField + */ + readonly field_code: string +} + +/** + * Request parameters for deleteDealFieldOptions operation in DealFieldsApi. + * @export + * @interface DealFieldsApiDeleteDealFieldOptionsRequest + */ +export interface DealFieldsApiDeleteDealFieldOptionsRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof DealFieldsApiDeleteDealFieldOptions + */ + readonly field_code: string + + /** + * + * @type {Array} + * @memberof DealFieldsApiDeleteDealFieldOptions + */ + readonly DeleteDealFieldOptionsRequestInner: Array +} + +/** + * Request parameters for getDealField operation in DealFieldsApi. + * @export + * @interface DealFieldsApiGetDealFieldRequest + */ +export interface DealFieldsApiGetDealFieldRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof DealFieldsApiGetDealField + */ + readonly field_code: string + + /** + * Optional comma separated string array of additional data namespaces to include in response + * @type {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} + * @memberof DealFieldsApiGetDealField + */ + readonly include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields' +} + +/** + * Request parameters for getDealFields operation in DealFieldsApi. + * @export + * @interface DealFieldsApiGetDealFieldsRequest + */ +export interface DealFieldsApiGetDealFieldsRequest { + /** + * Optional comma separated string array of additional data namespaces to include in response + * @type {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} + * @memberof DealFieldsApiGetDealFields + */ + readonly include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields' + + /** + * 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 DealFieldsApiGetDealFields + */ + readonly limit?: number + + /** + * For pagination, the marker (an opaque string value) representing the first item on the next page + * @type {string} + * @memberof DealFieldsApiGetDealFields + */ + readonly cursor?: string +} + +/** + * Request parameters for updateDealField operation in DealFieldsApi. + * @export + * @interface DealFieldsApiUpdateDealFieldRequest + */ +export interface DealFieldsApiUpdateDealFieldRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof DealFieldsApiUpdateDealField + */ + readonly field_code: string + + /** + * + * @type {UpdateDealFieldRequest} + * @memberof DealFieldsApiUpdateDealField + */ + readonly UpdateDealFieldRequest: UpdateDealFieldRequest +} + +/** + * Request parameters for updateDealFieldOptions operation in DealFieldsApi. + * @export + * @interface DealFieldsApiUpdateDealFieldOptionsRequest + */ +export interface DealFieldsApiUpdateDealFieldOptionsRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof DealFieldsApiUpdateDealFieldOptions + */ + readonly field_code: string + + /** + * + * @type {Array} + * @memberof DealFieldsApiUpdateDealFieldOptions + */ + readonly UpdateDealFieldOptionsRequestInner: Array +} + +/** + * DealFieldsApi - object-oriented interface + * @export + * @class DealFieldsApi + * @extends {BaseAPI} + */ +export class DealFieldsApi extends BaseAPI { + /** + * Creates a new deal custom field. + * @summary Create one deal field + * @param {DealFieldsApiAddDealFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof DealFieldsApi + */ + public addDealField(requestParameters: DealFieldsApiAddDealFieldRequest, ) { + return DealFieldsApiFp(this.configuration).addDealField(requestParameters.AddDealFieldRequest, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Adds new options to a deal custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options. + * @summary Add deal field options in bulk + * @param {DealFieldsApiAddDealFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof DealFieldsApi + */ + public addDealFieldOptions(requestParameters: DealFieldsApiAddDealFieldOptionsRequest, ) { + return DealFieldsApiFp(this.configuration).addDealFieldOptions(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Marks a custom field as deleted. + * @summary Delete one deal field + * @param {DealFieldsApiDeleteDealFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof DealFieldsApi + */ + public deleteDealField(requestParameters: DealFieldsApiDeleteDealFieldRequest, ) { + return DealFieldsApiFp(this.configuration).deleteDealField(requestParameters.field_code, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Removes existing options from a deal custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options. + * @summary Delete deal field options in bulk + * @param {DealFieldsApiDeleteDealFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof DealFieldsApi + */ + public deleteDealFieldOptions(requestParameters: DealFieldsApiDeleteDealFieldOptionsRequest, ) { + return DealFieldsApiFp(this.configuration).deleteDealFieldOptions(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns metadata about a specific deal field. + * @summary Get one deal field + * @param {DealFieldsApiGetDealFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof DealFieldsApi + */ + public getDealField(requestParameters: DealFieldsApiGetDealFieldRequest, ) { + return DealFieldsApiFp(this.configuration).getDealField(requestParameters.field_code, requestParameters.include_fields, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns metadata about all deal fields in the company. + * @summary Get all deal fields + * @param {DealFieldsApiGetDealFieldsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof DealFieldsApi + */ + public getDealFields(requestParameters: DealFieldsApiGetDealFieldsRequest = {}, ) { + return DealFieldsApiFp(this.configuration).getDealFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates a deal custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body. + * @summary Update one deal field + * @param {DealFieldsApiUpdateDealFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof DealFieldsApi + */ + public updateDealField(requestParameters: DealFieldsApiUpdateDealFieldRequest, ) { + return DealFieldsApiFp(this.configuration).updateDealField(requestParameters.field_code, requestParameters.UpdateDealFieldRequest, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates existing options for a deal custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options. + * @summary Update deal field options in bulk + * @param {DealFieldsApiUpdateDealFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof DealFieldsApi + */ + public updateDealFieldOptions(requestParameters: DealFieldsApiUpdateDealFieldOptionsRequest, ) { + return DealFieldsApiFp(this.configuration).updateDealFieldOptions(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner, ).then((request) => request(this.axios, this.basePath)); + } +} diff --git a/src/versions/v2/api/organization-fields-api.ts b/src/versions/v2/api/organization-fields-api.ts new file mode 100644 index 00000000..1163d0b1 --- /dev/null +++ b/src/versions/v2/api/organization-fields-api.ts @@ -0,0 +1,880 @@ +/* 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. + */ + + +import type { Configuration } from '../configuration'; +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base'; +// @ts-ignore +import { AddDealFieldOptions200Response } from '../models'; +// @ts-ignore +import { AddDealFieldOptionsRequestInner } from '../models'; +// @ts-ignore +import { AddOrganizationField200Response } from '../models'; +// @ts-ignore +import { AddOrganizationFieldRequest } from '../models'; +// @ts-ignore +import { DeleteDealFieldOptionsRequestInner } from '../models'; +// @ts-ignore +import { DeletePersonField200Response } from '../models'; +// @ts-ignore +import { GetOrganizationFields200Response } from '../models'; +// @ts-ignore +import { UpdateDealFieldOptionsRequestInner } from '../models'; +// @ts-ignore +import { UpdateOrganizationFieldRequest } from '../models'; +/** + * OrganizationFieldsApi - axios parameter creator + * @export + */ +export const OrganizationFieldsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Creates a new organization custom field. + * @summary Create one organization field + * @param {AddOrganizationFieldRequest} AddOrganizationFieldRequest + + * @throws {RequiredError} + */ + addOrganizationField: async (AddOrganizationFieldRequest: AddOrganizationFieldRequest, ): Promise => { + // verify required parameter 'AddOrganizationFieldRequest' is not null or undefined + assertParamExists('addOrganizationField', 'AddOrganizationFieldRequest', AddOrganizationFieldRequest) + const localVarPath = `/organizationFields`; + // 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 = { method: 'POST', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["admin"], configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + localVarRequestOptions.data = serializeDataIfNeeded(AddOrganizationFieldRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Adds new options to an organization custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options. + * @summary Add organization field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} AddDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + addOrganizationFieldOptions: async (field_code: string, AddDealFieldOptionsRequestInner: Array, ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('addOrganizationFieldOptions', 'field_code', field_code) + // verify required parameter 'AddDealFieldOptionsRequestInner' is not null or undefined + assertParamExists('addOrganizationFieldOptions', 'AddDealFieldOptionsRequestInner', AddDealFieldOptionsRequestInner) + const localVarPath = `/organizationFields/{field_code}/options` + .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 = { method: 'POST', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full", "admin"], configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + localVarRequestOptions.data = serializeDataIfNeeded(AddDealFieldOptionsRequestInner, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Marks a custom field as deleted. + * @summary Delete one organization field + * @param {string} field_code The unique code identifying the field + + * @throws {RequiredError} + */ + deleteOrganizationField: async (field_code: string, ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('deleteOrganizationField', 'field_code', field_code) + const localVarPath = `/organizationFields/{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 = { method: 'DELETE', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["admin"], configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Removes existing options from an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options. + * @summary Delete organization field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} DeleteDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + deleteOrganizationFieldOptions: async (field_code: string, DeleteDealFieldOptionsRequestInner: Array, ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('deleteOrganizationFieldOptions', 'field_code', field_code) + // verify required parameter 'DeleteDealFieldOptionsRequestInner' is not null or undefined + assertParamExists('deleteOrganizationFieldOptions', 'DeleteDealFieldOptionsRequestInner', DeleteDealFieldOptionsRequestInner) + const localVarPath = `/organizationFields/{field_code}/options` + .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 = { method: 'DELETE', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full", "admin"], configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + localVarRequestOptions.data = serializeDataIfNeeded(DeleteDealFieldOptionsRequestInner, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns metadata about a specific organization field. + * @summary Get one organization field + * @param {string} field_code The unique code identifying the field + * @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [include_fields] Optional comma separated string array of additional data namespaces to include in response + + * @throws {RequiredError} + */ + getOrganizationField: async (field_code: string, include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields', ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('getOrganizationField', 'field_code', field_code) + const localVarPath = `/organizationFields/{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 = { method: 'GET', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full", "admin"], configuration) + + if (include_fields !== undefined) { + localVarQueryParameter['include_fields'] = include_fields; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns metadata about all organization fields in the company. + * @summary Get all organization fields + * @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [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} + */ + getOrganizationFields: async (include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields', limit?: number, cursor?: string, ): Promise => { + const localVarPath = `/organizationFields`; + // 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 = { method: 'GET', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full", "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 = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Updates an organization custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body. + * @summary Update one organization field + * @param {string} field_code The unique code identifying the field + * @param {UpdateOrganizationFieldRequest} UpdateOrganizationFieldRequest + + * @throws {RequiredError} + */ + updateOrganizationField: async (field_code: string, UpdateOrganizationFieldRequest: UpdateOrganizationFieldRequest, ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('updateOrganizationField', 'field_code', field_code) + // verify required parameter 'UpdateOrganizationFieldRequest' is not null or undefined + assertParamExists('updateOrganizationField', 'UpdateOrganizationFieldRequest', UpdateOrganizationFieldRequest) + const localVarPath = `/organizationFields/{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 = { method: 'PATCH', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full", "admin"], configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + localVarRequestOptions.data = serializeDataIfNeeded(UpdateOrganizationFieldRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Updates existing options for an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options. + * @summary Update organization field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} UpdateDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + updateOrganizationFieldOptions: async (field_code: string, UpdateDealFieldOptionsRequestInner: Array, ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('updateOrganizationFieldOptions', 'field_code', field_code) + // verify required parameter 'UpdateDealFieldOptionsRequestInner' is not null or undefined + assertParamExists('updateOrganizationFieldOptions', 'UpdateDealFieldOptionsRequestInner', UpdateDealFieldOptionsRequestInner) + const localVarPath = `/organizationFields/{field_code}/options` + .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 = { method: 'PATCH', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full", "admin"], configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + localVarRequestOptions.data = serializeDataIfNeeded(UpdateDealFieldOptionsRequestInner, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + + +/** + * OrganizationFieldsApi - functional programming interface + * @export + */ +export const OrganizationFieldsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = OrganizationFieldsApiAxiosParamCreator(configuration) + return { + /** + * Creates a new organization custom field. + * @summary Create one organization field + * @param {AddOrganizationFieldRequest} AddOrganizationFieldRequest + + * @throws {RequiredError} + */ + async addOrganizationField(AddOrganizationFieldRequest: AddOrganizationFieldRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.addOrganizationField(AddOrganizationFieldRequest, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Adds new options to an organization custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options. + * @summary Add organization field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} AddDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + async addOrganizationFieldOptions(field_code: string, AddDealFieldOptionsRequestInner: Array, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.addOrganizationFieldOptions(field_code, AddDealFieldOptionsRequestInner, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Marks a custom field as deleted. + * @summary Delete one organization field + * @param {string} field_code The unique code identifying the field + + * @throws {RequiredError} + */ + async deleteOrganizationField(field_code: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteOrganizationField(field_code, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Removes existing options from an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options. + * @summary Delete organization field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} DeleteDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + async deleteOrganizationFieldOptions(field_code: string, DeleteDealFieldOptionsRequestInner: Array, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteOrganizationFieldOptions(field_code, DeleteDealFieldOptionsRequestInner, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Returns metadata about a specific organization field. + * @summary Get one organization field + * @param {string} field_code The unique code identifying the field + * @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [include_fields] Optional comma separated string array of additional data namespaces to include in response + + * @throws {RequiredError} + */ + async getOrganizationField(field_code: string, include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields', ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getOrganizationField(field_code, include_fields, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Returns metadata about all organization fields in the company. + * @summary Get all organization fields + * @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [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} + */ + async getOrganizationFields(include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields', limit?: number, cursor?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getOrganizationFields(include_fields, limit, cursor, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Updates an organization custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body. + * @summary Update one organization field + * @param {string} field_code The unique code identifying the field + * @param {UpdateOrganizationFieldRequest} UpdateOrganizationFieldRequest + + * @throws {RequiredError} + */ + async updateOrganizationField(field_code: string, UpdateOrganizationFieldRequest: UpdateOrganizationFieldRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateOrganizationField(field_code, UpdateOrganizationFieldRequest, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Updates existing options for an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options. + * @summary Update organization field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} UpdateDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + async updateOrganizationFieldOptions(field_code: string, UpdateDealFieldOptionsRequestInner: Array, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateOrganizationFieldOptions(field_code, UpdateDealFieldOptionsRequestInner, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * OrganizationFieldsApi - factory interface + * @export + */ +export const OrganizationFieldsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = OrganizationFieldsApiFp(configuration) + return { + /** + * Creates a new organization custom field. + * @summary Create one organization field + * @param {OrganizationFieldsApiAddOrganizationFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + addOrganizationField(requestParameters: OrganizationFieldsApiAddOrganizationFieldRequest, ): Promise { + return localVarFp.addOrganizationField(requestParameters.AddOrganizationFieldRequest, ).then((request) => request(axios, basePath)); + }, + /** + * Adds new options to an organization custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options. + * @summary Add organization field options in bulk + * @param {OrganizationFieldsApiAddOrganizationFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + addOrganizationFieldOptions(requestParameters: OrganizationFieldsApiAddOrganizationFieldOptionsRequest, ): Promise { + return localVarFp.addOrganizationFieldOptions(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner, ).then((request) => request(axios, basePath)); + }, + /** + * Marks a custom field as deleted. + * @summary Delete one organization field + * @param {OrganizationFieldsApiDeleteOrganizationFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + deleteOrganizationField(requestParameters: OrganizationFieldsApiDeleteOrganizationFieldRequest, ): Promise { + return localVarFp.deleteOrganizationField(requestParameters.field_code, ).then((request) => request(axios, basePath)); + }, + /** + * Removes existing options from an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options. + * @summary Delete organization field options in bulk + * @param {OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + deleteOrganizationFieldOptions(requestParameters: OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest, ): Promise { + return localVarFp.deleteOrganizationFieldOptions(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner, ).then((request) => request(axios, basePath)); + }, + /** + * Returns metadata about a specific organization field. + * @summary Get one organization field + * @param {OrganizationFieldsApiGetOrganizationFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + getOrganizationField(requestParameters: OrganizationFieldsApiGetOrganizationFieldRequest, ): Promise { + return localVarFp.getOrganizationField(requestParameters.field_code, requestParameters.include_fields, ).then((request) => request(axios, basePath)); + }, + /** + * Returns metadata about all organization fields in the company. + * @summary Get all organization fields + * @param {OrganizationFieldsApiGetOrganizationFieldsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + getOrganizationFields(requestParameters: OrganizationFieldsApiGetOrganizationFieldsRequest = {}, ): Promise { + return localVarFp.getOrganizationFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor, ).then((request) => request(axios, basePath)); + }, + /** + * Updates an organization custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body. + * @summary Update one organization field + * @param {OrganizationFieldsApiUpdateOrganizationFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + updateOrganizationField(requestParameters: OrganizationFieldsApiUpdateOrganizationFieldRequest, ): Promise { + return localVarFp.updateOrganizationField(requestParameters.field_code, requestParameters.UpdateOrganizationFieldRequest, ).then((request) => request(axios, basePath)); + }, + /** + * Updates existing options for an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options. + * @summary Update organization field options in bulk + * @param {OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + updateOrganizationFieldOptions(requestParameters: OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest, ): Promise { + return localVarFp.updateOrganizationFieldOptions(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner, ).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for addOrganizationField operation in OrganizationFieldsApi. + * @export + * @interface OrganizationFieldsApiAddOrganizationFieldRequest + */ +export interface OrganizationFieldsApiAddOrganizationFieldRequest { + /** + * + * @type {AddOrganizationFieldRequest} + * @memberof OrganizationFieldsApiAddOrganizationField + */ + readonly AddOrganizationFieldRequest: AddOrganizationFieldRequest +} + +/** + * Request parameters for addOrganizationFieldOptions operation in OrganizationFieldsApi. + * @export + * @interface OrganizationFieldsApiAddOrganizationFieldOptionsRequest + */ +export interface OrganizationFieldsApiAddOrganizationFieldOptionsRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof OrganizationFieldsApiAddOrganizationFieldOptions + */ + readonly field_code: string + + /** + * + * @type {Array} + * @memberof OrganizationFieldsApiAddOrganizationFieldOptions + */ + readonly AddDealFieldOptionsRequestInner: Array +} + +/** + * Request parameters for deleteOrganizationField operation in OrganizationFieldsApi. + * @export + * @interface OrganizationFieldsApiDeleteOrganizationFieldRequest + */ +export interface OrganizationFieldsApiDeleteOrganizationFieldRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof OrganizationFieldsApiDeleteOrganizationField + */ + readonly field_code: string +} + +/** + * Request parameters for deleteOrganizationFieldOptions operation in OrganizationFieldsApi. + * @export + * @interface OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest + */ +export interface OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof OrganizationFieldsApiDeleteOrganizationFieldOptions + */ + readonly field_code: string + + /** + * + * @type {Array} + * @memberof OrganizationFieldsApiDeleteOrganizationFieldOptions + */ + readonly DeleteDealFieldOptionsRequestInner: Array +} + +/** + * Request parameters for getOrganizationField operation in OrganizationFieldsApi. + * @export + * @interface OrganizationFieldsApiGetOrganizationFieldRequest + */ +export interface OrganizationFieldsApiGetOrganizationFieldRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof OrganizationFieldsApiGetOrganizationField + */ + readonly field_code: string + + /** + * Optional comma separated string array of additional data namespaces to include in response + * @type {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} + * @memberof OrganizationFieldsApiGetOrganizationField + */ + readonly include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields' +} + +/** + * Request parameters for getOrganizationFields operation in OrganizationFieldsApi. + * @export + * @interface OrganizationFieldsApiGetOrganizationFieldsRequest + */ +export interface OrganizationFieldsApiGetOrganizationFieldsRequest { + /** + * Optional comma separated string array of additional data namespaces to include in response + * @type {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} + * @memberof OrganizationFieldsApiGetOrganizationFields + */ + readonly include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields' + + /** + * 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 OrganizationFieldsApiGetOrganizationFields + */ + readonly limit?: number + + /** + * For pagination, the marker (an opaque string value) representing the first item on the next page + * @type {string} + * @memberof OrganizationFieldsApiGetOrganizationFields + */ + readonly cursor?: string +} + +/** + * Request parameters for updateOrganizationField operation in OrganizationFieldsApi. + * @export + * @interface OrganizationFieldsApiUpdateOrganizationFieldRequest + */ +export interface OrganizationFieldsApiUpdateOrganizationFieldRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof OrganizationFieldsApiUpdateOrganizationField + */ + readonly field_code: string + + /** + * + * @type {UpdateOrganizationFieldRequest} + * @memberof OrganizationFieldsApiUpdateOrganizationField + */ + readonly UpdateOrganizationFieldRequest: UpdateOrganizationFieldRequest +} + +/** + * Request parameters for updateOrganizationFieldOptions operation in OrganizationFieldsApi. + * @export + * @interface OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest + */ +export interface OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof OrganizationFieldsApiUpdateOrganizationFieldOptions + */ + readonly field_code: string + + /** + * + * @type {Array} + * @memberof OrganizationFieldsApiUpdateOrganizationFieldOptions + */ + readonly UpdateDealFieldOptionsRequestInner: Array +} + +/** + * OrganizationFieldsApi - object-oriented interface + * @export + * @class OrganizationFieldsApi + * @extends {BaseAPI} + */ +export class OrganizationFieldsApi extends BaseAPI { + /** + * Creates a new organization custom field. + * @summary Create one organization field + * @param {OrganizationFieldsApiAddOrganizationFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof OrganizationFieldsApi + */ + public addOrganizationField(requestParameters: OrganizationFieldsApiAddOrganizationFieldRequest, ) { + return OrganizationFieldsApiFp(this.configuration).addOrganizationField(requestParameters.AddOrganizationFieldRequest, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Adds new options to an organization custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options. + * @summary Add organization field options in bulk + * @param {OrganizationFieldsApiAddOrganizationFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof OrganizationFieldsApi + */ + public addOrganizationFieldOptions(requestParameters: OrganizationFieldsApiAddOrganizationFieldOptionsRequest, ) { + return OrganizationFieldsApiFp(this.configuration).addOrganizationFieldOptions(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Marks a custom field as deleted. + * @summary Delete one organization field + * @param {OrganizationFieldsApiDeleteOrganizationFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof OrganizationFieldsApi + */ + public deleteOrganizationField(requestParameters: OrganizationFieldsApiDeleteOrganizationFieldRequest, ) { + return OrganizationFieldsApiFp(this.configuration).deleteOrganizationField(requestParameters.field_code, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Removes existing options from an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options. + * @summary Delete organization field options in bulk + * @param {OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof OrganizationFieldsApi + */ + public deleteOrganizationFieldOptions(requestParameters: OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest, ) { + return OrganizationFieldsApiFp(this.configuration).deleteOrganizationFieldOptions(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns metadata about a specific organization field. + * @summary Get one organization field + * @param {OrganizationFieldsApiGetOrganizationFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof OrganizationFieldsApi + */ + public getOrganizationField(requestParameters: OrganizationFieldsApiGetOrganizationFieldRequest, ) { + return OrganizationFieldsApiFp(this.configuration).getOrganizationField(requestParameters.field_code, requestParameters.include_fields, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns metadata about all organization fields in the company. + * @summary Get all organization fields + * @param {OrganizationFieldsApiGetOrganizationFieldsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof OrganizationFieldsApi + */ + public getOrganizationFields(requestParameters: OrganizationFieldsApiGetOrganizationFieldsRequest = {}, ) { + return OrganizationFieldsApiFp(this.configuration).getOrganizationFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates an organization custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body. + * @summary Update one organization field + * @param {OrganizationFieldsApiUpdateOrganizationFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof OrganizationFieldsApi + */ + public updateOrganizationField(requestParameters: OrganizationFieldsApiUpdateOrganizationFieldRequest, ) { + return OrganizationFieldsApiFp(this.configuration).updateOrganizationField(requestParameters.field_code, requestParameters.UpdateOrganizationFieldRequest, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates existing options for an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options. + * @summary Update organization field options in bulk + * @param {OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof OrganizationFieldsApi + */ + public updateOrganizationFieldOptions(requestParameters: OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest, ) { + return OrganizationFieldsApiFp(this.configuration).updateOrganizationFieldOptions(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner, ).then((request) => request(this.axios, this.basePath)); + } +} diff --git a/src/versions/v2/api/person-fields-api.ts b/src/versions/v2/api/person-fields-api.ts new file mode 100644 index 00000000..0fb0a8e5 --- /dev/null +++ b/src/versions/v2/api/person-fields-api.ts @@ -0,0 +1,880 @@ +/* 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. + */ + + +import type { Configuration } from '../configuration'; +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base'; +// @ts-ignore +import { AddDealFieldOptions200Response } from '../models'; +// @ts-ignore +import { AddDealFieldOptionsRequestInner } from '../models'; +// @ts-ignore +import { AddPersonField200Response } from '../models'; +// @ts-ignore +import { AddPersonFieldRequest } from '../models'; +// @ts-ignore +import { DeleteDealFieldOptionsRequestInner } from '../models'; +// @ts-ignore +import { DeletePersonField200Response } from '../models'; +// @ts-ignore +import { GetPersonFields200Response } from '../models'; +// @ts-ignore +import { UpdateDealFieldOptionsRequestInner } from '../models'; +// @ts-ignore +import { UpdatePersonFieldRequest } from '../models'; +/** + * PersonFieldsApi - axios parameter creator + * @export + */ +export const PersonFieldsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Creates a new person custom field. + * @summary Create one person field + * @param {AddPersonFieldRequest} AddPersonFieldRequest + + * @throws {RequiredError} + */ + addPersonField: async (AddPersonFieldRequest: AddPersonFieldRequest, ): Promise => { + // verify required parameter 'AddPersonFieldRequest' is not null or undefined + assertParamExists('addPersonField', 'AddPersonFieldRequest', AddPersonFieldRequest) + const localVarPath = `/personFields`; + // 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 = { method: 'POST', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["admin"], configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + localVarRequestOptions.data = serializeDataIfNeeded(AddPersonFieldRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Adds new options to a person custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options. + * @summary Add person field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} AddDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + addPersonFieldOptions: async (field_code: string, AddDealFieldOptionsRequestInner: Array, ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('addPersonFieldOptions', 'field_code', field_code) + // verify required parameter 'AddDealFieldOptionsRequestInner' is not null or undefined + assertParamExists('addPersonFieldOptions', 'AddDealFieldOptionsRequestInner', AddDealFieldOptionsRequestInner) + const localVarPath = `/personFields/{field_code}/options` + .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 = { method: 'POST', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full", "admin"], configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + localVarRequestOptions.data = serializeDataIfNeeded(AddDealFieldOptionsRequestInner, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Marks a custom field as deleted. + * @summary Delete one person field + * @param {string} field_code The unique code identifying the field + + * @throws {RequiredError} + */ + deletePersonField: async (field_code: string, ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('deletePersonField', 'field_code', field_code) + const localVarPath = `/personFields/{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 = { method: 'DELETE', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["admin"], configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Removes existing options from a person custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options. + * @summary Delete person field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} DeleteDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + deletePersonFieldOptions: async (field_code: string, DeleteDealFieldOptionsRequestInner: Array, ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('deletePersonFieldOptions', 'field_code', field_code) + // verify required parameter 'DeleteDealFieldOptionsRequestInner' is not null or undefined + assertParamExists('deletePersonFieldOptions', 'DeleteDealFieldOptionsRequestInner', DeleteDealFieldOptionsRequestInner) + const localVarPath = `/personFields/{field_code}/options` + .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 = { method: 'DELETE', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full", "admin"], configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + localVarRequestOptions.data = serializeDataIfNeeded(DeleteDealFieldOptionsRequestInner, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns metadata about a specific person field. + * @summary Get one person field + * @param {string} field_code The unique code identifying the field + * @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [include_fields] Optional comma separated string array of additional data namespaces to include in response + + * @throws {RequiredError} + */ + getPersonField: async (field_code: string, include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields', ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('getPersonField', 'field_code', field_code) + const localVarPath = `/personFields/{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 = { method: 'GET', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full", "admin"], configuration) + + if (include_fields !== undefined) { + localVarQueryParameter['include_fields'] = include_fields; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns metadata about all person fields in the company. + * @summary Get all person fields + * @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [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} + */ + getPersonFields: async (include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields', limit?: number, cursor?: string, ): Promise => { + const localVarPath = `/personFields`; + // 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 = { method: 'GET', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full", "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 = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Updates a person custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body. + * @summary Update one person field + * @param {string} field_code The unique code identifying the field + * @param {UpdatePersonFieldRequest} UpdatePersonFieldRequest + + * @throws {RequiredError} + */ + updatePersonField: async (field_code: string, UpdatePersonFieldRequest: UpdatePersonFieldRequest, ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('updatePersonField', 'field_code', field_code) + // verify required parameter 'UpdatePersonFieldRequest' is not null or undefined + assertParamExists('updatePersonField', 'UpdatePersonFieldRequest', UpdatePersonFieldRequest) + const localVarPath = `/personFields/{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 = { method: 'PATCH', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full", "admin"], configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + localVarRequestOptions.data = serializeDataIfNeeded(UpdatePersonFieldRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Updates existing options for a person custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options. + * @summary Update person field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} UpdateDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + updatePersonFieldOptions: async (field_code: string, UpdateDealFieldOptionsRequestInner: Array, ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('updatePersonFieldOptions', 'field_code', field_code) + // verify required parameter 'UpdateDealFieldOptionsRequestInner' is not null or undefined + assertParamExists('updatePersonFieldOptions', 'UpdateDealFieldOptionsRequestInner', UpdateDealFieldOptionsRequestInner) + const localVarPath = `/personFields/{field_code}/options` + .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 = { method: 'PATCH', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full", "admin"], configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + localVarRequestOptions.data = serializeDataIfNeeded(UpdateDealFieldOptionsRequestInner, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + + +/** + * PersonFieldsApi - functional programming interface + * @export + */ +export const PersonFieldsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = PersonFieldsApiAxiosParamCreator(configuration) + return { + /** + * Creates a new person custom field. + * @summary Create one person field + * @param {AddPersonFieldRequest} AddPersonFieldRequest + + * @throws {RequiredError} + */ + async addPersonField(AddPersonFieldRequest: AddPersonFieldRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.addPersonField(AddPersonFieldRequest, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Adds new options to a person custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options. + * @summary Add person field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} AddDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + async addPersonFieldOptions(field_code: string, AddDealFieldOptionsRequestInner: Array, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.addPersonFieldOptions(field_code, AddDealFieldOptionsRequestInner, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Marks a custom field as deleted. + * @summary Delete one person field + * @param {string} field_code The unique code identifying the field + + * @throws {RequiredError} + */ + async deletePersonField(field_code: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deletePersonField(field_code, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Removes existing options from a person custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options. + * @summary Delete person field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} DeleteDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + async deletePersonFieldOptions(field_code: string, DeleteDealFieldOptionsRequestInner: Array, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deletePersonFieldOptions(field_code, DeleteDealFieldOptionsRequestInner, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Returns metadata about a specific person field. + * @summary Get one person field + * @param {string} field_code The unique code identifying the field + * @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [include_fields] Optional comma separated string array of additional data namespaces to include in response + + * @throws {RequiredError} + */ + async getPersonField(field_code: string, include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields', ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPersonField(field_code, include_fields, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Returns metadata about all person fields in the company. + * @summary Get all person fields + * @param {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} [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} + */ + async getPersonFields(include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields', limit?: number, cursor?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPersonFields(include_fields, limit, cursor, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Updates a person custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body. + * @summary Update one person field + * @param {string} field_code The unique code identifying the field + * @param {UpdatePersonFieldRequest} UpdatePersonFieldRequest + + * @throws {RequiredError} + */ + async updatePersonField(field_code: string, UpdatePersonFieldRequest: UpdatePersonFieldRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updatePersonField(field_code, UpdatePersonFieldRequest, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Updates existing options for a person custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options. + * @summary Update person field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} UpdateDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + async updatePersonFieldOptions(field_code: string, UpdateDealFieldOptionsRequestInner: Array, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updatePersonFieldOptions(field_code, UpdateDealFieldOptionsRequestInner, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * PersonFieldsApi - factory interface + * @export + */ +export const PersonFieldsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = PersonFieldsApiFp(configuration) + return { + /** + * Creates a new person custom field. + * @summary Create one person field + * @param {PersonFieldsApiAddPersonFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + addPersonField(requestParameters: PersonFieldsApiAddPersonFieldRequest, ): Promise { + return localVarFp.addPersonField(requestParameters.AddPersonFieldRequest, ).then((request) => request(axios, basePath)); + }, + /** + * Adds new options to a person custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options. + * @summary Add person field options in bulk + * @param {PersonFieldsApiAddPersonFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + addPersonFieldOptions(requestParameters: PersonFieldsApiAddPersonFieldOptionsRequest, ): Promise { + return localVarFp.addPersonFieldOptions(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner, ).then((request) => request(axios, basePath)); + }, + /** + * Marks a custom field as deleted. + * @summary Delete one person field + * @param {PersonFieldsApiDeletePersonFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + deletePersonField(requestParameters: PersonFieldsApiDeletePersonFieldRequest, ): Promise { + return localVarFp.deletePersonField(requestParameters.field_code, ).then((request) => request(axios, basePath)); + }, + /** + * Removes existing options from a person custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options. + * @summary Delete person field options in bulk + * @param {PersonFieldsApiDeletePersonFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + deletePersonFieldOptions(requestParameters: PersonFieldsApiDeletePersonFieldOptionsRequest, ): Promise { + return localVarFp.deletePersonFieldOptions(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner, ).then((request) => request(axios, basePath)); + }, + /** + * Returns metadata about a specific person field. + * @summary Get one person field + * @param {PersonFieldsApiGetPersonFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + getPersonField(requestParameters: PersonFieldsApiGetPersonFieldRequest, ): Promise { + return localVarFp.getPersonField(requestParameters.field_code, requestParameters.include_fields, ).then((request) => request(axios, basePath)); + }, + /** + * Returns metadata about all person fields in the company. + * @summary Get all person fields + * @param {PersonFieldsApiGetPersonFieldsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + getPersonFields(requestParameters: PersonFieldsApiGetPersonFieldsRequest = {}, ): Promise { + return localVarFp.getPersonFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor, ).then((request) => request(axios, basePath)); + }, + /** + * Updates a person custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body. + * @summary Update one person field + * @param {PersonFieldsApiUpdatePersonFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + updatePersonField(requestParameters: PersonFieldsApiUpdatePersonFieldRequest, ): Promise { + return localVarFp.updatePersonField(requestParameters.field_code, requestParameters.UpdatePersonFieldRequest, ).then((request) => request(axios, basePath)); + }, + /** + * Updates existing options for a person custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options. + * @summary Update person field options in bulk + * @param {PersonFieldsApiUpdatePersonFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + updatePersonFieldOptions(requestParameters: PersonFieldsApiUpdatePersonFieldOptionsRequest, ): Promise { + return localVarFp.updatePersonFieldOptions(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner, ).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for addPersonField operation in PersonFieldsApi. + * @export + * @interface PersonFieldsApiAddPersonFieldRequest + */ +export interface PersonFieldsApiAddPersonFieldRequest { + /** + * + * @type {AddPersonFieldRequest} + * @memberof PersonFieldsApiAddPersonField + */ + readonly AddPersonFieldRequest: AddPersonFieldRequest +} + +/** + * Request parameters for addPersonFieldOptions operation in PersonFieldsApi. + * @export + * @interface PersonFieldsApiAddPersonFieldOptionsRequest + */ +export interface PersonFieldsApiAddPersonFieldOptionsRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof PersonFieldsApiAddPersonFieldOptions + */ + readonly field_code: string + + /** + * + * @type {Array} + * @memberof PersonFieldsApiAddPersonFieldOptions + */ + readonly AddDealFieldOptionsRequestInner: Array +} + +/** + * Request parameters for deletePersonField operation in PersonFieldsApi. + * @export + * @interface PersonFieldsApiDeletePersonFieldRequest + */ +export interface PersonFieldsApiDeletePersonFieldRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof PersonFieldsApiDeletePersonField + */ + readonly field_code: string +} + +/** + * Request parameters for deletePersonFieldOptions operation in PersonFieldsApi. + * @export + * @interface PersonFieldsApiDeletePersonFieldOptionsRequest + */ +export interface PersonFieldsApiDeletePersonFieldOptionsRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof PersonFieldsApiDeletePersonFieldOptions + */ + readonly field_code: string + + /** + * + * @type {Array} + * @memberof PersonFieldsApiDeletePersonFieldOptions + */ + readonly DeleteDealFieldOptionsRequestInner: Array +} + +/** + * Request parameters for getPersonField operation in PersonFieldsApi. + * @export + * @interface PersonFieldsApiGetPersonFieldRequest + */ +export interface PersonFieldsApiGetPersonFieldRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof PersonFieldsApiGetPersonField + */ + readonly field_code: string + + /** + * Optional comma separated string array of additional data namespaces to include in response + * @type {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} + * @memberof PersonFieldsApiGetPersonField + */ + readonly include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields' +} + +/** + * Request parameters for getPersonFields operation in PersonFieldsApi. + * @export + * @interface PersonFieldsApiGetPersonFieldsRequest + */ +export interface PersonFieldsApiGetPersonFieldsRequest { + /** + * Optional comma separated string array of additional data namespaces to include in response + * @type {'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields'} + * @memberof PersonFieldsApiGetPersonFields + */ + readonly include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields' | 'ui_visibility,important_fields' | 'ui_visibility,required_fields' | 'important_fields,required_fields' | 'ui_visibility,important_fields,required_fields' + + /** + * 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 PersonFieldsApiGetPersonFields + */ + readonly limit?: number + + /** + * For pagination, the marker (an opaque string value) representing the first item on the next page + * @type {string} + * @memberof PersonFieldsApiGetPersonFields + */ + readonly cursor?: string +} + +/** + * Request parameters for updatePersonField operation in PersonFieldsApi. + * @export + * @interface PersonFieldsApiUpdatePersonFieldRequest + */ +export interface PersonFieldsApiUpdatePersonFieldRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof PersonFieldsApiUpdatePersonField + */ + readonly field_code: string + + /** + * + * @type {UpdatePersonFieldRequest} + * @memberof PersonFieldsApiUpdatePersonField + */ + readonly UpdatePersonFieldRequest: UpdatePersonFieldRequest +} + +/** + * Request parameters for updatePersonFieldOptions operation in PersonFieldsApi. + * @export + * @interface PersonFieldsApiUpdatePersonFieldOptionsRequest + */ +export interface PersonFieldsApiUpdatePersonFieldOptionsRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof PersonFieldsApiUpdatePersonFieldOptions + */ + readonly field_code: string + + /** + * + * @type {Array} + * @memberof PersonFieldsApiUpdatePersonFieldOptions + */ + readonly UpdateDealFieldOptionsRequestInner: Array +} + +/** + * PersonFieldsApi - object-oriented interface + * @export + * @class PersonFieldsApi + * @extends {BaseAPI} + */ +export class PersonFieldsApi extends BaseAPI { + /** + * Creates a new person custom field. + * @summary Create one person field + * @param {PersonFieldsApiAddPersonFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof PersonFieldsApi + */ + public addPersonField(requestParameters: PersonFieldsApiAddPersonFieldRequest, ) { + return PersonFieldsApiFp(this.configuration).addPersonField(requestParameters.AddPersonFieldRequest, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Adds new options to a person custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options. + * @summary Add person field options in bulk + * @param {PersonFieldsApiAddPersonFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof PersonFieldsApi + */ + public addPersonFieldOptions(requestParameters: PersonFieldsApiAddPersonFieldOptionsRequest, ) { + return PersonFieldsApiFp(this.configuration).addPersonFieldOptions(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Marks a custom field as deleted. + * @summary Delete one person field + * @param {PersonFieldsApiDeletePersonFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof PersonFieldsApi + */ + public deletePersonField(requestParameters: PersonFieldsApiDeletePersonFieldRequest, ) { + return PersonFieldsApiFp(this.configuration).deletePersonField(requestParameters.field_code, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Removes existing options from a person custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options. + * @summary Delete person field options in bulk + * @param {PersonFieldsApiDeletePersonFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof PersonFieldsApi + */ + public deletePersonFieldOptions(requestParameters: PersonFieldsApiDeletePersonFieldOptionsRequest, ) { + return PersonFieldsApiFp(this.configuration).deletePersonFieldOptions(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns metadata about a specific person field. + * @summary Get one person field + * @param {PersonFieldsApiGetPersonFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof PersonFieldsApi + */ + public getPersonField(requestParameters: PersonFieldsApiGetPersonFieldRequest, ) { + return PersonFieldsApiFp(this.configuration).getPersonField(requestParameters.field_code, requestParameters.include_fields, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns metadata about all person fields in the company. + * @summary Get all person fields + * @param {PersonFieldsApiGetPersonFieldsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof PersonFieldsApi + */ + public getPersonFields(requestParameters: PersonFieldsApiGetPersonFieldsRequest = {}, ) { + return PersonFieldsApiFp(this.configuration).getPersonFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates a person custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body. + * @summary Update one person field + * @param {PersonFieldsApiUpdatePersonFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof PersonFieldsApi + */ + public updatePersonField(requestParameters: PersonFieldsApiUpdatePersonFieldRequest, ) { + return PersonFieldsApiFp(this.configuration).updatePersonField(requestParameters.field_code, requestParameters.UpdatePersonFieldRequest, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates existing options for a person custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options. + * @summary Update person field options in bulk + * @param {PersonFieldsApiUpdatePersonFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof PersonFieldsApi + */ + public updatePersonFieldOptions(requestParameters: PersonFieldsApiUpdatePersonFieldOptionsRequest, ) { + return PersonFieldsApiFp(this.configuration).updatePersonFieldOptions(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner, ).then((request) => request(this.axios, this.basePath)); + } +} diff --git a/src/versions/v2/api/persons-api.ts b/src/versions/v2/api/persons-api.ts index c5d42a3b..9a58a076 100644 --- a/src/versions/v2/api/persons-api.ts +++ b/src/versions/v2/api/persons-api.ts @@ -381,6 +381,7 @@ export const PersonsApiAxiosParamCreator = function (configuration?: Configurati * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response. * @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored. * @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored. + * @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored. * @param {string} [updated_since] If set, only persons with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. * @param {string} [updated_until] If set, only persons with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`. @@ -392,7 +393,7 @@ export const PersonsApiAxiosParamCreator = function (configuration?: Configurati * @throws {RequiredError} */ - getPersons: async (filter_id?: number, ids?: string, owner_id?: number, org_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status', custom_fields?: string, limit?: number, cursor?: string, ): Promise => { + getPersons: async (filter_id?: number, ids?: string, owner_id?: number, org_id?: number, deal_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status', custom_fields?: string, limit?: number, cursor?: string, ): Promise => { const localVarPath = `/persons`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -428,6 +429,10 @@ export const PersonsApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['org_id'] = org_id; } + if (deal_id !== undefined) { + localVarQueryParameter['deal_id'] = deal_id; + } + if (updated_since !== undefined) { localVarQueryParameter['updated_since'] = updated_since; } @@ -693,6 +698,7 @@ export const PersonsApiFp = function(configuration?: Configuration) { * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response. * @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored. * @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored. + * @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored. * @param {string} [updated_since] If set, only persons with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. * @param {string} [updated_until] If set, only persons with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`. @@ -704,8 +710,8 @@ export const PersonsApiFp = function(configuration?: Configuration) { * @throws {RequiredError} */ - async getPersons(filter_id?: number, ids?: string, owner_id?: number, org_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status', custom_fields?: string, limit?: number, cursor?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPersons(filter_id, ids, owner_id, org_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor, ); + async getPersons(filter_id?: number, ids?: string, owner_id?: number, org_id?: number, deal_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status', custom_fields?: string, limit?: number, cursor?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPersons(filter_id, ids, owner_id, org_id, deal_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor, ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -825,7 +831,7 @@ export const PersonsApiFactory = function (configuration?: Configuration, basePa * @throws {RequiredError} */ getPersons(requestParameters: PersonsApiGetPersonsRequest = {}, ): Promise { - return localVarFp.getPersons(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.org_id, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.limit, requestParameters.cursor, ).then((request) => request(axios, basePath)); + return localVarFp.getPersons(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.org_id, requestParameters.deal_id, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.limit, requestParameters.cursor, ).then((request) => request(axios, basePath)); }, /** * Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found persons can be filtered by organization ID. @@ -1038,6 +1044,13 @@ export interface PersonsApiGetPersonsRequest { */ readonly org_id?: number + /** + * If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored. + * @type {number} + * @memberof PersonsApiGetPersons + */ + readonly deal_id?: number + /** * If set, only persons with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. * @type {string} @@ -1272,7 +1285,7 @@ export class PersonsApi extends BaseAPI { * @memberof PersonsApi */ public getPersons(requestParameters: PersonsApiGetPersonsRequest = {}, ) { - return PersonsApiFp(this.configuration).getPersons(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.org_id, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.limit, requestParameters.cursor, ).then((request) => request(this.axios, this.basePath)); + return PersonsApiFp(this.configuration).getPersons(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.org_id, requestParameters.deal_id, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.custom_fields, requestParameters.limit, requestParameters.cursor, ).then((request) => request(this.axios, this.basePath)); } /** diff --git a/src/versions/v2/api/product-fields-api.ts b/src/versions/v2/api/product-fields-api.ts new file mode 100644 index 00000000..9fb3aa36 --- /dev/null +++ b/src/versions/v2/api/product-fields-api.ts @@ -0,0 +1,880 @@ +/* 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. + */ + + +import type { Configuration } from '../configuration'; +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base'; +// @ts-ignore +import { AddDealFieldOptions200Response } from '../models'; +// @ts-ignore +import { AddDealFieldOptionsRequestInner } from '../models'; +// @ts-ignore +import { AddProductFieldRequest } from '../models'; +// @ts-ignore +import { DeleteDealFieldOptionsRequestInner } from '../models'; +// @ts-ignore +import { DeletePersonField200Response } from '../models'; +// @ts-ignore +import { GetActivityField200Response } from '../models'; +// @ts-ignore +import { GetActivityFields200Response } from '../models'; +// @ts-ignore +import { UpdateDealFieldOptionsRequestInner } from '../models'; +// @ts-ignore +import { UpdateProductFieldRequest } from '../models'; +/** + * ProductFieldsApi - axios parameter creator + * @export + */ +export const ProductFieldsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Creates a new product custom field. + * @summary Create one product field + * @param {AddProductFieldRequest} AddProductFieldRequest + + * @throws {RequiredError} + */ + addProductField: async (AddProductFieldRequest: AddProductFieldRequest, ): Promise => { + // verify required parameter 'AddProductFieldRequest' is not null or undefined + assertParamExists('addProductField', 'AddProductFieldRequest', AddProductFieldRequest) + const localVarPath = `/productFields`; + // 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 = { method: 'POST', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full"], configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + localVarRequestOptions.data = serializeDataIfNeeded(AddProductFieldRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Adds new options to a product custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options. + * @summary Add product field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} AddDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + addProductFieldOptions: async (field_code: string, AddDealFieldOptionsRequestInner: Array, ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('addProductFieldOptions', 'field_code', field_code) + // verify required parameter 'AddDealFieldOptionsRequestInner' is not null or undefined + assertParamExists('addProductFieldOptions', 'AddDealFieldOptionsRequestInner', AddDealFieldOptionsRequestInner) + const localVarPath = `/productFields/{field_code}/options` + .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 = { method: 'POST', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full"], configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + localVarRequestOptions.data = serializeDataIfNeeded(AddDealFieldOptionsRequestInner, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Marks a custom field as deleted. + * @summary Delete one product field + * @param {string} field_code The unique code identifying the field + + * @throws {RequiredError} + */ + deleteProductField: async (field_code: string, ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('deleteProductField', 'field_code', field_code) + const localVarPath = `/productFields/{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 = { method: 'DELETE', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full"], configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Removes existing options from a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options. + * @summary Delete product field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} DeleteDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + deleteProductFieldOptions: async (field_code: string, DeleteDealFieldOptionsRequestInner: Array, ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('deleteProductFieldOptions', 'field_code', field_code) + // verify required parameter 'DeleteDealFieldOptionsRequestInner' is not null or undefined + assertParamExists('deleteProductFieldOptions', 'DeleteDealFieldOptionsRequestInner', DeleteDealFieldOptionsRequestInner) + const localVarPath = `/productFields/{field_code}/options` + .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 = { method: 'DELETE', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full"], configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + localVarRequestOptions.data = serializeDataIfNeeded(DeleteDealFieldOptionsRequestInner, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns metadata about a specific product field. + * @summary Get one product 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} + */ + getProductField: async (field_code: string, include_fields?: 'ui_visibility', ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('getProductField', 'field_code', field_code) + const localVarPath = `/productFields/{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 = { method: 'GET', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:read", "products:full"], configuration) + + if (include_fields !== undefined) { + localVarQueryParameter['include_fields'] = include_fields; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns metadata about all product fields in the company. + * @summary Get all product 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} + */ + getProductFields: async (include_fields?: 'ui_visibility', limit?: number, cursor?: string, ): Promise => { + const localVarPath = `/productFields`; + // 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 = { method: 'GET', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:read", "products:full"], 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 = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Updates a product custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body. + * @summary Update one product field + * @param {string} field_code The unique code identifying the field + * @param {UpdateProductFieldRequest} UpdateProductFieldRequest + + * @throws {RequiredError} + */ + updateProductField: async (field_code: string, UpdateProductFieldRequest: UpdateProductFieldRequest, ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('updateProductField', 'field_code', field_code) + // verify required parameter 'UpdateProductFieldRequest' is not null or undefined + assertParamExists('updateProductField', 'UpdateProductFieldRequest', UpdateProductFieldRequest) + const localVarPath = `/productFields/{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 = { method: 'PATCH', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full"], configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + localVarRequestOptions.data = serializeDataIfNeeded(UpdateProductFieldRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Updates existing options for a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options. + * @summary Update product field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} UpdateDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + updateProductFieldOptions: async (field_code: string, UpdateDealFieldOptionsRequestInner: Array, ): Promise => { + // verify required parameter 'field_code' is not null or undefined + assertParamExists('updateProductFieldOptions', 'field_code', field_code) + // verify required parameter 'UpdateDealFieldOptionsRequestInner' is not null or undefined + assertParamExists('updateProductFieldOptions', 'UpdateDealFieldOptionsRequestInner', UpdateDealFieldOptionsRequestInner) + const localVarPath = `/productFields/{field_code}/options` + .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 = { method: 'PATCH', ...baseOptions }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication api_key required + await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration) + + // authentication oauth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full"], configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, }; + localVarRequestOptions.data = serializeDataIfNeeded(UpdateDealFieldOptionsRequestInner, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + + +/** + * ProductFieldsApi - functional programming interface + * @export + */ +export const ProductFieldsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ProductFieldsApiAxiosParamCreator(configuration) + return { + /** + * Creates a new product custom field. + * @summary Create one product field + * @param {AddProductFieldRequest} AddProductFieldRequest + + * @throws {RequiredError} + */ + async addProductField(AddProductFieldRequest: AddProductFieldRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.addProductField(AddProductFieldRequest, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Adds new options to a product custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options. + * @summary Add product field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} AddDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + async addProductFieldOptions(field_code: string, AddDealFieldOptionsRequestInner: Array, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.addProductFieldOptions(field_code, AddDealFieldOptionsRequestInner, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Marks a custom field as deleted. + * @summary Delete one product field + * @param {string} field_code The unique code identifying the field + + * @throws {RequiredError} + */ + async deleteProductField(field_code: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProductField(field_code, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Removes existing options from a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options. + * @summary Delete product field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} DeleteDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + async deleteProductFieldOptions(field_code: string, DeleteDealFieldOptionsRequestInner: Array, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProductFieldOptions(field_code, DeleteDealFieldOptionsRequestInner, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Returns metadata about a specific product field. + * @summary Get one product 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} + */ + async getProductField(field_code: string, include_fields?: 'ui_visibility', ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getProductField(field_code, include_fields, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Returns metadata about all product fields in the company. + * @summary Get all product 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} + */ + async getProductFields(include_fields?: 'ui_visibility', limit?: number, cursor?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getProductFields(include_fields, limit, cursor, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Updates a product custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body. + * @summary Update one product field + * @param {string} field_code The unique code identifying the field + * @param {UpdateProductFieldRequest} UpdateProductFieldRequest + + * @throws {RequiredError} + */ + async updateProductField(field_code: string, UpdateProductFieldRequest: UpdateProductFieldRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateProductField(field_code, UpdateProductFieldRequest, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Updates existing options for a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options. + * @summary Update product field options in bulk + * @param {string} field_code The unique code identifying the field + * @param {Array} UpdateDealFieldOptionsRequestInner + + * @throws {RequiredError} + */ + async updateProductFieldOptions(field_code: string, UpdateDealFieldOptionsRequestInner: Array, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateProductFieldOptions(field_code, UpdateDealFieldOptionsRequestInner, ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * ProductFieldsApi - factory interface + * @export + */ +export const ProductFieldsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ProductFieldsApiFp(configuration) + return { + /** + * Creates a new product custom field. + * @summary Create one product field + * @param {ProductFieldsApiAddProductFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + addProductField(requestParameters: ProductFieldsApiAddProductFieldRequest, ): Promise { + return localVarFp.addProductField(requestParameters.AddProductFieldRequest, ).then((request) => request(axios, basePath)); + }, + /** + * Adds new options to a product custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options. + * @summary Add product field options in bulk + * @param {ProductFieldsApiAddProductFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + addProductFieldOptions(requestParameters: ProductFieldsApiAddProductFieldOptionsRequest, ): Promise { + return localVarFp.addProductFieldOptions(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner, ).then((request) => request(axios, basePath)); + }, + /** + * Marks a custom field as deleted. + * @summary Delete one product field + * @param {ProductFieldsApiDeleteProductFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + deleteProductField(requestParameters: ProductFieldsApiDeleteProductFieldRequest, ): Promise { + return localVarFp.deleteProductField(requestParameters.field_code, ).then((request) => request(axios, basePath)); + }, + /** + * Removes existing options from a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options. + * @summary Delete product field options in bulk + * @param {ProductFieldsApiDeleteProductFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + deleteProductFieldOptions(requestParameters: ProductFieldsApiDeleteProductFieldOptionsRequest, ): Promise { + return localVarFp.deleteProductFieldOptions(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner, ).then((request) => request(axios, basePath)); + }, + /** + * Returns metadata about a specific product field. + * @summary Get one product field + * @param {ProductFieldsApiGetProductFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + getProductField(requestParameters: ProductFieldsApiGetProductFieldRequest, ): Promise { + return localVarFp.getProductField(requestParameters.field_code, requestParameters.include_fields, ).then((request) => request(axios, basePath)); + }, + /** + * Returns metadata about all product fields in the company. + * @summary Get all product fields + * @param {ProductFieldsApiGetProductFieldsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + getProductFields(requestParameters: ProductFieldsApiGetProductFieldsRequest = {}, ): Promise { + return localVarFp.getProductFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor, ).then((request) => request(axios, basePath)); + }, + /** + * Updates a product custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body. + * @summary Update one product field + * @param {ProductFieldsApiUpdateProductFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + updateProductField(requestParameters: ProductFieldsApiUpdateProductFieldRequest, ): Promise { + return localVarFp.updateProductField(requestParameters.field_code, requestParameters.UpdateProductFieldRequest, ).then((request) => request(axios, basePath)); + }, + /** + * Updates existing options for a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options. + * @summary Update product field options in bulk + * @param {ProductFieldsApiUpdateProductFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + */ + updateProductFieldOptions(requestParameters: ProductFieldsApiUpdateProductFieldOptionsRequest, ): Promise { + return localVarFp.updateProductFieldOptions(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner, ).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for addProductField operation in ProductFieldsApi. + * @export + * @interface ProductFieldsApiAddProductFieldRequest + */ +export interface ProductFieldsApiAddProductFieldRequest { + /** + * + * @type {AddProductFieldRequest} + * @memberof ProductFieldsApiAddProductField + */ + readonly AddProductFieldRequest: AddProductFieldRequest +} + +/** + * Request parameters for addProductFieldOptions operation in ProductFieldsApi. + * @export + * @interface ProductFieldsApiAddProductFieldOptionsRequest + */ +export interface ProductFieldsApiAddProductFieldOptionsRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof ProductFieldsApiAddProductFieldOptions + */ + readonly field_code: string + + /** + * + * @type {Array} + * @memberof ProductFieldsApiAddProductFieldOptions + */ + readonly AddDealFieldOptionsRequestInner: Array +} + +/** + * Request parameters for deleteProductField operation in ProductFieldsApi. + * @export + * @interface ProductFieldsApiDeleteProductFieldRequest + */ +export interface ProductFieldsApiDeleteProductFieldRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof ProductFieldsApiDeleteProductField + */ + readonly field_code: string +} + +/** + * Request parameters for deleteProductFieldOptions operation in ProductFieldsApi. + * @export + * @interface ProductFieldsApiDeleteProductFieldOptionsRequest + */ +export interface ProductFieldsApiDeleteProductFieldOptionsRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof ProductFieldsApiDeleteProductFieldOptions + */ + readonly field_code: string + + /** + * + * @type {Array} + * @memberof ProductFieldsApiDeleteProductFieldOptions + */ + readonly DeleteDealFieldOptionsRequestInner: Array +} + +/** + * Request parameters for getProductField operation in ProductFieldsApi. + * @export + * @interface ProductFieldsApiGetProductFieldRequest + */ +export interface ProductFieldsApiGetProductFieldRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof ProductFieldsApiGetProductField + */ + readonly field_code: string + + /** + * Optional comma separated string array of additional data namespaces to include in response + * @type {'ui_visibility'} + * @memberof ProductFieldsApiGetProductField + */ + readonly include_fields?: 'ui_visibility' +} + +/** + * Request parameters for getProductFields operation in ProductFieldsApi. + * @export + * @interface ProductFieldsApiGetProductFieldsRequest + */ +export interface ProductFieldsApiGetProductFieldsRequest { + /** + * Optional comma separated string array of additional data namespaces to include in response + * @type {'ui_visibility'} + * @memberof ProductFieldsApiGetProductFields + */ + 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 ProductFieldsApiGetProductFields + */ + readonly limit?: number + + /** + * For pagination, the marker (an opaque string value) representing the first item on the next page + * @type {string} + * @memberof ProductFieldsApiGetProductFields + */ + readonly cursor?: string +} + +/** + * Request parameters for updateProductField operation in ProductFieldsApi. + * @export + * @interface ProductFieldsApiUpdateProductFieldRequest + */ +export interface ProductFieldsApiUpdateProductFieldRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof ProductFieldsApiUpdateProductField + */ + readonly field_code: string + + /** + * + * @type {UpdateProductFieldRequest} + * @memberof ProductFieldsApiUpdateProductField + */ + readonly UpdateProductFieldRequest: UpdateProductFieldRequest +} + +/** + * Request parameters for updateProductFieldOptions operation in ProductFieldsApi. + * @export + * @interface ProductFieldsApiUpdateProductFieldOptionsRequest + */ +export interface ProductFieldsApiUpdateProductFieldOptionsRequest { + /** + * The unique code identifying the field + * @type {string} + * @memberof ProductFieldsApiUpdateProductFieldOptions + */ + readonly field_code: string + + /** + * + * @type {Array} + * @memberof ProductFieldsApiUpdateProductFieldOptions + */ + readonly UpdateDealFieldOptionsRequestInner: Array +} + +/** + * ProductFieldsApi - object-oriented interface + * @export + * @class ProductFieldsApi + * @extends {BaseAPI} + */ +export class ProductFieldsApi extends BaseAPI { + /** + * Creates a new product custom field. + * @summary Create one product field + * @param {ProductFieldsApiAddProductFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof ProductFieldsApi + */ + public addProductField(requestParameters: ProductFieldsApiAddProductFieldRequest, ) { + return ProductFieldsApiFp(this.configuration).addProductField(requestParameters.AddProductFieldRequest, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Adds new options to a product custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options. + * @summary Add product field options in bulk + * @param {ProductFieldsApiAddProductFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof ProductFieldsApi + */ + public addProductFieldOptions(requestParameters: ProductFieldsApiAddProductFieldOptionsRequest, ) { + return ProductFieldsApiFp(this.configuration).addProductFieldOptions(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Marks a custom field as deleted. + * @summary Delete one product field + * @param {ProductFieldsApiDeleteProductFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof ProductFieldsApi + */ + public deleteProductField(requestParameters: ProductFieldsApiDeleteProductFieldRequest, ) { + return ProductFieldsApiFp(this.configuration).deleteProductField(requestParameters.field_code, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Removes existing options from a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options. + * @summary Delete product field options in bulk + * @param {ProductFieldsApiDeleteProductFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof ProductFieldsApi + */ + public deleteProductFieldOptions(requestParameters: ProductFieldsApiDeleteProductFieldOptionsRequest, ) { + return ProductFieldsApiFp(this.configuration).deleteProductFieldOptions(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns metadata about a specific product field. + * @summary Get one product field + * @param {ProductFieldsApiGetProductFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof ProductFieldsApi + */ + public getProductField(requestParameters: ProductFieldsApiGetProductFieldRequest, ) { + return ProductFieldsApiFp(this.configuration).getProductField(requestParameters.field_code, requestParameters.include_fields, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns metadata about all product fields in the company. + * @summary Get all product fields + * @param {ProductFieldsApiGetProductFieldsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof ProductFieldsApi + */ + public getProductFields(requestParameters: ProductFieldsApiGetProductFieldsRequest = {}, ) { + return ProductFieldsApiFp(this.configuration).getProductFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates a product custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body. + * @summary Update one product field + * @param {ProductFieldsApiUpdateProductFieldRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof ProductFieldsApi + */ + public updateProductField(requestParameters: ProductFieldsApiUpdateProductFieldRequest, ) { + return ProductFieldsApiFp(this.configuration).updateProductField(requestParameters.field_code, requestParameters.UpdateProductFieldRequest, ).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates existing options for a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options. + * @summary Update product field options in bulk + * @param {ProductFieldsApiUpdateProductFieldOptionsRequest} requestParameters Request parameters. + + * @throws {RequiredError} + * @memberof ProductFieldsApi + */ + public updateProductFieldOptions(requestParameters: ProductFieldsApiUpdateProductFieldOptionsRequest, ) { + return ProductFieldsApiFp(this.configuration).updateProductFieldOptions(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner, ).then((request) => request(this.axios, this.basePath)); + } +} diff --git a/src/versions/v2/models/add-deal-field-options-request-inner.ts b/src/versions/v2/models/add-deal-field-options-request-inner.ts new file mode 100644 index 00000000..b62e0108 --- /dev/null +++ b/src/versions/v2/models/add-deal-field-options-request-inner.ts @@ -0,0 +1,29 @@ +/* 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. + */ + + + +/** +* +* @export +* @interface AddDealFieldOptionsRequestInner +*/ +export interface AddDealFieldOptionsRequestInner { + /** + * The display label for the new option + * @type {string} + */ + 'label': string; +} + diff --git a/src/versions/v2/models/add-deal-field-options200-response-data-inner.ts b/src/versions/v2/models/add-deal-field-options200-response-data-inner.ts new file mode 100644 index 00000000..c42e00e2 --- /dev/null +++ b/src/versions/v2/models/add-deal-field-options200-response-data-inner.ts @@ -0,0 +1,34 @@ +/* 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. + */ + + + +/** +* +* @export +* @interface AddDealFieldOptions200ResponseDataInner +*/ +export interface AddDealFieldOptions200ResponseDataInner { + /** + * The unique identifier of the option + * @type {number} + */ + 'id': number; + /** + * The display label of the option + * @type {string} + */ + 'label': string; +} + diff --git a/src/versions/v2/models/add-deal-field-options200-response.ts b/src/versions/v2/models/add-deal-field-options200-response.ts new file mode 100644 index 00000000..f1bdd190 --- /dev/null +++ b/src/versions/v2/models/add-deal-field-options200-response.ts @@ -0,0 +1,42 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { AddDealFieldOptions200ResponseDataInner } from './add-deal-field-options200-response-data-inner'; + +/** +* +* @export +* @interface AddDealFieldOptions200Response +*/ +export interface AddDealFieldOptions200Response { + /** + * + * @type {boolean} + */ + 'success'?: boolean; + /** + * + * @type {Array} + */ + 'data'?: Array; + /** + * + * @type {object} + */ + 'additional_data'?: object | null; +} + diff --git a/src/versions/v2/models/add-deal-field-request-important-fields.ts b/src/versions/v2/models/add-deal-field-request-important-fields.ts new file mode 100644 index 00000000..5acddfa7 --- /dev/null +++ b/src/versions/v2/models/add-deal-field-request-important-fields.ts @@ -0,0 +1,36 @@ +/* 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. + */ + + + +/** +* Configuration for highlighting the field at specific stages. +* @export +* @interface AddDealFieldRequestImportantFields +*/ +export interface AddDealFieldRequestImportantFields { + [key: string]: any | any; + + /** + * Whether the field is marked as important. When false, the field is not highlighted. When true with empty stage_ids, the field is important everywhere. When true with specific stage_ids, the field is important only at those stages. Default is false. + * @type {boolean} + */ + 'enabled'?: boolean; + /** + * Array of deal stage IDs where this field should be highlighted as important. Must reference valid, active deal stages. Empty array when enabled is false. The stages must be in pipelines where this field is visible (show_in_pipelines). + * @type {Array} + */ + 'stage_ids'?: Array; +} + diff --git a/src/versions/v2/models/add-deal-field-request-options-inner.ts b/src/versions/v2/models/add-deal-field-request-options-inner.ts new file mode 100644 index 00000000..4401fe5f --- /dev/null +++ b/src/versions/v2/models/add-deal-field-request-options-inner.ts @@ -0,0 +1,29 @@ +/* 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. + */ + + + +/** +* +* @export +* @interface AddDealFieldRequestOptionsInner +*/ +export interface AddDealFieldRequestOptionsInner { + /** + * The option label + * @type {string} + */ + 'label': string; +} + diff --git a/src/versions/v2/models/add-deal-field-request-required-fields.ts b/src/versions/v2/models/add-deal-field-request-required-fields.ts new file mode 100644 index 00000000..3f769ac1 --- /dev/null +++ b/src/versions/v2/models/add-deal-field-request-required-fields.ts @@ -0,0 +1,49 @@ +/* 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. + */ + + + +/** +* Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI. +* @export +* @interface AddDealFieldRequestRequiredFields +*/ +export interface AddDealFieldRequestRequiredFields { + [key: string]: any | any; + + /** + * Whether the field is required. When false, the field is optional. When true with empty stage_ids, the field is required everywhere. When true with specific stage_ids, the field is required only at those stages. Default is false. + * @type {boolean} + */ + 'enabled'?: boolean; + /** + * Array of deal stage IDs where this field is required. Must reference valid, active deal stages. Empty array when enabled is false. The stages must be in pipelines where this field is visible (show_in_pipelines). + * @type {Array} + */ + 'stage_ids'?: Array; + /** + * Pipeline-specific status requirements for when deals are won or lost. Keys are pipeline IDs (as strings), values are arrays of status strings (\'won\', \'lost\'). Example - {\"1\":[\"won\",\"lost\"],\"2\":[\"won\"]} means the field is required when marking deals as won or lost in pipeline 1, and only when won in pipeline 2. Must reference valid, active pipelines. + * @type {{ [key: string]: Array | undefined; }} + */ + 'statuses'?: { [key: string]: Array | undefined; }; +} + + export const AddDealFieldRequestRequiredFieldsStatusesConst = { + won: 'won', + lost: 'lost' + } as const; + + export type AddDealFieldRequestRequiredFieldsStatusesConst = typeof AddDealFieldRequestRequiredFieldsStatusesConst[keyof typeof AddDealFieldRequestRequiredFieldsStatusesConst]; + + diff --git a/src/versions/v2/models/add-deal-field-request-ui-visibility-show-in-pipelines.ts b/src/versions/v2/models/add-deal-field-request-ui-visibility-show-in-pipelines.ts new file mode 100644 index 00000000..532d949e --- /dev/null +++ b/src/versions/v2/models/add-deal-field-request-ui-visibility-show-in-pipelines.ts @@ -0,0 +1,34 @@ +/* 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. + */ + + + +/** +* Controls which pipelines display this field. Default is show_in_all=true. Note that fields marked as important or required must be visible in the pipelines where they are configured. +* @export +* @interface AddDealFieldRequestUiVisibilityShowInPipelines +*/ +export interface AddDealFieldRequestUiVisibilityShowInPipelines { + /** + * When true, the field is visible in all pipelines. When false, visibility is controlled by pipeline_ids. Default is true. + * @type {boolean} + */ + 'show_in_all'?: boolean; + /** + * Array of pipeline IDs where the field should be visible. Only used when show_in_all is false. Must reference valid, active pipelines. + * @type {Array} + */ + 'pipeline_ids'?: Array; +} + diff --git a/src/versions/v2/models/add-deal-field-request-ui-visibility.ts b/src/versions/v2/models/add-deal-field-request-ui-visibility.ts new file mode 100644 index 00000000..4d10b050 --- /dev/null +++ b/src/versions/v2/models/add-deal-field-request-ui-visibility.ts @@ -0,0 +1,49 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { AddDealFieldRequestUiVisibilityShowInPipelines } from './add-deal-field-request-ui-visibility-show-in-pipelines'; + +/** +* UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI. +* @export +* @interface AddDealFieldRequestUiVisibility +*/ +export interface AddDealFieldRequestUiVisibility { + [key: string]: any | any; + + /** + * Whether the field is shown in the add deal modal. Default is false. Cannot be set to false for required system fields (title, pipeline, stage_id, probability). + * @type {boolean} + */ + 'add_visible_flag'?: boolean; + /** + * Whether the field is shown in the deal details view. Default is true. + * @type {boolean} + */ + 'details_visible_flag'?: boolean; + /** + * Whether the field is shown in the project details view when the deal is linked to a project. Default is false. + * @type {boolean} + */ + 'projects_detail_visible_flag'?: boolean; + /** + * + * @type {AddDealFieldRequestUiVisibilityShowInPipelines} + */ + 'show_in_pipelines'?: AddDealFieldRequestUiVisibilityShowInPipelines; +} + diff --git a/src/versions/v2/models/add-deal-field-request.ts b/src/versions/v2/models/add-deal-field-request.ts new file mode 100644 index 00000000..56273af7 --- /dev/null +++ b/src/versions/v2/models/add-deal-field-request.ts @@ -0,0 +1,93 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { AddDealFieldRequestImportantFields } from './add-deal-field-request-important-fields'; +// May contain unused imports in some cases +// @ts-ignore +import { AddDealFieldRequestOptionsInner } from './add-deal-field-request-options-inner'; +// May contain unused imports in some cases +// @ts-ignore +import { AddDealFieldRequestRequiredFields } from './add-deal-field-request-required-fields'; +// May contain unused imports in some cases +// @ts-ignore +import { AddDealFieldRequestUiVisibility } from './add-deal-field-request-ui-visibility'; + +/** +* +* @export +* @interface AddDealFieldRequest +*/ +export interface AddDealFieldRequest { + /** + * Field name + * @type {string} + */ + 'field_name': string; + /** + * The type of the field
ValueDescription
`varchar`Text (up to 255 characters)
`varchar_auto`Autocomplete text (up to 255 characters)
`text`Long text (up to 65k characters)
`double`Numeric value
`monetary`Monetary field (has a numeric value and a currency value)
`date`Date (format YYYY-MM-DD)
`set`Options field with a possibility of having multiple chosen options
`enum`Options field with a single possible chosen option
`user`User field (contains a user ID of another Pipedrive user)
`org`Organization field (contains an organization ID which is stored on the same account)
`people`Person field (contains a product ID which is stored on the same account)
`phone`Phone field (up to 255 numbers and/or characters)
`time`Time field (format HH:MM:SS)
`timerange`Time-range field (has a start time and end time value, both HH:MM:SS)
`daterange`Date-range field (has a start date and end date value, both YYYY-MM-DD)
`address`Address field
+ * @type {string} + */ + 'field_type': AddDealFieldRequestFieldTypeConst; + /** + * Field options (required for enum and set field types) + * @type {Array} + */ + 'options'?: Array; + /** + * + * @type {AddDealFieldRequestUiVisibility} + */ + 'ui_visibility'?: AddDealFieldRequestUiVisibility; + /** + * + * @type {AddDealFieldRequestImportantFields} + */ + 'important_fields'?: AddDealFieldRequestImportantFields; + /** + * + * @type {AddDealFieldRequestRequiredFields} + */ + 'required_fields'?: AddDealFieldRequestRequiredFields; + /** + * Field description + * @type {string} + */ + 'description'?: string | null; +} + + export const AddDealFieldRequestFieldTypeConst = { + varchar: 'varchar', + text: 'text', + double: 'double', + phone: 'phone', + date: 'date', + daterange: 'daterange', + time: 'time', + timerange: 'timerange', + set: 'set', + enum: 'enum', + varchar_auto: 'varchar_auto', + address: 'address', + monetary: 'monetary', + org: 'org', + people: 'people', + user: 'user' + } as const; + + export type AddDealFieldRequestFieldTypeConst = typeof AddDealFieldRequestFieldTypeConst[keyof typeof AddDealFieldRequestFieldTypeConst]; + + diff --git a/src/versions/v2/models/add-deal-field200-response.ts b/src/versions/v2/models/add-deal-field200-response.ts new file mode 100644 index 00000000..51c08105 --- /dev/null +++ b/src/versions/v2/models/add-deal-field200-response.ts @@ -0,0 +1,37 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { GetDealFields200ResponseDataInner } from './get-deal-fields200-response-data-inner'; + +/** +* +* @export +* @interface AddDealField200Response +*/ +export interface AddDealField200Response { + /** + * Whether the request was successful + * @type {boolean} + */ + 'success'?: boolean; + /** + * + * @type {GetDealFields200ResponseDataInner} + */ + 'data'?: GetDealFields200ResponseDataInner; +} + diff --git a/src/versions/v2/models/add-organization-field-request-important-fields.ts b/src/versions/v2/models/add-organization-field-request-important-fields.ts new file mode 100644 index 00000000..23dadda9 --- /dev/null +++ b/src/versions/v2/models/add-organization-field-request-important-fields.ts @@ -0,0 +1,36 @@ +/* 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. + */ + + + +/** +* Configuration for highlighting the field at specific stages. +* @export +* @interface AddOrganizationFieldRequestImportantFields +*/ +export interface AddOrganizationFieldRequestImportantFields { + [key: string]: any | any; + + /** + * Whether the field is marked as important. When false, the field is not highlighted. When true with empty stage_ids, the field is important everywhere. When true with specific stage_ids, the field is important only at those deal stages. Default is false. + * @type {boolean} + */ + 'enabled'?: boolean; + /** + * Array of deal stage IDs where this organization field should be highlighted as important. Must reference valid, active deal stages. Empty array when enabled is false. + * @type {Array} + */ + 'stage_ids'?: Array; +} + diff --git a/src/versions/v2/models/add-organization-field-request-required-fields.ts b/src/versions/v2/models/add-organization-field-request-required-fields.ts new file mode 100644 index 00000000..bf814d61 --- /dev/null +++ b/src/versions/v2/models/add-organization-field-request-required-fields.ts @@ -0,0 +1,31 @@ +/* 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. + */ + + + +/** +* Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI. +* @export +* @interface AddOrganizationFieldRequestRequiredFields +*/ +export interface AddOrganizationFieldRequestRequiredFields { + [key: string]: any | any; + + /** + * Whether the field is required. When false, the field is optional. When true, the field is required when creating or updating organizations. Default is false. + * @type {boolean} + */ + 'enabled'?: boolean; +} + diff --git a/src/versions/v2/models/add-organization-field-request-ui-visibility-show-in-add-deal-dialog.ts b/src/versions/v2/models/add-organization-field-request-ui-visibility-show-in-add-deal-dialog.ts new file mode 100644 index 00000000..f1046b13 --- /dev/null +++ b/src/versions/v2/models/add-organization-field-request-ui-visibility-show-in-add-deal-dialog.ts @@ -0,0 +1,34 @@ +/* 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. + */ + + + +/** +* Configuration for showing this organization field when adding a new deal. Only available for custom fields or specific eligible system fields. Default is show=false, order=null. +* @export +* @interface AddOrganizationFieldRequestUiVisibilityShowInAddDealDialog +*/ +export interface AddOrganizationFieldRequestUiVisibilityShowInAddDealDialog { + /** + * Whether the field is shown in the add deal dialog. Default is false. + * @type {boolean} + */ + 'show'?: boolean; + /** + * Display order in the add deal dialog. This value is auto-calculated and managed by the system. When show is set to false, order is automatically set to null. When show changes from false to true, order is automatically assigned the next available position. + * @type {number} + */ + 'order'?: number | null; +} + diff --git a/src/versions/v2/models/add-organization-field-request-ui-visibility-show-in-add-person-dialog.ts b/src/versions/v2/models/add-organization-field-request-ui-visibility-show-in-add-person-dialog.ts new file mode 100644 index 00000000..b36d5676 --- /dev/null +++ b/src/versions/v2/models/add-organization-field-request-ui-visibility-show-in-add-person-dialog.ts @@ -0,0 +1,34 @@ +/* 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. + */ + + + +/** +* Configuration for showing this organization field when adding a new person. Only available for custom fields or specific eligible system fields. Default is show=false, order=null. +* @export +* @interface AddOrganizationFieldRequestUiVisibilityShowInAddPersonDialog +*/ +export interface AddOrganizationFieldRequestUiVisibilityShowInAddPersonDialog { + /** + * Whether the field is shown in the add person dialog. Default is false. + * @type {boolean} + */ + 'show'?: boolean; + /** + * Display order in the add person dialog. This value is auto-calculated and managed by the system. When show is set to false, order is automatically set to null. When show changes from false to true, order is automatically assigned the next available position. + * @type {number} + */ + 'order'?: number | null; +} + diff --git a/src/versions/v2/models/add-organization-field-request-ui-visibility.ts b/src/versions/v2/models/add-organization-field-request-ui-visibility.ts new file mode 100644 index 00000000..92e9b0be --- /dev/null +++ b/src/versions/v2/models/add-organization-field-request-ui-visibility.ts @@ -0,0 +1,52 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { AddOrganizationFieldRequestUiVisibilityShowInAddDealDialog } from './add-organization-field-request-ui-visibility-show-in-add-deal-dialog'; +// May contain unused imports in some cases +// @ts-ignore +import { AddOrganizationFieldRequestUiVisibilityShowInAddPersonDialog } from './add-organization-field-request-ui-visibility-show-in-add-person-dialog'; + +/** +* UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI. +* @export +* @interface AddOrganizationFieldRequestUiVisibility +*/ +export interface AddOrganizationFieldRequestUiVisibility { + [key: string]: any | any; + + /** + * Whether the field is shown in the add organization modal. Default is false. Cannot be set to false for the \'name\' system field. + * @type {boolean} + */ + 'add_visible_flag'?: boolean; + /** + * Whether the field is shown in the organization details view. Default is true. + * @type {boolean} + */ + 'details_visible_flag'?: boolean; + /** + * + * @type {AddOrganizationFieldRequestUiVisibilityShowInAddDealDialog} + */ + 'show_in_add_deal_dialog'?: AddOrganizationFieldRequestUiVisibilityShowInAddDealDialog; + /** + * + * @type {AddOrganizationFieldRequestUiVisibilityShowInAddPersonDialog} + */ + 'show_in_add_person_dialog'?: AddOrganizationFieldRequestUiVisibilityShowInAddPersonDialog; +} + diff --git a/src/versions/v2/models/add-organization-field-request.ts b/src/versions/v2/models/add-organization-field-request.ts new file mode 100644 index 00000000..23776480 --- /dev/null +++ b/src/versions/v2/models/add-organization-field-request.ts @@ -0,0 +1,93 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { AddDealFieldRequestOptionsInner } from './add-deal-field-request-options-inner'; +// May contain unused imports in some cases +// @ts-ignore +import { AddOrganizationFieldRequestImportantFields } from './add-organization-field-request-important-fields'; +// May contain unused imports in some cases +// @ts-ignore +import { AddOrganizationFieldRequestRequiredFields } from './add-organization-field-request-required-fields'; +// May contain unused imports in some cases +// @ts-ignore +import { AddOrganizationFieldRequestUiVisibility } from './add-organization-field-request-ui-visibility'; + +/** +* +* @export +* @interface AddOrganizationFieldRequest +*/ +export interface AddOrganizationFieldRequest { + /** + * Field name + * @type {string} + */ + 'field_name': string; + /** + * The type of the field
ValueDescription
`varchar`Text (up to 255 characters)
`varchar_auto`Autocomplete text (up to 255 characters)
`text`Long text (up to 65k characters)
`double`Numeric value
`monetary`Monetary field (has a numeric value and a currency value)
`date`Date (format YYYY-MM-DD)
`set`Options field with a possibility of having multiple chosen options
`enum`Options field with a single possible chosen option
`user`User field (contains a user ID of another Pipedrive user)
`org`Organization field (contains an organization ID which is stored on the same account)
`people`Person field (contains a product ID which is stored on the same account)
`phone`Phone field (up to 255 numbers and/or characters)
`time`Time field (format HH:MM:SS)
`timerange`Time-range field (has a start time and end time value, both HH:MM:SS)
`daterange`Date-range field (has a start date and end date value, both YYYY-MM-DD)
`address`Address field
+ * @type {string} + */ + 'field_type': AddOrganizationFieldRequestFieldTypeConst; + /** + * Field options (required for enum and set field types) + * @type {Array} + */ + 'options'?: Array; + /** + * + * @type {AddOrganizationFieldRequestUiVisibility} + */ + 'ui_visibility'?: AddOrganizationFieldRequestUiVisibility; + /** + * + * @type {AddOrganizationFieldRequestImportantFields} + */ + 'important_fields'?: AddOrganizationFieldRequestImportantFields; + /** + * + * @type {AddOrganizationFieldRequestRequiredFields} + */ + 'required_fields'?: AddOrganizationFieldRequestRequiredFields; + /** + * Field description + * @type {string} + */ + 'description'?: string | null; +} + + export const AddOrganizationFieldRequestFieldTypeConst = { + varchar: 'varchar', + text: 'text', + double: 'double', + phone: 'phone', + date: 'date', + daterange: 'daterange', + time: 'time', + timerange: 'timerange', + set: 'set', + enum: 'enum', + varchar_auto: 'varchar_auto', + address: 'address', + monetary: 'monetary', + org: 'org', + people: 'people', + user: 'user' + } as const; + + export type AddOrganizationFieldRequestFieldTypeConst = typeof AddOrganizationFieldRequestFieldTypeConst[keyof typeof AddOrganizationFieldRequestFieldTypeConst]; + + diff --git a/src/versions/v2/models/add-organization-field200-response.ts b/src/versions/v2/models/add-organization-field200-response.ts new file mode 100644 index 00000000..03cf5a47 --- /dev/null +++ b/src/versions/v2/models/add-organization-field200-response.ts @@ -0,0 +1,37 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { GetOrganizationFields200ResponseDataInner } from './get-organization-fields200-response-data-inner'; + +/** +* +* @export +* @interface AddOrganizationField200Response +*/ +export interface AddOrganizationField200Response { + /** + * Whether the request was successful + * @type {boolean} + */ + 'success'?: boolean; + /** + * + * @type {GetOrganizationFields200ResponseDataInner} + */ + 'data'?: GetOrganizationFields200ResponseDataInner; +} + diff --git a/src/versions/v2/models/add-person-field-request-important-fields.ts b/src/versions/v2/models/add-person-field-request-important-fields.ts new file mode 100644 index 00000000..d82fb5b2 --- /dev/null +++ b/src/versions/v2/models/add-person-field-request-important-fields.ts @@ -0,0 +1,36 @@ +/* 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. + */ + + + +/** +* Configuration for highlighting the field at specific stages. +* @export +* @interface AddPersonFieldRequestImportantFields +*/ +export interface AddPersonFieldRequestImportantFields { + [key: string]: any | any; + + /** + * Whether the field is marked as important. When false, the field is not highlighted. When true with empty stage_ids, the field is important everywhere. When true with specific stage_ids, the field is important only at those deal stages. Default is false. + * @type {boolean} + */ + 'enabled'?: boolean; + /** + * Array of deal stage IDs where this person field should be highlighted as important. Must reference valid, active deal stages. Empty array when enabled is false. + * @type {Array} + */ + 'stage_ids'?: Array; +} + diff --git a/src/versions/v2/models/add-person-field-request-required-fields.ts b/src/versions/v2/models/add-person-field-request-required-fields.ts new file mode 100644 index 00000000..3fe78f1a --- /dev/null +++ b/src/versions/v2/models/add-person-field-request-required-fields.ts @@ -0,0 +1,31 @@ +/* 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. + */ + + + +/** +* Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI. +* @export +* @interface AddPersonFieldRequestRequiredFields +*/ +export interface AddPersonFieldRequestRequiredFields { + [key: string]: any | any; + + /** + * Whether the field is required. When false, the field is optional. When true, the field is required when creating or updating persons. Default is false. + * @type {boolean} + */ + 'enabled'?: boolean; +} + diff --git a/src/versions/v2/models/add-person-field-request-ui-visibility-show-in-add-deal-dialog.ts b/src/versions/v2/models/add-person-field-request-ui-visibility-show-in-add-deal-dialog.ts new file mode 100644 index 00000000..0f66c9b1 --- /dev/null +++ b/src/versions/v2/models/add-person-field-request-ui-visibility-show-in-add-deal-dialog.ts @@ -0,0 +1,34 @@ +/* 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. + */ + + + +/** +* Configuration for showing this person field when adding a new deal. Only available for custom fields or specific eligible system fields. Default is show=false, order=null. +* @export +* @interface AddPersonFieldRequestUiVisibilityShowInAddDealDialog +*/ +export interface AddPersonFieldRequestUiVisibilityShowInAddDealDialog { + /** + * Whether the field is shown in the add deal dialog. Default is false. + * @type {boolean} + */ + 'show'?: boolean; + /** + * Display order in the add deal dialog. This value is auto-calculated and managed by the system. When show is set to false, order is automatically set to null. When show changes from false to true, order is automatically assigned the next available position. + * @type {number} + */ + 'order'?: number | null; +} + diff --git a/src/versions/v2/models/add-person-field-request-ui-visibility.ts b/src/versions/v2/models/add-person-field-request-ui-visibility.ts new file mode 100644 index 00000000..b8982a6b --- /dev/null +++ b/src/versions/v2/models/add-person-field-request-ui-visibility.ts @@ -0,0 +1,44 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { AddPersonFieldRequestUiVisibilityShowInAddDealDialog } from './add-person-field-request-ui-visibility-show-in-add-deal-dialog'; + +/** +* UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI. +* @export +* @interface AddPersonFieldRequestUiVisibility +*/ +export interface AddPersonFieldRequestUiVisibility { + [key: string]: any | any; + + /** + * Whether the field is shown in the add person modal. Default is false. Cannot be set to false for required system fields (\'name\', \'org_id\'). + * @type {boolean} + */ + 'add_visible_flag'?: boolean; + /** + * Whether the field is shown in the person details view. Default is true. + * @type {boolean} + */ + 'details_visible_flag'?: boolean; + /** + * + * @type {AddPersonFieldRequestUiVisibilityShowInAddDealDialog} + */ + 'show_in_add_deal_dialog'?: AddPersonFieldRequestUiVisibilityShowInAddDealDialog; +} + diff --git a/src/versions/v2/models/add-person-field-request.ts b/src/versions/v2/models/add-person-field-request.ts new file mode 100644 index 00000000..b7da0e63 --- /dev/null +++ b/src/versions/v2/models/add-person-field-request.ts @@ -0,0 +1,93 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { AddDealFieldRequestOptionsInner } from './add-deal-field-request-options-inner'; +// May contain unused imports in some cases +// @ts-ignore +import { AddPersonFieldRequestImportantFields } from './add-person-field-request-important-fields'; +// May contain unused imports in some cases +// @ts-ignore +import { AddPersonFieldRequestRequiredFields } from './add-person-field-request-required-fields'; +// May contain unused imports in some cases +// @ts-ignore +import { AddPersonFieldRequestUiVisibility } from './add-person-field-request-ui-visibility'; + +/** +* +* @export +* @interface AddPersonFieldRequest +*/ +export interface AddPersonFieldRequest { + /** + * Field name + * @type {string} + */ + 'field_name': string; + /** + * The type of the field
ValueDescription
`varchar`Text (up to 255 characters)
`varchar_auto`Autocomplete text (up to 255 characters)
`text`Long text (up to 65k characters)
`double`Numeric value
`monetary`Monetary field (has a numeric value and a currency value)
`date`Date (format YYYY-MM-DD)
`set`Options field with a possibility of having multiple chosen options
`enum`Options field with a single possible chosen option
`user`User field (contains a user ID of another Pipedrive user)
`org`Organization field (contains an organization ID which is stored on the same account)
`people`Person field (contains a product ID which is stored on the same account)
`phone`Phone field (up to 255 numbers and/or characters)
`time`Time field (format HH:MM:SS)
`timerange`Time-range field (has a start time and end time value, both HH:MM:SS)
`daterange`Date-range field (has a start date and end date value, both YYYY-MM-DD)
`address`Address field
+ * @type {string} + */ + 'field_type': AddPersonFieldRequestFieldTypeConst; + /** + * Field options (required for enum and set field types) + * @type {Array} + */ + 'options'?: Array; + /** + * + * @type {AddPersonFieldRequestUiVisibility} + */ + 'ui_visibility'?: AddPersonFieldRequestUiVisibility; + /** + * + * @type {AddPersonFieldRequestImportantFields} + */ + 'important_fields'?: AddPersonFieldRequestImportantFields; + /** + * + * @type {AddPersonFieldRequestRequiredFields} + */ + 'required_fields'?: AddPersonFieldRequestRequiredFields; + /** + * Field description + * @type {string} + */ + 'description'?: string | null; +} + + export const AddPersonFieldRequestFieldTypeConst = { + varchar: 'varchar', + text: 'text', + double: 'double', + phone: 'phone', + date: 'date', + daterange: 'daterange', + time: 'time', + timerange: 'timerange', + set: 'set', + enum: 'enum', + varchar_auto: 'varchar_auto', + address: 'address', + monetary: 'monetary', + org: 'org', + people: 'people', + user: 'user' + } as const; + + export type AddPersonFieldRequestFieldTypeConst = typeof AddPersonFieldRequestFieldTypeConst[keyof typeof AddPersonFieldRequestFieldTypeConst]; + + diff --git a/src/versions/v2/models/add-person-field200-response.ts b/src/versions/v2/models/add-person-field200-response.ts new file mode 100644 index 00000000..d26916d5 --- /dev/null +++ b/src/versions/v2/models/add-person-field200-response.ts @@ -0,0 +1,37 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { GetPersonFields200ResponseDataInner } from './get-person-fields200-response-data-inner'; + +/** +* +* @export +* @interface AddPersonField200Response +*/ +export interface AddPersonField200Response { + /** + * Whether the request was successful + * @type {boolean} + */ + 'success'?: boolean; + /** + * + * @type {GetPersonFields200ResponseDataInner} + */ + 'data'?: GetPersonFields200ResponseDataInner; +} + diff --git a/src/versions/v2/models/add-product-field-request-ui-visibility.ts b/src/versions/v2/models/add-product-field-request-ui-visibility.ts new file mode 100644 index 00000000..87902898 --- /dev/null +++ b/src/versions/v2/models/add-product-field-request-ui-visibility.ts @@ -0,0 +1,36 @@ +/* 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. + */ + + + +/** +* UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI. Note that products have a simpler visibility model than other entity types. +* @export +* @interface AddProductFieldRequestUiVisibility +*/ +export interface AddProductFieldRequestUiVisibility { + [key: string]: any | any; + + /** + * Whether the field is shown in the add product modal. Default is false. Cannot be set to false for the \'name\' system field. + * @type {boolean} + */ + 'add_visible_flag'?: boolean; + /** + * Whether the field is shown in the product details view. Default is true. + * @type {boolean} + */ + 'details_visible_flag'?: boolean; +} + diff --git a/src/versions/v2/models/add-product-field-request.ts b/src/versions/v2/models/add-product-field-request.ts new file mode 100644 index 00000000..f7d46075 --- /dev/null +++ b/src/versions/v2/models/add-product-field-request.ts @@ -0,0 +1,77 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { AddDealFieldRequestOptionsInner } from './add-deal-field-request-options-inner'; +// May contain unused imports in some cases +// @ts-ignore +import { AddProductFieldRequestUiVisibility } from './add-product-field-request-ui-visibility'; + +/** +* +* @export +* @interface AddProductFieldRequest +*/ +export interface AddProductFieldRequest { + /** + * Field name + * @type {string} + */ + 'field_name': string; + /** + * The type of the field
ValueDescription
`varchar`Text (up to 255 characters)
`varchar_auto`Autocomplete text (up to 255 characters)
`text`Long text (up to 65k characters)
`double`Numeric value
`monetary`Monetary field (has a numeric value and a currency value)
`date`Date (format YYYY-MM-DD)
`set`Options field with a possibility of having multiple chosen options
`enum`Options field with a single possible chosen option
`user`User field (contains a user ID of another Pipedrive user)
`org`Organization field (contains an organization ID which is stored on the same account)
`people`Person field (contains a product ID which is stored on the same account)
`phone`Phone field (up to 255 numbers and/or characters)
`time`Time field (format HH:MM:SS)
`timerange`Time-range field (has a start time and end time value, both HH:MM:SS)
`daterange`Date-range field (has a start date and end date value, both YYYY-MM-DD)
`address`Address field
+ * @type {string} + */ + 'field_type': AddProductFieldRequestFieldTypeConst; + /** + * Field options (required for enum and set field types) + * @type {Array} + */ + 'options'?: Array; + /** + * + * @type {AddProductFieldRequestUiVisibility} + */ + 'ui_visibility'?: AddProductFieldRequestUiVisibility; + /** + * Field description + * @type {string} + */ + 'description'?: string | null; +} + + export const AddProductFieldRequestFieldTypeConst = { + varchar: 'varchar', + text: 'text', + double: 'double', + phone: 'phone', + date: 'date', + daterange: 'daterange', + time: 'time', + timerange: 'timerange', + set: 'set', + enum: 'enum', + varchar_auto: 'varchar_auto', + address: 'address', + monetary: 'monetary', + org: 'org', + people: 'people', + user: 'user' + } as const; + + export type AddProductFieldRequestFieldTypeConst = typeof AddProductFieldRequestFieldTypeConst[keyof typeof AddProductFieldRequestFieldTypeConst]; + + diff --git a/src/versions/v2/models/delete-deal-field-options-request-inner.ts b/src/versions/v2/models/delete-deal-field-options-request-inner.ts new file mode 100644 index 00000000..1ba75a15 --- /dev/null +++ b/src/versions/v2/models/delete-deal-field-options-request-inner.ts @@ -0,0 +1,29 @@ +/* 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. + */ + + + +/** +* +* @export +* @interface DeleteDealFieldOptionsRequestInner +*/ +export interface DeleteDealFieldOptionsRequestInner { + /** + * The unique identifier of the option to delete + * @type {number} + */ + 'id': number; +} + diff --git a/src/versions/v2/models/delete-deal-field200-response-data.ts b/src/versions/v2/models/delete-deal-field200-response-data.ts new file mode 100644 index 00000000..a331b8b0 --- /dev/null +++ b/src/versions/v2/models/delete-deal-field200-response-data.ts @@ -0,0 +1,64 @@ +/* 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. + */ + + + +/** +* +* @export +* @interface DeleteDealField200ResponseData +*/ +export interface DeleteDealField200ResponseData { + /** + * The display name/label of the field + * @type {string} + */ + 'field_name': string; + /** + * The unique identifier for the field (40-character hash for custom fields) + * @type {string} + */ + 'field_code': string; + /** + * The description of the field + * @type {string} + */ + 'description': string; + /** + * The type of the field + * @type {string} + */ + 'field_type': string; + /** + * Whether this is a user-created custom field + * @type {boolean} + */ + 'is_custom_field': boolean; + /** + * Whether this field is not returned by default in entity responses + * @type {boolean} + */ + 'is_optional_response_field': boolean; + /** + * Array of available options for enum/set fields, null for other field types + * @type {Array} + */ + 'options'?: Array | null; + /** + * Array of subfields for complex field types (address, monetary), null for simple field types + * @type {Array} + */ + 'subfields'?: Array | null; +} + diff --git a/src/versions/v2/models/delete-deal-field200-response.ts b/src/versions/v2/models/delete-deal-field200-response.ts new file mode 100644 index 00000000..5558ff3b --- /dev/null +++ b/src/versions/v2/models/delete-deal-field200-response.ts @@ -0,0 +1,37 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { DeleteDealField200ResponseData } from './delete-deal-field200-response-data'; + +/** +* +* @export +* @interface DeleteDealField200Response +*/ +export interface DeleteDealField200Response { + /** + * Whether the request was successful + * @type {boolean} + */ + 'success'?: boolean; + /** + * + * @type {DeleteDealField200ResponseData} + */ + 'data'?: DeleteDealField200ResponseData; +} + diff --git a/src/versions/v2/models/delete-person-field200-response-data.ts b/src/versions/v2/models/delete-person-field200-response-data.ts new file mode 100644 index 00000000..0a8c26bf --- /dev/null +++ b/src/versions/v2/models/delete-person-field200-response-data.ts @@ -0,0 +1,59 @@ +/* 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. + */ + + + +/** +* +* @export +* @interface DeletePersonField200ResponseData +*/ +export interface DeletePersonField200ResponseData { + /** + * The display name/label of the field + * @type {string} + */ + 'field_name': string; + /** + * The unique identifier for the field (40-character hash for custom fields) + * @type {string} + */ + 'field_code': string; + /** + * The type of the field + * @type {string} + */ + 'field_type': string; + /** + * Whether this is a user-created custom field + * @type {boolean} + */ + 'is_custom_field': boolean; + /** + * Whether this field is not returned by default in entity responses + * @type {boolean} + */ + 'is_optional_response_field': boolean; + /** + * Array of available options for enum/set fields, null for other field types + * @type {Array} + */ + 'options'?: Array | null; + /** + * Array of subfields for complex field types (address, monetary), null for simple field types + * @type {Array} + */ + 'subfields'?: Array | null; +} + diff --git a/src/versions/v2/models/delete-person-field200-response.ts b/src/versions/v2/models/delete-person-field200-response.ts new file mode 100644 index 00000000..dc9a221c --- /dev/null +++ b/src/versions/v2/models/delete-person-field200-response.ts @@ -0,0 +1,37 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { DeletePersonField200ResponseData } from './delete-person-field200-response-data'; + +/** +* +* @export +* @interface DeletePersonField200Response +*/ +export interface DeletePersonField200Response { + /** + * Whether the request was successful + * @type {boolean} + */ + 'success'?: boolean; + /** + * + * @type {DeletePersonField200ResponseData} + */ + 'data'?: DeletePersonField200ResponseData; +} + diff --git a/src/versions/v2/models/get-activity-field200-response.ts b/src/versions/v2/models/get-activity-field200-response.ts new file mode 100644 index 00000000..af347fb0 --- /dev/null +++ b/src/versions/v2/models/get-activity-field200-response.ts @@ -0,0 +1,37 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { GetActivityFields200ResponseDataInner } from './get-activity-fields200-response-data-inner'; + +/** +* +* @export +* @interface GetActivityField200Response +*/ +export interface GetActivityField200Response { + /** + * Whether the request was successful + * @type {boolean} + */ + 'success'?: boolean; + /** + * + * @type {GetActivityFields200ResponseDataInner} + */ + 'data'?: GetActivityFields200ResponseDataInner; +} + diff --git a/src/versions/v2/models/get-activity-fields200-response-additional-data.ts b/src/versions/v2/models/get-activity-fields200-response-additional-data.ts new file mode 100644 index 00000000..d221cf1f --- /dev/null +++ b/src/versions/v2/models/get-activity-fields200-response-additional-data.ts @@ -0,0 +1,29 @@ +/* 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. + */ + + + +/** +* +* @export +* @interface GetActivityFields200ResponseAdditionalData +*/ +export interface GetActivityFields200ResponseAdditionalData { + /** + * Base64url-encoded cursor for fetching the next page of results, null if no more pages + * @type {string} + */ + 'next_cursor'?: string | null; +} + diff --git a/src/versions/v2/models/get-activity-fields200-response-data-inner-options-inner.ts b/src/versions/v2/models/get-activity-fields200-response-data-inner-options-inner.ts new file mode 100644 index 00000000..8b6456c7 --- /dev/null +++ b/src/versions/v2/models/get-activity-fields200-response-data-inner-options-inner.ts @@ -0,0 +1,49 @@ +/* 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. + */ + + + +/** +* +* @export +* @interface GetActivityFields200ResponseDataInnerOptionsInner +*/ +export interface GetActivityFields200ResponseDataInnerOptionsInner { + /** + * The option ID + * @type {number} + */ + 'id'?: number; + /** + * The option display label + * @type {string} + */ + 'label'?: string; + /** + * Optional color code for the option + * @type {string} + */ + 'color'?: string | null; + /** + * When the option was last updated + * @type {string} + */ + 'update_time'?: string | null; + /** + * When the option was created + * @type {string} + */ + 'add_time'?: string | null; +} + diff --git a/src/versions/v2/models/get-activity-fields200-response-data-inner-subfields-inner.ts b/src/versions/v2/models/get-activity-fields200-response-data-inner-subfields-inner.ts new file mode 100644 index 00000000..5deafc75 --- /dev/null +++ b/src/versions/v2/models/get-activity-fields200-response-data-inner-subfields-inner.ts @@ -0,0 +1,39 @@ +/* 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. + */ + + + +/** +* +* @export +* @interface GetActivityFields200ResponseDataInnerSubfieldsInner +*/ +export interface GetActivityFields200ResponseDataInnerSubfieldsInner { + /** + * The subfield identifier + * @type {string} + */ + 'field_code'?: string; + /** + * The subfield display name + * @type {string} + */ + 'field_name'?: string; + /** + * The subfield type + * @type {string} + */ + 'field_type'?: string; +} + diff --git a/src/versions/v2/models/get-activity-fields200-response-data-inner-ui-visibility.ts b/src/versions/v2/models/get-activity-fields200-response-data-inner-ui-visibility.ts new file mode 100644 index 00000000..f58dd446 --- /dev/null +++ b/src/versions/v2/models/get-activity-fields200-response-data-inner-ui-visibility.ts @@ -0,0 +1,34 @@ +/* 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. + */ + + + +/** +* UI visibility settings (only included when requested via include_fields parameter) +* @export +* @interface GetActivityFields200ResponseDataInnerUiVisibility +*/ +export interface GetActivityFields200ResponseDataInnerUiVisibility { + /** + * Whether the field is shown in the add modal + * @type {boolean} + */ + 'add_visible_flag'?: boolean; + /** + * Whether the field is shown in the details view (read-only) + * @type {boolean} + */ + 'details_visible_flag'?: boolean; +} + diff --git a/src/versions/v2/models/get-activity-fields200-response-data-inner.ts b/src/versions/v2/models/get-activity-fields200-response-data-inner.ts new file mode 100644 index 00000000..bbb070b6 --- /dev/null +++ b/src/versions/v2/models/get-activity-fields200-response-data-inner.ts @@ -0,0 +1,112 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { GetActivityFields200ResponseDataInnerOptionsInner } from './get-activity-fields200-response-data-inner-options-inner'; +// May contain unused imports in some cases +// @ts-ignore +import { GetActivityFields200ResponseDataInnerSubfieldsInner } from './get-activity-fields200-response-data-inner-subfields-inner'; +// May contain unused imports in some cases +// @ts-ignore +import { GetActivityFields200ResponseDataInnerUiVisibility } from './get-activity-fields200-response-data-inner-ui-visibility'; + +/** +* +* @export +* @interface GetActivityFields200ResponseDataInner +*/ +export interface GetActivityFields200ResponseDataInner { + /** + * The display name/label of the field + * @type {string} + */ + 'field_name': string; + /** + * The unique identifier for the field (40-character hash for custom fields) + * @type {string} + */ + 'field_code': string; + /** + * The type of the field + * @type {string} + */ + 'field_type': GetActivityFields200ResponseDataInnerFieldTypeConst; + /** + * Whether this is a user-created custom field + * @type {boolean} + */ + 'is_custom_field': boolean; + /** + * Whether this field is not returned by default in entity responses + * @type {boolean} + */ + 'is_optional_response_field': boolean; + /** + * Array of available options for enum/set fields, null for other field types + * @type {Array} + */ + 'options'?: Array | null; + /** + * Array of subfields for complex field types (address, monetary), null for simple field types + * @type {Array} + */ + 'subfields'?: Array | null; + /** + * + * @type {GetActivityFields200ResponseDataInnerUiVisibility} + */ + 'ui_visibility'?: GetActivityFields200ResponseDataInnerUiVisibility; +} + + export const GetActivityFields200ResponseDataInnerFieldTypeConst = { + int: 'int', + double: 'double', + boolean: 'boolean', + varchar: 'varchar', + text: 'text', + phone: 'phone', + varchar_options: 'varchar_options', + varchar_auto: 'varchar_auto', + date: 'date', + daterange: 'daterange', + time: 'time', + timerange: 'timerange', + enum: 'enum', + set: 'set', + address: 'address', + monetary: 'monetary', + deal: 'deal', + deals: 'deals', + lead: 'lead', + org: 'org', + people: 'people', + project: 'project', + stage: 'stage', + user: 'user', + activity: 'activity', + json: 'json', + picture: 'picture', + status: 'status', + visible_to: 'visible_to', + price_list: 'price_list', + billing_frequency: 'billing_frequency', + projects_board: 'projects_board', + projects_phase: 'projects_phase' + } as const; + + export type GetActivityFields200ResponseDataInnerFieldTypeConst = typeof GetActivityFields200ResponseDataInnerFieldTypeConst[keyof typeof GetActivityFields200ResponseDataInnerFieldTypeConst]; + + diff --git a/src/versions/v2/models/get-activity-fields200-response.ts b/src/versions/v2/models/get-activity-fields200-response.ts new file mode 100644 index 00000000..2d446a4c --- /dev/null +++ b/src/versions/v2/models/get-activity-fields200-response.ts @@ -0,0 +1,45 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { GetActivityFields200ResponseAdditionalData } from './get-activity-fields200-response-additional-data'; +// May contain unused imports in some cases +// @ts-ignore +import { GetActivityFields200ResponseDataInner } from './get-activity-fields200-response-data-inner'; + +/** +* +* @export +* @interface GetActivityFields200Response +*/ +export interface GetActivityFields200Response { + /** + * Whether the request was successful + * @type {boolean} + */ + 'success'?: boolean; + /** + * + * @type {Array} + */ + 'data'?: Array; + /** + * + * @type {GetActivityFields200ResponseAdditionalData} + */ + 'additional_data'?: GetActivityFields200ResponseAdditionalData; +} + diff --git a/src/versions/v2/models/get-deal-fields200-response-data-inner-important-fields.ts b/src/versions/v2/models/get-deal-fields200-response-data-inner-important-fields.ts new file mode 100644 index 00000000..5a5364a2 --- /dev/null +++ b/src/versions/v2/models/get-deal-fields200-response-data-inner-important-fields.ts @@ -0,0 +1,34 @@ +/* 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. + */ + + + +/** +* Important fields configuration +* @export +* @interface GetDealFields200ResponseDataInnerImportantFields +*/ +export interface GetDealFields200ResponseDataInnerImportantFields { + /** + * Whether the field is marked as important + * @type {boolean} + */ + 'enabled'?: boolean; + /** + * Array of stage IDs where the field is important + * @type {Array} + */ + 'stage_ids'?: Array; +} + diff --git a/src/versions/v2/models/get-deal-fields200-response-data-inner-required-fields.ts b/src/versions/v2/models/get-deal-fields200-response-data-inner-required-fields.ts new file mode 100644 index 00000000..4599b8ff --- /dev/null +++ b/src/versions/v2/models/get-deal-fields200-response-data-inner-required-fields.ts @@ -0,0 +1,47 @@ +/* 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. + */ + + + +/** +* Required fields configuration +* @export +* @interface GetDealFields200ResponseDataInnerRequiredFields +*/ +export interface GetDealFields200ResponseDataInnerRequiredFields { + /** + * Whether the field is required + * @type {boolean} + */ + 'enabled'?: boolean; + /** + * Array of stage IDs where the field is required + * @type {Array} + */ + 'stage_ids'?: Array; + /** + * Pipeline-specific status requirements, mapping pipeline ID to array of statuses + * @type {{ [key: string]: Array | undefined; }} + */ + 'statuses'?: { [key: string]: Array | undefined; }; +} + + export const GetDealFields200ResponseDataInnerRequiredFieldsStatusesConst = { + won: 'won', + lost: 'lost' + } as const; + + export type GetDealFields200ResponseDataInnerRequiredFieldsStatusesConst = typeof GetDealFields200ResponseDataInnerRequiredFieldsStatusesConst[keyof typeof GetDealFields200ResponseDataInnerRequiredFieldsStatusesConst]; + + diff --git a/src/versions/v2/models/get-deal-fields200-response-data-inner-ui-visibility-show-in-pipelines.ts b/src/versions/v2/models/get-deal-fields200-response-data-inner-ui-visibility-show-in-pipelines.ts new file mode 100644 index 00000000..933502b1 --- /dev/null +++ b/src/versions/v2/models/get-deal-fields200-response-data-inner-ui-visibility-show-in-pipelines.ts @@ -0,0 +1,34 @@ +/* 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. + */ + + + +/** +* Pipeline visibility configuration +* @export +* @interface GetDealFields200ResponseDataInnerUiVisibilityShowInPipelines +*/ +export interface GetDealFields200ResponseDataInnerUiVisibilityShowInPipelines { + /** + * Whether the field is shown in all pipelines + * @type {boolean} + */ + 'show_in_all'?: boolean; + /** + * Specific pipeline IDs where the field is shown (if show_in_all is false) + * @type {Array} + */ + 'pipeline_ids'?: Array; +} + diff --git a/src/versions/v2/models/get-deal-fields200-response-data-inner-ui-visibility.ts b/src/versions/v2/models/get-deal-fields200-response-data-inner-ui-visibility.ts new file mode 100644 index 00000000..ad6b664a --- /dev/null +++ b/src/versions/v2/models/get-deal-fields200-response-data-inner-ui-visibility.ts @@ -0,0 +1,47 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { GetDealFields200ResponseDataInnerUiVisibilityShowInPipelines } from './get-deal-fields200-response-data-inner-ui-visibility-show-in-pipelines'; + +/** +* UI visibility settings (only included when requested via include_fields parameter) +* @export +* @interface GetDealFields200ResponseDataInnerUiVisibility +*/ +export interface GetDealFields200ResponseDataInnerUiVisibility { + /** + * Whether the field is shown in the add modal + * @type {boolean} + */ + 'add_visible_flag'?: boolean; + /** + * Whether the field is shown in the details view + * @type {boolean} + */ + 'details_visible_flag'?: boolean; + /** + * Whether the field is shown in project details view + * @type {boolean} + */ + 'projects_detail_visible_flag'?: boolean; + /** + * + * @type {GetDealFields200ResponseDataInnerUiVisibilityShowInPipelines} + */ + 'show_in_pipelines'?: GetDealFields200ResponseDataInnerUiVisibilityShowInPipelines; +} + diff --git a/src/versions/v2/models/get-deal-fields200-response-data-inner.ts b/src/versions/v2/models/get-deal-fields200-response-data-inner.ts new file mode 100644 index 00000000..f9094b9d --- /dev/null +++ b/src/versions/v2/models/get-deal-fields200-response-data-inner.ts @@ -0,0 +1,133 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { GetActivityFields200ResponseDataInnerOptionsInner } from './get-activity-fields200-response-data-inner-options-inner'; +// May contain unused imports in some cases +// @ts-ignore +import { GetActivityFields200ResponseDataInnerSubfieldsInner } from './get-activity-fields200-response-data-inner-subfields-inner'; +// May contain unused imports in some cases +// @ts-ignore +import { GetDealFields200ResponseDataInnerImportantFields } from './get-deal-fields200-response-data-inner-important-fields'; +// May contain unused imports in some cases +// @ts-ignore +import { GetDealFields200ResponseDataInnerRequiredFields } from './get-deal-fields200-response-data-inner-required-fields'; +// May contain unused imports in some cases +// @ts-ignore +import { GetDealFields200ResponseDataInnerUiVisibility } from './get-deal-fields200-response-data-inner-ui-visibility'; + +/** +* +* @export +* @interface GetDealFields200ResponseDataInner +*/ +export interface GetDealFields200ResponseDataInner { + /** + * The display name/label of the field + * @type {string} + */ + 'field_name': string; + /** + * The unique identifier for the field (40-character hash for custom fields) + * @type {string} + */ + 'field_code': string; + /** + * The description of the field + * @type {string} + */ + 'description': string; + /** + * The type of the field + * @type {string} + */ + 'field_type': GetDealFields200ResponseDataInnerFieldTypeConst; + /** + * Whether this is a user-created custom field + * @type {boolean} + */ + 'is_custom_field': boolean; + /** + * Whether this field is not returned by default in entity responses + * @type {boolean} + */ + 'is_optional_response_field': boolean; + /** + * Array of available options for enum/set fields, null for other field types + * @type {Array} + */ + 'options'?: Array | null; + /** + * Array of subfields for complex field types (address, monetary), null for simple field types + * @type {Array} + */ + 'subfields'?: Array | null; + /** + * + * @type {GetDealFields200ResponseDataInnerUiVisibility} + */ + 'ui_visibility'?: GetDealFields200ResponseDataInnerUiVisibility; + /** + * + * @type {GetDealFields200ResponseDataInnerImportantFields} + */ + 'important_fields'?: GetDealFields200ResponseDataInnerImportantFields; + /** + * + * @type {GetDealFields200ResponseDataInnerRequiredFields} + */ + 'required_fields'?: GetDealFields200ResponseDataInnerRequiredFields; +} + + export const GetDealFields200ResponseDataInnerFieldTypeConst = { + int: 'int', + double: 'double', + boolean: 'boolean', + varchar: 'varchar', + text: 'text', + phone: 'phone', + varchar_options: 'varchar_options', + varchar_auto: 'varchar_auto', + date: 'date', + daterange: 'daterange', + time: 'time', + timerange: 'timerange', + enum: 'enum', + set: 'set', + address: 'address', + monetary: 'monetary', + deal: 'deal', + deals: 'deals', + lead: 'lead', + org: 'org', + people: 'people', + project: 'project', + stage: 'stage', + user: 'user', + activity: 'activity', + json: 'json', + picture: 'picture', + status: 'status', + visible_to: 'visible_to', + price_list: 'price_list', + billing_frequency: 'billing_frequency', + projects_board: 'projects_board', + projects_phase: 'projects_phase' + } as const; + + export type GetDealFields200ResponseDataInnerFieldTypeConst = typeof GetDealFields200ResponseDataInnerFieldTypeConst[keyof typeof GetDealFields200ResponseDataInnerFieldTypeConst]; + + diff --git a/src/versions/v2/models/get-deal-fields200-response.ts b/src/versions/v2/models/get-deal-fields200-response.ts new file mode 100644 index 00000000..e7bd14a1 --- /dev/null +++ b/src/versions/v2/models/get-deal-fields200-response.ts @@ -0,0 +1,45 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { GetActivityFields200ResponseAdditionalData } from './get-activity-fields200-response-additional-data'; +// May contain unused imports in some cases +// @ts-ignore +import { GetDealFields200ResponseDataInner } from './get-deal-fields200-response-data-inner'; + +/** +* +* @export +* @interface GetDealFields200Response +*/ +export interface GetDealFields200Response { + /** + * Whether the request was successful + * @type {boolean} + */ + 'success'?: boolean; + /** + * + * @type {Array} + */ + 'data'?: Array; + /** + * + * @type {GetActivityFields200ResponseAdditionalData} + */ + 'additional_data'?: GetActivityFields200ResponseAdditionalData; +} + diff --git a/src/versions/v2/models/get-organization-fields200-response-data-inner-ui-visibility-show-in-add-person-dialog.ts b/src/versions/v2/models/get-organization-fields200-response-data-inner-ui-visibility-show-in-add-person-dialog.ts new file mode 100644 index 00000000..9cf36d1b --- /dev/null +++ b/src/versions/v2/models/get-organization-fields200-response-data-inner-ui-visibility-show-in-add-person-dialog.ts @@ -0,0 +1,34 @@ +/* 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. + */ + + + +/** +* Configuration for showing the field in the add person dialog +* @export +* @interface GetOrganizationFields200ResponseDataInnerUiVisibilityShowInAddPersonDialog +*/ +export interface GetOrganizationFields200ResponseDataInnerUiVisibilityShowInAddPersonDialog { + /** + * Whether the field is shown in the add person dialog + * @type {boolean} + */ + 'show'?: boolean; + /** + * Display order in the add person dialog (null if not shown) + * @type {number} + */ + 'order'?: number | null; +} + diff --git a/src/versions/v2/models/get-organization-fields200-response-data-inner-ui-visibility.ts b/src/versions/v2/models/get-organization-fields200-response-data-inner-ui-visibility.ts new file mode 100644 index 00000000..9255cf41 --- /dev/null +++ b/src/versions/v2/models/get-organization-fields200-response-data-inner-ui-visibility.ts @@ -0,0 +1,50 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { GetOrganizationFields200ResponseDataInnerUiVisibilityShowInAddPersonDialog } from './get-organization-fields200-response-data-inner-ui-visibility-show-in-add-person-dialog'; +// May contain unused imports in some cases +// @ts-ignore +import { GetPersonFields200ResponseDataInnerUiVisibilityShowInAddDealDialog } from './get-person-fields200-response-data-inner-ui-visibility-show-in-add-deal-dialog'; + +/** +* UI visibility settings (only included when requested via include_fields parameter) +* @export +* @interface GetOrganizationFields200ResponseDataInnerUiVisibility +*/ +export interface GetOrganizationFields200ResponseDataInnerUiVisibility { + /** + * Whether the field is shown in the add modal + * @type {boolean} + */ + 'add_visible_flag'?: boolean; + /** + * Whether the field is shown in the details view + * @type {boolean} + */ + 'details_visible_flag'?: boolean; + /** + * + * @type {GetPersonFields200ResponseDataInnerUiVisibilityShowInAddDealDialog} + */ + 'show_in_add_deal_dialog'?: GetPersonFields200ResponseDataInnerUiVisibilityShowInAddDealDialog; + /** + * + * @type {GetOrganizationFields200ResponseDataInnerUiVisibilityShowInAddPersonDialog} + */ + 'show_in_add_person_dialog'?: GetOrganizationFields200ResponseDataInnerUiVisibilityShowInAddPersonDialog; +} + diff --git a/src/versions/v2/models/get-organization-fields200-response-data-inner.ts b/src/versions/v2/models/get-organization-fields200-response-data-inner.ts new file mode 100644 index 00000000..0313c114 --- /dev/null +++ b/src/versions/v2/models/get-organization-fields200-response-data-inner.ts @@ -0,0 +1,128 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { GetActivityFields200ResponseDataInnerOptionsInner } from './get-activity-fields200-response-data-inner-options-inner'; +// May contain unused imports in some cases +// @ts-ignore +import { GetActivityFields200ResponseDataInnerSubfieldsInner } from './get-activity-fields200-response-data-inner-subfields-inner'; +// May contain unused imports in some cases +// @ts-ignore +import { GetOrganizationFields200ResponseDataInnerUiVisibility } from './get-organization-fields200-response-data-inner-ui-visibility'; +// May contain unused imports in some cases +// @ts-ignore +import { GetPersonFields200ResponseDataInnerImportantFields } from './get-person-fields200-response-data-inner-important-fields'; +// May contain unused imports in some cases +// @ts-ignore +import { GetPersonFields200ResponseDataInnerRequiredFields } from './get-person-fields200-response-data-inner-required-fields'; + +/** +* +* @export +* @interface GetOrganizationFields200ResponseDataInner +*/ +export interface GetOrganizationFields200ResponseDataInner { + /** + * The display name/label of the field + * @type {string} + */ + 'field_name': string; + /** + * The unique identifier for the field (40-character hash for custom fields) + * @type {string} + */ + 'field_code': string; + /** + * The type of the field + * @type {string} + */ + 'field_type': GetOrganizationFields200ResponseDataInnerFieldTypeConst; + /** + * Whether this is a user-created custom field + * @type {boolean} + */ + 'is_custom_field': boolean; + /** + * Whether this field is not returned by default in entity responses + * @type {boolean} + */ + 'is_optional_response_field': boolean; + /** + * Array of available options for enum/set fields, null for other field types + * @type {Array} + */ + 'options'?: Array | null; + /** + * Array of subfields for complex field types (address, monetary), null for simple field types + * @type {Array} + */ + 'subfields'?: Array | null; + /** + * + * @type {GetOrganizationFields200ResponseDataInnerUiVisibility} + */ + 'ui_visibility'?: GetOrganizationFields200ResponseDataInnerUiVisibility; + /** + * + * @type {GetPersonFields200ResponseDataInnerImportantFields} + */ + 'important_fields'?: GetPersonFields200ResponseDataInnerImportantFields; + /** + * + * @type {GetPersonFields200ResponseDataInnerRequiredFields} + */ + 'required_fields'?: GetPersonFields200ResponseDataInnerRequiredFields; +} + + export const GetOrganizationFields200ResponseDataInnerFieldTypeConst = { + int: 'int', + double: 'double', + boolean: 'boolean', + varchar: 'varchar', + text: 'text', + phone: 'phone', + varchar_options: 'varchar_options', + varchar_auto: 'varchar_auto', + date: 'date', + daterange: 'daterange', + time: 'time', + timerange: 'timerange', + enum: 'enum', + set: 'set', + address: 'address', + monetary: 'monetary', + deal: 'deal', + deals: 'deals', + lead: 'lead', + org: 'org', + people: 'people', + project: 'project', + stage: 'stage', + user: 'user', + activity: 'activity', + json: 'json', + picture: 'picture', + status: 'status', + visible_to: 'visible_to', + price_list: 'price_list', + billing_frequency: 'billing_frequency', + projects_board: 'projects_board', + projects_phase: 'projects_phase' + } as const; + + export type GetOrganizationFields200ResponseDataInnerFieldTypeConst = typeof GetOrganizationFields200ResponseDataInnerFieldTypeConst[keyof typeof GetOrganizationFields200ResponseDataInnerFieldTypeConst]; + + diff --git a/src/versions/v2/models/get-organization-fields200-response.ts b/src/versions/v2/models/get-organization-fields200-response.ts new file mode 100644 index 00000000..fb7b5676 --- /dev/null +++ b/src/versions/v2/models/get-organization-fields200-response.ts @@ -0,0 +1,45 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { GetActivityFields200ResponseAdditionalData } from './get-activity-fields200-response-additional-data'; +// May contain unused imports in some cases +// @ts-ignore +import { GetOrganizationFields200ResponseDataInner } from './get-organization-fields200-response-data-inner'; + +/** +* +* @export +* @interface GetOrganizationFields200Response +*/ +export interface GetOrganizationFields200Response { + /** + * Whether the request was successful + * @type {boolean} + */ + 'success'?: boolean; + /** + * + * @type {Array} + */ + 'data'?: Array; + /** + * + * @type {GetActivityFields200ResponseAdditionalData} + */ + 'additional_data'?: GetActivityFields200ResponseAdditionalData; +} + diff --git a/src/versions/v2/models/get-person-fields200-response-data-inner-important-fields.ts b/src/versions/v2/models/get-person-fields200-response-data-inner-important-fields.ts new file mode 100644 index 00000000..86f03a04 --- /dev/null +++ b/src/versions/v2/models/get-person-fields200-response-data-inner-important-fields.ts @@ -0,0 +1,34 @@ +/* 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. + */ + + + +/** +* Important fields configuration +* @export +* @interface GetPersonFields200ResponseDataInnerImportantFields +*/ +export interface GetPersonFields200ResponseDataInnerImportantFields { + /** + * Whether the field is marked as important + * @type {boolean} + */ + 'enabled'?: boolean; + /** + * Array of deal stage IDs where the field is important + * @type {Array} + */ + 'stage_ids'?: Array; +} + diff --git a/src/versions/v2/models/get-person-fields200-response-data-inner-required-fields.ts b/src/versions/v2/models/get-person-fields200-response-data-inner-required-fields.ts new file mode 100644 index 00000000..9c69ee9a --- /dev/null +++ b/src/versions/v2/models/get-person-fields200-response-data-inner-required-fields.ts @@ -0,0 +1,29 @@ +/* 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. + */ + + + +/** +* Required fields configuration +* @export +* @interface GetPersonFields200ResponseDataInnerRequiredFields +*/ +export interface GetPersonFields200ResponseDataInnerRequiredFields { + /** + * Whether the field is required + * @type {boolean} + */ + 'enabled'?: boolean; +} + diff --git a/src/versions/v2/models/get-person-fields200-response-data-inner-ui-visibility-show-in-add-deal-dialog.ts b/src/versions/v2/models/get-person-fields200-response-data-inner-ui-visibility-show-in-add-deal-dialog.ts new file mode 100644 index 00000000..9f9ceec2 --- /dev/null +++ b/src/versions/v2/models/get-person-fields200-response-data-inner-ui-visibility-show-in-add-deal-dialog.ts @@ -0,0 +1,34 @@ +/* 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. + */ + + + +/** +* Configuration for showing the field in the add deal dialog +* @export +* @interface GetPersonFields200ResponseDataInnerUiVisibilityShowInAddDealDialog +*/ +export interface GetPersonFields200ResponseDataInnerUiVisibilityShowInAddDealDialog { + /** + * Whether the field is shown in the add deal dialog + * @type {boolean} + */ + 'show'?: boolean; + /** + * Display order in the add deal dialog (null if not shown) + * @type {number} + */ + 'order'?: number | null; +} + diff --git a/src/versions/v2/models/get-person-fields200-response-data-inner-ui-visibility.ts b/src/versions/v2/models/get-person-fields200-response-data-inner-ui-visibility.ts new file mode 100644 index 00000000..fc21dbaa --- /dev/null +++ b/src/versions/v2/models/get-person-fields200-response-data-inner-ui-visibility.ts @@ -0,0 +1,42 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { GetPersonFields200ResponseDataInnerUiVisibilityShowInAddDealDialog } from './get-person-fields200-response-data-inner-ui-visibility-show-in-add-deal-dialog'; + +/** +* UI visibility settings (only included when requested via include_fields parameter) +* @export +* @interface GetPersonFields200ResponseDataInnerUiVisibility +*/ +export interface GetPersonFields200ResponseDataInnerUiVisibility { + /** + * Whether the field is shown in the add modal + * @type {boolean} + */ + 'add_visible_flag'?: boolean; + /** + * Whether the field is shown in the details view + * @type {boolean} + */ + 'details_visible_flag'?: boolean; + /** + * + * @type {GetPersonFields200ResponseDataInnerUiVisibilityShowInAddDealDialog} + */ + 'show_in_add_deal_dialog'?: GetPersonFields200ResponseDataInnerUiVisibilityShowInAddDealDialog; +} + diff --git a/src/versions/v2/models/get-person-fields200-response-data-inner.ts b/src/versions/v2/models/get-person-fields200-response-data-inner.ts new file mode 100644 index 00000000..338d200d --- /dev/null +++ b/src/versions/v2/models/get-person-fields200-response-data-inner.ts @@ -0,0 +1,128 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { GetActivityFields200ResponseDataInnerOptionsInner } from './get-activity-fields200-response-data-inner-options-inner'; +// May contain unused imports in some cases +// @ts-ignore +import { GetActivityFields200ResponseDataInnerSubfieldsInner } from './get-activity-fields200-response-data-inner-subfields-inner'; +// May contain unused imports in some cases +// @ts-ignore +import { GetPersonFields200ResponseDataInnerImportantFields } from './get-person-fields200-response-data-inner-important-fields'; +// May contain unused imports in some cases +// @ts-ignore +import { GetPersonFields200ResponseDataInnerRequiredFields } from './get-person-fields200-response-data-inner-required-fields'; +// May contain unused imports in some cases +// @ts-ignore +import { GetPersonFields200ResponseDataInnerUiVisibility } from './get-person-fields200-response-data-inner-ui-visibility'; + +/** +* +* @export +* @interface GetPersonFields200ResponseDataInner +*/ +export interface GetPersonFields200ResponseDataInner { + /** + * The display name/label of the field + * @type {string} + */ + 'field_name': string; + /** + * The unique identifier for the field (40-character hash for custom fields) + * @type {string} + */ + 'field_code': string; + /** + * The type of the field + * @type {string} + */ + 'field_type': GetPersonFields200ResponseDataInnerFieldTypeConst; + /** + * Whether this is a user-created custom field + * @type {boolean} + */ + 'is_custom_field': boolean; + /** + * Whether this field is not returned by default in entity responses + * @type {boolean} + */ + 'is_optional_response_field': boolean; + /** + * Array of available options for enum/set fields, null for other field types + * @type {Array} + */ + 'options'?: Array | null; + /** + * Array of subfields for complex field types (address, monetary), null for simple field types + * @type {Array} + */ + 'subfields'?: Array | null; + /** + * + * @type {GetPersonFields200ResponseDataInnerUiVisibility} + */ + 'ui_visibility'?: GetPersonFields200ResponseDataInnerUiVisibility; + /** + * + * @type {GetPersonFields200ResponseDataInnerImportantFields} + */ + 'important_fields'?: GetPersonFields200ResponseDataInnerImportantFields; + /** + * + * @type {GetPersonFields200ResponseDataInnerRequiredFields} + */ + 'required_fields'?: GetPersonFields200ResponseDataInnerRequiredFields; +} + + export const GetPersonFields200ResponseDataInnerFieldTypeConst = { + int: 'int', + double: 'double', + boolean: 'boolean', + varchar: 'varchar', + text: 'text', + phone: 'phone', + varchar_options: 'varchar_options', + varchar_auto: 'varchar_auto', + date: 'date', + daterange: 'daterange', + time: 'time', + timerange: 'timerange', + enum: 'enum', + set: 'set', + address: 'address', + monetary: 'monetary', + deal: 'deal', + deals: 'deals', + lead: 'lead', + org: 'org', + people: 'people', + project: 'project', + stage: 'stage', + user: 'user', + activity: 'activity', + json: 'json', + picture: 'picture', + status: 'status', + visible_to: 'visible_to', + price_list: 'price_list', + billing_frequency: 'billing_frequency', + projects_board: 'projects_board', + projects_phase: 'projects_phase' + } as const; + + export type GetPersonFields200ResponseDataInnerFieldTypeConst = typeof GetPersonFields200ResponseDataInnerFieldTypeConst[keyof typeof GetPersonFields200ResponseDataInnerFieldTypeConst]; + + diff --git a/src/versions/v2/models/get-person-fields200-response.ts b/src/versions/v2/models/get-person-fields200-response.ts new file mode 100644 index 00000000..7cd22f47 --- /dev/null +++ b/src/versions/v2/models/get-person-fields200-response.ts @@ -0,0 +1,45 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { GetActivityFields200ResponseAdditionalData } from './get-activity-fields200-response-additional-data'; +// May contain unused imports in some cases +// @ts-ignore +import { GetPersonFields200ResponseDataInner } from './get-person-fields200-response-data-inner'; + +/** +* +* @export +* @interface GetPersonFields200Response +*/ +export interface GetPersonFields200Response { + /** + * Whether the request was successful + * @type {boolean} + */ + 'success'?: boolean; + /** + * + * @type {Array} + */ + 'data'?: Array; + /** + * + * @type {GetActivityFields200ResponseAdditionalData} + */ + 'additional_data'?: GetActivityFields200ResponseAdditionalData; +} + diff --git a/src/versions/v2/models/index.ts b/src/versions/v2/models/index.ts index 6f36ceca..960a1f62 100644 --- a/src/versions/v2/models/index.ts +++ b/src/versions/v2/models/index.ts @@ -10,6 +10,16 @@ export * from './add-additional-discount-response'; export * from './add-convert-deal-to-lead-response'; export * from './add-convert-deal-to-lead-response-data'; export * from './add-convert-lead-to-deal-response'; +export * from './add-deal-field200-response'; +export * from './add-deal-field-options200-response'; +export * from './add-deal-field-options200-response-data-inner'; +export * from './add-deal-field-options-request-inner'; +export * from './add-deal-field-request'; +export * from './add-deal-field-request-important-fields'; +export * from './add-deal-field-request-options-inner'; +export * from './add-deal-field-request-required-fields'; +export * from './add-deal-field-request-ui-visibility'; +export * from './add-deal-field-request-ui-visibility-show-in-pipelines'; export * from './add-deal-follower-request'; export * from './add-deal-product-request'; export * from './add-deal-product-response'; @@ -18,11 +28,26 @@ export * from './add-follower-response'; export * from './add-follower-response-all-of'; export * from './add-installment-request-body'; export * from './add-many-deal-product-response'; +export * from './add-organization-field200-response'; +export * from './add-organization-field-request'; +export * from './add-organization-field-request-important-fields'; +export * from './add-organization-field-request-required-fields'; +export * from './add-organization-field-request-ui-visibility'; +export * from './add-organization-field-request-ui-visibility-show-in-add-deal-dialog'; +export * from './add-organization-field-request-ui-visibility-show-in-add-person-dialog'; export * from './add-organization-request'; +export * from './add-person-field200-response'; +export * from './add-person-field-request'; +export * from './add-person-field-request-important-fields'; +export * from './add-person-field-request-required-fields'; +export * from './add-person-field-request-ui-visibility'; +export * from './add-person-field-request-ui-visibility-show-in-add-deal-dialog'; export * from './add-person-request'; export * from './add-person-request-emails-inner'; export * from './add-person-request-phones-inner'; export * from './add-pipeline-request'; +export * from './add-product-field-request'; +export * from './add-product-field-request-ui-visibility'; export * from './add-product-image-response'; export * from './add-product-request'; export * from './add-product-request-all-of'; @@ -42,6 +67,9 @@ export * from './delete-activity-response'; export * from './delete-activity-response-data'; export * from './delete-additional-discount-response'; export * from './delete-additional-discount-response-data'; +export * from './delete-deal-field200-response'; +export * from './delete-deal-field200-response-data'; +export * from './delete-deal-field-options-request-inner'; export * from './delete-deal-product-response'; export * from './delete-deal-product-response-data'; export * from './delete-deal-response'; @@ -55,6 +83,8 @@ export * from './delete-many-deal-product-response-additional-data'; export * from './delete-many-deal-product-response-data'; export * from './delete-organization-response'; export * from './delete-organization-response-data'; +export * from './delete-person-field200-response'; +export * from './delete-person-field200-response-data'; export * from './delete-person-response'; export * from './delete-person-response-data'; export * from './delete-pipeline-response'; @@ -73,11 +103,24 @@ export * from './follower-item1'; export * from './get-activities-response'; export * from './get-activities-response-all-of'; export * from './get-activities-response-all-of-additional-data'; +export * from './get-activity-field200-response'; +export * from './get-activity-fields200-response'; +export * from './get-activity-fields200-response-additional-data'; +export * from './get-activity-fields200-response-data-inner'; +export * from './get-activity-fields200-response-data-inner-options-inner'; +export * from './get-activity-fields200-response-data-inner-subfields-inner'; +export * from './get-activity-fields200-response-data-inner-ui-visibility'; export * from './get-additional-discounts-response'; export * from './get-additional-discounts-response-data-inner'; export * from './get-convert-response'; export * from './get-convert-response1'; export * from './get-convert-response1-data'; +export * from './get-deal-fields200-response'; +export * from './get-deal-fields200-response-data-inner'; +export * from './get-deal-fields200-response-data-inner-important-fields'; +export * from './get-deal-fields200-response-data-inner-required-fields'; +export * from './get-deal-fields200-response-data-inner-ui-visibility'; +export * from './get-deal-fields200-response-data-inner-ui-visibility-show-in-pipelines'; export * from './get-deal-search-response'; export * from './get-deal-search-response-all-of'; export * from './get-deal-search-response-all-of-data'; @@ -110,6 +153,10 @@ export * from './get-item-search-response-data-data'; export * from './get-lead-search-response'; export * from './get-lead-search-response-data'; export * from './get-lead-search-response-data-data'; +export * from './get-organization-fields200-response'; +export * from './get-organization-fields200-response-data-inner'; +export * from './get-organization-fields200-response-data-inner-ui-visibility'; +export * from './get-organization-fields200-response-data-inner-ui-visibility-show-in-add-person-dialog'; export * from './get-organization-search-response'; export * from './get-organization-search-response-all-of'; export * from './get-organization-search-response-all-of-data'; @@ -117,6 +164,12 @@ export * from './get-organization-search-response-all-of-data-items-inner'; export * from './get-organization-search-response-all-of-data-items-inner-item'; export * from './get-organizations-response'; export * from './get-organizations-response-all-of'; +export * from './get-person-fields200-response'; +export * from './get-person-fields200-response-data-inner'; +export * from './get-person-fields200-response-data-inner-important-fields'; +export * from './get-person-fields200-response-data-inner-required-fields'; +export * from './get-person-fields200-response-data-inner-ui-visibility'; +export * from './get-person-fields200-response-data-inner-ui-visibility-show-in-add-deal-dialog'; export * from './get-person-search-response'; export * from './get-person-search-response-all-of'; export * from './get-person-search-response-all-of-data'; @@ -164,14 +217,19 @@ export * from './stage-item'; export * from './stage-item1'; export * from './update-additional-discount-request-body'; export * from './update-additional-discount-response'; +export * from './update-deal-field-options-request-inner'; +export * from './update-deal-field-request'; export * from './update-deal-product-request'; export * from './update-deal-product-request-all-of'; export * from './update-deal-request'; export * from './update-installment-request-body'; export * from './update-installment-response'; +export * from './update-organization-field-request'; export * from './update-organization-request'; +export * from './update-person-field-request'; export * from './update-person-request'; export * from './update-pipeline-request'; +export * from './update-product-field-request'; export * from './update-product-image-response'; export * from './update-product-image-response-data'; export * from './update-product-request'; diff --git a/src/versions/v2/models/update-deal-field-options-request-inner.ts b/src/versions/v2/models/update-deal-field-options-request-inner.ts new file mode 100644 index 00000000..5cab8426 --- /dev/null +++ b/src/versions/v2/models/update-deal-field-options-request-inner.ts @@ -0,0 +1,34 @@ +/* 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. + */ + + + +/** +* +* @export +* @interface UpdateDealFieldOptionsRequestInner +*/ +export interface UpdateDealFieldOptionsRequestInner { + /** + * The unique identifier of the option to update + * @type {number} + */ + 'id': number; + /** + * The new display label for the option + * @type {string} + */ + 'label': string; +} + diff --git a/src/versions/v2/models/update-deal-field-request.ts b/src/versions/v2/models/update-deal-field-request.ts new file mode 100644 index 00000000..2459f825 --- /dev/null +++ b/src/versions/v2/models/update-deal-field-request.ts @@ -0,0 +1,58 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { AddDealFieldRequestImportantFields } from './add-deal-field-request-important-fields'; +// May contain unused imports in some cases +// @ts-ignore +import { AddDealFieldRequestRequiredFields } from './add-deal-field-request-required-fields'; +// May contain unused imports in some cases +// @ts-ignore +import { AddDealFieldRequestUiVisibility } from './add-deal-field-request-ui-visibility'; + +/** +* +* @export +* @interface UpdateDealFieldRequest +*/ +export interface UpdateDealFieldRequest { + /** + * Field name + * @type {string} + */ + 'field_name'?: string; + /** + * + * @type {AddDealFieldRequestUiVisibility} + */ + 'ui_visibility'?: AddDealFieldRequestUiVisibility; + /** + * + * @type {AddDealFieldRequestImportantFields} + */ + 'important_fields'?: AddDealFieldRequestImportantFields; + /** + * + * @type {AddDealFieldRequestRequiredFields} + */ + 'required_fields'?: AddDealFieldRequestRequiredFields; + /** + * Field description + * @type {string} + */ + 'description'?: string | null; +} + diff --git a/src/versions/v2/models/update-organization-field-request.ts b/src/versions/v2/models/update-organization-field-request.ts new file mode 100644 index 00000000..d684ff93 --- /dev/null +++ b/src/versions/v2/models/update-organization-field-request.ts @@ -0,0 +1,58 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { AddOrganizationFieldRequestImportantFields } from './add-organization-field-request-important-fields'; +// May contain unused imports in some cases +// @ts-ignore +import { AddOrganizationFieldRequestRequiredFields } from './add-organization-field-request-required-fields'; +// May contain unused imports in some cases +// @ts-ignore +import { AddOrganizationFieldRequestUiVisibility } from './add-organization-field-request-ui-visibility'; + +/** +* +* @export +* @interface UpdateOrganizationFieldRequest +*/ +export interface UpdateOrganizationFieldRequest { + /** + * Field name + * @type {string} + */ + 'field_name'?: string; + /** + * + * @type {AddOrganizationFieldRequestUiVisibility} + */ + 'ui_visibility'?: AddOrganizationFieldRequestUiVisibility; + /** + * + * @type {AddOrganizationFieldRequestImportantFields} + */ + 'important_fields'?: AddOrganizationFieldRequestImportantFields; + /** + * + * @type {AddOrganizationFieldRequestRequiredFields} + */ + 'required_fields'?: AddOrganizationFieldRequestRequiredFields; + /** + * Field description + * @type {string} + */ + 'description'?: string | null; +} + diff --git a/src/versions/v2/models/update-person-field-request.ts b/src/versions/v2/models/update-person-field-request.ts new file mode 100644 index 00000000..d68d3eaf --- /dev/null +++ b/src/versions/v2/models/update-person-field-request.ts @@ -0,0 +1,58 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { AddPersonFieldRequestImportantFields } from './add-person-field-request-important-fields'; +// May contain unused imports in some cases +// @ts-ignore +import { AddPersonFieldRequestRequiredFields } from './add-person-field-request-required-fields'; +// May contain unused imports in some cases +// @ts-ignore +import { AddPersonFieldRequestUiVisibility } from './add-person-field-request-ui-visibility'; + +/** +* +* @export +* @interface UpdatePersonFieldRequest +*/ +export interface UpdatePersonFieldRequest { + /** + * Field name + * @type {string} + */ + 'field_name'?: string; + /** + * + * @type {AddPersonFieldRequestUiVisibility} + */ + 'ui_visibility'?: AddPersonFieldRequestUiVisibility; + /** + * + * @type {AddPersonFieldRequestImportantFields} + */ + 'important_fields'?: AddPersonFieldRequestImportantFields; + /** + * + * @type {AddPersonFieldRequestRequiredFields} + */ + 'required_fields'?: AddPersonFieldRequestRequiredFields; + /** + * Field description + * @type {string} + */ + 'description'?: string | null; +} + diff --git a/src/versions/v2/models/update-product-field-request.ts b/src/versions/v2/models/update-product-field-request.ts new file mode 100644 index 00000000..e975cec2 --- /dev/null +++ b/src/versions/v2/models/update-product-field-request.ts @@ -0,0 +1,42 @@ +/* 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. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import { AddProductFieldRequestUiVisibility } from './add-product-field-request-ui-visibility'; + +/** +* +* @export +* @interface UpdateProductFieldRequest +*/ +export interface UpdateProductFieldRequest { + /** + * Field name + * @type {string} + */ + 'field_name'?: string; + /** + * + * @type {AddProductFieldRequestUiVisibility} + */ + 'ui_visibility'?: AddProductFieldRequestUiVisibility; + /** + * Field description + * @type {string} + */ + 'description'?: string | null; +} +