@wix/auto_sdk_online-programs_sections 1.0.0

package/build/cjs/meta.d.ts

@@ -0,0 +1,514 @@
+import { CreateSectionRequest as CreateSectionRequest$1, CreateSectionResponse as CreateSectionResponse$1, BulkCreateSectionRequest as BulkCreateSectionRequest$1, BulkCreateSectionResponse as BulkCreateSectionResponse$1, BulkCreateSectionMigrationRequest as BulkCreateSectionMigrationRequest$1, BulkCreateSectionMigrationResponse as BulkCreateSectionMigrationResponse$1, GetSectionRequest as GetSectionRequest$1, GetSectionResponse as GetSectionResponse$1, UpdateSectionRequest as UpdateSectionRequest$1, UpdateSectionResponse as UpdateSectionResponse$1, DeleteSectionRequest as DeleteSectionRequest$1, DeleteSectionResponse as DeleteSectionResponse$1, QuerySectionsRequest as QuerySectionsRequest$1, QuerySectionsResponse as QuerySectionsResponse$1, ListSectionsRequest as ListSectionsRequest$1, ListSectionsResponse as ListSectionsResponse$1, CloneSectionRequest as CloneSectionRequest$1, CloneSectionResponse as CloneSectionResponse$1, MoveSectionRequest as MoveSectionRequest$1, MoveSectionResponse as MoveSectionResponse$1, PublishSectionRequest as PublishSectionRequest$1, PublishSectionResponse as PublishSectionResponse$1 } from './index.typings.js';
+import '@wix/sdk-types';
+
+interface Section {
+    /**
+     * Program Section ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Represents the current state of an item. Each time the item is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Represents the time this Section was created
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Represents the time this Section was last updated
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Program Id to which this section is assigned to.
+     * @format GUID
+     * @readonly
+     */
+    programId?: string;
+    /** title, description and media content. */
+    description?: Description;
+    /** is this section published yet? */
+    state?: StateWithLiterals;
+    /**
+     * number of program steps in this section.
+     * @readonly
+     */
+    oldTotalSteps?: number;
+    /**
+     * number of program steps in this section.
+     * @readonly
+     */
+    totalSteps?: number | null;
+    /** should we open this section as a trial content even though the owning program isn't purchased yet? */
+    trialSection?: boolean;
+    /** field for manual ordering of sections */
+    ordering?: number;
+    /**
+     * open after defined number of days passed.
+     * @max 5000
+     */
+    delayInDays?: number;
+    /** extensible field */
+    extendedFields?: ExtendedFields;
+}
+interface Description extends DescriptionMediaOneOf {
+    /**
+     * @deprecated
+     * @targetRemovalDate 2025-05-10
+     */
+    image?: Image;
+    /**
+     * @deprecated
+     * @targetRemovalDate 2025-05-10
+     */
+    video?: VideoV2;
+    /** @maxLength 500 */
+    title?: string;
+    /** @maxLength 10000000 */
+    details?: string | null;
+}
+/** @oneof */
+interface DescriptionMediaOneOf {
+    /**
+     * @deprecated
+     * @targetRemovalDate 2025-05-10
+     */
+    image?: Image;
+    /**
+     * @deprecated
+     * @targetRemovalDate 2025-05-10
+     */
+    video?: VideoV2;
+}
+interface Image {
+    /** WixMedia image ID. */
+    id?: string;
+    /** Image URL. */
+    url?: string;
+    /**
+     * Original image height.
+     * @readonly
+     */
+    height?: number;
+    /**
+     * Original image width.
+     * @readonly
+     */
+    width?: number;
+    /** Image alt text. */
+    altText?: string | null;
+    /**
+     * Image filename.
+     * @readonly
+     */
+    filename?: string | null;
+}
+interface VideoV2 {
+    /** WixMedia ID. */
+    id?: string;
+    /**
+     * Available resolutions for the video, starting with the optimal resolution.
+     * @readonly
+     * @maxSize 100
+     */
+    resolutions?: VideoResolution[];
+    /**
+     * Video filename.
+     * @readonly
+     */
+    filename?: string | null;
+}
+interface VideoResolution {
+    /** Video URL. */
+    url?: string;
+    /** Video height. */
+    height?: number;
+    /** Video width. */
+    width?: number;
+    /** Video format for example, mp4, hls. */
+    format?: string;
+}
+declare enum State {
+    /** invalid default state. */
+    UNKNOWN_STATE = "UNKNOWN_STATE",
+    /** the section isn't ready to be shown to participants. */
+    DRAFT = "DRAFT",
+    /** this content is visible to participants. */
+    PUBLISHED = "PUBLISHED"
+}
+/** @enumType */
+type StateWithLiterals = State | 'UNKNOWN_STATE' | 'DRAFT' | 'PUBLISHED';
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+interface CreateSectionRequest {
+    /** Section to be created. */
+    section: Section;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+declare enum RequestedFields {
+    /** not implemented, invalid default value. */
+    UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
+    /** return total number of steps in this section. */
+    TOTAL_STEPS = "TOTAL_STEPS"
+}
+/** @enumType */
+type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'TOTAL_STEPS';
+interface CreateSectionResponse {
+    /** The created Section. */
+    section?: Section;
+}
+interface BulkCreateSectionRequest {
+    /**
+     * List of sections you want to create
+     * @minSize 1
+     * @maxSize 100
+     */
+    sections: Section[];
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface BulkCreateSectionResponse {
+    /** bulk results */
+    results?: BulkSectionResult[];
+    /** bulk metadata */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkSectionResult {
+    /** item metadata */
+    itemMetadata?: ItemMetadata;
+    /** created section */
+    item?: Section;
+    /** indicator whether it was create or update */
+    action?: BulkActionTypeWithLiterals;
+}
+interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+declare enum BulkActionType {
+    UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
+    INSERT = "INSERT",
+    UPDATE = "UPDATE",
+    DELETE = "DELETE"
+}
+/** @enumType */
+type BulkActionTypeWithLiterals = BulkActionType | 'UNKNOWN_ACTION_TYPE' | 'INSERT' | 'UPDATE' | 'DELETE';
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface BulkCreateSectionMigrationRequest {
+    /**
+     * List of sections you want to create
+     * @minSize 1
+     * @maxSize 100
+     */
+    sections: Section[];
+}
+interface BulkCreateSectionMigrationResponse {
+    /** bulk results */
+    results?: BulkSectionResult[];
+    /** bulk metadata */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface GetSectionRequest {
+    /**
+     * ID of the Section to retrieve.
+     * @format GUID
+     */
+    sectionId: string;
+    /** Whenever to return description only with title or with details as well */
+    descriptionFieldSet?: DescriptionFieldSetWithLiterals;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+declare enum DescriptionFieldSet {
+    STANDARD = "STANDARD",
+    EXTENDED = "EXTENDED"
+}
+/** @enumType */
+type DescriptionFieldSetWithLiterals = DescriptionFieldSet | 'STANDARD' | 'EXTENDED';
+interface GetSectionResponse {
+    /** The requested Section. */
+    section?: Section;
+}
+interface UpdateSectionRequest {
+    /** Section to be updated, may be partial. */
+    section?: Section;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface UpdateSectionResponse {
+    /** Updated Section. */
+    section?: Section;
+}
+interface DeleteSectionRequest {
+    /**
+     * Id of the Section to delete.
+     * @format GUID
+     */
+    sectionId: string;
+}
+interface DeleteSectionResponse {
+}
+interface QuerySectionsRequest {
+    /** WQL expression. */
+    query?: CursorQuery;
+    /** Whenever to return description only with title or with details as well */
+    descriptionFieldSet?: DescriptionFieldSetWithLiterals;
+    /**
+     * Program id to query sections
+     * @maxLength 36
+     */
+    programId?: string;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | 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?: string | null;
+}
+interface QuerySectionsResponse {
+    /** List of Sections. */
+    sections?: Section[];
+    /** Paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in current page. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface ListSectionsRequest {
+    /**
+     * Program id to list sections
+     * @format GUID
+     */
+    programId: string;
+    /** Whenever to return description only with title or with details as well */
+    descriptionFieldSet?: DescriptionFieldSetWithLiterals;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface ListSectionsResponse {
+    /**
+     * sections
+     * @maxSize 1000
+     */
+    sections?: Section[];
+}
+interface CloneSectionRequest {
+    /**
+     * Section to clone
+     * @format GUID
+     */
+    sectionId: string;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface CloneSectionResponse {
+    /** cloned section */
+    section?: Section;
+}
+interface MoveSectionRequest {
+    /**
+     * Section to move
+     * @format GUID
+     */
+    sectionId?: string;
+    /**
+     * change section position to be after the specified section. If empty insert in the "0" position.
+     * @format GUID
+     */
+    afterSectionId?: string | null;
+    /** section revision */
+    revision?: string;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface MoveSectionResponse {
+    /** updated section which was moved */
+    section?: Section;
+}
+interface PublishSectionRequest {
+    /**
+     * Section to publish
+     * @format GUID
+     */
+    sectionId?: string;
+    /** section revision */
+    revision?: string;
+    /**
+     * Predefined sets of fields to return.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface PublishSectionResponse {
+    /** Published section */
+    section?: Section;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function createSection(): __PublicMethodMetaInfo<'POST', {}, CreateSectionRequest$1, CreateSectionRequest, CreateSectionResponse$1, CreateSectionResponse>;
+declare function bulkCreateSection(): __PublicMethodMetaInfo<'POST', {}, BulkCreateSectionRequest$1, BulkCreateSectionRequest, BulkCreateSectionResponse$1, BulkCreateSectionResponse>;
+declare function bulkCreateSectionMigration(): __PublicMethodMetaInfo<'POST', {}, BulkCreateSectionMigrationRequest$1, BulkCreateSectionMigrationRequest, BulkCreateSectionMigrationResponse$1, BulkCreateSectionMigrationResponse>;
+declare function getSection(): __PublicMethodMetaInfo<'GET', {
+    sectionId: string;
+}, GetSectionRequest$1, GetSectionRequest, GetSectionResponse$1, GetSectionResponse>;
+declare function updateSection(): __PublicMethodMetaInfo<'PATCH', {
+    sectionId: string;
+}, UpdateSectionRequest$1, UpdateSectionRequest, UpdateSectionResponse$1, UpdateSectionResponse>;
+declare function deleteSection(): __PublicMethodMetaInfo<'DELETE', {
+    sectionId: string;
+}, DeleteSectionRequest$1, DeleteSectionRequest, DeleteSectionResponse$1, DeleteSectionResponse>;
+declare function querySections(): __PublicMethodMetaInfo<'POST', {}, QuerySectionsRequest$1, QuerySectionsRequest, QuerySectionsResponse$1, QuerySectionsResponse>;
+declare function listSections(): __PublicMethodMetaInfo<'GET', {}, ListSectionsRequest$1, ListSectionsRequest, ListSectionsResponse$1, ListSectionsResponse>;
+declare function cloneSection(): __PublicMethodMetaInfo<'POST', {
+    sectionId: string;
+}, CloneSectionRequest$1, CloneSectionRequest, CloneSectionResponse$1, CloneSectionResponse>;
+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 };