@remkoj/optimizely-cms-api 6.0.0-rc.1 → 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/dist/api-client.d.ts +10 -65
- package/dist/api-client.js +18 -124
- package/dist/client/client/client.gen.js +107 -126
- package/dist/client/client/index.d.ts +2 -0
- package/dist/client/client/types.gen.d.ts +6 -3
- package/dist/client/client/utils.gen.d.ts +8 -4
- package/dist/client/client/utils.gen.js +6 -6
- package/dist/client/client.gen.d.ts +2 -2
- package/dist/client/client.gen.js +1 -1
- package/dist/client/core/auth.gen.d.ts +7 -0
- package/dist/client/core/params.gen.d.ts +2 -2
- package/dist/client/core/params.gen.js +24 -16
- package/dist/client/core/queryKeySerializer.gen.d.ts +1 -1
- package/dist/client/core/serverSentEvents.gen.d.ts +1 -1
- package/dist/client/core/serverSentEvents.gen.js +4 -6
- 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 +3 -3
- package/dist/client/index.js +63 -21
- package/dist/client/sdk.gen.d.ts +221 -118
- package/dist/client/sdk.gen.js +431 -180
- package/dist/client/transformers.gen.d.ts +35 -13
- package/dist/client/transformers.gen.js +341 -99
- package/dist/client/types.gen.d.ts +4383 -1300
- 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 -1
- package/dist/index.js +18 -4
- package/dist/types.d.ts +1 -14
- package/dist/types.js +0 -7
- package/dist/version.json +3 -3
- package/package.json +19 -8
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 {
|
|
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,300 +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
16
|
/**
|
|
17
|
-
* List
|
|
17
|
+
* List applications
|
|
18
18
|
*
|
|
19
|
-
* List
|
|
19
|
+
* List all applications available in the CMS.
|
|
20
20
|
*/
|
|
21
|
-
export declare const
|
|
21
|
+
export declare const applicationsList: <ThrowOnError extends boolean = false>(options?: Options<ApplicationsListData, ThrowOnError>) => RequestResult<ApplicationsListResponses, ApplicationsListErrors, ThrowOnError>;
|
|
22
22
|
/**
|
|
23
|
-
* Create
|
|
23
|
+
* Create application
|
|
24
24
|
*
|
|
25
|
-
* Create a new
|
|
25
|
+
* Create a new application.
|
|
26
26
|
*/
|
|
27
|
-
export declare const
|
|
27
|
+
export declare const applicationsCreate: <ThrowOnError extends boolean = false>(options: Options<ApplicationsCreateData, ThrowOnError>) => RequestResult<ApplicationsCreateResponses, ApplicationsCreateErrors, ThrowOnError>;
|
|
28
28
|
/**
|
|
29
|
-
* Delete
|
|
29
|
+
* Delete application
|
|
30
30
|
*
|
|
31
|
-
* Deletes the
|
|
31
|
+
* Deletes the application with the provided key.
|
|
32
32
|
*/
|
|
33
|
-
export declare const
|
|
33
|
+
export declare const applicationsDelete: <ThrowOnError extends boolean = false>(options: Options<ApplicationsDeleteData, ThrowOnError>) => RequestResult<ApplicationsDeleteResponses, ApplicationsDeleteErrors, ThrowOnError>;
|
|
34
34
|
/**
|
|
35
|
-
* Get
|
|
35
|
+
* Get application
|
|
36
36
|
*
|
|
37
|
-
* Get the
|
|
37
|
+
* Get the application with the provided key.
|
|
38
38
|
*/
|
|
39
|
-
export declare const
|
|
39
|
+
export declare const applicationsGet: <ThrowOnError extends boolean = false>(options: Options<ApplicationsGetData, ThrowOnError>) => RequestResult<ApplicationsGetResponses, ApplicationsGetErrors, ThrowOnError>;
|
|
40
40
|
/**
|
|
41
|
-
* Patch
|
|
41
|
+
* Patch application
|
|
42
42
|
*
|
|
43
|
-
* Patch an existing
|
|
43
|
+
* Patch an existing application.
|
|
44
44
|
*/
|
|
45
|
-
export declare const
|
|
45
|
+
export declare const applicationsPatch: <ThrowOnError extends boolean = false>(options: Options<ApplicationsPatchData, ThrowOnError>) => RequestResult<ApplicationsPatchResponses, ApplicationsPatchErrors, ThrowOnError>;
|
|
46
46
|
/**
|
|
47
|
-
* List
|
|
47
|
+
* List blueprints
|
|
48
48
|
*
|
|
49
|
-
*
|
|
49
|
+
* List blueprints using the provided parameters.
|
|
50
50
|
*/
|
|
51
|
-
export declare const
|
|
51
|
+
export declare const blueprintsList: <ThrowOnError extends boolean = false>(options?: Options<BlueprintsListData, ThrowOnError>) => RequestResult<BlueprintsListResponses, BlueprintsListErrors, ThrowOnError>;
|
|
52
52
|
/**
|
|
53
|
-
* Create
|
|
53
|
+
* Create blueprint
|
|
54
54
|
*
|
|
55
|
-
*
|
|
55
|
+
* Create a new blueprint.
|
|
56
56
|
*/
|
|
57
|
-
export declare const
|
|
57
|
+
export declare const blueprintsCreate: <ThrowOnError extends boolean = false>(options: Options<BlueprintsCreateData, ThrowOnError>) => RequestResult<BlueprintsCreateResponses, BlueprintsCreateErrors, ThrowOnError>;
|
|
58
58
|
/**
|
|
59
|
-
* Delete
|
|
59
|
+
* Delete blueprint
|
|
60
60
|
*
|
|
61
|
-
* Deletes the
|
|
61
|
+
* Deletes the blueprint with the provided key.
|
|
62
62
|
*/
|
|
63
|
-
export declare const
|
|
63
|
+
export declare const blueprintsDelete: <ThrowOnError extends boolean = false>(options: Options<BlueprintsDeleteData, ThrowOnError>) => RequestResult<BlueprintsDeleteResponses, BlueprintsDeleteErrors, ThrowOnError>;
|
|
64
64
|
/**
|
|
65
|
-
* Get
|
|
65
|
+
* Get blueprint
|
|
66
66
|
*
|
|
67
|
-
*
|
|
67
|
+
* Get the blueprint with the provided key.
|
|
68
68
|
*/
|
|
69
|
-
export declare const
|
|
69
|
+
export declare const blueprintsGet: <ThrowOnError extends boolean = false>(options: Options<BlueprintsGetData, ThrowOnError>) => RequestResult<BlueprintsGetResponses, BlueprintsGetErrors, ThrowOnError>;
|
|
70
70
|
/**
|
|
71
|
-
* Patch
|
|
71
|
+
* Patch blueprint
|
|
72
72
|
*
|
|
73
|
-
* Patch an existing
|
|
73
|
+
* Patch an existing blueprint.
|
|
74
74
|
*/
|
|
75
|
-
export declare const
|
|
75
|
+
export declare const blueprintsPatch: <ThrowOnError extends boolean = false>(options: Options<BlueprintsPatchData, ThrowOnError>) => RequestResult<BlueprintsPatchResponses, BlueprintsPatchErrors, ThrowOnError>;
|
|
76
76
|
/**
|
|
77
|
-
*
|
|
77
|
+
* Create content
|
|
78
78
|
*
|
|
79
|
-
*
|
|
79
|
+
* Create a new content item.
|
|
80
80
|
*/
|
|
81
|
-
export declare const
|
|
81
|
+
export declare const contentCreate: <ThrowOnError extends boolean = false>(options: Options<ContentCreateData, ThrowOnError>) => RequestResult<ContentCreateResponses, ContentCreateErrors, ThrowOnError>;
|
|
82
82
|
/**
|
|
83
|
-
*
|
|
83
|
+
* Copy content
|
|
84
84
|
*
|
|
85
|
-
*
|
|
85
|
+
* Create a copy of the content item with the provided key.
|
|
86
86
|
*/
|
|
87
|
-
export declare const
|
|
87
|
+
export declare const contentCopy: <ThrowOnError extends boolean = false>(options: Options<ContentCopyData, ThrowOnError>) => RequestResult<ContentCopyResponses, ContentCopyErrors, ThrowOnError>;
|
|
88
88
|
/**
|
|
89
|
-
*
|
|
89
|
+
* Restore content
|
|
90
90
|
*
|
|
91
|
-
*
|
|
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
92
|
*/
|
|
93
|
-
export declare const
|
|
93
|
+
export declare const contentUndelete: <ThrowOnError extends boolean = false>(options: Options<ContentUndeleteData, ThrowOnError>) => RequestResult<ContentUndeleteResponses, ContentUndeleteErrors, ThrowOnError>;
|
|
94
94
|
/**
|
|
95
|
-
*
|
|
95
|
+
* Delete content
|
|
96
96
|
*
|
|
97
|
-
*
|
|
98
|
-
* the provided options. This API is experimental and may change in future releases.
|
|
97
|
+
* Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned.
|
|
99
98
|
*/
|
|
100
|
-
export declare const
|
|
99
|
+
export declare const contentDelete: <ThrowOnError extends boolean = false>(options: Options<ContentDeleteData, ThrowOnError>) => RequestResult<ContentDeleteResponses, ContentDeleteErrors, ThrowOnError>;
|
|
101
100
|
/**
|
|
102
|
-
*
|
|
101
|
+
* Get content node
|
|
103
102
|
*
|
|
104
|
-
*
|
|
103
|
+
* Get content node with the provided key.
|
|
105
104
|
*/
|
|
106
|
-
export declare const
|
|
105
|
+
export declare const contentGetNode: <ThrowOnError extends boolean = false>(options: Options<ContentGetNodeData, ThrowOnError>) => RequestResult<ContentGetNodeResponses, ContentGetNodeErrors, ThrowOnError>;
|
|
107
106
|
/**
|
|
108
|
-
*
|
|
107
|
+
* Patch content
|
|
109
108
|
*
|
|
110
|
-
*
|
|
109
|
+
* Patch an existing content item. If a content item with the provided key does not exist an error is returned.
|
|
111
110
|
*/
|
|
112
|
-
export declare const
|
|
111
|
+
export declare const contentPatchNode: <ThrowOnError extends boolean = false>(options: Options<ContentPatchNodeData, ThrowOnError>) => RequestResult<ContentPatchNodeResponses, ContentPatchNodeErrors, ThrowOnError>;
|
|
113
112
|
/**
|
|
114
|
-
*
|
|
113
|
+
* List assets
|
|
115
114
|
*
|
|
116
|
-
*
|
|
115
|
+
* List the assets that belongs to a content instance.
|
|
117
116
|
*/
|
|
118
|
-
export declare const
|
|
117
|
+
export declare const contentListAssets: <ThrowOnError extends boolean = false>(options: Options<ContentListAssetsData, ThrowOnError>) => RequestResult<ContentListAssetsResponses, ContentListAssetsErrors, ThrowOnError>;
|
|
119
118
|
/**
|
|
120
|
-
*
|
|
119
|
+
* List content in container
|
|
121
120
|
*
|
|
122
|
-
*
|
|
121
|
+
* List the content items located in a specific container.
|
|
123
122
|
*/
|
|
124
|
-
export declare const
|
|
123
|
+
export declare const contentListItems: <ThrowOnError extends boolean = false>(options: Options<ContentListItemsData, ThrowOnError>) => RequestResult<ContentListItemsResponses, ContentListItemsErrors, ThrowOnError>;
|
|
125
124
|
/**
|
|
126
|
-
*
|
|
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
|
|
127
132
|
*
|
|
128
|
-
*
|
|
133
|
+
* List versions of the content with the provided key and locale.
|
|
129
134
|
*/
|
|
130
|
-
export declare const
|
|
135
|
+
export declare const contentListLocaleVersions: <ThrowOnError extends boolean = false>(options: Options<ContentListLocaleVersionsData, ThrowOnError>) => RequestResult<ContentListLocaleVersionsResponses, ContentListLocaleVersionsErrors, ThrowOnError>;
|
|
131
136
|
/**
|
|
132
137
|
* Get content path
|
|
133
138
|
*
|
|
134
|
-
* Get the content path with the provided key.
|
|
139
|
+
* Get the content path with the provided key.
|
|
135
140
|
*/
|
|
136
|
-
export declare const contentGetPath: <ThrowOnError extends boolean = false>(options: Options<ContentGetPathData, ThrowOnError>) =>
|
|
141
|
+
export declare const contentGetPath: <ThrowOnError extends boolean = false>(options: Options<ContentGetPathData, ThrowOnError>) => RequestResult<ContentGetPathResponses, ContentGetPathErrors, ThrowOnError>;
|
|
137
142
|
/**
|
|
138
|
-
* List
|
|
143
|
+
* List versions
|
|
139
144
|
*
|
|
140
|
-
* List the content
|
|
145
|
+
* List versions of the content item with the provided key and the provided options.
|
|
141
146
|
*/
|
|
142
|
-
export declare const
|
|
147
|
+
export declare const contentListVersions: <ThrowOnError extends boolean = false>(options: Options<ContentListVersionsData, ThrowOnError>) => RequestResult<ContentListVersionsResponses, ContentListVersionsErrors, ThrowOnError>;
|
|
143
148
|
/**
|
|
144
|
-
*
|
|
149
|
+
* Create version
|
|
145
150
|
*
|
|
146
|
-
*
|
|
151
|
+
* Create a new version of a content item.
|
|
147
152
|
*/
|
|
148
|
-
export declare const
|
|
153
|
+
export declare const contentCreateVersion: <ThrowOnError extends boolean = false>(options: Options<ContentCreateVersionData, ThrowOnError>) => RequestResult<ContentCreateVersionResponses, ContentCreateVersionErrors, ThrowOnError>;
|
|
149
154
|
/**
|
|
150
|
-
*
|
|
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
|
|
151
176
|
*
|
|
152
|
-
*
|
|
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.
|
|
153
178
|
*/
|
|
154
|
-
export declare const
|
|
179
|
+
export declare const contentDeleteVersion: <ThrowOnError extends boolean = false>(options: Options<ContentDeleteVersionData, ThrowOnError>) => RequestResult<ContentDeleteVersionResponses, ContentDeleteVersionErrors, ThrowOnError>;
|
|
155
180
|
/**
|
|
156
|
-
*
|
|
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
|
|
157
188
|
*
|
|
158
|
-
*
|
|
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.
|
|
159
190
|
*/
|
|
160
|
-
export declare const
|
|
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>;
|
|
161
204
|
/**
|
|
162
205
|
* Query versions
|
|
163
206
|
*
|
|
164
|
-
* List content versions based on the provided query options.
|
|
207
|
+
* List content versions based on the provided query options.
|
|
165
208
|
*/
|
|
166
|
-
export declare const contentListAllVersions: <ThrowOnError extends boolean = false>(options?: Options<ContentListAllVersionsData, ThrowOnError>) =>
|
|
209
|
+
export declare const contentListAllVersions: <ThrowOnError extends boolean = false>(options?: Options<ContentListAllVersionsData, ThrowOnError>) => RequestResult<ContentListAllVersionsResponses, ContentListAllVersionsErrors, ThrowOnError>;
|
|
167
210
|
/**
|
|
168
|
-
*
|
|
211
|
+
* List content sources
|
|
169
212
|
*
|
|
170
|
-
*
|
|
213
|
+
* List content sources using the provided options.
|
|
171
214
|
*/
|
|
172
|
-
export declare const
|
|
215
|
+
export declare const contentSourcesList: <ThrowOnError extends boolean = false>(options?: Options<ContentSourcesListData, ThrowOnError>) => RequestResult<ContentSourcesListResponses, ContentSourcesListErrors, ThrowOnError>;
|
|
173
216
|
/**
|
|
174
|
-
*
|
|
217
|
+
* Create contentsource
|
|
175
218
|
*
|
|
176
|
-
*
|
|
219
|
+
* Create a new contentsource.
|
|
177
220
|
*/
|
|
178
|
-
export declare const
|
|
221
|
+
export declare const contentSourcesCreate: <ThrowOnError extends boolean = false>(options: Options<ContentSourcesCreateData, ThrowOnError>) => RequestResult<ContentSourcesCreateResponses, ContentSourcesCreateErrors, ThrowOnError>;
|
|
179
222
|
/**
|
|
180
|
-
*
|
|
223
|
+
* Delete contentsource
|
|
181
224
|
*
|
|
182
|
-
*
|
|
225
|
+
* Deletes the contentsource with the provided key.
|
|
183
226
|
*/
|
|
184
|
-
export declare const
|
|
227
|
+
export declare const contentSourcesDelete: <ThrowOnError extends boolean = false>(options: Options<ContentSourcesDeleteData, ThrowOnError>) => RequestResult<ContentSourcesDeleteResponses, ContentSourcesDeleteErrors, ThrowOnError>;
|
|
185
228
|
/**
|
|
186
|
-
*
|
|
229
|
+
* Get contentsource
|
|
187
230
|
*
|
|
188
|
-
*
|
|
231
|
+
* Get the contentsource with the provided key.
|
|
189
232
|
*/
|
|
190
|
-
export declare const
|
|
233
|
+
export declare const contentSourcesGet: <ThrowOnError extends boolean = false>(options: Options<ContentSourcesGetData, ThrowOnError>) => RequestResult<ContentSourcesGetResponses, ContentSourcesGetErrors, ThrowOnError>;
|
|
191
234
|
/**
|
|
192
|
-
*
|
|
235
|
+
* Patch contentsource
|
|
193
236
|
*
|
|
194
|
-
*
|
|
237
|
+
* Patch an existing contentsource.
|
|
195
238
|
*/
|
|
196
|
-
export declare const
|
|
239
|
+
export declare const contentSourcesPatch: <ThrowOnError extends boolean = false>(options: Options<ContentSourcesPatchData, ThrowOnError>) => RequestResult<ContentSourcesPatchResponses, ContentSourcesPatchErrors, ThrowOnError>;
|
|
197
240
|
/**
|
|
198
|
-
*
|
|
241
|
+
* List content type bindings
|
|
199
242
|
*
|
|
200
|
-
*
|
|
243
|
+
* List type bindings using the provided options.
|
|
201
244
|
*/
|
|
202
|
-
export declare const
|
|
245
|
+
export declare const contentTypeBindingsList: <ThrowOnError extends boolean = false>(options?: Options<ContentTypeBindingsListData, ThrowOnError>) => RequestResult<ContentTypeBindingsListResponses, ContentTypeBindingsListErrors, ThrowOnError>;
|
|
203
246
|
/**
|
|
204
|
-
*
|
|
247
|
+
* Create contenttypebinding
|
|
205
248
|
*
|
|
206
|
-
*
|
|
249
|
+
* Create a new contenttypebinding.
|
|
207
250
|
*/
|
|
208
|
-
export declare const
|
|
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>;
|
|
209
270
|
/**
|
|
210
271
|
* List content types
|
|
211
272
|
*
|
|
212
273
|
* List content types using the provided parameters.
|
|
213
274
|
*/
|
|
214
|
-
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>;
|
|
215
276
|
/**
|
|
216
277
|
* Create content type
|
|
217
278
|
*
|
|
218
279
|
* Create a new content type.
|
|
219
280
|
*/
|
|
220
|
-
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>;
|
|
221
282
|
/**
|
|
222
283
|
* Delete content type
|
|
223
284
|
*
|
|
224
|
-
* Deletes the content type with the provided key.
|
|
285
|
+
* Deletes the content type with the provided key.
|
|
225
286
|
*/
|
|
226
|
-
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>;
|
|
227
288
|
/**
|
|
228
289
|
* Get content type
|
|
229
290
|
*
|
|
230
291
|
* Get the content type with the provided key.
|
|
231
292
|
*/
|
|
232
|
-
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>;
|
|
233
294
|
/**
|
|
234
295
|
* Patch content type
|
|
235
296
|
*
|
|
236
|
-
* Patch an existing content type.
|
|
297
|
+
* Patch an existing content type.
|
|
237
298
|
*/
|
|
238
|
-
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>;
|
|
239
300
|
/**
|
|
240
301
|
* List display templates
|
|
241
302
|
*
|
|
242
303
|
* List display templates using the provided parameters.
|
|
243
304
|
*/
|
|
244
|
-
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>;
|
|
245
306
|
/**
|
|
246
307
|
* Create display template
|
|
247
308
|
*
|
|
248
309
|
* Create a new display template.
|
|
249
310
|
*/
|
|
250
|
-
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>;
|
|
251
312
|
/**
|
|
252
313
|
* Delete display template
|
|
253
314
|
*
|
|
254
315
|
* Deletes the display template with the provided key.
|
|
255
316
|
*/
|
|
256
|
-
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>;
|
|
257
318
|
/**
|
|
258
319
|
* Get display template
|
|
259
320
|
*
|
|
260
321
|
* Get the display template with the provided key.
|
|
261
322
|
*/
|
|
262
|
-
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>;
|
|
263
324
|
/**
|
|
264
325
|
* Patch display template
|
|
265
326
|
*
|
|
266
327
|
* Patch an existing display template.
|
|
267
328
|
*/
|
|
268
|
-
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>;
|
|
269
372
|
/**
|
|
270
373
|
* List property formats
|
|
271
374
|
*
|
|
272
375
|
* List all property formats using the provided options.
|
|
273
376
|
*/
|
|
274
|
-
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>;
|
|
275
378
|
/**
|
|
276
379
|
* Get property format
|
|
277
380
|
*
|
|
278
381
|
* Get the property format with the provided key.
|
|
279
382
|
*/
|
|
280
|
-
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>;
|
|
281
384
|
/**
|
|
282
385
|
* List property groups
|
|
283
386
|
*
|
|
284
387
|
* List property groups using the provided options.
|
|
285
388
|
*/
|
|
286
|
-
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>;
|
|
287
390
|
/**
|
|
288
391
|
* Create property group
|
|
289
392
|
*
|
|
290
393
|
* Create a new property group.
|
|
291
394
|
*/
|
|
292
|
-
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>;
|
|
293
396
|
/**
|
|
294
397
|
* Delete property group
|
|
295
398
|
*
|
|
296
399
|
* Deletes the property group with the provided key.
|
|
297
400
|
*/
|
|
298
|
-
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>;
|
|
299
402
|
/**
|
|
300
403
|
* Get property group
|
|
301
404
|
*
|
|
302
405
|
* Get the property group with the provided key.
|
|
303
406
|
*/
|
|
304
|
-
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>;
|
|
305
408
|
/**
|
|
306
409
|
* Patch property group
|
|
307
410
|
*
|
|
308
411
|
* Patch an existing property group.
|
|
309
412
|
*/
|
|
310
|
-
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>;
|