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
@@ -104,7 +104,7 @@ export const BetaApiAxiosParamCreator = function (configuration) {
104
104
  };
105
105
  }),
106
106
  /**
107
- * Removes an installment from a deal. Only available in Advanced and above plans.
107
+ * Removes an installment from a deal. Only available in Growth and above plans.
108
108
  * @summary Delete an installment from a deal
109
109
  * @param {number} id The ID of the deal
110
110
  * @param {number} installment_id The ID of the installment
@@ -141,6 +141,40 @@ export const BetaApiAxiosParamCreator = function (configuration) {
141
141
  options: localVarRequestOptions,
142
142
  };
143
143
  }),
144
+ /**
145
+ * Deletes the image of a product.
146
+ * @summary Delete an image of a product
147
+ * @param {number} id The ID of the product
148
+
149
+ * @throws {RequiredError}
150
+ */
151
+ deleteProductImage: (id) => __awaiter(this, void 0, void 0, function* () {
152
+ // verify required parameter 'id' is not null or undefined
153
+ assertParamExists('deleteProductImage', 'id', id);
154
+ const localVarPath = `/products/{id}/images`
155
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
156
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
157
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
158
+ let baseOptions;
159
+ if (configuration) {
160
+ baseOptions = configuration.baseOptions;
161
+ }
162
+ const localVarRequestOptions = Object.assign({ method: 'DELETE' }, baseOptions);
163
+ const localVarHeaderParameter = {};
164
+ const localVarQueryParameter = {};
165
+ // authentication api_key required
166
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
167
+ // authentication oauth2 required
168
+ // oauth required
169
+ yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full"], configuration);
170
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
171
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
172
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
173
+ return {
174
+ url: toPathString(localVarUrlObj),
175
+ options: localVarRequestOptions,
176
+ };
177
+ }),
144
178
  /**
145
179
  * Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
146
180
  * @summary Get Deal conversion status (BETA)
@@ -180,7 +214,7 @@ export const BetaApiAxiosParamCreator = function (configuration) {
180
214
  };
181
215
  }),
182
216
  /**
183
- * Lists installments attached to a list of deals. Only available in Advanced and above plans.
217
+ * Lists installments attached to a list of deals. Only available in Growth and above plans.
184
218
  * @summary List installments added to a list of deals
185
219
  * @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided.
186
220
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
@@ -270,7 +304,41 @@ export const BetaApiAxiosParamCreator = function (configuration) {
270
304
  };
271
305
  }),
272
306
  /**
273
- * Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Advanced and above plans.
307
+ * Retrieves the image of a product. The public URL has a limited lifetime of 7 days.
308
+ * @summary Get image of a product
309
+ * @param {number} id The ID of the product
310
+
311
+ * @throws {RequiredError}
312
+ */
313
+ getProductImage: (id) => __awaiter(this, void 0, void 0, function* () {
314
+ // verify required parameter 'id' is not null or undefined
315
+ assertParamExists('getProductImage', 'id', id);
316
+ const localVarPath = `/products/{id}/images`
317
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
318
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
319
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
320
+ let baseOptions;
321
+ if (configuration) {
322
+ baseOptions = configuration.baseOptions;
323
+ }
324
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
325
+ const localVarHeaderParameter = {};
326
+ const localVarQueryParameter = {};
327
+ // authentication api_key required
328
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
329
+ // authentication oauth2 required
330
+ // oauth required
331
+ yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:read", "products:full"], configuration);
332
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
333
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
334
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
335
+ return {
336
+ url: toPathString(localVarUrlObj),
337
+ options: localVarRequestOptions,
338
+ };
339
+ }),
340
+ /**
341
+ * Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Growth and above plans.
274
342
  * @summary Add an installment to a deal
275
343
  * @param {number} id The ID of the deal
276
344
  * @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
@@ -307,7 +375,7 @@ export const BetaApiAxiosParamCreator = function (configuration) {
307
375
  };
308
376
  }),
309
377
  /**
310
- * Edits an installment added to a deal. Only available in Advanced and above plans.
378
+ * Edits an installment added to a deal. Only available in Growth and above plans.
311
379
  * @summary Update an installment added to a deal
312
380
  * @param {number} id The ID of the deal
313
381
  * @param {number} installment_id The ID of the installment
@@ -347,6 +415,92 @@ export const BetaApiAxiosParamCreator = function (configuration) {
347
415
  options: localVarRequestOptions,
348
416
  };
349
417
  }),
418
+ /**
419
+ * Updates the image of a product.
420
+ * @summary Update an image for a product
421
+ * @param {number} id The ID of the product
422
+ * @param {File} data One image supplied in the multipart/form-data encoding
423
+
424
+ * @throws {RequiredError}
425
+ */
426
+ updateProductImage: (id, data) => __awaiter(this, void 0, void 0, function* () {
427
+ // verify required parameter 'id' is not null or undefined
428
+ assertParamExists('updateProductImage', 'id', id);
429
+ // verify required parameter 'data' is not null or undefined
430
+ assertParamExists('updateProductImage', 'data', data);
431
+ const localVarPath = `/products/{id}/images`
432
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
433
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
434
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
435
+ let baseOptions;
436
+ if (configuration) {
437
+ baseOptions = configuration.baseOptions;
438
+ }
439
+ const localVarRequestOptions = Object.assign({ method: 'PUT' }, baseOptions);
440
+ const localVarHeaderParameter = {};
441
+ const localVarQueryParameter = {};
442
+ const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
443
+ // authentication api_key required
444
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
445
+ // authentication oauth2 required
446
+ // oauth required
447
+ yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full"], configuration);
448
+ if (data !== undefined) {
449
+ localVarFormParams.append('data', data);
450
+ }
451
+ localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
452
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
453
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
454
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
455
+ localVarRequestOptions.data = localVarFormParams;
456
+ return {
457
+ url: toPathString(localVarUrlObj),
458
+ options: localVarRequestOptions,
459
+ };
460
+ }),
461
+ /**
462
+ * Uploads an image for a product.
463
+ * @summary Upload an image for a product
464
+ * @param {number} id The ID of the product
465
+ * @param {File} data One image supplied in the multipart/form-data encoding
466
+
467
+ * @throws {RequiredError}
468
+ */
469
+ uploadProductImage: (id, data) => __awaiter(this, void 0, void 0, function* () {
470
+ // verify required parameter 'id' is not null or undefined
471
+ assertParamExists('uploadProductImage', 'id', id);
472
+ // verify required parameter 'data' is not null or undefined
473
+ assertParamExists('uploadProductImage', 'data', data);
474
+ const localVarPath = `/products/{id}/images`
475
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
476
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
477
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
478
+ let baseOptions;
479
+ if (configuration) {
480
+ baseOptions = configuration.baseOptions;
481
+ }
482
+ const localVarRequestOptions = Object.assign({ method: 'POST' }, baseOptions);
483
+ const localVarHeaderParameter = {};
484
+ const localVarQueryParameter = {};
485
+ const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
486
+ // authentication api_key required
487
+ yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
488
+ // authentication oauth2 required
489
+ // oauth required
490
+ yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full"], configuration);
491
+ if (data !== undefined) {
492
+ localVarFormParams.append('data', data);
493
+ }
494
+ localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
495
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
496
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
497
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
498
+ localVarRequestOptions.data = localVarFormParams;
499
+ return {
500
+ url: toPathString(localVarUrlObj),
501
+ options: localVarRequestOptions,
502
+ };
503
+ }),
350
504
  };
351
505
  };
352
506
  /**
@@ -384,7 +538,7 @@ export const BetaApiFp = function (configuration) {
384
538
  });
385
539
  },
386
540
  /**
387
- * Removes an installment from a deal. Only available in Advanced and above plans.
541
+ * Removes an installment from a deal. Only available in Growth and above plans.
388
542
  * @summary Delete an installment from a deal
389
543
  * @param {number} id The ID of the deal
390
544
  * @param {number} installment_id The ID of the installment
@@ -397,6 +551,19 @@ export const BetaApiFp = function (configuration) {
397
551
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
398
552
  });
399
553
  },
554
+ /**
555
+ * Deletes the image of a product.
556
+ * @summary Delete an image of a product
557
+ * @param {number} id The ID of the product
558
+
559
+ * @throws {RequiredError}
560
+ */
561
+ deleteProductImage(id) {
562
+ return __awaiter(this, void 0, void 0, function* () {
563
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteProductImage(id);
564
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
565
+ });
566
+ },
400
567
  /**
401
568
  * Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
402
569
  * @summary Get Deal conversion status (BETA)
@@ -412,7 +579,7 @@ export const BetaApiFp = function (configuration) {
412
579
  });
413
580
  },
414
581
  /**
415
- * Lists installments attached to a list of deals. Only available in Advanced and above plans.
582
+ * Lists installments attached to a list of deals. Only available in Growth and above plans.
416
583
  * @summary List installments added to a list of deals
417
584
  * @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided.
418
585
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
@@ -443,7 +610,20 @@ export const BetaApiFp = function (configuration) {
443
610
  });
444
611
  },
445
612
  /**
446
- * Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Advanced and above plans.
613
+ * Retrieves the image of a product. The public URL has a limited lifetime of 7 days.
614
+ * @summary Get image of a product
615
+ * @param {number} id The ID of the product
616
+
617
+ * @throws {RequiredError}
618
+ */
619
+ getProductImage(id) {
620
+ return __awaiter(this, void 0, void 0, function* () {
621
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getProductImage(id);
622
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
623
+ });
624
+ },
625
+ /**
626
+ * Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Growth and above plans.
447
627
  * @summary Add an installment to a deal
448
628
  * @param {number} id The ID of the deal
449
629
  * @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
@@ -457,7 +637,7 @@ export const BetaApiFp = function (configuration) {
457
637
  });
458
638
  },
459
639
  /**
460
- * Edits an installment added to a deal. Only available in Advanced and above plans.
640
+ * Edits an installment added to a deal. Only available in Growth and above plans.
461
641
  * @summary Update an installment added to a deal
462
642
  * @param {number} id The ID of the deal
463
643
  * @param {number} installment_id The ID of the installment
@@ -471,6 +651,34 @@ export const BetaApiFp = function (configuration) {
471
651
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
472
652
  });
473
653
  },
654
+ /**
655
+ * Updates the image of a product.
656
+ * @summary Update an image for a product
657
+ * @param {number} id The ID of the product
658
+ * @param {File} data One image supplied in the multipart/form-data encoding
659
+
660
+ * @throws {RequiredError}
661
+ */
662
+ updateProductImage(id, data) {
663
+ return __awaiter(this, void 0, void 0, function* () {
664
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.updateProductImage(id, data);
665
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
666
+ });
667
+ },
668
+ /**
669
+ * Uploads an image for a product.
670
+ * @summary Upload an image for a product
671
+ * @param {number} id The ID of the product
672
+ * @param {File} data One image supplied in the multipart/form-data encoding
673
+
674
+ * @throws {RequiredError}
675
+ */
676
+ uploadProductImage(id, data) {
677
+ return __awaiter(this, void 0, void 0, function* () {
678
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.uploadProductImage(id, data);
679
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
680
+ });
681
+ },
474
682
  };
475
683
  };
476
684
  /**
@@ -501,7 +709,7 @@ export const BetaApiFactory = function (configuration, basePath, axios) {
501
709
  return localVarFp.convertLeadToDeal(requestParameters.id, requestParameters.ConvertLeadToDealRequest).then((request) => request(axios, basePath));
502
710
  },
503
711
  /**
504
- * Removes an installment from a deal. Only available in Advanced and above plans.
712
+ * Removes an installment from a deal. Only available in Growth and above plans.
505
713
  * @summary Delete an installment from a deal
506
714
  * @param {BetaApiDeleteInstallmentRequest} requestParameters Request parameters.
507
715
 
@@ -510,6 +718,16 @@ export const BetaApiFactory = function (configuration, basePath, axios) {
510
718
  deleteInstallment(requestParameters) {
511
719
  return localVarFp.deleteInstallment(requestParameters.id, requestParameters.installment_id).then((request) => request(axios, basePath));
512
720
  },
721
+ /**
722
+ * Deletes the image of a product.
723
+ * @summary Delete an image of a product
724
+ * @param {BetaApiDeleteProductImageRequest} requestParameters Request parameters.
725
+
726
+ * @throws {RequiredError}
727
+ */
728
+ deleteProductImage(requestParameters) {
729
+ return localVarFp.deleteProductImage(requestParameters.id).then((request) => request(axios, basePath));
730
+ },
513
731
  /**
514
732
  * Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
515
733
  * @summary Get Deal conversion status (BETA)
@@ -521,7 +739,7 @@ export const BetaApiFactory = function (configuration, basePath, axios) {
521
739
  return localVarFp.getDealConversionStatus(requestParameters.id, requestParameters.conversion_id).then((request) => request(axios, basePath));
522
740
  },
523
741
  /**
524
- * Lists installments attached to a list of deals. Only available in Advanced and above plans.
742
+ * Lists installments attached to a list of deals. Only available in Growth and above plans.
525
743
  * @summary List installments added to a list of deals
526
744
  * @param {BetaApiGetInstallmentsRequest} requestParameters Request parameters.
527
745
 
@@ -541,7 +759,17 @@ export const BetaApiFactory = function (configuration, basePath, axios) {
541
759
  return localVarFp.getLeadConversionStatus(requestParameters.id, requestParameters.conversion_id).then((request) => request(axios, basePath));
542
760
  },
543
761
  /**
544
- * Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Advanced and above plans.
762
+ * Retrieves the image of a product. The public URL has a limited lifetime of 7 days.
763
+ * @summary Get image of a product
764
+ * @param {BetaApiGetProductImageRequest} requestParameters Request parameters.
765
+
766
+ * @throws {RequiredError}
767
+ */
768
+ getProductImage(requestParameters) {
769
+ return localVarFp.getProductImage(requestParameters.id).then((request) => request(axios, basePath));
770
+ },
771
+ /**
772
+ * Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Growth and above plans.
545
773
  * @summary Add an installment to a deal
546
774
  * @param {BetaApiPostInstallmentRequest} requestParameters Request parameters.
547
775
 
@@ -551,7 +779,7 @@ export const BetaApiFactory = function (configuration, basePath, axios) {
551
779
  return localVarFp.postInstallment(requestParameters.id, requestParameters.AddInstallmentRequestBody).then((request) => request(axios, basePath));
552
780
  },
553
781
  /**
554
- * Edits an installment added to a deal. Only available in Advanced and above plans.
782
+ * Edits an installment added to a deal. Only available in Growth and above plans.
555
783
  * @summary Update an installment added to a deal
556
784
  * @param {BetaApiUpdateInstallmentRequest} requestParameters Request parameters.
557
785
 
@@ -560,6 +788,26 @@ export const BetaApiFactory = function (configuration, basePath, axios) {
560
788
  updateInstallment(requestParameters) {
561
789
  return localVarFp.updateInstallment(requestParameters.id, requestParameters.installment_id, requestParameters.UpdateInstallmentRequestBody).then((request) => request(axios, basePath));
562
790
  },
791
+ /**
792
+ * Updates the image of a product.
793
+ * @summary Update an image for a product
794
+ * @param {BetaApiUpdateProductImageRequest} requestParameters Request parameters.
795
+
796
+ * @throws {RequiredError}
797
+ */
798
+ updateProductImage(requestParameters) {
799
+ return localVarFp.updateProductImage(requestParameters.id, requestParameters.data).then((request) => request(axios, basePath));
800
+ },
801
+ /**
802
+ * Uploads an image for a product.
803
+ * @summary Upload an image for a product
804
+ * @param {BetaApiUploadProductImageRequest} requestParameters Request parameters.
805
+
806
+ * @throws {RequiredError}
807
+ */
808
+ uploadProductImage(requestParameters) {
809
+ return localVarFp.uploadProductImage(requestParameters.id, requestParameters.data).then((request) => request(axios, basePath));
810
+ },
563
811
  };
564
812
  };
565
813
  /**
@@ -592,7 +840,7 @@ export class BetaApi extends BaseAPI {
592
840
  return BetaApiFp(this.configuration).convertLeadToDeal(requestParameters.id, requestParameters.ConvertLeadToDealRequest).then((request) => request(this.axios, this.basePath));
593
841
  }
594
842
  /**
595
- * Removes an installment from a deal. Only available in Advanced and above plans.
843
+ * Removes an installment from a deal. Only available in Growth and above plans.
596
844
  * @summary Delete an installment from a deal
597
845
  * @param {BetaApiDeleteInstallmentRequest} requestParameters Request parameters.
598
846
 
@@ -602,6 +850,17 @@ export class BetaApi extends BaseAPI {
602
850
  deleteInstallment(requestParameters) {
603
851
  return BetaApiFp(this.configuration).deleteInstallment(requestParameters.id, requestParameters.installment_id).then((request) => request(this.axios, this.basePath));
604
852
  }
853
+ /**
854
+ * Deletes the image of a product.
855
+ * @summary Delete an image of a product
856
+ * @param {BetaApiDeleteProductImageRequest} requestParameters Request parameters.
857
+
858
+ * @throws {RequiredError}
859
+ * @memberof BetaApi
860
+ */
861
+ deleteProductImage(requestParameters) {
862
+ return BetaApiFp(this.configuration).deleteProductImage(requestParameters.id).then((request) => request(this.axios, this.basePath));
863
+ }
605
864
  /**
606
865
  * Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
607
866
  * @summary Get Deal conversion status (BETA)
@@ -614,7 +873,7 @@ export class BetaApi extends BaseAPI {
614
873
  return BetaApiFp(this.configuration).getDealConversionStatus(requestParameters.id, requestParameters.conversion_id).then((request) => request(this.axios, this.basePath));
615
874
  }
616
875
  /**
617
- * Lists installments attached to a list of deals. Only available in Advanced and above plans.
876
+ * Lists installments attached to a list of deals. Only available in Growth and above plans.
618
877
  * @summary List installments added to a list of deals
619
878
  * @param {BetaApiGetInstallmentsRequest} requestParameters Request parameters.
620
879
 
@@ -636,7 +895,18 @@ export class BetaApi extends BaseAPI {
636
895
  return BetaApiFp(this.configuration).getLeadConversionStatus(requestParameters.id, requestParameters.conversion_id).then((request) => request(this.axios, this.basePath));
637
896
  }
638
897
  /**
639
- * Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Advanced and above plans.
898
+ * Retrieves the image of a product. The public URL has a limited lifetime of 7 days.
899
+ * @summary Get image of a product
900
+ * @param {BetaApiGetProductImageRequest} requestParameters Request parameters.
901
+
902
+ * @throws {RequiredError}
903
+ * @memberof BetaApi
904
+ */
905
+ getProductImage(requestParameters) {
906
+ return BetaApiFp(this.configuration).getProductImage(requestParameters.id).then((request) => request(this.axios, this.basePath));
907
+ }
908
+ /**
909
+ * Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Growth and above plans.
640
910
  * @summary Add an installment to a deal
641
911
  * @param {BetaApiPostInstallmentRequest} requestParameters Request parameters.
642
912
 
@@ -647,7 +917,7 @@ export class BetaApi extends BaseAPI {
647
917
  return BetaApiFp(this.configuration).postInstallment(requestParameters.id, requestParameters.AddInstallmentRequestBody).then((request) => request(this.axios, this.basePath));
648
918
  }
649
919
  /**
650
- * Edits an installment added to a deal. Only available in Advanced and above plans.
920
+ * Edits an installment added to a deal. Only available in Growth and above plans.
651
921
  * @summary Update an installment added to a deal
652
922
  * @param {BetaApiUpdateInstallmentRequest} requestParameters Request parameters.
653
923
 
@@ -657,4 +927,26 @@ export class BetaApi extends BaseAPI {
657
927
  updateInstallment(requestParameters) {
658
928
  return BetaApiFp(this.configuration).updateInstallment(requestParameters.id, requestParameters.installment_id, requestParameters.UpdateInstallmentRequestBody).then((request) => request(this.axios, this.basePath));
659
929
  }
930
+ /**
931
+ * Updates the image of a product.
932
+ * @summary Update an image for a product
933
+ * @param {BetaApiUpdateProductImageRequest} requestParameters Request parameters.
934
+
935
+ * @throws {RequiredError}
936
+ * @memberof BetaApi
937
+ */
938
+ updateProductImage(requestParameters) {
939
+ return BetaApiFp(this.configuration).updateProductImage(requestParameters.id, requestParameters.data).then((request) => request(this.axios, this.basePath));
940
+ }
941
+ /**
942
+ * Uploads an image for a product.
943
+ * @summary Upload an image for a product
944
+ * @param {BetaApiUploadProductImageRequest} requestParameters Request parameters.
945
+
946
+ * @throws {RequiredError}
947
+ * @memberof BetaApi
948
+ */
949
+ uploadProductImage(requestParameters) {
950
+ return BetaApiFp(this.configuration).uploadProductImage(requestParameters.id, requestParameters.data).then((request) => request(this.axios, this.basePath));
951
+ }
660
952
  }
@@ -117,7 +117,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
117
117
  */
118
118
  deleteDealProduct: (id: number, product_attachment_id: number) => Promise<RequestArgs>;
119
119
  /**
120
- * Removes an installment from a deal. Only available in Advanced and above plans.
120
+ * Removes an installment from a deal. Only available in Growth and above plans.
121
121
  * @summary Delete an installment from a deal
122
122
  * @param {number} id The ID of the deal
123
123
  * @param {number} installment_id The ID of the installment
@@ -243,7 +243,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
243
243
  */
244
244
  getDealsProducts: (deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
245
245
  /**
246
- * Lists installments attached to a list of deals. Only available in Advanced and above plans.
246
+ * Lists installments attached to a list of deals. Only available in Growth and above plans.
247
247
  * @summary List installments added to a list of deals
248
248
  * @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided.
249
249
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
@@ -264,7 +264,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
264
264
  */
265
265
  postAdditionalDiscount: (id: number, AddAdditionalDiscountRequestBody?: AddAdditionalDiscountRequestBody) => Promise<RequestArgs>;
266
266
  /**
267
- * Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Advanced and above plans.
267
+ * Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Growth and above plans.
268
268
  * @summary Add an installment to a deal
269
269
  * @param {number} id The ID of the deal
270
270
  * @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
@@ -318,7 +318,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
318
318
  */
319
319
  updateDealProduct: (id: number, product_attachment_id: number, UpdateDealProductRequest?: UpdateDealProductRequest) => Promise<RequestArgs>;
320
320
  /**
321
- * Edits an installment added to a deal. Only available in Advanced and above plans.
321
+ * Edits an installment added to a deal. Only available in Growth and above plans.
322
322
  * @summary Update an installment added to a deal
323
323
  * @param {number} id The ID of the deal
324
324
  * @param {number} installment_id The ID of the installment
@@ -403,7 +403,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
403
403
  */
404
404
  deleteDealProduct(id: number, product_attachment_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealProductResponse>>;
405
405
  /**
406
- * Removes an installment from a deal. Only available in Advanced and above plans.
406
+ * Removes an installment from a deal. Only available in Growth and above plans.
407
407
  * @summary Delete an installment from a deal
408
408
  * @param {number} id The ID of the deal
409
409
  * @param {number} installment_id The ID of the installment
@@ -529,7 +529,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
529
529
  */
530
530
  getDealsProducts(deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsProductsResponse>>;
531
531
  /**
532
- * Lists installments attached to a list of deals. Only available in Advanced and above plans.
532
+ * Lists installments attached to a list of deals. Only available in Growth and above plans.
533
533
  * @summary List installments added to a list of deals
534
534
  * @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided.
535
535
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
@@ -550,7 +550,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
550
550
  */
551
551
  postAdditionalDiscount(id: number, AddAdditionalDiscountRequestBody?: AddAdditionalDiscountRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddAdditionalDiscountResponse>>;
552
552
  /**
553
- * Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Advanced and above plans.
553
+ * Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Growth and above plans.
554
554
  * @summary Add an installment to a deal
555
555
  * @param {number} id The ID of the deal
556
556
  * @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
@@ -604,7 +604,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
604
604
  */
605
605
  updateDealProduct(id: number, product_attachment_id: number, UpdateDealProductRequest?: UpdateDealProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealProductResponse>>;
606
606
  /**
607
- * Edits an installment added to a deal. Only available in Advanced and above plans.
607
+ * Edits an installment added to a deal. Only available in Growth and above plans.
608
608
  * @summary Update an installment added to a deal
609
609
  * @param {number} id The ID of the deal
610
610
  * @param {number} installment_id The ID of the installment
@@ -684,7 +684,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
684
684
  */
685
685
  deleteDealProduct(requestParameters: DealsApiDeleteDealProductRequest): Promise<DeleteDealProductResponse>;
686
686
  /**
687
- * Removes an installment from a deal. Only available in Advanced and above plans.
687
+ * Removes an installment from a deal. Only available in Growth and above plans.
688
688
  * @summary Delete an installment from a deal
689
689
  * @param {DealsApiDeleteInstallmentRequest} requestParameters Request parameters.
690
690
 
@@ -764,7 +764,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
764
764
  */
765
765
  getDealsProducts(requestParameters: DealsApiGetDealsProductsRequest): Promise<GetDealsProductsResponse>;
766
766
  /**
767
- * Lists installments attached to a list of deals. Only available in Advanced and above plans.
767
+ * Lists installments attached to a list of deals. Only available in Growth and above plans.
768
768
  * @summary List installments added to a list of deals
769
769
  * @param {DealsApiGetInstallmentsRequest} requestParameters Request parameters.
770
770
 
@@ -780,7 +780,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
780
780
  */
781
781
  postAdditionalDiscount(requestParameters: DealsApiPostAdditionalDiscountRequest): Promise<AddAdditionalDiscountResponse>;
782
782
  /**
783
- * Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Advanced and above plans.
783
+ * Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Growth and above plans.
784
784
  * @summary Add an installment to a deal
785
785
  * @param {DealsApiPostInstallmentRequest} requestParameters Request parameters.
786
786
 
@@ -820,7 +820,7 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
820
820
  */
821
821
  updateDealProduct(requestParameters: DealsApiUpdateDealProductRequest): Promise<AddDealProductResponse>;
822
822
  /**
823
- * Edits an installment added to a deal. Only available in Advanced and above plans.
823
+ * Edits an installment added to a deal. Only available in Growth and above plans.
824
824
  * @summary Update an installment added to a deal
825
825
  * @param {DealsApiUpdateInstallmentRequest} requestParameters Request parameters.
826
826
 
@@ -1678,7 +1678,7 @@ export declare class DealsApi extends BaseAPI {
1678
1678
  */
1679
1679
  deleteDealProduct(requestParameters: DealsApiDeleteDealProductRequest): Promise<DeleteDealProductResponse>;
1680
1680
  /**
1681
- * Removes an installment from a deal. Only available in Advanced and above plans.
1681
+ * Removes an installment from a deal. Only available in Growth and above plans.
1682
1682
  * @summary Delete an installment from a deal
1683
1683
  * @param {DealsApiDeleteInstallmentRequest} requestParameters Request parameters.
1684
1684
 
@@ -1768,7 +1768,7 @@ export declare class DealsApi extends BaseAPI {
1768
1768
  */
1769
1769
  getDealsProducts(requestParameters: DealsApiGetDealsProductsRequest): Promise<GetDealsProductsResponse>;
1770
1770
  /**
1771
- * Lists installments attached to a list of deals. Only available in Advanced and above plans.
1771
+ * Lists installments attached to a list of deals. Only available in Growth and above plans.
1772
1772
  * @summary List installments added to a list of deals
1773
1773
  * @param {DealsApiGetInstallmentsRequest} requestParameters Request parameters.
1774
1774
 
@@ -1786,7 +1786,7 @@ export declare class DealsApi extends BaseAPI {
1786
1786
  */
1787
1787
  postAdditionalDiscount(requestParameters: DealsApiPostAdditionalDiscountRequest): Promise<AddAdditionalDiscountResponse>;
1788
1788
  /**
1789
- * Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Advanced and above plans.
1789
+ * Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Growth and above plans.
1790
1790
  * @summary Add an installment to a deal
1791
1791
  * @param {DealsApiPostInstallmentRequest} requestParameters Request parameters.
1792
1792
 
@@ -1831,7 +1831,7 @@ export declare class DealsApi extends BaseAPI {
1831
1831
  */
1832
1832
  updateDealProduct(requestParameters: DealsApiUpdateDealProductRequest): Promise<AddDealProductResponse>;
1833
1833
  /**
1834
- * Edits an installment added to a deal. Only available in Advanced and above plans.
1834
+ * Edits an installment added to a deal. Only available in Growth and above plans.
1835
1835
  * @summary Update an installment added to a deal
1836
1836
  * @param {DealsApiUpdateInstallmentRequest} requestParameters Request parameters.
1837
1837