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
@@ -65,6 +65,43 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
65
65
  options: localVarRequestOptions,
66
66
  };
67
67
  }),
68
+ /**
69
+ * Adds a user as a follower to the product.
70
+ * @summary Add a follower to a product
71
+ * @param {number} id The ID of the product
72
+ * @param {AddDealFollowerRequest} [AddDealFollowerRequest]
73
+
74
+ * @throws {RequiredError}
75
+ */
76
+ addProductFollower: (id, AddDealFollowerRequest) => __awaiter(this, void 0, void 0, function* () {
77
+ // verify required parameter 'id' is not null or undefined
78
+ assertParamExists('addProductFollower', 'id', id);
79
+ const localVarPath = `/products/{id}/followers`
80
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
81
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
82
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
83
+ let baseOptions;
84
+ if (configuration) {
85
+ baseOptions = configuration.baseOptions;
86
+ }
87
+ const localVarRequestOptions = Object.assign({ method: 'POST' }, baseOptions);
88
+ const localVarHeaderParameter = {};
89
+ const localVarQueryParameter = {};
90
+ // authentication api_key required
91
+ yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
92
+ // authentication oauth2 required
93
+ // oauth required
94
+ yield setOAuthToObject(localVarHeaderParameter, "oauth2", [], configuration);
95
+ localVarHeaderParameter['Content-Type'] = 'application/json';
96
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
97
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
98
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
99
+ localVarRequestOptions.data = serializeDataIfNeeded(AddDealFollowerRequest, localVarRequestOptions, configuration);
100
+ return {
101
+ url: toPathString(localVarUrlObj),
102
+ options: localVarRequestOptions,
103
+ };
104
+ }),
68
105
  /**
69
106
  * Adds a new product variation.
70
107
  * @summary Add a product variation
@@ -136,6 +173,44 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
136
173
  options: localVarRequestOptions,
137
174
  };
138
175
  }),
176
+ /**
177
+ * Deletes a user follower from the product.
178
+ * @summary Delete a follower from a product
179
+ * @param {number} id The ID of the product
180
+ * @param {number} follower_id The ID of the following user
181
+
182
+ * @throws {RequiredError}
183
+ */
184
+ deleteProductFollower: (id, follower_id) => __awaiter(this, void 0, void 0, function* () {
185
+ // verify required parameter 'id' is not null or undefined
186
+ assertParamExists('deleteProductFollower', 'id', id);
187
+ // verify required parameter 'follower_id' is not null or undefined
188
+ assertParamExists('deleteProductFollower', 'follower_id', follower_id);
189
+ const localVarPath = `/products/{id}/followers/{follower_id}`
190
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)))
191
+ .replace(`{${"follower_id"}}`, encodeURIComponent(String(follower_id)));
192
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
193
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
194
+ let baseOptions;
195
+ if (configuration) {
196
+ baseOptions = configuration.baseOptions;
197
+ }
198
+ const localVarRequestOptions = Object.assign({ method: 'DELETE' }, baseOptions);
199
+ const localVarHeaderParameter = {};
200
+ const localVarQueryParameter = {};
201
+ // authentication api_key required
202
+ yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
203
+ // authentication oauth2 required
204
+ // oauth required
205
+ yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full"], configuration);
206
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
207
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
208
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
209
+ return {
210
+ url: toPathString(localVarUrlObj),
211
+ options: localVarRequestOptions,
212
+ };
213
+ }),
139
214
  /**
140
215
  * Deletes a product variation.
141
216
  * @summary Delete a product variation
@@ -208,6 +283,90 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
208
283
  options: localVarRequestOptions,
209
284
  };
210
285
  }),
286
+ /**
287
+ * Lists users who are following the product.
288
+ * @summary List followers of a product
289
+ * @param {number} id The ID of the product
290
+ * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
291
+ * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
292
+
293
+ * @throws {RequiredError}
294
+ */
295
+ getProductFollowers: (id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
296
+ // verify required parameter 'id' is not null or undefined
297
+ assertParamExists('getProductFollowers', 'id', id);
298
+ const localVarPath = `/products/{id}/followers`
299
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
300
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
301
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
302
+ let baseOptions;
303
+ if (configuration) {
304
+ baseOptions = configuration.baseOptions;
305
+ }
306
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
307
+ const localVarHeaderParameter = {};
308
+ const localVarQueryParameter = {};
309
+ // authentication api_key required
310
+ yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
311
+ // authentication oauth2 required
312
+ // oauth required
313
+ yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:read", "products:full"], configuration);
314
+ if (limit !== undefined) {
315
+ localVarQueryParameter['limit'] = limit;
316
+ }
317
+ if (cursor !== undefined) {
318
+ localVarQueryParameter['cursor'] = cursor;
319
+ }
320
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
321
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
322
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
323
+ return {
324
+ url: toPathString(localVarUrlObj),
325
+ options: localVarRequestOptions,
326
+ };
327
+ }),
328
+ /**
329
+ * Lists changelogs about users have followed the product.
330
+ * @summary List followers changelog of a product
331
+ * @param {number} id The ID of the product
332
+ * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
333
+ * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
334
+
335
+ * @throws {RequiredError}
336
+ */
337
+ getProductFollowersChangelog: (id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
338
+ // verify required parameter 'id' is not null or undefined
339
+ assertParamExists('getProductFollowersChangelog', 'id', id);
340
+ const localVarPath = `/products/{id}/followers/changelog`
341
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
342
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
343
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
344
+ let baseOptions;
345
+ if (configuration) {
346
+ baseOptions = configuration.baseOptions;
347
+ }
348
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
349
+ const localVarHeaderParameter = {};
350
+ const localVarQueryParameter = {};
351
+ // authentication api_key required
352
+ yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
353
+ // authentication oauth2 required
354
+ // oauth required
355
+ yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:read", "products:full"], configuration);
356
+ if (limit !== undefined) {
357
+ localVarQueryParameter['limit'] = limit;
358
+ }
359
+ if (cursor !== undefined) {
360
+ localVarQueryParameter['cursor'] = cursor;
361
+ }
362
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
363
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
364
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
365
+ return {
366
+ url: toPathString(localVarUrlObj),
367
+ options: localVarRequestOptions,
368
+ };
369
+ }),
211
370
  /**
212
371
  * Returns data about all product variations.
213
372
  * @summary Get all product variations
@@ -468,6 +627,20 @@ export const ProductsApiFp = function (configuration) {
468
627
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
469
628
  });
470
629
  },
630
+ /**
631
+ * Adds a user as a follower to the product.
632
+ * @summary Add a follower to a product
633
+ * @param {number} id The ID of the product
634
+ * @param {AddDealFollowerRequest} [AddDealFollowerRequest]
635
+
636
+ * @throws {RequiredError}
637
+ */
638
+ addProductFollower(id, AddDealFollowerRequest) {
639
+ return __awaiter(this, void 0, void 0, function* () {
640
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.addProductFollower(id, AddDealFollowerRequest);
641
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
642
+ });
643
+ },
471
644
  /**
472
645
  * Adds a new product variation.
473
646
  * @summary Add a product variation
@@ -495,6 +668,20 @@ export const ProductsApiFp = function (configuration) {
495
668
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
496
669
  });
497
670
  },
671
+ /**
672
+ * Deletes a user follower from the product.
673
+ * @summary Delete a follower from a product
674
+ * @param {number} id The ID of the product
675
+ * @param {number} follower_id The ID of the following user
676
+
677
+ * @throws {RequiredError}
678
+ */
679
+ deleteProductFollower(id, follower_id) {
680
+ return __awaiter(this, void 0, void 0, function* () {
681
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteProductFollower(id, follower_id);
682
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
683
+ });
684
+ },
498
685
  /**
499
686
  * Deletes a product variation.
500
687
  * @summary Delete a product variation
@@ -522,6 +709,36 @@ export const ProductsApiFp = function (configuration) {
522
709
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
523
710
  });
524
711
  },
712
+ /**
713
+ * Lists users who are following the product.
714
+ * @summary List followers of a product
715
+ * @param {number} id The ID of the product
716
+ * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
717
+ * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
718
+
719
+ * @throws {RequiredError}
720
+ */
721
+ getProductFollowers(id, limit, cursor) {
722
+ return __awaiter(this, void 0, void 0, function* () {
723
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getProductFollowers(id, limit, cursor);
724
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
725
+ });
726
+ },
727
+ /**
728
+ * Lists changelogs about users have followed the product.
729
+ * @summary List followers changelog of a product
730
+ * @param {number} id The ID of the product
731
+ * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
732
+ * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
733
+
734
+ * @throws {RequiredError}
735
+ */
736
+ getProductFollowersChangelog(id, limit, cursor) {
737
+ return __awaiter(this, void 0, void 0, function* () {
738
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getProductFollowersChangelog(id, limit, cursor);
739
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
740
+ });
741
+ },
525
742
  /**
526
743
  * Returns data about all product variations.
527
744
  * @summary Get all product variations
@@ -623,6 +840,16 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
623
840
  addProduct(requestParameters = {}) {
624
841
  return localVarFp.addProduct(requestParameters.AddProductRequest).then((request) => request(axios, basePath));
625
842
  },
843
+ /**
844
+ * Adds a user as a follower to the product.
845
+ * @summary Add a follower to a product
846
+ * @param {ProductsApiAddProductFollowerRequest} requestParameters Request parameters.
847
+
848
+ * @throws {RequiredError}
849
+ */
850
+ addProductFollower(requestParameters) {
851
+ return localVarFp.addProductFollower(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(axios, basePath));
852
+ },
626
853
  /**
627
854
  * Adds a new product variation.
628
855
  * @summary Add a product variation
@@ -643,6 +870,16 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
643
870
  deleteProduct(requestParameters) {
644
871
  return localVarFp.deleteProduct(requestParameters.id).then((request) => request(axios, basePath));
645
872
  },
873
+ /**
874
+ * Deletes a user follower from the product.
875
+ * @summary Delete a follower from a product
876
+ * @param {ProductsApiDeleteProductFollowerRequest} requestParameters Request parameters.
877
+
878
+ * @throws {RequiredError}
879
+ */
880
+ deleteProductFollower(requestParameters) {
881
+ return localVarFp.deleteProductFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(axios, basePath));
882
+ },
646
883
  /**
647
884
  * Deletes a product variation.
648
885
  * @summary Delete a product variation
@@ -663,6 +900,26 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
663
900
  getProduct(requestParameters) {
664
901
  return localVarFp.getProduct(requestParameters.id).then((request) => request(axios, basePath));
665
902
  },
903
+ /**
904
+ * Lists users who are following the product.
905
+ * @summary List followers of a product
906
+ * @param {ProductsApiGetProductFollowersRequest} requestParameters Request parameters.
907
+
908
+ * @throws {RequiredError}
909
+ */
910
+ getProductFollowers(requestParameters) {
911
+ return localVarFp.getProductFollowers(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
912
+ },
913
+ /**
914
+ * Lists changelogs about users have followed the product.
915
+ * @summary List followers changelog of a product
916
+ * @param {ProductsApiGetProductFollowersChangelogRequest} requestParameters Request parameters.
917
+
918
+ * @throws {RequiredError}
919
+ */
920
+ getProductFollowersChangelog(requestParameters) {
921
+ return localVarFp.getProductFollowersChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
922
+ },
666
923
  /**
667
924
  * Returns data about all product variations.
668
925
  * @summary Get all product variations
@@ -733,6 +990,17 @@ export class ProductsApi extends BaseAPI {
733
990
  addProduct(requestParameters = {}) {
734
991
  return ProductsApiFp(this.configuration).addProduct(requestParameters.AddProductRequest).then((request) => request(this.axios, this.basePath));
735
992
  }
993
+ /**
994
+ * Adds a user as a follower to the product.
995
+ * @summary Add a follower to a product
996
+ * @param {ProductsApiAddProductFollowerRequest} requestParameters Request parameters.
997
+
998
+ * @throws {RequiredError}
999
+ * @memberof ProductsApi
1000
+ */
1001
+ addProductFollower(requestParameters) {
1002
+ return ProductsApiFp(this.configuration).addProductFollower(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(this.axios, this.basePath));
1003
+ }
736
1004
  /**
737
1005
  * Adds a new product variation.
738
1006
  * @summary Add a product variation
@@ -755,6 +1023,17 @@ export class ProductsApi extends BaseAPI {
755
1023
  deleteProduct(requestParameters) {
756
1024
  return ProductsApiFp(this.configuration).deleteProduct(requestParameters.id).then((request) => request(this.axios, this.basePath));
757
1025
  }
1026
+ /**
1027
+ * Deletes a user follower from the product.
1028
+ * @summary Delete a follower from a product
1029
+ * @param {ProductsApiDeleteProductFollowerRequest} requestParameters Request parameters.
1030
+
1031
+ * @throws {RequiredError}
1032
+ * @memberof ProductsApi
1033
+ */
1034
+ deleteProductFollower(requestParameters) {
1035
+ return ProductsApiFp(this.configuration).deleteProductFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(this.axios, this.basePath));
1036
+ }
758
1037
  /**
759
1038
  * Deletes a product variation.
760
1039
  * @summary Delete a product variation
@@ -777,6 +1056,28 @@ export class ProductsApi extends BaseAPI {
777
1056
  getProduct(requestParameters) {
778
1057
  return ProductsApiFp(this.configuration).getProduct(requestParameters.id).then((request) => request(this.axios, this.basePath));
779
1058
  }
1059
+ /**
1060
+ * Lists users who are following the product.
1061
+ * @summary List followers of a product
1062
+ * @param {ProductsApiGetProductFollowersRequest} requestParameters Request parameters.
1063
+
1064
+ * @throws {RequiredError}
1065
+ * @memberof ProductsApi
1066
+ */
1067
+ getProductFollowers(requestParameters) {
1068
+ return ProductsApiFp(this.configuration).getProductFollowers(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
1069
+ }
1070
+ /**
1071
+ * Lists changelogs about users have followed the product.
1072
+ * @summary List followers changelog of a product
1073
+ * @param {ProductsApiGetProductFollowersChangelogRequest} requestParameters Request parameters.
1074
+
1075
+ * @throws {RequiredError}
1076
+ * @memberof ProductsApi
1077
+ */
1078
+ getProductFollowersChangelog(requestParameters) {
1079
+ return ProductsApiFp(this.configuration).getProductFollowersChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
1080
+ }
780
1081
  /**
781
1082
  * Returns data about all product variations.
782
1083
  * @summary Get all product variations
@@ -0,0 +1,103 @@
1
+ /**
2
+ * Pipedrive API v2
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from '../configuration';
13
+ import type { AxiosInstance } from 'axios';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { GetFollowersResponse } from '../models';
16
+ /**
17
+ * UsersApi - axios parameter creator
18
+ * @export
19
+ */
20
+ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => {
21
+ /**
22
+ * Lists users who are following the user.
23
+ * @summary List followers of a user
24
+ * @param {number} id The ID of the user
25
+ * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
26
+ * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
27
+
28
+ * @throws {RequiredError}
29
+ */
30
+ getUserFollowers: (id: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
31
+ };
32
+ /**
33
+ * UsersApi - functional programming interface
34
+ * @export
35
+ */
36
+ export declare const UsersApiFp: (configuration?: Configuration) => {
37
+ /**
38
+ * Lists users who are following the user.
39
+ * @summary List followers of a user
40
+ * @param {number} id The ID of the user
41
+ * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
42
+ * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
43
+
44
+ * @throws {RequiredError}
45
+ */
46
+ getUserFollowers(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFollowersResponse>>;
47
+ };
48
+ /**
49
+ * UsersApi - factory interface
50
+ * @export
51
+ */
52
+ export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
53
+ /**
54
+ * Lists users who are following the user.
55
+ * @summary List followers of a user
56
+ * @param {UsersApiGetUserFollowersRequest} requestParameters Request parameters.
57
+
58
+ * @throws {RequiredError}
59
+ */
60
+ getUserFollowers(requestParameters: UsersApiGetUserFollowersRequest): Promise<GetFollowersResponse>;
61
+ };
62
+ /**
63
+ * Request parameters for getUserFollowers operation in UsersApi.
64
+ * @export
65
+ * @interface UsersApiGetUserFollowersRequest
66
+ */
67
+ export interface UsersApiGetUserFollowersRequest {
68
+ /**
69
+ * The ID of the user
70
+ * @type {number}
71
+ * @memberof UsersApiGetUserFollowers
72
+ */
73
+ readonly id: number;
74
+ /**
75
+ * For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
76
+ * @type {number}
77
+ * @memberof UsersApiGetUserFollowers
78
+ */
79
+ readonly limit?: number;
80
+ /**
81
+ * For pagination, the marker (an opaque string value) representing the first item on the next page
82
+ * @type {string}
83
+ * @memberof UsersApiGetUserFollowers
84
+ */
85
+ readonly cursor?: string;
86
+ }
87
+ /**
88
+ * UsersApi - object-oriented interface
89
+ * @export
90
+ * @class UsersApi
91
+ * @extends {BaseAPI}
92
+ */
93
+ export declare class UsersApi extends BaseAPI {
94
+ /**
95
+ * Lists users who are following the user.
96
+ * @summary List followers of a user
97
+ * @param {UsersApiGetUserFollowersRequest} requestParameters Request parameters.
98
+
99
+ * @throws {RequiredError}
100
+ * @memberof UsersApi
101
+ */
102
+ getUserFollowers(requestParameters: UsersApiGetUserFollowersRequest): Promise<GetFollowersResponse>;
103
+ }
@@ -0,0 +1,140 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Pipedrive API v2
5
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
+ return new (P || (P = Promise))(function (resolve, reject) {
17
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
18
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
19
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
20
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
21
+ });
22
+ };
23
+ import globalAxios from 'axios';
24
+ // Some imports not used depending on template conditions
25
+ // @ts-ignore
26
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
27
+ // @ts-ignore
28
+ import { BASE_PATH, BaseAPI } from '../base';
29
+ /**
30
+ * UsersApi - axios parameter creator
31
+ * @export
32
+ */
33
+ export const UsersApiAxiosParamCreator = function (configuration) {
34
+ return {
35
+ /**
36
+ * Lists users who are following the user.
37
+ * @summary List followers of a user
38
+ * @param {number} id The ID of the user
39
+ * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
40
+ * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
41
+
42
+ * @throws {RequiredError}
43
+ */
44
+ getUserFollowers: (id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
45
+ // verify required parameter 'id' is not null or undefined
46
+ assertParamExists('getUserFollowers', 'id', id);
47
+ const localVarPath = `/users/{id}/followers`
48
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
49
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
50
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
51
+ let baseOptions;
52
+ if (configuration) {
53
+ baseOptions = configuration.baseOptions;
54
+ }
55
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
56
+ const localVarHeaderParameter = {};
57
+ const localVarQueryParameter = {};
58
+ // authentication api_key required
59
+ yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
60
+ // authentication oauth2 required
61
+ // oauth required
62
+ yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["users:read"], configuration);
63
+ if (limit !== undefined) {
64
+ localVarQueryParameter['limit'] = limit;
65
+ }
66
+ if (cursor !== undefined) {
67
+ localVarQueryParameter['cursor'] = cursor;
68
+ }
69
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
70
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
71
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
72
+ return {
73
+ url: toPathString(localVarUrlObj),
74
+ options: localVarRequestOptions,
75
+ };
76
+ }),
77
+ };
78
+ };
79
+ /**
80
+ * UsersApi - functional programming interface
81
+ * @export
82
+ */
83
+ export const UsersApiFp = function (configuration) {
84
+ const localVarAxiosParamCreator = UsersApiAxiosParamCreator(configuration);
85
+ return {
86
+ /**
87
+ * Lists users who are following the user.
88
+ * @summary List followers of a user
89
+ * @param {number} id The ID of the user
90
+ * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
91
+ * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
92
+
93
+ * @throws {RequiredError}
94
+ */
95
+ getUserFollowers(id, limit, cursor) {
96
+ return __awaiter(this, void 0, void 0, function* () {
97
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getUserFollowers(id, limit, cursor);
98
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
99
+ });
100
+ },
101
+ };
102
+ };
103
+ /**
104
+ * UsersApi - factory interface
105
+ * @export
106
+ */
107
+ export const UsersApiFactory = function (configuration, basePath, axios) {
108
+ const localVarFp = UsersApiFp(configuration);
109
+ return {
110
+ /**
111
+ * Lists users who are following the user.
112
+ * @summary List followers of a user
113
+ * @param {UsersApiGetUserFollowersRequest} requestParameters Request parameters.
114
+
115
+ * @throws {RequiredError}
116
+ */
117
+ getUserFollowers(requestParameters) {
118
+ return localVarFp.getUserFollowers(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
119
+ },
120
+ };
121
+ };
122
+ /**
123
+ * UsersApi - object-oriented interface
124
+ * @export
125
+ * @class UsersApi
126
+ * @extends {BaseAPI}
127
+ */
128
+ export class UsersApi extends BaseAPI {
129
+ /**
130
+ * Lists users who are following the user.
131
+ * @summary List followers of a user
132
+ * @param {UsersApiGetUserFollowersRequest} requestParameters Request parameters.
133
+
134
+ * @throws {RequiredError}
135
+ * @memberof UsersApi
136
+ */
137
+ getUserFollowers(requestParameters) {
138
+ return UsersApiFp(this.configuration).getUserFollowers(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
139
+ }
140
+ }
@@ -19,3 +19,4 @@ export * from './api/persons-api';
19
19
  export * from './api/pipelines-api';
20
20
  export * from './api/products-api';
21
21
  export * from './api/stages-api';
22
+ export * from './api/users-api';
@@ -21,3 +21,4 @@ export * from './api/persons-api';
21
21
  export * from './api/pipelines-api';
22
22
  export * from './api/products-api';
23
23
  export * from './api/stages-api';
24
+ export * from './api/users-api';
@@ -0,0 +1,23 @@
1
+ /**
2
+ * Pipedrive API v2
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface AddDealFollowerRequest
16
+ */
17
+ export interface AddDealFollowerRequest {
18
+ /**
19
+ * The ID of the user to add as a follower
20
+ * @type {number}
21
+ */
22
+ 'user_id': number;
23
+ }
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Pipedrive API v2
5
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};