@wix/auto_sdk_online-programs_sections 1.0.8 → 1.0.10

package/build/es/index.typings.d.mts

@@ -1,4 +1,4 @@
-import { NonNullablePaths } from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
 
 interface Section {
     /**
@@ -810,6 +810,23 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountDetails {
+    /**
+     * ID of the account.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the site, if applicable.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
 /**
  * Creates a Section.
  * @param section - Section to be created.
@@ -1040,7 +1057,88 @@ interface SectionsQueryBuilder {
  * @fqn wix.onlineprograms.sections.v3.SectionsService.QuerySections
  * @requiredField query
  */
-declare function typedQuerySections(query: CursorQuery, options?: QuerySectionsOptions): Promise<NonNullablePaths<QuerySectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.state` | `sections.${number}.oldTotalSteps` | `sections.${number}.trialSection` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 5>>;
+declare function typedQuerySections(query: SectionQuery, options?: QuerySectionsOptions): Promise<NonNullablePaths<QuerySectionsResponse, `sections` | `sections.${number}.programId` | `sections.${number}.description.title` | `sections.${number}.state` | `sections.${number}.oldTotalSteps` | `sections.${number}.trialSection` | `sections.${number}.ordering` | `sections.${number}.delayInDays`, 5>>;
+interface SectionQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: ['programId'];
+            operators: ['$eq'];
+            sort: 'NONE';
+        },
+        {
+            fields: ['delayInDays'];
+            operators: ['$eq'];
+            sort: 'BOTH';
+        },
+        {
+            fields: ['_createdDate'];
+            operators: [];
+            sort: 'BOTH';
+        },
+        {
+            fields: ['trialSection'];
+            operators: ['$eq'];
+            sort: 'NONE';
+        },
+        {
+            fields: ['_id'];
+            operators: ['$eq', '$in', '$ne', '$nin'];
+            sort: 'BOTH';
+        },
+        {
+            fields: ['ordering'];
+            operators: [];
+            sort: 'BOTH';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<Section, SectionQuerySpec>;
+type SectionQuery = {
+    /**
+    Cursor paging options.
+  
+    Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+    */
+    cursorPaging?: {
+        /**
+      Maximum number of items to return in the results.
+      @max: 100
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | 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?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object.
+  
+    Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object.
+  
+    Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+    @maxSize: 5
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
 /**
  * List sections per program id
  * @param programId - Program id to list sections
@@ -1131,4 +1229,4 @@ interface PublishSectionOptions {
     fields?: RequestedFieldsWithLiterals[];
 }
 
-export { type ActionEvent, type ApplicationError, type BulkActionMetadata, BulkActionType, type BulkActionTypeWithLiterals, type BulkCloneSectionRequest, type BulkCloneSectionResponse, type BulkCreateSectionMigrationRequest, type BulkCreateSectionMigrationResponse, type BulkCreateSectionOptions, type BulkCreateSectionRequest, type BulkCreateSectionResponse, type BulkSectionResult, type CloneSectionOptions, type CloneSectionRequest, type CloneSectionResponse, type CreateSectionOptions, type CreateSectionRequest, type CreateSectionResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteAllProgramSectionsRequest, type DeleteAllProgramSectionsResponse, type DeleteByFilterOperation, type DeleteByIdsOperation, type DeleteSectionRequest, type DeleteSectionResponse, type Description, DescriptionFieldSet, type DescriptionFieldSetWithLiterals, type DescriptionMediaOneOf, type DocumentImage, type DocumentPayload, type DocumentUpdateOperation, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type ExtendedFields, type FocalPoint, type GetSectionOptions, type GetSectionRequest, type GetSectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type IndexDocument, type ItemMetadata, type ListSectionsOptions, type ListSectionsRequest, type ListSectionsResponse, type MessageEnvelope, type MoveSectionOptions, type MoveSectionRequest, type MoveSectionResponse, type PublishSectionOptions, type PublishSectionRequest, type PublishSectionResponse, type QuerySectionsOptions, type QuerySectionsRequest, type QuerySectionsResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type RestoreSectionFromTrashRequest, type RestoreSectionFromTrashResponse, type SearchIndexingNotification, SearchIndexingNotificationState, type SearchIndexingNotificationStateWithLiterals, type Section, type SectionCloned, type SectionDeleted, type SectionMoved, type SectionPublished, type SectionUpdated, type SectionsQueryBuilder, type SectionsQueryResult, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type UpdateByFilterOperation, type UpdateDocumentsEvent, type UpdateDocumentsEventOperationOneOf, type UpdateExistingOperation, type UpdateSectionOptions, type UpdateSectionRequest, type UpdateSectionResponse, type VideoResolution, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateSection, bulkCreateSectionMigration, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, publishSection, querySections, typedQuerySections, updateSection };
+export { type AccountDetails, type ActionEvent, type ApplicationError, type BulkActionMetadata, BulkActionType, type BulkActionTypeWithLiterals, type BulkCloneSectionRequest, type BulkCloneSectionResponse, type BulkCreateSectionMigrationRequest, type BulkCreateSectionMigrationResponse, type BulkCreateSectionOptions, type BulkCreateSectionRequest, type BulkCreateSectionResponse, type BulkSectionResult, type CloneSectionOptions, type CloneSectionRequest, type CloneSectionResponse, type CommonQueryWithEntityContext, type CreateSectionOptions, type CreateSectionRequest, type CreateSectionResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteAllProgramSectionsRequest, type DeleteAllProgramSectionsResponse, type DeleteByFilterOperation, type DeleteByIdsOperation, type DeleteSectionRequest, type DeleteSectionResponse, type Description, DescriptionFieldSet, type DescriptionFieldSetWithLiterals, type DescriptionMediaOneOf, type DocumentImage, type DocumentPayload, type DocumentUpdateOperation, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type ExtendedFields, type FocalPoint, type GetSectionOptions, type GetSectionRequest, type GetSectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type IndexDocument, type ItemMetadata, type ListSectionsOptions, type ListSectionsRequest, type ListSectionsResponse, type MessageEnvelope, type MoveSectionOptions, type MoveSectionRequest, type MoveSectionResponse, type PublishSectionOptions, type PublishSectionRequest, type PublishSectionResponse, type QuerySectionsOptions, type QuerySectionsRequest, type QuerySectionsResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type RestoreSectionFromTrashRequest, type RestoreSectionFromTrashResponse, type SearchIndexingNotification, SearchIndexingNotificationState, type SearchIndexingNotificationStateWithLiterals, type Section, type SectionCloned, type SectionDeleted, type SectionMoved, type SectionPublished, type SectionQuery, type SectionQuerySpec, type SectionUpdated, type SectionsQueryBuilder, type SectionsQueryResult, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type UpdateByFilterOperation, type UpdateDocumentsEvent, type UpdateDocumentsEventOperationOneOf, type UpdateExistingOperation, type UpdateSectionOptions, type UpdateSectionRequest, type UpdateSectionResponse, type VideoResolution, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateSection, bulkCreateSectionMigration, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, publishSection, querySections, typedQuerySections, updateSection };