Kaltura

Kaltura productPrice API

The productPrice API from Kaltura — 1 operation(s) for productprice.

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.kaltura.com/api-docs/
📖
Authentication
https://developer.kaltura.com/api-docs/VPaaS-API-Getting-Started/Kaltura_API_Authentication_and_Security.html
📖
GettingStarted
https://developer.kaltura.com/api-docs/VPaaS-API-Getting-Started/Getting-Started-VPaaS-API.html
📖
Documentation
https://devdocs.api.ott.kaltura.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/kaltura/refs/heads/main/openapi/kaltura-productprice-api-openapi.yml

Other Resources

🔗
Console
https://developer.kaltura.com/console
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/kaltura/refs/heads/main/graphql/kaltura-graphql.md

OpenAPI Specification

kaltura-productprice-api-openapi.yml Raw ↑ 
swagger: '2.0'
info:
  description: The Kaltura OTT API
  title: Kaltura OTT accessControl productPrice API
  version: 3.6.287.20720
host: tvpapi-us-preprod.ott.kaltura.com
basePath: /api_v3
schemes:
- https
- http
produces:
- application/json
- text/xml
security:
- ks: []
tags:
- name: productPrice
paths:
  /service/productprice/action/list:
    post:
      description: Returns a price and a purchase status for each subscription or/and media file, for a given user (if passed) and with the consideration of a coupon code (if passed).
      operationId: productPrice.list
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            filter:
              $ref: '#/definitions/KalturaProductPriceFilter'
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaProductPriceListResponse'
      tags:
      - productPrice
      x-kaltura-format: post
      x-kaltura-parameters:
      - filter
definitions:
  KalturaAssetReminderFilter:
    allOf:
    - $ref: '#/definitions/KalturaReminderFilter'
    properties:
      orderBy:
        enum:
        - RELEVANCY_DESC
        - NAME_ASC
        - NAME_DESC
        - VIEWS_DESC
        - RATINGS_DESC
        - VOTES_DESC
        - START_DATE_DESC
        - START_DATE_ASC
        - LIKES_DESC
        type: string
        x-enumLabels:
        - RELEVANCY_DESC
        - NAME_ASC
        - NAME_DESC
        - VIEWS_DESC
        - RATINGS_DESC
        - VOTES_DESC
        - START_DATE_DESC
        - START_DATE_ASC
        - LIKES_DESC
        x-enumType: KalturaAssetReminderOrderBy
    title: KalturaAssetReminderFilter
    type: object
  KalturaProductPriceListResponse:
    allOf:
    - $ref: '#/definitions/KalturaListResponse'
    description: Prices list
    properties:
      objects:
        items:
          $ref: '#/definitions/KalturaProductPrice'
        type: array
    title: KalturaProductPriceListResponse
    type: object
  KalturaProductPrice:
    description: '`abstract`'
    discriminator: objectType
    oneOf:
    - $ref: '#/definitions/KalturaCollectionPrice'
    - $ref: '#/definitions/KalturaPpvPrice'
    - $ref: '#/definitions/KalturaSubscriptionPrice'
    properties:
      objectType:
        enum:
        - KalturaCollectionPrice
        - KalturaPpvPrice
        - KalturaSubscriptionPrice
        type: string
      price:
        $ref: '#/definitions/KalturaPrice'
      productId:
        description: Product identifier
        type: string
      productType:
        description: 'Enum Type: `KalturaTransactionType`


          Product Type'
        enum:
        - ppv
        - subscription
        - collection
        type: string
        x-enumLabels:
        - PPV
        - SUBSCRIPTION
        - COLLECTION
        x-enumType: KalturaTransactionType
      purchaseStatus:
        description: 'Enum Type: `KalturaPurchaseStatus`


          Product purchase status'
        enum:
        - ppv_purchased
        - free
        - for_purchase_subscription_only
        - subscription_purchased
        - for_purchase
        - subscription_purchased_wrong_currency
        - pre_paid_purchased
        - geo_commerce_blocked
        - entitled_to_preview_module
        - first_device_limitation
        - collection_purchased
        - user_suspended
        - not_for_purchase
        - invalid_currency
        - currency_not_defined_on_price_code
        type: string
        x-enumLabels:
        - PPV_PURCHASED
        - FREE
        - FOR_PURCHASE_SUBSCRIPTION_ONLY
        - SUBSCRIPTION_PURCHASED
        - FOR_PURCHASE
        - SUBSCRIPTION_PURCHASED_WRONG_CURRENCY
        - PRE_PAID_PURCHASED
        - GEO_COMMERCE_BLOCKED
        - ENTITLED_TO_PREVIEW_MODULE
        - FIRST_DEVICE_LIMITATION
        - COLLECTION_PURCHASED
        - USER_SUSPENDED
        - NOT_FOR_PURCHASE
        - INVALID_CURRENCY
        - CURRENCY_NOT_DEFINED_ON_PRICE_CODE
        x-enumType: KalturaPurchaseStatus
    title: KalturaProductPrice
    type: object
  KalturaSeasonsReminderFilter:
    allOf:
    - $ref: '#/definitions/KalturaReminderFilter'
    properties:
      epgChannelIdEqual:
        description: EPG channel ID
        type: integer
      seasonNumberIn:
        description: Comma separated season numbers
        type: string
      seriesIdEqual:
        description: Series ID
        type: string
    title: KalturaSeasonsReminderFilter
    type: object
  KalturaPersonalFeedFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    properties:
      orderBy:
        enum:
        - RELEVANCY_DESC
        - NAME_ASC
        - NAME_DESC
        - VIEWS_DESC
        - RATINGS_DESC
        - VOTES_DESC
        - START_DATE_DESC
        - START_DATE_ASC
        type: string
        x-enumLabels:
        - RELEVANCY_DESC
        - NAME_ASC
        - NAME_DESC
        - VIEWS_DESC
        - RATINGS_DESC
        - VOTES_DESC
        - START_DATE_DESC
        - START_DATE_ASC
        x-enumType: KalturaPersonalFeedOrderBy
    title: KalturaPersonalFeedFilter
    type: object
  KalturaSocialCommentFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    properties:
      assetIdEqual:
        description: Asset ID to filter by
        type: integer
      assetTypeEqual:
        description: 'Enum Type: `KalturaAssetType`


          Asset type to filter by, currently only VOD (media)'
        enum:
        - media
        - recording
        - epg
        type: string
        x-enumLabels:
        - MEDIA
        - RECORDING
        - EPG
        x-enumType: KalturaAssetType
      createDateGreaterThan:
        description: The create date from which to get the comments
        type: integer
      orderBy:
        enum:
        - CREATE_DATE_ASC
        - CREATE_DATE_DESC
        type: string
        x-enumLabels:
        - CREATE_DATE_ASC
        - CREATE_DATE_DESC
        x-enumType: KalturaSocialCommentOrderBy
      socialPlatformEqual:
        description: 'Enum Type: `KalturaSocialPlatform`


          Comma separated list of social actions to filter by'
        enum:
        - IN_APP
        - FACEBOOK
        - TWITTER
        type: string
        x-enumLabels:
        - IN_APP
        - FACEBOOK
        - TWITTER
        x-enumType: KalturaSocialPlatform
    title: KalturaSocialCommentFilter
    type: object
  KalturaPersistedFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    description: '`abstract`'
    discriminator: objectType
    oneOf:
    - $ref: '#/definitions/KalturaAssetFilter'
    properties:
      name:
        description: Name for the presisted filter. If empty, no action will be done. If has value, the filter will be saved and persisted in user's search history.
        type: string
      objectType:
        enum:
        - KalturaAssetFilter
        type: string
    title: KalturaPersistedFilter
    type: object
  KalturaSocialActionFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    properties:
      actionTypeIn:
        description: Comma separated list of social actions to filter by
        type: string
      assetIdIn:
        description: Comma separated list of asset identifiers.
        type: string
      assetTypeEqual:
        description: 'Enum Type: `KalturaAssetType`


          Asset Type'
        enum:
        - media
        - recording
        - epg
        type: string
        x-enumLabels:
        - MEDIA
        - RECORDING
        - EPG
        x-enumType: KalturaAssetType
      orderBy:
        enum:
        - NONE
        type: string
        x-enumLabels:
        - NONE
        x-enumType: KalturaSocialActionOrderBy
    title: KalturaSocialActionFilter
    type: object
  KalturaConfigurationGroupTagFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    description: Configuration group tag filter
    properties:
      configurationGroupIdEqual:
        description: the ID of the configuration group for which to return related configurations group tags
        type: string
      orderBy:
        enum:
        - NONE
        type: string
        x-enumLabels:
        - NONE
        x-enumType: KalturaConfigurationGroupTagOrderBy
    title: KalturaConfigurationGroupTagFilter
    type: object
  KalturaInboxMessageFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    properties:
      createdAtGreaterThanOrEqual:
        description: createdAtGreaterThanOrEqual
        type: integer
      createdAtLessThanOrEqual:
        description: createdAtLessThanOrEqual
        type: integer
      orderBy:
        enum:
        - NONE
        type: string
        x-enumLabels:
        - NONE
        x-enumType: KalturaInboxMessageOrderBy
      typeIn:
        description: List of inbox message types to search within.
        type: string
    title: KalturaInboxMessageFilter
    type: object
  KalturaEntitlementFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    description: Entitlements filter
    properties:
      entityReferenceEqual:
        description: 'Enum Type: `KalturaEntityReferenceBy`


          Reference type to filter by'
        enum:
        - user
        - household
        type: string
        x-enumLabels:
        - USER
        - HOUSEHOLD
        x-enumType: KalturaEntityReferenceBy
      isExpiredEqual:
        description: Is expired
        type: boolean
      orderBy:
        enum:
        - PURCHASE_DATE_ASC
        - PURCHASE_DATE_DESC
        type: string
        x-enumLabels:
        - PURCHASE_DATE_ASC
        - PURCHASE_DATE_DESC
        x-enumType: KalturaEntitlementOrderBy
      productTypeEqual:
        description: 'Enum Type: `KalturaTransactionType`


          The type of the entitlements to return'
        enum:
        - ppv
        - subscription
        - collection
        type: string
        x-enumLabels:
        - PPV
        - SUBSCRIPTION
        - COLLECTION
        x-enumType: KalturaTransactionType
    title: KalturaEntitlementFilter
    type: object
  KalturaFollowTvSeriesFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    properties:
      orderBy:
        enum:
        - START_DATE_DESC
        - START_DATE_ASC
        type: string
        x-enumLabels:
        - START_DATE_DESC
        - START_DATE_ASC
        x-enumType: KalturaFollowTvSeriesOrderBy
    title: KalturaFollowTvSeriesFilter
    type: object
  KalturaPpvPrice:
    allOf:
    - $ref: '#/definitions/KalturaProductPrice'
    description: PPV price details
    properties:
      collectionId:
        description: The identifier of the relevant collection
        type: string
      discountEndDate:
        description: Discount end date
        type: integer
      endDate:
        description: If the item already purchased - until when the user can watch the item
        type: integer
      fileId:
        description: Media file identifier
        type: integer
      firstDeviceName:
        description: If the item already purchased and played - the name of the device on which it was first played
        type: string
      fullPrice:
        $ref: '#/definitions/KalturaPrice'
      isInCancelationPeriod:
        description: If waiver period is enabled - donates whether the user is still in the cancelation window
        type: boolean
      isSubscriptionOnly:
        description: Denotes whether this object is available only as part of a subscription or can be sold separately
        type: boolean
      ppvDescriptions:
        items:
          $ref: '#/definitions/KalturaTranslationToken'
        type: array
      ppvModuleId:
        description: The associated PPV module identifier
        type: string
      ppvProductCode:
        description: The PPV product code
        type: string
      prePaidId:
        description: The identifier of the relevant pre paid
        type: string
      purchaseUserId:
        description: If the item already purchased - the identifier of the user (in the household) who purchased this item
        type: string
      purchasedMediaFileId:
        description: If the item already purchased - the identifier of the purchased file
        type: integer
      relatedMediaFileIds:
        items:
          $ref: '#/definitions/KalturaIntegerValue'
        type: array
      startDate:
        description: If the item already purchased - since when the user can start watching the item
        type: integer
      subscriptionId:
        description: The identifier of the relevant subscription
        type: string
    title: KalturaPpvPrice
    type: object
  KalturaValue:
    description: '`abstract`


      A representation to return an array of values'
    discriminator: objectType
    oneOf:
    - $ref: '#/definitions/KalturaIntegerValue'
    - $ref: '#/definitions/KalturaMultilingualStringValue'
    - $ref: '#/definitions/KalturaLongValue'
    - $ref: '#/definitions/KalturaDoubleValue'
    - $ref: '#/definitions/KalturaBooleanValue'
    - $ref: '#/definitions/KalturaStringValue'
    properties:
      description:
        description: Description
        type: string
      objectType:
        enum:
        - KalturaIntegerValue
        - KalturaMultilingualStringValue
        - KalturaLongValue
        - KalturaDoubleValue
        - KalturaBooleanValue
        - KalturaStringValue
        type: string
    title: KalturaValue
    type: object
  KalturaCountryFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    description: Country filter
    properties:
      idIn:
        description: Country identifiers
        type: string
      ipEqual:
        description: Ip to identify the country
        type: string
      ipEqualCurrent:
        description: Indicates if to get the IP from the request
        type: boolean
      orderBy:
        enum:
        - NAME_ASC
        type: string
        x-enumLabels:
        - NAME_ASC
        x-enumType: KalturaCountryOrderBy
    title: KalturaCountryFilter
    type: object
  KalturaTranslationToken:
    description: Container for translation
    properties:
      language:
        description: Language code
        type: string
      value:
        description: Translated value
        type: string
    title: KalturaTranslationToken
    type: object
  OTTRequest:
    properties:
      ks:
        type: string
      version:
        default: 3.6.287.20720
        type: string
    type: object
  KalturaListResponse:
    description: Base list wrapper
    properties:
      totalCount:
        description: Total items
        type: integer
    title: KalturaListResponse
    type: object
  KalturaFilter:
    description: '`abstract`'
    discriminator: objectType
    oneOf:
    - $ref: '#/definitions/KalturaRelatedObjectFilter'
    - $ref: '#/definitions/KalturaChannelsFilter'
    - $ref: '#/definitions/KalturaMediaFileFilter'
    - $ref: '#/definitions/KalturaImageFilter'
    - $ref: '#/definitions/KalturaImageTypeFilter'
    - $ref: '#/definitions/KalturaTagFilter'
    - $ref: '#/definitions/KalturaAssetStructFilter'
    - $ref: '#/definitions/KalturaCurrencyFilter'
    - $ref: '#/definitions/KalturaPersistedFilter'
    - $ref: '#/definitions/KalturaCollectionFilter'
    - $ref: '#/definitions/KalturaPricePlanFilter'
    - $ref: '#/definitions/KalturaPriceDetailsFilter'
    - $ref: '#/definitions/KalturaSubscriptionSetFilter'
    - $ref: '#/definitions/KalturaLanguageFilter'
    - $ref: '#/definitions/KalturaMetaFilter'
    - $ref: '#/definitions/KalturaCountryFilter'
    - $ref: '#/definitions/KalturaSearchHistoryFilter'
    - $ref: '#/definitions/KalturaConfigurationsFilter'
    - $ref: '#/definitions/KalturaReportFilter'
    - $ref: '#/definitions/KalturaConfigurationGroupTagFilter'
    - $ref: '#/definitions/KalturaConfigurationGroupDeviceFilter'
    - $ref: '#/definitions/KalturaHouseholdDeviceFilter'
    - $ref: '#/definitions/KalturaRegionFilter'
    - $ref: '#/definitions/KalturaUserAssetRuleFilter'
    - $ref: '#/definitions/KalturaParentalRuleFilter'
    - $ref: '#/definitions/KalturaExportTaskFilter'
    - $ref: '#/definitions/KalturaAssetCommentFilter'
    - $ref: '#/definitions/KalturaBookmarkFilter'
    - $ref: '#/definitions/KalturaSeriesRecordingFilter'
    - $ref: '#/definitions/KalturaProductPriceFilter'
    - $ref: '#/definitions/KalturaEntitlementFilter'
    - $ref: '#/definitions/KalturaTransactionHistoryFilter'
    - $ref: '#/definitions/KalturaUserRoleFilter'
    - $ref: '#/definitions/KalturaPaymentMethodProfileFilter'
    - $ref: '#/definitions/KalturaAssetHistoryFilter'
    - $ref: '#/definitions/KalturaRecordingContextFilter'
    - $ref: '#/definitions/KalturaRecordingFilter'
    - $ref: '#/definitions/KalturaHouseholdUserFilter'
    - $ref: '#/definitions/KalturaEngagementFilter'
    - $ref: '#/definitions/KalturaReminderFilter'
    - $ref: '#/definitions/KalturaFollowTvSeriesFilter'
    - $ref: '#/definitions/KalturaInboxMessageFilter'
    - $ref: '#/definitions/KalturaAnnouncementFilter'
    - $ref: '#/definitions/KalturaPersonalFeedFilter'
    - $ref: '#/definitions/KalturaTopicFilter'
    - $ref: '#/definitions/KalturaSubscriptionFilter'
    - $ref: '#/definitions/KalturaSocialCommentFilter'
    - $ref: '#/definitions/KalturaSocialFriendActivityFilter'
    - $ref: '#/definitions/KalturaSocialActionFilter'
    - $ref: '#/definitions/KalturaFavoriteFilter'
    - $ref: '#/definitions/KalturaOTTUserFilter'
    properties:
      objectType:
        enum:
        - KalturaRelatedObjectFilter
        - KalturaChannelsFilter
        - KalturaMediaFileFilter
        - KalturaImageFilter
        - KalturaImageTypeFilter
        - KalturaTagFilter
        - KalturaAssetStructFilter
        - KalturaCurrencyFilter
        - KalturaPersistedFilter
        - KalturaCollectionFilter
        - KalturaPricePlanFilter
        - KalturaPriceDetailsFilter
        - KalturaSubscriptionSetFilter
        - KalturaLanguageFilter
        - KalturaMetaFilter
        - KalturaCountryFilter
        - KalturaSearchHistoryFilter
        - KalturaConfigurationsFilter
        - KalturaReportFilter
        - KalturaConfigurationGroupTagFilter
        - KalturaConfigurationGroupDeviceFilter
        - KalturaHouseholdDeviceFilter
        - KalturaRegionFilter
        - KalturaUserAssetRuleFilter
        - KalturaParentalRuleFilter
        - KalturaExportTaskFilter
        - KalturaAssetCommentFilter
        - KalturaBookmarkFilter
        - KalturaSeriesRecordingFilter
        - KalturaProductPriceFilter
        - KalturaEntitlementFilter
        - KalturaTransactionHistoryFilter
        - KalturaUserRoleFilter
        - KalturaPaymentMethodProfileFilter
        - KalturaAssetHistoryFilter
        - KalturaRecordingContextFilter
        - KalturaRecordingFilter
        - KalturaHouseholdUserFilter
        - KalturaEngagementFilter
        - KalturaReminderFilter
        - KalturaFollowTvSeriesFilter
        - KalturaInboxMessageFilter
        - KalturaAnnouncementFilter
        - KalturaPersonalFeedFilter
        - KalturaTopicFilter
        - KalturaSubscriptionFilter
        - KalturaSocialCommentFilter
        - KalturaSocialFriendActivityFilter
        - KalturaSocialActionFilter
        - KalturaFavoriteFilter
        - KalturaOTTUserFilter
        type: string
      orderBy:
        description: order by
        type: string
    title: KalturaFilter
    type: object
  KalturaRegionFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    properties:
      externalIdIn:
        description: List of comma separated regions external identifiers
        type: string
      orderBy:
        enum:
        - CREATE_DATE_ASC
        - CREATE_DATE_DESC
        type: string
        x-enumLabels:
        - CREATE_DATE_ASC
        - CREATE_DATE_DESC
        x-enumType: KalturaRegionOrderBy
    title: KalturaRegionFilter
    type: object
  KalturaPaymentMethodProfileFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    properties:
      orderBy:
        enum:
        - NONE
        type: string
        x-enumLabels:
        - NONE
        x-enumType: KalturaPaymentMethodProfileOrderBy
      paymentGatewayIdEqual:
        description: Payment gateway identifier to list the payment methods for
        type: integer
    title: KalturaPaymentMethodProfileFilter
    type: object
  KalturaSubscriptionFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    properties:
      externalIdIn:
        description: Comma separated subscription external IDs to get the subscriptions by
        type: string
      mediaFileIdEqual:
        description: Media-file ID to get the subscriptions by
        type: integer
      orderBy:
        enum:
        - START_DATE_ASC
        - START_DATE_DESC
        type: string
        x-enumLabels:
        - START_DATE_ASC
        - START_DATE_DESC
        x-enumType: KalturaSubscriptionOrderBy
      subscriptionIdIn:
        description: Comma separated subscription IDs to get the subscriptions by
        type: string
    title: KalturaSubscriptionFilter
    type: object
  KalturaRecordingContextFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    description: Filtering assets
    properties:
      assetIdIn:
        description: Comma separated asset ids
        type: string
      orderBy:
        enum:
        - NONE
        type: string
        x-enumLabels:
        - NONE
        x-enumType: KalturaRecordingContextOrderBy
    title: KalturaRecordingContextFilter
    type: object
  KalturaAnnouncementFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    description: order announcements
    properties:
      orderBy:
        enum:
        - NONE
        type: string
        x-enumLabels:
        - NONE
        x-enumType: KalturaAnnouncementOrderBy
    title: KalturaAnnouncementFilter
    type: object
  KalturaCurrencyFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    description: Currency filter
    properties:
      codeIn:
        description: Currency codes
        type: string
      orderBy:
        enum:
        - NAME_ASC
        - NAME_DESC
        - CODE_ASC
        - CODE_DESC
        type: string
        x-enumLabels:
        - NAME_ASC
        - NAME_DESC
        - CODE_ASC
        - CODE_DESC
        x-enumType: KalturaCurrencyOrderBy
    title: KalturaCurrencyFilter
    type: object
  KalturaOTTUserFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    description: OTT User filter
    properties:
      externalIdEqual:
        description: User external identifier
        type: string
      idIn:
        description: List of user identifiers separated by ','
        type: string
      orderBy:
        enum:
        - NONE
        type: string
        x-enumLabels:
        - NONE
        x-enumType: KalturaOTTUserOrderBy
      usernameEqual:
        description: Username
        type: string
    title: KalturaOTTUserFilter
    type: object
  KalturaImageTypeFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    properties:
      idIn:
        description: IDs to filter by
        type: string
      orderBy:
        enum:
        - NONE
        type: string
        x-enumLabels:
        - NONE
        x-enumType: KalturaImageTypeOrderBy
      ratioIdIn:
        description: Ratio IDs to filter by
        type: string
    title: KalturaImageTypeFilter
    type: object
  KalturaSeriesReminderFilter:
    allOf:
    - $ref: '#/definitions/KalturaReminderFilter'
    properties:
      epgChannelIdEqual:
        description: EPG channel ID
        type: integer
      orderBy:
        enum:
        - NONE
        type: string
        x-enumLabels:
        - NONE
        x-enumType: KalturaSeriesReminderOrderBy
      seriesIdIn:
        description: Comma separated series IDs
        type: string
    title: KalturaSeriesReminderFilter
    type: object
  KalturaEngagementFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    properties:
      orderBy:
        enum:
        - NONE
        type: string
        x-enumLabels:
        - NONE
        x-enumType: KalturaEngagementOrderBy
      sendTimeGreaterThanOrEqual:
        description: SendTime GreaterThanOrEqual
        type: integer
      typeIn:
        description: List of inbox message types to search within.
        type: string
    title: KalturaEngagementFilter
    type: object
  KalturaParentalRuleFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    properties:
      entityReferenceEqual:
        description: 'Enum Type: `KalturaEntityReferenceBy`


          Reference type to filter by'
        enum:
        - user
        - household
        type: string
        x-enumLabels:
        - USER
        - HOUSEHOLD
        x-enumType: KalturaEntityReferenceBy
      orderBy:
        enum:
        - PARTNER_SORT_VALUE
        type: string
        x-enumLabels:
        - PARTNER_SORT_VALUE
        x-enumType: KalturaParentalRuleOrderBy
    title: KalturaParentalRuleFilter
    type: object
  KalturaDoubleValue:
    allOf:
    - $ref: '#/definitions/KalturaValue'
    description: A string representation to return an array of doubles
    properties:
      value:
        description: Value
        type: number
    title: KalturaDoubleValue
    type: object
  KalturaImageFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    properties:
      idIn:
        description: IDs to filter by
        type: string
      imageObjectIdEqual:
        description: ID of the object the is related to, to filter by
        type: integer
      imageObjectTypeEqual:
        description: 'Enum Type: `KalturaImageObjectType`


          Type of the object the image is related to, to filter by'
        enum:
        - MEDIA_ASSET
        - PROGRAM_ASSET
        - CHANNEL
        - CATEGORY
        - PARTNER
        - IMAGE_TYPE
        type: string
        x-enumLabels:
        - MEDIA_ASSET
        - PROGRAM_ASSET
        - CHANNEL
        - CATEGORY
        - PARTNER
        - IMAGE_TYPE
        x-enumType: KalturaImageObjectType
      isDefaultEqual:
        description: Filter images that are default on atleast on image type or not default at any
        type: boolean
      orderBy:
        enum:
        - NONE
        type: string
        x-enumLabels:
        - NONE
        x-enumType: KalturaImageOrderBy
    title: KalturaImageFilter
    type: object
  KalturaReminderFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    description: '`abstract`'
    discriminator: objectType
    oneOf:
    - $ref: '#/definitions/KalturaAssetReminderFilter'
    - $ref: '#/definitions/KalturaSeriesReminderFilter'
    - $ref: '#/definitions/KalturaSeasonsReminderFilter'
    properties:
      objectType:
        enum:
        - KalturaAssetReminderFilter
        - KalturaSeriesReminderFilter
        - KalturaSeasonsReminderFilter
        type: string
    title: KalturaReminderFilter
    type: object
  KalturaAssetHistoryFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    properties:
      assetIdIn:
        description: Comma separated list of asset identifiers.
        type: string
      daysLessThanOrEqual:
        description: How many days back to return the watched media. If omitted, default to 7 days
        type: integer
      orderBy:
        enum:
        - NONE
        type: string
        x-enumLabels:
        - NONE
        x-enumType: KalturaAssetHistoryOrderBy
      statusEqual:
        description: "Enum Type: `KalturaWatchStatus`\n\nWhich type of recently watched media to include in the result – those that finished watching, those that are in progress or both.\r\n            If omitted or specified filter = all – return all types.\r\n            Allowed values: progress – return medias that are in-progress, done – return medias that finished watching."
        enum:
        - progress
        - done
        - all
        type: string
        x-enumLabels:
        - PROGRESS
        - DONE
        - ALL
        x-enumType: KalturaWatchStatus
      typeIn:
        description: "Comma separated list of asset types to search within.\r\n            Possible values: 0 – EPG linear programs entries, any media type ID (according to media type IDs defined dynamically in the system).\r\n            If omitted – all types should be included."
        type: string
    title: KalturaAssetHistoryFilter
    type: object
  KalturaAssetFilter:
    allOf:
    - $ref: '#/definitions/KalturaPersistedFilter'
    properties:
      dynamicOrderBy:
        $ref: '#/definitions/KalturaDynamicOrderBy'
      orderBy:
        enum:
        - RELEVANCY_DESC
        - NAME_ASC
        - NAME_DESC
        - VIEWS_DESC
        - RATINGS_DESC
        - VOTES_DESC
        - START_DATE_DESC
        - START_DATE_ASC
        - LIKES_DESC
        - CREATE_DATE_ASC
        - CREATE_DATE_DESC
        type: string
        x-enumLabels:
        - RELEVANCY_DESC
        - NAME_ASC
        - NAME_DESC
        - VIEWS_DESC
        - RATINGS_DESC
        - VOTES_DESC
        - START_DATE_DESC
        - START_DATE_ASC
        - LIKES_DESC
        - CREATE_DATE_ASC
        - CREATE_DATE_DESC
        x-enumType: KalturaAssetOrderBy
    title: KalturaAssetFilter
    type: object
  KalturaExportTaskFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    description: Bulk export tasks filter
    properties:
      idIn:
        description: Comma separated tasks identifiers
        type: string
      orderBy:
        enum:
        - CREATE_DATE_ASC
        - CREATE_DATE_DESC
        type: string
        x-enumLabels:
        - CREATE_DATE_ASC
        - CREATE_DATE_DESC
        x-enumType: KalturaExportTaskOrderBy
    title: KalturaExportTaskFilter
    type: object
  KalturaSubscriptionPrice:
    allOf:
    - $ref: '#/definitions/KalturaProductPrice'
    description: Subscription price details
    properties:
      endDate:
        description: If the item related to unified billing cycle purchased - until when the this price is relevant
        type: integer
    title: KalturaSubscriptionPrice
    type: object
  KalturaTopicFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    properties:
      orderBy:
        enum:
        - NONE
        type: string
        x-enumLabels:
        - NONE
        x-enumType: KalturaTopicOrderBy
    title: KalturaTopicFilter
    type: object
  KalturaSocialFriendActivityFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    properties:
      actionTypeIn:
        description: Comma separated list of social actions to filter by
        type: string
      assetIdEqual:
        description: Asset ID to filter by
        type: integer
      assetTypeEqual:
        description: 'Enum Type: `KalturaAssetType`


          Asset type to filter by, currently only VOD (media)'
        enum:
        - media
        - recording
        - epg
        type: string
        x-enumLabels:
        - MEDIA
        - RECORDING
        - EPG
        x-enumType: KalturaAssetType
      orderBy:
        enum:
        - NONE
        - UPDATE_DATE_DESC
        type: string
        x-enumLabels:
        - NONE
        - UPDATE_DATE_DESC
        x-enumType: KalturaSocialFriendActivityOrderBy
    title: KalturaSocialFriendActivityFilter
    type: object
  KalturaLongValue:
    allOf:
    - $ref: '#/definitions/KalturaValue'
    description: A string representation to return an array of longs
    properties:
      value:
        description: Value
        type: integer
    title: KalturaLongValue
    type: object
  KalturaMediaFileFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    properties:
      assetIdEqual:
        description: Asset identifier to filter by
        type: integer
      idEqual:
        description: Asset file identifier to filter by
        type: integer
      orderBy:
        enum:
        - NONE
        type: string
        x-enumLabels:
        - NONE
        x-enumType: KalturaMediaFileOrderBy
    title: KalturaMediaFileFilter
    type: object
  KalturaReportFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    description: '`abstract`


      Report filter'
    discriminator: objectType
    oneOf:
    - $ref: '#/definitions/KalturaDeviceReportFilter'
    properties:
      objectType:
        enum:
        - KalturaDeviceReportFilter
        type: string
      orderBy:
        enum:
        - NONE
        type: string
        x-enumLabels:
        - NONE
        x-enumType: KalturaReportOrderBy
    title: KalturaReportFilter
    type: object
  KalturaUserAssetRuleFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    description: User asset rule filter
    proper

# --- truncated at 32 KB (122 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kaltura/refs/heads/main/openapi/kaltura-productprice-api-openapi.yml