pipedrive 24.2.0 → 25.0.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.
Files changed (113) hide show
  1. package/dist/esm/versions/v1/api/deals-api.d.ts +3 -3
  2. package/dist/esm/versions/v1/api/deals-api.js +2 -2
  3. package/dist/esm/versions/v1/api/organizations-api.d.ts +3 -3
  4. package/dist/esm/versions/v1/api/organizations-api.js +2 -2
  5. package/dist/esm/versions/v1/api/persons-api.d.ts +3 -3
  6. package/dist/esm/versions/v1/api/persons-api.js +2 -2
  7. package/dist/esm/versions/v1/api/subscriptions-api.d.ts +36 -36
  8. package/dist/esm/versions/v1/api/subscriptions-api.js +36 -36
  9. package/dist/esm/versions/v1/api/webhooks-api.d.ts +4 -4
  10. package/dist/esm/versions/v1/api/webhooks-api.js +4 -4
  11. package/dist/esm/versions/v1/models/add-webhook-request.d.ts +5 -6
  12. package/dist/esm/versions/v1/models/add-webhook-request.js +4 -5
  13. package/dist/esm/versions/v1/models/user-access.d.ts +3 -2
  14. package/dist/esm/versions/v1/models/user-access.js +4 -3
  15. package/dist/esm/versions/v1/models/user-access1.d.ts +3 -2
  16. package/dist/esm/versions/v1/models/user-access1.js +4 -3
  17. package/dist/esm/versions/v2/api/beta-api.d.ts +82 -2632
  18. package/dist/esm/versions/v2/api/beta-api.js +139 -3090
  19. package/dist/esm/versions/v2/api/deals-api.d.ts +237 -0
  20. package/dist/esm/versions/v2/api/deals-api.js +301 -0
  21. package/dist/esm/versions/v2/api/organizations-api.d.ts +237 -0
  22. package/dist/esm/versions/v2/api/organizations-api.js +301 -0
  23. package/dist/esm/versions/v2/api/persons-api.d.ts +237 -0
  24. package/dist/esm/versions/v2/api/persons-api.js +301 -0
  25. package/dist/esm/versions/v2/api/products-api.d.ts +237 -0
  26. package/dist/esm/versions/v2/api/products-api.js +301 -0
  27. package/dist/esm/versions/v2/api/users-api.d.ts +103 -0
  28. package/dist/esm/versions/v2/api/users-api.js +140 -0
  29. package/dist/esm/versions/v2/api.d.ts +1 -0
  30. package/dist/esm/versions/v2/api.js +1 -0
  31. package/dist/esm/versions/v2/models/add-deal-follower-request.d.ts +23 -0
  32. package/dist/esm/versions/v2/models/add-deal-follower-request.js +14 -0
  33. package/dist/esm/versions/v2/models/add-follower-response-all-of.d.ts +24 -0
  34. package/dist/esm/versions/v2/models/add-follower-response-all-of.js +14 -0
  35. package/dist/esm/versions/v2/models/add-follower-response.d.ts +18 -0
  36. package/dist/esm/versions/v2/models/add-follower-response.js +14 -0
  37. package/dist/esm/versions/v2/models/delete-follower-response-data.d.ts +23 -0
  38. package/dist/esm/versions/v2/models/delete-follower-response-data.js +14 -0
  39. package/dist/esm/versions/v2/models/delete-follower-response.d.ts +29 -0
  40. package/dist/esm/versions/v2/models/delete-follower-response.js +14 -0
  41. package/dist/esm/versions/v2/models/follower-changelog-item.d.ts +38 -0
  42. package/dist/esm/versions/v2/models/follower-changelog-item.js +14 -0
  43. package/dist/esm/versions/v2/models/follower-item.d.ts +28 -0
  44. package/dist/esm/versions/v2/models/follower-item.js +14 -0
  45. package/dist/esm/versions/v2/models/follower-item1.d.ts +28 -0
  46. package/dist/esm/versions/v2/models/follower-item1.js +14 -0
  47. package/dist/esm/versions/v2/models/get-follower-changelogs-response-all-of.d.ts +30 -0
  48. package/dist/esm/versions/v2/models/get-follower-changelogs-response-all-of.js +14 -0
  49. package/dist/esm/versions/v2/models/get-follower-changelogs-response.d.ts +18 -0
  50. package/dist/esm/versions/v2/models/get-follower-changelogs-response.js +14 -0
  51. package/dist/esm/versions/v2/models/get-followers-response-all-of.d.ts +30 -0
  52. package/dist/esm/versions/v2/models/get-followers-response-all-of.js +14 -0
  53. package/dist/esm/versions/v2/models/get-followers-response.d.ts +18 -0
  54. package/dist/esm/versions/v2/models/get-followers-response.js +14 -0
  55. package/dist/esm/versions/v2/models/index.d.ts +12 -0
  56. package/dist/esm/versions/v2/models/index.js +12 -0
  57. package/dist/versions/v1/api/deals-api.d.ts +3 -3
  58. package/dist/versions/v1/api/deals-api.js +2 -2
  59. package/dist/versions/v1/api/organizations-api.d.ts +3 -3
  60. package/dist/versions/v1/api/organizations-api.js +2 -2
  61. package/dist/versions/v1/api/persons-api.d.ts +3 -3
  62. package/dist/versions/v1/api/persons-api.js +2 -2
  63. package/dist/versions/v1/api/subscriptions-api.d.ts +36 -36
  64. package/dist/versions/v1/api/subscriptions-api.js +36 -36
  65. package/dist/versions/v1/api/webhooks-api.d.ts +4 -4
  66. package/dist/versions/v1/api/webhooks-api.js +4 -4
  67. package/dist/versions/v1/models/add-webhook-request.d.ts +5 -6
  68. package/dist/versions/v1/models/add-webhook-request.js +4 -5
  69. package/dist/versions/v1/models/user-access.d.ts +3 -2
  70. package/dist/versions/v1/models/user-access.js +4 -3
  71. package/dist/versions/v1/models/user-access1.d.ts +3 -2
  72. package/dist/versions/v1/models/user-access1.js +4 -3
  73. package/dist/versions/v2/api/beta-api.d.ts +82 -2632
  74. package/dist/versions/v2/api/beta-api.js +141 -3092
  75. package/dist/versions/v2/api/deals-api.d.ts +237 -0
  76. package/dist/versions/v2/api/deals-api.js +301 -0
  77. package/dist/versions/v2/api/organizations-api.d.ts +237 -0
  78. package/dist/versions/v2/api/organizations-api.js +301 -0
  79. package/dist/versions/v2/api/persons-api.d.ts +237 -0
  80. package/dist/versions/v2/api/persons-api.js +301 -0
  81. package/dist/versions/v2/api/products-api.d.ts +237 -0
  82. package/dist/versions/v2/api/products-api.js +301 -0
  83. package/dist/versions/v2/api/users-api.d.ts +103 -0
  84. package/dist/versions/v2/api/users-api.js +150 -0
  85. package/dist/versions/v2/api.d.ts +1 -0
  86. package/dist/versions/v2/api.js +1 -0
  87. package/dist/versions/v2/models/add-deal-follower-request.d.ts +23 -0
  88. package/dist/versions/v2/models/add-deal-follower-request.js +15 -0
  89. package/dist/versions/v2/models/add-follower-response-all-of.d.ts +24 -0
  90. package/dist/versions/v2/models/add-follower-response-all-of.js +15 -0
  91. package/dist/versions/v2/models/add-follower-response.d.ts +18 -0
  92. package/dist/versions/v2/models/add-follower-response.js +15 -0
  93. package/dist/versions/v2/models/delete-follower-response-data.d.ts +23 -0
  94. package/dist/versions/v2/models/delete-follower-response-data.js +15 -0
  95. package/dist/versions/v2/models/delete-follower-response.d.ts +29 -0
  96. package/dist/versions/v2/models/delete-follower-response.js +15 -0
  97. package/dist/versions/v2/models/follower-changelog-item.d.ts +38 -0
  98. package/dist/versions/v2/models/follower-changelog-item.js +15 -0
  99. package/dist/versions/v2/models/follower-item.d.ts +28 -0
  100. package/dist/versions/v2/models/follower-item.js +15 -0
  101. package/dist/versions/v2/models/follower-item1.d.ts +28 -0
  102. package/dist/versions/v2/models/follower-item1.js +15 -0
  103. package/dist/versions/v2/models/get-follower-changelogs-response-all-of.d.ts +30 -0
  104. package/dist/versions/v2/models/get-follower-changelogs-response-all-of.js +15 -0
  105. package/dist/versions/v2/models/get-follower-changelogs-response.d.ts +18 -0
  106. package/dist/versions/v2/models/get-follower-changelogs-response.js +15 -0
  107. package/dist/versions/v2/models/get-followers-response-all-of.d.ts +30 -0
  108. package/dist/versions/v2/models/get-followers-response-all-of.js +15 -0
  109. package/dist/versions/v2/models/get-followers-response.d.ts +18 -0
  110. package/dist/versions/v2/models/get-followers-response.js +15 -0
  111. package/dist/versions/v2/models/index.d.ts +12 -0
  112. package/dist/versions/v2/models/index.js +12 -0
  113. package/package.json +1 -1
@@ -22,7 +22,7 @@ import { GetWebhooksResponse } from '../models';
22
22
  */
23
23
  export declare const WebhooksApiAxiosParamCreator: (configuration?: Configuration) => {
24
24
  /**
25
- * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `added.deal` for any newly added deals, `deleted.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
25
+ * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `create.deal` for any newly added deals, `delete.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks-v2?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
26
26
  * @summary Create a new Webhook
27
27
  * @param {AddWebhookRequest} [AddWebhookRequest]
28
28
 
@@ -51,7 +51,7 @@ export declare const WebhooksApiAxiosParamCreator: (configuration?: Configuratio
51
51
  */
52
52
  export declare const WebhooksApiFp: (configuration?: Configuration) => {
53
53
  /**
54
- * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `added.deal` for any newly added deals, `deleted.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
54
+ * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `create.deal` for any newly added deals, `delete.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks-v2?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
55
55
  * @summary Create a new Webhook
56
56
  * @param {AddWebhookRequest} [AddWebhookRequest]
57
57
 
@@ -80,7 +80,7 @@ export declare const WebhooksApiFp: (configuration?: Configuration) => {
80
80
  */
81
81
  export declare const WebhooksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
82
82
  /**
83
- * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `added.deal` for any newly added deals, `deleted.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
83
+ * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `create.deal` for any newly added deals, `delete.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks-v2?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
84
84
  * @summary Create a new Webhook
85
85
  * @param {WebhooksApiAddWebhookRequest} requestParameters Request parameters.
86
86
 
@@ -137,7 +137,7 @@ export interface WebhooksApiDeleteWebhookRequest {
137
137
  */
138
138
  export declare class WebhooksApi extends BaseAPI {
139
139
  /**
140
- * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `added.deal` for any newly added deals, `deleted.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
140
+ * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `create.deal` for any newly added deals, `delete.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks-v2?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
141
141
  * @summary Create a new Webhook
142
142
  * @param {WebhooksApiAddWebhookRequest} requestParameters Request parameters.
143
143
 
@@ -39,7 +39,7 @@ const base_1 = require("../base");
39
39
  const WebhooksApiAxiosParamCreator = function (configuration) {
40
40
  return {
41
41
  /**
42
- * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `added.deal` for any newly added deals, `deleted.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
42
+ * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `create.deal` for any newly added deals, `delete.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks-v2?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
43
43
  * @summary Create a new Webhook
44
44
  * @param {AddWebhookRequest} [AddWebhookRequest]
45
45
 
@@ -146,7 +146,7 @@ const WebhooksApiFp = function (configuration) {
146
146
  const localVarAxiosParamCreator = (0, exports.WebhooksApiAxiosParamCreator)(configuration);
147
147
  return {
148
148
  /**
149
- * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `added.deal` for any newly added deals, `deleted.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
149
+ * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `create.deal` for any newly added deals, `delete.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks-v2?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
150
150
  * @summary Create a new Webhook
151
151
  * @param {AddWebhookRequest} [AddWebhookRequest]
152
152
 
@@ -194,7 +194,7 @@ const WebhooksApiFactory = function (configuration, basePath, axios) {
194
194
  const localVarFp = (0, exports.WebhooksApiFp)(configuration);
195
195
  return {
196
196
  /**
197
- * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `added.deal` for any newly added deals, `deleted.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
197
+ * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `create.deal` for any newly added deals, `delete.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks-v2?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
198
198
  * @summary Create a new Webhook
199
199
  * @param {WebhooksApiAddWebhookRequest} requestParameters Request parameters.
200
200
 
@@ -233,7 +233,7 @@ exports.WebhooksApiFactory = WebhooksApiFactory;
233
233
  */
234
234
  class WebhooksApi extends base_1.BaseAPI {
235
235
  /**
236
- * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `added.deal` for any newly added deals, `deleted.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
236
+ * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `create.deal` for any newly added deals, `delete.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks-v2?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
237
237
  * @summary Create a new Webhook
238
238
  * @param {WebhooksApiAddWebhookRequest} requestParameters Request parameters.
239
239
 
@@ -46,23 +46,22 @@ export interface AddWebhookRequest {
46
46
  */
47
47
  'http_auth_password'?: string;
48
48
  /**
49
- * The webhook\'s version. NB! Webhooks v2 will become the default from March 17th, 2025. See <a href=\"https://developers.pipedrive.com/changelog/post/breaking-change-webhooks-v2-will-become-the-new-default-version\" target=\"_blank\" rel=\"noopener noreferrer\">this Changelog post</a> for more details.
49
+ * The webhook\'s version. NB! Webhooks v2 is the default from March 17th, 2025. See <a href=\"https://developers.pipedrive.com/changelog/post/breaking-change-webhooks-v2-will-become-the-new-default-version\" target=\"_blank\" rel=\"noopener noreferrer\">this Changelog post</a> for more details.
50
50
  * @type {string}
51
51
  */
52
52
  'version'?: AddWebhookRequestVersionConst;
53
53
  }
54
54
  export declare const AddWebhookRequestEventActionConst: {
55
- readonly added: "added";
56
- readonly updated: "updated";
57
- readonly merged: "merged";
58
- readonly deleted: "deleted";
55
+ readonly create: "create";
56
+ readonly change: "change";
57
+ readonly delete: "delete";
59
58
  readonly Star: "*";
60
59
  };
61
60
  export type AddWebhookRequestEventActionConst = typeof AddWebhookRequestEventActionConst[keyof typeof AddWebhookRequestEventActionConst];
62
61
  export declare const AddWebhookRequestEventObjectConst: {
63
62
  readonly activity: "activity";
64
- readonly activityType: "activityType";
65
63
  readonly deal: "deal";
64
+ readonly lead: "lead";
66
65
  readonly note: "note";
67
66
  readonly organization: "organization";
68
67
  readonly person: "person";
@@ -15,16 +15,15 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.AddWebhookRequestVersionConst = exports.AddWebhookRequestEventObjectConst = exports.AddWebhookRequestEventActionConst = void 0;
17
17
  exports.AddWebhookRequestEventActionConst = {
18
- added: 'added',
19
- updated: 'updated',
20
- merged: 'merged',
21
- deleted: 'deleted',
18
+ create: 'create',
19
+ change: 'change',
20
+ delete: 'delete',
22
21
  Star: '*'
23
22
  };
24
23
  exports.AddWebhookRequestEventObjectConst = {
25
24
  activity: 'activity',
26
- activityType: 'activityType',
27
25
  deal: 'deal',
26
+ lead: 'lead',
28
27
  note: 'note',
29
28
  organization: 'organization',
30
29
  person: 'person',
@@ -32,10 +32,11 @@ export interface UserAccess {
32
32
  'permission_set_id'?: string;
33
33
  }
34
34
  export declare const UserAccessAppConst: {
35
+ readonly global: "global";
35
36
  readonly sales: "sales";
36
- readonly projects: "projects";
37
37
  readonly campaigns: "campaigns";
38
- readonly global: "global";
38
+ readonly projects: "projects";
39
39
  readonly account_settings: "account_settings";
40
+ readonly partnership: "partnership";
40
41
  };
41
42
  export type UserAccessAppConst = typeof UserAccessAppConst[keyof typeof UserAccessAppConst];
@@ -15,9 +15,10 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.UserAccessAppConst = void 0;
17
17
  exports.UserAccessAppConst = {
18
+ global: 'global',
18
19
  sales: 'sales',
19
- projects: 'projects',
20
20
  campaigns: 'campaigns',
21
- global: 'global',
22
- account_settings: 'account_settings'
21
+ projects: 'projects',
22
+ account_settings: 'account_settings',
23
+ partnership: 'partnership'
23
24
  };
@@ -32,10 +32,11 @@ export interface UserAccess1 {
32
32
  'permission_set_id'?: string;
33
33
  }
34
34
  export declare const UserAccess1AppConst: {
35
+ readonly global: "global";
35
36
  readonly sales: "sales";
36
- readonly projects: "projects";
37
37
  readonly campaigns: "campaigns";
38
- readonly global: "global";
38
+ readonly projects: "projects";
39
39
  readonly account_settings: "account_settings";
40
+ readonly partnership: "partnership";
40
41
  };
41
42
  export type UserAccess1AppConst = typeof UserAccess1AppConst[keyof typeof UserAccess1AppConst];
@@ -15,9 +15,10 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.UserAccess1AppConst = void 0;
17
17
  exports.UserAccess1AppConst = {
18
+ global: 'global',
18
19
  sales: 'sales',
19
- projects: 'projects',
20
20
  campaigns: 'campaigns',
21
- global: 'global',
22
- account_settings: 'account_settings'
21
+ projects: 'projects',
22
+ account_settings: 'account_settings',
23
+ partnership: 'partnership'
23
24
  };