@caraer/client 2.0.666 → 2.0.669
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/.openapi-generator/FILES +2 -0
- package/api.ts +32 -14
- package/dist/api.d.ts +31 -14
- package/dist/api.js +12 -12
- package/dist/esm/api.d.ts +31 -14
- package/dist/esm/api.js +12 -12
- package/docs/ExistingWidgetSummary.md +2 -2
- package/docs/Record.md +2 -2
- package/docs/RecordWriteEnvelope.md +23 -0
- package/docs/RecordWriteRequest.md +48 -0
- package/docs/RecordsApi.md +6 -6
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
package/api.ts
CHANGED
|
@@ -2820,9 +2820,9 @@ export const EventRsvpRequestScopeEnum = {
|
|
|
2820
2820
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2821
2821
|
|
|
2822
2822
|
export interface ExistingWidgetSummary {
|
|
2823
|
-
'xproperty'?: string;
|
|
2824
2823
|
'ymetric'?: string;
|
|
2825
2824
|
'yproperty'?: string;
|
|
2825
|
+
'xproperty'?: string;
|
|
2826
2826
|
'title'?: string;
|
|
2827
2827
|
'chartType'?: string;
|
|
2828
2828
|
'xProperty'?: string;
|
|
@@ -3736,9 +3736,9 @@ export interface ModelRecord {
|
|
|
3736
3736
|
'complete'?: boolean;
|
|
3737
3737
|
'deleted'?: boolean;
|
|
3738
3738
|
'uuid': string;
|
|
3739
|
+
'user'?: PublicUserDTO;
|
|
3739
3740
|
'properties'?: Array<FilledProperty>;
|
|
3740
3741
|
'objects'?: { [key: string]: any | null; };
|
|
3741
|
-
'user'?: PublicUserDTO;
|
|
3742
3742
|
}
|
|
3743
3743
|
export interface MultiFile extends PropertyFormat {
|
|
3744
3744
|
}
|
|
@@ -5426,6 +5426,24 @@ export interface RecordSummary {
|
|
|
5426
5426
|
'properties'?: { [key: string]: any | null; };
|
|
5427
5427
|
'parsedProperties'?: { [key: string]: any | null; };
|
|
5428
5428
|
}
|
|
5429
|
+
/**
|
|
5430
|
+
* Optional record-write envelope. objectName must match the URL\'s object context. Query parameters still control parse, ignoreErrors and recordReturnFormat.
|
|
5431
|
+
*/
|
|
5432
|
+
export interface RecordWriteEnvelope {
|
|
5433
|
+
/**
|
|
5434
|
+
* Optional object name; when provided it must match the URL.
|
|
5435
|
+
*/
|
|
5436
|
+
'objectName'?: string;
|
|
5437
|
+
/**
|
|
5438
|
+
* The record to create or update.
|
|
5439
|
+
*/
|
|
5440
|
+
'record': RecordDTO;
|
|
5441
|
+
}
|
|
5442
|
+
/**
|
|
5443
|
+
* @type RecordWriteRequest
|
|
5444
|
+
*/
|
|
5445
|
+
export type RecordWriteRequest = RecordDTO | RecordWriteEnvelope;
|
|
5446
|
+
|
|
5429
5447
|
export interface Recurrence extends PropertyFormat {
|
|
5430
5448
|
}
|
|
5431
5449
|
export interface Reference {
|
|
@@ -26172,7 +26190,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
26172
26190
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
26173
26191
|
* @summary Create a new record
|
|
26174
26192
|
* @param {string} objectName
|
|
26175
|
-
* @param {RecordDTO} recordDTO
|
|
26193
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to create
|
|
26176
26194
|
* @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).
|
|
26177
26195
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
26178
26196
|
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -26230,7 +26248,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
26230
26248
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
26231
26249
|
* @summary Create or update a record
|
|
26232
26250
|
* @param {string} objectName
|
|
26233
|
-
* @param {RecordDTO} recordDTO
|
|
26251
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
26234
26252
|
* @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).
|
|
26235
26253
|
* @param {boolean} [ignoreErrors]
|
|
26236
26254
|
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -27041,7 +27059,7 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
27041
27059
|
* @summary Update a record
|
|
27042
27060
|
* @param {string} uuid
|
|
27043
27061
|
* @param {string} objectName
|
|
27044
|
-
* @param {RecordDTO} recordDTO
|
|
27062
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to update
|
|
27045
27063
|
* @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).
|
|
27046
27064
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
27047
27065
|
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -27306,7 +27324,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27306
27324
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
27307
27325
|
* @summary Create a new record
|
|
27308
27326
|
* @param {string} objectName
|
|
27309
|
-
* @param {RecordDTO} recordDTO
|
|
27327
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to create
|
|
27310
27328
|
* @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).
|
|
27311
27329
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
27312
27330
|
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -27323,7 +27341,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27323
27341
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
27324
27342
|
* @summary Create or update a record
|
|
27325
27343
|
* @param {string} objectName
|
|
27326
|
-
* @param {RecordDTO} recordDTO
|
|
27344
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
27327
27345
|
* @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).
|
|
27328
27346
|
* @param {boolean} [ignoreErrors]
|
|
27329
27347
|
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -27572,7 +27590,7 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
27572
27590
|
* @summary Update a record
|
|
27573
27591
|
* @param {string} uuid
|
|
27574
27592
|
* @param {string} objectName
|
|
27575
|
-
* @param {RecordDTO} recordDTO
|
|
27593
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to update
|
|
27576
27594
|
* @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).
|
|
27577
27595
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
27578
27596
|
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -27695,7 +27713,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27695
27713
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
27696
27714
|
* @summary Create a new record
|
|
27697
27715
|
* @param {string} objectName
|
|
27698
|
-
* @param {RecordDTO} recordDTO
|
|
27716
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to create
|
|
27699
27717
|
* @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).
|
|
27700
27718
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
27701
27719
|
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -27709,7 +27727,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27709
27727
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
27710
27728
|
* @summary Create or update a record
|
|
27711
27729
|
* @param {string} objectName
|
|
27712
|
-
* @param {RecordDTO} recordDTO
|
|
27730
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
27713
27731
|
* @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).
|
|
27714
27732
|
* @param {boolean} [ignoreErrors]
|
|
27715
27733
|
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -27910,7 +27928,7 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27910
27928
|
* @summary Update a record
|
|
27911
27929
|
* @param {string} uuid
|
|
27912
27930
|
* @param {string} objectName
|
|
27913
|
-
* @param {RecordDTO} recordDTO
|
|
27931
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to update
|
|
27914
27932
|
* @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).
|
|
27915
27933
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
27916
27934
|
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -28028,7 +28046,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
28028
28046
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
28029
28047
|
* @summary Create a new record
|
|
28030
28048
|
* @param {string} objectName
|
|
28031
|
-
* @param {RecordDTO} recordDTO
|
|
28049
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to create
|
|
28032
28050
|
* @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).
|
|
28033
28051
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
28034
28052
|
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -28043,7 +28061,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
28043
28061
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
28044
28062
|
* @summary Create or update a record
|
|
28045
28063
|
* @param {string} objectName
|
|
28046
|
-
* @param {RecordDTO} recordDTO
|
|
28064
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
28047
28065
|
* @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).
|
|
28048
28066
|
* @param {boolean} [ignoreErrors]
|
|
28049
28067
|
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -28260,7 +28278,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
28260
28278
|
* @summary Update a record
|
|
28261
28279
|
* @param {string} uuid
|
|
28262
28280
|
* @param {string} objectName
|
|
28263
|
-
* @param {RecordDTO} recordDTO
|
|
28281
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to update
|
|
28264
28282
|
* @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).
|
|
28265
28283
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
28266
28284
|
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
package/dist/api.d.ts
CHANGED
|
@@ -2814,9 +2814,9 @@ export declare const EventRsvpRequestScopeEnum: {
|
|
|
2814
2814
|
};
|
|
2815
2815
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2816
2816
|
export interface ExistingWidgetSummary {
|
|
2817
|
-
'xproperty'?: string;
|
|
2818
2817
|
'ymetric'?: string;
|
|
2819
2818
|
'yproperty'?: string;
|
|
2819
|
+
'xproperty'?: string;
|
|
2820
2820
|
'title'?: string;
|
|
2821
2821
|
'chartType'?: string;
|
|
2822
2822
|
'xProperty'?: string;
|
|
@@ -3748,11 +3748,11 @@ export interface ModelRecord {
|
|
|
3748
3748
|
'complete'?: boolean;
|
|
3749
3749
|
'deleted'?: boolean;
|
|
3750
3750
|
'uuid': string;
|
|
3751
|
+
'user'?: PublicUserDTO;
|
|
3751
3752
|
'properties'?: Array<FilledProperty>;
|
|
3752
3753
|
'objects'?: {
|
|
3753
3754
|
[key: string]: any | null;
|
|
3754
3755
|
};
|
|
3755
|
-
'user'?: PublicUserDTO;
|
|
3756
3756
|
}
|
|
3757
3757
|
export interface MultiFile extends PropertyFormat {
|
|
3758
3758
|
}
|
|
@@ -5470,6 +5470,23 @@ export interface RecordSummary {
|
|
|
5470
5470
|
[key: string]: any | null;
|
|
5471
5471
|
};
|
|
5472
5472
|
}
|
|
5473
|
+
/**
|
|
5474
|
+
* Optional record-write envelope. objectName must match the URL\'s object context. Query parameters still control parse, ignoreErrors and recordReturnFormat.
|
|
5475
|
+
*/
|
|
5476
|
+
export interface RecordWriteEnvelope {
|
|
5477
|
+
/**
|
|
5478
|
+
* Optional object name; when provided it must match the URL.
|
|
5479
|
+
*/
|
|
5480
|
+
'objectName'?: string;
|
|
5481
|
+
/**
|
|
5482
|
+
* The record to create or update.
|
|
5483
|
+
*/
|
|
5484
|
+
'record': RecordDTO;
|
|
5485
|
+
}
|
|
5486
|
+
/**
|
|
5487
|
+
* @type RecordWriteRequest
|
|
5488
|
+
*/
|
|
5489
|
+
export type RecordWriteRequest = RecordDTO | RecordWriteEnvelope;
|
|
5473
5490
|
export interface Recurrence extends PropertyFormat {
|
|
5474
5491
|
}
|
|
5475
5492
|
export interface Reference {
|
|
@@ -16809,7 +16826,7 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
16809
16826
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
16810
16827
|
* @summary Create a new record
|
|
16811
16828
|
* @param {string} objectName
|
|
16812
|
-
* @param {RecordDTO} recordDTO
|
|
16829
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to create
|
|
16813
16830
|
* @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).
|
|
16814
16831
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
16815
16832
|
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -16821,7 +16838,7 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
16821
16838
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
16822
16839
|
* @summary Create or update a record
|
|
16823
16840
|
* @param {string} objectName
|
|
16824
|
-
* @param {RecordDTO} recordDTO
|
|
16841
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
16825
16842
|
* @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).
|
|
16826
16843
|
* @param {boolean} [ignoreErrors]
|
|
16827
16844
|
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -16990,7 +17007,7 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
16990
17007
|
* @summary Update a record
|
|
16991
17008
|
* @param {string} uuid
|
|
16992
17009
|
* @param {string} objectName
|
|
16993
|
-
* @param {RecordDTO} recordDTO
|
|
17010
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to update
|
|
16994
17011
|
* @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).
|
|
16995
17012
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
16996
17013
|
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17082,7 +17099,7 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
|
|
|
17082
17099
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17083
17100
|
* @summary Create a new record
|
|
17084
17101
|
* @param {string} objectName
|
|
17085
|
-
* @param {RecordDTO} recordDTO
|
|
17102
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to create
|
|
17086
17103
|
* @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).
|
|
17087
17104
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
17088
17105
|
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17094,7 +17111,7 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
|
|
|
17094
17111
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17095
17112
|
* @summary Create or update a record
|
|
17096
17113
|
* @param {string} objectName
|
|
17097
|
-
* @param {RecordDTO} recordDTO
|
|
17114
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
17098
17115
|
* @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).
|
|
17099
17116
|
* @param {boolean} [ignoreErrors]
|
|
17100
17117
|
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17263,7 +17280,7 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
|
|
|
17263
17280
|
* @summary Update a record
|
|
17264
17281
|
* @param {string} uuid
|
|
17265
17282
|
* @param {string} objectName
|
|
17266
|
-
* @param {RecordDTO} recordDTO
|
|
17283
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to update
|
|
17267
17284
|
* @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).
|
|
17268
17285
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
17269
17286
|
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17355,7 +17372,7 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
|
|
|
17355
17372
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17356
17373
|
* @summary Create a new record
|
|
17357
17374
|
* @param {string} objectName
|
|
17358
|
-
* @param {RecordDTO} recordDTO
|
|
17375
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to create
|
|
17359
17376
|
* @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).
|
|
17360
17377
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
17361
17378
|
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17367,7 +17384,7 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
|
|
|
17367
17384
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17368
17385
|
* @summary Create or update a record
|
|
17369
17386
|
* @param {string} objectName
|
|
17370
|
-
* @param {RecordDTO} recordDTO
|
|
17387
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
17371
17388
|
* @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).
|
|
17372
17389
|
* @param {boolean} [ignoreErrors]
|
|
17373
17390
|
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17536,7 +17553,7 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
|
|
|
17536
17553
|
* @summary Update a record
|
|
17537
17554
|
* @param {string} uuid
|
|
17538
17555
|
* @param {string} objectName
|
|
17539
|
-
* @param {RecordDTO} recordDTO
|
|
17556
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to update
|
|
17540
17557
|
* @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).
|
|
17541
17558
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
17542
17559
|
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17628,7 +17645,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17628
17645
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17629
17646
|
* @summary Create a new record
|
|
17630
17647
|
* @param {string} objectName
|
|
17631
|
-
* @param {RecordDTO} recordDTO
|
|
17648
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to create
|
|
17632
17649
|
* @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).
|
|
17633
17650
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
17634
17651
|
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17640,7 +17657,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17640
17657
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17641
17658
|
* @summary Create or update a record
|
|
17642
17659
|
* @param {string} objectName
|
|
17643
|
-
* @param {RecordDTO} recordDTO
|
|
17660
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
17644
17661
|
* @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).
|
|
17645
17662
|
* @param {boolean} [ignoreErrors]
|
|
17646
17663
|
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17809,7 +17826,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17809
17826
|
* @summary Update a record
|
|
17810
17827
|
* @param {string} uuid
|
|
17811
17828
|
* @param {string} objectName
|
|
17812
|
-
* @param {RecordDTO} recordDTO
|
|
17829
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to update
|
|
17813
17830
|
* @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).
|
|
17814
17831
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
17815
17832
|
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
package/dist/api.js
CHANGED
|
@@ -16998,7 +16998,7 @@ const RecordsApiAxiosParamCreator = function (configuration) {
|
|
|
16998
16998
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
16999
16999
|
* @summary Create a new record
|
|
17000
17000
|
* @param {string} objectName
|
|
17001
|
-
* @param {RecordDTO} recordDTO
|
|
17001
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to create
|
|
17002
17002
|
* @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).
|
|
17003
17003
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
17004
17004
|
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17048,7 +17048,7 @@ const RecordsApiAxiosParamCreator = function (configuration) {
|
|
|
17048
17048
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17049
17049
|
* @summary Create or update a record
|
|
17050
17050
|
* @param {string} objectName
|
|
17051
|
-
* @param {RecordDTO} recordDTO
|
|
17051
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
17052
17052
|
* @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).
|
|
17053
17053
|
* @param {boolean} [ignoreErrors]
|
|
17054
17054
|
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17748,7 +17748,7 @@ const RecordsApiAxiosParamCreator = function (configuration) {
|
|
|
17748
17748
|
* @summary Update a record
|
|
17749
17749
|
* @param {string} uuid
|
|
17750
17750
|
* @param {string} objectName
|
|
17751
|
-
* @param {RecordDTO} recordDTO
|
|
17751
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to update
|
|
17752
17752
|
* @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).
|
|
17753
17753
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
17754
17754
|
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -18009,7 +18009,7 @@ const RecordsApiFp = function (configuration) {
|
|
|
18009
18009
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
18010
18010
|
* @summary Create a new record
|
|
18011
18011
|
* @param {string} objectName
|
|
18012
|
-
* @param {RecordDTO} recordDTO
|
|
18012
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to create
|
|
18013
18013
|
* @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).
|
|
18014
18014
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
18015
18015
|
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -18029,7 +18029,7 @@ const RecordsApiFp = function (configuration) {
|
|
|
18029
18029
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
18030
18030
|
* @summary Create or update a record
|
|
18031
18031
|
* @param {string} objectName
|
|
18032
|
-
* @param {RecordDTO} recordDTO
|
|
18032
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
18033
18033
|
* @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).
|
|
18034
18034
|
* @param {boolean} [ignoreErrors]
|
|
18035
18035
|
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -18326,7 +18326,7 @@ const RecordsApiFp = function (configuration) {
|
|
|
18326
18326
|
* @summary Update a record
|
|
18327
18327
|
* @param {string} uuid
|
|
18328
18328
|
* @param {string} objectName
|
|
18329
|
-
* @param {RecordDTO} recordDTO
|
|
18329
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to update
|
|
18330
18330
|
* @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).
|
|
18331
18331
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
18332
18332
|
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -18458,7 +18458,7 @@ const RecordsApiFactory = function (configuration, basePath, axios) {
|
|
|
18458
18458
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
18459
18459
|
* @summary Create a new record
|
|
18460
18460
|
* @param {string} objectName
|
|
18461
|
-
* @param {RecordDTO} recordDTO
|
|
18461
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to create
|
|
18462
18462
|
* @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).
|
|
18463
18463
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
18464
18464
|
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -18472,7 +18472,7 @@ const RecordsApiFactory = function (configuration, basePath, axios) {
|
|
|
18472
18472
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
18473
18473
|
* @summary Create or update a record
|
|
18474
18474
|
* @param {string} objectName
|
|
18475
|
-
* @param {RecordDTO} recordDTO
|
|
18475
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
18476
18476
|
* @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).
|
|
18477
18477
|
* @param {boolean} [ignoreErrors]
|
|
18478
18478
|
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -18673,7 +18673,7 @@ const RecordsApiFactory = function (configuration, basePath, axios) {
|
|
|
18673
18673
|
* @summary Update a record
|
|
18674
18674
|
* @param {string} uuid
|
|
18675
18675
|
* @param {string} objectName
|
|
18676
|
-
* @param {RecordDTO} recordDTO
|
|
18676
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to update
|
|
18677
18677
|
* @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).
|
|
18678
18678
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
18679
18679
|
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -18785,7 +18785,7 @@ class RecordsApi extends base_1.BaseAPI {
|
|
|
18785
18785
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
18786
18786
|
* @summary Create a new record
|
|
18787
18787
|
* @param {string} objectName
|
|
18788
|
-
* @param {RecordDTO} recordDTO
|
|
18788
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to create
|
|
18789
18789
|
* @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).
|
|
18790
18790
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
18791
18791
|
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -18799,7 +18799,7 @@ class RecordsApi extends base_1.BaseAPI {
|
|
|
18799
18799
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
18800
18800
|
* @summary Create or update a record
|
|
18801
18801
|
* @param {string} objectName
|
|
18802
|
-
* @param {RecordDTO} recordDTO
|
|
18802
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
18803
18803
|
* @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).
|
|
18804
18804
|
* @param {boolean} [ignoreErrors]
|
|
18805
18805
|
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -19000,7 +19000,7 @@ class RecordsApi extends base_1.BaseAPI {
|
|
|
19000
19000
|
* @summary Update a record
|
|
19001
19001
|
* @param {string} uuid
|
|
19002
19002
|
* @param {string} objectName
|
|
19003
|
-
* @param {RecordDTO} recordDTO
|
|
19003
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to update
|
|
19004
19004
|
* @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).
|
|
19005
19005
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
19006
19006
|
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -2813,9 +2813,9 @@ export declare const EventRsvpRequestScopeEnum: {
|
|
|
2813
2813
|
};
|
|
2814
2814
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2815
2815
|
export interface ExistingWidgetSummary {
|
|
2816
|
-
'xproperty'?: string;
|
|
2817
2816
|
'ymetric'?: string;
|
|
2818
2817
|
'yproperty'?: string;
|
|
2818
|
+
'xproperty'?: string;
|
|
2819
2819
|
'title'?: string;
|
|
2820
2820
|
'chartType'?: string;
|
|
2821
2821
|
'xProperty'?: string;
|
|
@@ -3747,11 +3747,11 @@ export interface ModelRecord {
|
|
|
3747
3747
|
'complete'?: boolean;
|
|
3748
3748
|
'deleted'?: boolean;
|
|
3749
3749
|
'uuid': string;
|
|
3750
|
+
'user'?: PublicUserDTO;
|
|
3750
3751
|
'properties'?: Array<FilledProperty>;
|
|
3751
3752
|
'objects'?: {
|
|
3752
3753
|
[key: string]: any | null;
|
|
3753
3754
|
};
|
|
3754
|
-
'user'?: PublicUserDTO;
|
|
3755
3755
|
}
|
|
3756
3756
|
export interface MultiFile extends PropertyFormat {
|
|
3757
3757
|
}
|
|
@@ -5469,6 +5469,23 @@ export interface RecordSummary {
|
|
|
5469
5469
|
[key: string]: any | null;
|
|
5470
5470
|
};
|
|
5471
5471
|
}
|
|
5472
|
+
/**
|
|
5473
|
+
* Optional record-write envelope. objectName must match the URL\'s object context. Query parameters still control parse, ignoreErrors and recordReturnFormat.
|
|
5474
|
+
*/
|
|
5475
|
+
export interface RecordWriteEnvelope {
|
|
5476
|
+
/**
|
|
5477
|
+
* Optional object name; when provided it must match the URL.
|
|
5478
|
+
*/
|
|
5479
|
+
'objectName'?: string;
|
|
5480
|
+
/**
|
|
5481
|
+
* The record to create or update.
|
|
5482
|
+
*/
|
|
5483
|
+
'record': RecordDTO;
|
|
5484
|
+
}
|
|
5485
|
+
/**
|
|
5486
|
+
* @type RecordWriteRequest
|
|
5487
|
+
*/
|
|
5488
|
+
export type RecordWriteRequest = RecordDTO | RecordWriteEnvelope;
|
|
5472
5489
|
export interface Recurrence extends PropertyFormat {
|
|
5473
5490
|
}
|
|
5474
5491
|
export interface Reference {
|
|
@@ -16808,7 +16825,7 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
16808
16825
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
16809
16826
|
* @summary Create a new record
|
|
16810
16827
|
* @param {string} objectName
|
|
16811
|
-
* @param {RecordDTO} recordDTO
|
|
16828
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to create
|
|
16812
16829
|
* @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).
|
|
16813
16830
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
16814
16831
|
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -16820,7 +16837,7 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
16820
16837
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
16821
16838
|
* @summary Create or update a record
|
|
16822
16839
|
* @param {string} objectName
|
|
16823
|
-
* @param {RecordDTO} recordDTO
|
|
16840
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
16824
16841
|
* @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).
|
|
16825
16842
|
* @param {boolean} [ignoreErrors]
|
|
16826
16843
|
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -16989,7 +17006,7 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
16989
17006
|
* @summary Update a record
|
|
16990
17007
|
* @param {string} uuid
|
|
16991
17008
|
* @param {string} objectName
|
|
16992
|
-
* @param {RecordDTO} recordDTO
|
|
17009
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to update
|
|
16993
17010
|
* @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).
|
|
16994
17011
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
16995
17012
|
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17081,7 +17098,7 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
|
|
|
17081
17098
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17082
17099
|
* @summary Create a new record
|
|
17083
17100
|
* @param {string} objectName
|
|
17084
|
-
* @param {RecordDTO} recordDTO
|
|
17101
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to create
|
|
17085
17102
|
* @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).
|
|
17086
17103
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
17087
17104
|
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17093,7 +17110,7 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
|
|
|
17093
17110
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17094
17111
|
* @summary Create or update a record
|
|
17095
17112
|
* @param {string} objectName
|
|
17096
|
-
* @param {RecordDTO} recordDTO
|
|
17113
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
17097
17114
|
* @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).
|
|
17098
17115
|
* @param {boolean} [ignoreErrors]
|
|
17099
17116
|
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17262,7 +17279,7 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
|
|
|
17262
17279
|
* @summary Update a record
|
|
17263
17280
|
* @param {string} uuid
|
|
17264
17281
|
* @param {string} objectName
|
|
17265
|
-
* @param {RecordDTO} recordDTO
|
|
17282
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to update
|
|
17266
17283
|
* @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).
|
|
17267
17284
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
17268
17285
|
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17354,7 +17371,7 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
|
|
|
17354
17371
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17355
17372
|
* @summary Create a new record
|
|
17356
17373
|
* @param {string} objectName
|
|
17357
|
-
* @param {RecordDTO} recordDTO
|
|
17374
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to create
|
|
17358
17375
|
* @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).
|
|
17359
17376
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
17360
17377
|
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17366,7 +17383,7 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
|
|
|
17366
17383
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17367
17384
|
* @summary Create or update a record
|
|
17368
17385
|
* @param {string} objectName
|
|
17369
|
-
* @param {RecordDTO} recordDTO
|
|
17386
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
17370
17387
|
* @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).
|
|
17371
17388
|
* @param {boolean} [ignoreErrors]
|
|
17372
17389
|
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17535,7 +17552,7 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
|
|
|
17535
17552
|
* @summary Update a record
|
|
17536
17553
|
* @param {string} uuid
|
|
17537
17554
|
* @param {string} objectName
|
|
17538
|
-
* @param {RecordDTO} recordDTO
|
|
17555
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to update
|
|
17539
17556
|
* @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).
|
|
17540
17557
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
17541
17558
|
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17627,7 +17644,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17627
17644
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17628
17645
|
* @summary Create a new record
|
|
17629
17646
|
* @param {string} objectName
|
|
17630
|
-
* @param {RecordDTO} recordDTO
|
|
17647
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to create
|
|
17631
17648
|
* @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).
|
|
17632
17649
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
17633
17650
|
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17639,7 +17656,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17639
17656
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17640
17657
|
* @summary Create or update a record
|
|
17641
17658
|
* @param {string} objectName
|
|
17642
|
-
* @param {RecordDTO} recordDTO
|
|
17659
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
17643
17660
|
* @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).
|
|
17644
17661
|
* @param {boolean} [ignoreErrors]
|
|
17645
17662
|
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17808,7 +17825,7 @@ export declare class RecordsApi extends BaseAPI {
|
|
|
17808
17825
|
* @summary Update a record
|
|
17809
17826
|
* @param {string} uuid
|
|
17810
17827
|
* @param {string} objectName
|
|
17811
|
-
* @param {RecordDTO} recordDTO
|
|
17828
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to update
|
|
17812
17829
|
* @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).
|
|
17813
17830
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
17814
17831
|
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
package/dist/esm/api.js
CHANGED
|
@@ -16893,7 +16893,7 @@ export const RecordsApiAxiosParamCreator = function (configuration) {
|
|
|
16893
16893
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
16894
16894
|
* @summary Create a new record
|
|
16895
16895
|
* @param {string} objectName
|
|
16896
|
-
* @param {RecordDTO} recordDTO
|
|
16896
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to create
|
|
16897
16897
|
* @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).
|
|
16898
16898
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
16899
16899
|
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -16943,7 +16943,7 @@ export const RecordsApiAxiosParamCreator = function (configuration) {
|
|
|
16943
16943
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
16944
16944
|
* @summary Create or update a record
|
|
16945
16945
|
* @param {string} objectName
|
|
16946
|
-
* @param {RecordDTO} recordDTO
|
|
16946
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
16947
16947
|
* @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).
|
|
16948
16948
|
* @param {boolean} [ignoreErrors]
|
|
16949
16949
|
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17643,7 +17643,7 @@ export const RecordsApiAxiosParamCreator = function (configuration) {
|
|
|
17643
17643
|
* @summary Update a record
|
|
17644
17644
|
* @param {string} uuid
|
|
17645
17645
|
* @param {string} objectName
|
|
17646
|
-
* @param {RecordDTO} recordDTO
|
|
17646
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to update
|
|
17647
17647
|
* @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).
|
|
17648
17648
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
17649
17649
|
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17903,7 +17903,7 @@ export const RecordsApiFp = function (configuration) {
|
|
|
17903
17903
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17904
17904
|
* @summary Create a new record
|
|
17905
17905
|
* @param {string} objectName
|
|
17906
|
-
* @param {RecordDTO} recordDTO
|
|
17906
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to create
|
|
17907
17907
|
* @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).
|
|
17908
17908
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
17909
17909
|
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -17923,7 +17923,7 @@ export const RecordsApiFp = function (configuration) {
|
|
|
17923
17923
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
17924
17924
|
* @summary Create or update a record
|
|
17925
17925
|
* @param {string} objectName
|
|
17926
|
-
* @param {RecordDTO} recordDTO
|
|
17926
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
17927
17927
|
* @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).
|
|
17928
17928
|
* @param {boolean} [ignoreErrors]
|
|
17929
17929
|
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -18220,7 +18220,7 @@ export const RecordsApiFp = function (configuration) {
|
|
|
18220
18220
|
* @summary Update a record
|
|
18221
18221
|
* @param {string} uuid
|
|
18222
18222
|
* @param {string} objectName
|
|
18223
|
-
* @param {RecordDTO} recordDTO
|
|
18223
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to update
|
|
18224
18224
|
* @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).
|
|
18225
18225
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
18226
18226
|
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -18351,7 +18351,7 @@ export const RecordsApiFactory = function (configuration, basePath, axios) {
|
|
|
18351
18351
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
18352
18352
|
* @summary Create a new record
|
|
18353
18353
|
* @param {string} objectName
|
|
18354
|
-
* @param {RecordDTO} recordDTO
|
|
18354
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to create
|
|
18355
18355
|
* @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).
|
|
18356
18356
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
18357
18357
|
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -18365,7 +18365,7 @@ export const RecordsApiFactory = function (configuration, basePath, axios) {
|
|
|
18365
18365
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
18366
18366
|
* @summary Create or update a record
|
|
18367
18367
|
* @param {string} objectName
|
|
18368
|
-
* @param {RecordDTO} recordDTO
|
|
18368
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
18369
18369
|
* @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).
|
|
18370
18370
|
* @param {boolean} [ignoreErrors]
|
|
18371
18371
|
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -18566,7 +18566,7 @@ export const RecordsApiFactory = function (configuration, basePath, axios) {
|
|
|
18566
18566
|
* @summary Update a record
|
|
18567
18567
|
* @param {string} uuid
|
|
18568
18568
|
* @param {string} objectName
|
|
18569
|
-
* @param {RecordDTO} recordDTO
|
|
18569
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to update
|
|
18570
18570
|
* @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).
|
|
18571
18571
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
18572
18572
|
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -18677,7 +18677,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
18677
18677
|
* Creates a new record for the specified object using the provided RecordDTO data. Returns a CreateResponse with the newly created record. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
18678
18678
|
* @summary Create a new record
|
|
18679
18679
|
* @param {string} objectName
|
|
18680
|
-
* @param {RecordDTO} recordDTO
|
|
18680
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to create
|
|
18681
18681
|
* @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).
|
|
18682
18682
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
18683
18683
|
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -18691,7 +18691,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
18691
18691
|
* Creates a new record or updates an existing one. Match order: body/path uuid already in the graph, then unique property values. If a matching record exists, it is updated; otherwise, a new record is created. Returns a CreateResponse or UpdateResponse with the record details. Validation: Record properties are validated according to the property rules defined for the object. Each property may have validation rules such as required, type constraints, character limits, uniqueness, etc.
|
|
18692
18692
|
* @summary Create or update a record
|
|
18693
18693
|
* @param {string} objectName
|
|
18694
|
-
* @param {RecordDTO} recordDTO
|
|
18694
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
18695
18695
|
* @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).
|
|
18696
18696
|
* @param {boolean} [ignoreErrors]
|
|
18697
18697
|
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -18892,7 +18892,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
18892
18892
|
* @summary Update a record
|
|
18893
18893
|
* @param {string} uuid
|
|
18894
18894
|
* @param {string} objectName
|
|
18895
|
-
* @param {RecordDTO} recordDTO
|
|
18895
|
+
* @param {RecordDTO} recordDTO Direct record body or {objectName, record} envelope to update
|
|
18896
18896
|
* @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).
|
|
18897
18897
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
18898
18898
|
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**xproperty** | **string** | | [optional] [default to undefined]
|
|
9
8
|
**ymetric** | **string** | | [optional] [default to undefined]
|
|
10
9
|
**yproperty** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**xproperty** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**title** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**chartType** | **string** | | [optional] [default to undefined]
|
|
13
13
|
**xProperty** | **string** | | [optional] [default to undefined]
|
|
@@ -20,9 +20,9 @@ Name | Type | Description | Notes
|
|
|
20
20
|
import { ExistingWidgetSummary } from '@caraer/client';
|
|
21
21
|
|
|
22
22
|
const instance: ExistingWidgetSummary = {
|
|
23
|
-
xproperty,
|
|
24
23
|
ymetric,
|
|
25
24
|
yproperty,
|
|
25
|
+
xproperty,
|
|
26
26
|
title,
|
|
27
27
|
chartType,
|
|
28
28
|
xProperty,
|
package/docs/Record.md
CHANGED
|
@@ -17,9 +17,9 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**complete** | **boolean** | | [optional] [default to undefined]
|
|
18
18
|
**deleted** | **boolean** | | [optional] [default to undefined]
|
|
19
19
|
**uuid** | **string** | | [default to undefined]
|
|
20
|
+
**user** | [**PublicUserDTO**](PublicUserDTO.md) | | [optional] [default to undefined]
|
|
20
21
|
**properties** | [**Array<FilledProperty>**](FilledProperty.md) | | [optional] [default to undefined]
|
|
21
22
|
**objects** | **{ [key: string]: any | null; }** | | [optional] [default to undefined]
|
|
22
|
-
**user** | [**PublicUserDTO**](PublicUserDTO.md) | | [optional] [default to undefined]
|
|
23
23
|
|
|
24
24
|
## Example
|
|
25
25
|
|
|
@@ -39,9 +39,9 @@ const instance: ModelRecord = {
|
|
|
39
39
|
complete,
|
|
40
40
|
deleted,
|
|
41
41
|
uuid,
|
|
42
|
+
user,
|
|
42
43
|
properties,
|
|
43
44
|
objects,
|
|
44
|
-
user,
|
|
45
45
|
};
|
|
46
46
|
```
|
|
47
47
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# RecordWriteEnvelope
|
|
2
|
+
|
|
3
|
+
Optional record-write envelope. objectName must match the URL\'s object context. Query parameters still control parse, ignoreErrors and recordReturnFormat.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**objectName** | **string** | Optional object name; when provided it must match the URL. | [optional] [default to undefined]
|
|
10
|
+
**record** | [**RecordDTO**](RecordDTO.md) | The record to create or update. | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { RecordWriteEnvelope } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: RecordWriteEnvelope = {
|
|
18
|
+
objectName,
|
|
19
|
+
record,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# RecordWriteRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**uuid** | **string** | Unique identifier for the entity | [default to undefined]
|
|
9
|
+
**name** | **string** | The name of the entity | [default to undefined]
|
|
10
|
+
**label** | **string** | Display label for the entity, can be different from name | [optional] [default to undefined]
|
|
11
|
+
**createdAt** | **number** | Unix timestamp when the entity was created | [optional] [default to undefined]
|
|
12
|
+
**createdBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who created the entity | [optional] [default to undefined]
|
|
13
|
+
**updatedAt** | **number** | Unix timestamp when the entity was last updated | [optional] [default to undefined]
|
|
14
|
+
**updatedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who last updated the entity | [optional] [default to undefined]
|
|
15
|
+
**deletedAt** | **number** | Unix timestamp when the entity was deleted (null if not deleted) | [optional] [default to undefined]
|
|
16
|
+
**deletedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who deleted the entity | [optional] [default to undefined]
|
|
17
|
+
**index** | **number** | Index number for ordering entities | [optional] [default to undefined]
|
|
18
|
+
**properties** | **{ [key: string]: any | null; }** | Property values as a name→value map, or a LEGACY array of {name,type,value} objects (same shape as LEGACY GET responses). File properties accept existing company file keys/URLs, an inline upload object {fileName,contentBase64,contentType?}, or a base64 data URL. Bare base64 bytes require the object form with fileName. Multi-file properties also accept an ordered array mixing existing keys/URLs and inline uploads; semicolon-separated keys and null remain supported. Uploads are stored as ordinary file keys after authorization and property validation. File type and configured upload size limits apply; base64 text counts toward the request limit. | [optional] [default to undefined]
|
|
19
|
+
**user** | [**PublicUserDTO**](PublicUserDTO.md) | The user of the record if the user trait is enabled. | [optional] [default to undefined]
|
|
20
|
+
**relations** | [**Array<RecordRelationRequestDTO>**](RecordRelationRequestDTO.md) | Relations to create or merge after the record is saved. Each item links to an existing record (uuid) or creates a nested record first. | [optional] [default to undefined]
|
|
21
|
+
**objectName** | **string** | Optional object name; when provided it must match the URL. | [optional] [default to undefined]
|
|
22
|
+
**record** | [**RecordDTO**](RecordDTO.md) | The record to create or update. | [default to undefined]
|
|
23
|
+
|
|
24
|
+
## Example
|
|
25
|
+
|
|
26
|
+
```typescript
|
|
27
|
+
import { RecordWriteRequest } from '@caraer/client';
|
|
28
|
+
|
|
29
|
+
const instance: RecordWriteRequest = {
|
|
30
|
+
uuid,
|
|
31
|
+
name,
|
|
32
|
+
label,
|
|
33
|
+
createdAt,
|
|
34
|
+
createdBy,
|
|
35
|
+
updatedAt,
|
|
36
|
+
updatedBy,
|
|
37
|
+
deletedAt,
|
|
38
|
+
deletedBy,
|
|
39
|
+
index,
|
|
40
|
+
properties,
|
|
41
|
+
user,
|
|
42
|
+
relations,
|
|
43
|
+
objectName,
|
|
44
|
+
record,
|
|
45
|
+
};
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/RecordsApi.md
CHANGED
|
@@ -393,7 +393,7 @@ const configuration = new Configuration();
|
|
|
393
393
|
const apiInstance = new RecordsApi(configuration);
|
|
394
394
|
|
|
395
395
|
let objectName: string; // (default to undefined)
|
|
396
|
-
let recordDTO: RecordDTO; //
|
|
396
|
+
let recordDTO: RecordDTO; //Direct record body or {objectName, record} envelope to create
|
|
397
397
|
let parse: 'DB' | 'HUMAN_READABLE' | 'STRUCTURED'; //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). (optional) (default to undefined)
|
|
398
398
|
let ignoreErrors: boolean; //If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported. (optional) (default to false)
|
|
399
399
|
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. (optional) (default to 'LEGACY')
|
|
@@ -411,7 +411,7 @@ const { status, data } = await apiInstance.create(
|
|
|
411
411
|
|
|
412
412
|
|Name | Type | Description | Notes|
|
|
413
413
|
|------------- | ------------- | ------------- | -------------|
|
|
414
|
-
| **recordDTO** | **RecordDTO**|
|
|
414
|
+
| **recordDTO** | **RecordDTO**| Direct record body or {objectName, record} envelope to create | |
|
|
415
415
|
| **objectName** | [**string**] | | defaults to undefined|
|
|
416
416
|
| **parse** | [**'DB' | 'HUMAN_READABLE' | 'STRUCTURED'**]**Array<'DB' | 'HUMAN_READABLE' | 'STRUCTURED'>** | 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). | (optional) defaults to undefined|
|
|
417
417
|
| **ignoreErrors** | [**boolean**] | If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported. | (optional) defaults to false|
|
|
@@ -462,7 +462,7 @@ const configuration = new Configuration();
|
|
|
462
462
|
const apiInstance = new RecordsApi(configuration);
|
|
463
463
|
|
|
464
464
|
let objectName: string; // (default to undefined)
|
|
465
|
-
let recordDTO: RecordDTO; //
|
|
465
|
+
let recordDTO: RecordDTO; //Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists.
|
|
466
466
|
let parse: 'DB' | 'HUMAN_READABLE' | 'STRUCTURED'; //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). (optional) (default to undefined)
|
|
467
467
|
let ignoreErrors: boolean; // (optional) (default to false)
|
|
468
468
|
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. (optional) (default to 'LEGACY')
|
|
@@ -480,7 +480,7 @@ const { status, data } = await apiInstance.createOrUpdate(
|
|
|
480
480
|
|
|
481
481
|
|Name | Type | Description | Notes|
|
|
482
482
|
|------------- | ------------- | ------------- | -------------|
|
|
483
|
-
| **recordDTO** | **RecordDTO**|
|
|
483
|
+
| **recordDTO** | **RecordDTO**| Direct record body or {objectName, record} envelope. uuid belongs to the record and updates that record when it already exists. | |
|
|
484
484
|
| **objectName** | [**string**] | | defaults to undefined|
|
|
485
485
|
| **parse** | [**'DB' | 'HUMAN_READABLE' | 'STRUCTURED'**]**Array<'DB' | 'HUMAN_READABLE' | 'STRUCTURED'>** | 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). | (optional) defaults to undefined|
|
|
486
486
|
| **ignoreErrors** | [**boolean**] | | (optional) defaults to false|
|
|
@@ -1484,7 +1484,7 @@ const apiInstance = new RecordsApi(configuration);
|
|
|
1484
1484
|
|
|
1485
1485
|
let uuid: string; // (default to undefined)
|
|
1486
1486
|
let objectName: string; // (default to undefined)
|
|
1487
|
-
let recordDTO: RecordDTO; //
|
|
1487
|
+
let recordDTO: RecordDTO; //Direct record body or {objectName, record} envelope to update
|
|
1488
1488
|
let parse: 'DB' | 'HUMAN_READABLE' | 'STRUCTURED'; //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). (optional) (default to undefined)
|
|
1489
1489
|
let ignoreErrors: boolean; //If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported. (optional) (default to false)
|
|
1490
1490
|
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. (optional) (default to 'LEGACY')
|
|
@@ -1503,7 +1503,7 @@ const { status, data } = await apiInstance.update(
|
|
|
1503
1503
|
|
|
1504
1504
|
|Name | Type | Description | Notes|
|
|
1505
1505
|
|------------- | ------------- | ------------- | -------------|
|
|
1506
|
-
| **recordDTO** | **RecordDTO**|
|
|
1506
|
+
| **recordDTO** | **RecordDTO**| Direct record body or {objectName, record} envelope to update | |
|
|
1507
1507
|
| **uuid** | [**string**] | | defaults to undefined|
|
|
1508
1508
|
| **objectName** | [**string**] | | defaults to undefined|
|
|
1509
1509
|
| **parse** | [**'DB' | 'HUMAN_READABLE' | 'STRUCTURED'**]**Array<'DB' | 'HUMAN_READABLE' | 'STRUCTURED'>** | 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). | (optional) defaults to undefined|
|