pipedrive 33.4.3 → 33.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/deals-api.d.ts +10 -2
- package/dist/esm/versions/v1/api/deals-api.js +10 -5
- package/dist/esm/versions/v1/api/organizations-api.d.ts +10 -2
- package/dist/esm/versions/v1/api/organizations-api.js +10 -5
- package/dist/esm/versions/v1/api/persons-api.d.ts +10 -2
- package/dist/esm/versions/v1/api/persons-api.js +10 -5
- package/dist/esm/versions/v1/common.d.ts +1 -1
- package/dist/esm/versions/v1/common.js +2 -0
- package/dist/esm/versions/v1/models/mail-message-data.d.ts +5 -0
- package/dist/esm/versions/v2/api/persons-api.d.ts +15 -14
- package/dist/esm/versions/v2/api/persons-api.js +16 -16
- package/dist/esm/versions/v2/common.d.ts +1 -1
- package/dist/esm/versions/v2/common.js +2 -0
- package/dist/esm/versions/v2/models/add-organization-request.d.ts +26 -6
- package/dist/esm/versions/v2/models/add-person-request.d.ts +33 -11
- package/dist/esm/versions/v2/models/index.d.ts +5 -4
- package/dist/esm/versions/v2/models/index.js +5 -4
- package/dist/esm/versions/v2/models/{person-postal-address.d.ts → person-item-address.d.ts} +2 -2
- package/dist/esm/versions/v2/models/{add-person-request-emails-inner.d.ts → person-item-email.d.ts} +2 -2
- package/dist/{versions/v2/models/person-im-inner.d.ts → esm/versions/v2/models/person-item-im.d.ts} +2 -2
- package/dist/{versions/v2/models/add-person-request-phones-inner.d.ts → esm/versions/v2/models/person-item-phone.d.ts} +2 -2
- package/dist/esm/versions/v2/models/person.d.ts +12 -12
- package/dist/esm/versions/v2/models/update-organization-request.d.ts +25 -10
- package/dist/esm/versions/v2/models/update-person-request.d.ts +101 -0
- package/dist/esm/versions/v2/models/update-person-request.js +19 -0
- package/dist/versions/v1/api/deals-api.d.ts +10 -2
- package/dist/versions/v1/api/deals-api.js +10 -5
- package/dist/versions/v1/api/organizations-api.d.ts +10 -2
- package/dist/versions/v1/api/organizations-api.js +10 -5
- package/dist/versions/v1/api/persons-api.d.ts +10 -2
- package/dist/versions/v1/api/persons-api.js +10 -5
- package/dist/versions/v1/common.d.ts +1 -1
- package/dist/versions/v1/common.js +2 -0
- package/dist/versions/v1/models/mail-message-data.d.ts +5 -0
- package/dist/versions/v2/api/persons-api.d.ts +15 -14
- package/dist/versions/v2/api/persons-api.js +16 -16
- package/dist/versions/v2/common.d.ts +1 -1
- package/dist/versions/v2/common.js +2 -0
- package/dist/versions/v2/models/add-organization-request.d.ts +26 -6
- package/dist/versions/v2/models/add-person-request.d.ts +33 -11
- package/dist/versions/v2/models/index.d.ts +5 -4
- package/dist/versions/v2/models/index.js +5 -4
- package/dist/versions/v2/models/{person-postal-address.d.ts → person-item-address.d.ts} +2 -2
- package/dist/versions/v2/models/{add-person-request-emails-inner.d.ts → person-item-email.d.ts} +2 -2
- package/dist/{esm/versions/v2/models/person-im-inner.d.ts → versions/v2/models/person-item-im.d.ts} +2 -2
- package/dist/{esm/versions/v2/models/add-person-request-phones-inner.d.ts → versions/v2/models/person-item-phone.d.ts} +2 -2
- package/dist/versions/v2/models/person.d.ts +12 -12
- package/dist/versions/v2/models/update-organization-request.d.ts +25 -10
- package/dist/versions/v2/models/update-person-request.d.ts +101 -0
- package/dist/versions/v2/models/update-person-request.js +22 -0
- package/package.json +1 -1
- /package/dist/esm/versions/v2/models/{add-person-request-emails-inner.js → person-item-address.js} +0 -0
- /package/dist/esm/versions/v2/models/{add-person-request-phones-inner.js → person-item-email.js} +0 -0
- /package/dist/esm/versions/v2/models/{person-im-inner.js → person-item-im.js} +0 -0
- /package/dist/esm/versions/v2/models/{person-postal-address.js → person-item-phone.js} +0 -0
- /package/dist/versions/v2/models/{add-person-request-emails-inner.js → person-item-address.js} +0 -0
- /package/dist/versions/v2/models/{add-person-request-phones-inner.js → person-item-email.js} +0 -0
- /package/dist/versions/v2/models/{person-im-inner.js → person-item-im.js} +0 -0
- /package/dist/versions/v2/models/{person-postal-address.js → person-item-phone.js} +0 -0
|
@@ -163,10 +163,11 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
163
163
|
* @param {number} id The ID of the deal
|
|
164
164
|
* @param {number} [start] Pagination start
|
|
165
165
|
* @param {number} [limit] Items shown per page
|
|
166
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
166
167
|
|
|
167
168
|
* @throws {RequiredError}
|
|
168
169
|
*/
|
|
169
|
-
getDealMailMessages: (id: number, start?: number, limit?: number) => Promise<RequestArgs>;
|
|
170
|
+
getDealMailMessages: (id: number, start?: number, limit?: number, include_body?: 0 | 1) => Promise<RequestArgs>;
|
|
170
171
|
/**
|
|
171
172
|
* Lists the participants associated with a deal.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
|
172
173
|
* @summary List participants of a deal
|
|
@@ -376,10 +377,11 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
376
377
|
* @param {number} id The ID of the deal
|
|
377
378
|
* @param {number} [start] Pagination start
|
|
378
379
|
* @param {number} [limit] Items shown per page
|
|
380
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
379
381
|
|
|
380
382
|
* @throws {RequiredError}
|
|
381
383
|
*/
|
|
382
|
-
getDealMailMessages(id: number, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedMailMessagesResponse>>;
|
|
384
|
+
getDealMailMessages(id: number, start?: number, limit?: number, include_body?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedMailMessagesResponse>>;
|
|
383
385
|
/**
|
|
384
386
|
* Lists the participants associated with a deal.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
|
385
387
|
* @summary List participants of a deal
|
|
@@ -975,6 +977,12 @@ export interface DealsApiGetDealMailMessagesRequest {
|
|
|
975
977
|
* @memberof DealsApiGetDealMailMessages
|
|
976
978
|
*/
|
|
977
979
|
readonly limit?: number;
|
|
980
|
+
/**
|
|
981
|
+
* Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
982
|
+
* @type {0 | 1}
|
|
983
|
+
* @memberof DealsApiGetDealMailMessages
|
|
984
|
+
*/
|
|
985
|
+
readonly include_body?: 0 | 1;
|
|
978
986
|
}
|
|
979
987
|
/**
|
|
980
988
|
* Request parameters for getDealParticipants operation in DealsApi.
|
|
@@ -548,10 +548,11 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
548
548
|
* @param {number} id The ID of the deal
|
|
549
549
|
* @param {number} [start] Pagination start
|
|
550
550
|
* @param {number} [limit] Items shown per page
|
|
551
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
551
552
|
|
|
552
553
|
* @throws {RequiredError}
|
|
553
554
|
*/
|
|
554
|
-
getDealMailMessages: (id, start, limit) => __awaiter(this, void 0, void 0, function* () {
|
|
555
|
+
getDealMailMessages: (id, start, limit, include_body) => __awaiter(this, void 0, void 0, function* () {
|
|
555
556
|
// verify required parameter 'id' is not null or undefined
|
|
556
557
|
assertParamExists('getDealMailMessages', 'id', id);
|
|
557
558
|
const localVarPath = `/deals/{id}/mailMessages`
|
|
@@ -576,6 +577,9 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
576
577
|
if (limit !== undefined) {
|
|
577
578
|
localVarQueryParameter['limit'] = limit;
|
|
578
579
|
}
|
|
580
|
+
if (include_body !== undefined) {
|
|
581
|
+
localVarQueryParameter['include_body'] = include_body;
|
|
582
|
+
}
|
|
579
583
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
580
584
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
581
585
|
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
@@ -1105,12 +1109,13 @@ export const DealsApiFp = function (configuration) {
|
|
|
1105
1109
|
* @param {number} id The ID of the deal
|
|
1106
1110
|
* @param {number} [start] Pagination start
|
|
1107
1111
|
* @param {number} [limit] Items shown per page
|
|
1112
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
1108
1113
|
|
|
1109
1114
|
* @throws {RequiredError}
|
|
1110
1115
|
*/
|
|
1111
|
-
getDealMailMessages(id, start, limit) {
|
|
1116
|
+
getDealMailMessages(id, start, limit, include_body) {
|
|
1112
1117
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1113
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealMailMessages(id, start, limit);
|
|
1118
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealMailMessages(id, start, limit, include_body);
|
|
1114
1119
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1115
1120
|
});
|
|
1116
1121
|
},
|
|
@@ -1353,7 +1358,7 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1353
1358
|
* @throws {RequiredError}
|
|
1354
1359
|
*/
|
|
1355
1360
|
getDealMailMessages(requestParameters) {
|
|
1356
|
-
return localVarFp.getDealMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
|
|
1361
|
+
return localVarFp.getDealMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body).then((request) => request(axios, basePath));
|
|
1357
1362
|
},
|
|
1358
1363
|
/**
|
|
1359
1364
|
* Lists the participants associated with a deal.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
|
@@ -1564,7 +1569,7 @@ export class DealsApi extends BaseAPI {
|
|
|
1564
1569
|
* @memberof DealsApi
|
|
1565
1570
|
*/
|
|
1566
1571
|
getDealMailMessages(requestParameters) {
|
|
1567
|
-
return DealsApiFp(this.configuration).getDealMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
1572
|
+
return DealsApiFp(this.configuration).getDealMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body).then((request) => request(this.axios, this.basePath));
|
|
1568
1573
|
}
|
|
1569
1574
|
/**
|
|
1570
1575
|
* Lists the participants associated with a deal.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
|
@@ -81,10 +81,11 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
81
81
|
* @param {number} id The ID of the organization
|
|
82
82
|
* @param {number} [start] Pagination start
|
|
83
83
|
* @param {number} [limit] Items shown per page
|
|
84
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
84
85
|
|
|
85
86
|
* @throws {RequiredError}
|
|
86
87
|
*/
|
|
87
|
-
getOrganizationMailMessages: (id: number, start?: number, limit?: number) => Promise<RequestArgs>;
|
|
88
|
+
getOrganizationMailMessages: (id: number, start?: number, limit?: number, include_body?: 0 | 1) => Promise<RequestArgs>;
|
|
88
89
|
/**
|
|
89
90
|
* Lists updates about an organization.
|
|
90
91
|
* @summary List updates about an organization
|
|
@@ -173,10 +174,11 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
173
174
|
* @param {number} id The ID of the organization
|
|
174
175
|
* @param {number} [start] Pagination start
|
|
175
176
|
* @param {number} [limit] Items shown per page
|
|
177
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
176
178
|
|
|
177
179
|
* @throws {RequiredError}
|
|
178
180
|
*/
|
|
179
|
-
getOrganizationMailMessages(id: number, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedMailMessagesResponse>>;
|
|
181
|
+
getOrganizationMailMessages(id: number, start?: number, limit?: number, include_body?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedMailMessagesResponse>>;
|
|
180
182
|
/**
|
|
181
183
|
* Lists updates about an organization.
|
|
182
184
|
* @summary List updates about an organization
|
|
@@ -416,6 +418,12 @@ export interface OrganizationsApiGetOrganizationMailMessagesRequest {
|
|
|
416
418
|
* @memberof OrganizationsApiGetOrganizationMailMessages
|
|
417
419
|
*/
|
|
418
420
|
readonly limit?: number;
|
|
421
|
+
/**
|
|
422
|
+
* Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
423
|
+
* @type {0 | 1}
|
|
424
|
+
* @memberof OrganizationsApiGetOrganizationMailMessages
|
|
425
|
+
*/
|
|
426
|
+
readonly include_body?: 0 | 1;
|
|
419
427
|
}
|
|
420
428
|
/**
|
|
421
429
|
* Request parameters for getOrganizationUpdates operation in OrganizationsApi.
|
|
@@ -235,10 +235,11 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
235
235
|
* @param {number} id The ID of the organization
|
|
236
236
|
* @param {number} [start] Pagination start
|
|
237
237
|
* @param {number} [limit] Items shown per page
|
|
238
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
238
239
|
|
|
239
240
|
* @throws {RequiredError}
|
|
240
241
|
*/
|
|
241
|
-
getOrganizationMailMessages: (id, start, limit) => __awaiter(this, void 0, void 0, function* () {
|
|
242
|
+
getOrganizationMailMessages: (id, start, limit, include_body) => __awaiter(this, void 0, void 0, function* () {
|
|
242
243
|
// verify required parameter 'id' is not null or undefined
|
|
243
244
|
assertParamExists('getOrganizationMailMessages', 'id', id);
|
|
244
245
|
const localVarPath = `/organizations/{id}/mailMessages`
|
|
@@ -263,6 +264,9 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
263
264
|
if (limit !== undefined) {
|
|
264
265
|
localVarQueryParameter['limit'] = limit;
|
|
265
266
|
}
|
|
267
|
+
if (include_body !== undefined) {
|
|
268
|
+
localVarQueryParameter['include_body'] = include_body;
|
|
269
|
+
}
|
|
266
270
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
267
271
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
268
272
|
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
@@ -479,12 +483,13 @@ export const OrganizationsApiFp = function (configuration) {
|
|
|
479
483
|
* @param {number} id The ID of the organization
|
|
480
484
|
* @param {number} [start] Pagination start
|
|
481
485
|
* @param {number} [limit] Items shown per page
|
|
486
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
482
487
|
|
|
483
488
|
* @throws {RequiredError}
|
|
484
489
|
*/
|
|
485
|
-
getOrganizationMailMessages(id, start, limit) {
|
|
490
|
+
getOrganizationMailMessages(id, start, limit, include_body) {
|
|
486
491
|
return __awaiter(this, void 0, void 0, function* () {
|
|
487
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganizationMailMessages(id, start, limit);
|
|
492
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganizationMailMessages(id, start, limit, include_body);
|
|
488
493
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
489
494
|
});
|
|
490
495
|
},
|
|
@@ -599,7 +604,7 @@ export const OrganizationsApiFactory = function (configuration, basePath, axios)
|
|
|
599
604
|
* @throws {RequiredError}
|
|
600
605
|
*/
|
|
601
606
|
getOrganizationMailMessages(requestParameters) {
|
|
602
|
-
return localVarFp.getOrganizationMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
|
|
607
|
+
return localVarFp.getOrganizationMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body).then((request) => request(axios, basePath));
|
|
603
608
|
},
|
|
604
609
|
/**
|
|
605
610
|
* Lists updates about an organization.
|
|
@@ -704,7 +709,7 @@ export class OrganizationsApi extends BaseAPI {
|
|
|
704
709
|
* @memberof OrganizationsApi
|
|
705
710
|
*/
|
|
706
711
|
getOrganizationMailMessages(requestParameters) {
|
|
707
|
-
return OrganizationsApiFp(this.configuration).getOrganizationMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
712
|
+
return OrganizationsApiFp(this.configuration).getOrganizationMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body).then((request) => request(this.axios, this.basePath));
|
|
708
713
|
}
|
|
709
714
|
/**
|
|
710
715
|
* Lists updates about an organization.
|
|
@@ -104,10 +104,11 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
104
104
|
* @param {number} id The ID of the person
|
|
105
105
|
* @param {number} [start] Pagination start
|
|
106
106
|
* @param {number} [limit] Items shown per page
|
|
107
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
107
108
|
|
|
108
109
|
* @throws {RequiredError}
|
|
109
110
|
*/
|
|
110
|
-
getPersonMailMessages: (id: number, start?: number, limit?: number) => Promise<RequestArgs>;
|
|
111
|
+
getPersonMailMessages: (id: number, start?: number, limit?: number, include_body?: 0 | 1) => Promise<RequestArgs>;
|
|
111
112
|
/**
|
|
112
113
|
* Lists products associated with a person.
|
|
113
114
|
* @summary List products associated with a person
|
|
@@ -227,10 +228,11 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
227
228
|
* @param {number} id The ID of the person
|
|
228
229
|
* @param {number} [start] Pagination start
|
|
229
230
|
* @param {number} [limit] Items shown per page
|
|
231
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
230
232
|
|
|
231
233
|
* @throws {RequiredError}
|
|
232
234
|
*/
|
|
233
|
-
getPersonMailMessages(id: number, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedMailMessagesResponse>>;
|
|
235
|
+
getPersonMailMessages(id: number, start?: number, limit?: number, include_body?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedMailMessagesResponse>>;
|
|
234
236
|
/**
|
|
235
237
|
* Lists products associated with a person.
|
|
236
238
|
* @summary List products associated with a person
|
|
@@ -560,6 +562,12 @@ export interface PersonsApiGetPersonMailMessagesRequest {
|
|
|
560
562
|
* @memberof PersonsApiGetPersonMailMessages
|
|
561
563
|
*/
|
|
562
564
|
readonly limit?: number;
|
|
565
|
+
/**
|
|
566
|
+
* Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
567
|
+
* @type {0 | 1}
|
|
568
|
+
* @memberof PersonsApiGetPersonMailMessages
|
|
569
|
+
*/
|
|
570
|
+
readonly include_body?: 0 | 1;
|
|
563
571
|
}
|
|
564
572
|
/**
|
|
565
573
|
* Request parameters for getPersonProducts operation in PersonsApi.
|
|
@@ -328,10 +328,11 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
328
328
|
* @param {number} id The ID of the person
|
|
329
329
|
* @param {number} [start] Pagination start
|
|
330
330
|
* @param {number} [limit] Items shown per page
|
|
331
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
331
332
|
|
|
332
333
|
* @throws {RequiredError}
|
|
333
334
|
*/
|
|
334
|
-
getPersonMailMessages: (id, start, limit) => __awaiter(this, void 0, void 0, function* () {
|
|
335
|
+
getPersonMailMessages: (id, start, limit, include_body) => __awaiter(this, void 0, void 0, function* () {
|
|
335
336
|
// verify required parameter 'id' is not null or undefined
|
|
336
337
|
assertParamExists('getPersonMailMessages', 'id', id);
|
|
337
338
|
const localVarPath = `/persons/{id}/mailMessages`
|
|
@@ -356,6 +357,9 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
356
357
|
if (limit !== undefined) {
|
|
357
358
|
localVarQueryParameter['limit'] = limit;
|
|
358
359
|
}
|
|
360
|
+
if (include_body !== undefined) {
|
|
361
|
+
localVarQueryParameter['include_body'] = include_body;
|
|
362
|
+
}
|
|
359
363
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
360
364
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
361
365
|
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
@@ -645,12 +649,13 @@ export const PersonsApiFp = function (configuration) {
|
|
|
645
649
|
* @param {number} id The ID of the person
|
|
646
650
|
* @param {number} [start] Pagination start
|
|
647
651
|
* @param {number} [limit] Items shown per page
|
|
652
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
648
653
|
|
|
649
654
|
* @throws {RequiredError}
|
|
650
655
|
*/
|
|
651
|
-
getPersonMailMessages(id, start, limit) {
|
|
656
|
+
getPersonMailMessages(id, start, limit, include_body) {
|
|
652
657
|
return __awaiter(this, void 0, void 0, function* () {
|
|
653
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersonMailMessages(id, start, limit);
|
|
658
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersonMailMessages(id, start, limit, include_body);
|
|
654
659
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
655
660
|
});
|
|
656
661
|
},
|
|
@@ -800,7 +805,7 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
800
805
|
* @throws {RequiredError}
|
|
801
806
|
*/
|
|
802
807
|
getPersonMailMessages(requestParameters) {
|
|
803
|
-
return localVarFp.getPersonMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
|
|
808
|
+
return localVarFp.getPersonMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body).then((request) => request(axios, basePath));
|
|
804
809
|
},
|
|
805
810
|
/**
|
|
806
811
|
* Lists products associated with a person.
|
|
@@ -937,7 +942,7 @@ export class PersonsApi extends BaseAPI {
|
|
|
937
942
|
* @memberof PersonsApi
|
|
938
943
|
*/
|
|
939
944
|
getPersonMailMessages(requestParameters) {
|
|
940
|
-
return PersonsApiFp(this.configuration).getPersonMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
945
|
+
return PersonsApiFp(this.configuration).getPersonMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body).then((request) => request(this.axios, this.basePath));
|
|
941
946
|
}
|
|
942
947
|
/**
|
|
943
948
|
* Lists products associated with a person.
|
|
@@ -139,6 +139,8 @@ export const toPathString = function (url) {
|
|
|
139
139
|
* @export
|
|
140
140
|
*/
|
|
141
141
|
export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
|
|
142
|
+
// Explicit return type + cast avoid inferring axios's internal AxiosResponseResult type,
|
|
143
|
+
// which references a module-private `unique symbol` and breaks `tsc --declaration` (TS2742).
|
|
142
144
|
return (axios = globalAxios, basePath = BASE_PATH) => {
|
|
143
145
|
const axiosRequestArgs = Object.assign(Object.assign({}, axiosArgs.options), { url: ((configuration === null || configuration === void 0 ? void 0 : configuration.basePath) || basePath) + axiosArgs.url });
|
|
144
146
|
return axios.request(axiosRequestArgs);
|
|
@@ -47,6 +47,11 @@ export interface MailMessageData {
|
|
|
47
47
|
*/
|
|
48
48
|
'body_url'?: string;
|
|
49
49
|
/**
|
|
50
|
+
* The mail message body content. Only present when `include_body=1` is passed.
|
|
51
|
+
* @type {string}
|
|
52
|
+
*/
|
|
53
|
+
'body'?: string;
|
|
54
|
+
/**
|
|
50
55
|
* The connection account ID
|
|
51
56
|
* @type {string}
|
|
52
57
|
*/
|
|
@@ -22,6 +22,7 @@ import { GetFollowersResponse } from '../models';
|
|
|
22
22
|
import { GetPersonPictureResponse } from '../models';
|
|
23
23
|
import { GetPersonSearchResponse } from '../models';
|
|
24
24
|
import { GetPersonsResponse } from '../models';
|
|
25
|
+
import { UpdatePersonRequest } from '../models';
|
|
25
26
|
import { UpsertPersonResponse } from '../models';
|
|
26
27
|
/**
|
|
27
28
|
* PersonsApi - axios parameter creator
|
|
@@ -29,7 +30,7 @@ import { UpsertPersonResponse } from '../models';
|
|
|
29
30
|
*/
|
|
30
31
|
export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
31
32
|
/**
|
|
32
|
-
* Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
|
|
33
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync.
|
|
33
34
|
* @summary Add a new person
|
|
34
35
|
* @param {AddPersonRequest} [AddPersonRequest]
|
|
35
36
|
|
|
@@ -139,14 +140,14 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
139
140
|
*/
|
|
140
141
|
searchPersons: (term: string, fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name', exact_match?: boolean, organization_id?: number, include_fields?: 'person.picture', limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
141
142
|
/**
|
|
142
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
|
|
143
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync.
|
|
143
144
|
* @summary Update a person
|
|
144
145
|
* @param {number} id The ID of the person
|
|
145
|
-
* @param {
|
|
146
|
+
* @param {UpdatePersonRequest} [UpdatePersonRequest]
|
|
146
147
|
|
|
147
148
|
* @throws {RequiredError}
|
|
148
149
|
*/
|
|
149
|
-
updatePerson: (id: number,
|
|
150
|
+
updatePerson: (id: number, UpdatePersonRequest?: UpdatePersonRequest) => Promise<RequestArgs>;
|
|
150
151
|
};
|
|
151
152
|
/**
|
|
152
153
|
* PersonsApi - functional programming interface
|
|
@@ -154,7 +155,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
154
155
|
*/
|
|
155
156
|
export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
156
157
|
/**
|
|
157
|
-
* Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
|
|
158
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync.
|
|
158
159
|
* @summary Add a new person
|
|
159
160
|
* @param {AddPersonRequest} [AddPersonRequest]
|
|
160
161
|
|
|
@@ -264,14 +265,14 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
264
265
|
*/
|
|
265
266
|
searchPersons(term: string, fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name', exact_match?: boolean, organization_id?: number, include_fields?: 'person.picture', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonSearchResponse>>;
|
|
266
267
|
/**
|
|
267
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
|
|
268
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync.
|
|
268
269
|
* @summary Update a person
|
|
269
270
|
* @param {number} id The ID of the person
|
|
270
|
-
* @param {
|
|
271
|
+
* @param {UpdatePersonRequest} [UpdatePersonRequest]
|
|
271
272
|
|
|
272
273
|
* @throws {RequiredError}
|
|
273
274
|
*/
|
|
274
|
-
updatePerson(id: number,
|
|
275
|
+
updatePerson(id: number, UpdatePersonRequest?: UpdatePersonRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertPersonResponse>>;
|
|
275
276
|
};
|
|
276
277
|
/**
|
|
277
278
|
* PersonsApi - factory interface
|
|
@@ -279,7 +280,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
279
280
|
*/
|
|
280
281
|
export declare const PersonsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
281
282
|
/**
|
|
282
|
-
* Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
|
|
283
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync.
|
|
283
284
|
* @summary Add a new person
|
|
284
285
|
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
|
285
286
|
|
|
@@ -359,7 +360,7 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
|
359
360
|
*/
|
|
360
361
|
searchPersons(requestParameters: PersonsApiSearchPersonsRequest): Promise<GetPersonSearchResponse>;
|
|
361
362
|
/**
|
|
362
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
|
|
363
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync.
|
|
363
364
|
* @summary Update a person
|
|
364
365
|
* @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
|
|
365
366
|
|
|
@@ -691,10 +692,10 @@ export interface PersonsApiUpdatePersonRequest {
|
|
|
691
692
|
readonly id: number;
|
|
692
693
|
/**
|
|
693
694
|
*
|
|
694
|
-
* @type {
|
|
695
|
+
* @type {UpdatePersonRequest}
|
|
695
696
|
* @memberof PersonsApiUpdatePerson
|
|
696
697
|
*/
|
|
697
|
-
readonly
|
|
698
|
+
readonly UpdatePersonRequest?: UpdatePersonRequest;
|
|
698
699
|
}
|
|
699
700
|
/**
|
|
700
701
|
* PersonsApi - object-oriented interface
|
|
@@ -704,7 +705,7 @@ export interface PersonsApiUpdatePersonRequest {
|
|
|
704
705
|
*/
|
|
705
706
|
export declare class PersonsApi extends BaseAPI {
|
|
706
707
|
/**
|
|
707
|
-
* Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
|
|
708
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync.
|
|
708
709
|
* @summary Add a new person
|
|
709
710
|
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
|
710
711
|
|
|
@@ -794,7 +795,7 @@ export declare class PersonsApi extends BaseAPI {
|
|
|
794
795
|
*/
|
|
795
796
|
searchPersons(requestParameters: PersonsApiSearchPersonsRequest): Promise<GetPersonSearchResponse>;
|
|
796
797
|
/**
|
|
797
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
|
|
798
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync.
|
|
798
799
|
* @summary Update a person
|
|
799
800
|
* @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
|
|
800
801
|
|
|
@@ -33,7 +33,7 @@ import { BASE_PATH, BaseAPI } from '../base';
|
|
|
33
33
|
export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
34
34
|
return {
|
|
35
35
|
/**
|
|
36
|
-
* Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
|
|
36
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync.
|
|
37
37
|
* @summary Add a new person
|
|
38
38
|
* @param {AddPersonRequest} [AddPersonRequest]
|
|
39
39
|
|
|
@@ -493,14 +493,14 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
493
493
|
};
|
|
494
494
|
}),
|
|
495
495
|
/**
|
|
496
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
|
|
496
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync.
|
|
497
497
|
* @summary Update a person
|
|
498
498
|
* @param {number} id The ID of the person
|
|
499
|
-
* @param {
|
|
499
|
+
* @param {UpdatePersonRequest} [UpdatePersonRequest]
|
|
500
500
|
|
|
501
501
|
* @throws {RequiredError}
|
|
502
502
|
*/
|
|
503
|
-
updatePerson: (id,
|
|
503
|
+
updatePerson: (id, UpdatePersonRequest) => __awaiter(this, void 0, void 0, function* () {
|
|
504
504
|
// verify required parameter 'id' is not null or undefined
|
|
505
505
|
assertParamExists('updatePerson', 'id', id);
|
|
506
506
|
const localVarPath = `/persons/{id}`
|
|
@@ -523,7 +523,7 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
523
523
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
524
524
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
525
525
|
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
526
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
526
|
+
localVarRequestOptions.data = serializeDataIfNeeded(UpdatePersonRequest, localVarRequestOptions, configuration);
|
|
527
527
|
return {
|
|
528
528
|
url: toPathString(localVarUrlObj),
|
|
529
529
|
options: localVarRequestOptions,
|
|
@@ -539,7 +539,7 @@ export const PersonsApiFp = function (configuration) {
|
|
|
539
539
|
const localVarAxiosParamCreator = PersonsApiAxiosParamCreator(configuration);
|
|
540
540
|
return {
|
|
541
541
|
/**
|
|
542
|
-
* Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
|
|
542
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync.
|
|
543
543
|
* @summary Add a new person
|
|
544
544
|
* @param {AddPersonRequest} [AddPersonRequest]
|
|
545
545
|
|
|
@@ -699,16 +699,16 @@ export const PersonsApiFp = function (configuration) {
|
|
|
699
699
|
});
|
|
700
700
|
},
|
|
701
701
|
/**
|
|
702
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
|
|
702
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync.
|
|
703
703
|
* @summary Update a person
|
|
704
704
|
* @param {number} id The ID of the person
|
|
705
|
-
* @param {
|
|
705
|
+
* @param {UpdatePersonRequest} [UpdatePersonRequest]
|
|
706
706
|
|
|
707
707
|
* @throws {RequiredError}
|
|
708
708
|
*/
|
|
709
|
-
updatePerson(id,
|
|
709
|
+
updatePerson(id, UpdatePersonRequest) {
|
|
710
710
|
return __awaiter(this, void 0, void 0, function* () {
|
|
711
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.updatePerson(id,
|
|
711
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updatePerson(id, UpdatePersonRequest);
|
|
712
712
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
713
713
|
});
|
|
714
714
|
},
|
|
@@ -722,7 +722,7 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
722
722
|
const localVarFp = PersonsApiFp(configuration);
|
|
723
723
|
return {
|
|
724
724
|
/**
|
|
725
|
-
* Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
|
|
725
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync.
|
|
726
726
|
* @summary Add a new person
|
|
727
727
|
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
|
728
728
|
|
|
@@ -822,14 +822,14 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
822
822
|
return localVarFp.searchPersons(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.organization_id, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
823
823
|
},
|
|
824
824
|
/**
|
|
825
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
|
|
825
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync.
|
|
826
826
|
* @summary Update a person
|
|
827
827
|
* @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
|
|
828
828
|
|
|
829
829
|
* @throws {RequiredError}
|
|
830
830
|
*/
|
|
831
831
|
updatePerson(requestParameters) {
|
|
832
|
-
return localVarFp.updatePerson(requestParameters.id, requestParameters.
|
|
832
|
+
return localVarFp.updatePerson(requestParameters.id, requestParameters.UpdatePersonRequest).then((request) => request(axios, basePath));
|
|
833
833
|
},
|
|
834
834
|
};
|
|
835
835
|
};
|
|
@@ -841,7 +841,7 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
841
841
|
*/
|
|
842
842
|
export class PersonsApi extends BaseAPI {
|
|
843
843
|
/**
|
|
844
|
-
* Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
|
|
844
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync.
|
|
845
845
|
* @summary Add a new person
|
|
846
846
|
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
|
847
847
|
|
|
@@ -951,7 +951,7 @@ export class PersonsApi extends BaseAPI {
|
|
|
951
951
|
return PersonsApiFp(this.configuration).searchPersons(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.organization_id, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
952
952
|
}
|
|
953
953
|
/**
|
|
954
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
|
|
954
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync.
|
|
955
955
|
* @summary Update a person
|
|
956
956
|
* @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
|
|
957
957
|
|
|
@@ -959,6 +959,6 @@ export class PersonsApi extends BaseAPI {
|
|
|
959
959
|
* @memberof PersonsApi
|
|
960
960
|
*/
|
|
961
961
|
updatePerson(requestParameters) {
|
|
962
|
-
return PersonsApiFp(this.configuration).updatePerson(requestParameters.id, requestParameters.
|
|
962
|
+
return PersonsApiFp(this.configuration).updatePerson(requestParameters.id, requestParameters.UpdatePersonRequest).then((request) => request(this.axios, this.basePath));
|
|
963
963
|
}
|
|
964
964
|
}
|
|
@@ -139,6 +139,8 @@ export const toPathString = function (url) {
|
|
|
139
139
|
* @export
|
|
140
140
|
*/
|
|
141
141
|
export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
|
|
142
|
+
// Explicit return type + cast avoid inferring axios's internal AxiosResponseResult type,
|
|
143
|
+
// which references a module-private `unique symbol` and breaks `tsc --declaration` (TS2742).
|
|
142
144
|
return (axios = globalAxios, basePath = BASE_PATH) => {
|
|
143
145
|
const axiosRequestArgs = Object.assign(Object.assign({}, axiosArgs.options), { url: ((configuration === null || configuration === void 0 ? void 0 : configuration.basePath) || basePath) + axiosArgs.url });
|
|
144
146
|
return axios.request(axiosRequestArgs);
|
|
@@ -20,7 +20,7 @@ export interface AddOrganizationRequest {
|
|
|
20
20
|
* The name of the organization
|
|
21
21
|
* @type {string}
|
|
22
22
|
*/
|
|
23
|
-
'name'
|
|
23
|
+
'name': string;
|
|
24
24
|
/**
|
|
25
25
|
* The ID of the user who owns the organization
|
|
26
26
|
* @type {number}
|
|
@@ -32,11 +32,6 @@ export interface AddOrganizationRequest {
|
|
|
32
32
|
*/
|
|
33
33
|
'add_time'?: string;
|
|
34
34
|
/**
|
|
35
|
-
* The last updated date and time of the organization
|
|
36
|
-
* @type {string}
|
|
37
|
-
*/
|
|
38
|
-
'update_time'?: string;
|
|
39
|
-
/**
|
|
40
35
|
* The visibility of the organization
|
|
41
36
|
* @type {number}
|
|
42
37
|
*/
|
|
@@ -52,6 +47,31 @@ export interface AddOrganizationRequest {
|
|
|
52
47
|
*/
|
|
53
48
|
'address'?: OrganizationItemAddress;
|
|
54
49
|
/**
|
|
50
|
+
* The website of the organization
|
|
51
|
+
* @type {string}
|
|
52
|
+
*/
|
|
53
|
+
'website'?: string | null;
|
|
54
|
+
/**
|
|
55
|
+
* The LinkedIn profile URL of the organization
|
|
56
|
+
* @type {string}
|
|
57
|
+
*/
|
|
58
|
+
'linkedin'?: string | null;
|
|
59
|
+
/**
|
|
60
|
+
* The industry the organization belongs to
|
|
61
|
+
* @type {number}
|
|
62
|
+
*/
|
|
63
|
+
'industry'?: number | null;
|
|
64
|
+
/**
|
|
65
|
+
* The annual revenue of the organization
|
|
66
|
+
* @type {number}
|
|
67
|
+
*/
|
|
68
|
+
'annual_revenue'?: number | null;
|
|
69
|
+
/**
|
|
70
|
+
* The number of employees in the organization
|
|
71
|
+
* @type {number}
|
|
72
|
+
*/
|
|
73
|
+
'employee_count'?: number | null;
|
|
74
|
+
/**
|
|
55
75
|
* An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error.
|
|
56
76
|
* @type {{ [key: string]: any | undefined; }}
|
|
57
77
|
*/
|