@wix/auto_sdk_faq_question-entry 1.0.18 → 1.0.19

package/build/cjs/index.d.ts

@@ -6,48 +6,61 @@ type QuestionEntryNonNullablePaths = `draftjs` | `plainText` | `labels` | `label
 declare function createQuestionEntry$1(httpClient: HttpClient): CreateQuestionEntrySignature;
 interface CreateQuestionEntrySignature {
     /**
-     * Creates a new QuestionEntry.
-     * @param - QuestionEntry to be created.
-     * @returns The created QuestionEntry.
+     * Creates a question entry with the provided details including question text, answer content, and category assignment.
+     * The question entry must be assigned to an existing category and can optionally include labels for additional organization.
+     * @param - Question entry to create.
+     * @returns Created question entry.
      */
     (questionEntry: NonNullablePaths<QuestionEntry, `question`>): Promise<NonNullablePaths<QuestionEntry, QuestionEntryNonNullablePaths>>;
 }
 declare function getQuestionEntry$1(httpClient: HttpClient): GetQuestionEntrySignature;
 interface GetQuestionEntrySignature {
     /**
-     * Retrieves a single QuestionEntry by id.
-     * @param - ID of the QuestionEntry to retrieve.
-     * @returns The requested QuestionEntry.
+     * Retrieves a single question entry by ID.
+     * @param - ID of the question entry to retrieve.
+     * @returns Retrieved question entry.
      */
     (questionEntryId: string): Promise<NonNullablePaths<QuestionEntry, QuestionEntryNonNullablePaths>>;
 }
 declare function updateQuestionEntry$1(httpClient: HttpClient): UpdateQuestionEntrySignature;
 interface UpdateQuestionEntrySignature {
     /**
-     * Updates a QuestionEntry, replaces the previous version.
+     * Updates a question entry.
      *
-     * Each time the QuestionEntry is updated `revision` increments by 1.
-     * The current `revision` must be passed when updating the QuestionEntry.
-     * This ensures you're working with the latest QuestionEntry and prevents unintended overwrites.
-     * @param - QuestionEntry ID.
-     * @returns Updated QuestionEntry.
+     * Each time the question entry is updated, `revision` increments by 1.
+     * The current `revision` must be specified when updating the question entry.
+     * This ensures you're working with the latest version of a question entry and prevents unintended overwrites.
+     *
+     * To update multiple question entries, call the Bulk Update Question Entry method.
+     *
+     * To update only the question entry's `extendedFields` field, call the Update Extended Fields method.
+     *
+     * To update only the question entry's labels, call the Set Question Entry Labels method.
+     * @param - Question entry ID.
+     * @returns Updated question entry.
      */
     (_id: string, questionEntry: NonNullablePaths<UpdateQuestionEntry, `revision`>): Promise<NonNullablePaths<QuestionEntry, QuestionEntryNonNullablePaths>>;
 }
 declare function deleteQuestionEntry$1(httpClient: HttpClient): DeleteQuestionEntrySignature;
 interface DeleteQuestionEntrySignature {
     /**
-     * Deletes a QuestionEntry.
-     * Deleting a QuestionEntry permanently removes them from the QuestionEntry List.
-     * @param - Id of the QuestionEntry to delete.
+     * Deletes a question entry.
+     *
+     * Deleting a question entry permanently removes it from the site's Wix FAQ dashboard page.
+     *
+     * To delete multiple question entries, call the Bulk Delete Question Entries method.
+     * @param - ID of the question entry to delete.
      */
     (questionEntryId: string): Promise<void>;
 }
 declare function listQuestionEntries$1(httpClient: HttpClient): ListQuestionEntriesSignature;
 interface ListQuestionEntriesSignature {
     /**
-     * Retrieves up to 100 question entries, given the provided filtering, paging, and sorting.
-     * Use the `fieldSet` parameter to set whether sharing links are included in the response.
+     * Retrieves a list of question entries, given the specified filters and paging.
+     *
+     * For field support for filters and sorting, see [Question Entries V2: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/faq-app/faq/question-entry-v2/supported-filters).
+     *
+     * Use the `fieldSet` parameter to control whether sharing links are included in the response.
      */
     (options?: ListQuestionEntriesOptions): Promise<NonNullablePaths<ListQuestionEntriesResponse, {
         [P in QuestionEntryNonNullablePaths]: `questionEntries.${number}.${P}`;
@@ -56,22 +69,28 @@ interface ListQuestionEntriesSignature {
 declare function queryQuestionEntries$1(httpClient: HttpClient): QueryQuestionEntriesSignature;
 interface QueryQuestionEntriesSignature {
     /**
-     * Retrieves a list of QuestionEntries, given the provided [paging, filtering, and sorting].
+     * Retrieves question entries, given the provided paging, filtering, and sorting.
+     *
+     * For field support for filters and sorting, see [Question Entries V2: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/faq-app/faq/question-entry-v2/supported-filters).
      */
     (options?: QueryQuestionEntriesOptions): QuestionEntriesQueryBuilder;
 }
 declare function bulkDeleteQuestionEntries$1(httpClient: HttpClient): BulkDeleteQuestionEntriesSignature;
 interface BulkDeleteQuestionEntriesSignature {
     /**
-     * Deletes multiple QuestionEntries in a single request. Works synchronously.
-     * @param - QuestionEntry ids to be deleted.
+     * Deletes multiple question entries.
+     *
+     * Deleting a question entry permanently removes it from the site's Wix FAQ dashboard page.
+     *
+     * To delete a single question entry, call the Delete Question Entry method.
+     * @param - IDs of question entries to delete.
      */
     (questionEntryIds: string[]): Promise<NonNullablePaths<BulkDeleteQuestionEntriesResponse, `itemMetadata` | `itemMetadata.${number}.originalIndex` | `itemMetadata.${number}.success` | `itemMetadata.${number}.error.code` | `itemMetadata.${number}.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 }
 declare function updateExtendedFields$1(httpClient: HttpClient): UpdateExtendedFieldsSignature;
 interface UpdateExtendedFieldsSignature {
     /**
-     * Updates extended fields of a QuestionEntry without incrementing revision
+     * Updates extended fields of a question entry without incrementing `revision`.
      * @param - ID of the entity to update.
      * @param - Identifier for the app whose extended fields are being updated.
      */
@@ -82,9 +101,11 @@ interface UpdateExtendedFieldsSignature {
 declare function setQuestionEntryLabels$1(httpClient: HttpClient): SetQuestionEntryLabelsSignature;
 interface SetQuestionEntryLabelsSignature {
     /**
-     * Adds or updates a question entry's labels. Replaces existing labels.
-     * Note: If 'labels' field is empty in the request, it will clear all existing labels for the question entry.
-     * @param - ID of question entry to add labels to.
+     * Sets `labels` for a question entry.
+     *
+     * This method replaces all existing labels for the question entry.
+     * To clear all labels, specify an empty labels array.
+     * @param - ID of the question entry to update labels for.
      */
     (questionEntryId: string, options?: SetQuestionEntryLabelsOptions): Promise<NonNullablePaths<SetQuestionEntryLabelsResponse, {
         [P in QuestionEntryNonNullablePaths]: `questionEntry.${P}`;
@@ -93,11 +114,13 @@ interface SetQuestionEntryLabelsSignature {
 declare function bulkUpdateQuestionEntry$1(httpClient: HttpClient): BulkUpdateQuestionEntrySignature;
 interface BulkUpdateQuestionEntrySignature {
     /**
-     * Updates multiple question entries'.
-     * This method replace the following bulk methods from the previous service:
-     * 1. updateQuestionsVisibility - Updates multiple question entries' visibility within their categories
-     * 2. bulkSetQuestionStatus - Updates multiple question entries' statuses.
-     * 3. bulkUpdateLabelOrder - Updates a question entry's labels order.
+     * Updates multiple question entries.
+     *
+     * Each time a question entry is updated, its `revision` increments by 1.
+     * The current `revision` must be specified when updating the question entry.
+     * This ensures you're working with the latest version of a question entry and prevents unintended overwrites.
+     *
+     * To update a single question entry, call the Update Question Entry method.
      */
     (options?: NonNullablePaths<BulkUpdateQuestionEntryOptions, `questionEntries.${number}.questionEntry` | `questionEntries.${number}.questionEntry._id` | `questionEntries.${number}.questionEntry.revision`>): Promise<NonNullablePaths<BulkUpdateQuestionEntryResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
         [P in QuestionEntryNonNullablePaths]: `results.${number}.questionEntry.${P}`;