@remkoj/optimizely-cms-api 6.0.0-pre12 → 6.0.0-pre13

package/dist/api-client.js

@@ -110,10 +110,10 @@ class BaseApiClient {
         // Store instance variables
         this._config = config ?? (0, config_1.readEnvConfig)();
         this._client = (0, client_1.createClient)((0, client_config_1.createClientConfig)((0, client_1.createConfig)({
-            baseUrl: 'https://api.cms.optimizely.com/preview3'
+            baseUrl: 'https://api.cms.optimizely.com/preview3',
         }), this._config));
         this._instanceClient = (0, client_2.createClient)((0, client_config_1.createClientConfig)((0, client_2.createConfig)({
-            baseUrl: new URL('/_cms/preview2', this._config.base).href
+            baseUrl: new URL('/_cms/preview2', this._config.base).href,
         })));
         // Configure Client
         if (this._config.debug) {

package/dist/client/sdk.gen.d.ts

@@ -1,5 +1,5 @@
 import type { Client, Options as Options2, TDataShape } from './client';
-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';
+import type { BlueprintsCreateData, BlueprintsCreateErrors, BlueprintsCreateResponses, BlueprintsDeleteData, BlueprintsDeleteErrors, BlueprintsDeleteResponses, BlueprintsGetData, BlueprintsGetErrors, BlueprintsGetResponses, BlueprintsListData, BlueprintsListErrors, BlueprintsListResponses, BlueprintsPatchData, BlueprintsPatchErrors, BlueprintsPatchResponses, ChangesetsCreateData, ChangesetsCreateErrors, ChangesetsCreateItemData, ChangesetsCreateItemErrors, ChangesetsCreateItemResponses, ChangesetsCreateResponses, ChangesetsDeleteData, ChangesetsDeleteErrors, ChangesetsDeleteItemData, ChangesetsDeleteItemErrors, ChangesetsDeleteItemResponses, ChangesetsDeleteResponses, ChangesetsGetData, ChangesetsGetErrors, ChangesetsGetItemData, ChangesetsGetItemErrors, ChangesetsGetItemResponses, ChangesetsGetResponses, ChangesetsListData, ChangesetsListErrors, ChangesetsListItemsData, ChangesetsListItemsErrors, ChangesetsListItemsResponses, ChangesetsListResponses, ChangesetsPatchData, ChangesetsPatchErrors, ChangesetsPatchItemData, ChangesetsPatchItemErrors, ChangesetsPatchItemResponses, ChangesetsPatchResponses, ContentCopyData, ContentCopyErrors, ContentCopyResponses, ContentCreateData, ContentCreateErrors, ContentCreateResponses, ContentCreateVersionData, ContentCreateVersionErrors, ContentCreateVersionResponses, ContentDeleteData, ContentDeleteErrors, ContentDeleteLocaleData, ContentDeleteLocaleErrors, ContentDeleteLocaleResponses, ContentDeleteResponses, ContentDeleteVersionData, ContentDeleteVersionErrors, ContentDeleteVersionResponses, ContentGetMetadataData, ContentGetMetadataErrors, ContentGetMetadataResponses, ContentGetPathData, ContentGetPathErrors, ContentGetPathResponses, ContentGetVersionData, ContentGetVersionErrors, ContentGetVersionResponses, ContentListAllVersionsData, ContentListAllVersionsErrors, ContentListAllVersionsResponses, ContentListAssetsData, ContentListAssetsErrors, ContentListAssetsResponses, ContentListItemsData, ContentListItemsErrors, ContentListItemsResponses, ContentListVersionsData, ContentListVersionsErrors, ContentListVersionsResponses, ContentPatchMetadataData, ContentPatchMetadataErrors, ContentPatchMetadataResponses, ContentPatchVersionData, ContentPatchVersionErrors, ContentPatchVersionResponses, ContentTypesCreateData, ContentTypesCreateErrors, ContentTypesCreateResponses, ContentTypesDeleteData, ContentTypesDeleteErrors, ContentTypesDeleteResponses, ContentTypesGetData, ContentTypesGetErrors, ContentTypesGetResponses, ContentTypesListData, ContentTypesListErrors, ContentTypesListResponses, ContentTypesPatchData, ContentTypesPatchErrors, ContentTypesPatchResponses, ContentUndeleteData, ContentUndeleteErrors, ContentUndeleteResponses, DisplayTemplatesCreateData, DisplayTemplatesCreateErrors, DisplayTemplatesCreateResponses, DisplayTemplatesDeleteData, DisplayTemplatesDeleteErrors, DisplayTemplatesDeleteResponses, DisplayTemplatesGetData, DisplayTemplatesGetErrors, DisplayTemplatesGetResponses, DisplayTemplatesListData, DisplayTemplatesListErrors, DisplayTemplatesListResponses, DisplayTemplatesPatchData, DisplayTemplatesPatchErrors, DisplayTemplatesPatchResponses, PropertyFormatsGetData, PropertyFormatsGetErrors, PropertyFormatsGetResponses, PropertyFormatsListData, PropertyFormatsListErrors, PropertyFormatsListResponses, PropertyGroupsCreateData, PropertyGroupsCreateErrors, PropertyGroupsCreateResponses, PropertyGroupsDeleteData, PropertyGroupsDeleteErrors, PropertyGroupsDeleteResponses, PropertyGroupsGetData, PropertyGroupsGetErrors, PropertyGroupsGetResponses, PropertyGroupsListData, PropertyGroupsListErrors, PropertyGroupsListResponses, PropertyGroupsPatchData, PropertyGroupsPatchErrors, PropertyGroupsPatchResponses } from './types.gen';
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
     /**
      * You can provide a client instance returned by `createClient()` instead of
@@ -13,6 +13,193 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
      */
     meta?: Record<string, unknown>;
 };
+/**
+ * List blueprints
+ *
+ * List blueprints using the provided parameters. This API is experimental and may change in future releases.
+ */
+export declare const blueprintsList: <ThrowOnError extends boolean = false>(options?: Options<BlueprintsListData, ThrowOnError>) => import("./client").RequestResult<BlueprintsListResponses, BlueprintsListErrors, ThrowOnError, "fields">;
+/**
+ * Create a blueprint
+ *
+ * Create a new blueprint. This API is experimental and may change in future releases.
+ */
+export declare const blueprintsCreate: <ThrowOnError extends boolean = false>(options: Options<BlueprintsCreateData, ThrowOnError>) => import("./client").RequestResult<BlueprintsCreateResponses, BlueprintsCreateErrors, ThrowOnError, "fields">;
+/**
+ * Delete a blueprint
+ *
+ * Deletes the blueprint with the provided key. This API is experimental and may change in future releases.
+ */
+export declare const blueprintsDelete: <ThrowOnError extends boolean = false>(options: Options<BlueprintsDeleteData, ThrowOnError>) => import("./client").RequestResult<BlueprintsDeleteResponses, BlueprintsDeleteErrors, ThrowOnError, "fields">;
+/**
+ * Get a specific blueprint
+ *
+ * Get the blueprint with the provided key. This API is experimental and may change in future releases.
+ */
+export declare const blueprintsGet: <ThrowOnError extends boolean = false>(options: Options<BlueprintsGetData, ThrowOnError>) => import("./client").RequestResult<BlueprintsGetResponses, BlueprintsGetErrors, ThrowOnError, "fields">;
+/**
+ * Patch blueprint
+ *
+ * Patch an existing blueprint. This API is experimental and may change in future releases.
+ */
+export declare const blueprintsPatch: <ThrowOnError extends boolean = false>(options: Options<BlueprintsPatchData, ThrowOnError>) => import("./client").RequestResult<BlueprintsPatchResponses, BlueprintsPatchErrors, ThrowOnError, "fields">;
+/**
+ * List changeset
+ *
+ * Lists all changeset using the provided options. This API is experimental and may change in future releases.
+ */
+export declare const changesetsList: <ThrowOnError extends boolean = false>(options?: Options<ChangesetsListData, ThrowOnError>) => import("./client").RequestResult<ChangesetsListResponses, ChangesetsListErrors, ThrowOnError, "fields">;
+/**
+ * Create changeset
+ *
+ * Creates a new changeset. This API is experimental and may change in future releases.
+ */
+export declare const changesetsCreate: <ThrowOnError extends boolean = false>(options: Options<ChangesetsCreateData, ThrowOnError>) => import("./client").RequestResult<ChangesetsCreateResponses, ChangesetsCreateErrors, ThrowOnError, "fields">;
+/**
+ * Delete changeset
+ *
+ * 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.
+ */
+export declare const changesetsDelete: <ThrowOnError extends boolean = false>(options: Options<ChangesetsDeleteData, ThrowOnError>) => import("./client").RequestResult<ChangesetsDeleteResponses, ChangesetsDeleteErrors, ThrowOnError, "fields">;
+/**
+ * Get changeset
+ *
+ * Gets the changeset with the provided key. This API is experimental and may change in future releases.
+ */
+export declare const changesetsGet: <ThrowOnError extends boolean = false>(options: Options<ChangesetsGetData, ThrowOnError>) => import("./client").RequestResult<ChangesetsGetResponses, ChangesetsGetErrors, ThrowOnError, "fields">;
+/**
+ * Patch changeset
+ *
+ * Patch an existing changeset. This API is experimental and may change in future releases.
+ */
+export declare const changesetsPatch: <ThrowOnError extends boolean = false>(options: Options<ChangesetsPatchData, ThrowOnError>) => import("./client").RequestResult<ChangesetsPatchResponses, ChangesetsPatchErrors, ThrowOnError, "fields">;
+/**
+ * Delete changeset item
+ *
+ * Deletes the specified changeset item from the changeset. This API is experimental and may change in future releases.
+ */
+export declare const changesetsDeleteItem: <ThrowOnError extends boolean = false>(options: Options<ChangesetsDeleteItemData, ThrowOnError>) => import("./client").RequestResult<ChangesetsDeleteItemResponses, ChangesetsDeleteItemErrors, ThrowOnError, "fields">;
+/**
+ * Get changeset item
+ *
+ * Gets the changeset item for the specified content reference. This API is experimental and may change in future releases.
+ */
+export declare const changesetsGetItem: <ThrowOnError extends boolean = false>(options: Options<ChangesetsGetItemData, ThrowOnError>) => import("./client").RequestResult<ChangesetsGetItemResponses, ChangesetsGetItemErrors, ThrowOnError, "fields">;
+/**
+ * Patch changeset item
+ *
+ * Patch the given changeset item. This API is experimental and may change in future releases.
+ */
+export declare const changesetsPatchItem: <ThrowOnError extends boolean = false>(options: Options<ChangesetsPatchItemData, ThrowOnError>) => import("./client").RequestResult<ChangesetsPatchItemResponses, ChangesetsPatchItemErrors, ThrowOnError, "fields">;
+/**
+ * List changeset items
+ *
+ * Lists the available changeset items for the specified changeset using
+ * the provided options. This API is experimental and may change in future releases.
+ */
+export declare const changesetsListItems: <ThrowOnError extends boolean = false>(options: Options<ChangesetsListItemsData, ThrowOnError>) => import("./client").RequestResult<ChangesetsListItemsResponses, ChangesetsListItemsErrors, ThrowOnError, "fields">;
+/**
+ * Create changeset item
+ *
+ * Creates the given changeset item. This API is experimental and may change in future releases.
+ */
+export declare const changesetsCreateItem: <ThrowOnError extends boolean = false>(options: Options<ChangesetsCreateItemData, ThrowOnError>) => import("./client").RequestResult<ChangesetsCreateItemResponses, ChangesetsCreateItemErrors, ThrowOnError, "fields">;
+/**
+ * Create content
+ *
+ * Create a new content item. This API is experimental and may change in future releases.
+ */
+export declare const contentCreate: <ThrowOnError extends boolean = false>(options: Options<ContentCreateData, ThrowOnError>) => import("./client").RequestResult<ContentCreateResponses, ContentCreateErrors, ThrowOnError, "fields">;
+/**
+ * Delete content
+ *
+ * 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.
+ */
+export declare const contentDelete: <ThrowOnError extends boolean = false>(options: Options<ContentDeleteData, ThrowOnError>) => import("./client").RequestResult<ContentDeleteResponses, ContentDeleteErrors, ThrowOnError, "fields">;
+/**
+ * Get content
+ *
+ * Get shared metadata about the content instance with the provided key. This API is experimental and may change in future releases.
+ */
+export declare const contentGetMetadata: <ThrowOnError extends boolean = false>(options: Options<ContentGetMetadataData, ThrowOnError>) => import("./client").RequestResult<ContentGetMetadataResponses, ContentGetMetadataErrors, ThrowOnError, "fields">;
+/**
+ * Patch content
+ *
+ * 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.
+ */
+export declare const contentPatchMetadata: <ThrowOnError extends boolean = false>(options: Options<ContentPatchMetadataData, ThrowOnError>) => import("./client").RequestResult<ContentPatchMetadataResponses, ContentPatchMetadataErrors, ThrowOnError, "fields">;
+/**
+ * Get content path
+ *
+ * Get the content path with the provided key. This API is experimental and may change in future releases.
+ */
+export declare const contentGetPath: <ThrowOnError extends boolean = false>(options: Options<ContentGetPathData, ThrowOnError>) => import("./client").RequestResult<ContentGetPathResponses, ContentGetPathErrors, ThrowOnError, "fields">;
+/**
+ * List content in container
+ *
+ * List the content items located in a specific container. This API is experimental and may change in future releases.
+ */
+export declare const contentListItems: <ThrowOnError extends boolean = false>(options: Options<ContentListItemsData, ThrowOnError>) => import("./client").RequestResult<ContentListItemsResponses, ContentListItemsErrors, ThrowOnError, "fields">;
+/**
+ * List assets
+ *
+ * List the assets that belongs to a content instance. This API is experimental and may change in future releases.
+ */
+export declare const contentListAssets: <ThrowOnError extends boolean = false>(options: Options<ContentListAssetsData, ThrowOnError>) => import("./client").RequestResult<ContentListAssetsResponses, ContentListAssetsErrors, ThrowOnError, "fields">;
+/**
+ * Copy content
+ *
+ * Create a copy of the content item with the provided key. This API is experimental and may change in future releases.
+ */
+export declare const contentCopy: <ThrowOnError extends boolean = false>(options: Options<ContentCopyData, ThrowOnError>) => import("./client").RequestResult<ContentCopyResponses, ContentCopyErrors, ThrowOnError, "fields">;
+/**
+ * Restore content
+ *
+ * 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.
+ */
+export declare const contentUndelete: <ThrowOnError extends boolean = false>(options: Options<ContentUndeleteData, ThrowOnError>) => import("./client").RequestResult<ContentUndeleteResponses, ContentUndeleteErrors, ThrowOnError, "fields">;
+/**
+ * Query versions
+ *
+ * List content versions based on the provided query options. This API is experimental and may change in future releases.
+ */
+export declare const contentListAllVersions: <ThrowOnError extends boolean = false>(options?: Options<ContentListAllVersionsData, ThrowOnError>) => import("./client").RequestResult<ContentListAllVersionsResponses, ContentListAllVersionsErrors, ThrowOnError, "fields">;
+/**
+ * Delete locale
+ *
+ * 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.
+ */
+export declare const contentDeleteLocale: <ThrowOnError extends boolean = false>(options: Options<ContentDeleteLocaleData, ThrowOnError>) => import("./client").RequestResult<ContentDeleteLocaleResponses, ContentDeleteLocaleErrors, ThrowOnError, "fields">;
+/**
+ * List versions
+ *
+ * List versions of the content item with the provided key and the provided options. This API is experimental and may change in future releases.
+ */
+export declare const contentListVersions: <ThrowOnError extends boolean = false>(options: Options<ContentListVersionsData, ThrowOnError>) => import("./client").RequestResult<ContentListVersionsResponses, ContentListVersionsErrors, ThrowOnError, "fields">;
+/**
+ * Create version
+ *
+ * Create a new version of a content item. This API is experimental and may change in future releases.
+ */
+export declare const contentCreateVersion: <ThrowOnError extends boolean = false>(options: Options<ContentCreateVersionData, ThrowOnError>) => import("./client").RequestResult<ContentCreateVersionResponses, ContentCreateVersionErrors, ThrowOnError, "fields">;
+/**
+ * Delete version
+ *
+ * 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.
+ */
+export declare const contentDeleteVersion: <ThrowOnError extends boolean = false>(options: Options<ContentDeleteVersionData, ThrowOnError>) => import("./client").RequestResult<ContentDeleteVersionResponses, ContentDeleteVersionErrors, ThrowOnError, "fields">;
+/**
+ * Get version
+ *
+ * Get the content item with the provided key and version. This API is experimental and may change in future releases.
+ */
+export declare const contentGetVersion: <ThrowOnError extends boolean = false>(options: Options<ContentGetVersionData, ThrowOnError>) => import("./client").RequestResult<ContentGetVersionResponses, ContentGetVersionErrors, ThrowOnError, "fields">;
+/**
+ * Patch version
+ *
+ * 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.
+ */
+export declare const contentPatchVersion: <ThrowOnError extends boolean = false>(options: Options<ContentPatchVersionData, ThrowOnError>) => import("./client").RequestResult<ContentPatchVersionResponses, ContentPatchVersionErrors, ThrowOnError, "fields">;
 /**
  * List content types
  *