@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/dist/api.d.ts CHANGED
@@ -2806,9 +2806,9 @@ export declare const EventRsvpRequestScopeEnum: {
2806
2806
  };
2807
2807
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2808
2808
  export interface ExistingWidgetSummary {
2809
- 'yproperty'?: string;
2810
- 'xproperty'?: string;
2811
2809
  'ymetric'?: string;
2810
+ 'xproperty'?: string;
2811
+ 'yproperty'?: string;
2812
2812
  'title'?: string;
2813
2813
  'chartType'?: string;
2814
2814
  'xProperty'?: string;
@@ -3740,11 +3740,11 @@ export interface ModelRecord {
3740
3740
  'complete'?: boolean;
3741
3741
  'deleted'?: boolean;
3742
3742
  'uuid': string;
3743
- 'user'?: PublicUserDTO;
3744
3743
  'properties'?: Array<FilledProperty>;
3745
3744
  'objects'?: {
3746
3745
  [key: string]: any | null;
3747
3746
  };
3747
+ 'user'?: PublicUserDTO;
3748
3748
  }
3749
3749
  export interface MultiFile extends PropertyFormat {
3750
3750
  }
@@ -7108,7 +7108,7 @@ export interface SubscribeWebhookDTO {
7108
7108
  */
7109
7109
  'description'?: string;
7110
7110
  /**
7111
- * Webhook payload format (LEGACY, USER_FRIENDLY)
7111
+ * Webhook payload format (LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL)
7112
7112
  */
7113
7113
  'webhookFormat'?: string;
7114
7114
  /**
@@ -7119,6 +7119,10 @@ export interface SubscribeWebhookDTO {
7119
7119
  * Filter criteria for webhook triggers
7120
7120
  */
7121
7121
  'filter'?: Filter;
7122
+ /**
7123
+ * Comma-separated property names to include on the main record. Omitted or blank returns all readable properties; record identity is always included.
7124
+ */
7125
+ 'fields'?: string;
7122
7126
  /**
7123
7127
  * Records to include in webhook payload
7124
7128
  */
@@ -12250,6 +12254,16 @@ export declare const CMSV2PublicApiAxiosParamCreator: (configuration?: Configura
12250
12254
  records: (xCaraerSubdomain: string, requestBody: {
12251
12255
  [key: string]: any | null;
12252
12256
  }, environment?: string, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12257
+ /**
12258
+ * Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
12259
+ * @summary Resolve a historical CMS v2 path to its latest published route
12260
+ * @param {string} xCaraerSubdomain
12261
+ * @param {string} path
12262
+ * @param {string} [environment]
12263
+ * @param {*} [options] Override http request option.
12264
+ * @throws {RequiredError}
12265
+ */
12266
+ redirect: (xCaraerSubdomain: string, path: string, environment?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12253
12267
  /**
12254
12268
  *
12255
12269
  * @summary Company settings, branding and locales
@@ -12390,6 +12404,16 @@ export declare const CMSV2PublicApiFp: (configuration?: Configuration) => {
12390
12404
  records(xCaraerSubdomain: string, requestBody: {
12391
12405
  [key: string]: any | null;
12392
12406
  }, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
12407
+ /**
12408
+ * Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
12409
+ * @summary Resolve a historical CMS v2 path to its latest published route
12410
+ * @param {string} xCaraerSubdomain
12411
+ * @param {string} path
12412
+ * @param {string} [environment]
12413
+ * @param {*} [options] Override http request option.
12414
+ * @throws {RequiredError}
12415
+ */
12416
+ redirect(xCaraerSubdomain: string, path: string, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringString>>;
12393
12417
  /**
12394
12418
  *
12395
12419
  * @summary Company settings, branding and locales
@@ -12530,6 +12554,16 @@ export declare const CMSV2PublicApiFactory: (configuration?: Configuration, base
12530
12554
  records(xCaraerSubdomain: string, requestBody: {
12531
12555
  [key: string]: any | null;
12532
12556
  }, environment?: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
12557
+ /**
12558
+ * Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
12559
+ * @summary Resolve a historical CMS v2 path to its latest published route
12560
+ * @param {string} xCaraerSubdomain
12561
+ * @param {string} path
12562
+ * @param {string} [environment]
12563
+ * @param {*} [options] Override http request option.
12564
+ * @throws {RequiredError}
12565
+ */
12566
+ redirect(xCaraerSubdomain: string, path: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringString>;
12533
12567
  /**
12534
12568
  *
12535
12569
  * @summary Company settings, branding and locales
@@ -12670,6 +12704,16 @@ export declare class CMSV2PublicApi extends BaseAPI {
12670
12704
  records(xCaraerSubdomain: string, requestBody: {
12671
12705
  [key: string]: any | null;
12672
12706
  }, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
12707
+ /**
12708
+ * Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
12709
+ * @summary Resolve a historical CMS v2 path to its latest published route
12710
+ * @param {string} xCaraerSubdomain
12711
+ * @param {string} path
12712
+ * @param {string} [environment]
12713
+ * @param {*} [options] Override http request option.
12714
+ * @throws {RequiredError}
12715
+ */
12716
+ redirect(xCaraerSubdomain: string, path: string, environment?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringString, any, {}>>;
12673
12717
  /**
12674
12718
  *
12675
12719
  * @summary Company settings, branding and locales
@@ -16656,7 +16700,7 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
16656
16700
  * @param {RecordDTO} recordDTO Record data to create
16657
16701
  * @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).
16658
16702
  * @param {boolean} [ignoreErrors] If \&#39;true\&#39;, allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
16659
- * @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
16703
+ * @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
16660
16704
  * @param {*} [options] Override http request option.
16661
16705
  * @throws {RequiredError}
16662
16706
  */
@@ -16668,7 +16712,7 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
16668
16712
  * @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists.
16669
16713
  * @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).
16670
16714
  * @param {boolean} [ignoreErrors]
16671
- * @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
16715
+ * @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
16672
16716
  * @param {*} [options] Override http request option.
16673
16717
  * @throws {RequiredError}
16674
16718
  */
@@ -16700,7 +16744,7 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
16700
16744
  * @summary Extend a record
16701
16745
  * @param {string} uuid
16702
16746
  * @param {ExtendRecordRequest} extendRecordRequest
16703
- * @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
16747
+ * @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
16704
16748
  * @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).
16705
16749
  * @param {*} [options] Override http request option.
16706
16750
  * @throws {RequiredError}
@@ -16713,7 +16757,7 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
16713
16757
  * @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).
16714
16758
  * @param {boolean} [archived] When \&#39;true\&#39;, archived records are returned instead of active records. Defaults to \&#39;false\&#39;.
16715
16759
  * @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.
16716
- * @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
16760
+ * @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
16717
16761
  * @param {*} [options] Override http request option.
16718
16762
  * @throws {RequiredError}
16719
16763
  */
@@ -16783,7 +16827,7 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
16783
16827
  * @param {SearchRequest} searchRequest Search criteria
16784
16828
  * @param {boolean} [archived] When set to \&#39;true\&#39;, includes soft-deleted records in the search results.
16785
16829
  * @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).
16786
- * @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
16830
+ * @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
16787
16831
  * @param {*} [options] Override http request option.
16788
16832
  * @throws {RequiredError}
16789
16833
  */
@@ -16803,7 +16847,7 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
16803
16847
  * @summary Get record details
16804
16848
  * @param {string} uuid
16805
16849
  * @param {string} [object] Optional object name to resolve the record in a specific object context.
16806
- * @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
16850
+ * @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
16807
16851
  * @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).
16808
16852
  * @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned.
16809
16853
  * @param {*} [options] Override http request option.
@@ -16815,7 +16859,7 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
16815
16859
  * @summary Get record details by object
16816
16860
  * @param {string} objectName
16817
16861
  * @param {string} uuid
16818
- * @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
16862
+ * @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
16819
16863
  * @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).
16820
16864
  * @param {*} [options] Override http request option.
16821
16865
  * @throws {RequiredError}
@@ -16837,7 +16881,7 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
16837
16881
  * @param {RecordDTO} recordDTO Record data to update
16838
16882
  * @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).
16839
16883
  * @param {boolean} [ignoreErrors] If \&#39;true\&#39;, allows the update to proceed while ignoring certain non-critical validation errors, when supported.
16840
- * @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
16884
+ * @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
16841
16885
  * @param {*} [options] Override http request option.
16842
16886
  * @throws {RequiredError}
16843
16887
  */
@@ -16850,7 +16894,7 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
16850
16894
  * @param {string} [object] Optional object name to resolve the record in a specific object context.
16851
16895
  * @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).
16852
16896
  * @param {boolean} [ignoreErrors] If \&#39;true\&#39;, allows the update to proceed while ignoring certain non-critical validation errors, when supported.
16853
- * @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
16897
+ * @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
16854
16898
  * @param {*} [options] Override http request option.
16855
16899
  * @throws {RequiredError}
16856
16900
  */
@@ -16922,7 +16966,7 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
16922
16966
  * @param {RecordDTO} recordDTO Record data to create
16923
16967
  * @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).
16924
16968
  * @param {boolean} [ignoreErrors] If \&#39;true\&#39;, allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
16925
- * @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
16969
+ * @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
16926
16970
  * @param {*} [options] Override http request option.
16927
16971
  * @throws {RequiredError}
16928
16972
  */
@@ -16934,7 +16978,7 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
16934
16978
  * @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists.
16935
16979
  * @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).
16936
16980
  * @param {boolean} [ignoreErrors]
16937
- * @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
16981
+ * @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
16938
16982
  * @param {*} [options] Override http request option.
16939
16983
  * @throws {RequiredError}
16940
16984
  */
@@ -16966,7 +17010,7 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
16966
17010
  * @summary Extend a record
16967
17011
  * @param {string} uuid
16968
17012
  * @param {ExtendRecordRequest} extendRecordRequest
16969
- * @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17013
+ * @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
16970
17014
  * @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).
16971
17015
  * @param {*} [options] Override http request option.
16972
17016
  * @throws {RequiredError}
@@ -16979,7 +17023,7 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
16979
17023
  * @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).
16980
17024
  * @param {boolean} [archived] When \&#39;true\&#39;, archived records are returned instead of active records. Defaults to \&#39;false\&#39;.
16981
17025
  * @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.
16982
- * @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
17026
+ * @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
16983
17027
  * @param {*} [options] Override http request option.
16984
17028
  * @throws {RequiredError}
16985
17029
  */
@@ -17049,7 +17093,7 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
17049
17093
  * @param {SearchRequest} searchRequest Search criteria
17050
17094
  * @param {boolean} [archived] When set to \&#39;true\&#39;, includes soft-deleted records in the search results.
17051
17095
  * @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).
17052
- * @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
17096
+ * @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17053
17097
  * @param {*} [options] Override http request option.
17054
17098
  * @throws {RequiredError}
17055
17099
  */
@@ -17069,7 +17113,7 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
17069
17113
  * @summary Get record details
17070
17114
  * @param {string} uuid
17071
17115
  * @param {string} [object] Optional object name to resolve the record in a specific object context.
17072
- * @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17116
+ * @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17073
17117
  * @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).
17074
17118
  * @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned.
17075
17119
  * @param {*} [options] Override http request option.
@@ -17081,7 +17125,7 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
17081
17125
  * @summary Get record details by object
17082
17126
  * @param {string} objectName
17083
17127
  * @param {string} uuid
17084
- * @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17128
+ * @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17085
17129
  * @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).
17086
17130
  * @param {*} [options] Override http request option.
17087
17131
  * @throws {RequiredError}
@@ -17103,7 +17147,7 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
17103
17147
  * @param {RecordDTO} recordDTO Record data to update
17104
17148
  * @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).
17105
17149
  * @param {boolean} [ignoreErrors] If \&#39;true\&#39;, allows the update to proceed while ignoring certain non-critical validation errors, when supported.
17106
- * @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17150
+ * @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17107
17151
  * @param {*} [options] Override http request option.
17108
17152
  * @throws {RequiredError}
17109
17153
  */
@@ -17116,7 +17160,7 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
17116
17160
  * @param {string} [object] Optional object name to resolve the record in a specific object context.
17117
17161
  * @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).
17118
17162
  * @param {boolean} [ignoreErrors] If \&#39;true\&#39;, allows the update to proceed while ignoring certain non-critical validation errors, when supported.
17119
- * @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17163
+ * @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17120
17164
  * @param {*} [options] Override http request option.
17121
17165
  * @throws {RequiredError}
17122
17166
  */
@@ -17188,7 +17232,7 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
17188
17232
  * @param {RecordDTO} recordDTO Record data to create
17189
17233
  * @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).
17190
17234
  * @param {boolean} [ignoreErrors] If \&#39;true\&#39;, allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
17191
- * @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17235
+ * @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17192
17236
  * @param {*} [options] Override http request option.
17193
17237
  * @throws {RequiredError}
17194
17238
  */
@@ -17200,7 +17244,7 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
17200
17244
  * @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists.
17201
17245
  * @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).
17202
17246
  * @param {boolean} [ignoreErrors]
17203
- * @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17247
+ * @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17204
17248
  * @param {*} [options] Override http request option.
17205
17249
  * @throws {RequiredError}
17206
17250
  */
@@ -17232,7 +17276,7 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
17232
17276
  * @summary Extend a record
17233
17277
  * @param {string} uuid
17234
17278
  * @param {ExtendRecordRequest} extendRecordRequest
17235
- * @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17279
+ * @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17236
17280
  * @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).
17237
17281
  * @param {*} [options] Override http request option.
17238
17282
  * @throws {RequiredError}
@@ -17245,7 +17289,7 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
17245
17289
  * @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).
17246
17290
  * @param {boolean} [archived] When \&#39;true\&#39;, archived records are returned instead of active records. Defaults to \&#39;false\&#39;.
17247
17291
  * @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.
17248
- * @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
17292
+ * @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17249
17293
  * @param {*} [options] Override http request option.
17250
17294
  * @throws {RequiredError}
17251
17295
  */
@@ -17315,7 +17359,7 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
17315
17359
  * @param {SearchRequest} searchRequest Search criteria
17316
17360
  * @param {boolean} [archived] When set to \&#39;true\&#39;, includes soft-deleted records in the search results.
17317
17361
  * @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).
17318
- * @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
17362
+ * @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17319
17363
  * @param {*} [options] Override http request option.
17320
17364
  * @throws {RequiredError}
17321
17365
  */
@@ -17335,7 +17379,7 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
17335
17379
  * @summary Get record details
17336
17380
  * @param {string} uuid
17337
17381
  * @param {string} [object] Optional object name to resolve the record in a specific object context.
17338
- * @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17382
+ * @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17339
17383
  * @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).
17340
17384
  * @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned.
17341
17385
  * @param {*} [options] Override http request option.
@@ -17347,7 +17391,7 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
17347
17391
  * @summary Get record details by object
17348
17392
  * @param {string} objectName
17349
17393
  * @param {string} uuid
17350
- * @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17394
+ * @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17351
17395
  * @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).
17352
17396
  * @param {*} [options] Override http request option.
17353
17397
  * @throws {RequiredError}
@@ -17369,7 +17413,7 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
17369
17413
  * @param {RecordDTO} recordDTO Record data to update
17370
17414
  * @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).
17371
17415
  * @param {boolean} [ignoreErrors] If \&#39;true\&#39;, allows the update to proceed while ignoring certain non-critical validation errors, when supported.
17372
- * @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17416
+ * @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17373
17417
  * @param {*} [options] Override http request option.
17374
17418
  * @throws {RequiredError}
17375
17419
  */
@@ -17382,7 +17426,7 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
17382
17426
  * @param {string} [object] Optional object name to resolve the record in a specific object context.
17383
17427
  * @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).
17384
17428
  * @param {boolean} [ignoreErrors] If \&#39;true\&#39;, allows the update to proceed while ignoring certain non-critical validation errors, when supported.
17385
- * @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17429
+ * @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17386
17430
  * @param {*} [options] Override http request option.
17387
17431
  * @throws {RequiredError}
17388
17432
  */
@@ -17454,7 +17498,7 @@ export declare class RecordsApi extends BaseAPI {
17454
17498
  * @param {RecordDTO} recordDTO Record data to create
17455
17499
  * @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).
17456
17500
  * @param {boolean} [ignoreErrors] If \&#39;true\&#39;, allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
17457
- * @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17501
+ * @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17458
17502
  * @param {*} [options] Override http request option.
17459
17503
  * @throws {RequiredError}
17460
17504
  */
@@ -17466,7 +17510,7 @@ export declare class RecordsApi extends BaseAPI {
17466
17510
  * @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists.
17467
17511
  * @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).
17468
17512
  * @param {boolean} [ignoreErrors]
17469
- * @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17513
+ * @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17470
17514
  * @param {*} [options] Override http request option.
17471
17515
  * @throws {RequiredError}
17472
17516
  */
@@ -17498,7 +17542,7 @@ export declare class RecordsApi extends BaseAPI {
17498
17542
  * @summary Extend a record
17499
17543
  * @param {string} uuid
17500
17544
  * @param {ExtendRecordRequest} extendRecordRequest
17501
- * @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17545
+ * @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17502
17546
  * @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).
17503
17547
  * @param {*} [options] Override http request option.
17504
17548
  * @throws {RequiredError}
@@ -17511,7 +17555,7 @@ export declare class RecordsApi extends BaseAPI {
17511
17555
  * @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).
17512
17556
  * @param {boolean} [archived] When \&#39;true\&#39;, archived records are returned instead of active records. Defaults to \&#39;false\&#39;.
17513
17557
  * @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.
17514
- * @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
17558
+ * @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17515
17559
  * @param {*} [options] Override http request option.
17516
17560
  * @throws {RequiredError}
17517
17561
  */
@@ -17581,7 +17625,7 @@ export declare class RecordsApi extends BaseAPI {
17581
17625
  * @param {SearchRequest} searchRequest Search criteria
17582
17626
  * @param {boolean} [archived] When set to \&#39;true\&#39;, includes soft-deleted records in the search results.
17583
17627
  * @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).
17584
- * @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
17628
+ * @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17585
17629
  * @param {*} [options] Override http request option.
17586
17630
  * @throws {RequiredError}
17587
17631
  */
@@ -17601,7 +17645,7 @@ export declare class RecordsApi extends BaseAPI {
17601
17645
  * @summary Get record details
17602
17646
  * @param {string} uuid
17603
17647
  * @param {string} [object] Optional object name to resolve the record in a specific object context.
17604
- * @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17648
+ * @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17605
17649
  * @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).
17606
17650
  * @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned.
17607
17651
  * @param {*} [options] Override http request option.
@@ -17613,7 +17657,7 @@ export declare class RecordsApi extends BaseAPI {
17613
17657
  * @summary Get record details by object
17614
17658
  * @param {string} objectName
17615
17659
  * @param {string} uuid
17616
- * @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17660
+ * @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17617
17661
  * @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).
17618
17662
  * @param {*} [options] Override http request option.
17619
17663
  * @throws {RequiredError}
@@ -17635,7 +17679,7 @@ export declare class RecordsApi extends BaseAPI {
17635
17679
  * @param {RecordDTO} recordDTO Record data to update
17636
17680
  * @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).
17637
17681
  * @param {boolean} [ignoreErrors] If \&#39;true\&#39;, allows the update to proceed while ignoring certain non-critical validation errors, when supported.
17638
- * @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17682
+ * @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17639
17683
  * @param {*} [options] Override http request option.
17640
17684
  * @throws {RequiredError}
17641
17685
  */
@@ -17648,7 +17692,7 @@ export declare class RecordsApi extends BaseAPI {
17648
17692
  * @param {string} [object] Optional object name to resolve the record in a specific object context.
17649
17693
  * @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).
17650
17694
  * @param {boolean} [ignoreErrors] If \&#39;true\&#39;, allows the update to proceed while ignoring certain non-critical validation errors, when supported.
17651
- * @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17695
+ * @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17652
17696
  * @param {*} [options] Override http request option.
17653
17697
  * @throws {RequiredError}
17654
17698
  */
@@ -17675,6 +17719,7 @@ export declare const CreateRecordReturnFormatEnum: {
17675
17719
  readonly Legacy: "LEGACY";
17676
17720
  readonly UserFriendly: "USER_FRIENDLY";
17677
17721
  readonly Expanded: "EXPANDED";
17722
+ readonly Minimal: "MINIMAL";
17678
17723
  };
17679
17724
  export type CreateRecordReturnFormatEnum = typeof CreateRecordReturnFormatEnum[keyof typeof CreateRecordReturnFormatEnum];
17680
17725
  export declare const CreateOrUpdateParseEnum: {
@@ -17687,12 +17732,14 @@ export declare const CreateOrUpdateRecordReturnFormatEnum: {
17687
17732
  readonly Legacy: "LEGACY";
17688
17733
  readonly UserFriendly: "USER_FRIENDLY";
17689
17734
  readonly Expanded: "EXPANDED";
17735
+ readonly Minimal: "MINIMAL";
17690
17736
  };
17691
17737
  export type CreateOrUpdateRecordReturnFormatEnum = typeof CreateOrUpdateRecordReturnFormatEnum[keyof typeof CreateOrUpdateRecordReturnFormatEnum];
17692
17738
  export declare const ExtendRecordReturnFormatEnum: {
17693
17739
  readonly Legacy: "LEGACY";
17694
17740
  readonly UserFriendly: "USER_FRIENDLY";
17695
17741
  readonly Expanded: "EXPANDED";
17742
+ readonly Minimal: "MINIMAL";
17696
17743
  };
17697
17744
  export type ExtendRecordReturnFormatEnum = typeof ExtendRecordReturnFormatEnum[keyof typeof ExtendRecordReturnFormatEnum];
17698
17745
  export declare const ExtendParseEnum: {
@@ -17711,6 +17758,7 @@ export declare const IndexRecordReturnFormatEnum: {
17711
17758
  readonly Legacy: "LEGACY";
17712
17759
  readonly UserFriendly: "USER_FRIENDLY";
17713
17760
  readonly Expanded: "EXPANDED";
17761
+ readonly Minimal: "MINIMAL";
17714
17762
  };
17715
17763
  export type IndexRecordReturnFormatEnum = typeof IndexRecordReturnFormatEnum[keyof typeof IndexRecordReturnFormatEnum];
17716
17764
  export declare const IndexFlowParseEnum: {
@@ -17735,6 +17783,7 @@ export declare const SearchRecordReturnFormatEnum: {
17735
17783
  readonly Legacy: "LEGACY";
17736
17784
  readonly UserFriendly: "USER_FRIENDLY";
17737
17785
  readonly Expanded: "EXPANDED";
17786
+ readonly Minimal: "MINIMAL";
17738
17787
  };
17739
17788
  export type SearchRecordReturnFormatEnum = typeof SearchRecordReturnFormatEnum[keyof typeof SearchRecordReturnFormatEnum];
17740
17789
  export declare const SearchCrossObjectParseEnum: {
@@ -17747,6 +17796,7 @@ export declare const ShowRecordReturnFormatEnum: {
17747
17796
  readonly Legacy: "LEGACY";
17748
17797
  readonly UserFriendly: "USER_FRIENDLY";
17749
17798
  readonly Expanded: "EXPANDED";
17799
+ readonly Minimal: "MINIMAL";
17750
17800
  };
17751
17801
  export type ShowRecordReturnFormatEnum = typeof ShowRecordReturnFormatEnum[keyof typeof ShowRecordReturnFormatEnum];
17752
17802
  export declare const ShowParseEnum: {
@@ -17759,6 +17809,7 @@ export declare const ShowByObjectRecordReturnFormatEnum: {
17759
17809
  readonly Legacy: "LEGACY";
17760
17810
  readonly UserFriendly: "USER_FRIENDLY";
17761
17811
  readonly Expanded: "EXPANDED";
17812
+ readonly Minimal: "MINIMAL";
17762
17813
  };
17763
17814
  export type ShowByObjectRecordReturnFormatEnum = typeof ShowByObjectRecordReturnFormatEnum[keyof typeof ShowByObjectRecordReturnFormatEnum];
17764
17815
  export declare const ShowByObjectParseEnum: {
@@ -17777,6 +17828,7 @@ export declare const UpdateRecordReturnFormatEnum: {
17777
17828
  readonly Legacy: "LEGACY";
17778
17829
  readonly UserFriendly: "USER_FRIENDLY";
17779
17830
  readonly Expanded: "EXPANDED";
17831
+ readonly Minimal: "MINIMAL";
17780
17832
  };
17781
17833
  export type UpdateRecordReturnFormatEnum = typeof UpdateRecordReturnFormatEnum[keyof typeof UpdateRecordReturnFormatEnum];
17782
17834
  export declare const UpdateByUuidParseEnum: {
@@ -17789,6 +17841,7 @@ export declare const UpdateByUuidRecordReturnFormatEnum: {
17789
17841
  readonly Legacy: "LEGACY";
17790
17842
  readonly UserFriendly: "USER_FRIENDLY";
17791
17843
  readonly Expanded: "EXPANDED";
17844
+ readonly Minimal: "MINIMAL";
17792
17845
  };
17793
17846
  export type UpdateByUuidRecordReturnFormatEnum = typeof UpdateByUuidRecordReturnFormatEnum[keyof typeof UpdateByUuidRecordReturnFormatEnum];
17794
17847
  /**