@wix/auto_sdk_online-programs_sections 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,109 @@
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { Section, CreateSectionOptions, BulkCreateSectionOptions, BulkCreateSectionResponse, BulkCreateSectionMigrationResponse, GetSectionOptions, UpdateSectionOptions, QuerySectionsOptions, SectionsQueryBuilder, ListSectionsOptions, ListSectionsResponse, CloneSectionOptions, CloneSectionResponse, MoveSectionOptions, MoveSectionResponse, PublishSectionOptions, PublishSectionResponse } from './index.typings.js';
+export { ActionEvent, ApplicationError, BulkActionMetadata, BulkActionType, BulkActionTypeWithLiterals, BulkCloneSectionRequest, BulkCloneSectionResponse, BulkCreateSectionMigrationRequest, BulkCreateSectionRequest, BulkSectionResult, CloneSectionRequest, CreateSectionRequest, CreateSectionResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteAllProgramSectionsRequest, DeleteAllProgramSectionsResponse, DeleteByFilterOperation, DeleteByIdsOperation, DeleteSectionRequest, DeleteSectionResponse, Description, DescriptionFieldSet, DescriptionFieldSetWithLiterals, DescriptionMediaOneOf, DocumentImage, DocumentPayload, DocumentUpdateOperation, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Enum, EnumWithLiterals, ExtendedFields, FocalPoint, GetSectionRequest, GetSectionResponse, IdentificationData, IdentificationDataIdOneOf, IndexDocument, ItemMetadata, ListSectionsRequest, MessageEnvelope, MoveSectionRequest, PublishSectionRequest, QuerySectionsRequest, QuerySectionsResponse, RequestedFields, RequestedFieldsWithLiterals, RestoreInfo, RestoreSectionFromTrashRequest, RestoreSectionFromTrashResponse, SearchIndexingNotification, SearchIndexingNotificationState, SearchIndexingNotificationStateWithLiterals, SectionCloned, SectionDeleted, SectionMoved, SectionPublished, SectionUpdated, SectionsQueryResult, SortOrder, SortOrderWithLiterals, Sorting, State, StateWithLiterals, UpdateByFilterOperation, UpdateDocumentsEvent, UpdateDocumentsEventOperationOneOf, UpdateExistingOperation, UpdateSectionRequest, UpdateSectionResponse, VideoResolution, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
+
+declare function createSection$1(httpClient: HttpClient): CreateSectionSignature;
+interface CreateSectionSignature {
+    /**
+     * Creates a Section.
+     * @param - Section to be created.
+     * @returns The created Section.
+     */
+    (section: Section, options?: CreateSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `state` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
+}
+declare function bulkCreateSection$1(httpClient: HttpClient): BulkCreateSectionSignature;
+interface BulkCreateSectionSignature {
+    /**
+     * Bulk Section creation.
+     * @param - List of sections you want to create
+     */
+    (sections: Section[], options?: BulkCreateSectionOptions): Promise<NonNullablePaths<BulkCreateSectionResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.programId` | `results.${number}.item.description.title` | `results.${number}.item.state` | `results.${number}.item.oldTotalSteps` | `results.${number}.item.trialSection` | `results.${number}.item.ordering` | `results.${number}.item.delayInDays` | `results.${number}.action` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+}
+declare function bulkCreateSectionMigration$1(httpClient: HttpClient): BulkCreateSectionMigrationSignature;
+interface BulkCreateSectionMigrationSignature {
+    /**
+     * Bulk Section creation for migration.
+     * @param - List of sections you want to create
+     */
+    (sections: Section[]): Promise<NonNullablePaths<BulkCreateSectionMigrationResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.programId` | `results.${number}.item.description.title` | `results.${number}.item.state` | `results.${number}.item.oldTotalSteps` | `results.${number}.item.trialSection` | `results.${number}.item.ordering` | `results.${number}.item.delayInDays` | `results.${number}.action` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+}
+declare function getSection$1(httpClient: HttpClient): GetSectionSignature;
+interface GetSectionSignature {
+    /**
+     * Retrieves a Section.
+     * @param - ID of the Section to retrieve.
+     * @returns The requested Section.
+     */
+    (sectionId: string, options?: GetSectionOptions): Promise<NonNullablePaths<Section, `programId` | `description.title` | `state` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
+}
+declare function updateSection$1(httpClient: HttpClient): UpdateSectionSignature;
+interface UpdateSectionSignature {
+    /**
+     * Updates a Section.
+     * @param - Program Section ID.
+     * @returns Updated Section.
+     */
+    (_id: string, options?: NonNullablePaths<UpdateSectionOptions, `section.revision`, 3>): Promise<NonNullablePaths<Section, `programId` | `description.title` | `state` | `oldTotalSteps` | `trialSection` | `ordering` | `delayInDays`, 3>>;
+}
+declare function deleteSection$1(httpClient: HttpClient): DeleteSectionSignature;
+interface DeleteSectionSignature {
+    /**
+     * Deletes a Section.
+     * Deleting a Section permanently removes them from the Section List.
+     * @param - Id of the Section to delete.
+     */
+    (sectionId: string): Promise<void>;
+}
+declare function querySections$1(httpClient: HttpClient): QuerySectionsSignature;
+interface QuerySectionsSignature {
+    /**
+     * Retrieves a list of Sections, given the provided [paging, filtering, and sorting][1].
+     *
+     * Up to 1,000 Sections can be returned per request.
+     */
+    (options?: QuerySectionsOptions): SectionsQueryBuilder;
+}
+declare function listSections$1(httpClient: HttpClient): ListSectionsSignature;
+interface ListSectionsSignature {
+    /**
+     * List sections per program id
+     * @param - Program id to list sections
+     */
+    (programId: string, options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `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 cloneSection$1(httpClient: HttpClient): CloneSectionSignature;
+interface CloneSectionSignature {
+    /**
+     * Clones section with specified id
+     * @param - Section to clone
+     */
+    (sectionId: string, options?: CloneSectionOptions): Promise<NonNullablePaths<CloneSectionResponse, `section.programId` | `section.description.title` | `section.state` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
+}
+declare function moveSection$1(httpClient: HttpClient): MoveSectionSignature;
+interface MoveSectionSignature {
+    /**
+     * Places section after specified one or inserts it in the beginning
+     */
+    (options?: MoveSectionOptions): Promise<NonNullablePaths<MoveSectionResponse, `section.programId` | `section.description.title` | `section.state` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
+}
+declare function publishSection$1(httpClient: HttpClient): PublishSectionSignature;
+interface PublishSectionSignature {
+    /**
+     * Publishes section
+     */
+    (options?: PublishSectionOptions): Promise<NonNullablePaths<PublishSectionResponse, `section.programId` | `section.description.title` | `section.state` | `section.oldTotalSteps` | `section.trialSection` | `section.ordering` | `section.delayInDays`, 4>>;
+}
+
+declare const createSection: MaybeContext<BuildRESTFunction<typeof createSection$1> & typeof createSection$1>;
+declare const bulkCreateSection: MaybeContext<BuildRESTFunction<typeof bulkCreateSection$1> & typeof bulkCreateSection$1>;
+declare const bulkCreateSectionMigration: MaybeContext<BuildRESTFunction<typeof bulkCreateSectionMigration$1> & typeof bulkCreateSectionMigration$1>;
+declare const getSection: MaybeContext<BuildRESTFunction<typeof getSection$1> & typeof getSection$1>;
+declare const updateSection: MaybeContext<BuildRESTFunction<typeof updateSection$1> & typeof updateSection$1>;
+declare const deleteSection: MaybeContext<BuildRESTFunction<typeof deleteSection$1> & typeof deleteSection$1>;
+declare const querySections: MaybeContext<BuildRESTFunction<typeof querySections$1> & typeof querySections$1>;
+declare const listSections: MaybeContext<BuildRESTFunction<typeof listSections$1> & typeof listSections$1>;
+declare const cloneSection: MaybeContext<BuildRESTFunction<typeof cloneSection$1> & typeof cloneSection$1>;
+declare const moveSection: MaybeContext<BuildRESTFunction<typeof moveSection$1> & typeof moveSection$1>;
+declare const publishSection: MaybeContext<BuildRESTFunction<typeof publishSection$1> & typeof publishSection$1>;
+
+export { BulkCreateSectionMigrationResponse, BulkCreateSectionOptions, BulkCreateSectionResponse, CloneSectionOptions, CloneSectionResponse, CreateSectionOptions, GetSectionOptions, ListSectionsOptions, ListSectionsResponse, MoveSectionOptions, MoveSectionResponse, PublishSectionOptions, PublishSectionResponse, QuerySectionsOptions, Section, SectionsQueryBuilder, UpdateSectionOptions, bulkCreateSection, bulkCreateSectionMigration, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, publishSection, querySections, updateSection };