@wix/auto_sdk_online-programs_sections 1.0.1 → 1.0.2

package/build/internal/es/meta.d.mts

@@ -107,6 +107,16 @@ interface Image {
      */
     filename?: string | null;
 }
+interface FocalPoint {
+    /** X-coordinate of the focal point. */
+    x?: number;
+    /** Y-coordinate of the focal point. */
+    y?: number;
+    /** crop by height */
+    height?: number | null;
+    /** crop by width */
+    width?: number | null;
+}
 interface VideoV2 {
     /** WixMedia ID. */
     id?: string;
@@ -153,6 +163,149 @@ interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
+interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
+    /** insert/update documents */
+    update?: DocumentUpdateOperation;
+    /** delete by document ids */
+    deleteByIds?: DeleteByIdsOperation;
+    /** delete documents matching filter */
+    deleteByFilter?: DeleteByFilterOperation;
+    /** update documents matching filter */
+    updateByFilter?: UpdateByFilterOperation;
+    /** update only existing documents */
+    updateExisting?: UpdateExistingOperation;
+    /**
+     * application which owns documents
+     * @minLength 2
+     */
+    appDefId?: string | null;
+    /**
+     * type of the documents
+     * @minLength 2
+     */
+    documentType?: string | null;
+    /**
+     * language of the documents
+     * @minLength 2
+     */
+    language?: string | null;
+    /**
+     * site documents belong to
+     * @minLength 2
+     */
+    msId?: string | null;
+}
+/** @oneof */
+interface UpdateDocumentsEventOperationOneOf {
+    /** insert/update documents */
+    update?: DocumentUpdateOperation;
+    /** delete by document ids */
+    deleteByIds?: DeleteByIdsOperation;
+    /** delete documents matching filter */
+    deleteByFilter?: DeleteByFilterOperation;
+    /** update documents matching filter */
+    updateByFilter?: UpdateByFilterOperation;
+    /** update only existing documents */
+    updateExisting?: UpdateExistingOperation;
+}
+interface DocumentUpdateOperation {
+    /** documents to index or update */
+    documents?: IndexDocument[];
+}
+interface IndexDocument {
+    /** data bag with non-searchable fields (url, image) */
+    payload?: DocumentPayload;
+    /** what type of users should documents be visible to */
+    exposure?: EnumWithLiterals;
+    /** document with mandatory fields (id, title, description) and with fields specific to the type of the document */
+    document?: Record<string, any> | null;
+    /** what member groups is the document exposed to. Used only with GROUP_PROTECTED exposure */
+    permittedMemberGroups?: string[];
+    /** if true SEO is disabled for this document */
+    seoHidden?: boolean | null;
+    /** if true the page is a lightbox popup */
+    isPopup?: boolean | null;
+}
+interface DocumentPayload {
+    /** url of the page representing the document */
+    url?: string | null;
+    /** image which represents the document */
+    documentImage?: DocumentImage;
+}
+interface DocumentImage {
+    /** the name of the image */
+    name?: string;
+    /** the width of the image */
+    width?: number;
+    /** the height of the image */
+    height?: number;
+}
+declare enum Enum {
+    /** Default value. Means that permission not set */
+    UNKNOWN = "UNKNOWN",
+    /** Protected exposure. Exposed to members and owners */
+    PROTECTED = "PROTECTED",
+    /** Private exposure. Exposed to owners */
+    PRIVATE = "PRIVATE",
+    /** Public exposure. Visible to everyone */
+    PUBLIC = "PUBLIC",
+    /** Used for partial updates, to state that exposure is not changing */
+    UNCHANGED = "UNCHANGED",
+    /** Protected to members of permitted groups and owners */
+    GROUP_PROTECTED = "GROUP_PROTECTED"
+}
+/** @enumType */
+type EnumWithLiterals = Enum | 'UNKNOWN' | 'PROTECTED' | 'PRIVATE' | 'PUBLIC' | 'UNCHANGED' | 'GROUP_PROTECTED';
+interface DeleteByIdsOperation {
+    /** ids of the documents to delete */
+    documentIds?: string[];
+}
+interface DeleteByFilterOperation {
+    /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
+    filter?: Record<string, any> | null;
+}
+interface UpdateByFilterOperation {
+    /** documents matching this filter will be updated */
+    filter?: Record<string, any> | null;
+    /** partial document to apply */
+    document?: IndexDocument;
+}
+interface UpdateExistingOperation {
+    /** documents to update */
+    documents?: IndexDocument[];
+}
+interface SectionUpdated {
+    /** Section before update. */
+    previous?: Section;
+    /** Section after update. */
+    current?: Section;
+}
+interface SectionDeleted {
+    /** Full section that was deleted */
+    section?: Section;
+}
+interface SectionCloned {
+    /** Section which was used as a prototype for cloning. */
+    prototype?: Section;
+    /** Result of section cloning. */
+    cloned?: Section;
+}
+interface SectionMoved {
+    /**
+     * Moved section id
+     * @format GUID
+     */
+    sectionId?: string;
+    /** section position */
+    newSectionPositionRank?: number;
+}
+interface SectionPublished {
+    /**
+     * Published section id
+     * @format GUID
+     */
+    sectionId?: string;
+}
 interface CreateSectionRequest {
     /** Section to be created. */
     section: Section;
@@ -295,6 +448,21 @@ interface DeleteSectionRequest {
 }
 interface DeleteSectionResponse {
 }
+interface DeleteAllProgramSectionsRequest {
+    /**
+     * Program id to delete sections from
+     * @format GUID
+     */
+    programId?: string;
+}
+interface DeleteAllProgramSectionsResponse {
+    /** Total count of sections in the program */
+    sectionsTotal?: number;
+    /** Count of successfully deleted sections */
+    successfulCount?: number;
+    /** Count of sections that failed to be deleted */
+    failedCount?: number;
+}
 interface QuerySectionsRequest {
     /** WQL expression. */
     query?: CursorQuery;
@@ -480,6 +648,209 @@ interface PublishSectionResponse {
     /** Published section */
     section?: Section;
 }
+interface BulkCloneSectionRequest {
+    /**
+     * id of program which was cloned
+     * @format GUID
+     */
+    prototypeProgramId?: string;
+    /**
+     * id of program created after clone
+     * @format GUID
+     */
+    clonedProgramId?: string;
+}
+interface BulkCloneSectionResponse {
+    /**
+     * id of program which was cloned
+     * @format GUID
+     */
+    prototypeProgramId?: string;
+    /**
+     * id of program created after clone
+     * @format GUID
+     */
+    clonedProgramId?: string;
+    /** mapping of original to cloned section ids */
+    prototypeIdToClonedId?: Record<string, string>;
+}
+interface RestoreSectionFromTrashRequest {
+    /**
+     * section id to restore
+     * @format GUID
+     */
+    sectionId?: string;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface RestoreSectionFromTrashResponse {
+    /** restored section */
+    section?: Section;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntityAsJson?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntityAsJson?: string | null;
+}
+interface ActionEvent {
+    bodyAsJson?: string;
+}
+interface Empty {
+}
+interface SearchIndexingNotification {
+    /** new state of indexing for the site specified in ms_id */
+    indexState?: SearchIndexingNotificationStateWithLiterals;
+    /** type of the document the notification is targeted for. Applies to all types if not provided */
+    documentType?: string | null;
+    /** languaInternalDocumentUpdateByFilterOperationge the notification is targeted for. Applies to all languages if not provided */
+    language?: string | null;
+    /**
+     * site for which notification is targeted
+     * @minLength 2
+     */
+    msId?: string | null;
+}
+declare enum SearchIndexingNotificationState {
+    /** default state */
+    Unknown = "Unknown",
+    /** metasite does not require site search indexing */
+    Off = "Off",
+    /** metasite requires site search indexing */
+    On = "On"
+}
+/** @enumType */
+type SearchIndexingNotificationStateWithLiterals = SearchIndexingNotificationState | 'Unknown' | 'Off' | 'On';
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * 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.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * 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.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
 
 type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
     getUrl: (context: any) => string;
@@ -511,4 +882,4 @@ declare function cloneSection(): __PublicMethodMetaInfo<'POST', {
 declare function moveSection(): __PublicMethodMetaInfo<'PATCH', {}, MoveSectionRequest$1, MoveSectionRequest, MoveSectionResponse$1, MoveSectionResponse>;
 declare function publishSection(): __PublicMethodMetaInfo<'PATCH', {}, PublishSectionRequest$1, PublishSectionRequest, PublishSectionResponse$1, PublishSectionResponse>;
 
-export { type __PublicMethodMetaInfo, bulkCreateSection, bulkCreateSectionMigration, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, publishSection, querySections, updateSection };
+export { type ActionEvent as ActionEventOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, BulkActionType as BulkActionTypeOriginal, type BulkActionTypeWithLiterals as BulkActionTypeWithLiteralsOriginal, type BulkCloneSectionRequest as BulkCloneSectionRequestOriginal, type BulkCloneSectionResponse as BulkCloneSectionResponseOriginal, type BulkCreateSectionMigrationRequest as BulkCreateSectionMigrationRequestOriginal, type BulkCreateSectionMigrationResponse as BulkCreateSectionMigrationResponseOriginal, type BulkCreateSectionRequest as BulkCreateSectionRequestOriginal, type BulkCreateSectionResponse as BulkCreateSectionResponseOriginal, type BulkSectionResult as BulkSectionResultOriginal, type CloneSectionRequest as CloneSectionRequestOriginal, type CloneSectionResponse as CloneSectionResponseOriginal, type CreateSectionRequest as CreateSectionRequestOriginal, type CreateSectionResponse as CreateSectionResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type DeleteAllProgramSectionsRequest as DeleteAllProgramSectionsRequestOriginal, type DeleteAllProgramSectionsResponse as DeleteAllProgramSectionsResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteSectionRequest as DeleteSectionRequestOriginal, type DeleteSectionResponse as DeleteSectionResponseOriginal, DescriptionFieldSet as DescriptionFieldSetOriginal, type DescriptionFieldSetWithLiterals as DescriptionFieldSetWithLiteralsOriginal, type DescriptionMediaOneOf as DescriptionMediaOneOfOriginal, type Description as DescriptionOriginal, type DocumentImage as DocumentImageOriginal, type DocumentPayload as DocumentPayloadOriginal, type DocumentUpdateOperation as DocumentUpdateOperationOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, Enum as EnumOriginal, type EnumWithLiterals as EnumWithLiteralsOriginal, type ExtendedFields as ExtendedFieldsOriginal, type FocalPoint as FocalPointOriginal, type GetSectionRequest as GetSectionRequestOriginal, type GetSectionResponse as GetSectionResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type IndexDocument as IndexDocumentOriginal, type ItemMetadata as ItemMetadataOriginal, type ListSectionsRequest as ListSectionsRequestOriginal, type ListSectionsResponse as ListSectionsResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MoveSectionRequest as MoveSectionRequestOriginal, type MoveSectionResponse as MoveSectionResponseOriginal, type PublishSectionRequest as PublishSectionRequestOriginal, type PublishSectionResponse as PublishSectionResponseOriginal, type QuerySectionsRequest as QuerySectionsRequestOriginal, type QuerySectionsResponse as QuerySectionsResponseOriginal, RequestedFields as RequestedFieldsOriginal, type RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type RestoreSectionFromTrashRequest as RestoreSectionFromTrashRequestOriginal, type RestoreSectionFromTrashResponse as RestoreSectionFromTrashResponseOriginal, type SearchIndexingNotification as SearchIndexingNotificationOriginal, SearchIndexingNotificationState as SearchIndexingNotificationStateOriginal, type SearchIndexingNotificationStateWithLiterals as SearchIndexingNotificationStateWithLiteralsOriginal, type SectionCloned as SectionClonedOriginal, type SectionDeleted as SectionDeletedOriginal, type SectionMoved as SectionMovedOriginal, type Section as SectionOriginal, type SectionPublished as SectionPublishedOriginal, type SectionUpdated as SectionUpdatedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type UpdateByFilterOperation as UpdateByFilterOperationOriginal, type UpdateDocumentsEventOperationOneOf as UpdateDocumentsEventOperationOneOfOriginal, type UpdateDocumentsEvent as UpdateDocumentsEventOriginal, type UpdateExistingOperation as UpdateExistingOperationOriginal, type UpdateSectionRequest as UpdateSectionRequestOriginal, type UpdateSectionResponse as UpdateSectionResponseOriginal, type VideoResolution as VideoResolutionOriginal, type VideoV2 as VideoV2Original, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCreateSection, bulkCreateSectionMigration, cloneSection, createSection, deleteSection, getSection, listSections, moveSection, publishSection, querySections, updateSection };

package/build/internal/es/meta.mjs

@@ -799,6 +799,59 @@ function publishSection(payload) {
   return __publishSection;
 }
 
+// src/online-programs-v3-section-sections.types.ts
+var State = /* @__PURE__ */ ((State2) => {
+  State2["UNKNOWN_STATE"] = "UNKNOWN_STATE";
+  State2["DRAFT"] = "DRAFT";
+  State2["PUBLISHED"] = "PUBLISHED";
+  return State2;
+})(State || {});
+var Enum = /* @__PURE__ */ ((Enum2) => {
+  Enum2["UNKNOWN"] = "UNKNOWN";
+  Enum2["PROTECTED"] = "PROTECTED";
+  Enum2["PRIVATE"] = "PRIVATE";
+  Enum2["PUBLIC"] = "PUBLIC";
+  Enum2["UNCHANGED"] = "UNCHANGED";
+  Enum2["GROUP_PROTECTED"] = "GROUP_PROTECTED";
+  return Enum2;
+})(Enum || {});
+var RequestedFields = /* @__PURE__ */ ((RequestedFields2) => {
+  RequestedFields2["UNKNOWN_REQUESTED_FIELD"] = "UNKNOWN_REQUESTED_FIELD";
+  RequestedFields2["TOTAL_STEPS"] = "TOTAL_STEPS";
+  return RequestedFields2;
+})(RequestedFields || {});
+var BulkActionType = /* @__PURE__ */ ((BulkActionType2) => {
+  BulkActionType2["UNKNOWN_ACTION_TYPE"] = "UNKNOWN_ACTION_TYPE";
+  BulkActionType2["INSERT"] = "INSERT";
+  BulkActionType2["UPDATE"] = "UPDATE";
+  BulkActionType2["DELETE"] = "DELETE";
+  return BulkActionType2;
+})(BulkActionType || {});
+var DescriptionFieldSet = /* @__PURE__ */ ((DescriptionFieldSet2) => {
+  DescriptionFieldSet2["STANDARD"] = "STANDARD";
+  DescriptionFieldSet2["EXTENDED"] = "EXTENDED";
+  return DescriptionFieldSet2;
+})(DescriptionFieldSet || {});
+var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
+  SortOrder2["ASC"] = "ASC";
+  SortOrder2["DESC"] = "DESC";
+  return SortOrder2;
+})(SortOrder || {});
+var SearchIndexingNotificationState = /* @__PURE__ */ ((SearchIndexingNotificationState2) => {
+  SearchIndexingNotificationState2["Unknown"] = "Unknown";
+  SearchIndexingNotificationState2["Off"] = "Off";
+  SearchIndexingNotificationState2["On"] = "On";
+  return SearchIndexingNotificationState2;
+})(SearchIndexingNotificationState || {});
+var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
+  WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
+  WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+  WebhookIdentityType2["MEMBER"] = "MEMBER";
+  WebhookIdentityType2["WIX_USER"] = "WIX_USER";
+  WebhookIdentityType2["APP"] = "APP";
+  return WebhookIdentityType2;
+})(WebhookIdentityType || {});
+
 // src/online-programs-v3-section-sections.meta.ts
 function createSection2() {
   const payload = {};
@@ -999,6 +1052,14 @@ function publishSection2() {
   };
 }
 export {
+  BulkActionType as BulkActionTypeOriginal,
+  DescriptionFieldSet as DescriptionFieldSetOriginal,
+  Enum as EnumOriginal,
+  RequestedFields as RequestedFieldsOriginal,
+  SearchIndexingNotificationState as SearchIndexingNotificationStateOriginal,
+  SortOrder as SortOrderOriginal,
+  State as StateOriginal,
+  WebhookIdentityType as WebhookIdentityTypeOriginal,
   bulkCreateSection2 as bulkCreateSection,
   bulkCreateSectionMigration2 as bulkCreateSectionMigration,
   cloneSection2 as cloneSection,