Kaltura household API

openapi: 3.2.0
info:
  description: The Kaltura OTT API
  title: Kaltura OTT accessControl Household API
  version: 3.6.287.20720
servers:
- url: https://tvpapi-us-preprod.ott.kaltura.com/api_v3
- url: http://tvpapi-us-preprod.ott.kaltura.com/api_v3
security:
- ks: []
tags:
- name: household
paths:
  /service/household/action/add:
    post:
      description: Creates a household for the user
      operationId: household.add
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KalturaHousehold'
            text/xml:
              schema:
                $ref: '#/components/schemas/KalturaHousehold'
        x-Errors:
          description: '* `DomainNotExists`: undefined

            * `HouseholdUserFailed`: undefined'
      tags:
      - household
      x-kaltura-format: post
      x-kaltura-parameters:
      - household
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OTTRequest'
              properties:
                household:
                  $ref: '#/components/schemas/KalturaHousehold'
              type: object
  /service/household/action/delete:
    post:
      description: Fully delete a household. Delete all of the household information, including users, devices, entitlements, payment methods and notification date.
      operationId: household.delete
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: boolean
            text/xml:
              schema:
                type: boolean
        x-Errors:
          description: '* `DomainNotExists`: undefined'
      tags:
      - household
      x-kaltura-format: post
      x-kaltura-parameters:
      - id
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OTTRequest'
              properties:
                id:
                  type: integer
              type: object
  /service/household/action/get:
    post:
      description: Returns the household model
      operationId: household.get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KalturaHousehold'
            text/xml:
              schema:
                $ref: '#/components/schemas/KalturaHousehold'
        x-Errors:
          description: '* `HouseholdUserFailed`: undefined

            * `DomainNotExists`: undefined'
      tags:
      - household
      x-kaltura-format: post
      x-kaltura-parameters:
      - id
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OTTRequest'
              properties:
                id:
                  type: integer
              type: object
  /service/household/action/purge:
    post:
      description: Purge a household. Delete all of the household information, including users, devices, entitlements, payment methods and notification date.
      operationId: household.purge
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: boolean
            text/xml:
              schema:
                type: boolean
        x-Errors:
          description: '* `DomainNotExists`: undefined'
      tags:
      - household
      x-kaltura-format: post
      x-kaltura-parameters:
      - id
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OTTRequest'
              properties:
                id:
                  type: integer
              type: object
  /service/household/action/resetFrequency:
    post:
      description: Reset a household’s time limitation for removing user or device
      operationId: household.resetFrequency
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KalturaHousehold'
            text/xml:
              schema:
                $ref: '#/components/schemas/KalturaHousehold'
      tags:
      - household
      x-kaltura-format: post
      x-kaltura-parameters:
      - frequencyType
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OTTRequest'
              properties:
                frequencyType:
                  enum:
                  - devices
                  - users
                  type: string
                  x-enumLabels:
                  - DEVICES
                  - USERS
                  x-enumType: KalturaHouseholdFrequencyType
              type: object
  /service/household/action/resume:
    post:
      description: Resumed a given household service to its previous service settings
      operationId: household.resume
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: boolean
            text/xml:
              schema:
                type: boolean
        x-Errors:
          description: '* `DomainAlreadyActive`: undefined'
      tags:
      - household
      x-kaltura-format: post
      x-kaltura-parameters: []
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OTTRequest'
              properties: {}
              type: object
  /service/household/action/suspend:
    post:
      description: Suspend a given household service. Sets the household status to “suspended".The household service settings are maintained for later resume
      operationId: household.suspend
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: boolean
            text/xml:
              schema:
                type: boolean
        x-Errors:
          description: '* `DomainAlreadySuspended`: undefined'
      tags:
      - household
      x-kaltura-format: post
      x-kaltura-parameters:
      - roleId
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OTTRequest'
              properties:
                roleId:
                  type: integer
              type: object
  /service/household/action/update:
    post:
      description: Update the household name and description
      operationId: household.update
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KalturaHousehold'
            text/xml:
              schema:
                $ref: '#/components/schemas/KalturaHousehold'
      tags:
      - household
      x-kaltura-format: post
      x-kaltura-parameters:
      - household
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OTTRequest'
              properties:
                household:
                  $ref: '#/components/schemas/KalturaHousehold'
              type: object
components:
  schemas:
    KalturaHousehold:
      description: Household details
      properties:
        concurrentLimit:
          description: '`readOnly`


            The max number of concurrent streams in the household'
          readOnly: true
          type: integer
        description:
          description: Household description
          type: string
        devicesLimit:
          description: '`readOnly`


            The max number of the devices that can be added to the household'
          readOnly: true
          type: integer
        externalId:
          description: '`insertOnly`


            Household external identifier'
          type: string
        frequencyNextDeviceAction:
          description: '`readOnly`


            The next time a device is allowed to be removed from the household (epoch)'
          readOnly: true
          type: integer
        frequencyNextUserAction:
          description: '`readOnly`


            The next time a user is allowed to be removed from the household (epoch)'
          readOnly: true
          type: integer
        householdLimitationsId:
          description: '`readOnly`


            Household limitation module identifier'
          readOnly: true
          type: integer
        id:
          description: '`readOnly`


            Household identifier'
          readOnly: true
          type: integer
        isFrequencyEnabled:
          description: '`readOnly`


            Is household frequency enabled'
          readOnly: true
          type: boolean
        name:
          description: Household name
          type: string
        regionId:
          description: '`readOnly`


            The households region identifier'
          readOnly: true
          type: integer
        restriction:
          description: '`readOnly`


            Enum Type: `KalturaHouseholdRestriction`


            Household restriction'
          enum:
          - not_restricted
          - user_master_restricted
          - device_master_restricted
          - device_user_master_restricted
          readOnly: true
          type: string
          x-enumLabels:
          - NOT_RESTRICTED
          - USER_MASTER_RESTRICTED
          - DEVICE_MASTER_RESTRICTED
          - DEVICE_USER_MASTER_RESTRICTED
          x-enumType: KalturaHouseholdRestriction
        roleId:
          description: '`readOnly`


            suspended roleId'
          readOnly: true
          type: integer
        state:
          description: '`readOnly`


            Enum Type: `KalturaHouseholdState`


            Household state'
          enum:
          - ok
          - created_without_npvr_account
          - suspended
          - no_users_in_household
          - pending
          readOnly: true
          type: string
          x-enumLabels:
          - OK
          - CREATED_WITHOUT_NPVR_ACCOUNT
          - SUSPENDED
          - NO_USERS_IN_HOUSEHOLD
          - PENDING
          x-enumType: KalturaHouseholdState
        usersLimit:
          description: '`readOnly`


            The max number of the users that can be added to the household'
          readOnly: true
          type: integer
      title: KalturaHousehold
      type: object
    OTTRequest:
      properties:
        ks:
          type: string
        version:
          default: 3.6.287.20720
          type: string
      type: object
  securitySchemes:
    ks:
      description: A Kaltura session ID
      in: body
      name: ks
      type: apiKey
x-enums:
  KalturaAdsPolicy:
    oneOf:
    - enum:
      - NO_ADS
      title: NO_ADS
    - enum:
      - KEEP_ADS
      title: KEEP_ADS
    title: KalturaAdsPolicy
  KalturaAggregationCountOrderBy:
    oneOf:
    - enum:
      - NONE
      title: NONE
    title: KalturaAggregationCountOrderBy
  KalturaAnnouncementOrderBy:
    oneOf:
    - enum:
      - NONE
      title: NONE
    title: KalturaAnnouncementOrderBy
  KalturaAnnouncementRecipientsType:
    oneOf:
    - enum:
      - All
      title: ALL
    - enum:
      - LoggedIn
      title: LOGGEDIN
    - enum:
      - Guests
      title: GUESTS
    - enum:
      - Other
      title: OTHER
    title: KalturaAnnouncementRecipientsType
  KalturaAnnouncementStatus:
    oneOf:
    - enum:
      - NotSent
      title: NOTSENT
    - enum:
      - Sending
      title: SENDING
    - enum:
      - Sent
      title: SENT
    - enum:
      - Aborted
      title: ABORTED
    title: KalturaAnnouncementStatus
  KalturaApiParameterPermissionItemAction:
    oneOf:
    - enum:
      - READ
      title: READ
    - enum:
      - INSERT
      title: INSERT
    - enum:
      - UPDATE
      title: UPDATE
    - enum:
      - USAGE
      title: USAGE
    title: KalturaApiParameterPermissionItemAction
  KalturaAppTokenHashType:
    oneOf:
    - enum:
      - SHA1
      title: SHA1
    - enum:
      - SHA256
      title: SHA256
    - enum:
      - SHA512
      title: SHA512
    - enum:
      - MD5
      title: MD5
    title: KalturaAppTokenHashType
  KalturaAssetCommentOrderBy:
    oneOf:
    - enum:
      - CREATE_DATE_DESC
      title: CREATE_DATE_DESC
    title: KalturaAssetCommentOrderBy
  KalturaAssetHistoryOrderBy:
    oneOf:
    - enum:
      - NONE
      title: NONE
    title: KalturaAssetHistoryOrderBy
  KalturaAssetOrderBy:
    oneOf:
    - enum:
      - RELEVANCY_DESC
      title: RELEVANCY_DESC
    - enum:
      - NAME_ASC
      title: NAME_ASC
    - enum:
      - NAME_DESC
      title: NAME_DESC
    - enum:
      - VIEWS_DESC
      title: VIEWS_DESC
    - enum:
      - RATINGS_DESC
      title: RATINGS_DESC
    - enum:
      - VOTES_DESC
      title: VOTES_DESC
    - enum:
      - START_DATE_DESC
      title: START_DATE_DESC
    - enum:
      - START_DATE_ASC
      title: START_DATE_ASC
    - enum:
      - LIKES_DESC
      title: LIKES_DESC
    - enum:
      - CREATE_DATE_ASC
      title: CREATE_DATE_ASC
    - enum:
      - CREATE_DATE_DESC
      title: CREATE_DATE_DESC
    title: KalturaAssetOrderBy
  KalturaAssetReferenceType:
    oneOf:
    - enum:
      - media
      title: MEDIA
    - enum:
      - epg_internal
      title: EPG_INTERNAL
    - enum:
      - epg_external
      title: EPG_EXTERNAL
    title: KalturaAssetReferenceType
  KalturaAssetReminderOrderBy:
    oneOf:
    - enum:
      - RELEVANCY_DESC
      title: RELEVANCY_DESC
    - enum:
      - NAME_ASC
      title: NAME_ASC
    - enum:
      - NAME_DESC
      title: NAME_DESC
    - enum:
      - VIEWS_DESC
      title: VIEWS_DESC
    - enum:
      - RATINGS_DESC
      title: RATINGS_DESC
    - enum:
      - VOTES_DESC
      title: VOTES_DESC
    - enum:
      - START_DATE_DESC
      title: START_DATE_DESC
    - enum:
      - START_DATE_ASC
      title: START_DATE_ASC
    - enum:
      - LIKES_DESC
      title: LIKES_DESC
    title: KalturaAssetReminderOrderBy
  KalturaAssetStructOrderBy:
    oneOf:
    - enum:
      - NAME_ASC
      title: NAME_ASC
    - enum:
      - NAME_DESC
      title: NAME_DESC
    - enum:
      - SYSTEM_NAME_ASC
      title: SYSTEM_NAME_ASC
    - enum:
      - SYSTEM_NAME_DESC
      title: SYSTEM_NAME_DESC
    - enum:
      - CREATE_DATE_ASC
      title: CREATE_DATE_ASC
    - enum:
      - CREATE_DATE_DESC
      title: CREATE_DATE_DESC
    - enum:
      - UPDATE_DATE_ASC
      title: UPDATE_DATE_ASC
    - enum:
      - UPDATE_DATE_DESC
      title: UPDATE_DATE_DESC
    title: KalturaAssetStructOrderBy
  KalturaAssetType:
    oneOf:
    - enum:
      - media
      title: MEDIA
    - enum:
      - recording
      title: RECORDING
    - enum:
      - epg
      title: EPG
    title: KalturaAssetType
  KalturaBillingAction:
    oneOf:
    - enum:
      - unknown
      title: UNKNOWN
    - enum:
      - purchase
      title: PURCHASE
    - enum:
      - renew_payment
      title: RENEW_PAYMENT
    - enum:
      - renew_canceled_subscription
      title: RENEW_CANCELED_SUBSCRIPTION
    - enum:
      - cancel_subscription_order
      title: CANCEL_SUBSCRIPTION_ORDER
    - enum:
      - subscription_date_changed
      title: SUBSCRIPTION_DATE_CHANGED
    title: KalturaBillingAction
  KalturaBillingItemsType:
    oneOf:
    - enum:
      - unknown
      title: UNKNOWN
    - enum:
      - ppv
      title: PPV
    - enum:
      - subscription
      title: SUBSCRIPTION
    - enum:
      - pre_paid
      title: PRE_PAID
    - enum:
      - pre_paid_expired
      title: PRE_PAID_EXPIRED
    - enum:
      - collection
      title: COLLECTION
    title: KalturaBillingItemsType
  KalturaBillingPriceType:
    oneOf:
    - enum:
      - FullPeriod
      title: FULLPERIOD
    - enum:
      - PartialPeriod
      title: PARTIALPERIOD
    title: KalturaBillingPriceType
  KalturaBookmarkActionType:
    oneOf:
    - enum:
      - HIT
      title: HIT
    - enum:
      - PLAY
      title: PLAY
    - enum:
      - STOP
      title: STOP
    - enum:
      - PAUSE
      title: PAUSE
    - enum:
      - FIRST_PLAY
      title: FIRST_PLAY
    - enum:
      - SWOOSH
      title: SWOOSH
    - enum:
      - FULL_SCREEN
      title: FULL_SCREEN
    - enum:
      - SEND_TO_FRIEND
      title: SEND_TO_FRIEND
    - enum:
      - LOAD
      title: LOAD
    - enum:
      - FULL_SCREEN_EXIT
      title: FULL_SCREEN_EXIT
    - enum:
      - FINISH
      title: FINISH
    - enum:
      - ERROR
      title: ERROR
    - enum:
      - BITRATE_CHANGE
      title: BITRATE_CHANGE
    - enum:
      - NONE
      title: NONE
    title: KalturaBookmarkActionType
  KalturaBookmarkOrderBy:
    oneOf:
    - enum:
      - POSITION_ASC
      title: POSITION_ASC
    - enum:
      - POSITION_DESC
      title: POSITION_DESC
    title: KalturaBookmarkOrderBy
  KalturaBundleType:
    oneOf:
    - enum:
      - subscription
      title: SUBSCRIPTION
    - enum:
      - collection
      title: COLLECTION
    title: KalturaBundleType
  KalturaCatalogReferenceBy:
    oneOf:
    - enum:
      - MEDIA
      title: MEDIA
    - enum:
      - EPG_INTERNAL
      title: EPG_INTERNAL
    - enum:
      - EPG_EXTERNAL
      title: EPG_EXTERNAL
    title: KalturaCatalogReferenceBy
  KalturaCatalogWith:
    oneOf:
    - enum:
      - images
      title: IMAGES
    - enum:
      - files
      title: FILES
    - enum:
      - stats
      title: STATS
    title: KalturaCatalogWith
  KalturaChannelEnrichment:
    oneOf:
    - enum:
      - ClientLocation
      title: CLIENTLOCATION
    - enum:
      - UserId
      title: USERID
    - enum:
      - HouseholdId
      title: HOUSEHOLDID
    - enum:
      - DeviceId
      title: DEVICEID
    - enum:
      - DeviceType
      title: DEVICETYPE
    - enum:
      - UTCOffset
      title: UTCOFFSET
    - enum:
      - Language
      title: LANGUAGE
    - enum:
      - NPVRSupport
      title: NPVRSUPPORT
    - enum:
      - Catchup
      title: CATCHUP
    - enum:
      - Parental
      title: PARENTAL
    - enum:
      - DTTRegion
      title: DTTREGION
    - enum:
      - AtHome
      title: ATHOME
    title: KalturaChannelEnrichment
  KalturaChannelOrderBy:
    oneOf:
    - enum:
      - ORDER_NUM
      title: ORDER_NUM
    - enum:
      - RELEVANCY_DESC
      title: RELEVANCY_DESC
    - enum:
      - NAME_ASC
      title: NAME_ASC
    - enum:
      - NAME_DESC
      title: NAME_DESC
    - enum:
      - VIEWS_DESC
      title: VIEWS_DESC
    - enum:
      - RATINGS_DESC
      title: RATINGS_DESC
    - enum:
      - VOTES_DESC
      title: VOTES_DESC
    - enum:
      - START_DATE_DESC
      title: START_DATE_DESC
    - enum:
      - START_DATE_ASC
      title: START_DATE_ASC
    - enum:
      - LIKES_DESC
      title: LIKES_DESC
    - enum:
      - CREATE_DATE_ASC
      title: CREATE_DATE_ASC
    - enum:
      - CREATE_DATE_DESC
      title: CREATE_DATE_DESC
    title: KalturaChannelOrderBy
  KalturaChannelsOrderBy:
    oneOf:
    - enum:
      - NONE
      title: NONE
    - enum:
      - NAME_ASC
      title: NAME_ASC
    - enum:
      - NAME_DESC
      title: NAME_DESC
    - enum:
      - CREATE_DATE_ASC
      title: CREATE_DATE_ASC
    - enum:
      - CREATE_DATE_DESC
      title: CREATE_DATE_DESC
    title: KalturaChannelsOrderBy
  KalturaCollectionOrderBy:
    oneOf:
    - enum:
      - NONE
      title: NONE
    title: KalturaCollectionOrderBy
  KalturaCompensationType:
    oneOf:
    - enum:
      - PERCENTAGE
      title: PERCENTAGE
    - enum:
      - FIXED_AMOUNT
      title: FIXED_AMOUNT
    title: KalturaCompensationType
  KalturaConfigurationGroupDeviceOrderBy:
    oneOf:
    - enum:
      - NONE
      title: NONE
    title: KalturaConfigurationGroupDeviceOrderBy
  KalturaConfigurationGroupTagOrderBy:
    oneOf:
    - enum:
      - NONE
      title: NONE
    title: KalturaConfigurationGroupTagOrderBy
  KalturaConfigurationsOrderBy:
    oneOf:
    - enum:
      - NONE
      title: NONE
    title: KalturaConfigurationsOrderBy
  KalturaContextType:
    oneOf:
    - enum:
      - none
      title: NONE
    - enum:
      - recording
      title: RECORDING
    title: KalturaContextType
  KalturaCountryOrderBy:
    oneOf:
    - enum:
      - NAME_ASC
      title: NAME_ASC
    title: KalturaCountryOrderBy
  KalturaCouponGroupType:
    oneOf:
    - enum:
      - COUPON
      title: COUPON
    - enum:
      - GIFT_CARD
      title: GIFT_CARD
    title: KalturaCouponGroupType
  KalturaCouponStatus:
    oneOf:
    - enum:
      - VALID
      title: VALID
    - enum:
      - NOT_EXISTS
      title: NOT_EXISTS
    - enum:
      - ALREADY_USED
      title: ALREADY_USED
    - enum:
      - EXPIRED
      title: EXPIRED
    - enum:
      - INACTIVE
      title: INACTIVE
    title: KalturaCouponStatus
  KalturaCurrencyOrderBy:
    oneOf:
    - enum:
      - NAME_ASC
      title: NAME_ASC
    - enum:
      - NAME_DESC
      title: NAME_DESC
    - enum:
      - CODE_ASC
      title: CODE_ASC
    - enum:
      - CODE_DESC
      title: CODE_DESC
    title: KalturaCurrencyOrderBy
  KalturaCutWith:
    oneOf:
    - enum:
      - or
      title: OR
    - enum:
      - and
      title: AND
    title: KalturaCutWith
  KalturaDeviceRegistrationStatus:
    oneOf:
    - enum:
      - not_registered
      title: NOT_REGISTERED
    - enum:
      - registered
      title: REGISTERED
    - enum:
      - registered_to_another_household
      title: REGISTERED_TO_ANOTHER_HOUSEHOLD
    title: KalturaDeviceRegistrationStatus
  KalturaDeviceStatus:
    oneOf:
    - enum:
      - PENDING
      title: PENDING
    - enum:
      - ACTIVATED
      title: ACTIVATED
    - enum:
      - NOT_ACTIVATED
      title: NOT_ACTIVATED
    title: KalturaDeviceStatus
  KalturaDrmSchemeName:
    oneOf:
    - enum:
      - PLAYREADY_CENC
      title: PLAYREADY_CENC
    - enum:
      - WIDEVINE_CENC
      title: WIDEVINE_CENC
    - enum:
      - FAIRPLAY
      title: FAIRPLAY
    - enum:
      - WIDEVINE
      title: WIDEVINE
    - enum:
      - PLAYREADY
      title: PLAYREADY
    - enum:
      - CUSTOM_DRM
      title: CUSTOM_DRM
    title: KalturaDrmSchemeName
  KalturaDummyOrderBy:
    oneOf: []
    title: KalturaDummyOrderBy
  KalturaEngagementOrderBy:
    oneOf:
    - enum:
      - NONE
      title: NONE
    title: KalturaEngagementOrderBy
  KalturaEngagementType:
    oneOf:
    - enum:
      - Churn
      title: CHURN
    title: KalturaEngagementType
  KalturaEntitlementOrderBy:
    oneOf:
    - enum:
      - PURCHASE_DATE_ASC
      title: PURCHASE_DATE_ASC
    - enum:
      - PURCHASE_DATE_DESC
      title: PURCHASE_DATE_DESC
    title: KalturaEntitlementOrderBy
  KalturaEntityReferenceBy:
    oneOf:
    - enum:
      - user
      title: USER
    - enum:
      - household
      title: HOUSEHOLD
    title: KalturaEntityReferenceBy
  KalturaExportDataType:
    oneOf:
    - enum:
      - vod
      title: VOD
    - enum:
      - epg
      title: EPG
    - enum:
      - users
      title: USERS
    title: KalturaExportDataType
  KalturaExportTaskOrderBy:
    oneOf:
    - enum:
      - CREATE_DATE_ASC
      title: CREATE_DATE_ASC
    - enum:
      - CREATE_DATE_DESC
      title: CREATE_DATE_DESC
    title: KalturaExportTaskOrderBy
  KalturaExportType:
    oneOf:
    - enum:
      - full
      title: FULL
    - enum:
      - incremental
      title: INCREMENTAL
    title: KalturaExportType
  KalturaFavoriteOrderBy:
    oneOf:
    - enum:
      - CREATE_DATE_ASC
      title: CREATE_DATE_ASC
    - enum:
      - CREATE_DATE_DESC
      title: CREATE_DATE_DESC
    title: KalturaFavoriteOrderBy
  KalturaFollowTvSeriesOrderBy:
    oneOf:
    - enum:
      - START_DATE_DESC
      title: START_DATE_DESC
    - enum:
      - START_DATE_ASC
      title: START_DATE_ASC
    title: KalturaFollowTvSeriesOrderBy
  KalturaGroupByField:
    oneOf:
    - enum:
      - media_type_id
      title: MEDIA_TYPE_ID
    title: KalturaGroupByField
  KalturaHouseholdDeviceOrderBy:
    oneOf:
    - enum:
      - NONE
      title: NONE
    title: KalturaHouseholdDeviceOrderBy
  KalturaHouseholdFrequencyType:
    oneOf:
    - enum:
      - devices
      title: DEVICES
    - enum:
      - users
      title: USERS
    title: KalturaHouseholdFrequencyType
  KalturaHouseholdPaymentGatewaySelectedBy:
    oneOf:
    - enum:
      - none
      title: NONE
    - enum:
      - account
      title: ACCOUNT
    - enum:
      - household
      title: HOUSEHOLD
    title: KalturaHouseholdPaymentGatewaySelectedBy
  KalturaHouseholdRestriction:
    oneOf:
    - enum:
      - not_restricted
      title: NOT_RESTRICTED
    - enum:
      - user_master_restricted
      title: USER_MASTER_RESTRICTED
    - enum:
      - device_master_restricted
      title: DEVICE_MASTER_RESTRICTED
    - enum:
      - device_user_master_restricted
      title: DEVICE_USER_MASTER_RESTRICTED
    title: KalturaHouseholdRestriction
  KalturaHouseholdState:
    oneOf:
    - enum:
      - ok
      title: OK
    - enum:
      - created_without_npvr_account
      title: CREATED_WITHOUT_NPVR_ACCOUNT
    - enum:
      - suspended
      title: SUSPENDED
    - enum:
      - no_users_in_household
      title: NO_USERS_IN_HOUSEHOLD
    - enum:
      - pending
      title: PENDING
    title: KalturaHouseholdState
  KalturaHouseholdSuspensionState:
    oneOf:
    - enum:
      - NOT_SUSPENDED
      title: NOT_SUSPENDED
    - enum:
      - SUSPENDED
      title: SUSPENDED
    title: KalturaHouseholdSuspensionState
  KalturaHouseholdUserOrderBy:
    oneOf:
    - enum:
      - NONE
      title: NONE
    title: KalturaHouseholdUserOrderBy
  KalturaHouseholdUserStatus:
    oneOf:
    - enum:
      - OK
      title: OK
    - enum:
      - PENDING
      title: PENDING
    title: KalturaHouseholdUserStatus
  KalturaHouseholdWith:
    oneOf:
    - enum:
      - users_base_info
      title: USERS_BASE_INFO
    - enum:
      - users_full_info
      title: USERS_FULL_INFO
    title: KalturaHouseholdWith
  KalturaIdentifierTypeBy:
    oneOf:
    - enum:
      - internal_id
      title: INTERNAL_ID
    - enum:
      - external_id
      title: EXTERNAL_ID
    title: KalturaIdentifierTypeBy
  KalturaImageObjectType:
    oneOf:
    - enum:
      - MEDIA_ASSET
      title: MEDIA_ASSET
    - enum:
      - PROGRAM_ASSET
      title: PROGRAM_ASSET
    - enum:
      - CHANNEL
      title: CHANNEL
    - enum:
      - CATEGORY
      title: CATEGORY
    - enum:
      - PARTNER
      title: PARTNER
    - enum:
      - IMAGE_TYPE
      title: IMAGE_TYPE
    title: KalturaImageObjectType
  KalturaImageOrderBy:
    oneOf:
    - enum:
      - NONE
      title: NONE
    title: KalturaImageOrderBy
  KalturaImageStatus:
    oneOf:
    - enum:
      - PENDING
      title: PENDING
    - enum:
      - READY
      title: READY
    - enum:
      - FAILED
      title: FAILED
    title: KalturaImageStatus
  KalturaImageTypeOrderBy:
    oneOf:
    - enum:
      - NONE
      title: NONE
    title: KalturaImageTypeOrderBy
  KalturaInboxMessageOrderBy:
    oneOf:
    - enum:
      - NONE
      title: NONE
    title: KalturaInboxMessageOrderBy
  KalturaInboxMessageStatus:
    oneOf:
    - enum:
      - Unread
      title: UNREAD
    - enum:
      - Read
      title: READ
    - enum:
      - Deleted
      title: DELETED
    title: KalturaInboxMessageStatus
  KalturaInboxMessageType:
    oneOf:
    - enum:
      - SystemAnnouncement
      title: SYSTEMANNOUNCEMENT
    - enum:
      - Followed
      title: FOLLOWED
    - enum:
      - Engagement
      title: ENGAGEMENT
    - enum:
      - Interest
      title: INTEREST
    title: KalturaInboxMessageType
  KalturaLanguageOrderBy:
    oneOf:
    - enum:
      - SYSTEM_NAME_ASC
      title: SYSTEM_NAME_ASC
    - enum:
      - SYSTEM_NAME_DESC
      title: SYSTEM_NAME_DESC
    - enum:
      - CODE_ASC
      title: CODE_ASC
    - enum:
      - CODE_DESC
      title: CODE_DESC
    title: KalturaLanguageOrderBy
  KalturaMediaFileOrderBy:
    oneOf:
    - enum:
      - NONE
      title: NONE
    title: KalturaMediaFileOrderBy
  KalturaMediaFileStreamerType:
    oneOf:
    - enum:
      - APPLE_HTTP
      title: APPLE_HTTP
    - enum:
      - MPEG_DASH
      title: MPEG_DASH
    - enum:
      - URL
      title: URL
    - enum:
      - SMOOTH_STREAMING
      title: SMOOTH_STREAMING
    title: KalturaMediaFileStreamerType
  KalturaMediaFileTypeQuality:
    oneOf:
    - enum:
      - ADAPTIVE
      title: ADAPTIVE
    - enum:
      - SD
      title: SD
    - enum:
      - HD_720
      title: HD_720
    - enum:
      - HD_1080
      title: HD_1080
    - enum:
      - UHD_4K
      title: UHD_4K
    title: KalturaMediaFileTypeQuality
  KalturaMessageTemplateType:
    oneOf:
    - enum:
      - Series
      title: SERIES
    - enum:
      - Reminder
      title: REMINDER
    - enum:
      - Churn
      title: CHURN
    - enum:
      - SeriesReminder
      title: SERIESREMINDER
    - enum:
      - InterestVod
      title: INTERESTVOD
    - enum:
      - InterestEPG
      title: INTERESTEPG
    title: KalturaMessageTemplateType
  KalturaMetaDataType:
    oneOf:
    - enum:
      - STRING
      title: STRING
    - enum:
      - MULTILINGUAL_STRING
      title: MULTILINGUAL_STRING
    - enum:
      - NUMBER
      title: NUMBER
    - enum:
      - BOOLEAN
      title: BOOLEAN
    - enum:
      - DATE
      title: DATE
    title: KalturaMetaDataType
  KalturaMetaFieldName:
    oneOf:
    - enum:
      - NONE
      title: NONE
    - enum:
      - SERIES_ID
      title: SERIES_ID
    - enum:
      - SEASON_NUMBER
      title: SEASON_NUMBER
    - enum:
      - EPISODE_NUMBER
      title: EPISODE_NUMBER
    title: KalturaMetaFieldName
  KalturaMetaOrderBy:
    oneOf:
    - enum:
      - NAME_ASC
      title: NAME_ASC
    - enum:
      - NAME_DESC
      title: NAME_DESC
    - enum:
      - SYSTEM_NAME_ASC
      title: SYSTEM_NAME_ASC
    - enum:
      - SYSTEM_NAME_DESC
      title: SYSTEM_NAME_DESC
    - enum:
      - CREATE_DATE_ASC
      title: CREATE_DATE_ASC
    - enum:
      - CREATE_DATE_DESC
      title: CREATE_DATE_DESC
    - enum:
      - UPDATE_DATE_ASC
      title: UPDATE_DATE_ASC
    - enum:
      - UPDATE_DATE_DESC
      title: UPDATE_DATE_DESC
    title: KalturaMetaOrderBy
  KalturaMetaTagOrderBy:
    oneOf:
    - enum:
      - META_ASC
      title: META_ASC
    - enum:
      - META_DESC
      title: META_DESC
    title: KalturaMetaTagOrderBy
  KalturaMetaType:
    oneOf:
    - enum:
      - STRING
      title: STRING
    - enum:
      - NUMBER
      title: NUMBER
    - enum:
      - BOOLEAN
      title: BOOLEAN
    - enum:
      - STRING_ARRAY
      title: STRING_ARRAY
    title: KalturaMetaType
  KalturaNotificationType:
    oneOf:
    - enum:
      - announcement
      title: ANNOUNCEMENT
    - enum:
      - system
      title: SYSTEM
    - enum:
      - Reminder
      title: REMINDER
    - enum:
      - series_reminder
      title: SERIES_REMINDER
    title: KalturaNotificationType
  KalturaOTTUserOrderBy:
    oneOf:
    - enum:
      - NONE
      title: NONE
    title: KalturaOTTUserOrderBy
  KalturaParentalRuleOrderBy:
    oneOf:
    - enum:
      - PARTNER_SORT_VALUE
      title: PARTNER_SORT_VALUE
    title: KalturaParentalRuleOrderBy
  KalturaParentalRuleType:
    oneOf:
    - enum:
      - ALL
      title: ALL
    - enum:
      - MOVIES
      title: MOVIES
    - enum:
      - TV_SERIES
      title: TV_SERIES
    title: KalturaParentalRuleType
  KalturaPartnerConfigurationType:
    oneOf:
    - enum:
      - DefaultPaymentGateway
      title: DEFAULTPAYMENTGATEWAY
    - enum:
      - EnablePaymentGatewaySelection
      title: ENABLEPAYMENTGATEWAYSELECTION
    - enum:
      - OSSAdapter
      title: OSSADAPTER
    title: KalturaPartnerConfigurationType
  KalturaPaymentMethodProfileOrderBy:
    oneOf:
    - enum:
      - NONE
      title: NONE
    title: KalturaPaymentMethodProfileOrderBy
  KalturaPaymentMethodType:
    oneOf:
    - enum:
      - unknown
      title: UNKNOWN
    - enum:
      - credit_card
      title: CREDIT_CARD
    - enum:
      - sms
      title: SMS
    - enum:
      - pay_pal
      title: PAY_PAL
    - enum:
      - debit_card
      title: DEBIT_CARD
    - enum:
      - ideal
      title: IDEAL
    - enum:
      - incaso
      title: INCASO
    - enum:
      - gift
     

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