Kaltura
Kaltura social API

The social API from Kaltura — 8 operation(s) for social.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  description: The Kaltura OTT API
  title: Kaltura OTT accessControl social 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: social
paths:
  /service/social/action/UpdateConfiguration:
    post:
      description: Set the user social network’s configuration information
      operationId: social.UpdateConfiguration
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            configuration:
              $ref: '#/definitions/KalturaSocialConfig'
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaSocialConfig'
      tags:
      - social
      x-kaltura-format: post
      x-kaltura-parameters:
      - configuration
  /service/social/action/get:
    post:
      description: List social accounts
      operationId: social.get
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            type:
              enum:
              - facebook
              type: string
              x-enumLabels:
              - FACEBOOK
              x-enumType: KalturaSocialNetwork
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaSocial'
      tags:
      - social
      x-kaltura-format: post
      x-kaltura-parameters:
      - type
  /service/social/action/getByToken:
    post:
      description: Return the user object with social information according to a provided external social token
      operationId: social.getByToken
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            partnerId:
              type: integer
            token:
              type: string
            type:
              enum:
              - facebook
              type: string
              x-enumLabels:
              - FACEBOOK
              x-enumType: KalturaSocialNetwork
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaSocial'
        x-Errors:
          description: '* `Conflict`: undefined

            * `MinFriendsLimitation`: undefined'
      tags:
      - social
      x-kaltura-format: post
      x-kaltura-parameters:
      - partnerId
      - token
      - type
  /service/social/action/getConfiguration:
    post:
      description: Retrieve the social network’s configuration information
      operationId: social.getConfiguration
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            partnerId:
              type: integer
            type:
              enum:
              - facebook
              type: string
              x-enumLabels:
              - FACEBOOK
              x-enumType: KalturaSocialNetwork
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaSocialConfig'
      tags:
      - social
      x-kaltura-format: post
      x-kaltura-parameters:
      - type
      - partnerId
  /service/social/action/login:
    post:
      description: Login using social token
      operationId: social.login
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            partnerId:
              type: integer
            token:
              type: string
            type:
              enum:
              - facebook
              type: string
              x-enumLabels:
              - FACEBOOK
              x-enumType: KalturaSocialNetwork
            udid:
              type: string
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaLoginResponse'
        x-Errors:
          description: '* `UserDoesNotExist`: undefined'
      tags:
      - social
      x-kaltura-format: post
      x-kaltura-parameters:
      - partnerId
      - token
      - type
      - udid
  /service/social/action/merge:
    post:
      description: Connect an existing user in the system to an external social network user
      operationId: social.merge
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            token:
              type: string
            type:
              enum:
              - facebook
              type: string
              x-enumLabels:
              - FACEBOOK
              x-enumType: KalturaSocialNetwork
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaSocial'
        x-Errors:
          description: '* `MinFriendsLimitation`: undefined

            * `WrongPasswordOrUserName`: undefined

            * `Conflict`: undefined'
      tags:
      - social
      x-kaltura-format: post
      x-kaltura-parameters:
      - token
      - type
  /service/social/action/register:
    post:
      description: Create a new user in the system using a provided external social token
      operationId: social.register
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            email:
              type: string
            partnerId:
              type: integer
            token:
              type: string
            type:
              enum:
              - facebook
              type: string
              x-enumLabels:
              - FACEBOOK
              x-enumType: KalturaSocialNetwork
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaSocial'
        x-Errors:
          description: '* `Conflict`: undefined

            * `MinFriendsLimitation`: undefined'
      tags:
      - social
      x-kaltura-format: post
      x-kaltura-parameters:
      - partnerId
      - token
      - type
      - email
  /service/social/action/unmerge:
    post:
      description: Disconnect an existing user in the system from its external social network user
      operationId: social.unmerge
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            type:
              enum:
              - facebook
              type: string
              x-enumLabels:
              - FACEBOOK
              x-enumType: KalturaSocialNetwork
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaSocial'
        x-Errors:
          description: '* `MinFriendsLimitation`: undefined

            * `WrongPasswordOrUserName`: undefined

            * `Conflict`: undefined'
      tags:
      - social
      x-kaltura-format: post
      x-kaltura-parameters:
      - type
definitions:
  KalturaLongValue:
    allOf:
    - $ref: '#/definitions/KalturaValue'
    description: A string representation to return an array of longs
    properties:
      value:
        description: Value
        type: integer
    title: KalturaLongValue
    type: object
  KalturaOTTUser:
    allOf:
    - $ref: '#/definitions/KalturaBaseOTTUser'
    description: User
    properties:
      address:
        description: Address
        type: string
      affiliateCode:
        description: '`insertOnly`


          Affiliate code'
        type: string
      city:
        description: City
        type: string
      countryId:
        description: Country identifier
        type: integer
      dynamicData:
        items:
          $ref: '#/definitions/KalturaStringValue'
        type: array
      email:
        description: Email
        type: string
      externalId:
        description: External user identifier
        type: string
      householdId:
        description: '`readOnly`


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


          Is the user the household master'
        readOnly: true
        type: boolean
      phone:
        description: Phone
        type: string
      suspensionState:
        description: '`readOnly`


          Enum Type: `KalturaHouseholdSuspensionState`


          Suspension state'
        enum:
        - NOT_SUSPENDED
        - SUSPENDED
        readOnly: true
        type: string
        x-enumLabels:
        - NOT_SUSPENDED
        - SUSPENDED
        x-enumType: KalturaHouseholdSuspensionState
      userState:
        description: '`readOnly`


          Enum Type: `KalturaUserState`


          User state'
        enum:
        - ok
        - user_with_no_household
        - user_created_with_no_role
        - user_not_activated
        readOnly: true
        type: string
        x-enumLabels:
        - OK
        - USER_WITH_NO_HOUSEHOLD
        - USER_CREATED_WITH_NO_ROLE
        - USER_NOT_ACTIVATED
        x-enumType: KalturaUserState
      userType:
        $ref: '#/definitions/KalturaOTTUserType'
      zip:
        description: Zip code
        type: string
    title: KalturaOTTUser
    type: object
  KalturaSocialConfig:
    description: Returns social configuration for the partner
    properties: {}
    title: KalturaSocialConfig
    type: object
  KalturaOTTUserType:
    description: User type
    properties:
      description:
        description: User type description
        type: string
      id:
        description: '`readOnly`


          User type identifier'
        readOnly: true
        type: integer
    title: KalturaOTTUserType
    type: object
  KalturaIntegerValue:
    allOf:
    - $ref: '#/definitions/KalturaValue'
    description: A string representation to return an array of ints
    properties:
      value:
        description: Value
        type: integer
    title: KalturaIntegerValue
    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
  KalturaLoginResponse:
    properties:
      loginSession:
        $ref: '#/definitions/KalturaLoginSession'
      user:
        $ref: '#/definitions/KalturaOTTUser'
    title: KalturaLoginResponse
    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
  KalturaMultilingualStringValue:
    allOf:
    - $ref: '#/definitions/KalturaValue'
    description: Array of translated strings
    properties:
      multilingualValue:
        items:
          $ref: '#/definitions/KalturaTranslationToken'
        type: array
      value:
        description: Value
        type: string
    title: KalturaMultilingualStringValue
    type: object
  KalturaLoginSession:
    description: Login response
    properties:
      ks:
        description: Access token in a KS format
        type: string
    title: KalturaLoginSession
    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
  KalturaFacebookSocial:
    allOf:
    - $ref: '#/definitions/KalturaSocial'
    properties: {}
    title: KalturaFacebookSocial
    type: object
  KalturaStringValue:
    allOf:
    - $ref: '#/definitions/KalturaValue'
    description: A string representation to return an array of strings
    properties:
      value:
        description: Value
        type: string
    title: KalturaStringValue
    type: object
  OTTRequest:
    properties:
      ks:
        type: string
      version:
        default: 3.6.287.20720
        type: string
    type: object
  KalturaTranslationToken:
    description: Container for translation
    properties:
      language:
        description: Language code
        type: string
      value:
        description: Translated value
        type: string
    title: KalturaTranslationToken
    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
  KalturaSocial:
    description: '`abstract`'
    discriminator: objectType
    oneOf:
    - $ref: '#/definitions/KalturaFacebookSocial'
    properties:
      birthday:
        description: User birthday
        type: string
      email:
        description: User email
        type: string
      firstName:
        description: First name
        type: string
      gender:
        description: Gender
        type: string
      id:
        description: '`readOnly`


          Facebook identifier'
        readOnly: true
        type: string
      lastName:
        description: Last name
        type: string
      name:
        description: Full name
        type: string
      objectType:
        enum:
        - KalturaFacebookSocial
        type: string
      pictureUrl:
        description: Profile picture URL
        type: string
      status:
        description: "`readOnly`\n\nUser model status\r\n            Possible values: UNKNOWN, OK, ERROR, NOACTION, NOTEXIST, CONFLICT, MERGE, MERGEOK, NEWUSER, MINFRIENDS, INVITEOK, INVITEERROR, ACCESSDENIED, WRONGPASSWORDORUSERNAME, UNMERGEOK, USEREMAILISMISSING"
        readOnly: true
        type: string
      userId:
        description: '`readOnly`


          User identifier'
        readOnly: true
        type: string
    title: KalturaSocial
    type: object
securityDefinitions:
  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:
    -

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

Documentation

Specifications

Other Resources

OpenAPI Specification
