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