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.
- package/dist/esm/versions/v2/api/activities-api.d.ts +16 -16
- package/dist/esm/versions/v2/api/activities-api.js +13 -13
- package/dist/esm/versions/v2/api/activity-fields-api.d.ts +12 -12
- package/dist/esm/versions/v2/api/activity-fields-api.js +9 -9
- package/dist/esm/versions/v2/api/deal-fields-api.d.ts +12 -12
- package/dist/esm/versions/v2/api/deal-fields-api.js +9 -9
- package/dist/esm/versions/v2/api/deals-api.d.ts +38 -38
- package/dist/esm/versions/v2/api/deals-api.js +33 -33
- package/dist/esm/versions/v2/api/organization-fields-api.d.ts +12 -12
- package/dist/esm/versions/v2/api/organization-fields-api.js +9 -9
- package/dist/esm/versions/v2/api/organizations-api.d.ts +24 -24
- package/dist/esm/versions/v2/api/organizations-api.js +21 -21
- package/dist/esm/versions/v2/api/person-fields-api.d.ts +12 -12
- package/dist/esm/versions/v2/api/person-fields-api.js +9 -9
- package/dist/esm/versions/v2/api/persons-api.d.ts +24 -24
- package/dist/esm/versions/v2/api/persons-api.js +21 -21
- package/dist/esm/versions/v2/api/product-fields-api.d.ts +24 -24
- package/dist/esm/versions/v2/api/product-fields-api.js +9 -9
- package/dist/esm/versions/v2/api/products-api.d.ts +14 -14
- package/dist/esm/versions/v2/api/products-api.js +15 -15
- package/dist/esm/versions/v2/models/add-product-field200-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/add-product-field200-response.js +14 -0
- package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner.d.ts +2 -0
- package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner.js +3 -1
- package/dist/esm/versions/v2/models/get-product-fields200-response-data-inner.d.ts +97 -0
- package/dist/esm/versions/v2/models/get-product-fields200-response-data-inner.js +48 -0
- package/dist/esm/versions/v2/models/get-product-fields200-response.d.ts +35 -0
- package/dist/esm/versions/v2/models/get-product-fields200-response.js +14 -0
- package/dist/esm/versions/v2/models/get-project-fields200-response-data-inner.d.ts +1 -0
- package/dist/esm/versions/v2/models/get-project-fields200-response-data-inner.js +2 -1
- package/dist/esm/versions/v2/models/index.d.ts +3 -0
- package/dist/esm/versions/v2/models/index.js +3 -0
- package/dist/versions/v2/api/activities-api.d.ts +16 -16
- package/dist/versions/v2/api/activities-api.js +12 -12
- package/dist/versions/v2/api/activity-fields-api.d.ts +12 -12
- package/dist/versions/v2/api/activity-fields-api.js +8 -8
- package/dist/versions/v2/api/deal-fields-api.d.ts +12 -12
- package/dist/versions/v2/api/deal-fields-api.js +8 -8
- package/dist/versions/v2/api/deals-api.d.ts +38 -38
- package/dist/versions/v2/api/deals-api.js +32 -32
- package/dist/versions/v2/api/organization-fields-api.d.ts +12 -12
- package/dist/versions/v2/api/organization-fields-api.js +8 -8
- package/dist/versions/v2/api/organizations-api.d.ts +24 -24
- package/dist/versions/v2/api/organizations-api.js +20 -20
- package/dist/versions/v2/api/person-fields-api.d.ts +12 -12
- package/dist/versions/v2/api/person-fields-api.js +8 -8
- package/dist/versions/v2/api/persons-api.d.ts +24 -24
- package/dist/versions/v2/api/persons-api.js +20 -20
- package/dist/versions/v2/api/product-fields-api.d.ts +24 -24
- package/dist/versions/v2/api/product-fields-api.js +8 -8
- package/dist/versions/v2/api/products-api.d.ts +14 -14
- package/dist/versions/v2/api/products-api.js +14 -14
- package/dist/versions/v2/models/add-product-field200-response.d.ts +29 -0
- package/dist/versions/v2/models/add-product-field200-response.js +15 -0
- package/dist/versions/v2/models/get-activity-fields200-response-data-inner.d.ts +2 -0
- package/dist/versions/v2/models/get-activity-fields200-response-data-inner.js +3 -1
- package/dist/versions/v2/models/get-product-fields200-response-data-inner.d.ts +97 -0
- package/dist/versions/v2/models/get-product-fields200-response-data-inner.js +51 -0
- package/dist/versions/v2/models/get-product-fields200-response.d.ts +35 -0
- package/dist/versions/v2/models/get-product-fields200-response.js +15 -0
- package/dist/versions/v2/models/get-project-fields200-response-data-inner.d.ts +1 -0
- package/dist/versions/v2/models/get-project-fields200-response-data-inner.js +2 -1
- package/dist/versions/v2/models/index.d.ts +3 -0
- package/dist/versions/v2/models/index.js +3 -0
- package/package.json +1 -1
|
@@ -109,7 +109,7 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
|
|
|
109
109
|
* Returns data about all activities.
|
|
110
110
|
* @summary Get all activities
|
|
111
111
|
* @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
|
|
112
|
-
* @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.
|
|
112
|
+
* @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.
|
|
113
113
|
* @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
114
114
|
* @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
115
115
|
* @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
|
|
@@ -120,7 +120,7 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
|
|
|
120
120
|
* @param {string} [updated_until] If set, only activities with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
121
121
|
* @param {'id' | 'update_time' | 'add_time' | 'due_date'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`.
|
|
122
122
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
123
|
-
* @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
|
|
123
|
+
* @param {Set<'attendees'>} [include_fields] Optional comma separated string array of additional fields to include
|
|
124
124
|
* @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.
|
|
125
125
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
126
126
|
|
|
@@ -145,8 +145,8 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
|
|
|
145
145
|
if (filter_id !== undefined) {
|
|
146
146
|
localVarQueryParameter['filter_id'] = filter_id;
|
|
147
147
|
}
|
|
148
|
-
if (ids
|
|
149
|
-
localVarQueryParameter['ids'] = ids;
|
|
148
|
+
if (ids) {
|
|
149
|
+
localVarQueryParameter['ids'] = Array.from(ids).join(base_1.COLLECTION_FORMATS.csv);
|
|
150
150
|
}
|
|
151
151
|
if (owner_id !== undefined) {
|
|
152
152
|
localVarQueryParameter['owner_id'] = owner_id;
|
|
@@ -178,8 +178,8 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
|
|
|
178
178
|
if (sort_direction !== undefined) {
|
|
179
179
|
localVarQueryParameter['sort_direction'] = sort_direction;
|
|
180
180
|
}
|
|
181
|
-
if (include_fields
|
|
182
|
-
localVarQueryParameter['include_fields'] = include_fields;
|
|
181
|
+
if (include_fields) {
|
|
182
|
+
localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
|
|
183
183
|
}
|
|
184
184
|
if (limit !== undefined) {
|
|
185
185
|
localVarQueryParameter['limit'] = limit;
|
|
@@ -199,7 +199,7 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
|
|
|
199
199
|
* Returns the details of a specific activity.
|
|
200
200
|
* @summary Get details of an activity
|
|
201
201
|
* @param {number} id The ID of the activity
|
|
202
|
-
* @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
|
|
202
|
+
* @param {Set<'attendees'>} [include_fields] Optional comma separated string array of additional fields to include
|
|
203
203
|
|
|
204
204
|
* @throws {RequiredError}
|
|
205
205
|
*/
|
|
@@ -222,8 +222,8 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
|
|
|
222
222
|
// authentication oauth2 required
|
|
223
223
|
// oauth required
|
|
224
224
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["activities:read", "activities:full"], configuration);
|
|
225
|
-
if (include_fields
|
|
226
|
-
localVarQueryParameter['include_fields'] = include_fields;
|
|
225
|
+
if (include_fields) {
|
|
226
|
+
localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
|
|
227
227
|
}
|
|
228
228
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
229
229
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -310,7 +310,7 @@ const ActivitiesApiFp = function (configuration) {
|
|
|
310
310
|
* Returns data about all activities.
|
|
311
311
|
* @summary Get all activities
|
|
312
312
|
* @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
|
|
313
|
-
* @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.
|
|
313
|
+
* @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.
|
|
314
314
|
* @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
315
315
|
* @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
316
316
|
* @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
|
|
@@ -321,7 +321,7 @@ const ActivitiesApiFp = function (configuration) {
|
|
|
321
321
|
* @param {string} [updated_until] If set, only activities with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
322
322
|
* @param {'id' | 'update_time' | 'add_time' | 'due_date'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`.
|
|
323
323
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
324
|
-
* @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
|
|
324
|
+
* @param {Set<'attendees'>} [include_fields] Optional comma separated string array of additional fields to include
|
|
325
325
|
* @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.
|
|
326
326
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
327
327
|
|
|
@@ -337,7 +337,7 @@ const ActivitiesApiFp = function (configuration) {
|
|
|
337
337
|
* Returns the details of a specific activity.
|
|
338
338
|
* @summary Get details of an activity
|
|
339
339
|
* @param {number} id The ID of the activity
|
|
340
|
-
* @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
|
|
340
|
+
* @param {Set<'attendees'>} [include_fields] Optional comma separated string array of additional fields to include
|
|
341
341
|
|
|
342
342
|
* @throws {RequiredError}
|
|
343
343
|
*/
|
|
@@ -23,21 +23,21 @@ export declare const ActivityFieldsApiAxiosParamCreator: (configuration?: Config
|
|
|
23
23
|
* Returns metadata about a specific activity field.
|
|
24
24
|
* @summary Get one activity field
|
|
25
25
|
* @param {string} field_code The unique code identifying the field
|
|
26
|
-
* @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
26
|
+
* @param {Set<'ui_visibility'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
27
27
|
|
|
28
28
|
* @throws {RequiredError}
|
|
29
29
|
*/
|
|
30
|
-
getActivityField: (field_code: string, include_fields?: 'ui_visibility') => Promise<RequestArgs>;
|
|
30
|
+
getActivityField: (field_code: string, include_fields?: Set<'ui_visibility'>) => Promise<RequestArgs>;
|
|
31
31
|
/**
|
|
32
32
|
* Returns metadata about all activity fields in the company.
|
|
33
33
|
* @summary Get all activity fields
|
|
34
|
-
* @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
34
|
+
* @param {Set<'ui_visibility'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
35
35
|
* @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.
|
|
36
36
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
37
37
|
|
|
38
38
|
* @throws {RequiredError}
|
|
39
39
|
*/
|
|
40
|
-
getActivityFields: (include_fields?: 'ui_visibility'
|
|
40
|
+
getActivityFields: (include_fields?: Set<'ui_visibility'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
41
41
|
};
|
|
42
42
|
/**
|
|
43
43
|
* ActivityFieldsApi - functional programming interface
|
|
@@ -48,21 +48,21 @@ export declare const ActivityFieldsApiFp: (configuration?: Configuration) => {
|
|
|
48
48
|
* Returns metadata about a specific activity field.
|
|
49
49
|
* @summary Get one activity field
|
|
50
50
|
* @param {string} field_code The unique code identifying the field
|
|
51
|
-
* @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
51
|
+
* @param {Set<'ui_visibility'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
52
52
|
|
|
53
53
|
* @throws {RequiredError}
|
|
54
54
|
*/
|
|
55
|
-
getActivityField(field_code: string, include_fields?: 'ui_visibility'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivityField200Response>>;
|
|
55
|
+
getActivityField(field_code: string, include_fields?: Set<'ui_visibility'>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivityField200Response>>;
|
|
56
56
|
/**
|
|
57
57
|
* Returns metadata about all activity fields in the company.
|
|
58
58
|
* @summary Get all activity fields
|
|
59
|
-
* @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
59
|
+
* @param {Set<'ui_visibility'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
60
60
|
* @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.
|
|
61
61
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
62
62
|
|
|
63
63
|
* @throws {RequiredError}
|
|
64
64
|
*/
|
|
65
|
-
getActivityFields(include_fields?: 'ui_visibility'
|
|
65
|
+
getActivityFields(include_fields?: Set<'ui_visibility'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivityFields200Response>>;
|
|
66
66
|
};
|
|
67
67
|
/**
|
|
68
68
|
* ActivityFieldsApi - factory interface
|
|
@@ -100,10 +100,10 @@ export interface ActivityFieldsApiGetActivityFieldRequest {
|
|
|
100
100
|
readonly field_code: string;
|
|
101
101
|
/**
|
|
102
102
|
* Optional comma separated string array of additional data namespaces to include in response
|
|
103
|
-
* @type {'ui_visibility'}
|
|
103
|
+
* @type {Set<'ui_visibility'>}
|
|
104
104
|
* @memberof ActivityFieldsApiGetActivityField
|
|
105
105
|
*/
|
|
106
|
-
readonly include_fields?: 'ui_visibility'
|
|
106
|
+
readonly include_fields?: Set<'ui_visibility'>;
|
|
107
107
|
}
|
|
108
108
|
/**
|
|
109
109
|
* Request parameters for getActivityFields operation in ActivityFieldsApi.
|
|
@@ -113,10 +113,10 @@ export interface ActivityFieldsApiGetActivityFieldRequest {
|
|
|
113
113
|
export interface ActivityFieldsApiGetActivityFieldsRequest {
|
|
114
114
|
/**
|
|
115
115
|
* Optional comma separated string array of additional data namespaces to include in response
|
|
116
|
-
* @type {'ui_visibility'}
|
|
116
|
+
* @type {Set<'ui_visibility'>}
|
|
117
117
|
* @memberof ActivityFieldsApiGetActivityFields
|
|
118
118
|
*/
|
|
119
|
-
readonly include_fields?: 'ui_visibility'
|
|
119
|
+
readonly include_fields?: Set<'ui_visibility'>;
|
|
120
120
|
/**
|
|
121
121
|
* 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.
|
|
122
122
|
* @type {number}
|
|
@@ -42,7 +42,7 @@ const ActivityFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
42
42
|
* Returns metadata about a specific activity field.
|
|
43
43
|
* @summary Get one activity field
|
|
44
44
|
* @param {string} field_code The unique code identifying the field
|
|
45
|
-
* @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
45
|
+
* @param {Set<'ui_visibility'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
46
46
|
|
|
47
47
|
* @throws {RequiredError}
|
|
48
48
|
*/
|
|
@@ -65,8 +65,8 @@ const ActivityFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
65
65
|
// authentication oauth2 required
|
|
66
66
|
// oauth required
|
|
67
67
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["admin"], configuration);
|
|
68
|
-
if (include_fields
|
|
69
|
-
localVarQueryParameter['include_fields'] = include_fields;
|
|
68
|
+
if (include_fields) {
|
|
69
|
+
localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
|
|
70
70
|
}
|
|
71
71
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
72
72
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -79,7 +79,7 @@ const ActivityFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
79
79
|
/**
|
|
80
80
|
* Returns metadata about all activity fields in the company.
|
|
81
81
|
* @summary Get all activity fields
|
|
82
|
-
* @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
82
|
+
* @param {Set<'ui_visibility'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
83
83
|
* @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.
|
|
84
84
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
85
85
|
|
|
@@ -101,8 +101,8 @@ const ActivityFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
101
101
|
// authentication oauth2 required
|
|
102
102
|
// oauth required
|
|
103
103
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["admin"], configuration);
|
|
104
|
-
if (include_fields
|
|
105
|
-
localVarQueryParameter['include_fields'] = include_fields;
|
|
104
|
+
if (include_fields) {
|
|
105
|
+
localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
|
|
106
106
|
}
|
|
107
107
|
if (limit !== undefined) {
|
|
108
108
|
localVarQueryParameter['limit'] = limit;
|
|
@@ -132,7 +132,7 @@ const ActivityFieldsApiFp = function (configuration) {
|
|
|
132
132
|
* Returns metadata about a specific activity field.
|
|
133
133
|
* @summary Get one activity field
|
|
134
134
|
* @param {string} field_code The unique code identifying the field
|
|
135
|
-
* @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
135
|
+
* @param {Set<'ui_visibility'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
136
136
|
|
|
137
137
|
* @throws {RequiredError}
|
|
138
138
|
*/
|
|
@@ -145,7 +145,7 @@ const ActivityFieldsApiFp = function (configuration) {
|
|
|
145
145
|
/**
|
|
146
146
|
* Returns metadata about all activity fields in the company.
|
|
147
147
|
* @summary Get all activity fields
|
|
148
|
-
* @param {'ui_visibility'} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
148
|
+
* @param {Set<'ui_visibility'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
149
149
|
* @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.
|
|
150
150
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
151
151
|
|
|
@@ -64,21 +64,21 @@ export declare const DealFieldsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
64
64
|
* Returns metadata about a specific deal field.
|
|
65
65
|
* @summary Get one deal field
|
|
66
66
|
* @param {string} field_code The unique code identifying the field
|
|
67
|
-
* @param {'ui_visibility' | 'important_fields' | 'required_fields'
|
|
67
|
+
* @param {Set<'ui_visibility' | 'important_fields' | 'required_fields'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
68
68
|
|
|
69
69
|
* @throws {RequiredError}
|
|
70
70
|
*/
|
|
71
|
-
getDealField: (field_code: string, include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields'
|
|
71
|
+
getDealField: (field_code: string, include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>) => Promise<RequestArgs>;
|
|
72
72
|
/**
|
|
73
73
|
* Returns metadata about all deal fields in the company.
|
|
74
74
|
* @summary Get all deal fields
|
|
75
|
-
* @param {'ui_visibility' | 'important_fields' | 'required_fields'
|
|
75
|
+
* @param {Set<'ui_visibility' | 'important_fields' | 'required_fields'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
76
76
|
* @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.
|
|
77
77
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
78
78
|
|
|
79
79
|
* @throws {RequiredError}
|
|
80
80
|
*/
|
|
81
|
-
getDealFields: (include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields'
|
|
81
|
+
getDealFields: (include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
82
82
|
/**
|
|
83
83
|
* Updates a deal custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
|
|
84
84
|
* @summary Update one deal field
|
|
@@ -141,21 +141,21 @@ export declare const DealFieldsApiFp: (configuration?: Configuration) => {
|
|
|
141
141
|
* Returns metadata about a specific deal field.
|
|
142
142
|
* @summary Get one deal field
|
|
143
143
|
* @param {string} field_code The unique code identifying the field
|
|
144
|
-
* @param {'ui_visibility' | 'important_fields' | 'required_fields'
|
|
144
|
+
* @param {Set<'ui_visibility' | 'important_fields' | 'required_fields'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
145
145
|
|
|
146
146
|
* @throws {RequiredError}
|
|
147
147
|
*/
|
|
148
|
-
getDealField(field_code: string, include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields'
|
|
148
|
+
getDealField(field_code: string, include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealField200Response>>;
|
|
149
149
|
/**
|
|
150
150
|
* Returns metadata about all deal fields in the company.
|
|
151
151
|
* @summary Get all deal fields
|
|
152
|
-
* @param {'ui_visibility' | 'important_fields' | 'required_fields'
|
|
152
|
+
* @param {Set<'ui_visibility' | 'important_fields' | 'required_fields'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
153
153
|
* @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.
|
|
154
154
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
155
155
|
|
|
156
156
|
* @throws {RequiredError}
|
|
157
157
|
*/
|
|
158
|
-
getDealFields(include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields'
|
|
158
|
+
getDealFields(include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealFields200Response>>;
|
|
159
159
|
/**
|
|
160
160
|
* Updates a deal custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
|
|
161
161
|
* @summary Update one deal field
|
|
@@ -323,10 +323,10 @@ export interface DealFieldsApiGetDealFieldRequest {
|
|
|
323
323
|
readonly field_code: string;
|
|
324
324
|
/**
|
|
325
325
|
* Optional comma separated string array of additional data namespaces to include in response
|
|
326
|
-
* @type {'ui_visibility' | 'important_fields' | 'required_fields'
|
|
326
|
+
* @type {Set<'ui_visibility' | 'important_fields' | 'required_fields'>}
|
|
327
327
|
* @memberof DealFieldsApiGetDealField
|
|
328
328
|
*/
|
|
329
|
-
readonly include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields'
|
|
329
|
+
readonly include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>;
|
|
330
330
|
}
|
|
331
331
|
/**
|
|
332
332
|
* Request parameters for getDealFields operation in DealFieldsApi.
|
|
@@ -336,10 +336,10 @@ export interface DealFieldsApiGetDealFieldRequest {
|
|
|
336
336
|
export interface DealFieldsApiGetDealFieldsRequest {
|
|
337
337
|
/**
|
|
338
338
|
* Optional comma separated string array of additional data namespaces to include in response
|
|
339
|
-
* @type {'ui_visibility' | 'important_fields' | 'required_fields'
|
|
339
|
+
* @type {Set<'ui_visibility' | 'important_fields' | 'required_fields'>}
|
|
340
340
|
* @memberof DealFieldsApiGetDealFields
|
|
341
341
|
*/
|
|
342
|
-
readonly include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields'
|
|
342
|
+
readonly include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>;
|
|
343
343
|
/**
|
|
344
344
|
* 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.
|
|
345
345
|
* @type {number}
|
|
@@ -189,7 +189,7 @@ const DealFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
189
189
|
* Returns metadata about a specific deal field.
|
|
190
190
|
* @summary Get one deal field
|
|
191
191
|
* @param {string} field_code The unique code identifying the field
|
|
192
|
-
* @param {'ui_visibility' | 'important_fields' | 'required_fields'
|
|
192
|
+
* @param {Set<'ui_visibility' | 'important_fields' | 'required_fields'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
193
193
|
|
|
194
194
|
* @throws {RequiredError}
|
|
195
195
|
*/
|
|
@@ -212,8 +212,8 @@ const DealFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
212
212
|
// authentication oauth2 required
|
|
213
213
|
// oauth required
|
|
214
214
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full", "admin", "deal-fields:full"], configuration);
|
|
215
|
-
if (include_fields
|
|
216
|
-
localVarQueryParameter['include_fields'] = include_fields;
|
|
215
|
+
if (include_fields) {
|
|
216
|
+
localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
|
|
217
217
|
}
|
|
218
218
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
219
219
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -226,7 +226,7 @@ const DealFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
226
226
|
/**
|
|
227
227
|
* Returns metadata about all deal fields in the company.
|
|
228
228
|
* @summary Get all deal fields
|
|
229
|
-
* @param {'ui_visibility' | 'important_fields' | 'required_fields'
|
|
229
|
+
* @param {Set<'ui_visibility' | 'important_fields' | 'required_fields'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
230
230
|
* @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.
|
|
231
231
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
232
232
|
|
|
@@ -248,8 +248,8 @@ const DealFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
248
248
|
// authentication oauth2 required
|
|
249
249
|
// oauth required
|
|
250
250
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full", "admin", "deal-fields:full"], configuration);
|
|
251
|
-
if (include_fields
|
|
252
|
-
localVarQueryParameter['include_fields'] = include_fields;
|
|
251
|
+
if (include_fields) {
|
|
252
|
+
localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
|
|
253
253
|
}
|
|
254
254
|
if (limit !== undefined) {
|
|
255
255
|
localVarQueryParameter['limit'] = limit;
|
|
@@ -411,7 +411,7 @@ const DealFieldsApiFp = function (configuration) {
|
|
|
411
411
|
* Returns metadata about a specific deal field.
|
|
412
412
|
* @summary Get one deal field
|
|
413
413
|
* @param {string} field_code The unique code identifying the field
|
|
414
|
-
* @param {'ui_visibility' | 'important_fields' | 'required_fields'
|
|
414
|
+
* @param {Set<'ui_visibility' | 'important_fields' | 'required_fields'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
415
415
|
|
|
416
416
|
* @throws {RequiredError}
|
|
417
417
|
*/
|
|
@@ -424,7 +424,7 @@ const DealFieldsApiFp = function (configuration) {
|
|
|
424
424
|
/**
|
|
425
425
|
* Returns metadata about all deal fields in the company.
|
|
426
426
|
* @summary Get all deal fields
|
|
427
|
-
* @param {'ui_visibility' | 'important_fields' | 'required_fields'
|
|
427
|
+
* @param {Set<'ui_visibility' | 'important_fields' | 'required_fields'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
|
|
428
428
|
* @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.
|
|
429
429
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
430
430
|
|