pipedrive 33.4.0 → 33.4.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.
Files changed (27) hide show
  1. package/dist/esm/versions/v2/api/products-api.d.ts +10 -2
  2. package/dist/esm/versions/v2/api/products-api.js +10 -5
  3. package/dist/esm/versions/v2/models/base-product-all-of.d.ts +21 -1
  4. package/dist/esm/versions/v2/models/get-product-response.d.ts +3 -3
  5. package/dist/esm/versions/v2/models/{get-product-response-data.d.ts → get-products-response-data-inner.d.ts} +2 -2
  6. package/dist/esm/versions/v2/models/get-products-response.d.ts +3 -3
  7. package/dist/esm/versions/v2/models/index.d.ts +2 -1
  8. package/dist/esm/versions/v2/models/index.js +2 -1
  9. package/dist/esm/versions/v2/models/prices-array-prices-inner.d.ts +48 -0
  10. package/dist/esm/versions/v2/models/prices-array-prices-inner.js +14 -0
  11. package/dist/esm/versions/v2/models/prices-array.d.ts +4 -3
  12. package/dist/esm/versions/v2/models/update-product-response.d.ts +3 -3
  13. package/dist/versions/v2/api/products-api.d.ts +10 -2
  14. package/dist/versions/v2/api/products-api.js +10 -5
  15. package/dist/versions/v2/models/base-product-all-of.d.ts +21 -1
  16. package/dist/versions/v2/models/get-product-response.d.ts +3 -3
  17. package/dist/versions/v2/models/{get-product-response-data.d.ts → get-products-response-data-inner.d.ts} +2 -2
  18. package/dist/versions/v2/models/get-products-response.d.ts +3 -3
  19. package/dist/versions/v2/models/index.d.ts +2 -1
  20. package/dist/versions/v2/models/index.js +2 -1
  21. package/dist/versions/v2/models/prices-array-prices-inner.d.ts +48 -0
  22. package/dist/versions/v2/models/prices-array-prices-inner.js +15 -0
  23. package/dist/versions/v2/models/prices-array.d.ts +4 -3
  24. package/dist/versions/v2/models/update-product-response.d.ts +3 -3
  25. package/package.json +1 -1
  26. /package/dist/esm/versions/v2/models/{get-product-response-data.js → get-products-response-data-inner.js} +0 -0
  27. /package/dist/versions/v2/models/{get-product-response-data.js → get-products-response-data-inner.js} +0 -0
@@ -162,11 +162,12 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
162
162
  * @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.
163
163
  * @param {'id' | 'name' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: `id`, `name`, `add_time`, `update_time`.
164
164
  * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
165
+ * @param {string} [updated_since] If set, only products with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
165
166
  * @param {string} [custom_fields] 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 a smaller response.<br/>A maximum of 15 keys is allowed.
166
167
 
167
168
  * @throws {RequiredError}
168
169
  */
169
- getProducts: (owner_id?: number, ids?: string, filter_id?: number, cursor?: string, limit?: number, sort_by?: 'id' | 'name' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc', custom_fields?: string) => Promise<RequestArgs>;
170
+ getProducts: (owner_id?: number, ids?: string, filter_id?: number, cursor?: string, limit?: number, sort_by?: 'id' | 'name' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc', updated_since?: string, custom_fields?: string) => Promise<RequestArgs>;
170
171
  /**
171
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.
172
173
  * @summary Search products
@@ -347,11 +348,12 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
347
348
  * @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.
348
349
  * @param {'id' | 'name' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;name&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
349
350
  * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
351
+ * @param {string} [updated_since] If set, only products with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
350
352
  * @param {string} [custom_fields] 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 a smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
351
353
 
352
354
  * @throws {RequiredError}
353
355
  */
354
- getProducts(owner_id?: number, ids?: string, filter_id?: number, cursor?: string, limit?: number, sort_by?: 'id' | 'name' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc', custom_fields?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductsResponse>>;
356
+ getProducts(owner_id?: number, ids?: string, filter_id?: number, cursor?: string, limit?: number, sort_by?: 'id' | 'name' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc', updated_since?: string, custom_fields?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductsResponse>>;
355
357
  /**
356
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.
357
359
  * @summary Search products
@@ -838,6 +840,12 @@ export interface ProductsApiGetProductsRequest {
838
840
  * @memberof ProductsApiGetProducts
839
841
  */
840
842
  readonly sort_direction?: 'asc' | 'desc';
843
+ /**
844
+ * If set, only products with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
845
+ * @type {string}
846
+ * @memberof ProductsApiGetProducts
847
+ */
848
+ readonly updated_since?: string;
841
849
  /**
842
850
  * 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 a smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
843
851
  * @type {string}
@@ -521,11 +521,12 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
521
521
  * @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.
522
522
  * @param {'id' | 'name' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;name&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
523
523
  * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
524
+ * @param {string} [updated_since] If set, only products with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
524
525
  * @param {string} [custom_fields] 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 a smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
525
526
 
526
527
  * @throws {RequiredError}
527
528
  */
528
- getProducts: (owner_id, ids, filter_id, cursor, limit, sort_by, sort_direction, custom_fields) => __awaiter(this, void 0, void 0, function* () {
529
+ getProducts: (owner_id, ids, filter_id, cursor, limit, sort_by, sort_direction, updated_since, custom_fields) => __awaiter(this, void 0, void 0, function* () {
529
530
  const localVarPath = `/products`;
530
531
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
531
532
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -562,6 +563,9 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
562
563
  if (sort_direction !== undefined) {
563
564
  localVarQueryParameter['sort_direction'] = sort_direction;
564
565
  }
566
+ if (updated_since !== undefined) {
567
+ localVarQueryParameter['updated_since'] = updated_since;
568
+ }
565
569
  if (custom_fields !== undefined) {
566
570
  localVarQueryParameter['custom_fields'] = custom_fields;
567
571
  }
@@ -991,13 +995,14 @@ export const ProductsApiFp = function (configuration) {
991
995
  * @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.
992
996
  * @param {'id' | 'name' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;name&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
993
997
  * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
998
+ * @param {string} [updated_since] If set, only products with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
994
999
  * @param {string} [custom_fields] 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 a smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
995
1000
 
996
1001
  * @throws {RequiredError}
997
1002
  */
998
- getProducts(owner_id, ids, filter_id, cursor, limit, sort_by, sort_direction, custom_fields) {
1003
+ getProducts(owner_id, ids, filter_id, cursor, limit, sort_by, sort_direction, updated_since, custom_fields) {
999
1004
  return __awaiter(this, void 0, void 0, function* () {
1000
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getProducts(owner_id, ids, filter_id, cursor, limit, sort_by, sort_direction, custom_fields);
1005
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getProducts(owner_id, ids, filter_id, cursor, limit, sort_by, sort_direction, updated_since, custom_fields);
1001
1006
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1002
1007
  });
1003
1008
  },
@@ -1223,7 +1228,7 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
1223
1228
  * @throws {RequiredError}
1224
1229
  */
1225
1230
  getProducts(requestParameters = {}) {
1226
- return localVarFp.getProducts(requestParameters.owner_id, requestParameters.ids, requestParameters.filter_id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.custom_fields).then((request) => request(axios, basePath));
1231
+ return localVarFp.getProducts(requestParameters.owner_id, requestParameters.ids, requestParameters.filter_id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.updated_since, requestParameters.custom_fields).then((request) => request(axios, basePath));
1227
1232
  },
1228
1233
  /**
1229
1234
  * 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.
@@ -1436,7 +1441,7 @@ export class ProductsApi extends BaseAPI {
1436
1441
  * @memberof ProductsApi
1437
1442
  */
1438
1443
  getProducts(requestParameters = {}) {
1439
- return ProductsApiFp(this.configuration).getProducts(requestParameters.owner_id, requestParameters.ids, requestParameters.filter_id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.custom_fields).then((request) => request(this.axios, this.basePath));
1444
+ return ProductsApiFp(this.configuration).getProducts(requestParameters.owner_id, requestParameters.ids, requestParameters.filter_id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.updated_since, requestParameters.custom_fields).then((request) => request(this.axios, this.basePath));
1440
1445
  }
1441
1446
  /**
1442
1447
  * 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.
@@ -56,11 +56,31 @@ export interface BaseProductAllOf {
56
56
  */
57
57
  'visible_to'?: BaseProductAllOfVisibleToConst;
58
58
  /**
59
- * Information about the Pipedrive user who owns the product
59
+ * The ID of the Pipedrive user who owns the product
60
60
  * @type {number}
61
61
  */
62
62
  'owner_id'?: number;
63
63
  /**
64
+ * The date and time when the product was added
65
+ * @type {string}
66
+ */
67
+ 'add_time'?: string;
68
+ /**
69
+ * The date and time when the product was last updated
70
+ * @type {string}
71
+ */
72
+ 'update_time'?: string;
73
+ /**
74
+ * The description of the product
75
+ * @type {string}
76
+ */
77
+ 'description'?: string;
78
+ /**
79
+ * The category of the product
80
+ * @type {string}
81
+ */
82
+ 'category'?: string | null;
83
+ /**
64
84
  * 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.
65
85
  * @type {{ [key: string]: any | undefined; }}
66
86
  */
@@ -9,7 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import { GetProductResponseData } from './get-product-response-data';
12
+ import { GetProductsResponseDataInner } from './get-products-response-data-inner';
13
13
  /**
14
14
  *
15
15
  * @export
@@ -23,7 +23,7 @@ export interface GetProductResponse {
23
23
  'success'?: boolean;
24
24
  /**
25
25
  *
26
- * @type {GetProductResponseData}
26
+ * @type {GetProductsResponseDataInner}
27
27
  */
28
- 'data'?: GetProductResponseData;
28
+ 'data'?: GetProductsResponseDataInner;
29
29
  }
@@ -12,7 +12,7 @@
12
12
  import { BaseProduct } from './base-product';
13
13
  import { PricesArray } from './prices-array';
14
14
  /**
15
- * @type GetProductResponseData
15
+ * @type GetProductsResponseDataInner
16
16
  * @export
17
17
  */
18
- export type GetProductResponseData = BaseProduct & PricesArray;
18
+ export type GetProductsResponseDataInner = BaseProduct & PricesArray;
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import { GetDealsProductsResponseAdditionalData } from './get-deals-products-response-additional-data';
13
- import { GetProductResponse } from './get-product-response';
13
+ import { GetProductsResponseDataInner } from './get-products-response-data-inner';
14
14
  /**
15
15
  *
16
16
  * @export
@@ -24,9 +24,9 @@ export interface GetProductsResponse {
24
24
  'success'?: boolean;
25
25
  /**
26
26
  * Array containing data for all products
27
- * @type {Array<GetProductResponse>}
27
+ * @type {Array<GetProductsResponseDataInner>}
28
28
  */
29
- 'data'?: Array<GetProductResponse>;
29
+ 'data'?: Array<GetProductsResponseDataInner>;
30
30
  /**
31
31
  *
32
32
  * @type {GetDealsProductsResponseAdditionalData}
@@ -205,7 +205,6 @@ export * from './get-pipelines-response-all-of-data-inner';
205
205
  export * from './get-product-image-response';
206
206
  export * from './get-product-image-response-data';
207
207
  export * from './get-product-response';
208
- export * from './get-product-response-data';
209
208
  export * from './get-product-search-response';
210
209
  export * from './get-product-search-response-all-of';
211
210
  export * from './get-product-search-response-all-of-data';
@@ -216,6 +215,7 @@ export * from './get-product-variation-response';
216
215
  export * from './get-product-variations-response';
217
216
  export * from './get-product-variations-response-data-inner';
218
217
  export * from './get-products-response';
218
+ export * from './get-products-response-data-inner';
219
219
  export * from './get-project-boards-response';
220
220
  export * from './get-project-boards-response-data-inner';
221
221
  export * from './get-project-changelog-response';
@@ -256,6 +256,7 @@ export * from './person';
256
256
  export * from './person-im-inner';
257
257
  export * from './person-postal-address';
258
258
  export * from './prices-array';
259
+ export * from './prices-array-prices-inner';
259
260
  export * from './product-request';
260
261
  export * from './project';
261
262
  export * from './project-template';
@@ -205,7 +205,6 @@ export * from './get-pipelines-response-all-of-data-inner';
205
205
  export * from './get-product-image-response';
206
206
  export * from './get-product-image-response-data';
207
207
  export * from './get-product-response';
208
- export * from './get-product-response-data';
209
208
  export * from './get-product-search-response';
210
209
  export * from './get-product-search-response-all-of';
211
210
  export * from './get-product-search-response-all-of-data';
@@ -216,6 +215,7 @@ export * from './get-product-variation-response';
216
215
  export * from './get-product-variations-response';
217
216
  export * from './get-product-variations-response-data-inner';
218
217
  export * from './get-products-response';
218
+ export * from './get-products-response-data-inner';
219
219
  export * from './get-project-boards-response';
220
220
  export * from './get-project-boards-response-data-inner';
221
221
  export * from './get-project-changelog-response';
@@ -256,6 +256,7 @@ export * from './person';
256
256
  export * from './person-im-inner';
257
257
  export * from './person-postal-address';
258
258
  export * from './prices-array';
259
+ export * from './prices-array-prices-inner';
259
260
  export * from './product-request';
260
261
  export * from './project';
261
262
  export * from './project-template';
@@ -0,0 +1,48 @@
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 PricesArrayPricesInner
16
+ */
17
+ export interface PricesArrayPricesInner {
18
+ /**
19
+ * The ID of the product
20
+ * @type {number}
21
+ */
22
+ 'product_id'?: number;
23
+ /**
24
+ * The price of the product
25
+ * @type {number}
26
+ */
27
+ 'price'?: number;
28
+ /**
29
+ * The currency of the price
30
+ * @type {string}
31
+ */
32
+ 'currency'?: string;
33
+ /**
34
+ * The cost of the product
35
+ * @type {number}
36
+ */
37
+ 'cost'?: number;
38
+ /**
39
+ * The direct cost of the product
40
+ * @type {number}
41
+ */
42
+ 'direct_cost'?: number | null;
43
+ /**
44
+ * The notes about the price
45
+ * @type {string}
46
+ */
47
+ 'notes'?: string;
48
+ }
@@ -0,0 +1,14 @@
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 {};
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import { PricesArrayPricesInner } from './prices-array-prices-inner';
12
13
  /**
13
14
  *
14
15
  * @export
@@ -16,8 +17,8 @@
16
17
  */
17
18
  export interface PricesArray {
18
19
  /**
19
- * Array of objects, each containing: product_id (number), currency (string), price (number), cost (number), direct_cost (number | null), notes (string)
20
- * @type {Array<object>}
20
+ * The prices of the product in different currencies
21
+ * @type {Array<PricesArrayPricesInner>}
21
22
  */
22
- 'prices'?: Array<object>;
23
+ 'prices'?: Array<PricesArrayPricesInner>;
23
24
  }
@@ -9,7 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import { GetProductResponseData } from './get-product-response-data';
12
+ import { GetProductsResponseDataInner } from './get-products-response-data-inner';
13
13
  /**
14
14
  *
15
15
  * @export
@@ -23,7 +23,7 @@ export interface UpdateProductResponse {
23
23
  'success'?: boolean;
24
24
  /**
25
25
  *
26
- * @type {GetProductResponseData}
26
+ * @type {GetProductsResponseDataInner}
27
27
  */
28
- 'data'?: GetProductResponseData;
28
+ 'data'?: GetProductsResponseDataInner;
29
29
  }
@@ -162,11 +162,12 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
162
162
  * @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.
163
163
  * @param {'id' | 'name' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;name&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
164
164
  * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
165
+ * @param {string} [updated_since] If set, only products with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
165
166
  * @param {string} [custom_fields] 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 a smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
166
167
 
167
168
  * @throws {RequiredError}
168
169
  */
169
- getProducts: (owner_id?: number, ids?: string, filter_id?: number, cursor?: string, limit?: number, sort_by?: 'id' | 'name' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc', custom_fields?: string) => Promise<RequestArgs>;
170
+ getProducts: (owner_id?: number, ids?: string, filter_id?: number, cursor?: string, limit?: number, sort_by?: 'id' | 'name' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc', updated_since?: string, custom_fields?: string) => Promise<RequestArgs>;
170
171
  /**
171
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.
172
173
  * @summary Search products
@@ -347,11 +348,12 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
347
348
  * @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.
348
349
  * @param {'id' | 'name' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;name&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
349
350
  * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
351
+ * @param {string} [updated_since] If set, only products with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
350
352
  * @param {string} [custom_fields] 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 a smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
351
353
 
352
354
  * @throws {RequiredError}
353
355
  */
354
- getProducts(owner_id?: number, ids?: string, filter_id?: number, cursor?: string, limit?: number, sort_by?: 'id' | 'name' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc', custom_fields?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductsResponse>>;
356
+ getProducts(owner_id?: number, ids?: string, filter_id?: number, cursor?: string, limit?: number, sort_by?: 'id' | 'name' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc', updated_since?: string, custom_fields?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductsResponse>>;
355
357
  /**
356
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.
357
359
  * @summary Search products
@@ -838,6 +840,12 @@ export interface ProductsApiGetProductsRequest {
838
840
  * @memberof ProductsApiGetProducts
839
841
  */
840
842
  readonly sort_direction?: 'asc' | 'desc';
843
+ /**
844
+ * If set, only products with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
845
+ * @type {string}
846
+ * @memberof ProductsApiGetProducts
847
+ */
848
+ readonly updated_since?: string;
841
849
  /**
842
850
  * 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 a smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
843
851
  * @type {string}
@@ -527,11 +527,12 @@ const ProductsApiAxiosParamCreator = function (configuration) {
527
527
  * @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.
528
528
  * @param {'id' | 'name' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;name&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
529
529
  * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
530
+ * @param {string} [updated_since] If set, only products with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
530
531
  * @param {string} [custom_fields] 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 a smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
531
532
 
532
533
  * @throws {RequiredError}
533
534
  */
534
- getProducts: (owner_id, ids, filter_id, cursor, limit, sort_by, sort_direction, custom_fields) => __awaiter(this, void 0, void 0, function* () {
535
+ getProducts: (owner_id, ids, filter_id, cursor, limit, sort_by, sort_direction, updated_since, custom_fields) => __awaiter(this, void 0, void 0, function* () {
535
536
  const localVarPath = `/products`;
536
537
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
537
538
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -568,6 +569,9 @@ const ProductsApiAxiosParamCreator = function (configuration) {
568
569
  if (sort_direction !== undefined) {
569
570
  localVarQueryParameter['sort_direction'] = sort_direction;
570
571
  }
572
+ if (updated_since !== undefined) {
573
+ localVarQueryParameter['updated_since'] = updated_since;
574
+ }
571
575
  if (custom_fields !== undefined) {
572
576
  localVarQueryParameter['custom_fields'] = custom_fields;
573
577
  }
@@ -998,13 +1002,14 @@ const ProductsApiFp = function (configuration) {
998
1002
  * @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.
999
1003
  * @param {'id' | 'name' | 'add_time' | 'update_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;name&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
1000
1004
  * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
1005
+ * @param {string} [updated_since] If set, only products with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
1001
1006
  * @param {string} [custom_fields] 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 a smaller response.&lt;br/&gt;A maximum of 15 keys is allowed.
1002
1007
 
1003
1008
  * @throws {RequiredError}
1004
1009
  */
1005
- getProducts(owner_id, ids, filter_id, cursor, limit, sort_by, sort_direction, custom_fields) {
1010
+ getProducts(owner_id, ids, filter_id, cursor, limit, sort_by, sort_direction, updated_since, custom_fields) {
1006
1011
  return __awaiter(this, void 0, void 0, function* () {
1007
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getProducts(owner_id, ids, filter_id, cursor, limit, sort_by, sort_direction, custom_fields);
1012
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getProducts(owner_id, ids, filter_id, cursor, limit, sort_by, sort_direction, updated_since, custom_fields);
1008
1013
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1009
1014
  });
1010
1015
  },
@@ -1231,7 +1236,7 @@ const ProductsApiFactory = function (configuration, basePath, axios) {
1231
1236
  * @throws {RequiredError}
1232
1237
  */
1233
1238
  getProducts(requestParameters = {}) {
1234
- return localVarFp.getProducts(requestParameters.owner_id, requestParameters.ids, requestParameters.filter_id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.custom_fields).then((request) => request(axios, basePath));
1239
+ return localVarFp.getProducts(requestParameters.owner_id, requestParameters.ids, requestParameters.filter_id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.updated_since, requestParameters.custom_fields).then((request) => request(axios, basePath));
1235
1240
  },
1236
1241
  /**
1237
1242
  * 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.
@@ -1445,7 +1450,7 @@ class ProductsApi extends base_1.BaseAPI {
1445
1450
  * @memberof ProductsApi
1446
1451
  */
1447
1452
  getProducts(requestParameters = {}) {
1448
- return (0, exports.ProductsApiFp)(this.configuration).getProducts(requestParameters.owner_id, requestParameters.ids, requestParameters.filter_id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.custom_fields).then((request) => request(this.axios, this.basePath));
1453
+ return (0, exports.ProductsApiFp)(this.configuration).getProducts(requestParameters.owner_id, requestParameters.ids, requestParameters.filter_id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.updated_since, requestParameters.custom_fields).then((request) => request(this.axios, this.basePath));
1449
1454
  }
1450
1455
  /**
1451
1456
  * 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.
@@ -56,11 +56,31 @@ export interface BaseProductAllOf {
56
56
  */
57
57
  'visible_to'?: BaseProductAllOfVisibleToConst;
58
58
  /**
59
- * Information about the Pipedrive user who owns the product
59
+ * The ID of the Pipedrive user who owns the product
60
60
  * @type {number}
61
61
  */
62
62
  'owner_id'?: number;
63
63
  /**
64
+ * The date and time when the product was added
65
+ * @type {string}
66
+ */
67
+ 'add_time'?: string;
68
+ /**
69
+ * The date and time when the product was last updated
70
+ * @type {string}
71
+ */
72
+ 'update_time'?: string;
73
+ /**
74
+ * The description of the product
75
+ * @type {string}
76
+ */
77
+ 'description'?: string;
78
+ /**
79
+ * The category of the product
80
+ * @type {string}
81
+ */
82
+ 'category'?: string | null;
83
+ /**
64
84
  * 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.
65
85
  * @type {{ [key: string]: any | undefined; }}
66
86
  */
@@ -9,7 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import { GetProductResponseData } from './get-product-response-data';
12
+ import { GetProductsResponseDataInner } from './get-products-response-data-inner';
13
13
  /**
14
14
  *
15
15
  * @export
@@ -23,7 +23,7 @@ export interface GetProductResponse {
23
23
  'success'?: boolean;
24
24
  /**
25
25
  *
26
- * @type {GetProductResponseData}
26
+ * @type {GetProductsResponseDataInner}
27
27
  */
28
- 'data'?: GetProductResponseData;
28
+ 'data'?: GetProductsResponseDataInner;
29
29
  }
@@ -12,7 +12,7 @@
12
12
  import { BaseProduct } from './base-product';
13
13
  import { PricesArray } from './prices-array';
14
14
  /**
15
- * @type GetProductResponseData
15
+ * @type GetProductsResponseDataInner
16
16
  * @export
17
17
  */
18
- export type GetProductResponseData = BaseProduct & PricesArray;
18
+ export type GetProductsResponseDataInner = BaseProduct & PricesArray;
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import { GetDealsProductsResponseAdditionalData } from './get-deals-products-response-additional-data';
13
- import { GetProductResponse } from './get-product-response';
13
+ import { GetProductsResponseDataInner } from './get-products-response-data-inner';
14
14
  /**
15
15
  *
16
16
  * @export
@@ -24,9 +24,9 @@ export interface GetProductsResponse {
24
24
  'success'?: boolean;
25
25
  /**
26
26
  * Array containing data for all products
27
- * @type {Array<GetProductResponse>}
27
+ * @type {Array<GetProductsResponseDataInner>}
28
28
  */
29
- 'data'?: Array<GetProductResponse>;
29
+ 'data'?: Array<GetProductsResponseDataInner>;
30
30
  /**
31
31
  *
32
32
  * @type {GetDealsProductsResponseAdditionalData}
@@ -205,7 +205,6 @@ export * from './get-pipelines-response-all-of-data-inner';
205
205
  export * from './get-product-image-response';
206
206
  export * from './get-product-image-response-data';
207
207
  export * from './get-product-response';
208
- export * from './get-product-response-data';
209
208
  export * from './get-product-search-response';
210
209
  export * from './get-product-search-response-all-of';
211
210
  export * from './get-product-search-response-all-of-data';
@@ -216,6 +215,7 @@ export * from './get-product-variation-response';
216
215
  export * from './get-product-variations-response';
217
216
  export * from './get-product-variations-response-data-inner';
218
217
  export * from './get-products-response';
218
+ export * from './get-products-response-data-inner';
219
219
  export * from './get-project-boards-response';
220
220
  export * from './get-project-boards-response-data-inner';
221
221
  export * from './get-project-changelog-response';
@@ -256,6 +256,7 @@ export * from './person';
256
256
  export * from './person-im-inner';
257
257
  export * from './person-postal-address';
258
258
  export * from './prices-array';
259
+ export * from './prices-array-prices-inner';
259
260
  export * from './product-request';
260
261
  export * from './project';
261
262
  export * from './project-template';
@@ -221,7 +221,6 @@ __exportStar(require("./get-pipelines-response-all-of-data-inner"), exports);
221
221
  __exportStar(require("./get-product-image-response"), exports);
222
222
  __exportStar(require("./get-product-image-response-data"), exports);
223
223
  __exportStar(require("./get-product-response"), exports);
224
- __exportStar(require("./get-product-response-data"), exports);
225
224
  __exportStar(require("./get-product-search-response"), exports);
226
225
  __exportStar(require("./get-product-search-response-all-of"), exports);
227
226
  __exportStar(require("./get-product-search-response-all-of-data"), exports);
@@ -232,6 +231,7 @@ __exportStar(require("./get-product-variation-response"), exports);
232
231
  __exportStar(require("./get-product-variations-response"), exports);
233
232
  __exportStar(require("./get-product-variations-response-data-inner"), exports);
234
233
  __exportStar(require("./get-products-response"), exports);
234
+ __exportStar(require("./get-products-response-data-inner"), exports);
235
235
  __exportStar(require("./get-project-boards-response"), exports);
236
236
  __exportStar(require("./get-project-boards-response-data-inner"), exports);
237
237
  __exportStar(require("./get-project-changelog-response"), exports);
@@ -272,6 +272,7 @@ __exportStar(require("./person"), exports);
272
272
  __exportStar(require("./person-im-inner"), exports);
273
273
  __exportStar(require("./person-postal-address"), exports);
274
274
  __exportStar(require("./prices-array"), exports);
275
+ __exportStar(require("./prices-array-prices-inner"), exports);
275
276
  __exportStar(require("./product-request"), exports);
276
277
  __exportStar(require("./project"), exports);
277
278
  __exportStar(require("./project-template"), exports);
@@ -0,0 +1,48 @@
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 PricesArrayPricesInner
16
+ */
17
+ export interface PricesArrayPricesInner {
18
+ /**
19
+ * The ID of the product
20
+ * @type {number}
21
+ */
22
+ 'product_id'?: number;
23
+ /**
24
+ * The price of the product
25
+ * @type {number}
26
+ */
27
+ 'price'?: number;
28
+ /**
29
+ * The currency of the price
30
+ * @type {string}
31
+ */
32
+ 'currency'?: string;
33
+ /**
34
+ * The cost of the product
35
+ * @type {number}
36
+ */
37
+ 'cost'?: number;
38
+ /**
39
+ * The direct cost of the product
40
+ * @type {number}
41
+ */
42
+ 'direct_cost'?: number | null;
43
+ /**
44
+ * The notes about the price
45
+ * @type {string}
46
+ */
47
+ 'notes'?: string;
48
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Pipedrive API v2
6
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import { PricesArrayPricesInner } from './prices-array-prices-inner';
12
13
  /**
13
14
  *
14
15
  * @export
@@ -16,8 +17,8 @@
16
17
  */
17
18
  export interface PricesArray {
18
19
  /**
19
- * Array of objects, each containing: product_id (number), currency (string), price (number), cost (number), direct_cost (number | null), notes (string)
20
- * @type {Array<object>}
20
+ * The prices of the product in different currencies
21
+ * @type {Array<PricesArrayPricesInner>}
21
22
  */
22
- 'prices'?: Array<object>;
23
+ 'prices'?: Array<PricesArrayPricesInner>;
23
24
  }
@@ -9,7 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import { GetProductResponseData } from './get-product-response-data';
12
+ import { GetProductsResponseDataInner } from './get-products-response-data-inner';
13
13
  /**
14
14
  *
15
15
  * @export
@@ -23,7 +23,7 @@ export interface UpdateProductResponse {
23
23
  'success'?: boolean;
24
24
  /**
25
25
  *
26
- * @type {GetProductResponseData}
26
+ * @type {GetProductsResponseDataInner}
27
27
  */
28
- 'data'?: GetProductResponseData;
28
+ 'data'?: GetProductsResponseDataInner;
29
29
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pipedrive",
3
- "version": "33.4.0",
3
+ "version": "33.4.1",
4
4
  "description": "Pipedrive REST client for NodeJS",
5
5
  "license": "MIT",
6
6
  "homepage": "https://developers.pipedrive.com",