pipedrive 33.4.2 → 33.5.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/models/mail-message-data.d.ts +5 -0
- package/dist/esm/versions/v2/models/add-deal-field-request-required-fields.d.ts +1 -1
- package/dist/esm/versions/v2/models/delete-deal-field200-response-data.d.ts +5 -5
- package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner-options-inner-id.d.ts +17 -0
- package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner-options-inner-id.js +14 -0
- package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner-options-inner.d.ts +4 -3
- package/dist/esm/versions/v2/models/get-deal-fields200-response-data-inner.d.ts +5 -5
- package/dist/esm/versions/v2/models/index.d.ts +1 -0
- package/dist/esm/versions/v2/models/index.js +1 -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/models/mail-message-data.d.ts +5 -0
- package/dist/versions/v2/models/add-deal-field-request-required-fields.d.ts +1 -1
- package/dist/versions/v2/models/delete-deal-field200-response-data.d.ts +5 -5
- package/dist/versions/v2/models/get-activity-fields200-response-data-inner-options-inner-id.d.ts +17 -0
- package/dist/versions/v2/models/get-activity-fields200-response-data-inner-options-inner-id.js +15 -0
- package/dist/versions/v2/models/get-activity-fields200-response-data-inner-options-inner.d.ts +4 -3
- package/dist/versions/v2/models/get-deal-fields200-response-data-inner.d.ts +5 -5
- package/dist/versions/v2/models/index.d.ts +1 -0
- package/dist/versions/v2/models/index.js +1 -0
- package/package.json +1 -1
|
@@ -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.
|
|
@@ -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
|
*/
|
|
@@ -27,7 +27,7 @@ export interface AddDealFieldRequestRequiredFields {
|
|
|
27
27
|
*/
|
|
28
28
|
'stage_ids'?: Array<number>;
|
|
29
29
|
/**
|
|
30
|
-
* Pipeline-specific status requirements for when deals are won or lost. Keys are pipeline IDs (as strings), values are arrays of status strings (\'won\', \'lost\'). Example - {\"1\":[\"won\",\"lost\"],\"2\":[\"won\"]} means the field is required when marking deals as won or lost in pipeline 1, and only when won in pipeline 2. Must reference valid, active pipelines.
|
|
30
|
+
* Pipeline-specific status requirements for when deals are won or lost. Keys are pipeline IDs (as strings), values are arrays of status strings (\'won\', \'lost\'). Example - `{\"1\":[\"won\",\"lost\"],\"2\":[\"won\"]}` means the field is required when marking deals as won or lost in pipeline 1, and only when won in pipeline 2. Must reference valid, active pipelines.
|
|
31
31
|
* @type {{ [key: string]: Array<string> | undefined; }}
|
|
32
32
|
*/
|
|
33
33
|
'statuses'?: {
|
|
@@ -26,11 +26,6 @@ export interface DeleteDealField200ResponseData {
|
|
|
26
26
|
*/
|
|
27
27
|
'field_code': string;
|
|
28
28
|
/**
|
|
29
|
-
* The description of the field
|
|
30
|
-
* @type {string}
|
|
31
|
-
*/
|
|
32
|
-
'description': string;
|
|
33
|
-
/**
|
|
34
29
|
* The type of the field
|
|
35
30
|
* @type {string}
|
|
36
31
|
*/
|
|
@@ -46,6 +41,11 @@ export interface DeleteDealField200ResponseData {
|
|
|
46
41
|
*/
|
|
47
42
|
'is_optional_response_field': boolean;
|
|
48
43
|
/**
|
|
44
|
+
* The description of the field
|
|
45
|
+
* @type {string}
|
|
46
|
+
*/
|
|
47
|
+
'description'?: string;
|
|
48
|
+
/**
|
|
49
49
|
* Array of available options for enum/set fields, null for other field types
|
|
50
50
|
* @type {Array<object>}
|
|
51
51
|
*/
|
package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner-options-inner-id.d.ts
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Pipedrive API v2
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.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
|
+
/**
|
|
13
|
+
* @type GetActivityFields200ResponseDataInnerOptionsInnerId
|
|
14
|
+
* The option ID (integer for custom fields, string for built-in fields)
|
|
15
|
+
* @export
|
|
16
|
+
*/
|
|
17
|
+
export type GetActivityFields200ResponseDataInnerOptionsInnerId = number | string;
|
package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner-options-inner-id.js
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Pipedrive API v2
|
|
5
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.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
|
+
export {};
|
package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner-options-inner.d.ts
CHANGED
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import { GetActivityFields200ResponseDataInnerOptionsInnerId } from './get-activity-fields200-response-data-inner-options-inner-id';
|
|
12
13
|
/**
|
|
13
14
|
*
|
|
14
15
|
* @export
|
|
@@ -16,10 +17,10 @@
|
|
|
16
17
|
*/
|
|
17
18
|
export interface GetActivityFields200ResponseDataInnerOptionsInner {
|
|
18
19
|
/**
|
|
19
|
-
*
|
|
20
|
-
* @type {
|
|
20
|
+
*
|
|
21
|
+
* @type {GetActivityFields200ResponseDataInnerOptionsInnerId}
|
|
21
22
|
*/
|
|
22
|
-
'id'?:
|
|
23
|
+
'id'?: GetActivityFields200ResponseDataInnerOptionsInnerId;
|
|
23
24
|
/**
|
|
24
25
|
* The option display label
|
|
25
26
|
* @type {string}
|
|
@@ -31,11 +31,6 @@ export interface GetDealFields200ResponseDataInner {
|
|
|
31
31
|
*/
|
|
32
32
|
'field_code': string;
|
|
33
33
|
/**
|
|
34
|
-
* The description of the field
|
|
35
|
-
* @type {string}
|
|
36
|
-
*/
|
|
37
|
-
'description': string;
|
|
38
|
-
/**
|
|
39
34
|
* The type of the field
|
|
40
35
|
* @type {string}
|
|
41
36
|
*/
|
|
@@ -51,6 +46,11 @@ export interface GetDealFields200ResponseDataInner {
|
|
|
51
46
|
*/
|
|
52
47
|
'is_optional_response_field': boolean;
|
|
53
48
|
/**
|
|
49
|
+
* The description of the field
|
|
50
|
+
* @type {string}
|
|
51
|
+
*/
|
|
52
|
+
'description'?: string;
|
|
53
|
+
/**
|
|
54
54
|
* Array of available options for enum/set fields, null for other field types
|
|
55
55
|
* @type {Array<GetActivityFields200ResponseDataInnerOptionsInner>}
|
|
56
56
|
*/
|
|
@@ -125,6 +125,7 @@ export * from './get-activity-fields200-response';
|
|
|
125
125
|
export * from './get-activity-fields200-response-additional-data';
|
|
126
126
|
export * from './get-activity-fields200-response-data-inner';
|
|
127
127
|
export * from './get-activity-fields200-response-data-inner-options-inner';
|
|
128
|
+
export * from './get-activity-fields200-response-data-inner-options-inner-id';
|
|
128
129
|
export * from './get-activity-fields200-response-data-inner-subfields-inner';
|
|
129
130
|
export * from './get-activity-fields200-response-data-inner-ui-visibility';
|
|
130
131
|
export * from './get-additional-discounts-response';
|
|
@@ -125,6 +125,7 @@ export * from './get-activity-fields200-response';
|
|
|
125
125
|
export * from './get-activity-fields200-response-additional-data';
|
|
126
126
|
export * from './get-activity-fields200-response-data-inner';
|
|
127
127
|
export * from './get-activity-fields200-response-data-inner-options-inner';
|
|
128
|
+
export * from './get-activity-fields200-response-data-inner-options-inner-id';
|
|
128
129
|
export * from './get-activity-fields200-response-data-inner-subfields-inner';
|
|
129
130
|
export * from './get-activity-fields200-response-data-inner-ui-visibility';
|
|
130
131
|
export * from './get-additional-discounts-response';
|
|
@@ -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.
|
|
@@ -554,10 +554,11 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
554
554
|
* @param {number} id The ID of the deal
|
|
555
555
|
* @param {number} [start] Pagination start
|
|
556
556
|
* @param {number} [limit] Items shown per page
|
|
557
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
557
558
|
|
|
558
559
|
* @throws {RequiredError}
|
|
559
560
|
*/
|
|
560
|
-
getDealMailMessages: (id, start, limit) => __awaiter(this, void 0, void 0, function* () {
|
|
561
|
+
getDealMailMessages: (id, start, limit, include_body) => __awaiter(this, void 0, void 0, function* () {
|
|
561
562
|
// verify required parameter 'id' is not null or undefined
|
|
562
563
|
(0, common_1.assertParamExists)('getDealMailMessages', 'id', id);
|
|
563
564
|
const localVarPath = `/deals/{id}/mailMessages`
|
|
@@ -582,6 +583,9 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
582
583
|
if (limit !== undefined) {
|
|
583
584
|
localVarQueryParameter['limit'] = limit;
|
|
584
585
|
}
|
|
586
|
+
if (include_body !== undefined) {
|
|
587
|
+
localVarQueryParameter['include_body'] = include_body;
|
|
588
|
+
}
|
|
585
589
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
586
590
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
587
591
|
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
@@ -1112,12 +1116,13 @@ const DealsApiFp = function (configuration) {
|
|
|
1112
1116
|
* @param {number} id The ID of the deal
|
|
1113
1117
|
* @param {number} [start] Pagination start
|
|
1114
1118
|
* @param {number} [limit] Items shown per page
|
|
1119
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
1115
1120
|
|
|
1116
1121
|
* @throws {RequiredError}
|
|
1117
1122
|
*/
|
|
1118
|
-
getDealMailMessages(id, start, limit) {
|
|
1123
|
+
getDealMailMessages(id, start, limit, include_body) {
|
|
1119
1124
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1120
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealMailMessages(id, start, limit);
|
|
1125
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealMailMessages(id, start, limit, include_body);
|
|
1121
1126
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1122
1127
|
});
|
|
1123
1128
|
},
|
|
@@ -1361,7 +1366,7 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
|
1361
1366
|
* @throws {RequiredError}
|
|
1362
1367
|
*/
|
|
1363
1368
|
getDealMailMessages(requestParameters) {
|
|
1364
|
-
return localVarFp.getDealMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
|
|
1369
|
+
return localVarFp.getDealMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body).then((request) => request(axios, basePath));
|
|
1365
1370
|
},
|
|
1366
1371
|
/**
|
|
1367
1372
|
* 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.
|
|
@@ -1573,7 +1578,7 @@ class DealsApi extends base_1.BaseAPI {
|
|
|
1573
1578
|
* @memberof DealsApi
|
|
1574
1579
|
*/
|
|
1575
1580
|
getDealMailMessages(requestParameters) {
|
|
1576
|
-
return (0, exports.DealsApiFp)(this.configuration).getDealMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
1581
|
+
return (0, exports.DealsApiFp)(this.configuration).getDealMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body).then((request) => request(this.axios, this.basePath));
|
|
1577
1582
|
}
|
|
1578
1583
|
/**
|
|
1579
1584
|
* 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.
|
|
@@ -241,10 +241,11 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
241
241
|
* @param {number} id The ID of the organization
|
|
242
242
|
* @param {number} [start] Pagination start
|
|
243
243
|
* @param {number} [limit] Items shown per page
|
|
244
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
244
245
|
|
|
245
246
|
* @throws {RequiredError}
|
|
246
247
|
*/
|
|
247
|
-
getOrganizationMailMessages: (id, start, limit) => __awaiter(this, void 0, void 0, function* () {
|
|
248
|
+
getOrganizationMailMessages: (id, start, limit, include_body) => __awaiter(this, void 0, void 0, function* () {
|
|
248
249
|
// verify required parameter 'id' is not null or undefined
|
|
249
250
|
(0, common_1.assertParamExists)('getOrganizationMailMessages', 'id', id);
|
|
250
251
|
const localVarPath = `/organizations/{id}/mailMessages`
|
|
@@ -269,6 +270,9 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
269
270
|
if (limit !== undefined) {
|
|
270
271
|
localVarQueryParameter['limit'] = limit;
|
|
271
272
|
}
|
|
273
|
+
if (include_body !== undefined) {
|
|
274
|
+
localVarQueryParameter['include_body'] = include_body;
|
|
275
|
+
}
|
|
272
276
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
273
277
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
274
278
|
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
@@ -486,12 +490,13 @@ const OrganizationsApiFp = function (configuration) {
|
|
|
486
490
|
* @param {number} id The ID of the organization
|
|
487
491
|
* @param {number} [start] Pagination start
|
|
488
492
|
* @param {number} [limit] Items shown per page
|
|
493
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
489
494
|
|
|
490
495
|
* @throws {RequiredError}
|
|
491
496
|
*/
|
|
492
|
-
getOrganizationMailMessages(id, start, limit) {
|
|
497
|
+
getOrganizationMailMessages(id, start, limit, include_body) {
|
|
493
498
|
return __awaiter(this, void 0, void 0, function* () {
|
|
494
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganizationMailMessages(id, start, limit);
|
|
499
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganizationMailMessages(id, start, limit, include_body);
|
|
495
500
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
496
501
|
});
|
|
497
502
|
},
|
|
@@ -607,7 +612,7 @@ const OrganizationsApiFactory = function (configuration, basePath, axios) {
|
|
|
607
612
|
* @throws {RequiredError}
|
|
608
613
|
*/
|
|
609
614
|
getOrganizationMailMessages(requestParameters) {
|
|
610
|
-
return localVarFp.getOrganizationMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
|
|
615
|
+
return localVarFp.getOrganizationMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body).then((request) => request(axios, basePath));
|
|
611
616
|
},
|
|
612
617
|
/**
|
|
613
618
|
* Lists updates about an organization.
|
|
@@ -713,7 +718,7 @@ class OrganizationsApi extends base_1.BaseAPI {
|
|
|
713
718
|
* @memberof OrganizationsApi
|
|
714
719
|
*/
|
|
715
720
|
getOrganizationMailMessages(requestParameters) {
|
|
716
|
-
return (0, exports.OrganizationsApiFp)(this.configuration).getOrganizationMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
721
|
+
return (0, exports.OrganizationsApiFp)(this.configuration).getOrganizationMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body).then((request) => request(this.axios, this.basePath));
|
|
717
722
|
}
|
|
718
723
|
/**
|
|
719
724
|
* 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.
|
|
@@ -334,10 +334,11 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
334
334
|
* @param {number} id The ID of the person
|
|
335
335
|
* @param {number} [start] Pagination start
|
|
336
336
|
* @param {number} [limit] Items shown per page
|
|
337
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
337
338
|
|
|
338
339
|
* @throws {RequiredError}
|
|
339
340
|
*/
|
|
340
|
-
getPersonMailMessages: (id, start, limit) => __awaiter(this, void 0, void 0, function* () {
|
|
341
|
+
getPersonMailMessages: (id, start, limit, include_body) => __awaiter(this, void 0, void 0, function* () {
|
|
341
342
|
// verify required parameter 'id' is not null or undefined
|
|
342
343
|
(0, common_1.assertParamExists)('getPersonMailMessages', 'id', id);
|
|
343
344
|
const localVarPath = `/persons/{id}/mailMessages`
|
|
@@ -362,6 +363,9 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
362
363
|
if (limit !== undefined) {
|
|
363
364
|
localVarQueryParameter['limit'] = limit;
|
|
364
365
|
}
|
|
366
|
+
if (include_body !== undefined) {
|
|
367
|
+
localVarQueryParameter['include_body'] = include_body;
|
|
368
|
+
}
|
|
365
369
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
366
370
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
367
371
|
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
|
@@ -652,12 +656,13 @@ const PersonsApiFp = function (configuration) {
|
|
|
652
656
|
* @param {number} id The ID of the person
|
|
653
657
|
* @param {number} [start] Pagination start
|
|
654
658
|
* @param {number} [limit] Items shown per page
|
|
659
|
+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
|
|
655
660
|
|
|
656
661
|
* @throws {RequiredError}
|
|
657
662
|
*/
|
|
658
|
-
getPersonMailMessages(id, start, limit) {
|
|
663
|
+
getPersonMailMessages(id, start, limit, include_body) {
|
|
659
664
|
return __awaiter(this, void 0, void 0, function* () {
|
|
660
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersonMailMessages(id, start, limit);
|
|
665
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersonMailMessages(id, start, limit, include_body);
|
|
661
666
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
662
667
|
});
|
|
663
668
|
},
|
|
@@ -808,7 +813,7 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
808
813
|
* @throws {RequiredError}
|
|
809
814
|
*/
|
|
810
815
|
getPersonMailMessages(requestParameters) {
|
|
811
|
-
return localVarFp.getPersonMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
|
|
816
|
+
return localVarFp.getPersonMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body).then((request) => request(axios, basePath));
|
|
812
817
|
},
|
|
813
818
|
/**
|
|
814
819
|
* Lists products associated with a person.
|
|
@@ -946,7 +951,7 @@ class PersonsApi extends base_1.BaseAPI {
|
|
|
946
951
|
* @memberof PersonsApi
|
|
947
952
|
*/
|
|
948
953
|
getPersonMailMessages(requestParameters) {
|
|
949
|
-
return (0, exports.PersonsApiFp)(this.configuration).getPersonMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
|
954
|
+
return (0, exports.PersonsApiFp)(this.configuration).getPersonMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body).then((request) => request(this.axios, this.basePath));
|
|
950
955
|
}
|
|
951
956
|
/**
|
|
952
957
|
* Lists products associated with a person.
|
|
@@ -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
|
*/
|
|
@@ -27,7 +27,7 @@ export interface AddDealFieldRequestRequiredFields {
|
|
|
27
27
|
*/
|
|
28
28
|
'stage_ids'?: Array<number>;
|
|
29
29
|
/**
|
|
30
|
-
* Pipeline-specific status requirements for when deals are won or lost. Keys are pipeline IDs (as strings), values are arrays of status strings (\'won\', \'lost\'). Example - {\"1\":[\"won\",\"lost\"],\"2\":[\"won\"]} means the field is required when marking deals as won or lost in pipeline 1, and only when won in pipeline 2. Must reference valid, active pipelines.
|
|
30
|
+
* Pipeline-specific status requirements for when deals are won or lost. Keys are pipeline IDs (as strings), values are arrays of status strings (\'won\', \'lost\'). Example - `{\"1\":[\"won\",\"lost\"],\"2\":[\"won\"]}` means the field is required when marking deals as won or lost in pipeline 1, and only when won in pipeline 2. Must reference valid, active pipelines.
|
|
31
31
|
* @type {{ [key: string]: Array<string> | undefined; }}
|
|
32
32
|
*/
|
|
33
33
|
'statuses'?: {
|
|
@@ -26,11 +26,6 @@ export interface DeleteDealField200ResponseData {
|
|
|
26
26
|
*/
|
|
27
27
|
'field_code': string;
|
|
28
28
|
/**
|
|
29
|
-
* The description of the field
|
|
30
|
-
* @type {string}
|
|
31
|
-
*/
|
|
32
|
-
'description': string;
|
|
33
|
-
/**
|
|
34
29
|
* The type of the field
|
|
35
30
|
* @type {string}
|
|
36
31
|
*/
|
|
@@ -46,6 +41,11 @@ export interface DeleteDealField200ResponseData {
|
|
|
46
41
|
*/
|
|
47
42
|
'is_optional_response_field': boolean;
|
|
48
43
|
/**
|
|
44
|
+
* The description of the field
|
|
45
|
+
* @type {string}
|
|
46
|
+
*/
|
|
47
|
+
'description'?: string;
|
|
48
|
+
/**
|
|
49
49
|
* Array of available options for enum/set fields, null for other field types
|
|
50
50
|
* @type {Array<object>}
|
|
51
51
|
*/
|
package/dist/versions/v2/models/get-activity-fields200-response-data-inner-options-inner-id.d.ts
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Pipedrive API v2
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.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
|
+
/**
|
|
13
|
+
* @type GetActivityFields200ResponseDataInnerOptionsInnerId
|
|
14
|
+
* The option ID (integer for custom fields, string for built-in fields)
|
|
15
|
+
* @export
|
|
16
|
+
*/
|
|
17
|
+
export type GetActivityFields200ResponseDataInnerOptionsInnerId = number | string;
|
package/dist/versions/v2/models/get-activity-fields200-response-data-inner-options-inner-id.js
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Pipedrive API v2
|
|
6
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2.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
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
package/dist/versions/v2/models/get-activity-fields200-response-data-inner-options-inner.d.ts
CHANGED
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import { GetActivityFields200ResponseDataInnerOptionsInnerId } from './get-activity-fields200-response-data-inner-options-inner-id';
|
|
12
13
|
/**
|
|
13
14
|
*
|
|
14
15
|
* @export
|
|
@@ -16,10 +17,10 @@
|
|
|
16
17
|
*/
|
|
17
18
|
export interface GetActivityFields200ResponseDataInnerOptionsInner {
|
|
18
19
|
/**
|
|
19
|
-
*
|
|
20
|
-
* @type {
|
|
20
|
+
*
|
|
21
|
+
* @type {GetActivityFields200ResponseDataInnerOptionsInnerId}
|
|
21
22
|
*/
|
|
22
|
-
'id'?:
|
|
23
|
+
'id'?: GetActivityFields200ResponseDataInnerOptionsInnerId;
|
|
23
24
|
/**
|
|
24
25
|
* The option display label
|
|
25
26
|
* @type {string}
|
|
@@ -31,11 +31,6 @@ export interface GetDealFields200ResponseDataInner {
|
|
|
31
31
|
*/
|
|
32
32
|
'field_code': string;
|
|
33
33
|
/**
|
|
34
|
-
* The description of the field
|
|
35
|
-
* @type {string}
|
|
36
|
-
*/
|
|
37
|
-
'description': string;
|
|
38
|
-
/**
|
|
39
34
|
* The type of the field
|
|
40
35
|
* @type {string}
|
|
41
36
|
*/
|
|
@@ -51,6 +46,11 @@ export interface GetDealFields200ResponseDataInner {
|
|
|
51
46
|
*/
|
|
52
47
|
'is_optional_response_field': boolean;
|
|
53
48
|
/**
|
|
49
|
+
* The description of the field
|
|
50
|
+
* @type {string}
|
|
51
|
+
*/
|
|
52
|
+
'description'?: string;
|
|
53
|
+
/**
|
|
54
54
|
* Array of available options for enum/set fields, null for other field types
|
|
55
55
|
* @type {Array<GetActivityFields200ResponseDataInnerOptionsInner>}
|
|
56
56
|
*/
|
|
@@ -125,6 +125,7 @@ export * from './get-activity-fields200-response';
|
|
|
125
125
|
export * from './get-activity-fields200-response-additional-data';
|
|
126
126
|
export * from './get-activity-fields200-response-data-inner';
|
|
127
127
|
export * from './get-activity-fields200-response-data-inner-options-inner';
|
|
128
|
+
export * from './get-activity-fields200-response-data-inner-options-inner-id';
|
|
128
129
|
export * from './get-activity-fields200-response-data-inner-subfields-inner';
|
|
129
130
|
export * from './get-activity-fields200-response-data-inner-ui-visibility';
|
|
130
131
|
export * from './get-additional-discounts-response';
|
|
@@ -141,6 +141,7 @@ __exportStar(require("./get-activity-fields200-response"), exports);
|
|
|
141
141
|
__exportStar(require("./get-activity-fields200-response-additional-data"), exports);
|
|
142
142
|
__exportStar(require("./get-activity-fields200-response-data-inner"), exports);
|
|
143
143
|
__exportStar(require("./get-activity-fields200-response-data-inner-options-inner"), exports);
|
|
144
|
+
__exportStar(require("./get-activity-fields200-response-data-inner-options-inner-id"), exports);
|
|
144
145
|
__exportStar(require("./get-activity-fields200-response-data-inner-subfields-inner"), exports);
|
|
145
146
|
__exportStar(require("./get-activity-fields200-response-data-inner-ui-visibility"), exports);
|
|
146
147
|
__exportStar(require("./get-additional-discounts-response"), exports);
|