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
@@ -45,7 +45,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
45
45
|
* 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>.
|
46
46
|
* @summary Add an organization
|
47
47
|
* @param {AddOrganizationRequest} [AddOrganizationRequest]
|
48
|
-
|
48
|
+
* @deprecated
|
49
49
|
* @throws {RequiredError}
|
50
50
|
*/
|
51
51
|
addOrganization: (AddOrganizationRequest?: AddOrganizationRequest) => Promise<RequestArgs>;
|
@@ -62,7 +62,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
62
62
|
* Marks an organization as deleted. After 30 days, the organization will be permanently deleted.
|
63
63
|
* @summary Delete an organization
|
64
64
|
* @param {number} id The ID of the organization
|
65
|
-
|
65
|
+
* @deprecated
|
66
66
|
* @throws {RequiredError}
|
67
67
|
*/
|
68
68
|
deleteOrganization: (id: number) => Promise<RequestArgs>;
|
@@ -76,10 +76,10 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
76
76
|
*/
|
77
77
|
deleteOrganizationFollower: (id: number, follower_id: number) => Promise<RequestArgs>;
|
78
78
|
/**
|
79
|
-
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
|
79
|
+
* 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.
|
80
80
|
* @summary Delete multiple organizations in bulk
|
81
81
|
* @param {string} ids The comma-separated IDs that will be deleted
|
82
|
-
|
82
|
+
* @deprecated
|
83
83
|
* @throws {RequiredError}
|
84
84
|
*/
|
85
85
|
deleteOrganizations: (ids: string) => Promise<RequestArgs>;
|
@@ -87,19 +87,19 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
87
87
|
* 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.
|
88
88
|
* @summary Get details of an organization
|
89
89
|
* @param {number} id The ID of the organization
|
90
|
-
|
90
|
+
* @deprecated
|
91
91
|
* @throws {RequiredError}
|
92
92
|
*/
|
93
93
|
getOrganization: (id: number) => Promise<RequestArgs>;
|
94
94
|
/**
|
95
|
-
* Lists activities associated with an organization.
|
95
|
+
* 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.
|
96
96
|
* @summary List activities associated with an organization
|
97
97
|
* @param {number} id The ID of the organization
|
98
98
|
* @param {number} [start] Pagination start
|
99
99
|
* @param {number} [limit] Items shown per page
|
100
100
|
* @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.
|
101
101
|
* @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
|
102
|
-
|
102
|
+
* @deprecated
|
103
103
|
* @throws {RequiredError}
|
104
104
|
*/
|
105
105
|
getOrganizationActivities: (id: number, start?: number, limit?: number, done?: 0 | 1, exclude?: string) => Promise<RequestArgs>;
|
@@ -114,7 +114,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
114
114
|
*/
|
115
115
|
getOrganizationChangelog: (id: number, cursor?: string, limit?: number) => Promise<RequestArgs>;
|
116
116
|
/**
|
117
|
-
* Lists deals associated with an organization.
|
117
|
+
* 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.
|
118
118
|
* @summary List deals associated with an organization
|
119
119
|
* @param {number} id The ID of the organization
|
120
120
|
* @param {number} [start] Pagination start
|
@@ -122,7 +122,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
122
122
|
* @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.
|
123
123
|
* @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).
|
124
124
|
* @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.
|
125
|
-
|
125
|
+
* @deprecated
|
126
126
|
* @throws {RequiredError}
|
127
127
|
*/
|
128
128
|
getOrganizationDeals: (id: number, start?: number, limit?: number, status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted', sort?: string, only_primary_association?: 0 | 1) => Promise<RequestArgs>;
|
@@ -156,12 +156,12 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
156
156
|
*/
|
157
157
|
getOrganizationMailMessages: (id: number, start?: number, limit?: number) => Promise<RequestArgs>;
|
158
158
|
/**
|
159
|
-
* 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.
|
159
|
+
* 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.
|
160
160
|
* @summary List persons of an organization
|
161
161
|
* @param {number} id The ID of the organization
|
162
162
|
* @param {number} [start] Pagination start
|
163
163
|
* @param {number} [limit] Items shown per page
|
164
|
-
|
164
|
+
* @deprecated
|
165
165
|
* @throws {RequiredError}
|
166
166
|
*/
|
167
167
|
getOrganizationPersons: (id: number, start?: number, limit?: number) => Promise<RequestArgs>;
|
@@ -194,20 +194,20 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
194
194
|
* @param {number} [start] Pagination start
|
195
195
|
* @param {number} [limit] Items shown per page
|
196
196
|
* @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).
|
197
|
-
|
197
|
+
* @deprecated
|
198
198
|
* @throws {RequiredError}
|
199
199
|
*/
|
200
200
|
getOrganizations: (user_id?: number, filter_id?: number, first_char?: string, start?: number, limit?: number, sort?: string) => Promise<RequestArgs>;
|
201
201
|
/**
|
202
|
-
* Returns all organizations.
|
203
|
-
* @summary Get all organizations
|
202
|
+
* 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.
|
203
|
+
* @summary Get all organizations collection
|
204
204
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
205
205
|
* @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.
|
206
206
|
* @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.
|
207
207
|
* @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.
|
208
208
|
* @param {number} [owner_id] If supplied, only organizations owned by the given user will be returned
|
209
209
|
* @param {string} [first_char] If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive)
|
210
|
-
|
210
|
+
* @deprecated
|
211
211
|
* @throws {RequiredError}
|
212
212
|
*/
|
213
213
|
getOrganizationsCollection: (cursor?: string, limit?: number, since?: string, until?: string, owner_id?: number, first_char?: string) => Promise<RequestArgs>;
|
@@ -228,7 +228,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
228
228
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
229
229
|
* @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.
|
230
230
|
* @param {number} [limit] Items shown per page
|
231
|
-
|
231
|
+
* @deprecated
|
232
232
|
* @throws {RequiredError}
|
233
233
|
*/
|
234
234
|
searchOrganization: (term: string, fields?: 'address' | 'custom_fields' | 'notes' | 'name', exact_match?: boolean, start?: number, limit?: number) => Promise<RequestArgs>;
|
@@ -237,7 +237,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
237
237
|
* @summary Update an organization
|
238
238
|
* @param {number} id The ID of the organization
|
239
239
|
* @param {UpdateOrganizationRequest} [UpdateOrganizationRequest]
|
240
|
-
|
240
|
+
* @deprecated
|
241
241
|
* @throws {RequiredError}
|
242
242
|
*/
|
243
243
|
updateOrganization: (id: number, UpdateOrganizationRequest?: UpdateOrganizationRequest) => Promise<RequestArgs>;
|
@@ -251,7 +251,7 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
251
251
|
* 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>.
|
252
252
|
* @summary Add an organization
|
253
253
|
* @param {AddOrganizationRequest} [AddOrganizationRequest]
|
254
|
-
|
254
|
+
* @deprecated
|
255
255
|
* @throws {RequiredError}
|
256
256
|
*/
|
257
257
|
addOrganization(AddOrganizationRequest?: AddOrganizationRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddOrganizationResponse>>;
|
@@ -268,7 +268,7 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
268
268
|
* Marks an organization as deleted. After 30 days, the organization will be permanently deleted.
|
269
269
|
* @summary Delete an organization
|
270
270
|
* @param {number} id The ID of the organization
|
271
|
-
|
271
|
+
* @deprecated
|
272
272
|
* @throws {RequiredError}
|
273
273
|
*/
|
274
274
|
deleteOrganization(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteOrganizationResponse>>;
|
@@ -282,10 +282,10 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
282
282
|
*/
|
283
283
|
deleteOrganizationFollower(id: number, follower_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteOrganizationFollowerResponse>>;
|
284
284
|
/**
|
285
|
-
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
|
285
|
+
* 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.
|
286
286
|
* @summary Delete multiple organizations in bulk
|
287
287
|
* @param {string} ids The comma-separated IDs that will be deleted
|
288
|
-
|
288
|
+
* @deprecated
|
289
289
|
* @throws {RequiredError}
|
290
290
|
*/
|
291
291
|
deleteOrganizations(ids: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteOrganizationsResponse>>;
|
@@ -293,19 +293,19 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
293
293
|
* 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.
|
294
294
|
* @summary Get details of an organization
|
295
295
|
* @param {number} id The ID of the organization
|
296
|
-
|
296
|
+
* @deprecated
|
297
297
|
* @throws {RequiredError}
|
298
298
|
*/
|
299
299
|
getOrganization(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetOrganizationResponse>>;
|
300
300
|
/**
|
301
|
-
* Lists activities associated with an organization.
|
301
|
+
* 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.
|
302
302
|
* @summary List activities associated with an organization
|
303
303
|
* @param {number} id The ID of the organization
|
304
304
|
* @param {number} [start] Pagination start
|
305
305
|
* @param {number} [limit] Items shown per page
|
306
306
|
* @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.
|
307
307
|
* @param {string} [exclude] A comma-separated string of activity IDs to exclude from result
|
308
|
-
|
308
|
+
* @deprecated
|
309
309
|
* @throws {RequiredError}
|
310
310
|
*/
|
311
311
|
getOrganizationActivities(id: number, start?: number, limit?: number, done?: 0 | 1, exclude?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedActivitiesResponse>>;
|
@@ -320,7 +320,7 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
320
320
|
*/
|
321
321
|
getOrganizationChangelog(id: number, cursor?: string, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetChangelogResponse>>;
|
322
322
|
/**
|
323
|
-
* Lists deals associated with an organization.
|
323
|
+
* 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.
|
324
324
|
* @summary List deals associated with an organization
|
325
325
|
* @param {number} id The ID of the organization
|
326
326
|
* @param {number} [start] Pagination start
|
@@ -328,7 +328,7 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
328
328
|
* @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.
|
329
329
|
* @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).
|
330
330
|
* @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.
|
331
|
-
|
331
|
+
* @deprecated
|
332
332
|
* @throws {RequiredError}
|
333
333
|
*/
|
334
334
|
getOrganizationDeals(id: number, start?: number, limit?: number, status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted', sort?: string, only_primary_association?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedDealsResponse>>;
|
@@ -362,12 +362,12 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
362
362
|
*/
|
363
363
|
getOrganizationMailMessages(id: number, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedMailMessagesResponse>>;
|
364
364
|
/**
|
365
|
-
* 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.
|
365
|
+
* 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.
|
366
366
|
* @summary List persons of an organization
|
367
367
|
* @param {number} id The ID of the organization
|
368
368
|
* @param {number} [start] Pagination start
|
369
369
|
* @param {number} [limit] Items shown per page
|
370
|
-
|
370
|
+
* @deprecated
|
371
371
|
* @throws {RequiredError}
|
372
372
|
*/
|
373
373
|
getOrganizationPersons(id: number, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonsResponse>>;
|
@@ -400,20 +400,20 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
400
400
|
* @param {number} [start] Pagination start
|
401
401
|
* @param {number} [limit] Items shown per page
|
402
402
|
* @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).
|
403
|
-
|
403
|
+
* @deprecated
|
404
404
|
* @throws {RequiredError}
|
405
405
|
*/
|
406
406
|
getOrganizations(user_id?: number, filter_id?: number, first_char?: string, start?: number, limit?: number, sort?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetOrganizationsResponse>>;
|
407
407
|
/**
|
408
|
-
* Returns all organizations.
|
409
|
-
* @summary Get all organizations
|
408
|
+
* 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.
|
409
|
+
* @summary Get all organizations collection
|
410
410
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
411
411
|
* @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.
|
412
412
|
* @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.
|
413
413
|
* @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.
|
414
414
|
* @param {number} [owner_id] If supplied, only organizations owned by the given user will be returned
|
415
415
|
* @param {string} [first_char] If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive)
|
416
|
-
|
416
|
+
* @deprecated
|
417
417
|
* @throws {RequiredError}
|
418
418
|
*/
|
419
419
|
getOrganizationsCollection(cursor?: string, limit?: number, since?: string, until?: string, owner_id?: number, first_char?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetOrganizationsCollection200Response>>;
|
@@ -434,7 +434,7 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
434
434
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
435
435
|
* @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.
|
436
436
|
* @param {number} [limit] Items shown per page
|
437
|
-
|
437
|
+
* @deprecated
|
438
438
|
* @throws {RequiredError}
|
439
439
|
*/
|
440
440
|
searchOrganization(term: string, fields?: 'address' | 'custom_fields' | 'notes' | 'name', exact_match?: boolean, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetOrganizationSearchResponse>>;
|
@@ -443,7 +443,7 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
443
443
|
* @summary Update an organization
|
444
444
|
* @param {number} id The ID of the organization
|
445
445
|
* @param {UpdateOrganizationRequest} [UpdateOrganizationRequest]
|
446
|
-
|
446
|
+
* @deprecated
|
447
447
|
* @throws {RequiredError}
|
448
448
|
*/
|
449
449
|
updateOrganization(id: number, UpdateOrganizationRequest?: UpdateOrganizationRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateOrganizationResponse>>;
|
@@ -457,7 +457,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
457
457
|
* 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>.
|
458
458
|
* @summary Add an organization
|
459
459
|
* @param {OrganizationsApiAddOrganizationRequest} requestParameters Request parameters.
|
460
|
-
|
460
|
+
* @deprecated
|
461
461
|
* @throws {RequiredError}
|
462
462
|
*/
|
463
463
|
addOrganization(requestParameters?: OrganizationsApiAddOrganizationRequest): Promise<AddOrganizationResponse>;
|
@@ -473,7 +473,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
473
473
|
* Marks an organization as deleted. After 30 days, the organization will be permanently deleted.
|
474
474
|
* @summary Delete an organization
|
475
475
|
* @param {OrganizationsApiDeleteOrganizationRequest} requestParameters Request parameters.
|
476
|
-
|
476
|
+
* @deprecated
|
477
477
|
* @throws {RequiredError}
|
478
478
|
*/
|
479
479
|
deleteOrganization(requestParameters: OrganizationsApiDeleteOrganizationRequest): Promise<DeleteOrganizationResponse>;
|
@@ -486,10 +486,10 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
486
486
|
*/
|
487
487
|
deleteOrganizationFollower(requestParameters: OrganizationsApiDeleteOrganizationFollowerRequest): Promise<DeleteOrganizationFollowerResponse>;
|
488
488
|
/**
|
489
|
-
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
|
489
|
+
* 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.
|
490
490
|
* @summary Delete multiple organizations in bulk
|
491
491
|
* @param {OrganizationsApiDeleteOrganizationsRequest} requestParameters Request parameters.
|
492
|
-
|
492
|
+
* @deprecated
|
493
493
|
* @throws {RequiredError}
|
494
494
|
*/
|
495
495
|
deleteOrganizations(requestParameters: OrganizationsApiDeleteOrganizationsRequest): Promise<DeleteOrganizationsResponse>;
|
@@ -497,15 +497,15 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
497
497
|
* 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.
|
498
498
|
* @summary Get details of an organization
|
499
499
|
* @param {OrganizationsApiGetOrganizationRequest} requestParameters Request parameters.
|
500
|
-
|
500
|
+
* @deprecated
|
501
501
|
* @throws {RequiredError}
|
502
502
|
*/
|
503
503
|
getOrganization(requestParameters: OrganizationsApiGetOrganizationRequest): Promise<GetOrganizationResponse>;
|
504
504
|
/**
|
505
|
-
* Lists activities associated with an organization.
|
505
|
+
* 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.
|
506
506
|
* @summary List activities associated with an organization
|
507
507
|
* @param {OrganizationsApiGetOrganizationActivitiesRequest} requestParameters Request parameters.
|
508
|
-
|
508
|
+
* @deprecated
|
509
509
|
* @throws {RequiredError}
|
510
510
|
*/
|
511
511
|
getOrganizationActivities(requestParameters: OrganizationsApiGetOrganizationActivitiesRequest): Promise<GetAssociatedActivitiesResponse>;
|
@@ -518,10 +518,10 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
518
518
|
*/
|
519
519
|
getOrganizationChangelog(requestParameters: OrganizationsApiGetOrganizationChangelogRequest): Promise<GetChangelogResponse>;
|
520
520
|
/**
|
521
|
-
* Lists deals associated with an organization.
|
521
|
+
* 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.
|
522
522
|
* @summary List deals associated with an organization
|
523
523
|
* @param {OrganizationsApiGetOrganizationDealsRequest} requestParameters Request parameters.
|
524
|
-
|
524
|
+
* @deprecated
|
525
525
|
* @throws {RequiredError}
|
526
526
|
*/
|
527
527
|
getOrganizationDeals(requestParameters: OrganizationsApiGetOrganizationDealsRequest): Promise<GetAssociatedDealsResponse>;
|
@@ -550,10 +550,10 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
550
550
|
*/
|
551
551
|
getOrganizationMailMessages(requestParameters: OrganizationsApiGetOrganizationMailMessagesRequest): Promise<GetAssociatedMailMessagesResponse>;
|
552
552
|
/**
|
553
|
-
* 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.
|
553
|
+
* 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.
|
554
554
|
* @summary List persons of an organization
|
555
555
|
* @param {OrganizationsApiGetOrganizationPersonsRequest} requestParameters Request parameters.
|
556
|
-
|
556
|
+
* @deprecated
|
557
557
|
* @throws {RequiredError}
|
558
558
|
*/
|
559
559
|
getOrganizationPersons(requestParameters: OrganizationsApiGetOrganizationPersonsRequest): Promise<GetPersonsResponse>;
|
@@ -577,15 +577,15 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
577
577
|
* Returns all organizations.
|
578
578
|
* @summary Get all organizations
|
579
579
|
* @param {OrganizationsApiGetOrganizationsRequest} requestParameters Request parameters.
|
580
|
-
|
580
|
+
* @deprecated
|
581
581
|
* @throws {RequiredError}
|
582
582
|
*/
|
583
583
|
getOrganizations(requestParameters?: OrganizationsApiGetOrganizationsRequest): Promise<GetOrganizationsResponse>;
|
584
584
|
/**
|
585
|
-
* Returns all organizations.
|
586
|
-
* @summary Get all organizations
|
585
|
+
* 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.
|
586
|
+
* @summary Get all organizations collection
|
587
587
|
* @param {OrganizationsApiGetOrganizationsCollectionRequest} requestParameters Request parameters.
|
588
|
-
|
588
|
+
* @deprecated
|
589
589
|
* @throws {RequiredError}
|
590
590
|
*/
|
591
591
|
getOrganizationsCollection(requestParameters?: OrganizationsApiGetOrganizationsCollectionRequest): Promise<GetOrganizationsCollection200Response>;
|
@@ -601,7 +601,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
601
601
|
* 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.
|
602
602
|
* @summary Search organizations
|
603
603
|
* @param {OrganizationsApiSearchOrganizationRequest} requestParameters Request parameters.
|
604
|
-
|
604
|
+
* @deprecated
|
605
605
|
* @throws {RequiredError}
|
606
606
|
*/
|
607
607
|
searchOrganization(requestParameters: OrganizationsApiSearchOrganizationRequest): Promise<GetOrganizationSearchResponse>;
|
@@ -609,7 +609,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
609
609
|
* Updates the properties of an organization.
|
610
610
|
* @summary Update an organization
|
611
611
|
* @param {OrganizationsApiUpdateOrganizationRequest} requestParameters Request parameters.
|
612
|
-
|
612
|
+
* @deprecated
|
613
613
|
* @throws {RequiredError}
|
614
614
|
*/
|
615
615
|
updateOrganization(requestParameters: OrganizationsApiUpdateOrganizationRequest): Promise<UpdateOrganizationResponse>;
|
@@ -1125,7 +1125,7 @@ export declare class OrganizationsApi extends BaseAPI {
|
|
1125
1125
|
* 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>.
|
1126
1126
|
* @summary Add an organization
|
1127
1127
|
* @param {OrganizationsApiAddOrganizationRequest} requestParameters Request parameters.
|
1128
|
-
|
1128
|
+
* @deprecated
|
1129
1129
|
* @throws {RequiredError}
|
1130
1130
|
* @memberof OrganizationsApi
|
1131
1131
|
*/
|
@@ -1143,7 +1143,7 @@ export declare class OrganizationsApi extends BaseAPI {
|
|
1143
1143
|
* Marks an organization as deleted. After 30 days, the organization will be permanently deleted.
|
1144
1144
|
* @summary Delete an organization
|
1145
1145
|
* @param {OrganizationsApiDeleteOrganizationRequest} requestParameters Request parameters.
|
1146
|
-
|
1146
|
+
* @deprecated
|
1147
1147
|
* @throws {RequiredError}
|
1148
1148
|
* @memberof OrganizationsApi
|
1149
1149
|
*/
|
@@ -1158,10 +1158,10 @@ export declare class OrganizationsApi extends BaseAPI {
|
|
1158
1158
|
*/
|
1159
1159
|
deleteOrganizationFollower(requestParameters: OrganizationsApiDeleteOrganizationFollowerRequest): Promise<DeleteOrganizationFollowerResponse>;
|
1160
1160
|
/**
|
1161
|
-
* Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
|
1161
|
+
* 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.
|
1162
1162
|
* @summary Delete multiple organizations in bulk
|
1163
1163
|
* @param {OrganizationsApiDeleteOrganizationsRequest} requestParameters Request parameters.
|
1164
|
-
|
1164
|
+
* @deprecated
|
1165
1165
|
* @throws {RequiredError}
|
1166
1166
|
* @memberof OrganizationsApi
|
1167
1167
|
*/
|
@@ -1170,16 +1170,16 @@ export declare class OrganizationsApi extends BaseAPI {
|
|
1170
1170
|
* 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.
|
1171
1171
|
* @summary Get details of an organization
|
1172
1172
|
* @param {OrganizationsApiGetOrganizationRequest} requestParameters Request parameters.
|
1173
|
-
|
1173
|
+
* @deprecated
|
1174
1174
|
* @throws {RequiredError}
|
1175
1175
|
* @memberof OrganizationsApi
|
1176
1176
|
*/
|
1177
1177
|
getOrganization(requestParameters: OrganizationsApiGetOrganizationRequest): Promise<GetOrganizationResponse>;
|
1178
1178
|
/**
|
1179
|
-
* Lists activities associated with an organization.
|
1179
|
+
* 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.
|
1180
1180
|
* @summary List activities associated with an organization
|
1181
1181
|
* @param {OrganizationsApiGetOrganizationActivitiesRequest} requestParameters Request parameters.
|
1182
|
-
|
1182
|
+
* @deprecated
|
1183
1183
|
* @throws {RequiredError}
|
1184
1184
|
* @memberof OrganizationsApi
|
1185
1185
|
*/
|
@@ -1194,10 +1194,10 @@ export declare class OrganizationsApi extends BaseAPI {
|
|
1194
1194
|
*/
|
1195
1195
|
getOrganizationChangelog(requestParameters: OrganizationsApiGetOrganizationChangelogRequest): Promise<GetChangelogResponse>;
|
1196
1196
|
/**
|
1197
|
-
* Lists deals associated with an organization.
|
1197
|
+
* 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.
|
1198
1198
|
* @summary List deals associated with an organization
|
1199
1199
|
* @param {OrganizationsApiGetOrganizationDealsRequest} requestParameters Request parameters.
|
1200
|
-
|
1200
|
+
* @deprecated
|
1201
1201
|
* @throws {RequiredError}
|
1202
1202
|
* @memberof OrganizationsApi
|
1203
1203
|
*/
|
@@ -1230,10 +1230,10 @@ export declare class OrganizationsApi extends BaseAPI {
|
|
1230
1230
|
*/
|
1231
1231
|
getOrganizationMailMessages(requestParameters: OrganizationsApiGetOrganizationMailMessagesRequest): Promise<GetAssociatedMailMessagesResponse>;
|
1232
1232
|
/**
|
1233
|
-
* 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.
|
1233
|
+
* 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.
|
1234
1234
|
* @summary List persons of an organization
|
1235
1235
|
* @param {OrganizationsApiGetOrganizationPersonsRequest} requestParameters Request parameters.
|
1236
|
-
|
1236
|
+
* @deprecated
|
1237
1237
|
* @throws {RequiredError}
|
1238
1238
|
* @memberof OrganizationsApi
|
1239
1239
|
*/
|
@@ -1260,16 +1260,16 @@ export declare class OrganizationsApi extends BaseAPI {
|
|
1260
1260
|
* Returns all organizations.
|
1261
1261
|
* @summary Get all organizations
|
1262
1262
|
* @param {OrganizationsApiGetOrganizationsRequest} requestParameters Request parameters.
|
1263
|
-
|
1263
|
+
* @deprecated
|
1264
1264
|
* @throws {RequiredError}
|
1265
1265
|
* @memberof OrganizationsApi
|
1266
1266
|
*/
|
1267
1267
|
getOrganizations(requestParameters?: OrganizationsApiGetOrganizationsRequest): Promise<GetOrganizationsResponse>;
|
1268
1268
|
/**
|
1269
|
-
* Returns all organizations.
|
1270
|
-
* @summary Get all organizations
|
1269
|
+
* 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.
|
1270
|
+
* @summary Get all organizations collection
|
1271
1271
|
* @param {OrganizationsApiGetOrganizationsCollectionRequest} requestParameters Request parameters.
|
1272
|
-
|
1272
|
+
* @deprecated
|
1273
1273
|
* @throws {RequiredError}
|
1274
1274
|
* @memberof OrganizationsApi
|
1275
1275
|
*/
|
@@ -1287,7 +1287,7 @@ export declare class OrganizationsApi extends BaseAPI {
|
|
1287
1287
|
* 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.
|
1288
1288
|
* @summary Search organizations
|
1289
1289
|
* @param {OrganizationsApiSearchOrganizationRequest} requestParameters Request parameters.
|
1290
|
-
|
1290
|
+
* @deprecated
|
1291
1291
|
* @throws {RequiredError}
|
1292
1292
|
* @memberof OrganizationsApi
|
1293
1293
|
*/
|
@@ -1296,7 +1296,7 @@ export declare class OrganizationsApi extends BaseAPI {
|
|
1296
1296
|
* Updates the properties of an organization.
|
1297
1297
|
* @summary Update an organization
|
1298
1298
|
* @param {OrganizationsApiUpdateOrganizationRequest} requestParameters Request parameters.
|
1299
|
-
|
1299
|
+
* @deprecated
|
1300
1300
|
* @throws {RequiredError}
|
1301
1301
|
* @memberof OrganizationsApi
|
1302
1302
|
*/
|