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
|
@@ -189,7 +189,7 @@ const OrganizationFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
189
189
|
* Returns metadata about a specific organization field.
|
|
190
190
|
* @summary Get one organization 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 OrganizationFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
212
212
|
// authentication oauth2 required
|
|
213
213
|
// oauth required
|
|
214
214
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full", "admin", "contact-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 OrganizationFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
226
226
|
/**
|
|
227
227
|
* Returns metadata about all organization fields in the company.
|
|
228
228
|
* @summary Get all organization 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 OrganizationFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
248
248
|
// authentication oauth2 required
|
|
249
249
|
// oauth required
|
|
250
250
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full", "admin", "contact-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 OrganizationFieldsApiFp = function (configuration) {
|
|
|
411
411
|
* Returns metadata about a specific organization field.
|
|
412
412
|
* @summary Get one organization 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 OrganizationFieldsApiFp = function (configuration) {
|
|
|
424
424
|
/**
|
|
425
425
|
* Returns metadata about all organization fields in the company.
|
|
426
426
|
* @summary Get all organization 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
|
|
|
@@ -66,14 +66,14 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
66
66
|
* Returns the details of a specific organization.
|
|
67
67
|
* @summary Get details of a organization
|
|
68
68
|
* @param {number} id The ID of the organization
|
|
69
|
-
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include
|
|
70
|
-
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
69
|
+
* @param {Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'>} [include_fields] Optional comma separated string array of additional fields to include
|
|
70
|
+
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
71
71
|
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
72
72
|
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
73
73
|
|
|
74
74
|
* @throws {RequiredError}
|
|
75
75
|
*/
|
|
76
|
-
getOrganization: (id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'
|
|
76
|
+
getOrganization: (id: number, include_fields?: Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean) => Promise<RequestArgs>;
|
|
77
77
|
/**
|
|
78
78
|
* Lists users who are following the organization.
|
|
79
79
|
* @summary List followers of an organization
|
|
@@ -98,14 +98,14 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
98
98
|
* Returns data about all organizations.
|
|
99
99
|
* @summary Get all organizations
|
|
100
100
|
* @param {number} [filter_id] If supplied, only organizations matching the specified filter are returned
|
|
101
|
-
* @param {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.
|
|
101
|
+
* @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.
|
|
102
102
|
* @param {number} [owner_id] If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
103
103
|
* @param {string} [updated_since] If set, only organizations with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
104
104
|
* @param {string} [updated_until] If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
105
105
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
106
106
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
107
|
-
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include
|
|
108
|
-
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
107
|
+
* @param {Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'>} [include_fields] Optional comma separated string array of additional fields to include
|
|
108
|
+
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
109
109
|
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
110
110
|
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
111
111
|
* @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.
|
|
@@ -113,7 +113,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
113
113
|
|
|
114
114
|
* @throws {RequiredError}
|
|
115
115
|
*/
|
|
116
|
-
getOrganizations: (filter_id?: number, ids?: string
|
|
116
|
+
getOrganizations: (filter_id?: number, ids?: Set<string>, owner_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
117
117
|
/**
|
|
118
118
|
* Searches all organizations by name, address, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
|
|
119
119
|
* @summary Search organizations
|
|
@@ -179,14 +179,14 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
179
179
|
* Returns the details of a specific organization.
|
|
180
180
|
* @summary Get details of a organization
|
|
181
181
|
* @param {number} id The ID of the organization
|
|
182
|
-
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include
|
|
183
|
-
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
182
|
+
* @param {Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'>} [include_fields] Optional comma separated string array of additional fields to include
|
|
183
|
+
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
184
184
|
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
185
185
|
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
186
186
|
|
|
187
187
|
* @throws {RequiredError}
|
|
188
188
|
*/
|
|
189
|
-
getOrganization(id: number, include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'
|
|
189
|
+
getOrganization(id: number, include_fields?: Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertOrganizationResponse>>;
|
|
190
190
|
/**
|
|
191
191
|
* Lists users who are following the organization.
|
|
192
192
|
* @summary List followers of an organization
|
|
@@ -211,14 +211,14 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
211
211
|
* Returns data about all organizations.
|
|
212
212
|
* @summary Get all organizations
|
|
213
213
|
* @param {number} [filter_id] If supplied, only organizations matching the specified filter are returned
|
|
214
|
-
* @param {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.
|
|
214
|
+
* @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.
|
|
215
215
|
* @param {number} [owner_id] If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
216
216
|
* @param {string} [updated_since] If set, only organizations with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
217
217
|
* @param {string} [updated_until] If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
218
218
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
219
219
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
220
|
-
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include
|
|
221
|
-
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
220
|
+
* @param {Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'>} [include_fields] Optional comma separated string array of additional fields to include
|
|
221
|
+
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
222
222
|
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
223
223
|
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
224
224
|
* @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.
|
|
@@ -226,7 +226,7 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
226
226
|
|
|
227
227
|
* @throws {RequiredError}
|
|
228
228
|
*/
|
|
229
|
-
getOrganizations(filter_id?: number, ids?: string
|
|
229
|
+
getOrganizations(filter_id?: number, ids?: Set<string>, owner_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetOrganizationsResponse>>;
|
|
230
230
|
/**
|
|
231
231
|
* Searches all organizations by name, address, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
|
|
232
232
|
* @summary Search organizations
|
|
@@ -413,16 +413,16 @@ export interface OrganizationsApiGetOrganizationRequest {
|
|
|
413
413
|
readonly id: number;
|
|
414
414
|
/**
|
|
415
415
|
* Optional comma separated string array of additional fields to include
|
|
416
|
-
* @type {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'}
|
|
416
|
+
* @type {Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'>}
|
|
417
417
|
* @memberof OrganizationsApiGetOrganization
|
|
418
418
|
*/
|
|
419
|
-
readonly include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'
|
|
419
|
+
readonly include_fields?: Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'>;
|
|
420
420
|
/**
|
|
421
421
|
* Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
422
|
-
* @type {string}
|
|
422
|
+
* @type {Set<string>}
|
|
423
423
|
* @memberof OrganizationsApiGetOrganization
|
|
424
424
|
*/
|
|
425
|
-
readonly custom_fields?: string
|
|
425
|
+
readonly custom_fields?: Set<string>;
|
|
426
426
|
/**
|
|
427
427
|
* When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
428
428
|
* @type {boolean}
|
|
@@ -500,10 +500,10 @@ export interface OrganizationsApiGetOrganizationsRequest {
|
|
|
500
500
|
readonly filter_id?: number;
|
|
501
501
|
/**
|
|
502
502
|
* 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.
|
|
503
|
-
* @type {string}
|
|
503
|
+
* @type {Set<string>}
|
|
504
504
|
* @memberof OrganizationsApiGetOrganizations
|
|
505
505
|
*/
|
|
506
|
-
readonly ids?: string
|
|
506
|
+
readonly ids?: Set<string>;
|
|
507
507
|
/**
|
|
508
508
|
* If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
509
509
|
* @type {number}
|
|
@@ -536,16 +536,16 @@ export interface OrganizationsApiGetOrganizationsRequest {
|
|
|
536
536
|
readonly sort_direction?: 'asc' | 'desc';
|
|
537
537
|
/**
|
|
538
538
|
* Optional comma separated string array of additional fields to include
|
|
539
|
-
* @type {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'}
|
|
539
|
+
* @type {Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'>}
|
|
540
540
|
* @memberof OrganizationsApiGetOrganizations
|
|
541
541
|
*/
|
|
542
|
-
readonly include_fields?: 'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'
|
|
542
|
+
readonly include_fields?: Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'>;
|
|
543
543
|
/**
|
|
544
544
|
* Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
545
|
-
* @type {string}
|
|
545
|
+
* @type {Set<string>}
|
|
546
546
|
* @memberof OrganizationsApiGetOrganizations
|
|
547
547
|
*/
|
|
548
|
-
readonly custom_fields?: string
|
|
548
|
+
readonly custom_fields?: Set<string>;
|
|
549
549
|
/**
|
|
550
550
|
* When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
551
551
|
* @type {boolean}
|
|
@@ -184,8 +184,8 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
184
184
|
* Returns the details of a specific organization.
|
|
185
185
|
* @summary Get details of a organization
|
|
186
186
|
* @param {number} id The ID of the organization
|
|
187
|
-
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include
|
|
188
|
-
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
187
|
+
* @param {Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'>} [include_fields] Optional comma separated string array of additional fields to include
|
|
188
|
+
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
189
189
|
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
190
190
|
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
191
191
|
|
|
@@ -210,11 +210,11 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
210
210
|
// authentication oauth2 required
|
|
211
211
|
// oauth required
|
|
212
212
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full"], configuration);
|
|
213
|
-
if (include_fields
|
|
214
|
-
localVarQueryParameter['include_fields'] = include_fields;
|
|
213
|
+
if (include_fields) {
|
|
214
|
+
localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
|
|
215
215
|
}
|
|
216
|
-
if (custom_fields
|
|
217
|
-
localVarQueryParameter['custom_fields'] = custom_fields;
|
|
216
|
+
if (custom_fields) {
|
|
217
|
+
localVarQueryParameter['custom_fields'] = Array.from(custom_fields).join(base_1.COLLECTION_FORMATS.csv);
|
|
218
218
|
}
|
|
219
219
|
if (include_option_labels !== undefined) {
|
|
220
220
|
localVarQueryParameter['include_option_labels'] = include_option_labels;
|
|
@@ -318,14 +318,14 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
318
318
|
* Returns data about all organizations.
|
|
319
319
|
* @summary Get all organizations
|
|
320
320
|
* @param {number} [filter_id] If supplied, only organizations matching the specified filter are returned
|
|
321
|
-
* @param {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.
|
|
321
|
+
* @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.
|
|
322
322
|
* @param {number} [owner_id] If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
323
323
|
* @param {string} [updated_since] If set, only organizations with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
324
324
|
* @param {string} [updated_until] If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
325
325
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
326
326
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
327
|
-
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include
|
|
328
|
-
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
327
|
+
* @param {Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'>} [include_fields] Optional comma separated string array of additional fields to include
|
|
328
|
+
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
329
329
|
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
330
330
|
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
331
331
|
* @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.
|
|
@@ -352,8 +352,8 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
352
352
|
if (filter_id !== undefined) {
|
|
353
353
|
localVarQueryParameter['filter_id'] = filter_id;
|
|
354
354
|
}
|
|
355
|
-
if (ids
|
|
356
|
-
localVarQueryParameter['ids'] = ids;
|
|
355
|
+
if (ids) {
|
|
356
|
+
localVarQueryParameter['ids'] = Array.from(ids).join(base_1.COLLECTION_FORMATS.csv);
|
|
357
357
|
}
|
|
358
358
|
if (owner_id !== undefined) {
|
|
359
359
|
localVarQueryParameter['owner_id'] = owner_id;
|
|
@@ -370,11 +370,11 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
370
370
|
if (sort_direction !== undefined) {
|
|
371
371
|
localVarQueryParameter['sort_direction'] = sort_direction;
|
|
372
372
|
}
|
|
373
|
-
if (include_fields
|
|
374
|
-
localVarQueryParameter['include_fields'] = include_fields;
|
|
373
|
+
if (include_fields) {
|
|
374
|
+
localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
|
|
375
375
|
}
|
|
376
|
-
if (custom_fields
|
|
377
|
-
localVarQueryParameter['custom_fields'] = custom_fields;
|
|
376
|
+
if (custom_fields) {
|
|
377
|
+
localVarQueryParameter['custom_fields'] = Array.from(custom_fields).join(base_1.COLLECTION_FORMATS.csv);
|
|
378
378
|
}
|
|
379
379
|
if (include_option_labels !== undefined) {
|
|
380
380
|
localVarQueryParameter['include_option_labels'] = include_option_labels;
|
|
@@ -553,8 +553,8 @@ const OrganizationsApiFp = function (configuration) {
|
|
|
553
553
|
* Returns the details of a specific organization.
|
|
554
554
|
* @summary Get details of a organization
|
|
555
555
|
* @param {number} id The ID of the organization
|
|
556
|
-
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include
|
|
557
|
-
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
556
|
+
* @param {Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'>} [include_fields] Optional comma separated string array of additional fields to include
|
|
557
|
+
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
558
558
|
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
559
559
|
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
560
560
|
|
|
@@ -600,14 +600,14 @@ const OrganizationsApiFp = function (configuration) {
|
|
|
600
600
|
* Returns data about all organizations.
|
|
601
601
|
* @summary Get all organizations
|
|
602
602
|
* @param {number} [filter_id] If supplied, only organizations matching the specified filter are returned
|
|
603
|
-
* @param {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.
|
|
603
|
+
* @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.
|
|
604
604
|
* @param {number} [owner_id] If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
605
605
|
* @param {string} [updated_since] If set, only organizations with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
606
606
|
* @param {string} [updated_until] If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
607
607
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
608
608
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
|
609
|
-
* @param {'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'} [include_fields] Optional comma separated string array of additional fields to include
|
|
610
|
-
* @param {string} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
609
|
+
* @param {Set<'next_activity_id' | 'last_activity_id' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'email_messages_count' | 'people_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'smart_bcc_email'>} [include_fields] Optional comma separated string array of additional fields to include
|
|
610
|
+
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
611
611
|
* @param {boolean} [include_option_labels] When provided with a \'true\' value, single option and multiple option custom fields values contain objects in the form of \'{ id: number, label: string }\' instead of plain id
|
|
612
612
|
* @param {boolean} [include_labels] When provided with \'true\' value, response will include an array of label objects in the form of \'{ id: number, label: string }\'
|
|
613
613
|
* @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.
|
|
@@ -64,21 +64,21 @@ export declare const PersonFieldsApiAxiosParamCreator: (configuration?: Configur
|
|
|
64
64
|
* Returns metadata about a specific person field.
|
|
65
65
|
* @summary Get one person 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
|
-
getPersonField: (field_code: string, include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields'
|
|
71
|
+
getPersonField: (field_code: string, include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>) => Promise<RequestArgs>;
|
|
72
72
|
/**
|
|
73
73
|
* Returns metadata about all person fields in the company.
|
|
74
74
|
* @summary Get all person 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
|
-
getPersonFields: (include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields'
|
|
81
|
+
getPersonFields: (include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
82
82
|
/**
|
|
83
83
|
* Updates a person 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 person field
|
|
@@ -141,21 +141,21 @@ export declare const PersonFieldsApiFp: (configuration?: Configuration) => {
|
|
|
141
141
|
* Returns metadata about a specific person field.
|
|
142
142
|
* @summary Get one person 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
|
-
getPersonField(field_code: string, include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields'
|
|
148
|
+
getPersonField(field_code: string, include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddPersonField200Response>>;
|
|
149
149
|
/**
|
|
150
150
|
* Returns metadata about all person fields in the company.
|
|
151
151
|
* @summary Get all person 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
|
-
getPersonFields(include_fields?: 'ui_visibility' | 'important_fields' | 'required_fields'
|
|
158
|
+
getPersonFields(include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonFields200Response>>;
|
|
159
159
|
/**
|
|
160
160
|
* Updates a person 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 person field
|
|
@@ -323,10 +323,10 @@ export interface PersonFieldsApiGetPersonFieldRequest {
|
|
|
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 PersonFieldsApiGetPersonField
|
|
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 getPersonFields operation in PersonFieldsApi.
|
|
@@ -336,10 +336,10 @@ export interface PersonFieldsApiGetPersonFieldRequest {
|
|
|
336
336
|
export interface PersonFieldsApiGetPersonFieldsRequest {
|
|
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 PersonFieldsApiGetPersonFields
|
|
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 PersonFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
189
189
|
* Returns metadata about a specific person field.
|
|
190
190
|
* @summary Get one person 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 PersonFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
212
212
|
// authentication oauth2 required
|
|
213
213
|
// oauth required
|
|
214
214
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full", "admin", "contact-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 PersonFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
226
226
|
/**
|
|
227
227
|
* Returns metadata about all person fields in the company.
|
|
228
228
|
* @summary Get all person 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 PersonFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
248
248
|
// authentication oauth2 required
|
|
249
249
|
// oauth required
|
|
250
250
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full", "admin", "contact-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 PersonFieldsApiFp = function (configuration) {
|
|
|
411
411
|
* Returns metadata about a specific person field.
|
|
412
412
|
* @summary Get one person 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 PersonFieldsApiFp = function (configuration) {
|
|
|
424
424
|
/**
|
|
425
425
|
* Returns metadata about all person fields in the company.
|
|
426
426
|
* @summary Get all person 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
|
|