@caraer/client 2.0.421 → 2.0.423
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 +74 -2
- package/dist/api.d.ts +34 -2
- package/dist/api.js +69 -0
- package/dist/esm/api.d.ts +34 -2
- package/dist/esm/api.js +69 -0
- package/docs/AppDTO.md +1 -1
- package/docs/RelationsApi.md +54 -0
- package/docs/SettingField.md +2 -2
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -455,7 +455,7 @@ export interface AppDTO {
|
|
|
455
455
|
*/
|
|
456
456
|
'privateApp'?: boolean;
|
|
457
457
|
/**
|
|
458
|
-
* Whether to hide the API token field in
|
|
458
|
+
* Whether to hide the API token field in marketplace installer UI. Defaults to true when omitted. Private apps show the key regardless.
|
|
459
459
|
*/
|
|
460
460
|
'hideApiKeyField'?: boolean;
|
|
461
461
|
/**
|
|
@@ -4374,8 +4374,8 @@ export interface SettingField {
|
|
|
4374
4374
|
'hidden'?: boolean;
|
|
4375
4375
|
'disabled'?: boolean;
|
|
4376
4376
|
'options'?: Array<SettingOption>;
|
|
4377
|
-
'value'?: any;
|
|
4378
4377
|
'defaultValue'?: any;
|
|
4378
|
+
'value'?: any;
|
|
4379
4379
|
}
|
|
4380
4380
|
|
|
4381
4381
|
export const SettingFieldTypeEnum = {
|
|
@@ -20598,6 +20598,44 @@ export const RelationsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
20598
20598
|
options: localVarRequestOptions,
|
|
20599
20599
|
};
|
|
20600
20600
|
},
|
|
20601
|
+
/**
|
|
20602
|
+
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
20603
|
+
* @summary Permanently delete archived relation
|
|
20604
|
+
* @param {string} relationUuid
|
|
20605
|
+
* @param {*} [options] Override http request option.
|
|
20606
|
+
* @throws {RequiredError}
|
|
20607
|
+
*/
|
|
20608
|
+
permanentlyDeleteArchivedRelation: async (relationUuid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20609
|
+
// verify required parameter 'relationUuid' is not null or undefined
|
|
20610
|
+
assertParamExists('permanentlyDeleteArchivedRelation', 'relationUuid', relationUuid)
|
|
20611
|
+
const localVarPath = `/api/v2/relations/{relationUuid}/permanent`
|
|
20612
|
+
.replace('{relationUuid}', encodeURIComponent(String(relationUuid)));
|
|
20613
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20614
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20615
|
+
let baseOptions;
|
|
20616
|
+
if (configuration) {
|
|
20617
|
+
baseOptions = configuration.baseOptions;
|
|
20618
|
+
}
|
|
20619
|
+
|
|
20620
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
20621
|
+
const localVarHeaderParameter = {} as any;
|
|
20622
|
+
const localVarQueryParameter = {} as any;
|
|
20623
|
+
|
|
20624
|
+
// authentication bearerAuth required
|
|
20625
|
+
// http bearer authentication required
|
|
20626
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
20627
|
+
|
|
20628
|
+
localVarHeaderParameter['Accept'] = 'application/json,*/*';
|
|
20629
|
+
|
|
20630
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20631
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20632
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
20633
|
+
|
|
20634
|
+
return {
|
|
20635
|
+
url: toPathString(localVarUrlObj),
|
|
20636
|
+
options: localVarRequestOptions,
|
|
20637
|
+
};
|
|
20638
|
+
},
|
|
20601
20639
|
/**
|
|
20602
20640
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
20603
20641
|
* @summary Restore a deleted relation
|
|
@@ -20810,6 +20848,19 @@ export const RelationsApiFp = function(configuration?: Configuration) {
|
|
|
20810
20848
|
const localVarOperationServerBasePath = operationServerMap['RelationsApi.getRelationsByObject']?.[localVarOperationServerIndex]?.url;
|
|
20811
20849
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20812
20850
|
},
|
|
20851
|
+
/**
|
|
20852
|
+
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
20853
|
+
* @summary Permanently delete archived relation
|
|
20854
|
+
* @param {string} relationUuid
|
|
20855
|
+
* @param {*} [options] Override http request option.
|
|
20856
|
+
* @throws {RequiredError}
|
|
20857
|
+
*/
|
|
20858
|
+
async permanentlyDeleteArchivedRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponse>> {
|
|
20859
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.permanentlyDeleteArchivedRelation(relationUuid, options);
|
|
20860
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
20861
|
+
const localVarOperationServerBasePath = operationServerMap['RelationsApi.permanentlyDeleteArchivedRelation']?.[localVarOperationServerIndex]?.url;
|
|
20862
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20863
|
+
},
|
|
20813
20864
|
/**
|
|
20814
20865
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
20815
20866
|
* @summary Restore a deleted relation
|
|
@@ -20944,6 +20995,16 @@ export const RelationsApiFactory = function (configuration?: Configuration, base
|
|
|
20944
20995
|
getRelationsByObject(objectUuid: string, body: any, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponse> {
|
|
20945
20996
|
return localVarFp.getRelationsByObject(objectUuid, body, options).then((request) => request(axios, basePath));
|
|
20946
20997
|
},
|
|
20998
|
+
/**
|
|
20999
|
+
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
21000
|
+
* @summary Permanently delete archived relation
|
|
21001
|
+
* @param {string} relationUuid
|
|
21002
|
+
* @param {*} [options] Override http request option.
|
|
21003
|
+
* @throws {RequiredError}
|
|
21004
|
+
*/
|
|
21005
|
+
permanentlyDeleteArchivedRelation(relationUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponse> {
|
|
21006
|
+
return localVarFp.permanentlyDeleteArchivedRelation(relationUuid, options).then((request) => request(axios, basePath));
|
|
21007
|
+
},
|
|
20947
21008
|
/**
|
|
20948
21009
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
20949
21010
|
* @summary Restore a deleted relation
|
|
@@ -21079,6 +21140,17 @@ export class RelationsApi extends BaseAPI {
|
|
|
21079
21140
|
return RelationsApiFp(this.configuration).getRelationsByObject(objectUuid, body, options).then((request) => request(this.axios, this.basePath));
|
|
21080
21141
|
}
|
|
21081
21142
|
|
|
21143
|
+
/**
|
|
21144
|
+
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
21145
|
+
* @summary Permanently delete archived relation
|
|
21146
|
+
* @param {string} relationUuid
|
|
21147
|
+
* @param {*} [options] Override http request option.
|
|
21148
|
+
* @throws {RequiredError}
|
|
21149
|
+
*/
|
|
21150
|
+
public permanentlyDeleteArchivedRelation(relationUuid: string, options?: RawAxiosRequestConfig) {
|
|
21151
|
+
return RelationsApiFp(this.configuration).permanentlyDeleteArchivedRelation(relationUuid, options).then((request) => request(this.axios, this.basePath));
|
|
21152
|
+
}
|
|
21153
|
+
|
|
21082
21154
|
/**
|
|
21083
21155
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
21084
21156
|
* @summary Restore a deleted relation
|
package/dist/api.d.ts
CHANGED
|
@@ -448,7 +448,7 @@ export interface AppDTO {
|
|
|
448
448
|
*/
|
|
449
449
|
'privateApp'?: boolean;
|
|
450
450
|
/**
|
|
451
|
-
* Whether to hide the API token field in
|
|
451
|
+
* Whether to hide the API token field in marketplace installer UI. Defaults to true when omitted. Private apps show the key regardless.
|
|
452
452
|
*/
|
|
453
453
|
'hideApiKeyField'?: boolean;
|
|
454
454
|
/**
|
|
@@ -4397,8 +4397,8 @@ export interface SettingField {
|
|
|
4397
4397
|
'hidden'?: boolean;
|
|
4398
4398
|
'disabled'?: boolean;
|
|
4399
4399
|
'options'?: Array<SettingOption>;
|
|
4400
|
-
'value'?: any;
|
|
4401
4400
|
'defaultValue'?: any;
|
|
4401
|
+
'value'?: any;
|
|
4402
4402
|
}
|
|
4403
4403
|
export declare const SettingFieldTypeEnum: {
|
|
4404
4404
|
readonly String: "STRING";
|
|
@@ -12805,6 +12805,14 @@ export declare const RelationsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12805
12805
|
* @throws {RequiredError}
|
|
12806
12806
|
*/
|
|
12807
12807
|
getRelationsByObject: (objectUuid: string, body: any, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12808
|
+
/**
|
|
12809
|
+
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
12810
|
+
* @summary Permanently delete archived relation
|
|
12811
|
+
* @param {string} relationUuid
|
|
12812
|
+
* @param {*} [options] Override http request option.
|
|
12813
|
+
* @throws {RequiredError}
|
|
12814
|
+
*/
|
|
12815
|
+
permanentlyDeleteArchivedRelation: (relationUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12808
12816
|
/**
|
|
12809
12817
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
12810
12818
|
* @summary Restore a deleted relation
|
|
@@ -12907,6 +12915,14 @@ export declare const RelationsApiFp: (configuration?: Configuration) => {
|
|
|
12907
12915
|
* @throws {RequiredError}
|
|
12908
12916
|
*/
|
|
12909
12917
|
getRelationsByObject(objectUuid: string, body: any, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponse>>;
|
|
12918
|
+
/**
|
|
12919
|
+
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
12920
|
+
* @summary Permanently delete archived relation
|
|
12921
|
+
* @param {string} relationUuid
|
|
12922
|
+
* @param {*} [options] Override http request option.
|
|
12923
|
+
* @throws {RequiredError}
|
|
12924
|
+
*/
|
|
12925
|
+
permanentlyDeleteArchivedRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponse>>;
|
|
12910
12926
|
/**
|
|
12911
12927
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
12912
12928
|
* @summary Restore a deleted relation
|
|
@@ -13009,6 +13025,14 @@ export declare const RelationsApiFactory: (configuration?: Configuration, basePa
|
|
|
13009
13025
|
* @throws {RequiredError}
|
|
13010
13026
|
*/
|
|
13011
13027
|
getRelationsByObject(objectUuid: string, body: any, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponse>;
|
|
13028
|
+
/**
|
|
13029
|
+
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
13030
|
+
* @summary Permanently delete archived relation
|
|
13031
|
+
* @param {string} relationUuid
|
|
13032
|
+
* @param {*} [options] Override http request option.
|
|
13033
|
+
* @throws {RequiredError}
|
|
13034
|
+
*/
|
|
13035
|
+
permanentlyDeleteArchivedRelation(relationUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponse>;
|
|
13012
13036
|
/**
|
|
13013
13037
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
13014
13038
|
* @summary Restore a deleted relation
|
|
@@ -13111,6 +13135,14 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
13111
13135
|
* @throws {RequiredError}
|
|
13112
13136
|
*/
|
|
13113
13137
|
getRelationsByObject(objectUuid: string, body: any, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginationResponse, any, {}>>;
|
|
13138
|
+
/**
|
|
13139
|
+
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
13140
|
+
* @summary Permanently delete archived relation
|
|
13141
|
+
* @param {string} relationUuid
|
|
13142
|
+
* @param {*} [options] Override http request option.
|
|
13143
|
+
* @throws {RequiredError}
|
|
13144
|
+
*/
|
|
13145
|
+
permanentlyDeleteArchivedRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponse, any, {}>>;
|
|
13114
13146
|
/**
|
|
13115
13147
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
13116
13148
|
* @summary Restore a deleted relation
|
package/dist/api.js
CHANGED
|
@@ -13854,6 +13854,39 @@ const RelationsApiAxiosParamCreator = function (configuration) {
|
|
|
13854
13854
|
options: localVarRequestOptions,
|
|
13855
13855
|
};
|
|
13856
13856
|
}),
|
|
13857
|
+
/**
|
|
13858
|
+
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
13859
|
+
* @summary Permanently delete archived relation
|
|
13860
|
+
* @param {string} relationUuid
|
|
13861
|
+
* @param {*} [options] Override http request option.
|
|
13862
|
+
* @throws {RequiredError}
|
|
13863
|
+
*/
|
|
13864
|
+
permanentlyDeleteArchivedRelation: (relationUuid_1, ...args_1) => __awaiter(this, [relationUuid_1, ...args_1], void 0, function* (relationUuid, options = {}) {
|
|
13865
|
+
// verify required parameter 'relationUuid' is not null or undefined
|
|
13866
|
+
(0, common_1.assertParamExists)('permanentlyDeleteArchivedRelation', 'relationUuid', relationUuid);
|
|
13867
|
+
const localVarPath = `/api/v2/relations/{relationUuid}/permanent`
|
|
13868
|
+
.replace('{relationUuid}', encodeURIComponent(String(relationUuid)));
|
|
13869
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
13870
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
13871
|
+
let baseOptions;
|
|
13872
|
+
if (configuration) {
|
|
13873
|
+
baseOptions = configuration.baseOptions;
|
|
13874
|
+
}
|
|
13875
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
13876
|
+
const localVarHeaderParameter = {};
|
|
13877
|
+
const localVarQueryParameter = {};
|
|
13878
|
+
// authentication bearerAuth required
|
|
13879
|
+
// http bearer authentication required
|
|
13880
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
13881
|
+
localVarHeaderParameter['Accept'] = 'application/json,*/*';
|
|
13882
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
13883
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13884
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
13885
|
+
return {
|
|
13886
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
13887
|
+
options: localVarRequestOptions,
|
|
13888
|
+
};
|
|
13889
|
+
}),
|
|
13857
13890
|
/**
|
|
13858
13891
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
13859
13892
|
* @summary Restore a deleted relation
|
|
@@ -14083,6 +14116,22 @@ const RelationsApiFp = function (configuration) {
|
|
|
14083
14116
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14084
14117
|
});
|
|
14085
14118
|
},
|
|
14119
|
+
/**
|
|
14120
|
+
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
14121
|
+
* @summary Permanently delete archived relation
|
|
14122
|
+
* @param {string} relationUuid
|
|
14123
|
+
* @param {*} [options] Override http request option.
|
|
14124
|
+
* @throws {RequiredError}
|
|
14125
|
+
*/
|
|
14126
|
+
permanentlyDeleteArchivedRelation(relationUuid, options) {
|
|
14127
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
14128
|
+
var _a, _b, _c;
|
|
14129
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.permanentlyDeleteArchivedRelation(relationUuid, options);
|
|
14130
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
14131
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['RelationsApi.permanentlyDeleteArchivedRelation']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
14132
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14133
|
+
});
|
|
14134
|
+
},
|
|
14086
14135
|
/**
|
|
14087
14136
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
14088
14137
|
* @summary Restore a deleted relation
|
|
@@ -14223,6 +14272,16 @@ const RelationsApiFactory = function (configuration, basePath, axios) {
|
|
|
14223
14272
|
getRelationsByObject(objectUuid, body, options) {
|
|
14224
14273
|
return localVarFp.getRelationsByObject(objectUuid, body, options).then((request) => request(axios, basePath));
|
|
14225
14274
|
},
|
|
14275
|
+
/**
|
|
14276
|
+
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
14277
|
+
* @summary Permanently delete archived relation
|
|
14278
|
+
* @param {string} relationUuid
|
|
14279
|
+
* @param {*} [options] Override http request option.
|
|
14280
|
+
* @throws {RequiredError}
|
|
14281
|
+
*/
|
|
14282
|
+
permanentlyDeleteArchivedRelation(relationUuid, options) {
|
|
14283
|
+
return localVarFp.permanentlyDeleteArchivedRelation(relationUuid, options).then((request) => request(axios, basePath));
|
|
14284
|
+
},
|
|
14226
14285
|
/**
|
|
14227
14286
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
14228
14287
|
* @summary Restore a deleted relation
|
|
@@ -14349,6 +14408,16 @@ class RelationsApi extends base_1.BaseAPI {
|
|
|
14349
14408
|
getRelationsByObject(objectUuid, body, options) {
|
|
14350
14409
|
return (0, exports.RelationsApiFp)(this.configuration).getRelationsByObject(objectUuid, body, options).then((request) => request(this.axios, this.basePath));
|
|
14351
14410
|
}
|
|
14411
|
+
/**
|
|
14412
|
+
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
14413
|
+
* @summary Permanently delete archived relation
|
|
14414
|
+
* @param {string} relationUuid
|
|
14415
|
+
* @param {*} [options] Override http request option.
|
|
14416
|
+
* @throws {RequiredError}
|
|
14417
|
+
*/
|
|
14418
|
+
permanentlyDeleteArchivedRelation(relationUuid, options) {
|
|
14419
|
+
return (0, exports.RelationsApiFp)(this.configuration).permanentlyDeleteArchivedRelation(relationUuid, options).then((request) => request(this.axios, this.basePath));
|
|
14420
|
+
}
|
|
14352
14421
|
/**
|
|
14353
14422
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
14354
14423
|
* @summary Restore a deleted relation
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -448,7 +448,7 @@ export interface AppDTO {
|
|
|
448
448
|
*/
|
|
449
449
|
'privateApp'?: boolean;
|
|
450
450
|
/**
|
|
451
|
-
* Whether to hide the API token field in
|
|
451
|
+
* Whether to hide the API token field in marketplace installer UI. Defaults to true when omitted. Private apps show the key regardless.
|
|
452
452
|
*/
|
|
453
453
|
'hideApiKeyField'?: boolean;
|
|
454
454
|
/**
|
|
@@ -4397,8 +4397,8 @@ export interface SettingField {
|
|
|
4397
4397
|
'hidden'?: boolean;
|
|
4398
4398
|
'disabled'?: boolean;
|
|
4399
4399
|
'options'?: Array<SettingOption>;
|
|
4400
|
-
'value'?: any;
|
|
4401
4400
|
'defaultValue'?: any;
|
|
4401
|
+
'value'?: any;
|
|
4402
4402
|
}
|
|
4403
4403
|
export declare const SettingFieldTypeEnum: {
|
|
4404
4404
|
readonly String: "STRING";
|
|
@@ -12805,6 +12805,14 @@ export declare const RelationsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12805
12805
|
* @throws {RequiredError}
|
|
12806
12806
|
*/
|
|
12807
12807
|
getRelationsByObject: (objectUuid: string, body: any, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12808
|
+
/**
|
|
12809
|
+
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
12810
|
+
* @summary Permanently delete archived relation
|
|
12811
|
+
* @param {string} relationUuid
|
|
12812
|
+
* @param {*} [options] Override http request option.
|
|
12813
|
+
* @throws {RequiredError}
|
|
12814
|
+
*/
|
|
12815
|
+
permanentlyDeleteArchivedRelation: (relationUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12808
12816
|
/**
|
|
12809
12817
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
12810
12818
|
* @summary Restore a deleted relation
|
|
@@ -12907,6 +12915,14 @@ export declare const RelationsApiFp: (configuration?: Configuration) => {
|
|
|
12907
12915
|
* @throws {RequiredError}
|
|
12908
12916
|
*/
|
|
12909
12917
|
getRelationsByObject(objectUuid: string, body: any, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponse>>;
|
|
12918
|
+
/**
|
|
12919
|
+
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
12920
|
+
* @summary Permanently delete archived relation
|
|
12921
|
+
* @param {string} relationUuid
|
|
12922
|
+
* @param {*} [options] Override http request option.
|
|
12923
|
+
* @throws {RequiredError}
|
|
12924
|
+
*/
|
|
12925
|
+
permanentlyDeleteArchivedRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponse>>;
|
|
12910
12926
|
/**
|
|
12911
12927
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
12912
12928
|
* @summary Restore a deleted relation
|
|
@@ -13009,6 +13025,14 @@ export declare const RelationsApiFactory: (configuration?: Configuration, basePa
|
|
|
13009
13025
|
* @throws {RequiredError}
|
|
13010
13026
|
*/
|
|
13011
13027
|
getRelationsByObject(objectUuid: string, body: any, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponse>;
|
|
13028
|
+
/**
|
|
13029
|
+
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
13030
|
+
* @summary Permanently delete archived relation
|
|
13031
|
+
* @param {string} relationUuid
|
|
13032
|
+
* @param {*} [options] Override http request option.
|
|
13033
|
+
* @throws {RequiredError}
|
|
13034
|
+
*/
|
|
13035
|
+
permanentlyDeleteArchivedRelation(relationUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponse>;
|
|
13012
13036
|
/**
|
|
13013
13037
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
13014
13038
|
* @summary Restore a deleted relation
|
|
@@ -13111,6 +13135,14 @@ export declare class RelationsApi extends BaseAPI {
|
|
|
13111
13135
|
* @throws {RequiredError}
|
|
13112
13136
|
*/
|
|
13113
13137
|
getRelationsByObject(objectUuid: string, body: any, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginationResponse, any, {}>>;
|
|
13138
|
+
/**
|
|
13139
|
+
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
13140
|
+
* @summary Permanently delete archived relation
|
|
13141
|
+
* @param {string} relationUuid
|
|
13142
|
+
* @param {*} [options] Override http request option.
|
|
13143
|
+
* @throws {RequiredError}
|
|
13144
|
+
*/
|
|
13145
|
+
permanentlyDeleteArchivedRelation(relationUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponse, any, {}>>;
|
|
13114
13146
|
/**
|
|
13115
13147
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
13116
13148
|
* @summary Restore a deleted relation
|
package/dist/esm/api.js
CHANGED
|
@@ -13777,6 +13777,39 @@ export const RelationsApiAxiosParamCreator = function (configuration) {
|
|
|
13777
13777
|
options: localVarRequestOptions,
|
|
13778
13778
|
};
|
|
13779
13779
|
}),
|
|
13780
|
+
/**
|
|
13781
|
+
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
13782
|
+
* @summary Permanently delete archived relation
|
|
13783
|
+
* @param {string} relationUuid
|
|
13784
|
+
* @param {*} [options] Override http request option.
|
|
13785
|
+
* @throws {RequiredError}
|
|
13786
|
+
*/
|
|
13787
|
+
permanentlyDeleteArchivedRelation: (relationUuid_1, ...args_1) => __awaiter(this, [relationUuid_1, ...args_1], void 0, function* (relationUuid, options = {}) {
|
|
13788
|
+
// verify required parameter 'relationUuid' is not null or undefined
|
|
13789
|
+
assertParamExists('permanentlyDeleteArchivedRelation', 'relationUuid', relationUuid);
|
|
13790
|
+
const localVarPath = `/api/v2/relations/{relationUuid}/permanent`
|
|
13791
|
+
.replace('{relationUuid}', encodeURIComponent(String(relationUuid)));
|
|
13792
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
13793
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
13794
|
+
let baseOptions;
|
|
13795
|
+
if (configuration) {
|
|
13796
|
+
baseOptions = configuration.baseOptions;
|
|
13797
|
+
}
|
|
13798
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
13799
|
+
const localVarHeaderParameter = {};
|
|
13800
|
+
const localVarQueryParameter = {};
|
|
13801
|
+
// authentication bearerAuth required
|
|
13802
|
+
// http bearer authentication required
|
|
13803
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
13804
|
+
localVarHeaderParameter['Accept'] = 'application/json,*/*';
|
|
13805
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
13806
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13807
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
13808
|
+
return {
|
|
13809
|
+
url: toPathString(localVarUrlObj),
|
|
13810
|
+
options: localVarRequestOptions,
|
|
13811
|
+
};
|
|
13812
|
+
}),
|
|
13780
13813
|
/**
|
|
13781
13814
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
13782
13815
|
* @summary Restore a deleted relation
|
|
@@ -14005,6 +14038,22 @@ export const RelationsApiFp = function (configuration) {
|
|
|
14005
14038
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14006
14039
|
});
|
|
14007
14040
|
},
|
|
14041
|
+
/**
|
|
14042
|
+
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
14043
|
+
* @summary Permanently delete archived relation
|
|
14044
|
+
* @param {string} relationUuid
|
|
14045
|
+
* @param {*} [options] Override http request option.
|
|
14046
|
+
* @throws {RequiredError}
|
|
14047
|
+
*/
|
|
14048
|
+
permanentlyDeleteArchivedRelation(relationUuid, options) {
|
|
14049
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
14050
|
+
var _a, _b, _c;
|
|
14051
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.permanentlyDeleteArchivedRelation(relationUuid, options);
|
|
14052
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
14053
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['RelationsApi.permanentlyDeleteArchivedRelation']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
14054
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14055
|
+
});
|
|
14056
|
+
},
|
|
14008
14057
|
/**
|
|
14009
14058
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
14010
14059
|
* @summary Restore a deleted relation
|
|
@@ -14144,6 +14193,16 @@ export const RelationsApiFactory = function (configuration, basePath, axios) {
|
|
|
14144
14193
|
getRelationsByObject(objectUuid, body, options) {
|
|
14145
14194
|
return localVarFp.getRelationsByObject(objectUuid, body, options).then((request) => request(axios, basePath));
|
|
14146
14195
|
},
|
|
14196
|
+
/**
|
|
14197
|
+
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
14198
|
+
* @summary Permanently delete archived relation
|
|
14199
|
+
* @param {string} relationUuid
|
|
14200
|
+
* @param {*} [options] Override http request option.
|
|
14201
|
+
* @throws {RequiredError}
|
|
14202
|
+
*/
|
|
14203
|
+
permanentlyDeleteArchivedRelation(relationUuid, options) {
|
|
14204
|
+
return localVarFp.permanentlyDeleteArchivedRelation(relationUuid, options).then((request) => request(axios, basePath));
|
|
14205
|
+
},
|
|
14147
14206
|
/**
|
|
14148
14207
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
14149
14208
|
* @summary Restore a deleted relation
|
|
@@ -14269,6 +14328,16 @@ export class RelationsApi extends BaseAPI {
|
|
|
14269
14328
|
getRelationsByObject(objectUuid, body, options) {
|
|
14270
14329
|
return RelationsApiFp(this.configuration).getRelationsByObject(objectUuid, body, options).then((request) => request(this.axios, this.basePath));
|
|
14271
14330
|
}
|
|
14331
|
+
/**
|
|
14332
|
+
* Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
14333
|
+
* @summary Permanently delete archived relation
|
|
14334
|
+
* @param {string} relationUuid
|
|
14335
|
+
* @param {*} [options] Override http request option.
|
|
14336
|
+
* @throws {RequiredError}
|
|
14337
|
+
*/
|
|
14338
|
+
permanentlyDeleteArchivedRelation(relationUuid, options) {
|
|
14339
|
+
return RelationsApiFp(this.configuration).permanentlyDeleteArchivedRelation(relationUuid, options).then((request) => request(this.axios, this.basePath));
|
|
14340
|
+
}
|
|
14272
14341
|
/**
|
|
14273
14342
|
* Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
|
|
14274
14343
|
* @summary Restore a deleted relation
|
package/docs/AppDTO.md
CHANGED
|
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**deletedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who deleted the entity | [optional] [default to undefined]
|
|
18
18
|
**index** | **number** | Index number for ordering entities | [optional] [default to undefined]
|
|
19
19
|
**privateApp** | **boolean** | Indicates whether this app is private (only available to the creator\'s company) | [optional] [default to undefined]
|
|
20
|
-
**hideApiKeyField** | **boolean** | Whether to hide the API token field in
|
|
20
|
+
**hideApiKeyField** | **boolean** | Whether to hide the API token field in marketplace installer UI. Defaults to true when omitted. Private apps show the key regardless. | [optional] [default to undefined]
|
|
21
21
|
**details** | [**AppDetailsDTO**](AppDetailsDTO.md) | Additional details and specifications about the application | [optional] [default to undefined]
|
|
22
22
|
**appBars** | [**Array<AppBarDTO>**](AppBarDTO.md) | App bars (location-specific configuration and actions) | [optional] [default to undefined]
|
|
23
23
|
**serverlessFunctions** | [**Array<ServerlessFunctionDTO>**](ServerlessFunctionDTO.md) | Serverless functions owned by this app | [optional] [default to undefined]
|
package/docs/RelationsApi.md
CHANGED
|
@@ -13,6 +13,7 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
13
13
|
|[**getRelations**](#getrelations) | **POST** /api/v2/relations/index | Fetch paginated relations|
|
|
14
14
|
|[**getRelationsBetweenObjects**](#getrelationsbetweenobjects) | **POST** /api/v2/relations/index/{fromObjectUuid}/{toObjectUuid} | Get all relations between two objects|
|
|
15
15
|
|[**getRelationsByObject**](#getrelationsbyobject) | **POST** /api/v2/relations/index/{objectUuid} | Fetch relations for a specific object|
|
|
16
|
+
|[**permanentlyDeleteArchivedRelation**](#permanentlydeletearchivedrelation) | **DELETE** /api/v2/relations/{relationUuid}/permanent | Permanently delete archived relation|
|
|
16
17
|
|[**restoreRelation**](#restorerelation) | **POST** /api/v2/relations/{relationUuid}/restore | Restore a deleted relation|
|
|
17
18
|
|[**updateIndices**](#updateindices) | **PUT** /api/v2/relations/updateIndices | Update relation indices|
|
|
18
19
|
|
|
@@ -519,6 +520,59 @@ const { status, data } = await apiInstance.getRelationsByObject(
|
|
|
519
520
|
|
|
520
521
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
521
522
|
|
|
523
|
+
# **permanentlyDeleteArchivedRelation**
|
|
524
|
+
> DeleteResponse permanentlyDeleteArchivedRelation()
|
|
525
|
+
|
|
526
|
+
Hard-deletes a soft-deleted relation. Only relations with deletedAt set can be removed.
|
|
527
|
+
|
|
528
|
+
### Example
|
|
529
|
+
|
|
530
|
+
```typescript
|
|
531
|
+
import {
|
|
532
|
+
RelationsApi,
|
|
533
|
+
Configuration
|
|
534
|
+
} from '@caraer/client';
|
|
535
|
+
|
|
536
|
+
const configuration = new Configuration();
|
|
537
|
+
const apiInstance = new RelationsApi(configuration);
|
|
538
|
+
|
|
539
|
+
let relationUuid: string; // (default to undefined)
|
|
540
|
+
|
|
541
|
+
const { status, data } = await apiInstance.permanentlyDeleteArchivedRelation(
|
|
542
|
+
relationUuid
|
|
543
|
+
);
|
|
544
|
+
```
|
|
545
|
+
|
|
546
|
+
### Parameters
|
|
547
|
+
|
|
548
|
+
|Name | Type | Description | Notes|
|
|
549
|
+
|------------- | ------------- | ------------- | -------------|
|
|
550
|
+
| **relationUuid** | [**string**] | | defaults to undefined|
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
### Return type
|
|
554
|
+
|
|
555
|
+
**DeleteResponse**
|
|
556
|
+
|
|
557
|
+
### Authorization
|
|
558
|
+
|
|
559
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
560
|
+
|
|
561
|
+
### HTTP request headers
|
|
562
|
+
|
|
563
|
+
- **Content-Type**: Not defined
|
|
564
|
+
- **Accept**: application/json, */*
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
### HTTP response details
|
|
568
|
+
| Status code | Description | Response headers |
|
|
569
|
+
|-------------|-------------|------------------|
|
|
570
|
+
|**200** | Relation permanently deleted | - |
|
|
571
|
+
|**400** | Relation is not archived | - |
|
|
572
|
+
|**404** | Relation not found | - |
|
|
573
|
+
|
|
574
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
575
|
+
|
|
522
576
|
# **restoreRelation**
|
|
523
577
|
> RestoreResponse restoreRelation()
|
|
524
578
|
|
package/docs/SettingField.md
CHANGED
|
@@ -14,8 +14,8 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**hidden** | **boolean** | | [optional] [default to undefined]
|
|
15
15
|
**disabled** | **boolean** | | [optional] [default to undefined]
|
|
16
16
|
**_options** | [**Array<SettingOption>**](SettingOption.md) | | [optional] [default to undefined]
|
|
17
|
-
**value** | **any** | | [optional] [default to undefined]
|
|
18
17
|
**defaultValue** | **any** | | [optional] [default to undefined]
|
|
18
|
+
**value** | **any** | | [optional] [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
@@ -32,8 +32,8 @@ const instance: SettingField = {
|
|
|
32
32
|
hidden,
|
|
33
33
|
disabled,
|
|
34
34
|
_options,
|
|
35
|
-
value,
|
|
36
35
|
defaultValue,
|
|
36
|
+
value,
|
|
37
37
|
};
|
|
38
38
|
```
|
|
39
39
|
|