@tivio/sdk-react 4.2.0 → 4.4.0

package/dist/index.d.ts

@@ -55,6 +55,12 @@ export declare type AdMetadata = {
     skip: () => void;
 } | null;
 
+/**
+ * @public
+ */
+export declare interface AdMonetization extends Monetization {
+}
+
 /**
  * @public
  */
@@ -156,35 +162,6 @@ export declare type Assets = {
     [assetName: string]: ScalableAsset;
 };
 
-/**
- * @public
- */
-export declare type AuthOverlayPayload = {
-    prefilledData?: {
-        email: string;
-    };
-    /**
-     * "Goto" function (see router.utils.ts) to run after the overlay is closed. Null if no redirect is required.
-     * Defaults to homepage.
-     */
-    redirectAfterSubmit?: ((...args: any[]) => void) | null;
-};
-
-/**
- * @public
- */
-export declare type AuthOverlayState = {
-    type: AuthOverlayType;
-    closeAuthOverlay: () => void;
-    openAuthOverlay: (type: AuthOverlayType, payload?: AuthOverlayPayload) => void;
-    payload?: AuthOverlayPayload | null;
-};
-
-/**
- * @public
- */
-export declare type AuthOverlayType = 'login' | 'registration' | 'closed' | 'reset-password';
-
 /**
  * @public
  */
@@ -210,6 +187,11 @@ export declare type BadRequestError = Error & {
     };
 };
 
+export declare enum BannerItemComponent {
+    CLASSIC = "CLASSIC",
+    SPLIT = "SPLIT"
+}
+
 /**
  * @public
  */
@@ -355,6 +337,7 @@ export declare type CreateUserWithEmailAndPassword = (email: string, password: s
 export declare const CURRENCIES: string[];
 
 /**
+ * Three upper-case letters according to ISO-4217.
  * @public
  */
 export declare type Currency = 'CZK' | 'EUR' | 'USD';
@@ -425,6 +408,22 @@ export declare type DocumentOptions = Partial<{
     subscribeOnChanges: boolean;
 }>;
 
+/**
+ * @public
+ */
+export declare interface Duration {
+    units: DurationUnits;
+    value: number;
+}
+
+/**
+ * @public
+ */
+export declare enum DurationUnits {
+    DAY = "day",
+    MONTH = "month"
+}
+
 /**
  * @public
  */
@@ -477,6 +476,28 @@ export declare interface GenericOnCallError {
  */
 export declare const getPubSub: () => PubSub;
 
+/**
+ * @public
+ */
+export declare type GetPurchasableMonetizationsOptions = {
+    includeMonetizationsWithPurchaseDisabled: boolean;
+};
+
+/**
+ * Response from Tivio getPurchaseInfo HTTP endpoint.
+ *
+ * @public
+ */
+export declare type GetPurchaseInfoResponse = {
+    monetizationId: string;
+    monetization: PurchaseMonetization;
+    status: PurchaseStatus;
+    video?: {
+        id: string;
+        name: string | Translation;
+    };
+};
+
 /**
  * @public
  */
@@ -580,6 +601,11 @@ declare interface IntroMarker {
     skip: () => void;
 }
 
+/**
+ * @public
+ */
+export declare type ItemComponent = RowItemComponent | BannerItemComponent;
+
 /**
  * @public
  */
@@ -616,7 +642,8 @@ export declare enum LangCode {
     PL = "pl",
     PT = "pt",
     SK = "sk",
-    ES = "es"
+    ES = "es",
+    HU = "hu"
 }
 
 /**
@@ -667,6 +694,20 @@ export declare type LiveTvChannelSource = SourceBase & {
     channelName: string;
 };
 
+/**
+ * @public
+ */
+export declare type LocationField = {
+    /**
+     * Two-letter uppercase continent code (TODO not sure if this ISO-3166 format or something else, we get these from maxmind service)
+     */
+    continentCode?: 'AF' | 'AN' | 'AS' | 'EU' | 'NA' | 'OC' | 'SA';
+    /**
+     * Two-letter uppercase country code according to ISO-3166 format (see https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)
+     */
+    countryIsoCode?: string;
+};
+
 declare interface Logger {
     /** important messages */
     warn(...data: LoggerArgs): void;
@@ -722,14 +763,9 @@ export declare interface MigratedVideoExternals {
  */
 export declare interface Monetization {
     id: string;
-    price?: string | number;
     type?: MonetizationType;
-    frequency?: MONETIZATION_FREQUENCY;
-    isPurchased?: boolean;
     name?: string;
     description?: string;
-    benefits?: Translation[];
-    localizedBenefits?: string[];
 }
 
 /**
@@ -740,9 +776,49 @@ export declare enum MONETIZATION_FREQUENCY {
     DAILY = "DAILY",
     WEEKLY = "WEEKLY",
     MONTHLY = "MONTHLY",
+    HALF_ANNUALLY = "HALF_ANNUALLY",
     ANNUALLY = "ANNUALLY"
 }
 
+/**
+ * @public
+ */
+export declare interface MonetizationCardProps {
+    subscription: PurchasableMonetization;
+    onClick: (subscription: PurchasableMonetization) => void;
+    buttonLabel: string;
+    purchased: boolean;
+    focused?: boolean;
+}
+
+/**
+ * @public
+ */
+export declare interface MonetizationsSelectOverlayData {
+    subscriptions?: PurchasableMonetization[];
+    /**
+     * Item from which monetization select was opened.
+     * Note: does not necessarily mean that result purchase will be transaction.
+     */
+    item?: Video | TvChannel;
+    /**
+     * If set to true, user is buying voucher.
+     * Otherwise, user is making a purchase for himself.
+     */
+    voucherPurchase?: boolean;
+    onPurchase?: () => void;
+    onClose?: () => void;
+}
+
+/**
+ * @public
+ */
+export declare type MonetizationsSelectOverlayState = {
+    data: MonetizationsSelectOverlayData | null;
+    closeMonetizationsSelectOverlay: () => void;
+    openMonetizationsSelectOverlay: (data: MonetizationsSelectOverlayData) => void;
+};
+
 /**
  * @public
  * @TODO change to enum
@@ -789,6 +865,13 @@ export declare interface OrderBy {
     directionStr?: OrderByDirection;
 }
 
+/**
+ * The same as WhereFilter, but in array, for easier usage.
+ * Format: [field, directionStr] or [field]
+ * @public
+ */
+export declare type OrderByArray = [string, OrderByDirection] | [string];
+
 declare type OrderByDirection = 'desc' | 'asc';
 
 /**
@@ -1079,6 +1162,14 @@ export declare enum PlayerWrapperEventType {
  */
 export declare type PlayerWrapperEventTypeType = `${PlayerWrapperEventType}`;
 
+/**
+ * @public
+ */
+export declare interface Promotion {
+    duration?: Duration;
+    price?: number;
+}
+
 /**
  * @public
  */
@@ -1087,6 +1178,43 @@ export declare interface PubSub {
     subscribe: <K extends keyof Events>(triggerName: K, onMessage: (data: Events[K]) => Empty) => Disposer;
 }
 
+/**
+ * @public
+ */
+export declare interface PurchasableMonetization extends Monetization {
+    /**
+     * Price before any discounts (e.g. promotions).
+     */
+    originalPrice: number;
+    /**
+     * Final price (after discounts).
+     */
+    price?: string | number;
+    promotion: Promotion | null;
+    frequency?: MONETIZATION_FREQUENCY;
+    /**
+     * Returns TRUE if subscription is purchased (and not expired) by user.
+     * Returns TRUE if transaction is purchased (and not expired) for transactionItemId.
+     * Returns FALSE otherwise.
+     *
+     * @param transactionItemId id of item for which transaction purchase is checked
+     * @param transactionField type of item (video or tvChannel)
+     */
+    isPurchased(transactionItemId?: string, transactionField?: 'videoId' | 'tvChannelId'): boolean;
+    benefits?: Translation[];
+    localizedBenefits?: string[];
+    /**
+     * Set to true for subscriptions which is not possible to buy - typically for historical subscriptions which users
+     * still have bought but can't be purchased anymore.
+     */
+    purchaseDisabled?: boolean;
+    /**
+     * When set to true, users can buy this monetization as a voucher (e.g. to send it as a gift to a friend).
+     * If not set or set to false, users cannot buy it as a voucher.
+     */
+    isPurchasableAsVoucher?: boolean;
+}
+
 /**
  * @public
  */
@@ -1118,6 +1246,135 @@ export declare type Purchase = {
     voucherId?: string;
 };
 
+/**
+ * @public
+ */
+export declare enum PurchaseDocumentGateway {
+    'qerko' = "qerko",
+    'oktagon' = "oktagon",
+    'voucher' = "voucher",
+    'comgate' = "comgate"
+}
+
+/**
+ * Payload which is sent to organization's webhook (if provided). It is send only when purchase status changes to PAID,
+ * it means that it is send also when user applies the voucher.
+ *
+ * @public
+ */
+export declare type PurchaseEndpointPayload = {
+    /**
+     * Information about the purchase which changes status to PAID.
+     */
+    purchase: {
+        /**
+         * Two-letter upper-case continent code.
+         */
+        continentCode?: LocationField['continentCode'];
+        /**
+         * Two-letter upper-case country code according to ISO-3166 format (see https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).
+         */
+        countryIsoCode?: LocationField['countryIsoCode'];
+        /**
+         * Gateway name or "voucher".
+         */
+        gateway: PurchaseDocumentGateway;
+        /**
+         * Tivio ID of the purchase.
+         */
+        id: string;
+        /**
+         * Timestamp of the last change of the purchase - in this case it is timestamp when it was paid.
+         */
+        updated: number;
+        /**
+         * True if delayed payment is confirmed but not charged yet, undefined in all other cases.
+         */
+        isDelayedPayment?: boolean;
+    };
+    /**
+     * Information about the monetization which has been bought by this purchase. Monetization definition may change in time so information provided here
+     * reflects monetization definition in time of the purchase.
+     */
+    monetization: {
+        /**
+         * Currency in which the purchase has been made. Three upper-case letters according to ISO-4217.
+         */
+        currency?: Currency;
+        /**
+         * Frequency in which the user will be charged.
+         */
+        frequency?: MONETIZATION_FREQUENCY | null;
+        /**
+         * Tivio ID of the monetization.
+         */
+        id: string;
+        /**
+         * Price of the purchase.
+         */
+        price?: number;
+        /**
+         * Name of the monetization.
+         */
+        title?: string;
+        /**
+         * Type of the monetization ("transaction" or "subscription").
+         */
+        type: MonetizationType;
+    };
+    /**
+     * Information about the video which has been bought by this purchase. Provided only for transaction purchases.
+     */
+    video?: {
+        /**
+         * Tivio ID of the video.
+         */
+        id: string;
+        /**
+         * Name of the video.
+         */
+        name: string | Translation;
+    };
+    /**
+     * Information about the user who made this purchase.
+     */
+    user: {
+        /**
+         * User's e-mail.
+         */
+        email: string;
+        /**
+         * External ID of the user.
+         */
+        externalUserId: string;
+        /**
+         * Tivio ID of the user.
+         */
+        id: string;
+        /**
+         * User's name.
+         */
+        name: string;
+    };
+    /**
+     * Information about the voucher. Provided only when purchase is purchase (not application) of the voucher.
+     */
+    voucher?: {
+        /**
+         * Voucher code.
+         */
+        code: string;
+        /**
+         * Voucher expiration timestamp.
+         */
+        expiration: number;
+        /**
+         * Duration (in seconds) after which purchase is considered expired. If undefined, monetization's duration is used.
+         */
+        purchaseDuration?: number;
+    };
+};
+
 /**
  * @public
  */
@@ -1171,8 +1428,13 @@ export declare interface QerkoCancellationInfo {
  * @public
  */
 export declare interface QerkoData {
-    monetization: Monetization;
+    monetization: PurchasableMonetization;
     item?: Video | TvChannel;
+    /**
+     * If set to true, user is buying voucher.
+     * Otherwise, user is making a purchase for himself.
+     */
+    voucherPurchase?: boolean;
     onPurchase?: () => void;
     onClose?: () => void;
 }
@@ -1181,8 +1443,14 @@ export declare interface QerkoData {
  * @public
  */
 export declare interface QerkoOverlayState {
+    isOpen: boolean;
     data: QerkoData | null;
-    openQerkoOverlay: ((data: QerkoData) => void);
+    /**
+     * Prepares data for
+     * Use this in case when you need to split actions
+     */
+    setData: (data: QerkoData) => void;
+    openQerkoOverlay: (data?: QerkoData) => void;
     closeQerkoOverlay: () => void;
 }
 
@@ -1260,13 +1528,14 @@ export declare type RemoteProviderProps = {
  * @public
  */
 export declare interface RouterOverrides {
-    goToVideoDetailPage: (videoId: string) => void;
+    goToVideoDetailPage: (videoIdOrUrlName: string) => void;
     goToSeriesDetailPage: (tagId: string) => void;
     goToTagPage: (tagId: string) => void;
-    goToLoginScreen: () => void;
+    goToLoginPage: () => void;
+    goToRegistrationPage: () => void;
     goBack: () => void;
-    goLivePlayer: (videoId: string) => void;
-    goVodPlayer: (tvChannelId: string) => void;
+    goLivePlayer: (tvChannelId: string) => void;
+    goVodPlayer: (videoIdOrUrlName: string) => void;
     goToHome: () => void;
 }
 
@@ -1280,17 +1549,7 @@ export declare interface RouterOverridesContextState {
 /**
  * @public
  */
-export declare interface Row {
-    id: string;
-    rowId: string;
-    name: string;
-    description?: string;
-    itemComponent: RowItemComponent;
-    rowComponent: RowComponent;
-    assets: Assets;
-    type: ScreenRowType;
-    isLiveRow: boolean;
-}
+export declare type Row = RowStandard | RowBanner;
 
 /**
  * @public
@@ -1301,6 +1560,27 @@ export declare enum ROW_ITEM_TYPES {
     TV_CHANNEL = "TV_CHANNEL"
 }
 
+/**
+ * @private
+ */
+export declare interface RowBanner extends RowBase {
+    rowComponent: RowComponent.BANNER;
+    itemComponent: BannerItemComponent;
+}
+
+/**
+ * @private
+ */
+declare interface RowBase {
+    id: string;
+    rowId: string;
+    name: string;
+    description?: string;
+    assets: Assets;
+    type: ScreenRowType;
+    isLiveRow: boolean;
+}
+
 /**
  * @public
  */
@@ -1313,6 +1593,7 @@ export declare enum RowComponent {
  * @public
  */
 export declare interface RowItem extends RowItemAssets {
+    created?: Date;
     itemType: ROW_ITEM_TYPES;
     name?: string;
     description?: string;
@@ -1353,6 +1634,14 @@ export declare type RowItemsSubscription = (rowId: string, cb: (error: Error | n
     hasNextPage: boolean;
 } | null, fetchMore: null | ((count?: number) => void), isLoading: boolean) => void, limit?: number) => Disposer_2;
 
+/**
+ * @private
+ */
+export declare interface RowStandard extends RowBase {
+    rowComponent: RowComponent.ROW;
+    itemComponent: RowItemComponent;
+}
+
 /**
  * @public
  */
@@ -1440,6 +1729,12 @@ export declare interface Section {
     videos: Video[];
 }
 
+export declare enum SemanticDate {
+    YESTERDAY = "Yesterday",
+    TODAY = "Today",
+    TOMORROW = "Tomorrow"
+}
+
 /**
  * Used for entities, that can be global (e.g. asset presets, tag types).
  * Non-global is stored under organizations (in sub-collection), and shown for organization's users and super-admin.
@@ -1559,17 +1854,6 @@ export declare type SubscribeToTaggedVideosOptions = SubscribeToItemsInRowOption
     where?: WhereFilter[];
 };
 
-/**
- * @public
- */
-export declare interface SubscriptionCardProps {
-    subscription: Monetization;
-    onClick: (subscription: Monetization) => void;
-    buttonLabel: string;
-    purchased: boolean;
-    focused?: boolean;
-}
-
 declare type SubscriptionInfo = {
     type: 'subscription';
     name: string;
@@ -1577,24 +1861,6 @@ declare type SubscriptionInfo = {
     frequency: string;
 };
 
-/**
- * @public
- */
-export declare interface SubscriptionOverlayData {
-    subscriptions?: Monetization[];
-    onPurchase?: () => void;
-    onClose?: () => void;
-}
-
-/**
- * @public
- */
-export declare type SubscriptionOverlayState = {
-    data: SubscriptionOverlayData | null;
-    closeSubscriptionOverlay: () => void;
-    openSubscriptionOverlay: (data: SubscriptionOverlayData) => void;
-};
-
 /**
  * @public
  */
@@ -1609,6 +1875,7 @@ export declare interface Tag extends RowItem {
     isFavorite: boolean;
     addToFavorites: () => void;
     removeFromFavorites: () => void;
+    cover: string;
 }
 
 /**
@@ -1623,6 +1890,7 @@ export declare type TileProps = {
     cover: string;
     bottomLabel: string;
     bottomLabelAreaHeight: number;
+    bottomLabelTextLinesCount: number;
     innerLabel: string;
     duration: string;
     price: string | null;
@@ -1641,6 +1909,7 @@ export declare type TileProps = {
      * Now used for backward compatibility for WebTileGrid. Consider to use it other way.
      */
     containerMargin?: number | string;
+    created?: Date;
 };
 
 /**
@@ -1663,6 +1932,7 @@ export declare interface TivioAuth {
      * @param password
      */
     signInWithEmailAndPassword: (email: string, password: string) => Promise<string | null>;
+    signInWithCustomToken: (token: string) => Promise<string | null>;
     signOut: () => Promise<void>;
     /**
      * Used for reset forgotten password by user
@@ -1849,12 +2119,12 @@ export declare type TivioInternalBundle = {
  * @public
  */
 export declare type TivioInternalComponents = {
-    PrimaryButton: React_2.ComponentType;
+    PrimaryButton: React_2.ComponentType<any>;
     WebLandingScreen: React_2.ComponentType<{
         logo?: string;
     }>;
     WebVideoScreen: React_2.ComponentType<{
-        videoId: string;
+        videoIdOrUrlName: string;
     }>;
     WebSeriesDetailScreen: React_2.ComponentType<WebSeriesDetailScreenProps>;
 };
@@ -1863,25 +2133,35 @@ export declare type TivioInternalComponents = {
  * @public
  */
 export declare type TivioInternalHooks = {
-    useAuthOverlay: () => AuthOverlayState;
-    useSubscriptionsOverlay: () => SubscriptionOverlayState;
+    useMonetizationsSelectOverlay: () => MonetizationsSelectOverlayState;
     useQerkoOverlay: () => QerkoOverlayState;
     usePurchasesWithVideos: () => {
         purchases: Purchase[];
     };
-    useOrganizationSubscriptions: () => {
-        subscriptions: Monetization[];
+    useOrganizationSubscriptions: (onlyPurchasableSubscriptions?: boolean) => {
+        subscriptions: PurchasableMonetization[];
     };
     useIsMonetizationPurchased: () => {
         isOneOfSubscriptionPurchased: (subscriptionIds: string[]) => boolean;
     };
-    useReferralInfo: any;
+    useReferralInfo: (referralToken: string) => ({
+        data: {
+            email: string;
+            externalUserId: string;
+            promotionId?: string;
+            referralId: string;
+            promotion?: any;
+        };
+        error: Error | null;
+        loading: boolean;
+    });
     useTvChannel: UseTvChannel;
     useChannelSource: UseChannelSource;
     useUser: () => {
         user: User | null;
         error: string | null;
         isInitialized: boolean;
+        isSignedIn: boolean;
     };
 };
 
@@ -1890,7 +2170,6 @@ export declare type TivioInternalHooks = {
  */
 export declare type TivioInternalProviders = {
     AppThemeProvider: React_2.ComponentType;
-    AuthOverlayContextProvider: React_2.ComponentType;
     CustomerProvider: React_2.ComponentType<{
         customer: CUSTOMER_BUILD;
         platform: PLATFORM;
@@ -1898,9 +2177,12 @@ export declare type TivioInternalProviders = {
     }>;
     ConfigProvider: React_2.ComponentType;
     UserContextProvider: React_2.ComponentType;
-    SubscriptionOverlayContextProvider: React_2.ComponentType;
+    MonetizationsSelectOverlayContextProvider: React_2.ComponentType;
     QerkoOverlayContextProvider: React_2.ComponentType;
     PurchasesWithVideosContextProvider: React_2.ComponentType;
+    /**
+     * @deprecated not used in our app, can be removed when no sdk in production uses it
+     */
     OrganizationSubscriptionsContextProvider: React_2.ComponentType;
     RouterOverridesContextProvider: React_2.ComponentType<RouterOverridesContextState>;
 };
@@ -2134,8 +2416,14 @@ export declare interface TvChannel extends RowItem {
     logo?: string;
     hls: string;
     dash: string;
+    /**
+     * Returns all transactions and subscriptions applied to this tv channel.
+     * Transactions before subscriptions, sorted by price ascending.
+     */
+    getPurchasableMonetizations(options?: GetPurchasableMonetizationsOptions): PurchasableMonetization[];
     purchasableMonetization: any | null;
     price: number;
+    cover: string;
 }
 
 /**
@@ -2280,8 +2568,8 @@ export declare const useMarkers: () => Marker[] | null;
 /**
  * @public
  */
-export declare const useOrganizationSubscriptions: () => {
-    subscriptions: Monetization[];
+export declare const useOrganizationSubscriptions: (onlyPurchasableSubscriptions?: boolean | undefined) => {
+    subscriptions: PurchasableMonetization[];
 };
 
 /**
@@ -2455,14 +2743,15 @@ export declare const useUser: () => {
     user: User | null;
     error: string | null;
     isInitialized: boolean;
+    isSignedIn: boolean;
 };
 
 /**
  * Use video
- * @param videoId - video id
+ * @param videoIdOrUrlName - video id or video nice url (e.g. some-interesting-video)
  * @public
  */
-export declare const useVideo: (videoId?: string | undefined) => {
+export declare const useVideo: (videoIdOrUrlName?: string | undefined) => {
     data: Video | null;
     error: string | null;
 };
@@ -2524,7 +2813,10 @@ export declare enum VastProvider {
     MALL_TV_PREBID = "malltv-prebid",
     PRIMA = "prima",
     TEST = "test",
-    TEST_VPAID = "test-vpaid"
+    TEST_VPAID = "test-vpaid",
+    JOJ_TEST_AD_FORM_PROGRAMMATIC = "joj-test-ad-form-programmatic",
+    JOJ_TEST_TESTER_VASTERIX = "joj-test-tester-vasterix",
+    JOJ_TEST_TESTER_ADFORM_30 = "joj-test-tester-adform-30"
 }
 
 /**
@@ -2536,7 +2828,6 @@ export declare interface Video extends RowItem {
      * @deprecated use assets instead
      */
     cover: string | null;
-    created: Date;
     sectionId: string | null;
     channelId: string | null;
     /**
@@ -2548,14 +2839,19 @@ export declare interface Video extends RowItem {
     image: string | null;
     isPlayable: boolean;
     monetizations: Monetization[];
-    monetization: Monetization | undefined;
-    transactionId?: string;
-    transaction: Monetization | undefined;
-    subscriptions: Monetization[];
-    subscriptionIds: string[];
+    /**
+     * Returns all transactions and subscriptions applied to this video.
+     * Transactions before subscriptions, sorted by price ascending.
+     */
+    getPurchasableMonetizations(options?: GetPurchasableMonetizationsOptions): PurchasableMonetization[];
+    purchasableMonetization: any | null;
+    transaction: PurchasableMonetization | undefined;
+    subscriptions: PurchasableMonetization[];
+    sources?: any[];
     isPlaylist: boolean;
     name: string;
-    description?: string;
+    urlNames?: string[];
+    urlName?: string;
     price: number | null;
     detailedPrice: DetailedPrice | null;
     uri: string;
@@ -2566,7 +2862,6 @@ export declare interface Video extends RowItem {
     detailBanner?: string;
     linkedVideosRaw: any[];
     linkedVideos: LinkedVideo[];
-    purchasableMonetization: any | null;
     contentType: VideoContentType | null;
     year?: number;
     episodeNumber?: number;
@@ -2623,6 +2918,14 @@ export declare enum VideoType {
      * Video is a standard single video.
      */
     VIDEO = "VIDEO",
+    /**
+     * Part of video original video like CUT.
+     */
+    CUT = "CUT",
+    /**
+     * Part of video original video like TRAILER.
+     */
+    TRAILER = "TRAILER",
     TV_PROGRAM = "TV_PROGRAM",
     /**
      * Video object represents whole series, e.g. tv show.
@@ -2630,6 +2933,13 @@ export declare enum VideoType {
     SERIES = "SERIES"
 }
 
+/**
+ * @public
+ */
+export declare type VideoUrlName = {
+    [key in LangCode]?: string[];
+};
+
 /**
  * @public
  */
@@ -2755,6 +3065,13 @@ export declare interface WhereFilter {
     value: any;
 }
 
+/**
+ * The same as WhereFilter, but in array, for easier usage.
+ * Format: [field, operator, value]
+ * @public
+ */
+export declare type WhereFilterArray = [string, WhereFilterOp, any];
+
 declare type WhereFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-contains' | 'in' | 'array-contains-any' | 'not-in';
 
 /**