@remkoj/optimizely-cms-api 6.0.0-pre1 → 6.0.0-pre11

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

@@ -1,6 +1,6 @@
-import type { Options as ClientOptions, TDataShape, Client } from './client';
-import type { ChangesetsListData, ChangesetsListResponses, ChangesetsListErrors, ChangesetsCreateData, ChangesetsCreateResponses, ChangesetsCreateErrors, ChangesetsDeleteData, ChangesetsDeleteResponses, ChangesetsDeleteErrors, ChangesetsGetData, ChangesetsGetResponses, ChangesetsGetErrors, ChangesetsPutData, ChangesetsPutResponses, ChangesetsPutErrors, ChangesetsDeleteItemData, ChangesetsDeleteItemResponses, ChangesetsDeleteItemErrors, ChangesetsGetItemData, ChangesetsGetItemResponses, ChangesetsGetItemErrors, ChangesetsListItemsData, ChangesetsListItemsResponses, ChangesetsListItemsErrors, ChangesetsCreateItemData, ChangesetsCreateItemResponses, ChangesetsCreateItemErrors, ChangesetsUpdateItemData, ChangesetsUpdateItemResponses, ChangesetsUpdateItemErrors, ContentCreateData, ContentCreateResponses, ContentCreateErrors, ContentDeleteData, ContentDeleteResponses, ContentDeleteErrors, ContentGetMetadataData, ContentGetMetadataResponses, ContentGetMetadataErrors, ContentPatchMetadataData, ContentPatchMetadataResponses, ContentPatchMetadataErrors, ContentGetPathData, ContentGetPathResponses, ContentGetPathErrors, ContentListItemsData, ContentListItemsResponses, ContentListItemsErrors, ContentListAssetsData, ContentListAssetsResponses, ContentListAssetsErrors, ContentCopyData, ContentCopyResponses, ContentCopyErrors, ContentUndeleteData, ContentUndeleteResponses, ContentUndeleteErrors, ContentListAllVersionsData, ContentListAllVersionsResponses, ContentListAllVersionsErrors, ContentDeleteLocaleData, ContentDeleteLocaleResponses, ContentDeleteLocaleErrors, ContentListVersionsData, ContentListVersionsResponses, ContentListVersionsErrors, ContentCreateVersionData, ContentCreateVersionResponses, ContentCreateVersionErrors, ContentDeleteVersionData, ContentDeleteVersionResponses, ContentDeleteVersionErrors, ContentGetVersionData, ContentGetVersionResponses, ContentGetVersionErrors, ContentPatchVersionData, ContentPatchVersionResponses, ContentPatchVersionErrors, ContentTypesListData, ContentTypesListResponses, ContentTypesListErrors, ContentTypesCreateData, ContentTypesCreateResponses, ContentTypesCreateErrors, ContentTypesDeleteData, ContentTypesDeleteResponses, ContentTypesDeleteErrors, ContentTypesGetData, ContentTypesGetResponses, ContentTypesGetErrors, ContentTypesPatchData, ContentTypesPatchResponses, ContentTypesPatchErrors, ContentTypesPutData, ContentTypesPutResponses, ContentTypesPutErrors, DisplayTemplatesListData, DisplayTemplatesListResponses, DisplayTemplatesListErrors, DisplayTemplatesCreateData, DisplayTemplatesCreateResponses, DisplayTemplatesCreateErrors, DisplayTemplatesDeleteData, DisplayTemplatesDeleteResponses, DisplayTemplatesDeleteErrors, DisplayTemplatesGetData, DisplayTemplatesGetResponses, DisplayTemplatesGetErrors, DisplayTemplatesPatchData, DisplayTemplatesPatchResponses, DisplayTemplatesPatchErrors, DisplayTemplatesPutData, DisplayTemplatesPutResponses, DisplayTemplatesPutErrors, OauthTokenData, OauthTokenResponses, OauthTokenErrors, PropertyFormatsListData, PropertyFormatsListResponses, PropertyFormatsListErrors, PropertyFormatsGetData, PropertyFormatsGetResponses, PropertyFormatsGetErrors, PropertyGroupsListData, PropertyGroupsListResponses, PropertyGroupsListErrors, PropertyGroupsCreateData, PropertyGroupsCreateResponses, PropertyGroupsCreateErrors, PropertyGroupsDeleteData, PropertyGroupsDeleteResponses, PropertyGroupsDeleteErrors, PropertyGroupsGetData, PropertyGroupsGetResponses, PropertyGroupsGetErrors, PropertyGroupsPatchData, PropertyGroupsPatchResponses, PropertyGroupsPatchErrors, PropertyGroupsPutData, PropertyGroupsPutResponses, PropertyGroupsPutErrors } from './types.gen';
-export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
+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';
+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
      * individual options. This might be also useful if you want to implement a
@@ -13,244 +13,105 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
      */
     meta?: Record<string, unknown>;
 };
-/**
- * List changeset
- * Lists all changeset using the provided options.
- */
-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.
- */
-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.
- */
-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.
- */
-export declare const changesetsGet: <ThrowOnError extends boolean = false>(options: Options<ChangesetsGetData, ThrowOnError>) => import("./client").RequestResult<ChangesetsGetResponses, ChangesetsGetErrors, ThrowOnError, "fields">;
-/**
- * Create or replace changeset
- * Creates or replaces a changeset. If a changeset with the provided key exist it is replaced.
- * Otherwise a new changeset is created.
- */
-export declare const changesetsPut: <ThrowOnError extends boolean = false>(options: Options<ChangesetsPutData, ThrowOnError>) => import("./client").RequestResult<ChangesetsPutResponses, ChangesetsPutErrors, ThrowOnError, "fields">;
-/**
- * Delete changeset item
- * Deletes the specified changeset item from the changeset.
- */
-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.
- */
-export declare const changesetsGetItem: <ThrowOnError extends boolean = false>(options: Options<ChangesetsGetItemData, ThrowOnError>) => import("./client").RequestResult<ChangesetsGetItemResponses, ChangesetsGetItemErrors, ThrowOnError, "fields">;
-/**
- * List changeset items
- * Lists the available changeset items for the specified changeset using
- * the provided options.
- */
-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.
- */
-export declare const changesetsCreateItem: <ThrowOnError extends boolean = false>(options: Options<ChangesetsCreateItemData, ThrowOnError>) => import("./client").RequestResult<ChangesetsCreateItemResponses, ChangesetsCreateItemErrors, ThrowOnError, "fields">;
-/**
- * Update changeset item
- * Updates the given changeset item.
- */
-export declare const changesetsUpdateItem: <ThrowOnError extends boolean = false>(options: Options<ChangesetsUpdateItemData, ThrowOnError>) => import("./client").RequestResult<ChangesetsUpdateItemResponses, ChangesetsUpdateItemErrors, ThrowOnError, "fields">;
-/**
- * Create content
- * Create a new content item.
- */
-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.
- */
-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.
- */
-export declare const contentGetMetadata: <ThrowOnError extends boolean = false>(options: Options<ContentGetMetadataData, ThrowOnError>) => import("./client").RequestResult<ContentGetMetadataResponses, ContentGetMetadataErrors, ThrowOnError, "fields">;
-/**
- * Update content
- * Update an existing content item. If a content item with the provided key does not exist an error is returned.
- */
-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.
- */
-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.
- */
-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.
- */
-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.
- */
-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.
- */
-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.
- */
-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.
- */
-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.
- */
-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.
- */
-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.
- */
-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.
- */
-export declare const contentGetVersion: <ThrowOnError extends boolean = false>(options: Options<ContentGetVersionData, ThrowOnError>) => import("./client").RequestResult<ContentGetVersionResponses, ContentGetVersionErrors, ThrowOnError, "fields">;
-/**
- * Update version
- * Update an existing content item. If a content item with the provided key does not exist an error is returned.
- */
-export declare const contentPatchVersion: <ThrowOnError extends boolean = false>(options: Options<ContentPatchVersionData, ThrowOnError>) => import("./client").RequestResult<ContentPatchVersionResponses, ContentPatchVersionErrors, ThrowOnError, "fields">;
 /**
  * List content types
- * List content types using the provided options.
+ *
+ * List content types using the provided parameters.
  */
 export declare const contentTypesList: <ThrowOnError extends boolean = false>(options?: Options<ContentTypesListData, ThrowOnError>) => import("./client").RequestResult<ContentTypesListResponses, ContentTypesListErrors, ThrowOnError, "fields">;
 /**
  * Create content type
+ *
  * Create a new content type.
  */
 export declare const contentTypesCreate: <ThrowOnError extends boolean = false>(options: Options<ContentTypesCreateData, ThrowOnError>) => import("./client").RequestResult<ContentTypesCreateResponses, ContentTypesCreateErrors, ThrowOnError, "fields">;
 /**
  * Delete content type
+ *
  * Deletes the content type with the provided key. If a content type with the provided key does not exist an error is returned.
  */
 export declare const contentTypesDelete: <ThrowOnError extends boolean = false>(options: Options<ContentTypesDeleteData, ThrowOnError>) => import("./client").RequestResult<ContentTypesDeleteResponses, ContentTypesDeleteErrors, ThrowOnError, "fields">;
 /**
  * Get content type
+ *
  * Get the content type with the provided key.
  */
 export declare const contentTypesGet: <ThrowOnError extends boolean = false>(options: Options<ContentTypesGetData, ThrowOnError>) => import("./client").RequestResult<ContentTypesGetResponses, ContentTypesGetErrors, ThrowOnError, "fields">;
 /**
- * Update content type
- * Update an existing content type. If a content type with the provided key does not exist an error is returned.
+ * Patch content type
+ *
+ * Patch an existing content type. If a content type with the provided key does not exist an error is returned.
  */
 export declare const contentTypesPatch: <ThrowOnError extends boolean = false>(options: Options<ContentTypesPatchData, ThrowOnError>) => import("./client").RequestResult<ContentTypesPatchResponses, ContentTypesPatchErrors, ThrowOnError, "fields">;
-/**
- * Create or replace content type
- * Create or replace a content type. If a content type with the provided key exist it is replaced.
- * Otherwise a new content type is created.
- */
-export declare const contentTypesPut: <ThrowOnError extends boolean = false>(options: Options<ContentTypesPutData, ThrowOnError>) => import("./client").RequestResult<ContentTypesPutResponses, ContentTypesPutErrors, ThrowOnError, "fields">;
 /**
  * List display templates
- * List display templates using the provided options.
+ *
+ * List display templates using the provided parameters.
  */
 export declare const displayTemplatesList: <ThrowOnError extends boolean = false>(options?: Options<DisplayTemplatesListData, ThrowOnError>) => import("./client").RequestResult<DisplayTemplatesListResponses, DisplayTemplatesListErrors, ThrowOnError, "fields">;
 /**
  * Create display template
+ *
  * Create a new display template.
  */
 export declare const displayTemplatesCreate: <ThrowOnError extends boolean = false>(options: Options<DisplayTemplatesCreateData, ThrowOnError>) => import("./client").RequestResult<DisplayTemplatesCreateResponses, DisplayTemplatesCreateErrors, ThrowOnError, "fields">;
 /**
  * Delete display template
+ *
  * Deletes the display template with the provided key.
  */
 export declare const displayTemplatesDelete: <ThrowOnError extends boolean = false>(options: Options<DisplayTemplatesDeleteData, ThrowOnError>) => import("./client").RequestResult<DisplayTemplatesDeleteResponses, DisplayTemplatesDeleteErrors, ThrowOnError, "fields">;
 /**
  * Get display template
+ *
  * Get the display template with the provided key.
  */
 export declare const displayTemplatesGet: <ThrowOnError extends boolean = false>(options: Options<DisplayTemplatesGetData, ThrowOnError>) => import("./client").RequestResult<DisplayTemplatesGetResponses, DisplayTemplatesGetErrors, ThrowOnError, "fields">;
 /**
- * Update display template
- * Update an existing display template.
+ * Patch display template
+ *
+ * Patch an existing display template.
  */
 export declare const displayTemplatesPatch: <ThrowOnError extends boolean = false>(options: Options<DisplayTemplatesPatchData, ThrowOnError>) => import("./client").RequestResult<DisplayTemplatesPatchResponses, DisplayTemplatesPatchErrors, ThrowOnError, "fields">;
-/**
- * Create or replace a display template
- * Create or replace a display template. If a display template with the provided key exist it is replaced.
- * Otherwise a new display template is created.
- */
-export declare const displayTemplatesPut: <ThrowOnError extends boolean = false>(options: Options<DisplayTemplatesPutData, ThrowOnError>) => import("./client").RequestResult<DisplayTemplatesPutResponses, DisplayTemplatesPutErrors, ThrowOnError, "fields">;
-/**
- * Request access token
- * Request an access token. This endpoint only supports the 'client_credentials' grant type
- * and will only issue short-lived tokens.
- */
-export declare const oauthToken: <ThrowOnError extends boolean = false>(options: Options<OauthTokenData, ThrowOnError>) => import("./client").RequestResult<OauthTokenResponses, OauthTokenErrors, ThrowOnError, "fields">;
 /**
  * List property formats
+ *
  * List all property formats using the provided options.
  */
 export declare const propertyFormatsList: <ThrowOnError extends boolean = false>(options?: Options<PropertyFormatsListData, ThrowOnError>) => import("./client").RequestResult<PropertyFormatsListResponses, PropertyFormatsListErrors, ThrowOnError, "fields">;
 /**
  * Get property format
+ *
  * Get the property format with the provided key.
  */
 export declare const propertyFormatsGet: <ThrowOnError extends boolean = false>(options: Options<PropertyFormatsGetData, ThrowOnError>) => import("./client").RequestResult<PropertyFormatsGetResponses, PropertyFormatsGetErrors, ThrowOnError, "fields">;
 /**
  * List property groups
+ *
  * List property groups using the provided options.
  */
 export declare const propertyGroupsList: <ThrowOnError extends boolean = false>(options?: Options<PropertyGroupsListData, ThrowOnError>) => import("./client").RequestResult<PropertyGroupsListResponses, PropertyGroupsListErrors, ThrowOnError, "fields">;
 /**
  * Create property group
+ *
  * Create a new property group.
  */
 export declare const propertyGroupsCreate: <ThrowOnError extends boolean = false>(options: Options<PropertyGroupsCreateData, ThrowOnError>) => import("./client").RequestResult<PropertyGroupsCreateResponses, PropertyGroupsCreateErrors, ThrowOnError, "fields">;
 /**
  * Delete property group
+ *
  * Deletes the property group with the provided key.
  */
 export declare const propertyGroupsDelete: <ThrowOnError extends boolean = false>(options: Options<PropertyGroupsDeleteData, ThrowOnError>) => import("./client").RequestResult<PropertyGroupsDeleteResponses, PropertyGroupsDeleteErrors, ThrowOnError, "fields">;
 /**
  * Get property group
+ *
  * Get the property group with the provided key.
  */
 export declare const propertyGroupsGet: <ThrowOnError extends boolean = false>(options: Options<PropertyGroupsGetData, ThrowOnError>) => import("./client").RequestResult<PropertyGroupsGetResponses, PropertyGroupsGetErrors, ThrowOnError, "fields">;
 /**
- * Update property group
- * Update an existing property group.
+ * Patch property group
+ *
+ * Patch an existing property group.
  */
 export declare const propertyGroupsPatch: <ThrowOnError extends boolean = false>(options: Options<PropertyGroupsPatchData, ThrowOnError>) => import("./client").RequestResult<PropertyGroupsPatchResponses, PropertyGroupsPatchErrors, ThrowOnError, "fields">;
-/**
- * Create or replace property group
- * Create or replace a property group. If a property group with the provided key exist it is replaced.
- * Otherwise a new property group is created.
- */
-export declare const propertyGroupsPut: <ThrowOnError extends boolean = false>(options: Options<PropertyGroupsPutData, ThrowOnError>) => import("./client").RequestResult<PropertyGroupsPutResponses, PropertyGroupsPutErrors, ThrowOnError, "fields">;