pipedrive 33.9.0 → 34.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.
Files changed (65) hide show
  1. package/dist/esm/versions/v2/api/activities-api.d.ts +16 -16
  2. package/dist/esm/versions/v2/api/activities-api.js +13 -13
  3. package/dist/esm/versions/v2/api/activity-fields-api.d.ts +12 -12
  4. package/dist/esm/versions/v2/api/activity-fields-api.js +9 -9
  5. package/dist/esm/versions/v2/api/deal-fields-api.d.ts +12 -12
  6. package/dist/esm/versions/v2/api/deal-fields-api.js +9 -9
  7. package/dist/esm/versions/v2/api/deals-api.d.ts +38 -38
  8. package/dist/esm/versions/v2/api/deals-api.js +33 -33
  9. package/dist/esm/versions/v2/api/organization-fields-api.d.ts +12 -12
  10. package/dist/esm/versions/v2/api/organization-fields-api.js +9 -9
  11. package/dist/esm/versions/v2/api/organizations-api.d.ts +24 -24
  12. package/dist/esm/versions/v2/api/organizations-api.js +21 -21
  13. package/dist/esm/versions/v2/api/person-fields-api.d.ts +12 -12
  14. package/dist/esm/versions/v2/api/person-fields-api.js +9 -9
  15. package/dist/esm/versions/v2/api/persons-api.d.ts +24 -24
  16. package/dist/esm/versions/v2/api/persons-api.js +21 -21
  17. package/dist/esm/versions/v2/api/product-fields-api.d.ts +24 -24
  18. package/dist/esm/versions/v2/api/product-fields-api.js +9 -9
  19. package/dist/esm/versions/v2/api/products-api.d.ts +14 -14
  20. package/dist/esm/versions/v2/api/products-api.js +15 -15
  21. package/dist/esm/versions/v2/models/add-product-field200-response.d.ts +29 -0
  22. package/dist/esm/versions/v2/models/add-product-field200-response.js +14 -0
  23. package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner.d.ts +2 -0
  24. package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner.js +3 -1
  25. package/dist/esm/versions/v2/models/get-product-fields200-response-data-inner.d.ts +97 -0
  26. package/dist/esm/versions/v2/models/get-product-fields200-response-data-inner.js +48 -0
  27. package/dist/esm/versions/v2/models/get-product-fields200-response.d.ts +35 -0
  28. package/dist/esm/versions/v2/models/get-product-fields200-response.js +14 -0
  29. package/dist/esm/versions/v2/models/get-project-fields200-response-data-inner.d.ts +1 -0
  30. package/dist/esm/versions/v2/models/get-project-fields200-response-data-inner.js +2 -1
  31. package/dist/esm/versions/v2/models/index.d.ts +3 -0
  32. package/dist/esm/versions/v2/models/index.js +3 -0
  33. package/dist/versions/v2/api/activities-api.d.ts +16 -16
  34. package/dist/versions/v2/api/activities-api.js +12 -12
  35. package/dist/versions/v2/api/activity-fields-api.d.ts +12 -12
  36. package/dist/versions/v2/api/activity-fields-api.js +8 -8
  37. package/dist/versions/v2/api/deal-fields-api.d.ts +12 -12
  38. package/dist/versions/v2/api/deal-fields-api.js +8 -8
  39. package/dist/versions/v2/api/deals-api.d.ts +38 -38
  40. package/dist/versions/v2/api/deals-api.js +32 -32
  41. package/dist/versions/v2/api/organization-fields-api.d.ts +12 -12
  42. package/dist/versions/v2/api/organization-fields-api.js +8 -8
  43. package/dist/versions/v2/api/organizations-api.d.ts +24 -24
  44. package/dist/versions/v2/api/organizations-api.js +20 -20
  45. package/dist/versions/v2/api/person-fields-api.d.ts +12 -12
  46. package/dist/versions/v2/api/person-fields-api.js +8 -8
  47. package/dist/versions/v2/api/persons-api.d.ts +24 -24
  48. package/dist/versions/v2/api/persons-api.js +20 -20
  49. package/dist/versions/v2/api/product-fields-api.d.ts +24 -24
  50. package/dist/versions/v2/api/product-fields-api.js +8 -8
  51. package/dist/versions/v2/api/products-api.d.ts +14 -14
  52. package/dist/versions/v2/api/products-api.js +14 -14
  53. package/dist/versions/v2/models/add-product-field200-response.d.ts +29 -0
  54. package/dist/versions/v2/models/add-product-field200-response.js +15 -0
  55. package/dist/versions/v2/models/get-activity-fields200-response-data-inner.d.ts +2 -0
  56. package/dist/versions/v2/models/get-activity-fields200-response-data-inner.js +3 -1
  57. package/dist/versions/v2/models/get-product-fields200-response-data-inner.d.ts +97 -0
  58. package/dist/versions/v2/models/get-product-fields200-response-data-inner.js +51 -0
  59. package/dist/versions/v2/models/get-product-fields200-response.d.ts +35 -0
  60. package/dist/versions/v2/models/get-product-fields200-response.js +15 -0
  61. package/dist/versions/v2/models/get-project-fields200-response-data-inner.d.ts +1 -0
  62. package/dist/versions/v2/models/get-project-fields200-response-data-inner.js +2 -1
  63. package/dist/versions/v2/models/index.d.ts +3 -0
  64. package/dist/versions/v2/models/index.js +3 -0
  65. package/package.json +1 -1
@@ -156,18 +156,18 @@ 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 {string} [ids] Optional comma separated string 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.
159
+ * @param {Set<string>} [ids] Optional comma separated string 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
+ * @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.&lt;br/&gt;A maximum of 15 keys is allowed.
160
161
  * @param {number} [filter_id] The ID of the filter to use
161
162
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
162
163
  * @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
164
  * @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
165
  * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
165
166
  * @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.
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.
167
167
 
168
168
  * @throws {RequiredError}
169
169
  */
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
+ getProducts: (owner_id?: number, ids?: Set<string>, 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,18 +342,18 @@ 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 {string} [ids] Optional comma separated string 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.
345
+ * @param {Set<string>} [ids] Optional comma separated string 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
+ * @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.&lt;br/&gt;A maximum of 15 keys is allowed.
346
347
  * @param {number} [filter_id] The ID of the filter to use
347
348
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
348
349
  * @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.
349
350
  * @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;.
350
351
  * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
351
352
  * @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.
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.
353
353
 
354
354
  * @throws {RequiredError}
355
355
  */
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>>;
356
+ getProducts(owner_id?: number, ids?: Set<string>, 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
@@ -806,10 +806,16 @@ export interface ProductsApiGetProductsRequest {
806
806
  readonly owner_id?: number;
807
807
  /**
808
808
  * Optional comma separated string 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 {string}
809
+ * @type {Set<string>}
810
+ * @memberof ProductsApiGetProducts
811
+ */
812
+ readonly ids?: Set<string>;
813
+ /**
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.&lt;br/&gt;A maximum of 15 keys is allowed.
815
+ * @type {Set<string>}
810
816
  * @memberof ProductsApiGetProducts
811
817
  */
812
- readonly ids?: string;
818
+ readonly custom_fields?: Set<string>;
813
819
  /**
814
820
  * The ID of the filter to use
815
821
  * @type {number}
@@ -846,12 +852,6 @@ export interface ProductsApiGetProductsRequest {
846
852
  * @memberof ProductsApiGetProducts
847
853
  */
848
854
  readonly updated_since?: string;
849
- /**
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.
851
- * @type {string}
852
- * @memberof ProductsApiGetProducts
853
- */
854
- readonly custom_fields?: string;
855
855
  }
856
856
  /**
857
857
  * Request parameters for searchProducts operation in ProductsApi.
@@ -25,7 +25,7 @@ import globalAxios from 'axios';
25
25
  // @ts-ignore
26
26
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
27
27
  // @ts-ignore
28
- import { BASE_PATH, BaseAPI } from '../base';
28
+ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
29
29
  /**
30
30
  * ProductsApi - axios parameter creator
31
31
  * @export
@@ -515,18 +515,18 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
515
515
  * Returns data about all products.
516
516
  * @summary Get all products
517
517
  * @param {number} [owner_id] If supplied, only products owned by the given user will be returned
518
- * @param {string} [ids] Optional comma separated string 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.
518
+ * @param {Set<string>} [ids] Optional comma separated string 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.
519
+ * @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.&lt;br/&gt;A maximum of 15 keys is allowed.
519
520
  * @param {number} [filter_id] The ID of the filter to use
520
521
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
521
522
  * @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
523
  * @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
524
  * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
524
525
  * @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.
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.
526
526
 
527
527
  * @throws {RequiredError}
528
528
  */
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
+ getProducts: (owner_id, ids, custom_fields, filter_id, cursor, limit, sort_by, sort_direction, updated_since) => __awaiter(this, void 0, void 0, function* () {
530
530
  const localVarPath = `/products`;
531
531
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
532
532
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -545,8 +545,11 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
545
545
  if (owner_id !== undefined) {
546
546
  localVarQueryParameter['owner_id'] = owner_id;
547
547
  }
548
- if (ids !== undefined) {
549
- localVarQueryParameter['ids'] = ids;
548
+ if (ids) {
549
+ localVarQueryParameter['ids'] = Array.from(ids).join(COLLECTION_FORMATS.csv);
550
+ }
551
+ if (custom_fields) {
552
+ localVarQueryParameter['custom_fields'] = Array.from(custom_fields).join(COLLECTION_FORMATS.csv);
550
553
  }
551
554
  if (filter_id !== undefined) {
552
555
  localVarQueryParameter['filter_id'] = filter_id;
@@ -566,9 +569,6 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
566
569
  if (updated_since !== undefined) {
567
570
  localVarQueryParameter['updated_since'] = updated_since;
568
571
  }
569
- if (custom_fields !== undefined) {
570
- localVarQueryParameter['custom_fields'] = custom_fields;
571
- }
572
572
  setSearchParams(localVarUrlObj, localVarQueryParameter);
573
573
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
574
574
  localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
@@ -989,20 +989,20 @@ export const ProductsApiFp = function (configuration) {
989
989
  * Returns data about all products.
990
990
  * @summary Get all products
991
991
  * @param {number} [owner_id] If supplied, only products owned by the given user will be returned
992
- * @param {string} [ids] Optional comma separated string 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.
992
+ * @param {Set<string>} [ids] Optional comma separated string 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.
993
+ * @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.&lt;br/&gt;A maximum of 15 keys is allowed.
993
994
  * @param {number} [filter_id] The ID of the filter to use
994
995
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
995
996
  * @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.
996
997
  * @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;.
997
998
  * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
998
999
  * @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.
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.
1000
1000
 
1001
1001
  * @throws {RequiredError}
1002
1002
  */
1003
- getProducts(owner_id, ids, filter_id, cursor, limit, sort_by, sort_direction, updated_since, custom_fields) {
1003
+ getProducts(owner_id, ids, custom_fields, filter_id, cursor, limit, sort_by, sort_direction, updated_since) {
1004
1004
  return __awaiter(this, void 0, void 0, function* () {
1005
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getProducts(owner_id, ids, filter_id, cursor, limit, sort_by, sort_direction, updated_since, custom_fields);
1005
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getProducts(owner_id, ids, custom_fields, filter_id, cursor, limit, sort_by, sort_direction, updated_since);
1006
1006
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1007
1007
  });
1008
1008
  },
@@ -1228,7 +1228,7 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
1228
1228
  * @throws {RequiredError}
1229
1229
  */
1230
1230
  getProducts(requestParameters = {}) {
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));
1231
+ return localVarFp.getProducts(requestParameters.owner_id, requestParameters.ids, requestParameters.custom_fields, requestParameters.filter_id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.updated_since).then((request) => request(axios, basePath));
1232
1232
  },
1233
1233
  /**
1234
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.
@@ -1441,7 +1441,7 @@ export class ProductsApi extends BaseAPI {
1441
1441
  * @memberof ProductsApi
1442
1442
  */
1443
1443
  getProducts(requestParameters = {}) {
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));
1444
+ return ProductsApiFp(this.configuration).getProducts(requestParameters.owner_id, requestParameters.ids, requestParameters.custom_fields, requestParameters.filter_id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.updated_since).then((request) => request(this.axios, this.basePath));
1445
1445
  }
1446
1446
  /**
1447
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.
@@ -0,0 +1,29 @@
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 { GetProductFields200ResponseDataInner } from './get-product-fields200-response-data-inner';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface AddProductField200Response
17
+ */
18
+ export interface AddProductField200Response {
19
+ /**
20
+ * Whether the request was successful
21
+ * @type {boolean}
22
+ */
23
+ 'success'?: boolean;
24
+ /**
25
+ *
26
+ * @type {GetProductFields200ResponseDataInner}
27
+ */
28
+ 'data'?: GetProductFields200ResponseDataInner;
29
+ }
@@ -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 {};
@@ -93,5 +93,7 @@ export declare const GetActivityFields200ResponseDataInnerFieldTypeConst: {
93
93
  readonly billing_frequency: "billing_frequency";
94
94
  readonly projects_board: "projects_board";
95
95
  readonly projects_phase: "projects_phase";
96
+ readonly participants: "participants";
97
+ readonly attendees: "attendees";
96
98
  };
97
99
  export type GetActivityFields200ResponseDataInnerFieldTypeConst = typeof GetActivityFields200ResponseDataInnerFieldTypeConst[keyof typeof GetActivityFields200ResponseDataInnerFieldTypeConst];
@@ -44,5 +44,7 @@ export const GetActivityFields200ResponseDataInnerFieldTypeConst = {
44
44
  price_list: 'price_list',
45
45
  billing_frequency: 'billing_frequency',
46
46
  projects_board: 'projects_board',
47
- projects_phase: 'projects_phase'
47
+ projects_phase: 'projects_phase',
48
+ participants: 'participants',
49
+ attendees: 'attendees'
48
50
  };
@@ -0,0 +1,97 @@
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 { GetActivityFields200ResponseDataInnerOptionsInner } from './get-activity-fields200-response-data-inner-options-inner';
13
+ import { GetActivityFields200ResponseDataInnerSubfieldsInner } from './get-activity-fields200-response-data-inner-subfields-inner';
14
+ import { GetActivityFields200ResponseDataInnerUiVisibility } from './get-activity-fields200-response-data-inner-ui-visibility';
15
+ /**
16
+ *
17
+ * @export
18
+ * @interface GetProductFields200ResponseDataInner
19
+ */
20
+ export interface GetProductFields200ResponseDataInner {
21
+ /**
22
+ * The display name/label of the field
23
+ * @type {string}
24
+ */
25
+ 'field_name': string;
26
+ /**
27
+ * The unique identifier for the field (40-character hash for custom fields)
28
+ * @type {string}
29
+ */
30
+ 'field_code': string;
31
+ /**
32
+ * The type of the field
33
+ * @type {string}
34
+ */
35
+ 'field_type': GetProductFields200ResponseDataInnerFieldTypeConst;
36
+ /**
37
+ * Whether this is a user-created custom field
38
+ * @type {boolean}
39
+ */
40
+ 'is_custom_field': boolean;
41
+ /**
42
+ * Whether this field is not returned by default in entity responses
43
+ * @type {boolean}
44
+ */
45
+ 'is_optional_response_field': boolean;
46
+ /**
47
+ * Array of available options for enum/set fields, null for other field types
48
+ * @type {Array<GetActivityFields200ResponseDataInnerOptionsInner>}
49
+ */
50
+ 'options'?: Array<GetActivityFields200ResponseDataInnerOptionsInner> | null;
51
+ /**
52
+ * Array of subfields for complex field types (address, monetary), null for simple field types
53
+ * @type {Array<GetActivityFields200ResponseDataInnerSubfieldsInner>}
54
+ */
55
+ 'subfields'?: Array<GetActivityFields200ResponseDataInnerSubfieldsInner> | null;
56
+ /**
57
+ *
58
+ * @type {GetActivityFields200ResponseDataInnerUiVisibility}
59
+ */
60
+ 'ui_visibility'?: GetActivityFields200ResponseDataInnerUiVisibility;
61
+ }
62
+ export declare const GetProductFields200ResponseDataInnerFieldTypeConst: {
63
+ readonly int: "int";
64
+ readonly double: "double";
65
+ readonly boolean: "boolean";
66
+ readonly varchar: "varchar";
67
+ readonly text: "text";
68
+ readonly phone: "phone";
69
+ readonly varchar_options: "varchar_options";
70
+ readonly varchar_auto: "varchar_auto";
71
+ readonly date: "date";
72
+ readonly daterange: "daterange";
73
+ readonly time: "time";
74
+ readonly timerange: "timerange";
75
+ readonly enum: "enum";
76
+ readonly set: "set";
77
+ readonly address: "address";
78
+ readonly monetary: "monetary";
79
+ readonly deal: "deal";
80
+ readonly deals: "deals";
81
+ readonly lead: "lead";
82
+ readonly org: "org";
83
+ readonly people: "people";
84
+ readonly project: "project";
85
+ readonly stage: "stage";
86
+ readonly user: "user";
87
+ readonly activity: "activity";
88
+ readonly json: "json";
89
+ readonly picture: "picture";
90
+ readonly status: "status";
91
+ readonly visible_to: "visible_to";
92
+ readonly price_list: "price_list";
93
+ readonly billing_frequency: "billing_frequency";
94
+ readonly projects_board: "projects_board";
95
+ readonly projects_phase: "projects_phase";
96
+ };
97
+ export type GetProductFields200ResponseDataInnerFieldTypeConst = typeof GetProductFields200ResponseDataInnerFieldTypeConst[keyof typeof GetProductFields200ResponseDataInnerFieldTypeConst];
@@ -0,0 +1,48 @@
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 const GetProductFields200ResponseDataInnerFieldTypeConst = {
15
+ int: 'int',
16
+ double: 'double',
17
+ boolean: 'boolean',
18
+ varchar: 'varchar',
19
+ text: 'text',
20
+ phone: 'phone',
21
+ varchar_options: 'varchar_options',
22
+ varchar_auto: 'varchar_auto',
23
+ date: 'date',
24
+ daterange: 'daterange',
25
+ time: 'time',
26
+ timerange: 'timerange',
27
+ enum: 'enum',
28
+ set: 'set',
29
+ address: 'address',
30
+ monetary: 'monetary',
31
+ deal: 'deal',
32
+ deals: 'deals',
33
+ lead: 'lead',
34
+ org: 'org',
35
+ people: 'people',
36
+ project: 'project',
37
+ stage: 'stage',
38
+ user: 'user',
39
+ activity: 'activity',
40
+ json: 'json',
41
+ picture: 'picture',
42
+ status: 'status',
43
+ visible_to: 'visible_to',
44
+ price_list: 'price_list',
45
+ billing_frequency: 'billing_frequency',
46
+ projects_board: 'projects_board',
47
+ projects_phase: 'projects_phase'
48
+ };
@@ -0,0 +1,35 @@
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 { GetActivityFields200ResponseAdditionalData } from './get-activity-fields200-response-additional-data';
13
+ import { GetProductFields200ResponseDataInner } from './get-product-fields200-response-data-inner';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface GetProductFields200Response
18
+ */
19
+ export interface GetProductFields200Response {
20
+ /**
21
+ * Whether the request was successful
22
+ * @type {boolean}
23
+ */
24
+ 'success'?: boolean;
25
+ /**
26
+ *
27
+ * @type {Array<GetProductFields200ResponseDataInner>}
28
+ */
29
+ 'data'?: Array<GetProductFields200ResponseDataInner>;
30
+ /**
31
+ *
32
+ * @type {GetActivityFields200ResponseAdditionalData}
33
+ */
34
+ 'additional_data'?: GetActivityFields200ResponseAdditionalData;
35
+ }
@@ -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 {};
@@ -105,5 +105,6 @@ export declare const GetProjectFields200ResponseDataInnerFieldTypeConst: {
105
105
  readonly billing_frequency: "billing_frequency";
106
106
  readonly projects_board: "projects_board";
107
107
  readonly projects_phase: "projects_phase";
108
+ readonly orgs: "orgs";
108
109
  };
109
110
  export type GetProjectFields200ResponseDataInnerFieldTypeConst = typeof GetProjectFields200ResponseDataInnerFieldTypeConst[keyof typeof GetProjectFields200ResponseDataInnerFieldTypeConst];
@@ -44,5 +44,6 @@ export const GetProjectFields200ResponseDataInnerFieldTypeConst = {
44
44
  price_list: 'price_list',
45
45
  billing_frequency: 'billing_frequency',
46
46
  projects_board: 'projects_board',
47
- projects_phase: 'projects_phase'
47
+ projects_phase: 'projects_phase',
48
+ orgs: 'orgs'
48
49
  };
@@ -44,6 +44,7 @@ export * from './add-person-field-request-ui-visibility';
44
44
  export * from './add-person-field-request-ui-visibility-show-in-add-deal-dialog';
45
45
  export * from './add-person-request';
46
46
  export * from './add-pipeline-request';
47
+ export * from './add-product-field200-response';
47
48
  export * from './add-product-field-request';
48
49
  export * from './add-product-field-request-ui-visibility';
49
50
  export * from './add-product-image-response';
@@ -202,6 +203,8 @@ export * from './get-persons-response-all-of';
202
203
  export * from './get-pipelines-response';
203
204
  export * from './get-pipelines-response-all-of';
204
205
  export * from './get-pipelines-response-all-of-data-inner';
206
+ export * from './get-product-fields200-response';
207
+ export * from './get-product-fields200-response-data-inner';
205
208
  export * from './get-product-image-response';
206
209
  export * from './get-product-image-response-data';
207
210
  export * from './get-product-response';
@@ -44,6 +44,7 @@ export * from './add-person-field-request-ui-visibility';
44
44
  export * from './add-person-field-request-ui-visibility-show-in-add-deal-dialog';
45
45
  export * from './add-person-request';
46
46
  export * from './add-pipeline-request';
47
+ export * from './add-product-field200-response';
47
48
  export * from './add-product-field-request';
48
49
  export * from './add-product-field-request-ui-visibility';
49
50
  export * from './add-product-image-response';
@@ -202,6 +203,8 @@ export * from './get-persons-response-all-of';
202
203
  export * from './get-pipelines-response';
203
204
  export * from './get-pipelines-response-all-of';
204
205
  export * from './get-pipelines-response-all-of-data-inner';
206
+ export * from './get-product-fields200-response';
207
+ export * from './get-product-fields200-response-data-inner';
205
208
  export * from './get-product-image-response';
206
209
  export * from './get-product-image-response-data';
207
210
  export * from './get-product-response';
@@ -41,7 +41,7 @@ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configurat
41
41
  * Returns data about all activities.
42
42
  * @summary Get all activities
43
43
  * @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
44
- * @param {string} [ids] Optional comma separated string 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.
44
+ * @param {Set<string>} [ids] Optional comma separated string 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.
45
45
  * @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
46
46
  * @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
47
47
  * @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
@@ -52,22 +52,22 @@ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configurat
52
52
  * @param {string} [updated_until] If set, only activities with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
53
53
  * @param {'id' | 'update_time' | 'add_time' | 'due_date'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;, &#x60;due_date&#x60;.
54
54
  * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
55
- * @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
55
+ * @param {Set<'attendees'>} [include_fields] Optional comma separated string array of additional fields to include
56
56
  * @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.
57
57
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
58
58
 
59
59
  * @throws {RequiredError}
60
60
  */
61
- getActivities: (filter_id?: number, ids?: string, owner_id?: number, deal_id?: number, lead_id?: string, person_id?: number, org_id?: number, done?: boolean, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time' | 'due_date', sort_direction?: 'asc' | 'desc', include_fields?: 'attendees', limit?: number, cursor?: string) => Promise<RequestArgs>;
61
+ getActivities: (filter_id?: number, ids?: Set<string>, owner_id?: number, deal_id?: number, lead_id?: string, person_id?: number, org_id?: number, done?: boolean, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time' | 'due_date', sort_direction?: 'asc' | 'desc', include_fields?: Set<'attendees'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
62
62
  /**
63
63
  * Returns the details of a specific activity.
64
64
  * @summary Get details of an activity
65
65
  * @param {number} id The ID of the activity
66
- * @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
66
+ * @param {Set<'attendees'>} [include_fields] Optional comma separated string array of additional fields to include
67
67
 
68
68
  * @throws {RequiredError}
69
69
  */
70
- getActivity: (id: number, include_fields?: 'attendees') => Promise<RequestArgs>;
70
+ getActivity: (id: number, include_fields?: Set<'attendees'>) => Promise<RequestArgs>;
71
71
  /**
72
72
  * Updates the properties of an activity.
73
73
  * @summary Update an activity
@@ -103,7 +103,7 @@ export declare const ActivitiesApiFp: (configuration?: Configuration) => {
103
103
  * Returns data about all activities.
104
104
  * @summary Get all activities
105
105
  * @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
106
- * @param {string} [ids] Optional comma separated string 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.
106
+ * @param {Set<string>} [ids] Optional comma separated string 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.
107
107
  * @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
108
108
  * @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
109
109
  * @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
@@ -114,22 +114,22 @@ export declare const ActivitiesApiFp: (configuration?: Configuration) => {
114
114
  * @param {string} [updated_until] If set, only activities with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
115
115
  * @param {'id' | 'update_time' | 'add_time' | 'due_date'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;, &#x60;due_date&#x60;.
116
116
  * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
117
- * @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
117
+ * @param {Set<'attendees'>} [include_fields] Optional comma separated string array of additional fields to include
118
118
  * @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.
119
119
  * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
120
120
 
121
121
  * @throws {RequiredError}
122
122
  */
123
- getActivities(filter_id?: number, ids?: string, owner_id?: number, deal_id?: number, lead_id?: string, person_id?: number, org_id?: number, done?: boolean, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time' | 'due_date', sort_direction?: 'asc' | 'desc', include_fields?: 'attendees', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivitiesResponse>>;
123
+ getActivities(filter_id?: number, ids?: Set<string>, owner_id?: number, deal_id?: number, lead_id?: string, person_id?: number, org_id?: number, done?: boolean, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time' | 'due_date', sort_direction?: 'asc' | 'desc', include_fields?: Set<'attendees'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivitiesResponse>>;
124
124
  /**
125
125
  * Returns the details of a specific activity.
126
126
  * @summary Get details of an activity
127
127
  * @param {number} id The ID of the activity
128
- * @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
128
+ * @param {Set<'attendees'>} [include_fields] Optional comma separated string array of additional fields to include
129
129
 
130
130
  * @throws {RequiredError}
131
131
  */
132
- getActivity(id: number, include_fields?: 'attendees'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertActivityResponse>>;
132
+ getActivity(id: number, include_fields?: Set<'attendees'>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertActivityResponse>>;
133
133
  /**
134
134
  * Updates the properties of an activity.
135
135
  * @summary Update an activity
@@ -226,10 +226,10 @@ export interface ActivitiesApiGetActivitiesRequest {
226
226
  readonly filter_id?: number;
227
227
  /**
228
228
  * Optional comma separated string 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.
229
- * @type {string}
229
+ * @type {Set<string>}
230
230
  * @memberof ActivitiesApiGetActivities
231
231
  */
232
- readonly ids?: string;
232
+ readonly ids?: Set<string>;
233
233
  /**
234
234
  * If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
235
235
  * @type {number}
@@ -292,10 +292,10 @@ export interface ActivitiesApiGetActivitiesRequest {
292
292
  readonly sort_direction?: 'asc' | 'desc';
293
293
  /**
294
294
  * Optional comma separated string array of additional fields to include
295
- * @type {'attendees'}
295
+ * @type {Set<'attendees'>}
296
296
  * @memberof ActivitiesApiGetActivities
297
297
  */
298
- readonly include_fields?: 'attendees';
298
+ readonly include_fields?: Set<'attendees'>;
299
299
  /**
300
300
  * 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.
301
301
  * @type {number}
@@ -323,10 +323,10 @@ export interface ActivitiesApiGetActivityRequest {
323
323
  readonly id: number;
324
324
  /**
325
325
  * Optional comma separated string array of additional fields to include
326
- * @type {'attendees'}
326
+ * @type {Set<'attendees'>}
327
327
  * @memberof ActivitiesApiGetActivity
328
328
  */
329
- readonly include_fields?: 'attendees';
329
+ readonly include_fields?: Set<'attendees'>;
330
330
  }
331
331
  /**
332
332
  * Request parameters for updateActivity operation in ActivitiesApi.