Skip to content

Commit 6b36039

Browse files
author
pipedrive-bot
committed
Build 295 - version-minor
1 parent 01a5eae commit 6b36039

File tree

71 files changed

+6980
-5
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+6980
-5
lines changed

CHANGELOG.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,38 @@ The file format of it is based on [Keep a Changelog](http://keepachangelog.com/e
77
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).
88

99
## [Unreleased]
10+
### Added
11+
- Documented the following new v2 endpoints:
12+
- `GET /api/v2/activityFields`
13+
- `GET /api/v2/dealFields`
14+
- `GET /api/v2/organizationFields`
15+
- `GET /api/v2/personFields`
16+
- `GET /api/v2/productFields`
17+
- `GET /api/v2/activityFields/{field_code}`
18+
- `GET /api/v2/dealFields/{field_code}`
19+
- `GET /api/v2/organizationFields/{field_code}`
20+
- `GET /api/v2/personFields/{field_code}`
21+
- `GET /api/v2/productFields/{field_code}`
22+
- `POST /api/v2/dealFields`
23+
- `POST /api/v2/organizationFields`
24+
- `POST /api/v2/personFields`
25+
- `POST /api/v2/productFields`
26+
- `DELETE /api/v2/dealFields/{field_code}`
27+
- `DELETE /api/v2/organizationFields/{field_code}`
28+
- `DELETE /api/v2/personFields/{field_code}`
29+
- `DELETE /api/v2/productFields/{field_code}`
30+
- `POST /api/v2/dealFields/{field_code}/options`
31+
- `POST /api/v2/organizationFields/{field_code}/options`
32+
- `POST /api/v2/personFields/{field_code}/options`
33+
- `POST /api/v2/productFields/{field_code}/options`
34+
- `PATCH /api/v2/dealFields/{field_code}/options`
35+
- `PATCH /api/v2/organizationFields/{field_code}/options`
36+
- `PATCH /api/v2/personFields/{field_code}/options`
37+
- `PATCH /api/v2/productFields/{field_code}/options`
38+
- `DELETE /api/v2/dealFields/{field_code}/options`
39+
- `DELETE /api/v2/organizationFields/{field_code}/options`
40+
- `DELETE /api/v2/personFields/{field_code}/options`
41+
- `DELETE /api/v2/productFields/{field_code}/options`
1042

1143
## [30.4.0] - 2025-11-18
1244
### Added

docs/v1.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ GoalsApi | getGoals | **GET** /goals/find | Find goals
8989
GoalsApi | updateGoal | **PUT** /goals/{id} | Update existing goal
9090
ItemSearchApi | searchItem | **GET** /itemSearch | Perform a search from multiple item types
9191
ItemSearchApi | searchItemByField | **GET** /itemSearch/field | Perform a search using a specific field from an item type
92+
LeadFieldsApi | getLeadFields | **GET** /leadFields | Get all lead fields
9293
LeadLabelsApi | addLeadLabel | **POST** /leadLabels | Add a lead label
9394
LeadLabelsApi | deleteLeadLabel | **DELETE** /leadLabels/{id} | Delete a lead label
9495
LeadLabelsApi | getLeadLabels | **GET** /leadLabels | Get all lead labels

docs/v2.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ ActivitiesApi | deleteActivity | **DELETE** /activities/{id} | Delete an activit
99
ActivitiesApi | getActivities | **GET** /activities | Get all activities
1010
ActivitiesApi | getActivity | **GET** /activities/{id} | Get details of an activity
1111
ActivitiesApi | updateActivity | **PATCH** /activities/{id} | Update an activity
12+
ActivityFieldsApi | getActivityField | **GET** /activityFields/{field_code} | Get one activity field
13+
ActivityFieldsApi | getActivityFields | **GET** /activityFields | Get all activity fields
1214
BetaApi | convertDealToLead | **POST** /deals/{id}/convert/lead | Convert a deal to a lead (BETA)
1315
BetaApi | convertLeadToDeal | **POST** /leads/{id}/convert/deal | Convert a lead to a deal (BETA)
1416
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
2123
BetaApi | updateInstallment | **PATCH** /deals/{id}/installments/{installment_id} | Update an installment added to a deal
2224
BetaApi | updateProductImage | **PUT** /products/{id}/images | Update an image for a product
2325
BetaApi | uploadProductImage | **POST** /products/{id}/images | Upload an image for a product
26+
DealFieldsApi | addDealField | **POST** /dealFields | Create one deal field
27+
DealFieldsApi | addDealFieldOptions | **POST** /dealFields/{field_code}/options | Add deal field options in bulk
28+
DealFieldsApi | deleteDealField | **DELETE** /dealFields/{field_code} | Delete one deal field
29+
DealFieldsApi | deleteDealFieldOptions | **DELETE** /dealFields/{field_code}/options | Delete deal field options in bulk
30+
DealFieldsApi | getDealField | **GET** /dealFields/{field_code} | Get one deal field
31+
DealFieldsApi | getDealFields | **GET** /dealFields | Get all deal fields
32+
DealFieldsApi | updateDealField | **PATCH** /dealFields/{field_code} | Update one deal field
33+
DealFieldsApi | updateDealFieldOptions | **PATCH** /dealFields/{field_code}/options | Update deal field options in bulk
2434
DealsApi | addDeal | **POST** /deals | Add a new deal
2535
DealsApi | addDealFollower | **POST** /deals/{id}/followers | Add a follower to a deal
2636
DealsApi | addDealProduct | **POST** /deals/{id}/products | Add a product to a deal
@@ -54,6 +64,14 @@ ItemSearchApi | searchItemByField | **GET** /itemSearch/field | Perform a search
5464
LeadsApi | convertLeadToDeal | **POST** /leads/{id}/convert/deal | Convert a lead to a deal (BETA)
5565
LeadsApi | getLeadConversionStatus | **GET** /leads/{id}/convert/status/{conversion_id} | Get Lead conversion status (BETA)
5666
LeadsApi | searchLeads | **GET** /leads/search | Search leads
67+
OrganizationFieldsApi | addOrganizationField | **POST** /organizationFields | Create one organization field
68+
OrganizationFieldsApi | addOrganizationFieldOptions | **POST** /organizationFields/{field_code}/options | Add organization field options in bulk
69+
OrganizationFieldsApi | deleteOrganizationField | **DELETE** /organizationFields/{field_code} | Delete one organization field
70+
OrganizationFieldsApi | deleteOrganizationFieldOptions | **DELETE** /organizationFields/{field_code}/options | Delete organization field options in bulk
71+
OrganizationFieldsApi | getOrganizationField | **GET** /organizationFields/{field_code} | Get one organization field
72+
OrganizationFieldsApi | getOrganizationFields | **GET** /organizationFields | Get all organization fields
73+
OrganizationFieldsApi | updateOrganizationField | **PATCH** /organizationFields/{field_code} | Update one organization field
74+
OrganizationFieldsApi | updateOrganizationFieldOptions | **PATCH** /organizationFields/{field_code}/options | Update organization field options in bulk
5775
OrganizationsApi | addOrganization | **POST** /organizations | Add a new organization
5876
OrganizationsApi | addOrganizationFollower | **POST** /organizations/{id}/followers | Add a follower to an organization
5977
OrganizationsApi | deleteOrganization | **DELETE** /organizations/{id} | Delete a organization
@@ -64,6 +82,14 @@ OrganizationsApi | getOrganizationFollowersChangelog | **GET** /organizations/{i
6482
OrganizationsApi | getOrganizations | **GET** /organizations | Get all organizations
6583
OrganizationsApi | searchOrganization | **GET** /organizations/search | Search organizations
6684
OrganizationsApi | updateOrganization | **PATCH** /organizations/{id} | Update a organization
85+
PersonFieldsApi | addPersonField | **POST** /personFields | Create one person field
86+
PersonFieldsApi | addPersonFieldOptions | **POST** /personFields/{field_code}/options | Add person field options in bulk
87+
PersonFieldsApi | deletePersonField | **DELETE** /personFields/{field_code} | Delete one person field
88+
PersonFieldsApi | deletePersonFieldOptions | **DELETE** /personFields/{field_code}/options | Delete person field options in bulk
89+
PersonFieldsApi | getPersonField | **GET** /personFields/{field_code} | Get one person field
90+
PersonFieldsApi | getPersonFields | **GET** /personFields | Get all person fields
91+
PersonFieldsApi | updatePersonField | **PATCH** /personFields/{field_code} | Update one person field
92+
PersonFieldsApi | updatePersonFieldOptions | **PATCH** /personFields/{field_code}/options | Update person field options in bulk
6793
PersonsApi | addPerson | **POST** /persons | Add a new person
6894
PersonsApi | addPersonFollower | **POST** /persons/{id}/followers | Add a follower to a person
6995
PersonsApi | deletePerson | **DELETE** /persons/{id} | Delete a person
@@ -79,6 +105,14 @@ PipelinesApi | deletePipeline | **DELETE** /pipelines/{id} | Delete a pipeline
79105
PipelinesApi | getPipeline | **GET** /pipelines/{id} | Get one pipeline
80106
PipelinesApi | getPipelines | **GET** /pipelines | Get all pipelines
81107
PipelinesApi | updatePipeline | **PATCH** /pipelines/{id} | Update a pipeline
108+
ProductFieldsApi | addProductField | **POST** /productFields | Create one product field
109+
ProductFieldsApi | addProductFieldOptions | **POST** /productFields/{field_code}/options | Add product field options in bulk
110+
ProductFieldsApi | deleteProductField | **DELETE** /productFields/{field_code} | Delete one product field
111+
ProductFieldsApi | deleteProductFieldOptions | **DELETE** /productFields/{field_code}/options | Delete product field options in bulk
112+
ProductFieldsApi | getProductField | **GET** /productFields/{field_code} | Get one product field
113+
ProductFieldsApi | getProductFields | **GET** /productFields | Get all product fields
114+
ProductFieldsApi | updateProductField | **PATCH** /productFields/{field_code} | Update one product field
115+
ProductFieldsApi | updateProductFieldOptions | **PATCH** /productFields/{field_code}/options | Update product field options in bulk
82116
ProductsApi | addProduct | **POST** /products | Add a product
83117
ProductsApi | addProductFollower | **POST** /products/{id}/followers | Add a follower to a product
84118
ProductsApi | addProductVariation | **POST** /products/{id}/variations | Add a product variation

src/versions/v1/api.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ export * from './api/files-api';
2727
export * from './api/filters-api';
2828
export * from './api/goals-api';
2929
export * from './api/item-search-api';
30+
export * from './api/lead-fields-api';
3031
export * from './api/lead-labels-api';
3132
export * from './api/lead-sources-api';
3233
export * from './api/leads-api';
Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
/* tslint:disable */
2+
/* eslint-disable */
3+
/**
4+
* Pipedrive API v1
5+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6+
*
7+
* The version of the OpenAPI document: 1.0.0
8+
*
9+
*
10+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11+
* https://openapi-generator.tech
12+
* Do not edit the class manually.
13+
*/
14+
15+
16+
import type { Configuration } from '../configuration';
17+
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
18+
import globalAxios from 'axios';
19+
// Some imports not used depending on template conditions
20+
// @ts-ignore
21+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
22+
// @ts-ignore
23+
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
24+
// @ts-ignore
25+
import { GetFieldsResponse } from '../models';
26+
/**
27+
* LeadFieldsApi - axios parameter creator
28+
* @export
29+
*/
30+
export const LeadFieldsApiAxiosParamCreator = function (configuration?: Configuration) {
31+
return {
32+
/**
33+
* Returns data about all lead fields.
34+
* @summary Get all lead fields
35+
* @param {number} [start] Pagination start
36+
* @param {number} [limit] Items shown per page
37+
38+
* @throws {RequiredError}
39+
*/
40+
getLeadFields: async (start?: number, limit?: number, ): Promise<RequestArgs> => {
41+
const localVarPath = `/leadFields`;
42+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
43+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
44+
let baseOptions;
45+
if (configuration) {
46+
baseOptions = configuration.baseOptions;
47+
}
48+
49+
const localVarRequestOptions = { method: 'GET', ...baseOptions };
50+
const localVarHeaderParameter = {} as any;
51+
const localVarQueryParameter = {} as any;
52+
53+
// authentication api_key required
54+
await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration)
55+
56+
// authentication oauth2 required
57+
// oauth required
58+
await setOAuthToObject(localVarHeaderParameter, "oauth2", ["leads:read", "leads:full", "admin"], configuration)
59+
60+
if (start !== undefined) {
61+
localVarQueryParameter['start'] = start;
62+
}
63+
64+
if (limit !== undefined) {
65+
localVarQueryParameter['limit'] = limit;
66+
}
67+
68+
69+
70+
setSearchParams(localVarUrlObj, localVarQueryParameter);
71+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
72+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, };
73+
74+
return {
75+
url: toPathString(localVarUrlObj),
76+
options: localVarRequestOptions,
77+
};
78+
},
79+
}
80+
};
81+
82+
83+
/**
84+
* LeadFieldsApi - functional programming interface
85+
* @export
86+
*/
87+
export const LeadFieldsApiFp = function(configuration?: Configuration) {
88+
const localVarAxiosParamCreator = LeadFieldsApiAxiosParamCreator(configuration)
89+
return {
90+
/**
91+
* Returns data about all lead fields.
92+
* @summary Get all lead fields
93+
* @param {number} [start] Pagination start
94+
* @param {number} [limit] Items shown per page
95+
96+
* @throws {RequiredError}
97+
*/
98+
async getLeadFields(start?: number, limit?: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFieldsResponse>> {
99+
const localVarAxiosArgs = await localVarAxiosParamCreator.getLeadFields(start, limit, );
100+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
101+
},
102+
}
103+
};
104+
105+
/**
106+
* LeadFieldsApi - factory interface
107+
* @export
108+
*/
109+
export const LeadFieldsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
110+
const localVarFp = LeadFieldsApiFp(configuration)
111+
return {
112+
/**
113+
* Returns data about all lead fields.
114+
* @summary Get all lead fields
115+
* @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.
116+
117+
* @throws {RequiredError}
118+
*/
119+
getLeadFields(requestParameters: LeadFieldsApiGetLeadFieldsRequest = {}, ): Promise<GetFieldsResponse> {
120+
return localVarFp.getLeadFields(requestParameters.start, requestParameters.limit, ).then((request) => request(axios, basePath));
121+
},
122+
};
123+
};
124+
125+
/**
126+
* Request parameters for getLeadFields operation in LeadFieldsApi.
127+
* @export
128+
* @interface LeadFieldsApiGetLeadFieldsRequest
129+
*/
130+
export interface LeadFieldsApiGetLeadFieldsRequest {
131+
/**
132+
* Pagination start
133+
* @type {number}
134+
* @memberof LeadFieldsApiGetLeadFields
135+
*/
136+
readonly start?: number
137+
138+
/**
139+
* Items shown per page
140+
* @type {number}
141+
* @memberof LeadFieldsApiGetLeadFields
142+
*/
143+
readonly limit?: number
144+
}
145+
146+
/**
147+
* LeadFieldsApi - object-oriented interface
148+
* @export
149+
* @class LeadFieldsApi
150+
* @extends {BaseAPI}
151+
*/
152+
export class LeadFieldsApi extends BaseAPI {
153+
/**
154+
* Returns data about all lead fields.
155+
* @summary Get all lead fields
156+
* @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.
157+
158+
* @throws {RequiredError}
159+
* @memberof LeadFieldsApi
160+
*/
161+
public getLeadFields(requestParameters: LeadFieldsApiGetLeadFieldsRequest = {}, ) {
162+
return LeadFieldsApiFp(this.configuration).getLeadFields(requestParameters.start, requestParameters.limit, ).then((request) => request(this.axios, this.basePath));
163+
}
164+
}

src/versions/v2/api.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,18 @@
1515

1616

1717
export * from './api/activities-api';
18+
export * from './api/activity-fields-api';
1819
export * from './api/beta-api';
20+
export * from './api/deal-fields-api';
1921
export * from './api/deals-api';
2022
export * from './api/item-search-api';
2123
export * from './api/leads-api';
24+
export * from './api/organization-fields-api';
2225
export * from './api/organizations-api';
26+
export * from './api/person-fields-api';
2327
export * from './api/persons-api';
2428
export * from './api/pipelines-api';
29+
export * from './api/product-fields-api';
2530
export * from './api/products-api';
2631
export * from './api/stages-api';
2732
export * from './api/users-api';

0 commit comments

Comments
 (0)