pipedrive 24.1.0 → 24.2.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 (79) hide show
  1. package/dist/esm/versions/v1/models/additional-data.d.ts +38 -0
  2. package/dist/esm/versions/v1/models/additional-data.js +14 -0
  3. package/dist/esm/versions/v1/models/base-webhook.d.ts +2 -1
  4. package/dist/esm/versions/v1/models/base-webhook.js +2 -1
  5. package/dist/esm/versions/v1/models/get-notes-response-additional-data.d.ts +3 -3
  6. package/dist/esm/versions/v1/models/index.d.ts +1 -1
  7. package/dist/esm/versions/v1/models/index.js +1 -1
  8. package/dist/esm/versions/v2/api/activities-api.d.ts +34 -2
  9. package/dist/esm/versions/v2/api/activities-api.js +25 -5
  10. package/dist/esm/versions/v2/api/beta-api.d.ts +288 -2
  11. package/dist/esm/versions/v2/api/beta-api.js +337 -5
  12. package/dist/esm/versions/v2/api/deals-api.d.ts +254 -0
  13. package/dist/esm/versions/v2/api/deals-api.js +312 -0
  14. package/dist/esm/versions/v2/models/add-ainstallment-response.d.ts +29 -0
  15. package/dist/esm/versions/v2/models/add-ainstallment-response.js +14 -0
  16. package/dist/esm/versions/v2/models/add-installment-request-body.d.ts +33 -0
  17. package/dist/esm/versions/v2/models/add-installment-request-body.js +14 -0
  18. package/dist/esm/versions/v2/models/delete-installment-response-data.d.ts +23 -0
  19. package/dist/esm/versions/v2/models/delete-installment-response-data.js +14 -0
  20. package/dist/esm/versions/v2/models/delete-installment-response.d.ts +29 -0
  21. package/dist/esm/versions/v2/models/delete-installment-response.js +14 -0
  22. package/dist/esm/versions/v2/models/get-activities-response-all-of-additional-data.d.ts +23 -0
  23. package/dist/esm/versions/v2/models/get-activities-response-all-of-additional-data.js +14 -0
  24. package/dist/esm/versions/v2/models/get-activities-response-all-of.d.ts +6 -0
  25. package/dist/esm/versions/v2/models/get-deals-response-all-of.d.ts +6 -0
  26. package/dist/esm/versions/v2/models/get-installments-response-data-inner.d.ts +43 -0
  27. package/dist/esm/versions/v2/models/get-installments-response-data-inner.js +14 -0
  28. package/dist/esm/versions/v2/models/get-installments-response.d.ts +29 -0
  29. package/dist/esm/versions/v2/models/get-installments-response.js +14 -0
  30. package/dist/esm/versions/v2/models/get-organizations-response-all-of.d.ts +6 -0
  31. package/dist/esm/versions/v2/models/get-persons-response-all-of.d.ts +6 -0
  32. package/dist/esm/versions/v2/models/get-pipelines-response-all-of.d.ts +6 -0
  33. package/dist/esm/versions/v2/models/get-stages-response.d.ts +6 -0
  34. package/dist/esm/versions/v2/models/index.d.ts +9 -0
  35. package/dist/esm/versions/v2/models/index.js +9 -0
  36. package/dist/esm/versions/v2/models/update-installment-request-body.d.ts +33 -0
  37. package/dist/esm/versions/v2/models/update-installment-request-body.js +14 -0
  38. package/dist/esm/versions/v2/models/update-installment-response.d.ts +29 -0
  39. package/dist/esm/versions/v2/models/update-installment-response.js +14 -0
  40. package/dist/versions/v1/models/additional-data.d.ts +38 -0
  41. package/dist/versions/v1/models/additional-data.js +15 -0
  42. package/dist/versions/v1/models/base-webhook.d.ts +2 -1
  43. package/dist/versions/v1/models/base-webhook.js +2 -1
  44. package/dist/versions/v1/models/get-notes-response-additional-data.d.ts +3 -3
  45. package/dist/versions/v1/models/index.d.ts +1 -1
  46. package/dist/versions/v1/models/index.js +1 -1
  47. package/dist/versions/v2/api/activities-api.d.ts +34 -2
  48. package/dist/versions/v2/api/activities-api.js +25 -5
  49. package/dist/versions/v2/api/beta-api.d.ts +288 -2
  50. package/dist/versions/v2/api/beta-api.js +337 -5
  51. package/dist/versions/v2/api/deals-api.d.ts +254 -0
  52. package/dist/versions/v2/api/deals-api.js +312 -0
  53. package/dist/versions/v2/models/add-ainstallment-response.d.ts +29 -0
  54. package/dist/versions/v2/models/add-ainstallment-response.js +15 -0
  55. package/dist/versions/v2/models/add-installment-request-body.d.ts +33 -0
  56. package/dist/versions/v2/models/add-installment-request-body.js +15 -0
  57. package/dist/versions/v2/models/delete-installment-response-data.d.ts +23 -0
  58. package/dist/versions/v2/models/delete-installment-response-data.js +15 -0
  59. package/dist/versions/v2/models/delete-installment-response.d.ts +29 -0
  60. package/dist/versions/v2/models/delete-installment-response.js +15 -0
  61. package/dist/versions/v2/models/get-activities-response-all-of-additional-data.d.ts +23 -0
  62. package/dist/versions/v2/models/get-activities-response-all-of-additional-data.js +15 -0
  63. package/dist/versions/v2/models/get-activities-response-all-of.d.ts +6 -0
  64. package/dist/versions/v2/models/get-deals-response-all-of.d.ts +6 -0
  65. package/dist/versions/v2/models/get-installments-response-data-inner.d.ts +43 -0
  66. package/dist/versions/v2/models/get-installments-response-data-inner.js +15 -0
  67. package/dist/versions/v2/models/get-installments-response.d.ts +29 -0
  68. package/dist/versions/v2/models/get-installments-response.js +15 -0
  69. package/dist/versions/v2/models/get-organizations-response-all-of.d.ts +6 -0
  70. package/dist/versions/v2/models/get-persons-response-all-of.d.ts +6 -0
  71. package/dist/versions/v2/models/get-pipelines-response-all-of.d.ts +6 -0
  72. package/dist/versions/v2/models/get-stages-response.d.ts +6 -0
  73. package/dist/versions/v2/models/index.d.ts +9 -0
  74. package/dist/versions/v2/models/index.js +9 -0
  75. package/dist/versions/v2/models/update-installment-request-body.d.ts +33 -0
  76. package/dist/versions/v2/models/update-installment-request-body.js +15 -0
  77. package/dist/versions/v2/models/update-installment-response.d.ts +29 -0
  78. package/dist/versions/v2/models/update-installment-response.js +15 -0
  79. package/package.json +1 -1
@@ -218,6 +218,44 @@ const DealsApiAxiosParamCreator = function (configuration) {
218
218
  options: localVarRequestOptions,
219
219
  };
220
220
  }),
221
+ /**
222
+ * Removes an installment from a deal. Only available in Advanced and above plans.
223
+ * @summary Delete an installment from a deal
224
+ * @param {number} id The ID of the deal
225
+ * @param {number} installment_id The ID of the installment
226
+
227
+ * @throws {RequiredError}
228
+ */
229
+ deleteInstallment: (id, installment_id) => __awaiter(this, void 0, void 0, function* () {
230
+ // verify required parameter 'id' is not null or undefined
231
+ (0, common_1.assertParamExists)('deleteInstallment', 'id', id);
232
+ // verify required parameter 'installment_id' is not null or undefined
233
+ (0, common_1.assertParamExists)('deleteInstallment', 'installment_id', installment_id);
234
+ const localVarPath = `/deals/{id}/installments/{installment_id}`
235
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)))
236
+ .replace(`{${"installment_id"}}`, encodeURIComponent(String(installment_id)));
237
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
238
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
239
+ let baseOptions;
240
+ if (configuration) {
241
+ baseOptions = configuration.baseOptions;
242
+ }
243
+ const localVarRequestOptions = Object.assign({ method: 'DELETE' }, baseOptions);
244
+ const localVarHeaderParameter = {};
245
+ const localVarQueryParameter = {};
246
+ // authentication api_key required
247
+ yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
248
+ // authentication oauth2 required
249
+ // oauth required
250
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
251
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
252
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
253
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
254
+ return {
255
+ url: (0, common_1.toPathString)(localVarUrlObj),
256
+ options: localVarRequestOptions,
257
+ };
258
+ }),
221
259
  /**
222
260
  * Lists discounts attached to a deal.
223
261
  * @summary List discounts added to a deal
@@ -490,6 +528,58 @@ const DealsApiAxiosParamCreator = function (configuration) {
490
528
  options: localVarRequestOptions,
491
529
  };
492
530
  }),
531
+ /**
532
+ * Lists installments attached to a list of deals. Only available in Advanced and above plans.
533
+ * @summary List installments added to a list of deals
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
+ * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
536
+ * @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.
537
+ * @param {'id' | 'billing_date' | 'deal_id'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;billing_date&#x60;, &#x60;deal_id&#x60;.
538
+ * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
539
+
540
+ * @throws {RequiredError}
541
+ */
542
+ getInstallments: (deal_ids, cursor, limit, sort_by, sort_direction) => __awaiter(this, void 0, void 0, function* () {
543
+ // verify required parameter 'deal_ids' is not null or undefined
544
+ (0, common_1.assertParamExists)('getInstallments', 'deal_ids', deal_ids);
545
+ const localVarPath = `/deals/installments`;
546
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
547
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
548
+ let baseOptions;
549
+ if (configuration) {
550
+ baseOptions = configuration.baseOptions;
551
+ }
552
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
553
+ const localVarHeaderParameter = {};
554
+ const localVarQueryParameter = {};
555
+ // authentication api_key required
556
+ yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
557
+ // authentication oauth2 required
558
+ // oauth required
559
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
560
+ if (deal_ids) {
561
+ localVarQueryParameter['deal_ids'] = deal_ids;
562
+ }
563
+ if (cursor !== undefined) {
564
+ localVarQueryParameter['cursor'] = cursor;
565
+ }
566
+ if (limit !== undefined) {
567
+ localVarQueryParameter['limit'] = limit;
568
+ }
569
+ if (sort_by !== undefined) {
570
+ localVarQueryParameter['sort_by'] = sort_by;
571
+ }
572
+ if (sort_direction !== undefined) {
573
+ localVarQueryParameter['sort_direction'] = sort_direction;
574
+ }
575
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
576
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
577
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
578
+ return {
579
+ url: (0, common_1.toPathString)(localVarUrlObj),
580
+ options: localVarRequestOptions,
581
+ };
582
+ }),
493
583
  /**
494
584
  * Adds a discount to a deal changing, the deal value if the deal has one-time products attached.
495
585
  * @summary Add a discount to a deal
@@ -527,6 +617,43 @@ const DealsApiAxiosParamCreator = function (configuration) {
527
617
  options: localVarRequestOptions,
528
618
  };
529
619
  }),
620
+ /**
621
+ * 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.
622
+ * @summary Add an installment to a deal
623
+ * @param {number} id The ID of the deal
624
+ * @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
625
+
626
+ * @throws {RequiredError}
627
+ */
628
+ postInstallment: (id, AddInstallmentRequestBody) => __awaiter(this, void 0, void 0, function* () {
629
+ // verify required parameter 'id' is not null or undefined
630
+ (0, common_1.assertParamExists)('postInstallment', 'id', id);
631
+ const localVarPath = `/deals/{id}/installments`
632
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
633
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
634
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
635
+ let baseOptions;
636
+ if (configuration) {
637
+ baseOptions = configuration.baseOptions;
638
+ }
639
+ const localVarRequestOptions = Object.assign({ method: 'POST' }, baseOptions);
640
+ const localVarHeaderParameter = {};
641
+ const localVarQueryParameter = {};
642
+ // authentication api_key required
643
+ yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
644
+ // authentication oauth2 required
645
+ // oauth required
646
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
647
+ localVarHeaderParameter['Content-Type'] = 'application/json';
648
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
649
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
650
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
651
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(AddInstallmentRequestBody, localVarRequestOptions, configuration);
652
+ return {
653
+ url: (0, common_1.toPathString)(localVarUrlObj),
654
+ options: localVarRequestOptions,
655
+ };
656
+ }),
530
657
  /**
531
658
  * Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
532
659
  * @summary Search deals
@@ -714,6 +841,47 @@ const DealsApiAxiosParamCreator = function (configuration) {
714
841
  options: localVarRequestOptions,
715
842
  };
716
843
  }),
844
+ /**
845
+ * Edits an installment added to a deal. Only available in Advanced and above plans.
846
+ * @summary Update an installment added to a deal
847
+ * @param {number} id The ID of the deal
848
+ * @param {number} installment_id The ID of the installment
849
+ * @param {UpdateInstallmentRequestBody} [UpdateInstallmentRequestBody]
850
+
851
+ * @throws {RequiredError}
852
+ */
853
+ updateInstallment: (id, installment_id, UpdateInstallmentRequestBody) => __awaiter(this, void 0, void 0, function* () {
854
+ // verify required parameter 'id' is not null or undefined
855
+ (0, common_1.assertParamExists)('updateInstallment', 'id', id);
856
+ // verify required parameter 'installment_id' is not null or undefined
857
+ (0, common_1.assertParamExists)('updateInstallment', 'installment_id', installment_id);
858
+ const localVarPath = `/deals/{id}/installments/{installment_id}`
859
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)))
860
+ .replace(`{${"installment_id"}}`, encodeURIComponent(String(installment_id)));
861
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
862
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
863
+ let baseOptions;
864
+ if (configuration) {
865
+ baseOptions = configuration.baseOptions;
866
+ }
867
+ const localVarRequestOptions = Object.assign({ method: 'PATCH' }, baseOptions);
868
+ const localVarHeaderParameter = {};
869
+ const localVarQueryParameter = {};
870
+ // authentication api_key required
871
+ yield (0, common_1.setApiKeyToObject)(localVarQueryParameter, "api_token", configuration);
872
+ // authentication oauth2 required
873
+ // oauth required
874
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
875
+ localVarHeaderParameter['Content-Type'] = 'application/json';
876
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
877
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
878
+ localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
879
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(UpdateInstallmentRequestBody, localVarRequestOptions, configuration);
880
+ return {
881
+ url: (0, common_1.toPathString)(localVarUrlObj),
882
+ options: localVarRequestOptions,
883
+ };
884
+ }),
717
885
  };
718
886
  };
719
887
  exports.DealsApiAxiosParamCreator = DealsApiAxiosParamCreator;
@@ -792,6 +960,20 @@ const DealsApiFp = function (configuration) {
792
960
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
793
961
  });
794
962
  },
963
+ /**
964
+ * Removes an installment from a deal. Only available in Advanced and above plans.
965
+ * @summary Delete an installment from a deal
966
+ * @param {number} id The ID of the deal
967
+ * @param {number} installment_id The ID of the installment
968
+
969
+ * @throws {RequiredError}
970
+ */
971
+ deleteInstallment(id, installment_id) {
972
+ return __awaiter(this, void 0, void 0, function* () {
973
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteInstallment(id, installment_id);
974
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
975
+ });
976
+ },
795
977
  /**
796
978
  * Lists discounts attached to a deal.
797
979
  * @summary List discounts added to a deal
@@ -882,6 +1064,23 @@ const DealsApiFp = function (configuration) {
882
1064
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
883
1065
  });
884
1066
  },
1067
+ /**
1068
+ * Lists installments attached to a list of deals. Only available in Advanced and above plans.
1069
+ * @summary List installments added to a list of deals
1070
+ * @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.
1071
+ * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
1072
+ * @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.
1073
+ * @param {'id' | 'billing_date' | 'deal_id'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;billing_date&#x60;, &#x60;deal_id&#x60;.
1074
+ * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
1075
+
1076
+ * @throws {RequiredError}
1077
+ */
1078
+ getInstallments(deal_ids, cursor, limit, sort_by, sort_direction) {
1079
+ return __awaiter(this, void 0, void 0, function* () {
1080
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getInstallments(deal_ids, cursor, limit, sort_by, sort_direction);
1081
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1082
+ });
1083
+ },
885
1084
  /**
886
1085
  * Adds a discount to a deal changing, the deal value if the deal has one-time products attached.
887
1086
  * @summary Add a discount to a deal
@@ -896,6 +1095,20 @@ const DealsApiFp = function (configuration) {
896
1095
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
897
1096
  });
898
1097
  },
1098
+ /**
1099
+ * 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.
1100
+ * @summary Add an installment to a deal
1101
+ * @param {number} id The ID of the deal
1102
+ * @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
1103
+
1104
+ * @throws {RequiredError}
1105
+ */
1106
+ postInstallment(id, AddInstallmentRequestBody) {
1107
+ return __awaiter(this, void 0, void 0, function* () {
1108
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.postInstallment(id, AddInstallmentRequestBody);
1109
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1110
+ });
1111
+ },
899
1112
  /**
900
1113
  * Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
901
1114
  * @summary Search deals
@@ -961,6 +1174,21 @@ const DealsApiFp = function (configuration) {
961
1174
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
962
1175
  });
963
1176
  },
1177
+ /**
1178
+ * Edits an installment added to a deal. Only available in Advanced and above plans.
1179
+ * @summary Update an installment added to a deal
1180
+ * @param {number} id The ID of the deal
1181
+ * @param {number} installment_id The ID of the installment
1182
+ * @param {UpdateInstallmentRequestBody} [UpdateInstallmentRequestBody]
1183
+
1184
+ * @throws {RequiredError}
1185
+ */
1186
+ updateInstallment(id, installment_id, UpdateInstallmentRequestBody) {
1187
+ return __awaiter(this, void 0, void 0, function* () {
1188
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.updateInstallment(id, installment_id, UpdateInstallmentRequestBody);
1189
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1190
+ });
1191
+ },
964
1192
  };
965
1193
  };
966
1194
  exports.DealsApiFp = DealsApiFp;
@@ -1021,6 +1249,16 @@ const DealsApiFactory = function (configuration, basePath, axios) {
1021
1249
  deleteDealProduct(requestParameters) {
1022
1250
  return localVarFp.deleteDealProduct(requestParameters.id, requestParameters.product_attachment_id).then((request) => request(axios, basePath));
1023
1251
  },
1252
+ /**
1253
+ * Removes an installment from a deal. Only available in Advanced and above plans.
1254
+ * @summary Delete an installment from a deal
1255
+ * @param {DealsApiDeleteInstallmentRequest} requestParameters Request parameters.
1256
+
1257
+ * @throws {RequiredError}
1258
+ */
1259
+ deleteInstallment(requestParameters) {
1260
+ return localVarFp.deleteInstallment(requestParameters.id, requestParameters.installment_id).then((request) => request(axios, basePath));
1261
+ },
1024
1262
  /**
1025
1263
  * Lists discounts attached to a deal.
1026
1264
  * @summary List discounts added to a deal
@@ -1071,6 +1309,16 @@ const DealsApiFactory = function (configuration, basePath, axios) {
1071
1309
  getDealsProducts(requestParameters) {
1072
1310
  return localVarFp.getDealsProducts(requestParameters.deal_ids, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(axios, basePath));
1073
1311
  },
1312
+ /**
1313
+ * Lists installments attached to a list of deals. Only available in Advanced and above plans.
1314
+ * @summary List installments added to a list of deals
1315
+ * @param {DealsApiGetInstallmentsRequest} requestParameters Request parameters.
1316
+
1317
+ * @throws {RequiredError}
1318
+ */
1319
+ getInstallments(requestParameters) {
1320
+ return localVarFp.getInstallments(requestParameters.deal_ids, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(axios, basePath));
1321
+ },
1074
1322
  /**
1075
1323
  * Adds a discount to a deal changing, the deal value if the deal has one-time products attached.
1076
1324
  * @summary Add a discount to a deal
@@ -1081,6 +1329,16 @@ const DealsApiFactory = function (configuration, basePath, axios) {
1081
1329
  postAdditionalDiscount(requestParameters) {
1082
1330
  return localVarFp.postAdditionalDiscount(requestParameters.id, requestParameters.AddAdditionalDiscountRequestBody).then((request) => request(axios, basePath));
1083
1331
  },
1332
+ /**
1333
+ * 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.
1334
+ * @summary Add an installment to a deal
1335
+ * @param {DealsApiPostInstallmentRequest} requestParameters Request parameters.
1336
+
1337
+ * @throws {RequiredError}
1338
+ */
1339
+ postInstallment(requestParameters) {
1340
+ return localVarFp.postInstallment(requestParameters.id, requestParameters.AddInstallmentRequestBody).then((request) => request(axios, basePath));
1341
+ },
1084
1342
  /**
1085
1343
  * Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
1086
1344
  * @summary Search deals
@@ -1121,6 +1379,16 @@ const DealsApiFactory = function (configuration, basePath, axios) {
1121
1379
  updateDealProduct(requestParameters) {
1122
1380
  return localVarFp.updateDealProduct(requestParameters.id, requestParameters.product_attachment_id, requestParameters.UpdateDealProductRequest).then((request) => request(axios, basePath));
1123
1381
  },
1382
+ /**
1383
+ * Edits an installment added to a deal. Only available in Advanced and above plans.
1384
+ * @summary Update an installment added to a deal
1385
+ * @param {DealsApiUpdateInstallmentRequest} requestParameters Request parameters.
1386
+
1387
+ * @throws {RequiredError}
1388
+ */
1389
+ updateInstallment(requestParameters) {
1390
+ return localVarFp.updateInstallment(requestParameters.id, requestParameters.installment_id, requestParameters.UpdateInstallmentRequestBody).then((request) => request(axios, basePath));
1391
+ },
1124
1392
  };
1125
1393
  };
1126
1394
  exports.DealsApiFactory = DealsApiFactory;
@@ -1186,6 +1454,17 @@ class DealsApi extends base_1.BaseAPI {
1186
1454
  deleteDealProduct(requestParameters) {
1187
1455
  return (0, exports.DealsApiFp)(this.configuration).deleteDealProduct(requestParameters.id, requestParameters.product_attachment_id).then((request) => request(this.axios, this.basePath));
1188
1456
  }
1457
+ /**
1458
+ * Removes an installment from a deal. Only available in Advanced and above plans.
1459
+ * @summary Delete an installment from a deal
1460
+ * @param {DealsApiDeleteInstallmentRequest} requestParameters Request parameters.
1461
+
1462
+ * @throws {RequiredError}
1463
+ * @memberof DealsApi
1464
+ */
1465
+ deleteInstallment(requestParameters) {
1466
+ return (0, exports.DealsApiFp)(this.configuration).deleteInstallment(requestParameters.id, requestParameters.installment_id).then((request) => request(this.axios, this.basePath));
1467
+ }
1189
1468
  /**
1190
1469
  * Lists discounts attached to a deal.
1191
1470
  * @summary List discounts added to a deal
@@ -1241,6 +1520,17 @@ class DealsApi extends base_1.BaseAPI {
1241
1520
  getDealsProducts(requestParameters) {
1242
1521
  return (0, exports.DealsApiFp)(this.configuration).getDealsProducts(requestParameters.deal_ids, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(this.axios, this.basePath));
1243
1522
  }
1523
+ /**
1524
+ * Lists installments attached to a list of deals. Only available in Advanced and above plans.
1525
+ * @summary List installments added to a list of deals
1526
+ * @param {DealsApiGetInstallmentsRequest} requestParameters Request parameters.
1527
+
1528
+ * @throws {RequiredError}
1529
+ * @memberof DealsApi
1530
+ */
1531
+ getInstallments(requestParameters) {
1532
+ return (0, exports.DealsApiFp)(this.configuration).getInstallments(requestParameters.deal_ids, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(this.axios, this.basePath));
1533
+ }
1244
1534
  /**
1245
1535
  * Adds a discount to a deal changing, the deal value if the deal has one-time products attached.
1246
1536
  * @summary Add a discount to a deal
@@ -1252,6 +1542,17 @@ class DealsApi extends base_1.BaseAPI {
1252
1542
  postAdditionalDiscount(requestParameters) {
1253
1543
  return (0, exports.DealsApiFp)(this.configuration).postAdditionalDiscount(requestParameters.id, requestParameters.AddAdditionalDiscountRequestBody).then((request) => request(this.axios, this.basePath));
1254
1544
  }
1545
+ /**
1546
+ * 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.
1547
+ * @summary Add an installment to a deal
1548
+ * @param {DealsApiPostInstallmentRequest} requestParameters Request parameters.
1549
+
1550
+ * @throws {RequiredError}
1551
+ * @memberof DealsApi
1552
+ */
1553
+ postInstallment(requestParameters) {
1554
+ return (0, exports.DealsApiFp)(this.configuration).postInstallment(requestParameters.id, requestParameters.AddInstallmentRequestBody).then((request) => request(this.axios, this.basePath));
1555
+ }
1255
1556
  /**
1256
1557
  * Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
1257
1558
  * @summary Search deals
@@ -1296,5 +1597,16 @@ class DealsApi extends base_1.BaseAPI {
1296
1597
  updateDealProduct(requestParameters) {
1297
1598
  return (0, exports.DealsApiFp)(this.configuration).updateDealProduct(requestParameters.id, requestParameters.product_attachment_id, requestParameters.UpdateDealProductRequest).then((request) => request(this.axios, this.basePath));
1298
1599
  }
1600
+ /**
1601
+ * Edits an installment added to a deal. Only available in Advanced and above plans.
1602
+ * @summary Update an installment added to a deal
1603
+ * @param {DealsApiUpdateInstallmentRequest} requestParameters Request parameters.
1604
+
1605
+ * @throws {RequiredError}
1606
+ * @memberof DealsApi
1607
+ */
1608
+ updateInstallment(requestParameters) {
1609
+ return (0, exports.DealsApiFp)(this.configuration).updateInstallment(requestParameters.id, requestParameters.installment_id, requestParameters.UpdateInstallmentRequestBody).then((request) => request(this.axios, this.basePath));
1610
+ }
1299
1611
  }
1300
1612
  exports.DealsApi = DealsApi;
@@ -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 { GetInstallmentsResponseDataInner } from './get-installments-response-data-inner';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface AddAInstallmentResponse
17
+ */
18
+ export interface AddAInstallmentResponse {
19
+ /**
20
+ * If the response is successful or not
21
+ * @type {boolean}
22
+ */
23
+ 'success'?: boolean;
24
+ /**
25
+ *
26
+ * @type {GetInstallmentsResponseDataInner}
27
+ */
28
+ 'data'?: GetInstallmentsResponseDataInner;
29
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Pipedrive API v2
6
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,33 @@
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 AddInstallmentRequestBody
16
+ */
17
+ export interface AddInstallmentRequestBody {
18
+ /**
19
+ * The name of the installment.
20
+ * @type {string}
21
+ */
22
+ 'description': string;
23
+ /**
24
+ * The installment amount. Must be a positive number (excluding 0).
25
+ * @type {number}
26
+ */
27
+ 'amount': number;
28
+ /**
29
+ * The date which the installment will be charged. Must be in the format YYYY-MM-DD.
30
+ * @type {string}
31
+ */
32
+ 'billing_date': string;
33
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Pipedrive API v2
6
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -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 DeleteInstallmentResponseData
16
+ */
17
+ export interface DeleteInstallmentResponseData {
18
+ /**
19
+ * The ID of the installment that was deleted from the deal
20
+ * @type {number}
21
+ */
22
+ 'id'?: number;
23
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Pipedrive API v2
6
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -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 { DeleteInstallmentResponseData } from './delete-installment-response-data';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface DeleteInstallmentResponse
17
+ */
18
+ export interface DeleteInstallmentResponse {
19
+ /**
20
+ * If the response is successful or not
21
+ * @type {boolean}
22
+ */
23
+ 'success'?: boolean;
24
+ /**
25
+ *
26
+ * @type {DeleteInstallmentResponseData}
27
+ */
28
+ 'data'?: DeleteInstallmentResponseData;
29
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Pipedrive API v2
6
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -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
+ * The additional data of the list
14
+ * @export
15
+ * @interface GetActivitiesResponseAllOfAdditionalData
16
+ */
17
+ export interface GetActivitiesResponseAllOfAdditionalData {
18
+ /**
19
+ * The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned.
20
+ * @type {string}
21
+ */
22
+ 'next_cursor'?: string;
23
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Pipedrive API v2
6
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import { ActivityItem } from './activity-item';
13
+ import { GetActivitiesResponseAllOfAdditionalData } from './get-activities-response-all-of-additional-data';
13
14
  /**
14
15
  *
15
16
  * @export
@@ -21,4 +22,9 @@ export interface GetActivitiesResponseAllOf {
21
22
  * @type {Array<ActivityItem>}
22
23
  */
23
24
  'data'?: Array<ActivityItem>;
25
+ /**
26
+ *
27
+ * @type {GetActivitiesResponseAllOfAdditionalData}
28
+ */
29
+ 'additional_data'?: GetActivitiesResponseAllOfAdditionalData;
24
30
  }