@caraer/client 2.0.576 → 2.0.583
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +1 -0
- package/.openapi-generator-ignore +2 -0
- package/README.md +33 -1
- package/api.ts +279 -33
- package/dist/api.d.ts +148 -24
- package/dist/api.js +264 -33
- package/dist/esm/api.d.ts +148 -24
- package/dist/esm/api.js +257 -30
- package/docs/AppSettingFieldSchema.md +2 -0
- package/docs/ApplicationsApi.md +1 -1
- package/docs/CMSV2PublicApi.md +4 -1
- package/docs/CMSWebsiteUpdatesApi.md +159 -0
- package/docs/ExistingWidgetSummary.md +2 -2
- package/docs/PropertyApi.md +1 -1
- package/docs/RecordDTO.md +1 -1
- package/docs/RecordsApi.md +4 -4
- package/docs/WebpageDTO.md +4 -0
- package/docs/WebsiteSettingsDTO.md +2 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Generated TypeScript client (axios) for the [Caraer API](https://v2.api.caraer.com).
|
|
4
4
|
|
|
5
|
-
This repository is regenerated automatically from the production OpenAPI spec after each Caraer backend production deploy.
|
|
5
|
+
This repository is regenerated automatically from the production OpenAPI spec after each Caraer backend production deploy. Hand-written serverless payload helpers in `apps.ts` are preserved across regenerations.
|
|
6
6
|
|
|
7
7
|
## Install
|
|
8
8
|
|
|
@@ -20,6 +20,38 @@ npm install @caraer/client
|
|
|
20
20
|
|
|
21
21
|
Configure the generated axios client with a Bearer token (see generated `configuration` helpers after the first codegen publish).
|
|
22
22
|
|
|
23
|
+
## Serverless app payload types
|
|
24
|
+
|
|
25
|
+
Import typed helpers for lifecycle / webhook / schedule / inbound / job bodies
|
|
26
|
+
(instead of running `caraer apps typegen`):
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
import type {
|
|
30
|
+
LifecyclePayload,
|
|
31
|
+
WebhookPayload,
|
|
32
|
+
SchedulePayload,
|
|
33
|
+
InboundPayload,
|
|
34
|
+
JobPayload,
|
|
35
|
+
SettingFieldValue,
|
|
36
|
+
} from "@caraer/client";
|
|
37
|
+
|
|
38
|
+
export const handler = async (req: { body: LifecyclePayload }, res: any) => {
|
|
39
|
+
const body = req.body;
|
|
40
|
+
// ...
|
|
41
|
+
};
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Plain JS (JSDoc):
|
|
45
|
+
|
|
46
|
+
```js
|
|
47
|
+
/**
|
|
48
|
+
* @param {import('@caraer/client').LifecyclePayload} body
|
|
49
|
+
*/
|
|
50
|
+
function onInstall(body) {
|
|
51
|
+
// ...
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
23
55
|
## License
|
|
24
56
|
|
|
25
57
|
See [LICENSE](LICENSE).
|
package/api.ts
CHANGED
|
@@ -995,6 +995,7 @@ export interface AppSettingFieldSchema {
|
|
|
995
995
|
'itemLabel'?: string;
|
|
996
996
|
'value'?: any;
|
|
997
997
|
'hasValue'?: boolean;
|
|
998
|
+
'clearValue'?: boolean;
|
|
998
999
|
'mappingValue'?: AppSettingFieldMappingStructure;
|
|
999
1000
|
'valueScope'?: string;
|
|
1000
1001
|
'settingsGroup'?: boolean;
|
|
@@ -2772,8 +2773,8 @@ export const EventRsvpRequestScopeEnum = {
|
|
|
2772
2773
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2773
2774
|
|
|
2774
2775
|
export interface ExistingWidgetSummary {
|
|
2775
|
-
'yproperty'?: string;
|
|
2776
2776
|
'xproperty'?: string;
|
|
2777
|
+
'yproperty'?: string;
|
|
2777
2778
|
'ymetric'?: string;
|
|
2778
2779
|
'title'?: string;
|
|
2779
2780
|
'chartType'?: string;
|
|
@@ -5338,7 +5339,7 @@ export interface RecordDTO {
|
|
|
5338
5339
|
*/
|
|
5339
5340
|
'index'?: number;
|
|
5340
5341
|
/**
|
|
5341
|
-
* Property values as a name→value map, or a LEGACY array of {name,type,value} objects (same shape as LEGACY GET responses).
|
|
5342
|
+
* Property values as a name→value map, or a LEGACY array of {name,type,value} objects (same shape as LEGACY GET responses). File properties accept existing company file keys/URLs, an inline upload object {fileName,contentBase64,contentType?}, or a base64 data URL. Bare base64 bytes require the object form with fileName. Multi-file properties also accept an ordered array mixing existing keys/URLs and inline uploads; semicolon-separated keys and null remain supported. Uploads are stored as ordinary file keys after authorization and property validation. File type and configured upload size limits apply; base64 text counts toward the request limit.
|
|
5342
5343
|
*/
|
|
5343
5344
|
'properties'?: { [key: string]: any | null; };
|
|
5344
5345
|
/**
|
|
@@ -8082,6 +8083,8 @@ export interface WebpageAccessGrantDTO {
|
|
|
8082
8083
|
* Data transfer object representing a webpage with its various states, properties, and associated form/versions
|
|
8083
8084
|
*/
|
|
8084
8085
|
export interface WebpageDTO {
|
|
8086
|
+
'canonicalUrl'?: string;
|
|
8087
|
+
'lastModified'?: string;
|
|
8085
8088
|
/**
|
|
8086
8089
|
* The environment of the webpage.
|
|
8087
8090
|
*/
|
|
@@ -8301,6 +8304,7 @@ export interface WebpageUnlockRequest {
|
|
|
8301
8304
|
export interface WebsiteSettingsDTO {
|
|
8302
8305
|
'subdomain'?: string;
|
|
8303
8306
|
'customDomain'?: string;
|
|
8307
|
+
'primaryEnvironment'?: string;
|
|
8304
8308
|
'recordType'?: string;
|
|
8305
8309
|
'recordValue'?: string;
|
|
8306
8310
|
'favicon'?: string;
|
|
@@ -10664,7 +10668,7 @@ export const ApplicationsApiAxiosParamCreator = function (configuration?: Config
|
|
|
10664
10668
|
};
|
|
10665
10669
|
},
|
|
10666
10670
|
/**
|
|
10667
|
-
* Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. On success, returns a PaginationResponse containing AppSummaryDTO objects.
|
|
10671
|
+
* Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. Unpublished public apps are visible only when the selected company is their creator. The native tools list includes only published apps. On success, returns a PaginationResponse containing AppSummaryDTO objects.
|
|
10668
10672
|
* @summary Retrieve a paginated list of applications
|
|
10669
10673
|
* @param {PaginationRequest} paginationRequest
|
|
10670
10674
|
* @param {string} [type]
|
|
@@ -11717,7 +11721,7 @@ export const ApplicationsApiFp = function(configuration?: Configuration) {
|
|
|
11717
11721
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11718
11722
|
},
|
|
11719
11723
|
/**
|
|
11720
|
-
* Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. On success, returns a PaginationResponse containing AppSummaryDTO objects.
|
|
11724
|
+
* Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. Unpublished public apps are visible only when the selected company is their creator. The native tools list includes only published apps. On success, returns a PaginationResponse containing AppSummaryDTO objects.
|
|
11721
11725
|
* @summary Retrieve a paginated list of applications
|
|
11722
11726
|
* @param {PaginationRequest} paginationRequest
|
|
11723
11727
|
* @param {string} [type]
|
|
@@ -12125,7 +12129,7 @@ export const ApplicationsApiFactory = function (configuration?: Configuration, b
|
|
|
12125
12129
|
return localVarFp.getAppWebhooks(appUuid, paginationRequest, options).then((request) => request(axios, basePath));
|
|
12126
12130
|
},
|
|
12127
12131
|
/**
|
|
12128
|
-
* Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. On success, returns a PaginationResponse containing AppSummaryDTO objects.
|
|
12132
|
+
* Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. Unpublished public apps are visible only when the selected company is their creator. The native tools list includes only published apps. On success, returns a PaginationResponse containing AppSummaryDTO objects.
|
|
12129
12133
|
* @summary Retrieve a paginated list of applications
|
|
12130
12134
|
* @param {PaginationRequest} paginationRequest
|
|
12131
12135
|
* @param {string} [type]
|
|
@@ -12474,7 +12478,7 @@ export class ApplicationsApi extends BaseAPI {
|
|
|
12474
12478
|
}
|
|
12475
12479
|
|
|
12476
12480
|
/**
|
|
12477
|
-
* Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. On success, returns a PaginationResponse containing AppSummaryDTO objects.
|
|
12481
|
+
* Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. Unpublished public apps are visible only when the selected company is their creator. The native tools list includes only published apps. On success, returns a PaginationResponse containing AppSummaryDTO objects.
|
|
12478
12482
|
* @summary Retrieve a paginated list of applications
|
|
12479
12483
|
* @param {PaginationRequest} paginationRequest
|
|
12480
12484
|
* @param {string} [type]
|
|
@@ -15865,10 +15869,11 @@ export const CMSV2PublicApiAxiosParamCreator = function (configuration?: Configu
|
|
|
15865
15869
|
*
|
|
15866
15870
|
* @summary Installed apps and modules for a company\'s website build
|
|
15867
15871
|
* @param {string} xCaraerSubdomain
|
|
15872
|
+
* @param {string} [channel]
|
|
15868
15873
|
* @param {*} [options] Override http request option.
|
|
15869
15874
|
* @throws {RequiredError}
|
|
15870
15875
|
*/
|
|
15871
|
-
buildManifest: async (xCaraerSubdomain: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
15876
|
+
buildManifest: async (xCaraerSubdomain: string, channel?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
15872
15877
|
// verify required parameter 'xCaraerSubdomain' is not null or undefined
|
|
15873
15878
|
assertParamExists('buildManifest', 'xCaraerSubdomain', xCaraerSubdomain)
|
|
15874
15879
|
const localVarPath = `/api/v2/webpages/v2/build/manifest`;
|
|
@@ -15887,6 +15892,10 @@ export const CMSV2PublicApiAxiosParamCreator = function (configuration?: Configu
|
|
|
15887
15892
|
// http bearer authentication required
|
|
15888
15893
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
15889
15894
|
|
|
15895
|
+
if (channel !== undefined) {
|
|
15896
|
+
localVarQueryParameter['channel'] = channel;
|
|
15897
|
+
}
|
|
15898
|
+
|
|
15890
15899
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
15891
15900
|
|
|
15892
15901
|
if (xCaraerSubdomain != null) {
|
|
@@ -16424,11 +16433,12 @@ export const CMSV2PublicApiFp = function(configuration?: Configuration) {
|
|
|
16424
16433
|
*
|
|
16425
16434
|
* @summary Installed apps and modules for a company\'s website build
|
|
16426
16435
|
* @param {string} xCaraerSubdomain
|
|
16436
|
+
* @param {string} [channel]
|
|
16427
16437
|
* @param {*} [options] Override http request option.
|
|
16428
16438
|
* @throws {RequiredError}
|
|
16429
16439
|
*/
|
|
16430
|
-
async buildManifest(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>> {
|
|
16431
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.buildManifest(xCaraerSubdomain, options);
|
|
16440
|
+
async buildManifest(xCaraerSubdomain: string, channel?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>> {
|
|
16441
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.buildManifest(xCaraerSubdomain, channel, options);
|
|
16432
16442
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
16433
16443
|
const localVarOperationServerBasePath = operationServerMap['CMSV2PublicApi.buildManifest']?.[localVarOperationServerIndex]?.url;
|
|
16434
16444
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -16612,11 +16622,12 @@ export const CMSV2PublicApiFactory = function (configuration?: Configuration, ba
|
|
|
16612
16622
|
*
|
|
16613
16623
|
* @summary Installed apps and modules for a company\'s website build
|
|
16614
16624
|
* @param {string} xCaraerSubdomain
|
|
16625
|
+
* @param {string} [channel]
|
|
16615
16626
|
* @param {*} [options] Override http request option.
|
|
16616
16627
|
* @throws {RequiredError}
|
|
16617
16628
|
*/
|
|
16618
|
-
buildManifest(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject> {
|
|
16619
|
-
return localVarFp.buildManifest(xCaraerSubdomain, options).then((request) => request(axios, basePath));
|
|
16629
|
+
buildManifest(xCaraerSubdomain: string, channel?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject> {
|
|
16630
|
+
return localVarFp.buildManifest(xCaraerSubdomain, channel, options).then((request) => request(axios, basePath));
|
|
16620
16631
|
},
|
|
16621
16632
|
/**
|
|
16622
16633
|
*
|
|
@@ -16773,11 +16784,12 @@ export class CMSV2PublicApi extends BaseAPI {
|
|
|
16773
16784
|
*
|
|
16774
16785
|
* @summary Installed apps and modules for a company\'s website build
|
|
16775
16786
|
* @param {string} xCaraerSubdomain
|
|
16787
|
+
* @param {string} [channel]
|
|
16776
16788
|
* @param {*} [options] Override http request option.
|
|
16777
16789
|
* @throws {RequiredError}
|
|
16778
16790
|
*/
|
|
16779
|
-
public buildManifest(xCaraerSubdomain: string, options?: RawAxiosRequestConfig) {
|
|
16780
|
-
return CMSV2PublicApiFp(this.configuration).buildManifest(xCaraerSubdomain, options).then((request) => request(this.axios, this.basePath));
|
|
16791
|
+
public buildManifest(xCaraerSubdomain: string, channel?: string, options?: RawAxiosRequestConfig) {
|
|
16792
|
+
return CMSV2PublicApiFp(this.configuration).buildManifest(xCaraerSubdomain, channel, options).then((request) => request(this.axios, this.basePath));
|
|
16781
16793
|
}
|
|
16782
16794
|
|
|
16783
16795
|
/**
|
|
@@ -17231,6 +17243,240 @@ export class CMSV2TransferApi extends BaseAPI {
|
|
|
17231
17243
|
|
|
17232
17244
|
|
|
17233
17245
|
|
|
17246
|
+
/**
|
|
17247
|
+
* CMSWebsiteUpdatesApi - axios parameter creator
|
|
17248
|
+
*/
|
|
17249
|
+
export const CMSWebsiteUpdatesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
17250
|
+
return {
|
|
17251
|
+
/**
|
|
17252
|
+
*
|
|
17253
|
+
* @summary Pending module updates for this website
|
|
17254
|
+
* @param {*} [options] Override http request option.
|
|
17255
|
+
* @throws {RequiredError}
|
|
17256
|
+
*/
|
|
17257
|
+
pending: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
17258
|
+
const localVarPath = `/api/v2/webpages/v2/updates`;
|
|
17259
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17260
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17261
|
+
let baseOptions;
|
|
17262
|
+
if (configuration) {
|
|
17263
|
+
baseOptions = configuration.baseOptions;
|
|
17264
|
+
}
|
|
17265
|
+
|
|
17266
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
17267
|
+
const localVarHeaderParameter = {} as any;
|
|
17268
|
+
const localVarQueryParameter = {} as any;
|
|
17269
|
+
|
|
17270
|
+
// authentication bearerAuth required
|
|
17271
|
+
// http bearer authentication required
|
|
17272
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
17273
|
+
|
|
17274
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
17275
|
+
|
|
17276
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17277
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17278
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
17279
|
+
|
|
17280
|
+
return {
|
|
17281
|
+
url: toPathString(localVarUrlObj),
|
|
17282
|
+
options: localVarRequestOptions,
|
|
17283
|
+
};
|
|
17284
|
+
},
|
|
17285
|
+
/**
|
|
17286
|
+
*
|
|
17287
|
+
* @summary Build a preview site with every pending module update
|
|
17288
|
+
* @param {*} [options] Override http request option.
|
|
17289
|
+
* @throws {RequiredError}
|
|
17290
|
+
*/
|
|
17291
|
+
preview: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
17292
|
+
const localVarPath = `/api/v2/webpages/v2/updates/preview`;
|
|
17293
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17294
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17295
|
+
let baseOptions;
|
|
17296
|
+
if (configuration) {
|
|
17297
|
+
baseOptions = configuration.baseOptions;
|
|
17298
|
+
}
|
|
17299
|
+
|
|
17300
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
17301
|
+
const localVarHeaderParameter = {} as any;
|
|
17302
|
+
const localVarQueryParameter = {} as any;
|
|
17303
|
+
|
|
17304
|
+
// authentication bearerAuth required
|
|
17305
|
+
// http bearer authentication required
|
|
17306
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
17307
|
+
|
|
17308
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
17309
|
+
|
|
17310
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17311
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17312
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
17313
|
+
|
|
17314
|
+
return {
|
|
17315
|
+
url: toPathString(localVarUrlObj),
|
|
17316
|
+
options: localVarRequestOptions,
|
|
17317
|
+
};
|
|
17318
|
+
},
|
|
17319
|
+
/**
|
|
17320
|
+
* Rejected with 409 when the preview revision is no longer the current pending set.
|
|
17321
|
+
* @summary Promote a previewed module set to production
|
|
17322
|
+
* @param {{ [key: string]: any | null; }} [requestBody]
|
|
17323
|
+
* @param {*} [options] Override http request option.
|
|
17324
|
+
* @throws {RequiredError}
|
|
17325
|
+
*/
|
|
17326
|
+
promote: async (requestBody?: { [key: string]: any | null; }, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
17327
|
+
const localVarPath = `/api/v2/webpages/v2/updates/promote`;
|
|
17328
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17329
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17330
|
+
let baseOptions;
|
|
17331
|
+
if (configuration) {
|
|
17332
|
+
baseOptions = configuration.baseOptions;
|
|
17333
|
+
}
|
|
17334
|
+
|
|
17335
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
17336
|
+
const localVarHeaderParameter = {} as any;
|
|
17337
|
+
const localVarQueryParameter = {} as any;
|
|
17338
|
+
|
|
17339
|
+
// authentication bearerAuth required
|
|
17340
|
+
// http bearer authentication required
|
|
17341
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
17342
|
+
|
|
17343
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
17344
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
17345
|
+
|
|
17346
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17347
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17348
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
17349
|
+
localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration)
|
|
17350
|
+
|
|
17351
|
+
return {
|
|
17352
|
+
url: toPathString(localVarUrlObj),
|
|
17353
|
+
options: localVarRequestOptions,
|
|
17354
|
+
};
|
|
17355
|
+
},
|
|
17356
|
+
}
|
|
17357
|
+
};
|
|
17358
|
+
|
|
17359
|
+
/**
|
|
17360
|
+
* CMSWebsiteUpdatesApi - functional programming interface
|
|
17361
|
+
*/
|
|
17362
|
+
export const CMSWebsiteUpdatesApiFp = function(configuration?: Configuration) {
|
|
17363
|
+
const localVarAxiosParamCreator = CMSWebsiteUpdatesApiAxiosParamCreator(configuration)
|
|
17364
|
+
return {
|
|
17365
|
+
/**
|
|
17366
|
+
*
|
|
17367
|
+
* @summary Pending module updates for this website
|
|
17368
|
+
* @param {*} [options] Override http request option.
|
|
17369
|
+
* @throws {RequiredError}
|
|
17370
|
+
*/
|
|
17371
|
+
async pending(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>> {
|
|
17372
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.pending(options);
|
|
17373
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
17374
|
+
const localVarOperationServerBasePath = operationServerMap['CMSWebsiteUpdatesApi.pending']?.[localVarOperationServerIndex]?.url;
|
|
17375
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17376
|
+
},
|
|
17377
|
+
/**
|
|
17378
|
+
*
|
|
17379
|
+
* @summary Build a preview site with every pending module update
|
|
17380
|
+
* @param {*} [options] Override http request option.
|
|
17381
|
+
* @throws {RequiredError}
|
|
17382
|
+
*/
|
|
17383
|
+
async preview(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>> {
|
|
17384
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.preview(options);
|
|
17385
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
17386
|
+
const localVarOperationServerBasePath = operationServerMap['CMSWebsiteUpdatesApi.preview']?.[localVarOperationServerIndex]?.url;
|
|
17387
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17388
|
+
},
|
|
17389
|
+
/**
|
|
17390
|
+
* Rejected with 409 when the preview revision is no longer the current pending set.
|
|
17391
|
+
* @summary Promote a previewed module set to production
|
|
17392
|
+
* @param {{ [key: string]: any | null; }} [requestBody]
|
|
17393
|
+
* @param {*} [options] Override http request option.
|
|
17394
|
+
* @throws {RequiredError}
|
|
17395
|
+
*/
|
|
17396
|
+
async promote(requestBody?: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>> {
|
|
17397
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.promote(requestBody, options);
|
|
17398
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
17399
|
+
const localVarOperationServerBasePath = operationServerMap['CMSWebsiteUpdatesApi.promote']?.[localVarOperationServerIndex]?.url;
|
|
17400
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17401
|
+
},
|
|
17402
|
+
}
|
|
17403
|
+
};
|
|
17404
|
+
|
|
17405
|
+
/**
|
|
17406
|
+
* CMSWebsiteUpdatesApi - factory interface
|
|
17407
|
+
*/
|
|
17408
|
+
export const CMSWebsiteUpdatesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
17409
|
+
const localVarFp = CMSWebsiteUpdatesApiFp(configuration)
|
|
17410
|
+
return {
|
|
17411
|
+
/**
|
|
17412
|
+
*
|
|
17413
|
+
* @summary Pending module updates for this website
|
|
17414
|
+
* @param {*} [options] Override http request option.
|
|
17415
|
+
* @throws {RequiredError}
|
|
17416
|
+
*/
|
|
17417
|
+
pending(options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject> {
|
|
17418
|
+
return localVarFp.pending(options).then((request) => request(axios, basePath));
|
|
17419
|
+
},
|
|
17420
|
+
/**
|
|
17421
|
+
*
|
|
17422
|
+
* @summary Build a preview site with every pending module update
|
|
17423
|
+
* @param {*} [options] Override http request option.
|
|
17424
|
+
* @throws {RequiredError}
|
|
17425
|
+
*/
|
|
17426
|
+
preview(options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject> {
|
|
17427
|
+
return localVarFp.preview(options).then((request) => request(axios, basePath));
|
|
17428
|
+
},
|
|
17429
|
+
/**
|
|
17430
|
+
* Rejected with 409 when the preview revision is no longer the current pending set.
|
|
17431
|
+
* @summary Promote a previewed module set to production
|
|
17432
|
+
* @param {{ [key: string]: any | null; }} [requestBody]
|
|
17433
|
+
* @param {*} [options] Override http request option.
|
|
17434
|
+
* @throws {RequiredError}
|
|
17435
|
+
*/
|
|
17436
|
+
promote(requestBody?: { [key: string]: any | null; }, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject> {
|
|
17437
|
+
return localVarFp.promote(requestBody, options).then((request) => request(axios, basePath));
|
|
17438
|
+
},
|
|
17439
|
+
};
|
|
17440
|
+
};
|
|
17441
|
+
|
|
17442
|
+
/**
|
|
17443
|
+
* CMSWebsiteUpdatesApi - object-oriented interface
|
|
17444
|
+
*/
|
|
17445
|
+
export class CMSWebsiteUpdatesApi extends BaseAPI {
|
|
17446
|
+
/**
|
|
17447
|
+
*
|
|
17448
|
+
* @summary Pending module updates for this website
|
|
17449
|
+
* @param {*} [options] Override http request option.
|
|
17450
|
+
* @throws {RequiredError}
|
|
17451
|
+
*/
|
|
17452
|
+
public pending(options?: RawAxiosRequestConfig) {
|
|
17453
|
+
return CMSWebsiteUpdatesApiFp(this.configuration).pending(options).then((request) => request(this.axios, this.basePath));
|
|
17454
|
+
}
|
|
17455
|
+
|
|
17456
|
+
/**
|
|
17457
|
+
*
|
|
17458
|
+
* @summary Build a preview site with every pending module update
|
|
17459
|
+
* @param {*} [options] Override http request option.
|
|
17460
|
+
* @throws {RequiredError}
|
|
17461
|
+
*/
|
|
17462
|
+
public preview(options?: RawAxiosRequestConfig) {
|
|
17463
|
+
return CMSWebsiteUpdatesApiFp(this.configuration).preview(options).then((request) => request(this.axios, this.basePath));
|
|
17464
|
+
}
|
|
17465
|
+
|
|
17466
|
+
/**
|
|
17467
|
+
* Rejected with 409 when the preview revision is no longer the current pending set.
|
|
17468
|
+
* @summary Promote a previewed module set to production
|
|
17469
|
+
* @param {{ [key: string]: any | null; }} [requestBody]
|
|
17470
|
+
* @param {*} [options] Override http request option.
|
|
17471
|
+
* @throws {RequiredError}
|
|
17472
|
+
*/
|
|
17473
|
+
public promote(requestBody?: { [key: string]: any | null; }, options?: RawAxiosRequestConfig) {
|
|
17474
|
+
return CMSWebsiteUpdatesApiFp(this.configuration).promote(requestBody, options).then((request) => request(this.axios, this.basePath));
|
|
17475
|
+
}
|
|
17476
|
+
}
|
|
17477
|
+
|
|
17478
|
+
|
|
17479
|
+
|
|
17234
17480
|
/**
|
|
17235
17481
|
* CalendarsApi - axios parameter creator
|
|
17236
17482
|
*/
|
|
@@ -24398,7 +24644,7 @@ export const PropertyApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
24398
24644
|
};
|
|
24399
24645
|
},
|
|
24400
24646
|
/**
|
|
24401
|
-
* Deletes the soft-deleted HAS_PROPERTY link to this object.
|
|
24647
|
+
* Deletes only the soft-deleted HAS_PROPERTY link to this object. Other object links and their stored values are preserved. If no object links remain, the property node and this object\'s stored field values are permanently deleted.
|
|
24402
24648
|
* @summary Permanently remove archived property
|
|
24403
24649
|
* @param {string} objectUuid
|
|
24404
24650
|
* @param {string} propertyUuid
|
|
@@ -24775,7 +25021,7 @@ export const PropertyApiFp = function(configuration?: Configuration) {
|
|
|
24775
25021
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24776
25022
|
},
|
|
24777
25023
|
/**
|
|
24778
|
-
* Deletes the soft-deleted HAS_PROPERTY link to this object.
|
|
25024
|
+
* Deletes only the soft-deleted HAS_PROPERTY link to this object. Other object links and their stored values are preserved. If no object links remain, the property node and this object\'s stored field values are permanently deleted.
|
|
24779
25025
|
* @summary Permanently remove archived property
|
|
24780
25026
|
* @param {string} objectUuid
|
|
24781
25027
|
* @param {string} propertyUuid
|
|
@@ -24955,7 +25201,7 @@ export const PropertyApiFactory = function (configuration?: Configuration, baseP
|
|
|
24955
25201
|
return localVarFp.getPropertyCalculationTypes(objectUuid, propertyUuid, options).then((request) => request(axios, basePath));
|
|
24956
25202
|
},
|
|
24957
25203
|
/**
|
|
24958
|
-
* Deletes the soft-deleted HAS_PROPERTY link to this object.
|
|
25204
|
+
* Deletes only the soft-deleted HAS_PROPERTY link to this object. Other object links and their stored values are preserved. If no object links remain, the property node and this object\'s stored field values are permanently deleted.
|
|
24959
25205
|
* @summary Permanently remove archived property
|
|
24960
25206
|
* @param {string} objectUuid
|
|
24961
25207
|
* @param {string} propertyUuid
|
|
@@ -25123,7 +25369,7 @@ export class PropertyApi extends BaseAPI {
|
|
|
25123
25369
|
}
|
|
25124
25370
|
|
|
25125
25371
|
/**
|
|
25126
|
-
* Deletes the soft-deleted HAS_PROPERTY link to this object.
|
|
25372
|
+
* Deletes only the soft-deleted HAS_PROPERTY link to this object. Other object links and their stored values are preserved. If no object links remain, the property node and this object\'s stored field values are permanently deleted.
|
|
25127
25373
|
* @summary Permanently remove archived property
|
|
25128
25374
|
* @param {string} objectUuid
|
|
25129
25375
|
* @param {string} propertyUuid
|
|
@@ -25908,15 +26154,15 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
25908
26154
|
* @param {string} uuid
|
|
25909
26155
|
* @param {string} name
|
|
25910
26156
|
* @param {string} [object] Optional object name used to resolve the record before building the preview.
|
|
25911
|
-
* @param {
|
|
26157
|
+
* @param {Preview1ParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
25912
26158
|
* @param {*} [options] Override http request option.
|
|
25913
26159
|
* @throws {RequiredError}
|
|
25914
26160
|
*/
|
|
25915
|
-
|
|
26161
|
+
preview1: async (uuid: string, name: string, object?: string, parse?: Preview1ParseEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25916
26162
|
// verify required parameter 'uuid' is not null or undefined
|
|
25917
|
-
assertParamExists('
|
|
26163
|
+
assertParamExists('preview1', 'uuid', uuid)
|
|
25918
26164
|
// verify required parameter 'name' is not null or undefined
|
|
25919
|
-
assertParamExists('
|
|
26165
|
+
assertParamExists('preview1', 'name', name)
|
|
25920
26166
|
const localVarPath = `/api/v2/records/{uuid}/previews/{name}`
|
|
25921
26167
|
.replace('{uuid}', encodeURIComponent(String(uuid)))
|
|
25922
26168
|
.replace('{name}', encodeURIComponent(String(name)));
|
|
@@ -26689,14 +26935,14 @@ export const RecordsApiFp = function(configuration?: Configuration) {
|
|
|
26689
26935
|
* @param {string} uuid
|
|
26690
26936
|
* @param {string} name
|
|
26691
26937
|
* @param {string} [object] Optional object name used to resolve the record before building the preview.
|
|
26692
|
-
* @param {
|
|
26938
|
+
* @param {Preview1ParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
26693
26939
|
* @param {*} [options] Override http request option.
|
|
26694
26940
|
* @throws {RequiredError}
|
|
26695
26941
|
*/
|
|
26696
|
-
async
|
|
26697
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
26942
|
+
async preview1(uuid: string, name: string, object?: string, parse?: Preview1ParseEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponsePreviewDTO>> {
|
|
26943
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.preview1(uuid, name, object, parse, options);
|
|
26698
26944
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
26699
|
-
const localVarOperationServerBasePath = operationServerMap['RecordsApi.
|
|
26945
|
+
const localVarOperationServerBasePath = operationServerMap['RecordsApi.preview1']?.[localVarOperationServerIndex]?.url;
|
|
26700
26946
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
26701
26947
|
},
|
|
26702
26948
|
/**
|
|
@@ -27042,12 +27288,12 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
|
|
|
27042
27288
|
* @param {string} uuid
|
|
27043
27289
|
* @param {string} name
|
|
27044
27290
|
* @param {string} [object] Optional object name used to resolve the record before building the preview.
|
|
27045
|
-
* @param {
|
|
27291
|
+
* @param {Preview1ParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27046
27292
|
* @param {*} [options] Override http request option.
|
|
27047
27293
|
* @throws {RequiredError}
|
|
27048
27294
|
*/
|
|
27049
|
-
|
|
27050
|
-
return localVarFp.
|
|
27295
|
+
preview1(uuid: string, name: string, object?: string, parse?: Preview1ParseEnum, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponsePreviewDTO> {
|
|
27296
|
+
return localVarFp.preview1(uuid, name, object, parse, options).then((request) => request(axios, basePath));
|
|
27051
27297
|
},
|
|
27052
27298
|
/**
|
|
27053
27299
|
* Executes a two-pass GraphRAG query using natural language or a declarative plan. Returns records with scores and graph evidence.
|
|
@@ -27374,12 +27620,12 @@ export class RecordsApi extends BaseAPI {
|
|
|
27374
27620
|
* @param {string} uuid
|
|
27375
27621
|
* @param {string} name
|
|
27376
27622
|
* @param {string} [object] Optional object name used to resolve the record before building the preview.
|
|
27377
|
-
* @param {
|
|
27623
|
+
* @param {Preview1ParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
|
|
27378
27624
|
* @param {*} [options] Override http request option.
|
|
27379
27625
|
* @throws {RequiredError}
|
|
27380
27626
|
*/
|
|
27381
|
-
public
|
|
27382
|
-
return RecordsApiFp(this.configuration).
|
|
27627
|
+
public preview1(uuid: string, name: string, object?: string, parse?: Preview1ParseEnum, options?: RawAxiosRequestConfig) {
|
|
27628
|
+
return RecordsApiFp(this.configuration).preview1(uuid, name, object, parse, options).then((request) => request(this.axios, this.basePath));
|
|
27383
27629
|
}
|
|
27384
27630
|
|
|
27385
27631
|
/**
|
|
@@ -27572,12 +27818,12 @@ export const IndexFlowParseEnum = {
|
|
|
27572
27818
|
Structured: 'STRUCTURED',
|
|
27573
27819
|
} as const;
|
|
27574
27820
|
export type IndexFlowParseEnum = typeof IndexFlowParseEnum[keyof typeof IndexFlowParseEnum];
|
|
27575
|
-
export const
|
|
27821
|
+
export const Preview1ParseEnum = {
|
|
27576
27822
|
Db: 'DB',
|
|
27577
27823
|
HumanReadable: 'HUMAN_READABLE',
|
|
27578
27824
|
Structured: 'STRUCTURED',
|
|
27579
27825
|
} as const;
|
|
27580
|
-
export type
|
|
27826
|
+
export type Preview1ParseEnum = typeof Preview1ParseEnum[keyof typeof Preview1ParseEnum];
|
|
27581
27827
|
export const SearchParseEnum = {
|
|
27582
27828
|
Db: 'DB',
|
|
27583
27829
|
HumanReadable: 'HUMAN_READABLE',
|