Kaltura entitlement API

swagger: '2.0'
info:
  description: The Kaltura OTT API
  title: Kaltura OTT accessControl entitlement 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: entitlement
paths:
  /service/entitlement/action/cancel:
    post:
      description: Immediately cancel a subscription, PPV or collection. Cancel is possible only if within cancellation window and content not already consumed
      operationId: entitlement.cancel
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            assetId:
              type: integer
            productType:
              enum:
              - ppv
              - subscription
              - collection
              type: string
              x-enumLabels:
              - PPV
              - SUBSCRIPTION
              - COLLECTION
              x-enumType: KalturaTransactionType
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: boolean
        x-Errors:
          description: '* `CancelationWindowPeriodExpired`: undefined

            * `ContentAlreadyConsumed`: undefined

            * `PaymentGatewayNotValid`: undefined

            * `SubscriptionCancellationIsBlocked`: undefined

            * `DomainSuspended`: undefined

            * `InvalidPurchase`: undefined'
      tags:
      - entitlement
      x-kaltura-format: post
      x-kaltura-parameters:
      - assetId
      - productType
  /service/entitlement/action/cancelRenewal:
    post:
      description: Cancel a household service subscription at the next renewal. The subscription stays valid till the next renewal.
      operationId: entitlement.cancelRenewal
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            subscriptionId:
              type: string
          type: object
      responses:
        '200':
          description: Success
        x-Errors:
          description: '* `SubscriptionCancellationIsBlocked`: undefined

            * `DomainSuspended`: undefined

            * `InvalidPurchase`: undefined

            * `SubscriptionNotRenewable`: undefined'
      tags:
      - entitlement
      x-kaltura-format: post
      x-kaltura-parameters:
      - subscriptionId
  /service/entitlement/action/cancelScheduledSubscription:
    post:
      description: Cancel Scheduled Subscription
      operationId: entitlement.cancelScheduledSubscription
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            scheduledSubscriptionId:
              type: integer
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: boolean
        x-Errors:
          description: '* `SubscriptionCancellationIsBlocked`: undefined'
      tags:
      - entitlement
      x-kaltura-format: post
      x-kaltura-parameters:
      - scheduledSubscriptionId
  /service/entitlement/action/externalReconcile:
    post:
      description: Reconcile the user household's entitlements with an external entitlements source. This request is frequency protected to avoid too frequent calls per household.
      operationId: entitlement.externalReconcile
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties: {}
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: boolean
        x-Errors:
          description: '* `UserDoesNotExist`: undefined

            * `AdapterAppFailure`: undefined

            * `UserNotInDomain`: undefined

            * `ReconciliationFrequencyLimitation`: undefined'
      tags:
      - entitlement
      x-kaltura-format: post
      x-kaltura-parameters: []
  /service/entitlement/action/forceCancel:
    post:
      description: Immediately cancel a subscription, PPV or collection. Cancel applies regardless of cancellation window and content consumption status
      operationId: entitlement.forceCancel
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            assetId:
              type: integer
            productType:
              enum:
              - ppv
              - subscription
              - collection
              type: string
              x-enumLabels:
              - PPV
              - SUBSCRIPTION
              - COLLECTION
              x-enumType: KalturaTransactionType
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: boolean
        x-Errors:
          description: '* `InvalidPurchase`: undefined

            * `DomainSuspended`: undefined'
      tags:
      - entitlement
      x-kaltura-format: post
      x-kaltura-parameters:
      - assetId
      - productType
  /service/entitlement/action/getNextRenewal:
    post:
      description: Returns the data about the next renewal
      operationId: entitlement.getNextRenewal
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            id:
              type: integer
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaEntitlementRenewal'
      tags:
      - entitlement
      x-kaltura-format: post
      x-kaltura-parameters:
      - id
  /service/entitlement/action/grant:
    post:
      description: Grant household for an entitlement for a PPV or Subscription.
      operationId: entitlement.grant
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            contentId:
              default: 0
              type: integer
            history:
              type: boolean
            productId:
              type: integer
            productType:
              enum:
              - ppv
              - subscription
              - collection
              type: string
              x-enumLabels:
              - PPV
              - SUBSCRIPTION
              - COLLECTION
              x-enumType: KalturaTransactionType
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: boolean
        x-Errors:
          description: '* `UserSuspended`: undefined

            * `UserNotInDomain`: undefined

            * `UserDoesNotExist`: undefined

            * `UnableToPurchaseSubscriptionPurchased`: undefined

            * `UnableToPurchaseFree`: undefined

            * `UnableToPurchaseForPurchaseSubscriptionOnly`: undefined

            * `UnableToPurchasePPVPurchased`: undefined

            * `NotForPurchase`: undefined

            * `UnableToPurchaseCollectionPurchased`: undefined

            * `UnKnownPPVModule`: undefined'
      tags:
      - entitlement
      x-kaltura-format: post
      x-kaltura-parameters:
      - productId
      - productType
      - history
      - contentId
  /service/entitlement/action/list:
    post:
      description: Gets all the entitled media items for a household
      operationId: entitlement.list
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            filter:
              $ref: '#/definitions/KalturaEntitlementFilter'
            pager:
              $ref: '#/definitions/KalturaFilterPager'
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaEntitlementListResponse'
      tags:
      - entitlement
      x-kaltura-format: post
      x-kaltura-parameters:
      - filter
      - pager
  /service/entitlement/action/swap:
    post:
      description: Swap current entitlement (subscription) with new entitlement (subscription) - only Grant
      operationId: entitlement.swap
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            currentProductId:
              type: integer
            history:
              type: boolean
            newProductId:
              type: integer
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: boolean
      tags:
      - entitlement
      x-kaltura-format: post
      x-kaltura-parameters:
      - currentProductId
      - newProductId
      - history
  /service/entitlement/action/update:
    post:
      description: Update Kaltura Entitelment by Purchase id
      operationId: entitlement.update
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            entitlement:
              $ref: '#/definitions/KalturaEntitlement'
            id:
              type: integer
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaEntitlement'
      tags:
      - entitlement
      x-kaltura-format: post
      x-kaltura-parameters:
      - id
      - entitlement
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
  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
  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
  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
  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
  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
  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
  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
  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
  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
  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
  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
  KalturaEntitlement:
    description: Entitlement
    properties:
      currentDate:
        description: '`readOnly`


          Current date'
        readOnly: true
        type: integer
      currentUses:
        description: '`readOnly`


          The current number of uses'
        readOnly: true
        type: integer
      deviceName:
        description: '`readOnly`


          The name of the device from which the purchase was made'
        readOnly: true
        type: string
      deviceUdid:
        description: '`readOnly`


          The UDID of the device from which the purchase was made'
        readOnly: true
        type: string
      endDate:
        description: '`readOnly`


          The end date of the entitlement'
        readOnly: true
        type: integer
      householdId:
        description: '`readOnly`


          The Identifier of the purchasing household'
        readOnly: true
        type: integer
      id:
        description: '`readOnly`


          Purchase identifier (for subscriptions and collections only)'
        readOnly: true
        type: integer
      isCancelationWindowEnabled:
        description: '`readOnly`


          Indicates whether a cancelation window period is enabled'
        readOnly: true
        type: boolean
      lastViewDate:
        description: '`readOnly`


          The last date the item was viewed'
        readOnly: true
        type: integer
      maxUses:
        description: '`readOnly`


          The maximum number of uses available for this item (only for subscription and PPV)'
        readOnly: true
        type: integer
      paymentMethod:
        description: '`readOnly`


          Enum Type: `KalturaPaymentMethodType`


          Payment Method'
        enum:
        - unknown
        - credit_card
        - sms
        - pay_pal
        - debit_card
        - ideal
        - incaso
        - gift
        - visa
        - master_card
        - in_app
        - m1
        - change_subscription
        - offline
        readOnly: true
        type: string
        x-enumLabels:
        - UNKNOWN
        - CREDIT_CARD
        - SMS
        - PAY_PAL
        - DEBIT_CARD
        - IDEAL
        - INCASO
        - GIFT
        - VISA
        - MASTER_CARD
        - IN_APP
        - M1
        - CHANGE_SUBSCRIPTION
        - OFFLINE
        x-enumType: KalturaPaymentMethodType
      productId:
        description: '`readOnly`


          Product identifier'
        readOnly: true
        type: string
      purchaseDate:
        description: '`readOnly`


          Purchase date'
        readOnly: true
        type: integer
      userId:
        description: '`readOnly`


          The Identifier of the purchasing user'
        readOnly: true
        type: string
    title: KalturaEntitlement
    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
  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
  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
  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
  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
  KalturaFilterPager:
    description: The KalturaFilterPager object enables paging management to be applied upon service list actions
    properties:
      pageIndex:
        description: The page number for which {pageSize} of objects should be retrieved
        type: integer
      pageSize:
        description: The number of objects to retrieve. Possible range 1 ≤ value ≤ 50. If omitted or value < 1 - will be set to 25. If a value > 50 provided – will be set to 50
        type: integer
    title: KalturaFilterPager
    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
  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`'
    disc

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