pipedrive 33.4.3 → 33.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/versions/v1/api/deals-api.d.ts +10 -2
- package/dist/esm/versions/v1/api/deals-api.js +10 -5
- package/dist/esm/versions/v1/api/organizations-api.d.ts +10 -2
- package/dist/esm/versions/v1/api/organizations-api.js +10 -5
- package/dist/esm/versions/v1/api/persons-api.d.ts +10 -2
- package/dist/esm/versions/v1/api/persons-api.js +10 -5
- package/dist/esm/versions/v1/common.d.ts +1 -1
- package/dist/esm/versions/v1/common.js +2 -0
- package/dist/esm/versions/v1/models/mail-message-data.d.ts +5 -0
- package/dist/esm/versions/v2/api/persons-api.d.ts +15 -14
- package/dist/esm/versions/v2/api/persons-api.js +16 -16
- package/dist/esm/versions/v2/common.d.ts +1 -1
- package/dist/esm/versions/v2/common.js +2 -0
- package/dist/esm/versions/v2/models/add-organization-request.d.ts +26 -6
- package/dist/esm/versions/v2/models/add-person-request.d.ts +33 -11
- package/dist/esm/versions/v2/models/index.d.ts +5 -4
- package/dist/esm/versions/v2/models/index.js +5 -4
- package/dist/esm/versions/v2/models/{person-postal-address.d.ts → person-item-address.d.ts} +2 -2
- package/dist/esm/versions/v2/models/{add-person-request-emails-inner.d.ts → person-item-email.d.ts} +2 -2
- package/dist/{versions/v2/models/person-im-inner.d.ts → esm/versions/v2/models/person-item-im.d.ts} +2 -2
- package/dist/{versions/v2/models/add-person-request-phones-inner.d.ts → esm/versions/v2/models/person-item-phone.d.ts} +2 -2
- package/dist/esm/versions/v2/models/person.d.ts +12 -12
- package/dist/esm/versions/v2/models/update-organization-request.d.ts +25 -10
- package/dist/esm/versions/v2/models/update-person-request.d.ts +101 -0
- package/dist/esm/versions/v2/models/update-person-request.js +19 -0
- package/dist/versions/v1/api/deals-api.d.ts +10 -2
- package/dist/versions/v1/api/deals-api.js +10 -5
- package/dist/versions/v1/api/organizations-api.d.ts +10 -2
- package/dist/versions/v1/api/organizations-api.js +10 -5
- package/dist/versions/v1/api/persons-api.d.ts +10 -2
- package/dist/versions/v1/api/persons-api.js +10 -5
- package/dist/versions/v1/common.d.ts +1 -1
- package/dist/versions/v1/common.js +2 -0
- package/dist/versions/v1/models/mail-message-data.d.ts +5 -0
- package/dist/versions/v2/api/persons-api.d.ts +15 -14
- package/dist/versions/v2/api/persons-api.js +16 -16
- package/dist/versions/v2/common.d.ts +1 -1
- package/dist/versions/v2/common.js +2 -0
- package/dist/versions/v2/models/add-organization-request.d.ts +26 -6
- package/dist/versions/v2/models/add-person-request.d.ts +33 -11
- package/dist/versions/v2/models/index.d.ts +5 -4
- package/dist/versions/v2/models/index.js +5 -4
- package/dist/versions/v2/models/{person-postal-address.d.ts → person-item-address.d.ts} +2 -2
- package/dist/versions/v2/models/{add-person-request-emails-inner.d.ts → person-item-email.d.ts} +2 -2
- package/dist/{esm/versions/v2/models/person-im-inner.d.ts → versions/v2/models/person-item-im.d.ts} +2 -2
- package/dist/{esm/versions/v2/models/add-person-request-phones-inner.d.ts → versions/v2/models/person-item-phone.d.ts} +2 -2
- package/dist/versions/v2/models/person.d.ts +12 -12
- package/dist/versions/v2/models/update-organization-request.d.ts +25 -10
- package/dist/versions/v2/models/update-person-request.d.ts +101 -0
- package/dist/versions/v2/models/update-person-request.js +22 -0
- package/package.json +1 -1
- /package/dist/esm/versions/v2/models/{add-person-request-emails-inner.js → person-item-address.js} +0 -0
- /package/dist/esm/versions/v2/models/{add-person-request-phones-inner.js → person-item-email.js} +0 -0
- /package/dist/esm/versions/v2/models/{person-im-inner.js → person-item-im.js} +0 -0
- /package/dist/esm/versions/v2/models/{person-postal-address.js → person-item-phone.js} +0 -0
- /package/dist/versions/v2/models/{add-person-request-emails-inner.js → person-item-address.js} +0 -0
- /package/dist/versions/v2/models/{add-person-request-phones-inner.js → person-item-email.js} +0 -0
- /package/dist/versions/v2/models/{person-im-inner.js → person-item-im.js} +0 -0
- /package/dist/versions/v2/models/{person-postal-address.js → person-item-phone.js} +0 -0
|
@@ -9,8 +9,10 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import {
|
|
13
|
-
import {
|
|
12
|
+
import { PersonItemAddress } from './person-item-address';
|
|
13
|
+
import { PersonItemEmail } from './person-item-email';
|
|
14
|
+
import { PersonItemIm } from './person-item-im';
|
|
15
|
+
import { PersonItemPhone } from './person-item-phone';
|
|
14
16
|
/**
|
|
15
17
|
*
|
|
16
18
|
* @export
|
|
@@ -38,20 +40,15 @@ export interface AddPersonRequest {
|
|
|
38
40
|
*/
|
|
39
41
|
'add_time'?: string;
|
|
40
42
|
/**
|
|
41
|
-
* The last updated date and time of the person
|
|
42
|
-
* @type {string}
|
|
43
|
-
*/
|
|
44
|
-
'update_time'?: string;
|
|
45
|
-
/**
|
|
46
43
|
* The emails of the person
|
|
47
|
-
* @type {Array<
|
|
44
|
+
* @type {Array<PersonItemEmail>}
|
|
48
45
|
*/
|
|
49
|
-
'emails'?: Array<
|
|
46
|
+
'emails'?: Array<PersonItemEmail>;
|
|
50
47
|
/**
|
|
51
48
|
* The phones of the person
|
|
52
|
-
* @type {Array<
|
|
49
|
+
* @type {Array<PersonItemPhone>}
|
|
53
50
|
*/
|
|
54
|
-
'phones'?: Array<
|
|
51
|
+
'phones'?: Array<PersonItemPhone>;
|
|
55
52
|
/**
|
|
56
53
|
* The visibility of the person
|
|
57
54
|
* @type {number}
|
|
@@ -63,6 +60,31 @@ export interface AddPersonRequest {
|
|
|
63
60
|
*/
|
|
64
61
|
'label_ids'?: Array<number>;
|
|
65
62
|
/**
|
|
63
|
+
*
|
|
64
|
+
* @type {PersonItemAddress}
|
|
65
|
+
*/
|
|
66
|
+
'postal_address'?: PersonItemAddress;
|
|
67
|
+
/**
|
|
68
|
+
* Contact sync notes of the person, maximum 10 000 characters, included if contact sync is enabled for the company
|
|
69
|
+
* @type {string}
|
|
70
|
+
*/
|
|
71
|
+
'notes'?: string;
|
|
72
|
+
/**
|
|
73
|
+
* The instant messaging accounts of the person, included if contact sync is enabled for the company
|
|
74
|
+
* @type {Array<PersonItemIm>}
|
|
75
|
+
*/
|
|
76
|
+
'im'?: Array<PersonItemIm>;
|
|
77
|
+
/**
|
|
78
|
+
* The birthday of the person, included if contact sync is enabled for the company
|
|
79
|
+
* @type {string}
|
|
80
|
+
*/
|
|
81
|
+
'birthday'?: string;
|
|
82
|
+
/**
|
|
83
|
+
* The job title of the person, included if contact sync is enabled for the company
|
|
84
|
+
* @type {string}
|
|
85
|
+
*/
|
|
86
|
+
'job_title'?: string;
|
|
87
|
+
/**
|
|
66
88
|
* If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table>
|
|
67
89
|
* @type {string}
|
|
68
90
|
*/
|
|
@@ -42,8 +42,6 @@ export * from './add-person-field-request-required-fields';
|
|
|
42
42
|
export * from './add-person-field-request-ui-visibility';
|
|
43
43
|
export * from './add-person-field-request-ui-visibility-show-in-add-deal-dialog';
|
|
44
44
|
export * from './add-person-request';
|
|
45
|
-
export * from './add-person-request-emails-inner';
|
|
46
|
-
export * from './add-person-request-phones-inner';
|
|
47
45
|
export * from './add-pipeline-request';
|
|
48
46
|
export * from './add-product-field-request';
|
|
49
47
|
export * from './add-product-field-request-ui-visibility';
|
|
@@ -254,8 +252,10 @@ export * from './lead-search-item-item-person';
|
|
|
254
252
|
export * from './organization-item';
|
|
255
253
|
export * from './organization-item-address';
|
|
256
254
|
export * from './person';
|
|
257
|
-
export * from './person-
|
|
258
|
-
export * from './person-
|
|
255
|
+
export * from './person-item-address';
|
|
256
|
+
export * from './person-item-email';
|
|
257
|
+
export * from './person-item-im';
|
|
258
|
+
export * from './person-item-phone';
|
|
259
259
|
export * from './prices-array';
|
|
260
260
|
export * from './prices-array-prices-inner';
|
|
261
261
|
export * from './product-request';
|
|
@@ -275,6 +275,7 @@ export * from './update-installment-response';
|
|
|
275
275
|
export * from './update-organization-field-request';
|
|
276
276
|
export * from './update-organization-request';
|
|
277
277
|
export * from './update-person-field-request';
|
|
278
|
+
export * from './update-person-request';
|
|
278
279
|
export * from './update-pipeline-request';
|
|
279
280
|
export * from './update-product-field-request';
|
|
280
281
|
export * from './update-product-image-response';
|
|
@@ -42,8 +42,6 @@ export * from './add-person-field-request-required-fields';
|
|
|
42
42
|
export * from './add-person-field-request-ui-visibility';
|
|
43
43
|
export * from './add-person-field-request-ui-visibility-show-in-add-deal-dialog';
|
|
44
44
|
export * from './add-person-request';
|
|
45
|
-
export * from './add-person-request-emails-inner';
|
|
46
|
-
export * from './add-person-request-phones-inner';
|
|
47
45
|
export * from './add-pipeline-request';
|
|
48
46
|
export * from './add-product-field-request';
|
|
49
47
|
export * from './add-product-field-request-ui-visibility';
|
|
@@ -254,8 +252,10 @@ export * from './lead-search-item-item-person';
|
|
|
254
252
|
export * from './organization-item';
|
|
255
253
|
export * from './organization-item-address';
|
|
256
254
|
export * from './person';
|
|
257
|
-
export * from './person-
|
|
258
|
-
export * from './person-
|
|
255
|
+
export * from './person-item-address';
|
|
256
|
+
export * from './person-item-email';
|
|
257
|
+
export * from './person-item-im';
|
|
258
|
+
export * from './person-item-phone';
|
|
259
259
|
export * from './prices-array';
|
|
260
260
|
export * from './prices-array-prices-inner';
|
|
261
261
|
export * from './product-request';
|
|
@@ -275,6 +275,7 @@ export * from './update-installment-response';
|
|
|
275
275
|
export * from './update-organization-field-request';
|
|
276
276
|
export * from './update-organization-request';
|
|
277
277
|
export * from './update-person-field-request';
|
|
278
|
+
export * from './update-person-request';
|
|
278
279
|
export * from './update-pipeline-request';
|
|
279
280
|
export * from './update-product-field-request';
|
|
280
281
|
export * from './update-product-image-response';
|
|
@@ -12,9 +12,9 @@
|
|
|
12
12
|
/**
|
|
13
13
|
* Postal address of the person, included if contact sync is enabled for the company
|
|
14
14
|
* @export
|
|
15
|
-
* @interface
|
|
15
|
+
* @interface PersonItemAddress
|
|
16
16
|
*/
|
|
17
|
-
export interface
|
|
17
|
+
export interface PersonItemAddress {
|
|
18
18
|
/**
|
|
19
19
|
* The full address of the person
|
|
20
20
|
* @type {string}
|
package/dist/esm/versions/v2/models/{add-person-request-emails-inner.d.ts → person-item-email.d.ts}
RENAMED
|
@@ -12,9 +12,9 @@
|
|
|
12
12
|
/**
|
|
13
13
|
*
|
|
14
14
|
* @export
|
|
15
|
-
* @interface
|
|
15
|
+
* @interface PersonItemEmail
|
|
16
16
|
*/
|
|
17
|
-
export interface
|
|
17
|
+
export interface PersonItemEmail {
|
|
18
18
|
/**
|
|
19
19
|
* The email address of the person
|
|
20
20
|
* @type {string}
|
|
@@ -12,9 +12,9 @@
|
|
|
12
12
|
/**
|
|
13
13
|
*
|
|
14
14
|
* @export
|
|
15
|
-
* @interface
|
|
15
|
+
* @interface PersonItemPhone
|
|
16
16
|
*/
|
|
17
|
-
export interface
|
|
17
|
+
export interface PersonItemPhone {
|
|
18
18
|
/**
|
|
19
19
|
* The phone number of the person
|
|
20
20
|
* @type {string}
|
|
@@ -9,10 +9,10 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import {
|
|
13
|
-
import {
|
|
14
|
-
import {
|
|
15
|
-
import {
|
|
12
|
+
import { PersonItemAddress } from './person-item-address';
|
|
13
|
+
import { PersonItemEmail } from './person-item-email';
|
|
14
|
+
import { PersonItemIm } from './person-item-im';
|
|
15
|
+
import { PersonItemPhone } from './person-item-phone';
|
|
16
16
|
/**
|
|
17
17
|
*
|
|
18
18
|
* @export
|
|
@@ -61,14 +61,14 @@ export interface Person {
|
|
|
61
61
|
'update_time'?: string;
|
|
62
62
|
/**
|
|
63
63
|
* The emails of the person
|
|
64
|
-
* @type {Array<
|
|
64
|
+
* @type {Array<PersonItemEmail>}
|
|
65
65
|
*/
|
|
66
|
-
'emails'?: Array<
|
|
66
|
+
'emails'?: Array<PersonItemEmail>;
|
|
67
67
|
/**
|
|
68
68
|
* The phones of the person
|
|
69
|
-
* @type {Array<
|
|
69
|
+
* @type {Array<PersonItemPhone>}
|
|
70
70
|
*/
|
|
71
|
-
'phones'?: Array<
|
|
71
|
+
'phones'?: Array<PersonItemPhone>;
|
|
72
72
|
/**
|
|
73
73
|
* Whether the person is deleted or not
|
|
74
74
|
* @type {boolean}
|
|
@@ -91,9 +91,9 @@ export interface Person {
|
|
|
91
91
|
'picture_id'?: number;
|
|
92
92
|
/**
|
|
93
93
|
*
|
|
94
|
-
* @type {
|
|
94
|
+
* @type {PersonItemAddress}
|
|
95
95
|
*/
|
|
96
|
-
'postal_address'?:
|
|
96
|
+
'postal_address'?: PersonItemAddress;
|
|
97
97
|
/**
|
|
98
98
|
* Contact sync notes of the person, maximum 10 000 characters, included if contact sync is enabled for the company
|
|
99
99
|
* @type {string}
|
|
@@ -101,9 +101,9 @@ export interface Person {
|
|
|
101
101
|
'notes'?: string;
|
|
102
102
|
/**
|
|
103
103
|
* The instant messaging accounts of the person, included if contact sync is enabled for the company
|
|
104
|
-
* @type {Array<
|
|
104
|
+
* @type {Array<PersonItemIm>}
|
|
105
105
|
*/
|
|
106
|
-
'im'?: Array<
|
|
106
|
+
'im'?: Array<PersonItemIm>;
|
|
107
107
|
/**
|
|
108
108
|
* The birthday of the person, included if contact sync is enabled for the company
|
|
109
109
|
* @type {string}
|
|
@@ -27,16 +27,6 @@ export interface UpdateOrganizationRequest {
|
|
|
27
27
|
*/
|
|
28
28
|
'owner_id'?: number;
|
|
29
29
|
/**
|
|
30
|
-
* The creation date and time of the organization
|
|
31
|
-
* @type {string}
|
|
32
|
-
*/
|
|
33
|
-
'add_time'?: string;
|
|
34
|
-
/**
|
|
35
|
-
* The last updated date and time of the organization
|
|
36
|
-
* @type {string}
|
|
37
|
-
*/
|
|
38
|
-
'update_time'?: string;
|
|
39
|
-
/**
|
|
40
30
|
* The visibility of the organization
|
|
41
31
|
* @type {number}
|
|
42
32
|
*/
|
|
@@ -52,6 +42,31 @@ export interface UpdateOrganizationRequest {
|
|
|
52
42
|
*/
|
|
53
43
|
'address'?: OrganizationItemAddress;
|
|
54
44
|
/**
|
|
45
|
+
* The website of the organization
|
|
46
|
+
* @type {string}
|
|
47
|
+
*/
|
|
48
|
+
'website'?: string | null;
|
|
49
|
+
/**
|
|
50
|
+
* The LinkedIn profile URL of the organization
|
|
51
|
+
* @type {string}
|
|
52
|
+
*/
|
|
53
|
+
'linkedin'?: string | null;
|
|
54
|
+
/**
|
|
55
|
+
* The industry the organization belongs to
|
|
56
|
+
* @type {number}
|
|
57
|
+
*/
|
|
58
|
+
'industry'?: number | null;
|
|
59
|
+
/**
|
|
60
|
+
* The annual revenue of the organization
|
|
61
|
+
* @type {number}
|
|
62
|
+
*/
|
|
63
|
+
'annual_revenue'?: number | null;
|
|
64
|
+
/**
|
|
65
|
+
* The number of employees in the organization
|
|
66
|
+
* @type {number}
|
|
67
|
+
*/
|
|
68
|
+
'employee_count'?: number | null;
|
|
69
|
+
/**
|
|
55
70
|
* An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error.
|
|
56
71
|
* @type {{ [key: string]: any | undefined; }}
|
|
57
72
|
*/
|
|
@@ -0,0 +1,101 @@
|
|
|
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
|
+
import { PersonItemAddress } from './person-item-address';
|
|
13
|
+
import { PersonItemEmail } from './person-item-email';
|
|
14
|
+
import { PersonItemIm } from './person-item-im';
|
|
15
|
+
import { PersonItemPhone } from './person-item-phone';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface UpdatePersonRequest
|
|
20
|
+
*/
|
|
21
|
+
export interface UpdatePersonRequest {
|
|
22
|
+
/**
|
|
23
|
+
* The name of the person
|
|
24
|
+
* @type {string}
|
|
25
|
+
*/
|
|
26
|
+
'name'?: string;
|
|
27
|
+
/**
|
|
28
|
+
* The ID of the user who owns the person
|
|
29
|
+
* @type {number}
|
|
30
|
+
*/
|
|
31
|
+
'owner_id'?: number;
|
|
32
|
+
/**
|
|
33
|
+
* The ID of the organization linked to the person
|
|
34
|
+
* @type {number}
|
|
35
|
+
*/
|
|
36
|
+
'org_id'?: number;
|
|
37
|
+
/**
|
|
38
|
+
* The emails of the person
|
|
39
|
+
* @type {Array<PersonItemEmail>}
|
|
40
|
+
*/
|
|
41
|
+
'emails'?: Array<PersonItemEmail>;
|
|
42
|
+
/**
|
|
43
|
+
* The phones of the person
|
|
44
|
+
* @type {Array<PersonItemPhone>}
|
|
45
|
+
*/
|
|
46
|
+
'phones'?: Array<PersonItemPhone>;
|
|
47
|
+
/**
|
|
48
|
+
* The visibility of the person
|
|
49
|
+
* @type {number}
|
|
50
|
+
*/
|
|
51
|
+
'visible_to'?: number;
|
|
52
|
+
/**
|
|
53
|
+
* The IDs of labels assigned to the person
|
|
54
|
+
* @type {Array<number>}
|
|
55
|
+
*/
|
|
56
|
+
'label_ids'?: Array<number>;
|
|
57
|
+
/**
|
|
58
|
+
*
|
|
59
|
+
* @type {PersonItemAddress}
|
|
60
|
+
*/
|
|
61
|
+
'postal_address'?: PersonItemAddress;
|
|
62
|
+
/**
|
|
63
|
+
* Contact sync notes of the person, maximum 10 000 characters, included if contact sync is enabled for the company
|
|
64
|
+
* @type {string}
|
|
65
|
+
*/
|
|
66
|
+
'notes'?: string;
|
|
67
|
+
/**
|
|
68
|
+
* The instant messaging accounts of the person, included if contact sync is enabled for the company
|
|
69
|
+
* @type {Array<PersonItemIm>}
|
|
70
|
+
*/
|
|
71
|
+
'im'?: Array<PersonItemIm>;
|
|
72
|
+
/**
|
|
73
|
+
* The birthday of the person, included if contact sync is enabled for the company
|
|
74
|
+
* @type {string}
|
|
75
|
+
*/
|
|
76
|
+
'birthday'?: string;
|
|
77
|
+
/**
|
|
78
|
+
* The job title of the person, included if contact sync is enabled for the company
|
|
79
|
+
* @type {string}
|
|
80
|
+
*/
|
|
81
|
+
'job_title'?: string;
|
|
82
|
+
/**
|
|
83
|
+
* If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table>
|
|
84
|
+
* @type {string}
|
|
85
|
+
*/
|
|
86
|
+
'marketing_status'?: UpdatePersonRequestMarketingStatusConst;
|
|
87
|
+
/**
|
|
88
|
+
* An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error.
|
|
89
|
+
* @type {{ [key: string]: any | undefined; }}
|
|
90
|
+
*/
|
|
91
|
+
'custom_fields'?: {
|
|
92
|
+
[key: string]: any | undefined;
|
|
93
|
+
};
|
|
94
|
+
}
|
|
95
|
+
export declare const UpdatePersonRequestMarketingStatusConst: {
|
|
96
|
+
readonly no_consent: "no_consent";
|
|
97
|
+
readonly unsubscribed: "unsubscribed";
|
|
98
|
+
readonly subscribed: "subscribed";
|
|
99
|
+
readonly archived: "archived";
|
|
100
|
+
};
|
|
101
|
+
export type UpdatePersonRequestMarketingStatusConst = typeof UpdatePersonRequestMarketingStatusConst[keyof typeof UpdatePersonRequestMarketingStatusConst];
|
|
@@ -0,0 +1,19 @@
|
|
|
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 const UpdatePersonRequestMarketingStatusConst = {
|
|
15
|
+
no_consent: 'no_consent',
|
|
16
|
+
unsubscribed: 'unsubscribed',
|
|
17
|
+
subscribed: 'subscribed',
|
|
18
|
+
archived: 'archived'
|
|
19
|
+
};
|
|
@@ -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.
|