@caraer/client 2.0.512 → 2.0.513
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 +159 -2
- package/dist/api.d.ts +70 -2
- package/dist/api.js +149 -0
- package/dist/esm/api.d.ts +70 -2
- package/dist/esm/api.js +149 -0
- package/docs/Record.md +2 -2
- package/docs/Team.md +2 -2
- package/docs/WebpagesApi.md +115 -0
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -3488,8 +3488,8 @@ export interface ModelRecord {
|
|
|
3488
3488
|
'updatedByUuid'?: string;
|
|
3489
3489
|
'deletedByUuid'?: string;
|
|
3490
3490
|
'index'?: number;
|
|
3491
|
-
'deleted'?: boolean;
|
|
3492
3491
|
'complete'?: boolean;
|
|
3492
|
+
'deleted'?: boolean;
|
|
3493
3493
|
'uuid': string;
|
|
3494
3494
|
'properties'?: Array<FilledProperty>;
|
|
3495
3495
|
'objects'?: { [key: string]: any | null; };
|
|
@@ -7194,8 +7194,8 @@ export interface Team {
|
|
|
7194
7194
|
'filtersString'?: string;
|
|
7195
7195
|
'filters'?: { [key: string]: Filter; };
|
|
7196
7196
|
'memberCount'?: number;
|
|
7197
|
-
'deleted'?: boolean;
|
|
7198
7197
|
'complete'?: boolean;
|
|
7198
|
+
'deleted'?: boolean;
|
|
7199
7199
|
'uuid': string;
|
|
7200
7200
|
}
|
|
7201
7201
|
export interface TeamDTO {
|
|
@@ -32404,6 +32404,92 @@ export const WebpagesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
32404
32404
|
options: localVarRequestOptions,
|
|
32405
32405
|
};
|
|
32406
32406
|
},
|
|
32407
|
+
/**
|
|
32408
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
32409
|
+
* @summary Publish a library file for a webpage
|
|
32410
|
+
* @param {string} uuid
|
|
32411
|
+
* @param {string} key
|
|
32412
|
+
* @param {*} [options] Override http request option.
|
|
32413
|
+
* @throws {RequiredError}
|
|
32414
|
+
*/
|
|
32415
|
+
publishFile: async (uuid: string, key: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
32416
|
+
// verify required parameter 'uuid' is not null or undefined
|
|
32417
|
+
assertParamExists('publishFile', 'uuid', uuid)
|
|
32418
|
+
// verify required parameter 'key' is not null or undefined
|
|
32419
|
+
assertParamExists('publishFile', 'key', key)
|
|
32420
|
+
const localVarPath = `/api/v2/webpages/{uuid}/publishFile`
|
|
32421
|
+
.replace('{uuid}', encodeURIComponent(String(uuid)));
|
|
32422
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
32423
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
32424
|
+
let baseOptions;
|
|
32425
|
+
if (configuration) {
|
|
32426
|
+
baseOptions = configuration.baseOptions;
|
|
32427
|
+
}
|
|
32428
|
+
|
|
32429
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
32430
|
+
const localVarHeaderParameter = {} as any;
|
|
32431
|
+
const localVarQueryParameter = {} as any;
|
|
32432
|
+
|
|
32433
|
+
// authentication bearerAuth required
|
|
32434
|
+
// http bearer authentication required
|
|
32435
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
32436
|
+
|
|
32437
|
+
if (key !== undefined) {
|
|
32438
|
+
localVarQueryParameter['key'] = key;
|
|
32439
|
+
}
|
|
32440
|
+
|
|
32441
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
32442
|
+
|
|
32443
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
32444
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
32445
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
32446
|
+
|
|
32447
|
+
return {
|
|
32448
|
+
url: toPathString(localVarUrlObj),
|
|
32449
|
+
options: localVarRequestOptions,
|
|
32450
|
+
};
|
|
32451
|
+
},
|
|
32452
|
+
/**
|
|
32453
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
32454
|
+
* @summary Publish a library file for a webpage
|
|
32455
|
+
* @param {string} key
|
|
32456
|
+
* @param {*} [options] Override http request option.
|
|
32457
|
+
* @throws {RequiredError}
|
|
32458
|
+
*/
|
|
32459
|
+
publishFile1: async (key: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
32460
|
+
// verify required parameter 'key' is not null or undefined
|
|
32461
|
+
assertParamExists('publishFile1', 'key', key)
|
|
32462
|
+
const localVarPath = `/api/v2/webpages/publishFile`;
|
|
32463
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
32464
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
32465
|
+
let baseOptions;
|
|
32466
|
+
if (configuration) {
|
|
32467
|
+
baseOptions = configuration.baseOptions;
|
|
32468
|
+
}
|
|
32469
|
+
|
|
32470
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
32471
|
+
const localVarHeaderParameter = {} as any;
|
|
32472
|
+
const localVarQueryParameter = {} as any;
|
|
32473
|
+
|
|
32474
|
+
// authentication bearerAuth required
|
|
32475
|
+
// http bearer authentication required
|
|
32476
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
32477
|
+
|
|
32478
|
+
if (key !== undefined) {
|
|
32479
|
+
localVarQueryParameter['key'] = key;
|
|
32480
|
+
}
|
|
32481
|
+
|
|
32482
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
32483
|
+
|
|
32484
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
32485
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
32486
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
32487
|
+
|
|
32488
|
+
return {
|
|
32489
|
+
url: toPathString(localVarUrlObj),
|
|
32490
|
+
options: localVarRequestOptions,
|
|
32491
|
+
};
|
|
32492
|
+
},
|
|
32407
32493
|
/**
|
|
32408
32494
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
32409
32495
|
* @summary Publish a webpage
|
|
@@ -33244,6 +33330,33 @@ export const WebpagesApiFp = function(configuration?: Configuration) {
|
|
|
33244
33330
|
const localVarOperationServerBasePath = operationServerMap['WebpagesApi.listProtectionGrants']?.[localVarOperationServerIndex]?.url;
|
|
33245
33331
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
33246
33332
|
},
|
|
33333
|
+
/**
|
|
33334
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
33335
|
+
* @summary Publish a library file for a webpage
|
|
33336
|
+
* @param {string} uuid
|
|
33337
|
+
* @param {string} key
|
|
33338
|
+
* @param {*} [options] Override http request option.
|
|
33339
|
+
* @throws {RequiredError}
|
|
33340
|
+
*/
|
|
33341
|
+
async publishFile(uuid: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseString>> {
|
|
33342
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.publishFile(uuid, key, options);
|
|
33343
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
33344
|
+
const localVarOperationServerBasePath = operationServerMap['WebpagesApi.publishFile']?.[localVarOperationServerIndex]?.url;
|
|
33345
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
33346
|
+
},
|
|
33347
|
+
/**
|
|
33348
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
33349
|
+
* @summary Publish a library file for a webpage
|
|
33350
|
+
* @param {string} key
|
|
33351
|
+
* @param {*} [options] Override http request option.
|
|
33352
|
+
* @throws {RequiredError}
|
|
33353
|
+
*/
|
|
33354
|
+
async publishFile1(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseString>> {
|
|
33355
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.publishFile1(key, options);
|
|
33356
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
33357
|
+
const localVarOperationServerBasePath = operationServerMap['WebpagesApi.publishFile1']?.[localVarOperationServerIndex]?.url;
|
|
33358
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
33359
|
+
},
|
|
33247
33360
|
/**
|
|
33248
33361
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
33249
33362
|
* @summary Publish a webpage
|
|
@@ -33723,6 +33836,27 @@ export const WebpagesApiFactory = function (configuration?: Configuration, baseP
|
|
|
33723
33836
|
listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponseWebpageAccessGrantDTO> {
|
|
33724
33837
|
return localVarFp.listProtectionGrants(uuid, environment, options).then((request) => request(axios, basePath));
|
|
33725
33838
|
},
|
|
33839
|
+
/**
|
|
33840
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
33841
|
+
* @summary Publish a library file for a webpage
|
|
33842
|
+
* @param {string} uuid
|
|
33843
|
+
* @param {string} key
|
|
33844
|
+
* @param {*} [options] Override http request option.
|
|
33845
|
+
* @throws {RequiredError}
|
|
33846
|
+
*/
|
|
33847
|
+
publishFile(uuid: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString> {
|
|
33848
|
+
return localVarFp.publishFile(uuid, key, options).then((request) => request(axios, basePath));
|
|
33849
|
+
},
|
|
33850
|
+
/**
|
|
33851
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
33852
|
+
* @summary Publish a library file for a webpage
|
|
33853
|
+
* @param {string} key
|
|
33854
|
+
* @param {*} [options] Override http request option.
|
|
33855
|
+
* @throws {RequiredError}
|
|
33856
|
+
*/
|
|
33857
|
+
publishFile1(key: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString> {
|
|
33858
|
+
return localVarFp.publishFile1(key, options).then((request) => request(axios, basePath));
|
|
33859
|
+
},
|
|
33726
33860
|
/**
|
|
33727
33861
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
33728
33862
|
* @summary Publish a webpage
|
|
@@ -34200,6 +34334,29 @@ export class WebpagesApi extends BaseAPI {
|
|
|
34200
34334
|
return WebpagesApiFp(this.configuration).listProtectionGrants(uuid, environment, options).then((request) => request(this.axios, this.basePath));
|
|
34201
34335
|
}
|
|
34202
34336
|
|
|
34337
|
+
/**
|
|
34338
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
34339
|
+
* @summary Publish a library file for a webpage
|
|
34340
|
+
* @param {string} uuid
|
|
34341
|
+
* @param {string} key
|
|
34342
|
+
* @param {*} [options] Override http request option.
|
|
34343
|
+
* @throws {RequiredError}
|
|
34344
|
+
*/
|
|
34345
|
+
public publishFile(uuid: string, key: string, options?: RawAxiosRequestConfig) {
|
|
34346
|
+
return WebpagesApiFp(this.configuration).publishFile(uuid, key, options).then((request) => request(this.axios, this.basePath));
|
|
34347
|
+
}
|
|
34348
|
+
|
|
34349
|
+
/**
|
|
34350
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
34351
|
+
* @summary Publish a library file for a webpage
|
|
34352
|
+
* @param {string} key
|
|
34353
|
+
* @param {*} [options] Override http request option.
|
|
34354
|
+
* @throws {RequiredError}
|
|
34355
|
+
*/
|
|
34356
|
+
public publishFile1(key: string, options?: RawAxiosRequestConfig) {
|
|
34357
|
+
return WebpagesApiFp(this.configuration).publishFile1(key, options).then((request) => request(this.axios, this.basePath));
|
|
34358
|
+
}
|
|
34359
|
+
|
|
34203
34360
|
/**
|
|
34204
34361
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
34205
34362
|
* @summary Publish a webpage
|
package/dist/api.d.ts
CHANGED
|
@@ -3496,8 +3496,8 @@ export interface ModelRecord {
|
|
|
3496
3496
|
'updatedByUuid'?: string;
|
|
3497
3497
|
'deletedByUuid'?: string;
|
|
3498
3498
|
'index'?: number;
|
|
3499
|
-
'deleted'?: boolean;
|
|
3500
3499
|
'complete'?: boolean;
|
|
3500
|
+
'deleted'?: boolean;
|
|
3501
3501
|
'uuid': string;
|
|
3502
3502
|
'properties'?: Array<FilledProperty>;
|
|
3503
3503
|
'objects'?: {
|
|
@@ -7310,8 +7310,8 @@ export interface Team {
|
|
|
7310
7310
|
[key: string]: Filter;
|
|
7311
7311
|
};
|
|
7312
7312
|
'memberCount'?: number;
|
|
7313
|
-
'deleted'?: boolean;
|
|
7314
7313
|
'complete'?: boolean;
|
|
7314
|
+
'deleted'?: boolean;
|
|
7315
7315
|
'uuid': string;
|
|
7316
7316
|
}
|
|
7317
7317
|
export interface TeamDTO {
|
|
@@ -19287,6 +19287,23 @@ export declare const WebpagesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
19287
19287
|
* @throws {RequiredError}
|
|
19288
19288
|
*/
|
|
19289
19289
|
listProtectionGrants: (uuid: string, environment?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19290
|
+
/**
|
|
19291
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
19292
|
+
* @summary Publish a library file for a webpage
|
|
19293
|
+
* @param {string} uuid
|
|
19294
|
+
* @param {string} key
|
|
19295
|
+
* @param {*} [options] Override http request option.
|
|
19296
|
+
* @throws {RequiredError}
|
|
19297
|
+
*/
|
|
19298
|
+
publishFile: (uuid: string, key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19299
|
+
/**
|
|
19300
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
19301
|
+
* @summary Publish a library file for a webpage
|
|
19302
|
+
* @param {string} key
|
|
19303
|
+
* @param {*} [options] Override http request option.
|
|
19304
|
+
* @throws {RequiredError}
|
|
19305
|
+
*/
|
|
19306
|
+
publishFile1: (key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19290
19307
|
/**
|
|
19291
19308
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
19292
19309
|
* @summary Publish a webpage
|
|
@@ -19663,6 +19680,23 @@ export declare const WebpagesApiFp: (configuration?: Configuration) => {
|
|
|
19663
19680
|
* @throws {RequiredError}
|
|
19664
19681
|
*/
|
|
19665
19682
|
listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponseWebpageAccessGrantDTO>>;
|
|
19683
|
+
/**
|
|
19684
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
19685
|
+
* @summary Publish a library file for a webpage
|
|
19686
|
+
* @param {string} uuid
|
|
19687
|
+
* @param {string} key
|
|
19688
|
+
* @param {*} [options] Override http request option.
|
|
19689
|
+
* @throws {RequiredError}
|
|
19690
|
+
*/
|
|
19691
|
+
publishFile(uuid: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseString>>;
|
|
19692
|
+
/**
|
|
19693
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
19694
|
+
* @summary Publish a library file for a webpage
|
|
19695
|
+
* @param {string} key
|
|
19696
|
+
* @param {*} [options] Override http request option.
|
|
19697
|
+
* @throws {RequiredError}
|
|
19698
|
+
*/
|
|
19699
|
+
publishFile1(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseString>>;
|
|
19666
19700
|
/**
|
|
19667
19701
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
19668
19702
|
* @summary Publish a webpage
|
|
@@ -20039,6 +20073,23 @@ export declare const WebpagesApiFactory: (configuration?: Configuration, basePat
|
|
|
20039
20073
|
* @throws {RequiredError}
|
|
20040
20074
|
*/
|
|
20041
20075
|
listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponseWebpageAccessGrantDTO>;
|
|
20076
|
+
/**
|
|
20077
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
20078
|
+
* @summary Publish a library file for a webpage
|
|
20079
|
+
* @param {string} uuid
|
|
20080
|
+
* @param {string} key
|
|
20081
|
+
* @param {*} [options] Override http request option.
|
|
20082
|
+
* @throws {RequiredError}
|
|
20083
|
+
*/
|
|
20084
|
+
publishFile(uuid: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString>;
|
|
20085
|
+
/**
|
|
20086
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
20087
|
+
* @summary Publish a library file for a webpage
|
|
20088
|
+
* @param {string} key
|
|
20089
|
+
* @param {*} [options] Override http request option.
|
|
20090
|
+
* @throws {RequiredError}
|
|
20091
|
+
*/
|
|
20092
|
+
publishFile1(key: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString>;
|
|
20042
20093
|
/**
|
|
20043
20094
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
20044
20095
|
* @summary Publish a webpage
|
|
@@ -20415,6 +20466,23 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
20415
20466
|
* @throws {RequiredError}
|
|
20416
20467
|
*/
|
|
20417
20468
|
listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginationResponseWebpageAccessGrantDTO, any, {}>>;
|
|
20469
|
+
/**
|
|
20470
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
20471
|
+
* @summary Publish a library file for a webpage
|
|
20472
|
+
* @param {string} uuid
|
|
20473
|
+
* @param {string} key
|
|
20474
|
+
* @param {*} [options] Override http request option.
|
|
20475
|
+
* @throws {RequiredError}
|
|
20476
|
+
*/
|
|
20477
|
+
publishFile(uuid: string, key: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseString, any, {}>>;
|
|
20478
|
+
/**
|
|
20479
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
20480
|
+
* @summary Publish a library file for a webpage
|
|
20481
|
+
* @param {string} key
|
|
20482
|
+
* @param {*} [options] Override http request option.
|
|
20483
|
+
* @throws {RequiredError}
|
|
20484
|
+
*/
|
|
20485
|
+
publishFile1(key: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseString, any, {}>>;
|
|
20418
20486
|
/**
|
|
20419
20487
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
20420
20488
|
* @summary Publish a webpage
|
package/dist/api.js
CHANGED
|
@@ -23188,6 +23188,80 @@ const WebpagesApiAxiosParamCreator = function (configuration) {
|
|
|
23188
23188
|
options: localVarRequestOptions,
|
|
23189
23189
|
};
|
|
23190
23190
|
}),
|
|
23191
|
+
/**
|
|
23192
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
23193
|
+
* @summary Publish a library file for a webpage
|
|
23194
|
+
* @param {string} uuid
|
|
23195
|
+
* @param {string} key
|
|
23196
|
+
* @param {*} [options] Override http request option.
|
|
23197
|
+
* @throws {RequiredError}
|
|
23198
|
+
*/
|
|
23199
|
+
publishFile: (uuid_1, key_1, ...args_1) => __awaiter(this, [uuid_1, key_1, ...args_1], void 0, function* (uuid, key, options = {}) {
|
|
23200
|
+
// verify required parameter 'uuid' is not null or undefined
|
|
23201
|
+
(0, common_1.assertParamExists)('publishFile', 'uuid', uuid);
|
|
23202
|
+
// verify required parameter 'key' is not null or undefined
|
|
23203
|
+
(0, common_1.assertParamExists)('publishFile', 'key', key);
|
|
23204
|
+
const localVarPath = `/api/v2/webpages/{uuid}/publishFile`
|
|
23205
|
+
.replace('{uuid}', encodeURIComponent(String(uuid)));
|
|
23206
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23207
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
23208
|
+
let baseOptions;
|
|
23209
|
+
if (configuration) {
|
|
23210
|
+
baseOptions = configuration.baseOptions;
|
|
23211
|
+
}
|
|
23212
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
23213
|
+
const localVarHeaderParameter = {};
|
|
23214
|
+
const localVarQueryParameter = {};
|
|
23215
|
+
// authentication bearerAuth required
|
|
23216
|
+
// http bearer authentication required
|
|
23217
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
23218
|
+
if (key !== undefined) {
|
|
23219
|
+
localVarQueryParameter['key'] = key;
|
|
23220
|
+
}
|
|
23221
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
23222
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
23223
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23224
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23225
|
+
return {
|
|
23226
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
23227
|
+
options: localVarRequestOptions,
|
|
23228
|
+
};
|
|
23229
|
+
}),
|
|
23230
|
+
/**
|
|
23231
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
23232
|
+
* @summary Publish a library file for a webpage
|
|
23233
|
+
* @param {string} key
|
|
23234
|
+
* @param {*} [options] Override http request option.
|
|
23235
|
+
* @throws {RequiredError}
|
|
23236
|
+
*/
|
|
23237
|
+
publishFile1: (key_1, ...args_1) => __awaiter(this, [key_1, ...args_1], void 0, function* (key, options = {}) {
|
|
23238
|
+
// verify required parameter 'key' is not null or undefined
|
|
23239
|
+
(0, common_1.assertParamExists)('publishFile1', 'key', key);
|
|
23240
|
+
const localVarPath = `/api/v2/webpages/publishFile`;
|
|
23241
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23242
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
23243
|
+
let baseOptions;
|
|
23244
|
+
if (configuration) {
|
|
23245
|
+
baseOptions = configuration.baseOptions;
|
|
23246
|
+
}
|
|
23247
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
23248
|
+
const localVarHeaderParameter = {};
|
|
23249
|
+
const localVarQueryParameter = {};
|
|
23250
|
+
// authentication bearerAuth required
|
|
23251
|
+
// http bearer authentication required
|
|
23252
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
23253
|
+
if (key !== undefined) {
|
|
23254
|
+
localVarQueryParameter['key'] = key;
|
|
23255
|
+
}
|
|
23256
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
23257
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
23258
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23259
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23260
|
+
return {
|
|
23261
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
23262
|
+
options: localVarRequestOptions,
|
|
23263
|
+
};
|
|
23264
|
+
}),
|
|
23191
23265
|
/**
|
|
23192
23266
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
23193
23267
|
* @summary Publish a webpage
|
|
@@ -24057,6 +24131,39 @@ const WebpagesApiFp = function (configuration) {
|
|
|
24057
24131
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24058
24132
|
});
|
|
24059
24133
|
},
|
|
24134
|
+
/**
|
|
24135
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
24136
|
+
* @summary Publish a library file for a webpage
|
|
24137
|
+
* @param {string} uuid
|
|
24138
|
+
* @param {string} key
|
|
24139
|
+
* @param {*} [options] Override http request option.
|
|
24140
|
+
* @throws {RequiredError}
|
|
24141
|
+
*/
|
|
24142
|
+
publishFile(uuid, key, options) {
|
|
24143
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24144
|
+
var _a, _b, _c;
|
|
24145
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.publishFile(uuid, key, options);
|
|
24146
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
24147
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['WebpagesApi.publishFile']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
24148
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24149
|
+
});
|
|
24150
|
+
},
|
|
24151
|
+
/**
|
|
24152
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
24153
|
+
* @summary Publish a library file for a webpage
|
|
24154
|
+
* @param {string} key
|
|
24155
|
+
* @param {*} [options] Override http request option.
|
|
24156
|
+
* @throws {RequiredError}
|
|
24157
|
+
*/
|
|
24158
|
+
publishFile1(key, options) {
|
|
24159
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24160
|
+
var _a, _b, _c;
|
|
24161
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.publishFile1(key, options);
|
|
24162
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
24163
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['WebpagesApi.publishFile1']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
24164
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24165
|
+
});
|
|
24166
|
+
},
|
|
24060
24167
|
/**
|
|
24061
24168
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
24062
24169
|
* @summary Publish a webpage
|
|
@@ -24563,6 +24670,27 @@ const WebpagesApiFactory = function (configuration, basePath, axios) {
|
|
|
24563
24670
|
listProtectionGrants(uuid, environment, options) {
|
|
24564
24671
|
return localVarFp.listProtectionGrants(uuid, environment, options).then((request) => request(axios, basePath));
|
|
24565
24672
|
},
|
|
24673
|
+
/**
|
|
24674
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
24675
|
+
* @summary Publish a library file for a webpage
|
|
24676
|
+
* @param {string} uuid
|
|
24677
|
+
* @param {string} key
|
|
24678
|
+
* @param {*} [options] Override http request option.
|
|
24679
|
+
* @throws {RequiredError}
|
|
24680
|
+
*/
|
|
24681
|
+
publishFile(uuid, key, options) {
|
|
24682
|
+
return localVarFp.publishFile(uuid, key, options).then((request) => request(axios, basePath));
|
|
24683
|
+
},
|
|
24684
|
+
/**
|
|
24685
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
24686
|
+
* @summary Publish a library file for a webpage
|
|
24687
|
+
* @param {string} key
|
|
24688
|
+
* @param {*} [options] Override http request option.
|
|
24689
|
+
* @throws {RequiredError}
|
|
24690
|
+
*/
|
|
24691
|
+
publishFile1(key, options) {
|
|
24692
|
+
return localVarFp.publishFile1(key, options).then((request) => request(axios, basePath));
|
|
24693
|
+
},
|
|
24566
24694
|
/**
|
|
24567
24695
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
24568
24696
|
* @summary Publish a webpage
|
|
@@ -25013,6 +25141,27 @@ class WebpagesApi extends base_1.BaseAPI {
|
|
|
25013
25141
|
listProtectionGrants(uuid, environment, options) {
|
|
25014
25142
|
return (0, exports.WebpagesApiFp)(this.configuration).listProtectionGrants(uuid, environment, options).then((request) => request(this.axios, this.basePath));
|
|
25015
25143
|
}
|
|
25144
|
+
/**
|
|
25145
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
25146
|
+
* @summary Publish a library file for a webpage
|
|
25147
|
+
* @param {string} uuid
|
|
25148
|
+
* @param {string} key
|
|
25149
|
+
* @param {*} [options] Override http request option.
|
|
25150
|
+
* @throws {RequiredError}
|
|
25151
|
+
*/
|
|
25152
|
+
publishFile(uuid, key, options) {
|
|
25153
|
+
return (0, exports.WebpagesApiFp)(this.configuration).publishFile(uuid, key, options).then((request) => request(this.axios, this.basePath));
|
|
25154
|
+
}
|
|
25155
|
+
/**
|
|
25156
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
25157
|
+
* @summary Publish a library file for a webpage
|
|
25158
|
+
* @param {string} key
|
|
25159
|
+
* @param {*} [options] Override http request option.
|
|
25160
|
+
* @throws {RequiredError}
|
|
25161
|
+
*/
|
|
25162
|
+
publishFile1(key, options) {
|
|
25163
|
+
return (0, exports.WebpagesApiFp)(this.configuration).publishFile1(key, options).then((request) => request(this.axios, this.basePath));
|
|
25164
|
+
}
|
|
25016
25165
|
/**
|
|
25017
25166
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
25018
25167
|
* @summary Publish a webpage
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -3496,8 +3496,8 @@ export interface ModelRecord {
|
|
|
3496
3496
|
'updatedByUuid'?: string;
|
|
3497
3497
|
'deletedByUuid'?: string;
|
|
3498
3498
|
'index'?: number;
|
|
3499
|
-
'deleted'?: boolean;
|
|
3500
3499
|
'complete'?: boolean;
|
|
3500
|
+
'deleted'?: boolean;
|
|
3501
3501
|
'uuid': string;
|
|
3502
3502
|
'properties'?: Array<FilledProperty>;
|
|
3503
3503
|
'objects'?: {
|
|
@@ -7310,8 +7310,8 @@ export interface Team {
|
|
|
7310
7310
|
[key: string]: Filter;
|
|
7311
7311
|
};
|
|
7312
7312
|
'memberCount'?: number;
|
|
7313
|
-
'deleted'?: boolean;
|
|
7314
7313
|
'complete'?: boolean;
|
|
7314
|
+
'deleted'?: boolean;
|
|
7315
7315
|
'uuid': string;
|
|
7316
7316
|
}
|
|
7317
7317
|
export interface TeamDTO {
|
|
@@ -19287,6 +19287,23 @@ export declare const WebpagesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
19287
19287
|
* @throws {RequiredError}
|
|
19288
19288
|
*/
|
|
19289
19289
|
listProtectionGrants: (uuid: string, environment?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19290
|
+
/**
|
|
19291
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
19292
|
+
* @summary Publish a library file for a webpage
|
|
19293
|
+
* @param {string} uuid
|
|
19294
|
+
* @param {string} key
|
|
19295
|
+
* @param {*} [options] Override http request option.
|
|
19296
|
+
* @throws {RequiredError}
|
|
19297
|
+
*/
|
|
19298
|
+
publishFile: (uuid: string, key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19299
|
+
/**
|
|
19300
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
19301
|
+
* @summary Publish a library file for a webpage
|
|
19302
|
+
* @param {string} key
|
|
19303
|
+
* @param {*} [options] Override http request option.
|
|
19304
|
+
* @throws {RequiredError}
|
|
19305
|
+
*/
|
|
19306
|
+
publishFile1: (key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19290
19307
|
/**
|
|
19291
19308
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
19292
19309
|
* @summary Publish a webpage
|
|
@@ -19663,6 +19680,23 @@ export declare const WebpagesApiFp: (configuration?: Configuration) => {
|
|
|
19663
19680
|
* @throws {RequiredError}
|
|
19664
19681
|
*/
|
|
19665
19682
|
listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponseWebpageAccessGrantDTO>>;
|
|
19683
|
+
/**
|
|
19684
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
19685
|
+
* @summary Publish a library file for a webpage
|
|
19686
|
+
* @param {string} uuid
|
|
19687
|
+
* @param {string} key
|
|
19688
|
+
* @param {*} [options] Override http request option.
|
|
19689
|
+
* @throws {RequiredError}
|
|
19690
|
+
*/
|
|
19691
|
+
publishFile(uuid: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseString>>;
|
|
19692
|
+
/**
|
|
19693
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
19694
|
+
* @summary Publish a library file for a webpage
|
|
19695
|
+
* @param {string} key
|
|
19696
|
+
* @param {*} [options] Override http request option.
|
|
19697
|
+
* @throws {RequiredError}
|
|
19698
|
+
*/
|
|
19699
|
+
publishFile1(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseString>>;
|
|
19666
19700
|
/**
|
|
19667
19701
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
19668
19702
|
* @summary Publish a webpage
|
|
@@ -20039,6 +20073,23 @@ export declare const WebpagesApiFactory: (configuration?: Configuration, basePat
|
|
|
20039
20073
|
* @throws {RequiredError}
|
|
20040
20074
|
*/
|
|
20041
20075
|
listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponseWebpageAccessGrantDTO>;
|
|
20076
|
+
/**
|
|
20077
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
20078
|
+
* @summary Publish a library file for a webpage
|
|
20079
|
+
* @param {string} uuid
|
|
20080
|
+
* @param {string} key
|
|
20081
|
+
* @param {*} [options] Override http request option.
|
|
20082
|
+
* @throws {RequiredError}
|
|
20083
|
+
*/
|
|
20084
|
+
publishFile(uuid: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString>;
|
|
20085
|
+
/**
|
|
20086
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
20087
|
+
* @summary Publish a library file for a webpage
|
|
20088
|
+
* @param {string} key
|
|
20089
|
+
* @param {*} [options] Override http request option.
|
|
20090
|
+
* @throws {RequiredError}
|
|
20091
|
+
*/
|
|
20092
|
+
publishFile1(key: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString>;
|
|
20042
20093
|
/**
|
|
20043
20094
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
20044
20095
|
* @summary Publish a webpage
|
|
@@ -20415,6 +20466,23 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
20415
20466
|
* @throws {RequiredError}
|
|
20416
20467
|
*/
|
|
20417
20468
|
listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginationResponseWebpageAccessGrantDTO, any, {}>>;
|
|
20469
|
+
/**
|
|
20470
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
20471
|
+
* @summary Publish a library file for a webpage
|
|
20472
|
+
* @param {string} uuid
|
|
20473
|
+
* @param {string} key
|
|
20474
|
+
* @param {*} [options] Override http request option.
|
|
20475
|
+
* @throws {RequiredError}
|
|
20476
|
+
*/
|
|
20477
|
+
publishFile(uuid: string, key: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseString, any, {}>>;
|
|
20478
|
+
/**
|
|
20479
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
20480
|
+
* @summary Publish a library file for a webpage
|
|
20481
|
+
* @param {string} key
|
|
20482
|
+
* @param {*} [options] Override http request option.
|
|
20483
|
+
* @throws {RequiredError}
|
|
20484
|
+
*/
|
|
20485
|
+
publishFile1(key: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseString, any, {}>>;
|
|
20418
20486
|
/**
|
|
20419
20487
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
20420
20488
|
* @summary Publish a webpage
|
package/dist/esm/api.js
CHANGED
|
@@ -23062,6 +23062,80 @@ export const WebpagesApiAxiosParamCreator = function (configuration) {
|
|
|
23062
23062
|
options: localVarRequestOptions,
|
|
23063
23063
|
};
|
|
23064
23064
|
}),
|
|
23065
|
+
/**
|
|
23066
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
23067
|
+
* @summary Publish a library file for a webpage
|
|
23068
|
+
* @param {string} uuid
|
|
23069
|
+
* @param {string} key
|
|
23070
|
+
* @param {*} [options] Override http request option.
|
|
23071
|
+
* @throws {RequiredError}
|
|
23072
|
+
*/
|
|
23073
|
+
publishFile: (uuid_1, key_1, ...args_1) => __awaiter(this, [uuid_1, key_1, ...args_1], void 0, function* (uuid, key, options = {}) {
|
|
23074
|
+
// verify required parameter 'uuid' is not null or undefined
|
|
23075
|
+
assertParamExists('publishFile', 'uuid', uuid);
|
|
23076
|
+
// verify required parameter 'key' is not null or undefined
|
|
23077
|
+
assertParamExists('publishFile', 'key', key);
|
|
23078
|
+
const localVarPath = `/api/v2/webpages/{uuid}/publishFile`
|
|
23079
|
+
.replace('{uuid}', encodeURIComponent(String(uuid)));
|
|
23080
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23081
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23082
|
+
let baseOptions;
|
|
23083
|
+
if (configuration) {
|
|
23084
|
+
baseOptions = configuration.baseOptions;
|
|
23085
|
+
}
|
|
23086
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
23087
|
+
const localVarHeaderParameter = {};
|
|
23088
|
+
const localVarQueryParameter = {};
|
|
23089
|
+
// authentication bearerAuth required
|
|
23090
|
+
// http bearer authentication required
|
|
23091
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
23092
|
+
if (key !== undefined) {
|
|
23093
|
+
localVarQueryParameter['key'] = key;
|
|
23094
|
+
}
|
|
23095
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
23096
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23097
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23098
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23099
|
+
return {
|
|
23100
|
+
url: toPathString(localVarUrlObj),
|
|
23101
|
+
options: localVarRequestOptions,
|
|
23102
|
+
};
|
|
23103
|
+
}),
|
|
23104
|
+
/**
|
|
23105
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
23106
|
+
* @summary Publish a library file for a webpage
|
|
23107
|
+
* @param {string} key
|
|
23108
|
+
* @param {*} [options] Override http request option.
|
|
23109
|
+
* @throws {RequiredError}
|
|
23110
|
+
*/
|
|
23111
|
+
publishFile1: (key_1, ...args_1) => __awaiter(this, [key_1, ...args_1], void 0, function* (key, options = {}) {
|
|
23112
|
+
// verify required parameter 'key' is not null or undefined
|
|
23113
|
+
assertParamExists('publishFile1', 'key', key);
|
|
23114
|
+
const localVarPath = `/api/v2/webpages/publishFile`;
|
|
23115
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23116
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23117
|
+
let baseOptions;
|
|
23118
|
+
if (configuration) {
|
|
23119
|
+
baseOptions = configuration.baseOptions;
|
|
23120
|
+
}
|
|
23121
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
23122
|
+
const localVarHeaderParameter = {};
|
|
23123
|
+
const localVarQueryParameter = {};
|
|
23124
|
+
// authentication bearerAuth required
|
|
23125
|
+
// http bearer authentication required
|
|
23126
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
23127
|
+
if (key !== undefined) {
|
|
23128
|
+
localVarQueryParameter['key'] = key;
|
|
23129
|
+
}
|
|
23130
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
23131
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23132
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23133
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23134
|
+
return {
|
|
23135
|
+
url: toPathString(localVarUrlObj),
|
|
23136
|
+
options: localVarRequestOptions,
|
|
23137
|
+
};
|
|
23138
|
+
}),
|
|
23065
23139
|
/**
|
|
23066
23140
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
23067
23141
|
* @summary Publish a webpage
|
|
@@ -23930,6 +24004,39 @@ export const WebpagesApiFp = function (configuration) {
|
|
|
23930
24004
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23931
24005
|
});
|
|
23932
24006
|
},
|
|
24007
|
+
/**
|
|
24008
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
24009
|
+
* @summary Publish a library file for a webpage
|
|
24010
|
+
* @param {string} uuid
|
|
24011
|
+
* @param {string} key
|
|
24012
|
+
* @param {*} [options] Override http request option.
|
|
24013
|
+
* @throws {RequiredError}
|
|
24014
|
+
*/
|
|
24015
|
+
publishFile(uuid, key, options) {
|
|
24016
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24017
|
+
var _a, _b, _c;
|
|
24018
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.publishFile(uuid, key, options);
|
|
24019
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
24020
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['WebpagesApi.publishFile']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
24021
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24022
|
+
});
|
|
24023
|
+
},
|
|
24024
|
+
/**
|
|
24025
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
24026
|
+
* @summary Publish a library file for a webpage
|
|
24027
|
+
* @param {string} key
|
|
24028
|
+
* @param {*} [options] Override http request option.
|
|
24029
|
+
* @throws {RequiredError}
|
|
24030
|
+
*/
|
|
24031
|
+
publishFile1(key, options) {
|
|
24032
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24033
|
+
var _a, _b, _c;
|
|
24034
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.publishFile1(key, options);
|
|
24035
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
24036
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['WebpagesApi.publishFile1']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
24037
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24038
|
+
});
|
|
24039
|
+
},
|
|
23933
24040
|
/**
|
|
23934
24041
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
23935
24042
|
* @summary Publish a webpage
|
|
@@ -24435,6 +24542,27 @@ export const WebpagesApiFactory = function (configuration, basePath, axios) {
|
|
|
24435
24542
|
listProtectionGrants(uuid, environment, options) {
|
|
24436
24543
|
return localVarFp.listProtectionGrants(uuid, environment, options).then((request) => request(axios, basePath));
|
|
24437
24544
|
},
|
|
24545
|
+
/**
|
|
24546
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
24547
|
+
* @summary Publish a library file for a webpage
|
|
24548
|
+
* @param {string} uuid
|
|
24549
|
+
* @param {string} key
|
|
24550
|
+
* @param {*} [options] Override http request option.
|
|
24551
|
+
* @throws {RequiredError}
|
|
24552
|
+
*/
|
|
24553
|
+
publishFile(uuid, key, options) {
|
|
24554
|
+
return localVarFp.publishFile(uuid, key, options).then((request) => request(axios, basePath));
|
|
24555
|
+
},
|
|
24556
|
+
/**
|
|
24557
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
24558
|
+
* @summary Publish a library file for a webpage
|
|
24559
|
+
* @param {string} key
|
|
24560
|
+
* @param {*} [options] Override http request option.
|
|
24561
|
+
* @throws {RequiredError}
|
|
24562
|
+
*/
|
|
24563
|
+
publishFile1(key, options) {
|
|
24564
|
+
return localVarFp.publishFile1(key, options).then((request) => request(axios, basePath));
|
|
24565
|
+
},
|
|
24438
24566
|
/**
|
|
24439
24567
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
24440
24568
|
* @summary Publish a webpage
|
|
@@ -24884,6 +25012,27 @@ export class WebpagesApi extends BaseAPI {
|
|
|
24884
25012
|
listProtectionGrants(uuid, environment, options) {
|
|
24885
25013
|
return WebpagesApiFp(this.configuration).listProtectionGrants(uuid, environment, options).then((request) => request(this.axios, this.basePath));
|
|
24886
25014
|
}
|
|
25015
|
+
/**
|
|
25016
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
25017
|
+
* @summary Publish a library file for a webpage
|
|
25018
|
+
* @param {string} uuid
|
|
25019
|
+
* @param {string} key
|
|
25020
|
+
* @param {*} [options] Override http request option.
|
|
25021
|
+
* @throws {RequiredError}
|
|
25022
|
+
*/
|
|
25023
|
+
publishFile(uuid, key, options) {
|
|
25024
|
+
return WebpagesApiFp(this.configuration).publishFile(uuid, key, options).then((request) => request(this.axios, this.basePath));
|
|
25025
|
+
}
|
|
25026
|
+
/**
|
|
25027
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
25028
|
+
* @summary Publish a library file for a webpage
|
|
25029
|
+
* @param {string} key
|
|
25030
|
+
* @param {*} [options] Override http request option.
|
|
25031
|
+
* @throws {RequiredError}
|
|
25032
|
+
*/
|
|
25033
|
+
publishFile1(key, options) {
|
|
25034
|
+
return WebpagesApiFp(this.configuration).publishFile1(key, options).then((request) => request(this.axios, this.basePath));
|
|
25035
|
+
}
|
|
24887
25036
|
/**
|
|
24888
25037
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
24889
25038
|
* @summary Publish a webpage
|
package/docs/Record.md
CHANGED
|
@@ -14,8 +14,8 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**updatedByUuid** | **string** | | [optional] [default to undefined]
|
|
15
15
|
**deletedByUuid** | **string** | | [optional] [default to undefined]
|
|
16
16
|
**index** | **number** | | [optional] [default to undefined]
|
|
17
|
-
**deleted** | **boolean** | | [optional] [default to undefined]
|
|
18
17
|
**complete** | **boolean** | | [optional] [default to undefined]
|
|
18
|
+
**deleted** | **boolean** | | [optional] [default to undefined]
|
|
19
19
|
**uuid** | **string** | | [default to undefined]
|
|
20
20
|
**properties** | [**Array<FilledProperty>**](FilledProperty.md) | | [optional] [default to undefined]
|
|
21
21
|
**objects** | **{ [key: string]: any | null; }** | | [optional] [default to undefined]
|
|
@@ -36,8 +36,8 @@ const instance: ModelRecord = {
|
|
|
36
36
|
updatedByUuid,
|
|
37
37
|
deletedByUuid,
|
|
38
38
|
index,
|
|
39
|
-
deleted,
|
|
40
39
|
complete,
|
|
40
|
+
deleted,
|
|
41
41
|
uuid,
|
|
42
42
|
properties,
|
|
43
43
|
objects,
|
package/docs/Team.md
CHANGED
|
@@ -19,8 +19,8 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**filtersString** | **string** | | [optional] [default to undefined]
|
|
20
20
|
**filters** | [**{ [key: string]: Filter; }**](Filter.md) | | [optional] [default to undefined]
|
|
21
21
|
**memberCount** | **number** | | [optional] [default to undefined]
|
|
22
|
-
**deleted** | **boolean** | | [optional] [default to undefined]
|
|
23
22
|
**complete** | **boolean** | | [optional] [default to undefined]
|
|
23
|
+
**deleted** | **boolean** | | [optional] [default to undefined]
|
|
24
24
|
**uuid** | **string** | | [default to undefined]
|
|
25
25
|
|
|
26
26
|
## Example
|
|
@@ -43,8 +43,8 @@ const instance: Team = {
|
|
|
43
43
|
filtersString,
|
|
44
44
|
filters,
|
|
45
45
|
memberCount,
|
|
46
|
-
deleted,
|
|
47
46
|
complete,
|
|
47
|
+
deleted,
|
|
48
48
|
uuid,
|
|
49
49
|
};
|
|
50
50
|
```
|
package/docs/WebpagesApi.md
CHANGED
|
@@ -31,6 +31,8 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
31
31
|
|[**getWebpageEditingStatus**](#getwebpageeditingstatus) | **GET** /api/v2/webpages/{uuid}/editing-status | Check if a webpage is being edited|
|
|
32
32
|
|[**getWebpagePickerPages**](#getwebpagepickerpages) | **GET** /api/v2/webpages/picker/pages | List webpages for picker dropdowns|
|
|
33
33
|
|[**listProtectionGrants**](#listprotectiongrants) | **GET** /api/v2/webpages/{uuid}/protection/grants | List signed URL grants for a webpage|
|
|
34
|
+
|[**publishFile**](#publishfile) | **POST** /api/v2/webpages/{uuid}/publishFile | Publish a library file for a webpage|
|
|
35
|
+
|[**publishFile1**](#publishfile1) | **POST** /api/v2/webpages/publishFile | Publish a library file for a webpage|
|
|
34
36
|
|[**publishWebpage**](#publishwebpage) | **PUT** /api/v2/webpages/{uuid}/publish | Publish a webpage|
|
|
35
37
|
|[**releaseTemplateWebpageEditingSession**](#releasetemplatewebpageeditingsession) | **DELETE** /api/v2/webpages/template/{objectName}/{environment}/editing-session | Release a template webpage editing session|
|
|
36
38
|
|[**releaseWebpageEditingSession**](#releasewebpageeditingsession) | **DELETE** /api/v2/webpages/{uuid}/editing-session | Release a webpage editing session|
|
|
@@ -1729,6 +1731,119 @@ const { status, data } = await apiInstance.listProtectionGrants(
|
|
|
1729
1731
|
- **Accept**: application/json
|
|
1730
1732
|
|
|
1731
1733
|
|
|
1734
|
+
### HTTP response details
|
|
1735
|
+
| Status code | Description | Response headers |
|
|
1736
|
+
|-------------|-------------|------------------|
|
|
1737
|
+
|**200** | OK | - |
|
|
1738
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1739
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
1740
|
+
|**404** | The requested resource was not found. | - |
|
|
1741
|
+
|**500** | An internal server error occurred. | - |
|
|
1742
|
+
|
|
1743
|
+
[[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)
|
|
1744
|
+
|
|
1745
|
+
# **publishFile**
|
|
1746
|
+
> SuccessResponseString publishFile()
|
|
1747
|
+
|
|
1748
|
+
Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
1749
|
+
|
|
1750
|
+
### Example
|
|
1751
|
+
|
|
1752
|
+
```typescript
|
|
1753
|
+
import {
|
|
1754
|
+
WebpagesApi,
|
|
1755
|
+
Configuration
|
|
1756
|
+
} from '@caraer/client';
|
|
1757
|
+
|
|
1758
|
+
const configuration = new Configuration();
|
|
1759
|
+
const apiInstance = new WebpagesApi(configuration);
|
|
1760
|
+
|
|
1761
|
+
let uuid: string; // (default to undefined)
|
|
1762
|
+
let key: string; // (default to undefined)
|
|
1763
|
+
|
|
1764
|
+
const { status, data } = await apiInstance.publishFile(
|
|
1765
|
+
uuid,
|
|
1766
|
+
key
|
|
1767
|
+
);
|
|
1768
|
+
```
|
|
1769
|
+
|
|
1770
|
+
### Parameters
|
|
1771
|
+
|
|
1772
|
+
|Name | Type | Description | Notes|
|
|
1773
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1774
|
+
| **uuid** | [**string**] | | defaults to undefined|
|
|
1775
|
+
| **key** | [**string**] | | defaults to undefined|
|
|
1776
|
+
|
|
1777
|
+
|
|
1778
|
+
### Return type
|
|
1779
|
+
|
|
1780
|
+
**SuccessResponseString**
|
|
1781
|
+
|
|
1782
|
+
### Authorization
|
|
1783
|
+
|
|
1784
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1785
|
+
|
|
1786
|
+
### HTTP request headers
|
|
1787
|
+
|
|
1788
|
+
- **Content-Type**: Not defined
|
|
1789
|
+
- **Accept**: application/json
|
|
1790
|
+
|
|
1791
|
+
|
|
1792
|
+
### HTTP response details
|
|
1793
|
+
| Status code | Description | Response headers |
|
|
1794
|
+
|-------------|-------------|------------------|
|
|
1795
|
+
|**200** | OK | - |
|
|
1796
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1797
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
1798
|
+
|**404** | The requested resource was not found. | - |
|
|
1799
|
+
|**500** | An internal server error occurred. | - |
|
|
1800
|
+
|
|
1801
|
+
[[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)
|
|
1802
|
+
|
|
1803
|
+
# **publishFile1**
|
|
1804
|
+
> SuccessResponseString publishFile1()
|
|
1805
|
+
|
|
1806
|
+
Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
1807
|
+
|
|
1808
|
+
### Example
|
|
1809
|
+
|
|
1810
|
+
```typescript
|
|
1811
|
+
import {
|
|
1812
|
+
WebpagesApi,
|
|
1813
|
+
Configuration
|
|
1814
|
+
} from '@caraer/client';
|
|
1815
|
+
|
|
1816
|
+
const configuration = new Configuration();
|
|
1817
|
+
const apiInstance = new WebpagesApi(configuration);
|
|
1818
|
+
|
|
1819
|
+
let key: string; // (default to undefined)
|
|
1820
|
+
|
|
1821
|
+
const { status, data } = await apiInstance.publishFile1(
|
|
1822
|
+
key
|
|
1823
|
+
);
|
|
1824
|
+
```
|
|
1825
|
+
|
|
1826
|
+
### Parameters
|
|
1827
|
+
|
|
1828
|
+
|Name | Type | Description | Notes|
|
|
1829
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1830
|
+
| **key** | [**string**] | | defaults to undefined|
|
|
1831
|
+
|
|
1832
|
+
|
|
1833
|
+
### Return type
|
|
1834
|
+
|
|
1835
|
+
**SuccessResponseString**
|
|
1836
|
+
|
|
1837
|
+
### Authorization
|
|
1838
|
+
|
|
1839
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1840
|
+
|
|
1841
|
+
### HTTP request headers
|
|
1842
|
+
|
|
1843
|
+
- **Content-Type**: Not defined
|
|
1844
|
+
- **Accept**: application/json
|
|
1845
|
+
|
|
1846
|
+
|
|
1732
1847
|
### HTTP response details
|
|
1733
1848
|
| Status code | Description | Response headers |
|
|
1734
1849
|
|-------------|-------------|------------------|
|