@wix/auto_sdk_events_categories 1.0.20 → 1.0.22

package/build/cjs/index.d.ts

@@ -1,7 +1,8 @@
-import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
 import { Category, BulkCreateCategoryResponse, UpdateCategory, QueryCategoriesOptions, CategoriesQueryBuilder, BulkAssignEventsOptions, BulkAssignEventsResponse, BulkAssignEventsAsyncOptions, BulkUnassignEventsOptions, BulkUnassignEventsResponse, BulkUnassignEventsAsyncOptions, ListEventCategoriesResponse, ReorderCategoryEventsOptions, ReorderCategoryEventsApplicationErrors } from './index.typings.js';
 export { ActionEvent, ApplicationError, AssignEventsRequest, AssignEventsResponse, BulkActionMetadata, BulkAssignEventsAsyncRequest, BulkAssignEventsAsyncResponse, BulkAssignEventsRequest, BulkCategoryResult, BulkCreateCategoryRequest, BulkUnassignEventsAsyncRequest, BulkUnassignEventsAsyncResponse, BulkUnassignEventsRequest, CategoriesQueryResult, CategoryCounts, CategoryFieldset, CreateCategoryRequest, CreateCategoryResponse, Cursors, DeleteCategoryRequest, DeleteCategoryResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, ListEventCategoriesRequest, MessageEnvelope, Paging, PagingMetadataV2, QueryCategoriesRequest, QueryCategoriesResponse, QueryV2, QueryV2PagingMethodOneOf, ReorderCategoryEventsOptionsReferenceEventOneOf, ReorderCategoryEventsRequest, ReorderCategoryEventsRequestReferenceEventOneOf, ReorderCategoryEventsResponse, RestoreInfo, SortOrder, Sorting, State, UnassignEventsRequest, UnassignEventsResponse, UpdateCategoryRequest, UpdateCategoryResponse, WebhookIdentityType } from './index.typings.js';
 
+type CategoryNonNullablePaths = `_id` | `name` | `states`;
 declare function createCategory$1(httpClient: HttpClient): CreateCategorySignature;
 interface CreateCategorySignature {
     /**
@@ -9,7 +10,7 @@ interface CreateCategorySignature {
      * @param - Category to create.
      * @returns Created category.
      */
-    (category: Category): Promise<Category>;
+    (category: Category): Promise<NonNullablePaths<Category, CategoryNonNullablePaths>>;
 }
 declare function bulkCreateCategory$1(httpClient: HttpClient): BulkCreateCategorySignature;
 interface BulkCreateCategorySignature {
@@ -17,7 +18,9 @@ interface BulkCreateCategorySignature {
      * Creates multiple categories at once.
      * @param - Categories to create.
      */
-    (categories: Category[]): Promise<BulkCreateCategoryResponse>;
+    (categories: Category[]): Promise<NonNullablePaths<BulkCreateCategoryResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+        [P in CategoryNonNullablePaths]: `results.${number}.item.${P}`;
+    }[CategoryNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 }
 declare function updateCategory$1(httpClient: HttpClient): UpdateCategorySignature;
 interface UpdateCategorySignature {
@@ -26,7 +29,7 @@ interface UpdateCategorySignature {
      * @param - Category ID.
      * @returns Updated category.
      */
-    (_id: string, category: UpdateCategory): Promise<Category>;
+    (_id: string, category: UpdateCategory): Promise<NonNullablePaths<Category, CategoryNonNullablePaths>>;
 }
 declare function deleteCategory$1(httpClient: HttpClient): DeleteCategorySignature;
 interface DeleteCategorySignature {
@@ -53,7 +56,7 @@ interface QueryCategoriesSignature {
      *  - [`limit(50)`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/limit)
      * @param - Options to use when querying categories.
      */
-    (options?: QueryCategoriesOptions | undefined): CategoriesQueryBuilder;
+    (options?: QueryCategoriesOptions): CategoriesQueryBuilder;
 }
 declare function assignEvents$1(httpClient: HttpClient): AssignEventsSignature;
 interface AssignEventsSignature {
@@ -71,7 +74,9 @@ interface BulkAssignEventsSignature {
      * @param - A list of category IDs to which events should be assigned.
      * @param - Options to use when assigning events to multiple categories.
      */
-    (categoryId: string[], options: BulkAssignEventsOptions): Promise<BulkAssignEventsResponse>;
+    (categoryId: string[], options: NonNullablePaths<BulkAssignEventsOptions, `eventId`>): Promise<NonNullablePaths<BulkAssignEventsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+        [P in CategoryNonNullablePaths]: `results.${number}.item.${P}`;
+    }[CategoryNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 }
 declare function bulkAssignEventsAsync$1(httpClient: HttpClient): BulkAssignEventsAsyncSignature;
 interface BulkAssignEventsAsyncSignature {
@@ -84,7 +89,7 @@ interface BulkAssignEventsAsyncSignature {
      * @param - Category IDs.
      * @param - Options to use when assigning events to multiple categories.
      */
-    (categoryId: string[], options: BulkAssignEventsAsyncOptions): Promise<void>;
+    (categoryId: string[], options: NonNullablePaths<BulkAssignEventsAsyncOptions, `filter`>): Promise<void>;
 }
 declare function unassignEvents$1(httpClient: HttpClient): UnassignEventsSignature;
 interface UnassignEventsSignature {
@@ -102,7 +107,9 @@ interface BulkUnassignEventsSignature {
      * @param - A list of category IDs.
      * @param - Options to use when removing events from multiple categories.
      */
-    (categoryId: string[], options?: BulkUnassignEventsOptions | undefined): Promise<BulkUnassignEventsResponse>;
+    (categoryId: string[], options?: BulkUnassignEventsOptions): Promise<NonNullablePaths<BulkUnassignEventsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+        [P in CategoryNonNullablePaths]: `results.${number}.item.${P}`;
+    }[CategoryNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 }
 declare function bulkUnassignEventsAsync$1(httpClient: HttpClient): BulkUnassignEventsAsyncSignature;
 interface BulkUnassignEventsAsyncSignature {
@@ -115,7 +122,7 @@ interface BulkUnassignEventsAsyncSignature {
      * @param - Category ID.
      * @param - Options to use when removing events from multiple categories.
      */
-    (categoryId: string[], options: BulkUnassignEventsAsyncOptions): Promise<void>;
+    (categoryId: string[], options: NonNullablePaths<BulkUnassignEventsAsyncOptions, `filter`>): Promise<void>;
 }
 declare function listEventCategories$1(httpClient: HttpClient): ListEventCategoriesSignature;
 interface ListEventCategoriesSignature {
@@ -123,7 +130,9 @@ interface ListEventCategoriesSignature {
      * Retrieves a list of categories that are not in the `HIDDEN` state.
      * @param - Event ID.
      */
-    (eventId: string): Promise<ListEventCategoriesResponse>;
+    (eventId: string): Promise<NonNullablePaths<ListEventCategoriesResponse, {
+        [P in CategoryNonNullablePaths]: `categories.${number}.${P}`;
+    }[CategoryNonNullablePaths]>>;
 }
 declare function reorderCategoryEvents$1(httpClient: HttpClient): ReorderCategoryEventsSignature;
 interface ReorderCategoryEventsSignature {
@@ -135,8 +144,8 @@ interface ReorderCategoryEventsSignature {
      * @param - Category ID.
      * @param - Options to use when reordering events.
      */
-    (categoryId: string, options?: ReorderCategoryEventsOptions | undefined): Promise<void & {
-        __applicationErrorsType?: ReorderCategoryEventsApplicationErrors | undefined;
+    (categoryId: string, options?: ReorderCategoryEventsOptions): Promise<void & {
+        __applicationErrorsType?: ReorderCategoryEventsApplicationErrors;
     }>;
 }