@remkoj/optimizely-cms-api 6.0.0-pre8 → 6.0.0-rc.1
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/LICENSE +12 -12
- package/README.md +7 -5
- package/dist/api-client.d.ts +9 -6
- package/dist/api-client.js +45 -40
- package/dist/client/client/{client.d.ts → client.gen.d.ts} +1 -1
- package/dist/client/client/client.gen.js +239 -0
- package/dist/client/client/index.d.ts +8 -7
- package/dist/client/client/index.js +15 -12
- package/dist/client/client/{types.d.ts → types.gen.d.ts} +17 -19
- package/dist/client/{core/types.js → client/types.gen.js} +1 -0
- package/dist/client/client/{utils.d.ts → utils.gen.d.ts} +9 -21
- package/dist/client/client/{utils.js → utils.gen.js} +67 -124
- package/dist/client/client.gen.d.ts +3 -3
- package/dist/client/client.gen.js +2 -4
- package/dist/client/core/{auth.js → auth.gen.js} +1 -0
- package/dist/client/core/bodySerializer.gen.d.ts +25 -0
- package/dist/client/core/{bodySerializer.js → bodySerializer.gen.js} +5 -1
- package/dist/client/core/{params.d.ts → params.gen.d.ts} +20 -0
- package/dist/client/core/{params.js → params.gen.js} +19 -6
- package/dist/client/core/{pathSerializer.js → pathSerializer.gen.js} +4 -11
- package/dist/client/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/client/core/queryKeySerializer.gen.js +98 -0
- package/dist/client/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/client/core/serverSentEvents.gen.js +137 -0
- package/dist/client/core/{types.d.ts → types.gen.d.ts} +19 -14
- package/dist/client/{client/types.js → core/types.gen.js} +1 -0
- package/dist/client/core/utils.gen.d.ts +19 -0
- package/dist/client/core/utils.gen.js +93 -0
- package/dist/client/index.d.ts +4 -4
- package/dist/client/index.js +99 -19
- package/dist/client/sdk.gen.d.ts +124 -70
- package/dist/client/sdk.gen.js +448 -490
- package/dist/client/transformers.gen.d.ts +14 -4
- package/dist/client/transformers.gen.js +143 -59
- package/dist/client/types.gen.d.ts +1231 -856
- package/dist/client/types.gen.js +0 -84
- package/dist/client-config.d.ts +5 -2
- package/dist/client-config.js +42 -14
- package/dist/config.d.ts +2 -3
- package/dist/config.js +13 -42
- package/dist/getaccesstoken.d.ts +1 -1
- package/dist/getaccesstoken.js +9 -7
- package/dist/index.d.ts +3 -1
- package/dist/index.js +7 -1
- package/dist/types.d.ts +3 -1
- package/dist/types.js +1 -0
- package/dist/version.json +3 -3
- package/package.json +11 -15
- package/dist/client/client/client.js +0 -149
- package/dist/client/core/bodySerializer.d.ts +0 -17
- /package/dist/client/core/{auth.d.ts → auth.gen.d.ts} +0 -0
- /package/dist/client/core/{pathSerializer.d.ts → pathSerializer.gen.d.ts} +0 -0
package/dist/client/sdk.gen.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type { Options as
|
|
2
|
-
import type {
|
|
3
|
-
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> =
|
|
1
|
+
import type { Client, Options as Options2, TDataShape } from './client';
|
|
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, ContentGetPreviewsData, ContentGetPreviewsErrors, ContentGetPreviewsResponses, 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
|
+
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
|
|
6
6
|
* individual options. This might be also useful if you want to implement a
|
|
@@ -13,244 +13,298 @@ 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">;
|
|
16
46
|
/**
|
|
17
47
|
* List changeset
|
|
18
|
-
*
|
|
48
|
+
*
|
|
49
|
+
* Lists all changeset using the provided options. This API is experimental and may change in future releases.
|
|
19
50
|
*/
|
|
20
51
|
export declare const changesetsList: <ThrowOnError extends boolean = false>(options?: Options<ChangesetsListData, ThrowOnError>) => import("./client").RequestResult<ChangesetsListResponses, ChangesetsListErrors, ThrowOnError, "fields">;
|
|
21
52
|
/**
|
|
22
53
|
* Create changeset
|
|
23
|
-
*
|
|
54
|
+
*
|
|
55
|
+
* Creates a new changeset. This API is experimental and may change in future releases.
|
|
24
56
|
*/
|
|
25
57
|
export declare const changesetsCreate: <ThrowOnError extends boolean = false>(options: Options<ChangesetsCreateData, ThrowOnError>) => import("./client").RequestResult<ChangesetsCreateResponses, ChangesetsCreateErrors, ThrowOnError, "fields">;
|
|
26
58
|
/**
|
|
27
59
|
* Delete changeset
|
|
28
|
-
*
|
|
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.
|
|
29
62
|
*/
|
|
30
63
|
export declare const changesetsDelete: <ThrowOnError extends boolean = false>(options: Options<ChangesetsDeleteData, ThrowOnError>) => import("./client").RequestResult<ChangesetsDeleteResponses, ChangesetsDeleteErrors, ThrowOnError, "fields">;
|
|
31
64
|
/**
|
|
32
65
|
* Get changeset
|
|
33
|
-
*
|
|
66
|
+
*
|
|
67
|
+
* Gets the changeset with the provided key. This API is experimental and may change in future releases.
|
|
34
68
|
*/
|
|
35
69
|
export declare const changesetsGet: <ThrowOnError extends boolean = false>(options: Options<ChangesetsGetData, ThrowOnError>) => import("./client").RequestResult<ChangesetsGetResponses, ChangesetsGetErrors, ThrowOnError, "fields">;
|
|
36
70
|
/**
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
71
|
+
* Patch changeset
|
|
72
|
+
*
|
|
73
|
+
* Patch an existing changeset. This API is experimental and may change in future releases.
|
|
40
74
|
*/
|
|
41
|
-
export declare const
|
|
75
|
+
export declare const changesetsPatch: <ThrowOnError extends boolean = false>(options: Options<ChangesetsPatchData, ThrowOnError>) => import("./client").RequestResult<ChangesetsPatchResponses, ChangesetsPatchErrors, ThrowOnError, "fields">;
|
|
42
76
|
/**
|
|
43
77
|
* Delete changeset item
|
|
44
|
-
*
|
|
78
|
+
*
|
|
79
|
+
* Deletes the specified changeset item from the changeset. This API is experimental and may change in future releases.
|
|
45
80
|
*/
|
|
46
81
|
export declare const changesetsDeleteItem: <ThrowOnError extends boolean = false>(options: Options<ChangesetsDeleteItemData, ThrowOnError>) => import("./client").RequestResult<ChangesetsDeleteItemResponses, ChangesetsDeleteItemErrors, ThrowOnError, "fields">;
|
|
47
82
|
/**
|
|
48
83
|
* Get changeset item
|
|
49
|
-
*
|
|
84
|
+
*
|
|
85
|
+
* Gets the changeset item for the specified content reference. This API is experimental and may change in future releases.
|
|
50
86
|
*/
|
|
51
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">;
|
|
52
94
|
/**
|
|
53
95
|
* List changeset items
|
|
96
|
+
*
|
|
54
97
|
* Lists the available changeset items for the specified changeset using
|
|
55
|
-
* the provided options.
|
|
98
|
+
* the provided options. This API is experimental and may change in future releases.
|
|
56
99
|
*/
|
|
57
100
|
export declare const changesetsListItems: <ThrowOnError extends boolean = false>(options: Options<ChangesetsListItemsData, ThrowOnError>) => import("./client").RequestResult<ChangesetsListItemsResponses, ChangesetsListItemsErrors, ThrowOnError, "fields">;
|
|
58
101
|
/**
|
|
59
102
|
* Create changeset item
|
|
60
|
-
*
|
|
103
|
+
*
|
|
104
|
+
* Creates the given changeset item. This API is experimental and may change in future releases.
|
|
61
105
|
*/
|
|
62
106
|
export declare const changesetsCreateItem: <ThrowOnError extends boolean = false>(options: Options<ChangesetsCreateItemData, ThrowOnError>) => import("./client").RequestResult<ChangesetsCreateItemResponses, ChangesetsCreateItemErrors, ThrowOnError, "fields">;
|
|
63
|
-
/**
|
|
64
|
-
* Update changeset item
|
|
65
|
-
* Updates the given changeset item.
|
|
66
|
-
*/
|
|
67
|
-
export declare const changesetsUpdateItem: <ThrowOnError extends boolean = false>(options: Options<ChangesetsUpdateItemData, ThrowOnError>) => import("./client").RequestResult<ChangesetsUpdateItemResponses, ChangesetsUpdateItemErrors, ThrowOnError, "fields">;
|
|
68
107
|
/**
|
|
69
108
|
* Create content
|
|
70
|
-
*
|
|
109
|
+
*
|
|
110
|
+
* Create a new content item. This API is experimental and may change in future releases.
|
|
71
111
|
*/
|
|
72
112
|
export declare const contentCreate: <ThrowOnError extends boolean = false>(options: Options<ContentCreateData, ThrowOnError>) => import("./client").RequestResult<ContentCreateResponses, ContentCreateErrors, ThrowOnError, "fields">;
|
|
73
113
|
/**
|
|
74
114
|
* Delete content
|
|
75
|
-
*
|
|
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.
|
|
76
117
|
*/
|
|
77
118
|
export declare const contentDelete: <ThrowOnError extends boolean = false>(options: Options<ContentDeleteData, ThrowOnError>) => import("./client").RequestResult<ContentDeleteResponses, ContentDeleteErrors, ThrowOnError, "fields">;
|
|
78
119
|
/**
|
|
79
120
|
* Get content
|
|
80
|
-
*
|
|
121
|
+
*
|
|
122
|
+
* Get shared metadata about the content instance with the provided key. This API is experimental and may change in future releases.
|
|
81
123
|
*/
|
|
82
124
|
export declare const contentGetMetadata: <ThrowOnError extends boolean = false>(options: Options<ContentGetMetadataData, ThrowOnError>) => import("./client").RequestResult<ContentGetMetadataResponses, ContentGetMetadataErrors, ThrowOnError, "fields">;
|
|
83
125
|
/**
|
|
84
|
-
*
|
|
85
|
-
*
|
|
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.
|
|
86
129
|
*/
|
|
87
130
|
export declare const contentPatchMetadata: <ThrowOnError extends boolean = false>(options: Options<ContentPatchMetadataData, ThrowOnError>) => import("./client").RequestResult<ContentPatchMetadataResponses, ContentPatchMetadataErrors, ThrowOnError, "fields">;
|
|
88
131
|
/**
|
|
89
132
|
* Get content path
|
|
90
|
-
*
|
|
133
|
+
*
|
|
134
|
+
* Get the content path with the provided key. This API is experimental and may change in future releases.
|
|
91
135
|
*/
|
|
92
136
|
export declare const contentGetPath: <ThrowOnError extends boolean = false>(options: Options<ContentGetPathData, ThrowOnError>) => import("./client").RequestResult<ContentGetPathResponses, ContentGetPathErrors, ThrowOnError, "fields">;
|
|
93
137
|
/**
|
|
94
138
|
* List content in container
|
|
95
|
-
*
|
|
139
|
+
*
|
|
140
|
+
* List the content items located in a specific container. This API is experimental and may change in future releases.
|
|
96
141
|
*/
|
|
97
142
|
export declare const contentListItems: <ThrowOnError extends boolean = false>(options: Options<ContentListItemsData, ThrowOnError>) => import("./client").RequestResult<ContentListItemsResponses, ContentListItemsErrors, ThrowOnError, "fields">;
|
|
98
143
|
/**
|
|
99
144
|
* List assets
|
|
100
|
-
*
|
|
145
|
+
*
|
|
146
|
+
* List the assets that belongs to a content instance. This API is experimental and may change in future releases.
|
|
101
147
|
*/
|
|
102
148
|
export declare const contentListAssets: <ThrowOnError extends boolean = false>(options: Options<ContentListAssetsData, ThrowOnError>) => import("./client").RequestResult<ContentListAssetsResponses, ContentListAssetsErrors, ThrowOnError, "fields">;
|
|
103
149
|
/**
|
|
104
150
|
* Copy content
|
|
105
|
-
*
|
|
151
|
+
*
|
|
152
|
+
* Create a copy of the content item with the provided key. This API is experimental and may change in future releases.
|
|
106
153
|
*/
|
|
107
154
|
export declare const contentCopy: <ThrowOnError extends boolean = false>(options: Options<ContentCopyData, ThrowOnError>) => import("./client").RequestResult<ContentCopyResponses, ContentCopyErrors, ThrowOnError, "fields">;
|
|
108
155
|
/**
|
|
109
156
|
* Restore content
|
|
110
|
-
*
|
|
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.
|
|
111
159
|
*/
|
|
112
160
|
export declare const contentUndelete: <ThrowOnError extends boolean = false>(options: Options<ContentUndeleteData, ThrowOnError>) => import("./client").RequestResult<ContentUndeleteResponses, ContentUndeleteErrors, ThrowOnError, "fields">;
|
|
113
161
|
/**
|
|
114
162
|
* Query versions
|
|
115
|
-
*
|
|
163
|
+
*
|
|
164
|
+
* List content versions based on the provided query options. This API is experimental and may change in future releases.
|
|
116
165
|
*/
|
|
117
166
|
export declare const contentListAllVersions: <ThrowOnError extends boolean = false>(options?: Options<ContentListAllVersionsData, ThrowOnError>) => import("./client").RequestResult<ContentListAllVersionsResponses, ContentListAllVersionsErrors, ThrowOnError, "fields">;
|
|
118
167
|
/**
|
|
119
168
|
* Delete locale
|
|
120
|
-
*
|
|
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.
|
|
121
171
|
*/
|
|
122
172
|
export declare const contentDeleteLocale: <ThrowOnError extends boolean = false>(options: Options<ContentDeleteLocaleData, ThrowOnError>) => import("./client").RequestResult<ContentDeleteLocaleResponses, ContentDeleteLocaleErrors, ThrowOnError, "fields">;
|
|
123
173
|
/**
|
|
124
174
|
* List versions
|
|
125
|
-
*
|
|
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.
|
|
126
177
|
*/
|
|
127
178
|
export declare const contentListVersions: <ThrowOnError extends boolean = false>(options: Options<ContentListVersionsData, ThrowOnError>) => import("./client").RequestResult<ContentListVersionsResponses, ContentListVersionsErrors, ThrowOnError, "fields">;
|
|
128
179
|
/**
|
|
129
180
|
* Create version
|
|
130
|
-
*
|
|
181
|
+
*
|
|
182
|
+
* Create a new version of a content item. This API is experimental and may change in future releases.
|
|
131
183
|
*/
|
|
132
184
|
export declare const contentCreateVersion: <ThrowOnError extends boolean = false>(options: Options<ContentCreateVersionData, ThrowOnError>) => import("./client").RequestResult<ContentCreateVersionResponses, ContentCreateVersionErrors, ThrowOnError, "fields">;
|
|
133
185
|
/**
|
|
134
186
|
* Delete version
|
|
135
|
-
*
|
|
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.
|
|
136
189
|
*/
|
|
137
190
|
export declare const contentDeleteVersion: <ThrowOnError extends boolean = false>(options: Options<ContentDeleteVersionData, ThrowOnError>) => import("./client").RequestResult<ContentDeleteVersionResponses, ContentDeleteVersionErrors, ThrowOnError, "fields">;
|
|
138
191
|
/**
|
|
139
192
|
* Get version
|
|
140
|
-
*
|
|
193
|
+
*
|
|
194
|
+
* Get the content item with the provided key and version. This API is experimental and may change in future releases.
|
|
141
195
|
*/
|
|
142
196
|
export declare const contentGetVersion: <ThrowOnError extends boolean = false>(options: Options<ContentGetVersionData, ThrowOnError>) => import("./client").RequestResult<ContentGetVersionResponses, ContentGetVersionErrors, ThrowOnError, "fields">;
|
|
143
197
|
/**
|
|
144
|
-
*
|
|
145
|
-
*
|
|
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.
|
|
146
201
|
*/
|
|
147
202
|
export declare const contentPatchVersion: <ThrowOnError extends boolean = false>(options: Options<ContentPatchVersionData, ThrowOnError>) => import("./client").RequestResult<ContentPatchVersionResponses, ContentPatchVersionErrors, ThrowOnError, "fields">;
|
|
203
|
+
/**
|
|
204
|
+
* Get previews
|
|
205
|
+
*
|
|
206
|
+
* Generate preview URLs for the content item with fresh authentication tokens. This API is experimental and may change in future releases.
|
|
207
|
+
*/
|
|
208
|
+
export declare const contentGetPreviews: <ThrowOnError extends boolean = false>(options: Options<ContentGetPreviewsData, ThrowOnError>) => import("./client").RequestResult<ContentGetPreviewsResponses, ContentGetPreviewsErrors, ThrowOnError, "fields">;
|
|
148
209
|
/**
|
|
149
210
|
* List content types
|
|
150
|
-
*
|
|
211
|
+
*
|
|
212
|
+
* List content types using the provided parameters.
|
|
151
213
|
*/
|
|
152
214
|
export declare const contentTypesList: <ThrowOnError extends boolean = false>(options?: Options<ContentTypesListData, ThrowOnError>) => import("./client").RequestResult<ContentTypesListResponses, ContentTypesListErrors, ThrowOnError, "fields">;
|
|
153
215
|
/**
|
|
154
216
|
* Create content type
|
|
217
|
+
*
|
|
155
218
|
* Create a new content type.
|
|
156
219
|
*/
|
|
157
220
|
export declare const contentTypesCreate: <ThrowOnError extends boolean = false>(options: Options<ContentTypesCreateData, ThrowOnError>) => import("./client").RequestResult<ContentTypesCreateResponses, ContentTypesCreateErrors, ThrowOnError, "fields">;
|
|
158
221
|
/**
|
|
159
222
|
* Delete content type
|
|
223
|
+
*
|
|
160
224
|
* Deletes the content type with the provided key. If a content type with the provided key does not exist an error is returned.
|
|
161
225
|
*/
|
|
162
226
|
export declare const contentTypesDelete: <ThrowOnError extends boolean = false>(options: Options<ContentTypesDeleteData, ThrowOnError>) => import("./client").RequestResult<ContentTypesDeleteResponses, ContentTypesDeleteErrors, ThrowOnError, "fields">;
|
|
163
227
|
/**
|
|
164
228
|
* Get content type
|
|
229
|
+
*
|
|
165
230
|
* Get the content type with the provided key.
|
|
166
231
|
*/
|
|
167
232
|
export declare const contentTypesGet: <ThrowOnError extends boolean = false>(options: Options<ContentTypesGetData, ThrowOnError>) => import("./client").RequestResult<ContentTypesGetResponses, ContentTypesGetErrors, ThrowOnError, "fields">;
|
|
168
233
|
/**
|
|
169
|
-
*
|
|
170
|
-
*
|
|
234
|
+
* Patch content type
|
|
235
|
+
*
|
|
236
|
+
* Patch an existing content type. If a content type with the provided key does not exist an error is returned.
|
|
171
237
|
*/
|
|
172
238
|
export declare const contentTypesPatch: <ThrowOnError extends boolean = false>(options: Options<ContentTypesPatchData, ThrowOnError>) => import("./client").RequestResult<ContentTypesPatchResponses, ContentTypesPatchErrors, ThrowOnError, "fields">;
|
|
173
|
-
/**
|
|
174
|
-
* Create or replace content type
|
|
175
|
-
* Create or replace a content type. If a content type with the provided key exist it is replaced.
|
|
176
|
-
* Otherwise a new content type is created.
|
|
177
|
-
*/
|
|
178
|
-
export declare const contentTypesPut: <ThrowOnError extends boolean = false>(options: Options<ContentTypesPutData, ThrowOnError>) => import("./client").RequestResult<ContentTypesPutResponses, ContentTypesPutErrors, ThrowOnError, "fields">;
|
|
179
239
|
/**
|
|
180
240
|
* List display templates
|
|
181
|
-
*
|
|
241
|
+
*
|
|
242
|
+
* List display templates using the provided parameters.
|
|
182
243
|
*/
|
|
183
244
|
export declare const displayTemplatesList: <ThrowOnError extends boolean = false>(options?: Options<DisplayTemplatesListData, ThrowOnError>) => import("./client").RequestResult<DisplayTemplatesListResponses, DisplayTemplatesListErrors, ThrowOnError, "fields">;
|
|
184
245
|
/**
|
|
185
246
|
* Create display template
|
|
247
|
+
*
|
|
186
248
|
* Create a new display template.
|
|
187
249
|
*/
|
|
188
250
|
export declare const displayTemplatesCreate: <ThrowOnError extends boolean = false>(options: Options<DisplayTemplatesCreateData, ThrowOnError>) => import("./client").RequestResult<DisplayTemplatesCreateResponses, DisplayTemplatesCreateErrors, ThrowOnError, "fields">;
|
|
189
251
|
/**
|
|
190
252
|
* Delete display template
|
|
253
|
+
*
|
|
191
254
|
* Deletes the display template with the provided key.
|
|
192
255
|
*/
|
|
193
256
|
export declare const displayTemplatesDelete: <ThrowOnError extends boolean = false>(options: Options<DisplayTemplatesDeleteData, ThrowOnError>) => import("./client").RequestResult<DisplayTemplatesDeleteResponses, DisplayTemplatesDeleteErrors, ThrowOnError, "fields">;
|
|
194
257
|
/**
|
|
195
258
|
* Get display template
|
|
259
|
+
*
|
|
196
260
|
* Get the display template with the provided key.
|
|
197
261
|
*/
|
|
198
262
|
export declare const displayTemplatesGet: <ThrowOnError extends boolean = false>(options: Options<DisplayTemplatesGetData, ThrowOnError>) => import("./client").RequestResult<DisplayTemplatesGetResponses, DisplayTemplatesGetErrors, ThrowOnError, "fields">;
|
|
199
263
|
/**
|
|
200
|
-
*
|
|
201
|
-
*
|
|
264
|
+
* Patch display template
|
|
265
|
+
*
|
|
266
|
+
* Patch an existing display template.
|
|
202
267
|
*/
|
|
203
268
|
export declare const displayTemplatesPatch: <ThrowOnError extends boolean = false>(options: Options<DisplayTemplatesPatchData, ThrowOnError>) => import("./client").RequestResult<DisplayTemplatesPatchResponses, DisplayTemplatesPatchErrors, ThrowOnError, "fields">;
|
|
204
|
-
/**
|
|
205
|
-
* Create or replace a display template
|
|
206
|
-
* Create or replace a display template. If a display template with the provided key exist it is replaced.
|
|
207
|
-
* Otherwise a new display template is created.
|
|
208
|
-
*/
|
|
209
|
-
export declare const displayTemplatesPut: <ThrowOnError extends boolean = false>(options: Options<DisplayTemplatesPutData, ThrowOnError>) => import("./client").RequestResult<DisplayTemplatesPutResponses, DisplayTemplatesPutErrors, ThrowOnError, "fields">;
|
|
210
|
-
/**
|
|
211
|
-
* Request access token
|
|
212
|
-
* Request an access token. This endpoint only supports the 'client_credentials' grant type
|
|
213
|
-
* and will only issue short-lived tokens.
|
|
214
|
-
*/
|
|
215
|
-
export declare const oauthToken: <ThrowOnError extends boolean = false>(options: Options<OauthTokenData, ThrowOnError>) => import("./client").RequestResult<OauthTokenResponses, OauthTokenErrors, ThrowOnError, "fields">;
|
|
216
269
|
/**
|
|
217
270
|
* List property formats
|
|
271
|
+
*
|
|
218
272
|
* List all property formats using the provided options.
|
|
219
273
|
*/
|
|
220
274
|
export declare const propertyFormatsList: <ThrowOnError extends boolean = false>(options?: Options<PropertyFormatsListData, ThrowOnError>) => import("./client").RequestResult<PropertyFormatsListResponses, PropertyFormatsListErrors, ThrowOnError, "fields">;
|
|
221
275
|
/**
|
|
222
276
|
* Get property format
|
|
277
|
+
*
|
|
223
278
|
* Get the property format with the provided key.
|
|
224
279
|
*/
|
|
225
280
|
export declare const propertyFormatsGet: <ThrowOnError extends boolean = false>(options: Options<PropertyFormatsGetData, ThrowOnError>) => import("./client").RequestResult<PropertyFormatsGetResponses, PropertyFormatsGetErrors, ThrowOnError, "fields">;
|
|
226
281
|
/**
|
|
227
282
|
* List property groups
|
|
283
|
+
*
|
|
228
284
|
* List property groups using the provided options.
|
|
229
285
|
*/
|
|
230
286
|
export declare const propertyGroupsList: <ThrowOnError extends boolean = false>(options?: Options<PropertyGroupsListData, ThrowOnError>) => import("./client").RequestResult<PropertyGroupsListResponses, PropertyGroupsListErrors, ThrowOnError, "fields">;
|
|
231
287
|
/**
|
|
232
288
|
* Create property group
|
|
289
|
+
*
|
|
233
290
|
* Create a new property group.
|
|
234
291
|
*/
|
|
235
292
|
export declare const propertyGroupsCreate: <ThrowOnError extends boolean = false>(options: Options<PropertyGroupsCreateData, ThrowOnError>) => import("./client").RequestResult<PropertyGroupsCreateResponses, PropertyGroupsCreateErrors, ThrowOnError, "fields">;
|
|
236
293
|
/**
|
|
237
294
|
* Delete property group
|
|
295
|
+
*
|
|
238
296
|
* Deletes the property group with the provided key.
|
|
239
297
|
*/
|
|
240
298
|
export declare const propertyGroupsDelete: <ThrowOnError extends boolean = false>(options: Options<PropertyGroupsDeleteData, ThrowOnError>) => import("./client").RequestResult<PropertyGroupsDeleteResponses, PropertyGroupsDeleteErrors, ThrowOnError, "fields">;
|
|
241
299
|
/**
|
|
242
300
|
* Get property group
|
|
301
|
+
*
|
|
243
302
|
* Get the property group with the provided key.
|
|
244
303
|
*/
|
|
245
304
|
export declare const propertyGroupsGet: <ThrowOnError extends boolean = false>(options: Options<PropertyGroupsGetData, ThrowOnError>) => import("./client").RequestResult<PropertyGroupsGetResponses, PropertyGroupsGetErrors, ThrowOnError, "fields">;
|
|
246
305
|
/**
|
|
247
|
-
*
|
|
248
|
-
*
|
|
306
|
+
* Patch property group
|
|
307
|
+
*
|
|
308
|
+
* Patch an existing property group.
|
|
249
309
|
*/
|
|
250
310
|
export declare const propertyGroupsPatch: <ThrowOnError extends boolean = false>(options: Options<PropertyGroupsPatchData, ThrowOnError>) => import("./client").RequestResult<PropertyGroupsPatchResponses, PropertyGroupsPatchErrors, ThrowOnError, "fields">;
|
|
251
|
-
/**
|
|
252
|
-
* Create or replace property group
|
|
253
|
-
* Create or replace a property group. If a property group with the provided key exist it is replaced.
|
|
254
|
-
* Otherwise a new property group is created.
|
|
255
|
-
*/
|
|
256
|
-
export declare const propertyGroupsPut: <ThrowOnError extends boolean = false>(options: Options<PropertyGroupsPutData, ThrowOnError>) => import("./client").RequestResult<PropertyGroupsPutResponses, PropertyGroupsPutErrors, ThrowOnError, "fields">;
|