Kaltura

Kaltura householdDevice API

The householdDevice API from Kaltura — 9 operation(s) for householddevice.

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-householddevice-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-householddevice-api-openapi.yml Raw ↑ 
swagger: '2.0'
info:
  description: The Kaltura OTT API
  title: Kaltura OTT accessControl householdDevice 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: householdDevice
paths:
  /service/householddevice/action/add:
    post:
      description: Add device to household
      operationId: householdDevice.add
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            device:
              $ref: '#/definitions/KalturaHouseholdDevice'
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaHouseholdDevice'
        x-Errors:
          description: '* `DomainSuspended`: undefined

            * `DomainNotExists`: undefined

            * `DeviceExistsInOtherDomains`: undefined

            * `NoUsersInDomain`: undefined'
      tags:
      - householdDevice
      x-kaltura-format: post
      x-kaltura-parameters:
      - device
  /service/householddevice/action/addByPin:
    post:
      description: Registers a device to a household using pin code
      operationId: householdDevice.addByPin
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            deviceName:
              type: string
            pin:
              type: string
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaHouseholdDevice'
        x-Errors:
          description: '* `ExceededLimit`: undefined

            * `DuplicatePin`: undefined

            * `DeviceNotExists`: undefined'
      tags:
      - householdDevice
      x-kaltura-format: post
      x-kaltura-parameters:
      - deviceName
      - pin
  /service/householddevice/action/delete:
    post:
      description: Removes a device from household
      operationId: householdDevice.delete
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            udid:
              type: string
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: boolean
        x-Errors:
          description: '* `DeviceNotInDomain`: undefined

            * `DomainSuspended`: undefined

            * `LimitationPeriod`: undefined

            * `DeviceNotExists`: undefined'
      tags:
      - householdDevice
      x-kaltura-format: post
      x-kaltura-parameters:
      - udid
  /service/householddevice/action/generatePin:
    post:
      description: Generates device pin to use when adding a device to household by pin
      operationId: householdDevice.generatePin
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            brandId:
              type: integer
            udid:
              type: string
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaDevicePin'
      tags:
      - householdDevice
      x-kaltura-format: post
      x-kaltura-parameters:
      - udid
      - brandId
  /service/householddevice/action/get:
    post:
      description: Returns device registration status to the supplied household
      operationId: householdDevice.get
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties: {}
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaHouseholdDevice'
        x-Errors:
          description: '* `DeviceExistsInOtherDomains`: undefined

            * `AdapterNotExists`: undefined

            * `AdapterAppFailure`: undefined

            * `DeviceNotExists`: undefined

            * `DeviceNotInDomain`: undefined'
      tags:
      - householdDevice
      x-kaltura-format: post
      x-kaltura-parameters: []
  /service/householddevice/action/list:
    post:
      description: Returns the devices within the household
      operationId: householdDevice.list
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            filter:
              $ref: '#/definitions/KalturaHouseholdDeviceFilter'
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaHouseholdDeviceListResponse'
        x-Errors:
          description: '* `DeviceNotExists`: undefined'
      tags:
      - householdDevice
      x-kaltura-format: post
      x-kaltura-parameters:
      - filter
  /service/householddevice/action/loginWithPin:
    post:
      description: User sign-in via a time-expired sign-in PIN.
      operationId: householdDevice.loginWithPin
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            partnerId:
              type: integer
            pin:
              type: string
            udid:
              type: string
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaLoginResponse'
        x-Errors:
          description: '* `UserNotInDomain`: undefined

            * `WrongPasswordOrUserName`: undefined

            * `PinNotExists`: undefined

            * `PinExpired`: undefined

            * `NoValidPin`: undefined

            * `SecretIsWrong`: undefined

            * `LoginViaPinNotAllowed`: undefined

            * `UserSuspended`: undefined

            * `InsideLockTime`: undefined

            * `UserNotActivated`: undefined

            * `UserAllreadyLoggedIn`: undefined

            * `UserDoubleLogIn`: undefined

            * `DeviceNotRegistered`: undefined

            * `ErrorOnInitUser`: undefined

            * `UserNotMasterApproved`: undefined

            * `UserWithNoDomain`: undefined

            * `UserDoesNotExist`: undefined

            * `DeviceNotExists`: undefined

            * `PinNotExists`: undefined

            * `DeviceNotInDomain`: undefined

            * `DomainNotExists`: undefined

            * `NoValidPin`: undefined'
      tags:
      - householdDevice
      x-kaltura-format: post
      x-kaltura-parameters:
      - partnerId
      - pin
      - udid
  /service/householddevice/action/update:
    post:
      description: Update the name of the device by UDID
      operationId: householdDevice.update
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            device:
              $ref: '#/definitions/KalturaHouseholdDevice'
            udid:
              type: string
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaHouseholdDevice'
        x-Errors:
          description: '* `DeviceNotExists`: undefined'
      tags:
      - householdDevice
      x-kaltura-format: post
      x-kaltura-parameters:
      - udid
      - device
  /service/householddevice/action/updateStatus:
    post:
      description: Update the name of the device by UDID
      operationId: householdDevice.updateStatus
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            status:
              enum:
              - PENDING
              - ACTIVATED
              - NOT_ACTIVATED
              type: string
              x-enumLabels:
              - PENDING
              - ACTIVATED
              - NOT_ACTIVATED
              x-enumType: KalturaDeviceStatus
            udid:
              type: string
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: boolean
        x-Errors:
          description: '* `ExceededLimit`: undefined

            * `LimitationPeriod`: undefined'
      tags:
      - householdDevice
      x-kaltura-format: post
      x-kaltura-parameters:
      - udid
      - status
definitions:
  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
  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
  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
  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
  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
  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
  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
  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
  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
  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
  KalturaPluginData:
    properties: {}
    title: KalturaPluginData
    type: object
  KalturaSeriesRecordingFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    description: Filtering recordings
    properties:
      orderBy:
        enum:
        - START_DATE_ASC
        - START_DATE_DESC
        - ID_ASC
        - ID_DESC
        - SERIES_ID_ASC
        - SERIES_ID_DESC
        type: string
        x-enumLabels:
        - START_DATE_ASC
        - START_DATE_DESC
        - ID_ASC
        - ID_DESC
        - SERIES_ID_ASC
        - SERIES_ID_DESC
        x-enumType: KalturaSeriesRecordingOrderBy
    title: KalturaSeriesRecordingFilter
    type: object
  KalturaMetaFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    description: Meta filter
    properties:
      assetStructIdEqual:
        description: Filter Metas that are contained in a specific asset struct
        type: integer
      dataTypeEqual:
        description: 'Enum Type: `KalturaMetaDataType`


          Meta data type to filter by'
        enum:
        - STRING
        - MULTILINGUAL_STRING
        - NUMBER
        - BOOLEAN
        - DATE
        type: string
        x-enumLabels:
        - STRING
        - MULTILINGUAL_STRING
        - NUMBER
        - BOOLEAN
        - DATE
        x-enumType: KalturaMetaDataType
      idIn:
        description: Comma separated identifiers
        type: string
      multipleValueEqual:
        description: Filter metas by multipleValueEqual value
        type: boolean
      orderBy:
        enum:
        - NAME_ASC
        - NAME_DESC
        - SYSTEM_NAME_ASC
        - SYSTEM_NAME_DESC
        - CREATE_DATE_ASC
        - CREATE_DATE_DESC
        - UPDATE_DATE_ASC
        - UPDATE_DATE_DESC
        type: string
        x-enumLabels:
        - NAME_ASC
        - NAME_DESC
        - SYSTEM_NAME_ASC
        - SYSTEM_NAME_DESC
        - CREATE_DATE_ASC
        - CREATE_DATE_DESC
        - UPDATE_DATE_ASC
        - UPDATE_DATE_DESC
        x-enumType: KalturaMetaOrderBy
    title: KalturaMetaFilter
    type: object
  KalturaChannelsFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    properties:
      idEqual:
        description: channel identifier to filter by
        type: integer
      nameEqual:
        description: Exact channel name to filter by
        type: string
      nameStartsWith:
        description: Channel name starts with (autocomplete)
        type: string
      orderBy:
        enum:
        - NONE
        - NAME_ASC
        - NAME_DESC
        - CREATE_DATE_ASC
        - CREATE_DATE_DESC
        type: string
        x-enumLabels:
        - NONE
        - NAME_ASC
        - NAME_DESC
        - CREATE_DATE_ASC
        - CREATE_DATE_DESC
        x-enumType: KalturaChannelsOrderBy
    title: KalturaChannelsFilter
    type: object
  KalturaAssetStructFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    description: Filtering Asset Structs
    properties:
      idIn:
        description: Comma separated identifiers
        type: string
      isProtectedEqual:
        description: Filter Asset Structs by isProtectedEqual value
        type: boolean
      metaIdEqual:
        description: Filter Asset Structs that contain a specific meta id
        type: integer
      orderBy:
        enum:
        - NAME_ASC
        - NAME_DESC
        - SYSTEM_NAME_ASC
        - SYSTEM_NAME_DESC
        - CREATE_DATE_ASC
        - CREATE_DATE_DESC
        - UPDATE_DATE_ASC
        - UPDATE_DATE_DESC
        type: string
        x-enumLabels:
        - NAME_ASC
        - NAME_DESC
        - SYSTEM_NAME_ASC
        - SYSTEM_NAME_DESC
        - CREATE_DATE_ASC
        - CREATE_DATE_DESC
        - UPDATE_DATE_ASC
        - UPDATE_DATE_DESC
        x-enumType: KalturaAssetStructOrderBy
    title: KalturaAssetStructFilter
    type: object
  KalturaHouseholdDevice:
    description: Device details
    properties:
      activatedOn:
        description: Device activation date (epoch)
        type: integer
      brandId:
        description: Device brand identifier
        type: integer
      deviceFamilyId:
        description: '`readOnly`


          Device family id'
        readOnly: true
        type: integer
      drm:
        $ref: '#/definitions/KalturaCustomDrmPlaybackPluginData'
      householdId:
        description: Household identifier
        type: integer
      name:
        description: Device name
        type: string
      status:
        description: '`readOnly`


          Enum Type: `KalturaDeviceStatus`


          Device state'
        enum:
        - PENDING
        - ACTIVATED
        - NOT_ACTIVATED
        readOnly: true
        type: string
        x-enumLabels:
        - PENDING
        - ACTIVATED
        - NOT_ACTIVATED
        x-enumType: KalturaDeviceStatus
      udid:
        description: '`insertOnly`


          Device UDID'
        type: string
    title: KalturaHouseholdDevice
    type: object
  KalturaHouseholdUserFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    properties:
      householdIdEqual:
        description: The identifier of the household
        type: integer
      orderBy:
        enum:
        - NONE
        type: string
        x-enumLabels:
        - NONE
        x-enumType: KalturaHouseholdUserOrderBy
    title: KalturaHouseholdUserFilter
    type: object
  KalturaDynamicOrderBy:
    description: Kaltura Asset Order
    properties:
      name:
        description: order by name
        type: string
      orderBy:
        description: 'Enum Type: `KalturaMetaTagOrderBy`


          order by meta asc/desc'
        enum:
        - META_ASC
        - META_DESC
        type: string
        x-enumLabels:
        - META_ASC
        - META_DESC
        x-enumType: KalturaMetaTagOrderBy
    title: KalturaDynamicOrderBy
    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
  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
  KalturaBaseOTTUser:
    description: Slim user data
    properties:
      firstName:
        description: First name
        type: string
      id:
        description: '`readOnly`


          User identifier'
        readOnly: true
        type: string
      lastName:
        description: Last name
        type: string
      username:
        description: Username
        type: string
    title: KalturaBaseOTTUser
    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
  KalturaDrmPlaybackPluginData:
    allOf:
    - $ref: '#/definitions/KalturaPluginData'
    properties:
      licenseURL:
        description: License URL
        type: string
      scheme:
        description: 'Enum Type: `KalturaDrmSchemeName`


          Scheme'
        enum:
        - PLAYREADY_CENC
        - WIDEVINE_CENC
        - FAIRPLAY
        - WIDEVINE
        - PLAYREADY
        - CUSTOM_DRM
        type: string
        x-enumLabels:
        - PLAYREADY_CENC
        - WIDEVINE_CENC
        - FAIRPLAY
        - WIDEVINE
        - PLAYREADY
        - CUSTOM_DRM
        x-enumType: KalturaDrmSchemeName
    title: KalturaDrmPlaybackPluginData
    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
  KalturaAnnouncementFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    description: order announcements
    properties:
      orderBy:
        enum:
        - NONE
        type: string
        x-enumLabels:
        - NONE
        x-enumType: KalturaAnnouncementOrderBy
    title: KalturaAnnouncementFilter
    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
  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
  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
  KalturaDeviceReportFilter:
    allOf:
    - $ref: '#/definitions/KalturaReportFilter'
    description: Report filter
    properties:
      lastAccessDateGreaterThanOrEqual:
        description: Filter device configuration later than specific date
        type: integer
    title: KalturaDeviceReportFilter
    type: object
  KalturaUserAssetRuleFilter:
    allOf:
    - $ref: '#/definitions/KalturaFilter'
    description: User asset rule filter
    properties:
      assetIdEqual:
        description: Asset identifier to filter by
        type: integer
  

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