@remkoj/optimizely-cms-api 6.0.0-pre12 → 6.0.0-pre14
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/README.md +6 -2
- package/dist/api-client.js +2 -2
- package/dist/client/client/client.gen.js +26 -1
- package/dist/client/client/index.d.ts +1 -1
- package/dist/client/client/types.gen.d.ts +2 -9
- package/dist/client/client.gen.js +2 -4
- package/dist/client/core/params.gen.d.ts +10 -0
- package/dist/client/core/params.gen.js +17 -5
- package/dist/client/core/serverSentEvents.gen.js +2 -0
- package/dist/client/index.d.ts +4 -4
- package/dist/client/index.js +97 -17
- package/dist/client/sdk.gen.d.ts +188 -1
- package/dist/client/sdk.gen.js +482 -144
- package/dist/client/transformers.gen.d.ts +27 -1
- package/dist/client/transformers.gen.js +229 -29
- package/dist/client/types.gen.d.ts +1753 -29
- package/dist/client-config.js +1 -1
- package/dist/instance.client/client/client.gen.js +26 -1
- package/dist/instance.client/client/index.d.ts +1 -1
- package/dist/instance.client/client/types.gen.d.ts +2 -9
- package/dist/instance.client/client.gen.js +2 -4
- package/dist/instance.client/core/params.gen.d.ts +10 -0
- package/dist/instance.client/core/params.gen.js +17 -5
- package/dist/instance.client/core/serverSentEvents.gen.js +2 -0
- package/dist/instance.client/index.d.ts +4 -4
- package/dist/instance.client/index.js +86 -18
- package/dist/instance.client/sdk.gen.js +273 -405
- package/dist/instance.client/transformers.gen.d.ts +1 -15
- package/dist/instance.client/transformers.gen.js +26 -198
- package/dist/instance.client/types.gen.d.ts +48 -64
- package/dist/version.json +2 -2
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -1,7 +1,11 @@
|
|
|
1
|
+
# Optimizely CMS - Integration API Client <!-- omit in toc -->
|
|
2
|
+
|
|
3
|
+
> [!WARNING]
|
|
4
|
+
> There'll be an update of Optimizely SaaS CMS that is incompatible with all SDK versions prior to 5.1.6. If you don't upgrade, you will see empty pages (main website) and "Component not found" messages (preview).
|
|
5
|
+
|
|
1
6
|
[](./LICENSE)
|
|
2
7
|

|
|
3
8
|
|
|
4
|
-
# Optimizely CMS - Integration API Client <!-- omit in toc -->
|
|
5
9
|
A Javascript client for the Integration API provided by the Optimizely CMS. It wraps the [Optimizely CMS SaaS Core REST API](https://docs.developers.optimizely.com/content-management-system/v1.0.0-SaaS-Core/reference/introduction-to-the-cms-content-api).
|
|
6
10
|
|
|
7
11
|
## Installation
|
|
@@ -40,4 +44,4 @@ The following configuration options are available for
|
|
|
40
44
|
| OPTIMIZELY_CMS_URL | base | no | Sets the URL of the Optimizely CMS instance |
|
|
41
45
|
| OPTIMIZELY_CMS_CLIENT_ID | clientId | yes | The API Client ID, as configured within the CMS |
|
|
42
46
|
| OPTIMIZELY_CMS_CLIENT_SECRET | clientSecret | yes | The API Client Secret as generated by the CMS when creating the client |
|
|
43
|
-
| OPTIMIZELY_CMS_USER_ID | actAs | no | The username of the CMS user to impersonate |
|
|
47
|
+
| OPTIMIZELY_CMS_USER_ID | actAs | no | The username of the CMS user to impersonate |
|
package/dist/api-client.js
CHANGED
|
@@ -110,10 +110,10 @@ class BaseApiClient {
|
|
|
110
110
|
// Store instance variables
|
|
111
111
|
this._config = config ?? (0, config_1.readEnvConfig)();
|
|
112
112
|
this._client = (0, client_1.createClient)((0, client_config_1.createClientConfig)((0, client_1.createConfig)({
|
|
113
|
-
baseUrl: 'https://api.cms.optimizely.com/preview3'
|
|
113
|
+
baseUrl: 'https://api.cms.optimizely.com/preview3',
|
|
114
114
|
}), this._config));
|
|
115
115
|
this._instanceClient = (0, client_2.createClient)((0, client_config_1.createClientConfig)((0, client_2.createConfig)({
|
|
116
|
-
baseUrl: new URL('/_cms/preview2', this._config.base).href
|
|
116
|
+
baseUrl: new URL('/_cms/preview2', this._config.base).href,
|
|
117
117
|
})));
|
|
118
118
|
// Configure Client
|
|
119
119
|
if (this._config.debug) {
|
|
@@ -57,7 +57,31 @@ const createClient = (config = {}) => {
|
|
|
57
57
|
// fetch must be assigned here, otherwise it would throw the error:
|
|
58
58
|
// TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation
|
|
59
59
|
const _fetch = opts.fetch;
|
|
60
|
-
let response
|
|
60
|
+
let response;
|
|
61
|
+
try {
|
|
62
|
+
response = await _fetch(request);
|
|
63
|
+
}
|
|
64
|
+
catch (error) {
|
|
65
|
+
// Handle fetch exceptions (AbortError, network errors, etc.)
|
|
66
|
+
let finalError = error;
|
|
67
|
+
for (const fn of interceptors.error.fns) {
|
|
68
|
+
if (fn) {
|
|
69
|
+
finalError = (await fn(error, undefined, request, opts));
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
finalError = finalError || {};
|
|
73
|
+
if (opts.throwOnError) {
|
|
74
|
+
throw finalError;
|
|
75
|
+
}
|
|
76
|
+
// Return error response
|
|
77
|
+
return opts.responseStyle === 'data'
|
|
78
|
+
? undefined
|
|
79
|
+
: {
|
|
80
|
+
error: finalError,
|
|
81
|
+
request,
|
|
82
|
+
response: undefined,
|
|
83
|
+
};
|
|
84
|
+
}
|
|
61
85
|
for (const fn of interceptors.response.fns) {
|
|
62
86
|
if (fn) {
|
|
63
87
|
response = await fn(response, request, opts);
|
|
@@ -174,6 +198,7 @@ const createClient = (config = {}) => {
|
|
|
174
198
|
}
|
|
175
199
|
return request;
|
|
176
200
|
},
|
|
201
|
+
serializedBody: (0, utils_gen_1.getValidRequestBody)(opts),
|
|
177
202
|
url,
|
|
178
203
|
});
|
|
179
204
|
};
|
|
@@ -4,5 +4,5 @@ export { formDataBodySerializer, jsonBodySerializer, urlSearchParamsBodySerializ
|
|
|
4
4
|
export { buildClientParams } from '../core/params.gen';
|
|
5
5
|
export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen';
|
|
6
6
|
export { createClient } from './client.gen';
|
|
7
|
-
export type { Client, ClientOptions, Config, CreateClientConfig, Options,
|
|
7
|
+
export type { Client, ClientOptions, Config, CreateClientConfig, Options, RequestOptions, RequestResult, ResolvedRequestOptions, ResponseStyle, TDataShape, } from './types.gen';
|
|
8
8
|
export { createConfig, mergeHeaders } from './utils.gen';
|
|
@@ -92,7 +92,7 @@ type BuildUrlFn = <TData extends {
|
|
|
92
92
|
path?: Record<string, unknown>;
|
|
93
93
|
query?: Record<string, unknown>;
|
|
94
94
|
url: string;
|
|
95
|
-
}>(options:
|
|
95
|
+
}>(options: TData & Options<TData>) => string;
|
|
96
96
|
export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
|
|
97
97
|
interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
|
|
98
98
|
};
|
|
@@ -113,12 +113,5 @@ export interface TDataShape {
|
|
|
113
113
|
url: string;
|
|
114
114
|
}
|
|
115
115
|
type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
|
|
116
|
-
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & Omit<TData, 'url'
|
|
117
|
-
export type OptionsLegacyParser<TData = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = TData extends {
|
|
118
|
-
body?: any;
|
|
119
|
-
} ? TData extends {
|
|
120
|
-
headers?: any;
|
|
121
|
-
} ? OmitKeys<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'body' | 'headers' | 'url'> & TData : OmitKeys<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'body' | 'url'> & TData & Pick<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'headers'> : TData extends {
|
|
122
|
-
headers?: any;
|
|
123
|
-
} ? OmitKeys<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'headers' | 'url'> & TData & Pick<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'body'> : OmitKeys<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'url'> & TData;
|
|
116
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
|
|
124
117
|
export {};
|
|
@@ -2,8 +2,6 @@
|
|
|
2
2
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.client = void 0;
|
|
5
|
-
const client_1 = require("./client");
|
|
6
5
|
const client_config_1 = require("../client-config");
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
})));
|
|
6
|
+
const client_1 = require("./client");
|
|
7
|
+
exports.client = (0, client_1.createClient)((0, client_config_1.createClientConfig)((0, client_1.createConfig)({ baseUrl: 'https://api.cms.optimizely.com/preview3' })));
|
|
@@ -17,6 +17,16 @@ export type Field = {
|
|
|
17
17
|
*/
|
|
18
18
|
key?: string;
|
|
19
19
|
map?: string;
|
|
20
|
+
} | {
|
|
21
|
+
/**
|
|
22
|
+
* Field name. This is the name we want the user to see and use.
|
|
23
|
+
*/
|
|
24
|
+
key: string;
|
|
25
|
+
/**
|
|
26
|
+
* Field mapped name. This is the name we want to use in the request.
|
|
27
|
+
* If `in` is omitted, `map` aliases `key` to the transport layer.
|
|
28
|
+
*/
|
|
29
|
+
map: Slot;
|
|
20
30
|
};
|
|
21
31
|
export interface Fields {
|
|
22
32
|
allowExtra?: Partial<Record<Slot, boolean>>;
|
|
@@ -22,6 +22,11 @@ const buildKeyMap = (fields, map) => {
|
|
|
22
22
|
});
|
|
23
23
|
}
|
|
24
24
|
}
|
|
25
|
+
else if ('key' in config) {
|
|
26
|
+
map.set(config.key, {
|
|
27
|
+
map: config.map,
|
|
28
|
+
});
|
|
29
|
+
}
|
|
25
30
|
else if (config.args) {
|
|
26
31
|
buildKeyMap(config.args, map);
|
|
27
32
|
}
|
|
@@ -55,7 +60,9 @@ const buildClientParams = (args, fields) => {
|
|
|
55
60
|
if (config.key) {
|
|
56
61
|
const field = map.get(config.key);
|
|
57
62
|
const name = field.map || config.key;
|
|
58
|
-
|
|
63
|
+
if (field.in) {
|
|
64
|
+
params[field.in][name] = arg;
|
|
65
|
+
}
|
|
59
66
|
}
|
|
60
67
|
else {
|
|
61
68
|
params.body = arg;
|
|
@@ -65,8 +72,13 @@ const buildClientParams = (args, fields) => {
|
|
|
65
72
|
for (const [key, value] of Object.entries(arg ?? {})) {
|
|
66
73
|
const field = map.get(key);
|
|
67
74
|
if (field) {
|
|
68
|
-
|
|
69
|
-
|
|
75
|
+
if (field.in) {
|
|
76
|
+
const name = field.map || key;
|
|
77
|
+
params[field.in][name] = value;
|
|
78
|
+
}
|
|
79
|
+
else {
|
|
80
|
+
params[field.map] = value;
|
|
81
|
+
}
|
|
70
82
|
}
|
|
71
83
|
else {
|
|
72
84
|
const extra = extraPrefixes.find(([prefix]) => key.startsWith(prefix));
|
|
@@ -74,8 +86,8 @@ const buildClientParams = (args, fields) => {
|
|
|
74
86
|
const [prefix, slot] = extra;
|
|
75
87
|
params[slot][key.slice(prefix.length)] = value;
|
|
76
88
|
}
|
|
77
|
-
else {
|
|
78
|
-
for (const [slot, allowed] of Object.entries(config.allowExtra
|
|
89
|
+
else if ('allowExtra' in config && config.allowExtra) {
|
|
90
|
+
for (const [slot, allowed] of Object.entries(config.allowExtra)) {
|
|
79
91
|
if (allowed) {
|
|
80
92
|
params[slot][key] = value;
|
|
81
93
|
break;
|
|
@@ -59,6 +59,8 @@ const createSseClient = ({ onRequest, onSseError, onSseEvent, responseTransforme
|
|
|
59
59
|
if (done)
|
|
60
60
|
break;
|
|
61
61
|
buffer += value;
|
|
62
|
+
// Normalize line endings: CRLF -> LF, then CR -> LF
|
|
63
|
+
buffer = buffer.replace(/\r\n/g, '\n').replace(/\r/g, '\n');
|
|
62
64
|
const chunks = buffer.split('\n\n');
|
|
63
65
|
buffer = chunks.pop() ?? '';
|
|
64
66
|
for (const chunk of chunks) {
|
package/dist/client/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export type
|
|
2
|
-
export
|
|
3
|
-
export
|
|
4
|
-
export
|
|
1
|
+
export { client, type CreateClientConfig } from './client.gen';
|
|
2
|
+
export { blueprintsCreate, blueprintsDelete, blueprintsGet, blueprintsList, blueprintsPatch, changesetsCreate, changesetsCreateItem, changesetsDelete, changesetsDeleteItem, changesetsGet, changesetsGetItem, changesetsList, changesetsListItems, changesetsPatch, changesetsPatchItem, contentCopy, contentCreate, contentCreateVersion, contentDelete, contentDeleteLocale, contentDeleteVersion, contentGetMetadata, contentGetPath, contentGetVersion, contentListAllVersions, contentListAssets, contentListItems, contentListVersions, contentPatchMetadata, contentPatchVersion, contentTypesCreate, contentTypesDelete, contentTypesGet, contentTypesList, contentTypesPatch, contentUndelete, displayTemplatesCreate, displayTemplatesDelete, displayTemplatesGet, displayTemplatesList, displayTemplatesPatch, type Options, propertyFormatsGet, propertyFormatsList, propertyGroupsCreate, propertyGroupsDelete, propertyGroupsGet, propertyGroupsList, propertyGroupsPatch } from './sdk.gen';
|
|
3
|
+
export { blueprintsCreateResponseTransformer, blueprintsDeleteResponseTransformer, blueprintsGetResponseTransformer, blueprintsListResponseTransformer, blueprintsPatchResponseTransformer, changesetsCreateResponseTransformer, changesetsDeleteResponseTransformer, changesetsGetResponseTransformer, changesetsListResponseTransformer, changesetsPatchResponseTransformer, contentCopyResponseTransformer, contentCreateResponseTransformer, contentCreateVersionResponseTransformer, contentDeleteLocaleResponseTransformer, contentDeleteResponseTransformer, contentDeleteVersionResponseTransformer, contentGetMetadataResponseTransformer, contentGetPathResponseTransformer, contentGetVersionResponseTransformer, contentListAllVersionsResponseTransformer, contentListAssetsResponseTransformer, contentListItemsResponseTransformer, contentListVersionsResponseTransformer, contentPatchMetadataResponseTransformer, contentPatchVersionResponseTransformer, contentTypesCreateResponseTransformer, contentTypesDeleteResponseTransformer, contentTypesGetResponseTransformer, contentTypesListResponseTransformer, contentTypesPatchResponseTransformer, contentUndeleteResponseTransformer, displayTemplatesCreateResponseTransformer, displayTemplatesDeleteResponseTransformer, displayTemplatesGetResponseTransformer, displayTemplatesListResponseTransformer, displayTemplatesPatchResponseTransformer, propertyFormatsGetResponseTransformer, propertyFormatsListResponseTransformer, propertyGroupsCreateResponseTransformer, propertyGroupsDeleteResponseTransformer, propertyGroupsGetResponseTransformer, propertyGroupsListResponseTransformer, propertyGroupsPatchResponseTransformer } from './transformers.gen';
|
|
4
|
+
export type { ArrayItem, Blueprint, BlueprintData, BlueprintDataWritable, BlueprintPage, BlueprintPageWritable, BlueprintsCreateData, BlueprintsCreateError, BlueprintsCreateErrors, BlueprintsCreateResponse, BlueprintsCreateResponses, BlueprintsDeleteData, BlueprintsDeleteError, BlueprintsDeleteErrors, BlueprintsDeleteResponse, BlueprintsDeleteResponses, BlueprintsGetData, BlueprintsGetError, BlueprintsGetErrors, BlueprintsGetResponse, BlueprintsGetResponses, BlueprintsListData, BlueprintsListError, BlueprintsListErrors, BlueprintsListResponse, BlueprintsListResponses, BlueprintsPatchData, BlueprintsPatchError, BlueprintsPatchErrors, BlueprintsPatchResponse, BlueprintsPatchResponses, BlueprintWritable, Changeset, ChangesetItem, ChangesetItemPage, ChangesetItemPageWritable, ChangesetItemWritable, ChangesetPage, ChangesetPageWritable, ChangesetsCreateData, ChangesetsCreateError, ChangesetsCreateErrors, ChangesetsCreateItemData, ChangesetsCreateItemError, ChangesetsCreateItemErrors, ChangesetsCreateItemResponse, ChangesetsCreateItemResponses, ChangesetsCreateResponse, ChangesetsCreateResponses, ChangesetsDeleteData, ChangesetsDeleteError, ChangesetsDeleteErrors, ChangesetsDeleteItemData, ChangesetsDeleteItemError, ChangesetsDeleteItemErrors, ChangesetsDeleteItemResponse, ChangesetsDeleteItemResponses, ChangesetsDeleteResponse, ChangesetsDeleteResponses, ChangesetsGetData, ChangesetsGetError, ChangesetsGetErrors, ChangesetsGetItemData, ChangesetsGetItemError, ChangesetsGetItemErrors, ChangesetsGetItemResponse, ChangesetsGetItemResponses, ChangesetsGetResponse, ChangesetsGetResponses, ChangesetsListData, ChangesetsListError, ChangesetsListErrors, ChangesetsListItemsData, ChangesetsListItemsError, ChangesetsListItemsErrors, ChangesetsListItemsResponse, ChangesetsListItemsResponses, ChangesetsListResponse, ChangesetsListResponses, ChangesetsPatchData, ChangesetsPatchError, ChangesetsPatchErrors, ChangesetsPatchItemData, ChangesetsPatchItemError, ChangesetsPatchItemErrors, ChangesetsPatchItemResponse, ChangesetsPatchItemResponses, ChangesetsPatchResponse, ChangesetsPatchResponses, ChangesetWritable, ClientOptions, CompositionDisplaySettings, CompositionDisplaySettingsWritable, CompositionNode, CompositionNodeWritable, ContentComponent, ContentCopyData, ContentCopyError, ContentCopyErrors, ContentCopyResponse, ContentCopyResponses, ContentCreateData, ContentCreateError, ContentCreateErrors, ContentCreateResponse, ContentCreateResponses, ContentCreateVersionData, ContentCreateVersionError, ContentCreateVersionErrors, ContentCreateVersionResponse, ContentCreateVersionResponses, ContentDeleteData, ContentDeleteError, ContentDeleteErrors, ContentDeleteLocaleData, ContentDeleteLocaleError, ContentDeleteLocaleErrors, ContentDeleteLocaleResponse, ContentDeleteLocaleResponses, ContentDeleteResponse, ContentDeleteResponses, ContentDeleteVersionData, ContentDeleteVersionError, ContentDeleteVersionErrors, ContentDeleteVersionResponse, ContentDeleteVersionResponses, ContentGetMetadataData, ContentGetMetadataError, ContentGetMetadataErrors, ContentGetMetadataResponse, ContentGetMetadataResponses, ContentGetPathData, ContentGetPathError, ContentGetPathErrors, ContentGetPathResponse, ContentGetPathResponses, ContentGetVersionData, ContentGetVersionError, ContentGetVersionErrors, ContentGetVersionResponse, ContentGetVersionResponses, ContentItem, ContentItemPage, ContentItemPageWritable, ContentItemWritable, ContentListAllVersionsData, ContentListAllVersionsError, ContentListAllVersionsErrors, ContentListAllVersionsResponse, ContentListAllVersionsResponses, ContentListAssetsData, ContentListAssetsError, ContentListAssetsErrors, ContentListAssetsResponse, ContentListAssetsResponses, ContentListItemsData, ContentListItemsError, ContentListItemsErrors, ContentListItemsResponse, ContentListItemsResponses, ContentListVersionsData, ContentListVersionsError, ContentListVersionsErrors, ContentListVersionsResponse, ContentListVersionsResponses, ContentLocaleInfo, ContentMetadata, ContentMetadataPage, ContentMetadataPageWritable, ContentMetadataWritable, ContentPatchMetadataData, ContentPatchMetadataError, ContentPatchMetadataErrors, ContentPatchMetadataResponse, ContentPatchMetadataResponses, ContentPatchVersionData, ContentPatchVersionError, ContentPatchVersionErrors, ContentPatchVersionResponse, ContentPatchVersionResponses, ContentReference, ContentType, ContentTypePage, ContentTypePageWritable, ContentTypeProperty, ContentTypesCreateData, ContentTypesCreateError, ContentTypesCreateErrors, ContentTypesCreateResponse, ContentTypesCreateResponses, ContentTypesDeleteData, ContentTypesDeleteError, ContentTypesDeleteErrors, ContentTypesDeleteResponse, ContentTypesDeleteResponses, ContentTypesGetData, ContentTypesGetError, ContentTypesGetErrors, ContentTypesGetResponse, ContentTypesGetResponses, ContentTypesListData, ContentTypesListError, ContentTypesListErrors, ContentTypesListResponse, ContentTypesListResponses, ContentTypesPatchData, ContentTypesPatchError, ContentTypesPatchErrors, ContentTypesPatchResponse, ContentTypesPatchResponses, ContentTypeWritable, ContentUndeleteData, ContentUndeleteError, ContentUndeleteErrors, ContentUndeleteResponse, ContentUndeleteResponses, CopyContentOptions, DisplaySetting, DisplaySettingChoice, DisplayTemplate, DisplayTemplatePage, DisplayTemplatePageWritable, DisplayTemplatesCreateData, DisplayTemplatesCreateError, DisplayTemplatesCreateErrors, DisplayTemplatesCreateResponse, DisplayTemplatesCreateResponses, DisplayTemplatesDeleteData, DisplayTemplatesDeleteError, DisplayTemplatesDeleteErrors, DisplayTemplatesDeleteResponse, DisplayTemplatesDeleteResponses, DisplayTemplatesGetData, DisplayTemplatesGetError, DisplayTemplatesGetErrors, DisplayTemplatesGetResponse, DisplayTemplatesGetResponses, DisplayTemplatesListData, DisplayTemplatesListError, DisplayTemplatesListErrors, DisplayTemplatesListResponse, DisplayTemplatesListResponses, DisplayTemplatesPatchData, DisplayTemplatesPatchError, DisplayTemplatesPatchErrors, DisplayTemplatesPatchResponse, DisplayTemplatesPatchResponses, DisplayTemplateWritable, EnumerationValue, ImageDescriptor, Link, ProblemDetails, PropertyFormat, PropertyFormatPage, PropertyFormatPageWritable, PropertyFormatsGetData, PropertyFormatsGetError, PropertyFormatsGetErrors, PropertyFormatsGetResponse, PropertyFormatsGetResponses, PropertyFormatsListData, PropertyFormatsListError, PropertyFormatsListErrors, PropertyFormatsListResponse, PropertyFormatsListResponses, PropertyFormatWritable, PropertyGroup, PropertyGroupPage, PropertyGroupPageWritable, PropertyGroupsCreateData, PropertyGroupsCreateError, PropertyGroupsCreateErrors, PropertyGroupsCreateResponse, PropertyGroupsCreateResponses, PropertyGroupsDeleteData, PropertyGroupsDeleteError, PropertyGroupsDeleteErrors, PropertyGroupsDeleteResponse, PropertyGroupsDeleteResponses, PropertyGroupsGetData, PropertyGroupsGetError, PropertyGroupsGetErrors, PropertyGroupsGetResponse, PropertyGroupsGetResponses, PropertyGroupsListData, PropertyGroupsListError, PropertyGroupsListErrors, PropertyGroupsListResponse, PropertyGroupsListResponses, PropertyGroupsPatchData, PropertyGroupsPatchError, PropertyGroupsPatchErrors, PropertyGroupsPatchResponse, PropertyGroupsPatchResponses, PropertyGroupWritable } from './types.gen';
|
package/dist/client/index.js
CHANGED
|
@@ -1,20 +1,100 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
3
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
-
if (k2 === undefined) k2 = k;
|
|
5
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
-
}
|
|
9
|
-
Object.defineProperty(o, k2, desc);
|
|
10
|
-
}) : (function(o, m, k, k2) {
|
|
11
|
-
if (k2 === undefined) k2 = k;
|
|
12
|
-
o[k2] = m[k];
|
|
13
|
-
}));
|
|
14
|
-
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
15
|
-
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
16
|
-
};
|
|
17
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
4
|
+
exports.blueprintsCreateResponseTransformer = exports.propertyGroupsPatch = exports.propertyGroupsList = exports.propertyGroupsGet = exports.propertyGroupsDelete = exports.propertyGroupsCreate = exports.propertyFormatsList = exports.propertyFormatsGet = exports.displayTemplatesPatch = exports.displayTemplatesList = exports.displayTemplatesGet = exports.displayTemplatesDelete = exports.displayTemplatesCreate = exports.contentUndelete = exports.contentTypesPatch = exports.contentTypesList = exports.contentTypesGet = exports.contentTypesDelete = exports.contentTypesCreate = exports.contentPatchVersion = exports.contentPatchMetadata = exports.contentListVersions = exports.contentListItems = exports.contentListAssets = exports.contentListAllVersions = exports.contentGetVersion = exports.contentGetPath = exports.contentGetMetadata = exports.contentDeleteVersion = exports.contentDeleteLocale = exports.contentDelete = exports.contentCreateVersion = exports.contentCreate = exports.contentCopy = exports.changesetsPatchItem = exports.changesetsPatch = exports.changesetsListItems = exports.changesetsList = exports.changesetsGetItem = exports.changesetsGet = exports.changesetsDeleteItem = exports.changesetsDelete = exports.changesetsCreateItem = exports.changesetsCreate = exports.blueprintsPatch = exports.blueprintsList = exports.blueprintsGet = exports.blueprintsDelete = exports.blueprintsCreate = exports.client = void 0;
|
|
5
|
+
exports.propertyGroupsPatchResponseTransformer = exports.propertyGroupsListResponseTransformer = exports.propertyGroupsGetResponseTransformer = exports.propertyGroupsDeleteResponseTransformer = exports.propertyGroupsCreateResponseTransformer = exports.propertyFormatsListResponseTransformer = exports.propertyFormatsGetResponseTransformer = exports.displayTemplatesPatchResponseTransformer = exports.displayTemplatesListResponseTransformer = exports.displayTemplatesGetResponseTransformer = exports.displayTemplatesDeleteResponseTransformer = exports.displayTemplatesCreateResponseTransformer = exports.contentUndeleteResponseTransformer = exports.contentTypesPatchResponseTransformer = exports.contentTypesListResponseTransformer = exports.contentTypesGetResponseTransformer = exports.contentTypesDeleteResponseTransformer = exports.contentTypesCreateResponseTransformer = exports.contentPatchVersionResponseTransformer = exports.contentPatchMetadataResponseTransformer = exports.contentListVersionsResponseTransformer = exports.contentListItemsResponseTransformer = exports.contentListAssetsResponseTransformer = exports.contentListAllVersionsResponseTransformer = exports.contentGetVersionResponseTransformer = exports.contentGetPathResponseTransformer = exports.contentGetMetadataResponseTransformer = exports.contentDeleteVersionResponseTransformer = exports.contentDeleteResponseTransformer = exports.contentDeleteLocaleResponseTransformer = exports.contentCreateVersionResponseTransformer = exports.contentCreateResponseTransformer = exports.contentCopyResponseTransformer = exports.changesetsPatchResponseTransformer = exports.changesetsListResponseTransformer = exports.changesetsGetResponseTransformer = exports.changesetsDeleteResponseTransformer = exports.changesetsCreateResponseTransformer = exports.blueprintsPatchResponseTransformer = exports.blueprintsListResponseTransformer = exports.blueprintsGetResponseTransformer = exports.blueprintsDeleteResponseTransformer = void 0;
|
|
6
|
+
var client_gen_1 = require("./client.gen");
|
|
7
|
+
Object.defineProperty(exports, "client", { enumerable: true, get: function () { return client_gen_1.client; } });
|
|
8
|
+
var sdk_gen_1 = require("./sdk.gen");
|
|
9
|
+
Object.defineProperty(exports, "blueprintsCreate", { enumerable: true, get: function () { return sdk_gen_1.blueprintsCreate; } });
|
|
10
|
+
Object.defineProperty(exports, "blueprintsDelete", { enumerable: true, get: function () { return sdk_gen_1.blueprintsDelete; } });
|
|
11
|
+
Object.defineProperty(exports, "blueprintsGet", { enumerable: true, get: function () { return sdk_gen_1.blueprintsGet; } });
|
|
12
|
+
Object.defineProperty(exports, "blueprintsList", { enumerable: true, get: function () { return sdk_gen_1.blueprintsList; } });
|
|
13
|
+
Object.defineProperty(exports, "blueprintsPatch", { enumerable: true, get: function () { return sdk_gen_1.blueprintsPatch; } });
|
|
14
|
+
Object.defineProperty(exports, "changesetsCreate", { enumerable: true, get: function () { return sdk_gen_1.changesetsCreate; } });
|
|
15
|
+
Object.defineProperty(exports, "changesetsCreateItem", { enumerable: true, get: function () { return sdk_gen_1.changesetsCreateItem; } });
|
|
16
|
+
Object.defineProperty(exports, "changesetsDelete", { enumerable: true, get: function () { return sdk_gen_1.changesetsDelete; } });
|
|
17
|
+
Object.defineProperty(exports, "changesetsDeleteItem", { enumerable: true, get: function () { return sdk_gen_1.changesetsDeleteItem; } });
|
|
18
|
+
Object.defineProperty(exports, "changesetsGet", { enumerable: true, get: function () { return sdk_gen_1.changesetsGet; } });
|
|
19
|
+
Object.defineProperty(exports, "changesetsGetItem", { enumerable: true, get: function () { return sdk_gen_1.changesetsGetItem; } });
|
|
20
|
+
Object.defineProperty(exports, "changesetsList", { enumerable: true, get: function () { return sdk_gen_1.changesetsList; } });
|
|
21
|
+
Object.defineProperty(exports, "changesetsListItems", { enumerable: true, get: function () { return sdk_gen_1.changesetsListItems; } });
|
|
22
|
+
Object.defineProperty(exports, "changesetsPatch", { enumerable: true, get: function () { return sdk_gen_1.changesetsPatch; } });
|
|
23
|
+
Object.defineProperty(exports, "changesetsPatchItem", { enumerable: true, get: function () { return sdk_gen_1.changesetsPatchItem; } });
|
|
24
|
+
Object.defineProperty(exports, "contentCopy", { enumerable: true, get: function () { return sdk_gen_1.contentCopy; } });
|
|
25
|
+
Object.defineProperty(exports, "contentCreate", { enumerable: true, get: function () { return sdk_gen_1.contentCreate; } });
|
|
26
|
+
Object.defineProperty(exports, "contentCreateVersion", { enumerable: true, get: function () { return sdk_gen_1.contentCreateVersion; } });
|
|
27
|
+
Object.defineProperty(exports, "contentDelete", { enumerable: true, get: function () { return sdk_gen_1.contentDelete; } });
|
|
28
|
+
Object.defineProperty(exports, "contentDeleteLocale", { enumerable: true, get: function () { return sdk_gen_1.contentDeleteLocale; } });
|
|
29
|
+
Object.defineProperty(exports, "contentDeleteVersion", { enumerable: true, get: function () { return sdk_gen_1.contentDeleteVersion; } });
|
|
30
|
+
Object.defineProperty(exports, "contentGetMetadata", { enumerable: true, get: function () { return sdk_gen_1.contentGetMetadata; } });
|
|
31
|
+
Object.defineProperty(exports, "contentGetPath", { enumerable: true, get: function () { return sdk_gen_1.contentGetPath; } });
|
|
32
|
+
Object.defineProperty(exports, "contentGetVersion", { enumerable: true, get: function () { return sdk_gen_1.contentGetVersion; } });
|
|
33
|
+
Object.defineProperty(exports, "contentListAllVersions", { enumerable: true, get: function () { return sdk_gen_1.contentListAllVersions; } });
|
|
34
|
+
Object.defineProperty(exports, "contentListAssets", { enumerable: true, get: function () { return sdk_gen_1.contentListAssets; } });
|
|
35
|
+
Object.defineProperty(exports, "contentListItems", { enumerable: true, get: function () { return sdk_gen_1.contentListItems; } });
|
|
36
|
+
Object.defineProperty(exports, "contentListVersions", { enumerable: true, get: function () { return sdk_gen_1.contentListVersions; } });
|
|
37
|
+
Object.defineProperty(exports, "contentPatchMetadata", { enumerable: true, get: function () { return sdk_gen_1.contentPatchMetadata; } });
|
|
38
|
+
Object.defineProperty(exports, "contentPatchVersion", { enumerable: true, get: function () { return sdk_gen_1.contentPatchVersion; } });
|
|
39
|
+
Object.defineProperty(exports, "contentTypesCreate", { enumerable: true, get: function () { return sdk_gen_1.contentTypesCreate; } });
|
|
40
|
+
Object.defineProperty(exports, "contentTypesDelete", { enumerable: true, get: function () { return sdk_gen_1.contentTypesDelete; } });
|
|
41
|
+
Object.defineProperty(exports, "contentTypesGet", { enumerable: true, get: function () { return sdk_gen_1.contentTypesGet; } });
|
|
42
|
+
Object.defineProperty(exports, "contentTypesList", { enumerable: true, get: function () { return sdk_gen_1.contentTypesList; } });
|
|
43
|
+
Object.defineProperty(exports, "contentTypesPatch", { enumerable: true, get: function () { return sdk_gen_1.contentTypesPatch; } });
|
|
44
|
+
Object.defineProperty(exports, "contentUndelete", { enumerable: true, get: function () { return sdk_gen_1.contentUndelete; } });
|
|
45
|
+
Object.defineProperty(exports, "displayTemplatesCreate", { enumerable: true, get: function () { return sdk_gen_1.displayTemplatesCreate; } });
|
|
46
|
+
Object.defineProperty(exports, "displayTemplatesDelete", { enumerable: true, get: function () { return sdk_gen_1.displayTemplatesDelete; } });
|
|
47
|
+
Object.defineProperty(exports, "displayTemplatesGet", { enumerable: true, get: function () { return sdk_gen_1.displayTemplatesGet; } });
|
|
48
|
+
Object.defineProperty(exports, "displayTemplatesList", { enumerable: true, get: function () { return sdk_gen_1.displayTemplatesList; } });
|
|
49
|
+
Object.defineProperty(exports, "displayTemplatesPatch", { enumerable: true, get: function () { return sdk_gen_1.displayTemplatesPatch; } });
|
|
50
|
+
Object.defineProperty(exports, "propertyFormatsGet", { enumerable: true, get: function () { return sdk_gen_1.propertyFormatsGet; } });
|
|
51
|
+
Object.defineProperty(exports, "propertyFormatsList", { enumerable: true, get: function () { return sdk_gen_1.propertyFormatsList; } });
|
|
52
|
+
Object.defineProperty(exports, "propertyGroupsCreate", { enumerable: true, get: function () { return sdk_gen_1.propertyGroupsCreate; } });
|
|
53
|
+
Object.defineProperty(exports, "propertyGroupsDelete", { enumerable: true, get: function () { return sdk_gen_1.propertyGroupsDelete; } });
|
|
54
|
+
Object.defineProperty(exports, "propertyGroupsGet", { enumerable: true, get: function () { return sdk_gen_1.propertyGroupsGet; } });
|
|
55
|
+
Object.defineProperty(exports, "propertyGroupsList", { enumerable: true, get: function () { return sdk_gen_1.propertyGroupsList; } });
|
|
56
|
+
Object.defineProperty(exports, "propertyGroupsPatch", { enumerable: true, get: function () { return sdk_gen_1.propertyGroupsPatch; } });
|
|
57
|
+
var transformers_gen_1 = require("./transformers.gen");
|
|
58
|
+
Object.defineProperty(exports, "blueprintsCreateResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.blueprintsCreateResponseTransformer; } });
|
|
59
|
+
Object.defineProperty(exports, "blueprintsDeleteResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.blueprintsDeleteResponseTransformer; } });
|
|
60
|
+
Object.defineProperty(exports, "blueprintsGetResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.blueprintsGetResponseTransformer; } });
|
|
61
|
+
Object.defineProperty(exports, "blueprintsListResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.blueprintsListResponseTransformer; } });
|
|
62
|
+
Object.defineProperty(exports, "blueprintsPatchResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.blueprintsPatchResponseTransformer; } });
|
|
63
|
+
Object.defineProperty(exports, "changesetsCreateResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.changesetsCreateResponseTransformer; } });
|
|
64
|
+
Object.defineProperty(exports, "changesetsDeleteResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.changesetsDeleteResponseTransformer; } });
|
|
65
|
+
Object.defineProperty(exports, "changesetsGetResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.changesetsGetResponseTransformer; } });
|
|
66
|
+
Object.defineProperty(exports, "changesetsListResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.changesetsListResponseTransformer; } });
|
|
67
|
+
Object.defineProperty(exports, "changesetsPatchResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.changesetsPatchResponseTransformer; } });
|
|
68
|
+
Object.defineProperty(exports, "contentCopyResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentCopyResponseTransformer; } });
|
|
69
|
+
Object.defineProperty(exports, "contentCreateResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentCreateResponseTransformer; } });
|
|
70
|
+
Object.defineProperty(exports, "contentCreateVersionResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentCreateVersionResponseTransformer; } });
|
|
71
|
+
Object.defineProperty(exports, "contentDeleteLocaleResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentDeleteLocaleResponseTransformer; } });
|
|
72
|
+
Object.defineProperty(exports, "contentDeleteResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentDeleteResponseTransformer; } });
|
|
73
|
+
Object.defineProperty(exports, "contentDeleteVersionResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentDeleteVersionResponseTransformer; } });
|
|
74
|
+
Object.defineProperty(exports, "contentGetMetadataResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentGetMetadataResponseTransformer; } });
|
|
75
|
+
Object.defineProperty(exports, "contentGetPathResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentGetPathResponseTransformer; } });
|
|
76
|
+
Object.defineProperty(exports, "contentGetVersionResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentGetVersionResponseTransformer; } });
|
|
77
|
+
Object.defineProperty(exports, "contentListAllVersionsResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentListAllVersionsResponseTransformer; } });
|
|
78
|
+
Object.defineProperty(exports, "contentListAssetsResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentListAssetsResponseTransformer; } });
|
|
79
|
+
Object.defineProperty(exports, "contentListItemsResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentListItemsResponseTransformer; } });
|
|
80
|
+
Object.defineProperty(exports, "contentListVersionsResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentListVersionsResponseTransformer; } });
|
|
81
|
+
Object.defineProperty(exports, "contentPatchMetadataResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentPatchMetadataResponseTransformer; } });
|
|
82
|
+
Object.defineProperty(exports, "contentPatchVersionResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentPatchVersionResponseTransformer; } });
|
|
83
|
+
Object.defineProperty(exports, "contentTypesCreateResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentTypesCreateResponseTransformer; } });
|
|
84
|
+
Object.defineProperty(exports, "contentTypesDeleteResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentTypesDeleteResponseTransformer; } });
|
|
85
|
+
Object.defineProperty(exports, "contentTypesGetResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentTypesGetResponseTransformer; } });
|
|
86
|
+
Object.defineProperty(exports, "contentTypesListResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentTypesListResponseTransformer; } });
|
|
87
|
+
Object.defineProperty(exports, "contentTypesPatchResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentTypesPatchResponseTransformer; } });
|
|
88
|
+
Object.defineProperty(exports, "contentUndeleteResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.contentUndeleteResponseTransformer; } });
|
|
89
|
+
Object.defineProperty(exports, "displayTemplatesCreateResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.displayTemplatesCreateResponseTransformer; } });
|
|
90
|
+
Object.defineProperty(exports, "displayTemplatesDeleteResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.displayTemplatesDeleteResponseTransformer; } });
|
|
91
|
+
Object.defineProperty(exports, "displayTemplatesGetResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.displayTemplatesGetResponseTransformer; } });
|
|
92
|
+
Object.defineProperty(exports, "displayTemplatesListResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.displayTemplatesListResponseTransformer; } });
|
|
93
|
+
Object.defineProperty(exports, "displayTemplatesPatchResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.displayTemplatesPatchResponseTransformer; } });
|
|
94
|
+
Object.defineProperty(exports, "propertyFormatsGetResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.propertyFormatsGetResponseTransformer; } });
|
|
95
|
+
Object.defineProperty(exports, "propertyFormatsListResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.propertyFormatsListResponseTransformer; } });
|
|
96
|
+
Object.defineProperty(exports, "propertyGroupsCreateResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.propertyGroupsCreateResponseTransformer; } });
|
|
97
|
+
Object.defineProperty(exports, "propertyGroupsDeleteResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.propertyGroupsDeleteResponseTransformer; } });
|
|
98
|
+
Object.defineProperty(exports, "propertyGroupsGetResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.propertyGroupsGetResponseTransformer; } });
|
|
99
|
+
Object.defineProperty(exports, "propertyGroupsListResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.propertyGroupsListResponseTransformer; } });
|
|
100
|
+
Object.defineProperty(exports, "propertyGroupsPatchResponseTransformer", { enumerable: true, get: function () { return transformers_gen_1.propertyGroupsPatchResponseTransformer; } });
|
package/dist/client/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Client, Options as Options2, TDataShape } from './client';
|
|
2
|
-
import type { ContentTypesCreateData, ContentTypesCreateErrors, ContentTypesCreateResponses, ContentTypesDeleteData, ContentTypesDeleteErrors, ContentTypesDeleteResponses, ContentTypesGetData, ContentTypesGetErrors, ContentTypesGetResponses, ContentTypesListData, ContentTypesListErrors, ContentTypesListResponses, ContentTypesPatchData, ContentTypesPatchErrors, ContentTypesPatchResponses, DisplayTemplatesCreateData, DisplayTemplatesCreateErrors, DisplayTemplatesCreateResponses, DisplayTemplatesDeleteData, DisplayTemplatesDeleteErrors, DisplayTemplatesDeleteResponses, DisplayTemplatesGetData, DisplayTemplatesGetErrors, DisplayTemplatesGetResponses, DisplayTemplatesListData, DisplayTemplatesListErrors, DisplayTemplatesListResponses, DisplayTemplatesPatchData, DisplayTemplatesPatchErrors, DisplayTemplatesPatchResponses, PropertyFormatsGetData, PropertyFormatsGetErrors, PropertyFormatsGetResponses, PropertyFormatsListData, PropertyFormatsListErrors, PropertyFormatsListResponses, PropertyGroupsCreateData, PropertyGroupsCreateErrors, PropertyGroupsCreateResponses, PropertyGroupsDeleteData, PropertyGroupsDeleteErrors, PropertyGroupsDeleteResponses, PropertyGroupsGetData, PropertyGroupsGetErrors, PropertyGroupsGetResponses, PropertyGroupsListData, PropertyGroupsListErrors, PropertyGroupsListResponses, PropertyGroupsPatchData, PropertyGroupsPatchErrors, PropertyGroupsPatchResponses } from './types.gen';
|
|
2
|
+
import type { BlueprintsCreateData, BlueprintsCreateErrors, BlueprintsCreateResponses, BlueprintsDeleteData, BlueprintsDeleteErrors, BlueprintsDeleteResponses, BlueprintsGetData, BlueprintsGetErrors, BlueprintsGetResponses, BlueprintsListData, BlueprintsListErrors, BlueprintsListResponses, BlueprintsPatchData, BlueprintsPatchErrors, BlueprintsPatchResponses, ChangesetsCreateData, ChangesetsCreateErrors, ChangesetsCreateItemData, ChangesetsCreateItemErrors, ChangesetsCreateItemResponses, ChangesetsCreateResponses, ChangesetsDeleteData, ChangesetsDeleteErrors, ChangesetsDeleteItemData, ChangesetsDeleteItemErrors, ChangesetsDeleteItemResponses, ChangesetsDeleteResponses, ChangesetsGetData, ChangesetsGetErrors, ChangesetsGetItemData, ChangesetsGetItemErrors, ChangesetsGetItemResponses, ChangesetsGetResponses, ChangesetsListData, ChangesetsListErrors, ChangesetsListItemsData, ChangesetsListItemsErrors, ChangesetsListItemsResponses, ChangesetsListResponses, ChangesetsPatchData, ChangesetsPatchErrors, ChangesetsPatchItemData, ChangesetsPatchItemErrors, ChangesetsPatchItemResponses, ChangesetsPatchResponses, ContentCopyData, ContentCopyErrors, ContentCopyResponses, ContentCreateData, ContentCreateErrors, ContentCreateResponses, ContentCreateVersionData, ContentCreateVersionErrors, ContentCreateVersionResponses, ContentDeleteData, ContentDeleteErrors, ContentDeleteLocaleData, ContentDeleteLocaleErrors, ContentDeleteLocaleResponses, ContentDeleteResponses, ContentDeleteVersionData, ContentDeleteVersionErrors, ContentDeleteVersionResponses, ContentGetMetadataData, ContentGetMetadataErrors, ContentGetMetadataResponses, ContentGetPathData, ContentGetPathErrors, ContentGetPathResponses, ContentGetVersionData, ContentGetVersionErrors, ContentGetVersionResponses, ContentListAllVersionsData, ContentListAllVersionsErrors, ContentListAllVersionsResponses, ContentListAssetsData, ContentListAssetsErrors, ContentListAssetsResponses, ContentListItemsData, ContentListItemsErrors, ContentListItemsResponses, ContentListVersionsData, ContentListVersionsErrors, ContentListVersionsResponses, ContentPatchMetadataData, ContentPatchMetadataErrors, ContentPatchMetadataResponses, ContentPatchVersionData, ContentPatchVersionErrors, ContentPatchVersionResponses, ContentTypesCreateData, ContentTypesCreateErrors, ContentTypesCreateResponses, ContentTypesDeleteData, ContentTypesDeleteErrors, ContentTypesDeleteResponses, ContentTypesGetData, ContentTypesGetErrors, ContentTypesGetResponses, ContentTypesListData, ContentTypesListErrors, ContentTypesListResponses, ContentTypesPatchData, ContentTypesPatchErrors, ContentTypesPatchResponses, ContentUndeleteData, ContentUndeleteErrors, ContentUndeleteResponses, DisplayTemplatesCreateData, DisplayTemplatesCreateErrors, DisplayTemplatesCreateResponses, DisplayTemplatesDeleteData, DisplayTemplatesDeleteErrors, DisplayTemplatesDeleteResponses, DisplayTemplatesGetData, DisplayTemplatesGetErrors, DisplayTemplatesGetResponses, DisplayTemplatesListData, DisplayTemplatesListErrors, DisplayTemplatesListResponses, DisplayTemplatesPatchData, DisplayTemplatesPatchErrors, DisplayTemplatesPatchResponses, PropertyFormatsGetData, PropertyFormatsGetErrors, PropertyFormatsGetResponses, PropertyFormatsListData, PropertyFormatsListErrors, PropertyFormatsListResponses, PropertyGroupsCreateData, PropertyGroupsCreateErrors, PropertyGroupsCreateResponses, PropertyGroupsDeleteData, PropertyGroupsDeleteErrors, PropertyGroupsDeleteResponses, PropertyGroupsGetData, PropertyGroupsGetErrors, PropertyGroupsGetResponses, PropertyGroupsListData, PropertyGroupsListErrors, PropertyGroupsListResponses, PropertyGroupsPatchData, PropertyGroupsPatchErrors, PropertyGroupsPatchResponses } from './types.gen';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -13,6 +13,193 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
13
13
|
*/
|
|
14
14
|
meta?: Record<string, unknown>;
|
|
15
15
|
};
|
|
16
|
+
/**
|
|
17
|
+
* List blueprints
|
|
18
|
+
*
|
|
19
|
+
* List blueprints using the provided parameters. This API is experimental and may change in future releases.
|
|
20
|
+
*/
|
|
21
|
+
export declare const blueprintsList: <ThrowOnError extends boolean = false>(options?: Options<BlueprintsListData, ThrowOnError>) => import("./client").RequestResult<BlueprintsListResponses, BlueprintsListErrors, ThrowOnError, "fields">;
|
|
22
|
+
/**
|
|
23
|
+
* Create a blueprint
|
|
24
|
+
*
|
|
25
|
+
* Create a new blueprint. This API is experimental and may change in future releases.
|
|
26
|
+
*/
|
|
27
|
+
export declare const blueprintsCreate: <ThrowOnError extends boolean = false>(options: Options<BlueprintsCreateData, ThrowOnError>) => import("./client").RequestResult<BlueprintsCreateResponses, BlueprintsCreateErrors, ThrowOnError, "fields">;
|
|
28
|
+
/**
|
|
29
|
+
* Delete a blueprint
|
|
30
|
+
*
|
|
31
|
+
* Deletes the blueprint with the provided key. This API is experimental and may change in future releases.
|
|
32
|
+
*/
|
|
33
|
+
export declare const blueprintsDelete: <ThrowOnError extends boolean = false>(options: Options<BlueprintsDeleteData, ThrowOnError>) => import("./client").RequestResult<BlueprintsDeleteResponses, BlueprintsDeleteErrors, ThrowOnError, "fields">;
|
|
34
|
+
/**
|
|
35
|
+
* Get a specific blueprint
|
|
36
|
+
*
|
|
37
|
+
* Get the blueprint with the provided key. This API is experimental and may change in future releases.
|
|
38
|
+
*/
|
|
39
|
+
export declare const blueprintsGet: <ThrowOnError extends boolean = false>(options: Options<BlueprintsGetData, ThrowOnError>) => import("./client").RequestResult<BlueprintsGetResponses, BlueprintsGetErrors, ThrowOnError, "fields">;
|
|
40
|
+
/**
|
|
41
|
+
* Patch blueprint
|
|
42
|
+
*
|
|
43
|
+
* Patch an existing blueprint. This API is experimental and may change in future releases.
|
|
44
|
+
*/
|
|
45
|
+
export declare const blueprintsPatch: <ThrowOnError extends boolean = false>(options: Options<BlueprintsPatchData, ThrowOnError>) => import("./client").RequestResult<BlueprintsPatchResponses, BlueprintsPatchErrors, ThrowOnError, "fields">;
|
|
46
|
+
/**
|
|
47
|
+
* List changeset
|
|
48
|
+
*
|
|
49
|
+
* Lists all changeset using the provided options. This API is experimental and may change in future releases.
|
|
50
|
+
*/
|
|
51
|
+
export declare const changesetsList: <ThrowOnError extends boolean = false>(options?: Options<ChangesetsListData, ThrowOnError>) => import("./client").RequestResult<ChangesetsListResponses, ChangesetsListErrors, ThrowOnError, "fields">;
|
|
52
|
+
/**
|
|
53
|
+
* Create changeset
|
|
54
|
+
*
|
|
55
|
+
* Creates a new changeset. This API is experimental and may change in future releases.
|
|
56
|
+
*/
|
|
57
|
+
export declare const changesetsCreate: <ThrowOnError extends boolean = false>(options: Options<ChangesetsCreateData, ThrowOnError>) => import("./client").RequestResult<ChangesetsCreateResponses, ChangesetsCreateErrors, ThrowOnError, "fields">;
|
|
58
|
+
/**
|
|
59
|
+
* Delete changeset
|
|
60
|
+
*
|
|
61
|
+
* Deletes the changeset with the provided key. If a changeset with the provided key does not exist an error is returned. This API is experimental and may change in future releases.
|
|
62
|
+
*/
|
|
63
|
+
export declare const changesetsDelete: <ThrowOnError extends boolean = false>(options: Options<ChangesetsDeleteData, ThrowOnError>) => import("./client").RequestResult<ChangesetsDeleteResponses, ChangesetsDeleteErrors, ThrowOnError, "fields">;
|
|
64
|
+
/**
|
|
65
|
+
* Get changeset
|
|
66
|
+
*
|
|
67
|
+
* Gets the changeset with the provided key. This API is experimental and may change in future releases.
|
|
68
|
+
*/
|
|
69
|
+
export declare const changesetsGet: <ThrowOnError extends boolean = false>(options: Options<ChangesetsGetData, ThrowOnError>) => import("./client").RequestResult<ChangesetsGetResponses, ChangesetsGetErrors, ThrowOnError, "fields">;
|
|
70
|
+
/**
|
|
71
|
+
* Patch changeset
|
|
72
|
+
*
|
|
73
|
+
* Patch an existing changeset. This API is experimental and may change in future releases.
|
|
74
|
+
*/
|
|
75
|
+
export declare const changesetsPatch: <ThrowOnError extends boolean = false>(options: Options<ChangesetsPatchData, ThrowOnError>) => import("./client").RequestResult<ChangesetsPatchResponses, ChangesetsPatchErrors, ThrowOnError, "fields">;
|
|
76
|
+
/**
|
|
77
|
+
* Delete changeset item
|
|
78
|
+
*
|
|
79
|
+
* Deletes the specified changeset item from the changeset. This API is experimental and may change in future releases.
|
|
80
|
+
*/
|
|
81
|
+
export declare const changesetsDeleteItem: <ThrowOnError extends boolean = false>(options: Options<ChangesetsDeleteItemData, ThrowOnError>) => import("./client").RequestResult<ChangesetsDeleteItemResponses, ChangesetsDeleteItemErrors, ThrowOnError, "fields">;
|
|
82
|
+
/**
|
|
83
|
+
* Get changeset item
|
|
84
|
+
*
|
|
85
|
+
* Gets the changeset item for the specified content reference. This API is experimental and may change in future releases.
|
|
86
|
+
*/
|
|
87
|
+
export declare const changesetsGetItem: <ThrowOnError extends boolean = false>(options: Options<ChangesetsGetItemData, ThrowOnError>) => import("./client").RequestResult<ChangesetsGetItemResponses, ChangesetsGetItemErrors, ThrowOnError, "fields">;
|
|
88
|
+
/**
|
|
89
|
+
* Patch changeset item
|
|
90
|
+
*
|
|
91
|
+
* Patch the given changeset item. This API is experimental and may change in future releases.
|
|
92
|
+
*/
|
|
93
|
+
export declare const changesetsPatchItem: <ThrowOnError extends boolean = false>(options: Options<ChangesetsPatchItemData, ThrowOnError>) => import("./client").RequestResult<ChangesetsPatchItemResponses, ChangesetsPatchItemErrors, ThrowOnError, "fields">;
|
|
94
|
+
/**
|
|
95
|
+
* List changeset items
|
|
96
|
+
*
|
|
97
|
+
* Lists the available changeset items for the specified changeset using
|
|
98
|
+
* the provided options. This API is experimental and may change in future releases.
|
|
99
|
+
*/
|
|
100
|
+
export declare const changesetsListItems: <ThrowOnError extends boolean = false>(options: Options<ChangesetsListItemsData, ThrowOnError>) => import("./client").RequestResult<ChangesetsListItemsResponses, ChangesetsListItemsErrors, ThrowOnError, "fields">;
|
|
101
|
+
/**
|
|
102
|
+
* Create changeset item
|
|
103
|
+
*
|
|
104
|
+
* Creates the given changeset item. This API is experimental and may change in future releases.
|
|
105
|
+
*/
|
|
106
|
+
export declare const changesetsCreateItem: <ThrowOnError extends boolean = false>(options: Options<ChangesetsCreateItemData, ThrowOnError>) => import("./client").RequestResult<ChangesetsCreateItemResponses, ChangesetsCreateItemErrors, ThrowOnError, "fields">;
|
|
107
|
+
/**
|
|
108
|
+
* Create content
|
|
109
|
+
*
|
|
110
|
+
* Create a new content item. This API is experimental and may change in future releases.
|
|
111
|
+
*/
|
|
112
|
+
export declare const contentCreate: <ThrowOnError extends boolean = false>(options: Options<ContentCreateData, ThrowOnError>) => import("./client").RequestResult<ContentCreateResponses, ContentCreateErrors, ThrowOnError, "fields">;
|
|
113
|
+
/**
|
|
114
|
+
* Delete content
|
|
115
|
+
*
|
|
116
|
+
* Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned. This API is experimental and may change in future releases.
|
|
117
|
+
*/
|
|
118
|
+
export declare const contentDelete: <ThrowOnError extends boolean = false>(options: Options<ContentDeleteData, ThrowOnError>) => import("./client").RequestResult<ContentDeleteResponses, ContentDeleteErrors, ThrowOnError, "fields">;
|
|
119
|
+
/**
|
|
120
|
+
* Get content
|
|
121
|
+
*
|
|
122
|
+
* Get shared metadata about the content instance with the provided key. This API is experimental and may change in future releases.
|
|
123
|
+
*/
|
|
124
|
+
export declare const contentGetMetadata: <ThrowOnError extends boolean = false>(options: Options<ContentGetMetadataData, ThrowOnError>) => import("./client").RequestResult<ContentGetMetadataResponses, ContentGetMetadataErrors, ThrowOnError, "fields">;
|
|
125
|
+
/**
|
|
126
|
+
* Patch content
|
|
127
|
+
*
|
|
128
|
+
* Patch an existing content item. If a content item with the provided key does not exist an error is returned. This API is experimental and may change in future releases.
|
|
129
|
+
*/
|
|
130
|
+
export declare const contentPatchMetadata: <ThrowOnError extends boolean = false>(options: Options<ContentPatchMetadataData, ThrowOnError>) => import("./client").RequestResult<ContentPatchMetadataResponses, ContentPatchMetadataErrors, ThrowOnError, "fields">;
|
|
131
|
+
/**
|
|
132
|
+
* Get content path
|
|
133
|
+
*
|
|
134
|
+
* Get the content path with the provided key. This API is experimental and may change in future releases.
|
|
135
|
+
*/
|
|
136
|
+
export declare const contentGetPath: <ThrowOnError extends boolean = false>(options: Options<ContentGetPathData, ThrowOnError>) => import("./client").RequestResult<ContentGetPathResponses, ContentGetPathErrors, ThrowOnError, "fields">;
|
|
137
|
+
/**
|
|
138
|
+
* List content in container
|
|
139
|
+
*
|
|
140
|
+
* List the content items located in a specific container. This API is experimental and may change in future releases.
|
|
141
|
+
*/
|
|
142
|
+
export declare const contentListItems: <ThrowOnError extends boolean = false>(options: Options<ContentListItemsData, ThrowOnError>) => import("./client").RequestResult<ContentListItemsResponses, ContentListItemsErrors, ThrowOnError, "fields">;
|
|
143
|
+
/**
|
|
144
|
+
* List assets
|
|
145
|
+
*
|
|
146
|
+
* List the assets that belongs to a content instance. This API is experimental and may change in future releases.
|
|
147
|
+
*/
|
|
148
|
+
export declare const contentListAssets: <ThrowOnError extends boolean = false>(options: Options<ContentListAssetsData, ThrowOnError>) => import("./client").RequestResult<ContentListAssetsResponses, ContentListAssetsErrors, ThrowOnError, "fields">;
|
|
149
|
+
/**
|
|
150
|
+
* Copy content
|
|
151
|
+
*
|
|
152
|
+
* Create a copy of the content item with the provided key. This API is experimental and may change in future releases.
|
|
153
|
+
*/
|
|
154
|
+
export declare const contentCopy: <ThrowOnError extends boolean = false>(options: Options<ContentCopyData, ThrowOnError>) => import("./client").RequestResult<ContentCopyResponses, ContentCopyErrors, ThrowOnError, "fields">;
|
|
155
|
+
/**
|
|
156
|
+
* Restore content
|
|
157
|
+
*
|
|
158
|
+
* Restore the deleted content item with the provided key. If a content item with the provided key is not deleted an error is returned. This API is experimental and may change in future releases.
|
|
159
|
+
*/
|
|
160
|
+
export declare const contentUndelete: <ThrowOnError extends boolean = false>(options: Options<ContentUndeleteData, ThrowOnError>) => import("./client").RequestResult<ContentUndeleteResponses, ContentUndeleteErrors, ThrowOnError, "fields">;
|
|
161
|
+
/**
|
|
162
|
+
* Query versions
|
|
163
|
+
*
|
|
164
|
+
* List content versions based on the provided query options. This API is experimental and may change in future releases.
|
|
165
|
+
*/
|
|
166
|
+
export declare const contentListAllVersions: <ThrowOnError extends boolean = false>(options?: Options<ContentListAllVersionsData, ThrowOnError>) => import("./client").RequestResult<ContentListAllVersionsResponses, ContentListAllVersionsErrors, ThrowOnError, "fields">;
|
|
167
|
+
/**
|
|
168
|
+
* Delete locale
|
|
169
|
+
*
|
|
170
|
+
* Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned. This API is experimental and may change in future releases.
|
|
171
|
+
*/
|
|
172
|
+
export declare const contentDeleteLocale: <ThrowOnError extends boolean = false>(options: Options<ContentDeleteLocaleData, ThrowOnError>) => import("./client").RequestResult<ContentDeleteLocaleResponses, ContentDeleteLocaleErrors, ThrowOnError, "fields">;
|
|
173
|
+
/**
|
|
174
|
+
* List versions
|
|
175
|
+
*
|
|
176
|
+
* List versions of the content item with the provided key and the provided options. This API is experimental and may change in future releases.
|
|
177
|
+
*/
|
|
178
|
+
export declare const contentListVersions: <ThrowOnError extends boolean = false>(options: Options<ContentListVersionsData, ThrowOnError>) => import("./client").RequestResult<ContentListVersionsResponses, ContentListVersionsErrors, ThrowOnError, "fields">;
|
|
179
|
+
/**
|
|
180
|
+
* Create version
|
|
181
|
+
*
|
|
182
|
+
* Create a new version of a content item. This API is experimental and may change in future releases.
|
|
183
|
+
*/
|
|
184
|
+
export declare const contentCreateVersion: <ThrowOnError extends boolean = false>(options: Options<ContentCreateVersionData, ThrowOnError>) => import("./client").RequestResult<ContentCreateVersionResponses, ContentCreateVersionErrors, ThrowOnError, "fields">;
|
|
185
|
+
/**
|
|
186
|
+
* Delete version
|
|
187
|
+
*
|
|
188
|
+
* Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned. This API is experimental and may change in future releases.
|
|
189
|
+
*/
|
|
190
|
+
export declare const contentDeleteVersion: <ThrowOnError extends boolean = false>(options: Options<ContentDeleteVersionData, ThrowOnError>) => import("./client").RequestResult<ContentDeleteVersionResponses, ContentDeleteVersionErrors, ThrowOnError, "fields">;
|
|
191
|
+
/**
|
|
192
|
+
* Get version
|
|
193
|
+
*
|
|
194
|
+
* Get the content item with the provided key and version. This API is experimental and may change in future releases.
|
|
195
|
+
*/
|
|
196
|
+
export declare const contentGetVersion: <ThrowOnError extends boolean = false>(options: Options<ContentGetVersionData, ThrowOnError>) => import("./client").RequestResult<ContentGetVersionResponses, ContentGetVersionErrors, ThrowOnError, "fields">;
|
|
197
|
+
/**
|
|
198
|
+
* Patch version
|
|
199
|
+
*
|
|
200
|
+
* Patch an existing content item. If a content item with the provided key does not exist an error is returned. This API is experimental and may change in future releases.
|
|
201
|
+
*/
|
|
202
|
+
export declare const contentPatchVersion: <ThrowOnError extends boolean = false>(options: Options<ContentPatchVersionData, ThrowOnError>) => import("./client").RequestResult<ContentPatchVersionResponses, ContentPatchVersionErrors, ThrowOnError, "fields">;
|
|
16
203
|
/**
|
|
17
204
|
* List content types
|
|
18
205
|
*
|