Kaltura parentalRule API

The parentalRule API from Kaltura — 4 operation(s) for parentalrule.

OpenAPI Specification

kaltura-parentalrule-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  description: The Kaltura OTT API
  title: Kaltura OTT accessControl parentalRule 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: parentalRule
paths:
  /service/parentalrule/action/disable:
    post:
      description: Disables a parental rule that was previously defined by the household master. Disable can be at specific user or household level.
      operationId: parentalRule.disable
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            entityReference:
              enum:
              - user
              - household
              type: string
              x-enumLabels:
              - USER
              - HOUSEHOLD
              x-enumType: KalturaEntityReferenceBy
            ruleId:
              type: integer
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: boolean
        x-Errors:
          description: '* `DomainNotExists`: undefined

            * `UserDoesNotExist`: undefined

            * `UserWithNoDomain`: undefined

            * `UserSuspended`: undefined

            * `RuleNotExists`: undefined

            * `UserParentalRuleNotExists`: undefined'
      tags:
      - parentalRule
      x-kaltura-format: post
      x-kaltura-parameters:
      - ruleId
      - entityReference
  /service/parentalrule/action/disableDefault:
    post:
      description: Disables a parental rule that was defined at account level. Disable can be at specific user or household level.
      operationId: parentalRule.disableDefault
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            entityReference:
              enum:
              - user
              - household
              type: string
              x-enumLabels:
              - USER
              - HOUSEHOLD
              x-enumType: KalturaEntityReferenceBy
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: boolean
        x-Errors:
          description: '* `UserWithNoDomain`: undefined

            * `UserSuspended`: undefined

            * `DomainNotExists`: undefined

            * `UserDoesNotExist`: undefined'
      tags:
      - parentalRule
      x-kaltura-format: post
      x-kaltura-parameters:
      - entityReference
  /service/parentalrule/action/enable:
    post:
      description: Enable a parental rules for a user
      operationId: parentalRule.enable
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            entityReference:
              enum:
              - user
              - household
              type: string
              x-enumLabels:
              - USER
              - HOUSEHOLD
              x-enumType: KalturaEntityReferenceBy
            ruleId:
              type: integer
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: boolean
        x-Errors:
          description: '* `RuleNotExists`: undefined

            * `DomainNotExists`: undefined

            * `UserDoesNotExist`: undefined

            * `UserSuspended`: undefined

            * `UserWithNoDomain`: undefined'
      tags:
      - parentalRule
      x-kaltura-format: post
      x-kaltura-parameters:
      - ruleId
      - entityReference
  /service/parentalrule/action/list:
    post:
      description: "Return the parental rules that applies for the user or household. Can include rules that have been associated in account, household, or user level.\r\n            Association level is also specified in the response."
      operationId: parentalRule.list
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            filter:
              $ref: '#/definitions/KalturaParentalRuleFilter'
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaParentalRuleListResponse'
        x-Errors:
          description: '* `UserDoesNotExist`: undefined

            * `UserWithNoDomain`: undefined

            * `DomainNotExists`: undefined

            * `UserSuspended`: undefined'
      tags:
      - parentalRule
      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
  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
  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
  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
  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
  KalturaListResponse:
    description: Base list wrapper
    properties:
      totalCount:
        description: Total items
        type: integer
    title: KalturaListResponse
    type: object
  OTTRequest:
    properties:
      ks:
        type: string
      version:
        default: 3.6.287.20720
        type: string
    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
  KalturaBooleanValue:
    allOf:
    - $ref: '#/definitions/KalturaValue'
    description: A string representation to return an array of booleans
    properties:
      value:
        description: Value
        type: boolean
    title: KalturaBooleanValue
    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
  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
  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
  KalturaParentalRule:
    description: Parental rule
    properties:
      blockAnonymousAccess:
        description: Content that correspond to this rule is not available for guests
        type: boolean
      description:
        description: Explanatory description
        type: string
      epgTag:
        description: EPG asset tag ID to in which to look for corresponding trigger values
        type: integer
      epgTagValues:
        items:
          $ref: '#/definitions/KalturaStringValue'
        type: array
      id:
        description: '`readOnly`


          Unique parental rule identifier'
        readOnly: true
        type: integer
      isDefault:
        description: Is the rule the default rule of the account
        type: boolean
      mediaTag:
        description: Media asset tag ID to in which to look for corresponding trigger values
        type: integer
      mediaTagValues:
        items:
          $ref: '#/definitions/KalturaStringValue'
        type: array
      name:
        description: Rule display name
        type: string
      order:
        description: Rule order within the full list of rules
        type: integer
      origin:
        description: 'Enum Type: `KalturaRuleLevel`


          Where was this rule defined account, household or user'
        enum:
        - invalid
        - user
        - household
        - account
        type: string
        x-enumLabels:
        - INVALID
        - USER
        - HOUSEHOLD
        - ACCOUNT
        x-enumType: KalturaRuleLevel
      ruleType:
        description: 'Enum Type: `KalturaParentalRuleType`


          Rule type – Movies, TV series or both'
        enum:
        - ALL
        - MOVIES
        - TV_SERIES
        type: string
        x-enumLabels:
        - ALL
        - MOVIES
        - TV_SERIES
        x-enumType: KalturaParentalRuleType
    title: KalturaParentalRule
    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
  KalturaTopicFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    properties:
      orderBy:
        enum:
        - NONE
        type: string
        x-enumLabels:
        - NONE
        x-enumType: KalturaTopicOrderBy
    title: KalturaTopicFilter
    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
  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: KalturaSocialFriendAc

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