pipedrive 33.7.2 → 33.8.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.
@@ -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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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
 
@@ -33,7 +33,7 @@ import { BASE_PATH, BaseAPI } from '../base';
33
33
  export const PersonsApiAxiosParamCreator = function (configuration) {
34
34
  return {
35
35
  /**
36
- * 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.
36
+ * 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.
37
37
  * @summary Add a new person
38
38
  * @param {AddPersonRequest} [AddPersonRequest]
39
39
 
@@ -493,7 +493,7 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
493
493
  };
494
494
  }),
495
495
  /**
496
- * 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.
496
+ * 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.
497
497
  * @summary Update a person
498
498
  * @param {number} id The ID of the person
499
499
  * @param {UpdatePersonRequest} [UpdatePersonRequest]
@@ -539,7 +539,7 @@ export const PersonsApiFp = function (configuration) {
539
539
  const localVarAxiosParamCreator = PersonsApiAxiosParamCreator(configuration);
540
540
  return {
541
541
  /**
542
- * 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.
542
+ * 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.
543
543
  * @summary Add a new person
544
544
  * @param {AddPersonRequest} [AddPersonRequest]
545
545
 
@@ -699,7 +699,7 @@ export const PersonsApiFp = function (configuration) {
699
699
  });
700
700
  },
701
701
  /**
702
- * 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.
702
+ * 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.
703
703
  * @summary Update a person
704
704
  * @param {number} id The ID of the person
705
705
  * @param {UpdatePersonRequest} [UpdatePersonRequest]
@@ -722,7 +722,7 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
722
722
  const localVarFp = PersonsApiFp(configuration);
723
723
  return {
724
724
  /**
725
- * 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.
725
+ * 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.
726
726
  * @summary Add a new person
727
727
  * @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
728
728
 
@@ -822,7 +822,7 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
822
822
  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));
823
823
  },
824
824
  /**
825
- * 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.
825
+ * 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.
826
826
  * @summary Update a person
827
827
  * @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
828
828
 
@@ -841,7 +841,7 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
841
841
  */
842
842
  export class PersonsApi extends BaseAPI {
843
843
  /**
844
- * 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.
844
+ * 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.
845
845
  * @summary Add a new person
846
846
  * @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
847
847
 
@@ -951,7 +951,7 @@ export class PersonsApi extends BaseAPI {
951
951
  return 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));
952
952
  }
953
953
  /**
954
- * 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.
954
+ * 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.
955
955
  * @summary Update a person
956
956
  * @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
957
957
 
@@ -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'?: string;
26
+ 'name': string;
27
27
  /**
28
28
  * The ID of the user who owns the person
29
29
  * @type {number}
@@ -65,22 +65,22 @@ export interface AddPersonRequest {
65
65
  */
66
66
  'postal_address'?: PersonItemAddress;
67
67
  /**
68
- * Contact sync notes of the person, maximum 10 000 characters, included if contact sync is enabled for the company
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, included if contact sync is enabled for the company
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, included if contact sync is enabled for the company
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, included if contact sync is enabled for the company
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;
@@ -60,22 +60,22 @@ export interface UpdatePersonRequest {
60
60
  */
61
61
  'postal_address'?: PersonItemAddress;
62
62
  /**
63
- * Contact sync notes of the person, maximum 10 000 characters, included if contact sync is enabled for the company
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, included if contact sync is enabled for the company
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, included if contact sync is enabled for the company
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, included if contact sync is enabled for the company
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;
@@ -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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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’t exist by default in Pipedrive and are only created when you set up your contact sync.
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
 
@@ -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'?: string;
26
+ 'name': string;
27
27
  /**
28
28
  * The ID of the user who owns the person
29
29
  * @type {number}
@@ -65,22 +65,22 @@ export interface AddPersonRequest {
65
65
  */
66
66
  'postal_address'?: PersonItemAddress;
67
67
  /**
68
- * Contact sync notes of the person, maximum 10 000 characters, included if contact sync is enabled for the company
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, included if contact sync is enabled for the company
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, included if contact sync is enabled for the company
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, included if contact sync is enabled for the company
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;
@@ -60,22 +60,22 @@ export interface UpdatePersonRequest {
60
60
  */
61
61
  'postal_address'?: PersonItemAddress;
62
62
  /**
63
- * Contact sync notes of the person, maximum 10 000 characters, included if contact sync is enabled for the company
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, included if contact sync is enabled for the company
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, included if contact sync is enabled for the company
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, included if contact sync is enabled for the company
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;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pipedrive",
3
- "version": "33.7.2",
3
+ "version": "33.8.0",
4
4
  "description": "Pipedrive REST client for NodeJS",
5
5
  "license": "MIT",
6
6
  "homepage": "https://developers.pipedrive.com",