pipedrive 35.1.2 → 36.0.1
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/leads-api.d.ts +7 -7
- package/dist/esm/versions/v1/api/leads-api.js +2 -2
- package/dist/esm/versions/v1/models/deal-all-of.d.ts +6 -6
- package/dist/esm/versions/v1/models/index.d.ts +0 -3
- package/dist/esm/versions/v1/models/index.js +0 -3
- package/dist/esm/versions/v1/models/note-deal.d.ts +11 -5
- package/dist/esm/versions/v2/api/activities-api.d.ts +7 -7
- package/dist/esm/versions/v2/api/activities-api.js +2 -2
- package/dist/esm/versions/v2/api/deals-api.d.ts +14 -14
- package/dist/esm/versions/v2/api/deals-api.js +4 -4
- package/dist/esm/versions/v2/api/organizations-api.d.ts +7 -7
- package/dist/esm/versions/v2/api/organizations-api.js +2 -2
- package/dist/esm/versions/v2/api/persons-api.d.ts +7 -7
- package/dist/esm/versions/v2/api/persons-api.js +2 -2
- package/dist/esm/versions/v2/api/products-api.d.ts +7 -7
- package/dist/esm/versions/v2/api/products-api.js +2 -2
- package/dist/esm/versions/v2/models/index.d.ts +2 -5
- package/dist/esm/versions/v2/models/index.js +2 -5
- package/dist/esm/versions/v2/models/prices-array.d.ts +3 -3
- package/dist/esm/versions/v2/models/{product-request-prices-inner-all-of.d.ts → product-price-request.d.ts} +12 -2
- package/dist/{versions/v2/models/prices-array-prices-inner-all-of.d.ts → esm/versions/v2/models/product-price.d.ts} +12 -2
- package/dist/esm/versions/v2/models/product-request.d.ts +3 -3
- package/dist/versions/v1/api/leads-api.d.ts +7 -7
- package/dist/versions/v1/api/leads-api.js +2 -2
- package/dist/versions/v1/models/deal-all-of.d.ts +6 -6
- package/dist/versions/v1/models/index.d.ts +0 -3
- package/dist/versions/v1/models/index.js +0 -3
- package/dist/versions/v1/models/note-deal.d.ts +11 -5
- package/dist/versions/v2/api/activities-api.d.ts +7 -7
- package/dist/versions/v2/api/activities-api.js +2 -2
- package/dist/versions/v2/api/deals-api.d.ts +14 -14
- package/dist/versions/v2/api/deals-api.js +4 -4
- package/dist/versions/v2/api/organizations-api.d.ts +7 -7
- package/dist/versions/v2/api/organizations-api.js +2 -2
- package/dist/versions/v2/api/persons-api.d.ts +7 -7
- package/dist/versions/v2/api/persons-api.js +2 -2
- package/dist/versions/v2/api/products-api.d.ts +7 -7
- package/dist/versions/v2/api/products-api.js +2 -2
- package/dist/versions/v2/models/index.d.ts +2 -5
- package/dist/versions/v2/models/index.js +2 -5
- package/dist/versions/v2/models/prices-array.d.ts +3 -3
- package/dist/versions/v2/models/{product-request-prices-inner-all-of.d.ts → product-price-request.d.ts} +12 -2
- package/dist/{esm/versions/v2/models/prices-array-prices-inner-all-of.d.ts → versions/v2/models/product-price.d.ts} +12 -2
- package/dist/versions/v2/models/product-request.d.ts +3 -3
- package/package.json +1 -1
- package/dist/esm/versions/v1/models/deal-all-of-org-id.d.ts +0 -17
- package/dist/esm/versions/v1/models/deal-all-of-org-id.js +0 -14
- package/dist/esm/versions/v1/models/deal-all-of-person-id.d.ts +0 -17
- package/dist/esm/versions/v1/models/deal-all-of-person-id.js +0 -14
- package/dist/esm/versions/v1/models/note-deal-all-of.d.ts +0 -23
- package/dist/esm/versions/v1/models/note-deal-all-of.js +0 -14
- package/dist/esm/versions/v2/models/prices-array-prices-inner.d.ts +0 -18
- package/dist/esm/versions/v2/models/product-price-base.d.ts +0 -28
- package/dist/esm/versions/v2/models/product-price-base.js +0 -14
- package/dist/esm/versions/v2/models/product-request-prices-inner-all-of.js +0 -14
- package/dist/esm/versions/v2/models/product-request-prices-inner.d.ts +0 -18
- package/dist/esm/versions/v2/models/product-request-prices-inner.js +0 -14
- package/dist/versions/v1/models/deal-all-of-org-id.d.ts +0 -17
- package/dist/versions/v1/models/deal-all-of-org-id.js +0 -15
- package/dist/versions/v1/models/deal-all-of-person-id.d.ts +0 -17
- package/dist/versions/v1/models/deal-all-of-person-id.js +0 -15
- package/dist/versions/v1/models/note-deal-all-of.d.ts +0 -23
- package/dist/versions/v1/models/note-deal-all-of.js +0 -15
- package/dist/versions/v2/models/prices-array-prices-inner.d.ts +0 -18
- package/dist/versions/v2/models/product-price-base.d.ts +0 -28
- package/dist/versions/v2/models/product-price-base.js +0 -15
- package/dist/versions/v2/models/product-request-prices-inner-all-of.js +0 -15
- package/dist/versions/v2/models/product-request-prices-inner.d.ts +0 -18
- package/dist/versions/v2/models/product-request-prices-inner.js +0 -15
- /package/dist/esm/versions/v2/models/{prices-array-prices-inner-all-of.js → product-price-request.js} +0 -0
- /package/dist/esm/versions/v2/models/{prices-array-prices-inner.js → product-price.js} +0 -0
- /package/dist/versions/v2/models/{prices-array-prices-inner-all-of.js → product-price-request.js} +0 -0
- /package/dist/versions/v2/models/{prices-array-prices-inner.js → product-price.js} +0 -0
|
@@ -98,7 +98,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
98
98
|
* Returns data about all organizations.
|
|
99
99
|
* @summary Get all organizations
|
|
100
100
|
* @param {number} [filter_id] If supplied, only organizations matching the specified filter are returned
|
|
101
|
-
* @param {Set<
|
|
101
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
102
102
|
* @param {number} [owner_id] If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
103
103
|
* @param {string} [updated_since] If set, only organizations with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
104
104
|
* @param {string} [updated_until] If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
@@ -113,7 +113,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
113
113
|
|
|
114
114
|
* @throws {RequiredError}
|
|
115
115
|
*/
|
|
116
|
-
getOrganizations: (filter_id?: number, ids?: Set<
|
|
116
|
+
getOrganizations: (filter_id?: number, ids?: Set<number>, owner_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
117
117
|
/**
|
|
118
118
|
* 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.
|
|
119
119
|
* @summary Search organizations
|
|
@@ -211,7 +211,7 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
211
211
|
* Returns data about all organizations.
|
|
212
212
|
* @summary Get all organizations
|
|
213
213
|
* @param {number} [filter_id] If supplied, only organizations matching the specified filter are returned
|
|
214
|
-
* @param {Set<
|
|
214
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
215
215
|
* @param {number} [owner_id] If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
216
216
|
* @param {string} [updated_since] If set, only organizations with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
217
217
|
* @param {string} [updated_until] If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
@@ -226,7 +226,7 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
226
226
|
|
|
227
227
|
* @throws {RequiredError}
|
|
228
228
|
*/
|
|
229
|
-
getOrganizations(filter_id?: number, ids?: Set<
|
|
229
|
+
getOrganizations(filter_id?: number, ids?: Set<number>, owner_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetOrganizationsResponse>>;
|
|
230
230
|
/**
|
|
231
231
|
* 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.
|
|
232
232
|
* @summary Search organizations
|
|
@@ -499,11 +499,11 @@ export interface OrganizationsApiGetOrganizationsRequest {
|
|
|
499
499
|
*/
|
|
500
500
|
readonly filter_id?: number;
|
|
501
501
|
/**
|
|
502
|
-
* Optional comma separated
|
|
503
|
-
* @type {Set<
|
|
502
|
+
* Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
503
|
+
* @type {Set<number>}
|
|
504
504
|
* @memberof OrganizationsApiGetOrganizations
|
|
505
505
|
*/
|
|
506
|
-
readonly ids?: Set<
|
|
506
|
+
readonly ids?: Set<number>;
|
|
507
507
|
/**
|
|
508
508
|
* If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
509
509
|
* @type {number}
|
|
@@ -318,7 +318,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
318
318
|
* Returns data about all organizations.
|
|
319
319
|
* @summary Get all organizations
|
|
320
320
|
* @param {number} [filter_id] If supplied, only organizations matching the specified filter are returned
|
|
321
|
-
* @param {Set<
|
|
321
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
322
322
|
* @param {number} [owner_id] If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
323
323
|
* @param {string} [updated_since] If set, only organizations with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
324
324
|
* @param {string} [updated_until] If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
@@ -600,7 +600,7 @@ const OrganizationsApiFp = function (configuration) {
|
|
|
600
600
|
* Returns data about all organizations.
|
|
601
601
|
* @summary Get all organizations
|
|
602
602
|
* @param {number} [filter_id] If supplied, only organizations matching the specified filter are returned
|
|
603
|
-
* @param {Set<
|
|
603
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
604
604
|
* @param {number} [owner_id] If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
605
605
|
* @param {string} [updated_since] If set, only organizations with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
606
606
|
* @param {string} [updated_until] If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
@@ -107,7 +107,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
107
107
|
* Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
|
|
108
108
|
* @summary Get all persons
|
|
109
109
|
* @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
|
|
110
|
-
* @param {Set<
|
|
110
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
111
111
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
112
112
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
113
113
|
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
@@ -124,7 +124,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
124
124
|
|
|
125
125
|
* @throws {RequiredError}
|
|
126
126
|
*/
|
|
127
|
-
getPersons: (filter_id?: number, ids?: Set<
|
|
127
|
+
getPersons: (filter_id?: number, ids?: Set<number>, owner_id?: number, org_id?: number, deal_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
128
128
|
/**
|
|
129
129
|
* Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
|
|
130
130
|
* @summary Search persons
|
|
@@ -232,7 +232,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
232
232
|
* Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
|
|
233
233
|
* @summary Get all persons
|
|
234
234
|
* @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
|
|
235
|
-
* @param {Set<
|
|
235
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
236
236
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
237
237
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
238
238
|
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
@@ -249,7 +249,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
249
249
|
|
|
250
250
|
* @throws {RequiredError}
|
|
251
251
|
*/
|
|
252
|
-
getPersons(filter_id?: number, ids?: Set<
|
|
252
|
+
getPersons(filter_id?: number, ids?: Set<number>, owner_id?: number, org_id?: number, deal_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonsResponse>>;
|
|
253
253
|
/**
|
|
254
254
|
* Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
|
|
255
255
|
* @summary Search persons
|
|
@@ -545,11 +545,11 @@ export interface PersonsApiGetPersonsRequest {
|
|
|
545
545
|
*/
|
|
546
546
|
readonly filter_id?: number;
|
|
547
547
|
/**
|
|
548
|
-
* Optional comma separated
|
|
549
|
-
* @type {Set<
|
|
548
|
+
* Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
549
|
+
* @type {Set<number>}
|
|
550
550
|
* @memberof PersonsApiGetPersons
|
|
551
551
|
*/
|
|
552
|
-
readonly ids?: Set<
|
|
552
|
+
readonly ids?: Set<number>;
|
|
553
553
|
/**
|
|
554
554
|
* If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
555
555
|
* @type {number}
|
|
@@ -352,7 +352,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
352
352
|
* Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
|
|
353
353
|
* @summary Get all persons
|
|
354
354
|
* @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
|
|
355
|
-
* @param {Set<
|
|
355
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
356
356
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
357
357
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
358
358
|
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
@@ -663,7 +663,7 @@ const PersonsApiFp = function (configuration) {
|
|
|
663
663
|
* Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
|
|
664
664
|
* @summary Get all persons
|
|
665
665
|
* @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
|
|
666
|
-
* @param {Set<
|
|
666
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
667
667
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
668
668
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
669
669
|
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
@@ -156,7 +156,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
156
156
|
* Returns data about all products.
|
|
157
157
|
* @summary Get all products
|
|
158
158
|
* @param {number} [owner_id] If supplied, only products owned by the given user will be returned
|
|
159
|
-
* @param {Set<
|
|
159
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
160
160
|
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
161
161
|
* @param {number} [filter_id] The ID of the filter to use
|
|
162
162
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
@@ -167,7 +167,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
167
167
|
|
|
168
168
|
* @throws {RequiredError}
|
|
169
169
|
*/
|
|
170
|
-
getProducts: (owner_id?: number, ids?: Set<
|
|
170
|
+
getProducts: (owner_id?: number, ids?: Set<number>, custom_fields?: Set<string>, filter_id?: number, cursor?: string, limit?: number, sort_by?: 'id' | 'name' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc', updated_since?: string) => Promise<RequestArgs>;
|
|
171
171
|
/**
|
|
172
172
|
* Searches all products by name, code 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.
|
|
173
173
|
* @summary Search products
|
|
@@ -342,7 +342,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
342
342
|
* Returns data about all products.
|
|
343
343
|
* @summary Get all products
|
|
344
344
|
* @param {number} [owner_id] If supplied, only products owned by the given user will be returned
|
|
345
|
-
* @param {Set<
|
|
345
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
346
346
|
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
347
347
|
* @param {number} [filter_id] The ID of the filter to use
|
|
348
348
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
@@ -353,7 +353,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
353
353
|
|
|
354
354
|
* @throws {RequiredError}
|
|
355
355
|
*/
|
|
356
|
-
getProducts(owner_id?: number, ids?: Set<
|
|
356
|
+
getProducts(owner_id?: number, ids?: Set<number>, custom_fields?: Set<string>, filter_id?: number, cursor?: string, limit?: number, sort_by?: 'id' | 'name' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc', updated_since?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductsResponse>>;
|
|
357
357
|
/**
|
|
358
358
|
* Searches all products by name, code 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.
|
|
359
359
|
* @summary Search products
|
|
@@ -805,11 +805,11 @@ export interface ProductsApiGetProductsRequest {
|
|
|
805
805
|
*/
|
|
806
806
|
readonly owner_id?: number;
|
|
807
807
|
/**
|
|
808
|
-
* Optional comma separated
|
|
809
|
-
* @type {Set<
|
|
808
|
+
* Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
809
|
+
* @type {Set<number>}
|
|
810
810
|
* @memberof ProductsApiGetProducts
|
|
811
811
|
*/
|
|
812
|
-
readonly ids?: Set<
|
|
812
|
+
readonly ids?: Set<number>;
|
|
813
813
|
/**
|
|
814
814
|
* Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
815
815
|
* @type {Set<string>}
|
|
@@ -521,7 +521,7 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
521
521
|
* Returns data about all products.
|
|
522
522
|
* @summary Get all products
|
|
523
523
|
* @param {number} [owner_id] If supplied, only products owned by the given user will be returned
|
|
524
|
-
* @param {Set<
|
|
524
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
525
525
|
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
526
526
|
* @param {number} [filter_id] The ID of the filter to use
|
|
527
527
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
@@ -996,7 +996,7 @@ const ProductsApiFp = function (configuration) {
|
|
|
996
996
|
* Returns data about all products.
|
|
997
997
|
* @summary Get all products
|
|
998
998
|
* @param {number} [owner_id] If supplied, only products owned by the given user will be returned
|
|
999
|
-
* @param {Set<
|
|
999
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
1000
1000
|
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
1001
1001
|
* @param {number} [filter_id] The ID of the filter to use
|
|
1002
1002
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
@@ -261,12 +261,9 @@ export * from './person-item-email';
|
|
|
261
261
|
export * from './person-item-im';
|
|
262
262
|
export * from './person-item-phone';
|
|
263
263
|
export * from './prices-array';
|
|
264
|
-
export * from './
|
|
265
|
-
export * from './
|
|
266
|
-
export * from './product-price-base';
|
|
264
|
+
export * from './product-price';
|
|
265
|
+
export * from './product-price-request';
|
|
267
266
|
export * from './product-request';
|
|
268
|
-
export * from './product-request-prices-inner';
|
|
269
|
-
export * from './product-request-prices-inner-all-of';
|
|
270
267
|
export * from './project';
|
|
271
268
|
export * from './project-template';
|
|
272
269
|
export * from './stage-item';
|
|
@@ -277,12 +277,9 @@ __exportStar(require("./person-item-email"), exports);
|
|
|
277
277
|
__exportStar(require("./person-item-im"), exports);
|
|
278
278
|
__exportStar(require("./person-item-phone"), exports);
|
|
279
279
|
__exportStar(require("./prices-array"), exports);
|
|
280
|
-
__exportStar(require("./
|
|
281
|
-
__exportStar(require("./
|
|
282
|
-
__exportStar(require("./product-price-base"), exports);
|
|
280
|
+
__exportStar(require("./product-price"), exports);
|
|
281
|
+
__exportStar(require("./product-price-request"), exports);
|
|
283
282
|
__exportStar(require("./product-request"), exports);
|
|
284
|
-
__exportStar(require("./product-request-prices-inner"), exports);
|
|
285
|
-
__exportStar(require("./product-request-prices-inner-all-of"), exports);
|
|
286
283
|
__exportStar(require("./project"), exports);
|
|
287
284
|
__exportStar(require("./project-template"), exports);
|
|
288
285
|
__exportStar(require("./stage-item"), exports);
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import {
|
|
12
|
+
import { ProductPrice } from './product-price';
|
|
13
13
|
/**
|
|
14
14
|
*
|
|
15
15
|
* @export
|
|
@@ -18,7 +18,7 @@ import { PricesArrayPricesInner } from './prices-array-prices-inner';
|
|
|
18
18
|
export interface PricesArray {
|
|
19
19
|
/**
|
|
20
20
|
* The prices of the product in different currencies
|
|
21
|
-
* @type {Array<
|
|
21
|
+
* @type {Array<ProductPrice>}
|
|
22
22
|
*/
|
|
23
|
-
'prices'?: Array<
|
|
23
|
+
'prices'?: Array<ProductPrice>;
|
|
24
24
|
}
|
|
@@ -12,15 +12,25 @@
|
|
|
12
12
|
/**
|
|
13
13
|
*
|
|
14
14
|
* @export
|
|
15
|
-
* @interface
|
|
15
|
+
* @interface ProductPriceRequest
|
|
16
16
|
*/
|
|
17
|
-
export interface
|
|
17
|
+
export interface ProductPriceRequest {
|
|
18
|
+
/**
|
|
19
|
+
* The price of the product
|
|
20
|
+
* @type {number}
|
|
21
|
+
*/
|
|
22
|
+
'price': number;
|
|
18
23
|
/**
|
|
19
24
|
* The currency of the price
|
|
20
25
|
* @type {string}
|
|
21
26
|
*/
|
|
22
27
|
'currency': string;
|
|
23
28
|
/**
|
|
29
|
+
* The cost of the product
|
|
30
|
+
* @type {number}
|
|
31
|
+
*/
|
|
32
|
+
'cost'?: number;
|
|
33
|
+
/**
|
|
24
34
|
* The direct cost of the product
|
|
25
35
|
* @type {number}
|
|
26
36
|
*/
|
|
@@ -12,9 +12,19 @@
|
|
|
12
12
|
/**
|
|
13
13
|
*
|
|
14
14
|
* @export
|
|
15
|
-
* @interface
|
|
15
|
+
* @interface ProductPrice
|
|
16
16
|
*/
|
|
17
|
-
export interface
|
|
17
|
+
export interface ProductPrice {
|
|
18
|
+
/**
|
|
19
|
+
* The price of the product
|
|
20
|
+
* @type {number}
|
|
21
|
+
*/
|
|
22
|
+
'price'?: number;
|
|
23
|
+
/**
|
|
24
|
+
* The cost of the product
|
|
25
|
+
* @type {number}
|
|
26
|
+
*/
|
|
27
|
+
'cost'?: number;
|
|
18
28
|
/**
|
|
19
29
|
* The ID of the product
|
|
20
30
|
* @type {number}
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import {
|
|
12
|
+
import { ProductPriceRequest } from './product-price-request';
|
|
13
13
|
/**
|
|
14
14
|
*
|
|
15
15
|
* @export
|
|
@@ -58,9 +58,9 @@ export interface ProductRequest {
|
|
|
58
58
|
'visible_to'?: ProductRequestVisibleToConst;
|
|
59
59
|
/**
|
|
60
60
|
* The prices of the product in different currencies. Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and the user\'s default currency will be assigned.
|
|
61
|
-
* @type {Array<
|
|
61
|
+
* @type {Array<ProductPriceRequest>}
|
|
62
62
|
*/
|
|
63
|
-
'prices'?: Array<
|
|
63
|
+
'prices'?: Array<ProductPriceRequest>;
|
|
64
64
|
/**
|
|
65
65
|
* An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error.
|
|
66
66
|
* @type {{ [key: string]: any | undefined; }}
|
package/package.json
CHANGED
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Pipedrive API v1
|
|
3
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
-
*
|
|
5
|
-
* The version of the OpenAPI document: 1.0.0
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
-
* https://openapi-generator.tech
|
|
10
|
-
* Do not edit the class manually.
|
|
11
|
-
*/
|
|
12
|
-
import { DealOrganizationDataWithId } from './deal-organization-data-with-id';
|
|
13
|
-
/**
|
|
14
|
-
* @type DealAllOfOrgId
|
|
15
|
-
* @export
|
|
16
|
-
*/
|
|
17
|
-
export type DealAllOfOrgId = DealOrganizationDataWithId;
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/* tslint:disable */
|
|
2
|
-
/* eslint-disable */
|
|
3
|
-
/**
|
|
4
|
-
* Pipedrive API v1
|
|
5
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
6
|
-
*
|
|
7
|
-
* The version of the OpenAPI document: 1.0.0
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
-
* https://openapi-generator.tech
|
|
12
|
-
* Do not edit the class manually.
|
|
13
|
-
*/
|
|
14
|
-
export {};
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Pipedrive API v1
|
|
3
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
-
*
|
|
5
|
-
* The version of the OpenAPI document: 1.0.0
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
-
* https://openapi-generator.tech
|
|
10
|
-
* Do not edit the class manually.
|
|
11
|
-
*/
|
|
12
|
-
import { DealPersonDataWithId } from './deal-person-data-with-id';
|
|
13
|
-
/**
|
|
14
|
-
* @type DealAllOfPersonId
|
|
15
|
-
* @export
|
|
16
|
-
*/
|
|
17
|
-
export type DealAllOfPersonId = DealPersonDataWithId;
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/* tslint:disable */
|
|
2
|
-
/* eslint-disable */
|
|
3
|
-
/**
|
|
4
|
-
* Pipedrive API v1
|
|
5
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
6
|
-
*
|
|
7
|
-
* The version of the OpenAPI document: 1.0.0
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
-
* https://openapi-generator.tech
|
|
12
|
-
* Do not edit the class manually.
|
|
13
|
-
*/
|
|
14
|
-
export {};
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Pipedrive API v1
|
|
3
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
-
*
|
|
5
|
-
* The version of the OpenAPI document: 1.0.0
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
-
* https://openapi-generator.tech
|
|
10
|
-
* Do not edit the class manually.
|
|
11
|
-
*/
|
|
12
|
-
/**
|
|
13
|
-
* The deal this note is attached to
|
|
14
|
-
* @export
|
|
15
|
-
* @interface NoteDealAllOf
|
|
16
|
-
*/
|
|
17
|
-
export interface NoteDealAllOf {
|
|
18
|
-
/**
|
|
19
|
-
* The title of the deal this note is attached to
|
|
20
|
-
* @type {string}
|
|
21
|
-
*/
|
|
22
|
-
'title'?: string;
|
|
23
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/* tslint:disable */
|
|
2
|
-
/* eslint-disable */
|
|
3
|
-
/**
|
|
4
|
-
* Pipedrive API v1
|
|
5
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
6
|
-
*
|
|
7
|
-
* The version of the OpenAPI document: 1.0.0
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
-
* https://openapi-generator.tech
|
|
12
|
-
* Do not edit the class manually.
|
|
13
|
-
*/
|
|
14
|
-
export {};
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Pipedrive API v2
|
|
3
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
-
*
|
|
5
|
-
* The version of the OpenAPI document: 2.0.0
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
-
* https://openapi-generator.tech
|
|
10
|
-
* Do not edit the class manually.
|
|
11
|
-
*/
|
|
12
|
-
import { PricesArrayPricesInnerAllOf } from './prices-array-prices-inner-all-of';
|
|
13
|
-
import { ProductPriceBase } from './product-price-base';
|
|
14
|
-
/**
|
|
15
|
-
* @type PricesArrayPricesInner
|
|
16
|
-
* @export
|
|
17
|
-
*/
|
|
18
|
-
export type PricesArrayPricesInner = PricesArrayPricesInnerAllOf & ProductPriceBase;
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Pipedrive API v2
|
|
3
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
-
*
|
|
5
|
-
* The version of the OpenAPI document: 2.0.0
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
-
* https://openapi-generator.tech
|
|
10
|
-
* Do not edit the class manually.
|
|
11
|
-
*/
|
|
12
|
-
/**
|
|
13
|
-
*
|
|
14
|
-
* @export
|
|
15
|
-
* @interface ProductPriceBase
|
|
16
|
-
*/
|
|
17
|
-
export interface ProductPriceBase {
|
|
18
|
-
/**
|
|
19
|
-
* The price of the product
|
|
20
|
-
* @type {number}
|
|
21
|
-
*/
|
|
22
|
-
'price'?: number;
|
|
23
|
-
/**
|
|
24
|
-
* The cost of the product
|
|
25
|
-
* @type {number}
|
|
26
|
-
*/
|
|
27
|
-
'cost'?: number;
|
|
28
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/* tslint:disable */
|
|
2
|
-
/* eslint-disable */
|
|
3
|
-
/**
|
|
4
|
-
* Pipedrive API v2
|
|
5
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
6
|
-
*
|
|
7
|
-
* The version of the OpenAPI document: 2.0.0
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
-
* https://openapi-generator.tech
|
|
12
|
-
* Do not edit the class manually.
|
|
13
|
-
*/
|
|
14
|
-
export {};
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/* tslint:disable */
|
|
2
|
-
/* eslint-disable */
|
|
3
|
-
/**
|
|
4
|
-
* Pipedrive API v2
|
|
5
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
6
|
-
*
|
|
7
|
-
* The version of the OpenAPI document: 2.0.0
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
-
* https://openapi-generator.tech
|
|
12
|
-
* Do not edit the class manually.
|
|
13
|
-
*/
|
|
14
|
-
export {};
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Pipedrive API v2
|
|
3
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
-
*
|
|
5
|
-
* The version of the OpenAPI document: 2.0.0
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
-
* https://openapi-generator.tech
|
|
10
|
-
* Do not edit the class manually.
|
|
11
|
-
*/
|
|
12
|
-
import { ProductPriceBase } from './product-price-base';
|
|
13
|
-
import { ProductRequestPricesInnerAllOf } from './product-request-prices-inner-all-of';
|
|
14
|
-
/**
|
|
15
|
-
* @type ProductRequestPricesInner
|
|
16
|
-
* @export
|
|
17
|
-
*/
|
|
18
|
-
export type ProductRequestPricesInner = ProductPriceBase & ProductRequestPricesInnerAllOf;
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/* tslint:disable */
|
|
2
|
-
/* eslint-disable */
|
|
3
|
-
/**
|
|
4
|
-
* Pipedrive API v2
|
|
5
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
6
|
-
*
|
|
7
|
-
* The version of the OpenAPI document: 2.0.0
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
-
* https://openapi-generator.tech
|
|
12
|
-
* Do not edit the class manually.
|
|
13
|
-
*/
|
|
14
|
-
export {};
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Pipedrive API v1
|
|
3
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
-
*
|
|
5
|
-
* The version of the OpenAPI document: 1.0.0
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
-
* https://openapi-generator.tech
|
|
10
|
-
* Do not edit the class manually.
|
|
11
|
-
*/
|
|
12
|
-
import { DealOrganizationDataWithId } from './deal-organization-data-with-id';
|
|
13
|
-
/**
|
|
14
|
-
* @type DealAllOfOrgId
|
|
15
|
-
* @export
|
|
16
|
-
*/
|
|
17
|
-
export type DealAllOfOrgId = DealOrganizationDataWithId;
|