pipedrive 36.0.1 → 36.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/versions/v1/api/activity-fields-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/activity-fields-api.js +25 -0
- package/dist/esm/versions/v1/api/activity-types-api.d.ts +72 -1
- package/dist/esm/versions/v1/api/activity-types-api.js +107 -0
- package/dist/esm/versions/v1/api/billing-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/billing-api.js +25 -0
- package/dist/esm/versions/v1/api/call-logs-api.d.ts +93 -1
- package/dist/esm/versions/v1/api/call-logs-api.js +137 -0
- package/dist/esm/versions/v1/api/channels-api.d.ts +74 -1
- package/dist/esm/versions/v1/api/channels-api.js +109 -0
- package/dist/esm/versions/v1/api/currencies-api.d.ts +19 -1
- package/dist/esm/versions/v1/api/currencies-api.js +27 -0
- package/dist/esm/versions/v1/api/deal-fields-api.d.ts +111 -1
- package/dist/esm/versions/v1/api/deal-fields-api.js +164 -0
- package/dist/esm/versions/v1/api/deals-api.d.ts +399 -1
- package/dist/esm/versions/v1/api/deals-api.js +569 -0
- package/dist/esm/versions/v1/api/files-api.d.ts +163 -1
- package/dist/esm/versions/v1/api/files-api.js +234 -0
- package/dist/esm/versions/v1/api/filters-api.d.ts +129 -1
- package/dist/esm/versions/v1/api/filters-api.js +191 -0
- package/dist/esm/versions/v1/api/goals-api.d.ts +106 -1
- package/dist/esm/versions/v1/api/goals-api.js +150 -0
- package/dist/esm/versions/v1/api/lead-fields-api.d.ts +20 -1
- package/dist/esm/versions/v1/api/lead-fields-api.js +28 -0
- package/dist/esm/versions/v1/api/lead-labels-api.d.ts +72 -1
- package/dist/esm/versions/v1/api/lead-labels-api.js +107 -0
- package/dist/esm/versions/v1/api/lead-sources-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/lead-sources-api.js +25 -0
- package/dist/esm/versions/v1/api/leads-api.d.ts +166 -1
- package/dist/esm/versions/v1/api/leads-api.js +237 -0
- package/dist/esm/versions/v1/api/legacy-teams-api.d.ts +152 -1
- package/dist/esm/versions/v1/api/legacy-teams-api.js +223 -0
- package/dist/esm/versions/v1/api/mailbox-api.d.ts +117 -1
- package/dist/esm/versions/v1/api/mailbox-api.js +170 -0
- package/dist/esm/versions/v1/api/meetings-api.d.ts +37 -1
- package/dist/esm/versions/v1/api/meetings-api.js +54 -0
- package/dist/esm/versions/v1/api/note-fields-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/note-fields-api.js +25 -0
- package/dist/esm/versions/v1/api/notes-api.d.ts +207 -1
- package/dist/esm/versions/v1/api/notes-api.js +296 -0
- package/dist/esm/versions/v1/api/organization-fields-api.d.ts +111 -1
- package/dist/esm/versions/v1/api/organization-fields-api.js +164 -0
- package/dist/esm/versions/v1/api/organization-relationships-api.d.ts +93 -1
- package/dist/esm/versions/v1/api/organization-relationships-api.js +137 -0
- package/dist/esm/versions/v1/api/organizations-api.d.ts +178 -1
- package/dist/esm/versions/v1/api/organizations-api.js +258 -0
- package/dist/esm/versions/v1/api/permission-sets-api.d.ts +57 -1
- package/dist/esm/versions/v1/api/permission-sets-api.js +83 -0
- package/dist/esm/versions/v1/api/person-fields-api.d.ts +111 -1
- package/dist/esm/versions/v1/api/person-fields-api.js +164 -0
- package/dist/esm/versions/v1/api/persons-api.d.ts +275 -37
- package/dist/esm/versions/v1/api/persons-api.js +370 -24
- package/dist/esm/versions/v1/api/pipelines-api.d.ts +69 -1
- package/dist/esm/versions/v1/api/pipelines-api.js +95 -0
- package/dist/esm/versions/v1/api/product-fields-api.d.ts +111 -1
- package/dist/esm/versions/v1/api/product-fields-api.js +164 -0
- package/dist/esm/versions/v1/api/products-api.d.ts +119 -1
- package/dist/esm/versions/v1/api/products-api.js +172 -0
- package/dist/esm/versions/v1/api/project-boards-api.d.ts +35 -1
- package/dist/esm/versions/v1/api/project-boards-api.js +52 -0
- package/dist/esm/versions/v1/api/project-phases-api.d.ts +37 -1
- package/dist/esm/versions/v1/api/project-phases-api.js +54 -0
- package/dist/esm/versions/v1/api/project-templates-api.d.ts +38 -1
- package/dist/esm/versions/v1/api/project-templates-api.js +55 -0
- package/dist/esm/versions/v1/api/projects-api.d.ts +227 -1
- package/dist/esm/versions/v1/api/projects-api.js +334 -0
- package/dist/esm/versions/v1/api/recents-api.d.ts +22 -1
- package/dist/esm/versions/v1/api/recents-api.js +30 -0
- package/dist/esm/versions/v1/api/roles-api.d.ts +226 -1
- package/dist/esm/versions/v1/api/roles-api.js +333 -0
- package/dist/esm/versions/v1/api/stages-api.d.ts +24 -1
- package/dist/esm/versions/v1/api/stages-api.js +32 -0
- package/dist/esm/versions/v1/api/tasks-api.d.ts +97 -1
- package/dist/esm/versions/v1/api/tasks-api.js +141 -0
- package/dist/esm/versions/v1/api/user-connections-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/user-connections-api.js +25 -0
- package/dist/esm/versions/v1/api/user-settings-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/user-settings-api.js +25 -0
- package/dist/esm/versions/v1/api/users-api.d.ts +181 -1
- package/dist/esm/versions/v1/api/users-api.js +270 -0
- package/dist/esm/versions/v1/api/webhooks-api.d.ts +53 -1
- package/dist/esm/versions/v1/api/webhooks-api.js +79 -0
- package/dist/esm/versions/v1/base.d.ts +17 -0
- package/dist/esm/versions/v1/base.js +22 -0
- package/dist/esm/versions/v1/common.d.ts +1 -1
- package/dist/esm/versions/v1/common.js +7 -4
- package/dist/esm/versions/v2/api/activities-api.d.ts +107 -1
- package/dist/esm/versions/v2/api/activities-api.js +151 -0
- package/dist/esm/versions/v2/api/activity-fields-api.d.ts +40 -1
- package/dist/esm/versions/v2/api/activity-fields-api.js +57 -0
- package/dist/esm/versions/v2/api/beta-api.d.ts +451 -1
- package/dist/esm/versions/v2/api/beta-api.js +666 -0
- package/dist/esm/versions/v2/api/deal-fields-api.d.ts +152 -1
- package/dist/esm/versions/v2/api/deal-fields-api.js +223 -0
- package/dist/esm/versions/v2/api/deal-installments-api.d.ts +81 -1
- package/dist/esm/versions/v2/api/deal-installments-api.js +116 -0
- package/dist/esm/versions/v2/api/deal-products-api.d.ts +141 -1
- package/dist/esm/versions/v2/api/deal-products-api.js +203 -0
- package/dist/esm/versions/v2/api/deals-api.d.ts +363 -1
- package/dist/esm/versions/v2/api/deals-api.js +516 -1
- package/dist/esm/versions/v2/api/item-search-api.d.ts +49 -1
- package/dist/esm/versions/v2/api/item-search-api.js +66 -0
- package/dist/esm/versions/v2/api/leads-api.d.ts +64 -1
- package/dist/esm/versions/v2/api/leads-api.js +90 -0
- package/dist/esm/versions/v2/api/organization-fields-api.d.ts +152 -1
- package/dist/esm/versions/v2/api/organization-fields-api.js +223 -0
- package/dist/esm/versions/v2/api/organizations-api.d.ts +208 -1
- package/dist/esm/versions/v2/api/organizations-api.js +297 -0
- package/dist/esm/versions/v2/api/person-fields-api.d.ts +152 -1
- package/dist/esm/versions/v2/api/person-fields-api.js +223 -0
- package/dist/esm/versions/v2/api/persons-api.d.ts +230 -1
- package/dist/esm/versions/v2/api/persons-api.js +328 -0
- package/dist/esm/versions/v2/api/pipelines-api.d.ts +95 -1
- package/dist/esm/versions/v2/api/pipelines-api.js +139 -0
- package/dist/esm/versions/v2/api/product-fields-api.d.ts +152 -1
- package/dist/esm/versions/v2/api/product-fields-api.js +223 -0
- package/dist/esm/versions/v2/api/products-api.d.ts +371 -1
- package/dist/esm/versions/v2/api/products-api.js +541 -0
- package/dist/esm/versions/v2/api/project-boards-api.d.ts +90 -1
- package/dist/esm/versions/v2/api/project-boards-api.js +134 -0
- package/dist/esm/versions/v2/api/project-fields-api.d.ts +150 -1
- package/dist/esm/versions/v2/api/project-fields-api.js +221 -0
- package/dist/esm/versions/v2/api/project-phases-api.d.ts +92 -1
- package/dist/esm/versions/v2/api/project-phases-api.js +136 -0
- package/dist/esm/versions/v2/api/project-templates-api.d.ts +38 -1
- package/dist/esm/versions/v2/api/project-templates-api.js +55 -0
- package/dist/esm/versions/v2/api/projects-api.d.ts +201 -1
- package/dist/esm/versions/v2/api/projects-api.js +290 -0
- package/dist/esm/versions/v2/api/stages-api.d.ts +96 -1
- package/dist/esm/versions/v2/api/stages-api.js +140 -0
- package/dist/esm/versions/v2/api/tasks-api.d.ts +98 -1
- package/dist/esm/versions/v2/api/tasks-api.js +142 -0
- package/dist/esm/versions/v2/api/users-api.d.ts +21 -1
- package/dist/esm/versions/v2/api/users-api.js +29 -0
- package/dist/esm/versions/v2/base.d.ts +17 -0
- package/dist/esm/versions/v2/base.js +22 -0
- package/dist/esm/versions/v2/common.d.ts +1 -1
- package/dist/esm/versions/v2/common.js +7 -4
- package/dist/versions/v1/api/activity-fields-api.d.ts +17 -1
- package/dist/versions/v1/api/activity-fields-api.js +25 -0
- package/dist/versions/v1/api/activity-types-api.d.ts +72 -1
- package/dist/versions/v1/api/activity-types-api.js +107 -0
- package/dist/versions/v1/api/billing-api.d.ts +17 -1
- package/dist/versions/v1/api/billing-api.js +25 -0
- package/dist/versions/v1/api/call-logs-api.d.ts +93 -1
- package/dist/versions/v1/api/call-logs-api.js +137 -0
- package/dist/versions/v1/api/channels-api.d.ts +74 -1
- package/dist/versions/v1/api/channels-api.js +109 -0
- package/dist/versions/v1/api/currencies-api.d.ts +19 -1
- package/dist/versions/v1/api/currencies-api.js +27 -0
- package/dist/versions/v1/api/deal-fields-api.d.ts +111 -1
- package/dist/versions/v1/api/deal-fields-api.js +164 -0
- package/dist/versions/v1/api/deals-api.d.ts +399 -1
- package/dist/versions/v1/api/deals-api.js +569 -0
- package/dist/versions/v1/api/files-api.d.ts +163 -1
- package/dist/versions/v1/api/files-api.js +234 -0
- package/dist/versions/v1/api/filters-api.d.ts +129 -1
- package/dist/versions/v1/api/filters-api.js +191 -0
- package/dist/versions/v1/api/goals-api.d.ts +106 -1
- package/dist/versions/v1/api/goals-api.js +150 -0
- package/dist/versions/v1/api/lead-fields-api.d.ts +20 -1
- package/dist/versions/v1/api/lead-fields-api.js +28 -0
- package/dist/versions/v1/api/lead-labels-api.d.ts +72 -1
- package/dist/versions/v1/api/lead-labels-api.js +107 -0
- package/dist/versions/v1/api/lead-sources-api.d.ts +17 -1
- package/dist/versions/v1/api/lead-sources-api.js +25 -0
- package/dist/versions/v1/api/leads-api.d.ts +166 -1
- package/dist/versions/v1/api/leads-api.js +237 -0
- package/dist/versions/v1/api/legacy-teams-api.d.ts +152 -1
- package/dist/versions/v1/api/legacy-teams-api.js +223 -0
- package/dist/versions/v1/api/mailbox-api.d.ts +117 -1
- package/dist/versions/v1/api/mailbox-api.js +170 -0
- package/dist/versions/v1/api/meetings-api.d.ts +37 -1
- package/dist/versions/v1/api/meetings-api.js +54 -0
- package/dist/versions/v1/api/note-fields-api.d.ts +17 -1
- package/dist/versions/v1/api/note-fields-api.js +25 -0
- package/dist/versions/v1/api/notes-api.d.ts +207 -1
- package/dist/versions/v1/api/notes-api.js +296 -0
- package/dist/versions/v1/api/organization-fields-api.d.ts +111 -1
- package/dist/versions/v1/api/organization-fields-api.js +164 -0
- package/dist/versions/v1/api/organization-relationships-api.d.ts +93 -1
- package/dist/versions/v1/api/organization-relationships-api.js +137 -0
- package/dist/versions/v1/api/organizations-api.d.ts +178 -1
- package/dist/versions/v1/api/organizations-api.js +258 -0
- package/dist/versions/v1/api/permission-sets-api.d.ts +57 -1
- package/dist/versions/v1/api/permission-sets-api.js +83 -0
- package/dist/versions/v1/api/person-fields-api.d.ts +111 -1
- package/dist/versions/v1/api/person-fields-api.js +164 -0
- package/dist/versions/v1/api/persons-api.d.ts +275 -37
- package/dist/versions/v1/api/persons-api.js +370 -24
- package/dist/versions/v1/api/pipelines-api.d.ts +69 -1
- package/dist/versions/v1/api/pipelines-api.js +95 -0
- package/dist/versions/v1/api/product-fields-api.d.ts +111 -1
- package/dist/versions/v1/api/product-fields-api.js +164 -0
- package/dist/versions/v1/api/products-api.d.ts +119 -1
- package/dist/versions/v1/api/products-api.js +172 -0
- package/dist/versions/v1/api/project-boards-api.d.ts +35 -1
- package/dist/versions/v1/api/project-boards-api.js +52 -0
- package/dist/versions/v1/api/project-phases-api.d.ts +37 -1
- package/dist/versions/v1/api/project-phases-api.js +54 -0
- package/dist/versions/v1/api/project-templates-api.d.ts +38 -1
- package/dist/versions/v1/api/project-templates-api.js +55 -0
- package/dist/versions/v1/api/projects-api.d.ts +227 -1
- package/dist/versions/v1/api/projects-api.js +334 -0
- package/dist/versions/v1/api/recents-api.d.ts +22 -1
- package/dist/versions/v1/api/recents-api.js +30 -0
- package/dist/versions/v1/api/roles-api.d.ts +226 -1
- package/dist/versions/v1/api/roles-api.js +333 -0
- package/dist/versions/v1/api/stages-api.d.ts +24 -1
- package/dist/versions/v1/api/stages-api.js +32 -0
- package/dist/versions/v1/api/tasks-api.d.ts +97 -1
- package/dist/versions/v1/api/tasks-api.js +141 -0
- package/dist/versions/v1/api/user-connections-api.d.ts +17 -1
- package/dist/versions/v1/api/user-connections-api.js +25 -0
- package/dist/versions/v1/api/user-settings-api.d.ts +17 -1
- package/dist/versions/v1/api/user-settings-api.js +25 -0
- package/dist/versions/v1/api/users-api.d.ts +181 -1
- package/dist/versions/v1/api/users-api.js +270 -0
- package/dist/versions/v1/api/webhooks-api.d.ts +53 -1
- package/dist/versions/v1/api/webhooks-api.js +79 -0
- package/dist/versions/v1/base.d.ts +17 -0
- package/dist/versions/v1/base.js +24 -1
- package/dist/versions/v1/common.d.ts +1 -1
- package/dist/versions/v1/common.js +6 -3
- package/dist/versions/v2/api/activities-api.d.ts +107 -1
- package/dist/versions/v2/api/activities-api.js +151 -0
- package/dist/versions/v2/api/activity-fields-api.d.ts +40 -1
- package/dist/versions/v2/api/activity-fields-api.js +57 -0
- package/dist/versions/v2/api/beta-api.d.ts +451 -1
- package/dist/versions/v2/api/beta-api.js +666 -0
- package/dist/versions/v2/api/deal-fields-api.d.ts +152 -1
- package/dist/versions/v2/api/deal-fields-api.js +223 -0
- package/dist/versions/v2/api/deal-installments-api.d.ts +81 -1
- package/dist/versions/v2/api/deal-installments-api.js +116 -0
- package/dist/versions/v2/api/deal-products-api.d.ts +141 -1
- package/dist/versions/v2/api/deal-products-api.js +203 -0
- package/dist/versions/v2/api/deals-api.d.ts +363 -1
- package/dist/versions/v2/api/deals-api.js +516 -1
- package/dist/versions/v2/api/item-search-api.d.ts +49 -1
- package/dist/versions/v2/api/item-search-api.js +66 -0
- package/dist/versions/v2/api/leads-api.d.ts +64 -1
- package/dist/versions/v2/api/leads-api.js +90 -0
- package/dist/versions/v2/api/organization-fields-api.d.ts +152 -1
- package/dist/versions/v2/api/organization-fields-api.js +223 -0
- package/dist/versions/v2/api/organizations-api.d.ts +208 -1
- package/dist/versions/v2/api/organizations-api.js +297 -0
- package/dist/versions/v2/api/person-fields-api.d.ts +152 -1
- package/dist/versions/v2/api/person-fields-api.js +223 -0
- package/dist/versions/v2/api/persons-api.d.ts +230 -1
- package/dist/versions/v2/api/persons-api.js +328 -0
- package/dist/versions/v2/api/pipelines-api.d.ts +95 -1
- package/dist/versions/v2/api/pipelines-api.js +139 -0
- package/dist/versions/v2/api/product-fields-api.d.ts +152 -1
- package/dist/versions/v2/api/product-fields-api.js +223 -0
- package/dist/versions/v2/api/products-api.d.ts +371 -1
- package/dist/versions/v2/api/products-api.js +541 -0
- package/dist/versions/v2/api/project-boards-api.d.ts +90 -1
- package/dist/versions/v2/api/project-boards-api.js +134 -0
- package/dist/versions/v2/api/project-fields-api.d.ts +150 -1
- package/dist/versions/v2/api/project-fields-api.js +221 -0
- package/dist/versions/v2/api/project-phases-api.d.ts +92 -1
- package/dist/versions/v2/api/project-phases-api.js +136 -0
- package/dist/versions/v2/api/project-templates-api.d.ts +38 -1
- package/dist/versions/v2/api/project-templates-api.js +55 -0
- package/dist/versions/v2/api/projects-api.d.ts +201 -1
- package/dist/versions/v2/api/projects-api.js +290 -0
- package/dist/versions/v2/api/stages-api.d.ts +96 -1
- package/dist/versions/v2/api/stages-api.js +140 -0
- package/dist/versions/v2/api/tasks-api.d.ts +98 -1
- package/dist/versions/v2/api/tasks-api.js +142 -0
- package/dist/versions/v2/api/users-api.d.ts +21 -1
- package/dist/versions/v2/api/users-api.js +29 -0
- package/dist/versions/v2/base.d.ts +17 -0
- package/dist/versions/v2/base.js +24 -1
- package/dist/versions/v2/common.d.ts +1 -1
- package/dist/versions/v2/common.js +6 -3
- package/package.json +1 -1
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosInstance } from 'axios';
|
|
14
|
-
import { RequestArgs, BaseAPI } from '../base';
|
|
14
|
+
import { RequestArgs, BaseAPI, ApiResponse } from '../base';
|
|
15
15
|
import { AddDealFollowerRequest } from '../models';
|
|
16
16
|
import { AddFollowerResponse } from '../models';
|
|
17
17
|
import { AddPersonRequest } from '../models';
|
|
@@ -162,6 +162,14 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
162
162
|
* @throws {RequiredError}
|
|
163
163
|
*/
|
|
164
164
|
addPerson(AddPersonRequest?: AddPersonRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertPersonResponse>>;
|
|
165
|
+
/**
|
|
166
|
+
* Same as `addPerson`, but resolves with the response body together with the HTTP status and headers.
|
|
167
|
+
* @summary Add a new person
|
|
168
|
+
* @param {AddPersonRequest} [AddPersonRequest]
|
|
169
|
+
|
|
170
|
+
* @throws {RequiredError}
|
|
171
|
+
*/
|
|
172
|
+
addPersonWithHttpInfo(AddPersonRequest?: AddPersonRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpsertPersonResponse>>>;
|
|
165
173
|
/**
|
|
166
174
|
* Adds a user as a follower to the person.
|
|
167
175
|
* @summary Add a follower to a person
|
|
@@ -171,6 +179,15 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
171
179
|
* @throws {RequiredError}
|
|
172
180
|
*/
|
|
173
181
|
addPersonFollower(id: number, AddDealFollowerRequest?: AddDealFollowerRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFollowerResponse>>;
|
|
182
|
+
/**
|
|
183
|
+
* Same as `addPersonFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
184
|
+
* @summary Add a follower to a person
|
|
185
|
+
* @param {number} id The ID of the person
|
|
186
|
+
* @param {AddDealFollowerRequest} [AddDealFollowerRequest]
|
|
187
|
+
|
|
188
|
+
* @throws {RequiredError}
|
|
189
|
+
*/
|
|
190
|
+
addPersonFollowerWithHttpInfo(id: number, AddDealFollowerRequest?: AddDealFollowerRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddFollowerResponse>>>;
|
|
174
191
|
/**
|
|
175
192
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
|
176
193
|
* @summary Delete a person
|
|
@@ -179,6 +196,14 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
179
196
|
* @throws {RequiredError}
|
|
180
197
|
*/
|
|
181
198
|
deletePerson(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeletePersonResponse>>;
|
|
199
|
+
/**
|
|
200
|
+
* Same as `deletePerson`, but resolves with the response body together with the HTTP status and headers.
|
|
201
|
+
* @summary Delete a person
|
|
202
|
+
* @param {number} id The ID of the person
|
|
203
|
+
|
|
204
|
+
* @throws {RequiredError}
|
|
205
|
+
*/
|
|
206
|
+
deletePersonWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<DeletePersonResponse>>>;
|
|
182
207
|
/**
|
|
183
208
|
* Deletes a user follower from the person.
|
|
184
209
|
* @summary Delete a follower from a person
|
|
@@ -188,6 +213,15 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
188
213
|
* @throws {RequiredError}
|
|
189
214
|
*/
|
|
190
215
|
deletePersonFollower(id: number, follower_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFollowerResponse>>;
|
|
216
|
+
/**
|
|
217
|
+
* Same as `deletePersonFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
218
|
+
* @summary Delete a follower from a person
|
|
219
|
+
* @param {number} id The ID of the person
|
|
220
|
+
* @param {number} follower_id The ID of the following user
|
|
221
|
+
|
|
222
|
+
* @throws {RequiredError}
|
|
223
|
+
*/
|
|
224
|
+
deletePersonFollowerWithHttpInfo(id: number, follower_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<DeleteFollowerResponse>>>;
|
|
191
225
|
/**
|
|
192
226
|
* 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.
|
|
193
227
|
* @summary Get details of a person
|
|
@@ -200,6 +234,18 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
200
234
|
* @throws {RequiredError}
|
|
201
235
|
*/
|
|
202
236
|
getPerson(id: number, include_fields?: Set<'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' | 'smart_bcc_email'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertPersonResponse>>;
|
|
237
|
+
/**
|
|
238
|
+
* Same as `getPerson`, but resolves with the response body together with the HTTP status and headers.
|
|
239
|
+
* @summary Get details of a person
|
|
240
|
+
* @param {number} id The ID of the person
|
|
241
|
+
* @param {Set<'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' | 'smart_bcc_email'>} [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.
|
|
242
|
+
* @param {Set<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.
|
|
243
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
244
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
245
|
+
|
|
246
|
+
* @throws {RequiredError}
|
|
247
|
+
*/
|
|
248
|
+
getPersonWithHttpInfo(id: number, include_fields?: Set<'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' | 'smart_bcc_email'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpsertPersonResponse>>>;
|
|
203
249
|
/**
|
|
204
250
|
* Lists users who are following the person.
|
|
205
251
|
* @summary List followers of a person
|
|
@@ -210,6 +256,16 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
210
256
|
* @throws {RequiredError}
|
|
211
257
|
*/
|
|
212
258
|
getPersonFollowers(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFollowersResponse>>;
|
|
259
|
+
/**
|
|
260
|
+
* Same as `getPersonFollowers`, but resolves with the response body together with the HTTP status and headers.
|
|
261
|
+
* @summary List followers of a person
|
|
262
|
+
* @param {number} id The ID of the person
|
|
263
|
+
* @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.
|
|
264
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
265
|
+
|
|
266
|
+
* @throws {RequiredError}
|
|
267
|
+
*/
|
|
268
|
+
getPersonFollowersWithHttpInfo(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetFollowersResponse>>>;
|
|
213
269
|
/**
|
|
214
270
|
* Lists changelogs about users have followed the person.
|
|
215
271
|
* @summary List followers changelog of a person
|
|
@@ -220,6 +276,16 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
220
276
|
* @throws {RequiredError}
|
|
221
277
|
*/
|
|
222
278
|
getPersonFollowersChangelog(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFollowerChangelogsResponse>>;
|
|
279
|
+
/**
|
|
280
|
+
* Same as `getPersonFollowersChangelog`, but resolves with the response body together with the HTTP status and headers.
|
|
281
|
+
* @summary List followers changelog of a person
|
|
282
|
+
* @param {number} id The ID of the person
|
|
283
|
+
* @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.
|
|
284
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
285
|
+
|
|
286
|
+
* @throws {RequiredError}
|
|
287
|
+
*/
|
|
288
|
+
getPersonFollowersChangelogWithHttpInfo(id: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetFollowerChangelogsResponse>>>;
|
|
223
289
|
/**
|
|
224
290
|
* Returns the picture associated with a person. The picture URLs include both 128x128 and 512x512 pixel versions.
|
|
225
291
|
* @summary Get picture of a person
|
|
@@ -228,6 +294,14 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
228
294
|
* @throws {RequiredError}
|
|
229
295
|
*/
|
|
230
296
|
getPersonPicture(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonPictureResponse>>;
|
|
297
|
+
/**
|
|
298
|
+
* Same as `getPersonPicture`, but resolves with the response body together with the HTTP status and headers.
|
|
299
|
+
* @summary Get picture of a person
|
|
300
|
+
* @param {number} id The ID of the person
|
|
301
|
+
|
|
302
|
+
* @throws {RequiredError}
|
|
303
|
+
*/
|
|
304
|
+
getPersonPictureWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetPersonPictureResponse>>>;
|
|
231
305
|
/**
|
|
232
306
|
* 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.
|
|
233
307
|
* @summary Get all persons
|
|
@@ -250,6 +324,28 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
250
324
|
* @throws {RequiredError}
|
|
251
325
|
*/
|
|
252
326
|
getPersons(filter_id?: number, ids?: Set<number>, owner_id?: number, org_id?: number, deal_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'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' | 'smart_bcc_email'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonsResponse>>;
|
|
327
|
+
/**
|
|
328
|
+
* Same as `getPersons`, but resolves with the response body together with the HTTP status and headers.
|
|
329
|
+
* @summary Get all persons
|
|
330
|
+
* @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
|
|
331
|
+
* @param {Set<number>} [ids] Optional comma separated 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.
|
|
332
|
+
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
333
|
+
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
334
|
+
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
335
|
+
* @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.
|
|
336
|
+
* @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.
|
|
337
|
+
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
338
|
+
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
339
|
+
* @param {Set<'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' | 'smart_bcc_email'>} [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.
|
|
340
|
+
* @param {Set<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.
|
|
341
|
+
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
342
|
+
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
343
|
+
* @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.
|
|
344
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
345
|
+
|
|
346
|
+
* @throws {RequiredError}
|
|
347
|
+
*/
|
|
348
|
+
getPersonsWithHttpInfo(filter_id?: number, ids?: Set<number>, owner_id?: number, org_id?: number, deal_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'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' | 'smart_bcc_email'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetPersonsResponse>>>;
|
|
253
349
|
/**
|
|
254
350
|
* 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.
|
|
255
351
|
* @summary Search persons
|
|
@@ -264,6 +360,20 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
264
360
|
* @throws {RequiredError}
|
|
265
361
|
*/
|
|
266
362
|
searchPersons(term: string, fields?: Set<'custom_fields' | 'email' | 'notes' | 'phone' | 'name'>, exact_match?: boolean, organization_id?: number, include_fields?: Set<'person.picture'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonSearchResponse>>;
|
|
363
|
+
/**
|
|
364
|
+
* Same as `searchPersons`, but resolves with the response body together with the HTTP status and headers.
|
|
365
|
+
* @summary Search persons
|
|
366
|
+
* @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.
|
|
367
|
+
* @param {Set<'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>.
|
|
368
|
+
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
369
|
+
* @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
|
|
370
|
+
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
371
|
+
* @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 100 is allowed.
|
|
372
|
+
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
373
|
+
|
|
374
|
+
* @throws {RequiredError}
|
|
375
|
+
*/
|
|
376
|
+
searchPersonsWithHttpInfo(term: string, fields?: Set<'custom_fields' | 'email' | 'notes' | 'phone' | 'name'>, exact_match?: boolean, organization_id?: number, include_fields?: Set<'person.picture'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetPersonSearchResponse>>>;
|
|
267
377
|
/**
|
|
268
378
|
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
269
379
|
* @summary Update a person
|
|
@@ -273,6 +383,15 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
273
383
|
* @throws {RequiredError}
|
|
274
384
|
*/
|
|
275
385
|
updatePerson(id: number, UpdatePersonRequest?: UpdatePersonRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertPersonResponse>>;
|
|
386
|
+
/**
|
|
387
|
+
* Same as `updatePerson`, but resolves with the response body together with the HTTP status and headers.
|
|
388
|
+
* @summary Update a person
|
|
389
|
+
* @param {number} id The ID of the person
|
|
390
|
+
* @param {UpdatePersonRequest} [UpdatePersonRequest]
|
|
391
|
+
|
|
392
|
+
* @throws {RequiredError}
|
|
393
|
+
*/
|
|
394
|
+
updatePersonWithHttpInfo(id: number, UpdatePersonRequest?: UpdatePersonRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpsertPersonResponse>>>;
|
|
276
395
|
};
|
|
277
396
|
/**
|
|
278
397
|
* PersonsApi - factory interface
|
|
@@ -287,6 +406,7 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
|
287
406
|
* @throws {RequiredError}
|
|
288
407
|
*/
|
|
289
408
|
addPerson(requestParameters?: PersonsApiAddPersonRequest): Promise<UpsertPersonResponse>;
|
|
409
|
+
addPersonWithHttpInfo(requestParameters?: PersonsApiAddPersonRequest): Promise<ApiResponse<UpsertPersonResponse>>;
|
|
290
410
|
/**
|
|
291
411
|
* Adds a user as a follower to the person.
|
|
292
412
|
* @summary Add a follower to a person
|
|
@@ -295,6 +415,7 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
|
295
415
|
* @throws {RequiredError}
|
|
296
416
|
*/
|
|
297
417
|
addPersonFollower(requestParameters: PersonsApiAddPersonFollowerRequest): Promise<AddFollowerResponse>;
|
|
418
|
+
addPersonFollowerWithHttpInfo(requestParameters: PersonsApiAddPersonFollowerRequest): Promise<ApiResponse<AddFollowerResponse>>;
|
|
298
419
|
/**
|
|
299
420
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
|
300
421
|
* @summary Delete a person
|
|
@@ -303,6 +424,7 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
|
303
424
|
* @throws {RequiredError}
|
|
304
425
|
*/
|
|
305
426
|
deletePerson(requestParameters: PersonsApiDeletePersonRequest): Promise<DeletePersonResponse>;
|
|
427
|
+
deletePersonWithHttpInfo(requestParameters: PersonsApiDeletePersonRequest): Promise<ApiResponse<DeletePersonResponse>>;
|
|
306
428
|
/**
|
|
307
429
|
* Deletes a user follower from the person.
|
|
308
430
|
* @summary Delete a follower from a person
|
|
@@ -311,6 +433,7 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
|
311
433
|
* @throws {RequiredError}
|
|
312
434
|
*/
|
|
313
435
|
deletePersonFollower(requestParameters: PersonsApiDeletePersonFollowerRequest): Promise<DeleteFollowerResponse>;
|
|
436
|
+
deletePersonFollowerWithHttpInfo(requestParameters: PersonsApiDeletePersonFollowerRequest): Promise<ApiResponse<DeleteFollowerResponse>>;
|
|
314
437
|
/**
|
|
315
438
|
* 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.
|
|
316
439
|
* @summary Get details of a person
|
|
@@ -319,6 +442,7 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
|
319
442
|
* @throws {RequiredError}
|
|
320
443
|
*/
|
|
321
444
|
getPerson(requestParameters: PersonsApiGetPersonRequest): Promise<UpsertPersonResponse>;
|
|
445
|
+
getPersonWithHttpInfo(requestParameters: PersonsApiGetPersonRequest): Promise<ApiResponse<UpsertPersonResponse>>;
|
|
322
446
|
/**
|
|
323
447
|
* Lists users who are following the person.
|
|
324
448
|
* @summary List followers of a person
|
|
@@ -327,6 +451,7 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
|
327
451
|
* @throws {RequiredError}
|
|
328
452
|
*/
|
|
329
453
|
getPersonFollowers(requestParameters: PersonsApiGetPersonFollowersRequest): Promise<GetFollowersResponse>;
|
|
454
|
+
getPersonFollowersWithHttpInfo(requestParameters: PersonsApiGetPersonFollowersRequest): Promise<ApiResponse<GetFollowersResponse>>;
|
|
330
455
|
/**
|
|
331
456
|
* Lists changelogs about users have followed the person.
|
|
332
457
|
* @summary List followers changelog of a person
|
|
@@ -335,6 +460,7 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
|
335
460
|
* @throws {RequiredError}
|
|
336
461
|
*/
|
|
337
462
|
getPersonFollowersChangelog(requestParameters: PersonsApiGetPersonFollowersChangelogRequest): Promise<GetFollowerChangelogsResponse>;
|
|
463
|
+
getPersonFollowersChangelogWithHttpInfo(requestParameters: PersonsApiGetPersonFollowersChangelogRequest): Promise<ApiResponse<GetFollowerChangelogsResponse>>;
|
|
338
464
|
/**
|
|
339
465
|
* Returns the picture associated with a person. The picture URLs include both 128x128 and 512x512 pixel versions.
|
|
340
466
|
* @summary Get picture of a person
|
|
@@ -343,6 +469,7 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
|
343
469
|
* @throws {RequiredError}
|
|
344
470
|
*/
|
|
345
471
|
getPersonPicture(requestParameters: PersonsApiGetPersonPictureRequest): Promise<GetPersonPictureResponse>;
|
|
472
|
+
getPersonPictureWithHttpInfo(requestParameters: PersonsApiGetPersonPictureRequest): Promise<ApiResponse<GetPersonPictureResponse>>;
|
|
346
473
|
/**
|
|
347
474
|
* 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.
|
|
348
475
|
* @summary Get all persons
|
|
@@ -351,6 +478,7 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
|
351
478
|
* @throws {RequiredError}
|
|
352
479
|
*/
|
|
353
480
|
getPersons(requestParameters?: PersonsApiGetPersonsRequest): Promise<GetPersonsResponse>;
|
|
481
|
+
getPersonsWithHttpInfo(requestParameters?: PersonsApiGetPersonsRequest): Promise<ApiResponse<GetPersonsResponse>>;
|
|
354
482
|
/**
|
|
355
483
|
* 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.
|
|
356
484
|
* @summary Search persons
|
|
@@ -359,6 +487,7 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
|
359
487
|
* @throws {RequiredError}
|
|
360
488
|
*/
|
|
361
489
|
searchPersons(requestParameters: PersonsApiSearchPersonsRequest): Promise<GetPersonSearchResponse>;
|
|
490
|
+
searchPersonsWithHttpInfo(requestParameters: PersonsApiSearchPersonsRequest): Promise<ApiResponse<GetPersonSearchResponse>>;
|
|
362
491
|
/**
|
|
363
492
|
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
364
493
|
* @summary Update a person
|
|
@@ -367,6 +496,7 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
|
367
496
|
* @throws {RequiredError}
|
|
368
497
|
*/
|
|
369
498
|
updatePerson(requestParameters: PersonsApiUpdatePersonRequest): Promise<UpsertPersonResponse>;
|
|
499
|
+
updatePersonWithHttpInfo(requestParameters: PersonsApiUpdatePersonRequest): Promise<ApiResponse<UpsertPersonResponse>>;
|
|
370
500
|
};
|
|
371
501
|
/**
|
|
372
502
|
* Request parameters for addPerson operation in PersonsApi.
|
|
@@ -713,6 +843,15 @@ export declare class PersonsApi extends BaseAPI {
|
|
|
713
843
|
* @memberof PersonsApi
|
|
714
844
|
*/
|
|
715
845
|
addPerson(requestParameters?: PersonsApiAddPersonRequest): Promise<UpsertPersonResponse>;
|
|
846
|
+
/**
|
|
847
|
+
* Same as `addPerson`, but resolves with the response body together with the HTTP status and headers.
|
|
848
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
849
|
+
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
|
850
|
+
|
|
851
|
+
* @throws {RequiredError}
|
|
852
|
+
* @memberof PersonsApi
|
|
853
|
+
*/
|
|
854
|
+
addPersonWithHttpInfo(requestParameters?: PersonsApiAddPersonRequest): Promise<ApiResponse<UpsertPersonResponse>>;
|
|
716
855
|
/**
|
|
717
856
|
* Adds a user as a follower to the person.
|
|
718
857
|
* @summary Add a follower to a person
|
|
@@ -722,6 +861,15 @@ export declare class PersonsApi extends BaseAPI {
|
|
|
722
861
|
* @memberof PersonsApi
|
|
723
862
|
*/
|
|
724
863
|
addPersonFollower(requestParameters: PersonsApiAddPersonFollowerRequest): Promise<AddFollowerResponse>;
|
|
864
|
+
/**
|
|
865
|
+
* Same as `addPersonFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
866
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
867
|
+
* @param {PersonsApiAddPersonFollowerRequest} requestParameters Request parameters.
|
|
868
|
+
|
|
869
|
+
* @throws {RequiredError}
|
|
870
|
+
* @memberof PersonsApi
|
|
871
|
+
*/
|
|
872
|
+
addPersonFollowerWithHttpInfo(requestParameters: PersonsApiAddPersonFollowerRequest): Promise<ApiResponse<AddFollowerResponse>>;
|
|
725
873
|
/**
|
|
726
874
|
* Marks a person as deleted. After 30 days, the person will be permanently deleted.
|
|
727
875
|
* @summary Delete a person
|
|
@@ -731,6 +879,15 @@ export declare class PersonsApi extends BaseAPI {
|
|
|
731
879
|
* @memberof PersonsApi
|
|
732
880
|
*/
|
|
733
881
|
deletePerson(requestParameters: PersonsApiDeletePersonRequest): Promise<DeletePersonResponse>;
|
|
882
|
+
/**
|
|
883
|
+
* Same as `deletePerson`, but resolves with the response body together with the HTTP status and headers.
|
|
884
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
885
|
+
* @param {PersonsApiDeletePersonRequest} requestParameters Request parameters.
|
|
886
|
+
|
|
887
|
+
* @throws {RequiredError}
|
|
888
|
+
* @memberof PersonsApi
|
|
889
|
+
*/
|
|
890
|
+
deletePersonWithHttpInfo(requestParameters: PersonsApiDeletePersonRequest): Promise<ApiResponse<DeletePersonResponse>>;
|
|
734
891
|
/**
|
|
735
892
|
* Deletes a user follower from the person.
|
|
736
893
|
* @summary Delete a follower from a person
|
|
@@ -740,6 +897,15 @@ export declare class PersonsApi extends BaseAPI {
|
|
|
740
897
|
* @memberof PersonsApi
|
|
741
898
|
*/
|
|
742
899
|
deletePersonFollower(requestParameters: PersonsApiDeletePersonFollowerRequest): Promise<DeleteFollowerResponse>;
|
|
900
|
+
/**
|
|
901
|
+
* Same as `deletePersonFollower`, but resolves with the response body together with the HTTP status and headers.
|
|
902
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
903
|
+
* @param {PersonsApiDeletePersonFollowerRequest} requestParameters Request parameters.
|
|
904
|
+
|
|
905
|
+
* @throws {RequiredError}
|
|
906
|
+
* @memberof PersonsApi
|
|
907
|
+
*/
|
|
908
|
+
deletePersonFollowerWithHttpInfo(requestParameters: PersonsApiDeletePersonFollowerRequest): Promise<ApiResponse<DeleteFollowerResponse>>;
|
|
743
909
|
/**
|
|
744
910
|
* 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.
|
|
745
911
|
* @summary Get details of a person
|
|
@@ -749,6 +915,15 @@ export declare class PersonsApi extends BaseAPI {
|
|
|
749
915
|
* @memberof PersonsApi
|
|
750
916
|
*/
|
|
751
917
|
getPerson(requestParameters: PersonsApiGetPersonRequest): Promise<UpsertPersonResponse>;
|
|
918
|
+
/**
|
|
919
|
+
* Same as `getPerson`, but resolves with the response body together with the HTTP status and headers.
|
|
920
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
921
|
+
* @param {PersonsApiGetPersonRequest} requestParameters Request parameters.
|
|
922
|
+
|
|
923
|
+
* @throws {RequiredError}
|
|
924
|
+
* @memberof PersonsApi
|
|
925
|
+
*/
|
|
926
|
+
getPersonWithHttpInfo(requestParameters: PersonsApiGetPersonRequest): Promise<ApiResponse<UpsertPersonResponse>>;
|
|
752
927
|
/**
|
|
753
928
|
* Lists users who are following the person.
|
|
754
929
|
* @summary List followers of a person
|
|
@@ -758,6 +933,15 @@ export declare class PersonsApi extends BaseAPI {
|
|
|
758
933
|
* @memberof PersonsApi
|
|
759
934
|
*/
|
|
760
935
|
getPersonFollowers(requestParameters: PersonsApiGetPersonFollowersRequest): Promise<GetFollowersResponse>;
|
|
936
|
+
/**
|
|
937
|
+
* Same as `getPersonFollowers`, but resolves with the response body together with the HTTP status and headers.
|
|
938
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
939
|
+
* @param {PersonsApiGetPersonFollowersRequest} requestParameters Request parameters.
|
|
940
|
+
|
|
941
|
+
* @throws {RequiredError}
|
|
942
|
+
* @memberof PersonsApi
|
|
943
|
+
*/
|
|
944
|
+
getPersonFollowersWithHttpInfo(requestParameters: PersonsApiGetPersonFollowersRequest): Promise<ApiResponse<GetFollowersResponse>>;
|
|
761
945
|
/**
|
|
762
946
|
* Lists changelogs about users have followed the person.
|
|
763
947
|
* @summary List followers changelog of a person
|
|
@@ -767,6 +951,15 @@ export declare class PersonsApi extends BaseAPI {
|
|
|
767
951
|
* @memberof PersonsApi
|
|
768
952
|
*/
|
|
769
953
|
getPersonFollowersChangelog(requestParameters: PersonsApiGetPersonFollowersChangelogRequest): Promise<GetFollowerChangelogsResponse>;
|
|
954
|
+
/**
|
|
955
|
+
* Same as `getPersonFollowersChangelog`, but resolves with the response body together with the HTTP status and headers.
|
|
956
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
957
|
+
* @param {PersonsApiGetPersonFollowersChangelogRequest} requestParameters Request parameters.
|
|
958
|
+
|
|
959
|
+
* @throws {RequiredError}
|
|
960
|
+
* @memberof PersonsApi
|
|
961
|
+
*/
|
|
962
|
+
getPersonFollowersChangelogWithHttpInfo(requestParameters: PersonsApiGetPersonFollowersChangelogRequest): Promise<ApiResponse<GetFollowerChangelogsResponse>>;
|
|
770
963
|
/**
|
|
771
964
|
* Returns the picture associated with a person. The picture URLs include both 128x128 and 512x512 pixel versions.
|
|
772
965
|
* @summary Get picture of a person
|
|
@@ -776,6 +969,15 @@ export declare class PersonsApi extends BaseAPI {
|
|
|
776
969
|
* @memberof PersonsApi
|
|
777
970
|
*/
|
|
778
971
|
getPersonPicture(requestParameters: PersonsApiGetPersonPictureRequest): Promise<GetPersonPictureResponse>;
|
|
972
|
+
/**
|
|
973
|
+
* Same as `getPersonPicture`, but resolves with the response body together with the HTTP status and headers.
|
|
974
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
975
|
+
* @param {PersonsApiGetPersonPictureRequest} requestParameters Request parameters.
|
|
976
|
+
|
|
977
|
+
* @throws {RequiredError}
|
|
978
|
+
* @memberof PersonsApi
|
|
979
|
+
*/
|
|
980
|
+
getPersonPictureWithHttpInfo(requestParameters: PersonsApiGetPersonPictureRequest): Promise<ApiResponse<GetPersonPictureResponse>>;
|
|
779
981
|
/**
|
|
780
982
|
* 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.
|
|
781
983
|
* @summary Get all persons
|
|
@@ -785,6 +987,15 @@ export declare class PersonsApi extends BaseAPI {
|
|
|
785
987
|
* @memberof PersonsApi
|
|
786
988
|
*/
|
|
787
989
|
getPersons(requestParameters?: PersonsApiGetPersonsRequest): Promise<GetPersonsResponse>;
|
|
990
|
+
/**
|
|
991
|
+
* Same as `getPersons`, but resolves with the response body together with the HTTP status and headers.
|
|
992
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
993
|
+
* @param {PersonsApiGetPersonsRequest} requestParameters Request parameters.
|
|
994
|
+
|
|
995
|
+
* @throws {RequiredError}
|
|
996
|
+
* @memberof PersonsApi
|
|
997
|
+
*/
|
|
998
|
+
getPersonsWithHttpInfo(requestParameters?: PersonsApiGetPersonsRequest): Promise<ApiResponse<GetPersonsResponse>>;
|
|
788
999
|
/**
|
|
789
1000
|
* 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.
|
|
790
1001
|
* @summary Search persons
|
|
@@ -794,6 +1005,15 @@ export declare class PersonsApi extends BaseAPI {
|
|
|
794
1005
|
* @memberof PersonsApi
|
|
795
1006
|
*/
|
|
796
1007
|
searchPersons(requestParameters: PersonsApiSearchPersonsRequest): Promise<GetPersonSearchResponse>;
|
|
1008
|
+
/**
|
|
1009
|
+
* Same as `searchPersons`, but resolves with the response body together with the HTTP status and headers.
|
|
1010
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1011
|
+
* @param {PersonsApiSearchPersonsRequest} requestParameters Request parameters.
|
|
1012
|
+
|
|
1013
|
+
* @throws {RequiredError}
|
|
1014
|
+
* @memberof PersonsApi
|
|
1015
|
+
*/
|
|
1016
|
+
searchPersonsWithHttpInfo(requestParameters: PersonsApiSearchPersonsRequest): Promise<ApiResponse<GetPersonSearchResponse>>;
|
|
797
1017
|
/**
|
|
798
1018
|
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
799
1019
|
* @summary Update a person
|
|
@@ -803,4 +1023,13 @@ export declare class PersonsApi extends BaseAPI {
|
|
|
803
1023
|
* @memberof PersonsApi
|
|
804
1024
|
*/
|
|
805
1025
|
updatePerson(requestParameters: PersonsApiUpdatePersonRequest): Promise<UpsertPersonResponse>;
|
|
1026
|
+
/**
|
|
1027
|
+
* Same as `updatePerson`, but resolves with the response body together with the HTTP status and headers.
|
|
1028
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
1029
|
+
* @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
|
|
1030
|
+
|
|
1031
|
+
* @throws {RequiredError}
|
|
1032
|
+
* @memberof PersonsApi
|
|
1033
|
+
*/
|
|
1034
|
+
updatePersonWithHttpInfo(requestParameters: PersonsApiUpdatePersonRequest): Promise<ApiResponse<UpsertPersonResponse>>;
|
|
806
1035
|
}
|