pipedrive 30.4.0 → 30.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/versions/v1/api/lead-fields-api.d.ts +95 -0
- package/dist/esm/versions/v1/api/lead-fields-api.js +135 -0
- package/dist/esm/versions/v1/api.d.ts +1 -0
- package/dist/esm/versions/v1/api.js +1 -0
- package/dist/esm/versions/v2/api/persons-api.d.ts +10 -2
- package/dist/esm/versions/v2/api/persons-api.js +10 -5
- package/dist/versions/v1/api/lead-fields-api.d.ts +95 -0
- package/dist/versions/v1/api/lead-fields-api.js +145 -0
- package/dist/versions/v1/api.d.ts +1 -0
- package/dist/versions/v1/api.js +1 -0
- package/dist/versions/v2/api/persons-api.d.ts +10 -2
- package/dist/versions/v2/api/persons-api.js +10 -5
- package/package.json +1 -1
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Pipedrive API v1
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosInstance } from 'axios';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { GetFieldsResponse } from '../models';
|
|
16
|
+
/**
|
|
17
|
+
* LeadFieldsApi - axios parameter creator
|
|
18
|
+
* @export
|
|
19
|
+
*/
|
|
20
|
+
export declare const LeadFieldsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
|
+
/**
|
|
22
|
+
* Returns data about all lead fields.
|
|
23
|
+
* @summary Get all lead fields
|
|
24
|
+
* @param {number} [start] Pagination start
|
|
25
|
+
* @param {number} [limit] Items shown per page
|
|
26
|
+
|
|
27
|
+
* @throws {RequiredError}
|
|
28
|
+
*/
|
|
29
|
+
getLeadFields: (start?: number, limit?: number) => Promise<RequestArgs>;
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* LeadFieldsApi - functional programming interface
|
|
33
|
+
* @export
|
|
34
|
+
*/
|
|
35
|
+
export declare const LeadFieldsApiFp: (configuration?: Configuration) => {
|
|
36
|
+
/**
|
|
37
|
+
* Returns data about all lead fields.
|
|
38
|
+
* @summary Get all lead fields
|
|
39
|
+
* @param {number} [start] Pagination start
|
|
40
|
+
* @param {number} [limit] Items shown per page
|
|
41
|
+
|
|
42
|
+
* @throws {RequiredError}
|
|
43
|
+
*/
|
|
44
|
+
getLeadFields(start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFieldsResponse>>;
|
|
45
|
+
};
|
|
46
|
+
/**
|
|
47
|
+
* LeadFieldsApi - factory interface
|
|
48
|
+
* @export
|
|
49
|
+
*/
|
|
50
|
+
export declare const LeadFieldsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
51
|
+
/**
|
|
52
|
+
* Returns data about all lead fields.
|
|
53
|
+
* @summary Get all lead fields
|
|
54
|
+
* @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.
|
|
55
|
+
|
|
56
|
+
* @throws {RequiredError}
|
|
57
|
+
*/
|
|
58
|
+
getLeadFields(requestParameters?: LeadFieldsApiGetLeadFieldsRequest): Promise<GetFieldsResponse>;
|
|
59
|
+
};
|
|
60
|
+
/**
|
|
61
|
+
* Request parameters for getLeadFields operation in LeadFieldsApi.
|
|
62
|
+
* @export
|
|
63
|
+
* @interface LeadFieldsApiGetLeadFieldsRequest
|
|
64
|
+
*/
|
|
65
|
+
export interface LeadFieldsApiGetLeadFieldsRequest {
|
|
66
|
+
/**
|
|
67
|
+
* Pagination start
|
|
68
|
+
* @type {number}
|
|
69
|
+
* @memberof LeadFieldsApiGetLeadFields
|
|
70
|
+
*/
|
|
71
|
+
readonly start?: number;
|
|
72
|
+
/**
|
|
73
|
+
* Items shown per page
|
|
74
|
+
* @type {number}
|
|
75
|
+
* @memberof LeadFieldsApiGetLeadFields
|
|
76
|
+
*/
|
|
77
|
+
readonly limit?: number;
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* LeadFieldsApi - object-oriented interface
|
|
81
|
+
* @export
|
|
82
|
+
* @class LeadFieldsApi
|
|
83
|
+
* @extends {BaseAPI}
|
|
84
|
+
*/
|
|
85
|
+
export declare class LeadFieldsApi extends BaseAPI {
|
|
86
|
+
/**
|
|
87
|
+
* Returns data about all lead fields.
|
|
88
|
+
* @summary Get all lead fields
|
|
89
|
+
* @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.
|
|
90
|
+
|
|
91
|
+
* @throws {RequiredError}
|
|
92
|
+
* @memberof LeadFieldsApi
|
|
93
|
+
*/
|
|
94
|
+
getLeadFields(requestParameters?: LeadFieldsApiGetLeadFieldsRequest): Promise<GetFieldsResponse>;
|
|
95
|
+
}
|
|
@@ -0,0 +1,135 @@
|
|
|
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
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
15
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
16
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
17
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
18
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
19
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
20
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
21
|
+
});
|
|
22
|
+
};
|
|
23
|
+
import globalAxios from 'axios';
|
|
24
|
+
// Some imports not used depending on template conditions
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
import { DUMMY_BASE_URL, setApiKeyToObject, setOAuthToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
|
|
27
|
+
// @ts-ignore
|
|
28
|
+
import { BASE_PATH, BaseAPI } from '../base';
|
|
29
|
+
/**
|
|
30
|
+
* LeadFieldsApi - axios parameter creator
|
|
31
|
+
* @export
|
|
32
|
+
*/
|
|
33
|
+
export const LeadFieldsApiAxiosParamCreator = function (configuration) {
|
|
34
|
+
return {
|
|
35
|
+
/**
|
|
36
|
+
* Returns data about all lead fields.
|
|
37
|
+
* @summary Get all lead fields
|
|
38
|
+
* @param {number} [start] Pagination start
|
|
39
|
+
* @param {number} [limit] Items shown per page
|
|
40
|
+
|
|
41
|
+
* @throws {RequiredError}
|
|
42
|
+
*/
|
|
43
|
+
getLeadFields: (start, limit) => __awaiter(this, void 0, void 0, function* () {
|
|
44
|
+
const localVarPath = `/leadFields`;
|
|
45
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
46
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
47
|
+
let baseOptions;
|
|
48
|
+
if (configuration) {
|
|
49
|
+
baseOptions = configuration.baseOptions;
|
|
50
|
+
}
|
|
51
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
|
|
52
|
+
const localVarHeaderParameter = {};
|
|
53
|
+
const localVarQueryParameter = {};
|
|
54
|
+
// authentication api_key required
|
|
55
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
|
56
|
+
// authentication oauth2 required
|
|
57
|
+
// oauth required
|
|
58
|
+
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["leads:read", "leads:full", "admin"], configuration);
|
|
59
|
+
if (start !== undefined) {
|
|
60
|
+
localVarQueryParameter['start'] = start;
|
|
61
|
+
}
|
|
62
|
+
if (limit !== undefined) {
|
|
63
|
+
localVarQueryParameter['limit'] = limit;
|
|
64
|
+
}
|
|
65
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
66
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
67
|
+
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
68
|
+
return {
|
|
69
|
+
url: toPathString(localVarUrlObj),
|
|
70
|
+
options: localVarRequestOptions,
|
|
71
|
+
};
|
|
72
|
+
}),
|
|
73
|
+
};
|
|
74
|
+
};
|
|
75
|
+
/**
|
|
76
|
+
* LeadFieldsApi - functional programming interface
|
|
77
|
+
* @export
|
|
78
|
+
*/
|
|
79
|
+
export const LeadFieldsApiFp = function (configuration) {
|
|
80
|
+
const localVarAxiosParamCreator = LeadFieldsApiAxiosParamCreator(configuration);
|
|
81
|
+
return {
|
|
82
|
+
/**
|
|
83
|
+
* Returns data about all lead fields.
|
|
84
|
+
* @summary Get all lead fields
|
|
85
|
+
* @param {number} [start] Pagination start
|
|
86
|
+
* @param {number} [limit] Items shown per page
|
|
87
|
+
|
|
88
|
+
* @throws {RequiredError}
|
|
89
|
+
*/
|
|
90
|
+
getLeadFields(start, limit) {
|
|
91
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
92
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeadFields(start, limit);
|
|
93
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
94
|
+
});
|
|
95
|
+
},
|
|
96
|
+
};
|
|
97
|
+
};
|
|
98
|
+
/**
|
|
99
|
+
* LeadFieldsApi - factory interface
|
|
100
|
+
* @export
|
|
101
|
+
*/
|
|
102
|
+
export const LeadFieldsApiFactory = function (configuration, basePath, axios) {
|
|
103
|
+
const localVarFp = LeadFieldsApiFp(configuration);
|
|
104
|
+
return {
|
|
105
|
+
/**
|
|
106
|
+
* Returns data about all lead fields.
|
|
107
|
+
* @summary Get all lead fields
|
|
108
|
+
* @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.
|
|
109
|
+
|
|
110
|
+
* @throws {RequiredError}
|
|
111
|
+
*/
|
|
112
|
+
getLeadFields(requestParameters = {}) {
|
|
113
|
+
return localVarFp.getLeadFields(requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
|
|
114
|
+
},
|
|
115
|
+
};
|
|
116
|
+
};
|
|
117
|
+
/**
|
|
118
|
+
* LeadFieldsApi - object-oriented interface
|
|
119
|
+
* @export
|
|
120
|
+
* @class LeadFieldsApi
|
|
121
|
+
* @extends {BaseAPI}
|
|
122
|
+
*/
|
|
123
|
+
export class LeadFieldsApi extends BaseAPI {
|
|
124
|
+
/**
|
|
125
|
+
* Returns data about all lead fields.
|
|
126
|
+
* @summary Get all lead fields
|
|
127
|
+
* @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.
|
|
128
|
+
|
|
129
|
+
* @throws {RequiredError}
|
|
130
|
+
* @memberof LeadFieldsApi
|
|
131
|
+
*/
|
|
132
|
+
getLeadFields(requestParameters = {}) {
|
|
133
|
+
return LeadFieldsApiFp(this.configuration).getLeadFields(requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
134
|
+
}
|
|
135
|
+
}
|
|
@@ -22,6 +22,7 @@ export * from './api/files-api';
|
|
|
22
22
|
export * from './api/filters-api';
|
|
23
23
|
export * from './api/goals-api';
|
|
24
24
|
export * from './api/item-search-api';
|
|
25
|
+
export * from './api/lead-fields-api';
|
|
25
26
|
export * from './api/lead-labels-api';
|
|
26
27
|
export * from './api/lead-sources-api';
|
|
27
28
|
export * from './api/leads-api';
|
|
@@ -24,6 +24,7 @@ export * from './api/files-api';
|
|
|
24
24
|
export * from './api/filters-api';
|
|
25
25
|
export * from './api/goals-api';
|
|
26
26
|
export * from './api/item-search-api';
|
|
27
|
+
export * from './api/lead-fields-api';
|
|
27
28
|
export * from './api/lead-labels-api';
|
|
28
29
|
export * from './api/lead-sources-api';
|
|
29
30
|
export * from './api/leads-api';
|
|
@@ -99,6 +99,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
99
99
|
* @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.
|
|
100
100
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
101
101
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
102
|
+
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
102
103
|
* @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.
|
|
103
104
|
* @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.
|
|
104
105
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
@@ -110,7 +111,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
110
111
|
|
|
111
112
|
* @throws {RequiredError}
|
|
112
113
|
*/
|
|
113
|
-
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<RequestArgs>;
|
|
114
|
+
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<RequestArgs>;
|
|
114
115
|
/**
|
|
115
116
|
* Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
|
|
116
117
|
* @summary Search persons
|
|
@@ -211,6 +212,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
211
212
|
* @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.
|
|
212
213
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
213
214
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
215
|
+
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
214
216
|
* @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.
|
|
215
217
|
* @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.
|
|
216
218
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
@@ -222,7 +224,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
222
224
|
|
|
223
225
|
* @throws {RequiredError}
|
|
224
226
|
*/
|
|
225
|
-
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<GetPersonsResponse>>;
|
|
227
|
+
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<GetPersonsResponse>>;
|
|
226
228
|
/**
|
|
227
229
|
* Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
|
|
228
230
|
* @summary Search persons
|
|
@@ -502,6 +504,12 @@ export interface PersonsApiGetPersonsRequest {
|
|
|
502
504
|
* @memberof PersonsApiGetPersons
|
|
503
505
|
*/
|
|
504
506
|
readonly org_id?: number;
|
|
507
|
+
/**
|
|
508
|
+
* If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
509
|
+
* @type {number}
|
|
510
|
+
* @memberof PersonsApiGetPersons
|
|
511
|
+
*/
|
|
512
|
+
readonly deal_id?: number;
|
|
505
513
|
/**
|
|
506
514
|
* 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.
|
|
507
515
|
* @type {string}
|
|
@@ -307,6 +307,7 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
307
307
|
* @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.
|
|
308
308
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
309
309
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
310
|
+
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
310
311
|
* @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.
|
|
311
312
|
* @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.
|
|
312
313
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
@@ -318,7 +319,7 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
318
319
|
|
|
319
320
|
* @throws {RequiredError}
|
|
320
321
|
*/
|
|
321
|
-
getPersons: (filter_id, ids, owner_id, org_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
|
|
322
|
+
getPersons: (filter_id, ids, owner_id, org_id, deal_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
|
|
322
323
|
const localVarPath = `/persons`;
|
|
323
324
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
324
325
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -346,6 +347,9 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
346
347
|
if (org_id !== undefined) {
|
|
347
348
|
localVarQueryParameter['org_id'] = org_id;
|
|
348
349
|
}
|
|
350
|
+
if (deal_id !== undefined) {
|
|
351
|
+
localVarQueryParameter['deal_id'] = deal_id;
|
|
352
|
+
}
|
|
349
353
|
if (updated_since !== undefined) {
|
|
350
354
|
localVarQueryParameter['updated_since'] = updated_since;
|
|
351
355
|
}
|
|
@@ -590,6 +594,7 @@ export const PersonsApiFp = function (configuration) {
|
|
|
590
594
|
* @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.
|
|
591
595
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
592
596
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
597
|
+
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
593
598
|
* @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.
|
|
594
599
|
* @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.
|
|
595
600
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
@@ -601,9 +606,9 @@ export const PersonsApiFp = function (configuration) {
|
|
|
601
606
|
|
|
602
607
|
* @throws {RequiredError}
|
|
603
608
|
*/
|
|
604
|
-
getPersons(filter_id, ids, owner_id, org_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor) {
|
|
609
|
+
getPersons(filter_id, ids, owner_id, org_id, deal_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor) {
|
|
605
610
|
return __awaiter(this, void 0, void 0, function* () {
|
|
606
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersons(filter_id, ids, owner_id, org_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor);
|
|
611
|
+
const localVarAxiosArgs = yield 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);
|
|
607
612
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
608
613
|
});
|
|
609
614
|
},
|
|
@@ -727,7 +732,7 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
727
732
|
* @throws {RequiredError}
|
|
728
733
|
*/
|
|
729
734
|
getPersons(requestParameters = {}) {
|
|
730
|
-
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));
|
|
735
|
+
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));
|
|
731
736
|
},
|
|
732
737
|
/**
|
|
733
738
|
* Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
|
|
@@ -844,7 +849,7 @@ export class PersonsApi extends BaseAPI {
|
|
|
844
849
|
* @memberof PersonsApi
|
|
845
850
|
*/
|
|
846
851
|
getPersons(requestParameters = {}) {
|
|
847
|
-
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));
|
|
852
|
+
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));
|
|
848
853
|
}
|
|
849
854
|
/**
|
|
850
855
|
* Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Pipedrive API v1
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosInstance } from 'axios';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { GetFieldsResponse } from '../models';
|
|
16
|
+
/**
|
|
17
|
+
* LeadFieldsApi - axios parameter creator
|
|
18
|
+
* @export
|
|
19
|
+
*/
|
|
20
|
+
export declare const LeadFieldsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
|
+
/**
|
|
22
|
+
* Returns data about all lead fields.
|
|
23
|
+
* @summary Get all lead fields
|
|
24
|
+
* @param {number} [start] Pagination start
|
|
25
|
+
* @param {number} [limit] Items shown per page
|
|
26
|
+
|
|
27
|
+
* @throws {RequiredError}
|
|
28
|
+
*/
|
|
29
|
+
getLeadFields: (start?: number, limit?: number) => Promise<RequestArgs>;
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* LeadFieldsApi - functional programming interface
|
|
33
|
+
* @export
|
|
34
|
+
*/
|
|
35
|
+
export declare const LeadFieldsApiFp: (configuration?: Configuration) => {
|
|
36
|
+
/**
|
|
37
|
+
* Returns data about all lead fields.
|
|
38
|
+
* @summary Get all lead fields
|
|
39
|
+
* @param {number} [start] Pagination start
|
|
40
|
+
* @param {number} [limit] Items shown per page
|
|
41
|
+
|
|
42
|
+
* @throws {RequiredError}
|
|
43
|
+
*/
|
|
44
|
+
getLeadFields(start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFieldsResponse>>;
|
|
45
|
+
};
|
|
46
|
+
/**
|
|
47
|
+
* LeadFieldsApi - factory interface
|
|
48
|
+
* @export
|
|
49
|
+
*/
|
|
50
|
+
export declare const LeadFieldsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
51
|
+
/**
|
|
52
|
+
* Returns data about all lead fields.
|
|
53
|
+
* @summary Get all lead fields
|
|
54
|
+
* @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.
|
|
55
|
+
|
|
56
|
+
* @throws {RequiredError}
|
|
57
|
+
*/
|
|
58
|
+
getLeadFields(requestParameters?: LeadFieldsApiGetLeadFieldsRequest): Promise<GetFieldsResponse>;
|
|
59
|
+
};
|
|
60
|
+
/**
|
|
61
|
+
* Request parameters for getLeadFields operation in LeadFieldsApi.
|
|
62
|
+
* @export
|
|
63
|
+
* @interface LeadFieldsApiGetLeadFieldsRequest
|
|
64
|
+
*/
|
|
65
|
+
export interface LeadFieldsApiGetLeadFieldsRequest {
|
|
66
|
+
/**
|
|
67
|
+
* Pagination start
|
|
68
|
+
* @type {number}
|
|
69
|
+
* @memberof LeadFieldsApiGetLeadFields
|
|
70
|
+
*/
|
|
71
|
+
readonly start?: number;
|
|
72
|
+
/**
|
|
73
|
+
* Items shown per page
|
|
74
|
+
* @type {number}
|
|
75
|
+
* @memberof LeadFieldsApiGetLeadFields
|
|
76
|
+
*/
|
|
77
|
+
readonly limit?: number;
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* LeadFieldsApi - object-oriented interface
|
|
81
|
+
* @export
|
|
82
|
+
* @class LeadFieldsApi
|
|
83
|
+
* @extends {BaseAPI}
|
|
84
|
+
*/
|
|
85
|
+
export declare class LeadFieldsApi extends BaseAPI {
|
|
86
|
+
/**
|
|
87
|
+
* Returns data about all lead fields.
|
|
88
|
+
* @summary Get all lead fields
|
|
89
|
+
* @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.
|
|
90
|
+
|
|
91
|
+
* @throws {RequiredError}
|
|
92
|
+
* @memberof LeadFieldsApi
|
|
93
|
+
*/
|
|
94
|
+
getLeadFields(requestParameters?: LeadFieldsApiGetLeadFieldsRequest): Promise<GetFieldsResponse>;
|
|
95
|
+
}
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Pipedrive API v1
|
|
6
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
16
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
17
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
18
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
19
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
20
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
21
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
22
|
+
});
|
|
23
|
+
};
|
|
24
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
25
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
26
|
+
};
|
|
27
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
28
|
+
exports.LeadFieldsApi = exports.LeadFieldsApiFactory = exports.LeadFieldsApiFp = exports.LeadFieldsApiAxiosParamCreator = void 0;
|
|
29
|
+
const axios_1 = __importDefault(require("axios"));
|
|
30
|
+
// Some imports not used depending on template conditions
|
|
31
|
+
// @ts-ignore
|
|
32
|
+
const common_1 = require("../common");
|
|
33
|
+
// @ts-ignore
|
|
34
|
+
const base_1 = require("../base");
|
|
35
|
+
/**
|
|
36
|
+
* LeadFieldsApi - axios parameter creator
|
|
37
|
+
* @export
|
|
38
|
+
*/
|
|
39
|
+
const LeadFieldsApiAxiosParamCreator = function (configuration) {
|
|
40
|
+
return {
|
|
41
|
+
/**
|
|
42
|
+
* Returns data about all lead fields.
|
|
43
|
+
* @summary Get all lead fields
|
|
44
|
+
* @param {number} [start] Pagination start
|
|
45
|
+
* @param {number} [limit] Items shown per page
|
|
46
|
+
|
|
47
|
+
* @throws {RequiredError}
|
|
48
|
+
*/
|
|
49
|
+
getLeadFields: (start, limit) => __awaiter(this, void 0, void 0, function* () {
|
|
50
|
+
const localVarPath = `/leadFields`;
|
|
51
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
52
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
53
|
+
let baseOptions;
|
|
54
|
+
if (configuration) {
|
|
55
|
+
baseOptions = configuration.baseOptions;
|
|
56
|
+
}
|
|
57
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
|
|
58
|
+
const localVarHeaderParameter = {};
|
|
59
|
+
const localVarQueryParameter = {};
|
|
60
|
+
// authentication api_key required
|
|
61
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
|
62
|
+
// authentication oauth2 required
|
|
63
|
+
// oauth required
|
|
64
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["leads:read", "leads:full", "admin"], configuration);
|
|
65
|
+
if (start !== undefined) {
|
|
66
|
+
localVarQueryParameter['start'] = start;
|
|
67
|
+
}
|
|
68
|
+
if (limit !== undefined) {
|
|
69
|
+
localVarQueryParameter['limit'] = limit;
|
|
70
|
+
}
|
|
71
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
72
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
73
|
+
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
74
|
+
return {
|
|
75
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
76
|
+
options: localVarRequestOptions,
|
|
77
|
+
};
|
|
78
|
+
}),
|
|
79
|
+
};
|
|
80
|
+
};
|
|
81
|
+
exports.LeadFieldsApiAxiosParamCreator = LeadFieldsApiAxiosParamCreator;
|
|
82
|
+
/**
|
|
83
|
+
* LeadFieldsApi - functional programming interface
|
|
84
|
+
* @export
|
|
85
|
+
*/
|
|
86
|
+
const LeadFieldsApiFp = function (configuration) {
|
|
87
|
+
const localVarAxiosParamCreator = (0, exports.LeadFieldsApiAxiosParamCreator)(configuration);
|
|
88
|
+
return {
|
|
89
|
+
/**
|
|
90
|
+
* Returns data about all lead fields.
|
|
91
|
+
* @summary Get all lead fields
|
|
92
|
+
* @param {number} [start] Pagination start
|
|
93
|
+
* @param {number} [limit] Items shown per page
|
|
94
|
+
|
|
95
|
+
* @throws {RequiredError}
|
|
96
|
+
*/
|
|
97
|
+
getLeadFields(start, limit) {
|
|
98
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
99
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeadFields(start, limit);
|
|
100
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
101
|
+
});
|
|
102
|
+
},
|
|
103
|
+
};
|
|
104
|
+
};
|
|
105
|
+
exports.LeadFieldsApiFp = LeadFieldsApiFp;
|
|
106
|
+
/**
|
|
107
|
+
* LeadFieldsApi - factory interface
|
|
108
|
+
* @export
|
|
109
|
+
*/
|
|
110
|
+
const LeadFieldsApiFactory = function (configuration, basePath, axios) {
|
|
111
|
+
const localVarFp = (0, exports.LeadFieldsApiFp)(configuration);
|
|
112
|
+
return {
|
|
113
|
+
/**
|
|
114
|
+
* Returns data about all lead fields.
|
|
115
|
+
* @summary Get all lead fields
|
|
116
|
+
* @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.
|
|
117
|
+
|
|
118
|
+
* @throws {RequiredError}
|
|
119
|
+
*/
|
|
120
|
+
getLeadFields(requestParameters = {}) {
|
|
121
|
+
return localVarFp.getLeadFields(requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
|
|
122
|
+
},
|
|
123
|
+
};
|
|
124
|
+
};
|
|
125
|
+
exports.LeadFieldsApiFactory = LeadFieldsApiFactory;
|
|
126
|
+
/**
|
|
127
|
+
* LeadFieldsApi - object-oriented interface
|
|
128
|
+
* @export
|
|
129
|
+
* @class LeadFieldsApi
|
|
130
|
+
* @extends {BaseAPI}
|
|
131
|
+
*/
|
|
132
|
+
class LeadFieldsApi extends base_1.BaseAPI {
|
|
133
|
+
/**
|
|
134
|
+
* Returns data about all lead fields.
|
|
135
|
+
* @summary Get all lead fields
|
|
136
|
+
* @param {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.
|
|
137
|
+
|
|
138
|
+
* @throws {RequiredError}
|
|
139
|
+
* @memberof LeadFieldsApi
|
|
140
|
+
*/
|
|
141
|
+
getLeadFields(requestParameters = {}) {
|
|
142
|
+
return (0, exports.LeadFieldsApiFp)(this.configuration).getLeadFields(requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
exports.LeadFieldsApi = LeadFieldsApi;
|
|
@@ -22,6 +22,7 @@ export * from './api/files-api';
|
|
|
22
22
|
export * from './api/filters-api';
|
|
23
23
|
export * from './api/goals-api';
|
|
24
24
|
export * from './api/item-search-api';
|
|
25
|
+
export * from './api/lead-fields-api';
|
|
25
26
|
export * from './api/lead-labels-api';
|
|
26
27
|
export * from './api/lead-sources-api';
|
|
27
28
|
export * from './api/leads-api';
|
package/dist/versions/v1/api.js
CHANGED
|
@@ -40,6 +40,7 @@ __exportStar(require("./api/files-api"), exports);
|
|
|
40
40
|
__exportStar(require("./api/filters-api"), exports);
|
|
41
41
|
__exportStar(require("./api/goals-api"), exports);
|
|
42
42
|
__exportStar(require("./api/item-search-api"), exports);
|
|
43
|
+
__exportStar(require("./api/lead-fields-api"), exports);
|
|
43
44
|
__exportStar(require("./api/lead-labels-api"), exports);
|
|
44
45
|
__exportStar(require("./api/lead-sources-api"), exports);
|
|
45
46
|
__exportStar(require("./api/leads-api"), exports);
|
|
@@ -99,6 +99,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
99
99
|
* @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.
|
|
100
100
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
101
101
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
102
|
+
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
102
103
|
* @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.
|
|
103
104
|
* @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.
|
|
104
105
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
@@ -110,7 +111,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
110
111
|
|
|
111
112
|
* @throws {RequiredError}
|
|
112
113
|
*/
|
|
113
|
-
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<RequestArgs>;
|
|
114
|
+
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<RequestArgs>;
|
|
114
115
|
/**
|
|
115
116
|
* Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
|
|
116
117
|
* @summary Search persons
|
|
@@ -211,6 +212,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
211
212
|
* @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.
|
|
212
213
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
213
214
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
215
|
+
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
214
216
|
* @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.
|
|
215
217
|
* @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.
|
|
216
218
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
@@ -222,7 +224,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
222
224
|
|
|
223
225
|
* @throws {RequiredError}
|
|
224
226
|
*/
|
|
225
|
-
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<GetPersonsResponse>>;
|
|
227
|
+
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<GetPersonsResponse>>;
|
|
226
228
|
/**
|
|
227
229
|
* Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
|
|
228
230
|
* @summary Search persons
|
|
@@ -502,6 +504,12 @@ export interface PersonsApiGetPersonsRequest {
|
|
|
502
504
|
* @memberof PersonsApiGetPersons
|
|
503
505
|
*/
|
|
504
506
|
readonly org_id?: number;
|
|
507
|
+
/**
|
|
508
|
+
* If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
509
|
+
* @type {number}
|
|
510
|
+
* @memberof PersonsApiGetPersons
|
|
511
|
+
*/
|
|
512
|
+
readonly deal_id?: number;
|
|
505
513
|
/**
|
|
506
514
|
* 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.
|
|
507
515
|
* @type {string}
|
|
@@ -313,6 +313,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
313
313
|
* @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.
|
|
314
314
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
315
315
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
316
|
+
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
316
317
|
* @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.
|
|
317
318
|
* @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.
|
|
318
319
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
@@ -324,7 +325,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
324
325
|
|
|
325
326
|
* @throws {RequiredError}
|
|
326
327
|
*/
|
|
327
|
-
getPersons: (filter_id, ids, owner_id, org_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
|
|
328
|
+
getPersons: (filter_id, ids, owner_id, org_id, deal_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
|
|
328
329
|
const localVarPath = `/persons`;
|
|
329
330
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
330
331
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -352,6 +353,9 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
352
353
|
if (org_id !== undefined) {
|
|
353
354
|
localVarQueryParameter['org_id'] = org_id;
|
|
354
355
|
}
|
|
356
|
+
if (deal_id !== undefined) {
|
|
357
|
+
localVarQueryParameter['deal_id'] = deal_id;
|
|
358
|
+
}
|
|
355
359
|
if (updated_since !== undefined) {
|
|
356
360
|
localVarQueryParameter['updated_since'] = updated_since;
|
|
357
361
|
}
|
|
@@ -597,6 +601,7 @@ const PersonsApiFp = function (configuration) {
|
|
|
597
601
|
* @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.
|
|
598
602
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
599
603
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
604
|
+
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
600
605
|
* @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.
|
|
601
606
|
* @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.
|
|
602
607
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
@@ -608,9 +613,9 @@ const PersonsApiFp = function (configuration) {
|
|
|
608
613
|
|
|
609
614
|
* @throws {RequiredError}
|
|
610
615
|
*/
|
|
611
|
-
getPersons(filter_id, ids, owner_id, org_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor) {
|
|
616
|
+
getPersons(filter_id, ids, owner_id, org_id, deal_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor) {
|
|
612
617
|
return __awaiter(this, void 0, void 0, function* () {
|
|
613
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersons(filter_id, ids, owner_id, org_id, updated_since, updated_until, sort_by, sort_direction, include_fields, custom_fields, limit, cursor);
|
|
618
|
+
const localVarAxiosArgs = yield 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);
|
|
614
619
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
615
620
|
});
|
|
616
621
|
},
|
|
@@ -735,7 +740,7 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
735
740
|
* @throws {RequiredError}
|
|
736
741
|
*/
|
|
737
742
|
getPersons(requestParameters = {}) {
|
|
738
|
-
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));
|
|
743
|
+
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));
|
|
739
744
|
},
|
|
740
745
|
/**
|
|
741
746
|
* Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
|
|
@@ -853,7 +858,7 @@ class PersonsApi extends base_1.BaseAPI {
|
|
|
853
858
|
* @memberof PersonsApi
|
|
854
859
|
*/
|
|
855
860
|
getPersons(requestParameters = {}) {
|
|
856
|
-
return (0, exports.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));
|
|
861
|
+
return (0, exports.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));
|
|
857
862
|
}
|
|
858
863
|
/**
|
|
859
864
|
* Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
|