pipedrive 28.0.2 → 29.1.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 (91) hide show
  1. package/dist/esm/versions/v1/api/subscriptions-api.d.ts +9 -9
  2. package/dist/esm/versions/v1/api.d.ts +0 -1
  3. package/dist/esm/versions/v1/api.js +0 -1
  4. package/dist/esm/versions/v1/models/add-deal-product-request-all-of.d.ts +1 -1
  5. package/dist/esm/versions/v1/models/add-deal-product-request-all-of1.d.ts +1 -1
  6. package/dist/esm/versions/v1/models/add-deal-product-request-all-of2.d.ts +1 -1
  7. package/dist/esm/versions/v1/models/add-or-update-role-setting-request.d.ts +1 -1
  8. package/dist/esm/versions/v1/models/add-product-request-all-of1.d.ts +1 -1
  9. package/dist/esm/versions/v1/models/add-product-request-all-of2.d.ts +1 -1
  10. package/dist/esm/versions/v1/models/base-deal.d.ts +6 -6
  11. package/dist/esm/versions/v1/models/base-product.d.ts +2 -2
  12. package/dist/esm/versions/v1/models/index.d.ts +0 -11
  13. package/dist/esm/versions/v1/models/index.js +0 -11
  14. package/dist/esm/versions/v1/models/update-deal-product-request-all-of.d.ts +1 -1
  15. package/dist/esm/versions/v1/models/update-product-request-all-of1.d.ts +1 -1
  16. package/dist/esm/versions/v2/api/beta-api.d.ts +220 -16
  17. package/dist/esm/versions/v2/api/beta-api.js +308 -16
  18. package/dist/esm/versions/v2/api/deals-api.d.ts +16 -16
  19. package/dist/esm/versions/v2/api/deals-api.js +16 -16
  20. package/dist/esm/versions/v2/api/products-api.d.ts +204 -0
  21. package/dist/esm/versions/v2/api/products-api.js +292 -0
  22. package/dist/esm/versions/v2/models/add-product-image-response.d.ts +29 -0
  23. package/dist/esm/versions/v2/models/add-product-image-response.js +14 -0
  24. package/dist/esm/versions/v2/models/base-product-all-of1.d.ts +1 -1
  25. package/dist/esm/versions/v2/models/deal-item.d.ts +3 -3
  26. package/dist/esm/versions/v2/models/deal-item1.d.ts +3 -3
  27. package/dist/esm/versions/v2/models/delete-product-image-response-data.d.ts +23 -0
  28. package/dist/esm/versions/v2/models/delete-product-image-response-data.js +14 -0
  29. package/dist/esm/versions/v2/models/delete-product-image-response.d.ts +29 -0
  30. package/dist/esm/versions/v2/models/delete-product-image-response.js +14 -0
  31. package/dist/esm/versions/v2/models/get-deals-products-response-data-inner-all-of1.d.ts +1 -1
  32. package/dist/esm/versions/v2/models/get-deals-products-response-data-inner-all-of2.d.ts +1 -1
  33. package/dist/esm/versions/v2/models/get-deals-products-response-data-inner-all-of3.d.ts +1 -1
  34. package/dist/esm/versions/v2/models/get-product-image-response-data.d.ts +53 -0
  35. package/dist/esm/versions/v2/models/get-product-image-response-data.js +14 -0
  36. package/dist/esm/versions/v2/models/get-product-image-response.d.ts +29 -0
  37. package/dist/esm/versions/v2/models/get-product-image-response.js +14 -0
  38. package/dist/esm/versions/v2/models/index.d.ts +7 -0
  39. package/dist/esm/versions/v2/models/index.js +7 -0
  40. package/dist/esm/versions/v2/models/update-deal-product-request-all-of.d.ts +1 -1
  41. package/dist/esm/versions/v2/models/update-product-image-response-data.d.ts +38 -0
  42. package/dist/esm/versions/v2/models/update-product-image-response-data.js +14 -0
  43. package/dist/esm/versions/v2/models/update-product-image-response.d.ts +29 -0
  44. package/dist/esm/versions/v2/models/update-product-image-response.js +14 -0
  45. package/dist/esm/versions/v2/models/update-product-request-all-of1.d.ts +1 -1
  46. package/dist/versions/v1/api/subscriptions-api.d.ts +9 -9
  47. package/dist/versions/v1/api.d.ts +0 -1
  48. package/dist/versions/v1/api.js +0 -1
  49. package/dist/versions/v1/models/add-deal-product-request-all-of.d.ts +1 -1
  50. package/dist/versions/v1/models/add-deal-product-request-all-of1.d.ts +1 -1
  51. package/dist/versions/v1/models/add-deal-product-request-all-of2.d.ts +1 -1
  52. package/dist/versions/v1/models/add-or-update-role-setting-request.d.ts +1 -1
  53. package/dist/versions/v1/models/add-product-request-all-of1.d.ts +1 -1
  54. package/dist/versions/v1/models/add-product-request-all-of2.d.ts +1 -1
  55. package/dist/versions/v1/models/base-deal.d.ts +6 -6
  56. package/dist/versions/v1/models/base-product.d.ts +2 -2
  57. package/dist/versions/v1/models/index.d.ts +0 -11
  58. package/dist/versions/v1/models/index.js +0 -11
  59. package/dist/versions/v1/models/update-deal-product-request-all-of.d.ts +1 -1
  60. package/dist/versions/v1/models/update-product-request-all-of1.d.ts +1 -1
  61. package/dist/versions/v2/api/beta-api.d.ts +220 -16
  62. package/dist/versions/v2/api/beta-api.js +308 -16
  63. package/dist/versions/v2/api/deals-api.d.ts +16 -16
  64. package/dist/versions/v2/api/deals-api.js +16 -16
  65. package/dist/versions/v2/api/products-api.d.ts +204 -0
  66. package/dist/versions/v2/api/products-api.js +292 -0
  67. package/dist/versions/v2/models/add-product-image-response.d.ts +29 -0
  68. package/dist/versions/v2/models/add-product-image-response.js +15 -0
  69. package/dist/versions/v2/models/base-product-all-of1.d.ts +1 -1
  70. package/dist/versions/v2/models/deal-item.d.ts +3 -3
  71. package/dist/versions/v2/models/deal-item1.d.ts +3 -3
  72. package/dist/versions/v2/models/delete-product-image-response-data.d.ts +23 -0
  73. package/dist/versions/v2/models/delete-product-image-response-data.js +15 -0
  74. package/dist/versions/v2/models/delete-product-image-response.d.ts +29 -0
  75. package/dist/versions/v2/models/delete-product-image-response.js +15 -0
  76. package/dist/versions/v2/models/get-deals-products-response-data-inner-all-of1.d.ts +1 -1
  77. package/dist/versions/v2/models/get-deals-products-response-data-inner-all-of2.d.ts +1 -1
  78. package/dist/versions/v2/models/get-deals-products-response-data-inner-all-of3.d.ts +1 -1
  79. package/dist/versions/v2/models/get-product-image-response-data.d.ts +53 -0
  80. package/dist/versions/v2/models/get-product-image-response-data.js +15 -0
  81. package/dist/versions/v2/models/get-product-image-response.d.ts +29 -0
  82. package/dist/versions/v2/models/get-product-image-response.js +15 -0
  83. package/dist/versions/v2/models/index.d.ts +7 -0
  84. package/dist/versions/v2/models/index.js +7 -0
  85. package/dist/versions/v2/models/update-deal-product-request-all-of.d.ts +1 -1
  86. package/dist/versions/v2/models/update-product-image-response-data.d.ts +38 -0
  87. package/dist/versions/v2/models/update-product-image-response-data.js +15 -0
  88. package/dist/versions/v2/models/update-product-image-response.d.ts +29 -0
  89. package/dist/versions/v2/models/update-product-image-response.js +15 -0
  90. package/dist/versions/v2/models/update-product-request-all-of1.d.ts +1 -1
  91. package/package.json +1 -1
@@ -211,6 +211,40 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
211
211
  options: localVarRequestOptions,
212
212
  };
213
213
  }),
214
+ /**
215
+ * Deletes the image of a product.
216
+ * @summary Delete an image of a product
217
+ * @param {number} id The ID of the product
218
+
219
+ * @throws {RequiredError}
220
+ */
221
+ deleteProductImage: (id) => __awaiter(this, void 0, void 0, function* () {
222
+ // verify required parameter 'id' is not null or undefined
223
+ assertParamExists('deleteProductImage', 'id', id);
224
+ const localVarPath = `/products/{id}/images`
225
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
226
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
227
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
228
+ let baseOptions;
229
+ if (configuration) {
230
+ baseOptions = configuration.baseOptions;
231
+ }
232
+ const localVarRequestOptions = Object.assign({ method: 'DELETE' }, baseOptions);
233
+ const localVarHeaderParameter = {};
234
+ const localVarQueryParameter = {};
235
+ // authentication api_key required
236
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
237
+ // authentication oauth2 required
238
+ // oauth required
239
+ yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full"], configuration);
240
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
241
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
242
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
243
+ return {
244
+ url: toPathString(localVarUrlObj),
245
+ options: localVarRequestOptions,
246
+ };
247
+ }),
214
248
  /**
215
249
  * Deletes a product variation.
216
250
  * @summary Delete a product variation
@@ -367,6 +401,40 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
367
401
  options: localVarRequestOptions,
368
402
  };
369
403
  }),
404
+ /**
405
+ * Retrieves the image of a product. The public URL has a limited lifetime of 7 days.
406
+ * @summary Get image of a product
407
+ * @param {number} id The ID of the product
408
+
409
+ * @throws {RequiredError}
410
+ */
411
+ getProductImage: (id) => __awaiter(this, void 0, void 0, function* () {
412
+ // verify required parameter 'id' is not null or undefined
413
+ assertParamExists('getProductImage', 'id', id);
414
+ const localVarPath = `/products/{id}/images`
415
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
416
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
417
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
418
+ let baseOptions;
419
+ if (configuration) {
420
+ baseOptions = configuration.baseOptions;
421
+ }
422
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
423
+ const localVarHeaderParameter = {};
424
+ const localVarQueryParameter = {};
425
+ // authentication api_key required
426
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
427
+ // authentication oauth2 required
428
+ // oauth required
429
+ yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:read", "products:full"], configuration);
430
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
431
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
432
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
433
+ return {
434
+ url: toPathString(localVarUrlObj),
435
+ options: localVarRequestOptions,
436
+ };
437
+ }),
370
438
  /**
371
439
  * Returns data about all product variations.
372
440
  * @summary Get all product variations
@@ -564,6 +632,49 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
564
632
  options: localVarRequestOptions,
565
633
  };
566
634
  }),
635
+ /**
636
+ * Updates the image of a product.
637
+ * @summary Update an image for a product
638
+ * @param {number} id The ID of the product
639
+ * @param {File} data One image supplied in the multipart/form-data encoding
640
+
641
+ * @throws {RequiredError}
642
+ */
643
+ updateProductImage: (id, data) => __awaiter(this, void 0, void 0, function* () {
644
+ // verify required parameter 'id' is not null or undefined
645
+ assertParamExists('updateProductImage', 'id', id);
646
+ // verify required parameter 'data' is not null or undefined
647
+ assertParamExists('updateProductImage', 'data', data);
648
+ const localVarPath = `/products/{id}/images`
649
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
650
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
651
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
652
+ let baseOptions;
653
+ if (configuration) {
654
+ baseOptions = configuration.baseOptions;
655
+ }
656
+ const localVarRequestOptions = Object.assign({ method: 'PUT' }, baseOptions);
657
+ const localVarHeaderParameter = {};
658
+ const localVarQueryParameter = {};
659
+ const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
660
+ // authentication api_key required
661
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
662
+ // authentication oauth2 required
663
+ // oauth required
664
+ yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full"], configuration);
665
+ if (data !== undefined) {
666
+ localVarFormParams.append('data', data);
667
+ }
668
+ localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
669
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
670
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
671
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
672
+ localVarRequestOptions.data = localVarFormParams;
673
+ return {
674
+ url: toPathString(localVarUrlObj),
675
+ options: localVarRequestOptions,
676
+ };
677
+ }),
567
678
  /**
568
679
  * Updates product variation data.
569
680
  * @summary Update a product variation
@@ -605,6 +716,49 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
605
716
  options: localVarRequestOptions,
606
717
  };
607
718
  }),
719
+ /**
720
+ * Uploads an image for a product.
721
+ * @summary Upload an image for a product
722
+ * @param {number} id The ID of the product
723
+ * @param {File} data One image supplied in the multipart/form-data encoding
724
+
725
+ * @throws {RequiredError}
726
+ */
727
+ uploadProductImage: (id, data) => __awaiter(this, void 0, void 0, function* () {
728
+ // verify required parameter 'id' is not null or undefined
729
+ assertParamExists('uploadProductImage', 'id', id);
730
+ // verify required parameter 'data' is not null or undefined
731
+ assertParamExists('uploadProductImage', 'data', data);
732
+ const localVarPath = `/products/{id}/images`
733
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
734
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
735
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
736
+ let baseOptions;
737
+ if (configuration) {
738
+ baseOptions = configuration.baseOptions;
739
+ }
740
+ const localVarRequestOptions = Object.assign({ method: 'POST' }, baseOptions);
741
+ const localVarHeaderParameter = {};
742
+ const localVarQueryParameter = {};
743
+ const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
744
+ // authentication api_key required
745
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
746
+ // authentication oauth2 required
747
+ // oauth required
748
+ yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full"], configuration);
749
+ if (data !== undefined) {
750
+ localVarFormParams.append('data', data);
751
+ }
752
+ localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
753
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
754
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
755
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
756
+ localVarRequestOptions.data = localVarFormParams;
757
+ return {
758
+ url: toPathString(localVarUrlObj),
759
+ options: localVarRequestOptions,
760
+ };
761
+ }),
608
762
  };
609
763
  };
610
764
  /**
@@ -682,6 +836,19 @@ export const ProductsApiFp = function (configuration) {
682
836
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
683
837
  });
684
838
  },
839
+ /**
840
+ * Deletes the image of a product.
841
+ * @summary Delete an image of a product
842
+ * @param {number} id The ID of the product
843
+
844
+ * @throws {RequiredError}
845
+ */
846
+ deleteProductImage(id) {
847
+ return __awaiter(this, void 0, void 0, function* () {
848
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteProductImage(id);
849
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
850
+ });
851
+ },
685
852
  /**
686
853
  * Deletes a product variation.
687
854
  * @summary Delete a product variation
@@ -739,6 +906,19 @@ export const ProductsApiFp = function (configuration) {
739
906
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
740
907
  });
741
908
  },
909
+ /**
910
+ * Retrieves the image of a product. The public URL has a limited lifetime of 7 days.
911
+ * @summary Get image of a product
912
+ * @param {number} id The ID of the product
913
+
914
+ * @throws {RequiredError}
915
+ */
916
+ getProductImage(id) {
917
+ return __awaiter(this, void 0, void 0, function* () {
918
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getProductImage(id);
919
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
920
+ });
921
+ },
742
922
  /**
743
923
  * Returns data about all product variations.
744
924
  * @summary Get all product variations
@@ -806,6 +986,20 @@ export const ProductsApiFp = function (configuration) {
806
986
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
807
987
  });
808
988
  },
989
+ /**
990
+ * Updates the image of a product.
991
+ * @summary Update an image for a product
992
+ * @param {number} id The ID of the product
993
+ * @param {File} data One image supplied in the multipart/form-data encoding
994
+
995
+ * @throws {RequiredError}
996
+ */
997
+ updateProductImage(id, data) {
998
+ return __awaiter(this, void 0, void 0, function* () {
999
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.updateProductImage(id, data);
1000
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1001
+ });
1002
+ },
809
1003
  /**
810
1004
  * Updates product variation data.
811
1005
  * @summary Update a product variation
@@ -821,6 +1015,20 @@ export const ProductsApiFp = function (configuration) {
821
1015
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
822
1016
  });
823
1017
  },
1018
+ /**
1019
+ * Uploads an image for a product.
1020
+ * @summary Upload an image for a product
1021
+ * @param {number} id The ID of the product
1022
+ * @param {File} data One image supplied in the multipart/form-data encoding
1023
+
1024
+ * @throws {RequiredError}
1025
+ */
1026
+ uploadProductImage(id, data) {
1027
+ return __awaiter(this, void 0, void 0, function* () {
1028
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.uploadProductImage(id, data);
1029
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1030
+ });
1031
+ },
824
1032
  };
825
1033
  };
826
1034
  /**
@@ -880,6 +1088,16 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
880
1088
  deleteProductFollower(requestParameters) {
881
1089
  return localVarFp.deleteProductFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(axios, basePath));
882
1090
  },
1091
+ /**
1092
+ * Deletes the image of a product.
1093
+ * @summary Delete an image of a product
1094
+ * @param {ProductsApiDeleteProductImageRequest} requestParameters Request parameters.
1095
+
1096
+ * @throws {RequiredError}
1097
+ */
1098
+ deleteProductImage(requestParameters) {
1099
+ return localVarFp.deleteProductImage(requestParameters.id).then((request) => request(axios, basePath));
1100
+ },
883
1101
  /**
884
1102
  * Deletes a product variation.
885
1103
  * @summary Delete a product variation
@@ -920,6 +1138,16 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
920
1138
  getProductFollowersChangelog(requestParameters) {
921
1139
  return localVarFp.getProductFollowersChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
922
1140
  },
1141
+ /**
1142
+ * Retrieves the image of a product. The public URL has a limited lifetime of 7 days.
1143
+ * @summary Get image of a product
1144
+ * @param {ProductsApiGetProductImageRequest} requestParameters Request parameters.
1145
+
1146
+ * @throws {RequiredError}
1147
+ */
1148
+ getProductImage(requestParameters) {
1149
+ return localVarFp.getProductImage(requestParameters.id).then((request) => request(axios, basePath));
1150
+ },
923
1151
  /**
924
1152
  * Returns data about all product variations.
925
1153
  * @summary Get all product variations
@@ -960,6 +1188,16 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
960
1188
  updateProduct(requestParameters) {
961
1189
  return localVarFp.updateProduct(requestParameters.id, requestParameters.UpdateProductRequest).then((request) => request(axios, basePath));
962
1190
  },
1191
+ /**
1192
+ * Updates the image of a product.
1193
+ * @summary Update an image for a product
1194
+ * @param {ProductsApiUpdateProductImageRequest} requestParameters Request parameters.
1195
+
1196
+ * @throws {RequiredError}
1197
+ */
1198
+ updateProductImage(requestParameters) {
1199
+ return localVarFp.updateProductImage(requestParameters.id, requestParameters.data).then((request) => request(axios, basePath));
1200
+ },
963
1201
  /**
964
1202
  * Updates product variation data.
965
1203
  * @summary Update a product variation
@@ -970,6 +1208,16 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
970
1208
  updateProductVariation(requestParameters) {
971
1209
  return localVarFp.updateProductVariation(requestParameters.id, requestParameters.product_variation_id, requestParameters.UpdateProductVariationRequest).then((request) => request(axios, basePath));
972
1210
  },
1211
+ /**
1212
+ * Uploads an image for a product.
1213
+ * @summary Upload an image for a product
1214
+ * @param {ProductsApiUploadProductImageRequest} requestParameters Request parameters.
1215
+
1216
+ * @throws {RequiredError}
1217
+ */
1218
+ uploadProductImage(requestParameters) {
1219
+ return localVarFp.uploadProductImage(requestParameters.id, requestParameters.data).then((request) => request(axios, basePath));
1220
+ },
973
1221
  };
974
1222
  };
975
1223
  /**
@@ -1034,6 +1282,17 @@ export class ProductsApi extends BaseAPI {
1034
1282
  deleteProductFollower(requestParameters) {
1035
1283
  return ProductsApiFp(this.configuration).deleteProductFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(this.axios, this.basePath));
1036
1284
  }
1285
+ /**
1286
+ * Deletes the image of a product.
1287
+ * @summary Delete an image of a product
1288
+ * @param {ProductsApiDeleteProductImageRequest} requestParameters Request parameters.
1289
+
1290
+ * @throws {RequiredError}
1291
+ * @memberof ProductsApi
1292
+ */
1293
+ deleteProductImage(requestParameters) {
1294
+ return ProductsApiFp(this.configuration).deleteProductImage(requestParameters.id).then((request) => request(this.axios, this.basePath));
1295
+ }
1037
1296
  /**
1038
1297
  * Deletes a product variation.
1039
1298
  * @summary Delete a product variation
@@ -1078,6 +1337,17 @@ export class ProductsApi extends BaseAPI {
1078
1337
  getProductFollowersChangelog(requestParameters) {
1079
1338
  return ProductsApiFp(this.configuration).getProductFollowersChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
1080
1339
  }
1340
+ /**
1341
+ * Retrieves the image of a product. The public URL has a limited lifetime of 7 days.
1342
+ * @summary Get image of a product
1343
+ * @param {ProductsApiGetProductImageRequest} requestParameters Request parameters.
1344
+
1345
+ * @throws {RequiredError}
1346
+ * @memberof ProductsApi
1347
+ */
1348
+ getProductImage(requestParameters) {
1349
+ return ProductsApiFp(this.configuration).getProductImage(requestParameters.id).then((request) => request(this.axios, this.basePath));
1350
+ }
1081
1351
  /**
1082
1352
  * Returns data about all product variations.
1083
1353
  * @summary Get all product variations
@@ -1122,6 +1392,17 @@ export class ProductsApi extends BaseAPI {
1122
1392
  updateProduct(requestParameters) {
1123
1393
  return ProductsApiFp(this.configuration).updateProduct(requestParameters.id, requestParameters.UpdateProductRequest).then((request) => request(this.axios, this.basePath));
1124
1394
  }
1395
+ /**
1396
+ * Updates the image of a product.
1397
+ * @summary Update an image for a product
1398
+ * @param {ProductsApiUpdateProductImageRequest} requestParameters Request parameters.
1399
+
1400
+ * @throws {RequiredError}
1401
+ * @memberof ProductsApi
1402
+ */
1403
+ updateProductImage(requestParameters) {
1404
+ return ProductsApiFp(this.configuration).updateProductImage(requestParameters.id, requestParameters.data).then((request) => request(this.axios, this.basePath));
1405
+ }
1125
1406
  /**
1126
1407
  * Updates product variation data.
1127
1408
  * @summary Update a product variation
@@ -1133,4 +1414,15 @@ export class ProductsApi extends BaseAPI {
1133
1414
  updateProductVariation(requestParameters) {
1134
1415
  return ProductsApiFp(this.configuration).updateProductVariation(requestParameters.id, requestParameters.product_variation_id, requestParameters.UpdateProductVariationRequest).then((request) => request(this.axios, this.basePath));
1135
1416
  }
1417
+ /**
1418
+ * Uploads an image for a product.
1419
+ * @summary Upload an image for a product
1420
+ * @param {ProductsApiUploadProductImageRequest} requestParameters Request parameters.
1421
+
1422
+ * @throws {RequiredError}
1423
+ * @memberof ProductsApi
1424
+ */
1425
+ uploadProductImage(requestParameters) {
1426
+ return ProductsApiFp(this.configuration).uploadProductImage(requestParameters.id, requestParameters.data).then((request) => request(this.axios, this.basePath));
1427
+ }
1136
1428
  }
@@ -0,0 +1,29 @@
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 { UpdateProductImageResponseData } from './update-product-image-response-data';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface AddProductImageResponse
17
+ */
18
+ export interface AddProductImageResponse {
19
+ /**
20
+ * If the response is successful or not
21
+ * @type {boolean}
22
+ */
23
+ 'success'?: boolean;
24
+ /**
25
+ *
26
+ * @type {UpdateProductImageResponseData}
27
+ */
28
+ 'data'?: UpdateProductImageResponseData;
29
+ }
@@ -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 {};
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface BaseProductAllOf1 {
18
18
  /**
19
- * Only available in Advanced and above plans How often a customer is billed for access to a service or product
19
+ * Only available in Growth and above plans How often a customer is billed for access to a service or product
20
20
  * @type {string}
21
21
  */
22
22
  'billing_frequency'?: BaseProductAllOf1BillingFrequencyConst;
@@ -152,17 +152,17 @@ export interface DealItem {
152
152
  */
153
153
  'channel_id'?: string | null;
154
154
  /**
155
- * Only available in Advanced and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal
155
+ * Only available in Growth and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal
156
156
  * @type {number}
157
157
  */
158
158
  'arr'?: number | null;
159
159
  /**
160
- * Only available in Advanced and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal
160
+ * Only available in Growth and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal
161
161
  * @type {number}
162
162
  */
163
163
  'mrr'?: number | null;
164
164
  /**
165
- * Only available in Advanced and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal
165
+ * Only available in Growth and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal
166
166
  * @type {number}
167
167
  */
168
168
  'acv'?: number | null;
@@ -152,17 +152,17 @@ export interface DealItem1 {
152
152
  */
153
153
  'channel_id'?: string | null;
154
154
  /**
155
- * Only available in Advanced and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal
155
+ * Only available in Growth and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal
156
156
  * @type {number}
157
157
  */
158
158
  'arr'?: number | null;
159
159
  /**
160
- * Only available in Advanced and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal
160
+ * Only available in Growth and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal
161
161
  * @type {number}
162
162
  */
163
163
  'mrr'?: number | null;
164
164
  /**
165
- * Only available in Advanced and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal
165
+ * Only available in Growth and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal
166
166
  * @type {number}
167
167
  */
168
168
  'acv'?: number | null;
@@ -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 DeleteProductImageResponseData
16
+ */
17
+ export interface DeleteProductImageResponseData {
18
+ /**
19
+ * The ID of the image that was deleted from the product.
20
+ * @type {number}
21
+ */
22
+ '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 {};
@@ -0,0 +1,29 @@
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 { DeleteProductImageResponseData } from './delete-product-image-response-data';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface DeleteProductImageResponse
17
+ */
18
+ export interface DeleteProductImageResponse {
19
+ /**
20
+ * If the response is successful or not
21
+ * @type {boolean}
22
+ */
23
+ 'success'?: boolean;
24
+ /**
25
+ *
26
+ * @type {DeleteProductImageResponseData}
27
+ */
28
+ 'data'?: DeleteProductImageResponseData;
29
+ }
@@ -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 {};
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface GetDealsProductsResponseDataInnerAllOf1 {
18
18
  /**
19
- * Only available in Advanced and above plans How often a customer is billed for access to a service or product To set `billing_frequency` different than `one-time`, the deal must not have installments associated A deal can have up to 20 products attached with `billing_frequency` different than `one-time`
19
+ * Only available in Growth and above plans How often a customer is billed for access to a service or product To set `billing_frequency` different than `one-time`, the deal must not have installments associated A deal can have up to 20 products attached with `billing_frequency` different than `one-time`
20
20
  * @type {string}
21
21
  */
22
22
  'billing_frequency'?: GetDealsProductsResponseDataInnerAllOf1BillingFrequencyConst;
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface GetDealsProductsResponseDataInnerAllOf2 {
18
18
  /**
19
- * Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` When `billing_frequency` is set to `weekly`, this field cannot be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 208
19
+ * Only available in Growth and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` When `billing_frequency` is set to `weekly`, this field cannot be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 208
20
20
  * @type {number}
21
21
  */
22
22
  'billing_frequency_cycles'?: number | null;
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface GetDealsProductsResponseDataInnerAllOf3 {
18
18
  /**
19
- * Only available in Advanced and above plans The billing start date. Must be between 10 years in the past and 10 years in the future
19
+ * Only available in Growth and above plans The billing start date. Must be between 10 years in the past and 10 years in the future
20
20
  * @type {string}
21
21
  */
22
22
  'billing_start_date'?: string | null;
@@ -0,0 +1,53 @@
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
+ * The product image data and the respective public URL
14
+ * @export
15
+ * @interface GetProductImageResponseData
16
+ */
17
+ export interface GetProductImageResponseData {
18
+ /**
19
+ * The ID of the product image
20
+ * @type {number}
21
+ */
22
+ 'id'?: number;
23
+ /**
24
+ * The ID of the product associated
25
+ * @type {number}
26
+ */
27
+ 'product_id'?: number;
28
+ /**
29
+ * The ID of the company
30
+ * @type {string}
31
+ */
32
+ 'company_id'?: string;
33
+ /**
34
+ * The public URL of the product image
35
+ * @type {string}
36
+ */
37
+ 'public_url'?: string;
38
+ /**
39
+ * The date of image upload.
40
+ * @type {string}
41
+ */
42
+ 'add_time'?: string;
43
+ /**
44
+ * The MIME type of the product image
45
+ * @type {string}
46
+ */
47
+ 'mime_type'?: string;
48
+ /**
49
+ * The name of the product image file
50
+ * @type {string}
51
+ */
52
+ 'name'?: string;
53
+ }