pipedrive 25.0.0 → 27.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 +47 -47
- package/dist/esm/versions/v1/api/activity-fields-api.js +1 -1
- package/dist/esm/versions/v1/api/activity-types-api.js +5 -5
- package/dist/esm/versions/v1/api/billing-api.js +1 -1
- package/dist/esm/versions/v1/api/call-logs-api.js +5 -5
- package/dist/esm/versions/v1/api/channels-api.js +4 -4
- package/dist/esm/versions/v1/api/currencies-api.js +1 -1
- package/dist/esm/versions/v1/api/deal-fields-api.js +6 -6
- package/dist/esm/versions/v1/api/deals-api.d.ts +410 -88
- package/dist/esm/versions/v1/api/deals-api.js +447 -118
- package/dist/esm/versions/v1/api/files-api.js +8 -8
- package/dist/esm/versions/v1/api/filters-api.js +7 -7
- package/dist/esm/versions/v1/api/goals-api.js +5 -5
- package/dist/esm/versions/v1/api/item-search-api.d.ts +8 -8
- package/dist/esm/versions/v1/api/item-search-api.js +10 -10
- package/dist/esm/versions/v1/api/lead-labels-api.js +4 -4
- package/dist/esm/versions/v1/api/lead-sources-api.js +1 -1
- package/dist/esm/versions/v1/api/leads-api.d.ts +100 -14
- package/dist/esm/versions/v1/api/leads-api.js +114 -21
- package/dist/esm/versions/v1/api/legacy-teams-api.js +8 -8
- package/dist/esm/versions/v1/api/mailbox-api.js +6 -6
- package/dist/esm/versions/v1/api/meetings-api.js +2 -2
- package/dist/esm/versions/v1/api/note-fields-api.js +1 -1
- package/dist/esm/versions/v1/api/notes-api.d.ts +18 -2
- package/dist/esm/versions/v1/api/notes-api.js +25 -15
- package/dist/esm/versions/v1/api/organization-fields-api.js +6 -6
- package/dist/esm/versions/v1/api/organization-relationships-api.js +5 -5
- package/dist/esm/versions/v1/api/organizations-api.d.ts +68 -68
- package/dist/esm/versions/v1/api/organizations-api.js +88 -88
- package/dist/esm/versions/v1/api/permission-sets-api.js +3 -3
- package/dist/esm/versions/v1/api/person-fields-api.js +6 -6
- package/dist/esm/versions/v1/api/persons-api.d.ts +56 -56
- package/dist/esm/versions/v1/api/persons-api.js +78 -78
- package/dist/esm/versions/v1/api/pipelines-api.d.ts +28 -28
- package/dist/esm/versions/v1/api/pipelines-api.js +36 -36
- package/dist/esm/versions/v1/api/product-fields-api.js +6 -6
- package/dist/esm/versions/v1/api/products-api.d.ts +24 -24
- package/dist/esm/versions/v1/api/products-api.js +36 -36
- package/dist/esm/versions/v1/api/project-templates-api.js +4 -4
- package/dist/esm/versions/v1/api/projects-api.js +14 -14
- package/dist/esm/versions/v1/api/recents-api.js +1 -1
- package/dist/esm/versions/v1/api/roles-api.js +12 -12
- package/dist/esm/versions/v1/api/stages-api.d.ts +36 -36
- package/dist/esm/versions/v1/api/stages-api.js +43 -43
- package/dist/esm/versions/v1/api/subscriptions-api.js +9 -9
- package/dist/esm/versions/v1/api/tasks-api.js +5 -5
- package/dist/esm/versions/v1/api/user-connections-api.js +1 -1
- package/dist/esm/versions/v1/api/user-settings-api.js +1 -1
- package/dist/esm/versions/v1/api/users-api.js +10 -10
- package/dist/esm/versions/v1/api/webhooks-api.js +3 -3
- 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/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/v2/api/activities-api.d.ts +15 -7
- package/dist/esm/versions/v2/api/activities-api.js +17 -12
- package/dist/esm/versions/v2/api/beta-api.d.ts +212 -0
- package/dist/esm/versions/v2/api/beta-api.js +290 -4
- package/dist/esm/versions/v2/api/deals-api.d.ts +272 -4
- package/dist/esm/versions/v2/api/deals-api.js +311 -27
- package/dist/esm/versions/v2/api/item-search-api.js +2 -2
- package/dist/esm/versions/v2/api/leads-api.d.ts +111 -0
- package/dist/esm/versions/v2/api/leads-api.js +147 -2
- package/dist/esm/versions/v2/api/organizations-api.js +10 -10
- package/dist/esm/versions/v2/api/persons-api.d.ts +8 -8
- package/dist/esm/versions/v2/api/persons-api.js +18 -18
- package/dist/esm/versions/v2/api/pipelines-api.js +5 -5
- package/dist/esm/versions/v2/api/products-api.js +15 -15
- package/dist/esm/versions/v2/api/stages-api.js +5 -5
- package/dist/esm/versions/v2/api/users-api.js +1 -1
- 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-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/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/index.d.ts +7 -0
- package/dist/esm/versions/v2/models/index.js +7 -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 +47 -47
- package/dist/versions/v1/api/activity-fields-api.js +1 -1
- package/dist/versions/v1/api/activity-types-api.js +5 -5
- package/dist/versions/v1/api/billing-api.js +1 -1
- package/dist/versions/v1/api/call-logs-api.js +5 -5
- package/dist/versions/v1/api/channels-api.js +4 -4
- package/dist/versions/v1/api/currencies-api.js +1 -1
- package/dist/versions/v1/api/deal-fields-api.js +6 -6
- package/dist/versions/v1/api/deals-api.d.ts +410 -88
- package/dist/versions/v1/api/deals-api.js +447 -118
- package/dist/versions/v1/api/files-api.js +8 -8
- package/dist/versions/v1/api/filters-api.js +7 -7
- package/dist/versions/v1/api/goals-api.js +5 -5
- package/dist/versions/v1/api/item-search-api.d.ts +8 -8
- package/dist/versions/v1/api/item-search-api.js +10 -10
- package/dist/versions/v1/api/lead-labels-api.js +4 -4
- package/dist/versions/v1/api/lead-sources-api.js +1 -1
- package/dist/versions/v1/api/leads-api.d.ts +100 -14
- package/dist/versions/v1/api/leads-api.js +114 -21
- package/dist/versions/v1/api/legacy-teams-api.js +8 -8
- package/dist/versions/v1/api/mailbox-api.js +6 -6
- package/dist/versions/v1/api/meetings-api.js +2 -2
- package/dist/versions/v1/api/note-fields-api.js +1 -1
- package/dist/versions/v1/api/notes-api.d.ts +18 -2
- package/dist/versions/v1/api/notes-api.js +25 -15
- package/dist/versions/v1/api/organization-fields-api.js +6 -6
- package/dist/versions/v1/api/organization-relationships-api.js +5 -5
- package/dist/versions/v1/api/organizations-api.d.ts +68 -68
- package/dist/versions/v1/api/organizations-api.js +88 -88
- package/dist/versions/v1/api/permission-sets-api.js +3 -3
- package/dist/versions/v1/api/person-fields-api.js +6 -6
- package/dist/versions/v1/api/persons-api.d.ts +56 -56
- package/dist/versions/v1/api/persons-api.js +78 -78
- package/dist/versions/v1/api/pipelines-api.d.ts +28 -28
- package/dist/versions/v1/api/pipelines-api.js +36 -36
- package/dist/versions/v1/api/product-fields-api.js +6 -6
- package/dist/versions/v1/api/products-api.d.ts +24 -24
- package/dist/versions/v1/api/products-api.js +36 -36
- package/dist/versions/v1/api/project-templates-api.js +4 -4
- package/dist/versions/v1/api/projects-api.js +14 -14
- package/dist/versions/v1/api/recents-api.js +1 -1
- package/dist/versions/v1/api/roles-api.js +12 -12
- package/dist/versions/v1/api/stages-api.d.ts +36 -36
- package/dist/versions/v1/api/stages-api.js +43 -43
- package/dist/versions/v1/api/subscriptions-api.js +9 -9
- package/dist/versions/v1/api/tasks-api.js +5 -5
- package/dist/versions/v1/api/user-connections-api.js +1 -1
- package/dist/versions/v1/api/user-settings-api.js +1 -1
- package/dist/versions/v1/api/users-api.js +10 -10
- package/dist/versions/v1/api/webhooks-api.js +3 -3
- 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/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/v2/api/activities-api.d.ts +15 -7
- package/dist/versions/v2/api/activities-api.js +17 -12
- package/dist/versions/v2/api/beta-api.d.ts +212 -0
- package/dist/versions/v2/api/beta-api.js +290 -4
- package/dist/versions/v2/api/deals-api.d.ts +272 -4
- package/dist/versions/v2/api/deals-api.js +311 -27
- package/dist/versions/v2/api/item-search-api.js +2 -2
- package/dist/versions/v2/api/leads-api.d.ts +111 -0
- package/dist/versions/v2/api/leads-api.js +146 -1
- package/dist/versions/v2/api/organizations-api.js +10 -10
- package/dist/versions/v2/api/persons-api.d.ts +8 -8
- package/dist/versions/v2/api/persons-api.js +18 -18
- package/dist/versions/v2/api/pipelines-api.js +5 -5
- package/dist/versions/v2/api/products-api.js +15 -15
- package/dist/versions/v2/api/stages-api.js +5 -5
- package/dist/versions/v2/api/users-api.js +1 -1
- 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-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/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/index.d.ts +7 -0
- package/dist/versions/v2/models/index.js +7 -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
@@ -36,7 +36,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
36
36
|
* Adds a new organization. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the organizationFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-an-organization\" target=\"_blank\" rel=\"noopener noreferrer\">adding an organization</a>.
|
37
37
|
* @summary Add an organization
|
38
38
|
* @param {AddOrganizationRequest} [AddOrganizationRequest]
|
39
|
-
|
39
|
+
* @deprecated
|
40
40
|
* @throws {RequiredError}
|
41
41
|
*/
|
42
42
|
addOrganization: (AddOrganizationRequest) => __awaiter(this, void 0, void 0, function* () {
|
@@ -51,7 +51,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
51
51
|
const localVarHeaderParameter = {};
|
52
52
|
const localVarQueryParameter = {};
|
53
53
|
// authentication api_key required
|
54
|
-
yield setApiKeyToObject(
|
54
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
55
55
|
// authentication oauth2 required
|
56
56
|
// oauth required
|
57
57
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full"], configuration);
|
@@ -88,7 +88,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
88
88
|
const localVarHeaderParameter = {};
|
89
89
|
const localVarQueryParameter = {};
|
90
90
|
// authentication api_key required
|
91
|
-
yield setApiKeyToObject(
|
91
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
92
92
|
// authentication oauth2 required
|
93
93
|
// oauth required
|
94
94
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full"], configuration);
|
@@ -106,7 +106,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
106
106
|
* Marks an organization as deleted. After 30 days, the organization will be permanently deleted.
|
107
107
|
* @summary Delete an organization
|
108
108
|
* @param {number} id The ID of the organization
|
109
|
-
|
109
|
+
* @deprecated
|
110
110
|
* @throws {RequiredError}
|
111
111
|
*/
|
112
112
|
deleteOrganization: (id) => __awaiter(this, void 0, void 0, function* () {
|
@@ -124,7 +124,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
124
124
|
const localVarHeaderParameter = {};
|
125
125
|
const localVarQueryParameter = {};
|
126
126
|
// authentication api_key required
|
127
|
-
yield setApiKeyToObject(
|
127
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
128
128
|
// authentication oauth2 required
|
129
129
|
// oauth required
|
130
130
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full"], configuration);
|
@@ -162,7 +162,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
162
162
|
const localVarHeaderParameter = {};
|
163
163
|
const localVarQueryParameter = {};
|
164
164
|
// authentication api_key required
|
165
|
-
yield setApiKeyToObject(
|
165
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
166
166
|
// authentication oauth2 required
|
167
167
|
// oauth required
|
168
168
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full"], configuration);
|
@@ -175,10 +175,10 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
175
175
|
};
|
176
176
|
}),
|
177
177
|
/**
|
178
|
-
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
|
178
|
+
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#deleteOrganization\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/organizations/{id}</a> instead.
|
179
179
|
* @summary Delete multiple organizations in bulk
|
180
180
|
* @param {string} ids The comma-separated IDs that will be deleted
|
181
|
-
|
181
|
+
* @deprecated
|
182
182
|
* @throws {RequiredError}
|
183
183
|
*/
|
184
184
|
deleteOrganizations: (ids) => __awaiter(this, void 0, void 0, function* () {
|
@@ -195,7 +195,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
195
195
|
const localVarHeaderParameter = {};
|
196
196
|
const localVarQueryParameter = {};
|
197
197
|
// authentication api_key required
|
198
|
-
yield setApiKeyToObject(
|
198
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
199
199
|
// authentication oauth2 required
|
200
200
|
// oauth required
|
201
201
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full"], configuration);
|
@@ -214,7 +214,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
214
214
|
* Returns the details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of organizationFields.
|
215
215
|
* @summary Get details of an organization
|
216
216
|
* @param {number} id The ID of the organization
|
217
|
-
|
217
|
+
* @deprecated
|
218
218
|
* @throws {RequiredError}
|
219
219
|
*/
|
220
220
|
getOrganization: (id) => __awaiter(this, void 0, void 0, function* () {
|
@@ -232,7 +232,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
232
232
|
const localVarHeaderParameter = {};
|
233
233
|
const localVarQueryParameter = {};
|
234
234
|
// authentication api_key required
|
235
|
-
yield setApiKeyToObject(
|
235
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
236
236
|
// authentication oauth2 required
|
237
237
|
// oauth required
|
238
238
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full"], configuration);
|
@@ -245,14 +245,14 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
245
245
|
};
|
246
246
|
}),
|
247
247
|
/**
|
248
|
-
* Lists activities associated with an organization.
|
248
|
+
* Lists activities associated with an organization. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities?org_id={id}</a> instead.
|
249
249
|
* @summary List activities associated with an organization
|
250
250
|
* @param {number} id The ID of the organization
|
251
251
|
* @param {number} [start] Pagination start
|
252
252
|
* @param {number} [limit] Items shown per page
|
253
253
|
* @param {0 | 1} [done] Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.
|
254
254
|
* @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
|
255
|
-
|
255
|
+
* @deprecated
|
256
256
|
* @throws {RequiredError}
|
257
257
|
*/
|
258
258
|
getOrganizationActivities: (id, start, limit, done, exclude) => __awaiter(this, void 0, void 0, function* () {
|
@@ -270,7 +270,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
270
270
|
const localVarHeaderParameter = {};
|
271
271
|
const localVarQueryParameter = {};
|
272
272
|
// authentication api_key required
|
273
|
-
yield setApiKeyToObject(
|
273
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
274
274
|
// authentication oauth2 required
|
275
275
|
// oauth required
|
276
276
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["activities:read", "activities:full"], configuration);
|
@@ -318,7 +318,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
318
318
|
const localVarHeaderParameter = {};
|
319
319
|
const localVarQueryParameter = {};
|
320
320
|
// authentication api_key required
|
321
|
-
yield setApiKeyToObject(
|
321
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
322
322
|
// authentication oauth2 required
|
323
323
|
// oauth required
|
324
324
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["recents:read"], configuration);
|
@@ -337,7 +337,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
337
337
|
};
|
338
338
|
}),
|
339
339
|
/**
|
340
|
-
* Lists deals associated with an organization.
|
340
|
+
* Lists deals associated with an organization. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals?org_id={id}</a> instead.
|
341
341
|
* @summary List deals associated with an organization
|
342
342
|
* @param {number} id The ID of the organization
|
343
343
|
* @param {number} [start] Pagination start
|
@@ -345,7 +345,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
345
345
|
* @param {'open' | 'won' | 'lost' | 'deleted' | 'all_not_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.
|
346
346
|
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
347
347
|
* @param {0 | 1} [only_primary_association] If set, only deals that are directly associated to the organization are fetched. If not set (default), all deals are fetched that are either directly or indirectly related to the organization. Indirect relations include relations through custom, organization-type fields and through persons of the given organization.
|
348
|
-
|
348
|
+
* @deprecated
|
349
349
|
* @throws {RequiredError}
|
350
350
|
*/
|
351
351
|
getOrganizationDeals: (id, start, limit, status, sort, only_primary_association) => __awaiter(this, void 0, void 0, function* () {
|
@@ -363,7 +363,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
363
363
|
const localVarHeaderParameter = {};
|
364
364
|
const localVarQueryParameter = {};
|
365
365
|
// authentication api_key required
|
366
|
-
yield setApiKeyToObject(
|
366
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
367
367
|
// authentication oauth2 required
|
368
368
|
// oauth required
|
369
369
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration);
|
@@ -415,7 +415,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
415
415
|
const localVarHeaderParameter = {};
|
416
416
|
const localVarQueryParameter = {};
|
417
417
|
// authentication api_key required
|
418
|
-
yield setApiKeyToObject(
|
418
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
419
419
|
// authentication oauth2 required
|
420
420
|
// oauth required
|
421
421
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full"], configuration);
|
@@ -458,7 +458,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
458
458
|
const localVarHeaderParameter = {};
|
459
459
|
const localVarQueryParameter = {};
|
460
460
|
// authentication api_key required
|
461
|
-
yield setApiKeyToObject(
|
461
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
462
462
|
// authentication oauth2 required
|
463
463
|
// oauth required
|
464
464
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full"], configuration);
|
@@ -494,7 +494,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
494
494
|
const localVarHeaderParameter = {};
|
495
495
|
const localVarQueryParameter = {};
|
496
496
|
// authentication api_key required
|
497
|
-
yield setApiKeyToObject(
|
497
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
498
498
|
// authentication oauth2 required
|
499
499
|
// oauth required
|
500
500
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["mail:read", "mail:full"], configuration);
|
@@ -513,12 +513,12 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
513
513
|
};
|
514
514
|
}),
|
515
515
|
/**
|
516
|
-
* Lists persons associated with an organization.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
516
|
+
* Lists persons associated with an organization.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons?org_id={id}</a> instead.
|
517
517
|
* @summary List persons of an organization
|
518
518
|
* @param {number} id The ID of the organization
|
519
519
|
* @param {number} [start] Pagination start
|
520
520
|
* @param {number} [limit] Items shown per page
|
521
|
-
|
521
|
+
* @deprecated
|
522
522
|
* @throws {RequiredError}
|
523
523
|
*/
|
524
524
|
getOrganizationPersons: (id, start, limit) => __awaiter(this, void 0, void 0, function* () {
|
@@ -536,7 +536,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
536
536
|
const localVarHeaderParameter = {};
|
537
537
|
const localVarQueryParameter = {};
|
538
538
|
// authentication api_key required
|
539
|
-
yield setApiKeyToObject(
|
539
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
540
540
|
// authentication oauth2 required
|
541
541
|
// oauth required
|
542
542
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full"], configuration);
|
@@ -580,7 +580,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
580
580
|
const localVarHeaderParameter = {};
|
581
581
|
const localVarQueryParameter = {};
|
582
582
|
// authentication api_key required
|
583
|
-
yield setApiKeyToObject(
|
583
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
584
584
|
// authentication oauth2 required
|
585
585
|
// oauth required
|
586
586
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["recents:read"], configuration);
|
@@ -626,7 +626,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
626
626
|
const localVarHeaderParameter = {};
|
627
627
|
const localVarQueryParameter = {};
|
628
628
|
// authentication api_key required
|
629
|
-
yield setApiKeyToObject(
|
629
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
630
630
|
// authentication oauth2 required
|
631
631
|
// oauth required
|
632
632
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full"], configuration);
|
@@ -647,7 +647,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
647
647
|
* @param {number} [start] Pagination start
|
648
648
|
* @param {number} [limit] Items shown per page
|
649
649
|
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
650
|
-
|
650
|
+
* @deprecated
|
651
651
|
* @throws {RequiredError}
|
652
652
|
*/
|
653
653
|
getOrganizations: (user_id, filter_id, first_char, start, limit, sort) => __awaiter(this, void 0, void 0, function* () {
|
@@ -662,7 +662,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
662
662
|
const localVarHeaderParameter = {};
|
663
663
|
const localVarQueryParameter = {};
|
664
664
|
// authentication api_key required
|
665
|
-
yield setApiKeyToObject(
|
665
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
666
666
|
// authentication oauth2 required
|
667
667
|
// oauth required
|
668
668
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full"], configuration);
|
@@ -693,15 +693,15 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
693
693
|
};
|
694
694
|
}),
|
695
695
|
/**
|
696
|
-
* Returns all organizations.
|
697
|
-
* @summary Get all organizations
|
696
|
+
* Returns all organizations. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizations\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/organizations</a> instead.
|
697
|
+
* @summary Get all organizations collection
|
698
698
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
699
699
|
* @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.
|
700
700
|
* @param {string} [since] The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
|
701
701
|
* @param {string} [until] The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
|
702
702
|
* @param {number} [owner_id] If supplied, only organizations owned by the given user will be returned
|
703
703
|
* @param {string} [first_char] If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive)
|
704
|
-
|
704
|
+
* @deprecated
|
705
705
|
* @throws {RequiredError}
|
706
706
|
*/
|
707
707
|
getOrganizationsCollection: (cursor, limit, since, until, owner_id, first_char) => __awaiter(this, void 0, void 0, function* () {
|
@@ -716,7 +716,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
716
716
|
const localVarHeaderParameter = {};
|
717
717
|
const localVarQueryParameter = {};
|
718
718
|
// authentication api_key required
|
719
|
-
yield setApiKeyToObject(
|
719
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
720
720
|
// authentication oauth2 required
|
721
721
|
// oauth required
|
722
722
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full"], configuration);
|
@@ -769,7 +769,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
769
769
|
const localVarHeaderParameter = {};
|
770
770
|
const localVarQueryParameter = {};
|
771
771
|
// authentication api_key required
|
772
|
-
yield setApiKeyToObject(
|
772
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
773
773
|
// authentication oauth2 required
|
774
774
|
// oauth required
|
775
775
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full"], configuration);
|
@@ -791,7 +791,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
791
791
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
792
792
|
* @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
|
793
793
|
* @param {number} [limit] Items shown per page
|
794
|
-
|
794
|
+
* @deprecated
|
795
795
|
* @throws {RequiredError}
|
796
796
|
*/
|
797
797
|
searchOrganization: (term, fields, exact_match, start, limit) => __awaiter(this, void 0, void 0, function* () {
|
@@ -808,7 +808,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
808
808
|
const localVarHeaderParameter = {};
|
809
809
|
const localVarQueryParameter = {};
|
810
810
|
// authentication api_key required
|
811
|
-
yield setApiKeyToObject(
|
811
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
812
812
|
// authentication oauth2 required
|
813
813
|
// oauth required
|
814
814
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full", "search:read"], configuration);
|
@@ -840,7 +840,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
840
840
|
* @summary Update an organization
|
841
841
|
* @param {number} id The ID of the organization
|
842
842
|
* @param {UpdateOrganizationRequest} [UpdateOrganizationRequest]
|
843
|
-
|
843
|
+
* @deprecated
|
844
844
|
* @throws {RequiredError}
|
845
845
|
*/
|
846
846
|
updateOrganization: (id, UpdateOrganizationRequest) => __awaiter(this, void 0, void 0, function* () {
|
@@ -858,7 +858,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
858
858
|
const localVarHeaderParameter = {};
|
859
859
|
const localVarQueryParameter = {};
|
860
860
|
// authentication api_key required
|
861
|
-
yield setApiKeyToObject(
|
861
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
862
862
|
// authentication oauth2 required
|
863
863
|
// oauth required
|
864
864
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full"], configuration);
|
@@ -885,7 +885,7 @@ export const OrganizationsApiFp = function (configuration) {
|
|
885
885
|
* Adds a new organization. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the organizationFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-an-organization\" target=\"_blank\" rel=\"noopener noreferrer\">adding an organization</a>.
|
886
886
|
* @summary Add an organization
|
887
887
|
* @param {AddOrganizationRequest} [AddOrganizationRequest]
|
888
|
-
|
888
|
+
* @deprecated
|
889
889
|
* @throws {RequiredError}
|
890
890
|
*/
|
891
891
|
addOrganization(AddOrganizationRequest) {
|
@@ -912,7 +912,7 @@ export const OrganizationsApiFp = function (configuration) {
|
|
912
912
|
* Marks an organization as deleted. After 30 days, the organization will be permanently deleted.
|
913
913
|
* @summary Delete an organization
|
914
914
|
* @param {number} id The ID of the organization
|
915
|
-
|
915
|
+
* @deprecated
|
916
916
|
* @throws {RequiredError}
|
917
917
|
*/
|
918
918
|
deleteOrganization(id) {
|
@@ -936,10 +936,10 @@ export const OrganizationsApiFp = function (configuration) {
|
|
936
936
|
});
|
937
937
|
},
|
938
938
|
/**
|
939
|
-
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
|
939
|
+
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#deleteOrganization\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/organizations/{id}</a> instead.
|
940
940
|
* @summary Delete multiple organizations in bulk
|
941
941
|
* @param {string} ids The comma-separated IDs that will be deleted
|
942
|
-
|
942
|
+
* @deprecated
|
943
943
|
* @throws {RequiredError}
|
944
944
|
*/
|
945
945
|
deleteOrganizations(ids) {
|
@@ -952,7 +952,7 @@ export const OrganizationsApiFp = function (configuration) {
|
|
952
952
|
* Returns the details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of organizationFields.
|
953
953
|
* @summary Get details of an organization
|
954
954
|
* @param {number} id The ID of the organization
|
955
|
-
|
955
|
+
* @deprecated
|
956
956
|
* @throws {RequiredError}
|
957
957
|
*/
|
958
958
|
getOrganization(id) {
|
@@ -962,14 +962,14 @@ export const OrganizationsApiFp = function (configuration) {
|
|
962
962
|
});
|
963
963
|
},
|
964
964
|
/**
|
965
|
-
* Lists activities associated with an organization.
|
965
|
+
* Lists activities associated with an organization. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities?org_id={id}</a> instead.
|
966
966
|
* @summary List activities associated with an organization
|
967
967
|
* @param {number} id The ID of the organization
|
968
968
|
* @param {number} [start] Pagination start
|
969
969
|
* @param {number} [limit] Items shown per page
|
970
970
|
* @param {0 | 1} [done] Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.
|
971
971
|
* @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
|
972
|
-
|
972
|
+
* @deprecated
|
973
973
|
* @throws {RequiredError}
|
974
974
|
*/
|
975
975
|
getOrganizationActivities(id, start, limit, done, exclude) {
|
@@ -994,7 +994,7 @@ export const OrganizationsApiFp = function (configuration) {
|
|
994
994
|
});
|
995
995
|
},
|
996
996
|
/**
|
997
|
-
* Lists deals associated with an organization.
|
997
|
+
* Lists deals associated with an organization. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals?org_id={id}</a> instead.
|
998
998
|
* @summary List deals associated with an organization
|
999
999
|
* @param {number} id The ID of the organization
|
1000
1000
|
* @param {number} [start] Pagination start
|
@@ -1002,7 +1002,7 @@ export const OrganizationsApiFp = function (configuration) {
|
|
1002
1002
|
* @param {'open' | 'won' | 'lost' | 'deleted' | 'all_not_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.
|
1003
1003
|
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
1004
1004
|
* @param {0 | 1} [only_primary_association] If set, only deals that are directly associated to the organization are fetched. If not set (default), all deals are fetched that are either directly or indirectly related to the organization. Indirect relations include relations through custom, organization-type fields and through persons of the given organization.
|
1005
|
-
|
1005
|
+
* @deprecated
|
1006
1006
|
* @throws {RequiredError}
|
1007
1007
|
*/
|
1008
1008
|
getOrganizationDeals(id, start, limit, status, sort, only_primary_association) {
|
@@ -1056,12 +1056,12 @@ export const OrganizationsApiFp = function (configuration) {
|
|
1056
1056
|
});
|
1057
1057
|
},
|
1058
1058
|
/**
|
1059
|
-
* Lists persons associated with an organization.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
1059
|
+
* Lists persons associated with an organization.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons?org_id={id}</a> instead.
|
1060
1060
|
* @summary List persons of an organization
|
1061
1061
|
* @param {number} id The ID of the organization
|
1062
1062
|
* @param {number} [start] Pagination start
|
1063
1063
|
* @param {number} [limit] Items shown per page
|
1064
|
-
|
1064
|
+
* @deprecated
|
1065
1065
|
* @throws {RequiredError}
|
1066
1066
|
*/
|
1067
1067
|
getOrganizationPersons(id, start, limit) {
|
@@ -1109,7 +1109,7 @@ export const OrganizationsApiFp = function (configuration) {
|
|
1109
1109
|
* @param {number} [start] Pagination start
|
1110
1110
|
* @param {number} [limit] Items shown per page
|
1111
1111
|
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
1112
|
-
|
1112
|
+
* @deprecated
|
1113
1113
|
* @throws {RequiredError}
|
1114
1114
|
*/
|
1115
1115
|
getOrganizations(user_id, filter_id, first_char, start, limit, sort) {
|
@@ -1119,15 +1119,15 @@ export const OrganizationsApiFp = function (configuration) {
|
|
1119
1119
|
});
|
1120
1120
|
},
|
1121
1121
|
/**
|
1122
|
-
* Returns all organizations.
|
1123
|
-
* @summary Get all organizations
|
1122
|
+
* Returns all organizations. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizations\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/organizations</a> instead.
|
1123
|
+
* @summary Get all organizations collection
|
1124
1124
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
1125
1125
|
* @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.
|
1126
1126
|
* @param {string} [since] The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
|
1127
1127
|
* @param {string} [until] The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
|
1128
1128
|
* @param {number} [owner_id] If supplied, only organizations owned by the given user will be returned
|
1129
1129
|
* @param {string} [first_char] If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive)
|
1130
|
-
|
1130
|
+
* @deprecated
|
1131
1131
|
* @throws {RequiredError}
|
1132
1132
|
*/
|
1133
1133
|
getOrganizationsCollection(cursor, limit, since, until, owner_id, first_char) {
|
@@ -1158,7 +1158,7 @@ export const OrganizationsApiFp = function (configuration) {
|
|
1158
1158
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
1159
1159
|
* @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
|
1160
1160
|
* @param {number} [limit] Items shown per page
|
1161
|
-
|
1161
|
+
* @deprecated
|
1162
1162
|
* @throws {RequiredError}
|
1163
1163
|
*/
|
1164
1164
|
searchOrganization(term, fields, exact_match, start, limit) {
|
@@ -1172,7 +1172,7 @@ export const OrganizationsApiFp = function (configuration) {
|
|
1172
1172
|
* @summary Update an organization
|
1173
1173
|
* @param {number} id The ID of the organization
|
1174
1174
|
* @param {UpdateOrganizationRequest} [UpdateOrganizationRequest]
|
1175
|
-
|
1175
|
+
* @deprecated
|
1176
1176
|
* @throws {RequiredError}
|
1177
1177
|
*/
|
1178
1178
|
updateOrganization(id, UpdateOrganizationRequest) {
|
@@ -1194,7 +1194,7 @@ export const OrganizationsApiFactory = function (configuration, basePath, axios)
|
|
1194
1194
|
* Adds a new organization. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the organizationFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-an-organization\" target=\"_blank\" rel=\"noopener noreferrer\">adding an organization</a>.
|
1195
1195
|
* @summary Add an organization
|
1196
1196
|
* @param {OrganizationsApiAddOrganizationRequest} requestParameters Request parameters.
|
1197
|
-
|
1197
|
+
* @deprecated
|
1198
1198
|
* @throws {RequiredError}
|
1199
1199
|
*/
|
1200
1200
|
addOrganization(requestParameters = {}) {
|
@@ -1214,7 +1214,7 @@ export const OrganizationsApiFactory = function (configuration, basePath, axios)
|
|
1214
1214
|
* Marks an organization as deleted. After 30 days, the organization will be permanently deleted.
|
1215
1215
|
* @summary Delete an organization
|
1216
1216
|
* @param {OrganizationsApiDeleteOrganizationRequest} requestParameters Request parameters.
|
1217
|
-
|
1217
|
+
* @deprecated
|
1218
1218
|
* @throws {RequiredError}
|
1219
1219
|
*/
|
1220
1220
|
deleteOrganization(requestParameters) {
|
@@ -1231,10 +1231,10 @@ export const OrganizationsApiFactory = function (configuration, basePath, axios)
|
|
1231
1231
|
return localVarFp.deleteOrganizationFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(axios, basePath));
|
1232
1232
|
},
|
1233
1233
|
/**
|
1234
|
-
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
|
1234
|
+
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#deleteOrganization\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/organizations/{id}</a> instead.
|
1235
1235
|
* @summary Delete multiple organizations in bulk
|
1236
1236
|
* @param {OrganizationsApiDeleteOrganizationsRequest} requestParameters Request parameters.
|
1237
|
-
|
1237
|
+
* @deprecated
|
1238
1238
|
* @throws {RequiredError}
|
1239
1239
|
*/
|
1240
1240
|
deleteOrganizations(requestParameters) {
|
@@ -1244,17 +1244,17 @@ export const OrganizationsApiFactory = function (configuration, basePath, axios)
|
|
1244
1244
|
* Returns the details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of organizationFields.
|
1245
1245
|
* @summary Get details of an organization
|
1246
1246
|
* @param {OrganizationsApiGetOrganizationRequest} requestParameters Request parameters.
|
1247
|
-
|
1247
|
+
* @deprecated
|
1248
1248
|
* @throws {RequiredError}
|
1249
1249
|
*/
|
1250
1250
|
getOrganization(requestParameters) {
|
1251
1251
|
return localVarFp.getOrganization(requestParameters.id).then((request) => request(axios, basePath));
|
1252
1252
|
},
|
1253
1253
|
/**
|
1254
|
-
* Lists activities associated with an organization.
|
1254
|
+
* Lists activities associated with an organization. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities?org_id={id}</a> instead.
|
1255
1255
|
* @summary List activities associated with an organization
|
1256
1256
|
* @param {OrganizationsApiGetOrganizationActivitiesRequest} requestParameters Request parameters.
|
1257
|
-
|
1257
|
+
* @deprecated
|
1258
1258
|
* @throws {RequiredError}
|
1259
1259
|
*/
|
1260
1260
|
getOrganizationActivities(requestParameters) {
|
@@ -1271,10 +1271,10 @@ export const OrganizationsApiFactory = function (configuration, basePath, axios)
|
|
1271
1271
|
return localVarFp.getOrganizationChangelog(requestParameters.id, requestParameters.cursor, requestParameters.limit).then((request) => request(axios, basePath));
|
1272
1272
|
},
|
1273
1273
|
/**
|
1274
|
-
* Lists deals associated with an organization.
|
1274
|
+
* Lists deals associated with an organization. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals?org_id={id}</a> instead.
|
1275
1275
|
* @summary List deals associated with an organization
|
1276
1276
|
* @param {OrganizationsApiGetOrganizationDealsRequest} requestParameters Request parameters.
|
1277
|
-
|
1277
|
+
* @deprecated
|
1278
1278
|
* @throws {RequiredError}
|
1279
1279
|
*/
|
1280
1280
|
getOrganizationDeals(requestParameters) {
|
@@ -1311,10 +1311,10 @@ export const OrganizationsApiFactory = function (configuration, basePath, axios)
|
|
1311
1311
|
return localVarFp.getOrganizationMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
|
1312
1312
|
},
|
1313
1313
|
/**
|
1314
|
-
* Lists persons associated with an organization.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
1314
|
+
* Lists persons associated with an organization.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons?org_id={id}</a> instead.
|
1315
1315
|
* @summary List persons of an organization
|
1316
1316
|
* @param {OrganizationsApiGetOrganizationPersonsRequest} requestParameters Request parameters.
|
1317
|
-
|
1317
|
+
* @deprecated
|
1318
1318
|
* @throws {RequiredError}
|
1319
1319
|
*/
|
1320
1320
|
getOrganizationPersons(requestParameters) {
|
@@ -1344,17 +1344,17 @@ export const OrganizationsApiFactory = function (configuration, basePath, axios)
|
|
1344
1344
|
* Returns all organizations.
|
1345
1345
|
* @summary Get all organizations
|
1346
1346
|
* @param {OrganizationsApiGetOrganizationsRequest} requestParameters Request parameters.
|
1347
|
-
|
1347
|
+
* @deprecated
|
1348
1348
|
* @throws {RequiredError}
|
1349
1349
|
*/
|
1350
1350
|
getOrganizations(requestParameters = {}) {
|
1351
1351
|
return localVarFp.getOrganizations(requestParameters.user_id, requestParameters.filter_id, requestParameters.first_char, requestParameters.start, requestParameters.limit, requestParameters.sort).then((request) => request(axios, basePath));
|
1352
1352
|
},
|
1353
1353
|
/**
|
1354
|
-
* Returns all organizations.
|
1355
|
-
* @summary Get all organizations
|
1354
|
+
* Returns all organizations. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizations\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/organizations</a> instead.
|
1355
|
+
* @summary Get all organizations collection
|
1356
1356
|
* @param {OrganizationsApiGetOrganizationsCollectionRequest} requestParameters Request parameters.
|
1357
|
-
|
1357
|
+
* @deprecated
|
1358
1358
|
* @throws {RequiredError}
|
1359
1359
|
*/
|
1360
1360
|
getOrganizationsCollection(requestParameters = {}) {
|
@@ -1374,7 +1374,7 @@ export const OrganizationsApiFactory = function (configuration, basePath, axios)
|
|
1374
1374
|
* 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.
|
1375
1375
|
* @summary Search organizations
|
1376
1376
|
* @param {OrganizationsApiSearchOrganizationRequest} requestParameters Request parameters.
|
1377
|
-
|
1377
|
+
* @deprecated
|
1378
1378
|
* @throws {RequiredError}
|
1379
1379
|
*/
|
1380
1380
|
searchOrganization(requestParameters) {
|
@@ -1384,7 +1384,7 @@ export const OrganizationsApiFactory = function (configuration, basePath, axios)
|
|
1384
1384
|
* Updates the properties of an organization.
|
1385
1385
|
* @summary Update an organization
|
1386
1386
|
* @param {OrganizationsApiUpdateOrganizationRequest} requestParameters Request parameters.
|
1387
|
-
|
1387
|
+
* @deprecated
|
1388
1388
|
* @throws {RequiredError}
|
1389
1389
|
*/
|
1390
1390
|
updateOrganization(requestParameters) {
|
@@ -1403,7 +1403,7 @@ export class OrganizationsApi extends BaseAPI {
|
|
1403
1403
|
* Adds a new organization. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the organizationFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-an-organization\" target=\"_blank\" rel=\"noopener noreferrer\">adding an organization</a>.
|
1404
1404
|
* @summary Add an organization
|
1405
1405
|
* @param {OrganizationsApiAddOrganizationRequest} requestParameters Request parameters.
|
1406
|
-
|
1406
|
+
* @deprecated
|
1407
1407
|
* @throws {RequiredError}
|
1408
1408
|
* @memberof OrganizationsApi
|
1409
1409
|
*/
|
@@ -1425,7 +1425,7 @@ export class OrganizationsApi extends BaseAPI {
|
|
1425
1425
|
* Marks an organization as deleted. After 30 days, the organization will be permanently deleted.
|
1426
1426
|
* @summary Delete an organization
|
1427
1427
|
* @param {OrganizationsApiDeleteOrganizationRequest} requestParameters Request parameters.
|
1428
|
-
|
1428
|
+
* @deprecated
|
1429
1429
|
* @throws {RequiredError}
|
1430
1430
|
* @memberof OrganizationsApi
|
1431
1431
|
*/
|
@@ -1444,10 +1444,10 @@ export class OrganizationsApi extends BaseAPI {
|
|
1444
1444
|
return OrganizationsApiFp(this.configuration).deleteOrganizationFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(this.axios, this.basePath));
|
1445
1445
|
}
|
1446
1446
|
/**
|
1447
|
-
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
|
1447
|
+
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#deleteOrganization\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/organizations/{id}</a> instead.
|
1448
1448
|
* @summary Delete multiple organizations in bulk
|
1449
1449
|
* @param {OrganizationsApiDeleteOrganizationsRequest} requestParameters Request parameters.
|
1450
|
-
|
1450
|
+
* @deprecated
|
1451
1451
|
* @throws {RequiredError}
|
1452
1452
|
* @memberof OrganizationsApi
|
1453
1453
|
*/
|
@@ -1458,7 +1458,7 @@ export class OrganizationsApi extends BaseAPI {
|
|
1458
1458
|
* Returns the details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of organizationFields.
|
1459
1459
|
* @summary Get details of an organization
|
1460
1460
|
* @param {OrganizationsApiGetOrganizationRequest} requestParameters Request parameters.
|
1461
|
-
|
1461
|
+
* @deprecated
|
1462
1462
|
* @throws {RequiredError}
|
1463
1463
|
* @memberof OrganizationsApi
|
1464
1464
|
*/
|
@@ -1466,10 +1466,10 @@ export class OrganizationsApi extends BaseAPI {
|
|
1466
1466
|
return OrganizationsApiFp(this.configuration).getOrganization(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
1467
1467
|
}
|
1468
1468
|
/**
|
1469
|
-
* Lists activities associated with an organization.
|
1469
|
+
* Lists activities associated with an organization. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities?org_id={id}</a> instead.
|
1470
1470
|
* @summary List activities associated with an organization
|
1471
1471
|
* @param {OrganizationsApiGetOrganizationActivitiesRequest} requestParameters Request parameters.
|
1472
|
-
|
1472
|
+
* @deprecated
|
1473
1473
|
* @throws {RequiredError}
|
1474
1474
|
* @memberof OrganizationsApi
|
1475
1475
|
*/
|
@@ -1488,10 +1488,10 @@ export class OrganizationsApi extends BaseAPI {
|
|
1488
1488
|
return OrganizationsApiFp(this.configuration).getOrganizationChangelog(requestParameters.id, requestParameters.cursor, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
1489
1489
|
}
|
1490
1490
|
/**
|
1491
|
-
* Lists deals associated with an organization.
|
1491
|
+
* Lists deals associated with an organization. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/deals?org_id={id}</a> instead.
|
1492
1492
|
* @summary List deals associated with an organization
|
1493
1493
|
* @param {OrganizationsApiGetOrganizationDealsRequest} requestParameters Request parameters.
|
1494
|
-
|
1494
|
+
* @deprecated
|
1495
1495
|
* @throws {RequiredError}
|
1496
1496
|
* @memberof OrganizationsApi
|
1497
1497
|
*/
|
@@ -1532,10 +1532,10 @@ export class OrganizationsApi extends BaseAPI {
|
|
1532
1532
|
return OrganizationsApiFp(this.configuration).getOrganizationMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
1533
1533
|
}
|
1534
1534
|
/**
|
1535
|
-
* Lists persons associated with an organization.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
1535
|
+
* Lists persons associated with an organization.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/persons?org_id={id}</a> instead.
|
1536
1536
|
* @summary List persons of an organization
|
1537
1537
|
* @param {OrganizationsApiGetOrganizationPersonsRequest} requestParameters Request parameters.
|
1538
|
-
|
1538
|
+
* @deprecated
|
1539
1539
|
* @throws {RequiredError}
|
1540
1540
|
* @memberof OrganizationsApi
|
1541
1541
|
*/
|
@@ -1568,7 +1568,7 @@ export class OrganizationsApi extends BaseAPI {
|
|
1568
1568
|
* Returns all organizations.
|
1569
1569
|
* @summary Get all organizations
|
1570
1570
|
* @param {OrganizationsApiGetOrganizationsRequest} requestParameters Request parameters.
|
1571
|
-
|
1571
|
+
* @deprecated
|
1572
1572
|
* @throws {RequiredError}
|
1573
1573
|
* @memberof OrganizationsApi
|
1574
1574
|
*/
|
@@ -1576,10 +1576,10 @@ export class OrganizationsApi extends BaseAPI {
|
|
1576
1576
|
return OrganizationsApiFp(this.configuration).getOrganizations(requestParameters.user_id, requestParameters.filter_id, requestParameters.first_char, requestParameters.start, requestParameters.limit, requestParameters.sort).then((request) => request(this.axios, this.basePath));
|
1577
1577
|
}
|
1578
1578
|
/**
|
1579
|
-
* Returns all organizations.
|
1580
|
-
* @summary Get all organizations
|
1579
|
+
* Returns all organizations. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizations\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/organizations</a> instead.
|
1580
|
+
* @summary Get all organizations collection
|
1581
1581
|
* @param {OrganizationsApiGetOrganizationsCollectionRequest} requestParameters Request parameters.
|
1582
|
-
|
1582
|
+
* @deprecated
|
1583
1583
|
* @throws {RequiredError}
|
1584
1584
|
* @memberof OrganizationsApi
|
1585
1585
|
*/
|
@@ -1601,7 +1601,7 @@ export class OrganizationsApi extends BaseAPI {
|
|
1601
1601
|
* 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.
|
1602
1602
|
* @summary Search organizations
|
1603
1603
|
* @param {OrganizationsApiSearchOrganizationRequest} requestParameters Request parameters.
|
1604
|
-
|
1604
|
+
* @deprecated
|
1605
1605
|
* @throws {RequiredError}
|
1606
1606
|
* @memberof OrganizationsApi
|
1607
1607
|
*/
|
@@ -1612,7 +1612,7 @@ export class OrganizationsApi extends BaseAPI {
|
|
1612
1612
|
* Updates the properties of an organization.
|
1613
1613
|
* @summary Update an organization
|
1614
1614
|
* @param {OrganizationsApiUpdateOrganizationRequest} requestParameters Request parameters.
|
1615
|
-
|
1615
|
+
* @deprecated
|
1616
1616
|
* @throws {RequiredError}
|
1617
1617
|
* @memberof OrganizationsApi
|
1618
1618
|
*/
|