@caraer/client 2.0.610 → 2.0.618
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/api.ts +145 -40
- package/dist/api.d.ts +93 -40
- package/dist/api.js +132 -36
- package/dist/esm/api.d.ts +93 -40
- package/dist/esm/api.js +132 -36
- package/docs/CMSV2PublicApi.md +62 -0
- package/docs/ExistingWidgetSummary.md +4 -4
- package/docs/Record.md +2 -2
- package/docs/RecordsApi.md +18 -18
- package/docs/SubscribeWebhookDTO.md +3 -1
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -2813,9 +2813,9 @@ export const EventRsvpRequestScopeEnum = {
|
|
|
2813
2813
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2814
2814
|
|
|
2815
2815
|
export interface ExistingWidgetSummary {
|
|
2816
|
-
'yproperty'?: string;
|
|
2817
|
-
'xproperty'?: string;
|
|
2818
2816
|
'ymetric'?: string;
|
|
2817
|
+
'xproperty'?: string;
|
|
2818
|
+
'yproperty'?: string;
|
|
2819
2819
|
'title'?: string;
|
|
2820
2820
|
'chartType'?: string;
|
|
2821
2821
|
'xProperty'?: string;
|
|
@@ -3729,9 +3729,9 @@ export interface ModelRecord {
|
|
|
3729
3729
|
'complete'?: boolean;
|
|
3730
3730
|
'deleted'?: boolean;
|
|
3731
3731
|
'uuid': string;
|
|
3732
|
-
'user'?: PublicUserDTO;
|
|
3733
3732
|
'properties'?: Array<FilledProperty>;
|
|
3734
3733
|
'objects'?: { [key: string]: any | null; };
|
|
3734
|
+
'user'?: PublicUserDTO;
|
|
3735
3735
|
}
|
|
3736
3736
|
export interface MultiFile extends PropertyFormat {
|
|
3737
3737
|
}
|
|
@@ -7009,7 +7009,7 @@ export interface SubscribeWebhookDTO {
|
|
|
7009
7009
|
*/
|
|
7010
7010
|
'description'?: string;
|
|
7011
7011
|
/**
|
|
7012
|
-
* Webhook payload format (LEGACY, USER_FRIENDLY)
|
|
7012
|
+
* Webhook payload format (LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL)
|
|
7013
7013
|
*/
|
|
7014
7014
|
'webhookFormat'?: string;
|
|
7015
7015
|
/**
|
|
@@ -7020,6 +7020,10 @@ export interface SubscribeWebhookDTO {
|
|
|
7020
7020
|
* Filter criteria for webhook triggers
|
|
7021
7021
|
*/
|
|
7022
7022
|
'filter'?: Filter;
|
|
7023
|
+
/**
|
|
7024
|
+
* Comma-separated property names to include on the main record. Omitted or blank returns all readable properties; record identity is always included.
|
|
7025
|
+
*/
|
|
7026
|
+
'fields'?: string;
|
|
7023
7027
|
/**
|
|
7024
7028
|
* Records to include in webhook payload
|
|
7025
7029
|
*/
|
|
@@ -16509,6 +16513,58 @@ export const CMSV2PublicApiAxiosParamCreator = function (configuration?: Configu
|
|
|
16509
16513
|
options: localVarRequestOptions,
|
|
16510
16514
|
};
|
|
16511
16515
|
},
|
|
16516
|
+
/**
|
|
16517
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
16518
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
16519
|
+
* @param {string} xCaraerSubdomain
|
|
16520
|
+
* @param {string} path
|
|
16521
|
+
* @param {string} [environment]
|
|
16522
|
+
* @param {*} [options] Override http request option.
|
|
16523
|
+
* @throws {RequiredError}
|
|
16524
|
+
*/
|
|
16525
|
+
redirect: async (xCaraerSubdomain: string, path: string, environment?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
16526
|
+
// verify required parameter 'xCaraerSubdomain' is not null or undefined
|
|
16527
|
+
assertParamExists('redirect', 'xCaraerSubdomain', xCaraerSubdomain)
|
|
16528
|
+
// verify required parameter 'path' is not null or undefined
|
|
16529
|
+
assertParamExists('redirect', 'path', path)
|
|
16530
|
+
const localVarPath = `/api/v2/webpages/v2/public/redirect`;
|
|
16531
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16532
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16533
|
+
let baseOptions;
|
|
16534
|
+
if (configuration) {
|
|
16535
|
+
baseOptions = configuration.baseOptions;
|
|
16536
|
+
}
|
|
16537
|
+
|
|
16538
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
16539
|
+
const localVarHeaderParameter = {} as any;
|
|
16540
|
+
const localVarQueryParameter = {} as any;
|
|
16541
|
+
|
|
16542
|
+
// authentication bearerAuth required
|
|
16543
|
+
// http bearer authentication required
|
|
16544
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
16545
|
+
|
|
16546
|
+
if (environment !== undefined) {
|
|
16547
|
+
localVarQueryParameter['environment'] = environment;
|
|
16548
|
+
}
|
|
16549
|
+
|
|
16550
|
+
if (path !== undefined) {
|
|
16551
|
+
localVarQueryParameter['path'] = path;
|
|
16552
|
+
}
|
|
16553
|
+
|
|
16554
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
16555
|
+
|
|
16556
|
+
if (xCaraerSubdomain != null) {
|
|
16557
|
+
localVarHeaderParameter['X-Caraer-Subdomain'] = String(xCaraerSubdomain);
|
|
16558
|
+
}
|
|
16559
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16560
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16561
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
16562
|
+
|
|
16563
|
+
return {
|
|
16564
|
+
url: toPathString(localVarUrlObj),
|
|
16565
|
+
options: localVarRequestOptions,
|
|
16566
|
+
};
|
|
16567
|
+
},
|
|
16512
16568
|
/**
|
|
16513
16569
|
*
|
|
16514
16570
|
* @summary Company settings, branding and locales
|
|
@@ -16773,6 +16829,21 @@ export const CMSV2PublicApiFp = function(configuration?: Configuration) {
|
|
|
16773
16829
|
const localVarOperationServerBasePath = operationServerMap['CMSV2PublicApi.records']?.[localVarOperationServerIndex]?.url;
|
|
16774
16830
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16775
16831
|
},
|
|
16832
|
+
/**
|
|
16833
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
16834
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
16835
|
+
* @param {string} xCaraerSubdomain
|
|
16836
|
+
* @param {string} path
|
|
16837
|
+
* @param {string} [environment]
|
|
16838
|
+
* @param {*} [options] Override http request option.
|
|
16839
|
+
* @throws {RequiredError}
|
|
16840
|
+
*/
|
|
16841
|
+
async redirect(xCaraerSubdomain: string, path: string, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringString>> {
|
|
16842
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.redirect(xCaraerSubdomain, path, environment, options);
|
|
16843
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
16844
|
+
const localVarOperationServerBasePath = operationServerMap['CMSV2PublicApi.redirect']?.[localVarOperationServerIndex]?.url;
|
|
16845
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16846
|
+
},
|
|
16776
16847
|
/**
|
|
16777
16848
|
*
|
|
16778
16849
|
* @summary Company settings, branding and locales
|
|
@@ -16941,6 +17012,18 @@ export const CMSV2PublicApiFactory = function (configuration?: Configuration, ba
|
|
|
16941
17012
|
records(xCaraerSubdomain: string, requestBody: { [key: string]: any | null; }, environment?: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject> {
|
|
16942
17013
|
return localVarFp.records(xCaraerSubdomain, requestBody, environment, locale, options).then((request) => request(axios, basePath));
|
|
16943
17014
|
},
|
|
17015
|
+
/**
|
|
17016
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
17017
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
17018
|
+
* @param {string} xCaraerSubdomain
|
|
17019
|
+
* @param {string} path
|
|
17020
|
+
* @param {string} [environment]
|
|
17021
|
+
* @param {*} [options] Override http request option.
|
|
17022
|
+
* @throws {RequiredError}
|
|
17023
|
+
*/
|
|
17024
|
+
redirect(xCaraerSubdomain: string, path: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringString> {
|
|
17025
|
+
return localVarFp.redirect(xCaraerSubdomain, path, environment, options).then((request) => request(axios, basePath));
|
|
17026
|
+
},
|
|
16944
17027
|
/**
|
|
16945
17028
|
*
|
|
16946
17029
|
* @summary Company settings, branding and locales
|
|
@@ -17110,6 +17193,19 @@ export class CMSV2PublicApi extends BaseAPI {
|
|
|
17110
17193
|
return CMSV2PublicApiFp(this.configuration).records(xCaraerSubdomain, requestBody, environment, locale, options).then((request) => request(this.axios, this.basePath));
|
|
17111
17194
|
}
|
|
17112
17195
|
|
|
17196
|
+
/**
|
|
17197
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
17198
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
17199
|
+
* @param {string} xCaraerSubdomain
|
|
17200
|
+
* @param {string} path
|
|
17201
|
+
* @param {string} [environment]
|
|
17202
|
+
* @param {*} [options] Override http request option.
|
|
17203
|
+
* @throws {RequiredError}
|
|
17204
|
+
*/
|
|
17205
|
+
public redirect(xCaraerSubdomain: string, path: string, environment?: string, options?: RawAxiosRequestConfig) {
|
|
17206
|
+
return CMSV2PublicApiFp(this.configuration).redirect(xCaraerSubdomain, path, environment, options).then((request) => request(this.axios, this.basePath));
|
|
17207
|
+
}
|
|
17208
|
+
|
|
17113
17209
|
/**
|
|
17114
17210
|
*
|
|
17115
17211
|
* @summary Company settings, branding and locales
|
|
@@ -25893,7 +25989,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
25893
25989
|
* @param {RecordDTO} recordDTO Record data to create
|
|
25894
25990
|
* @param {CreateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
25895
25991
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
25896
|
-
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
25992
|
+
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
25897
25993
|
* @param {*} [options] Override http request option.
|
|
25898
25994
|
* @throws {RequiredError}
|
|
25899
25995
|
*/
|
|
@@ -25951,7 +26047,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
25951
26047
|
* @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists.
|
|
25952
26048
|
* @param {CreateOrUpdateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
25953
26049
|
* @param {boolean} [ignoreErrors]
|
|
25954
|
-
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
26050
|
+
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
25955
26051
|
* @param {*} [options] Override http request option.
|
|
25956
26052
|
* @throws {RequiredError}
|
|
25957
26053
|
*/
|
|
@@ -26109,7 +26205,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
26109
26205
|
* @summary Extend a record
|
|
26110
26206
|
* @param {string} uuid
|
|
26111
26207
|
* @param {ExtendRecordRequest} extendRecordRequest
|
|
26112
|
-
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
26208
|
+
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
26113
26209
|
* @param {ExtendParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
26114
26210
|
* @param {*} [options] Override http request option.
|
|
26115
26211
|
* @throws {RequiredError}
|
|
@@ -26164,7 +26260,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
26164
26260
|
* @param {IndexParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
26165
26261
|
* @param {boolean} [archived] When \'true\', archived records are returned instead of active records. Defaults to \'false\'.
|
|
26166
26262
|
* @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record.
|
|
26167
|
-
* @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
26263
|
+
* @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
26168
26264
|
* @param {*} [options] Override http request option.
|
|
26169
26265
|
* @throws {RequiredError}
|
|
26170
26266
|
*/
|
|
@@ -26508,7 +26604,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
26508
26604
|
* @param {SearchRequest} searchRequest Search criteria
|
|
26509
26605
|
* @param {boolean} [archived] When set to \'true\', includes soft-deleted records in the search results.
|
|
26510
26606
|
* @param {SearchParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
26511
|
-
* @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
26607
|
+
* @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
26512
26608
|
* @param {*} [options] Override http request option.
|
|
26513
26609
|
* @throws {RequiredError}
|
|
26514
26610
|
*/
|
|
@@ -26610,7 +26706,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
26610
26706
|
* @summary Get record details
|
|
26611
26707
|
* @param {string} uuid
|
|
26612
26708
|
* @param {string} [object] Optional object name to resolve the record in a specific object context.
|
|
26613
|
-
* @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
26709
|
+
* @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
26614
26710
|
* @param {ShowParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
26615
26711
|
* @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned.
|
|
26616
26712
|
* @param {*} [options] Override http request option.
|
|
@@ -26668,7 +26764,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
26668
26764
|
* @summary Get record details by object
|
|
26669
26765
|
* @param {string} objectName
|
|
26670
26766
|
* @param {string} uuid
|
|
26671
|
-
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
26767
|
+
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
26672
26768
|
* @param {ShowByObjectParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
26673
26769
|
* @param {*} [options] Override http request option.
|
|
26674
26770
|
* @throws {RequiredError}
|
|
@@ -26762,7 +26858,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
26762
26858
|
* @param {RecordDTO} recordDTO Record data to update
|
|
26763
26859
|
* @param {UpdateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
26764
26860
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
26765
|
-
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
26861
|
+
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
26766
26862
|
* @param {*} [options] Override http request option.
|
|
26767
26863
|
* @throws {RequiredError}
|
|
26768
26864
|
*/
|
|
@@ -26824,7 +26920,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
26824
26920
|
* @param {string} [object] Optional object name to resolve the record in a specific object context.
|
|
26825
26921
|
* @param {UpdateByUuidParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
26826
26922
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
26827
|
-
* @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
26923
|
+
* @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
26828
26924
|
* @param {*} [options] Override http request option.
|
|
26829
26925
|
* @throws {RequiredError}
|
|
26830
26926
|
*/
|
|
@@ -27015,7 +27111,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27015
27111
|
* @param {RecordDTO} recordDTO Record data to create
|
|
27016
27112
|
* @param {CreateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27017
27113
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
27018
|
-
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27114
|
+
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27019
27115
|
* @param {*} [options] Override http request option.
|
|
27020
27116
|
* @throws {RequiredError}
|
|
27021
27117
|
*/
|
|
@@ -27032,7 +27128,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27032
27128
|
* @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists.
|
|
27033
27129
|
* @param {CreateOrUpdateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27034
27130
|
* @param {boolean} [ignoreErrors]
|
|
27035
|
-
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27131
|
+
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27036
27132
|
* @param {*} [options] Override http request option.
|
|
27037
27133
|
* @throws {RequiredError}
|
|
27038
27134
|
*/
|
|
@@ -27079,7 +27175,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27079
27175
|
* @summary Extend a record
|
|
27080
27176
|
* @param {string} uuid
|
|
27081
27177
|
* @param {ExtendRecordRequest} extendRecordRequest
|
|
27082
|
-
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27178
|
+
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27083
27179
|
* @param {ExtendParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27084
27180
|
* @param {*} [options] Override http request option.
|
|
27085
27181
|
* @throws {RequiredError}
|
|
@@ -27097,7 +27193,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27097
27193
|
* @param {IndexParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27098
27194
|
* @param {boolean} [archived] When \'true\', archived records are returned instead of active records. Defaults to \'false\'.
|
|
27099
27195
|
* @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record.
|
|
27100
|
-
* @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27196
|
+
* @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27101
27197
|
* @param {*} [options] Override http request option.
|
|
27102
27198
|
* @throws {RequiredError}
|
|
27103
27199
|
*/
|
|
@@ -27202,7 +27298,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27202
27298
|
* @param {SearchRequest} searchRequest Search criteria
|
|
27203
27299
|
* @param {boolean} [archived] When set to \'true\', includes soft-deleted records in the search results.
|
|
27204
27300
|
* @param {SearchParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27205
|
-
* @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27301
|
+
* @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27206
27302
|
* @param {*} [options] Override http request option.
|
|
27207
27303
|
* @throws {RequiredError}
|
|
27208
27304
|
*/
|
|
@@ -27232,7 +27328,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27232
27328
|
* @summary Get record details
|
|
27233
27329
|
* @param {string} uuid
|
|
27234
27330
|
* @param {string} [object] Optional object name to resolve the record in a specific object context.
|
|
27235
|
-
* @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27331
|
+
* @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27236
27332
|
* @param {ShowParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27237
27333
|
* @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned.
|
|
27238
27334
|
* @param {*} [options] Override http request option.
|
|
@@ -27249,7 +27345,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27249
27345
|
* @summary Get record details by object
|
|
27250
27346
|
* @param {string} objectName
|
|
27251
27347
|
* @param {string} uuid
|
|
27252
|
-
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27348
|
+
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27253
27349
|
* @param {ShowByObjectParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27254
27350
|
* @param {*} [options] Override http request option.
|
|
27255
27351
|
* @throws {RequiredError}
|
|
@@ -27281,7 +27377,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27281
27377
|
* @param {RecordDTO} recordDTO Record data to update
|
|
27282
27378
|
* @param {UpdateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27283
27379
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
27284
|
-
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27380
|
+
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27285
27381
|
* @param {*} [options] Override http request option.
|
|
27286
27382
|
* @throws {RequiredError}
|
|
27287
27383
|
*/
|
|
@@ -27299,7 +27395,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27299
27395
|
* @param {string} [object] Optional object name to resolve the record in a specific object context.
|
|
27300
27396
|
* @param {UpdateByUuidParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27301
27397
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
27302
|
-
* @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27398
|
+
* @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27303
27399
|
* @param {*} [options] Override http request option.
|
|
27304
27400
|
* @throws {RequiredError}
|
|
27305
27401
|
*/
|
|
@@ -27395,7 +27491,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27395
27491
|
* @param {RecordDTO} recordDTO Record data to create
|
|
27396
27492
|
* @param {CreateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27397
27493
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
27398
|
-
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27494
|
+
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27399
27495
|
* @param {*} [options] Override http request option.
|
|
27400
27496
|
* @throws {RequiredError}
|
|
27401
27497
|
*/
|
|
@@ -27409,7 +27505,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27409
27505
|
* @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists.
|
|
27410
27506
|
* @param {CreateOrUpdateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27411
27507
|
* @param {boolean} [ignoreErrors]
|
|
27412
|
-
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27508
|
+
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27413
27509
|
* @param {*} [options] Override http request option.
|
|
27414
27510
|
* @throws {RequiredError}
|
|
27415
27511
|
*/
|
|
@@ -27447,7 +27543,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27447
27543
|
* @summary Extend a record
|
|
27448
27544
|
* @param {string} uuid
|
|
27449
27545
|
* @param {ExtendRecordRequest} extendRecordRequest
|
|
27450
|
-
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27546
|
+
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27451
27547
|
* @param {ExtendParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27452
27548
|
* @param {*} [options] Override http request option.
|
|
27453
27549
|
* @throws {RequiredError}
|
|
@@ -27462,7 +27558,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27462
27558
|
* @param {IndexParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27463
27559
|
* @param {boolean} [archived] When \'true\', archived records are returned instead of active records. Defaults to \'false\'.
|
|
27464
27560
|
* @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record.
|
|
27465
|
-
* @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27561
|
+
* @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27466
27562
|
* @param {*} [options] Override http request option.
|
|
27467
27563
|
* @throws {RequiredError}
|
|
27468
27564
|
*/
|
|
@@ -27546,7 +27642,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27546
27642
|
* @param {SearchRequest} searchRequest Search criteria
|
|
27547
27643
|
* @param {boolean} [archived] When set to \'true\', includes soft-deleted records in the search results.
|
|
27548
27644
|
* @param {SearchParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27549
|
-
* @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27645
|
+
* @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27550
27646
|
* @param {*} [options] Override http request option.
|
|
27551
27647
|
* @throws {RequiredError}
|
|
27552
27648
|
*/
|
|
@@ -27570,7 +27666,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27570
27666
|
* @summary Get record details
|
|
27571
27667
|
* @param {string} uuid
|
|
27572
27668
|
* @param {string} [object] Optional object name to resolve the record in a specific object context.
|
|
27573
|
-
* @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27669
|
+
* @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27574
27670
|
* @param {ShowParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27575
27671
|
* @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned.
|
|
27576
27672
|
* @param {*} [options] Override http request option.
|
|
@@ -27584,7 +27680,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27584
27680
|
* @summary Get record details by object
|
|
27585
27681
|
* @param {string} objectName
|
|
27586
27682
|
* @param {string} uuid
|
|
27587
|
-
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27683
|
+
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27588
27684
|
* @param {ShowByObjectParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27589
27685
|
* @param {*} [options] Override http request option.
|
|
27590
27686
|
* @throws {RequiredError}
|
|
@@ -27610,7 +27706,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27610
27706
|
* @param {RecordDTO} recordDTO Record data to update
|
|
27611
27707
|
* @param {UpdateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27612
27708
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
27613
|
-
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27709
|
+
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27614
27710
|
* @param {*} [options] Override http request option.
|
|
27615
27711
|
* @throws {RequiredError}
|
|
27616
27712
|
*/
|
|
@@ -27625,7 +27721,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27625
27721
|
* @param {string} [object] Optional object name to resolve the record in a specific object context.
|
|
27626
27722
|
* @param {UpdateByUuidParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27627
27723
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
27628
|
-
* @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27724
|
+
* @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27629
27725
|
* @param {*} [options] Override http request option.
|
|
27630
27726
|
* @throws {RequiredError}
|
|
27631
27727
|
*/
|
|
@@ -27718,7 +27814,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
27718
27814
|
* @param {RecordDTO} recordDTO Record data to create
|
|
27719
27815
|
* @param {CreateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27720
27816
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
27721
|
-
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27817
|
+
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27722
27818
|
* @param {*} [options] Override http request option.
|
|
27723
27819
|
* @throws {RequiredError}
|
|
27724
27820
|
*/
|
|
@@ -27733,7 +27829,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
27733
27829
|
* @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists.
|
|
27734
27830
|
* @param {CreateOrUpdateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27735
27831
|
* @param {boolean} [ignoreErrors]
|
|
27736
|
-
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27832
|
+
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27737
27833
|
* @param {*} [options] Override http request option.
|
|
27738
27834
|
* @throws {RequiredError}
|
|
27739
27835
|
*/
|
|
@@ -27774,7 +27870,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
27774
27870
|
* @summary Extend a record
|
|
27775
27871
|
* @param {string} uuid
|
|
27776
27872
|
* @param {ExtendRecordRequest} extendRecordRequest
|
|
27777
|
-
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27873
|
+
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27778
27874
|
* @param {ExtendParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27779
27875
|
* @param {*} [options] Override http request option.
|
|
27780
27876
|
* @throws {RequiredError}
|
|
@@ -27790,7 +27886,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
27790
27886
|
* @param {IndexParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27791
27887
|
* @param {boolean} [archived] When \'true\', archived records are returned instead of active records. Defaults to \'false\'.
|
|
27792
27888
|
* @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record.
|
|
27793
|
-
* @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27889
|
+
* @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27794
27890
|
* @param {*} [options] Override http request option.
|
|
27795
27891
|
* @throws {RequiredError}
|
|
27796
27892
|
*/
|
|
@@ -27881,7 +27977,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
27881
27977
|
* @param {SearchRequest} searchRequest Search criteria
|
|
27882
27978
|
* @param {boolean} [archived] When set to \'true\', includes soft-deleted records in the search results.
|
|
27883
27979
|
* @param {SearchParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27884
|
-
* @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27980
|
+
* @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27885
27981
|
* @param {*} [options] Override http request option.
|
|
27886
27982
|
* @throws {RequiredError}
|
|
27887
27983
|
*/
|
|
@@ -27907,7 +28003,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
27907
28003
|
* @summary Get record details
|
|
27908
28004
|
* @param {string} uuid
|
|
27909
28005
|
* @param {string} [object] Optional object name to resolve the record in a specific object context.
|
|
27910
|
-
* @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
28006
|
+
* @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27911
28007
|
* @param {ShowParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27912
28008
|
* @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned.
|
|
27913
28009
|
* @param {*} [options] Override http request option.
|
|
@@ -27922,7 +28018,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
27922
28018
|
* @summary Get record details by object
|
|
27923
28019
|
* @param {string} objectName
|
|
27924
28020
|
* @param {string} uuid
|
|
27925
|
-
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
28021
|
+
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27926
28022
|
* @param {ShowByObjectParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27927
28023
|
* @param {*} [options] Override http request option.
|
|
27928
28024
|
* @throws {RequiredError}
|
|
@@ -27950,7 +28046,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
27950
28046
|
* @param {RecordDTO} recordDTO Record data to update
|
|
27951
28047
|
* @param {UpdateParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27952
28048
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
27953
|
-
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
28049
|
+
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27954
28050
|
* @param {*} [options] Override http request option.
|
|
27955
28051
|
* @throws {RequiredError}
|
|
27956
28052
|
*/
|
|
@@ -27966,7 +28062,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
27966
28062
|
* @param {string} [object] Optional object name to resolve the record in a specific object context.
|
|
27967
28063
|
* @param {UpdateByUuidParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27968
28064
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
27969
|
-
* @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
28065
|
+
* @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27970
28066
|
* @param {*} [options] Override http request option.
|
|
27971
28067
|
* @throws {RequiredError}
|
|
27972
28068
|
*/
|
|
@@ -27999,6 +28095,7 @@ export const CreateRecordReturnFormatEnum = {
|
|
|
27999
28095
|
Legacy: 'LEGACY',
|
|
28000
28096
|
UserFriendly: 'USER_FRIENDLY',
|
|
28001
28097
|
Expanded: 'EXPANDED',
|
|
28098
|
+
Minimal: 'MINIMAL',
|
|
28002
28099
|
} as const;
|
|
28003
28100
|
export type CreateRecordReturnFormatEnum = typeof CreateRecordReturnFormatEnum[keyof typeof CreateRecordReturnFormatEnum];
|
|
28004
28101
|
export const CreateOrUpdateParseEnum = {
|
|
@@ -28011,12 +28108,14 @@ export const CreateOrUpdateRecordReturnFormatEnum = {
|
|
|
28011
28108
|
Legacy: 'LEGACY',
|
|
28012
28109
|
UserFriendly: 'USER_FRIENDLY',
|
|
28013
28110
|
Expanded: 'EXPANDED',
|
|
28111
|
+
Minimal: 'MINIMAL',
|
|
28014
28112
|
} as const;
|
|
28015
28113
|
export type CreateOrUpdateRecordReturnFormatEnum = typeof CreateOrUpdateRecordReturnFormatEnum[keyof typeof CreateOrUpdateRecordReturnFormatEnum];
|
|
28016
28114
|
export const ExtendRecordReturnFormatEnum = {
|
|
28017
28115
|
Legacy: 'LEGACY',
|
|
28018
28116
|
UserFriendly: 'USER_FRIENDLY',
|
|
28019
28117
|
Expanded: 'EXPANDED',
|
|
28118
|
+
Minimal: 'MINIMAL',
|
|
28020
28119
|
} as const;
|
|
28021
28120
|
export type ExtendRecordReturnFormatEnum = typeof ExtendRecordReturnFormatEnum[keyof typeof ExtendRecordReturnFormatEnum];
|
|
28022
28121
|
export const ExtendParseEnum = {
|
|
@@ -28035,6 +28134,7 @@ export const IndexRecordReturnFormatEnum = {
|
|
|
28035
28134
|
Legacy: 'LEGACY',
|
|
28036
28135
|
UserFriendly: 'USER_FRIENDLY',
|
|
28037
28136
|
Expanded: 'EXPANDED',
|
|
28137
|
+
Minimal: 'MINIMAL',
|
|
28038
28138
|
} as const;
|
|
28039
28139
|
export type IndexRecordReturnFormatEnum = typeof IndexRecordReturnFormatEnum[keyof typeof IndexRecordReturnFormatEnum];
|
|
28040
28140
|
export const IndexFlowParseEnum = {
|
|
@@ -28059,6 +28159,7 @@ export const SearchRecordReturnFormatEnum = {
|
|
|
28059
28159
|
Legacy: 'LEGACY',
|
|
28060
28160
|
UserFriendly: 'USER_FRIENDLY',
|
|
28061
28161
|
Expanded: 'EXPANDED',
|
|
28162
|
+
Minimal: 'MINIMAL',
|
|
28062
28163
|
} as const;
|
|
28063
28164
|
export type SearchRecordReturnFormatEnum = typeof SearchRecordReturnFormatEnum[keyof typeof SearchRecordReturnFormatEnum];
|
|
28064
28165
|
export const SearchCrossObjectParseEnum = {
|
|
@@ -28071,6 +28172,7 @@ export const ShowRecordReturnFormatEnum = {
|
|
|
28071
28172
|
Legacy: 'LEGACY',
|
|
28072
28173
|
UserFriendly: 'USER_FRIENDLY',
|
|
28073
28174
|
Expanded: 'EXPANDED',
|
|
28175
|
+
Minimal: 'MINIMAL',
|
|
28074
28176
|
} as const;
|
|
28075
28177
|
export type ShowRecordReturnFormatEnum = typeof ShowRecordReturnFormatEnum[keyof typeof ShowRecordReturnFormatEnum];
|
|
28076
28178
|
export const ShowParseEnum = {
|
|
@@ -28083,6 +28185,7 @@ export const ShowByObjectRecordReturnFormatEnum = {
|
|
|
28083
28185
|
Legacy: 'LEGACY',
|
|
28084
28186
|
UserFriendly: 'USER_FRIENDLY',
|
|
28085
28187
|
Expanded: 'EXPANDED',
|
|
28188
|
+
Minimal: 'MINIMAL',
|
|
28086
28189
|
} as const;
|
|
28087
28190
|
export type ShowByObjectRecordReturnFormatEnum = typeof ShowByObjectRecordReturnFormatEnum[keyof typeof ShowByObjectRecordReturnFormatEnum];
|
|
28088
28191
|
export const ShowByObjectParseEnum = {
|
|
@@ -28101,6 +28204,7 @@ export const UpdateRecordReturnFormatEnum = {
|
|
|
28101
28204
|
Legacy: 'LEGACY',
|
|
28102
28205
|
UserFriendly: 'USER_FRIENDLY',
|
|
28103
28206
|
Expanded: 'EXPANDED',
|
|
28207
|
+
Minimal: 'MINIMAL',
|
|
28104
28208
|
} as const;
|
|
28105
28209
|
export type UpdateRecordReturnFormatEnum = typeof UpdateRecordReturnFormatEnum[keyof typeof UpdateRecordReturnFormatEnum];
|
|
28106
28210
|
export const UpdateByUuidParseEnum = {
|
|
@@ -28113,6 +28217,7 @@ export const UpdateByUuidRecordReturnFormatEnum = {
|
|
|
28113
28217
|
Legacy: 'LEGACY',
|
|
28114
28218
|
UserFriendly: 'USER_FRIENDLY',
|
|
28115
28219
|
Expanded: 'EXPANDED',
|
|
28220
|
+
Minimal: 'MINIMAL',
|
|
28116
28221
|
} as const;
|
|
28117
28222
|
export type UpdateByUuidRecordReturnFormatEnum = typeof UpdateByUuidRecordReturnFormatEnum[keyof typeof UpdateByUuidRecordReturnFormatEnum];
|
|
28118
28223
|
|