pipedrive 25.0.0 → 26.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/versions/v1/api/activities-api.d.ts +40 -40
- package/dist/esm/versions/v1/api/activities-api.js +40 -40
- package/dist/esm/versions/v1/api/deals-api.d.ts +410 -88
- package/dist/esm/versions/v1/api/deals-api.js +417 -88
- package/dist/esm/versions/v1/api/item-search-api.d.ts +8 -8
- package/dist/esm/versions/v1/api/item-search-api.js +8 -8
- package/dist/esm/versions/v1/api/leads-api.d.ts +100 -14
- package/dist/esm/versions/v1/api/leads-api.js +107 -14
- package/dist/esm/versions/v1/api/notes-api.d.ts +18 -2
- package/dist/esm/versions/v1/api/notes-api.js +15 -5
- package/dist/esm/versions/v1/api/organizations-api.d.ts +68 -68
- package/dist/esm/versions/v1/api/organizations-api.js +68 -68
- package/dist/esm/versions/v1/api/persons-api.d.ts +56 -56
- package/dist/esm/versions/v1/api/persons-api.js +56 -56
- package/dist/esm/versions/v1/api/pipelines-api.d.ts +28 -28
- package/dist/esm/versions/v1/api/pipelines-api.js +28 -28
- package/dist/esm/versions/v1/api/products-api.d.ts +24 -24
- package/dist/esm/versions/v1/api/products-api.js +24 -24
- package/dist/esm/versions/v1/api/stages-api.d.ts +36 -36
- package/dist/esm/versions/v1/api/stages-api.js +36 -36
- package/dist/esm/versions/v1/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 +12 -7
- package/dist/esm/versions/v2/api/beta-api.d.ts +212 -0
- package/dist/esm/versions/v2/api/beta-api.js +286 -0
- package/dist/esm/versions/v2/api/deals-api.d.ts +272 -4
- package/dist/esm/versions/v2/api/deals-api.js +288 -4
- package/dist/esm/versions/v2/api/leads-api.d.ts +111 -0
- package/dist/esm/versions/v2/api/leads-api.js +146 -1
- package/dist/esm/versions/v2/api/persons-api.d.ts +8 -8
- package/dist/esm/versions/v2/api/persons-api.js +8 -8
- package/dist/esm/versions/v2/api/products-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 +40 -40
- package/dist/versions/v1/api/deals-api.d.ts +410 -88
- package/dist/versions/v1/api/deals-api.js +417 -88
- package/dist/versions/v1/api/item-search-api.d.ts +8 -8
- package/dist/versions/v1/api/item-search-api.js +8 -8
- package/dist/versions/v1/api/leads-api.d.ts +100 -14
- package/dist/versions/v1/api/leads-api.js +107 -14
- package/dist/versions/v1/api/notes-api.d.ts +18 -2
- package/dist/versions/v1/api/notes-api.js +15 -5
- package/dist/versions/v1/api/organizations-api.d.ts +68 -68
- package/dist/versions/v1/api/organizations-api.js +68 -68
- package/dist/versions/v1/api/persons-api.d.ts +56 -56
- package/dist/versions/v1/api/persons-api.js +56 -56
- package/dist/versions/v1/api/pipelines-api.d.ts +28 -28
- package/dist/versions/v1/api/pipelines-api.js +28 -28
- package/dist/versions/v1/api/products-api.d.ts +24 -24
- package/dist/versions/v1/api/products-api.js +24 -24
- package/dist/versions/v1/api/stages-api.d.ts +36 -36
- package/dist/versions/v1/api/stages-api.js +36 -36
- package/dist/versions/v1/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 +12 -7
- package/dist/versions/v2/api/beta-api.d.ts +212 -0
- package/dist/versions/v2/api/beta-api.js +286 -0
- package/dist/versions/v2/api/deals-api.d.ts +272 -4
- package/dist/versions/v2/api/deals-api.js +288 -4
- package/dist/versions/v2/api/leads-api.d.ts +111 -0
- package/dist/versions/v2/api/leads-api.js +145 -0
- package/dist/versions/v2/api/persons-api.d.ts +8 -8
- package/dist/versions/v2/api/persons-api.js +8 -8
- package/dist/versions/v2/api/products-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
@@ -42,7 +42,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
42
42
|
* 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>.
|
43
43
|
* @summary Add an organization
|
44
44
|
* @param {AddOrganizationRequest} [AddOrganizationRequest]
|
45
|
-
|
45
|
+
* @deprecated
|
46
46
|
* @throws {RequiredError}
|
47
47
|
*/
|
48
48
|
addOrganization: (AddOrganizationRequest) => __awaiter(this, void 0, void 0, function* () {
|
@@ -112,7 +112,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
112
112
|
* Marks an organization as deleted. After 30 days, the organization will be permanently deleted.
|
113
113
|
* @summary Delete an organization
|
114
114
|
* @param {number} id The ID of the organization
|
115
|
-
|
115
|
+
* @deprecated
|
116
116
|
* @throws {RequiredError}
|
117
117
|
*/
|
118
118
|
deleteOrganization: (id) => __awaiter(this, void 0, void 0, function* () {
|
@@ -181,10 +181,10 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
181
181
|
};
|
182
182
|
}),
|
183
183
|
/**
|
184
|
-
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
|
184
|
+
* 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.
|
185
185
|
* @summary Delete multiple organizations in bulk
|
186
186
|
* @param {string} ids The comma-separated IDs that will be deleted
|
187
|
-
|
187
|
+
* @deprecated
|
188
188
|
* @throws {RequiredError}
|
189
189
|
*/
|
190
190
|
deleteOrganizations: (ids) => __awaiter(this, void 0, void 0, function* () {
|
@@ -220,7 +220,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
220
220
|
* 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.
|
221
221
|
* @summary Get details of an organization
|
222
222
|
* @param {number} id The ID of the organization
|
223
|
-
|
223
|
+
* @deprecated
|
224
224
|
* @throws {RequiredError}
|
225
225
|
*/
|
226
226
|
getOrganization: (id) => __awaiter(this, void 0, void 0, function* () {
|
@@ -251,14 +251,14 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
251
251
|
};
|
252
252
|
}),
|
253
253
|
/**
|
254
|
-
* Lists activities associated with an organization.
|
254
|
+
* 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.
|
255
255
|
* @summary List activities associated with an organization
|
256
256
|
* @param {number} id The ID of the organization
|
257
257
|
* @param {number} [start] Pagination start
|
258
258
|
* @param {number} [limit] Items shown per page
|
259
259
|
* @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.
|
260
260
|
* @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
|
261
|
-
|
261
|
+
* @deprecated
|
262
262
|
* @throws {RequiredError}
|
263
263
|
*/
|
264
264
|
getOrganizationActivities: (id, start, limit, done, exclude) => __awaiter(this, void 0, void 0, function* () {
|
@@ -343,7 +343,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
343
343
|
};
|
344
344
|
}),
|
345
345
|
/**
|
346
|
-
* Lists deals associated with an organization.
|
346
|
+
* 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.
|
347
347
|
* @summary List deals associated with an organization
|
348
348
|
* @param {number} id The ID of the organization
|
349
349
|
* @param {number} [start] Pagination start
|
@@ -351,7 +351,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
351
351
|
* @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.
|
352
352
|
* @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).
|
353
353
|
* @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.
|
354
|
-
|
354
|
+
* @deprecated
|
355
355
|
* @throws {RequiredError}
|
356
356
|
*/
|
357
357
|
getOrganizationDeals: (id, start, limit, status, sort, only_primary_association) => __awaiter(this, void 0, void 0, function* () {
|
@@ -519,12 +519,12 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
519
519
|
};
|
520
520
|
}),
|
521
521
|
/**
|
522
|
-
* 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.
|
522
|
+
* 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.
|
523
523
|
* @summary List persons of an organization
|
524
524
|
* @param {number} id The ID of the organization
|
525
525
|
* @param {number} [start] Pagination start
|
526
526
|
* @param {number} [limit] Items shown per page
|
527
|
-
|
527
|
+
* @deprecated
|
528
528
|
* @throws {RequiredError}
|
529
529
|
*/
|
530
530
|
getOrganizationPersons: (id, start, limit) => __awaiter(this, void 0, void 0, function* () {
|
@@ -653,7 +653,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
653
653
|
* @param {number} [start] Pagination start
|
654
654
|
* @param {number} [limit] Items shown per page
|
655
655
|
* @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).
|
656
|
-
|
656
|
+
* @deprecated
|
657
657
|
* @throws {RequiredError}
|
658
658
|
*/
|
659
659
|
getOrganizations: (user_id, filter_id, first_char, start, limit, sort) => __awaiter(this, void 0, void 0, function* () {
|
@@ -699,15 +699,15 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
699
699
|
};
|
700
700
|
}),
|
701
701
|
/**
|
702
|
-
* Returns all organizations.
|
703
|
-
* @summary Get all organizations
|
702
|
+
* 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.
|
703
|
+
* @summary Get all organizations collection
|
704
704
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
705
705
|
* @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.
|
706
706
|
* @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.
|
707
707
|
* @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.
|
708
708
|
* @param {number} [owner_id] If supplied, only organizations owned by the given user will be returned
|
709
709
|
* @param {string} [first_char] If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive)
|
710
|
-
|
710
|
+
* @deprecated
|
711
711
|
* @throws {RequiredError}
|
712
712
|
*/
|
713
713
|
getOrganizationsCollection: (cursor, limit, since, until, owner_id, first_char) => __awaiter(this, void 0, void 0, function* () {
|
@@ -797,7 +797,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
797
797
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
798
798
|
* @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.
|
799
799
|
* @param {number} [limit] Items shown per page
|
800
|
-
|
800
|
+
* @deprecated
|
801
801
|
* @throws {RequiredError}
|
802
802
|
*/
|
803
803
|
searchOrganization: (term, fields, exact_match, start, limit) => __awaiter(this, void 0, void 0, function* () {
|
@@ -846,7 +846,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
846
846
|
* @summary Update an organization
|
847
847
|
* @param {number} id The ID of the organization
|
848
848
|
* @param {UpdateOrganizationRequest} [UpdateOrganizationRequest]
|
849
|
-
|
849
|
+
* @deprecated
|
850
850
|
* @throws {RequiredError}
|
851
851
|
*/
|
852
852
|
updateOrganization: (id, UpdateOrganizationRequest) => __awaiter(this, void 0, void 0, function* () {
|
@@ -892,7 +892,7 @@ const OrganizationsApiFp = function (configuration) {
|
|
892
892
|
* 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>.
|
893
893
|
* @summary Add an organization
|
894
894
|
* @param {AddOrganizationRequest} [AddOrganizationRequest]
|
895
|
-
|
895
|
+
* @deprecated
|
896
896
|
* @throws {RequiredError}
|
897
897
|
*/
|
898
898
|
addOrganization(AddOrganizationRequest) {
|
@@ -919,7 +919,7 @@ const OrganizationsApiFp = function (configuration) {
|
|
919
919
|
* Marks an organization as deleted. After 30 days, the organization will be permanently deleted.
|
920
920
|
* @summary Delete an organization
|
921
921
|
* @param {number} id The ID of the organization
|
922
|
-
|
922
|
+
* @deprecated
|
923
923
|
* @throws {RequiredError}
|
924
924
|
*/
|
925
925
|
deleteOrganization(id) {
|
@@ -943,10 +943,10 @@ const OrganizationsApiFp = function (configuration) {
|
|
943
943
|
});
|
944
944
|
},
|
945
945
|
/**
|
946
|
-
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
|
946
|
+
* 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.
|
947
947
|
* @summary Delete multiple organizations in bulk
|
948
948
|
* @param {string} ids The comma-separated IDs that will be deleted
|
949
|
-
|
949
|
+
* @deprecated
|
950
950
|
* @throws {RequiredError}
|
951
951
|
*/
|
952
952
|
deleteOrganizations(ids) {
|
@@ -959,7 +959,7 @@ const OrganizationsApiFp = function (configuration) {
|
|
959
959
|
* 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.
|
960
960
|
* @summary Get details of an organization
|
961
961
|
* @param {number} id The ID of the organization
|
962
|
-
|
962
|
+
* @deprecated
|
963
963
|
* @throws {RequiredError}
|
964
964
|
*/
|
965
965
|
getOrganization(id) {
|
@@ -969,14 +969,14 @@ const OrganizationsApiFp = function (configuration) {
|
|
969
969
|
});
|
970
970
|
},
|
971
971
|
/**
|
972
|
-
* Lists activities associated with an organization.
|
972
|
+
* 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.
|
973
973
|
* @summary List activities associated with an organization
|
974
974
|
* @param {number} id The ID of the organization
|
975
975
|
* @param {number} [start] Pagination start
|
976
976
|
* @param {number} [limit] Items shown per page
|
977
977
|
* @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.
|
978
978
|
* @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
|
979
|
-
|
979
|
+
* @deprecated
|
980
980
|
* @throws {RequiredError}
|
981
981
|
*/
|
982
982
|
getOrganizationActivities(id, start, limit, done, exclude) {
|
@@ -1001,7 +1001,7 @@ const OrganizationsApiFp = function (configuration) {
|
|
1001
1001
|
});
|
1002
1002
|
},
|
1003
1003
|
/**
|
1004
|
-
* Lists deals associated with an organization.
|
1004
|
+
* 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.
|
1005
1005
|
* @summary List deals associated with an organization
|
1006
1006
|
* @param {number} id The ID of the organization
|
1007
1007
|
* @param {number} [start] Pagination start
|
@@ -1009,7 +1009,7 @@ const OrganizationsApiFp = function (configuration) {
|
|
1009
1009
|
* @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.
|
1010
1010
|
* @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).
|
1011
1011
|
* @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.
|
1012
|
-
|
1012
|
+
* @deprecated
|
1013
1013
|
* @throws {RequiredError}
|
1014
1014
|
*/
|
1015
1015
|
getOrganizationDeals(id, start, limit, status, sort, only_primary_association) {
|
@@ -1063,12 +1063,12 @@ const OrganizationsApiFp = function (configuration) {
|
|
1063
1063
|
});
|
1064
1064
|
},
|
1065
1065
|
/**
|
1066
|
-
* 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.
|
1066
|
+
* 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.
|
1067
1067
|
* @summary List persons of an organization
|
1068
1068
|
* @param {number} id The ID of the organization
|
1069
1069
|
* @param {number} [start] Pagination start
|
1070
1070
|
* @param {number} [limit] Items shown per page
|
1071
|
-
|
1071
|
+
* @deprecated
|
1072
1072
|
* @throws {RequiredError}
|
1073
1073
|
*/
|
1074
1074
|
getOrganizationPersons(id, start, limit) {
|
@@ -1116,7 +1116,7 @@ const OrganizationsApiFp = function (configuration) {
|
|
1116
1116
|
* @param {number} [start] Pagination start
|
1117
1117
|
* @param {number} [limit] Items shown per page
|
1118
1118
|
* @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).
|
1119
|
-
|
1119
|
+
* @deprecated
|
1120
1120
|
* @throws {RequiredError}
|
1121
1121
|
*/
|
1122
1122
|
getOrganizations(user_id, filter_id, first_char, start, limit, sort) {
|
@@ -1126,15 +1126,15 @@ const OrganizationsApiFp = function (configuration) {
|
|
1126
1126
|
});
|
1127
1127
|
},
|
1128
1128
|
/**
|
1129
|
-
* Returns all organizations.
|
1130
|
-
* @summary Get all organizations
|
1129
|
+
* 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.
|
1130
|
+
* @summary Get all organizations collection
|
1131
1131
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
1132
1132
|
* @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.
|
1133
1133
|
* @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.
|
1134
1134
|
* @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.
|
1135
1135
|
* @param {number} [owner_id] If supplied, only organizations owned by the given user will be returned
|
1136
1136
|
* @param {string} [first_char] If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive)
|
1137
|
-
|
1137
|
+
* @deprecated
|
1138
1138
|
* @throws {RequiredError}
|
1139
1139
|
*/
|
1140
1140
|
getOrganizationsCollection(cursor, limit, since, until, owner_id, first_char) {
|
@@ -1165,7 +1165,7 @@ const OrganizationsApiFp = function (configuration) {
|
|
1165
1165
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
1166
1166
|
* @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.
|
1167
1167
|
* @param {number} [limit] Items shown per page
|
1168
|
-
|
1168
|
+
* @deprecated
|
1169
1169
|
* @throws {RequiredError}
|
1170
1170
|
*/
|
1171
1171
|
searchOrganization(term, fields, exact_match, start, limit) {
|
@@ -1179,7 +1179,7 @@ const OrganizationsApiFp = function (configuration) {
|
|
1179
1179
|
* @summary Update an organization
|
1180
1180
|
* @param {number} id The ID of the organization
|
1181
1181
|
* @param {UpdateOrganizationRequest} [UpdateOrganizationRequest]
|
1182
|
-
|
1182
|
+
* @deprecated
|
1183
1183
|
* @throws {RequiredError}
|
1184
1184
|
*/
|
1185
1185
|
updateOrganization(id, UpdateOrganizationRequest) {
|
@@ -1202,7 +1202,7 @@ const OrganizationsApiFactory = function (configuration, basePath, axios) {
|
|
1202
1202
|
* 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>.
|
1203
1203
|
* @summary Add an organization
|
1204
1204
|
* @param {OrganizationsApiAddOrganizationRequest} requestParameters Request parameters.
|
1205
|
-
|
1205
|
+
* @deprecated
|
1206
1206
|
* @throws {RequiredError}
|
1207
1207
|
*/
|
1208
1208
|
addOrganization(requestParameters = {}) {
|
@@ -1222,7 +1222,7 @@ const OrganizationsApiFactory = function (configuration, basePath, axios) {
|
|
1222
1222
|
* Marks an organization as deleted. After 30 days, the organization will be permanently deleted.
|
1223
1223
|
* @summary Delete an organization
|
1224
1224
|
* @param {OrganizationsApiDeleteOrganizationRequest} requestParameters Request parameters.
|
1225
|
-
|
1225
|
+
* @deprecated
|
1226
1226
|
* @throws {RequiredError}
|
1227
1227
|
*/
|
1228
1228
|
deleteOrganization(requestParameters) {
|
@@ -1239,10 +1239,10 @@ const OrganizationsApiFactory = function (configuration, basePath, axios) {
|
|
1239
1239
|
return localVarFp.deleteOrganizationFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(axios, basePath));
|
1240
1240
|
},
|
1241
1241
|
/**
|
1242
|
-
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
|
1242
|
+
* 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.
|
1243
1243
|
* @summary Delete multiple organizations in bulk
|
1244
1244
|
* @param {OrganizationsApiDeleteOrganizationsRequest} requestParameters Request parameters.
|
1245
|
-
|
1245
|
+
* @deprecated
|
1246
1246
|
* @throws {RequiredError}
|
1247
1247
|
*/
|
1248
1248
|
deleteOrganizations(requestParameters) {
|
@@ -1252,17 +1252,17 @@ const OrganizationsApiFactory = function (configuration, basePath, axios) {
|
|
1252
1252
|
* 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.
|
1253
1253
|
* @summary Get details of an organization
|
1254
1254
|
* @param {OrganizationsApiGetOrganizationRequest} requestParameters Request parameters.
|
1255
|
-
|
1255
|
+
* @deprecated
|
1256
1256
|
* @throws {RequiredError}
|
1257
1257
|
*/
|
1258
1258
|
getOrganization(requestParameters) {
|
1259
1259
|
return localVarFp.getOrganization(requestParameters.id).then((request) => request(axios, basePath));
|
1260
1260
|
},
|
1261
1261
|
/**
|
1262
|
-
* Lists activities associated with an organization.
|
1262
|
+
* 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.
|
1263
1263
|
* @summary List activities associated with an organization
|
1264
1264
|
* @param {OrganizationsApiGetOrganizationActivitiesRequest} requestParameters Request parameters.
|
1265
|
-
|
1265
|
+
* @deprecated
|
1266
1266
|
* @throws {RequiredError}
|
1267
1267
|
*/
|
1268
1268
|
getOrganizationActivities(requestParameters) {
|
@@ -1279,10 +1279,10 @@ const OrganizationsApiFactory = function (configuration, basePath, axios) {
|
|
1279
1279
|
return localVarFp.getOrganizationChangelog(requestParameters.id, requestParameters.cursor, requestParameters.limit).then((request) => request(axios, basePath));
|
1280
1280
|
},
|
1281
1281
|
/**
|
1282
|
-
* Lists deals associated with an organization.
|
1282
|
+
* 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.
|
1283
1283
|
* @summary List deals associated with an organization
|
1284
1284
|
* @param {OrganizationsApiGetOrganizationDealsRequest} requestParameters Request parameters.
|
1285
|
-
|
1285
|
+
* @deprecated
|
1286
1286
|
* @throws {RequiredError}
|
1287
1287
|
*/
|
1288
1288
|
getOrganizationDeals(requestParameters) {
|
@@ -1319,10 +1319,10 @@ const OrganizationsApiFactory = function (configuration, basePath, axios) {
|
|
1319
1319
|
return localVarFp.getOrganizationMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
|
1320
1320
|
},
|
1321
1321
|
/**
|
1322
|
-
* 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.
|
1322
|
+
* 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.
|
1323
1323
|
* @summary List persons of an organization
|
1324
1324
|
* @param {OrganizationsApiGetOrganizationPersonsRequest} requestParameters Request parameters.
|
1325
|
-
|
1325
|
+
* @deprecated
|
1326
1326
|
* @throws {RequiredError}
|
1327
1327
|
*/
|
1328
1328
|
getOrganizationPersons(requestParameters) {
|
@@ -1352,17 +1352,17 @@ const OrganizationsApiFactory = function (configuration, basePath, axios) {
|
|
1352
1352
|
* Returns all organizations.
|
1353
1353
|
* @summary Get all organizations
|
1354
1354
|
* @param {OrganizationsApiGetOrganizationsRequest} requestParameters Request parameters.
|
1355
|
-
|
1355
|
+
* @deprecated
|
1356
1356
|
* @throws {RequiredError}
|
1357
1357
|
*/
|
1358
1358
|
getOrganizations(requestParameters = {}) {
|
1359
1359
|
return localVarFp.getOrganizations(requestParameters.user_id, requestParameters.filter_id, requestParameters.first_char, requestParameters.start, requestParameters.limit, requestParameters.sort).then((request) => request(axios, basePath));
|
1360
1360
|
},
|
1361
1361
|
/**
|
1362
|
-
* Returns all organizations.
|
1363
|
-
* @summary Get all organizations
|
1362
|
+
* 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.
|
1363
|
+
* @summary Get all organizations collection
|
1364
1364
|
* @param {OrganizationsApiGetOrganizationsCollectionRequest} requestParameters Request parameters.
|
1365
|
-
|
1365
|
+
* @deprecated
|
1366
1366
|
* @throws {RequiredError}
|
1367
1367
|
*/
|
1368
1368
|
getOrganizationsCollection(requestParameters = {}) {
|
@@ -1382,7 +1382,7 @@ const OrganizationsApiFactory = function (configuration, basePath, axios) {
|
|
1382
1382
|
* 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.
|
1383
1383
|
* @summary Search organizations
|
1384
1384
|
* @param {OrganizationsApiSearchOrganizationRequest} requestParameters Request parameters.
|
1385
|
-
|
1385
|
+
* @deprecated
|
1386
1386
|
* @throws {RequiredError}
|
1387
1387
|
*/
|
1388
1388
|
searchOrganization(requestParameters) {
|
@@ -1392,7 +1392,7 @@ const OrganizationsApiFactory = function (configuration, basePath, axios) {
|
|
1392
1392
|
* Updates the properties of an organization.
|
1393
1393
|
* @summary Update an organization
|
1394
1394
|
* @param {OrganizationsApiUpdateOrganizationRequest} requestParameters Request parameters.
|
1395
|
-
|
1395
|
+
* @deprecated
|
1396
1396
|
* @throws {RequiredError}
|
1397
1397
|
*/
|
1398
1398
|
updateOrganization(requestParameters) {
|
@@ -1412,7 +1412,7 @@ class OrganizationsApi extends base_1.BaseAPI {
|
|
1412
1412
|
* 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>.
|
1413
1413
|
* @summary Add an organization
|
1414
1414
|
* @param {OrganizationsApiAddOrganizationRequest} requestParameters Request parameters.
|
1415
|
-
|
1415
|
+
* @deprecated
|
1416
1416
|
* @throws {RequiredError}
|
1417
1417
|
* @memberof OrganizationsApi
|
1418
1418
|
*/
|
@@ -1434,7 +1434,7 @@ class OrganizationsApi extends base_1.BaseAPI {
|
|
1434
1434
|
* Marks an organization as deleted. After 30 days, the organization will be permanently deleted.
|
1435
1435
|
* @summary Delete an organization
|
1436
1436
|
* @param {OrganizationsApiDeleteOrganizationRequest} requestParameters Request parameters.
|
1437
|
-
|
1437
|
+
* @deprecated
|
1438
1438
|
* @throws {RequiredError}
|
1439
1439
|
* @memberof OrganizationsApi
|
1440
1440
|
*/
|
@@ -1453,10 +1453,10 @@ class OrganizationsApi extends base_1.BaseAPI {
|
|
1453
1453
|
return (0, exports.OrganizationsApiFp)(this.configuration).deleteOrganizationFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(this.axios, this.basePath));
|
1454
1454
|
}
|
1455
1455
|
/**
|
1456
|
-
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
|
1456
|
+
* 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.
|
1457
1457
|
* @summary Delete multiple organizations in bulk
|
1458
1458
|
* @param {OrganizationsApiDeleteOrganizationsRequest} requestParameters Request parameters.
|
1459
|
-
|
1459
|
+
* @deprecated
|
1460
1460
|
* @throws {RequiredError}
|
1461
1461
|
* @memberof OrganizationsApi
|
1462
1462
|
*/
|
@@ -1467,7 +1467,7 @@ class OrganizationsApi extends base_1.BaseAPI {
|
|
1467
1467
|
* 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.
|
1468
1468
|
* @summary Get details of an organization
|
1469
1469
|
* @param {OrganizationsApiGetOrganizationRequest} requestParameters Request parameters.
|
1470
|
-
|
1470
|
+
* @deprecated
|
1471
1471
|
* @throws {RequiredError}
|
1472
1472
|
* @memberof OrganizationsApi
|
1473
1473
|
*/
|
@@ -1475,10 +1475,10 @@ class OrganizationsApi extends base_1.BaseAPI {
|
|
1475
1475
|
return (0, exports.OrganizationsApiFp)(this.configuration).getOrganization(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
1476
1476
|
}
|
1477
1477
|
/**
|
1478
|
-
* Lists activities associated with an organization.
|
1478
|
+
* 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.
|
1479
1479
|
* @summary List activities associated with an organization
|
1480
1480
|
* @param {OrganizationsApiGetOrganizationActivitiesRequest} requestParameters Request parameters.
|
1481
|
-
|
1481
|
+
* @deprecated
|
1482
1482
|
* @throws {RequiredError}
|
1483
1483
|
* @memberof OrganizationsApi
|
1484
1484
|
*/
|
@@ -1497,10 +1497,10 @@ class OrganizationsApi extends base_1.BaseAPI {
|
|
1497
1497
|
return (0, exports.OrganizationsApiFp)(this.configuration).getOrganizationChangelog(requestParameters.id, requestParameters.cursor, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
1498
1498
|
}
|
1499
1499
|
/**
|
1500
|
-
* Lists deals associated with an organization.
|
1500
|
+
* 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.
|
1501
1501
|
* @summary List deals associated with an organization
|
1502
1502
|
* @param {OrganizationsApiGetOrganizationDealsRequest} requestParameters Request parameters.
|
1503
|
-
|
1503
|
+
* @deprecated
|
1504
1504
|
* @throws {RequiredError}
|
1505
1505
|
* @memberof OrganizationsApi
|
1506
1506
|
*/
|
@@ -1541,10 +1541,10 @@ class OrganizationsApi extends base_1.BaseAPI {
|
|
1541
1541
|
return (0, exports.OrganizationsApiFp)(this.configuration).getOrganizationMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
|
1542
1542
|
}
|
1543
1543
|
/**
|
1544
|
-
* 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.
|
1544
|
+
* 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.
|
1545
1545
|
* @summary List persons of an organization
|
1546
1546
|
* @param {OrganizationsApiGetOrganizationPersonsRequest} requestParameters Request parameters.
|
1547
|
-
|
1547
|
+
* @deprecated
|
1548
1548
|
* @throws {RequiredError}
|
1549
1549
|
* @memberof OrganizationsApi
|
1550
1550
|
*/
|
@@ -1577,7 +1577,7 @@ class OrganizationsApi extends base_1.BaseAPI {
|
|
1577
1577
|
* Returns all organizations.
|
1578
1578
|
* @summary Get all organizations
|
1579
1579
|
* @param {OrganizationsApiGetOrganizationsRequest} requestParameters Request parameters.
|
1580
|
-
|
1580
|
+
* @deprecated
|
1581
1581
|
* @throws {RequiredError}
|
1582
1582
|
* @memberof OrganizationsApi
|
1583
1583
|
*/
|
@@ -1585,10 +1585,10 @@ class OrganizationsApi extends base_1.BaseAPI {
|
|
1585
1585
|
return (0, exports.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));
|
1586
1586
|
}
|
1587
1587
|
/**
|
1588
|
-
* Returns all organizations.
|
1589
|
-
* @summary Get all organizations
|
1588
|
+
* 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.
|
1589
|
+
* @summary Get all organizations collection
|
1590
1590
|
* @param {OrganizationsApiGetOrganizationsCollectionRequest} requestParameters Request parameters.
|
1591
|
-
|
1591
|
+
* @deprecated
|
1592
1592
|
* @throws {RequiredError}
|
1593
1593
|
* @memberof OrganizationsApi
|
1594
1594
|
*/
|
@@ -1610,7 +1610,7 @@ class OrganizationsApi extends base_1.BaseAPI {
|
|
1610
1610
|
* 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.
|
1611
1611
|
* @summary Search organizations
|
1612
1612
|
* @param {OrganizationsApiSearchOrganizationRequest} requestParameters Request parameters.
|
1613
|
-
|
1613
|
+
* @deprecated
|
1614
1614
|
* @throws {RequiredError}
|
1615
1615
|
* @memberof OrganizationsApi
|
1616
1616
|
*/
|
@@ -1621,7 +1621,7 @@ class OrganizationsApi extends base_1.BaseAPI {
|
|
1621
1621
|
* Updates the properties of an organization.
|
1622
1622
|
* @summary Update an organization
|
1623
1623
|
* @param {OrganizationsApiUpdateOrganizationRequest} requestParameters Request parameters.
|
1624
|
-
|
1624
|
+
* @deprecated
|
1625
1625
|
* @throws {RequiredError}
|
1626
1626
|
* @memberof OrganizationsApi
|
1627
1627
|
*/
|