pipedrive 24.1.1 → 25.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (175) hide show
  1. package/dist/esm/versions/v1/api/deals-api.d.ts +3 -3
  2. package/dist/esm/versions/v1/api/deals-api.js +2 -2
  3. package/dist/esm/versions/v1/api/organizations-api.d.ts +3 -3
  4. package/dist/esm/versions/v1/api/organizations-api.js +2 -2
  5. package/dist/esm/versions/v1/api/persons-api.d.ts +3 -3
  6. package/dist/esm/versions/v1/api/persons-api.js +2 -2
  7. package/dist/esm/versions/v1/api/subscriptions-api.d.ts +36 -36
  8. package/dist/esm/versions/v1/api/subscriptions-api.js +36 -36
  9. package/dist/esm/versions/v1/api/webhooks-api.d.ts +4 -4
  10. package/dist/esm/versions/v1/api/webhooks-api.js +4 -4
  11. package/dist/esm/versions/v1/models/add-webhook-request.d.ts +5 -6
  12. package/dist/esm/versions/v1/models/add-webhook-request.js +4 -5
  13. package/dist/esm/versions/v1/models/additional-data.d.ts +38 -0
  14. package/dist/esm/versions/v1/models/additional-data.js +14 -0
  15. package/dist/esm/versions/v1/models/get-notes-response-additional-data.d.ts +3 -3
  16. package/dist/esm/versions/v1/models/index.d.ts +1 -1
  17. package/dist/esm/versions/v1/models/index.js +1 -1
  18. package/dist/esm/versions/v1/models/user-access.d.ts +3 -2
  19. package/dist/esm/versions/v1/models/user-access.js +4 -3
  20. package/dist/esm/versions/v1/models/user-access1.d.ts +3 -2
  21. package/dist/esm/versions/v1/models/user-access1.js +4 -3
  22. package/dist/esm/versions/v2/api/activities-api.d.ts +34 -2
  23. package/dist/esm/versions/v2/api/activities-api.js +25 -5
  24. package/dist/esm/versions/v2/api/beta-api.d.ts +160 -2424
  25. package/dist/esm/versions/v2/api/beta-api.js +169 -2788
  26. package/dist/esm/versions/v2/api/deals-api.d.ts +491 -0
  27. package/dist/esm/versions/v2/api/deals-api.js +613 -0
  28. package/dist/esm/versions/v2/api/organizations-api.d.ts +237 -0
  29. package/dist/esm/versions/v2/api/organizations-api.js +301 -0
  30. package/dist/esm/versions/v2/api/persons-api.d.ts +237 -0
  31. package/dist/esm/versions/v2/api/persons-api.js +301 -0
  32. package/dist/esm/versions/v2/api/products-api.d.ts +237 -0
  33. package/dist/esm/versions/v2/api/products-api.js +301 -0
  34. package/dist/esm/versions/v2/api/users-api.d.ts +103 -0
  35. package/dist/esm/versions/v2/api/users-api.js +140 -0
  36. package/dist/esm/versions/v2/api.d.ts +1 -0
  37. package/dist/esm/versions/v2/api.js +1 -0
  38. package/dist/esm/versions/v2/models/add-ainstallment-response.d.ts +29 -0
  39. package/dist/esm/versions/v2/models/add-ainstallment-response.js +14 -0
  40. package/dist/esm/versions/v2/models/add-deal-follower-request.d.ts +23 -0
  41. package/dist/esm/versions/v2/models/add-deal-follower-request.js +14 -0
  42. package/dist/esm/versions/v2/models/add-follower-response-all-of.d.ts +24 -0
  43. package/dist/esm/versions/v2/models/add-follower-response-all-of.js +14 -0
  44. package/dist/esm/versions/v2/models/add-follower-response.d.ts +18 -0
  45. package/dist/esm/versions/v2/models/add-follower-response.js +14 -0
  46. package/dist/esm/versions/v2/models/add-installment-request-body.d.ts +33 -0
  47. package/dist/esm/versions/v2/models/add-installment-request-body.js +14 -0
  48. package/dist/esm/versions/v2/models/delete-follower-response-data.d.ts +23 -0
  49. package/dist/esm/versions/v2/models/delete-follower-response-data.js +14 -0
  50. package/dist/esm/versions/v2/models/delete-follower-response.d.ts +29 -0
  51. package/dist/esm/versions/v2/models/delete-follower-response.js +14 -0
  52. package/dist/esm/versions/v2/models/delete-installment-response-data.d.ts +23 -0
  53. package/dist/esm/versions/v2/models/delete-installment-response-data.js +14 -0
  54. package/dist/esm/versions/v2/models/delete-installment-response.d.ts +29 -0
  55. package/dist/esm/versions/v2/models/delete-installment-response.js +14 -0
  56. package/dist/esm/versions/v2/models/follower-changelog-item.d.ts +38 -0
  57. package/dist/esm/versions/v2/models/follower-changelog-item.js +14 -0
  58. package/dist/esm/versions/v2/models/follower-item.d.ts +28 -0
  59. package/dist/esm/versions/v2/models/follower-item.js +14 -0
  60. package/dist/esm/versions/v2/models/follower-item1.d.ts +28 -0
  61. package/dist/esm/versions/v2/models/follower-item1.js +14 -0
  62. package/dist/esm/versions/v2/models/get-activities-response-all-of-additional-data.d.ts +23 -0
  63. package/dist/esm/versions/v2/models/get-activities-response-all-of-additional-data.js +14 -0
  64. package/dist/esm/versions/v2/models/get-activities-response-all-of.d.ts +6 -0
  65. package/dist/esm/versions/v2/models/get-deals-response-all-of.d.ts +6 -0
  66. package/dist/esm/versions/v2/models/get-follower-changelogs-response-all-of.d.ts +30 -0
  67. package/dist/esm/versions/v2/models/get-follower-changelogs-response-all-of.js +14 -0
  68. package/dist/esm/versions/v2/models/get-follower-changelogs-response.d.ts +18 -0
  69. package/dist/esm/versions/v2/models/get-follower-changelogs-response.js +14 -0
  70. package/dist/esm/versions/v2/models/get-followers-response-all-of.d.ts +30 -0
  71. package/dist/esm/versions/v2/models/get-followers-response-all-of.js +14 -0
  72. package/dist/esm/versions/v2/models/get-followers-response.d.ts +18 -0
  73. package/dist/esm/versions/v2/models/get-followers-response.js +14 -0
  74. package/dist/esm/versions/v2/models/get-installments-response-data-inner.d.ts +43 -0
  75. package/dist/esm/versions/v2/models/get-installments-response-data-inner.js +14 -0
  76. package/dist/esm/versions/v2/models/get-installments-response.d.ts +29 -0
  77. package/dist/esm/versions/v2/models/get-installments-response.js +14 -0
  78. package/dist/esm/versions/v2/models/get-organizations-response-all-of.d.ts +6 -0
  79. package/dist/esm/versions/v2/models/get-persons-response-all-of.d.ts +6 -0
  80. package/dist/esm/versions/v2/models/get-pipelines-response-all-of.d.ts +6 -0
  81. package/dist/esm/versions/v2/models/get-stages-response.d.ts +6 -0
  82. package/dist/esm/versions/v2/models/index.d.ts +21 -0
  83. package/dist/esm/versions/v2/models/index.js +21 -0
  84. package/dist/esm/versions/v2/models/update-installment-request-body.d.ts +33 -0
  85. package/dist/esm/versions/v2/models/update-installment-request-body.js +14 -0
  86. package/dist/esm/versions/v2/models/update-installment-response.d.ts +29 -0
  87. package/dist/esm/versions/v2/models/update-installment-response.js +14 -0
  88. package/dist/versions/v1/api/deals-api.d.ts +3 -3
  89. package/dist/versions/v1/api/deals-api.js +2 -2
  90. package/dist/versions/v1/api/organizations-api.d.ts +3 -3
  91. package/dist/versions/v1/api/organizations-api.js +2 -2
  92. package/dist/versions/v1/api/persons-api.d.ts +3 -3
  93. package/dist/versions/v1/api/persons-api.js +2 -2
  94. package/dist/versions/v1/api/subscriptions-api.d.ts +36 -36
  95. package/dist/versions/v1/api/subscriptions-api.js +36 -36
  96. package/dist/versions/v1/api/webhooks-api.d.ts +4 -4
  97. package/dist/versions/v1/api/webhooks-api.js +4 -4
  98. package/dist/versions/v1/models/add-webhook-request.d.ts +5 -6
  99. package/dist/versions/v1/models/add-webhook-request.js +4 -5
  100. package/dist/versions/v1/models/additional-data.d.ts +38 -0
  101. package/dist/versions/v1/models/additional-data.js +15 -0
  102. package/dist/versions/v1/models/get-notes-response-additional-data.d.ts +3 -3
  103. package/dist/versions/v1/models/index.d.ts +1 -1
  104. package/dist/versions/v1/models/index.js +1 -1
  105. package/dist/versions/v1/models/user-access.d.ts +3 -2
  106. package/dist/versions/v1/models/user-access.js +4 -3
  107. package/dist/versions/v1/models/user-access1.d.ts +3 -2
  108. package/dist/versions/v1/models/user-access1.js +4 -3
  109. package/dist/versions/v2/api/activities-api.d.ts +34 -2
  110. package/dist/versions/v2/api/activities-api.js +25 -5
  111. package/dist/versions/v2/api/beta-api.d.ts +160 -2424
  112. package/dist/versions/v2/api/beta-api.js +171 -2790
  113. package/dist/versions/v2/api/deals-api.d.ts +491 -0
  114. package/dist/versions/v2/api/deals-api.js +613 -0
  115. package/dist/versions/v2/api/organizations-api.d.ts +237 -0
  116. package/dist/versions/v2/api/organizations-api.js +301 -0
  117. package/dist/versions/v2/api/persons-api.d.ts +237 -0
  118. package/dist/versions/v2/api/persons-api.js +301 -0
  119. package/dist/versions/v2/api/products-api.d.ts +237 -0
  120. package/dist/versions/v2/api/products-api.js +301 -0
  121. package/dist/versions/v2/api/users-api.d.ts +103 -0
  122. package/dist/versions/v2/api/users-api.js +150 -0
  123. package/dist/versions/v2/api.d.ts +1 -0
  124. package/dist/versions/v2/api.js +1 -0
  125. package/dist/versions/v2/models/add-ainstallment-response.d.ts +29 -0
  126. package/dist/versions/v2/models/add-ainstallment-response.js +15 -0
  127. package/dist/versions/v2/models/add-deal-follower-request.d.ts +23 -0
  128. package/dist/versions/v2/models/add-deal-follower-request.js +15 -0
  129. package/dist/versions/v2/models/add-follower-response-all-of.d.ts +24 -0
  130. package/dist/versions/v2/models/add-follower-response-all-of.js +15 -0
  131. package/dist/versions/v2/models/add-follower-response.d.ts +18 -0
  132. package/dist/versions/v2/models/add-follower-response.js +15 -0
  133. package/dist/versions/v2/models/add-installment-request-body.d.ts +33 -0
  134. package/dist/versions/v2/models/add-installment-request-body.js +15 -0
  135. package/dist/versions/v2/models/delete-follower-response-data.d.ts +23 -0
  136. package/dist/versions/v2/models/delete-follower-response-data.js +15 -0
  137. package/dist/versions/v2/models/delete-follower-response.d.ts +29 -0
  138. package/dist/versions/v2/models/delete-follower-response.js +15 -0
  139. package/dist/versions/v2/models/delete-installment-response-data.d.ts +23 -0
  140. package/dist/versions/v2/models/delete-installment-response-data.js +15 -0
  141. package/dist/versions/v2/models/delete-installment-response.d.ts +29 -0
  142. package/dist/versions/v2/models/delete-installment-response.js +15 -0
  143. package/dist/versions/v2/models/follower-changelog-item.d.ts +38 -0
  144. package/dist/versions/v2/models/follower-changelog-item.js +15 -0
  145. package/dist/versions/v2/models/follower-item.d.ts +28 -0
  146. package/dist/versions/v2/models/follower-item.js +15 -0
  147. package/dist/versions/v2/models/follower-item1.d.ts +28 -0
  148. package/dist/versions/v2/models/follower-item1.js +15 -0
  149. package/dist/versions/v2/models/get-activities-response-all-of-additional-data.d.ts +23 -0
  150. package/dist/versions/v2/models/get-activities-response-all-of-additional-data.js +15 -0
  151. package/dist/versions/v2/models/get-activities-response-all-of.d.ts +6 -0
  152. package/dist/versions/v2/models/get-deals-response-all-of.d.ts +6 -0
  153. package/dist/versions/v2/models/get-follower-changelogs-response-all-of.d.ts +30 -0
  154. package/dist/versions/v2/models/get-follower-changelogs-response-all-of.js +15 -0
  155. package/dist/versions/v2/models/get-follower-changelogs-response.d.ts +18 -0
  156. package/dist/versions/v2/models/get-follower-changelogs-response.js +15 -0
  157. package/dist/versions/v2/models/get-followers-response-all-of.d.ts +30 -0
  158. package/dist/versions/v2/models/get-followers-response-all-of.js +15 -0
  159. package/dist/versions/v2/models/get-followers-response.d.ts +18 -0
  160. package/dist/versions/v2/models/get-followers-response.js +15 -0
  161. package/dist/versions/v2/models/get-installments-response-data-inner.d.ts +43 -0
  162. package/dist/versions/v2/models/get-installments-response-data-inner.js +15 -0
  163. package/dist/versions/v2/models/get-installments-response.d.ts +29 -0
  164. package/dist/versions/v2/models/get-installments-response.js +15 -0
  165. package/dist/versions/v2/models/get-organizations-response-all-of.d.ts +6 -0
  166. package/dist/versions/v2/models/get-persons-response-all-of.d.ts +6 -0
  167. package/dist/versions/v2/models/get-pipelines-response-all-of.d.ts +6 -0
  168. package/dist/versions/v2/models/get-stages-response.d.ts +6 -0
  169. package/dist/versions/v2/models/index.d.ts +21 -0
  170. package/dist/versions/v2/models/index.js +21 -0
  171. package/dist/versions/v2/models/update-installment-request-body.d.ts +33 -0
  172. package/dist/versions/v2/models/update-installment-request-body.js +15 -0
  173. package/dist/versions/v2/models/update-installment-response.d.ts +29 -0
  174. package/dist/versions/v2/models/update-installment-response.js +15 -0
  175. package/package.json +1 -1
@@ -12,2226 +12,241 @@
12
12
  import type { Configuration } from '../configuration';
13
13
  import type { AxiosInstance } from 'axios';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
- import { AddActivityRequest } from '../models';
16
- import { AddAdditionalDiscountRequestBody } from '../models';
17
- import { AddAdditionalDiscountResponse } from '../models';
18
- import { AddDealProductRequest } from '../models';
19
- import { AddDealProductResponse } from '../models';
20
- import { AddDealRequest } from '../models';
21
- import { AddOrganizationRequest } from '../models';
22
- import { AddPersonRequest } from '../models';
23
- import { DeleteActivityResponse } from '../models';
24
- import { DeleteAdditionalDiscountResponse } from '../models';
25
- import { DeleteDealProductResponse } from '../models';
26
- import { DeleteDealResponse } from '../models';
27
- import { DeleteOrganizationResponse } from '../models';
28
- import { DeletePersonResponse } from '../models';
29
- import { GetActivitiesResponse } from '../models';
30
- import { GetAdditionalDiscountsResponse } from '../models';
31
- import { GetDealSearchResponse } from '../models';
32
- import { GetDealsProductsResponse } from '../models';
33
- import { GetDealsResponse } from '../models';
34
- import { GetItemSearchFieldResponse } from '../models';
35
- import { GetItemSearchResponse } from '../models';
36
- import { GetLeadSearchResponse } from '../models';
37
- import { GetOrganizationSearchResponse } from '../models';
38
- import { GetOrganizationsResponse } from '../models';
39
- import { GetPersonSearchResponse } from '../models';
40
- import { GetPersonsResponse } from '../models';
41
- import { UpdateAdditionalDiscountRequestBody } from '../models';
42
- import { UpdateAdditionalDiscountResponse } from '../models';
43
- import { UpdateDealProductRequest } from '../models';
44
- import { UpdateDealRequest } from '../models';
45
- import { UpdateOrganizationRequest } from '../models';
46
- import { UpdatePersonRequest } from '../models';
47
- import { UpsertActivityResponse } from '../models';
48
- import { UpsertDealResponse } from '../models';
49
- import { UpsertOrganizationResponse } from '../models';
50
- import { UpsertPersonResponse } from '../models';
15
+ import { AddAInstallmentResponse } from '../models';
16
+ import { AddInstallmentRequestBody } from '../models';
17
+ import { DeleteInstallmentResponse } from '../models';
18
+ import { GetInstallmentsResponse } from '../models';
19
+ import { UpdateInstallmentRequestBody } from '../models';
20
+ import { UpdateInstallmentResponse } from '../models';
51
21
  /**
52
22
  * BetaApi - axios parameter creator
53
23
  * @export
54
24
  */
55
25
  export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) => {
56
26
  /**
57
- * Adds a new activity.
58
- * @summary Add a new activity
59
- * @param {AddActivityRequest} [AddActivityRequest]
60
-
61
- * @throws {RequiredError}
62
- */
63
- addActivity: (AddActivityRequest?: AddActivityRequest) => Promise<RequestArgs>;
64
- /**
65
- * Adds a new deal.
66
- * @summary Add a new deal
67
- * @param {AddDealRequest} [AddDealRequest]
68
-
69
- * @throws {RequiredError}
70
- */
71
- addDeal: (AddDealRequest?: AddDealRequest) => Promise<RequestArgs>;
72
- /**
73
- * Adds a product to a deal, creating a new item called a deal-product.
74
- * @summary Add a product to a deal
75
- * @param {number} id The ID of the deal
76
- * @param {AddDealProductRequest} [AddDealProductRequest]
77
-
78
- * @throws {RequiredError}
79
- */
80
- addDealProduct: (id: number, AddDealProductRequest?: AddDealProductRequest) => Promise<RequestArgs>;
81
- /**
82
- * Adds a new organization.
83
- * @summary Add a new organization
84
- * @param {AddOrganizationRequest} [AddOrganizationRequest]
85
-
86
- * @throws {RequiredError}
87
- */
88
- addOrganization: (AddOrganizationRequest?: AddOrganizationRequest) => Promise<RequestArgs>;
89
- /**
90
- * Adds a new person.
91
- * @summary Add a new person
92
- * @param {AddPersonRequest} [AddPersonRequest]
93
-
94
- * @throws {RequiredError}
95
- */
96
- addPerson: (AddPersonRequest?: AddPersonRequest) => Promise<RequestArgs>;
97
- /**
98
- * Marks an activity as deleted. After 30 days, the activity will be permanently deleted.
99
- * @summary Delete an activity
100
- * @param {number} id The ID of the activity
101
-
102
- * @throws {RequiredError}
103
- */
104
- deleteActivity: (id: number) => Promise<RequestArgs>;
105
- /**
106
- * Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
107
- * @summary Delete a discount from a deal
108
- * @param {number} id The ID of the deal
109
- * @param {number} discount_id The ID of the discount
110
-
111
- * @throws {RequiredError}
112
- */
113
- deleteAdditionalDiscount: (id: number, discount_id: number) => Promise<RequestArgs>;
114
- /**
115
- * Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
116
- * @summary Delete a deal
117
- * @param {number} id The ID of the deal
118
-
119
- * @throws {RequiredError}
120
- */
121
- deleteDeal: (id: number) => Promise<RequestArgs>;
122
- /**
123
- * Deletes a product attachment from a deal, using the `product_attachment_id`.
124
- * @summary Delete an attached product from a deal
27
+ * Removes an installment from a deal. Only available in Advanced and above plans.
28
+ * @summary Delete an installment from a deal
125
29
  * @param {number} id The ID of the deal
126
- * @param {number} product_attachment_id The product attachment ID
127
-
128
- * @throws {RequiredError}
129
- */
130
- deleteDealProduct: (id: number, product_attachment_id: number) => Promise<RequestArgs>;
131
- /**
132
- * Marks a organization as deleted. After 30 days, the organization will be permanently deleted.
133
- * @summary Delete a organization
134
- * @param {number} id The ID of the organization
135
-
136
- * @throws {RequiredError}
137
- */
138
- deleteOrganization: (id: number) => Promise<RequestArgs>;
139
- /**
140
- * Marks a person as deleted. After 30 days, the person will be permanently deleted.
141
- * @summary Delete a person
142
- * @param {number} id The ID of the person
30
+ * @param {number} installment_id The ID of the installment
143
31
 
144
32
  * @throws {RequiredError}
145
33
  */
146
- deletePerson: (id: number) => Promise<RequestArgs>;
34
+ deleteInstallment: (id: number, installment_id: number) => Promise<RequestArgs>;
147
35
  /**
148
- * Returns data about all activities.
149
- * @summary Get all activities
150
- * @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
151
- * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
152
- * @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
153
- * @param {string} [updated_since] If set, only activities with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
154
- * @param {string} [updated_until] If set, only activities with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
155
- * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;.
156
- * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
157
- * @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
158
- * @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.
36
+ * Lists installments attached to a list of deals. Only available in Advanced and above plans.
37
+ * @summary List installments added to a list of deals
38
+ * @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.
159
39
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
40
+ * @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.
41
+ * @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;.
42
+ * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
160
43
 
161
44
  * @throws {RequiredError}
162
45
  */
163
- getActivities: (filter_id?: number, ids?: string, owner_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'attendees', limit?: number, cursor?: string) => Promise<RequestArgs>;
164
- /**
165
- * Returns the details of a specific activity.
166
- * @summary Get details of an activity
167
- * @param {number} id The ID of the activity
168
- * @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
169
-
170
- * @throws {RequiredError}
171
- */
172
- getActivity: (id: number, include_fields?: 'attendees') => Promise<RequestArgs>;
46
+ getInstallments: (deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'billing_date' | 'deal_id', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
173
47
  /**
174
- * Lists discounts attached to a deal.
175
- * @summary List discounts added to a deal
48
+ * 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.
49
+ * @summary Add an installment to a deal
176
50
  * @param {number} id The ID of the deal
51
+ * @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
177
52
 
178
53
  * @throws {RequiredError}
179
54
  */
180
- getAdditionalDiscounts: (id: number) => Promise<RequestArgs>;
55
+ postInstallment: (id: number, AddInstallmentRequestBody?: AddInstallmentRequestBody) => Promise<RequestArgs>;
181
56
  /**
182
- * Returns the details of a specific deal.
183
- * @summary Get details of a deal
57
+ * Edits an installment added to a deal. Only available in Advanced and above plans.
58
+ * @summary Update an installment added to a deal
184
59
  * @param {number} id The ID of the deal
185
- * @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time'} [include_fields] Optional comma separated string array of additional fields to include
186
- * @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
60
+ * @param {number} installment_id The ID of the installment
61
+ * @param {UpdateInstallmentRequestBody} [UpdateInstallmentRequestBody]
187
62
 
188
63
  * @throws {RequiredError}
189
64
  */
190
- getDeal: (id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time', custom_fields?: string) => Promise<RequestArgs>;
65
+ updateInstallment: (id: number, installment_id: number, UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody) => Promise<RequestArgs>;
66
+ };
67
+ /**
68
+ * BetaApi - functional programming interface
69
+ * @export
70
+ */
71
+ export declare const BetaApiFp: (configuration?: Configuration) => {
191
72
  /**
192
- * Lists products attached to a deal.
193
- * @summary List products attached to a deal
73
+ * Removes an installment from a deal. Only available in Advanced and above plans.
74
+ * @summary Delete an installment from a deal
194
75
  * @param {number} id The ID of the deal
195
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
196
- * @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.
197
- * @param {'id' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
198
- * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
199
-
200
- * @throws {RequiredError}
201
- */
202
- getDealProducts: (id: number, cursor?: string, limit?: number, sort_by?: 'id' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
203
- /**
204
- * Returns data about all deals.
205
- * @summary Get all deals
206
- * @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
207
- * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
208
- * @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
209
- * @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
210
- * @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
211
- * @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
212
- * @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
213
- * @param {'open' | 'won' | 'lost' | 'deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.
214
- * @param {string} [updated_since] If set, only deals with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
215
- * @param {string} [updated_until] If set, only deals with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
216
- * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;.
217
- * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
218
- * @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time'} [include_fields] Optional comma separated string array of additional fields to include
219
- * @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
220
- * @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.
221
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
76
+ * @param {number} installment_id The ID of the installment
222
77
 
223
78
  * @throws {RequiredError}
224
79
  */
225
- getDeals: (filter_id?: number, ids?: string, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted', updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time', custom_fields?: string, limit?: number, cursor?: string) => Promise<RequestArgs>;
80
+ deleteInstallment(id: number, installment_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteInstallmentResponse>>;
226
81
  /**
227
- * Returns data about products attached to deals
228
- * @summary Get deal products of several deals
229
- * @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached products will be returned. A maximum of 100 deal IDs can be provided.
82
+ * Lists installments attached to a list of deals. Only available in Advanced and above plans.
83
+ * @summary List installments added to a list of deals
84
+ * @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.
230
85
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
231
86
  * @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.
232
- * @param {'id' | 'deal_id' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;deal_id&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
233
- * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
234
-
235
- * @throws {RequiredError}
236
- */
237
- getDealsProducts: (deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
238
- /**
239
- * Returns the details of a specific organization.
240
- * @summary Get details of a organization
241
- * @param {number} id The ID of the organization
242
- * @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count'} [include_fields] Optional comma separated string array of additional fields to include
243
- * @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
244
-
245
- * @throws {RequiredError}
246
- */
247
- getOrganization: (id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count', custom_fields?: string) => Promise<RequestArgs>;
248
- /**
249
- * Returns data about all organizations.
250
- * @summary Get all organizations
251
- * @param {number} [filter_id] If supplied, only organizations matching the specified filter are returned
252
- * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
253
- * @param {number} [owner_id] If supplied, only organization owned by the specified user are returned. If filter_id is provided, this is ignored.
254
- * @param {string} [updated_since] If set, only organizations with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
255
- * @param {string} [updated_until] If set, only organizations with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
256
- * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;.
257
- * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
258
- * @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count'} [include_fields] Optional comma separated string array of additional fields to include
259
- * @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
260
- * @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.
261
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
262
-
263
- * @throws {RequiredError}
264
- */
265
- getOrganizations: (filter_id?: number, ids?: string, owner_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count', custom_fields?: string, limit?: number, cursor?: string) => Promise<RequestArgs>;
266
- /**
267
- * Returns the details of a specific person. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
268
- * @summary Get details of a person
269
- * @param {number} id The ID of the person
270
- * @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status'} [include_fields] Optional comma separated string array of additional fields to include. &#x60;marketing_status&#x60; and &#x60;doi_status&#x60; can only be included if the company has marketing app enabled.
271
- * @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
272
-
273
- * @throws {RequiredError}
274
- */
275
- getPerson: (id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status', custom_fields?: string) => Promise<RequestArgs>;
276
- /**
277
- * Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
278
- * @summary Get all persons
279
- * @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
280
- * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
281
- * @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
282
- * @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
283
- * @param {string} [updated_since] If set, only persons with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
284
- * @param {string} [updated_until] If set, only persons with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
285
- * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;.
87
+ * @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;.
286
88
  * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
287
- * @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status'} [include_fields] Optional comma separated string array of additional fields to include. &#x60;marketing_status&#x60; and &#x60;doi_status&#x60; can only be included if the company has marketing app enabled.
288
- * @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
289
- * @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.
290
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
291
-
292
- * @throws {RequiredError}
293
- */
294
- getPersons: (filter_id?: number, ids?: string, owner_id?: number, org_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status', custom_fields?: string, limit?: number, cursor?: string) => Promise<RequestArgs>;
295
- /**
296
- * Adds a discount to a deal changing, the deal value if the deal has one-time products attached.
297
- * @summary Add a discount to a deal
298
- * @param {number} id The ID of the deal
299
- * @param {AddAdditionalDiscountRequestBody} [AddAdditionalDiscountRequestBody]
300
-
301
- * @throws {RequiredError}
302
- */
303
- postAdditionalDiscount: (id: number, AddAdditionalDiscountRequestBody?: AddAdditionalDiscountRequestBody) => Promise<RequestArgs>;
304
- /**
305
- * 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.
306
- * @summary Search deals
307
- * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
308
- * @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
309
- * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
310
- * @param {number} [person_id] Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
311
- * @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
312
- * @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
313
- * @param {'deal.cc_email'} [include_fields] Supports including optional fields in the results which are not provided by default
314
- * @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.
315
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
316
-
317
- * @throws {RequiredError}
318
- */
319
- searchDeals: (term: string, fields?: 'custom_fields' | 'notes' | 'title', exact_match?: boolean, person_id?: number, organization_id?: number, status?: 'open' | 'won' | 'lost', include_fields?: 'deal.cc_email', limit?: number, cursor?: string) => Promise<RequestArgs>;
320
- /**
321
- * Performs a search from your choice of item types and fields.
322
- * @summary Perform a search from multiple item types
323
- * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
324
- * @param {'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'} [item_types] A comma-separated string array. The type of items to perform the search from. Defaults to all.
325
- * @param {'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'organization_name' | 'person_name' | 'phone' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:&lt;br&gt; &lt;table&gt; &lt;tr&gt;&lt;th&gt;&lt;b&gt;Item type&lt;/b&gt;&lt;/th&gt;&lt;th&gt;&lt;b&gt;Field&lt;/b&gt;&lt;/th&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Deal&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;title&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Person&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;email&#x60;, &#x60;name&#x60;, &#x60;notes&#x60;, &#x60;phone&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Organization&lt;/td&gt;&lt;td&gt;&#x60;address&#x60;, &#x60;custom_fields&#x60;, &#x60;name&#x60;, &#x60;notes&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Product&lt;/td&gt;&lt;td&gt;&#x60;code&#x60;, &#x60;custom_fields&#x60;, &#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Lead&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;email&#x60;, &#x60;organization_name&#x60;, &#x60;person_name&#x60;, &#x60;phone&#x60;, &#x60;title&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;File&lt;/td&gt;&lt;td&gt;&#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Mail attachment&lt;/td&gt;&lt;td&gt;&#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Project&lt;/td&gt;&lt;td&gt; &#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;title&#x60;, &#x60;description&#x60; &lt;/td&gt;&lt;/tr&gt; &lt;/table&gt; &lt;br&gt; Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.&lt;br/&gt; When searching for leads, the email, organization_name, person_name, and phone fields will return results only for leads not linked to contacts. For searching leads by person or organization values, please use &#x60;search_for_related_items&#x60;.
326
- * @param {boolean} [search_for_related_items] When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization
327
- * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
328
- * @param {'deal.cc_email' | 'person.picture' | 'product.price'} [include_fields] A comma-separated string array. Supports including optional fields in the results which are not provided by default.
329
- * @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.
330
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
331
-
332
- * @throws {RequiredError}
333
- */
334
- searchItem: (term: string, item_types?: 'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project', fields?: 'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'organization_name' | 'person_name' | 'phone' | 'title' | 'description', search_for_related_items?: boolean, exact_match?: boolean, include_fields?: 'deal.cc_email' | 'person.picture' | 'product.price', limit?: number, cursor?: string) => Promise<RequestArgs>;
335
- /**
336
- * Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products).
337
- * @summary Perform a search using a specific field from an item type
338
- * @param {string} term The search term to look for. Minimum 2 characters (or 1 if &#x60;match&#x60; is &#x60;exact&#x60;). Please note that the search term has to be URL encoded.
339
- * @param {'deal' | 'lead' | 'person' | 'organization' | 'product' | 'project'} entity_type The type of the field to perform the search from
340
- * @param {string} field The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields\&#39; API GET methods (dealFields, personFields, etc.). Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
341
- * @param {'exact' | 'beginning' | 'middle'} [match] The type of match used against the term. The search &lt;b&gt;is&lt;/b&gt; case sensitive.&lt;br/&gt;&lt;br/&gt; E.g. in case of searching for a value &#x60;monkey&#x60;, &lt;ul&gt; &lt;li&gt;with &#x60;exact&#x60; match, you will only find it if term is &#x60;monkey&#x60;&lt;/li&gt; &lt;li&gt;with &#x60;beginning&#x60; match, you will only find it if the term matches the beginning or the whole string, e.g. &#x60;monk&#x60; and &#x60;monkey&#x60;&lt;/li&gt; &lt;li&gt;with &#x60;middle&#x60; match, you will find the it if the term matches any substring of the value, e.g. &#x60;onk&#x60; and &#x60;ke&#x60;&lt;/li&gt; &lt;/ul&gt;.
342
- * @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.
343
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
344
-
345
- * @throws {RequiredError}
346
- */
347
- searchItemByField: (term: string, entity_type: 'deal' | 'lead' | 'person' | 'organization' | 'product' | 'project', field: string, match?: 'exact' | 'beginning' | 'middle', limit?: number, cursor?: string) => Promise<RequestArgs>;
348
- /**
349
- * Searches all leads 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 leads can be filtered by the person ID and the organization ID.
350
- * @summary Search leads
351
- * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
352
- * @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
353
- * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
354
- * @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
355
- * @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
356
- * @param {'lead.was_seen'} [include_fields] Supports including optional fields in the results which are not provided by default
357
- * @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.
358
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
359
-
360
- * @throws {RequiredError}
361
- */
362
- searchLeads: (term: string, fields?: 'custom_fields' | 'notes' | 'title', exact_match?: boolean, person_id?: number, organization_id?: number, include_fields?: 'lead.was_seen', limit?: number, cursor?: string) => Promise<RequestArgs>;
363
- /**
364
- * Searches all organizations by name, address, 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.
365
- * @summary Search organizations
366
- * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
367
- * @param {'address' | 'custom_fields' | 'notes' | 'name'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
368
- * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
369
- * @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.
370
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
371
-
372
- * @throws {RequiredError}
373
- */
374
- searchOrganization: (term: string, fields?: 'address' | 'custom_fields' | 'notes' | 'name', exact_match?: boolean, limit?: number, cursor?: string) => Promise<RequestArgs>;
375
- /**
376
- * Searches all persons by name, email, phone, 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 persons can be filtered by organization ID.
377
- * @summary Search persons
378
- * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
379
- * @param {'custom_fields' | 'email' | 'notes' | 'phone' | 'name'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
380
- * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
381
- * @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
382
- * @param {'person.picture'} [include_fields] Supports including optional fields in the results which are not provided by default
383
- * @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.
384
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
385
-
386
- * @throws {RequiredError}
387
- */
388
- searchPersons: (term: string, fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name', exact_match?: boolean, organization_id?: number, include_fields?: 'person.picture', limit?: number, cursor?: string) => Promise<RequestArgs>;
389
- /**
390
- * Updates the properties of an activity.
391
- * @summary Update an activity
392
- * @param {number} id The ID of the activity
393
- * @param {AddActivityRequest} [AddActivityRequest]
394
-
395
- * @throws {RequiredError}
396
- */
397
- updateActivity: (id: number, AddActivityRequest?: AddActivityRequest) => Promise<RequestArgs>;
398
- /**
399
- * Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
400
- * @summary Update a discount added to a deal
401
- * @param {number} id The ID of the deal
402
- * @param {number} discount_id The ID of the discount
403
- * @param {UpdateAdditionalDiscountRequestBody} [UpdateAdditionalDiscountRequestBody]
404
89
 
405
90
  * @throws {RequiredError}
406
91
  */
407
- updateAdditionalDiscount: (id: number, discount_id: number, UpdateAdditionalDiscountRequestBody?: UpdateAdditionalDiscountRequestBody) => Promise<RequestArgs>;
92
+ getInstallments(deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'billing_date' | 'deal_id', sort_direction?: 'asc' | 'desc'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetInstallmentsResponse>>;
408
93
  /**
409
- * Updates the properties of a deal.
410
- * @summary Update a deal
94
+ * 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.
95
+ * @summary Add an installment to a deal
411
96
  * @param {number} id The ID of the deal
412
- * @param {UpdateDealRequest} [UpdateDealRequest]
97
+ * @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
413
98
 
414
99
  * @throws {RequiredError}
415
100
  */
416
- updateDeal: (id: number, UpdateDealRequest?: UpdateDealRequest) => Promise<RequestArgs>;
101
+ postInstallment(id: number, AddInstallmentRequestBody?: AddInstallmentRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddAInstallmentResponse>>;
417
102
  /**
418
- * Updates the details of the product that has been attached to a deal.
419
- * @summary Update the product attached to a deal
103
+ * Edits an installment added to a deal. Only available in Advanced and above plans.
104
+ * @summary Update an installment added to a deal
420
105
  * @param {number} id The ID of the deal
421
- * @param {number} product_attachment_id The ID of the deal-product (the ID of the product attached to the deal)
422
- * @param {UpdateDealProductRequest} [UpdateDealProductRequest]
423
-
424
- * @throws {RequiredError}
425
- */
426
- updateDealProduct: (id: number, product_attachment_id: number, UpdateDealProductRequest?: UpdateDealProductRequest) => Promise<RequestArgs>;
427
- /**
428
- * Updates the properties of a organization.
429
- * @summary Update a organization
430
- * @param {number} id The ID of the organization
431
- * @param {UpdateOrganizationRequest} [UpdateOrganizationRequest]
432
-
433
- * @throws {RequiredError}
434
- */
435
- updateOrganization: (id: number, UpdateOrganizationRequest?: UpdateOrganizationRequest) => Promise<RequestArgs>;
436
- /**
437
- * Updates the properties of a person.
438
- * @summary Update a person
439
- * @param {number} id The ID of the person
440
- * @param {UpdatePersonRequest} [UpdatePersonRequest]
106
+ * @param {number} installment_id The ID of the installment
107
+ * @param {UpdateInstallmentRequestBody} [UpdateInstallmentRequestBody]
441
108
 
442
109
  * @throws {RequiredError}
443
110
  */
444
- updatePerson: (id: number, UpdatePersonRequest?: UpdatePersonRequest) => Promise<RequestArgs>;
111
+ updateInstallment(id: number, installment_id: number, UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateInstallmentResponse>>;
445
112
  };
446
113
  /**
447
- * BetaApi - functional programming interface
114
+ * BetaApi - factory interface
448
115
  * @export
449
116
  */
450
- export declare const BetaApiFp: (configuration?: Configuration) => {
451
- /**
452
- * Adds a new activity.
453
- * @summary Add a new activity
454
- * @param {AddActivityRequest} [AddActivityRequest]
455
-
456
- * @throws {RequiredError}
457
- */
458
- addActivity(AddActivityRequest?: AddActivityRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertActivityResponse>>;
459
- /**
460
- * Adds a new deal.
461
- * @summary Add a new deal
462
- * @param {AddDealRequest} [AddDealRequest]
463
-
464
- * @throws {RequiredError}
465
- */
466
- addDeal(AddDealRequest?: AddDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertDealResponse>>;
467
- /**
468
- * Adds a product to a deal, creating a new item called a deal-product.
469
- * @summary Add a product to a deal
470
- * @param {number} id The ID of the deal
471
- * @param {AddDealProductRequest} [AddDealProductRequest]
472
-
473
- * @throws {RequiredError}
474
- */
475
- addDealProduct(id: number, AddDealProductRequest?: AddDealProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealProductResponse>>;
476
- /**
477
- * Adds a new organization.
478
- * @summary Add a new organization
479
- * @param {AddOrganizationRequest} [AddOrganizationRequest]
480
-
481
- * @throws {RequiredError}
482
- */
483
- addOrganization(AddOrganizationRequest?: AddOrganizationRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertOrganizationResponse>>;
117
+ export declare const BetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
484
118
  /**
485
- * Adds a new person.
486
- * @summary Add a new person
487
- * @param {AddPersonRequest} [AddPersonRequest]
119
+ * Removes an installment from a deal. Only available in Advanced and above plans.
120
+ * @summary Delete an installment from a deal
121
+ * @param {BetaApiDeleteInstallmentRequest} requestParameters Request parameters.
488
122
 
489
123
  * @throws {RequiredError}
490
124
  */
491
- addPerson(AddPersonRequest?: AddPersonRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertPersonResponse>>;
125
+ deleteInstallment(requestParameters: BetaApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
492
126
  /**
493
- * Marks an activity as deleted. After 30 days, the activity will be permanently deleted.
494
- * @summary Delete an activity
495
- * @param {number} id The ID of the activity
127
+ * Lists installments attached to a list of deals. Only available in Advanced and above plans.
128
+ * @summary List installments added to a list of deals
129
+ * @param {BetaApiGetInstallmentsRequest} requestParameters Request parameters.
496
130
 
497
131
  * @throws {RequiredError}
498
132
  */
499
- deleteActivity(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteActivityResponse>>;
133
+ getInstallments(requestParameters: BetaApiGetInstallmentsRequest): Promise<GetInstallmentsResponse>;
500
134
  /**
501
- * Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
502
- * @summary Delete a discount from a deal
503
- * @param {number} id The ID of the deal
504
- * @param {number} discount_id The ID of the discount
135
+ * 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.
136
+ * @summary Add an installment to a deal
137
+ * @param {BetaApiPostInstallmentRequest} requestParameters Request parameters.
505
138
 
506
139
  * @throws {RequiredError}
507
140
  */
508
- deleteAdditionalDiscount(id: number, discount_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteAdditionalDiscountResponse>>;
141
+ postInstallment(requestParameters: BetaApiPostInstallmentRequest): Promise<AddAInstallmentResponse>;
509
142
  /**
510
- * Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
511
- * @summary Delete a deal
512
- * @param {number} id The ID of the deal
143
+ * Edits an installment added to a deal. Only available in Advanced and above plans.
144
+ * @summary Update an installment added to a deal
145
+ * @param {BetaApiUpdateInstallmentRequest} requestParameters Request parameters.
513
146
 
514
147
  * @throws {RequiredError}
515
148
  */
516
- deleteDeal(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealResponse>>;
149
+ updateInstallment(requestParameters: BetaApiUpdateInstallmentRequest): Promise<UpdateInstallmentResponse>;
150
+ };
151
+ /**
152
+ * Request parameters for deleteInstallment operation in BetaApi.
153
+ * @export
154
+ * @interface BetaApiDeleteInstallmentRequest
155
+ */
156
+ export interface BetaApiDeleteInstallmentRequest {
517
157
  /**
518
- * Deletes a product attachment from a deal, using the `product_attachment_id`.
519
- * @summary Delete an attached product from a deal
520
- * @param {number} id The ID of the deal
521
- * @param {number} product_attachment_id The product attachment ID
522
-
523
- * @throws {RequiredError}
158
+ * The ID of the deal
159
+ * @type {number}
160
+ * @memberof BetaApiDeleteInstallment
524
161
  */
525
- deleteDealProduct(id: number, product_attachment_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealProductResponse>>;
162
+ readonly id: number;
526
163
  /**
527
- * Marks a organization as deleted. After 30 days, the organization will be permanently deleted.
528
- * @summary Delete a organization
529
- * @param {number} id The ID of the organization
530
-
531
- * @throws {RequiredError}
164
+ * The ID of the installment
165
+ * @type {number}
166
+ * @memberof BetaApiDeleteInstallment
532
167
  */
533
- deleteOrganization(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteOrganizationResponse>>;
168
+ readonly installment_id: number;
169
+ }
170
+ /**
171
+ * Request parameters for getInstallments operation in BetaApi.
172
+ * @export
173
+ * @interface BetaApiGetInstallmentsRequest
174
+ */
175
+ export interface BetaApiGetInstallmentsRequest {
534
176
  /**
535
- * Marks a person as deleted. After 30 days, the person will be permanently deleted.
536
- * @summary Delete a person
537
- * @param {number} id The ID of the person
538
-
539
- * @throws {RequiredError}
177
+ * 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.
178
+ * @type {Array<number>}
179
+ * @memberof BetaApiGetInstallments
540
180
  */
541
- deletePerson(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeletePersonResponse>>;
181
+ readonly deal_ids: Array<number>;
542
182
  /**
543
- * Returns data about all activities.
544
- * @summary Get all activities
545
- * @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
546
- * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
547
- * @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
548
- * @param {string} [updated_since] If set, only activities with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
549
- * @param {string} [updated_until] If set, only activities with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
550
- * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;.
551
- * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
552
- * @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
553
- * @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.
554
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
555
-
556
- * @throws {RequiredError}
183
+ * For pagination, the marker (an opaque string value) representing the first item on the next page
184
+ * @type {string}
185
+ * @memberof BetaApiGetInstallments
557
186
  */
558
- getActivities(filter_id?: number, ids?: string, owner_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'attendees', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivitiesResponse>>;
187
+ readonly cursor?: string;
559
188
  /**
560
- * Returns the details of a specific activity.
561
- * @summary Get details of an activity
562
- * @param {number} id The ID of the activity
563
- * @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
564
-
565
- * @throws {RequiredError}
189
+ * 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.
190
+ * @type {number}
191
+ * @memberof BetaApiGetInstallments
566
192
  */
567
- getActivity(id: number, include_fields?: 'attendees'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertActivityResponse>>;
193
+ readonly limit?: number;
568
194
  /**
569
- * Lists discounts attached to a deal.
570
- * @summary List discounts added to a deal
571
- * @param {number} id The ID of the deal
572
-
573
- * @throws {RequiredError}
195
+ * The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;billing_date&#x60;, &#x60;deal_id&#x60;.
196
+ * @type {'id' | 'billing_date' | 'deal_id'}
197
+ * @memberof BetaApiGetInstallments
574
198
  */
575
- getAdditionalDiscounts(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAdditionalDiscountsResponse>>;
199
+ readonly sort_by?: 'id' | 'billing_date' | 'deal_id';
576
200
  /**
577
- * Returns the details of a specific deal.
578
- * @summary Get details of a deal
579
- * @param {number} id The ID of the deal
580
- * @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time'} [include_fields] Optional comma separated string array of additional fields to include
581
- * @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
582
-
583
- * @throws {RequiredError}
201
+ * The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
202
+ * @type {'asc' | 'desc'}
203
+ * @memberof BetaApiGetInstallments
584
204
  */
585
- getDeal(id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time', custom_fields?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertDealResponse>>;
205
+ readonly sort_direction?: 'asc' | 'desc';
206
+ }
207
+ /**
208
+ * Request parameters for postInstallment operation in BetaApi.
209
+ * @export
210
+ * @interface BetaApiPostInstallmentRequest
211
+ */
212
+ export interface BetaApiPostInstallmentRequest {
586
213
  /**
587
- * Lists products attached to a deal.
588
- * @summary List products attached to a deal
589
- * @param {number} id The ID of the deal
590
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
591
- * @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.
592
- * @param {'id' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
593
- * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
594
-
595
- * @throws {RequiredError}
214
+ * The ID of the deal
215
+ * @type {number}
216
+ * @memberof BetaApiPostInstallment
596
217
  */
597
- getDealProducts(id: number, cursor?: string, limit?: number, sort_by?: 'id' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsProductsResponse>>;
218
+ readonly id: number;
598
219
  /**
599
- * Returns data about all deals.
600
- * @summary Get all deals
601
- * @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
602
- * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
603
- * @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
604
- * @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
605
- * @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
606
- * @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
607
- * @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
608
- * @param {'open' | 'won' | 'lost' | 'deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.
609
- * @param {string} [updated_since] If set, only deals with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
610
- * @param {string} [updated_until] If set, only deals with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
611
- * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;.
612
- * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
613
- * @param {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time'} [include_fields] Optional comma separated string array of additional fields to include
614
- * @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
615
- * @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.
616
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
617
-
618
- * @throws {RequiredError}
220
+ *
221
+ * @type {AddInstallmentRequestBody}
222
+ * @memberof BetaApiPostInstallment
619
223
  */
620
- getDeals(filter_id?: number, ids?: string, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted', updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time', custom_fields?: string, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsResponse>>;
224
+ readonly AddInstallmentRequestBody?: AddInstallmentRequestBody;
225
+ }
226
+ /**
227
+ * Request parameters for updateInstallment operation in BetaApi.
228
+ * @export
229
+ * @interface BetaApiUpdateInstallmentRequest
230
+ */
231
+ export interface BetaApiUpdateInstallmentRequest {
621
232
  /**
622
- * Returns data about products attached to deals
623
- * @summary Get deal products of several deals
624
- * @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached products will be returned. A maximum of 100 deal IDs can be provided.
625
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
626
- * @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.
627
- * @param {'id' | 'deal_id' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;deal_id&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
628
- * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
629
-
630
- * @throws {RequiredError}
233
+ * The ID of the deal
234
+ * @type {number}
235
+ * @memberof BetaApiUpdateInstallment
631
236
  */
632
- 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>>;
237
+ readonly id: number;
633
238
  /**
634
- * Returns the details of a specific organization.
635
- * @summary Get details of a organization
636
- * @param {number} id The ID of the organization
637
- * @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count'} [include_fields] Optional comma separated string array of additional fields to include
638
- * @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
639
-
640
- * @throws {RequiredError}
239
+ * The ID of the installment
240
+ * @type {number}
241
+ * @memberof BetaApiUpdateInstallment
641
242
  */
642
- getOrganization(id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count', custom_fields?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertOrganizationResponse>>;
243
+ readonly installment_id: number;
643
244
  /**
644
- * Returns data about all organizations.
645
- * @summary Get all organizations
646
- * @param {number} [filter_id] If supplied, only organizations matching the specified filter are returned
647
- * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
648
- * @param {number} [owner_id] If supplied, only organization owned by the specified user are returned. If filter_id is provided, this is ignored.
649
- * @param {string} [updated_since] If set, only organizations with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
650
- * @param {string} [updated_until] If set, only organizations with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
651
- * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;.
652
- * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
653
- * @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count'} [include_fields] Optional comma separated string array of additional fields to include
654
- * @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
655
- * @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.
656
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
657
-
658
- * @throws {RequiredError}
245
+ *
246
+ * @type {UpdateInstallmentRequestBody}
247
+ * @memberof BetaApiUpdateInstallment
659
248
  */
660
- getOrganizations(filter_id?: number, ids?: string, owner_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count', custom_fields?: string, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetOrganizationsResponse>>;
661
- /**
662
- * Returns the details of a specific person. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
663
- * @summary Get details of a person
664
- * @param {number} id The ID of the person
665
- * @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status'} [include_fields] Optional comma separated string array of additional fields to include. &#x60;marketing_status&#x60; and &#x60;doi_status&#x60; can only be included if the company has marketing app enabled.
666
- * @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
667
-
668
- * @throws {RequiredError}
669
- */
670
- getPerson(id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status', custom_fields?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertPersonResponse>>;
671
- /**
672
- * Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
673
- * @summary Get all persons
674
- * @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
675
- * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
676
- * @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
677
- * @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
678
- * @param {string} [updated_since] If set, only persons with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
679
- * @param {string} [updated_until] If set, only persons with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
680
- * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;.
681
- * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
682
- * @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status'} [include_fields] Optional comma separated string array of additional fields to include. &#x60;marketing_status&#x60; and &#x60;doi_status&#x60; can only be included if the company has marketing app enabled.
683
- * @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
684
- * @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.
685
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
686
-
687
- * @throws {RequiredError}
688
- */
689
- getPersons(filter_id?: number, ids?: string, owner_id?: number, org_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status', custom_fields?: string, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonsResponse>>;
690
- /**
691
- * Adds a discount to a deal changing, the deal value if the deal has one-time products attached.
692
- * @summary Add a discount to a deal
693
- * @param {number} id The ID of the deal
694
- * @param {AddAdditionalDiscountRequestBody} [AddAdditionalDiscountRequestBody]
695
-
696
- * @throws {RequiredError}
697
- */
698
- postAdditionalDiscount(id: number, AddAdditionalDiscountRequestBody?: AddAdditionalDiscountRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddAdditionalDiscountResponse>>;
699
- /**
700
- * 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.
701
- * @summary Search deals
702
- * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
703
- * @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
704
- * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
705
- * @param {number} [person_id] Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
706
- * @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
707
- * @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
708
- * @param {'deal.cc_email'} [include_fields] Supports including optional fields in the results which are not provided by default
709
- * @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.
710
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
711
-
712
- * @throws {RequiredError}
713
- */
714
- searchDeals(term: string, fields?: 'custom_fields' | 'notes' | 'title', exact_match?: boolean, person_id?: number, organization_id?: number, status?: 'open' | 'won' | 'lost', include_fields?: 'deal.cc_email', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealSearchResponse>>;
715
- /**
716
- * Performs a search from your choice of item types and fields.
717
- * @summary Perform a search from multiple item types
718
- * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
719
- * @param {'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'} [item_types] A comma-separated string array. The type of items to perform the search from. Defaults to all.
720
- * @param {'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'organization_name' | 'person_name' | 'phone' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:&lt;br&gt; &lt;table&gt; &lt;tr&gt;&lt;th&gt;&lt;b&gt;Item type&lt;/b&gt;&lt;/th&gt;&lt;th&gt;&lt;b&gt;Field&lt;/b&gt;&lt;/th&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Deal&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;title&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Person&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;email&#x60;, &#x60;name&#x60;, &#x60;notes&#x60;, &#x60;phone&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Organization&lt;/td&gt;&lt;td&gt;&#x60;address&#x60;, &#x60;custom_fields&#x60;, &#x60;name&#x60;, &#x60;notes&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Product&lt;/td&gt;&lt;td&gt;&#x60;code&#x60;, &#x60;custom_fields&#x60;, &#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Lead&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;email&#x60;, &#x60;organization_name&#x60;, &#x60;person_name&#x60;, &#x60;phone&#x60;, &#x60;title&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;File&lt;/td&gt;&lt;td&gt;&#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Mail attachment&lt;/td&gt;&lt;td&gt;&#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Project&lt;/td&gt;&lt;td&gt; &#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;title&#x60;, &#x60;description&#x60; &lt;/td&gt;&lt;/tr&gt; &lt;/table&gt; &lt;br&gt; Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.&lt;br/&gt; When searching for leads, the email, organization_name, person_name, and phone fields will return results only for leads not linked to contacts. For searching leads by person or organization values, please use &#x60;search_for_related_items&#x60;.
721
- * @param {boolean} [search_for_related_items] When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization
722
- * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
723
- * @param {'deal.cc_email' | 'person.picture' | 'product.price'} [include_fields] A comma-separated string array. Supports including optional fields in the results which are not provided by default.
724
- * @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.
725
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
726
-
727
- * @throws {RequiredError}
728
- */
729
- searchItem(term: string, item_types?: 'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project', fields?: 'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'organization_name' | 'person_name' | 'phone' | 'title' | 'description', search_for_related_items?: boolean, exact_match?: boolean, include_fields?: 'deal.cc_email' | 'person.picture' | 'product.price', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetItemSearchResponse>>;
730
- /**
731
- * Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products).
732
- * @summary Perform a search using a specific field from an item type
733
- * @param {string} term The search term to look for. Minimum 2 characters (or 1 if &#x60;match&#x60; is &#x60;exact&#x60;). Please note that the search term has to be URL encoded.
734
- * @param {'deal' | 'lead' | 'person' | 'organization' | 'product' | 'project'} entity_type The type of the field to perform the search from
735
- * @param {string} field The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields\&#39; API GET methods (dealFields, personFields, etc.). Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
736
- * @param {'exact' | 'beginning' | 'middle'} [match] The type of match used against the term. The search &lt;b&gt;is&lt;/b&gt; case sensitive.&lt;br/&gt;&lt;br/&gt; E.g. in case of searching for a value &#x60;monkey&#x60;, &lt;ul&gt; &lt;li&gt;with &#x60;exact&#x60; match, you will only find it if term is &#x60;monkey&#x60;&lt;/li&gt; &lt;li&gt;with &#x60;beginning&#x60; match, you will only find it if the term matches the beginning or the whole string, e.g. &#x60;monk&#x60; and &#x60;monkey&#x60;&lt;/li&gt; &lt;li&gt;with &#x60;middle&#x60; match, you will find the it if the term matches any substring of the value, e.g. &#x60;onk&#x60; and &#x60;ke&#x60;&lt;/li&gt; &lt;/ul&gt;.
737
- * @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.
738
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
739
-
740
- * @throws {RequiredError}
741
- */
742
- searchItemByField(term: string, entity_type: 'deal' | 'lead' | 'person' | 'organization' | 'product' | 'project', field: string, match?: 'exact' | 'beginning' | 'middle', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetItemSearchFieldResponse>>;
743
- /**
744
- * Searches all leads 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 leads can be filtered by the person ID and the organization ID.
745
- * @summary Search leads
746
- * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
747
- * @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
748
- * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
749
- * @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
750
- * @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
751
- * @param {'lead.was_seen'} [include_fields] Supports including optional fields in the results which are not provided by default
752
- * @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.
753
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
754
-
755
- * @throws {RequiredError}
756
- */
757
- searchLeads(term: string, fields?: 'custom_fields' | 'notes' | 'title', exact_match?: boolean, person_id?: number, organization_id?: number, include_fields?: 'lead.was_seen', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadSearchResponse>>;
758
- /**
759
- * Searches all organizations by name, address, 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.
760
- * @summary Search organizations
761
- * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
762
- * @param {'address' | 'custom_fields' | 'notes' | 'name'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
763
- * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
764
- * @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.
765
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
766
-
767
- * @throws {RequiredError}
768
- */
769
- searchOrganization(term: string, fields?: 'address' | 'custom_fields' | 'notes' | 'name', exact_match?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetOrganizationSearchResponse>>;
770
- /**
771
- * Searches all persons by name, email, phone, 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 persons can be filtered by organization ID.
772
- * @summary Search persons
773
- * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
774
- * @param {'custom_fields' | 'email' | 'notes' | 'phone' | 'name'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
775
- * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
776
- * @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
777
- * @param {'person.picture'} [include_fields] Supports including optional fields in the results which are not provided by default
778
- * @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.
779
- * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
780
-
781
- * @throws {RequiredError}
782
- */
783
- searchPersons(term: string, fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name', exact_match?: boolean, organization_id?: number, include_fields?: 'person.picture', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonSearchResponse>>;
784
- /**
785
- * Updates the properties of an activity.
786
- * @summary Update an activity
787
- * @param {number} id The ID of the activity
788
- * @param {AddActivityRequest} [AddActivityRequest]
789
-
790
- * @throws {RequiredError}
791
- */
792
- updateActivity(id: number, AddActivityRequest?: AddActivityRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertActivityResponse>>;
793
- /**
794
- * Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
795
- * @summary Update a discount added to a deal
796
- * @param {number} id The ID of the deal
797
- * @param {number} discount_id The ID of the discount
798
- * @param {UpdateAdditionalDiscountRequestBody} [UpdateAdditionalDiscountRequestBody]
799
-
800
- * @throws {RequiredError}
801
- */
802
- updateAdditionalDiscount(id: number, discount_id: number, UpdateAdditionalDiscountRequestBody?: UpdateAdditionalDiscountRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateAdditionalDiscountResponse>>;
803
- /**
804
- * Updates the properties of a deal.
805
- * @summary Update a deal
806
- * @param {number} id The ID of the deal
807
- * @param {UpdateDealRequest} [UpdateDealRequest]
808
-
809
- * @throws {RequiredError}
810
- */
811
- updateDeal(id: number, UpdateDealRequest?: UpdateDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertDealResponse>>;
812
- /**
813
- * Updates the details of the product that has been attached to a deal.
814
- * @summary Update the product attached to a deal
815
- * @param {number} id The ID of the deal
816
- * @param {number} product_attachment_id The ID of the deal-product (the ID of the product attached to the deal)
817
- * @param {UpdateDealProductRequest} [UpdateDealProductRequest]
818
-
819
- * @throws {RequiredError}
820
- */
821
- updateDealProduct(id: number, product_attachment_id: number, UpdateDealProductRequest?: UpdateDealProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealProductResponse>>;
822
- /**
823
- * Updates the properties of a organization.
824
- * @summary Update a organization
825
- * @param {number} id The ID of the organization
826
- * @param {UpdateOrganizationRequest} [UpdateOrganizationRequest]
827
-
828
- * @throws {RequiredError}
829
- */
830
- updateOrganization(id: number, UpdateOrganizationRequest?: UpdateOrganizationRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertOrganizationResponse>>;
831
- /**
832
- * Updates the properties of a person.
833
- * @summary Update a person
834
- * @param {number} id The ID of the person
835
- * @param {UpdatePersonRequest} [UpdatePersonRequest]
836
-
837
- * @throws {RequiredError}
838
- */
839
- updatePerson(id: number, UpdatePersonRequest?: UpdatePersonRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertPersonResponse>>;
840
- };
841
- /**
842
- * BetaApi - factory interface
843
- * @export
844
- */
845
- export declare const BetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
846
- /**
847
- * Adds a new activity.
848
- * @summary Add a new activity
849
- * @param {BetaApiAddActivityRequest} requestParameters Request parameters.
850
-
851
- * @throws {RequiredError}
852
- */
853
- addActivity(requestParameters?: BetaApiAddActivityRequest): Promise<UpsertActivityResponse>;
854
- /**
855
- * Adds a new deal.
856
- * @summary Add a new deal
857
- * @param {BetaApiAddDealRequest} requestParameters Request parameters.
858
-
859
- * @throws {RequiredError}
860
- */
861
- addDeal(requestParameters?: BetaApiAddDealRequest): Promise<UpsertDealResponse>;
862
- /**
863
- * Adds a product to a deal, creating a new item called a deal-product.
864
- * @summary Add a product to a deal
865
- * @param {BetaApiAddDealProductRequest} requestParameters Request parameters.
866
-
867
- * @throws {RequiredError}
868
- */
869
- addDealProduct(requestParameters: BetaApiAddDealProductRequest): Promise<AddDealProductResponse>;
870
- /**
871
- * Adds a new organization.
872
- * @summary Add a new organization
873
- * @param {BetaApiAddOrganizationRequest} requestParameters Request parameters.
874
-
875
- * @throws {RequiredError}
876
- */
877
- addOrganization(requestParameters?: BetaApiAddOrganizationRequest): Promise<UpsertOrganizationResponse>;
878
- /**
879
- * Adds a new person.
880
- * @summary Add a new person
881
- * @param {BetaApiAddPersonRequest} requestParameters Request parameters.
882
-
883
- * @throws {RequiredError}
884
- */
885
- addPerson(requestParameters?: BetaApiAddPersonRequest): Promise<UpsertPersonResponse>;
886
- /**
887
- * Marks an activity as deleted. After 30 days, the activity will be permanently deleted.
888
- * @summary Delete an activity
889
- * @param {BetaApiDeleteActivityRequest} requestParameters Request parameters.
890
-
891
- * @throws {RequiredError}
892
- */
893
- deleteActivity(requestParameters: BetaApiDeleteActivityRequest): Promise<DeleteActivityResponse>;
894
- /**
895
- * Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
896
- * @summary Delete a discount from a deal
897
- * @param {BetaApiDeleteAdditionalDiscountRequest} requestParameters Request parameters.
898
-
899
- * @throws {RequiredError}
900
- */
901
- deleteAdditionalDiscount(requestParameters: BetaApiDeleteAdditionalDiscountRequest): Promise<DeleteAdditionalDiscountResponse>;
902
- /**
903
- * Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
904
- * @summary Delete a deal
905
- * @param {BetaApiDeleteDealRequest} requestParameters Request parameters.
906
-
907
- * @throws {RequiredError}
908
- */
909
- deleteDeal(requestParameters: BetaApiDeleteDealRequest): Promise<DeleteDealResponse>;
910
- /**
911
- * Deletes a product attachment from a deal, using the `product_attachment_id`.
912
- * @summary Delete an attached product from a deal
913
- * @param {BetaApiDeleteDealProductRequest} requestParameters Request parameters.
914
-
915
- * @throws {RequiredError}
916
- */
917
- deleteDealProduct(requestParameters: BetaApiDeleteDealProductRequest): Promise<DeleteDealProductResponse>;
918
- /**
919
- * Marks a organization as deleted. After 30 days, the organization will be permanently deleted.
920
- * @summary Delete a organization
921
- * @param {BetaApiDeleteOrganizationRequest} requestParameters Request parameters.
922
-
923
- * @throws {RequiredError}
924
- */
925
- deleteOrganization(requestParameters: BetaApiDeleteOrganizationRequest): Promise<DeleteOrganizationResponse>;
926
- /**
927
- * Marks a person as deleted. After 30 days, the person will be permanently deleted.
928
- * @summary Delete a person
929
- * @param {BetaApiDeletePersonRequest} requestParameters Request parameters.
930
-
931
- * @throws {RequiredError}
932
- */
933
- deletePerson(requestParameters: BetaApiDeletePersonRequest): Promise<DeletePersonResponse>;
934
- /**
935
- * Returns data about all activities.
936
- * @summary Get all activities
937
- * @param {BetaApiGetActivitiesRequest} requestParameters Request parameters.
938
-
939
- * @throws {RequiredError}
940
- */
941
- getActivities(requestParameters?: BetaApiGetActivitiesRequest): Promise<GetActivitiesResponse>;
942
- /**
943
- * Returns the details of a specific activity.
944
- * @summary Get details of an activity
945
- * @param {BetaApiGetActivityRequest} requestParameters Request parameters.
946
-
947
- * @throws {RequiredError}
948
- */
949
- getActivity(requestParameters: BetaApiGetActivityRequest): Promise<UpsertActivityResponse>;
950
- /**
951
- * Lists discounts attached to a deal.
952
- * @summary List discounts added to a deal
953
- * @param {BetaApiGetAdditionalDiscountsRequest} requestParameters Request parameters.
954
-
955
- * @throws {RequiredError}
956
- */
957
- getAdditionalDiscounts(requestParameters: BetaApiGetAdditionalDiscountsRequest): Promise<GetAdditionalDiscountsResponse>;
958
- /**
959
- * Returns the details of a specific deal.
960
- * @summary Get details of a deal
961
- * @param {BetaApiGetDealRequest} requestParameters Request parameters.
962
-
963
- * @throws {RequiredError}
964
- */
965
- getDeal(requestParameters: BetaApiGetDealRequest): Promise<UpsertDealResponse>;
966
- /**
967
- * Lists products attached to a deal.
968
- * @summary List products attached to a deal
969
- * @param {BetaApiGetDealProductsRequest} requestParameters Request parameters.
970
-
971
- * @throws {RequiredError}
972
- */
973
- getDealProducts(requestParameters: BetaApiGetDealProductsRequest): Promise<GetDealsProductsResponse>;
974
- /**
975
- * Returns data about all deals.
976
- * @summary Get all deals
977
- * @param {BetaApiGetDealsRequest} requestParameters Request parameters.
978
-
979
- * @throws {RequiredError}
980
- */
981
- getDeals(requestParameters?: BetaApiGetDealsRequest): Promise<GetDealsResponse>;
982
- /**
983
- * Returns data about products attached to deals
984
- * @summary Get deal products of several deals
985
- * @param {BetaApiGetDealsProductsRequest} requestParameters Request parameters.
986
-
987
- * @throws {RequiredError}
988
- */
989
- getDealsProducts(requestParameters: BetaApiGetDealsProductsRequest): Promise<GetDealsProductsResponse>;
990
- /**
991
- * Returns the details of a specific organization.
992
- * @summary Get details of a organization
993
- * @param {BetaApiGetOrganizationRequest} requestParameters Request parameters.
994
-
995
- * @throws {RequiredError}
996
- */
997
- getOrganization(requestParameters: BetaApiGetOrganizationRequest): Promise<UpsertOrganizationResponse>;
998
- /**
999
- * Returns data about all organizations.
1000
- * @summary Get all organizations
1001
- * @param {BetaApiGetOrganizationsRequest} requestParameters Request parameters.
1002
-
1003
- * @throws {RequiredError}
1004
- */
1005
- getOrganizations(requestParameters?: BetaApiGetOrganizationsRequest): Promise<GetOrganizationsResponse>;
1006
- /**
1007
- * Returns the details of a specific person. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
1008
- * @summary Get details of a person
1009
- * @param {BetaApiGetPersonRequest} requestParameters Request parameters.
1010
-
1011
- * @throws {RequiredError}
1012
- */
1013
- getPerson(requestParameters: BetaApiGetPersonRequest): Promise<UpsertPersonResponse>;
1014
- /**
1015
- * Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
1016
- * @summary Get all persons
1017
- * @param {BetaApiGetPersonsRequest} requestParameters Request parameters.
1018
-
1019
- * @throws {RequiredError}
1020
- */
1021
- getPersons(requestParameters?: BetaApiGetPersonsRequest): Promise<GetPersonsResponse>;
1022
- /**
1023
- * Adds a discount to a deal changing, the deal value if the deal has one-time products attached.
1024
- * @summary Add a discount to a deal
1025
- * @param {BetaApiPostAdditionalDiscountRequest} requestParameters Request parameters.
1026
-
1027
- * @throws {RequiredError}
1028
- */
1029
- postAdditionalDiscount(requestParameters: BetaApiPostAdditionalDiscountRequest): Promise<AddAdditionalDiscountResponse>;
1030
- /**
1031
- * 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.
1032
- * @summary Search deals
1033
- * @param {BetaApiSearchDealsRequest} requestParameters Request parameters.
1034
-
1035
- * @throws {RequiredError}
1036
- */
1037
- searchDeals(requestParameters: BetaApiSearchDealsRequest): Promise<GetDealSearchResponse>;
1038
- /**
1039
- * Performs a search from your choice of item types and fields.
1040
- * @summary Perform a search from multiple item types
1041
- * @param {BetaApiSearchItemRequest} requestParameters Request parameters.
1042
-
1043
- * @throws {RequiredError}
1044
- */
1045
- searchItem(requestParameters: BetaApiSearchItemRequest): Promise<GetItemSearchResponse>;
1046
- /**
1047
- * Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products).
1048
- * @summary Perform a search using a specific field from an item type
1049
- * @param {BetaApiSearchItemByFieldRequest} requestParameters Request parameters.
1050
-
1051
- * @throws {RequiredError}
1052
- */
1053
- searchItemByField(requestParameters: BetaApiSearchItemByFieldRequest): Promise<GetItemSearchFieldResponse>;
1054
- /**
1055
- * Searches all leads 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 leads can be filtered by the person ID and the organization ID.
1056
- * @summary Search leads
1057
- * @param {BetaApiSearchLeadsRequest} requestParameters Request parameters.
1058
-
1059
- * @throws {RequiredError}
1060
- */
1061
- searchLeads(requestParameters: BetaApiSearchLeadsRequest): Promise<GetLeadSearchResponse>;
1062
- /**
1063
- * Searches all organizations by name, address, 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.
1064
- * @summary Search organizations
1065
- * @param {BetaApiSearchOrganizationRequest} requestParameters Request parameters.
1066
-
1067
- * @throws {RequiredError}
1068
- */
1069
- searchOrganization(requestParameters: BetaApiSearchOrganizationRequest): Promise<GetOrganizationSearchResponse>;
1070
- /**
1071
- * Searches all persons by name, email, phone, 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 persons can be filtered by organization ID.
1072
- * @summary Search persons
1073
- * @param {BetaApiSearchPersonsRequest} requestParameters Request parameters.
1074
-
1075
- * @throws {RequiredError}
1076
- */
1077
- searchPersons(requestParameters: BetaApiSearchPersonsRequest): Promise<GetPersonSearchResponse>;
1078
- /**
1079
- * Updates the properties of an activity.
1080
- * @summary Update an activity
1081
- * @param {BetaApiUpdateActivityRequest} requestParameters Request parameters.
1082
-
1083
- * @throws {RequiredError}
1084
- */
1085
- updateActivity(requestParameters: BetaApiUpdateActivityRequest): Promise<UpsertActivityResponse>;
1086
- /**
1087
- * Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
1088
- * @summary Update a discount added to a deal
1089
- * @param {BetaApiUpdateAdditionalDiscountRequest} requestParameters Request parameters.
1090
-
1091
- * @throws {RequiredError}
1092
- */
1093
- updateAdditionalDiscount(requestParameters: BetaApiUpdateAdditionalDiscountRequest): Promise<UpdateAdditionalDiscountResponse>;
1094
- /**
1095
- * Updates the properties of a deal.
1096
- * @summary Update a deal
1097
- * @param {BetaApiUpdateDealRequest} requestParameters Request parameters.
1098
-
1099
- * @throws {RequiredError}
1100
- */
1101
- updateDeal(requestParameters: BetaApiUpdateDealRequest): Promise<UpsertDealResponse>;
1102
- /**
1103
- * Updates the details of the product that has been attached to a deal.
1104
- * @summary Update the product attached to a deal
1105
- * @param {BetaApiUpdateDealProductRequest} requestParameters Request parameters.
1106
-
1107
- * @throws {RequiredError}
1108
- */
1109
- updateDealProduct(requestParameters: BetaApiUpdateDealProductRequest): Promise<AddDealProductResponse>;
1110
- /**
1111
- * Updates the properties of a organization.
1112
- * @summary Update a organization
1113
- * @param {BetaApiUpdateOrganizationRequest} requestParameters Request parameters.
1114
-
1115
- * @throws {RequiredError}
1116
- */
1117
- updateOrganization(requestParameters: BetaApiUpdateOrganizationRequest): Promise<UpsertOrganizationResponse>;
1118
- /**
1119
- * Updates the properties of a person.
1120
- * @summary Update a person
1121
- * @param {BetaApiUpdatePersonRequest} requestParameters Request parameters.
1122
-
1123
- * @throws {RequiredError}
1124
- */
1125
- updatePerson(requestParameters: BetaApiUpdatePersonRequest): Promise<UpsertPersonResponse>;
1126
- };
1127
- /**
1128
- * Request parameters for addActivity operation in BetaApi.
1129
- * @export
1130
- * @interface BetaApiAddActivityRequest
1131
- */
1132
- export interface BetaApiAddActivityRequest {
1133
- /**
1134
- *
1135
- * @type {AddActivityRequest}
1136
- * @memberof BetaApiAddActivity
1137
- */
1138
- readonly AddActivityRequest?: AddActivityRequest;
1139
- }
1140
- /**
1141
- * Request parameters for addDeal operation in BetaApi.
1142
- * @export
1143
- * @interface BetaApiAddDealRequest
1144
- */
1145
- export interface BetaApiAddDealRequest {
1146
- /**
1147
- *
1148
- * @type {AddDealRequest}
1149
- * @memberof BetaApiAddDeal
1150
- */
1151
- readonly AddDealRequest?: AddDealRequest;
1152
- }
1153
- /**
1154
- * Request parameters for addDealProduct operation in BetaApi.
1155
- * @export
1156
- * @interface BetaApiAddDealProductRequest
1157
- */
1158
- export interface BetaApiAddDealProductRequest {
1159
- /**
1160
- * The ID of the deal
1161
- * @type {number}
1162
- * @memberof BetaApiAddDealProduct
1163
- */
1164
- readonly id: number;
1165
- /**
1166
- *
1167
- * @type {AddDealProductRequest}
1168
- * @memberof BetaApiAddDealProduct
1169
- */
1170
- readonly AddDealProductRequest?: AddDealProductRequest;
1171
- }
1172
- /**
1173
- * Request parameters for addOrganization operation in BetaApi.
1174
- * @export
1175
- * @interface BetaApiAddOrganizationRequest
1176
- */
1177
- export interface BetaApiAddOrganizationRequest {
1178
- /**
1179
- *
1180
- * @type {AddOrganizationRequest}
1181
- * @memberof BetaApiAddOrganization
1182
- */
1183
- readonly AddOrganizationRequest?: AddOrganizationRequest;
1184
- }
1185
- /**
1186
- * Request parameters for addPerson operation in BetaApi.
1187
- * @export
1188
- * @interface BetaApiAddPersonRequest
1189
- */
1190
- export interface BetaApiAddPersonRequest {
1191
- /**
1192
- *
1193
- * @type {AddPersonRequest}
1194
- * @memberof BetaApiAddPerson
1195
- */
1196
- readonly AddPersonRequest?: AddPersonRequest;
1197
- }
1198
- /**
1199
- * Request parameters for deleteActivity operation in BetaApi.
1200
- * @export
1201
- * @interface BetaApiDeleteActivityRequest
1202
- */
1203
- export interface BetaApiDeleteActivityRequest {
1204
- /**
1205
- * The ID of the activity
1206
- * @type {number}
1207
- * @memberof BetaApiDeleteActivity
1208
- */
1209
- readonly id: number;
1210
- }
1211
- /**
1212
- * Request parameters for deleteAdditionalDiscount operation in BetaApi.
1213
- * @export
1214
- * @interface BetaApiDeleteAdditionalDiscountRequest
1215
- */
1216
- export interface BetaApiDeleteAdditionalDiscountRequest {
1217
- /**
1218
- * The ID of the deal
1219
- * @type {number}
1220
- * @memberof BetaApiDeleteAdditionalDiscount
1221
- */
1222
- readonly id: number;
1223
- /**
1224
- * The ID of the discount
1225
- * @type {number}
1226
- * @memberof BetaApiDeleteAdditionalDiscount
1227
- */
1228
- readonly discount_id: number;
1229
- }
1230
- /**
1231
- * Request parameters for deleteDeal operation in BetaApi.
1232
- * @export
1233
- * @interface BetaApiDeleteDealRequest
1234
- */
1235
- export interface BetaApiDeleteDealRequest {
1236
- /**
1237
- * The ID of the deal
1238
- * @type {number}
1239
- * @memberof BetaApiDeleteDeal
1240
- */
1241
- readonly id: number;
1242
- }
1243
- /**
1244
- * Request parameters for deleteDealProduct operation in BetaApi.
1245
- * @export
1246
- * @interface BetaApiDeleteDealProductRequest
1247
- */
1248
- export interface BetaApiDeleteDealProductRequest {
1249
- /**
1250
- * The ID of the deal
1251
- * @type {number}
1252
- * @memberof BetaApiDeleteDealProduct
1253
- */
1254
- readonly id: number;
1255
- /**
1256
- * The product attachment ID
1257
- * @type {number}
1258
- * @memberof BetaApiDeleteDealProduct
1259
- */
1260
- readonly product_attachment_id: number;
1261
- }
1262
- /**
1263
- * Request parameters for deleteOrganization operation in BetaApi.
1264
- * @export
1265
- * @interface BetaApiDeleteOrganizationRequest
1266
- */
1267
- export interface BetaApiDeleteOrganizationRequest {
1268
- /**
1269
- * The ID of the organization
1270
- * @type {number}
1271
- * @memberof BetaApiDeleteOrganization
1272
- */
1273
- readonly id: number;
1274
- }
1275
- /**
1276
- * Request parameters for deletePerson operation in BetaApi.
1277
- * @export
1278
- * @interface BetaApiDeletePersonRequest
1279
- */
1280
- export interface BetaApiDeletePersonRequest {
1281
- /**
1282
- * The ID of the person
1283
- * @type {number}
1284
- * @memberof BetaApiDeletePerson
1285
- */
1286
- readonly id: number;
1287
- }
1288
- /**
1289
- * Request parameters for getActivities operation in BetaApi.
1290
- * @export
1291
- * @interface BetaApiGetActivitiesRequest
1292
- */
1293
- export interface BetaApiGetActivitiesRequest {
1294
- /**
1295
- * If supplied, only activities matching the specified filter are returned
1296
- * @type {number}
1297
- * @memberof BetaApiGetActivities
1298
- */
1299
- readonly filter_id?: number;
1300
- /**
1301
- * Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
1302
- * @type {string}
1303
- * @memberof BetaApiGetActivities
1304
- */
1305
- readonly ids?: string;
1306
- /**
1307
- * If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
1308
- * @type {number}
1309
- * @memberof BetaApiGetActivities
1310
- */
1311
- readonly owner_id?: number;
1312
- /**
1313
- * If set, only activities with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
1314
- * @type {string}
1315
- * @memberof BetaApiGetActivities
1316
- */
1317
- readonly updated_since?: string;
1318
- /**
1319
- * If set, only activities with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
1320
- * @type {string}
1321
- * @memberof BetaApiGetActivities
1322
- */
1323
- readonly updated_until?: string;
1324
- /**
1325
- * The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;.
1326
- * @type {'id' | 'update_time' | 'add_time'}
1327
- * @memberof BetaApiGetActivities
1328
- */
1329
- readonly sort_by?: 'id' | 'update_time' | 'add_time';
1330
- /**
1331
- * The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
1332
- * @type {'asc' | 'desc'}
1333
- * @memberof BetaApiGetActivities
1334
- */
1335
- readonly sort_direction?: 'asc' | 'desc';
1336
- /**
1337
- * Optional comma separated string array of additional fields to include
1338
- * @type {'attendees'}
1339
- * @memberof BetaApiGetActivities
1340
- */
1341
- readonly include_fields?: 'attendees';
1342
- /**
1343
- * 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.
1344
- * @type {number}
1345
- * @memberof BetaApiGetActivities
1346
- */
1347
- readonly limit?: number;
1348
- /**
1349
- * For pagination, the marker (an opaque string value) representing the first item on the next page
1350
- * @type {string}
1351
- * @memberof BetaApiGetActivities
1352
- */
1353
- readonly cursor?: string;
1354
- }
1355
- /**
1356
- * Request parameters for getActivity operation in BetaApi.
1357
- * @export
1358
- * @interface BetaApiGetActivityRequest
1359
- */
1360
- export interface BetaApiGetActivityRequest {
1361
- /**
1362
- * The ID of the activity
1363
- * @type {number}
1364
- * @memberof BetaApiGetActivity
1365
- */
1366
- readonly id: number;
1367
- /**
1368
- * Optional comma separated string array of additional fields to include
1369
- * @type {'attendees'}
1370
- * @memberof BetaApiGetActivity
1371
- */
1372
- readonly include_fields?: 'attendees';
1373
- }
1374
- /**
1375
- * Request parameters for getAdditionalDiscounts operation in BetaApi.
1376
- * @export
1377
- * @interface BetaApiGetAdditionalDiscountsRequest
1378
- */
1379
- export interface BetaApiGetAdditionalDiscountsRequest {
1380
- /**
1381
- * The ID of the deal
1382
- * @type {number}
1383
- * @memberof BetaApiGetAdditionalDiscounts
1384
- */
1385
- readonly id: number;
1386
- }
1387
- /**
1388
- * Request parameters for getDeal operation in BetaApi.
1389
- * @export
1390
- * @interface BetaApiGetDealRequest
1391
- */
1392
- export interface BetaApiGetDealRequest {
1393
- /**
1394
- * The ID of the deal
1395
- * @type {number}
1396
- * @memberof BetaApiGetDeal
1397
- */
1398
- readonly id: number;
1399
- /**
1400
- * Optional comma separated string array of additional fields to include
1401
- * @type {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time'}
1402
- * @memberof BetaApiGetDeal
1403
- */
1404
- readonly include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time';
1405
- /**
1406
- * Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
1407
- * @type {string}
1408
- * @memberof BetaApiGetDeal
1409
- */
1410
- readonly custom_fields?: string;
1411
- }
1412
- /**
1413
- * Request parameters for getDealProducts operation in BetaApi.
1414
- * @export
1415
- * @interface BetaApiGetDealProductsRequest
1416
- */
1417
- export interface BetaApiGetDealProductsRequest {
1418
- /**
1419
- * The ID of the deal
1420
- * @type {number}
1421
- * @memberof BetaApiGetDealProducts
1422
- */
1423
- readonly id: number;
1424
- /**
1425
- * For pagination, the marker (an opaque string value) representing the first item on the next page
1426
- * @type {string}
1427
- * @memberof BetaApiGetDealProducts
1428
- */
1429
- readonly cursor?: string;
1430
- /**
1431
- * 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.
1432
- * @type {number}
1433
- * @memberof BetaApiGetDealProducts
1434
- */
1435
- readonly limit?: number;
1436
- /**
1437
- * The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
1438
- * @type {'id' | 'add_time' | 'update_time'}
1439
- * @memberof BetaApiGetDealProducts
1440
- */
1441
- readonly sort_by?: 'id' | 'add_time' | 'update_time';
1442
- /**
1443
- * The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
1444
- * @type {'asc' | 'desc'}
1445
- * @memberof BetaApiGetDealProducts
1446
- */
1447
- readonly sort_direction?: 'asc' | 'desc';
1448
- }
1449
- /**
1450
- * Request parameters for getDeals operation in BetaApi.
1451
- * @export
1452
- * @interface BetaApiGetDealsRequest
1453
- */
1454
- export interface BetaApiGetDealsRequest {
1455
- /**
1456
- * If supplied, only deals matching the specified filter are returned
1457
- * @type {number}
1458
- * @memberof BetaApiGetDeals
1459
- */
1460
- readonly filter_id?: number;
1461
- /**
1462
- * Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
1463
- * @type {string}
1464
- * @memberof BetaApiGetDeals
1465
- */
1466
- readonly ids?: string;
1467
- /**
1468
- * If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
1469
- * @type {number}
1470
- * @memberof BetaApiGetDeals
1471
- */
1472
- readonly owner_id?: number;
1473
- /**
1474
- * If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
1475
- * @type {number}
1476
- * @memberof BetaApiGetDeals
1477
- */
1478
- readonly person_id?: number;
1479
- /**
1480
- * If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
1481
- * @type {number}
1482
- * @memberof BetaApiGetDeals
1483
- */
1484
- readonly org_id?: number;
1485
- /**
1486
- * If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
1487
- * @type {number}
1488
- * @memberof BetaApiGetDeals
1489
- */
1490
- readonly pipeline_id?: number;
1491
- /**
1492
- * If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
1493
- * @type {number}
1494
- * @memberof BetaApiGetDeals
1495
- */
1496
- readonly stage_id?: number;
1497
- /**
1498
- * Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.
1499
- * @type {'open' | 'won' | 'lost' | 'deleted'}
1500
- * @memberof BetaApiGetDeals
1501
- */
1502
- readonly status?: 'open' | 'won' | 'lost' | 'deleted';
1503
- /**
1504
- * If set, only deals with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
1505
- * @type {string}
1506
- * @memberof BetaApiGetDeals
1507
- */
1508
- readonly updated_since?: string;
1509
- /**
1510
- * If set, only deals with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
1511
- * @type {string}
1512
- * @memberof BetaApiGetDeals
1513
- */
1514
- readonly updated_until?: string;
1515
- /**
1516
- * The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;.
1517
- * @type {'id' | 'update_time' | 'add_time'}
1518
- * @memberof BetaApiGetDeals
1519
- */
1520
- readonly sort_by?: 'id' | 'update_time' | 'add_time';
1521
- /**
1522
- * The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
1523
- * @type {'asc' | 'desc'}
1524
- * @memberof BetaApiGetDeals
1525
- */
1526
- readonly sort_direction?: 'asc' | 'desc';
1527
- /**
1528
- * Optional comma separated string array of additional fields to include
1529
- * @type {'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time'}
1530
- * @memberof BetaApiGetDeals
1531
- */
1532
- readonly include_fields?: 'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time';
1533
- /**
1534
- * Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
1535
- * @type {string}
1536
- * @memberof BetaApiGetDeals
1537
- */
1538
- readonly custom_fields?: string;
1539
- /**
1540
- * 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.
1541
- * @type {number}
1542
- * @memberof BetaApiGetDeals
1543
- */
1544
- readonly limit?: number;
1545
- /**
1546
- * For pagination, the marker (an opaque string value) representing the first item on the next page
1547
- * @type {string}
1548
- * @memberof BetaApiGetDeals
1549
- */
1550
- readonly cursor?: string;
1551
- }
1552
- /**
1553
- * Request parameters for getDealsProducts operation in BetaApi.
1554
- * @export
1555
- * @interface BetaApiGetDealsProductsRequest
1556
- */
1557
- export interface BetaApiGetDealsProductsRequest {
1558
- /**
1559
- * An array of integers with the IDs of the deals for which the attached products will be returned. A maximum of 100 deal IDs can be provided.
1560
- * @type {Array<number>}
1561
- * @memberof BetaApiGetDealsProducts
1562
- */
1563
- readonly deal_ids: Array<number>;
1564
- /**
1565
- * For pagination, the marker (an opaque string value) representing the first item on the next page
1566
- * @type {string}
1567
- * @memberof BetaApiGetDealsProducts
1568
- */
1569
- readonly cursor?: string;
1570
- /**
1571
- * 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.
1572
- * @type {number}
1573
- * @memberof BetaApiGetDealsProducts
1574
- */
1575
- readonly limit?: number;
1576
- /**
1577
- * The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;deal_id&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
1578
- * @type {'id' | 'deal_id' | 'add_time' | 'update_time'}
1579
- * @memberof BetaApiGetDealsProducts
1580
- */
1581
- readonly sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time';
1582
- /**
1583
- * The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
1584
- * @type {'asc' | 'desc'}
1585
- * @memberof BetaApiGetDealsProducts
1586
- */
1587
- readonly sort_direction?: 'asc' | 'desc';
1588
- }
1589
- /**
1590
- * Request parameters for getOrganization operation in BetaApi.
1591
- * @export
1592
- * @interface BetaApiGetOrganizationRequest
1593
- */
1594
- export interface BetaApiGetOrganizationRequest {
1595
- /**
1596
- * The ID of the organization
1597
- * @type {number}
1598
- * @memberof BetaApiGetOrganization
1599
- */
1600
- readonly id: number;
1601
- /**
1602
- * Optional comma separated string array of additional fields to include
1603
- * @type {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count'}
1604
- * @memberof BetaApiGetOrganization
1605
- */
1606
- readonly include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count';
1607
- /**
1608
- * Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
1609
- * @type {string}
1610
- * @memberof BetaApiGetOrganization
1611
- */
1612
- readonly custom_fields?: string;
1613
- }
1614
- /**
1615
- * Request parameters for getOrganizations operation in BetaApi.
1616
- * @export
1617
- * @interface BetaApiGetOrganizationsRequest
1618
- */
1619
- export interface BetaApiGetOrganizationsRequest {
1620
- /**
1621
- * If supplied, only organizations matching the specified filter are returned
1622
- * @type {number}
1623
- * @memberof BetaApiGetOrganizations
1624
- */
1625
- readonly filter_id?: number;
1626
- /**
1627
- * Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
1628
- * @type {string}
1629
- * @memberof BetaApiGetOrganizations
1630
- */
1631
- readonly ids?: string;
1632
- /**
1633
- * If supplied, only organization owned by the specified user are returned. If filter_id is provided, this is ignored.
1634
- * @type {number}
1635
- * @memberof BetaApiGetOrganizations
1636
- */
1637
- readonly owner_id?: number;
1638
- /**
1639
- * If set, only organizations with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
1640
- * @type {string}
1641
- * @memberof BetaApiGetOrganizations
1642
- */
1643
- readonly updated_since?: string;
1644
- /**
1645
- * If set, only organizations with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
1646
- * @type {string}
1647
- * @memberof BetaApiGetOrganizations
1648
- */
1649
- readonly updated_until?: string;
1650
- /**
1651
- * The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;.
1652
- * @type {'id' | 'update_time' | 'add_time'}
1653
- * @memberof BetaApiGetOrganizations
1654
- */
1655
- readonly sort_by?: 'id' | 'update_time' | 'add_time';
1656
- /**
1657
- * The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
1658
- * @type {'asc' | 'desc'}
1659
- * @memberof BetaApiGetOrganizations
1660
- */
1661
- readonly sort_direction?: 'asc' | 'desc';
1662
- /**
1663
- * Optional comma separated string array of additional fields to include
1664
- * @type {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count'}
1665
- * @memberof BetaApiGetOrganizations
1666
- */
1667
- readonly include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count';
1668
- /**
1669
- * Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
1670
- * @type {string}
1671
- * @memberof BetaApiGetOrganizations
1672
- */
1673
- readonly custom_fields?: string;
1674
- /**
1675
- * 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.
1676
- * @type {number}
1677
- * @memberof BetaApiGetOrganizations
1678
- */
1679
- readonly limit?: number;
1680
- /**
1681
- * For pagination, the marker (an opaque string value) representing the first item on the next page
1682
- * @type {string}
1683
- * @memberof BetaApiGetOrganizations
1684
- */
1685
- readonly cursor?: string;
1686
- }
1687
- /**
1688
- * Request parameters for getPerson operation in BetaApi.
1689
- * @export
1690
- * @interface BetaApiGetPersonRequest
1691
- */
1692
- export interface BetaApiGetPersonRequest {
1693
- /**
1694
- * The ID of the person
1695
- * @type {number}
1696
- * @memberof BetaApiGetPerson
1697
- */
1698
- readonly id: number;
1699
- /**
1700
- * Optional comma separated string array of additional fields to include. &#x60;marketing_status&#x60; and &#x60;doi_status&#x60; can only be included if the company has marketing app enabled.
1701
- * @type {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status'}
1702
- * @memberof BetaApiGetPerson
1703
- */
1704
- readonly include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status';
1705
- /**
1706
- * Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
1707
- * @type {string}
1708
- * @memberof BetaApiGetPerson
1709
- */
1710
- readonly custom_fields?: string;
1711
- }
1712
- /**
1713
- * Request parameters for getPersons operation in BetaApi.
1714
- * @export
1715
- * @interface BetaApiGetPersonsRequest
1716
- */
1717
- export interface BetaApiGetPersonsRequest {
1718
- /**
1719
- * If supplied, only persons matching the specified filter are returned
1720
- * @type {number}
1721
- * @memberof BetaApiGetPersons
1722
- */
1723
- readonly filter_id?: number;
1724
- /**
1725
- * Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
1726
- * @type {string}
1727
- * @memberof BetaApiGetPersons
1728
- */
1729
- readonly ids?: string;
1730
- /**
1731
- * If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
1732
- * @type {number}
1733
- * @memberof BetaApiGetPersons
1734
- */
1735
- readonly owner_id?: number;
1736
- /**
1737
- * If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
1738
- * @type {number}
1739
- * @memberof BetaApiGetPersons
1740
- */
1741
- readonly org_id?: number;
1742
- /**
1743
- * If set, only persons with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
1744
- * @type {string}
1745
- * @memberof BetaApiGetPersons
1746
- */
1747
- readonly updated_since?: string;
1748
- /**
1749
- * If set, only persons with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
1750
- * @type {string}
1751
- * @memberof BetaApiGetPersons
1752
- */
1753
- readonly updated_until?: string;
1754
- /**
1755
- * The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;.
1756
- * @type {'id' | 'update_time' | 'add_time'}
1757
- * @memberof BetaApiGetPersons
1758
- */
1759
- readonly sort_by?: 'id' | 'update_time' | 'add_time';
1760
- /**
1761
- * The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
1762
- * @type {'asc' | 'desc'}
1763
- * @memberof BetaApiGetPersons
1764
- */
1765
- readonly sort_direction?: 'asc' | 'desc';
1766
- /**
1767
- * Optional comma separated string array of additional fields to include. &#x60;marketing_status&#x60; and &#x60;doi_status&#x60; can only be included if the company has marketing app enabled.
1768
- * @type {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status'}
1769
- * @memberof BetaApiGetPersons
1770
- */
1771
- readonly include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status';
1772
- /**
1773
- * Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
1774
- * @type {string}
1775
- * @memberof BetaApiGetPersons
1776
- */
1777
- readonly custom_fields?: string;
1778
- /**
1779
- * 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.
1780
- * @type {number}
1781
- * @memberof BetaApiGetPersons
1782
- */
1783
- readonly limit?: number;
1784
- /**
1785
- * For pagination, the marker (an opaque string value) representing the first item on the next page
1786
- * @type {string}
1787
- * @memberof BetaApiGetPersons
1788
- */
1789
- readonly cursor?: string;
1790
- }
1791
- /**
1792
- * Request parameters for postAdditionalDiscount operation in BetaApi.
1793
- * @export
1794
- * @interface BetaApiPostAdditionalDiscountRequest
1795
- */
1796
- export interface BetaApiPostAdditionalDiscountRequest {
1797
- /**
1798
- * The ID of the deal
1799
- * @type {number}
1800
- * @memberof BetaApiPostAdditionalDiscount
1801
- */
1802
- readonly id: number;
1803
- /**
1804
- *
1805
- * @type {AddAdditionalDiscountRequestBody}
1806
- * @memberof BetaApiPostAdditionalDiscount
1807
- */
1808
- readonly AddAdditionalDiscountRequestBody?: AddAdditionalDiscountRequestBody;
1809
- }
1810
- /**
1811
- * Request parameters for searchDeals operation in BetaApi.
1812
- * @export
1813
- * @interface BetaApiSearchDealsRequest
1814
- */
1815
- export interface BetaApiSearchDealsRequest {
1816
- /**
1817
- * The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
1818
- * @type {string}
1819
- * @memberof BetaApiSearchDeals
1820
- */
1821
- readonly term: string;
1822
- /**
1823
- * A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
1824
- * @type {'custom_fields' | 'notes' | 'title'}
1825
- * @memberof BetaApiSearchDeals
1826
- */
1827
- readonly fields?: 'custom_fields' | 'notes' | 'title';
1828
- /**
1829
- * When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
1830
- * @type {boolean}
1831
- * @memberof BetaApiSearchDeals
1832
- */
1833
- readonly exact_match?: boolean;
1834
- /**
1835
- * Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
1836
- * @type {number}
1837
- * @memberof BetaApiSearchDeals
1838
- */
1839
- readonly person_id?: number;
1840
- /**
1841
- * Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
1842
- * @type {number}
1843
- * @memberof BetaApiSearchDeals
1844
- */
1845
- readonly organization_id?: number;
1846
- /**
1847
- * Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
1848
- * @type {'open' | 'won' | 'lost'}
1849
- * @memberof BetaApiSearchDeals
1850
- */
1851
- readonly status?: 'open' | 'won' | 'lost';
1852
- /**
1853
- * Supports including optional fields in the results which are not provided by default
1854
- * @type {'deal.cc_email'}
1855
- * @memberof BetaApiSearchDeals
1856
- */
1857
- readonly include_fields?: 'deal.cc_email';
1858
- /**
1859
- * 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.
1860
- * @type {number}
1861
- * @memberof BetaApiSearchDeals
1862
- */
1863
- readonly limit?: number;
1864
- /**
1865
- * For pagination, the marker (an opaque string value) representing the first item on the next page
1866
- * @type {string}
1867
- * @memberof BetaApiSearchDeals
1868
- */
1869
- readonly cursor?: string;
1870
- }
1871
- /**
1872
- * Request parameters for searchItem operation in BetaApi.
1873
- * @export
1874
- * @interface BetaApiSearchItemRequest
1875
- */
1876
- export interface BetaApiSearchItemRequest {
1877
- /**
1878
- * The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
1879
- * @type {string}
1880
- * @memberof BetaApiSearchItem
1881
- */
1882
- readonly term: string;
1883
- /**
1884
- * A comma-separated string array. The type of items to perform the search from. Defaults to all.
1885
- * @type {'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'}
1886
- * @memberof BetaApiSearchItem
1887
- */
1888
- readonly item_types?: 'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project';
1889
- /**
1890
- * A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:&lt;br&gt; &lt;table&gt; &lt;tr&gt;&lt;th&gt;&lt;b&gt;Item type&lt;/b&gt;&lt;/th&gt;&lt;th&gt;&lt;b&gt;Field&lt;/b&gt;&lt;/th&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Deal&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;title&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Person&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;email&#x60;, &#x60;name&#x60;, &#x60;notes&#x60;, &#x60;phone&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Organization&lt;/td&gt;&lt;td&gt;&#x60;address&#x60;, &#x60;custom_fields&#x60;, &#x60;name&#x60;, &#x60;notes&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Product&lt;/td&gt;&lt;td&gt;&#x60;code&#x60;, &#x60;custom_fields&#x60;, &#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Lead&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;email&#x60;, &#x60;organization_name&#x60;, &#x60;person_name&#x60;, &#x60;phone&#x60;, &#x60;title&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;File&lt;/td&gt;&lt;td&gt;&#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Mail attachment&lt;/td&gt;&lt;td&gt;&#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Project&lt;/td&gt;&lt;td&gt; &#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;title&#x60;, &#x60;description&#x60; &lt;/td&gt;&lt;/tr&gt; &lt;/table&gt; &lt;br&gt; Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.&lt;br/&gt; When searching for leads, the email, organization_name, person_name, and phone fields will return results only for leads not linked to contacts. For searching leads by person or organization values, please use &#x60;search_for_related_items&#x60;.
1891
- * @type {'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'organization_name' | 'person_name' | 'phone' | 'title' | 'description'}
1892
- * @memberof BetaApiSearchItem
1893
- */
1894
- readonly fields?: 'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'organization_name' | 'person_name' | 'phone' | 'title' | 'description';
1895
- /**
1896
- * When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization
1897
- * @type {boolean}
1898
- * @memberof BetaApiSearchItem
1899
- */
1900
- readonly search_for_related_items?: boolean;
1901
- /**
1902
- * When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
1903
- * @type {boolean}
1904
- * @memberof BetaApiSearchItem
1905
- */
1906
- readonly exact_match?: boolean;
1907
- /**
1908
- * A comma-separated string array. Supports including optional fields in the results which are not provided by default.
1909
- * @type {'deal.cc_email' | 'person.picture' | 'product.price'}
1910
- * @memberof BetaApiSearchItem
1911
- */
1912
- readonly include_fields?: 'deal.cc_email' | 'person.picture' | 'product.price';
1913
- /**
1914
- * 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.
1915
- * @type {number}
1916
- * @memberof BetaApiSearchItem
1917
- */
1918
- readonly limit?: number;
1919
- /**
1920
- * For pagination, the marker (an opaque string value) representing the first item on the next page
1921
- * @type {string}
1922
- * @memberof BetaApiSearchItem
1923
- */
1924
- readonly cursor?: string;
1925
- }
1926
- /**
1927
- * Request parameters for searchItemByField operation in BetaApi.
1928
- * @export
1929
- * @interface BetaApiSearchItemByFieldRequest
1930
- */
1931
- export interface BetaApiSearchItemByFieldRequest {
1932
- /**
1933
- * The search term to look for. Minimum 2 characters (or 1 if &#x60;match&#x60; is &#x60;exact&#x60;). Please note that the search term has to be URL encoded.
1934
- * @type {string}
1935
- * @memberof BetaApiSearchItemByField
1936
- */
1937
- readonly term: string;
1938
- /**
1939
- * The type of the field to perform the search from
1940
- * @type {'deal' | 'lead' | 'person' | 'organization' | 'product' | 'project'}
1941
- * @memberof BetaApiSearchItemByField
1942
- */
1943
- readonly entity_type: 'deal' | 'lead' | 'person' | 'organization' | 'product' | 'project';
1944
- /**
1945
- * The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields\&#39; API GET methods (dealFields, personFields, etc.). Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
1946
- * @type {string}
1947
- * @memberof BetaApiSearchItemByField
1948
- */
1949
- readonly field: string;
1950
- /**
1951
- * The type of match used against the term. The search &lt;b&gt;is&lt;/b&gt; case sensitive.&lt;br/&gt;&lt;br/&gt; E.g. in case of searching for a value &#x60;monkey&#x60;, &lt;ul&gt; &lt;li&gt;with &#x60;exact&#x60; match, you will only find it if term is &#x60;monkey&#x60;&lt;/li&gt; &lt;li&gt;with &#x60;beginning&#x60; match, you will only find it if the term matches the beginning or the whole string, e.g. &#x60;monk&#x60; and &#x60;monkey&#x60;&lt;/li&gt; &lt;li&gt;with &#x60;middle&#x60; match, you will find the it if the term matches any substring of the value, e.g. &#x60;onk&#x60; and &#x60;ke&#x60;&lt;/li&gt; &lt;/ul&gt;.
1952
- * @type {'exact' | 'beginning' | 'middle'}
1953
- * @memberof BetaApiSearchItemByField
1954
- */
1955
- readonly match?: 'exact' | 'beginning' | 'middle';
1956
- /**
1957
- * 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.
1958
- * @type {number}
1959
- * @memberof BetaApiSearchItemByField
1960
- */
1961
- readonly limit?: number;
1962
- /**
1963
- * For pagination, the marker (an opaque string value) representing the first item on the next page
1964
- * @type {string}
1965
- * @memberof BetaApiSearchItemByField
1966
- */
1967
- readonly cursor?: string;
1968
- }
1969
- /**
1970
- * Request parameters for searchLeads operation in BetaApi.
1971
- * @export
1972
- * @interface BetaApiSearchLeadsRequest
1973
- */
1974
- export interface BetaApiSearchLeadsRequest {
1975
- /**
1976
- * The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
1977
- * @type {string}
1978
- * @memberof BetaApiSearchLeads
1979
- */
1980
- readonly term: string;
1981
- /**
1982
- * A comma-separated string array. The fields to perform the search from. Defaults to all of them.
1983
- * @type {'custom_fields' | 'notes' | 'title'}
1984
- * @memberof BetaApiSearchLeads
1985
- */
1986
- readonly fields?: 'custom_fields' | 'notes' | 'title';
1987
- /**
1988
- * When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
1989
- * @type {boolean}
1990
- * @memberof BetaApiSearchLeads
1991
- */
1992
- readonly exact_match?: boolean;
1993
- /**
1994
- * Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
1995
- * @type {number}
1996
- * @memberof BetaApiSearchLeads
1997
- */
1998
- readonly person_id?: number;
1999
- /**
2000
- * Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
2001
- * @type {number}
2002
- * @memberof BetaApiSearchLeads
2003
- */
2004
- readonly organization_id?: number;
2005
- /**
2006
- * Supports including optional fields in the results which are not provided by default
2007
- * @type {'lead.was_seen'}
2008
- * @memberof BetaApiSearchLeads
2009
- */
2010
- readonly include_fields?: 'lead.was_seen';
2011
- /**
2012
- * 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.
2013
- * @type {number}
2014
- * @memberof BetaApiSearchLeads
2015
- */
2016
- readonly limit?: number;
2017
- /**
2018
- * For pagination, the marker (an opaque string value) representing the first item on the next page
2019
- * @type {string}
2020
- * @memberof BetaApiSearchLeads
2021
- */
2022
- readonly cursor?: string;
2023
- }
2024
- /**
2025
- * Request parameters for searchOrganization operation in BetaApi.
2026
- * @export
2027
- * @interface BetaApiSearchOrganizationRequest
2028
- */
2029
- export interface BetaApiSearchOrganizationRequest {
2030
- /**
2031
- * The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
2032
- * @type {string}
2033
- * @memberof BetaApiSearchOrganization
2034
- */
2035
- readonly term: string;
2036
- /**
2037
- * A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
2038
- * @type {'address' | 'custom_fields' | 'notes' | 'name'}
2039
- * @memberof BetaApiSearchOrganization
2040
- */
2041
- readonly fields?: 'address' | 'custom_fields' | 'notes' | 'name';
2042
- /**
2043
- * When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
2044
- * @type {boolean}
2045
- * @memberof BetaApiSearchOrganization
2046
- */
2047
- readonly exact_match?: boolean;
2048
- /**
2049
- * 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.
2050
- * @type {number}
2051
- * @memberof BetaApiSearchOrganization
2052
- */
2053
- readonly limit?: number;
2054
- /**
2055
- * For pagination, the marker (an opaque string value) representing the first item on the next page
2056
- * @type {string}
2057
- * @memberof BetaApiSearchOrganization
2058
- */
2059
- readonly cursor?: string;
2060
- }
2061
- /**
2062
- * Request parameters for searchPersons operation in BetaApi.
2063
- * @export
2064
- * @interface BetaApiSearchPersonsRequest
2065
- */
2066
- export interface BetaApiSearchPersonsRequest {
2067
- /**
2068
- * The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
2069
- * @type {string}
2070
- * @memberof BetaApiSearchPersons
2071
- */
2072
- readonly term: string;
2073
- /**
2074
- * A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
2075
- * @type {'custom_fields' | 'email' | 'notes' | 'phone' | 'name'}
2076
- * @memberof BetaApiSearchPersons
2077
- */
2078
- readonly fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name';
2079
- /**
2080
- * When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
2081
- * @type {boolean}
2082
- * @memberof BetaApiSearchPersons
2083
- */
2084
- readonly exact_match?: boolean;
2085
- /**
2086
- * Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
2087
- * @type {number}
2088
- * @memberof BetaApiSearchPersons
2089
- */
2090
- readonly organization_id?: number;
2091
- /**
2092
- * Supports including optional fields in the results which are not provided by default
2093
- * @type {'person.picture'}
2094
- * @memberof BetaApiSearchPersons
2095
- */
2096
- readonly include_fields?: 'person.picture';
2097
- /**
2098
- * 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.
2099
- * @type {number}
2100
- * @memberof BetaApiSearchPersons
2101
- */
2102
- readonly limit?: number;
2103
- /**
2104
- * For pagination, the marker (an opaque string value) representing the first item on the next page
2105
- * @type {string}
2106
- * @memberof BetaApiSearchPersons
2107
- */
2108
- readonly cursor?: string;
2109
- }
2110
- /**
2111
- * Request parameters for updateActivity operation in BetaApi.
2112
- * @export
2113
- * @interface BetaApiUpdateActivityRequest
2114
- */
2115
- export interface BetaApiUpdateActivityRequest {
2116
- /**
2117
- * The ID of the activity
2118
- * @type {number}
2119
- * @memberof BetaApiUpdateActivity
2120
- */
2121
- readonly id: number;
2122
- /**
2123
- *
2124
- * @type {AddActivityRequest}
2125
- * @memberof BetaApiUpdateActivity
2126
- */
2127
- readonly AddActivityRequest?: AddActivityRequest;
2128
- }
2129
- /**
2130
- * Request parameters for updateAdditionalDiscount operation in BetaApi.
2131
- * @export
2132
- * @interface BetaApiUpdateAdditionalDiscountRequest
2133
- */
2134
- export interface BetaApiUpdateAdditionalDiscountRequest {
2135
- /**
2136
- * The ID of the deal
2137
- * @type {number}
2138
- * @memberof BetaApiUpdateAdditionalDiscount
2139
- */
2140
- readonly id: number;
2141
- /**
2142
- * The ID of the discount
2143
- * @type {number}
2144
- * @memberof BetaApiUpdateAdditionalDiscount
2145
- */
2146
- readonly discount_id: number;
2147
- /**
2148
- *
2149
- * @type {UpdateAdditionalDiscountRequestBody}
2150
- * @memberof BetaApiUpdateAdditionalDiscount
2151
- */
2152
- readonly UpdateAdditionalDiscountRequestBody?: UpdateAdditionalDiscountRequestBody;
2153
- }
2154
- /**
2155
- * Request parameters for updateDeal operation in BetaApi.
2156
- * @export
2157
- * @interface BetaApiUpdateDealRequest
2158
- */
2159
- export interface BetaApiUpdateDealRequest {
2160
- /**
2161
- * The ID of the deal
2162
- * @type {number}
2163
- * @memberof BetaApiUpdateDeal
2164
- */
2165
- readonly id: number;
2166
- /**
2167
- *
2168
- * @type {UpdateDealRequest}
2169
- * @memberof BetaApiUpdateDeal
2170
- */
2171
- readonly UpdateDealRequest?: UpdateDealRequest;
2172
- }
2173
- /**
2174
- * Request parameters for updateDealProduct operation in BetaApi.
2175
- * @export
2176
- * @interface BetaApiUpdateDealProductRequest
2177
- */
2178
- export interface BetaApiUpdateDealProductRequest {
2179
- /**
2180
- * The ID of the deal
2181
- * @type {number}
2182
- * @memberof BetaApiUpdateDealProduct
2183
- */
2184
- readonly id: number;
2185
- /**
2186
- * The ID of the deal-product (the ID of the product attached to the deal)
2187
- * @type {number}
2188
- * @memberof BetaApiUpdateDealProduct
2189
- */
2190
- readonly product_attachment_id: number;
2191
- /**
2192
- *
2193
- * @type {UpdateDealProductRequest}
2194
- * @memberof BetaApiUpdateDealProduct
2195
- */
2196
- readonly UpdateDealProductRequest?: UpdateDealProductRequest;
2197
- }
2198
- /**
2199
- * Request parameters for updateOrganization operation in BetaApi.
2200
- * @export
2201
- * @interface BetaApiUpdateOrganizationRequest
2202
- */
2203
- export interface BetaApiUpdateOrganizationRequest {
2204
- /**
2205
- * The ID of the organization
2206
- * @type {number}
2207
- * @memberof BetaApiUpdateOrganization
2208
- */
2209
- readonly id: number;
2210
- /**
2211
- *
2212
- * @type {UpdateOrganizationRequest}
2213
- * @memberof BetaApiUpdateOrganization
2214
- */
2215
- readonly UpdateOrganizationRequest?: UpdateOrganizationRequest;
2216
- }
2217
- /**
2218
- * Request parameters for updatePerson operation in BetaApi.
2219
- * @export
2220
- * @interface BetaApiUpdatePersonRequest
2221
- */
2222
- export interface BetaApiUpdatePersonRequest {
2223
- /**
2224
- * The ID of the person
2225
- * @type {number}
2226
- * @memberof BetaApiUpdatePerson
2227
- */
2228
- readonly id: number;
2229
- /**
2230
- *
2231
- * @type {UpdatePersonRequest}
2232
- * @memberof BetaApiUpdatePerson
2233
- */
2234
- readonly UpdatePersonRequest?: UpdatePersonRequest;
249
+ readonly UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody;
2235
250
  }
2236
251
  /**
2237
252
  * BetaApi - object-oriented interface
@@ -2241,318 +256,39 @@ export interface BetaApiUpdatePersonRequest {
2241
256
  */
2242
257
  export declare class BetaApi extends BaseAPI {
2243
258
  /**
2244
- * Adds a new activity.
2245
- * @summary Add a new activity
2246
- * @param {BetaApiAddActivityRequest} requestParameters Request parameters.
2247
-
2248
- * @throws {RequiredError}
2249
- * @memberof BetaApi
2250
- */
2251
- addActivity(requestParameters?: BetaApiAddActivityRequest): Promise<UpsertActivityResponse>;
2252
- /**
2253
- * Adds a new deal.
2254
- * @summary Add a new deal
2255
- * @param {BetaApiAddDealRequest} requestParameters Request parameters.
2256
-
2257
- * @throws {RequiredError}
2258
- * @memberof BetaApi
2259
- */
2260
- addDeal(requestParameters?: BetaApiAddDealRequest): Promise<UpsertDealResponse>;
2261
- /**
2262
- * Adds a product to a deal, creating a new item called a deal-product.
2263
- * @summary Add a product to a deal
2264
- * @param {BetaApiAddDealProductRequest} requestParameters Request parameters.
2265
-
2266
- * @throws {RequiredError}
2267
- * @memberof BetaApi
2268
- */
2269
- addDealProduct(requestParameters: BetaApiAddDealProductRequest): Promise<AddDealProductResponse>;
2270
- /**
2271
- * Adds a new organization.
2272
- * @summary Add a new organization
2273
- * @param {BetaApiAddOrganizationRequest} requestParameters Request parameters.
2274
-
2275
- * @throws {RequiredError}
2276
- * @memberof BetaApi
2277
- */
2278
- addOrganization(requestParameters?: BetaApiAddOrganizationRequest): Promise<UpsertOrganizationResponse>;
2279
- /**
2280
- * Adds a new person.
2281
- * @summary Add a new person
2282
- * @param {BetaApiAddPersonRequest} requestParameters Request parameters.
2283
-
2284
- * @throws {RequiredError}
2285
- * @memberof BetaApi
2286
- */
2287
- addPerson(requestParameters?: BetaApiAddPersonRequest): Promise<UpsertPersonResponse>;
2288
- /**
2289
- * Marks an activity as deleted. After 30 days, the activity will be permanently deleted.
2290
- * @summary Delete an activity
2291
- * @param {BetaApiDeleteActivityRequest} requestParameters Request parameters.
2292
-
2293
- * @throws {RequiredError}
2294
- * @memberof BetaApi
2295
- */
2296
- deleteActivity(requestParameters: BetaApiDeleteActivityRequest): Promise<DeleteActivityResponse>;
2297
- /**
2298
- * Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
2299
- * @summary Delete a discount from a deal
2300
- * @param {BetaApiDeleteAdditionalDiscountRequest} requestParameters Request parameters.
2301
-
2302
- * @throws {RequiredError}
2303
- * @memberof BetaApi
2304
- */
2305
- deleteAdditionalDiscount(requestParameters: BetaApiDeleteAdditionalDiscountRequest): Promise<DeleteAdditionalDiscountResponse>;
2306
- /**
2307
- * Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
2308
- * @summary Delete a deal
2309
- * @param {BetaApiDeleteDealRequest} requestParameters Request parameters.
2310
-
2311
- * @throws {RequiredError}
2312
- * @memberof BetaApi
2313
- */
2314
- deleteDeal(requestParameters: BetaApiDeleteDealRequest): Promise<DeleteDealResponse>;
2315
- /**
2316
- * Deletes a product attachment from a deal, using the `product_attachment_id`.
2317
- * @summary Delete an attached product from a deal
2318
- * @param {BetaApiDeleteDealProductRequest} requestParameters Request parameters.
2319
-
2320
- * @throws {RequiredError}
2321
- * @memberof BetaApi
2322
- */
2323
- deleteDealProduct(requestParameters: BetaApiDeleteDealProductRequest): Promise<DeleteDealProductResponse>;
2324
- /**
2325
- * Marks a organization as deleted. After 30 days, the organization will be permanently deleted.
2326
- * @summary Delete a organization
2327
- * @param {BetaApiDeleteOrganizationRequest} requestParameters Request parameters.
2328
-
2329
- * @throws {RequiredError}
2330
- * @memberof BetaApi
2331
- */
2332
- deleteOrganization(requestParameters: BetaApiDeleteOrganizationRequest): Promise<DeleteOrganizationResponse>;
2333
- /**
2334
- * Marks a person as deleted. After 30 days, the person will be permanently deleted.
2335
- * @summary Delete a person
2336
- * @param {BetaApiDeletePersonRequest} requestParameters Request parameters.
2337
-
2338
- * @throws {RequiredError}
2339
- * @memberof BetaApi
2340
- */
2341
- deletePerson(requestParameters: BetaApiDeletePersonRequest): Promise<DeletePersonResponse>;
2342
- /**
2343
- * Returns data about all activities.
2344
- * @summary Get all activities
2345
- * @param {BetaApiGetActivitiesRequest} requestParameters Request parameters.
2346
-
2347
- * @throws {RequiredError}
2348
- * @memberof BetaApi
2349
- */
2350
- getActivities(requestParameters?: BetaApiGetActivitiesRequest): Promise<GetActivitiesResponse>;
2351
- /**
2352
- * Returns the details of a specific activity.
2353
- * @summary Get details of an activity
2354
- * @param {BetaApiGetActivityRequest} requestParameters Request parameters.
2355
-
2356
- * @throws {RequiredError}
2357
- * @memberof BetaApi
2358
- */
2359
- getActivity(requestParameters: BetaApiGetActivityRequest): Promise<UpsertActivityResponse>;
2360
- /**
2361
- * Lists discounts attached to a deal.
2362
- * @summary List discounts added to a deal
2363
- * @param {BetaApiGetAdditionalDiscountsRequest} requestParameters Request parameters.
2364
-
2365
- * @throws {RequiredError}
2366
- * @memberof BetaApi
2367
- */
2368
- getAdditionalDiscounts(requestParameters: BetaApiGetAdditionalDiscountsRequest): Promise<GetAdditionalDiscountsResponse>;
2369
- /**
2370
- * Returns the details of a specific deal.
2371
- * @summary Get details of a deal
2372
- * @param {BetaApiGetDealRequest} requestParameters Request parameters.
2373
-
2374
- * @throws {RequiredError}
2375
- * @memberof BetaApi
2376
- */
2377
- getDeal(requestParameters: BetaApiGetDealRequest): Promise<UpsertDealResponse>;
2378
- /**
2379
- * Lists products attached to a deal.
2380
- * @summary List products attached to a deal
2381
- * @param {BetaApiGetDealProductsRequest} requestParameters Request parameters.
2382
-
2383
- * @throws {RequiredError}
2384
- * @memberof BetaApi
2385
- */
2386
- getDealProducts(requestParameters: BetaApiGetDealProductsRequest): Promise<GetDealsProductsResponse>;
2387
- /**
2388
- * Returns data about all deals.
2389
- * @summary Get all deals
2390
- * @param {BetaApiGetDealsRequest} requestParameters Request parameters.
2391
-
2392
- * @throws {RequiredError}
2393
- * @memberof BetaApi
2394
- */
2395
- getDeals(requestParameters?: BetaApiGetDealsRequest): Promise<GetDealsResponse>;
2396
- /**
2397
- * Returns data about products attached to deals
2398
- * @summary Get deal products of several deals
2399
- * @param {BetaApiGetDealsProductsRequest} requestParameters Request parameters.
2400
-
2401
- * @throws {RequiredError}
2402
- * @memberof BetaApi
2403
- */
2404
- getDealsProducts(requestParameters: BetaApiGetDealsProductsRequest): Promise<GetDealsProductsResponse>;
2405
- /**
2406
- * Returns the details of a specific organization.
2407
- * @summary Get details of a organization
2408
- * @param {BetaApiGetOrganizationRequest} requestParameters Request parameters.
2409
-
2410
- * @throws {RequiredError}
2411
- * @memberof BetaApi
2412
- */
2413
- getOrganization(requestParameters: BetaApiGetOrganizationRequest): Promise<UpsertOrganizationResponse>;
2414
- /**
2415
- * Returns data about all organizations.
2416
- * @summary Get all organizations
2417
- * @param {BetaApiGetOrganizationsRequest} requestParameters Request parameters.
2418
-
2419
- * @throws {RequiredError}
2420
- * @memberof BetaApi
2421
- */
2422
- getOrganizations(requestParameters?: BetaApiGetOrganizationsRequest): Promise<GetOrganizationsResponse>;
2423
- /**
2424
- * Returns the details of a specific person. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
2425
- * @summary Get details of a person
2426
- * @param {BetaApiGetPersonRequest} requestParameters Request parameters.
2427
-
2428
- * @throws {RequiredError}
2429
- * @memberof BetaApi
2430
- */
2431
- getPerson(requestParameters: BetaApiGetPersonRequest): Promise<UpsertPersonResponse>;
2432
- /**
2433
- * Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
2434
- * @summary Get all persons
2435
- * @param {BetaApiGetPersonsRequest} requestParameters Request parameters.
2436
-
2437
- * @throws {RequiredError}
2438
- * @memberof BetaApi
2439
- */
2440
- getPersons(requestParameters?: BetaApiGetPersonsRequest): Promise<GetPersonsResponse>;
2441
- /**
2442
- * Adds a discount to a deal changing, the deal value if the deal has one-time products attached.
2443
- * @summary Add a discount to a deal
2444
- * @param {BetaApiPostAdditionalDiscountRequest} requestParameters Request parameters.
2445
-
2446
- * @throws {RequiredError}
2447
- * @memberof BetaApi
2448
- */
2449
- postAdditionalDiscount(requestParameters: BetaApiPostAdditionalDiscountRequest): Promise<AddAdditionalDiscountResponse>;
2450
- /**
2451
- * 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.
2452
- * @summary Search deals
2453
- * @param {BetaApiSearchDealsRequest} requestParameters Request parameters.
2454
-
2455
- * @throws {RequiredError}
2456
- * @memberof BetaApi
2457
- */
2458
- searchDeals(requestParameters: BetaApiSearchDealsRequest): Promise<GetDealSearchResponse>;
2459
- /**
2460
- * Performs a search from your choice of item types and fields.
2461
- * @summary Perform a search from multiple item types
2462
- * @param {BetaApiSearchItemRequest} requestParameters Request parameters.
2463
-
2464
- * @throws {RequiredError}
2465
- * @memberof BetaApi
2466
- */
2467
- searchItem(requestParameters: BetaApiSearchItemRequest): Promise<GetItemSearchResponse>;
2468
- /**
2469
- * Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products).
2470
- * @summary Perform a search using a specific field from an item type
2471
- * @param {BetaApiSearchItemByFieldRequest} requestParameters Request parameters.
2472
-
2473
- * @throws {RequiredError}
2474
- * @memberof BetaApi
2475
- */
2476
- searchItemByField(requestParameters: BetaApiSearchItemByFieldRequest): Promise<GetItemSearchFieldResponse>;
2477
- /**
2478
- * Searches all leads 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 leads can be filtered by the person ID and the organization ID.
2479
- * @summary Search leads
2480
- * @param {BetaApiSearchLeadsRequest} requestParameters Request parameters.
2481
-
2482
- * @throws {RequiredError}
2483
- * @memberof BetaApi
2484
- */
2485
- searchLeads(requestParameters: BetaApiSearchLeadsRequest): Promise<GetLeadSearchResponse>;
2486
- /**
2487
- * Searches all organizations by name, address, 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.
2488
- * @summary Search organizations
2489
- * @param {BetaApiSearchOrganizationRequest} requestParameters Request parameters.
2490
-
2491
- * @throws {RequiredError}
2492
- * @memberof BetaApi
2493
- */
2494
- searchOrganization(requestParameters: BetaApiSearchOrganizationRequest): Promise<GetOrganizationSearchResponse>;
2495
- /**
2496
- * Searches all persons by name, email, phone, 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 persons can be filtered by organization ID.
2497
- * @summary Search persons
2498
- * @param {BetaApiSearchPersonsRequest} requestParameters Request parameters.
2499
-
2500
- * @throws {RequiredError}
2501
- * @memberof BetaApi
2502
- */
2503
- searchPersons(requestParameters: BetaApiSearchPersonsRequest): Promise<GetPersonSearchResponse>;
2504
- /**
2505
- * Updates the properties of an activity.
2506
- * @summary Update an activity
2507
- * @param {BetaApiUpdateActivityRequest} requestParameters Request parameters.
2508
-
2509
- * @throws {RequiredError}
2510
- * @memberof BetaApi
2511
- */
2512
- updateActivity(requestParameters: BetaApiUpdateActivityRequest): Promise<UpsertActivityResponse>;
2513
- /**
2514
- * Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
2515
- * @summary Update a discount added to a deal
2516
- * @param {BetaApiUpdateAdditionalDiscountRequest} requestParameters Request parameters.
2517
-
2518
- * @throws {RequiredError}
2519
- * @memberof BetaApi
2520
- */
2521
- updateAdditionalDiscount(requestParameters: BetaApiUpdateAdditionalDiscountRequest): Promise<UpdateAdditionalDiscountResponse>;
2522
- /**
2523
- * Updates the properties of a deal.
2524
- * @summary Update a deal
2525
- * @param {BetaApiUpdateDealRequest} requestParameters Request parameters.
259
+ * Removes an installment from a deal. Only available in Advanced and above plans.
260
+ * @summary Delete an installment from a deal
261
+ * @param {BetaApiDeleteInstallmentRequest} requestParameters Request parameters.
2526
262
 
2527
263
  * @throws {RequiredError}
2528
264
  * @memberof BetaApi
2529
265
  */
2530
- updateDeal(requestParameters: BetaApiUpdateDealRequest): Promise<UpsertDealResponse>;
266
+ deleteInstallment(requestParameters: BetaApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
2531
267
  /**
2532
- * Updates the details of the product that has been attached to a deal.
2533
- * @summary Update the product attached to a deal
2534
- * @param {BetaApiUpdateDealProductRequest} requestParameters Request parameters.
268
+ * Lists installments attached to a list of deals. Only available in Advanced and above plans.
269
+ * @summary List installments added to a list of deals
270
+ * @param {BetaApiGetInstallmentsRequest} requestParameters Request parameters.
2535
271
 
2536
272
  * @throws {RequiredError}
2537
273
  * @memberof BetaApi
2538
274
  */
2539
- updateDealProduct(requestParameters: BetaApiUpdateDealProductRequest): Promise<AddDealProductResponse>;
275
+ getInstallments(requestParameters: BetaApiGetInstallmentsRequest): Promise<GetInstallmentsResponse>;
2540
276
  /**
2541
- * Updates the properties of a organization.
2542
- * @summary Update a organization
2543
- * @param {BetaApiUpdateOrganizationRequest} requestParameters Request parameters.
277
+ * 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.
278
+ * @summary Add an installment to a deal
279
+ * @param {BetaApiPostInstallmentRequest} requestParameters Request parameters.
2544
280
 
2545
281
  * @throws {RequiredError}
2546
282
  * @memberof BetaApi
2547
283
  */
2548
- updateOrganization(requestParameters: BetaApiUpdateOrganizationRequest): Promise<UpsertOrganizationResponse>;
284
+ postInstallment(requestParameters: BetaApiPostInstallmentRequest): Promise<AddAInstallmentResponse>;
2549
285
  /**
2550
- * Updates the properties of a person.
2551
- * @summary Update a person
2552
- * @param {BetaApiUpdatePersonRequest} requestParameters Request parameters.
286
+ * Edits an installment added to a deal. Only available in Advanced and above plans.
287
+ * @summary Update an installment added to a deal
288
+ * @param {BetaApiUpdateInstallmentRequest} requestParameters Request parameters.
2553
289
 
2554
290
  * @throws {RequiredError}
2555
291
  * @memberof BetaApi
2556
292
  */
2557
- updatePerson(requestParameters: BetaApiUpdatePersonRequest): Promise<UpsertPersonResponse>;
293
+ updateInstallment(requestParameters: BetaApiUpdateInstallmentRequest): Promise<UpdateInstallmentResponse>;
2558
294
  }