Skip to content

Commit 494fdc1

Browse files
author
pipedrive-bot
committed
Build 336 - version-minor
1 parent 14ab3a2 commit 494fdc1

5 files changed

Lines changed: 62 additions & 15 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ The file format of it is based on [Keep a Changelog](http://keepachangelog.com/e
77
For public Changelog covering all changes done to Pipedrive’s API, webhooks and app extensions platforms, see [public Changelog](https://pipedrive.readme.io/docs/changelog) with discussion area in [Developers Community](https://devcommunity.pipedrive.com/c/documentation/changelog/19).
88

99
## [Unreleased]
10+
### Added
11+
- Added `include_body` query parameter to `GET /v1/deals/{id}/mailMessages`, `GET /v1/persons/{id}/mailMessages`, and `GET /v1/organizations/{id}/mailMessages` — pass `1` to include the mail message body content in the response
12+
- Added `body` field to `MailMessageData` schema to expose the mail message body content when `include_body=1` is used
1013

1114
## [33.4.3] - 2026-06-09
1215
### Fixed

‎src/versions/v1/api/deals-api.ts‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -693,10 +693,11 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration
693693
* @param {number} id The ID of the deal
694694
* @param {number} [start] Pagination start
695695
* @param {number} [limit] Items shown per page
696+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. `0` = Don\'t include, `1` = Include.
696697
697698
* @throws {RequiredError}
698699
*/
699-
getDealMailMessages: async (id: number, start?: number, limit?: number, ): Promise<RequestArgs> => {
700+
getDealMailMessages: async (id: number, start?: number, limit?: number, include_body?: 0 | 1, ): Promise<RequestArgs> => {
700701
// verify required parameter 'id' is not null or undefined
701702
assertParamExists('getDealMailMessages', 'id', id)
702703
const localVarPath = `/deals/{id}/mailMessages`
@@ -727,6 +728,10 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration
727728
localVarQueryParameter['limit'] = limit;
728729
}
729730

731+
if (include_body !== undefined) {
732+
localVarQueryParameter['include_body'] = include_body;
733+
}
734+
730735

731736

732737
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -1311,11 +1316,12 @@ export const DealsApiFp = function(configuration?: Configuration) {
13111316
* @param {number} id The ID of the deal
13121317
* @param {number} [start] Pagination start
13131318
* @param {number} [limit] Items shown per page
1319+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. &#x60;0&#x60; &#x3D; Don\&#39;t include, &#x60;1&#x60; &#x3D; Include.
13141320
13151321
* @throws {RequiredError}
13161322
*/
1317-
async getDealMailMessages(id: number, start?: number, limit?: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedMailMessagesResponse>> {
1318-
const localVarAxiosArgs = await localVarAxiosParamCreator.getDealMailMessages(id, start, limit, );
1323+
async getDealMailMessages(id: number, start?: number, limit?: number, include_body?: 0 | 1, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedMailMessagesResponse>> {
1324+
const localVarAxiosArgs = await localVarAxiosParamCreator.getDealMailMessages(id, start, limit, include_body, );
13191325
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
13201326
},
13211327
/**
@@ -1544,7 +1550,7 @@ export const DealsApiFactory = function (configuration?: Configuration, basePath
15441550
* @throws {RequiredError}
15451551
*/
15461552
getDealMailMessages(requestParameters: DealsApiGetDealMailMessagesRequest, ): Promise<GetAssociatedMailMessagesResponse> {
1547-
return localVarFp.getDealMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, ).then((request) => request(axios, basePath));
1553+
return localVarFp.getDealMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body, ).then((request) => request(axios, basePath));
15481554
},
15491555
/**
15501556
* 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.
@@ -2023,6 +2029,13 @@ export interface DealsApiGetDealMailMessagesRequest {
20232029
* @memberof DealsApiGetDealMailMessages
20242030
*/
20252031
readonly limit?: number
2032+
2033+
/**
2034+
* Whether to include the mail message body content in the response. &#x60;0&#x60; &#x3D; Don\&#39;t include, &#x60;1&#x60; &#x3D; Include.
2035+
* @type {0 | 1}
2036+
* @memberof DealsApiGetDealMailMessages
2037+
*/
2038+
readonly include_body?: 0 | 1
20262039
}
20272040

20282041
/**
@@ -2418,7 +2431,7 @@ export class DealsApi extends BaseAPI {
24182431
* @memberof DealsApi
24192432
*/
24202433
public getDealMailMessages(requestParameters: DealsApiGetDealMailMessagesRequest, ) {
2421-
return DealsApiFp(this.configuration).getDealMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, ).then((request) => request(this.axios, this.basePath));
2434+
return DealsApiFp(this.configuration).getDealMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body, ).then((request) => request(this.axios, this.basePath));
24222435
}
24232436

24242437
/**

‎src/versions/v1/api/organizations-api.ts‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -293,10 +293,11 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
293293
* @param {number} id The ID of the organization
294294
* @param {number} [start] Pagination start
295295
* @param {number} [limit] Items shown per page
296+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. &#x60;0&#x60; &#x3D; Don\&#39;t include, &#x60;1&#x60; &#x3D; Include.
296297
297298
* @throws {RequiredError}
298299
*/
299-
getOrganizationMailMessages: async (id: number, start?: number, limit?: number, ): Promise<RequestArgs> => {
300+
getOrganizationMailMessages: async (id: number, start?: number, limit?: number, include_body?: 0 | 1, ): Promise<RequestArgs> => {
300301
// verify required parameter 'id' is not null or undefined
301302
assertParamExists('getOrganizationMailMessages', 'id', id)
302303
const localVarPath = `/organizations/{id}/mailMessages`
@@ -327,6 +328,10 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
327328
localVarQueryParameter['limit'] = limit;
328329
}
329330

331+
if (include_body !== undefined) {
332+
localVarQueryParameter['include_body'] = include_body;
333+
}
334+
330335

331336

332337
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -564,11 +569,12 @@ export const OrganizationsApiFp = function(configuration?: Configuration) {
564569
* @param {number} id The ID of the organization
565570
* @param {number} [start] Pagination start
566571
* @param {number} [limit] Items shown per page
572+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. &#x60;0&#x60; &#x3D; Don\&#39;t include, &#x60;1&#x60; &#x3D; Include.
567573
568574
* @throws {RequiredError}
569575
*/
570-
async getOrganizationMailMessages(id: number, start?: number, limit?: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedMailMessagesResponse>> {
571-
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrganizationMailMessages(id, start, limit, );
576+
async getOrganizationMailMessages(id: number, start?: number, limit?: number, include_body?: 0 | 1, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedMailMessagesResponse>> {
577+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrganizationMailMessages(id, start, limit, include_body, );
572578
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
573579
},
574580
/**
@@ -677,7 +683,7 @@ export const OrganizationsApiFactory = function (configuration?: Configuration,
677683
* @throws {RequiredError}
678684
*/
679685
getOrganizationMailMessages(requestParameters: OrganizationsApiGetOrganizationMailMessagesRequest, ): Promise<GetAssociatedMailMessagesResponse> {
680-
return localVarFp.getOrganizationMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, ).then((request) => request(axios, basePath));
686+
return localVarFp.getOrganizationMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body, ).then((request) => request(axios, basePath));
681687
},
682688
/**
683689
* Lists updates about an organization.
@@ -857,6 +863,13 @@ export interface OrganizationsApiGetOrganizationMailMessagesRequest {
857863
* @memberof OrganizationsApiGetOrganizationMailMessages
858864
*/
859865
readonly limit?: number
866+
867+
/**
868+
* Whether to include the mail message body content in the response. &#x60;0&#x60; &#x3D; Don\&#39;t include, &#x60;1&#x60; &#x3D; Include.
869+
* @type {0 | 1}
870+
* @memberof OrganizationsApiGetOrganizationMailMessages
871+
*/
872+
readonly include_body?: 0 | 1
860873
}
861874

862875
/**
@@ -1012,7 +1025,7 @@ export class OrganizationsApi extends BaseAPI {
10121025
* @memberof OrganizationsApi
10131026
*/
10141027
public getOrganizationMailMessages(requestParameters: OrganizationsApiGetOrganizationMailMessagesRequest, ) {
1015-
return OrganizationsApiFp(this.configuration).getOrganizationMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, ).then((request) => request(this.axios, this.basePath));
1028+
return OrganizationsApiFp(this.configuration).getOrganizationMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body, ).then((request) => request(this.axios, this.basePath));
10161029
}
10171030

10181031
/**

‎src/versions/v1/api/persons-api.ts‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -410,10 +410,11 @@ export const PersonsApiAxiosParamCreator = function (configuration?: Configurati
410410
* @param {number} id The ID of the person
411411
* @param {number} [start] Pagination start
412412
* @param {number} [limit] Items shown per page
413+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. &#x60;0&#x60; &#x3D; Don\&#39;t include, &#x60;1&#x60; &#x3D; Include.
413414
414415
* @throws {RequiredError}
415416
*/
416-
getPersonMailMessages: async (id: number, start?: number, limit?: number, ): Promise<RequestArgs> => {
417+
getPersonMailMessages: async (id: number, start?: number, limit?: number, include_body?: 0 | 1, ): Promise<RequestArgs> => {
417418
// verify required parameter 'id' is not null or undefined
418419
assertParamExists('getPersonMailMessages', 'id', id)
419420
const localVarPath = `/persons/{id}/mailMessages`
@@ -444,6 +445,10 @@ export const PersonsApiAxiosParamCreator = function (configuration?: Configurati
444445
localVarQueryParameter['limit'] = limit;
445446
}
446447

448+
if (include_body !== undefined) {
449+
localVarQueryParameter['include_body'] = include_body;
450+
}
451+
447452

448453

449454
setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -759,11 +764,12 @@ export const PersonsApiFp = function(configuration?: Configuration) {
759764
* @param {number} id The ID of the person
760765
* @param {number} [start] Pagination start
761766
* @param {number} [limit] Items shown per page
767+
* @param {0 | 1} [include_body] Whether to include the mail message body content in the response. &#x60;0&#x60; &#x3D; Don\&#39;t include, &#x60;1&#x60; &#x3D; Include.
762768
763769
* @throws {RequiredError}
764770
*/
765-
async getPersonMailMessages(id: number, start?: number, limit?: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedMailMessagesResponse>> {
766-
const localVarAxiosArgs = await localVarAxiosParamCreator.getPersonMailMessages(id, start, limit, );
771+
async getPersonMailMessages(id: number, start?: number, limit?: number, include_body?: 0 | 1, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedMailMessagesResponse>> {
772+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPersonMailMessages(id, start, limit, include_body, );
767773
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
768774
},
769775
/**
@@ -905,7 +911,7 @@ export const PersonsApiFactory = function (configuration?: Configuration, basePa
905911
* @throws {RequiredError}
906912
*/
907913
getPersonMailMessages(requestParameters: PersonsApiGetPersonMailMessagesRequest, ): Promise<GetAssociatedMailMessagesResponse> {
908-
return localVarFp.getPersonMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, ).then((request) => request(axios, basePath));
914+
return localVarFp.getPersonMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body, ).then((request) => request(axios, basePath));
909915
},
910916
/**
911917
* Lists products associated with a person.
@@ -1158,6 +1164,13 @@ export interface PersonsApiGetPersonMailMessagesRequest {
11581164
* @memberof PersonsApiGetPersonMailMessages
11591165
*/
11601166
readonly limit?: number
1167+
1168+
/**
1169+
* Whether to include the mail message body content in the response. &#x60;0&#x60; &#x3D; Don\&#39;t include, &#x60;1&#x60; &#x3D; Include.
1170+
* @type {0 | 1}
1171+
* @memberof PersonsApiGetPersonMailMessages
1172+
*/
1173+
readonly include_body?: 0 | 1
11611174
}
11621175

11631176
/**
@@ -1365,7 +1378,7 @@ export class PersonsApi extends BaseAPI {
13651378
* @memberof PersonsApi
13661379
*/
13671380
public getPersonMailMessages(requestParameters: PersonsApiGetPersonMailMessagesRequest, ) {
1368-
return PersonsApiFp(this.configuration).getPersonMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, ).then((request) => request(this.axios, this.basePath));
1381+
return PersonsApiFp(this.configuration).getPersonMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, requestParameters.include_body, ).then((request) => request(this.axios, this.basePath));
13691382
}
13701383

13711384
/**

‎src/versions/v1/models/mail-message-data.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,11 @@ export interface MailMessageData {
5454
*/
5555
'body_url'?: string;
5656
/**
57+
* The mail message body content. Only present when `include_body=1` is passed.
58+
* @type {string}
59+
*/
60+
'body'?: string;
61+
/**
5762
* The connection account ID
5863
* @type {string}
5964
*/

0 commit comments

Comments
 (0)