pipedrive 33.7.2 → 33.9.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/models/deal-all-of-creator-user-id.d.ts +2 -2
- package/dist/esm/versions/v1/models/get-associated-product-files-response-all-of.d.ts +1 -1
- package/dist/esm/versions/v2/api/persons-api.d.ts +8 -8
- package/dist/esm/versions/v2/api/persons-api.js +8 -8
- package/dist/esm/versions/v2/models/activity-item-location.d.ts +68 -0
- package/dist/esm/versions/v2/models/activity-item-location.js +14 -0
- package/dist/esm/versions/v2/models/activity-item.d.ts +11 -11
- package/dist/esm/versions/v2/models/add-activity-request.d.ts +1 -6
- package/dist/esm/versions/v2/models/add-organization-request.d.ts +1 -1
- package/dist/esm/versions/v2/models/add-person-request.d.ts +6 -6
- package/dist/esm/versions/v2/models/deal.d.ts +1 -1
- package/dist/esm/versions/v2/models/get-activities-response-all-of-additional-data.d.ts +1 -1
- package/dist/esm/versions/v2/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +1 -1
- package/dist/esm/versions/v2/models/get-deals-products-response-additional-data.d.ts +1 -1
- package/dist/esm/versions/v2/models/get-organization-search-response-all-of-data-items-inner-item.d.ts +1 -1
- package/dist/esm/versions/v2/models/get-product-search-response-all-of-data-items-inner-item.d.ts +2 -2
- package/dist/esm/versions/v2/models/index.d.ts +1 -0
- package/dist/esm/versions/v2/models/index.js +1 -0
- package/dist/esm/versions/v2/models/lead-search-item-item.d.ts +1 -1
- package/dist/esm/versions/v2/models/organization-item-address.d.ts +9 -9
- package/dist/esm/versions/v2/models/organization-item.d.ts +2 -2
- package/dist/esm/versions/v2/models/person-item-address.d.ts +9 -9
- package/dist/esm/versions/v2/models/person.d.ts +3 -3
- package/dist/esm/versions/v2/models/stage-item.d.ts +1 -1
- package/dist/esm/versions/v2/models/stage-item1.d.ts +1 -1
- package/dist/esm/versions/v2/models/update-organization-request.d.ts +1 -1
- package/dist/esm/versions/v2/models/update-person-request.d.ts +5 -5
- package/dist/versions/v1/models/deal-all-of-creator-user-id.d.ts +2 -2
- package/dist/versions/v1/models/get-associated-product-files-response-all-of.d.ts +1 -1
- package/dist/versions/v2/api/persons-api.d.ts +8 -8
- package/dist/versions/v2/api/persons-api.js +8 -8
- package/dist/versions/v2/models/activity-item-location.d.ts +68 -0
- package/dist/versions/v2/models/activity-item-location.js +15 -0
- package/dist/versions/v2/models/activity-item.d.ts +11 -11
- package/dist/versions/v2/models/add-activity-request.d.ts +1 -6
- package/dist/versions/v2/models/add-organization-request.d.ts +1 -1
- package/dist/versions/v2/models/add-person-request.d.ts +6 -6
- package/dist/versions/v2/models/deal.d.ts +1 -1
- package/dist/versions/v2/models/get-activities-response-all-of-additional-data.d.ts +1 -1
- package/dist/versions/v2/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +1 -1
- package/dist/versions/v2/models/get-deals-products-response-additional-data.d.ts +1 -1
- package/dist/versions/v2/models/get-organization-search-response-all-of-data-items-inner-item.d.ts +1 -1
- package/dist/versions/v2/models/get-product-search-response-all-of-data-items-inner-item.d.ts +2 -2
- package/dist/versions/v2/models/index.d.ts +1 -0
- package/dist/versions/v2/models/index.js +1 -0
- package/dist/versions/v2/models/lead-search-item-item.d.ts +1 -1
- package/dist/versions/v2/models/organization-item-address.d.ts +9 -9
- package/dist/versions/v2/models/organization-item.d.ts +2 -2
- package/dist/versions/v2/models/person-item-address.d.ts +9 -9
- package/dist/versions/v2/models/person.d.ts +3 -3
- package/dist/versions/v2/models/stage-item.d.ts +1 -1
- package/dist/versions/v2/models/stage-item1.d.ts +1 -1
- package/dist/versions/v2/models/update-organization-request.d.ts +1 -1
- package/dist/versions/v2/models/update-person-request.d.ts +5 -5
- package/package.json +1 -1
|
@@ -58,24 +58,24 @@ export interface UpdatePersonRequest {
|
|
|
58
58
|
*
|
|
59
59
|
* @type {PersonItemAddress}
|
|
60
60
|
*/
|
|
61
|
-
'postal_address'?: PersonItemAddress;
|
|
61
|
+
'postal_address'?: PersonItemAddress | null;
|
|
62
62
|
/**
|
|
63
|
-
* Contact sync notes of the person, maximum 10 000 characters
|
|
63
|
+
* Contact sync notes of the person, maximum 10 000 characters. Only accepted when contact sync is enabled for the company; otherwise the request returns 403.
|
|
64
64
|
* @type {string}
|
|
65
65
|
*/
|
|
66
66
|
'notes'?: string;
|
|
67
67
|
/**
|
|
68
|
-
* The instant messaging accounts of the person
|
|
68
|
+
* The instant messaging accounts of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403.
|
|
69
69
|
* @type {Array<PersonItemIm>}
|
|
70
70
|
*/
|
|
71
71
|
'im'?: Array<PersonItemIm>;
|
|
72
72
|
/**
|
|
73
|
-
* The birthday of the person
|
|
73
|
+
* The birthday of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403.
|
|
74
74
|
* @type {string}
|
|
75
75
|
*/
|
|
76
76
|
'birthday'?: string;
|
|
77
77
|
/**
|
|
78
|
-
* The job title of the person
|
|
78
|
+
* The job title of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403.
|
|
79
79
|
* @type {string}
|
|
80
80
|
*/
|
|
81
81
|
'job_title'?: string;
|
|
@@ -32,9 +32,9 @@ export interface DealAllOfCreatorUserId {
|
|
|
32
32
|
'email'?: string;
|
|
33
33
|
/**
|
|
34
34
|
* If the creator has a picture or not
|
|
35
|
-
* @type {
|
|
35
|
+
* @type {number}
|
|
36
36
|
*/
|
|
37
|
-
'has_pic'?:
|
|
37
|
+
'has_pic'?: number;
|
|
38
38
|
/**
|
|
39
39
|
* The creator picture hash
|
|
40
40
|
* @type {string}
|
|
@@ -21,7 +21,7 @@ export interface GetAssociatedProductFilesResponseAllOf {
|
|
|
21
21
|
* The array of files
|
|
22
22
|
* @type {Array<GetAssociatedProductFilesResponseAllOfDataInner>}
|
|
23
23
|
*/
|
|
24
|
-
'data': Array<GetAssociatedProductFilesResponseAllOfDataInner
|
|
24
|
+
'data': Array<GetAssociatedProductFilesResponseAllOfDataInner> | null;
|
|
25
25
|
/**
|
|
26
26
|
*
|
|
27
27
|
* @type {GetFieldsResponseAllOfAdditionalData}
|
|
@@ -30,7 +30,7 @@ import { UpsertPersonResponse } from '../models';
|
|
|
30
30
|
*/
|
|
31
31
|
export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
32
32
|
/**
|
|
33
|
-
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
33
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
34
34
|
* @summary Add a new person
|
|
35
35
|
* @param {AddPersonRequest} [AddPersonRequest]
|
|
36
36
|
|
|
@@ -140,7 +140,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
140
140
|
*/
|
|
141
141
|
searchPersons: (term: string, fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name', exact_match?: boolean, organization_id?: number, include_fields?: 'person.picture', limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
142
142
|
/**
|
|
143
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
143
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
144
144
|
* @summary Update a person
|
|
145
145
|
* @param {number} id The ID of the person
|
|
146
146
|
* @param {UpdatePersonRequest} [UpdatePersonRequest]
|
|
@@ -155,7 +155,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
155
155
|
*/
|
|
156
156
|
export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
157
157
|
/**
|
|
158
|
-
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
158
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
159
159
|
* @summary Add a new person
|
|
160
160
|
* @param {AddPersonRequest} [AddPersonRequest]
|
|
161
161
|
|
|
@@ -265,7 +265,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
265
265
|
*/
|
|
266
266
|
searchPersons(term: string, fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name', exact_match?: boolean, organization_id?: number, include_fields?: 'person.picture', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonSearchResponse>>;
|
|
267
267
|
/**
|
|
268
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
268
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
269
269
|
* @summary Update a person
|
|
270
270
|
* @param {number} id The ID of the person
|
|
271
271
|
* @param {UpdatePersonRequest} [UpdatePersonRequest]
|
|
@@ -280,7 +280,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
280
280
|
*/
|
|
281
281
|
export declare const PersonsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
282
282
|
/**
|
|
283
|
-
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
283
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
284
284
|
* @summary Add a new person
|
|
285
285
|
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
|
286
286
|
|
|
@@ -360,7 +360,7 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
|
360
360
|
*/
|
|
361
361
|
searchPersons(requestParameters: PersonsApiSearchPersonsRequest): Promise<GetPersonSearchResponse>;
|
|
362
362
|
/**
|
|
363
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
363
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
364
364
|
* @summary Update a person
|
|
365
365
|
* @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
|
|
366
366
|
|
|
@@ -705,7 +705,7 @@ export interface PersonsApiUpdatePersonRequest {
|
|
|
705
705
|
*/
|
|
706
706
|
export declare class PersonsApi extends BaseAPI {
|
|
707
707
|
/**
|
|
708
|
-
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
708
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
709
709
|
* @summary Add a new person
|
|
710
710
|
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
|
711
711
|
|
|
@@ -795,7 +795,7 @@ export declare class PersonsApi extends BaseAPI {
|
|
|
795
795
|
*/
|
|
796
796
|
searchPersons(requestParameters: PersonsApiSearchPersonsRequest): Promise<GetPersonSearchResponse>;
|
|
797
797
|
/**
|
|
798
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
798
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
799
799
|
* @summary Update a person
|
|
800
800
|
* @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
|
|
801
801
|
|
|
@@ -39,7 +39,7 @@ const base_1 = require("../base");
|
|
|
39
39
|
const PersonsApiAxiosParamCreator = function (configuration) {
|
|
40
40
|
return {
|
|
41
41
|
/**
|
|
42
|
-
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
42
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
43
43
|
* @summary Add a new person
|
|
44
44
|
* @param {AddPersonRequest} [AddPersonRequest]
|
|
45
45
|
|
|
@@ -499,7 +499,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
499
499
|
};
|
|
500
500
|
}),
|
|
501
501
|
/**
|
|
502
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
502
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
503
503
|
* @summary Update a person
|
|
504
504
|
* @param {number} id The ID of the person
|
|
505
505
|
* @param {UpdatePersonRequest} [UpdatePersonRequest]
|
|
@@ -546,7 +546,7 @@ const PersonsApiFp = function (configuration) {
|
|
|
546
546
|
const localVarAxiosParamCreator = (0, exports.PersonsApiAxiosParamCreator)(configuration);
|
|
547
547
|
return {
|
|
548
548
|
/**
|
|
549
|
-
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
549
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
550
550
|
* @summary Add a new person
|
|
551
551
|
* @param {AddPersonRequest} [AddPersonRequest]
|
|
552
552
|
|
|
@@ -706,7 +706,7 @@ const PersonsApiFp = function (configuration) {
|
|
|
706
706
|
});
|
|
707
707
|
},
|
|
708
708
|
/**
|
|
709
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
709
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
710
710
|
* @summary Update a person
|
|
711
711
|
* @param {number} id The ID of the person
|
|
712
712
|
* @param {UpdatePersonRequest} [UpdatePersonRequest]
|
|
@@ -730,7 +730,7 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
730
730
|
const localVarFp = (0, exports.PersonsApiFp)(configuration);
|
|
731
731
|
return {
|
|
732
732
|
/**
|
|
733
|
-
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
733
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
734
734
|
* @summary Add a new person
|
|
735
735
|
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
|
736
736
|
|
|
@@ -830,7 +830,7 @@ const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
830
830
|
return localVarFp.searchPersons(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.organization_id, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
831
831
|
},
|
|
832
832
|
/**
|
|
833
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
833
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
834
834
|
* @summary Update a person
|
|
835
835
|
* @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
|
|
836
836
|
|
|
@@ -850,7 +850,7 @@ exports.PersonsApiFactory = PersonsApiFactory;
|
|
|
850
850
|
*/
|
|
851
851
|
class PersonsApi extends base_1.BaseAPI {
|
|
852
852
|
/**
|
|
853
|
-
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
853
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
854
854
|
* @summary Add a new person
|
|
855
855
|
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
|
856
856
|
|
|
@@ -960,7 +960,7 @@ class PersonsApi extends base_1.BaseAPI {
|
|
|
960
960
|
return (0, exports.PersonsApiFp)(this.configuration).searchPersons(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.organization_id, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
961
961
|
}
|
|
962
962
|
/**
|
|
963
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
963
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
964
964
|
* @summary Update a person
|
|
965
965
|
* @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
|
|
966
966
|
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Pipedrive API v2
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Location of the activity
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ActivityItemLocation
|
|
16
|
+
*/
|
|
17
|
+
export interface ActivityItemLocation {
|
|
18
|
+
/**
|
|
19
|
+
* The full address of the activity
|
|
20
|
+
* @type {string}
|
|
21
|
+
*/
|
|
22
|
+
'value'?: string;
|
|
23
|
+
/**
|
|
24
|
+
* Country of the activity
|
|
25
|
+
* @type {string}
|
|
26
|
+
*/
|
|
27
|
+
'country'?: string | null;
|
|
28
|
+
/**
|
|
29
|
+
* Admin area level 1 (e.g. state) of the activity
|
|
30
|
+
* @type {string}
|
|
31
|
+
*/
|
|
32
|
+
'admin_area_level_1'?: string | null;
|
|
33
|
+
/**
|
|
34
|
+
* Admin area level 2 (e.g. county) of the activity
|
|
35
|
+
* @type {string}
|
|
36
|
+
*/
|
|
37
|
+
'admin_area_level_2'?: string | null;
|
|
38
|
+
/**
|
|
39
|
+
* Locality (e.g. city) of the activity
|
|
40
|
+
* @type {string}
|
|
41
|
+
*/
|
|
42
|
+
'locality'?: string | null;
|
|
43
|
+
/**
|
|
44
|
+
* Sublocality (e.g. neighborhood) of the activity
|
|
45
|
+
* @type {string}
|
|
46
|
+
*/
|
|
47
|
+
'sublocality'?: string | null;
|
|
48
|
+
/**
|
|
49
|
+
* Route (e.g. street) of the activity
|
|
50
|
+
* @type {string}
|
|
51
|
+
*/
|
|
52
|
+
'route'?: string | null;
|
|
53
|
+
/**
|
|
54
|
+
* Street number of the activity
|
|
55
|
+
* @type {string}
|
|
56
|
+
*/
|
|
57
|
+
'street_number'?: string | null;
|
|
58
|
+
/**
|
|
59
|
+
* Subpremise (e.g. apartment/suite number) of the activity
|
|
60
|
+
* @type {string}
|
|
61
|
+
*/
|
|
62
|
+
'subpremise'?: string | null;
|
|
63
|
+
/**
|
|
64
|
+
* Postal code of the activity
|
|
65
|
+
* @type {string}
|
|
66
|
+
*/
|
|
67
|
+
'postal_code'?: string | null;
|
|
68
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Pipedrive API v2
|
|
6
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -9,8 +9,8 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import { ActivityItemLocation } from './activity-item-location';
|
|
12
13
|
import { AddActivityRequestAttendeesInner } from './add-activity-request-attendees-inner';
|
|
13
|
-
import { AddActivityRequestLocation } from './add-activity-request-location';
|
|
14
14
|
import { AddActivityRequestParticipantsInner } from './add-activity-request-participants-inner';
|
|
15
15
|
/**
|
|
16
16
|
*
|
|
@@ -62,27 +62,27 @@ export interface ActivityItem {
|
|
|
62
62
|
* The ID of the deal linked to the activity
|
|
63
63
|
* @type {number}
|
|
64
64
|
*/
|
|
65
|
-
'deal_id'?: number;
|
|
65
|
+
'deal_id'?: number | null;
|
|
66
66
|
/**
|
|
67
67
|
* The ID of the lead linked to the activity
|
|
68
68
|
* @type {string}
|
|
69
69
|
*/
|
|
70
|
-
'lead_id'?: string;
|
|
70
|
+
'lead_id'?: string | null;
|
|
71
71
|
/**
|
|
72
72
|
* The ID of the person linked to the activity
|
|
73
73
|
* @type {number}
|
|
74
74
|
*/
|
|
75
|
-
'person_id'?: number;
|
|
75
|
+
'person_id'?: number | null;
|
|
76
76
|
/**
|
|
77
77
|
* The ID of the organization linked to the activity
|
|
78
78
|
* @type {number}
|
|
79
79
|
*/
|
|
80
|
-
'org_id'?: number;
|
|
80
|
+
'org_id'?: number | null;
|
|
81
81
|
/**
|
|
82
82
|
* The ID of the project linked to the activity
|
|
83
83
|
* @type {number}
|
|
84
84
|
*/
|
|
85
|
-
'project_id'?: number;
|
|
85
|
+
'project_id'?: number | null;
|
|
86
86
|
/**
|
|
87
87
|
* The due date of the activity
|
|
88
88
|
* @type {string}
|
|
@@ -92,12 +92,12 @@ export interface ActivityItem {
|
|
|
92
92
|
* The due time of the activity
|
|
93
93
|
* @type {string}
|
|
94
94
|
*/
|
|
95
|
-
'due_time'?: string;
|
|
95
|
+
'due_time'?: string | null;
|
|
96
96
|
/**
|
|
97
97
|
* The duration of the activity
|
|
98
98
|
* @type {string}
|
|
99
99
|
*/
|
|
100
|
-
'duration'?: string;
|
|
100
|
+
'duration'?: string | null;
|
|
101
101
|
/**
|
|
102
102
|
* Whether the activity marks the assignee as busy or not in their calendar
|
|
103
103
|
* @type {boolean}
|
|
@@ -112,12 +112,12 @@ export interface ActivityItem {
|
|
|
112
112
|
* The date and time when the activity was marked as done
|
|
113
113
|
* @type {string}
|
|
114
114
|
*/
|
|
115
|
-
'marked_as_done_time'?: string;
|
|
115
|
+
'marked_as_done_time'?: string | null;
|
|
116
116
|
/**
|
|
117
117
|
*
|
|
118
|
-
* @type {
|
|
118
|
+
* @type {ActivityItemLocation}
|
|
119
119
|
*/
|
|
120
|
-
'location'?:
|
|
120
|
+
'location'?: ActivityItemLocation | null;
|
|
121
121
|
/**
|
|
122
122
|
* The participants of the activity
|
|
123
123
|
* @type {Array<AddActivityRequestParticipantsInner>}
|
|
@@ -44,11 +44,6 @@ export interface AddActivityRequest {
|
|
|
44
44
|
*/
|
|
45
45
|
'lead_id'?: string;
|
|
46
46
|
/**
|
|
47
|
-
* The ID of the person linked to the activity
|
|
48
|
-
* @type {number}
|
|
49
|
-
*/
|
|
50
|
-
'person_id'?: number;
|
|
51
|
-
/**
|
|
52
47
|
* The ID of the organization linked to the activity
|
|
53
48
|
* @type {number}
|
|
54
49
|
*/
|
|
@@ -89,7 +84,7 @@ export interface AddActivityRequest {
|
|
|
89
84
|
*/
|
|
90
85
|
'location'?: AddActivityRequestLocation;
|
|
91
86
|
/**
|
|
92
|
-
* The participants of the activity
|
|
87
|
+
* The participants of the activity. Use this to set the activity\'s person — a primary participant (`primary: true`) sets `person_id` on the activity.
|
|
93
88
|
* @type {Array<AddActivityRequestParticipantsInner>}
|
|
94
89
|
*/
|
|
95
90
|
'participants'?: Array<AddActivityRequestParticipantsInner>;
|
|
@@ -23,7 +23,7 @@ export interface AddPersonRequest {
|
|
|
23
23
|
* The name of the person
|
|
24
24
|
* @type {string}
|
|
25
25
|
*/
|
|
26
|
-
'name'
|
|
26
|
+
'name': string;
|
|
27
27
|
/**
|
|
28
28
|
* The ID of the user who owns the person
|
|
29
29
|
* @type {number}
|
|
@@ -63,24 +63,24 @@ export interface AddPersonRequest {
|
|
|
63
63
|
*
|
|
64
64
|
* @type {PersonItemAddress}
|
|
65
65
|
*/
|
|
66
|
-
'postal_address'?: PersonItemAddress;
|
|
66
|
+
'postal_address'?: PersonItemAddress | null;
|
|
67
67
|
/**
|
|
68
|
-
* Contact sync notes of the person, maximum 10 000 characters
|
|
68
|
+
* Contact sync notes of the person, maximum 10 000 characters. Only accepted when contact sync is enabled for the company; otherwise the request returns 403.
|
|
69
69
|
* @type {string}
|
|
70
70
|
*/
|
|
71
71
|
'notes'?: string;
|
|
72
72
|
/**
|
|
73
|
-
* The instant messaging accounts of the person
|
|
73
|
+
* The instant messaging accounts of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403.
|
|
74
74
|
* @type {Array<PersonItemIm>}
|
|
75
75
|
*/
|
|
76
76
|
'im'?: Array<PersonItemIm>;
|
|
77
77
|
/**
|
|
78
|
-
* The birthday of the person
|
|
78
|
+
* The birthday of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403.
|
|
79
79
|
* @type {string}
|
|
80
80
|
*/
|
|
81
81
|
'birthday'?: string;
|
|
82
82
|
/**
|
|
83
|
-
* The job title of the person
|
|
83
|
+
* The job title of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403.
|
|
84
84
|
* @type {string}
|
|
85
85
|
*/
|
|
86
86
|
'job_title'?: string;
|
|
@@ -19,5 +19,5 @@ export interface GetActivitiesResponseAllOfAdditionalData {
|
|
|
19
19
|
* The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned.
|
|
20
20
|
* @type {string}
|
|
21
21
|
*/
|
|
22
|
-
'next_cursor'?: string;
|
|
22
|
+
'next_cursor'?: string | null;
|
|
23
23
|
}
|
|
@@ -19,5 +19,5 @@ export interface GetDealsProductsResponseAdditionalData {
|
|
|
19
19
|
* The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned.
|
|
20
20
|
* @type {string}
|
|
21
21
|
*/
|
|
22
|
-
'next_cursor'?: string;
|
|
22
|
+
'next_cursor'?: string | null;
|
|
23
23
|
}
|
package/dist/versions/v2/models/get-product-search-response-all-of-data-items-inner-item.d.ts
CHANGED
|
@@ -33,9 +33,9 @@ export interface GetProductSearchResponseAllOfDataItemsInnerItem {
|
|
|
33
33
|
'name'?: string;
|
|
34
34
|
/**
|
|
35
35
|
* The code of the product
|
|
36
|
-
* @type {
|
|
36
|
+
* @type {string}
|
|
37
37
|
*/
|
|
38
|
-
'code'?:
|
|
38
|
+
'code'?: string | null;
|
|
39
39
|
/**
|
|
40
40
|
* The visibility of the product
|
|
41
41
|
* @type {number}
|
|
@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
__exportStar(require("./activity-item"), exports);
|
|
18
|
+
__exportStar(require("./activity-item-location"), exports);
|
|
18
19
|
__exportStar(require("./add-ainstallment-response"), exports);
|
|
19
20
|
__exportStar(require("./add-activity-request"), exports);
|
|
20
21
|
__exportStar(require("./add-activity-request-attendees-inner"), exports);
|
|
@@ -24,45 +24,45 @@ export interface OrganizationItemAddress {
|
|
|
24
24
|
* Country of the organization
|
|
25
25
|
* @type {string}
|
|
26
26
|
*/
|
|
27
|
-
'country'?: string;
|
|
27
|
+
'country'?: string | null;
|
|
28
28
|
/**
|
|
29
29
|
* Admin area level 1 (e.g. state) of the organization
|
|
30
30
|
* @type {string}
|
|
31
31
|
*/
|
|
32
|
-
'admin_area_level_1'?: string;
|
|
32
|
+
'admin_area_level_1'?: string | null;
|
|
33
33
|
/**
|
|
34
34
|
* Admin area level 2 (e.g. county) of the organization
|
|
35
35
|
* @type {string}
|
|
36
36
|
*/
|
|
37
|
-
'admin_area_level_2'?: string;
|
|
37
|
+
'admin_area_level_2'?: string | null;
|
|
38
38
|
/**
|
|
39
39
|
* Locality (e.g. city) of the organization
|
|
40
40
|
* @type {string}
|
|
41
41
|
*/
|
|
42
|
-
'locality'?: string;
|
|
42
|
+
'locality'?: string | null;
|
|
43
43
|
/**
|
|
44
44
|
* Sublocality (e.g. neighborhood) of the organization
|
|
45
45
|
* @type {string}
|
|
46
46
|
*/
|
|
47
|
-
'sublocality'?: string;
|
|
47
|
+
'sublocality'?: string | null;
|
|
48
48
|
/**
|
|
49
49
|
* Route (e.g. street) of the organization
|
|
50
50
|
* @type {string}
|
|
51
51
|
*/
|
|
52
|
-
'route'?: string;
|
|
52
|
+
'route'?: string | null;
|
|
53
53
|
/**
|
|
54
54
|
* Street number of the organization
|
|
55
55
|
* @type {string}
|
|
56
56
|
*/
|
|
57
|
-
'street_number'?: string;
|
|
57
|
+
'street_number'?: string | null;
|
|
58
58
|
/**
|
|
59
59
|
* Subpremise (e.g. apartment/suite number) of the organization
|
|
60
60
|
* @type {string}
|
|
61
61
|
*/
|
|
62
|
-
'subpremise'?: string;
|
|
62
|
+
'subpremise'?: string | null;
|
|
63
63
|
/**
|
|
64
64
|
* Postal code of the organization
|
|
65
65
|
* @type {string}
|
|
66
66
|
*/
|
|
67
|
-
'postal_code'?: string;
|
|
67
|
+
'postal_code'?: string | null;
|
|
68
68
|
}
|
|
@@ -40,7 +40,7 @@ export interface OrganizationItem {
|
|
|
40
40
|
* The last updated date and time of the organization
|
|
41
41
|
* @type {string}
|
|
42
42
|
*/
|
|
43
|
-
'update_time'?: string;
|
|
43
|
+
'update_time'?: string | null;
|
|
44
44
|
/**
|
|
45
45
|
* Whether the organization is deleted or not
|
|
46
46
|
* @type {boolean}
|
|
@@ -55,7 +55,7 @@ export interface OrganizationItem {
|
|
|
55
55
|
*
|
|
56
56
|
* @type {OrganizationItemAddress}
|
|
57
57
|
*/
|
|
58
|
-
'address'?: OrganizationItemAddress;
|
|
58
|
+
'address'?: OrganizationItemAddress | null;
|
|
59
59
|
/**
|
|
60
60
|
* The IDs of labels assigned to the organization
|
|
61
61
|
* @type {Array<number>}
|