@remkoj/optimizely-cms-api 6.0.0-pre9 → 6.0.0-rc.3
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/AGENTS.md +66 -0
- package/README.md +6 -2
- package/dist/api-client.d.ts +10 -77
- package/dist/api-client.js +18 -171
- package/dist/client/client/client.gen.js +114 -102
- package/dist/client/client/index.d.ts +3 -1
- package/dist/client/client/types.gen.d.ts +9 -13
- package/dist/client/client/utils.gen.d.ts +8 -4
- package/dist/client/client/utils.gen.js +15 -17
- package/dist/client/client.gen.d.ts +2 -2
- package/dist/client/client.gen.js +2 -4
- package/dist/client/core/auth.gen.d.ts +7 -0
- package/dist/client/core/bodySerializer.gen.d.ts +16 -8
- package/dist/client/core/bodySerializer.gen.js +1 -1
- package/dist/client/core/params.gen.d.ts +12 -2
- package/dist/client/core/params.gen.js +40 -20
- package/dist/client/core/pathSerializer.gen.js +3 -11
- package/dist/client/core/queryKeySerializer.gen.d.ts +1 -1
- package/dist/client/core/queryKeySerializer.gen.js +4 -11
- package/dist/client/core/serverSentEvents.gen.d.ts +1 -1
- package/dist/client/core/serverSentEvents.gen.js +7 -11
- package/dist/client/core/types.gen.d.ts +6 -1
- package/dist/client/core/utils.gen.js +1 -1
- package/dist/client/index.d.ts +4 -4
- package/dist/client/index.js +140 -17
- package/dist/client/sdk.gen.d.ts +336 -23
- package/dist/client/sdk.gen.js +761 -148
- package/dist/client/transformers.gen.d.ts +49 -1
- package/dist/client/transformers.gen.js +491 -49
- package/dist/client/types.gen.d.ts +5323 -466
- package/dist/client-config.d.ts +11 -0
- package/dist/client-config.js +21 -10
- package/dist/config.d.ts +39 -4
- package/dist/config.js +44 -18
- package/dist/getaccesstoken.js +22 -4
- package/dist/index.d.ts +20 -2
- package/dist/index.js +18 -5
- package/dist/types.d.ts +1 -14
- package/dist/types.js +0 -7
- package/dist/version.json +3 -3
- package/package.json +23 -12
- package/dist/instance.client/client/client.gen.d.ts +0 -2
- package/dist/instance.client/client/client.gen.js +0 -208
- package/dist/instance.client/client/index.d.ts +0 -8
- package/dist/instance.client/client/index.js +0 -17
- package/dist/instance.client/client/types.gen.d.ts +0 -124
- package/dist/instance.client/client/types.gen.js +0 -3
- package/dist/instance.client/client/utils.gen.d.ts +0 -33
- package/dist/instance.client/client/utils.gen.js +0 -241
- package/dist/instance.client/client.gen.d.ts +0 -12
- package/dist/instance.client/client.gen.js +0 -9
- package/dist/instance.client/core/auth.gen.d.ts +0 -18
- package/dist/instance.client/core/auth.gen.js +0 -18
- package/dist/instance.client/core/bodySerializer.gen.d.ts +0 -17
- package/dist/instance.client/core/bodySerializer.gen.js +0 -60
- package/dist/instance.client/core/params.gen.d.ts +0 -33
- package/dist/instance.client/core/params.gen.js +0 -92
- package/dist/instance.client/core/pathSerializer.gen.d.ts +0 -33
- package/dist/instance.client/core/pathSerializer.gen.js +0 -123
- package/dist/instance.client/core/queryKeySerializer.gen.d.ts +0 -18
- package/dist/instance.client/core/queryKeySerializer.gen.js +0 -105
- package/dist/instance.client/core/serverSentEvents.gen.d.ts +0 -71
- package/dist/instance.client/core/serverSentEvents.gen.js +0 -139
- package/dist/instance.client/core/types.gen.d.ts +0 -78
- package/dist/instance.client/core/types.gen.js +0 -3
- package/dist/instance.client/core/utils.gen.d.ts +0 -19
- package/dist/instance.client/core/utils.gen.js +0 -93
- package/dist/instance.client/index.d.ts +0 -4
- package/dist/instance.client/index.js +0 -21
- package/dist/instance.client/sdk.gen.d.ts +0 -256
- package/dist/instance.client/sdk.gen.js +0 -638
- package/dist/instance.client/transformers.gen.d.ts +0 -34
- package/dist/instance.client/transformers.gen.js +0 -273
- package/dist/instance.client/types.gen.d.ts +0 -2838
- package/dist/instance.client/types.gen.js +0 -3
package/dist/client/sdk.gen.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
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';
|
|
3
|
-
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
1
|
+
import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client';
|
|
2
|
+
import type { ApplicationsCreateData, ApplicationsCreateErrors, ApplicationsCreateResponses, ApplicationsDeleteData, ApplicationsDeleteErrors, ApplicationsDeleteResponses, ApplicationsGetData, ApplicationsGetErrors, ApplicationsGetResponses, ApplicationsListData, ApplicationsListErrors, ApplicationsListResponses, ApplicationsPatchData, ApplicationsPatchErrors, ApplicationsPatchResponses, BlueprintsCreateData, BlueprintsCreateErrors, BlueprintsCreateResponses, BlueprintsDeleteData, BlueprintsDeleteErrors, BlueprintsDeleteResponses, BlueprintsGetData, BlueprintsGetErrors, BlueprintsGetResponses, BlueprintsListData, BlueprintsListErrors, BlueprintsListResponses, BlueprintsPatchData, BlueprintsPatchErrors, BlueprintsPatchResponses, ContentApproveData, ContentApproveErrors, ContentApproveResponses, ContentCopyData, ContentCopyErrors, ContentCopyResponses, ContentCreateData, ContentCreateErrors, ContentCreateResponses, ContentCreateVersionData, ContentCreateVersionErrors, ContentCreateVersionResponses, ContentDeleteData, ContentDeleteErrors, ContentDeleteLocaleData, ContentDeleteLocaleErrors, ContentDeleteLocaleResponses, ContentDeleteResponses, ContentDeleteVersionData, ContentDeleteVersionErrors, ContentDeleteVersionResponses, ContentDraftData, ContentDraftErrors, ContentDraftResponses, ContentGetMediaData, ContentGetMediaErrors, ContentGetMediaResponses, ContentGetNodeData, ContentGetNodeErrors, ContentGetNodeResponses, ContentGetPathData, ContentGetPathErrors, ContentGetPathResponses, ContentGetPreviewsData, ContentGetPreviewsErrors, ContentGetPreviewsResponses, ContentGetVersionData, ContentGetVersionErrors, ContentGetVersionResponses, ContentListAllVersionsData, ContentListAllVersionsErrors, ContentListAllVersionsResponses, ContentListAssetsData, ContentListAssetsErrors, ContentListAssetsResponses, ContentListItemsData, ContentListItemsErrors, ContentListItemsResponses, ContentListLocaleVersionsData, ContentListLocaleVersionsErrors, ContentListLocaleVersionsResponses, ContentListVersionsData, ContentListVersionsErrors, ContentListVersionsResponses, ContentPatchNodeData, ContentPatchNodeErrors, ContentPatchNodeResponses, ContentPatchVersionData, ContentPatchVersionErrors, ContentPatchVersionResponses, ContentPublishData, ContentPublishErrors, ContentPublishResponses, ContentReadyData, ContentReadyErrors, ContentReadyResponses, ContentRejectData, ContentRejectErrors, ContentRejectResponses, ContentSourcesCreateData, ContentSourcesCreateErrors, ContentSourcesCreateResponses, ContentSourcesDeleteData, ContentSourcesDeleteErrors, ContentSourcesDeleteResponses, ContentSourcesGetData, ContentSourcesGetErrors, ContentSourcesGetResponses, ContentSourcesListData, ContentSourcesListErrors, ContentSourcesListResponses, ContentSourcesPatchData, ContentSourcesPatchErrors, ContentSourcesPatchResponses, ContentTypeBindingsCreateData, ContentTypeBindingsCreateErrors, ContentTypeBindingsCreateResponses, ContentTypeBindingsDeleteData, ContentTypeBindingsDeleteErrors, ContentTypeBindingsDeleteResponses, ContentTypeBindingsGetData, ContentTypeBindingsGetErrors, ContentTypeBindingsGetResponses, ContentTypeBindingsListData, ContentTypeBindingsListErrors, ContentTypeBindingsListResponses, ContentTypeBindingsPatchData, ContentTypeBindingsPatchErrors, ContentTypeBindingsPatchResponses, 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, LocalesCreateData, LocalesCreateErrors, LocalesCreateResponses, LocalesDeleteData, LocalesDeleteErrors, LocalesDeleteResponses, LocalesGetData, LocalesGetErrors, LocalesGetResponses, LocalesListData, LocalesListErrors, LocalesListResponses, LocalesPatchData, LocalesPatchErrors, LocalesPatchResponses, ManifestExportData, ManifestExportErrors, ManifestExportResponses, ManifestImportData, ManifestImportErrors, ManifestImportResponses, 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
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
6
6
|
* individual options. This might be also useful if you want to implement a
|
|
@@ -11,90 +11,403 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
11
11
|
* You can pass arbitrary values through the `meta` object. This can be
|
|
12
12
|
* used to access values that aren't defined as part of the SDK function.
|
|
13
13
|
*/
|
|
14
|
-
meta?: Record<string, unknown
|
|
14
|
+
meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
|
|
15
15
|
};
|
|
16
|
+
/**
|
|
17
|
+
* List applications
|
|
18
|
+
*
|
|
19
|
+
* List all applications available in the CMS.
|
|
20
|
+
*/
|
|
21
|
+
export declare const applicationsList: <ThrowOnError extends boolean = false>(options?: Options<ApplicationsListData, ThrowOnError>) => RequestResult<ApplicationsListResponses, ApplicationsListErrors, ThrowOnError>;
|
|
22
|
+
/**
|
|
23
|
+
* Create application
|
|
24
|
+
*
|
|
25
|
+
* Create a new application.
|
|
26
|
+
*/
|
|
27
|
+
export declare const applicationsCreate: <ThrowOnError extends boolean = false>(options: Options<ApplicationsCreateData, ThrowOnError>) => RequestResult<ApplicationsCreateResponses, ApplicationsCreateErrors, ThrowOnError>;
|
|
28
|
+
/**
|
|
29
|
+
* Delete application
|
|
30
|
+
*
|
|
31
|
+
* Deletes the application with the provided key.
|
|
32
|
+
*/
|
|
33
|
+
export declare const applicationsDelete: <ThrowOnError extends boolean = false>(options: Options<ApplicationsDeleteData, ThrowOnError>) => RequestResult<ApplicationsDeleteResponses, ApplicationsDeleteErrors, ThrowOnError>;
|
|
34
|
+
/**
|
|
35
|
+
* Get application
|
|
36
|
+
*
|
|
37
|
+
* Get the application with the provided key.
|
|
38
|
+
*/
|
|
39
|
+
export declare const applicationsGet: <ThrowOnError extends boolean = false>(options: Options<ApplicationsGetData, ThrowOnError>) => RequestResult<ApplicationsGetResponses, ApplicationsGetErrors, ThrowOnError>;
|
|
40
|
+
/**
|
|
41
|
+
* Patch application
|
|
42
|
+
*
|
|
43
|
+
* Patch an existing application.
|
|
44
|
+
*/
|
|
45
|
+
export declare const applicationsPatch: <ThrowOnError extends boolean = false>(options: Options<ApplicationsPatchData, ThrowOnError>) => RequestResult<ApplicationsPatchResponses, ApplicationsPatchErrors, ThrowOnError>;
|
|
46
|
+
/**
|
|
47
|
+
* List blueprints
|
|
48
|
+
*
|
|
49
|
+
* List blueprints using the provided parameters.
|
|
50
|
+
*/
|
|
51
|
+
export declare const blueprintsList: <ThrowOnError extends boolean = false>(options?: Options<BlueprintsListData, ThrowOnError>) => RequestResult<BlueprintsListResponses, BlueprintsListErrors, ThrowOnError>;
|
|
52
|
+
/**
|
|
53
|
+
* Create blueprint
|
|
54
|
+
*
|
|
55
|
+
* Create a new blueprint.
|
|
56
|
+
*/
|
|
57
|
+
export declare const blueprintsCreate: <ThrowOnError extends boolean = false>(options: Options<BlueprintsCreateData, ThrowOnError>) => RequestResult<BlueprintsCreateResponses, BlueprintsCreateErrors, ThrowOnError>;
|
|
58
|
+
/**
|
|
59
|
+
* Delete blueprint
|
|
60
|
+
*
|
|
61
|
+
* Deletes the blueprint with the provided key.
|
|
62
|
+
*/
|
|
63
|
+
export declare const blueprintsDelete: <ThrowOnError extends boolean = false>(options: Options<BlueprintsDeleteData, ThrowOnError>) => RequestResult<BlueprintsDeleteResponses, BlueprintsDeleteErrors, ThrowOnError>;
|
|
64
|
+
/**
|
|
65
|
+
* Get blueprint
|
|
66
|
+
*
|
|
67
|
+
* Get the blueprint with the provided key.
|
|
68
|
+
*/
|
|
69
|
+
export declare const blueprintsGet: <ThrowOnError extends boolean = false>(options: Options<BlueprintsGetData, ThrowOnError>) => RequestResult<BlueprintsGetResponses, BlueprintsGetErrors, ThrowOnError>;
|
|
70
|
+
/**
|
|
71
|
+
* Patch blueprint
|
|
72
|
+
*
|
|
73
|
+
* Patch an existing blueprint.
|
|
74
|
+
*/
|
|
75
|
+
export declare const blueprintsPatch: <ThrowOnError extends boolean = false>(options: Options<BlueprintsPatchData, ThrowOnError>) => RequestResult<BlueprintsPatchResponses, BlueprintsPatchErrors, ThrowOnError>;
|
|
76
|
+
/**
|
|
77
|
+
* Create content
|
|
78
|
+
*
|
|
79
|
+
* Create a new content item.
|
|
80
|
+
*/
|
|
81
|
+
export declare const contentCreate: <ThrowOnError extends boolean = false>(options: Options<ContentCreateData, ThrowOnError>) => RequestResult<ContentCreateResponses, ContentCreateErrors, ThrowOnError>;
|
|
82
|
+
/**
|
|
83
|
+
* Copy content
|
|
84
|
+
*
|
|
85
|
+
* Create a copy of the content item with the provided key.
|
|
86
|
+
*/
|
|
87
|
+
export declare const contentCopy: <ThrowOnError extends boolean = false>(options: Options<ContentCopyData, ThrowOnError>) => RequestResult<ContentCopyResponses, ContentCopyErrors, ThrowOnError>;
|
|
88
|
+
/**
|
|
89
|
+
* Restore content
|
|
90
|
+
*
|
|
91
|
+
* Restore the deleted content item with the provided key. If a content item with the provided key is not deleted an error is returned.
|
|
92
|
+
*/
|
|
93
|
+
export declare const contentUndelete: <ThrowOnError extends boolean = false>(options: Options<ContentUndeleteData, ThrowOnError>) => RequestResult<ContentUndeleteResponses, ContentUndeleteErrors, ThrowOnError>;
|
|
94
|
+
/**
|
|
95
|
+
* Delete content
|
|
96
|
+
*
|
|
97
|
+
* Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned.
|
|
98
|
+
*/
|
|
99
|
+
export declare const contentDelete: <ThrowOnError extends boolean = false>(options: Options<ContentDeleteData, ThrowOnError>) => RequestResult<ContentDeleteResponses, ContentDeleteErrors, ThrowOnError>;
|
|
100
|
+
/**
|
|
101
|
+
* Get content node
|
|
102
|
+
*
|
|
103
|
+
* Get content node with the provided key.
|
|
104
|
+
*/
|
|
105
|
+
export declare const contentGetNode: <ThrowOnError extends boolean = false>(options: Options<ContentGetNodeData, ThrowOnError>) => RequestResult<ContentGetNodeResponses, ContentGetNodeErrors, ThrowOnError>;
|
|
106
|
+
/**
|
|
107
|
+
* Patch content
|
|
108
|
+
*
|
|
109
|
+
* Patch an existing content item. If a content item with the provided key does not exist an error is returned.
|
|
110
|
+
*/
|
|
111
|
+
export declare const contentPatchNode: <ThrowOnError extends boolean = false>(options: Options<ContentPatchNodeData, ThrowOnError>) => RequestResult<ContentPatchNodeResponses, ContentPatchNodeErrors, ThrowOnError>;
|
|
112
|
+
/**
|
|
113
|
+
* List assets
|
|
114
|
+
*
|
|
115
|
+
* List the assets that belongs to a content instance.
|
|
116
|
+
*/
|
|
117
|
+
export declare const contentListAssets: <ThrowOnError extends boolean = false>(options: Options<ContentListAssetsData, ThrowOnError>) => RequestResult<ContentListAssetsResponses, ContentListAssetsErrors, ThrowOnError>;
|
|
118
|
+
/**
|
|
119
|
+
* List content in container
|
|
120
|
+
*
|
|
121
|
+
* List the content items located in a specific container.
|
|
122
|
+
*/
|
|
123
|
+
export declare const contentListItems: <ThrowOnError extends boolean = false>(options: Options<ContentListItemsData, ThrowOnError>) => RequestResult<ContentListItemsResponses, ContentListItemsErrors, ThrowOnError>;
|
|
124
|
+
/**
|
|
125
|
+
* Delete locale
|
|
126
|
+
*
|
|
127
|
+
* Deletes a branch of the content with the provided key and locale. Returns the published or latest content item in the locale that was deleted. If a content item with the provided key does not exist an error is returned.
|
|
128
|
+
*/
|
|
129
|
+
export declare const contentDeleteLocale: <ThrowOnError extends boolean = false>(options: Options<ContentDeleteLocaleData, ThrowOnError>) => RequestResult<ContentDeleteLocaleResponses, ContentDeleteLocaleErrors, ThrowOnError>;
|
|
130
|
+
/**
|
|
131
|
+
* List locale versions
|
|
132
|
+
*
|
|
133
|
+
* List versions of the content with the provided key and locale.
|
|
134
|
+
*/
|
|
135
|
+
export declare const contentListLocaleVersions: <ThrowOnError extends boolean = false>(options: Options<ContentListLocaleVersionsData, ThrowOnError>) => RequestResult<ContentListLocaleVersionsResponses, ContentListLocaleVersionsErrors, ThrowOnError>;
|
|
136
|
+
/**
|
|
137
|
+
* Get content path
|
|
138
|
+
*
|
|
139
|
+
* Get the content path with the provided key.
|
|
140
|
+
*/
|
|
141
|
+
export declare const contentGetPath: <ThrowOnError extends boolean = false>(options: Options<ContentGetPathData, ThrowOnError>) => RequestResult<ContentGetPathResponses, ContentGetPathErrors, ThrowOnError>;
|
|
142
|
+
/**
|
|
143
|
+
* List versions
|
|
144
|
+
*
|
|
145
|
+
* List versions of the content item with the provided key and the provided options.
|
|
146
|
+
*/
|
|
147
|
+
export declare const contentListVersions: <ThrowOnError extends boolean = false>(options: Options<ContentListVersionsData, ThrowOnError>) => RequestResult<ContentListVersionsResponses, ContentListVersionsErrors, ThrowOnError>;
|
|
148
|
+
/**
|
|
149
|
+
* Create version
|
|
150
|
+
*
|
|
151
|
+
* Create a new version of a content item.
|
|
152
|
+
*/
|
|
153
|
+
export declare const contentCreateVersion: <ThrowOnError extends boolean = false>(options: Options<ContentCreateVersionData, ThrowOnError>) => RequestResult<ContentCreateVersionResponses, ContentCreateVersionErrors, ThrowOnError>;
|
|
154
|
+
/**
|
|
155
|
+
* Approve the active step of an approval for a content version that is in review. For multi-step approvals, the version remains in review until all steps are approved.
|
|
156
|
+
*/
|
|
157
|
+
export declare const contentApprove: <ThrowOnError extends boolean = false>(options: Options<ContentApproveData, ThrowOnError>) => RequestResult<ContentApproveResponses, ContentApproveErrors, ThrowOnError>;
|
|
158
|
+
/**
|
|
159
|
+
* Change content version into draft status.
|
|
160
|
+
*/
|
|
161
|
+
export declare const contentDraft: <ThrowOnError extends boolean = false>(options: Options<ContentDraftData, ThrowOnError>) => RequestResult<ContentDraftResponses, ContentDraftErrors, ThrowOnError>;
|
|
162
|
+
/**
|
|
163
|
+
* Publish content version
|
|
164
|
+
*/
|
|
165
|
+
export declare const contentPublish: <ThrowOnError extends boolean = false>(options: Options<ContentPublishData, ThrowOnError>) => RequestResult<ContentPublishResponses, ContentPublishErrors, ThrowOnError>;
|
|
166
|
+
/**
|
|
167
|
+
* Make content ready to publish, if approvals are required the version will automatically be moved to in review.
|
|
168
|
+
*/
|
|
169
|
+
export declare const contentReady: <ThrowOnError extends boolean = false>(options: Options<ContentReadyData, ThrowOnError>) => RequestResult<ContentReadyResponses, ContentReadyErrors, ThrowOnError>;
|
|
170
|
+
/**
|
|
171
|
+
* Reject a content version that is in review. The version transitions to rejected status regardless of remaining approval steps.
|
|
172
|
+
*/
|
|
173
|
+
export declare const contentReject: <ThrowOnError extends boolean = false>(options: Options<ContentRejectData, ThrowOnError>) => RequestResult<ContentRejectResponses, ContentRejectErrors, ThrowOnError>;
|
|
174
|
+
/**
|
|
175
|
+
* Delete version
|
|
176
|
+
*
|
|
177
|
+
* Deletes the content item with the provided key and version and returns the deleted item. If a content item with the provided key does not exist an error is returned.
|
|
178
|
+
*/
|
|
179
|
+
export declare const contentDeleteVersion: <ThrowOnError extends boolean = false>(options: Options<ContentDeleteVersionData, ThrowOnError>) => RequestResult<ContentDeleteVersionResponses, ContentDeleteVersionErrors, ThrowOnError>;
|
|
180
|
+
/**
|
|
181
|
+
* Get version
|
|
182
|
+
*
|
|
183
|
+
* Get the content item with the provided key and version.
|
|
184
|
+
*/
|
|
185
|
+
export declare const contentGetVersion: <ThrowOnError extends boolean = false>(options: Options<ContentGetVersionData, ThrowOnError>) => RequestResult<ContentGetVersionResponses, ContentGetVersionErrors, ThrowOnError>;
|
|
186
|
+
/**
|
|
187
|
+
* Patch version
|
|
188
|
+
*
|
|
189
|
+
* Patch an existing content item and returns the updated content item. If a content item with the provided key does not exist an error is returned.
|
|
190
|
+
*/
|
|
191
|
+
export declare const contentPatchVersion: <ThrowOnError extends boolean = false>(options: Options<ContentPatchVersionData, ThrowOnError>) => RequestResult<ContentPatchVersionResponses, ContentPatchVersionErrors, ThrowOnError>;
|
|
192
|
+
/**
|
|
193
|
+
* Download content media file.
|
|
194
|
+
*
|
|
195
|
+
* Download the media file for a specific content item version.
|
|
196
|
+
*/
|
|
197
|
+
export declare const contentGetMedia: <ThrowOnError extends boolean = false>(options: Options<ContentGetMediaData, ThrowOnError>) => RequestResult<ContentGetMediaResponses, ContentGetMediaErrors, ThrowOnError>;
|
|
198
|
+
/**
|
|
199
|
+
* Get preview URLs for a content item version.
|
|
200
|
+
*
|
|
201
|
+
* Generate preview URLs for the content item with fresh authentication tokens.
|
|
202
|
+
*/
|
|
203
|
+
export declare const contentGetPreviews: <ThrowOnError extends boolean = false>(options: Options<ContentGetPreviewsData, ThrowOnError>) => RequestResult<ContentGetPreviewsResponses, ContentGetPreviewsErrors, ThrowOnError>;
|
|
204
|
+
/**
|
|
205
|
+
* Query versions
|
|
206
|
+
*
|
|
207
|
+
* List content versions based on the provided query options.
|
|
208
|
+
*/
|
|
209
|
+
export declare const contentListAllVersions: <ThrowOnError extends boolean = false>(options?: Options<ContentListAllVersionsData, ThrowOnError>) => RequestResult<ContentListAllVersionsResponses, ContentListAllVersionsErrors, ThrowOnError>;
|
|
210
|
+
/**
|
|
211
|
+
* List content sources
|
|
212
|
+
*
|
|
213
|
+
* List content sources using the provided options.
|
|
214
|
+
*/
|
|
215
|
+
export declare const contentSourcesList: <ThrowOnError extends boolean = false>(options?: Options<ContentSourcesListData, ThrowOnError>) => RequestResult<ContentSourcesListResponses, ContentSourcesListErrors, ThrowOnError>;
|
|
216
|
+
/**
|
|
217
|
+
* Create contentsource
|
|
218
|
+
*
|
|
219
|
+
* Create a new contentsource.
|
|
220
|
+
*/
|
|
221
|
+
export declare const contentSourcesCreate: <ThrowOnError extends boolean = false>(options: Options<ContentSourcesCreateData, ThrowOnError>) => RequestResult<ContentSourcesCreateResponses, ContentSourcesCreateErrors, ThrowOnError>;
|
|
222
|
+
/**
|
|
223
|
+
* Delete contentsource
|
|
224
|
+
*
|
|
225
|
+
* Deletes the contentsource with the provided key.
|
|
226
|
+
*/
|
|
227
|
+
export declare const contentSourcesDelete: <ThrowOnError extends boolean = false>(options: Options<ContentSourcesDeleteData, ThrowOnError>) => RequestResult<ContentSourcesDeleteResponses, ContentSourcesDeleteErrors, ThrowOnError>;
|
|
228
|
+
/**
|
|
229
|
+
* Get contentsource
|
|
230
|
+
*
|
|
231
|
+
* Get the contentsource with the provided key.
|
|
232
|
+
*/
|
|
233
|
+
export declare const contentSourcesGet: <ThrowOnError extends boolean = false>(options: Options<ContentSourcesGetData, ThrowOnError>) => RequestResult<ContentSourcesGetResponses, ContentSourcesGetErrors, ThrowOnError>;
|
|
234
|
+
/**
|
|
235
|
+
* Patch contentsource
|
|
236
|
+
*
|
|
237
|
+
* Patch an existing contentsource.
|
|
238
|
+
*/
|
|
239
|
+
export declare const contentSourcesPatch: <ThrowOnError extends boolean = false>(options: Options<ContentSourcesPatchData, ThrowOnError>) => RequestResult<ContentSourcesPatchResponses, ContentSourcesPatchErrors, ThrowOnError>;
|
|
240
|
+
/**
|
|
241
|
+
* List content type bindings
|
|
242
|
+
*
|
|
243
|
+
* List type bindings using the provided options.
|
|
244
|
+
*/
|
|
245
|
+
export declare const contentTypeBindingsList: <ThrowOnError extends boolean = false>(options?: Options<ContentTypeBindingsListData, ThrowOnError>) => RequestResult<ContentTypeBindingsListResponses, ContentTypeBindingsListErrors, ThrowOnError>;
|
|
246
|
+
/**
|
|
247
|
+
* Create contenttypebinding
|
|
248
|
+
*
|
|
249
|
+
* Create a new contenttypebinding.
|
|
250
|
+
*/
|
|
251
|
+
export declare const contentTypeBindingsCreate: <ThrowOnError extends boolean = false>(options: Options<ContentTypeBindingsCreateData, ThrowOnError>) => RequestResult<ContentTypeBindingsCreateResponses, ContentTypeBindingsCreateErrors, ThrowOnError>;
|
|
252
|
+
/**
|
|
253
|
+
* Delete contenttypebinding
|
|
254
|
+
*
|
|
255
|
+
* Deletes the contenttypebinding with the provided key.
|
|
256
|
+
*/
|
|
257
|
+
export declare const contentTypeBindingsDelete: <ThrowOnError extends boolean = false>(options: Options<ContentTypeBindingsDeleteData, ThrowOnError>) => RequestResult<ContentTypeBindingsDeleteResponses, ContentTypeBindingsDeleteErrors, ThrowOnError>;
|
|
258
|
+
/**
|
|
259
|
+
* Get contenttypebinding
|
|
260
|
+
*
|
|
261
|
+
* Get the contenttypebinding with the provided key.
|
|
262
|
+
*/
|
|
263
|
+
export declare const contentTypeBindingsGet: <ThrowOnError extends boolean = false>(options: Options<ContentTypeBindingsGetData, ThrowOnError>) => RequestResult<ContentTypeBindingsGetResponses, ContentTypeBindingsGetErrors, ThrowOnError>;
|
|
264
|
+
/**
|
|
265
|
+
* Patch contenttypebinding
|
|
266
|
+
*
|
|
267
|
+
* Patch an existing contenttypebinding.
|
|
268
|
+
*/
|
|
269
|
+
export declare const contentTypeBindingsPatch: <ThrowOnError extends boolean = false>(options: Options<ContentTypeBindingsPatchData, ThrowOnError>) => RequestResult<ContentTypeBindingsPatchResponses, ContentTypeBindingsPatchErrors, ThrowOnError>;
|
|
16
270
|
/**
|
|
17
271
|
* List content types
|
|
272
|
+
*
|
|
18
273
|
* List content types using the provided parameters.
|
|
19
274
|
*/
|
|
20
|
-
export declare const contentTypesList: <ThrowOnError extends boolean = false>(options?: Options<ContentTypesListData, ThrowOnError>) =>
|
|
275
|
+
export declare const contentTypesList: <ThrowOnError extends boolean = false>(options?: Options<ContentTypesListData, ThrowOnError>) => RequestResult<ContentTypesListResponses, ContentTypesListErrors, ThrowOnError>;
|
|
21
276
|
/**
|
|
22
277
|
* Create content type
|
|
278
|
+
*
|
|
23
279
|
* Create a new content type.
|
|
24
280
|
*/
|
|
25
|
-
export declare const contentTypesCreate: <ThrowOnError extends boolean = false>(options: Options<ContentTypesCreateData, ThrowOnError>) =>
|
|
281
|
+
export declare const contentTypesCreate: <ThrowOnError extends boolean = false>(options: Options<ContentTypesCreateData, ThrowOnError>) => RequestResult<ContentTypesCreateResponses, ContentTypesCreateErrors, ThrowOnError>;
|
|
26
282
|
/**
|
|
27
283
|
* Delete content type
|
|
28
|
-
*
|
|
284
|
+
*
|
|
285
|
+
* Deletes the content type with the provided key.
|
|
29
286
|
*/
|
|
30
|
-
export declare const contentTypesDelete: <ThrowOnError extends boolean = false>(options: Options<ContentTypesDeleteData, ThrowOnError>) =>
|
|
287
|
+
export declare const contentTypesDelete: <ThrowOnError extends boolean = false>(options: Options<ContentTypesDeleteData, ThrowOnError>) => RequestResult<ContentTypesDeleteResponses, ContentTypesDeleteErrors, ThrowOnError>;
|
|
31
288
|
/**
|
|
32
289
|
* Get content type
|
|
290
|
+
*
|
|
33
291
|
* Get the content type with the provided key.
|
|
34
292
|
*/
|
|
35
|
-
export declare const contentTypesGet: <ThrowOnError extends boolean = false>(options: Options<ContentTypesGetData, ThrowOnError>) =>
|
|
293
|
+
export declare const contentTypesGet: <ThrowOnError extends boolean = false>(options: Options<ContentTypesGetData, ThrowOnError>) => RequestResult<ContentTypesGetResponses, ContentTypesGetErrors, ThrowOnError>;
|
|
36
294
|
/**
|
|
37
295
|
* Patch content type
|
|
38
|
-
*
|
|
296
|
+
*
|
|
297
|
+
* Patch an existing content type.
|
|
39
298
|
*/
|
|
40
|
-
export declare const contentTypesPatch: <ThrowOnError extends boolean = false>(options: Options<ContentTypesPatchData, ThrowOnError>) =>
|
|
299
|
+
export declare const contentTypesPatch: <ThrowOnError extends boolean = false>(options: Options<ContentTypesPatchData, ThrowOnError>) => RequestResult<ContentTypesPatchResponses, ContentTypesPatchErrors, ThrowOnError>;
|
|
41
300
|
/**
|
|
42
301
|
* List display templates
|
|
302
|
+
*
|
|
43
303
|
* List display templates using the provided parameters.
|
|
44
304
|
*/
|
|
45
|
-
export declare const displayTemplatesList: <ThrowOnError extends boolean = false>(options?: Options<DisplayTemplatesListData, ThrowOnError>) =>
|
|
305
|
+
export declare const displayTemplatesList: <ThrowOnError extends boolean = false>(options?: Options<DisplayTemplatesListData, ThrowOnError>) => RequestResult<DisplayTemplatesListResponses, DisplayTemplatesListErrors, ThrowOnError>;
|
|
46
306
|
/**
|
|
47
307
|
* Create display template
|
|
308
|
+
*
|
|
48
309
|
* Create a new display template.
|
|
49
310
|
*/
|
|
50
|
-
export declare const displayTemplatesCreate: <ThrowOnError extends boolean = false>(options: Options<DisplayTemplatesCreateData, ThrowOnError>) =>
|
|
311
|
+
export declare const displayTemplatesCreate: <ThrowOnError extends boolean = false>(options: Options<DisplayTemplatesCreateData, ThrowOnError>) => RequestResult<DisplayTemplatesCreateResponses, DisplayTemplatesCreateErrors, ThrowOnError>;
|
|
51
312
|
/**
|
|
52
313
|
* Delete display template
|
|
314
|
+
*
|
|
53
315
|
* Deletes the display template with the provided key.
|
|
54
316
|
*/
|
|
55
|
-
export declare const displayTemplatesDelete: <ThrowOnError extends boolean = false>(options: Options<DisplayTemplatesDeleteData, ThrowOnError>) =>
|
|
317
|
+
export declare const displayTemplatesDelete: <ThrowOnError extends boolean = false>(options: Options<DisplayTemplatesDeleteData, ThrowOnError>) => RequestResult<DisplayTemplatesDeleteResponses, DisplayTemplatesDeleteErrors, ThrowOnError>;
|
|
56
318
|
/**
|
|
57
319
|
* Get display template
|
|
320
|
+
*
|
|
58
321
|
* Get the display template with the provided key.
|
|
59
322
|
*/
|
|
60
|
-
export declare const displayTemplatesGet: <ThrowOnError extends boolean = false>(options: Options<DisplayTemplatesGetData, ThrowOnError>) =>
|
|
323
|
+
export declare const displayTemplatesGet: <ThrowOnError extends boolean = false>(options: Options<DisplayTemplatesGetData, ThrowOnError>) => RequestResult<DisplayTemplatesGetResponses, DisplayTemplatesGetErrors, ThrowOnError>;
|
|
61
324
|
/**
|
|
62
325
|
* Patch display template
|
|
326
|
+
*
|
|
63
327
|
* Patch an existing display template.
|
|
64
328
|
*/
|
|
65
|
-
export declare const displayTemplatesPatch: <ThrowOnError extends boolean = false>(options: Options<DisplayTemplatesPatchData, ThrowOnError>) =>
|
|
329
|
+
export declare const displayTemplatesPatch: <ThrowOnError extends boolean = false>(options: Options<DisplayTemplatesPatchData, ThrowOnError>) => RequestResult<DisplayTemplatesPatchResponses, DisplayTemplatesPatchErrors, ThrowOnError>;
|
|
330
|
+
/**
|
|
331
|
+
* List locales
|
|
332
|
+
*
|
|
333
|
+
* List all locales (language branches) available in the CMS.
|
|
334
|
+
*/
|
|
335
|
+
export declare const localesList: <ThrowOnError extends boolean = false>(options?: Options<LocalesListData, ThrowOnError>) => RequestResult<LocalesListResponses, LocalesListErrors, ThrowOnError>;
|
|
336
|
+
/**
|
|
337
|
+
* Create locale
|
|
338
|
+
*
|
|
339
|
+
* Create a new locale.
|
|
340
|
+
*/
|
|
341
|
+
export declare const localesCreate: <ThrowOnError extends boolean = false>(options: Options<LocalesCreateData, ThrowOnError>) => RequestResult<LocalesCreateResponses, LocalesCreateErrors, ThrowOnError>;
|
|
342
|
+
/**
|
|
343
|
+
* Delete locale
|
|
344
|
+
*
|
|
345
|
+
* Deletes the locale with the provided key.
|
|
346
|
+
*/
|
|
347
|
+
export declare const localesDelete: <ThrowOnError extends boolean = false>(options: Options<LocalesDeleteData, ThrowOnError>) => RequestResult<LocalesDeleteResponses, LocalesDeleteErrors, ThrowOnError>;
|
|
348
|
+
/**
|
|
349
|
+
* Get locale
|
|
350
|
+
*
|
|
351
|
+
* Get the locale with the provided key.
|
|
352
|
+
*/
|
|
353
|
+
export declare const localesGet: <ThrowOnError extends boolean = false>(options: Options<LocalesGetData, ThrowOnError>) => RequestResult<LocalesGetResponses, LocalesGetErrors, ThrowOnError>;
|
|
354
|
+
/**
|
|
355
|
+
* Patch locale
|
|
356
|
+
*
|
|
357
|
+
* Patch an existing locale.
|
|
358
|
+
*/
|
|
359
|
+
export declare const localesPatch: <ThrowOnError extends boolean = false>(options: Options<LocalesPatchData, ThrowOnError>) => RequestResult<LocalesPatchResponses, LocalesPatchErrors, ThrowOnError>;
|
|
360
|
+
/**
|
|
361
|
+
* Export manifest
|
|
362
|
+
*
|
|
363
|
+
* Export a CMS content manifest.
|
|
364
|
+
*/
|
|
365
|
+
export declare const manifestExport: <ThrowOnError extends boolean = false>(options?: Options<ManifestExportData, ThrowOnError>) => RequestResult<ManifestExportResponses, ManifestExportErrors, ThrowOnError>;
|
|
366
|
+
/**
|
|
367
|
+
* Import manifest
|
|
368
|
+
*
|
|
369
|
+
* Import a CMS content manifest.
|
|
370
|
+
*/
|
|
371
|
+
export declare const manifestImport: <ThrowOnError extends boolean = false>(options: Options<ManifestImportData, ThrowOnError>) => RequestResult<ManifestImportResponses, ManifestImportErrors, ThrowOnError>;
|
|
66
372
|
/**
|
|
67
373
|
* List property formats
|
|
374
|
+
*
|
|
68
375
|
* List all property formats using the provided options.
|
|
69
376
|
*/
|
|
70
|
-
export declare const propertyFormatsList: <ThrowOnError extends boolean = false>(options?: Options<PropertyFormatsListData, ThrowOnError>) =>
|
|
377
|
+
export declare const propertyFormatsList: <ThrowOnError extends boolean = false>(options?: Options<PropertyFormatsListData, ThrowOnError>) => RequestResult<PropertyFormatsListResponses, PropertyFormatsListErrors, ThrowOnError>;
|
|
71
378
|
/**
|
|
72
379
|
* Get property format
|
|
380
|
+
*
|
|
73
381
|
* Get the property format with the provided key.
|
|
74
382
|
*/
|
|
75
|
-
export declare const propertyFormatsGet: <ThrowOnError extends boolean = false>(options: Options<PropertyFormatsGetData, ThrowOnError>) =>
|
|
383
|
+
export declare const propertyFormatsGet: <ThrowOnError extends boolean = false>(options: Options<PropertyFormatsGetData, ThrowOnError>) => RequestResult<PropertyFormatsGetResponses, PropertyFormatsGetErrors, ThrowOnError>;
|
|
76
384
|
/**
|
|
77
385
|
* List property groups
|
|
386
|
+
*
|
|
78
387
|
* List property groups using the provided options.
|
|
79
388
|
*/
|
|
80
|
-
export declare const propertyGroupsList: <ThrowOnError extends boolean = false>(options?: Options<PropertyGroupsListData, ThrowOnError>) =>
|
|
389
|
+
export declare const propertyGroupsList: <ThrowOnError extends boolean = false>(options?: Options<PropertyGroupsListData, ThrowOnError>) => RequestResult<PropertyGroupsListResponses, PropertyGroupsListErrors, ThrowOnError>;
|
|
81
390
|
/**
|
|
82
391
|
* Create property group
|
|
392
|
+
*
|
|
83
393
|
* Create a new property group.
|
|
84
394
|
*/
|
|
85
|
-
export declare const propertyGroupsCreate: <ThrowOnError extends boolean = false>(options: Options<PropertyGroupsCreateData, ThrowOnError>) =>
|
|
395
|
+
export declare const propertyGroupsCreate: <ThrowOnError extends boolean = false>(options: Options<PropertyGroupsCreateData, ThrowOnError>) => RequestResult<PropertyGroupsCreateResponses, PropertyGroupsCreateErrors, ThrowOnError>;
|
|
86
396
|
/**
|
|
87
397
|
* Delete property group
|
|
398
|
+
*
|
|
88
399
|
* Deletes the property group with the provided key.
|
|
89
400
|
*/
|
|
90
|
-
export declare const propertyGroupsDelete: <ThrowOnError extends boolean = false>(options: Options<PropertyGroupsDeleteData, ThrowOnError>) =>
|
|
401
|
+
export declare const propertyGroupsDelete: <ThrowOnError extends boolean = false>(options: Options<PropertyGroupsDeleteData, ThrowOnError>) => RequestResult<PropertyGroupsDeleteResponses, PropertyGroupsDeleteErrors, ThrowOnError>;
|
|
91
402
|
/**
|
|
92
403
|
* Get property group
|
|
404
|
+
*
|
|
93
405
|
* Get the property group with the provided key.
|
|
94
406
|
*/
|
|
95
|
-
export declare const propertyGroupsGet: <ThrowOnError extends boolean = false>(options: Options<PropertyGroupsGetData, ThrowOnError>) =>
|
|
407
|
+
export declare const propertyGroupsGet: <ThrowOnError extends boolean = false>(options: Options<PropertyGroupsGetData, ThrowOnError>) => RequestResult<PropertyGroupsGetResponses, PropertyGroupsGetErrors, ThrowOnError>;
|
|
96
408
|
/**
|
|
97
409
|
* Patch property group
|
|
410
|
+
*
|
|
98
411
|
* Patch an existing property group.
|
|
99
412
|
*/
|
|
100
|
-
export declare const propertyGroupsPatch: <ThrowOnError extends boolean = false>(options: Options<PropertyGroupsPatchData, ThrowOnError>) =>
|
|
413
|
+
export declare const propertyGroupsPatch: <ThrowOnError extends boolean = false>(options: Options<PropertyGroupsPatchData, ThrowOnError>) => RequestResult<PropertyGroupsPatchResponses, PropertyGroupsPatchErrors, ThrowOnError>;
|