pipedrive 33.7.1 → 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.
@@ -42,7 +42,7 @@ const LegacyTeamsApiAxiosParamCreator = function (configuration) {
42
42
  * Adds a new team to the company and returns the created object.
43
43
  * @summary Add a new team
44
44
  * @param {AddTeamRequest1} [AddTeamRequest1]
45
- * @deprecated
45
+
46
46
  * @throws {RequiredError}
47
47
  */
48
48
  addTeam: (AddTeamRequest1) => __awaiter(this, void 0, void 0, function* () {
@@ -76,7 +76,7 @@ const LegacyTeamsApiAxiosParamCreator = function (configuration) {
76
76
  * @summary Add users to a team
77
77
  * @param {number} id The ID of the team
78
78
  * @param {AddTeamUserRequest} [AddTeamUserRequest]
79
- * @deprecated
79
+
80
80
  * @throws {RequiredError}
81
81
  */
82
82
  addTeamUser: (id, AddTeamUserRequest) => __awaiter(this, void 0, void 0, function* () {
@@ -113,7 +113,7 @@ const LegacyTeamsApiAxiosParamCreator = function (configuration) {
113
113
  * @summary Delete users from a team
114
114
  * @param {number} id The ID of the team
115
115
  * @param {DeleteTeamUserRequest} [DeleteTeamUserRequest]
116
- * @deprecated
116
+
117
117
  * @throws {RequiredError}
118
118
  */
119
119
  deleteTeamUser: (id, DeleteTeamUserRequest) => __awaiter(this, void 0, void 0, function* () {
@@ -150,7 +150,7 @@ const LegacyTeamsApiAxiosParamCreator = function (configuration) {
150
150
  * @summary Get a single team
151
151
  * @param {number} id The ID of the team
152
152
  * @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
153
- * @deprecated
153
+
154
154
  * @throws {RequiredError}
155
155
  */
156
156
  getTeam: (id, skip_users) => __awaiter(this, void 0, void 0, function* () {
@@ -187,7 +187,7 @@ const LegacyTeamsApiAxiosParamCreator = function (configuration) {
187
187
  * Returns a list of all user IDs within a team.
188
188
  * @summary Get all users in a team
189
189
  * @param {number} id The ID of the team
190
- * @deprecated
190
+
191
191
  * @throws {RequiredError}
192
192
  */
193
193
  getTeamUsers: (id) => __awaiter(this, void 0, void 0, function* () {
@@ -222,7 +222,7 @@ const LegacyTeamsApiAxiosParamCreator = function (configuration) {
222
222
  * @summary Get all teams
223
223
  * @param {'id' | 'name' | 'manager_id' | 'active_flag'} [order_by] The field name to sort returned teams by
224
224
  * @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
225
- * @deprecated
225
+
226
226
  * @throws {RequiredError}
227
227
  */
228
228
  getTeams: (order_by, skip_users) => __awaiter(this, void 0, void 0, function* () {
@@ -261,7 +261,7 @@ const LegacyTeamsApiAxiosParamCreator = function (configuration) {
261
261
  * @param {number} id The ID of the user
262
262
  * @param {'id' | 'name' | 'manager_id' | 'active_flag'} [order_by] The field name to sort returned teams by
263
263
  * @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
264
- * @deprecated
264
+
265
265
  * @throws {RequiredError}
266
266
  */
267
267
  getUserTeams: (id, order_by, skip_users) => __awaiter(this, void 0, void 0, function* () {
@@ -302,7 +302,7 @@ const LegacyTeamsApiAxiosParamCreator = function (configuration) {
302
302
  * @summary Update a team
303
303
  * @param {number} id The ID of the team
304
304
  * @param {UpdateTeamRequest} [UpdateTeamRequest]
305
- * @deprecated
305
+
306
306
  * @throws {RequiredError}
307
307
  */
308
308
  updateTeam: (id, UpdateTeamRequest) => __awaiter(this, void 0, void 0, function* () {
@@ -348,7 +348,7 @@ const LegacyTeamsApiFp = function (configuration) {
348
348
  * Adds a new team to the company and returns the created object.
349
349
  * @summary Add a new team
350
350
  * @param {AddTeamRequest1} [AddTeamRequest1]
351
- * @deprecated
351
+
352
352
  * @throws {RequiredError}
353
353
  */
354
354
  addTeam(AddTeamRequest1) {
@@ -362,7 +362,7 @@ const LegacyTeamsApiFp = function (configuration) {
362
362
  * @summary Add users to a team
363
363
  * @param {number} id The ID of the team
364
364
  * @param {AddTeamUserRequest} [AddTeamUserRequest]
365
- * @deprecated
365
+
366
366
  * @throws {RequiredError}
367
367
  */
368
368
  addTeamUser(id, AddTeamUserRequest) {
@@ -376,7 +376,7 @@ const LegacyTeamsApiFp = function (configuration) {
376
376
  * @summary Delete users from a team
377
377
  * @param {number} id The ID of the team
378
378
  * @param {DeleteTeamUserRequest} [DeleteTeamUserRequest]
379
- * @deprecated
379
+
380
380
  * @throws {RequiredError}
381
381
  */
382
382
  deleteTeamUser(id, DeleteTeamUserRequest) {
@@ -390,7 +390,7 @@ const LegacyTeamsApiFp = function (configuration) {
390
390
  * @summary Get a single team
391
391
  * @param {number} id The ID of the team
392
392
  * @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
393
- * @deprecated
393
+
394
394
  * @throws {RequiredError}
395
395
  */
396
396
  getTeam(id, skip_users) {
@@ -403,7 +403,7 @@ const LegacyTeamsApiFp = function (configuration) {
403
403
  * Returns a list of all user IDs within a team.
404
404
  * @summary Get all users in a team
405
405
  * @param {number} id The ID of the team
406
- * @deprecated
406
+
407
407
  * @throws {RequiredError}
408
408
  */
409
409
  getTeamUsers(id) {
@@ -417,7 +417,7 @@ const LegacyTeamsApiFp = function (configuration) {
417
417
  * @summary Get all teams
418
418
  * @param {'id' | 'name' | 'manager_id' | 'active_flag'} [order_by] The field name to sort returned teams by
419
419
  * @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
420
- * @deprecated
420
+
421
421
  * @throws {RequiredError}
422
422
  */
423
423
  getTeams(order_by, skip_users) {
@@ -432,7 +432,7 @@ const LegacyTeamsApiFp = function (configuration) {
432
432
  * @param {number} id The ID of the user
433
433
  * @param {'id' | 'name' | 'manager_id' | 'active_flag'} [order_by] The field name to sort returned teams by
434
434
  * @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
435
- * @deprecated
435
+
436
436
  * @throws {RequiredError}
437
437
  */
438
438
  getUserTeams(id, order_by, skip_users) {
@@ -446,7 +446,7 @@ const LegacyTeamsApiFp = function (configuration) {
446
446
  * @summary Update a team
447
447
  * @param {number} id The ID of the team
448
448
  * @param {UpdateTeamRequest} [UpdateTeamRequest]
449
- * @deprecated
449
+
450
450
  * @throws {RequiredError}
451
451
  */
452
452
  updateTeam(id, UpdateTeamRequest) {
@@ -469,7 +469,7 @@ const LegacyTeamsApiFactory = function (configuration, basePath, axios) {
469
469
  * Adds a new team to the company and returns the created object.
470
470
  * @summary Add a new team
471
471
  * @param {LegacyTeamsApiAddTeamRequest} requestParameters Request parameters.
472
- * @deprecated
472
+
473
473
  * @throws {RequiredError}
474
474
  */
475
475
  addTeam(requestParameters = {}) {
@@ -479,7 +479,7 @@ const LegacyTeamsApiFactory = function (configuration, basePath, axios) {
479
479
  * Adds users to an existing team.
480
480
  * @summary Add users to a team
481
481
  * @param {LegacyTeamsApiAddTeamUserRequest} requestParameters Request parameters.
482
- * @deprecated
482
+
483
483
  * @throws {RequiredError}
484
484
  */
485
485
  addTeamUser(requestParameters) {
@@ -489,7 +489,7 @@ const LegacyTeamsApiFactory = function (configuration, basePath, axios) {
489
489
  * Deletes users from an existing team.
490
490
  * @summary Delete users from a team
491
491
  * @param {LegacyTeamsApiDeleteTeamUserRequest} requestParameters Request parameters.
492
- * @deprecated
492
+
493
493
  * @throws {RequiredError}
494
494
  */
495
495
  deleteTeamUser(requestParameters) {
@@ -499,7 +499,7 @@ const LegacyTeamsApiFactory = function (configuration, basePath, axios) {
499
499
  * Returns data about a specific team.
500
500
  * @summary Get a single team
501
501
  * @param {LegacyTeamsApiGetTeamRequest} requestParameters Request parameters.
502
- * @deprecated
502
+
503
503
  * @throws {RequiredError}
504
504
  */
505
505
  getTeam(requestParameters) {
@@ -509,7 +509,7 @@ const LegacyTeamsApiFactory = function (configuration, basePath, axios) {
509
509
  * Returns a list of all user IDs within a team.
510
510
  * @summary Get all users in a team
511
511
  * @param {LegacyTeamsApiGetTeamUsersRequest} requestParameters Request parameters.
512
- * @deprecated
512
+
513
513
  * @throws {RequiredError}
514
514
  */
515
515
  getTeamUsers(requestParameters) {
@@ -519,7 +519,7 @@ const LegacyTeamsApiFactory = function (configuration, basePath, axios) {
519
519
  * Returns data about teams within the company.
520
520
  * @summary Get all teams
521
521
  * @param {LegacyTeamsApiGetTeamsRequest} requestParameters Request parameters.
522
- * @deprecated
522
+
523
523
  * @throws {RequiredError}
524
524
  */
525
525
  getTeams(requestParameters = {}) {
@@ -529,7 +529,7 @@ const LegacyTeamsApiFactory = function (configuration, basePath, axios) {
529
529
  * Returns data about all teams which have the specified user as a member.
530
530
  * @summary Get all teams of a user
531
531
  * @param {LegacyTeamsApiGetUserTeamsRequest} requestParameters Request parameters.
532
- * @deprecated
532
+
533
533
  * @throws {RequiredError}
534
534
  */
535
535
  getUserTeams(requestParameters) {
@@ -539,7 +539,7 @@ const LegacyTeamsApiFactory = function (configuration, basePath, axios) {
539
539
  * Updates an existing team and returns the updated object.
540
540
  * @summary Update a team
541
541
  * @param {LegacyTeamsApiUpdateTeamRequest} requestParameters Request parameters.
542
- * @deprecated
542
+
543
543
  * @throws {RequiredError}
544
544
  */
545
545
  updateTeam(requestParameters) {
@@ -559,7 +559,7 @@ class LegacyTeamsApi extends base_1.BaseAPI {
559
559
  * Adds a new team to the company and returns the created object.
560
560
  * @summary Add a new team
561
561
  * @param {LegacyTeamsApiAddTeamRequest} requestParameters Request parameters.
562
- * @deprecated
562
+
563
563
  * @throws {RequiredError}
564
564
  * @memberof LegacyTeamsApi
565
565
  */
@@ -570,7 +570,7 @@ class LegacyTeamsApi extends base_1.BaseAPI {
570
570
  * Adds users to an existing team.
571
571
  * @summary Add users to a team
572
572
  * @param {LegacyTeamsApiAddTeamUserRequest} requestParameters Request parameters.
573
- * @deprecated
573
+
574
574
  * @throws {RequiredError}
575
575
  * @memberof LegacyTeamsApi
576
576
  */
@@ -581,7 +581,7 @@ class LegacyTeamsApi extends base_1.BaseAPI {
581
581
  * Deletes users from an existing team.
582
582
  * @summary Delete users from a team
583
583
  * @param {LegacyTeamsApiDeleteTeamUserRequest} requestParameters Request parameters.
584
- * @deprecated
584
+
585
585
  * @throws {RequiredError}
586
586
  * @memberof LegacyTeamsApi
587
587
  */
@@ -592,7 +592,7 @@ class LegacyTeamsApi extends base_1.BaseAPI {
592
592
  * Returns data about a specific team.
593
593
  * @summary Get a single team
594
594
  * @param {LegacyTeamsApiGetTeamRequest} requestParameters Request parameters.
595
- * @deprecated
595
+
596
596
  * @throws {RequiredError}
597
597
  * @memberof LegacyTeamsApi
598
598
  */
@@ -603,7 +603,7 @@ class LegacyTeamsApi extends base_1.BaseAPI {
603
603
  * Returns a list of all user IDs within a team.
604
604
  * @summary Get all users in a team
605
605
  * @param {LegacyTeamsApiGetTeamUsersRequest} requestParameters Request parameters.
606
- * @deprecated
606
+
607
607
  * @throws {RequiredError}
608
608
  * @memberof LegacyTeamsApi
609
609
  */
@@ -614,7 +614,7 @@ class LegacyTeamsApi extends base_1.BaseAPI {
614
614
  * Returns data about teams within the company.
615
615
  * @summary Get all teams
616
616
  * @param {LegacyTeamsApiGetTeamsRequest} requestParameters Request parameters.
617
- * @deprecated
617
+
618
618
  * @throws {RequiredError}
619
619
  * @memberof LegacyTeamsApi
620
620
  */
@@ -625,7 +625,7 @@ class LegacyTeamsApi extends base_1.BaseAPI {
625
625
  * Returns data about all teams which have the specified user as a member.
626
626
  * @summary Get all teams of a user
627
627
  * @param {LegacyTeamsApiGetUserTeamsRequest} requestParameters Request parameters.
628
- * @deprecated
628
+
629
629
  * @throws {RequiredError}
630
630
  * @memberof LegacyTeamsApi
631
631
  */
@@ -636,7 +636,7 @@ class LegacyTeamsApi extends base_1.BaseAPI {
636
636
  * Updates an existing team and returns the updated object.
637
637
  * @summary Update a team
638
638
  * @param {LegacyTeamsApiUpdateTeamRequest} requestParameters Request parameters.
639
- * @deprecated
639
+
640
640
  * @throws {RequiredError}
641
641
  * @memberof LegacyTeamsApi
642
642
  */
@@ -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.1",
3
+ "version": "33.8.0",
4
4
  "description": "Pipedrive REST client for NodeJS",
5
5
  "license": "MIT",
6
6
  "homepage": "https://developers.pipedrive.com",