@wix/autocms-collection-metadata-service 1.0.0

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

@@ -0,0 +1,273 @@
+/** CollectionMetadata contains CM-specific metadata for a collection */
+interface CollectionMetadata$1 {
+    /** ID of data collection */
+    dataCollectionId?: string;
+    /** active named view */
+    activeNamedViewId?: string | null;
+    /** if table view should be hidden */
+    hideTableView?: boolean | null;
+    /** named views */
+    namedViews?: Record<string, any>[] | null;
+    /** named view ID used for default site sort in datasets */
+    namedViewIdForSiteSort?: string | null;
+    /** Type of data permissions template used initially */
+    permissionsTemplate?: PermissionsTemplateType$1;
+}
+declare enum PermissionsTemplateType$1 {
+    UNDEFINED = "UNDEFINED",
+    SHOW_CONTENT = "SHOW_CONTENT",
+    COLLECT_CONTENT = "COLLECT_CONTENT",
+    CUSTOM = "CUSTOM"
+}
+interface CreateCollectionMetadataRequest$1 {
+    /** CollectionMetadata to be created */
+    collectionMetadata: CollectionMetadata$1;
+}
+interface CreateCollectionMetadataResponse$1 {
+    /** The created CollectionMetadata */
+    collectionMetadata?: CollectionMetadata$1;
+}
+interface GetCollectionMetadataRequest$1 {
+    /** Id of collection to retrieve metadata for */
+    dataCollectionId?: string;
+}
+interface GetCollectionMetadataResponse$1 {
+    /** The retrieved CollectionMetadata */
+    collectionMetadata?: CollectionMetadata$1;
+}
+interface UpdateCollectionMetadataRequest$1 {
+    /**
+     * ID of metadata to update, ignored if collection_metadata.data_collection_id is non-empty
+     * exists because of docs generation issue with nested fields and ** path variables
+     */
+    dataCollectionId?: string;
+    /** CollectionMetadata to be updated, may be partial */
+    collectionMetadata: CollectionMetadata$1;
+}
+interface UpdateCollectionMetadataResponse$1 {
+    /** The updated CollectionMetadata */
+    collectionMetadata?: CollectionMetadata$1;
+}
+interface ReplaceCollectionMetadataRequest$1 {
+    /** The updated CollectionMetadatas */
+    items?: CollectionMetadata$1[];
+}
+interface ReplaceCollectionMetadataResponse$1 {
+}
+interface DeleteCollectionMetadataRequest$1 {
+    /** Id of collection to delete metadata for */
+    dataCollectionId?: string;
+}
+interface DeleteCollectionMetadataResponse$1 {
+}
+interface ListCollectionMetadataRequest$1 {
+    /** paging info */
+    paging?: CursorPaging$1;
+}
+interface CursorPaging$1 {
+    /** Maximum number of items to return in the results. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+interface ListCollectionMetadataResponse$1 {
+    /** The retrieved CollectionMetadatas */
+    items?: CollectionMetadata$1[];
+    /** paging metadata */
+    pagingMetadata?: CursorPagingMetadata$1;
+}
+interface CursorPagingMetadata$1 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors$1;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors$1 {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+interface CollectionMetadataNonNullableFields$1 {
+    dataCollectionId: string;
+    permissionsTemplate: PermissionsTemplateType$1;
+}
+interface CreateCollectionMetadataResponseNonNullableFields$1 {
+    collectionMetadata?: CollectionMetadataNonNullableFields$1;
+}
+interface GetCollectionMetadataResponseNonNullableFields$1 {
+    collectionMetadata?: CollectionMetadataNonNullableFields$1;
+}
+interface UpdateCollectionMetadataResponseNonNullableFields$1 {
+    collectionMetadata?: CollectionMetadataNonNullableFields$1;
+}
+interface ListCollectionMetadataResponseNonNullableFields$1 {
+    items: CollectionMetadataNonNullableFields$1[];
+}
+
+/** CollectionMetadata contains CM-specific metadata for a collection */
+interface CollectionMetadata {
+    /** ID of data collection */
+    dataCollectionId?: string;
+    /** active named view */
+    activeNamedViewId?: string | null;
+    /** if table view should be hidden */
+    hideTableView?: boolean | null;
+    /** named views */
+    namedViews?: Record<string, any>[] | null;
+    /** named view ID used for default site sort in datasets */
+    namedViewIdForSiteSort?: string | null;
+    /** Type of data permissions template used initially */
+    permissionsTemplate?: PermissionsTemplateType;
+}
+declare enum PermissionsTemplateType {
+    UNDEFINED = "UNDEFINED",
+    SHOW_CONTENT = "SHOW_CONTENT",
+    COLLECT_CONTENT = "COLLECT_CONTENT",
+    CUSTOM = "CUSTOM"
+}
+interface CreateCollectionMetadataRequest {
+    /** CollectionMetadata to be created */
+    collectionMetadata: CollectionMetadata;
+}
+interface CreateCollectionMetadataResponse {
+    /** The created CollectionMetadata */
+    collectionMetadata?: CollectionMetadata;
+}
+interface GetCollectionMetadataRequest {
+    /** Id of collection to retrieve metadata for */
+    dataCollectionId?: string;
+}
+interface GetCollectionMetadataResponse {
+    /** The retrieved CollectionMetadata */
+    collectionMetadata?: CollectionMetadata;
+}
+interface UpdateCollectionMetadataRequest {
+    /**
+     * ID of metadata to update, ignored if collection_metadata.data_collection_id is non-empty
+     * exists because of docs generation issue with nested fields and ** path variables
+     */
+    dataCollectionId?: string;
+    /** CollectionMetadata to be updated, may be partial */
+    collectionMetadata: CollectionMetadata;
+}
+interface UpdateCollectionMetadataResponse {
+    /** The updated CollectionMetadata */
+    collectionMetadata?: CollectionMetadata;
+}
+interface ReplaceCollectionMetadataRequest {
+    /** The updated CollectionMetadatas */
+    items?: CollectionMetadata[];
+}
+interface ReplaceCollectionMetadataResponse {
+}
+interface DeleteCollectionMetadataRequest {
+    /** Id of collection to delete metadata for */
+    dataCollectionId?: string;
+}
+interface DeleteCollectionMetadataResponse {
+}
+interface ListCollectionMetadataRequest {
+    /** paging info */
+    paging?: CursorPaging;
+}
+interface CursorPaging {
+    /** Maximum number of items to return in the results. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+interface ListCollectionMetadataResponse {
+    /** The retrieved CollectionMetadatas */
+    items?: CollectionMetadata[];
+    /** paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+interface CollectionMetadataNonNullableFields {
+    dataCollectionId: string;
+    permissionsTemplate: PermissionsTemplateType;
+}
+interface CreateCollectionMetadataResponseNonNullableFields {
+    collectionMetadata?: CollectionMetadataNonNullableFields;
+}
+interface GetCollectionMetadataResponseNonNullableFields {
+    collectionMetadata?: CollectionMetadataNonNullableFields;
+}
+interface UpdateCollectionMetadataResponseNonNullableFields {
+    collectionMetadata?: CollectionMetadataNonNullableFields;
+}
+interface ListCollectionMetadataResponseNonNullableFields {
+    items: CollectionMetadataNonNullableFields[];
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function createCollectionMetadata(): __PublicMethodMetaInfo<'POST', {}, CreateCollectionMetadataRequest, CreateCollectionMetadataRequest$1, CreateCollectionMetadataResponse & CreateCollectionMetadataResponseNonNullableFields, CreateCollectionMetadataResponse$1 & CreateCollectionMetadataResponseNonNullableFields$1>;
+declare function getCollectionMetadata(): __PublicMethodMetaInfo<'GET', {
+    dataCollectionId: string;
+}, GetCollectionMetadataRequest, GetCollectionMetadataRequest$1, GetCollectionMetadataResponse & GetCollectionMetadataResponseNonNullableFields, GetCollectionMetadataResponse$1 & GetCollectionMetadataResponseNonNullableFields$1>;
+declare function updateCollectionMetadata(): __PublicMethodMetaInfo<'PATCH', {
+    dataCollectionId: string;
+}, UpdateCollectionMetadataRequest, UpdateCollectionMetadataRequest$1, UpdateCollectionMetadataResponse & UpdateCollectionMetadataResponseNonNullableFields, UpdateCollectionMetadataResponse$1 & UpdateCollectionMetadataResponseNonNullableFields$1>;
+declare function replaceCollectionMetadata(): __PublicMethodMetaInfo<'PUT', {}, ReplaceCollectionMetadataRequest, ReplaceCollectionMetadataRequest$1, ReplaceCollectionMetadataResponse, ReplaceCollectionMetadataResponse$1>;
+declare function deleteCollectionMetadata(): __PublicMethodMetaInfo<'DELETE', {
+    dataCollectionId: string;
+}, DeleteCollectionMetadataRequest, DeleteCollectionMetadataRequest$1, DeleteCollectionMetadataResponse, DeleteCollectionMetadataResponse$1>;
+declare function listCollectionMetadata(): __PublicMethodMetaInfo<'GET', {}, ListCollectionMetadataRequest, ListCollectionMetadataRequest$1, ListCollectionMetadataResponse & ListCollectionMetadataResponseNonNullableFields, ListCollectionMetadataResponse$1 & ListCollectionMetadataResponseNonNullableFields$1>;
+
+type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
+declare const meta_createCollectionMetadata: typeof createCollectionMetadata;
+declare const meta_deleteCollectionMetadata: typeof deleteCollectionMetadata;
+declare const meta_getCollectionMetadata: typeof getCollectionMetadata;
+declare const meta_listCollectionMetadata: typeof listCollectionMetadata;
+declare const meta_replaceCollectionMetadata: typeof replaceCollectionMetadata;
+declare const meta_updateCollectionMetadata: typeof updateCollectionMetadata;
+declare namespace meta {
+  export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_createCollectionMetadata as createCollectionMetadata, meta_deleteCollectionMetadata as deleteCollectionMetadata, meta_getCollectionMetadata as getCollectionMetadata, meta_listCollectionMetadata as listCollectionMetadata, meta_replaceCollectionMetadata as replaceCollectionMetadata, meta_updateCollectionMetadata as updateCollectionMetadata };
+}
+
+export { meta as autocms };