pipedrive 22.3.1-rc.2 → 22.3.1-rc.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (175) hide show
  1. package/CHANGELOG.md +17 -4
  2. package/README.md +29 -24
  3. package/api/activities-api.ts +1 -24
  4. package/api/activity-fields-api.ts +1 -24
  5. package/api/activity-types-api.ts +1 -21
  6. package/api/billing-api.ts +1 -24
  7. package/api/call-logs-api.ts +1 -24
  8. package/api/channels-api.ts +1 -24
  9. package/api/currencies-api.ts +1 -24
  10. package/api/deal-fields-api.ts +1 -24
  11. package/api/deals-api.ts +1 -24
  12. package/api/files-api.ts +1 -24
  13. package/api/filters-api.ts +1 -24
  14. package/api/goals-api.ts +1 -24
  15. package/api/item-search-api.ts +1 -24
  16. package/api/lead-labels-api.ts +1 -21
  17. package/api/lead-sources-api.ts +1 -24
  18. package/api/leads-api.ts +1 -24
  19. package/api/legacy-teams-api.ts +1 -24
  20. package/api/mailbox-api.ts +1 -24
  21. package/api/note-fields-api.ts +1 -24
  22. package/api/notes-api.ts +1 -21
  23. package/api/organization-fields-api.ts +1 -24
  24. package/api/organization-relationships-api.ts +1 -24
  25. package/api/organizations-api.ts +1 -24
  26. package/api/permission-sets-api.ts +1 -24
  27. package/api/person-fields-api.ts +1 -21
  28. package/api/persons-api.ts +1 -24
  29. package/api/pipelines-api.ts +1 -24
  30. package/api/product-fields-api.ts +1 -24
  31. package/api/products-api.ts +1 -24
  32. package/api/project-templates-api.ts +1 -24
  33. package/api/projects-api.ts +1 -24
  34. package/api/recents-api.ts +1 -24
  35. package/api/roles-api.ts +1 -24
  36. package/api/stages-api.ts +1 -24
  37. package/api/subscriptions-api.ts +1 -24
  38. package/api/tasks-api.ts +1 -24
  39. package/api/user-connections-api.ts +1 -24
  40. package/api/user-settings-api.ts +1 -24
  41. package/api/users-api.ts +1 -24
  42. package/api/webhooks-api.ts +1 -21
  43. package/base.ts +31 -0
  44. package/common.ts +0 -1
  45. package/configuration.ts +11 -2
  46. package/dist/api/activities-api.js +7 -30
  47. package/dist/api/activity-fields-api.js +1 -24
  48. package/dist/api/activity-types-api.js +0 -20
  49. package/dist/api/billing-api.js +1 -24
  50. package/dist/api/call-logs-api.js +5 -28
  51. package/dist/api/channels-api.js +4 -27
  52. package/dist/api/currencies-api.js +1 -24
  53. package/dist/api/deal-fields-api.js +6 -29
  54. package/dist/api/deals-api.js +28 -51
  55. package/dist/api/files-api.js +11 -34
  56. package/dist/api/filters-api.js +7 -30
  57. package/dist/api/goals-api.js +5 -28
  58. package/dist/api/item-search-api.js +2 -25
  59. package/dist/api/lead-labels-api.js +0 -20
  60. package/dist/api/lead-sources-api.js +1 -24
  61. package/dist/api/leads-api.js +7 -30
  62. package/dist/api/legacy-teams-api.js +8 -31
  63. package/dist/api/mailbox-api.js +7 -30
  64. package/dist/api/note-fields-api.js +1 -24
  65. package/dist/api/notes-api.js +0 -20
  66. package/dist/api/organization-fields-api.js +6 -29
  67. package/dist/api/organization-relationships-api.js +5 -28
  68. package/dist/api/organizations-api.js +19 -42
  69. package/dist/api/permission-sets-api.js +3 -26
  70. package/dist/api/person-fields-api.js +0 -20
  71. package/dist/api/persons-api.js +21 -44
  72. package/dist/api/pipelines-api.js +8 -31
  73. package/dist/api/product-fields-api.js +6 -29
  74. package/dist/api/products-api.js +12 -35
  75. package/dist/api/project-templates-api.js +4 -27
  76. package/dist/api/projects-api.js +14 -37
  77. package/dist/api/recents-api.js +1 -24
  78. package/dist/api/roles-api.js +12 -35
  79. package/dist/api/stages-api.js +7 -30
  80. package/dist/api/subscriptions-api.js +9 -32
  81. package/dist/api/tasks-api.js +5 -28
  82. package/dist/api/user-connections-api.js +1 -24
  83. package/dist/api/user-settings-api.js +1 -24
  84. package/dist/api/users-api.js +10 -33
  85. package/dist/api/webhooks-api.js +0 -20
  86. package/dist/base.js +26 -0
  87. package/dist/common.d.ts +0 -1
  88. package/dist/common.js +1 -2
  89. package/dist/configuration.d.ts +1 -0
  90. package/dist/configuration.js +8 -2
  91. package/dist/esm/api/activities-api.js +0 -23
  92. package/dist/esm/api/activity-fields-api.js +0 -23
  93. package/dist/esm/api/activity-types-api.js +0 -20
  94. package/dist/esm/api/billing-api.js +0 -23
  95. package/dist/esm/api/call-logs-api.js +0 -23
  96. package/dist/esm/api/channels-api.js +0 -23
  97. package/dist/esm/api/currencies-api.js +0 -23
  98. package/dist/esm/api/deal-fields-api.js +0 -23
  99. package/dist/esm/api/deals-api.js +0 -23
  100. package/dist/esm/api/files-api.js +0 -23
  101. package/dist/esm/api/filters-api.js +0 -23
  102. package/dist/esm/api/goals-api.js +0 -23
  103. package/dist/esm/api/item-search-api.js +0 -23
  104. package/dist/esm/api/lead-labels-api.js +0 -20
  105. package/dist/esm/api/lead-sources-api.js +0 -23
  106. package/dist/esm/api/leads-api.js +0 -23
  107. package/dist/esm/api/legacy-teams-api.js +0 -23
  108. package/dist/esm/api/mailbox-api.js +0 -23
  109. package/dist/esm/api/note-fields-api.js +0 -23
  110. package/dist/esm/api/notes-api.js +0 -20
  111. package/dist/esm/api/organization-fields-api.js +0 -23
  112. package/dist/esm/api/organization-relationships-api.js +0 -23
  113. package/dist/esm/api/organizations-api.js +0 -23
  114. package/dist/esm/api/permission-sets-api.js +0 -23
  115. package/dist/esm/api/person-fields-api.js +0 -20
  116. package/dist/esm/api/persons-api.js +0 -23
  117. package/dist/esm/api/pipelines-api.js +0 -23
  118. package/dist/esm/api/product-fields-api.js +0 -23
  119. package/dist/esm/api/products-api.js +0 -23
  120. package/dist/esm/api/project-templates-api.js +0 -23
  121. package/dist/esm/api/projects-api.js +0 -23
  122. package/dist/esm/api/recents-api.js +0 -23
  123. package/dist/esm/api/roles-api.js +0 -23
  124. package/dist/esm/api/stages-api.js +0 -23
  125. package/dist/esm/api/subscriptions-api.js +0 -23
  126. package/dist/esm/api/tasks-api.js +0 -23
  127. package/dist/esm/api/user-connections-api.js +0 -23
  128. package/dist/esm/api/user-settings-api.js +0 -23
  129. package/dist/esm/api/users-api.js +0 -23
  130. package/dist/esm/api/webhooks-api.js +0 -20
  131. package/dist/esm/base.js +26 -0
  132. package/dist/esm/common.d.ts +0 -1
  133. package/dist/esm/common.js +0 -1
  134. package/dist/esm/configuration.d.ts +1 -0
  135. package/dist/esm/configuration.js +8 -2
  136. package/docs/AddWebhookRequest.md +1 -1
  137. package/docs/BasicDeal.md +3 -0
  138. package/docs/CallLogObject.md +2 -1
  139. package/docs/DealParticipantsChangelog.md +12 -0
  140. package/docs/DealsApi.md +74 -8
  141. package/docs/FiltersApi.md +4 -1
  142. package/docs/GetDeal.md +1 -1
  143. package/docs/GetDealRelatedObjects.md +11 -0
  144. package/docs/GetDealsRelatedObjects.md +3 -3
  145. package/docs/ItemSearchApi.md +2 -2
  146. package/docs/LeadsApi.md +4 -1
  147. package/docs/MailboxApi.md +2 -2
  148. package/docs/MeetingsApi.md +118 -0
  149. package/docs/NewDeal.md +3 -0
  150. package/docs/OrganizationsApi.md +10 -4
  151. package/docs/ParticipantsChangelog.md +11 -0
  152. package/docs/ParticipantsChangelogItem.md +12 -0
  153. package/docs/PersonsApi.md +14 -5
  154. package/docs/PostDealParticipants.md +1 -1
  155. package/docs/PostDealParticipantsRelatedObjects.md +10 -0
  156. package/docs/ProductsApi.md +2 -2
  157. package/docs/RecentsApi.md +2 -2
  158. package/docs/ResponseCallLogObject.md +2 -1
  159. package/docs/UpdateDealRequest.md +3 -0
  160. package/docs/UserProviderLinkCreateRequest.md +12 -0
  161. package/docs/UserProviderLinkErrorResponse.md +10 -0
  162. package/docs/UserProviderLinkSuccessResponse.md +10 -0
  163. package/docs/UserProviderLinkSuccessResponseData.md +9 -0
  164. package/docs/UsersApi.md +2 -2
  165. package/migration.md +309 -0
  166. package/package.json +3 -3
  167. package/src/api/MeetingsApi.js +181 -0
  168. package/src/model/GetDealRelatedObjects.js +101 -0
  169. package/src/model/PostDealParticipantsRelatedObjects.js +90 -0
  170. package/src/model/UserProviderLinkCreateRequest.js +120 -0
  171. package/src/model/UserProviderLinkErrorResponse.js +90 -0
  172. package/src/model/UserProviderLinkSuccessResponse.js +90 -0
  173. package/src/model/UserProviderLinkSuccessResponseData.js +79 -0
  174. package/test/functional/access-token.test.js +5 -5
  175. package/test/functional/authorisation.test.js +5 -8
@@ -21,9 +21,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import globalAxios from 'axios';
24
- // URLSearchParams not necessarily used
25
- // @ts-ignore
26
- import { URL } from 'url';
27
24
  // Some imports not used depending on template conditions
28
25
  // @ts-ignore
29
26
  import { DUMMY_BASE_URL, setApiKeyToObject, setOAuthToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
@@ -72,26 +69,6 @@ export const UserConnectionsApiAxiosParamCreator = function (configuration) {
72
69
  * @export
73
70
  */
74
71
  export const UserConnectionsApiFp = function (configuration) {
75
- /**
76
- * Axios interceptor to add the SDK version as a User-Agent header
77
- * */
78
- globalAxios.interceptors.request.use(function (config) {
79
- const version = require("../../package.json").version;
80
- config.headers['User-Agent'] = `Pipedrive-SDK-Javascript-${version}`;
81
- return config;
82
- });
83
- /**
84
- * Axios response interceptor to modify response structure
85
- */
86
- globalAxios.interceptors.response.use(function (response) {
87
- return response.hasOwnProperty('success') ? response : response.data;
88
- }, function (error) {
89
- var _a;
90
- if ((_a = error === null || error === void 0 ? void 0 : error.response) === null || _a === void 0 ? void 0 : _a.data) {
91
- return Promise.reject(error.response.data);
92
- }
93
- return Promise.reject(error);
94
- });
95
72
  const localVarAxiosParamCreator = UserConnectionsApiAxiosParamCreator(configuration);
96
73
  return {
97
74
  /**
@@ -21,9 +21,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import globalAxios from 'axios';
24
- // URLSearchParams not necessarily used
25
- // @ts-ignore
26
- import { URL } from 'url';
27
24
  // Some imports not used depending on template conditions
28
25
  // @ts-ignore
29
26
  import { DUMMY_BASE_URL, setApiKeyToObject, setOAuthToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
@@ -72,26 +69,6 @@ export const UserSettingsApiAxiosParamCreator = function (configuration) {
72
69
  * @export
73
70
  */
74
71
  export const UserSettingsApiFp = function (configuration) {
75
- /**
76
- * Axios interceptor to add the SDK version as a User-Agent header
77
- * */
78
- globalAxios.interceptors.request.use(function (config) {
79
- const version = require("../../package.json").version;
80
- config.headers['User-Agent'] = `Pipedrive-SDK-Javascript-${version}`;
81
- return config;
82
- });
83
- /**
84
- * Axios response interceptor to modify response structure
85
- */
86
- globalAxios.interceptors.response.use(function (response) {
87
- return response.hasOwnProperty('success') ? response : response.data;
88
- }, function (error) {
89
- var _a;
90
- if ((_a = error === null || error === void 0 ? void 0 : error.response) === null || _a === void 0 ? void 0 : _a.data) {
91
- return Promise.reject(error.response.data);
92
- }
93
- return Promise.reject(error);
94
- });
95
72
  const localVarAxiosParamCreator = UserSettingsApiAxiosParamCreator(configuration);
96
73
  return {
97
74
  /**
@@ -21,9 +21,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import globalAxios from 'axios';
24
- // URLSearchParams not necessarily used
25
- // @ts-ignore
26
- import { URL } from 'url';
27
24
  // Some imports not used depending on template conditions
28
25
  // @ts-ignore
29
26
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
@@ -390,26 +387,6 @@ export const UsersApiAxiosParamCreator = function (configuration) {
390
387
  * @export
391
388
  */
392
389
  export const UsersApiFp = function (configuration) {
393
- /**
394
- * Axios interceptor to add the SDK version as a User-Agent header
395
- * */
396
- globalAxios.interceptors.request.use(function (config) {
397
- const version = require("../../package.json").version;
398
- config.headers['User-Agent'] = `Pipedrive-SDK-Javascript-${version}`;
399
- return config;
400
- });
401
- /**
402
- * Axios response interceptor to modify response structure
403
- */
404
- globalAxios.interceptors.response.use(function (response) {
405
- return response.hasOwnProperty('success') ? response : response.data;
406
- }, function (error) {
407
- var _a;
408
- if ((_a = error === null || error === void 0 ? void 0 : error.response) === null || _a === void 0 ? void 0 : _a.data) {
409
- return Promise.reject(error.response.data);
410
- }
411
- return Promise.reject(error);
412
- });
413
390
  const localVarAxiosParamCreator = UsersApiAxiosParamCreator(configuration);
414
391
  return {
415
392
  /**
@@ -136,26 +136,6 @@ export const WebhooksApiAxiosParamCreator = function (configuration) {
136
136
  * @export
137
137
  */
138
138
  export const WebhooksApiFp = function (configuration) {
139
- /**
140
- * Axios interceptor to add the SDK version as a User-Agent header
141
- * */
142
- globalAxios.interceptors.request.use(function (config) {
143
- const version = require("../../package.json").version;
144
- config.headers['User-Agent'] = `Pipedrive-SDK-Javascript-${version}`;
145
- return config;
146
- });
147
- /**
148
- * Axios response interceptor to modify response structure
149
- */
150
- globalAxios.interceptors.response.use(function (response) {
151
- return response.hasOwnProperty('success') ? response : response.data;
152
- }, function (error) {
153
- var _a;
154
- if ((_a = error === null || error === void 0 ? void 0 : error.response) === null || _a === void 0 ? void 0 : _a.data) {
155
- return Promise.reject(error.response.data);
156
- }
157
- return Promise.reject(error);
158
- });
159
139
  const localVarAxiosParamCreator = WebhooksApiAxiosParamCreator(configuration);
160
140
  return {
161
141
  /**
package/dist/esm/base.js CHANGED
@@ -23,6 +23,32 @@ export const COLLECTION_FORMATS = {
23
23
  tsv: "\t",
24
24
  pipes: "|",
25
25
  };
26
+ /**
27
+ * Axios interceptor to add the SDK version as a User-Agent header
28
+ * */
29
+ globalAxios.interceptors.request.use(function (config) {
30
+ let version;
31
+ try {
32
+ version = require('../package.json').version;
33
+ }
34
+ catch (error) {
35
+ version = '22.x';
36
+ }
37
+ config.headers['User-Agent'] = `Pipedrive-SDK-Javascript-${version}`;
38
+ return config;
39
+ });
40
+ /**
41
+ * Axios response interceptor to modify response structure
42
+ */
43
+ globalAxios.interceptors.response.use(function (response) {
44
+ return response ? (response.hasOwnProperty('success') ? response : response.data) : response;
45
+ }, function (error) {
46
+ var _a;
47
+ if ((_a = error === null || error === void 0 ? void 0 : error.response) === null || _a === void 0 ? void 0 : _a.data) {
48
+ return Promise.reject(error.response.data);
49
+ }
50
+ return Promise.reject(error);
51
+ });
26
52
  /**
27
53
  *
28
54
  * @export
@@ -12,7 +12,6 @@
12
12
  import { Configuration } from "./configuration";
13
13
  import { RequestArgs } from "./base";
14
14
  import { AxiosInstance, AxiosResponse } from 'axios';
15
- import { URL } from 'url';
16
15
  /**
17
16
  *
18
17
  * @export
@@ -21,7 +21,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import { RequiredError } from "./base";
24
- import { URLSearchParams } from 'url';
25
24
  /**
26
25
  *
27
26
  * @export
@@ -21,6 +21,7 @@ export interface Parameters {
21
21
  clientId: string;
22
22
  clientSecret: string;
23
23
  redirectUri: string;
24
+ host?: string;
24
25
  }
25
26
  export type ParamKey = keyof Parameters;
26
27
  export declare class OAuth2Configuration {
@@ -25,7 +25,6 @@ import { stringify } from "qs";
25
25
  ;
26
26
  export class OAuth2Configuration {
27
27
  constructor(params) {
28
- this.host = "https://oauth.pipedrive.com";
29
28
  this.accessToken = null;
30
29
  this.refreshToken = null;
31
30
  this.scope = null;
@@ -112,7 +111,13 @@ export class OAuth2Configuration {
112
111
  return token;
113
112
  };
114
113
  this.getUserAgent = () => {
115
- const version = require("../package.json").version;
114
+ let version;
115
+ try {
116
+ version = require('../package.json').version;
117
+ }
118
+ catch (error) {
119
+ version = '22.x';
120
+ }
116
121
  return `Pipedrive-SDK-Javascript-${version}`;
117
122
  };
118
123
  this.validateParam = (params, key) => {
@@ -124,6 +129,7 @@ export class OAuth2Configuration {
124
129
  this.clientId = this.validateParam(params, 'clientId');
125
130
  this.clientSecret = this.validateParam(params, 'clientSecret');
126
131
  this.redirectUri = this.validateParam(params, 'redirectUri');
132
+ this.host = params.host || "https://oauth.pipedrive.com";
127
133
  }
128
134
  get authorizationUrl() {
129
135
  return `${this.host}/oauth/authorize?client_id=${this.clientId}&redirect_uri=${encodeURIComponent(this.redirectUri)}`;
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  **subscriptionUrl** | **String** | A full, valid, publicly accessible URL which determines where to send the notifications. Please note that you cannot use Pipedrive API endpoints as the `subscription_url` and the chosen URL must not redirect to another link. |
8
8
  **eventAction** | **String** | The type of action to receive notifications about. Wildcard will match all supported actions. |
9
9
  **eventObject** | **String** | The type of object to receive notifications about. Wildcard will match all supported objects. |
10
- **userId** | **Number** | The ID of the user that this webhook will be authorized with. You have the option to use a different user's `user_id`. If it is not set, the current user's `user_id` will be used. As each webhook event is checked against a users permissions, the webhook will only be sent if the user has access to the specified object(s). If you want to receive notifications for all events, please use a top-level admin user’s `user_id`. | [optional]
10
+ **userId** | **Number** | The ID of the user that this webhook will be authorized with. You have the option to use a different user's `user_id`. If it is not set, the current user's `user_id` will be used. As each webhook event is checked against a user's permissions, the webhook will only be sent if the user has access to the specified object(s). If you want to receive notifications for all events, please use a top-level admin user’s `user_id`. | [optional]
11
11
  **httpAuthUser** | **String** | The HTTP basic auth username of the subscription URL endpoint (if required) | [optional]
12
12
  **httpAuthPassword** | **String** | The HTTP basic auth password of the subscription URL endpoint (if required) | [optional]
13
13
  **version** | **String** | The webhook's version | [optional] [default to '1.0']
package/docs/BasicDeal.md CHANGED
@@ -4,6 +4,9 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
+ **wonTime** | **String** | The optional date and time of changing the deal status as won in UTC. Format: YYYY-MM-DD HH:MM:SS. Can be set only when deal `status` is already Won. Can not be used together with `lost_time`. | [optional]
8
+ **lostTime** | **String** | The optional date and time of changing the deal status as lost in UTC. Format: YYYY-MM-DD HH:MM:SS. Can be set only when deal `status` is already Lost. Can not be used together with `won_time`. | [optional]
9
+ **closeTime** | **String** | The optional date and time of closing the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional]
7
10
  **expectedCloseDate** | **Date** | The expected close date of the deal. In ISO 8601 format: YYYY-MM-DD. | [optional]
8
11
  **probability** | **Number** | The success probability percentage of the deal. Used/shown only when `deal_probability` for the pipeline of the deal is enabled. | [optional]
9
12
  **lostReason** | **String** | The optional message about why the deal was lost (to be used when status = lost) | [optional]
@@ -15,7 +15,8 @@ Name | Type | Description | Notes
15
15
  **endTime** | **Date** | The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS. |
16
16
  **personId** | **Number** | The ID of the person this call is associated with | [optional]
17
17
  **orgId** | **Number** | The ID of the organization this call is associated with | [optional]
18
- **dealId** | **Number** | The ID of the deal this call is associated with | [optional]
18
+ **dealId** | **Number** | The ID of the deal this call is associated with. A call log can be associated with either a deal or a lead, but not both at once. | [optional]
19
+ **leadId** | **String** | The ID of the lead in the UUID format this call is associated with. A call log can be associated with either a deal or a lead, but not both at once. | [optional]
19
20
  **note** | **String** | The note for the call log in HTML format | [optional]
20
21
 
21
22
 
@@ -0,0 +1,12 @@
1
+ # Pipedrive.DealParticipantsChangelog
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **actorUserId** | **Number** | The ID of the user | [optional]
8
+ **personId** | **Number** | The ID of the person | [optional]
9
+ **action** | **String** | Deal participant action type | [optional]
10
+ **time** | **String** | The deal participant action log time | [optional]
11
+
12
+
package/docs/DealsApi.md CHANGED
@@ -20,6 +20,7 @@ Method | HTTP request | Description
20
20
  [**getDealFollowers**](DealsApi.md#getDealFollowers) | **GET** /deals/{id}/followers | List followers of a deal
21
21
  [**getDealMailMessages**](DealsApi.md#getDealMailMessages) | **GET** /deals/{id}/mailMessages | List mail messages associated with a deal
22
22
  [**getDealParticipants**](DealsApi.md#getDealParticipants) | **GET** /deals/{id}/participants | List participants of a deal
23
+ [**getDealParticipantsChangelog**](DealsApi.md#getDealParticipantsChangelog) | **GET** /deals/{id}/participantsChangelog | List updates about participants of a deal
23
24
  [**getDealPersons**](DealsApi.md#getDealPersons) | **GET** /deals/{id}/persons | List all persons associated with a deal
24
25
  [**getDealProducts**](DealsApi.md#getDealProducts) | **GET** /deals/{id}/products | List products attached to a deal
25
26
  [**getDealUpdates**](DealsApi.md#getDealUpdates) | **GET** /deals/{id}/flow | List updates about a deal
@@ -933,6 +934,65 @@ Name | Type | Description | Notes
933
934
  - **Accept**: application/json
934
935
 
935
936
 
937
+ ## getDealParticipantsChangelog
938
+
939
+ > ParticipantsChangelog getDealParticipantsChangelog(id, opts)
940
+
941
+ List updates about participants of a deal
942
+
943
+ List updates about participants of a deal. This is a cursor-paginated endpoint. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>.
944
+
945
+ ### Example
946
+
947
+ ```javascript
948
+ import Pipedrive from 'pipedrive';
949
+ let apiClient = new Pipedrive.ApiClient();
950
+ // Configure API key authorization: api_key
951
+ let api_key = apiClient.authentications['api_key'];
952
+ api_key.apiKey = 'YOUR API KEY';
953
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
954
+ //api_key.apiKeyPrefix = 'Token';
955
+ // Configure OAuth2 access token for authorization: oauth2
956
+ let oauth2 = apiClient.authentications['oauth2'];
957
+ oauth2.accessToken = 'YOUR ACCESS TOKEN';
958
+
959
+ let apiInstance = new Pipedrive.DealsApi(apiClient);
960
+ let id = 56; // Number | The ID of the deal
961
+ let opts = {
962
+ 'limit': 56, // Number | Items shown per page
963
+ 'cursor': "cursor_example" // String | For pagination, the marker (an opaque string value) representing the first item on the next page
964
+ };
965
+ apiInstance.getDealParticipantsChangelog(id, opts).then((data) => {
966
+ console.log('API called successfully. Returned data: ' + data);
967
+ }, (error) => {
968
+ console.error(error);
969
+ });
970
+
971
+ ```
972
+
973
+ ### Parameters
974
+
975
+
976
+ Name | Type | Description | Notes
977
+ ------------- | ------------- | ------------- | -------------
978
+ **id** | **Number**| The ID of the deal |
979
+ **limit** | **Number**| Items shown per page | [optional]
980
+ **cursor** | **String**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional]
981
+
982
+ ### Return type
983
+
984
+ [**ParticipantsChangelog**](ParticipantsChangelog.md)
985
+
986
+ ### Authorization
987
+
988
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
989
+
990
+ ### HTTP request headers
991
+
992
+ - **Content-Type**: Not defined
993
+ - **Accept**: application/json
994
+
995
+
936
996
  ## getDealPersons
937
997
 
938
998
  > ListPersonsResponse getDealPersons(id, opts)
@@ -1081,7 +1141,7 @@ let opts = {
1081
1141
  'start': 0, // Number | Pagination start
1082
1142
  'limit': 56, // Number | Items shown per page
1083
1143
  'allChanges': "allChanges_example", // String | Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
1084
- 'items': "items_example" // String | A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change)
1144
+ 'items': "items_example" // String | A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
1085
1145
  };
1086
1146
  apiInstance.getDealUpdates(id, opts).then((data) => {
1087
1147
  console.log('API called successfully. Returned data: ' + data);
@@ -1100,7 +1160,7 @@ Name | Type | Description | Notes
1100
1160
  **start** | **Number**| Pagination start | [optional] [default to 0]
1101
1161
  **limit** | **Number**| Items shown per page | [optional]
1102
1162
  **allChanges** | **String**| Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates. | [optional]
1103
- **items** | **String**| A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change) | [optional]
1163
+ **items** | **String**| A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change). | [optional]
1104
1164
 
1105
1165
  ### Return type
1106
1166
 
@@ -1134,6 +1194,9 @@ let api_key = apiClient.authentications['api_key'];
1134
1194
  api_key.apiKey = 'YOUR API KEY';
1135
1195
  // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1136
1196
  //api_key.apiKeyPrefix = 'Token';
1197
+ // Configure OAuth2 access token for authorization: oauth2
1198
+ let oauth2 = apiClient.authentications['oauth2'];
1199
+ oauth2.accessToken = 'YOUR ACCESS TOKEN';
1137
1200
 
1138
1201
  let apiInstance = new Pipedrive.DealsApi(apiClient);
1139
1202
  let id = 56; // Number | The ID of the deal
@@ -1158,7 +1221,7 @@ Name | Type | Description | Notes
1158
1221
 
1159
1222
  ### Authorization
1160
1223
 
1161
- [api_key](../README.md#api_key)
1224
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
1162
1225
 
1163
1226
  ### HTTP request headers
1164
1227
 
@@ -1326,7 +1389,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN';
1326
1389
 
1327
1390
  let apiInstance = new Pipedrive.DealsApi(apiClient);
1328
1391
  let opts = {
1329
- 'status': "status_example", // String | Only fetch deals with a specific status. open = Open, won = Won, lost = Lost
1392
+ 'status': "status_example", // String | Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
1330
1393
  'filterId': 56, // Number | <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
1331
1394
  'userId': 56, // Number | Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
1332
1395
  'stageId': 56 // Number | Only deals within the given stage will be returned
@@ -1344,7 +1407,7 @@ apiInstance.getDealsSummary(opts).then((data) => {
1344
1407
 
1345
1408
  Name | Type | Description | Notes
1346
1409
  ------------- | ------------- | ------------- | -------------
1347
- **status** | **String**| Only fetch deals with a specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost | [optional]
1410
+ **status** | **String**| Only fetch deals with a specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. | [optional]
1348
1411
  **filterId** | **Number**| &lt;code&gt;user_id&lt;/code&gt; will not be considered. Only deals matching the given filter will be returned. | [optional]
1349
1412
  **userId** | **Number**| Only deals matching the given user will be returned. &#x60;user_id&#x60; will not be considered if you use &#x60;filter_id&#x60;. | [optional]
1350
1413
  **stageId** | **Number**| Only deals within the given stage will be returned | [optional]
@@ -1386,7 +1449,7 @@ let oauth2 = apiClient.authentications['oauth2'];
1386
1449
  oauth2.accessToken = 'YOUR ACCESS TOKEN';
1387
1450
 
1388
1451
  let apiInstance = new Pipedrive.DealsApi(apiClient);
1389
- let startDate = new Date("2013-10-20"); // Date | The date when the first interval starts. Format: YYYY-MM-DD
1452
+ let startDate = new Date("2013-10-20"); // Date | The date when the first interval starts. Format: YYYY-MM-DD.
1390
1453
  let interval = "interval_example"; // String | The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table>
1391
1454
  let amount = 56; // Number | The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).
1392
1455
  let fieldKey = "fieldKey_example"; // String | The date field key which deals will be retrieved from
@@ -1410,7 +1473,7 @@ apiInstance.getDealsTimeline(startDate, interval, amount, fieldKey, opts).then((
1410
1473
 
1411
1474
  Name | Type | Description | Notes
1412
1475
  ------------- | ------------- | ------------- | -------------
1413
- **startDate** | **Date**| The date when the first interval starts. Format: YYYY-MM-DD |
1476
+ **startDate** | **Date**| The date when the first interval starts. Format: YYYY-MM-DD. |
1414
1477
  **interval** | **String**| The type of the interval&lt;table&gt;&lt;tr&gt;&lt;th&gt;Value&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;day&#x60;&lt;/td&gt;&lt;td&gt;Day&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;week&#x60;&lt;/td&gt;&lt;td&gt;A full week (7 days) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;month&#x60;&lt;/td&gt;&lt;td&gt;A full month (depending on the number of days in given month) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;quarter&#x60;&lt;/td&gt;&lt;td&gt;A full quarter (3 months) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt; |
1415
1478
  **amount** | **Number**| The number of given intervals, starting from &#x60;start_date&#x60;, to fetch. E.g. 3 (months). |
1416
1479
  **fieldKey** | **String**| The date field key which deals will be retrieved from |
@@ -1637,6 +1700,9 @@ let api_key = apiClient.authentications['api_key'];
1637
1700
  api_key.apiKey = 'YOUR API KEY';
1638
1701
  // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1639
1702
  //api_key.apiKeyPrefix = 'Token';
1703
+ // Configure OAuth2 access token for authorization: oauth2
1704
+ let oauth2 = apiClient.authentications['oauth2'];
1705
+ oauth2.accessToken = 'YOUR ACCESS TOKEN';
1640
1706
 
1641
1707
  let apiInstance = new Pipedrive.DealsApi(apiClient);
1642
1708
  let id = 56; // Number | The ID of the deal
@@ -1667,7 +1733,7 @@ Name | Type | Description | Notes
1667
1733
 
1668
1734
  ### Authorization
1669
1735
 
1670
- [api_key](../README.md#api_key)
1736
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
1671
1737
 
1672
1738
  ### HTTP request headers
1673
1739
 
@@ -246,6 +246,9 @@ let api_key = apiClient.authentications['api_key'];
246
246
  api_key.apiKey = 'YOUR API KEY';
247
247
  // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
248
248
  //api_key.apiKeyPrefix = 'Token';
249
+ // Configure OAuth2 access token for authorization: oauth2
250
+ let oauth2 = apiClient.authentications['oauth2'];
251
+ oauth2.accessToken = 'YOUR ACCESS TOKEN';
249
252
 
250
253
  let apiInstance = new Pipedrive.FiltersApi(apiClient);
251
254
  apiInstance.getFilterHelpers().then((data) => {
@@ -266,7 +269,7 @@ This endpoint does not need any parameter.
266
269
 
267
270
  ### Authorization
268
271
 
269
- [api_key](../README.md#api_key)
272
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
270
273
 
271
274
  ### HTTP request headers
272
275
 
package/docs/GetDeal.md CHANGED
@@ -7,6 +7,6 @@ Name | Type | Description | Notes
7
7
  **success** | **Boolean** | If the response is successful or not | [optional]
8
8
  **data** | [**DealNonStrictWithDetails**](DealNonStrictWithDetails.md) | | [optional]
9
9
  **additionalData** | [**GetDealAdditionalData**](GetDealAdditionalData.md) | | [optional]
10
- **relatedObjects** | [**GetDealsRelatedObjects**](GetDealsRelatedObjects.md) | | [optional]
10
+ **relatedObjects** | [**GetDealRelatedObjects**](GetDealRelatedObjects.md) | | [optional]
11
11
 
12
12
 
@@ -0,0 +1,11 @@
1
+ # Pipedrive.GetDealRelatedObjects
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **user** | [**RelatedUserData**](RelatedUserData.md) | | [optional]
8
+ **person** | [**RelatedPersonDataWithActiveFlag**](RelatedPersonDataWithActiveFlag.md) | | [optional]
9
+ **organization** | [**RelatedOrganizationDataWithActiveFlag**](RelatedOrganizationDataWithActiveFlag.md) | | [optional]
10
+
11
+
@@ -4,8 +4,8 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **user** | [**DealUserData**](DealUserData.md) | | [optional]
8
- **organization** | [**DealOrganizationData**](DealOrganizationData.md) | | [optional]
9
- **person** | [**DealPersonData**](DealPersonData.md) | | [optional]
7
+ **user** | [**RelatedUserData**](RelatedUserData.md) | | [optional]
8
+ **organization** | [**RelatedOrganizationDataWithActiveFlag**](RelatedOrganizationDataWithActiveFlag.md) | | [optional]
9
+ **person** | [**RelatedPersonDataWithActiveFlag**](RelatedPersonDataWithActiveFlag.md) | | [optional]
10
10
 
11
11
 
@@ -36,7 +36,7 @@ let term = "term_example"; // String | The search term to look for. Minimum 2 ch
36
36
  let opts = {
37
37
  'itemTypes': "itemTypes_example", // String | A comma-separated string array. The type of items to perform the search from. Defaults to all.
38
38
  'fields': "fields_example", // String | A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `email`, `organization_name`, `person_name`, `phone`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<br/> When searching for leads, the email, organization_name, person_name, and phone fields will return results only for leads not linked to contacts. For searching leads by person or organization values, please use `search_for_related_items`.
39
- 'searchForRelatedItems': true, // Boolean | When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization.
39
+ 'searchForRelatedItems': true, // Boolean | When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization
40
40
  'exactMatch': true, // Boolean | When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
41
41
  'includeFields': "includeFields_example", // String | A comma-separated string array. Supports including optional fields in the results which are not provided by default.
42
42
  'start': 0, // Number | Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
@@ -58,7 +58,7 @@ Name | Type | Description | Notes
58
58
  **term** | **String**| The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded. |
59
59
  **itemTypes** | **String**| A comma-separated string array. The type of items to perform the search from. Defaults to all. | [optional]
60
60
  **fields** | **String**| A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:&lt;br&gt; &lt;table&gt; &lt;tr&gt;&lt;th&gt;&lt;b&gt;Item type&lt;/b&gt;&lt;/th&gt;&lt;th&gt;&lt;b&gt;Field&lt;/b&gt;&lt;/th&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Deal&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;title&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Person&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;email&#x60;, &#x60;name&#x60;, &#x60;notes&#x60;, &#x60;phone&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Organization&lt;/td&gt;&lt;td&gt;&#x60;address&#x60;, &#x60;custom_fields&#x60;, &#x60;name&#x60;, &#x60;notes&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Product&lt;/td&gt;&lt;td&gt;&#x60;code&#x60;, &#x60;custom_fields&#x60;, &#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Lead&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;email&#x60;, &#x60;organization_name&#x60;, &#x60;person_name&#x60;, &#x60;phone&#x60;, &#x60;title&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;File&lt;/td&gt;&lt;td&gt;&#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Mail attachment&lt;/td&gt;&lt;td&gt;&#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Project&lt;/td&gt;&lt;td&gt; &#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;title&#x60;, &#x60;description&#x60; &lt;/td&gt;&lt;/tr&gt; &lt;/table&gt; &lt;br&gt; Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.&lt;br/&gt; When searching for leads, the email, organization_name, person_name, and phone fields will return results only for leads not linked to contacts. For searching leads by person or organization values, please use &#x60;search_for_related_items&#x60;. | [optional]
61
- **searchForRelatedItems** | **Boolean**| When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization. | [optional]
61
+ **searchForRelatedItems** | **Boolean**| When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization | [optional]
62
62
  **exactMatch** | **Boolean**| When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive. | [optional]
63
63
  **includeFields** | **String**| A comma-separated string array. Supports including optional fields in the results which are not provided by default. | [optional]
64
64
  **start** | **Number**| Pagination start. Note that the pagination is based on main results and does not include related items when using &#x60;search_for_related_items&#x60; parameter. | [optional] [default to 0]
package/docs/LeadsApi.md CHANGED
@@ -193,6 +193,9 @@ let api_key = apiClient.authentications['api_key'];
193
193
  api_key.apiKey = 'YOUR API KEY';
194
194
  // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
195
195
  //api_key.apiKeyPrefix = 'Token';
196
+ // Configure OAuth2 access token for authorization: oauth2
197
+ let oauth2 = apiClient.authentications['oauth2'];
198
+ oauth2.accessToken = 'YOUR ACCESS TOKEN';
196
199
 
197
200
  let apiInstance = new Pipedrive.LeadsApi(apiClient);
198
201
  let id = "id_example"; // String | The ID of the lead
@@ -217,7 +220,7 @@ Name | Type | Description | Notes
217
220
 
218
221
  ### Authorization
219
222
 
220
- [api_key](../README.md#api_key)
223
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
221
224
 
222
225
  ### HTTP request headers
223
226
 
@@ -91,7 +91,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN';
91
91
  let apiInstance = new Pipedrive.MailboxApi(apiClient);
92
92
  let id = 56; // Number | The ID of the mail message to fetch
93
93
  let opts = {
94
- 'includeBody': new Pipedrive.NumberBooleanDefault0() // NumberBooleanDefault0 | Whether to include the full message body or not. `0` = Don't include, `1` = Include
94
+ 'includeBody': new Pipedrive.NumberBooleanDefault0() // NumberBooleanDefault0 | Whether to include the full message body or not. `0` = Don't include, `1` = Include.
95
95
  };
96
96
  apiInstance.getMailMessage(id, opts).then((data) => {
97
97
  console.log('API called successfully. Returned data: ' + data);
@@ -107,7 +107,7 @@ apiInstance.getMailMessage(id, opts).then((data) => {
107
107
  Name | Type | Description | Notes
108
108
  ------------- | ------------- | ------------- | -------------
109
109
  **id** | **Number**| The ID of the mail message to fetch |
110
- **includeBody** | [**NumberBooleanDefault0**](.md)| Whether to include the full message body or not. &#x60;0&#x60; &#x3D; Don&#39;t include, &#x60;1&#x60; &#x3D; Include | [optional]
110
+ **includeBody** | [**NumberBooleanDefault0**](.md)| Whether to include the full message body or not. &#x60;0&#x60; &#x3D; Don&#39;t include, &#x60;1&#x60; &#x3D; Include. | [optional]
111
111
 
112
112
  ### Return type
113
113