@caraer/client 2.0.609 → 2.0.617
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 +51 -38
- package/dist/api.d.ts +51 -38
- package/dist/api.js +45 -36
- package/dist/esm/api.d.ts +51 -38
- package/dist/esm/api.js +45 -36
- package/docs/ExistingWidgetSummary.md +2 -2
- package/docs/RecordsApi.md +18 -18
- package/docs/SubscribeWebhookDTO.md +3 -1
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -2814,8 +2814,8 @@ export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof t
|
|
|
2814
2814
|
|
|
2815
2815
|
export interface ExistingWidgetSummary {
|
|
2816
2816
|
'xproperty'?: string;
|
|
2817
|
-
'ymetric'?: string;
|
|
2818
2817
|
'yproperty'?: string;
|
|
2818
|
+
'ymetric'?: string;
|
|
2819
2819
|
'title'?: string;
|
|
2820
2820
|
'chartType'?: string;
|
|
2821
2821
|
'xProperty'?: string;
|
|
@@ -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
|
*/
|
|
@@ -25893,7 +25897,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
25893
25897
|
* @param {RecordDTO} recordDTO Record data to create
|
|
25894
25898
|
* @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
25899
|
* @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.
|
|
25900
|
+
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
25897
25901
|
* @param {*} [options] Override http request option.
|
|
25898
25902
|
* @throws {RequiredError}
|
|
25899
25903
|
*/
|
|
@@ -25951,7 +25955,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
25951
25955
|
* @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists.
|
|
25952
25956
|
* @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
25957
|
* @param {boolean} [ignoreErrors]
|
|
25954
|
-
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
25958
|
+
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
25955
25959
|
* @param {*} [options] Override http request option.
|
|
25956
25960
|
* @throws {RequiredError}
|
|
25957
25961
|
*/
|
|
@@ -26109,7 +26113,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
26109
26113
|
* @summary Extend a record
|
|
26110
26114
|
* @param {string} uuid
|
|
26111
26115
|
* @param {ExtendRecordRequest} extendRecordRequest
|
|
26112
|
-
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
26116
|
+
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
26113
26117
|
* @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
26118
|
* @param {*} [options] Override http request option.
|
|
26115
26119
|
* @throws {RequiredError}
|
|
@@ -26164,7 +26168,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
26164
26168
|
* @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
26169
|
* @param {boolean} [archived] When \'true\', archived records are returned instead of active records. Defaults to \'false\'.
|
|
26166
26170
|
* @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.
|
|
26171
|
+
* @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
26168
26172
|
* @param {*} [options] Override http request option.
|
|
26169
26173
|
* @throws {RequiredError}
|
|
26170
26174
|
*/
|
|
@@ -26508,7 +26512,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
26508
26512
|
* @param {SearchRequest} searchRequest Search criteria
|
|
26509
26513
|
* @param {boolean} [archived] When set to \'true\', includes soft-deleted records in the search results.
|
|
26510
26514
|
* @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.
|
|
26515
|
+
* @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
26512
26516
|
* @param {*} [options] Override http request option.
|
|
26513
26517
|
* @throws {RequiredError}
|
|
26514
26518
|
*/
|
|
@@ -26610,7 +26614,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
26610
26614
|
* @summary Get record details
|
|
26611
26615
|
* @param {string} uuid
|
|
26612
26616
|
* @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.
|
|
26617
|
+
* @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
26614
26618
|
* @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
26619
|
* @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned.
|
|
26616
26620
|
* @param {*} [options] Override http request option.
|
|
@@ -26668,7 +26672,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
26668
26672
|
* @summary Get record details by object
|
|
26669
26673
|
* @param {string} objectName
|
|
26670
26674
|
* @param {string} uuid
|
|
26671
|
-
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
26675
|
+
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
26672
26676
|
* @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
26677
|
* @param {*} [options] Override http request option.
|
|
26674
26678
|
* @throws {RequiredError}
|
|
@@ -26762,7 +26766,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
26762
26766
|
* @param {RecordDTO} recordDTO Record data to update
|
|
26763
26767
|
* @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
26768
|
* @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.
|
|
26769
|
+
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
26766
26770
|
* @param {*} [options] Override http request option.
|
|
26767
26771
|
* @throws {RequiredError}
|
|
26768
26772
|
*/
|
|
@@ -26824,7 +26828,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
26824
26828
|
* @param {string} [object] Optional object name to resolve the record in a specific object context.
|
|
26825
26829
|
* @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
26830
|
* @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.
|
|
26831
|
+
* @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
26828
26832
|
* @param {*} [options] Override http request option.
|
|
26829
26833
|
* @throws {RequiredError}
|
|
26830
26834
|
*/
|
|
@@ -27015,7 +27019,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27015
27019
|
* @param {RecordDTO} recordDTO Record data to create
|
|
27016
27020
|
* @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
27021
|
* @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.
|
|
27022
|
+
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27019
27023
|
* @param {*} [options] Override http request option.
|
|
27020
27024
|
* @throws {RequiredError}
|
|
27021
27025
|
*/
|
|
@@ -27032,7 +27036,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27032
27036
|
* @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists.
|
|
27033
27037
|
* @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
27038
|
* @param {boolean} [ignoreErrors]
|
|
27035
|
-
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27039
|
+
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27036
27040
|
* @param {*} [options] Override http request option.
|
|
27037
27041
|
* @throws {RequiredError}
|
|
27038
27042
|
*/
|
|
@@ -27079,7 +27083,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27079
27083
|
* @summary Extend a record
|
|
27080
27084
|
* @param {string} uuid
|
|
27081
27085
|
* @param {ExtendRecordRequest} extendRecordRequest
|
|
27082
|
-
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27086
|
+
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27083
27087
|
* @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
27088
|
* @param {*} [options] Override http request option.
|
|
27085
27089
|
* @throws {RequiredError}
|
|
@@ -27097,7 +27101,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27097
27101
|
* @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
27102
|
* @param {boolean} [archived] When \'true\', archived records are returned instead of active records. Defaults to \'false\'.
|
|
27099
27103
|
* @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.
|
|
27104
|
+
* @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27101
27105
|
* @param {*} [options] Override http request option.
|
|
27102
27106
|
* @throws {RequiredError}
|
|
27103
27107
|
*/
|
|
@@ -27202,7 +27206,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27202
27206
|
* @param {SearchRequest} searchRequest Search criteria
|
|
27203
27207
|
* @param {boolean} [archived] When set to \'true\', includes soft-deleted records in the search results.
|
|
27204
27208
|
* @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.
|
|
27209
|
+
* @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27206
27210
|
* @param {*} [options] Override http request option.
|
|
27207
27211
|
* @throws {RequiredError}
|
|
27208
27212
|
*/
|
|
@@ -27232,7 +27236,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27232
27236
|
* @summary Get record details
|
|
27233
27237
|
* @param {string} uuid
|
|
27234
27238
|
* @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.
|
|
27239
|
+
* @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27236
27240
|
* @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
27241
|
* @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned.
|
|
27238
27242
|
* @param {*} [options] Override http request option.
|
|
@@ -27249,7 +27253,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27249
27253
|
* @summary Get record details by object
|
|
27250
27254
|
* @param {string} objectName
|
|
27251
27255
|
* @param {string} uuid
|
|
27252
|
-
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27256
|
+
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27253
27257
|
* @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
27258
|
* @param {*} [options] Override http request option.
|
|
27255
27259
|
* @throws {RequiredError}
|
|
@@ -27281,7 +27285,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27281
27285
|
* @param {RecordDTO} recordDTO Record data to update
|
|
27282
27286
|
* @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
27287
|
* @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.
|
|
27288
|
+
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27285
27289
|
* @param {*} [options] Override http request option.
|
|
27286
27290
|
* @throws {RequiredError}
|
|
27287
27291
|
*/
|
|
@@ -27299,7 +27303,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27299
27303
|
* @param {string} [object] Optional object name to resolve the record in a specific object context.
|
|
27300
27304
|
* @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
27305
|
* @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.
|
|
27306
|
+
* @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27303
27307
|
* @param {*} [options] Override http request option.
|
|
27304
27308
|
* @throws {RequiredError}
|
|
27305
27309
|
*/
|
|
@@ -27395,7 +27399,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27395
27399
|
* @param {RecordDTO} recordDTO Record data to create
|
|
27396
27400
|
* @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
27401
|
* @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.
|
|
27402
|
+
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27399
27403
|
* @param {*} [options] Override http request option.
|
|
27400
27404
|
* @throws {RequiredError}
|
|
27401
27405
|
*/
|
|
@@ -27409,7 +27413,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27409
27413
|
* @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists.
|
|
27410
27414
|
* @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
27415
|
* @param {boolean} [ignoreErrors]
|
|
27412
|
-
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27416
|
+
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27413
27417
|
* @param {*} [options] Override http request option.
|
|
27414
27418
|
* @throws {RequiredError}
|
|
27415
27419
|
*/
|
|
@@ -27447,7 +27451,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27447
27451
|
* @summary Extend a record
|
|
27448
27452
|
* @param {string} uuid
|
|
27449
27453
|
* @param {ExtendRecordRequest} extendRecordRequest
|
|
27450
|
-
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27454
|
+
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27451
27455
|
* @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
27456
|
* @param {*} [options] Override http request option.
|
|
27453
27457
|
* @throws {RequiredError}
|
|
@@ -27462,7 +27466,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27462
27466
|
* @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
27467
|
* @param {boolean} [archived] When \'true\', archived records are returned instead of active records. Defaults to \'false\'.
|
|
27464
27468
|
* @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.
|
|
27469
|
+
* @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27466
27470
|
* @param {*} [options] Override http request option.
|
|
27467
27471
|
* @throws {RequiredError}
|
|
27468
27472
|
*/
|
|
@@ -27546,7 +27550,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27546
27550
|
* @param {SearchRequest} searchRequest Search criteria
|
|
27547
27551
|
* @param {boolean} [archived] When set to \'true\', includes soft-deleted records in the search results.
|
|
27548
27552
|
* @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.
|
|
27553
|
+
* @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27550
27554
|
* @param {*} [options] Override http request option.
|
|
27551
27555
|
* @throws {RequiredError}
|
|
27552
27556
|
*/
|
|
@@ -27570,7 +27574,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27570
27574
|
* @summary Get record details
|
|
27571
27575
|
* @param {string} uuid
|
|
27572
27576
|
* @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.
|
|
27577
|
+
* @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27574
27578
|
* @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
27579
|
* @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned.
|
|
27576
27580
|
* @param {*} [options] Override http request option.
|
|
@@ -27584,7 +27588,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27584
27588
|
* @summary Get record details by object
|
|
27585
27589
|
* @param {string} objectName
|
|
27586
27590
|
* @param {string} uuid
|
|
27587
|
-
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27591
|
+
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27588
27592
|
* @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
27593
|
* @param {*} [options] Override http request option.
|
|
27590
27594
|
* @throws {RequiredError}
|
|
@@ -27610,7 +27614,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27610
27614
|
* @param {RecordDTO} recordDTO Record data to update
|
|
27611
27615
|
* @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
27616
|
* @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.
|
|
27617
|
+
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27614
27618
|
* @param {*} [options] Override http request option.
|
|
27615
27619
|
* @throws {RequiredError}
|
|
27616
27620
|
*/
|
|
@@ -27625,7 +27629,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27625
27629
|
* @param {string} [object] Optional object name to resolve the record in a specific object context.
|
|
27626
27630
|
* @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
27631
|
* @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.
|
|
27632
|
+
* @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27629
27633
|
* @param {*} [options] Override http request option.
|
|
27630
27634
|
* @throws {RequiredError}
|
|
27631
27635
|
*/
|
|
@@ -27718,7 +27722,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
27718
27722
|
* @param {RecordDTO} recordDTO Record data to create
|
|
27719
27723
|
* @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
27724
|
* @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.
|
|
27725
|
+
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27722
27726
|
* @param {*} [options] Override http request option.
|
|
27723
27727
|
* @throws {RequiredError}
|
|
27724
27728
|
*/
|
|
@@ -27733,7 +27737,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
27733
27737
|
* @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists.
|
|
27734
27738
|
* @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
27739
|
* @param {boolean} [ignoreErrors]
|
|
27736
|
-
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27740
|
+
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27737
27741
|
* @param {*} [options] Override http request option.
|
|
27738
27742
|
* @throws {RequiredError}
|
|
27739
27743
|
*/
|
|
@@ -27774,7 +27778,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
27774
27778
|
* @summary Extend a record
|
|
27775
27779
|
* @param {string} uuid
|
|
27776
27780
|
* @param {ExtendRecordRequest} extendRecordRequest
|
|
27777
|
-
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27781
|
+
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27778
27782
|
* @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
27783
|
* @param {*} [options] Override http request option.
|
|
27780
27784
|
* @throws {RequiredError}
|
|
@@ -27790,7 +27794,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
27790
27794
|
* @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
27795
|
* @param {boolean} [archived] When \'true\', archived records are returned instead of active records. Defaults to \'false\'.
|
|
27792
27796
|
* @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.
|
|
27797
|
+
* @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27794
27798
|
* @param {*} [options] Override http request option.
|
|
27795
27799
|
* @throws {RequiredError}
|
|
27796
27800
|
*/
|
|
@@ -27881,7 +27885,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
27881
27885
|
* @param {SearchRequest} searchRequest Search criteria
|
|
27882
27886
|
* @param {boolean} [archived] When set to \'true\', includes soft-deleted records in the search results.
|
|
27883
27887
|
* @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.
|
|
27888
|
+
* @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27885
27889
|
* @param {*} [options] Override http request option.
|
|
27886
27890
|
* @throws {RequiredError}
|
|
27887
27891
|
*/
|
|
@@ -27907,7 +27911,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
27907
27911
|
* @summary Get record details
|
|
27908
27912
|
* @param {string} uuid
|
|
27909
27913
|
* @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.
|
|
27914
|
+
* @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27911
27915
|
* @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
27916
|
* @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned.
|
|
27913
27917
|
* @param {*} [options] Override http request option.
|
|
@@ -27922,7 +27926,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
27922
27926
|
* @summary Get record details by object
|
|
27923
27927
|
* @param {string} objectName
|
|
27924
27928
|
* @param {string} uuid
|
|
27925
|
-
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
27929
|
+
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27926
27930
|
* @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
27931
|
* @param {*} [options] Override http request option.
|
|
27928
27932
|
* @throws {RequiredError}
|
|
@@ -27950,7 +27954,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
27950
27954
|
* @param {RecordDTO} recordDTO Record data to update
|
|
27951
27955
|
* @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
27956
|
* @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.
|
|
27957
|
+
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27954
27958
|
* @param {*} [options] Override http request option.
|
|
27955
27959
|
* @throws {RequiredError}
|
|
27956
27960
|
*/
|
|
@@ -27966,7 +27970,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
27966
27970
|
* @param {string} [object] Optional object name to resolve the record in a specific object context.
|
|
27967
27971
|
* @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
27972
|
* @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.
|
|
27973
|
+
* @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
27970
27974
|
* @param {*} [options] Override http request option.
|
|
27971
27975
|
* @throws {RequiredError}
|
|
27972
27976
|
*/
|
|
@@ -27999,6 +28003,7 @@ export const CreateRecordReturnFormatEnum = {
|
|
|
27999
28003
|
Legacy: 'LEGACY',
|
|
28000
28004
|
UserFriendly: 'USER_FRIENDLY',
|
|
28001
28005
|
Expanded: 'EXPANDED',
|
|
28006
|
+
Minimal: 'MINIMAL',
|
|
28002
28007
|
} as const;
|
|
28003
28008
|
export type CreateRecordReturnFormatEnum = typeof CreateRecordReturnFormatEnum[keyof typeof CreateRecordReturnFormatEnum];
|
|
28004
28009
|
export const CreateOrUpdateParseEnum = {
|
|
@@ -28011,12 +28016,14 @@ export const CreateOrUpdateRecordReturnFormatEnum = {
|
|
|
28011
28016
|
Legacy: 'LEGACY',
|
|
28012
28017
|
UserFriendly: 'USER_FRIENDLY',
|
|
28013
28018
|
Expanded: 'EXPANDED',
|
|
28019
|
+
Minimal: 'MINIMAL',
|
|
28014
28020
|
} as const;
|
|
28015
28021
|
export type CreateOrUpdateRecordReturnFormatEnum = typeof CreateOrUpdateRecordReturnFormatEnum[keyof typeof CreateOrUpdateRecordReturnFormatEnum];
|
|
28016
28022
|
export const ExtendRecordReturnFormatEnum = {
|
|
28017
28023
|
Legacy: 'LEGACY',
|
|
28018
28024
|
UserFriendly: 'USER_FRIENDLY',
|
|
28019
28025
|
Expanded: 'EXPANDED',
|
|
28026
|
+
Minimal: 'MINIMAL',
|
|
28020
28027
|
} as const;
|
|
28021
28028
|
export type ExtendRecordReturnFormatEnum = typeof ExtendRecordReturnFormatEnum[keyof typeof ExtendRecordReturnFormatEnum];
|
|
28022
28029
|
export const ExtendParseEnum = {
|
|
@@ -28035,6 +28042,7 @@ export const IndexRecordReturnFormatEnum = {
|
|
|
28035
28042
|
Legacy: 'LEGACY',
|
|
28036
28043
|
UserFriendly: 'USER_FRIENDLY',
|
|
28037
28044
|
Expanded: 'EXPANDED',
|
|
28045
|
+
Minimal: 'MINIMAL',
|
|
28038
28046
|
} as const;
|
|
28039
28047
|
export type IndexRecordReturnFormatEnum = typeof IndexRecordReturnFormatEnum[keyof typeof IndexRecordReturnFormatEnum];
|
|
28040
28048
|
export const IndexFlowParseEnum = {
|
|
@@ -28059,6 +28067,7 @@ export const SearchRecordReturnFormatEnum = {
|
|
|
28059
28067
|
Legacy: 'LEGACY',
|
|
28060
28068
|
UserFriendly: 'USER_FRIENDLY',
|
|
28061
28069
|
Expanded: 'EXPANDED',
|
|
28070
|
+
Minimal: 'MINIMAL',
|
|
28062
28071
|
} as const;
|
|
28063
28072
|
export type SearchRecordReturnFormatEnum = typeof SearchRecordReturnFormatEnum[keyof typeof SearchRecordReturnFormatEnum];
|
|
28064
28073
|
export const SearchCrossObjectParseEnum = {
|
|
@@ -28071,6 +28080,7 @@ export const ShowRecordReturnFormatEnum = {
|
|
|
28071
28080
|
Legacy: 'LEGACY',
|
|
28072
28081
|
UserFriendly: 'USER_FRIENDLY',
|
|
28073
28082
|
Expanded: 'EXPANDED',
|
|
28083
|
+
Minimal: 'MINIMAL',
|
|
28074
28084
|
} as const;
|
|
28075
28085
|
export type ShowRecordReturnFormatEnum = typeof ShowRecordReturnFormatEnum[keyof typeof ShowRecordReturnFormatEnum];
|
|
28076
28086
|
export const ShowParseEnum = {
|
|
@@ -28083,6 +28093,7 @@ export const ShowByObjectRecordReturnFormatEnum = {
|
|
|
28083
28093
|
Legacy: 'LEGACY',
|
|
28084
28094
|
UserFriendly: 'USER_FRIENDLY',
|
|
28085
28095
|
Expanded: 'EXPANDED',
|
|
28096
|
+
Minimal: 'MINIMAL',
|
|
28086
28097
|
} as const;
|
|
28087
28098
|
export type ShowByObjectRecordReturnFormatEnum = typeof ShowByObjectRecordReturnFormatEnum[keyof typeof ShowByObjectRecordReturnFormatEnum];
|
|
28088
28099
|
export const ShowByObjectParseEnum = {
|
|
@@ -28101,6 +28112,7 @@ export const UpdateRecordReturnFormatEnum = {
|
|
|
28101
28112
|
Legacy: 'LEGACY',
|
|
28102
28113
|
UserFriendly: 'USER_FRIENDLY',
|
|
28103
28114
|
Expanded: 'EXPANDED',
|
|
28115
|
+
Minimal: 'MINIMAL',
|
|
28104
28116
|
} as const;
|
|
28105
28117
|
export type UpdateRecordReturnFormatEnum = typeof UpdateRecordReturnFormatEnum[keyof typeof UpdateRecordReturnFormatEnum];
|
|
28106
28118
|
export const UpdateByUuidParseEnum = {
|
|
@@ -28113,6 +28125,7 @@ export const UpdateByUuidRecordReturnFormatEnum = {
|
|
|
28113
28125
|
Legacy: 'LEGACY',
|
|
28114
28126
|
UserFriendly: 'USER_FRIENDLY',
|
|
28115
28127
|
Expanded: 'EXPANDED',
|
|
28128
|
+
Minimal: 'MINIMAL',
|
|
28116
28129
|
} as const;
|
|
28117
28130
|
export type UpdateByUuidRecordReturnFormatEnum = typeof UpdateByUuidRecordReturnFormatEnum[keyof typeof UpdateByUuidRecordReturnFormatEnum];
|
|
28118
28131
|
|