Kaltura transaction API

The transaction API from Kaltura — 7 operation(s) for transaction.

OpenAPI Specification

kaltura-transaction-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  description: The Kaltura OTT API
  title: Kaltura OTT accessControl transaction 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: transaction
paths:
  /service/transaction/action/downgrade:
    post:
      description: downgrade specific subscription for a household. entitlements will be updated on the existing subscription end date.
      operationId: transaction.downgrade
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            purchase:
              $ref: '#/definitions/KalturaPurchase'
          type: object
      responses:
        '200':
          description: Success
        x-Errors:
          description: '* `NotForPurchase`: undefined

            * `UserNotInDomain`: undefined

            * `InvalidUser`: undefined

            * `UserDoesNotExist`: undefined

            * `UserSuspended`: undefined

            * `CouponNotValid`: undefined

            * `UnableToPurchasePPVPurchased`: undefined

            * `UnableToPurchaseFree`: undefined

            * `UnableToPurchaseForPurchaseSubscriptionOnly`: undefined

            * `UnableToPurchaseSubscriptionPurchased`: undefined

            * `PaymentGatewayChargeIdRequired`: undefined

            * `UnableToPurchaseCollectionPurchased`: undefined

            * `AdapterUrlRequired`: undefined

            * `IncorrectPrice`: undefined

            * `UnKnownPPVModule`: undefined

            * `PaymentGatewayNotSetForHousehold`: undefined

            * `PaymentGatewayNotExist`: undefined

            * `PaymentMethodNotSetForHousehold`: undefined

            * `SignatureMismatch`: undefined

            * `UnknownTransactionState`: undefined

            * `NoConfigurationFound`: undefined

            * `PaymentMethodNotExist`: undefined

            * `SubscriptionNotRenewable`: undefined'
      tags:
      - transaction
      x-kaltura-format: post
      x-kaltura-parameters:
      - purchase
  /service/transaction/action/getPurchaseSessionId:
    post:
      description: Retrieve the purchase session identifier
      operationId: transaction.getPurchaseSessionId
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            purchaseSession:
              $ref: '#/definitions/KalturaPurchaseSession'
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: integer
      tags:
      - transaction
      x-kaltura-format: post
      x-kaltura-parameters:
      - purchaseSession
  /service/transaction/action/purchase:
    post:
      description: Purchase specific product or subscription for a household. Upon successful charge entitlements to use the requested product or subscription are granted.
      operationId: transaction.purchase
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            purchase:
              $ref: '#/definitions/KalturaPurchase'
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaTransaction'
        x-Errors:
          description: '* `UnableToPurchaseSubscriptionPurchased`: undefined

            * `NotForPurchase`: undefined

            * `UserNotInDomain`: undefined

            * `InvalidUser`: undefined

            * `UserDoesNotExist`: undefined

            * `UserSuspended`: undefined

            * `CouponNotValid`: undefined

            * `UnableToPurchasePPVPurchased`: undefined

            * `UnableToPurchaseFree`: undefined

            * `UnableToPurchaseForPurchaseSubscriptionOnly`: undefined

            * `UnableToPurchaseCollectionPurchased`: undefined

            * `AdapterUrlRequired`: undefined

            * `IncorrectPrice`: undefined

            * `UnKnownPPVModule`: undefined

            * `PaymentGatewayNotSetForHousehold`: undefined

            * `PaymentGatewayNotExist`: undefined

            * `PaymentGatewayChargeIdRequired`: undefined

            * `NoConfigurationFound`: undefined

            * `SignatureMismatch`: undefined

            * `UnknownTransactionState`: undefined

            * `PaymentMethodNotSetForHousehold`: undefined

            * `PaymentMethodNotExist`: undefined'
      tags:
      - transaction
      x-kaltura-format: post
      x-kaltura-parameters:
      - purchase
  /service/transaction/action/setWaiver:
    post:
      description: This method shall set the waiver flag on the user entitlement table and the waiver date field to the current date.
      operationId: transaction.setWaiver
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            assetId:
              type: integer
            transactionType:
              enum:
              - ppv
              - subscription
              - collection
              type: string
              x-enumLabels:
              - PPV
              - SUBSCRIPTION
              - COLLECTION
              x-enumType: KalturaTransactionType
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: boolean
      tags:
      - transaction
      x-kaltura-format: post
      x-kaltura-parameters:
      - assetId
      - transactionType
  /service/transaction/action/updateStatus:
    post:
      description: Updates a pending purchase transaction state.
      operationId: transaction.updateStatus
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            externalTransactionId:
              type: string
            paymentGatewayId:
              type: string
            signature:
              type: string
            status:
              $ref: '#/definitions/KalturaTransactionStatus'
          type: object
      responses:
        '200':
          description: Success
      tags:
      - transaction
      x-kaltura-format: post
      x-kaltura-parameters:
      - paymentGatewayId
      - externalTransactionId
      - signature
      - status
  /service/transaction/action/upgrade:
    post:
      description: upgrade specific subscription for a household. Upon successful charge entitlements to use the requested product or subscription are granted.
      operationId: transaction.upgrade
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            purchase:
              $ref: '#/definitions/KalturaPurchase'
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaTransaction'
        x-Errors:
          description: '* `UserNotInDomain`: undefined

            * `AdapterUrlRequired`: undefined

            * `InvalidUser`: undefined

            * `UserDoesNotExist`: undefined

            * `UserSuspended`: undefined

            * `CouponNotValid`: undefined

            * `UnableToPurchasePPVPurchased`: undefined

            * `UnableToPurchaseFree`: undefined

            * `UnableToPurchaseForPurchaseSubscriptionOnly`: undefined

            * `UnableToPurchaseSubscriptionPurchased`: undefined

            * `NotForPurchase`: undefined

            * `UnableToPurchaseCollectionPurchased`: undefined

            * `IncorrectPrice`: undefined

            * `UnKnownPPVModule`: undefined

            * `PaymentGatewayNotSetForHousehold`: undefined

            * `PaymentGatewayNotExist`: undefined

            * `PaymentGatewayChargeIdRequired`: undefined

            * `NoConfigurationFound`: undefined

            * `SignatureMismatch`: undefined

            * `UnknownTransactionState`: undefined

            * `PaymentMethodNotSetForHousehold`: undefined

            * `PaymentMethodNotExist`: undefined

            * `SubscriptionNotRenewable`: undefined'
      tags:
      - transaction
      x-kaltura-format: post
      x-kaltura-parameters:
      - purchase
  /service/transaction/action/validateReceipt:
    post:
      description: Verifies PPV/Subscription/Collection client purchase (such as InApp) and entitles the user.
      operationId: transaction.validateReceipt
      parameters:
      - in: body
        name: body
        schema:
          allOf:
          - $ref: '#/definitions/OTTRequest'
          properties:
            externalReceipt:
              $ref: '#/definitions/KalturaExternalReceipt'
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaTransaction'
      tags:
      - transaction
      x-kaltura-format: post
      x-kaltura-parameters:
      - externalReceipt
definitions:
  KalturaPurchase:
    allOf:
    - $ref: '#/definitions/KalturaPurchaseBase'
    properties:
      adapterData:
        description: Additional data for the adapter
        type: string
      coupon:
        description: Coupon code
        type: string
      currency:
        description: Identifier for paying currency, according to ISO 4217
        type: string
      paymentGatewayId:
        description: Identifier for a pre-associated payment gateway. If not provided – the account’s default payment gateway is used
        type: integer
      paymentMethodId:
        description: Identifier for a pre-entered payment method. If not provided – the household’s default payment method is used
        type: integer
      price:
        description: Net sum to charge – as a one-time transaction. Price must match the previously provided price for the specified content.
        type: number
    title: KalturaPurchase
    type: object
  KalturaExternalReceipt:
    allOf:
    - $ref: '#/definitions/KalturaPurchaseBase'
    properties:
      paymentGatewayName:
        description: 'The payment gateway name for the In-App billing service to be used. Possible values: Google/Apple'
        type: string
      receiptId:
        description: A unique identifier that was provided by the In-App billing service to validate the purchase
        type: string
    title: KalturaExternalReceipt
    type: object
  KalturaTransaction:
    properties:
      createdAt:
        description: Entitlement creation date
        type: integer
      failReasonCode:
        description: "Adapter failure reason code\r\n            Insufficient funds = 20, Invalid account = 21, User unknown = 22, Reason unknown = 23, Unknown payment gateway response = 24,\r\n            No response from payment gateway = 25, Exceeded retry limit = 26, Illegal client request = 27, Expired = 28"
        type: integer
      id:
        description: Kaltura unique ID representing the transaction
        type: string
      paymentGatewayReferenceId:
        description: "Transaction reference ID received from the payment gateway. \r\n            Value is available only if the payment gateway provides this information."
        type: string
      paymentGatewayResponseId:
        description: "Response ID received from by the payment gateway. \r\n            Value is available only if the payment gateway provides this information."
        type: string
      state:
        description: 'Transaction state: OK/Pending/Failed'
        type: string
    title: KalturaTransaction
    type: object
  KalturaPurchaseSession:
    allOf:
    - $ref: '#/definitions/KalturaPurchase'
    properties:
      previewModuleId:
        description: Preview module identifier (relevant only for subscription)
        type: integer
    title: KalturaPurchaseSession
    type: object
  KalturaPurchaseBase:
    properties:
      contentId:
        description: Identifier for the content to purchase. Relevant only if Product type = PPV
        type: integer
      productId:
        description: Identifier for the package from which this content is offered
        type: integer
      productType:
        description: 'Enum Type: `KalturaTransactionType`


          Package type. Possible values: PPV, Subscription, Collection'
        enum:
        - ppv
        - subscription
        - collection
        type: string
        x-enumLabels:
        - PPV
        - SUBSCRIPTION
        - COLLECTION
        x-enumType: KalturaTransactionType
    title: KalturaPurchaseBase
    type: object
  KalturaTransactionStatus:
    properties:
      adapterTransactionStatus:
        description: 'Enum Type: `KalturaTransactionAdapterStatus`


          Payment gateway adapter application state for the transaction to update'
        enum:
        - OK
        - PENDING
        - FAILED
        type: string
        x-enumLabels:
        - OK
        - PENDING
        - FAILED
        x-enumType: KalturaTransactionAdapterStatus
      externalId:
        description: External transaction identifier
        type: string
      externalMessage:
        description: Payment gateway message
        type: string
      externalStatus:
        description: Payment gateway transaction status
        type: string
      failReason:
        description: The reason the transaction failed
        type: integer
    title: KalturaTransactionStatus
    type: object
  OTTRequest:
    properties:
      ks:
        type: string
      version:
        default: 3.6.287.20720
        type: string
    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:
    - 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: SE

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