@wix/auto_sdk_faq_question-entry 1.0.0 → 1.0.2

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

@@ -1,12 +1,21 @@
 export interface QuestionEntry extends QuestionEntryAnswerOneOf {
-    /** draft.js text. */
+    /**
+     * draft.js text.
+     * @minLength 1
+     * @maxLength 100000
+     */
     draftjs?: string;
     /** rich content text. */
     richContent?: RichContent;
-    /** plain text. */
+    /**
+     * plain text.
+     * @minLength 1
+     * @maxLength 10000
+     */
     plainText?: string;
     /**
      * QuestionEntry ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
@@ -29,24 +38,36 @@ export interface QuestionEntry extends QuestionEntryAnswerOneOf {
      * @readonly
      */
     _updatedDate?: Date | null;
-    /** QuestionEntry title. */
+    /**
+     * QuestionEntry title.
+     * @maxLength 1000
+     */
     question?: string | null;
-    /** List of up to 100 labels for this question entry. */
+    /**
+     * List of up to 100 labels for this question entry.
+     * @maxSize 100
+     */
     labels?: Label[];
     /** Order of question out of all questions (and not only in the category). */
     sortOrder?: number | null;
     /** Question's visibility status within the site. */
     status?: QuestionStatus;
-    /** ID of the category to which this question belongs. */
+    /**
+     * ID of the category to which this question belongs.
+     * @minLength 1
+     * @maxLength 50
+     */
     categoryId?: string | null;
     /**
      * FURL slug for this question generated from the question entry's text.
      * @readonly
+     * @maxLength 100
      */
     slug?: string | null;
     /**
      * Unique question URL.
      * @readonly
+     * @format WEB_URL
      */
     shareLink?: string | null;
     /** Data Extensions */
@@ -54,11 +75,19 @@ export interface QuestionEntry extends QuestionEntryAnswerOneOf {
 }
 /** @oneof */
 export interface QuestionEntryAnswerOneOf {
-    /** draft.js text. */
+    /**
+     * draft.js text.
+     * @minLength 1
+     * @maxLength 100000
+     */
     draftjs?: string;
     /** rich content text. */
     richContent?: RichContent;
-    /** plain text. */
+    /**
+     * plain text.
+     * @minLength 1
+     * @maxLength 10000
+     */
     plainText?: string;
 }
 export interface RichContent {
@@ -659,11 +688,20 @@ export interface GIFData {
     gifType?: GIFType;
 }
 export interface GIF {
-    /** GIF format URL. */
+    /**
+     * GIF format URL.
+     * @format WEB_URL
+     */
     gif?: string | null;
-    /** MP4 format URL. */
+    /**
+     * MP4 format URL.
+     * @format WEB_URL
+     */
     mp4?: string | null;
-    /** Thumbnail URL. */
+    /**
+     * Thumbnail URL.
+     * @format WEB_URL
+     */
     still?: string | null;
 }
 export declare enum GIFType {
@@ -729,6 +767,25 @@ export interface ImageData {
     caption?: string | null;
     /** Sets whether the image's download button is disabled. Defaults to `false`. */
     disableDownload?: boolean | null;
+    /** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
+    decorative?: boolean | null;
+    /** Styling for the image. */
+    styles?: ImageDataStyles;
+}
+export interface StylesBorder {
+    /** Border width in pixels. */
+    width?: number | null;
+    /**
+     * Border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    color?: string | null;
+    /** Border radius in pixels. */
+    radius?: number | null;
+}
+export interface ImageDataStyles {
+    /** Border attributes. */
+    border?: StylesBorder;
 }
 export interface LinkPreviewData {
     /** Styling for the link preview's container. */
@@ -875,13 +932,22 @@ export declare enum BackgroundType {
 export interface Gradient {
     /** The gradient angle in degrees. */
     angle?: number | null;
-    /** The start color as a hexademical value. */
+    /**
+     * The start color as a hexademical value.
+     * @format COLOR_HEX
+     */
     startColor?: string | null;
-    /** The end color as a hexademical value. */
+    /**
+     * The end color as a hexademical value.
+     * @format COLOR_HEX
+     */
     lastColor?: string | null;
 }
 export interface Background extends BackgroundBackgroundOneOf {
-    /** The background color as a hexademical value. */
+    /**
+     * The background color as a hexademical value.
+     * @format COLOR_HEX
+     */
     color?: string | null;
     /** An image to use for the background. */
     image?: Media;
@@ -892,7 +958,10 @@ export interface Background extends BackgroundBackgroundOneOf {
 }
 /** @oneof */
 export interface BackgroundBackgroundOneOf {
-    /** The background color as a hexademical value. */
+    /**
+     * The background color as a hexademical value.
+     * @format COLOR_HEX
+     */
     color?: string | null;
     /** An image to use for the background. */
     image?: Media;
@@ -1204,17 +1273,32 @@ export declare enum VerticalAlignment {
 export interface CellStyle {
     /** Vertical alignment for the cell's text. */
     verticalAlignment?: VerticalAlignment;
-    /** Cell background color as a hexadecimal value. */
+    /**
+     * Cell background color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
     backgroundColor?: string | null;
 }
 export interface BorderColors {
-    /** Left border color as a hexadecimal value. */
+    /**
+     * Left border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
     left?: string | null;
-    /** Right border color as a hexadecimal value. */
+    /**
+     * Right border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
     right?: string | null;
-    /** Top border color as a hexadecimal value. */
+    /**
+     * Top border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
     top?: string | null;
-    /** Bottom border color as a hexadecimal value. */
+    /**
+     * Bottom border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
     bottom?: string | null;
 }
 /**
@@ -1324,7 +1408,11 @@ export interface TextNodeStyle {
 }
 /** Labels are additional groupings of question entries for organizing FAQ questions in specific contexts. */
 export interface Label {
-    /** Label title. */
+    /**
+     * Label title.
+     * @minLength 1
+     * @maxLength 36
+     */
     title?: string;
     /** Order of question entry within label. */
     sortOrder?: number | null;
@@ -1354,7 +1442,10 @@ export interface CreateQuestionEntryResponse {
     questionEntry?: QuestionEntry;
 }
 export interface GetQuestionEntryRequest {
-    /** ID of the QuestionEntry to retrieve. */
+    /**
+     * ID of the QuestionEntry to retrieve.
+     * @format GUID
+     */
     questionEntryId: string;
 }
 export interface GetQuestionEntryResponse {
@@ -1370,33 +1461,55 @@ export interface UpdateQuestionEntryResponse {
     questionEntry?: QuestionEntry;
 }
 export interface DeleteQuestionEntryRequest {
-    /** Id of the QuestionEntry to delete. */
+    /**
+     * Id of the QuestionEntry to delete.
+     * @format GUID
+     */
     questionEntryId: string;
 }
 export interface DeleteQuestionEntryResponse {
 }
 export interface ListQuestionEntriesRequest {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @minLength 1
+     * @maxLength 50
+     */
     categoryId?: string | null;
-    /** List of question entry IDs. */
+    /**
+     * List of question entry IDs.
+     * @format GUID
+     * @maxSize 100
+     */
     questionEntryIds?: string[];
-    /** Question label. */
+    /**
+     * Question label.
+     * @minLength 1
+     * @maxLength 36
+     */
     questionEntryLabel?: string | null;
     /** Not needed if `question_entry_id`s are provided in filter. */
     paging?: CursorPaging;
     /** Text output format. */
     contentFormat?: ContentFormat;
-    /** Include fields inside question entries. */
+    /**
+     * Include fields inside question entries.
+     * @maxSize 100
+     */
     fieldSet?: FieldSet[];
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
     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.
+     * @maxLength 16000
      */
     cursor?: string | null;
 }
@@ -1429,9 +1542,15 @@ export interface PagingMetadataV2 {
     cursors?: Cursors;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface QueryQuestionEntriesRequest {
@@ -1439,7 +1558,10 @@ export interface QueryQuestionEntriesRequest {
     query?: CursorQuery;
     /** Text output format. */
     contentFormat?: QueryQuestionEntriesRequestContentFormat;
-    /** Include fields inside question entries. */
+    /**
+     * Include fields inside question entries.
+     * @maxSize 100
+     */
     fieldSet?: QueryQuestionEntriesRequestFieldSet[];
 }
 export interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -1459,6 +1581,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
      * Sort object.
      *
      * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * @maxSize 5
      */
     sort?: Sorting[];
 }
@@ -1472,7 +1595,10 @@ export interface CursorQueryPagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -1511,11 +1637,20 @@ export interface CursorPagingMetadata {
     hasNext?: boolean | null;
 }
 export interface BulkDeleteQuestionEntryRequest {
-    /** QuestionEntry ids to be deleted. */
+    /**
+     * QuestionEntry ids to be deleted.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
     questionEntryIds: string[];
 }
 export interface BulkDeleteQuestionEntryResponse {
-    /** Information about successful action or error for failure. */
+    /**
+     * Information about successful action or error for failure.
+     * @minSize 1
+     * @maxSize 100
+     */
     itemMetadata?: ItemMetadata[];
     /** Holds metadata of the entire bulk delete operation */
     bulkActionMetadata?: BulkActionMetadata;
@@ -1559,9 +1694,15 @@ export interface UpdateExtendedFieldsResponse {
     questionEntry?: QuestionEntry;
 }
 export interface SetQuestionEntryLabelsRequest {
-    /** ID of question entry to add labels to. */
+    /**
+     * ID of question entry to add labels to.
+     * @format GUID
+     */
     questionEntryId: string;
-    /** Labels to add to the question entry. */
+    /**
+     * Labels to add to the question entry.
+     * @maxSize 100
+     */
     labels?: Label[];
 }
 export interface SetQuestionEntryLabelsResponse {
@@ -1569,7 +1710,11 @@ export interface SetQuestionEntryLabelsResponse {
     questionEntry?: QuestionEntry;
 }
 export interface BulkUpdateQuestionEntryRequest {
-    /** List of question entry IDs to change status for. */
+    /**
+     * List of question entry IDs to change status for.
+     * @minSize 1
+     * @maxSize 100
+     */
     questionEntries?: MaskedQuestionEntry[];
     /** set to `true` if you wish to receive back the updated entities in the response */
     returnFullEntity?: boolean | null;
@@ -1579,7 +1724,10 @@ export interface MaskedQuestionEntry {
     questionEntry?: QuestionEntry;
 }
 export interface BulkUpdateQuestionEntryResponse {
-    /** Array with all updated items results. */
+    /**
+     * Array with all updated items results.
+     * @maxSize 100
+     */
     results?: BulkUpdateQuestionEntryResult[];
     /** Holds metadata of the entire bulk update operation */
     bulkActionMetadata?: BulkActionMetadata;
@@ -1663,9 +1811,15 @@ export interface ActionEvent {
 export interface Empty {
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -1673,26 +1827,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {
@@ -2008,9 +2186,15 @@ export interface BulkUpdateQuestionEntryResponseNonNullableFields {
     bulkActionMetadata?: BulkActionMetadataNonNullableFields;
 }
 export interface BaseEventMetadata {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -2059,6 +2243,8 @@ export interface QuestionEntryCreatedEnvelope {
 }
 /** @webhook
  * @eventType wix.faq.question_entry.v2.question_entry_created
+ * @serviceIdentifier wix.faq.questionentry.v2.QuestionEntryService
+ * @slug created
  */
 export declare function onQuestionEntryCreated(handler: (event: QuestionEntryCreatedEnvelope) => void | Promise<void>): void;
 export interface QuestionEntryDeletedEnvelope {
@@ -2066,6 +2252,8 @@ export interface QuestionEntryDeletedEnvelope {
 }
 /** @webhook
  * @eventType wix.faq.question_entry.v2.question_entry_deleted
+ * @serviceIdentifier wix.faq.questionentry.v2.QuestionEntryService
+ * @slug deleted
  */
 export declare function onQuestionEntryDeleted(handler: (event: QuestionEntryDeletedEnvelope) => void | Promise<void>): void;
 export interface QuestionEntryUpdatedEnvelope {
@@ -2074,6 +2262,8 @@ export interface QuestionEntryUpdatedEnvelope {
 }
 /** @webhook
  * @eventType wix.faq.question_entry.v2.question_entry_updated
+ * @serviceIdentifier wix.faq.questionentry.v2.QuestionEntryService
+ * @slug updated
  */
 export declare function onQuestionEntryUpdated(handler: (event: QuestionEntryUpdatedEnvelope) => void | Promise<void>): void;
 /**
@@ -2126,14 +2316,23 @@ export declare function getQuestionEntry(questionEntryId: string): Promise<Quest
  */
 export declare function updateQuestionEntry(_id: string | null, questionEntry: UpdateQuestionEntry): Promise<QuestionEntry & QuestionEntryNonNullableFields>;
 export interface UpdateQuestionEntry {
-    /** draft.js text. */
+    /**
+     * draft.js text.
+     * @minLength 1
+     * @maxLength 100000
+     */
     draftjs?: string;
     /** rich content text. */
     richContent?: RichContent;
-    /** plain text. */
+    /**
+     * plain text.
+     * @minLength 1
+     * @maxLength 10000
+     */
     plainText?: string;
     /**
      * QuestionEntry ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
@@ -2156,24 +2355,36 @@ export interface UpdateQuestionEntry {
      * @readonly
      */
     _updatedDate?: Date | null;
-    /** QuestionEntry title. */
+    /**
+     * QuestionEntry title.
+     * @maxLength 1000
+     */
     question?: string | null;
-    /** List of up to 100 labels for this question entry. */
+    /**
+     * List of up to 100 labels for this question entry.
+     * @maxSize 100
+     */
     labels?: Label[];
     /** Order of question out of all questions (and not only in the category). */
     sortOrder?: number | null;
     /** Question's visibility status within the site. */
     status?: QuestionStatus;
-    /** ID of the category to which this question belongs. */
+    /**
+     * ID of the category to which this question belongs.
+     * @minLength 1
+     * @maxLength 50
+     */
     categoryId?: string | null;
     /**
      * FURL slug for this question generated from the question entry's text.
      * @readonly
+     * @maxLength 100
      */
     slug?: string | null;
     /**
      * Unique question URL.
      * @readonly
+     * @format WEB_URL
      */
     shareLink?: string | null;
     /** Data Extensions */
@@ -2207,17 +2418,32 @@ export declare function deleteQuestionEntry(questionEntryId: string): Promise<vo
  */
 export declare function listQuestionEntries(options?: ListQuestionEntriesOptions): Promise<ListQuestionEntriesResponse & ListQuestionEntriesResponseNonNullableFields>;
 export interface ListQuestionEntriesOptions {
-    /** Category ID. */
+    /**
+     * Category ID.
+     * @minLength 1
+     * @maxLength 50
+     */
     categoryId?: string | null;
-    /** List of question entry IDs. */
+    /**
+     * List of question entry IDs.
+     * @format GUID
+     * @maxSize 100
+     */
     questionEntryIds?: string[];
-    /** Question label. */
+    /**
+     * Question label.
+     * @minLength 1
+     * @maxLength 36
+     */
     questionEntryLabel?: string | null;
     /** Not needed if `question_entry_id`s are provided in filter. */
     paging?: CursorPaging;
     /** Text output format. */
     contentFormat?: ContentFormat;
-    /** Include fields inside question entries. */
+    /**
+     * Include fields inside question entries.
+     * @maxSize 100
+     */
     fieldSet?: FieldSet[];
 }
 /**
@@ -2236,7 +2462,10 @@ export declare function queryQuestionEntries(options?: QueryQuestionEntriesOptio
 export interface QueryQuestionEntriesOptions {
     /** Text output format. */
     contentFormat?: QueryQuestionEntriesRequestContentFormat | undefined;
-    /** Include fields inside question entries. */
+    /**
+     * Include fields inside question entries.
+     * @maxSize 100
+     */
     fieldSet?: QueryQuestionEntriesRequestFieldSet[] | undefined;
 }
 interface QueryCursorResult {
@@ -2343,7 +2572,10 @@ export interface UpdateExtendedFieldsOptions {
  */
 export declare function setQuestionEntryLabels(questionEntryId: string, options?: SetQuestionEntryLabelsOptions): Promise<SetQuestionEntryLabelsResponse & SetQuestionEntryLabelsResponseNonNullableFields>;
 export interface SetQuestionEntryLabelsOptions {
-    /** Labels to add to the question entry. */
+    /**
+     * Labels to add to the question entry.
+     * @maxSize 100
+     */
     labels?: Label[];
 }
 /**
@@ -2364,7 +2596,11 @@ export interface SetQuestionEntryLabelsOptions {
  */
 export declare function bulkUpdateQuestionEntry(options?: BulkUpdateQuestionEntryOptions): Promise<BulkUpdateQuestionEntryResponse & BulkUpdateQuestionEntryResponseNonNullableFields>;
 export interface BulkUpdateQuestionEntryOptions {
-    /** List of question entry IDs to change status for. */
+    /**
+     * List of question entry IDs to change status for.
+     * @minSize 1
+     * @maxSize 100
+     */
     questionEntries?: MaskedQuestionEntry[];
     /** set to `true` if you wish to receive back the updated entities in the response */
     returnFullEntity?: boolean | null;