@caraer/client 2.0.512 → 2.0.514

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 CHANGED
@@ -2577,9 +2577,9 @@ export const EventRsvpRequestScopeEnum = {
2577
2577
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2578
2578
 
2579
2579
  export interface ExistingWidgetSummary {
2580
- 'ymetric'?: string;
2581
2580
  'yproperty'?: string;
2582
2581
  'xproperty'?: string;
2582
+ 'ymetric'?: string;
2583
2583
  'title'?: string;
2584
2584
  'chartType'?: string;
2585
2585
  'xProperty'?: string;
@@ -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; };
@@ -5687,8 +5687,8 @@ export interface SettingField {
5687
5687
  'hidden'?: boolean;
5688
5688
  'disabled'?: boolean;
5689
5689
  'options'?: Array<SettingOption>;
5690
- 'value'?: any;
5691
5690
  'defaultValue'?: any;
5691
+ 'value'?: any;
5692
5692
  }
5693
5693
 
5694
5694
  export const SettingFieldTypeEnum = {
@@ -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,47 @@ export const WebpagesApiAxiosParamCreator = function (configuration?: Configurat
32404
32404
  options: localVarRequestOptions,
32405
32405
  };
32406
32406
  },
32407
+ /**
32408
+ * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
32409
+ * @summary Public URL for a library file
32410
+ * @param {string} key
32411
+ * @param {*} [options] Override http request option.
32412
+ * @throws {RequiredError}
32413
+ */
32414
+ publishFile: async (key: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
32415
+ // verify required parameter 'key' is not null or undefined
32416
+ assertParamExists('publishFile', 'key', key)
32417
+ const localVarPath = `/api/v2/webpages/publishFile`;
32418
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
32419
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
32420
+ let baseOptions;
32421
+ if (configuration) {
32422
+ baseOptions = configuration.baseOptions;
32423
+ }
32424
+
32425
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
32426
+ const localVarHeaderParameter = {} as any;
32427
+ const localVarQueryParameter = {} as any;
32428
+
32429
+ // authentication bearerAuth required
32430
+ // http bearer authentication required
32431
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
32432
+
32433
+ if (key !== undefined) {
32434
+ localVarQueryParameter['key'] = key;
32435
+ }
32436
+
32437
+ localVarHeaderParameter['Accept'] = 'application/json';
32438
+
32439
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
32440
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
32441
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
32442
+
32443
+ return {
32444
+ url: toPathString(localVarUrlObj),
32445
+ options: localVarRequestOptions,
32446
+ };
32447
+ },
32407
32448
  /**
32408
32449
  * 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
32450
  * @summary Publish a webpage
@@ -33244,6 +33285,19 @@ export const WebpagesApiFp = function(configuration?: Configuration) {
33244
33285
  const localVarOperationServerBasePath = operationServerMap['WebpagesApi.listProtectionGrants']?.[localVarOperationServerIndex]?.url;
33245
33286
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
33246
33287
  },
33288
+ /**
33289
+ * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
33290
+ * @summary Public URL for a library file
33291
+ * @param {string} key
33292
+ * @param {*} [options] Override http request option.
33293
+ * @throws {RequiredError}
33294
+ */
33295
+ async publishFile(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseString>> {
33296
+ const localVarAxiosArgs = await localVarAxiosParamCreator.publishFile(key, options);
33297
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
33298
+ const localVarOperationServerBasePath = operationServerMap['WebpagesApi.publishFile']?.[localVarOperationServerIndex]?.url;
33299
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
33300
+ },
33247
33301
  /**
33248
33302
  * 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
33303
  * @summary Publish a webpage
@@ -33723,6 +33777,16 @@ export const WebpagesApiFactory = function (configuration?: Configuration, baseP
33723
33777
  listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponseWebpageAccessGrantDTO> {
33724
33778
  return localVarFp.listProtectionGrants(uuid, environment, options).then((request) => request(axios, basePath));
33725
33779
  },
33780
+ /**
33781
+ * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
33782
+ * @summary Public URL for a library file
33783
+ * @param {string} key
33784
+ * @param {*} [options] Override http request option.
33785
+ * @throws {RequiredError}
33786
+ */
33787
+ publishFile(key: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString> {
33788
+ return localVarFp.publishFile(key, options).then((request) => request(axios, basePath));
33789
+ },
33726
33790
  /**
33727
33791
  * 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
33792
  * @summary Publish a webpage
@@ -34200,6 +34264,17 @@ export class WebpagesApi extends BaseAPI {
34200
34264
  return WebpagesApiFp(this.configuration).listProtectionGrants(uuid, environment, options).then((request) => request(this.axios, this.basePath));
34201
34265
  }
34202
34266
 
34267
+ /**
34268
+ * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
34269
+ * @summary Public URL for a library file
34270
+ * @param {string} key
34271
+ * @param {*} [options] Override http request option.
34272
+ * @throws {RequiredError}
34273
+ */
34274
+ public publishFile(key: string, options?: RawAxiosRequestConfig) {
34275
+ return WebpagesApiFp(this.configuration).publishFile(key, options).then((request) => request(this.axios, this.basePath));
34276
+ }
34277
+
34203
34278
  /**
34204
34279
  * 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
34280
  * @summary Publish a webpage
package/dist/api.d.ts CHANGED
@@ -2567,9 +2567,9 @@ export declare const EventRsvpRequestScopeEnum: {
2567
2567
  };
2568
2568
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2569
2569
  export interface ExistingWidgetSummary {
2570
- 'ymetric'?: string;
2571
2570
  'yproperty'?: string;
2572
2571
  'xproperty'?: string;
2572
+ 'ymetric'?: string;
2573
2573
  'title'?: string;
2574
2574
  'chartType'?: string;
2575
2575
  'xProperty'?: string;
@@ -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'?: {
@@ -5737,8 +5737,8 @@ export interface SettingField {
5737
5737
  'hidden'?: boolean;
5738
5738
  'disabled'?: boolean;
5739
5739
  'options'?: Array<SettingOption>;
5740
- 'value'?: any;
5741
5740
  'defaultValue'?: any;
5741
+ 'value'?: any;
5742
5742
  }
5743
5743
  export declare const SettingFieldTypeEnum: {
5744
5744
  readonly String: "STRING";
@@ -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,14 @@ 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
+ * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
19292
+ * @summary Public URL for a library file
19293
+ * @param {string} key
19294
+ * @param {*} [options] Override http request option.
19295
+ * @throws {RequiredError}
19296
+ */
19297
+ publishFile: (key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19290
19298
  /**
19291
19299
  * 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
19300
  * @summary Publish a webpage
@@ -19663,6 +19671,14 @@ export declare const WebpagesApiFp: (configuration?: Configuration) => {
19663
19671
  * @throws {RequiredError}
19664
19672
  */
19665
19673
  listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponseWebpageAccessGrantDTO>>;
19674
+ /**
19675
+ * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
19676
+ * @summary Public URL for a library file
19677
+ * @param {string} key
19678
+ * @param {*} [options] Override http request option.
19679
+ * @throws {RequiredError}
19680
+ */
19681
+ publishFile(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseString>>;
19666
19682
  /**
19667
19683
  * 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
19684
  * @summary Publish a webpage
@@ -20039,6 +20055,14 @@ export declare const WebpagesApiFactory: (configuration?: Configuration, basePat
20039
20055
  * @throws {RequiredError}
20040
20056
  */
20041
20057
  listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponseWebpageAccessGrantDTO>;
20058
+ /**
20059
+ * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
20060
+ * @summary Public URL for a library file
20061
+ * @param {string} key
20062
+ * @param {*} [options] Override http request option.
20063
+ * @throws {RequiredError}
20064
+ */
20065
+ publishFile(key: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString>;
20042
20066
  /**
20043
20067
  * 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
20068
  * @summary Publish a webpage
@@ -20415,6 +20439,14 @@ export declare class WebpagesApi extends BaseAPI {
20415
20439
  * @throws {RequiredError}
20416
20440
  */
20417
20441
  listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginationResponseWebpageAccessGrantDTO, any, {}>>;
20442
+ /**
20443
+ * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
20444
+ * @summary Public URL for a library file
20445
+ * @param {string} key
20446
+ * @param {*} [options] Override http request option.
20447
+ * @throws {RequiredError}
20448
+ */
20449
+ publishFile(key: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseString, any, {}>>;
20418
20450
  /**
20419
20451
  * 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
20452
  * @summary Publish a webpage
package/dist/api.js CHANGED
@@ -23188,6 +23188,41 @@ const WebpagesApiAxiosParamCreator = function (configuration) {
23188
23188
  options: localVarRequestOptions,
23189
23189
  };
23190
23190
  }),
23191
+ /**
23192
+ * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
23193
+ * @summary Public URL for a library file
23194
+ * @param {string} key
23195
+ * @param {*} [options] Override http request option.
23196
+ * @throws {RequiredError}
23197
+ */
23198
+ publishFile: (key_1, ...args_1) => __awaiter(this, [key_1, ...args_1], void 0, function* (key, options = {}) {
23199
+ // verify required parameter 'key' is not null or undefined
23200
+ (0, common_1.assertParamExists)('publishFile', 'key', key);
23201
+ const localVarPath = `/api/v2/webpages/publishFile`;
23202
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
23203
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
23204
+ let baseOptions;
23205
+ if (configuration) {
23206
+ baseOptions = configuration.baseOptions;
23207
+ }
23208
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
23209
+ const localVarHeaderParameter = {};
23210
+ const localVarQueryParameter = {};
23211
+ // authentication bearerAuth required
23212
+ // http bearer authentication required
23213
+ yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
23214
+ if (key !== undefined) {
23215
+ localVarQueryParameter['key'] = key;
23216
+ }
23217
+ localVarHeaderParameter['Accept'] = 'application/json';
23218
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
23219
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
23220
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
23221
+ return {
23222
+ url: (0, common_1.toPathString)(localVarUrlObj),
23223
+ options: localVarRequestOptions,
23224
+ };
23225
+ }),
23191
23226
  /**
23192
23227
  * 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
23228
  * @summary Publish a webpage
@@ -24057,6 +24092,22 @@ const WebpagesApiFp = function (configuration) {
24057
24092
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24058
24093
  });
24059
24094
  },
24095
+ /**
24096
+ * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
24097
+ * @summary Public URL for a library file
24098
+ * @param {string} key
24099
+ * @param {*} [options] Override http request option.
24100
+ * @throws {RequiredError}
24101
+ */
24102
+ publishFile(key, options) {
24103
+ return __awaiter(this, void 0, void 0, function* () {
24104
+ var _a, _b, _c;
24105
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.publishFile(key, options);
24106
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
24107
+ 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;
24108
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24109
+ });
24110
+ },
24060
24111
  /**
24061
24112
  * 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
24113
  * @summary Publish a webpage
@@ -24563,6 +24614,16 @@ const WebpagesApiFactory = function (configuration, basePath, axios) {
24563
24614
  listProtectionGrants(uuid, environment, options) {
24564
24615
  return localVarFp.listProtectionGrants(uuid, environment, options).then((request) => request(axios, basePath));
24565
24616
  },
24617
+ /**
24618
+ * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
24619
+ * @summary Public URL for a library file
24620
+ * @param {string} key
24621
+ * @param {*} [options] Override http request option.
24622
+ * @throws {RequiredError}
24623
+ */
24624
+ publishFile(key, options) {
24625
+ return localVarFp.publishFile(key, options).then((request) => request(axios, basePath));
24626
+ },
24566
24627
  /**
24567
24628
  * 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
24629
  * @summary Publish a webpage
@@ -25013,6 +25074,16 @@ class WebpagesApi extends base_1.BaseAPI {
25013
25074
  listProtectionGrants(uuid, environment, options) {
25014
25075
  return (0, exports.WebpagesApiFp)(this.configuration).listProtectionGrants(uuid, environment, options).then((request) => request(this.axios, this.basePath));
25015
25076
  }
25077
+ /**
25078
+ * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
25079
+ * @summary Public URL for a library file
25080
+ * @param {string} key
25081
+ * @param {*} [options] Override http request option.
25082
+ * @throws {RequiredError}
25083
+ */
25084
+ publishFile(key, options) {
25085
+ return (0, exports.WebpagesApiFp)(this.configuration).publishFile(key, options).then((request) => request(this.axios, this.basePath));
25086
+ }
25016
25087
  /**
25017
25088
  * 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
25089
  * @summary Publish a webpage
package/dist/esm/api.d.ts CHANGED
@@ -2567,9 +2567,9 @@ export declare const EventRsvpRequestScopeEnum: {
2567
2567
  };
2568
2568
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2569
2569
  export interface ExistingWidgetSummary {
2570
- 'ymetric'?: string;
2571
2570
  'yproperty'?: string;
2572
2571
  'xproperty'?: string;
2572
+ 'ymetric'?: string;
2573
2573
  'title'?: string;
2574
2574
  'chartType'?: string;
2575
2575
  'xProperty'?: string;
@@ -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'?: {
@@ -5737,8 +5737,8 @@ export interface SettingField {
5737
5737
  'hidden'?: boolean;
5738
5738
  'disabled'?: boolean;
5739
5739
  'options'?: Array<SettingOption>;
5740
- 'value'?: any;
5741
5740
  'defaultValue'?: any;
5741
+ 'value'?: any;
5742
5742
  }
5743
5743
  export declare const SettingFieldTypeEnum: {
5744
5744
  readonly String: "STRING";
@@ -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,14 @@ 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
+ * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
19292
+ * @summary Public URL for a library file
19293
+ * @param {string} key
19294
+ * @param {*} [options] Override http request option.
19295
+ * @throws {RequiredError}
19296
+ */
19297
+ publishFile: (key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19290
19298
  /**
19291
19299
  * 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
19300
  * @summary Publish a webpage
@@ -19663,6 +19671,14 @@ export declare const WebpagesApiFp: (configuration?: Configuration) => {
19663
19671
  * @throws {RequiredError}
19664
19672
  */
19665
19673
  listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponseWebpageAccessGrantDTO>>;
19674
+ /**
19675
+ * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
19676
+ * @summary Public URL for a library file
19677
+ * @param {string} key
19678
+ * @param {*} [options] Override http request option.
19679
+ * @throws {RequiredError}
19680
+ */
19681
+ publishFile(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseString>>;
19666
19682
  /**
19667
19683
  * 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
19684
  * @summary Publish a webpage
@@ -20039,6 +20055,14 @@ export declare const WebpagesApiFactory: (configuration?: Configuration, basePat
20039
20055
  * @throws {RequiredError}
20040
20056
  */
20041
20057
  listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponseWebpageAccessGrantDTO>;
20058
+ /**
20059
+ * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
20060
+ * @summary Public URL for a library file
20061
+ * @param {string} key
20062
+ * @param {*} [options] Override http request option.
20063
+ * @throws {RequiredError}
20064
+ */
20065
+ publishFile(key: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString>;
20042
20066
  /**
20043
20067
  * 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
20068
  * @summary Publish a webpage
@@ -20415,6 +20439,14 @@ export declare class WebpagesApi extends BaseAPI {
20415
20439
  * @throws {RequiredError}
20416
20440
  */
20417
20441
  listProtectionGrants(uuid: string, environment?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginationResponseWebpageAccessGrantDTO, any, {}>>;
20442
+ /**
20443
+ * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
20444
+ * @summary Public URL for a library file
20445
+ * @param {string} key
20446
+ * @param {*} [options] Override http request option.
20447
+ * @throws {RequiredError}
20448
+ */
20449
+ publishFile(key: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseString, any, {}>>;
20418
20450
  /**
20419
20451
  * 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
20452
  * @summary Publish a webpage
package/dist/esm/api.js CHANGED
@@ -23062,6 +23062,41 @@ export const WebpagesApiAxiosParamCreator = function (configuration) {
23062
23062
  options: localVarRequestOptions,
23063
23063
  };
23064
23064
  }),
23065
+ /**
23066
+ * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
23067
+ * @summary Public URL for a library file
23068
+ * @param {string} key
23069
+ * @param {*} [options] Override http request option.
23070
+ * @throws {RequiredError}
23071
+ */
23072
+ publishFile: (key_1, ...args_1) => __awaiter(this, [key_1, ...args_1], void 0, function* (key, options = {}) {
23073
+ // verify required parameter 'key' is not null or undefined
23074
+ assertParamExists('publishFile', 'key', key);
23075
+ const localVarPath = `/api/v2/webpages/publishFile`;
23076
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
23077
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
23078
+ let baseOptions;
23079
+ if (configuration) {
23080
+ baseOptions = configuration.baseOptions;
23081
+ }
23082
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
23083
+ const localVarHeaderParameter = {};
23084
+ const localVarQueryParameter = {};
23085
+ // authentication bearerAuth required
23086
+ // http bearer authentication required
23087
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
23088
+ if (key !== undefined) {
23089
+ localVarQueryParameter['key'] = key;
23090
+ }
23091
+ localVarHeaderParameter['Accept'] = 'application/json';
23092
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
23093
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
23094
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
23095
+ return {
23096
+ url: toPathString(localVarUrlObj),
23097
+ options: localVarRequestOptions,
23098
+ };
23099
+ }),
23065
23100
  /**
23066
23101
  * 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
23102
  * @summary Publish a webpage
@@ -23930,6 +23965,22 @@ export const WebpagesApiFp = function (configuration) {
23930
23965
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
23931
23966
  });
23932
23967
  },
23968
+ /**
23969
+ * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
23970
+ * @summary Public URL for a library file
23971
+ * @param {string} key
23972
+ * @param {*} [options] Override http request option.
23973
+ * @throws {RequiredError}
23974
+ */
23975
+ publishFile(key, options) {
23976
+ return __awaiter(this, void 0, void 0, function* () {
23977
+ var _a, _b, _c;
23978
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.publishFile(key, options);
23979
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
23980
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['WebpagesApi.publishFile']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
23981
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
23982
+ });
23983
+ },
23933
23984
  /**
23934
23985
  * 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
23986
  * @summary Publish a webpage
@@ -24435,6 +24486,16 @@ export const WebpagesApiFactory = function (configuration, basePath, axios) {
24435
24486
  listProtectionGrants(uuid, environment, options) {
24436
24487
  return localVarFp.listProtectionGrants(uuid, environment, options).then((request) => request(axios, basePath));
24437
24488
  },
24489
+ /**
24490
+ * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
24491
+ * @summary Public URL for a library file
24492
+ * @param {string} key
24493
+ * @param {*} [options] Override http request option.
24494
+ * @throws {RequiredError}
24495
+ */
24496
+ publishFile(key, options) {
24497
+ return localVarFp.publishFile(key, options).then((request) => request(axios, basePath));
24498
+ },
24438
24499
  /**
24439
24500
  * 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
24501
  * @summary Publish a webpage
@@ -24884,6 +24945,16 @@ export class WebpagesApi extends BaseAPI {
24884
24945
  listProtectionGrants(uuid, environment, options) {
24885
24946
  return WebpagesApiFp(this.configuration).listProtectionGrants(uuid, environment, options).then((request) => request(this.axios, this.basePath));
24886
24947
  }
24948
+ /**
24949
+ * Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
24950
+ * @summary Public URL for a library file
24951
+ * @param {string} key
24952
+ * @param {*} [options] Override http request option.
24953
+ * @throws {RequiredError}
24954
+ */
24955
+ publishFile(key, options) {
24956
+ return WebpagesApiFp(this.configuration).publishFile(key, options).then((request) => request(this.axios, this.basePath));
24957
+ }
24887
24958
  /**
24888
24959
  * 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
24960
  * @summary Publish a webpage
@@ -5,9 +5,9 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **ymetric** | **string** | | [optional] [default to undefined]
9
8
  **yproperty** | **string** | | [optional] [default to undefined]
10
9
  **xproperty** | **string** | | [optional] [default to undefined]
10
+ **ymetric** | **string** | | [optional] [default to undefined]
11
11
  **title** | **string** | | [optional] [default to undefined]
12
12
  **chartType** | **string** | | [optional] [default to undefined]
13
13
  **xProperty** | **string** | | [optional] [default to undefined]
@@ -20,9 +20,9 @@ Name | Type | Description | Notes
20
20
  import { ExistingWidgetSummary } from '@caraer/client';
21
21
 
22
22
  const instance: ExistingWidgetSummary = {
23
- ymetric,
24
23
  yproperty,
25
24
  xproperty,
25
+ ymetric,
26
26
  title,
27
27
  chartType,
28
28
  xProperty,
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&lt;FilledProperty&gt;**](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,
@@ -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&lt;SettingOption&gt;**](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
 
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
  ```
@@ -31,6 +31,7 @@ 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/publishFile | Public URL for a library file|
34
35
  |[**publishWebpage**](#publishwebpage) | **PUT** /api/v2/webpages/{uuid}/publish | Publish a webpage|
35
36
  |[**releaseTemplateWebpageEditingSession**](#releasetemplatewebpageeditingsession) | **DELETE** /api/v2/webpages/template/{objectName}/{environment}/editing-session | Release a template webpage editing session|
36
37
  |[**releaseWebpageEditingSession**](#releasewebpageeditingsession) | **DELETE** /api/v2/webpages/{uuid}/editing-session | Release a webpage editing session|
@@ -1729,6 +1730,61 @@ const { status, data } = await apiInstance.listProtectionGrants(
1729
1730
  - **Accept**: application/json
1730
1731
 
1731
1732
 
1733
+ ### HTTP response details
1734
+ | Status code | Description | Response headers |
1735
+ |-------------|-------------|------------------|
1736
+ |**200** | OK | - |
1737
+ |**401** | Authentication is required or the token is invalid. | - |
1738
+ |**403** | The caller is missing a required role or scope. | - |
1739
+ |**404** | The requested resource was not found. | - |
1740
+ |**500** | An internal server error occurred. | - |
1741
+
1742
+ [[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)
1743
+
1744
+ # **publishFile**
1745
+ > SuccessResponseString publishFile()
1746
+
1747
+ Makes an existing company file public and returns its stable public URL. The file is not copied and is not tied to a webpage.
1748
+
1749
+ ### Example
1750
+
1751
+ ```typescript
1752
+ import {
1753
+ WebpagesApi,
1754
+ Configuration
1755
+ } from '@caraer/client';
1756
+
1757
+ const configuration = new Configuration();
1758
+ const apiInstance = new WebpagesApi(configuration);
1759
+
1760
+ let key: string; // (default to undefined)
1761
+
1762
+ const { status, data } = await apiInstance.publishFile(
1763
+ key
1764
+ );
1765
+ ```
1766
+
1767
+ ### Parameters
1768
+
1769
+ |Name | Type | Description | Notes|
1770
+ |------------- | ------------- | ------------- | -------------|
1771
+ | **key** | [**string**] | | defaults to undefined|
1772
+
1773
+
1774
+ ### Return type
1775
+
1776
+ **SuccessResponseString**
1777
+
1778
+ ### Authorization
1779
+
1780
+ [bearerAuth](../README.md#bearerAuth)
1781
+
1782
+ ### HTTP request headers
1783
+
1784
+ - **Content-Type**: Not defined
1785
+ - **Accept**: application/json
1786
+
1787
+
1732
1788
  ### HTTP response details
1733
1789
  | Status code | Description | Response headers |
1734
1790
  |-------------|-------------|------------------|
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@caraer/client",
3
- "version": "2.0.512",
3
+ "version": "2.0.514",
4
4
  "description": "Generated TypeScript client for the Caraer API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {