@wix/auto_sdk_faq_category 1.0.0

package/build/cjs/src/faq-category-v2-category-category.universal.d.ts

@@ -0,0 +1,587 @@
+/**
+ * Categories are themed groupings of FAQ question entries that a site owner can create to organize their
+ * FAQ questions (e.g., Shipping, Returns, etc.).
+ */
+export interface Category {
+    /**
+     * Category ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the Category is updated.
+     * To prevent conflicting changes,
+     * the current revision must be passed when updating the Category.
+     *
+     * Ignored when creating a Category.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Category was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the Category was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /** Category title. */
+    title?: string | null;
+    /** Order of category within a site. */
+    sortOrder?: number | null;
+    /** Data Extensions */
+    extendedFields?: ExtendedFields;
+}
+export interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+export interface CreateCategoryRequest {
+    /** Category to be created. */
+    category: Category;
+}
+export interface CreateCategoryResponse {
+    /** The created Category. */
+    category?: Category;
+}
+export interface GetCategoryRequest {
+    /** ID of the Category to retrieve. */
+    categoryId: string;
+}
+export interface GetCategoryResponse {
+    /** The requested Category. */
+    category?: Category;
+}
+export interface UpdateCategoryRequest {
+    /** Category to be updated, may be partial. */
+    category: Category;
+}
+export interface UpdateCategoryResponse {
+    /** Updated Category. */
+    category?: Category;
+}
+export interface DeleteCategoryRequest {
+    /** Id of the Category to delete. */
+    categoryId: string;
+}
+export interface DeleteCategoryResponse {
+}
+export interface ListCategoriesRequest {
+    /** Request more categories using cursor paging. */
+    paging?: CursorPaging;
+}
+export 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;
+}
+export interface ListCategoriesResponse {
+    /** List of Categories. */
+    categories?: Category[];
+    /** Paging metadata */
+    pagingMetadata?: PagingMetadataV2;
+}
+export interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+export 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;
+}
+export interface QueryCategoriesRequest {
+    /** WQL expression. */
+    query?: CursorQuery;
+}
+export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+export interface CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface QueryCategoriesResponse {
+    /** List of Categories. */
+    categories?: Category[];
+    /** Paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export interface CursorPagingMetadata {
+    /** Number of items returned in current page. */
+    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;
+}
+export interface UpdateExtendedFieldsRequest {
+    /** ID of the entity to update. */
+    _id: string;
+    /** Identifier for the app whose extended fields are being updated. */
+    namespace: string;
+    /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
+    namespaceData: Record<string, any> | null;
+}
+export interface UpdateExtendedFieldsResponse {
+    /** Updated Category. */
+    category?: Category;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** 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 | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entity?: string;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: string;
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+export interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+export interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** 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 | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+export interface CategoryCreatedEnvelope {
+    entity: Category;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage FAQ
+ * @permissionScopeId SCOPE.DC-LABS.MANAGE-FAQ
+ * @permissionScope Read FAQ
+ * @permissionScopeId SCOPE.DC-LABS.READ-FAQ
+ * @permissionId FAQ.READ_CATEGORIES
+ * @webhook
+ * @eventType wix.faq.category.v2.category_created
+ */
+export declare function onCategoryCreated(handler: (event: CategoryCreatedEnvelope) => void | Promise<void>): void;
+export interface CategoryDeletedEnvelope {
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage FAQ
+ * @permissionScopeId SCOPE.DC-LABS.MANAGE-FAQ
+ * @permissionScope Read FAQ
+ * @permissionScopeId SCOPE.DC-LABS.READ-FAQ
+ * @permissionId FAQ.READ_CATEGORIES
+ * @webhook
+ * @eventType wix.faq.category.v2.category_deleted
+ */
+export declare function onCategoryDeleted(handler: (event: CategoryDeletedEnvelope) => void | Promise<void>): void;
+export interface CategoryUpdatedEnvelope {
+    entity: Category;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage FAQ
+ * @permissionScopeId SCOPE.DC-LABS.MANAGE-FAQ
+ * @permissionScope Read FAQ
+ * @permissionScopeId SCOPE.DC-LABS.READ-FAQ
+ * @permissionId FAQ.READ_CATEGORIES
+ * @webhook
+ * @eventType wix.faq.category.v2.category_updated
+ */
+export declare function onCategoryUpdated(handler: (event: CategoryUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * Creates a new Category.
+ * @param category - Category to be created.
+ * @public
+ * @requiredField category
+ * @requiredField category.title
+ * @permissionId FAQ.CREATE_CATEGORY
+ * @permissionScope Manage FAQ
+ * @permissionScopeId SCOPE.DC-LABS.MANAGE-FAQ
+ * @applicableIdentity APP
+ * @returns The created Category.
+ * @fqn wix.faq.category.v2.CategoryService.CreateCategory
+ */
+export declare function createCategory(category: Category): Promise<Category>;
+/**
+ * Retrieves a single Category by id.
+ * @param categoryId - ID of the Category to retrieve.
+ * @public
+ * @requiredField categoryId
+ * @permissionId FAQ.READ_CATEGORIES
+ * @permissionScope Manage FAQ
+ * @permissionScopeId SCOPE.DC-LABS.MANAGE-FAQ
+ * @permissionScope Read FAQ
+ * @permissionScopeId SCOPE.DC-LABS.READ-FAQ
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @returns The requested Category.
+ * @fqn wix.faq.category.v2.CategoryService.GetCategory
+ */
+export declare function getCategory(categoryId: string): Promise<Category>;
+/**
+ * Updates a Category.
+ *
+ * Each time the Category is updated, `revision` increments by 1.
+ * The current `revision` must be passed when updating the Category.
+ * This ensures you're working with the latest Category and prevents unintended overwrites.
+ * @param _id - Category ID.
+ * @public
+ * @requiredField _id
+ * @requiredField category
+ * @requiredField category.revision
+ * @permissionId FAQ.UPDATE_CATEGORY
+ * @permissionScope Manage FAQ
+ * @permissionScopeId SCOPE.DC-LABS.MANAGE-FAQ
+ * @applicableIdentity APP
+ * @returns Updated Category.
+ * @fqn wix.faq.category.v2.CategoryService.UpdateCategory
+ */
+export declare function updateCategory(_id: string | null, category: UpdateCategory): Promise<Category>;
+export interface UpdateCategory {
+    /**
+     * Category ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the Category is updated.
+     * To prevent conflicting changes,
+     * the current revision must be passed when updating the Category.
+     *
+     * Ignored when creating a Category.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Category was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the Category was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /** Category title. */
+    title?: string | null;
+    /** Order of category within a site. */
+    sortOrder?: number | null;
+    /** Data Extensions */
+    extendedFields?: ExtendedFields;
+}
+/**
+ * Deletes a Category.
+ * Deleting a Category permanently removes them from the Category List.
+ * @param categoryId - Id of the Category to delete.
+ * @public
+ * @requiredField categoryId
+ * @permissionId FAQ.DELETE_CATEGORY
+ * @permissionScope Manage FAQ
+ * @permissionScopeId SCOPE.DC-LABS.MANAGE-FAQ
+ * @applicableIdentity APP
+ * @fqn wix.faq.category.v2.CategoryService.DeleteCategory
+ */
+export declare function deleteCategory(categoryId: string): Promise<void>;
+/**
+ * Retrieves categories.
+ * @public
+ * @permissionId FAQ.READ_CATEGORIES
+ * @permissionScope Manage FAQ
+ * @permissionScopeId SCOPE.DC-LABS.MANAGE-FAQ
+ * @permissionScope Read FAQ
+ * @permissionScopeId SCOPE.DC-LABS.READ-FAQ
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.faq.category.v2.CategoryService.ListCategories
+ */
+export declare function listCategories(options?: ListCategoriesOptions): Promise<ListCategoriesResponse>;
+export interface ListCategoriesOptions {
+    /** Request more categories using cursor paging. */
+    paging?: CursorPaging;
+}
+/**
+ * Retrieves a list of Categories, given the provided [paging, filtering, and sorting].
+ * @public
+ * @permissionScope Manage FAQ
+ * @permissionScopeId SCOPE.DC-LABS.MANAGE-FAQ
+ * @permissionScope Read FAQ
+ * @permissionScopeId SCOPE.DC-LABS.READ-FAQ
+ * @permissionId FAQ.READ_CATEGORIES
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.faq.category.v2.CategoryService.QueryCategories
+ */
+export declare function queryCategories(): CategoriesQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+export interface CategoriesQueryResult extends QueryCursorResult {
+    items: Category[];
+    query: CategoriesQueryBuilder;
+    next: () => Promise<CategoriesQueryResult>;
+    prev: () => Promise<CategoriesQueryResult>;
+}
+export interface CategoriesQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    eq: (propertyName: '_id' | 'title' | 'sortOrder', value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    ne: (propertyName: '_id' | 'title' | 'sortOrder', value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    ge: (propertyName: 'sortOrder', value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    gt: (propertyName: 'sortOrder', value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    le: (propertyName: 'sortOrder', value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    lt: (propertyName: 'sortOrder', value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     */
+    startsWith: (propertyName: '_id' | 'title', value: string) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     */
+    hasSome: (propertyName: '_id' | 'title' | 'sortOrder', value: any[]) => CategoriesQueryBuilder;
+    in: (propertyName: '_id' | 'title' | 'sortOrder', value: any) => CategoriesQueryBuilder;
+    exists: (propertyName: '_id' | 'title' | 'sortOrder', value: boolean) => CategoriesQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
+    ascending: (...propertyNames: Array<'_id' | 'title' | 'sortOrder'>) => CategoriesQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
+    descending: (...propertyNames: Array<'_id' | 'title' | 'sortOrder'>) => CategoriesQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
+    limit: (limit: number) => CategoriesQueryBuilder;
+    /** @param cursor - A pointer to specific record */
+    skipTo: (cursor: string) => CategoriesQueryBuilder;
+    find: () => Promise<CategoriesQueryResult>;
+}
+/**
+ * Updates extended fields of a Category without incrementing revision
+ * @param _id - ID of the entity to update.
+ * @param namespace - Identifier for the app whose extended fields are being updated.
+ * @public
+ * @requiredField _id
+ * @requiredField namespace
+ * @requiredField options
+ * @requiredField options.namespaceData
+ * @permissionId FAQ.UPDATE_CATEGORY
+ * @permissionScope Manage FAQ
+ * @permissionScopeId SCOPE.DC-LABS.MANAGE-FAQ
+ * @applicableIdentity APP
+ * @fqn wix.faq.category.v2.CategoryService.UpdateExtendedFields
+ */
+export declare function updateExtendedFields(_id: string, namespace: string, options: UpdateExtendedFieldsOptions): Promise<UpdateExtendedFieldsResponse>;
+export interface UpdateExtendedFieldsOptions {
+    /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
+    namespaceData: Record<string, any> | null;
+}
+export {};