@wix/autocms-collection-metadata-service 1.0.4 → 1.0.6

package/type-bundles/context.bundle.d.ts

@@ -1,8 +1,51 @@
+type HostModule<T, H extends Host> = {
+    __type: 'host';
+    create(host: H): T;
+};
+type HostModuleAPI<T extends HostModule<any, any>> = T extends HostModule<infer U, any> ? U : never;
+type Host<Environment = unknown> = {
+    channel: {
+        observeState(callback: (props: unknown, environment: Environment) => unknown): {
+            disconnect: () => void;
+        } | Promise<{
+            disconnect: () => void;
+        }>;
+    };
+    environment?: Environment;
+    /**
+     * Optional name of the environment, use for logging
+     */
+    name?: string;
+    /**
+     * Optional bast url to use for API requests, for example `www.wixapis.com`
+     */
+    apiBaseUrl?: string;
+    /**
+     * Possible data to be provided by every host, for cross cutting concerns
+     * like internationalization, billing, etc.
+     */
+    essentials?: {
+        /**
+         * The language of the currently viewed session
+         */
+        language?: string;
+        /**
+         * The locale of the currently viewed session
+         */
+        locale?: string;
+        /**
+         * Any headers that should be passed through to the API requests
+         */
+        passThroughHeaders?: Record<string, string>;
+    };
+};
+
 type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
 interface HttpClient {
     request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
     fetchWithAuth: typeof fetch;
     wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+    getActiveToken?: () => string | undefined;
 }
 type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
 type HttpResponse<T = any> = {
@@ -35,6 +78,55 @@ declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?
 type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
 type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
 
+type ServicePluginMethodInput = {
+    request: any;
+    metadata: any;
+};
+type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
+type ServicePluginMethodMetadata = {
+    name: string;
+    primaryHttpMappingPath: string;
+    transformations: {
+        fromREST: (...args: unknown[]) => ServicePluginMethodInput;
+        toREST: (...args: unknown[]) => unknown;
+    };
+};
+type ServicePluginDefinition<Contract extends ServicePluginContract> = {
+    __type: 'service-plugin-definition';
+    componentType: string;
+    methods: ServicePluginMethodMetadata[];
+    __contract: Contract;
+};
+declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
+type BuildServicePluginDefinition<T extends ServicePluginDefinition<any>> = (implementation: T['__contract']) => void;
+declare const SERVICE_PLUGIN_ERROR_TYPE = "wix_spi_error";
+
+type RequestContext = {
+    isSSR: boolean;
+    host: string;
+    protocol?: string;
+};
+type ResponseTransformer = (data: any, headers?: any) => any;
+/**
+ * Ambassador request options types are copied mostly from AxiosRequestConfig.
+ * They are copied and not imported to reduce the amount of dependencies (to reduce install time).
+ * https://github.com/axios/axios/blob/3f53eb6960f05a1f88409c4b731a40de595cb825/index.d.ts#L307-L315
+ */
+type Method = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
+type AmbassadorRequestOptions<T = any> = {
+    _?: T;
+    url?: string;
+    method?: Method;
+    params?: any;
+    data?: any;
+    transformResponse?: ResponseTransformer | ResponseTransformer[];
+};
+type AmbassadorFactory<Request, Response> = (payload: Request) => ((context: RequestContext) => AmbassadorRequestOptions<Response>) & {
+    __isAmbassador: boolean;
+};
+type AmbassadorFunctionDescriptor<Request = any, Response = any> = AmbassadorFactory<Request, Response>;
+type BuildAmbassadorFunction<T extends AmbassadorFunctionDescriptor> = T extends AmbassadorFunctionDescriptor<infer Request, infer Response> ? (req: Request) => Promise<Response> : never;
+
 declare global {
 	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
 	interface SymbolConstructor {
@@ -42,19 +134,361 @@ declare global {
 	}
 }
 
-/** CollectionMetadata contains CM-specific metadata for a collection */
+declare const emptyObjectSymbol: unique symbol;
+
+/**
+Represents a strictly empty plain object, the `{}` value.
+
+When you annotate something as the type `{}`, it can be anything except `null` and `undefined`. This means that you cannot use `{}` to represent an empty plain object ([read more](https://stackoverflow.com/questions/47339869/typescript-empty-object-and-any-difference/52193484#52193484)).
+
+@example
+```
+import type {EmptyObject} from 'type-fest';
+
+// The following illustrates the problem with `{}`.
+const foo1: {} = {}; // Pass
+const foo2: {} = []; // Pass
+const foo3: {} = 42; // Pass
+const foo4: {} = {a: 1}; // Pass
+
+// With `EmptyObject` only the first case is valid.
+const bar1: EmptyObject = {}; // Pass
+const bar2: EmptyObject = 42; // Fail
+const bar3: EmptyObject = []; // Fail
+const bar4: EmptyObject = {a: 1}; // Fail
+```
+
+Unfortunately, `Record<string, never>`, `Record<keyof any, never>` and `Record<never, never>` do not work. See {@link https://github.com/sindresorhus/type-fest/issues/395 #395}.
+
+@category Object
+*/
+type EmptyObject = {[emptyObjectSymbol]?: never};
+
+/**
+Returns a boolean for whether the two given types are equal.
+
+@link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
+@link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
+
+Use-cases:
+- If you want to make a conditional branch based on the result of a comparison of two types.
+
+@example
+```
+import type {IsEqual} from 'type-fest';
+
+// This type returns a boolean for whether the given array includes the given item.
+// `IsEqual` is used to compare the given array at position 0 and the given item and then return true if they are equal.
+type Includes<Value extends readonly any[], Item> =
+	Value extends readonly [Value[0], ...infer rest]
+		? IsEqual<Value[0], Item> extends true
+			? true
+			: Includes<rest, Item>
+		: false;
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IsEqual<A, B> =
+	(<G>() => G extends A ? 1 : 2) extends
+	(<G>() => G extends B ? 1 : 2)
+		? true
+		: false;
+
+/**
+Filter out keys from an object.
+
+Returns `never` if `Exclude` is strictly equal to `Key`.
+Returns `never` if `Key` extends `Exclude`.
+Returns `Key` otherwise.
+
+@example
+```
+type Filtered = Filter<'foo', 'foo'>;
+//=> never
+```
+
+@example
+```
+type Filtered = Filter<'bar', string>;
+//=> never
+```
+
+@example
+```
+type Filtered = Filter<'bar', 'foo'>;
+//=> 'bar'
+```
+
+@see {Except}
+*/
+type Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);
+
+type ExceptOptions = {
+	/**
+	Disallow assigning non-specified properties.
+
+	Note that any omitted properties in the resulting type will be present in autocomplete as `undefined`.
+
+	@default false
+	*/
+	requireExactProps?: boolean;
+};
+
+/**
+Create a type from an object type without certain keys.
+
+We recommend setting the `requireExactProps` option to `true`.
+
+This type is a stricter version of [`Omit`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-5.html#the-omit-helper-type). The `Omit` type does not restrict the omitted keys to be keys present on the given type, while `Except` does. The benefits of a stricter type are avoiding typos and allowing the compiler to pick up on rename refactors automatically.
+
+This type was proposed to the TypeScript team, which declined it, saying they prefer that libraries implement stricter versions of the built-in types ([microsoft/TypeScript#30825](https://github.com/microsoft/TypeScript/issues/30825#issuecomment-523668235)).
+
+@example
+```
+import type {Except} from 'type-fest';
+
+type Foo = {
+	a: number;
+	b: string;
+};
+
+type FooWithoutA = Except<Foo, 'a'>;
+//=> {b: string}
+
+const fooWithoutA: FooWithoutA = {a: 1, b: '2'};
+//=> errors: 'a' does not exist in type '{ b: string; }'
+
+type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
+//=> {a: number} & Partial<Record<"b", never>>
+
+const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
+//=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
+```
+
+@category Object
+*/
+type Except<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions = {requireExactProps: false}> = {
+	[KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];
+} & (Options['requireExactProps'] extends true
+	? Partial<Record<KeysType, never>>
+	: {});
+
+/**
+Returns a boolean for whether the given type is `never`.
+
+@link https://github.com/microsoft/TypeScript/issues/31751#issuecomment-498526919
+@link https://stackoverflow.com/a/53984913/10292952
+@link https://www.zhenghao.io/posts/ts-never
+
+Useful in type utilities, such as checking if something does not occur.
+
+@example
+```
+import type {IsNever, And} from 'type-fest';
+
+// https://github.com/andnp/SimplyTyped/blob/master/src/types/strings.ts
+type AreStringsEqual<A extends string, B extends string> =
+	And<
+		IsNever<Exclude<A, B>> extends true ? true : false,
+		IsNever<Exclude<B, A>> extends true ? true : false
+	>;
+
+type EndIfEqual<I extends string, O extends string> =
+	AreStringsEqual<I, O> extends true
+		? never
+		: void;
+
+function endIfEqual<I extends string, O extends string>(input: I, output: O): EndIfEqual<I, O> {
+	if (input === output) {
+		process.exit(0);
+	}
+}
+
+endIfEqual('abc', 'abc');
+//=> never
+
+endIfEqual('abc', '123');
+//=> void
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IsNever<T> = [T] extends [never] ? true : false;
+
+/**
+An if-else-like type that resolves depending on whether the given type is `never`.
+
+@see {@link IsNever}
+
+@example
+```
+import type {IfNever} from 'type-fest';
+
+type ShouldBeTrue = IfNever<never>;
+//=> true
+
+type ShouldBeBar = IfNever<'not never', 'foo', 'bar'>;
+//=> 'bar'
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IfNever<T, TypeIfNever = true, TypeIfNotNever = false> = (
+	IsNever<T> extends true ? TypeIfNever : TypeIfNotNever
+);
+
+/**
+Extract the keys from a type where the value type of the key extends the given `Condition`.
+
+Internally this is used for the `ConditionalPick` and `ConditionalExcept` types.
+
+@example
+```
+import type {ConditionalKeys} from 'type-fest';
+
+interface Example {
+	a: string;
+	b: string | number;
+	c?: string;
+	d: {};
+}
+
+type StringKeysOnly = ConditionalKeys<Example, string>;
+//=> 'a'
+```
+
+To support partial types, make sure your `Condition` is a union of undefined (for example, `string | undefined`) as demonstrated below.
+
+@example
+```
+import type {ConditionalKeys} from 'type-fest';
+
+type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
+//=> 'a' | 'c'
+```
+
+@category Object
+*/
+type ConditionalKeys<Base, Condition> =
+{
+	// Map through all the keys of the given base type.
+	[Key in keyof Base]-?:
+	// Pick only keys with types extending the given `Condition` type.
+	Base[Key] extends Condition
+	// Retain this key
+	// If the value for the key extends never, only include it if `Condition` also extends never
+		? IfNever<Base[Key], IfNever<Condition, Key, never>, Key>
+	// Discard this key since the condition fails.
+		: never;
+	// Convert the produced object into a union type of the keys which passed the conditional test.
+}[keyof Base];
+
+/**
+Exclude keys from a shape that matches the given `Condition`.
+
+This is useful when you want to create a new type with a specific set of keys from a shape. For example, you might want to exclude all the primitive properties from a class and form a new shape containing everything but the primitive properties.
+
+@example
+```
+import type {Primitive, ConditionalExcept} from 'type-fest';
+
+class Awesome {
+	name: string;
+	successes: number;
+	failures: bigint;
+
+	run() {}
+}
+
+type ExceptPrimitivesFromAwesome = ConditionalExcept<Awesome, Primitive>;
+//=> {run: () => void}
+```
+
+@example
+```
+import type {ConditionalExcept} from 'type-fest';
+
+interface Example {
+	a: string;
+	b: string | number;
+	c: () => void;
+	d: {};
+}
+
+type NonStringKeysOnly = ConditionalExcept<Example, string>;
+//=> {b: string | number; c: () => void; d: {}}
+```
+
+@category Object
+*/
+type ConditionalExcept<Base, Condition> = Except<
+Base,
+ConditionalKeys<Base, Condition>
+>;
+
+/**
+ * Descriptors are objects that describe the API of a module, and the module
+ * can either be a REST module or a host module.
+ * This type is recursive, so it can describe nested modules.
+ */
+type Descriptors = RESTFunctionDescriptor | AmbassadorFunctionDescriptor | HostModule<any, any> | EventDefinition<any> | ServicePluginDefinition<any> | {
+    [key: string]: Descriptors | PublicMetadata | any;
+};
+/**
+ * This type takes in a descriptors object of a certain Host (including an `unknown` host)
+ * and returns an object with the same structure, but with all descriptors replaced with their API.
+ * Any non-descriptor properties are removed from the returned object, including descriptors that
+ * do not match the given host (as they will not work with the given host).
+ */
+type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined, Depth extends number = 5> = {
+    done: T;
+    recurse: T extends {
+        __type: typeof SERVICE_PLUGIN_ERROR_TYPE;
+    } ? never : T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : T extends EventDefinition<any> ? BuildEventDefinition<T> : T extends ServicePluginDefinition<any> ? BuildServicePluginDefinition<T> : T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
+        [Key in keyof T]: T[Key] extends Descriptors ? BuildDescriptors<T[Key], H, [
+            -1,
+            0,
+            1,
+            2,
+            3,
+            4,
+            5
+        ][Depth]> : never;
+    }, EmptyObject>;
+}[Depth extends -1 ? 'done' : 'recurse'];
+type PublicMetadata = {
+    PACKAGE_NAME?: string;
+};
+
+declare global {
+    interface ContextualClient {
+    }
+}
+/**
+ * A type used to create concerete types from SDK descriptors in
+ * case a contextual client is available.
+ */
+type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
+    host: Host;
+} ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
+
+/** Contains the CMS metadata for the given collection. */
 interface CollectionMetadata {
-    /** ID of data collection */
+    /** ID of the associated data collection. */
     dataCollectionId?: string;
-    /** active named view */
+    /** ID of the active named (custom) view. Learn more about [creating custom collection views](https://support.wix.com/en/article/cms-creating-custom-collection-views) in the CMS. */
     activeNamedViewId?: string | null;
-    /** if table view should be hidden */
+    /** Whether to [hide the table layout view](https://support.wix.com/en/article/cms-setting-field-validations-in-your-collections#hiding-the-table-layout-to-prevent-empty-required-fields). Default: `false`. */
     hideTableView?: boolean | null;
-    /** named views */
+    /** List of [custom collection views](https://support.wix.com/en/article/cms-creating-custom-collection-views). */
     namedViews?: Record<string, any>[] | null;
-    /** named view ID used for default site sort in datasets */
+    /** Custom view to mirror on the Wix site. Learn more about [mirroring item order to the site's connected elements](https://support.wix.com/en/article/cms-mirroring-the-order-of-items-in-your-collection-to-your-sites-connected-elements). */
     namedViewIdForSiteSort?: string | null;
-    /** Type of data permissions template used initially */
+    /** Collection permission template. Each collection has a permissions template that determines what Learn more about [collection permissions](https://support.wix.com/en/article/cms-changing-your-collection-permissions). */
     permissionsTemplate?: PermissionsTemplateType;
 }
 declare enum PermissionsTemplateType {
@@ -64,48 +498,51 @@ declare enum PermissionsTemplateType {
     CUSTOM = "CUSTOM"
 }
 interface CreateCollectionMetadataRequest {
-    /** CollectionMetadata to be created */
+    /** Collection metadata details. */
     collectionMetadata: CollectionMetadata;
 }
 interface CreateCollectionMetadataResponse {
-    /** The created CollectionMetadata */
+    /** Created collection metadata instance. */
     collectionMetadata?: CollectionMetadata;
 }
 interface GetCollectionMetadataRequest {
-    /** Id of collection to retrieve metadata for */
+    /** ID of the collection for which to retrieve metadata. */
     dataCollectionId?: string;
 }
 interface GetCollectionMetadataResponse {
-    /** The retrieved CollectionMetadata */
+    /** Retrieved collection metadata instance. */
     collectionMetadata?: CollectionMetadata;
 }
 interface UpdateCollectionMetadataRequest {
     /**
-     * ID of metadata to update, ignored if collection_metadata.data_collection_id is non-empty
+     * TODO CLARIFY WHAT THIS MEANS:
+     * ID of metadata to update, ignored if **collection_metadata.data_collection_id** is non-empty // a technical workaround
      * exists because of docs generation issue with nested fields and ** path variables
+     * TODO shouldn't this be required? // Yes
+     * ID of the collection for which to update metadata.
      */
     dataCollectionId?: string;
-    /** CollectionMetadata to be updated, may be partial */
+    /** Collection metadata to update. Only the specified fields are affected. Fields not mentioned remain unchanged. */
     collectionMetadata: CollectionMetadata;
 }
 interface UpdateCollectionMetadataResponse {
-    /** The updated CollectionMetadata */
+    /** Updated collection metadata instance. */
     collectionMetadata?: CollectionMetadata;
 }
 interface ReplaceCollectionMetadataRequest {
-    /** The updated CollectionMetadatas */
+    /** Collection metadata to replace existing metadata. */
     items?: CollectionMetadata[];
 }
 interface ReplaceCollectionMetadataResponse {
 }
 interface DeleteCollectionMetadataRequest {
-    /** Id of collection to delete metadata for */
+    /** ID of the collection for which to delete metadata. */
     dataCollectionId?: string;
 }
 interface DeleteCollectionMetadataResponse {
 }
 interface ListCollectionMetadataRequest {
-    /** paging info */
+    /** Paging settings. */
     paging?: CursorPaging;
 }
 interface CursorPaging {
@@ -120,9 +557,9 @@ interface CursorPaging {
     cursor?: string | null;
 }
 interface ListCollectionMetadataResponse {
-    /** The retrieved CollectionMetadatas */
+    /** List of collection metadata instances. */
     items?: CollectionMetadata[];
-    /** paging metadata */
+    /** Paging information. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
@@ -168,7 +605,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
     /** ID of the entity associated with the event. */
     entityId?: string;
     /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
-    eventTime?: Date;
+    eventTime?: Date | null;
     /**
      * Whether the event was triggered as a result of a privacy regulation application
      * (for example, GDPR).
@@ -197,7 +634,7 @@ interface EntityCreatedEvent {
     entity?: string;
 }
 interface RestoreInfo {
-    deletedDate?: Date;
+    deletedDate?: Date | null;
 }
 interface EntityUpdatedEvent {
     /**
@@ -253,7 +690,10 @@ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
     version?: string;
     /** A timestamp of the event. */
     timestamp?: string;
-    /** A list of "assets" (applications). The same as MetaSiteContext. */
+    /**
+     * TODO(meta-site): Change validation once validations are disabled for consumers
+     * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
+     */
     assets?: Asset[];
 }
 /** @oneof */
@@ -420,7 +860,7 @@ interface SiteDeleted {
 }
 interface DeleteContext {
     /** When the meta site was deleted. */
-    dateDeleted?: Date;
+    dateDeleted?: Date | null;
     /** A status. */
     deleteStatus?: DeleteStatus;
     /** A reason (flow). */
@@ -580,7 +1020,7 @@ interface EventMetadata extends BaseEventMetadata {
     /** ID of the entity associated with the event. */
     entityId?: string;
     /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
-    eventTime?: Date;
+    eventTime?: Date | null;
     /**
      * Whether the event was triggered as a result of a privacy regulation application
      * (for example, GDPR).
@@ -610,68 +1050,75 @@ interface CollectionMetadataDeletedEnvelope {
     metadata: EventMetadata;
 }
 interface ReplaceCollectionMetadataOptions {
-    /** The updated CollectionMetadatas */
+    /** Collection metadata to replace existing metadata. */
     items?: CollectionMetadata[];
 }
 interface ListCollectionMetadataOptions {
-    /** paging info */
+    /** Paging settings. */
     paging?: CursorPaging;
 }
 
 declare function createCollectionMetadata$1(httpClient: HttpClient): CreateCollectionMetadataSignature;
 interface CreateCollectionMetadataSignature {
     /**
-     * Creates a new CollectionMetadata
-     * ### Error codes:
-     * - `METADATA_EXISTS` when metadata already exists for given collection
-     * @param - CollectionMetadata to be created
-     * @returns The created CollectionMetadata
+     * Creates a new collection metadata instance.
+     *
+     * In case of an error, this endpoint returns the following codes:
+     * - `METADATA_EXISTS`: Metadata already exists for the specified collection.
+     * @param - Collection metadata details.
+     * @returns Created collection metadata instance.
      */
     (collectionMetadata: CollectionMetadata): Promise<CollectionMetadata & CollectionMetadataNonNullableFields>;
 }
 declare function getCollectionMetadata$1(httpClient: HttpClient): GetCollectionMetadataSignature;
 interface GetCollectionMetadataSignature {
     /**
-     * Get a CollectionMetadata by collection id
-     * ### Error codes:
-     * - `ITEM_NOT_FOUND` if no metadata exists for given collection
-     * @param - Id of collection to retrieve metadata for
-     * @returns The retrieved CollectionMetadata
+     * Gets a collection metadata instance.
+     *
+     * In case of an error, this endpoint returns the following codes:
+     * - `ITEM_NOT_FOUND`: No metadata exists for the specified collection.
+     * @param - ID of the collection for which to retrieve metadata.
+     * @returns Retrieved collection metadata instance.
      */
     (dataCollectionId: string): Promise<CollectionMetadata & CollectionMetadataNonNullableFields>;
 }
 declare function updateCollectionMetadata$1(httpClient: HttpClient): UpdateCollectionMetadataSignature;
 interface UpdateCollectionMetadataSignature {
     /**
-     * Updates provided metadata fields for given collection ID
-     * ### Error codes:
-     * - `ITEM_NOT_FOUND` if no metadata exists for given collection
-     * @param - ID of metadata to update, ignored if collection_metadata.data_collection_id is non-empty
+     * Updates the metadata for the specified collection.
+     *
+     * In case of an error, this endpoint returns the following codes:
+     * - `ITEM_NOT_FOUND`: No metadata exists for the specified collection.
+     * @param - TODO CLARIFY WHAT THIS MEANS:
+     * ID of metadata to update, ignored if **collection_metadata.data_collection_id** is non-empty // a technical workaround
      * exists because of docs generation issue with nested fields and ** path variables
-     * @param - CollectionMetadata to be updated, may be partial
-     * @returns The updated CollectionMetadata
+     * TODO shouldn't this be required? // Yes
+     * ID of the collection for which to update metadata.
+     * @param - Collection metadata to update. Only the specified fields are affected. Fields not mentioned remain unchanged.
+     * @returns Updated collection metadata instance.
      */
     (dataCollectionId: string, collectionMetadata: CollectionMetadata): Promise<CollectionMetadata & CollectionMetadataNonNullableFields>;
 }
 declare function replaceCollectionMetadata$1(httpClient: HttpClient): ReplaceCollectionMetadataSignature;
 interface ReplaceCollectionMetadataSignature {
     /**
-     * Replaces all metadatas
+     * Completely replaces all existing collection metadata with the provided metadata.
      */
     (options?: ReplaceCollectionMetadataOptions | undefined): Promise<void>;
 }
 declare function deleteCollectionMetadata$1(httpClient: HttpClient): DeleteCollectionMetadataSignature;
 interface DeleteCollectionMetadataSignature {
     /**
-     * Delete a CollectionMetadata
-     * @param - Id of collection to delete metadata for
+     * Deletes a collection metadata instance. (1)
+     * Deletes the specified collection's metadata. (2)
+     * @param - ID of the collection for which to delete metadata.
      */
     (dataCollectionId: string): Promise<void>;
 }
 declare function listCollectionMetadata$1(httpClient: HttpClient): ListCollectionMetadataSignature;
 interface ListCollectionMetadataSignature {
     /**
-     * Lists all known metadata
+     * Lists all collection metadata.
      */
     (options?: ListCollectionMetadataOptions | undefined): Promise<ListCollectionMetadataResponse & ListCollectionMetadataResponseNonNullableFields>;
 }
@@ -681,23 +1128,29 @@ declare const onCollectionMetadataDeleted$1: EventDefinition<CollectionMetadataD
 
 declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
 
-declare const createCollectionMetadata: BuildRESTFunction<typeof createCollectionMetadata$1> & typeof createCollectionMetadata$1;
-declare const getCollectionMetadata: BuildRESTFunction<typeof getCollectionMetadata$1> & typeof getCollectionMetadata$1;
-declare const updateCollectionMetadata: BuildRESTFunction<typeof updateCollectionMetadata$1> & typeof updateCollectionMetadata$1;
-declare const replaceCollectionMetadata: BuildRESTFunction<typeof replaceCollectionMetadata$1> & typeof replaceCollectionMetadata$1;
-declare const deleteCollectionMetadata: BuildRESTFunction<typeof deleteCollectionMetadata$1> & typeof deleteCollectionMetadata$1;
-declare const listCollectionMetadata: BuildRESTFunction<typeof listCollectionMetadata$1> & typeof listCollectionMetadata$1;
+declare const createCollectionMetadata: MaybeContext<BuildRESTFunction<typeof createCollectionMetadata$1> & typeof createCollectionMetadata$1>;
+declare const getCollectionMetadata: MaybeContext<BuildRESTFunction<typeof getCollectionMetadata$1> & typeof getCollectionMetadata$1>;
+declare const updateCollectionMetadata: MaybeContext<BuildRESTFunction<typeof updateCollectionMetadata$1> & typeof updateCollectionMetadata$1>;
+declare const replaceCollectionMetadata: MaybeContext<BuildRESTFunction<typeof replaceCollectionMetadata$1> & typeof replaceCollectionMetadata$1>;
+declare const deleteCollectionMetadata: MaybeContext<BuildRESTFunction<typeof deleteCollectionMetadata$1> & typeof deleteCollectionMetadata$1>;
+declare const listCollectionMetadata: MaybeContext<BuildRESTFunction<typeof listCollectionMetadata$1> & typeof listCollectionMetadata$1>;
 
 type _publicOnCollectionMetadataCreatedType = typeof onCollectionMetadataCreated$1;
-/** */
+/**
+ * Triggered when a collection metadata instance is created.
+ */
 declare const onCollectionMetadataCreated: ReturnType<typeof createEventModule<_publicOnCollectionMetadataCreatedType>>;
 
 type _publicOnCollectionMetadataUpdatedType = typeof onCollectionMetadataUpdated$1;
-/** */
+/**
+ * Triggered when a collection metadata instance is updated.
+ */
 declare const onCollectionMetadataUpdated: ReturnType<typeof createEventModule<_publicOnCollectionMetadataUpdatedType>>;
 
 type _publicOnCollectionMetadataDeletedType = typeof onCollectionMetadataDeleted$1;
-/** */
+/**
+ * Triggered when a collection metadata instance is deleted.
+ */
 declare const onCollectionMetadataDeleted: ReturnType<typeof createEventModule<_publicOnCollectionMetadataDeletedType>>;
 
 type context_ActionEvent = ActionEvent;