{ "basePath": "/api_v3", "definitions": { "KalturaAccessControlBlockAction": { "allOf": [ { "$ref": "#/definitions/KalturaRuleAction" } ], "properties": {}, "title": "KalturaAccessControlBlockAction", "type": "object" }, "KalturaAccessControlMessage": { "properties": { "code": { "description": "Code", "type": "string" }, "message": { "description": "Message", "type": "string" } }, "title": "KalturaAccessControlMessage", "type": "object" }, "KalturaActionPermissionItem": { "properties": { "action": { "description": "Action - separated with comma", "type": "string" }, "actionPrivacy": { "description": "Enum Type: `KalturaSocialActionPrivacy`\n\nAction privacy", "enum": [ "ALLOW", "DONT_ALLOW" ], "type": "string", "x-enumLabels": [ "ALLOW", "DONT_ALLOW" ], "x-enumType": "KalturaSocialActionPrivacy" }, "network": { "description": "Enum Type: `KalturaSocialNetwork`\n\nSocial network", "enum": [ "facebook" ], "type": "string", "x-enumLabels": [ "FACEBOOK" ], "x-enumType": "KalturaSocialNetwork" }, "privacy": { "description": "Enum Type: `KalturaSocialPrivacy`\n\nSocial privacy", "enum": [ "UNKNOWN", "EVERYONE", "ALL_FRIENDS", "FRIENDS_OF_FRIENDS", "SELF", "CUSTOM" ], "type": "string", "x-enumLabels": [ "UNKNOWN", "EVERYONE", "ALL_FRIENDS", "FRIENDS_OF_FRIENDS", "SELF", "CUSTOM" ], "x-enumType": "KalturaSocialPrivacy" } }, "title": "KalturaActionPermissionItem", "type": "object" }, "KalturaAdsContext": { "properties": { "sources": { "items": { "$ref": "#/definitions/KalturaAdsSource" }, "type": "array" } }, "title": "KalturaAdsContext", "type": "object" }, "KalturaAdsSource": { "properties": { "adsParam": { "description": "The parameters to pass to the ads server", "type": "string" }, "adsPolicy": { "description": "Enum Type: `KalturaAdsPolicy`\n\nAds policy", "enum": [ "NO_ADS", "KEEP_ADS" ], "type": "string", "x-enumLabels": [ "NO_ADS", "KEEP_ADS" ], "x-enumType": "KalturaAdsPolicy" }, "id": { "description": "`readOnly`\n\nFile unique identifier", "readOnly": true, "type": "integer" }, "type": { "description": "Device types as defined in the system", "type": "string" } }, "title": "KalturaAdsSource", "type": "object" }, "KalturaAggregationCountFilter": { "allOf": [ { "$ref": "#/definitions/KalturaRelatedObjectFilter" } ], "description": "Kaltura Aggregation CountFilter", "properties": { "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaAggregationCountOrderBy" } }, "title": "KalturaAggregationCountFilter", "type": "object" }, "KalturaAnnouncement": { "properties": { "enabled": { "description": "Announcement enabled", "type": "boolean" }, "id": { "description": "`readOnly`\n\nAnnouncement id", "readOnly": true, "type": "integer" }, "imageUrl": { "description": "Announcement image URL, relevant for system announcements", "type": "string" }, "includeMail": { "description": "Include Mail", "type": "boolean" }, "includeSms": { "description": "Include SMS", "type": "boolean" }, "mailSubject": { "description": "Mail Subject", "type": "string" }, "mailTemplate": { "description": "Mail Template", "type": "string" }, "message": { "description": "Announcement message", "type": "string" }, "name": { "description": "Announcement name", "type": "string" }, "recipients": { "description": "Enum Type: `KalturaAnnouncementRecipientsType`\n\nAnnouncement recipients: All=0/LoggedIn=1/Guests=2/Other=3", "enum": [ "All", "LoggedIn", "Guests", "Other" ], "type": "string", "x-enumLabels": [ "ALL", "LOGGEDIN", "GUESTS", "OTHER" ], "x-enumType": "KalturaAnnouncementRecipientsType" }, "startTime": { "description": "Announcement start time", "type": "integer" }, "status": { "description": "`readOnly`\n\nEnum Type: `KalturaAnnouncementStatus`\n\nAnnouncement status: NotSent=0/Sending=1/Sent=2/Aborted=3", "enum": [ "NotSent", "Sending", "Sent", "Aborted" ], "readOnly": true, "type": "string", "x-enumLabels": [ "NOTSENT", "SENDING", "SENT", "ABORTED" ], "x-enumType": "KalturaAnnouncementStatus" }, "timezone": { "description": "Announcement time zone", "type": "string" } }, "title": "KalturaAnnouncement", "type": "object" }, "KalturaAnnouncementFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "order announcements", "properties": { "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaAnnouncementOrderBy" } }, "title": "KalturaAnnouncementFilter", "type": "object" }, "KalturaAnnouncementListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "List of message announcements from DB.", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaAnnouncement" }, "type": "array" } }, "title": "KalturaAnnouncementListResponse", "type": "object" }, "KalturaApiActionPermissionItem": { "allOf": [ { "$ref": "#/definitions/KalturaPermissionItem" } ], "properties": { "action": { "description": "API action name", "type": "string" }, "service": { "description": "API service name", "type": "string" } }, "title": "KalturaApiActionPermissionItem", "type": "object" }, "KalturaApiArgumentPermissionItem": { "allOf": [ { "$ref": "#/definitions/KalturaPermissionItem" } ], "properties": { "action": { "description": "API action name", "type": "string" }, "parameter": { "description": "API parameter name", "type": "string" }, "service": { "description": "API service name", "type": "string" } }, "title": "KalturaApiArgumentPermissionItem", "type": "object" }, "KalturaApiExceptionArg": { "properties": { "name": { "description": "Argument name", "type": "string" }, "value": { "description": "Argument value", "type": "string" } }, "title": "KalturaApiExceptionArg", "type": "object" }, "KalturaApiParameterPermissionItem": { "allOf": [ { "$ref": "#/definitions/KalturaPermissionItem" } ], "properties": { "action": { "description": "Enum Type: `KalturaApiParameterPermissionItemAction`\n\nAPI action type", "enum": [ "READ", "INSERT", "UPDATE", "USAGE" ], "type": "string", "x-enumLabels": [ "READ", "INSERT", "UPDATE", "USAGE" ], "x-enumType": "KalturaApiParameterPermissionItemAction" }, "object": { "description": "API object name", "type": "string" }, "parameter": { "description": "API parameter name", "type": "string" } }, "title": "KalturaApiParameterPermissionItem", "type": "object" }, "KalturaAppToken": { "description": "Application token", "properties": { "expiry": { "description": "Expiry time of current token (unix timestamp in seconds)", "type": "integer" }, "hashType": { "description": "Enum Type: `KalturaAppTokenHashType`\n\nThe hash type of the token", "enum": [ "SHA1", "SHA256", "SHA512", "MD5" ], "type": "string", "x-enumLabels": [ "SHA1", "SHA256", "SHA512", "MD5" ], "x-enumType": "KalturaAppTokenHashType" }, "id": { "description": "`readOnly`\n\nThe id of the application token", "readOnly": true, "type": "string" }, "partnerId": { "description": "`readOnly`\n\nPartner identifier", "readOnly": true, "type": "integer" }, "sessionDuration": { "description": "Expiry duration of KS (Kaltura Session) that created using the current token (in seconds)", "type": "integer" }, "sessionPrivileges": { "description": "Comma separated privileges to be applied on KS (Kaltura Session) that created using the current token", "type": "string" }, "sessionUserId": { "description": "User id of KS (Kaltura Session) that created using the current token", "type": "string" }, "token": { "description": "`readOnly`\n\nThe application token", "readOnly": true, "type": "string" } }, "title": "KalturaAppToken", "type": "object" }, "KalturaAsset": { "description": "`abstract`\n\nAsset info", "discriminator": "objectType", "oneOf": [ { "$ref": "#/definitions/KalturaMediaAsset" }, { "$ref": "#/definitions/KalturaProgramAsset" } ], "properties": { "createDate": { "description": "`readOnly`\n\nSpecifies when was the Asset was created. Date and time represented as epoch.", "readOnly": true, "type": "integer" }, "description": { "description": "Asset description", "type": "string" }, "endDate": { "description": "Date and time represented as epoch. For VOD – till when the asset be available in the catalog. For EPG/Linear – program end time and date", "type": "integer" }, "externalId": { "description": "External identifier for the media file", "type": "string" }, "id": { "description": "`readOnly`\n\nUnique identifier for the asset", "readOnly": true, "type": "integer" }, "images": { "items": { "$ref": "#/definitions/KalturaMediaImage" }, "type": "array" }, "mediaFiles": { "items": { "$ref": "#/definitions/KalturaMediaFile" }, "type": "array" }, "metas": { "items": { "$ref": "#/definitions/KalturaValue" }, "type": "array" }, "multilingualDescription": { "items": { "$ref": "#/definitions/KalturaTranslationToken" }, "type": "array" }, "multilingualName": { "items": { "$ref": "#/definitions/KalturaTranslationToken" }, "type": "array" }, "name": { "description": "Asset name", "type": "string" }, "objectType": { "enum": [ "KalturaMediaAsset", "KalturaProgramAsset" ], "type": "string" }, "startDate": { "description": "Date and time represented as epoch. For VOD – since when the asset is available in the catalog. For EPG/Linear – when the program is aired (can be in the future).", "type": "integer" }, "tags": { "items": { "$ref": "#/definitions/KalturaMultilingualStringValueArray" }, "type": "array" }, "type": { "description": "`insertOnly`\n\nIdentifies the asset type (EPG, Recording, Movie, TV Series, etc). \r\n Possible values: 0 – EPG linear programs, 1 - Recording; or any asset type ID according to the asset types IDs defined in the system.", "type": "integer" }, "updateDate": { "description": "`readOnly`\n\nSpecifies when was the Asset last updated. Date and time represented as epoch.", "readOnly": true, "type": "integer" } }, "title": "KalturaAsset", "type": "object" }, "KalturaAssetComment": { "allOf": [ { "$ref": "#/definitions/KalturaSocialComment" } ], "description": "Asset Comment", "properties": { "assetId": { "description": "Asset identifier", "type": "integer" }, "assetType": { "description": "Enum Type: `KalturaAssetType`\n\nAsset Type", "enum": [ "media", "recording", "epg" ], "type": "string", "x-enumLabels": [ "MEDIA", "RECORDING", "EPG" ], "x-enumType": "KalturaAssetType" }, "id": { "description": "Comment ID", "type": "integer" }, "subHeader": { "description": "Sub Header", "type": "string" } }, "title": "KalturaAssetComment", "type": "object" }, "KalturaAssetCommentFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "assetIdEqual": { "description": "Asset Id", "type": "integer" }, "assetTypeEqual": { "description": "Enum Type: `KalturaAssetType`\n\nAsset Type", "enum": [ "media", "recording", "epg" ], "type": "string", "x-enumLabels": [ "MEDIA", "RECORDING", "EPG" ], "x-enumType": "KalturaAssetType" }, "orderBy": { "enum": [ "CREATE_DATE_DESC" ], "type": "string", "x-enumLabels": [ "CREATE_DATE_DESC" ], "x-enumType": "KalturaAssetCommentOrderBy" } }, "title": "KalturaAssetCommentFilter", "type": "object" }, "KalturaAssetCommentListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Asset Comment Response", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaAssetComment" }, "type": "array" } }, "title": "KalturaAssetCommentListResponse", "type": "object" }, "KalturaAssetCount": { "description": "Asset count - represents a specific value of the field, its count and its sub groups.", "properties": { "count": { "description": "Count", "type": "integer" }, "subs": { "items": { "$ref": "#/definitions/KalturaAssetsCount" }, "type": "array" }, "value": { "description": "Value", "type": "string" } }, "title": "KalturaAssetCount", "type": "object" }, "KalturaAssetCountListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Asset counts wrapper - represents a group", "properties": { "assetsCount": { "description": "Count of assets that match filter result, regardless of group by result", "type": "integer" }, "objects": { "items": { "$ref": "#/definitions/KalturaAssetsCount" }, "type": "array" } }, "title": "KalturaAssetCountListResponse", "type": "object" }, "KalturaAssetFieldGroupBy": { "allOf": [ { "$ref": "#/definitions/KalturaAssetGroupBy" } ], "description": "Group by a field that is defined in enum", "properties": { "value": { "description": "Enum Type: `KalturaGroupByField`\n\nGroup by a specific field that is defined in enum", "enum": [ "media_type_id" ], "type": "string", "x-enumLabels": [ "MEDIA_TYPE_ID" ], "x-enumType": "KalturaGroupByField" } }, "title": "KalturaAssetFieldGroupBy", "type": "object" }, "KalturaAssetFileContext": { "properties": { "fullLifeCycle": { "description": "`readOnly`\n\nfullLifeCycle", "readOnly": true, "type": "string" }, "isOfflinePlayBack": { "description": "`readOnly`\n\nisOfflinePlayBack", "readOnly": true, "type": "boolean" }, "viewLifeCycle": { "description": "`readOnly`\n\nviewLifeCycle", "readOnly": true, "type": "string" } }, "title": "KalturaAssetFileContext", "type": "object" }, "KalturaAssetFilter": { "allOf": [ { "$ref": "#/definitions/KalturaPersistedFilter" } ], "properties": { "dynamicOrderBy": { "$ref": "#/definitions/KalturaDynamicOrderBy" }, "orderBy": { "enum": [ "RELEVANCY_DESC", "NAME_ASC", "NAME_DESC", "VIEWS_DESC", "RATINGS_DESC", "VOTES_DESC", "START_DATE_DESC", "START_DATE_ASC", "LIKES_DESC", "CREATE_DATE_ASC", "CREATE_DATE_DESC" ], "type": "string", "x-enumLabels": [ "RELEVANCY_DESC", "NAME_ASC", "NAME_DESC", "VIEWS_DESC", "RATINGS_DESC", "VOTES_DESC", "START_DATE_DESC", "START_DATE_ASC", "LIKES_DESC", "CREATE_DATE_ASC", "CREATE_DATE_DESC" ], "x-enumType": "KalturaAssetOrderBy" } }, "title": "KalturaAssetFilter", "type": "object" }, "KalturaAssetGroupBy": { "description": "`abstract`\n\nAbstarct class - represents an asset parameter that can be used for grouping", "discriminator": "objectType", "oneOf": [ { "$ref": "#/definitions/KalturaAssetMetaOrTagGroupBy" }, { "$ref": "#/definitions/KalturaAssetFieldGroupBy" } ], "properties": { "objectType": { "enum": [ "KalturaAssetMetaOrTagGroupBy", "KalturaAssetFieldGroupBy" ], "type": "string" } }, "title": "KalturaAssetGroupBy", "type": "object" }, "KalturaAssetHistory": { "description": "Watch history asset info", "properties": { "assetId": { "description": "`readOnly`\n\nAsset identifier", "readOnly": true, "type": "integer" }, "assetType": { "description": "`readOnly`\n\nEnum Type: `KalturaAssetType`\n\nAsset identifier", "enum": [ "media", "recording", "epg" ], "readOnly": true, "type": "string", "x-enumLabels": [ "MEDIA", "RECORDING", "EPG" ], "x-enumType": "KalturaAssetType" }, "duration": { "description": "`readOnly`\n\nDuration in seconds of the relevant asset", "readOnly": true, "type": "integer" }, "finishedWatching": { "description": "`readOnly`\n\nBoolean which specifies whether the user finished watching the movie or not", "readOnly": true, "type": "boolean" }, "position": { "description": "`readOnly`\n\nPosition in seconds of the relevant asset", "readOnly": true, "type": "integer" }, "watchedDate": { "description": "`readOnly`\n\nThe date when the media was last watched", "readOnly": true, "type": "integer" } }, "title": "KalturaAssetHistory", "type": "object" }, "KalturaAssetHistoryFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "assetIdIn": { "description": "Comma separated list of asset identifiers.", "type": "string" }, "daysLessThanOrEqual": { "description": "How many days back to return the watched media. If omitted, default to 7 days", "type": "integer" }, "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaAssetHistoryOrderBy" }, "statusEqual": { "description": "Enum Type: `KalturaWatchStatus`\n\nWhich type of recently watched media to include in the result – those that finished watching, those that are in progress or both.\r\n If omitted or specified filter = all – return all types.\r\n Allowed values: progress – return medias that are in-progress, done – return medias that finished watching.", "enum": [ "progress", "done", "all" ], "type": "string", "x-enumLabels": [ "PROGRESS", "DONE", "ALL" ], "x-enumType": "KalturaWatchStatus" }, "typeIn": { "description": "Comma separated list of asset types to search within.\r\n Possible values: 0 – EPG linear programs entries, any media type ID (according to media type IDs defined dynamically in the system).\r\n If omitted – all types should be included.", "type": "string" } }, "title": "KalturaAssetHistoryFilter", "type": "object" }, "KalturaAssetHistoryListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Watch history asset wrapper", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaAssetHistory" }, "type": "array" } }, "title": "KalturaAssetHistoryListResponse", "type": "object" }, "KalturaAssetListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Asset wrapper", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaAsset" }, "type": "array" } }, "title": "KalturaAssetListResponse", "type": "object" }, "KalturaAssetMetaOrTagGroupBy": { "allOf": [ { "$ref": "#/definitions/KalturaAssetGroupBy" } ], "description": "Group by a tag or meta - according to the name that appears in the system (similar to KSQL)", "properties": { "value": { "description": "Group by a tag or meta - according to the name that appears in the system (similar to KSQL)", "type": "string" } }, "title": "KalturaAssetMetaOrTagGroupBy", "type": "object" }, "KalturaAssetReminder": { "allOf": [ { "$ref": "#/definitions/KalturaReminder" } ], "properties": { "assetId": { "description": "Asset id", "type": "integer" } }, "title": "KalturaAssetReminder", "type": "object" }, "KalturaAssetReminderFilter": { "allOf": [ { "$ref": "#/definitions/KalturaReminderFilter" } ], "properties": { "orderBy": { "enum": [ "RELEVANCY_DESC", "NAME_ASC", "NAME_DESC", "VIEWS_DESC", "RATINGS_DESC", "VOTES_DESC", "START_DATE_DESC", "START_DATE_ASC", "LIKES_DESC" ], "type": "string", "x-enumLabels": [ "RELEVANCY_DESC", "NAME_ASC", "NAME_DESC", "VIEWS_DESC", "RATINGS_DESC", "VOTES_DESC", "START_DATE_DESC", "START_DATE_ASC", "LIKES_DESC" ], "x-enumType": "KalturaAssetReminderOrderBy" } }, "title": "KalturaAssetReminderFilter", "type": "object" }, "KalturaAssetStatistics": { "description": "Asset statistics", "properties": { "assetId": { "description": "Unique identifier for the asset", "type": "integer" }, "buzzScore": { "$ref": "#/definitions/KalturaBuzzScore" }, "likes": { "description": "Total number of likes for this asset", "type": "integer" }, "rating": { "description": "Average rating for the asset", "type": "number" }, "ratingCount": { "description": "Number of people that rated the asset", "type": "integer" }, "views": { "description": "Total number of views for this asset", "type": "integer" } }, "title": "KalturaAssetStatistics", "type": "object" }, "KalturaAssetStatisticsListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "List of assets statistics", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaAssetStatistics" }, "type": "array" } }, "title": "KalturaAssetStatisticsListResponse", "type": "object" }, "KalturaAssetStatisticsQuery": { "properties": { "assetIdIn": { "description": "Comma separated list of asset identifiers.", "type": "string" }, "assetTypeEqual": { "description": "Enum Type: `KalturaAssetType`\n\nAsset type", "enum": [ "media", "recording", "epg" ], "type": "string", "x-enumLabels": [ "MEDIA", "RECORDING", "EPG" ], "x-enumType": "KalturaAssetType" }, "endDateGreaterThanOrEqual": { "description": "/// The end of the time window to get the statistics for (in epoch).", "type": "integer" }, "startDateGreaterThanOrEqual": { "description": "The beginning of the time window to get the statistics for (in epoch).", "type": "integer" } }, "title": "KalturaAssetStatisticsQuery", "type": "object" }, "KalturaAssetStruct": { "properties": { "createDate": { "description": "`readOnly`\n\nSpecifies when was the Asset Struct was created. Date and time represented as epoch.", "readOnly": true, "type": "integer" }, "id": { "description": "`readOnly`\n\nAsset Struct id", "readOnly": true, "type": "integer" }, "isProtected": { "description": "Is the Asset Struct protected by the system", "type": "boolean" }, "metaIds": { "description": "A list of comma separated meta ids associated with this asset struct, returned according to the order.", "type": "string" }, "multilingualName": { "items": { "$ref": "#/definitions/KalturaTranslationToken" }, "type": "array" }, "name": { "description": "Asset struct name for the partner", "type": "string" }, "systemName": { "description": "Asset Struct system name for the partner", "type": "string" }, "updateDate": { "description": "`readOnly`\n\nSpecifies when was the Asset Struct last updated. Date and time represented as epoch.", "readOnly": true, "type": "integer" } }, "title": "KalturaAssetStruct", "type": "object" }, "KalturaAssetStructFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "Filtering Asset Structs", "properties": { "idIn": { "description": "Comma separated identifiers", "type": "string" }, "isProtectedEqual": { "description": "Filter Asset Structs by isProtectedEqual value", "type": "boolean" }, "metaIdEqual": { "description": "Filter Asset Structs that contain a specific meta id", "type": "integer" }, "orderBy": { "enum": [ "NAME_ASC", "NAME_DESC", "SYSTEM_NAME_ASC", "SYSTEM_NAME_DESC", "CREATE_DATE_ASC", "CREATE_DATE_DESC", "UPDATE_DATE_ASC", "UPDATE_DATE_DESC" ], "type": "string", "x-enumLabels": [ "NAME_ASC", "NAME_DESC", "SYSTEM_NAME_ASC", "SYSTEM_NAME_DESC", "CREATE_DATE_ASC", "CREATE_DATE_DESC", "UPDATE_DATE_ASC", "UPDATE_DATE_DESC" ], "x-enumType": "KalturaAssetStructOrderBy" } }, "title": "KalturaAssetStructFilter", "type": "object" }, "KalturaAssetStructListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Asset Structs list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaAssetStruct" }, "type": "array" } }, "title": "KalturaAssetStructListResponse", "type": "object" }, "KalturaAssetsCount": { "description": "Single aggregation objects", "properties": { "field": { "description": "Field name", "type": "string" }, "objects": { "items": { "$ref": "#/definitions/KalturaAssetCount" }, "type": "array" } }, "title": "KalturaAssetsCount", "type": "object" }, "KalturaBaseChannel": { "description": "Slim channel", "properties": { "id": { "description": "`readOnly`\n\nUnique identifier for the channel", "readOnly": true, "type": "integer" }, "name": { "description": "Channel name", "type": "string" } }, "title": "KalturaBaseChannel", "type": "object" }, "KalturaBaseOTTUser": { "description": "Slim user data", "properties": { "firstName": { "description": "First name", "type": "string" }, "id": { "description": "`readOnly`\n\nUser identifier", "readOnly": true, "type": "string" }, "lastName": { "description": "Last name", "type": "string" }, "username": { "description": "Username", "type": "string" } }, "title": "KalturaBaseOTTUser", "type": "object" }, "KalturaBaseResponseProfile": { "description": "`abstract`\n\nDefine base profile response - optional configurations", "discriminator": "objectType", "oneOf": [ { "$ref": "#/definitions/KalturaDetachedResponseProfile" } ], "properties": { "objectType": { "enum": [ "KalturaDetachedResponseProfile" ], "type": "string" } }, "title": "KalturaBaseResponseProfile", "type": "object" }, "KalturaBaseSearchAssetFilter": { "allOf": [ { "$ref": "#/definitions/KalturaAssetFilter" } ], "description": "`abstract`", "discriminator": "objectType", "oneOf": [ { "$ref": "#/definitions/KalturaRelatedFilter" }, { "$ref": "#/definitions/KalturaSearchAssetFilter" } ], "properties": { "groupBy": { "items": { "$ref": "#/definitions/KalturaAssetGroupBy" }, "type": "array" }, "objectType": { "enum": [ "KalturaRelatedFilter", "KalturaSearchAssetFilter" ], "type": "string" } }, "title": "KalturaBaseSearchAssetFilter", "type": "object" }, "KalturaBillingPartnerConfig": { "allOf": [ { "$ref": "#/definitions/KalturaPartnerConfiguration" } ], "description": "Partner billing configuration", "properties": { "type": { "description": "Enum Type: `KalturaPartnerConfigurationType`\n\npartner configuration type", "enum": [ "DefaultPaymentGateway", "EnablePaymentGatewaySelection", "OSSAdapter" ], "type": "string", "x-enumLabels": [ "DEFAULTPAYMENTGATEWAY", "ENABLEPAYMENTGATEWAYSELECTION", "OSSADAPTER" ], "x-enumType": "KalturaPartnerConfigurationType" }, "value": { "description": "configuration value", "type": "string" } }, "title": "KalturaBillingPartnerConfig", "type": "object" }, "KalturaBillingResponse": { "description": "Billing response", "properties": { "externalReceiptCode": { "description": "External receipt Code", "type": "string" }, "receiptCode": { "description": "Receipt Code", "type": "string" } }, "title": "KalturaBillingResponse", "type": "object" }, "KalturaBillingTransaction": { "description": "Billing Transaction", "properties": { "actionDate": { "description": "`readOnly`\n\nAction Date", "readOnly": true, "type": "integer" }, "billingAction": { "description": "`readOnly`\n\nEnum Type: `KalturaBillingAction`\n\nBilling Action", "enum": [ "unknown", "purchase", "renew_payment", "renew_canceled_subscription", "cancel_subscription_order", "subscription_date_changed" ], "readOnly": true, "type": "string", "x-enumLabels": [ "UNKNOWN", "PURCHASE", "RENEW_PAYMENT", "RENEW_CANCELED_SUBSCRIPTION", "CANCEL_SUBSCRIPTION_ORDER", "SUBSCRIPTION_DATE_CHANGED" ], "x-enumType": "KalturaBillingAction" }, "billingPriceType": { "description": "`readOnly`\n\nEnum Type: `KalturaBillingPriceType`\n\nBilling Price Info", "enum": [ "FullPeriod", "PartialPeriod" ], "readOnly": true, "type": "string", "x-enumLabels": [ "FULLPERIOD", "PARTIALPERIOD" ], "x-enumType": "KalturaBillingPriceType" }, "billingProviderRef": { "description": "`readOnly`\n\nBilling Provider Ref", "readOnly": true, "type": "integer" }, "endDate": { "description": "`readOnly`\n\nEnd Date", "readOnly": true, "type": "integer" }, "isRecurring": { "description": "`readOnly`\n\nIs Recurring", "readOnly": true, "type": "boolean" }, "itemType": { "description": "`readOnly`\n\nEnum Type: `KalturaBillingItemsType`\n\nItem Type", "enum": [ "unknown", "ppv", "subscription", "pre_paid", "pre_paid_expired", "collection" ], "readOnly": true, "type": "string", "x-enumLabels": [ "UNKNOWN", "PPV", "SUBSCRIPTION", "PRE_PAID", "PRE_PAID_EXPIRED", "COLLECTION" ], "x-enumType": "KalturaBillingItemsType" }, "paymentMethod": { "description": "`readOnly`\n\nEnum Type: `KalturaPaymentMethodType`\n\nPayment Method", "enum": [ "unknown", "credit_card", "sms", "pay_pal", "debit_card", "ideal", "incaso", "gift", "visa", "master_card", "in_app", "m1", "change_subscription", "offline" ], "readOnly": true, "type": "string", "x-enumLabels": [ "UNKNOWN", "CREDIT_CARD", "SMS", "PAY_PAL", "DEBIT_CARD", "IDEAL", "INCASO", "GIFT", "VISA", "MASTER_CARD", "IN_APP", "M1", "CHANGE_SUBSCRIPTION", "OFFLINE" ], "x-enumType": "KalturaPaymentMethodType" }, "paymentMethodExtraDetails": { "description": "`readOnly`\n\nPayment Method Extra Details", "readOnly": true, "type": "string" }, "price": { "$ref": "#/definitions/KalturaPrice" }, "purchaseId": { "description": "`readOnly`\n\nPurchase ID", "readOnly": true, "type": "integer" }, "purchasedItemCode": { "description": "`readOnly`\n\nPurchased Item Code", "readOnly": true, "type": "string" }, "purchasedItemName": { "description": "`readOnly`\n\nPurchased Item Name", "readOnly": true, "type": "string" }, "recieptCode": { "description": "`readOnly`\n\nReciept Code", "readOnly": true, "type": "string" }, "remarks": { "description": "`readOnly`\n\nRemarks", "readOnly": true, "type": "string" }, "startDate": { "description": "`readOnly`\n\nStart Date", "readOnly": true, "type": "integer" } }, "title": "KalturaBillingTransaction", "type": "object" }, "KalturaBillingTransactionListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Billing Transactions", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaBillingTransaction" }, "type": "array" } }, "title": "KalturaBillingTransactionListResponse", "type": "object" }, "KalturaBookmark": { "allOf": [ { "$ref": "#/definitions/KalturaSlimAsset" } ], "properties": { "finishedWatching": { "description": "`readOnly`\n\nSpecifies whether the user's current position exceeded 95% of the duration", "readOnly": true, "type": "boolean" }, "playerData": { "$ref": "#/definitions/KalturaBookmarkPlayerData" }, "position": { "description": "`insertOnly`\n\nThe position of the user in the specific asset (in seconds)", "type": "integer" }, "positionOwner": { "description": "`readOnly`\n\nEnum Type: `KalturaPositionOwner`\n\nIndicates who is the owner of this position", "enum": [ "household", "user" ], "readOnly": true, "type": "string", "x-enumLabels": [ "HOUSEHOLD", "USER" ], "x-enumType": "KalturaPositionOwner" }, "userId": { "description": "`readOnly`\n\nUser identifier", "readOnly": true, "type": "string" } }, "title": "KalturaBookmark", "type": "object" }, "KalturaBookmarkFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "Filtering Assets requests", "properties": { "assetIdIn": { "description": "Comma separated list of assets identifiers", "type": "string" }, "assetTypeEqual": { "description": "Enum Type: `KalturaAssetType`\n\nAsset type", "enum": [ "media", "recording", "epg" ], "type": "string", "x-enumLabels": [ "MEDIA", "RECORDING", "EPG" ], "x-enumType": "KalturaAssetType" }, "orderBy": { "enum": [ "POSITION_ASC", "POSITION_DESC" ], "type": "string", "x-enumLabels": [ "POSITION_ASC", "POSITION_DESC" ], "x-enumType": "KalturaBookmarkOrderBy" } }, "title": "KalturaBookmarkFilter", "type": "object" }, "KalturaBookmarkListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "List of assets and their bookmarks", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaBookmark" }, "type": "array" } }, "title": "KalturaBookmarkListResponse", "type": "object" }, "KalturaBookmarkPlayerData": { "properties": { "action": { "description": "Enum Type: `KalturaBookmarkActionType`\n\nAction", "enum": [ "HIT", "PLAY", "STOP", "PAUSE", "FIRST_PLAY", "SWOOSH", "FULL_SCREEN", "SEND_TO_FRIEND", "LOAD", "FULL_SCREEN_EXIT", "FINISH", "ERROR", "BITRATE_CHANGE", "NONE" ], "type": "string", "x-enumLabels": [ "HIT", "PLAY", "STOP", "PAUSE", "FIRST_PLAY", "SWOOSH", "FULL_SCREEN", "SEND_TO_FRIEND", "LOAD", "FULL_SCREEN_EXIT", "FINISH", "ERROR", "BITRATE_CHANGE", "NONE" ], "x-enumType": "KalturaBookmarkActionType" }, "averageBitrate": { "description": "Average Bitrate", "type": "integer" }, "currentBitrate": { "description": "Current Bitrate", "type": "integer" }, "fileId": { "description": "Identifier of the file", "type": "integer" }, "totalBitrate": { "description": "Total Bitrate", "type": "integer" } }, "title": "KalturaBookmarkPlayerData", "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" }, "KalturaBundleFilter": { "allOf": [ { "$ref": "#/definitions/KalturaAssetFilter" } ], "properties": { "bundleTypeEqual": { "description": "Enum Type: `KalturaBundleType`\n\nbundleType - possible values: Subscription or Collection", "enum": [ "subscription", "collection" ], "type": "string", "x-enumLabels": [ "SUBSCRIPTION", "COLLECTION" ], "x-enumType": "KalturaBundleType" }, "idEqual": { "description": "Bundle Id.", "type": "integer" }, "typeIn": { "description": "Comma separated list of asset types to search within. \r\n Possible values: 0 – EPG linear programs entries, any media type ID (according to media type IDs defined dynamically in the system).\r\n If omitted – all types should be included.", "type": "string" } }, "title": "KalturaBundleFilter", "type": "object" }, "KalturaBuzzScore": { "description": "Buzz score", "properties": { "avgScore": { "description": "Average score", "type": "number" }, "normalizedAvgScore": { "description": "Normalized average score", "type": "number" }, "updateDate": { "description": "Update date", "type": "integer" } }, "title": "KalturaBuzzScore", "type": "object" }, "KalturaCDNAdapterProfile": { "description": "CDN Adapter", "properties": { "adapterUrl": { "description": "CDN adapter URL", "type": "string" }, "baseUrl": { "description": "CDN adapter base URL", "type": "string" }, "id": { "description": "`readOnly`\n\nCDN adapter identifier", "readOnly": true, "type": "integer" }, "isActive": { "description": "CDN adapter active status", "type": "boolean" }, "name": { "description": "CDNR adapter name", "type": "string" }, "settings": { "items": { "$ref": "#/definitions/KalturaStringValue" }, "type": "array" }, "sharedSecret": { "description": "`readOnly`\n\nCDN shared secret", "readOnly": true, "type": "string" }, "systemName": { "description": "CDN adapter alias", "type": "string" } }, "title": "KalturaCDNAdapterProfile", "type": "object" }, "KalturaCDNAdapterProfileListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaCDNAdapterProfile" }, "type": "array" } }, "title": "KalturaCDNAdapterProfileListResponse", "type": "object" }, "KalturaCDNPartnerSettings": { "properties": { "defaultAdapterId": { "description": "Default CDN adapter identifier", "type": "integer" }, "defaultRecordingAdapterId": { "description": "Default recording CDN adapter identifier", "type": "integer" } }, "title": "KalturaCDNPartnerSettings", "type": "object" }, "KalturaCDVRAdapterProfile": { "description": "C-DVR Adapter", "properties": { "adapterUrl": { "description": "C-DVR adapter adapter URL", "type": "string" }, "dynamicLinksSupport": { "description": "Indicates whether the C-DVR adapter supports dynamic URLs", "type": "boolean" }, "externalIdentifier": { "description": "C-DVR adapter external identifier", "type": "string" }, "id": { "description": "`readOnly`\n\nC-DVR adapter identifier", "readOnly": true, "type": "integer" }, "isActive": { "description": "C-DVR adapter active status", "type": "boolean" }, "name": { "description": "C-DVR adapter name", "type": "string" }, "settings": { "items": { "$ref": "#/definitions/KalturaStringValue" }, "type": "array" }, "sharedSecret": { "description": "`readOnly`\n\nC-DVR shared secret", "readOnly": true, "type": "string" } }, "title": "KalturaCDVRAdapterProfile", "type": "object" }, "KalturaCDVRAdapterProfileListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "C-DVR adapter profiles", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaCDVRAdapterProfile" }, "type": "array" } }, "title": "KalturaCDVRAdapterProfileListResponse", "type": "object" }, "KalturaChannel": { "description": "Channel details", "properties": { "createDate": { "description": "`readOnly`\n\nSpecifies when was the Channel was created. Date and time represented as epoch.", "readOnly": true, "type": "integer" }, "description": { "description": "Channel description", "type": "string" }, "id": { "description": "`readOnly`\n\nUnique identifier for the channel", "readOnly": true, "type": "integer" }, "isActive": { "description": "active status", "type": "boolean" }, "multilingualDescription": { "items": { "$ref": "#/definitions/KalturaTranslationToken" }, "type": "array" }, "multilingualName": { "items": { "$ref": "#/definitions/KalturaTranslationToken" }, "type": "array" }, "name": { "description": "Channel name", "type": "string" }, "orderBy": { "$ref": "#/definitions/KalturaChannelOrder" }, "systemName": { "description": "Channel system name", "type": "string" }, "updateDate": { "description": "`readOnly`\n\nSpecifies when was the Channel last updated. Date and time represented as epoch.", "readOnly": true, "type": "integer" } }, "title": "KalturaChannel", "type": "object" }, "KalturaChannelEnrichmentHolder": { "description": "Holder object for channel enrichment enum", "properties": { "type": { "description": "Enum Type: `KalturaChannelEnrichment`\n\nEnrichment type", "enum": [ "ClientLocation", "UserId", "HouseholdId", "DeviceId", "DeviceType", "UTCOffset", "Language", "NPVRSupport", "Catchup", "Parental", "DTTRegion", "AtHome" ], "type": "string", "x-enumLabels": [ "CLIENTLOCATION", "USERID", "HOUSEHOLDID", "DEVICEID", "DEVICETYPE", "UTCOFFSET", "LANGUAGE", "NPVRSUPPORT", "CATCHUP", "PARENTAL", "DTTREGION", "ATHOME" ], "x-enumType": "KalturaChannelEnrichment" } }, "title": "KalturaChannelEnrichmentHolder", "type": "object" }, "KalturaChannelExternalFilter": { "allOf": [ { "$ref": "#/definitions/KalturaAssetFilter" } ], "properties": { "freeText": { "description": "FreeTextEqual", "type": "string" }, "idEqual": { "description": "External Channel Id.", "type": "integer" }, "utcOffsetEqual": { "description": "UtcOffsetEqual", "type": "number" } }, "title": "KalturaChannelExternalFilter", "type": "object" }, "KalturaChannelFilter": { "allOf": [ { "$ref": "#/definitions/KalturaAssetFilter" } ], "properties": { "idEqual": { "description": "Channel Id", "type": "integer" }, "kSql": { "description": "Search assets using dynamic criteria. Provided collection of nested expressions with key, comparison operators, value, and logical conjunction.\r\n Possible keys: any Tag or Meta defined in the system and the following reserved keys: start_date, end_date. \r\n epg_id, media_id - for specific asset IDs.\r\n geo_block - only valid value is "true": When enabled, only assets that are not restriced to the user by geo-block rules will return.\r\n parental_rules - only valid value is "true": When enabled, only assets that the user doesn't need to provide PIN code will return.\r\n user_interests - only valid value is "true". When enabled, only assets that the user defined as his interests (by tags and metas) will return.\r\n epg_channel_id – the channel identifier of the EPG program.\r\n entitled_assets - valid values: "free", "entitled", "both". free - gets only free to watch assets. entitled - only those that the user is implicitly entitled to watch.\r\n Comparison operators: for numerical fields =, >, >=, <, <=, : (in). \r\n For alpha-numerical fields =, != (not), ~ (like), !~, ^ (any word starts with), ^= (phrase starts with), + (exists), !+ (not exists).\r\n Logical conjunction: and, or. \r\n Search values are limited to 20 characters each.\r\n (maximum length of entire filter is 2048 characters)", "type": "string" }, "orderBy": { "enum": [ "ORDER_NUM", "RELEVANCY_DESC", "NAME_ASC", "NAME_DESC", "VIEWS_DESC", "RATINGS_DESC", "VOTES_DESC", "START_DATE_DESC", "START_DATE_ASC", "LIKES_DESC", "CREATE_DATE_ASC", "CREATE_DATE_DESC" ], "type": "string", "x-enumLabels": [ "ORDER_NUM", "RELEVANCY_DESC", "NAME_ASC", "NAME_DESC", "VIEWS_DESC", "RATINGS_DESC", "VOTES_DESC", "START_DATE_DESC", "START_DATE_ASC", "LIKES_DESC", "CREATE_DATE_ASC", "CREATE_DATE_DESC" ], "x-enumType": "KalturaChannelOrderBy" } }, "title": "KalturaChannelFilter", "type": "object" }, "KalturaChannelListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaChannel" }, "type": "array" } }, "title": "KalturaChannelListResponse", "type": "object" }, "KalturaChannelOrder": { "description": "Channel order details", "properties": { "dynamicOrderBy": { "$ref": "#/definitions/KalturaDynamicOrderBy" }, "orderBy": { "description": "Enum Type: `KalturaChannelOrderBy`\n\nChannel order by", "enum": [ "ORDER_NUM", "RELEVANCY_DESC", "NAME_ASC", "NAME_DESC", "VIEWS_DESC", "RATINGS_DESC", "VOTES_DESC", "START_DATE_DESC", "START_DATE_ASC", "LIKES_DESC", "CREATE_DATE_ASC", "CREATE_DATE_DESC" ], "type": "string", "x-enumLabels": [ "ORDER_NUM", "RELEVANCY_DESC", "NAME_ASC", "NAME_DESC", "VIEWS_DESC", "RATINGS_DESC", "VOTES_DESC", "START_DATE_DESC", "START_DATE_ASC", "LIKES_DESC", "CREATE_DATE_ASC", "CREATE_DATE_DESC" ], "x-enumType": "KalturaChannelOrderBy" }, "period": { "description": "Sliding window period in minutes, used only when ordering by LIKES_DESC / VOTES_DESC / RATINGS_DESC / VIEWS_DESC", "type": "integer" } }, "title": "KalturaChannelOrder", "type": "object" }, "KalturaChannelsFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "idEqual": { "description": "channel identifier to filter by", "type": "integer" }, "nameEqual": { "description": "Exact channel name to filter by", "type": "string" }, "nameStartsWith": { "description": "Channel name starts with (autocomplete)", "type": "string" }, "orderBy": { "enum": [ "NONE", "NAME_ASC", "NAME_DESC", "CREATE_DATE_ASC", "CREATE_DATE_DESC" ], "type": "string", "x-enumLabels": [ "NONE", "NAME_ASC", "NAME_DESC", "CREATE_DATE_ASC", "CREATE_DATE_DESC" ], "x-enumType": "KalturaChannelsOrderBy" } }, "title": "KalturaChannelsFilter", "type": "object" }, "KalturaClientConfiguration": { "description": "Define client optional configurations", "properties": { "apiVersion": { "description": "API client version", "type": "string" }, "clientTag": { "description": "Client Tag", "type": "string" } }, "title": "KalturaClientConfiguration", "type": "object" }, "KalturaCollection": { "description": "Collection", "properties": { "channels": { "items": { "$ref": "#/definitions/KalturaBaseChannel" }, "type": "array" }, "couponsGroups": { "items": { "$ref": "#/definitions/KalturaCouponsGroup" }, "type": "array" }, "description": { "description": "description of the subscription", "type": "string" }, "discountModule": { "$ref": "#/definitions/KalturaDiscountModule" }, "endDate": { "description": "The last date the collection is available for purchasing", "type": "integer" }, "externalId": { "description": "External ID", "type": "string" }, "id": { "description": "Collection identifier", "type": "string" }, "multilingualDescription": { "items": { "$ref": "#/definitions/KalturaTranslationToken" }, "type": "array" }, "multilingualName": { "items": { "$ref": "#/definitions/KalturaTranslationToken" }, "type": "array" }, "name": { "description": "Name of the subscription", "type": "string" }, "priceDetailsId": { "description": "The ID of the price details associated with this collection", "type": "integer" }, "productCodes": { "items": { "$ref": "#/definitions/KalturaProductCode" }, "type": "array" }, "startDate": { "description": "The first date the collection is available for purchasing", "type": "integer" }, "usageModule": { "$ref": "#/definitions/KalturaUsageModule" } }, "title": "KalturaCollection", "type": "object" }, "KalturaCollectionEntitlement": { "allOf": [ { "$ref": "#/definitions/KalturaEntitlement" } ], "properties": {}, "title": "KalturaCollectionEntitlement", "type": "object" }, "KalturaCollectionFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "Collection Filter", "properties": { "collectionIdIn": { "description": "Comma separated collection IDs", "type": "string" }, "mediaFileIdEqual": { "description": "Media-file ID to get the subscriptions by", "type": "integer" }, "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaCollectionOrderBy" } }, "title": "KalturaCollectionFilter", "type": "object" }, "KalturaCollectionListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Collections list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaCollection" }, "type": "array" } }, "title": "KalturaCollectionListResponse", "type": "object" }, "KalturaCollectionPrice": { "allOf": [ { "$ref": "#/definitions/KalturaProductPrice" } ], "description": "Collection price details", "properties": {}, "title": "KalturaCollectionPrice", "type": "object" }, "KalturaCompensation": { "description": "Compensation request parameters", "properties": { "amount": { "description": "Compensation amount", "type": "number" }, "appliedRenewalIterations": { "description": "`readOnly`\n\nThe number of renewals the compensation was already applied on", "readOnly": true, "type": "integer" }, "compensationType": { "description": "Enum Type: `KalturaCompensationType`\n\nCompensation type", "enum": [ "PERCENTAGE", "FIXED_AMOUNT" ], "type": "string", "x-enumLabels": [ "PERCENTAGE", "FIXED_AMOUNT" ], "x-enumType": "KalturaCompensationType" }, "id": { "description": "`readOnly`\n\nCompensation identifier", "readOnly": true, "type": "integer" }, "purchaseId": { "description": "Purchase identifier", "type": "integer" }, "subscriptionId": { "description": "`readOnly`\n\nSubscription identifier", "readOnly": true, "type": "integer" }, "totalRenewalIterations": { "description": "The number of renewals for compensation", "type": "integer" } }, "title": "KalturaCompensation", "type": "object" }, "KalturaConfigurationGroup": { "properties": { "configurationIdentifiers": { "items": { "$ref": "#/definitions/KalturaConfigurationIdentifier" }, "type": "array" }, "id": { "description": "`readOnly`\n\nConfiguration group identifier", "readOnly": true, "type": "string" }, "isDefault": { "description": "`insertOnly`\n\nIs default", "type": "boolean" }, "name": { "description": "Configuration group name", "type": "string" }, "numberOfDevices": { "description": "`readOnly`\n\nNumber of devices", "readOnly": true, "type": "integer" }, "partnerId": { "description": "`readOnly`\n\nPartner id", "readOnly": true, "type": "integer" }, "tags": { "items": { "$ref": "#/definitions/KalturaStringValue" }, "type": "array" } }, "title": "KalturaConfigurationGroup", "type": "object" }, "KalturaConfigurationGroupDevice": { "properties": { "configurationGroupId": { "description": "Configuration group id", "type": "string" }, "partnerId": { "description": "`readOnly`\n\nPartner id", "readOnly": true, "type": "integer" }, "udid": { "description": "Device UDID", "type": "string" } }, "title": "KalturaConfigurationGroupDevice", "type": "object" }, "KalturaConfigurationGroupDeviceFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "Configuration group device filter", "properties": { "configurationGroupIdEqual": { "description": "the ID of the configuration group for which to return related configurations group devices", "type": "string" }, "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaConfigurationGroupDeviceOrderBy" } }, "title": "KalturaConfigurationGroupDeviceFilter", "type": "object" }, "KalturaConfigurationGroupDeviceListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Configuration group devices info wrapper", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaConfigurationGroupDevice" }, "type": "array" } }, "title": "KalturaConfigurationGroupDeviceListResponse", "type": "object" }, "KalturaConfigurationGroupListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Configuration groups info wrapper", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaConfigurationGroup" }, "type": "array" } }, "title": "KalturaConfigurationGroupListResponse", "type": "object" }, "KalturaConfigurationGroupTag": { "properties": { "configurationGroupId": { "description": "Configuration group identifier", "type": "string" }, "partnerId": { "description": "`readOnly`\n\nPartner identifier", "readOnly": true, "type": "integer" }, "tag": { "description": "Tag", "type": "string" } }, "title": "KalturaConfigurationGroupTag", "type": "object" }, "KalturaConfigurationGroupTagFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "Configuration group tag filter", "properties": { "configurationGroupIdEqual": { "description": "the ID of the configuration group for which to return related configurations group tags", "type": "string" }, "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaConfigurationGroupTagOrderBy" } }, "title": "KalturaConfigurationGroupTagFilter", "type": "object" }, "KalturaConfigurationGroupTagListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Configurations group tags info wrapper", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaConfigurationGroupTag" }, "type": "array" } }, "title": "KalturaConfigurationGroupTagListResponse", "type": "object" }, "KalturaConfigurationIdentifier": { "properties": { "id": { "description": "Identifier", "type": "string" }, "name": { "description": "Name", "type": "string" } }, "title": "KalturaConfigurationIdentifier", "type": "object" }, "KalturaConfigurations": { "properties": { "appName": { "description": "Application name", "type": "string" }, "clientVersion": { "description": "Client version", "type": "string" }, "configurationGroupId": { "description": "Configuration group id", "type": "string" }, "content": { "description": "Content", "type": "string" }, "externalPushId": { "description": "External push id", "type": "string" }, "id": { "description": "`readOnly`\n\nConfiguration id", "readOnly": true, "type": "string" }, "isForceUpdate": { "description": "Is force update", "type": "boolean" }, "partnerId": { "description": "`readOnly`\n\nPartner id", "readOnly": true, "type": "integer" }, "platform": { "description": "Enum Type: `KalturaPlatform`\n\nPlatform: Android/iOS/WindowsPhone/Blackberry/STB/CTV/Other", "enum": [ "Android", "iOS", "WindowsPhone", "Blackberry", "STB", "CTV", "Other" ], "type": "string", "x-enumLabels": [ "ANDROID", "IOS", "WINDOWSPHONE", "BLACKBERRY", "STB", "CTV", "OTHER" ], "x-enumType": "KalturaPlatform" } }, "title": "KalturaConfigurations", "type": "object" }, "KalturaConfigurationsFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "Configuration filter", "properties": { "configurationGroupIdEqual": { "description": "the ID of the configuration group for which to return related configurations", "type": "string" }, "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaConfigurationsOrderBy" } }, "title": "KalturaConfigurationsFilter", "type": "object" }, "KalturaConfigurationsListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Configurations info wrapper", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaConfigurations" }, "type": "array" } }, "title": "KalturaConfigurationsListResponse", "type": "object" }, "KalturaContentResource": { "properties": {}, "title": "KalturaContentResource", "type": "object" }, "KalturaCountry": { "description": "Country details", "properties": { "code": { "description": "Country code", "type": "string" }, "currency": { "description": "Currency code", "type": "string" }, "currencySign": { "description": "Currency Sign", "type": "string" }, "id": { "description": "`readOnly`\n\nCountry identifier", "readOnly": true, "type": "integer" }, "languagesCode": { "description": "All the languages code that are supported in the country", "type": "string" }, "mainLanguageCode": { "description": "The main language code in the country", "type": "string" }, "name": { "description": "Country name", "type": "string" }, "vatPercent": { "description": "Vat Percent in the country", "type": "number" } }, "title": "KalturaCountry", "type": "object" }, "KalturaCountryFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "Country filter", "properties": { "idIn": { "description": "Country identifiers", "type": "string" }, "ipEqual": { "description": "Ip to identify the country", "type": "string" }, "ipEqualCurrent": { "description": "Indicates if to get the IP from the request", "type": "boolean" }, "orderBy": { "enum": [ "NAME_ASC" ], "type": "string", "x-enumLabels": [ "NAME_ASC" ], "x-enumType": "KalturaCountryOrderBy" } }, "title": "KalturaCountryFilter", "type": "object" }, "KalturaCountryListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaCountry" }, "type": "array" } }, "title": "KalturaCountryListResponse", "type": "object" }, "KalturaCoupon": { "description": "Coupon details container", "properties": { "couponsGroup": { "$ref": "#/definitions/KalturaCouponsGroup" }, "status": { "description": "`readOnly`\n\nEnum Type: `KalturaCouponStatus`\n\nCoupon status", "enum": [ "VALID", "NOT_EXISTS", "ALREADY_USED", "EXPIRED", "INACTIVE" ], "readOnly": true, "type": "string", "x-enumLabels": [ "VALID", "NOT_EXISTS", "ALREADY_USED", "EXPIRED", "INACTIVE" ], "x-enumType": "KalturaCouponStatus" } }, "title": "KalturaCoupon", "type": "object" }, "KalturaCouponsGroup": { "description": "Coupons group details", "properties": { "couponGroupType": { "description": "Enum Type: `KalturaCouponGroupType`\n\nType of the coupon group", "enum": [ "COUPON", "GIFT_CARD" ], "type": "string", "x-enumLabels": [ "COUPON", "GIFT_CARD" ], "x-enumType": "KalturaCouponGroupType" }, "descriptions": { "items": { "$ref": "#/definitions/KalturaTranslationToken" }, "type": "array" }, "endDate": { "description": "The last date the coupons in this coupons group are valid", "type": "integer" }, "id": { "description": "`readOnly`\n\nCoupon group identifier", "readOnly": true, "type": "string" }, "maxUsesNumber": { "description": "Maximum number of uses for each coupon in the group", "type": "integer" }, "maxUsesNumberOnRenewableSub": { "description": "Maximum number of uses for each coupon in the group on a renewable subscription", "type": "integer" }, "name": { "description": "Coupon group name", "type": "string" }, "startDate": { "description": "The first date the coupons in this coupons group are valid", "type": "integer" } }, "title": "KalturaCouponsGroup", "type": "object" }, "KalturaCurrency": { "description": "Currency details", "properties": { "code": { "description": "Currency code", "type": "string" }, "isDefault": { "description": "Is the default Currency of the account", "type": "boolean" }, "name": { "description": "Currency name", "type": "string" }, "sign": { "description": "Currency Sign", "type": "string" } }, "title": "KalturaCurrency", "type": "object" }, "KalturaCurrencyFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "Currency filter", "properties": { "codeIn": { "description": "Currency codes", "type": "string" }, "orderBy": { "enum": [ "NAME_ASC", "NAME_DESC", "CODE_ASC", "CODE_DESC" ], "type": "string", "x-enumLabels": [ "NAME_ASC", "NAME_DESC", "CODE_ASC", "CODE_DESC" ], "x-enumType": "KalturaCurrencyOrderBy" } }, "title": "KalturaCurrencyFilter", "type": "object" }, "KalturaCurrencyListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaCurrency" }, "type": "array" } }, "title": "KalturaCurrencyListResponse", "type": "object" }, "KalturaCustomDrmPlaybackPluginData": { "allOf": [ { "$ref": "#/definitions/KalturaDrmPlaybackPluginData" } ], "properties": { "data": { "description": "Custom DRM license data", "type": "string" } }, "title": "KalturaCustomDrmPlaybackPluginData", "type": "object" }, "KalturaDetachedResponseProfile": { "allOf": [ { "$ref": "#/definitions/KalturaBaseResponseProfile" } ], "description": "Define specific base profile response", "properties": { "filter": { "$ref": "#/definitions/KalturaRelatedObjectFilter" }, "name": { "description": "name", "type": "string" }, "relatedProfiles": { "items": { "$ref": "#/definitions/KalturaDetachedResponseProfile" }, "type": "array" } }, "title": "KalturaDetachedResponseProfile", "type": "object" }, "KalturaDeviceBrand": { "description": "Device brand details", "properties": { "deviceFamilyid": { "description": "`readOnly`\n\nDevice family identifier", "readOnly": true, "type": "integer" }, "id": { "description": "`readOnly`\n\nDevice brand identifier", "readOnly": true, "type": "integer" }, "name": { "description": "Device brand name", "type": "string" } }, "title": "KalturaDeviceBrand", "type": "object" }, "KalturaDeviceBrandListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaDeviceBrand" }, "type": "array" } }, "title": "KalturaDeviceBrandListResponse", "type": "object" }, "KalturaDeviceFamily": { "allOf": [ { "$ref": "#/definitions/KalturaDeviceFamilyBase" } ], "description": "Device family details", "properties": {}, "title": "KalturaDeviceFamily", "type": "object" }, "KalturaDeviceFamilyBase": { "description": "Device family details", "properties": { "id": { "description": "`readOnly`\n\nDevice family identifier", "readOnly": true, "type": "integer" }, "name": { "description": "Device family name", "type": "string" } }, "title": "KalturaDeviceFamilyBase", "type": "object" }, "KalturaDeviceFamilyListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaDeviceFamily" }, "type": "array" } }, "title": "KalturaDeviceFamilyListResponse", "type": "object" }, "KalturaDevicePin": { "description": "Device pin", "properties": { "pin": { "description": "Device pin", "type": "string" } }, "title": "KalturaDevicePin", "type": "object" }, "KalturaDeviceRegistrationStatusHolder": { "description": "Holder object for household device registration status enum", "properties": { "status": { "description": "Enum Type: `KalturaDeviceRegistrationStatus`\n\nHousehold device registration status", "enum": [ "not_registered", "registered", "registered_to_another_household" ], "type": "string", "x-enumLabels": [ "NOT_REGISTERED", "REGISTERED", "REGISTERED_TO_ANOTHER_HOUSEHOLD" ], "x-enumType": "KalturaDeviceRegistrationStatus" } }, "title": "KalturaDeviceRegistrationStatusHolder", "type": "object" }, "KalturaDeviceReport": { "allOf": [ { "$ref": "#/definitions/KalturaReport" } ], "properties": { "configurationGroupId": { "description": "Configuration group identifier which the version configuration the device last received belongs to", "type": "string" }, "lastAccessDate": { "description": "Last device configuration request date", "type": "integer" }, "lastAccessIP": { "description": "Last access IP", "type": "string" }, "operationSystem": { "description": "Request header property\r\n Incase value cannot be found - returns "Unknown 0.0"", "type": "string" }, "partnerId": { "description": "Partner unique identifier", "type": "integer" }, "pushParameters": { "$ref": "#/definitions/KalturaPushParams" }, "udid": { "description": "Device unique identifier", "type": "string" }, "userAgent": { "description": "request header property", "type": "string" }, "versionAppName": { "description": "Application version name", "type": "string" }, "versionNumber": { "description": "Application version number", "type": "string" }, "versionPlatform": { "description": "Enum Type: `KalturaPlatform`\n\nApplication version type", "enum": [ "Android", "iOS", "WindowsPhone", "Blackberry", "STB", "CTV", "Other" ], "type": "string", "x-enumLabels": [ "ANDROID", "IOS", "WINDOWSPHONE", "BLACKBERRY", "STB", "CTV", "OTHER" ], "x-enumType": "KalturaPlatform" } }, "title": "KalturaDeviceReport", "type": "object" }, "KalturaDeviceReportFilter": { "allOf": [ { "$ref": "#/definitions/KalturaReportFilter" } ], "description": "Report filter", "properties": { "lastAccessDateGreaterThanOrEqual": { "description": "Filter device configuration later than specific date", "type": "integer" } }, "title": "KalturaDeviceReportFilter", "type": "object" }, "KalturaDiscountModule": { "description": "Discount module", "properties": { "endDate": { "description": "The last date the discount is available", "type": "integer" }, "percent": { "description": "The discount percentage", "type": "number" }, "startDate": { "description": "The first date the discount is available", "type": "integer" } }, "title": "KalturaDiscountModule", "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" }, "KalturaDrmPlaybackPluginData": { "allOf": [ { "$ref": "#/definitions/KalturaPluginData" } ], "properties": { "licenseURL": { "description": "License URL", "type": "string" }, "scheme": { "description": "Enum Type: `KalturaDrmSchemeName`\n\nScheme", "enum": [ "PLAYREADY_CENC", "WIDEVINE_CENC", "FAIRPLAY", "WIDEVINE", "PLAYREADY", "CUSTOM_DRM" ], "type": "string", "x-enumLabels": [ "PLAYREADY_CENC", "WIDEVINE_CENC", "FAIRPLAY", "WIDEVINE", "PLAYREADY", "CUSTOM_DRM" ], "x-enumType": "KalturaDrmSchemeName" } }, "title": "KalturaDrmPlaybackPluginData", "type": "object" }, "KalturaDrmProfile": { "description": "DRM Adapter", "properties": { "adapterUrl": { "description": "DRM adapter URL", "type": "string" }, "id": { "description": "`readOnly`\n\nDRM adapter identifier", "readOnly": true, "type": "integer" }, "isActive": { "description": "DRM adapter active status", "type": "boolean" }, "name": { "description": "DRM adapter name", "type": "string" }, "settings": { "description": "DRM adapter settings", "type": "string" }, "sharedSecret": { "description": "`readOnly`\n\nDRM shared secret", "readOnly": true, "type": "string" }, "systemName": { "description": "DRM adapter alias", "type": "string" } }, "title": "KalturaDrmProfile", "type": "object" }, "KalturaDrmProfileListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaDrmProfile" }, "type": "array" } }, "title": "KalturaDrmProfileListResponse", "type": "object" }, "KalturaDynamicChannel": { "allOf": [ { "$ref": "#/definitions/KalturaChannel" } ], "properties": { "kSql": { "description": "Search assets using dynamic criteria. Provided collection of nested expressions with key, comparison operators, value, and logical conjunction.\r\n Possible keys: any Tag or Meta defined in the system and the following reserved keys: start_date, end_date. \r\n epg_id, media_id - for specific asset IDs.\r\n geo_block - only valid value is "true": When enabled, only assets that are not restriced to the user by geo-block rules will return.\r\n parental_rules - only valid value is "true": When enabled, only assets that the user doesn't need to provide PIN code will return.\r\n user_interests - only valid value is "true". When enabled, only assets that the user defined as his interests (by tags and metas) will return.\r\n epg_channel_id – the channel identifier of the EPG program.\r\n entitled_assets - valid values: "free", "entitled", "both". free - gets only free to watch assets. entitled - only those that the user is implicitly entitled to watch.\r\n Comparison operators: for numerical fields =, >, >=, <, <=, : (in). \r\n For alpha-numerical fields =, != (not), ~ (like), !~, ^ (any word starts with), ^= (phrase starts with), + (exists), !+ (not exists).\r\n Logical conjunction: and, or. \r\n Search values are limited to 20 characters each.\r\n (maximum length of entire filter is 2048 characters)", "type": "string" } }, "title": "KalturaDynamicChannel", "type": "object" }, "KalturaDynamicOrderBy": { "description": "Kaltura Asset Order", "properties": { "name": { "description": "order by name", "type": "string" }, "orderBy": { "description": "Enum Type: `KalturaMetaTagOrderBy`\n\norder by meta asc/desc", "enum": [ "META_ASC", "META_DESC" ], "type": "string", "x-enumLabels": [ "META_ASC", "META_DESC" ], "x-enumType": "KalturaMetaTagOrderBy" } }, "title": "KalturaDynamicOrderBy", "type": "object" }, "KalturaEmailMessage": { "properties": { "bccAddress": { "description": "bcc address - seperated by comma", "type": "string" }, "extraParameters": { "items": { "$ref": "#/definitions/KalturaKeyValue" }, "type": "array" }, "firstName": { "description": "first name", "type": "string" }, "lastName": { "description": "last name", "type": "string" }, "senderFrom": { "description": "sender from", "type": "string" }, "senderName": { "description": "sender name", "type": "string" }, "senderTo": { "description": "sender to", "type": "string" }, "subject": { "description": "email subject", "type": "string" }, "templateName": { "description": "email template name", "type": "string" } }, "title": "KalturaEmailMessage", "type": "object" }, "KalturaEngagement": { "description": "Engagement", "properties": { "adapterDynamicData": { "description": "Engagement adapter dynamic data", "type": "string" }, "adapterId": { "description": "Engagement adapter id", "type": "integer" }, "couponGroupId": { "description": "Coupon GroupId", "type": "integer" }, "id": { "description": "`readOnly`\n\nEngagement id", "readOnly": true, "type": "integer" }, "intervalSeconds": { "description": "Interval (seconds)", "type": "integer" }, "sendTimeInSeconds": { "description": "Send time (seconds)", "type": "integer" }, "totalNumberOfRecipients": { "description": "`readOnly`\n\nTotal number of recipients", "readOnly": true, "type": "integer" }, "type": { "description": "Enum Type: `KalturaEngagementType`\n\nEngagement type", "enum": [ "Churn" ], "type": "string", "x-enumLabels": [ "CHURN" ], "x-enumType": "KalturaEngagementType" }, "userList": { "description": "Manual User list", "type": "string" } }, "title": "KalturaEngagement", "type": "object" }, "KalturaEngagementAdapter": { "allOf": [ { "$ref": "#/definitions/KalturaEngagementAdapterBase" } ], "description": "Engagement Adapter", "properties": { "adapterUrl": { "description": "Engagement adapter adapter URL", "type": "string" }, "engagementAdapterSettings": { "items": { "$ref": "#/definitions/KalturaStringValue" }, "type": "array" }, "isActive": { "description": "Engagement adapter active status", "type": "boolean" }, "providerUrl": { "description": "Engagement provider adapter URL", "type": "string" }, "sharedSecret": { "description": "`readOnly`\n\nShared Secret", "readOnly": true, "type": "string" } }, "title": "KalturaEngagementAdapter", "type": "object" }, "KalturaEngagementAdapterBase": { "description": "Engagement adapter basic", "properties": { "id": { "description": "`readOnly`\n\nEngagement adapter id", "readOnly": true, "type": "integer" }, "name": { "description": "Engagement adapter name", "type": "string" } }, "title": "KalturaEngagementAdapterBase", "type": "object" }, "KalturaEngagementAdapterListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Engagement adapter list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaEngagementAdapter" }, "type": "array" } }, "title": "KalturaEngagementAdapterListResponse", "type": "object" }, "KalturaEngagementFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaEngagementOrderBy" }, "sendTimeGreaterThanOrEqual": { "description": "SendTime GreaterThanOrEqual", "type": "integer" }, "typeIn": { "description": "List of inbox message types to search within.", "type": "string" } }, "title": "KalturaEngagementFilter", "type": "object" }, "KalturaEngagementListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Engagement adapter list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaEngagement" }, "type": "array" } }, "title": "KalturaEngagementListResponse", "type": "object" }, "KalturaEntitlement": { "description": "Entitlement", "properties": { "currentDate": { "description": "`readOnly`\n\nCurrent date", "readOnly": true, "type": "integer" }, "currentUses": { "description": "`readOnly`\n\nThe current number of uses", "readOnly": true, "type": "integer" }, "deviceName": { "description": "`readOnly`\n\nThe name of the device from which the purchase was made", "readOnly": true, "type": "string" }, "deviceUdid": { "description": "`readOnly`\n\nThe UDID of the device from which the purchase was made", "readOnly": true, "type": "string" }, "endDate": { "description": "`readOnly`\n\nThe end date of the entitlement", "readOnly": true, "type": "integer" }, "householdId": { "description": "`readOnly`\n\nThe Identifier of the purchasing household", "readOnly": true, "type": "integer" }, "id": { "description": "`readOnly`\n\nPurchase identifier (for subscriptions and collections only)", "readOnly": true, "type": "integer" }, "isCancelationWindowEnabled": { "description": "`readOnly`\n\nIndicates whether a cancelation window period is enabled", "readOnly": true, "type": "boolean" }, "lastViewDate": { "description": "`readOnly`\n\nThe last date the item was viewed", "readOnly": true, "type": "integer" }, "maxUses": { "description": "`readOnly`\n\nThe maximum number of uses available for this item (only for subscription and PPV)", "readOnly": true, "type": "integer" }, "paymentMethod": { "description": "`readOnly`\n\nEnum Type: `KalturaPaymentMethodType`\n\nPayment Method", "enum": [ "unknown", "credit_card", "sms", "pay_pal", "debit_card", "ideal", "incaso", "gift", "visa", "master_card", "in_app", "m1", "change_subscription", "offline" ], "readOnly": true, "type": "string", "x-enumLabels": [ "UNKNOWN", "CREDIT_CARD", "SMS", "PAY_PAL", "DEBIT_CARD", "IDEAL", "INCASO", "GIFT", "VISA", "MASTER_CARD", "IN_APP", "M1", "CHANGE_SUBSCRIPTION", "OFFLINE" ], "x-enumType": "KalturaPaymentMethodType" }, "productId": { "description": "`readOnly`\n\nProduct identifier", "readOnly": true, "type": "string" }, "purchaseDate": { "description": "`readOnly`\n\nPurchase date", "readOnly": true, "type": "integer" }, "userId": { "description": "`readOnly`\n\nThe Identifier of the purchasing user", "readOnly": true, "type": "string" } }, "title": "KalturaEntitlement", "type": "object" }, "KalturaEntitlementFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "Entitlements filter", "properties": { "entityReferenceEqual": { "description": "Enum Type: `KalturaEntityReferenceBy`\n\nReference type to filter by", "enum": [ "user", "household" ], "type": "string", "x-enumLabels": [ "USER", "HOUSEHOLD" ], "x-enumType": "KalturaEntityReferenceBy" }, "isExpiredEqual": { "description": "Is expired", "type": "boolean" }, "orderBy": { "enum": [ "PURCHASE_DATE_ASC", "PURCHASE_DATE_DESC" ], "type": "string", "x-enumLabels": [ "PURCHASE_DATE_ASC", "PURCHASE_DATE_DESC" ], "x-enumType": "KalturaEntitlementOrderBy" }, "productTypeEqual": { "description": "Enum Type: `KalturaTransactionType`\n\nThe type of the entitlements to return", "enum": [ "ppv", "subscription", "collection" ], "type": "string", "x-enumLabels": [ "PPV", "SUBSCRIPTION", "COLLECTION" ], "x-enumType": "KalturaTransactionType" } }, "title": "KalturaEntitlementFilter", "type": "object" }, "KalturaEntitlementListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Entitlements list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaEntitlement" }, "type": "array" } }, "title": "KalturaEntitlementListResponse", "type": "object" }, "KalturaEntitlementRenewal": { "properties": { "date": { "description": "Next renewal date", "type": "integer" }, "price": { "$ref": "#/definitions/KalturaPrice" }, "purchaseId": { "description": "Puchase ID", "type": "integer" }, "subscriptionId": { "description": "Subscription ID", "type": "integer" } }, "title": "KalturaEntitlementRenewal", "type": "object" }, "KalturaEntitlementRenewalBase": { "properties": { "price": { "description": "Price that is going to be paid on the renewal", "type": "number" }, "purchaseId": { "description": "Puchase ID", "type": "integer" }, "subscriptionId": { "description": "Subscription ID", "type": "integer" } }, "title": "KalturaEntitlementRenewalBase", "type": "object" }, "KalturaExportTask": { "description": "Bulk export task", "properties": { "alias": { "description": "Alias for the task used to solicit an export using API", "type": "string" }, "dataType": { "description": "Enum Type: `KalturaExportDataType`\n\nThe data type exported in this task", "enum": [ "vod", "epg", "users" ], "type": "string", "x-enumLabels": [ "VOD", "EPG", "USERS" ], "x-enumType": "KalturaExportDataType" }, "exportType": { "description": "Enum Type: `KalturaExportType`\n\nType of export batch – full or incremental", "enum": [ "full", "incremental" ], "type": "string", "x-enumLabels": [ "FULL", "INCREMENTAL" ], "x-enumType": "KalturaExportType" }, "filter": { "description": "Filter to apply on the export, utilize KSQL.\r\n Note: KSQL currently applies to media assets only. It cannot be used for USERS filtering", "type": "string" }, "frequency": { "description": "How often the export should occur, reasonable minimum threshold should apply, configurable in minutes", "type": "integer" }, "id": { "description": "`readOnly`\n\nTask identifier", "readOnly": true, "type": "integer" }, "isActive": { "description": "Indicates if the task is active or not", "type": "boolean" }, "name": { "description": "Task display name", "type": "string" }, "notificationUrl": { "description": "The URL for sending a notification when the task's export process is done", "type": "string" }, "vodTypes": { "items": { "$ref": "#/definitions/KalturaIntegerValue" }, "type": "array" } }, "title": "KalturaExportTask", "type": "object" }, "KalturaExportTaskFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "Bulk export tasks filter", "properties": { "idIn": { "description": "Comma separated tasks identifiers", "type": "string" }, "orderBy": { "enum": [ "CREATE_DATE_ASC", "CREATE_DATE_DESC" ], "type": "string", "x-enumLabels": [ "CREATE_DATE_ASC", "CREATE_DATE_DESC" ], "x-enumType": "KalturaExportTaskOrderBy" } }, "title": "KalturaExportTaskFilter", "type": "object" }, "KalturaExportTaskListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Export task list wrapper", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaExportTask" }, "type": "array" } }, "title": "KalturaExportTaskListResponse", "type": "object" }, "KalturaExternalChannelProfile": { "description": "OSS Adapter", "properties": { "enrichments": { "items": { "$ref": "#/definitions/KalturaChannelEnrichmentHolder" }, "type": "array" }, "externalIdentifier": { "description": "External channel external identifier", "type": "string" }, "filterExpression": { "description": "Filter expression", "type": "string" }, "id": { "description": "`readOnly`\n\nExternal channel id", "readOnly": true, "type": "integer" }, "isActive": { "description": "External channel active status", "type": "boolean" }, "name": { "description": "External channel name", "type": "string" }, "recommendationEngineId": { "description": "Recommendation engine id", "type": "integer" } }, "title": "KalturaExternalChannelProfile", "type": "object" }, "KalturaExternalChannelProfileListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "External channel profiles", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaExternalChannelProfile" }, "type": "array" } }, "title": "KalturaExternalChannelProfileListResponse", "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" }, "KalturaFacebookPost": { "allOf": [ { "$ref": "#/definitions/KalturaSocialNetworkComment" } ], "properties": { "comments": { "items": { "$ref": "#/definitions/KalturaSocialNetworkComment" }, "type": "array" }, "link": { "description": "A link associated to the post", "type": "string" } }, "title": "KalturaFacebookPost", "type": "object" }, "KalturaFacebookSocial": { "allOf": [ { "$ref": "#/definitions/KalturaSocial" } ], "properties": {}, "title": "KalturaFacebookSocial", "type": "object" }, "KalturaFairPlayPlaybackPluginData": { "allOf": [ { "$ref": "#/definitions/KalturaDrmPlaybackPluginData" } ], "properties": { "certificate": { "description": "Custom data string", "type": "string" } }, "title": "KalturaFairPlayPlaybackPluginData", "type": "object" }, "KalturaFavorite": { "description": "Favorite details", "properties": { "assetId": { "description": "AssetInfo Model", "type": "integer" }, "createDate": { "description": "`readOnly`\n\nSpecifies when was the favorite created. Date and time represented as epoch.", "readOnly": true, "type": "integer" }, "extraData": { "description": "Extra Value", "type": "string" } }, "title": "KalturaFavorite", "type": "object" }, "KalturaFavoriteFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "Favorite request filter", "properties": { "mediaIdIn": { "description": "Media identifiers from which to filter the favorite assets", "type": "string" }, "mediaTypeEqual": { "description": "Media type to filter by the favorite assets", "type": "integer" }, "orderBy": { "enum": [ "CREATE_DATE_ASC", "CREATE_DATE_DESC" ], "type": "string", "x-enumLabels": [ "CREATE_DATE_ASC", "CREATE_DATE_DESC" ], "x-enumType": "KalturaFavoriteOrderBy" }, "udidEqualCurrent": { "description": "Indicates whether the results should be filtered by origin UDID using the current", "type": "boolean" } }, "title": "KalturaFavoriteFilter", "type": "object" }, "KalturaFavoriteListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Favorite list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaFavorite" }, "type": "array" } }, "title": "KalturaFavoriteListResponse", "type": "object" }, "KalturaFeed": { "properties": { "assetId": { "description": "`readOnly`\n\nAsset identifier", "readOnly": true, "type": "integer" } }, "title": "KalturaFeed", "type": "object" }, "KalturaFilter": { "description": "`abstract`", "discriminator": "objectType", "oneOf": [ { "$ref": "#/definitions/KalturaRelatedObjectFilter" }, { "$ref": "#/definitions/KalturaChannelsFilter" }, { "$ref": "#/definitions/KalturaMediaFileFilter" }, { "$ref": "#/definitions/KalturaImageFilter" }, { "$ref": "#/definitions/KalturaImageTypeFilter" }, { "$ref": "#/definitions/KalturaTagFilter" }, { "$ref": "#/definitions/KalturaAssetStructFilter" }, { "$ref": "#/definitions/KalturaCurrencyFilter" }, { "$ref": "#/definitions/KalturaPersistedFilter" }, { "$ref": "#/definitions/KalturaCollectionFilter" }, { "$ref": "#/definitions/KalturaPricePlanFilter" }, { "$ref": "#/definitions/KalturaPriceDetailsFilter" }, { "$ref": "#/definitions/KalturaSubscriptionSetFilter" }, { "$ref": "#/definitions/KalturaLanguageFilter" }, { "$ref": "#/definitions/KalturaMetaFilter" }, { "$ref": "#/definitions/KalturaCountryFilter" }, { "$ref": "#/definitions/KalturaSearchHistoryFilter" }, { "$ref": "#/definitions/KalturaConfigurationsFilter" }, { "$ref": "#/definitions/KalturaReportFilter" }, { "$ref": "#/definitions/KalturaConfigurationGroupTagFilter" }, { "$ref": "#/definitions/KalturaConfigurationGroupDeviceFilter" }, { "$ref": "#/definitions/KalturaHouseholdDeviceFilter" }, { "$ref": "#/definitions/KalturaRegionFilter" }, { "$ref": "#/definitions/KalturaUserAssetRuleFilter" }, { "$ref": "#/definitions/KalturaParentalRuleFilter" }, { "$ref": "#/definitions/KalturaExportTaskFilter" }, { "$ref": "#/definitions/KalturaAssetCommentFilter" }, { "$ref": "#/definitions/KalturaBookmarkFilter" }, { "$ref": "#/definitions/KalturaSeriesRecordingFilter" }, { "$ref": "#/definitions/KalturaProductPriceFilter" }, { "$ref": "#/definitions/KalturaEntitlementFilter" }, { "$ref": "#/definitions/KalturaTransactionHistoryFilter" }, { "$ref": "#/definitions/KalturaUserRoleFilter" }, { "$ref": "#/definitions/KalturaPaymentMethodProfileFilter" }, { "$ref": "#/definitions/KalturaAssetHistoryFilter" }, { "$ref": "#/definitions/KalturaRecordingContextFilter" }, { "$ref": "#/definitions/KalturaRecordingFilter" }, { "$ref": "#/definitions/KalturaHouseholdUserFilter" }, { "$ref": "#/definitions/KalturaEngagementFilter" }, { "$ref": "#/definitions/KalturaReminderFilter" }, { "$ref": "#/definitions/KalturaFollowTvSeriesFilter" }, { "$ref": "#/definitions/KalturaInboxMessageFilter" }, { "$ref": "#/definitions/KalturaAnnouncementFilter" }, { "$ref": "#/definitions/KalturaPersonalFeedFilter" }, { "$ref": "#/definitions/KalturaTopicFilter" }, { "$ref": "#/definitions/KalturaSubscriptionFilter" }, { "$ref": "#/definitions/KalturaSocialCommentFilter" }, { "$ref": "#/definitions/KalturaSocialFriendActivityFilter" }, { "$ref": "#/definitions/KalturaSocialActionFilter" }, { "$ref": "#/definitions/KalturaFavoriteFilter" }, { "$ref": "#/definitions/KalturaOTTUserFilter" } ], "properties": { "objectType": { "enum": [ "KalturaRelatedObjectFilter", "KalturaChannelsFilter", "KalturaMediaFileFilter", "KalturaImageFilter", "KalturaImageTypeFilter", "KalturaTagFilter", "KalturaAssetStructFilter", "KalturaCurrencyFilter", "KalturaPersistedFilter", "KalturaCollectionFilter", "KalturaPricePlanFilter", "KalturaPriceDetailsFilter", "KalturaSubscriptionSetFilter", "KalturaLanguageFilter", "KalturaMetaFilter", "KalturaCountryFilter", "KalturaSearchHistoryFilter", "KalturaConfigurationsFilter", "KalturaReportFilter", "KalturaConfigurationGroupTagFilter", "KalturaConfigurationGroupDeviceFilter", "KalturaHouseholdDeviceFilter", "KalturaRegionFilter", "KalturaUserAssetRuleFilter", "KalturaParentalRuleFilter", "KalturaExportTaskFilter", "KalturaAssetCommentFilter", "KalturaBookmarkFilter", "KalturaSeriesRecordingFilter", "KalturaProductPriceFilter", "KalturaEntitlementFilter", "KalturaTransactionHistoryFilter", "KalturaUserRoleFilter", "KalturaPaymentMethodProfileFilter", "KalturaAssetHistoryFilter", "KalturaRecordingContextFilter", "KalturaRecordingFilter", "KalturaHouseholdUserFilter", "KalturaEngagementFilter", "KalturaReminderFilter", "KalturaFollowTvSeriesFilter", "KalturaInboxMessageFilter", "KalturaAnnouncementFilter", "KalturaPersonalFeedFilter", "KalturaTopicFilter", "KalturaSubscriptionFilter", "KalturaSocialCommentFilter", "KalturaSocialFriendActivityFilter", "KalturaSocialActionFilter", "KalturaFavoriteFilter", "KalturaOTTUserFilter" ], "type": "string" }, "orderBy": { "description": "order by", "type": "string" } }, "title": "KalturaFilter", "type": "object" }, "KalturaFilterPager": { "description": "The KalturaFilterPager object enables paging management to be applied upon service list actions", "properties": { "pageIndex": { "description": "The page number for which {pageSize} of objects should be retrieved", "type": "integer" }, "pageSize": { "description": "The number of objects to retrieve. Possible range 1 ≤ value ≤ 50. If omitted or value < 1 - will be set to 25. If a value > 50 provided – will be set to 50", "type": "integer" } }, "title": "KalturaFilterPager", "type": "object" }, "KalturaFollowDataBase": { "properties": { "announcementId": { "description": "`readOnly`\n\nAnnouncement Id", "readOnly": true, "type": "integer" }, "followPhrase": { "description": "`readOnly`\n\nFollow Phrase", "readOnly": true, "type": "string" }, "status": { "description": "`readOnly`\n\nStatus", "readOnly": true, "type": "integer" }, "timestamp": { "description": "`readOnly`\n\nTimestamp", "readOnly": true, "type": "integer" }, "title": { "description": "`readOnly`\n\nTitle", "readOnly": true, "type": "string" } }, "title": "KalturaFollowDataBase", "type": "object" }, "KalturaFollowTvSeries": { "allOf": [ { "$ref": "#/definitions/KalturaFollowDataBase" } ], "properties": { "assetId": { "description": "Asset Id", "type": "integer" } }, "title": "KalturaFollowTvSeries", "type": "object" }, "KalturaFollowTvSeriesFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "orderBy": { "enum": [ "START_DATE_DESC", "START_DATE_ASC" ], "type": "string", "x-enumLabels": [ "START_DATE_DESC", "START_DATE_ASC" ], "x-enumType": "KalturaFollowTvSeriesOrderBy" } }, "title": "KalturaFollowTvSeriesFilter", "type": "object" }, "KalturaFollowTvSeriesListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "List of message follow data.", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaFollowTvSeries" }, "type": "array" } }, "title": "KalturaFollowTvSeriesListResponse", "type": "object" }, "KalturaGroupPermission": { "allOf": [ { "$ref": "#/definitions/KalturaPermission" } ], "properties": { "group": { "description": "Permission identifier", "type": "string" } }, "title": "KalturaGroupPermission", "type": "object" }, "KalturaHomeNetwork": { "description": "Home network details", "properties": { "description": { "description": "Home network description", "type": "string" }, "externalId": { "description": "`insertOnly`\n\nHome network identifier", "type": "string" }, "isActive": { "description": "Is home network is active", "type": "boolean" }, "name": { "description": "Home network name", "type": "string" } }, "title": "KalturaHomeNetwork", "type": "object" }, "KalturaHomeNetworkListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Home networks", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaHomeNetwork" }, "type": "array" } }, "title": "KalturaHomeNetworkListResponse", "type": "object" }, "KalturaHousehold": { "description": "Household details", "properties": { "concurrentLimit": { "description": "`readOnly`\n\nThe max number of concurrent streams in the household", "readOnly": true, "type": "integer" }, "description": { "description": "Household description", "type": "string" }, "devicesLimit": { "description": "`readOnly`\n\nThe max number of the devices that can be added to the household", "readOnly": true, "type": "integer" }, "externalId": { "description": "`insertOnly`\n\nHousehold external identifier", "type": "string" }, "frequencyNextDeviceAction": { "description": "`readOnly`\n\nThe next time a device is allowed to be removed from the household (epoch)", "readOnly": true, "type": "integer" }, "frequencyNextUserAction": { "description": "`readOnly`\n\nThe next time a user is allowed to be removed from the household (epoch)", "readOnly": true, "type": "integer" }, "householdLimitationsId": { "description": "`readOnly`\n\nHousehold limitation module identifier", "readOnly": true, "type": "integer" }, "id": { "description": "`readOnly`\n\nHousehold identifier", "readOnly": true, "type": "integer" }, "isFrequencyEnabled": { "description": "`readOnly`\n\nIs household frequency enabled", "readOnly": true, "type": "boolean" }, "name": { "description": "Household name", "type": "string" }, "regionId": { "description": "`readOnly`\n\nThe households region identifier", "readOnly": true, "type": "integer" }, "restriction": { "description": "`readOnly`\n\nEnum Type: `KalturaHouseholdRestriction`\n\nHousehold 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`\n\nsuspended roleId", "readOnly": true, "type": "integer" }, "state": { "description": "`readOnly`\n\nEnum Type: `KalturaHouseholdState`\n\nHousehold 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`\n\nThe max number of the users that can be added to the household", "readOnly": true, "type": "integer" } }, "title": "KalturaHousehold", "type": "object" }, "KalturaHouseholdDevice": { "description": "Device details", "properties": { "activatedOn": { "description": "Device activation date (epoch)", "type": "integer" }, "brandId": { "description": "Device brand identifier", "type": "integer" }, "deviceFamilyId": { "description": "`readOnly`\n\nDevice family id", "readOnly": true, "type": "integer" }, "drm": { "$ref": "#/definitions/KalturaCustomDrmPlaybackPluginData" }, "householdId": { "description": "Household identifier", "type": "integer" }, "name": { "description": "Device name", "type": "string" }, "status": { "description": "`readOnly`\n\nEnum Type: `KalturaDeviceStatus`\n\nDevice state", "enum": [ "PENDING", "ACTIVATED", "NOT_ACTIVATED" ], "readOnly": true, "type": "string", "x-enumLabels": [ "PENDING", "ACTIVATED", "NOT_ACTIVATED" ], "x-enumType": "KalturaDeviceStatus" }, "udid": { "description": "`insertOnly`\n\nDevice UDID", "type": "string" } }, "title": "KalturaHouseholdDevice", "type": "object" }, "KalturaHouseholdDeviceFamilyLimitations": { "allOf": [ { "$ref": "#/definitions/KalturaDeviceFamilyBase" } ], "description": "Device family limitations details", "properties": { "concurrentLimit": { "description": "Max number of streams allowed for this family", "type": "integer" }, "deviceLimit": { "description": "Max number of devices allowed for this family", "type": "integer" }, "frequency": { "description": "Allowed device change frequency code", "type": "integer" } }, "title": "KalturaHouseholdDeviceFamilyLimitations", "type": "object" }, "KalturaHouseholdDeviceFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "deviceFamilyIdIn": { "description": "Device family Ids", "type": "string" }, "householdIdEqual": { "description": "The identifier of the household", "type": "integer" }, "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaHouseholdDeviceOrderBy" } }, "title": "KalturaHouseholdDeviceFilter", "type": "object" }, "KalturaHouseholdDeviceListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaHouseholdDevice" }, "type": "array" } }, "title": "KalturaHouseholdDeviceListResponse", "type": "object" }, "KalturaHouseholdLimitations": { "description": "Household limitations details", "properties": { "concurrentLimit": { "description": "`readOnly`\n\nMax number of streams allowed for the household", "readOnly": true, "type": "integer" }, "deviceFamiliesLimitations": { "items": { "$ref": "#/definitions/KalturaHouseholdDeviceFamilyLimitations" }, "type": "array" }, "deviceFrequency": { "description": "`readOnly`\n\nAllowed device change frequency code", "readOnly": true, "type": "integer" }, "deviceFrequencyDescription": { "description": "`readOnly`\n\nAllowed device change frequency description", "readOnly": true, "type": "string" }, "deviceLimit": { "description": "`readOnly`\n\nMax number of devices allowed for the household", "readOnly": true, "type": "integer" }, "id": { "description": "`readOnly`\n\nHousehold limitation module identifier", "readOnly": true, "type": "integer" }, "name": { "description": "`readOnly`\n\nHousehold limitation module name", "readOnly": true, "type": "string" }, "npvrQuotaInSeconds": { "description": "`readOnly`\n\nAllowed NPVR Quota in Seconds", "readOnly": true, "type": "integer" }, "userFrequency": { "description": "`readOnly`\n\nAllowed user change frequency code", "readOnly": true, "type": "integer" }, "userFrequencyDescription": { "description": "`readOnly`\n\nAllowed user change frequency description", "readOnly": true, "type": "string" }, "usersLimit": { "description": "`readOnly`\n\nMax number of users allowed for the household", "readOnly": true, "type": "integer" } }, "title": "KalturaHouseholdLimitations", "type": "object" }, "KalturaHouseholdPaymentGateway": { "properties": { "id": { "description": "`readOnly`\n\npayment gateway id", "readOnly": true, "type": "integer" }, "isDefault": { "description": "Payment gateway default (true/false)", "type": "boolean" }, "name": { "description": "payment gateway name", "type": "string" }, "selectedBy": { "description": "Enum Type: `KalturaHouseholdPaymentGatewaySelectedBy`\n\ndistinction payment gateway selected by account or household", "enum": [ "none", "account", "household" ], "type": "string", "x-enumLabels": [ "NONE", "ACCOUNT", "HOUSEHOLD" ], "x-enumType": "KalturaHouseholdPaymentGatewaySelectedBy" } }, "title": "KalturaHouseholdPaymentGateway", "type": "object" }, "KalturaHouseholdPaymentGatewayListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "List of household payment gateways.", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaHouseholdPaymentGateway" }, "type": "array" } }, "title": "KalturaHouseholdPaymentGatewayListResponse", "type": "object" }, "KalturaHouseholdPaymentMethod": { "properties": { "details": { "description": "Description of the payment method details", "type": "string" }, "externalId": { "description": "`insertOnly`\n\nExternal identifier for the household payment method", "type": "string" }, "id": { "description": "`readOnly`\n\nHousehold payment method identifier (internal)", "readOnly": true, "type": "integer" }, "isDefault": { "description": "`readOnly`\n\nindicates whether the payment method is set as default for the household", "readOnly": true, "type": "boolean" }, "paymentGatewayId": { "description": "Payment-gateway identifier", "type": "integer" }, "paymentMethodProfileId": { "description": "Payment method profile identifier", "type": "integer" } }, "title": "KalturaHouseholdPaymentMethod", "type": "object" }, "KalturaHouseholdPaymentMethodListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "List of household payment methods.", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaHouseholdPaymentMethod" }, "type": "array" } }, "title": "KalturaHouseholdPaymentMethodListResponse", "type": "object" }, "KalturaHouseholdPremiumService": { "allOf": [ { "$ref": "#/definitions/KalturaPremiumService" } ], "description": "Houshold premium service", "properties": {}, "title": "KalturaHouseholdPremiumService", "type": "object" }, "KalturaHouseholdPremiumServiceListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Premium services list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaHouseholdPremiumService" }, "type": "array" } }, "title": "KalturaHouseholdPremiumServiceListResponse", "type": "object" }, "KalturaHouseholdQuota": { "properties": { "availableQuota": { "description": "`readOnly`\n\nAvailable quota that household has remaining", "readOnly": true, "type": "integer" }, "householdId": { "description": "`readOnly`\n\nHousehold identifier", "readOnly": true, "type": "integer" }, "totalQuota": { "description": "`readOnly`\n\nTotal quota that is allocated to the household", "readOnly": true, "type": "integer" } }, "title": "KalturaHouseholdQuota", "type": "object" }, "KalturaHouseholdUser": { "description": "Household user", "properties": { "householdId": { "description": "The identifier of the household", "type": "integer" }, "householdMasterUsername": { "description": "`insertOnly`\n\nThe username of the household master for adding a user in status pending for the household master to approve", "type": "string" }, "isDefault": { "description": "`readOnly`\n\nTrue if the user is a default user", "readOnly": true, "type": "boolean" }, "isMaster": { "description": "True if the user added as master use", "type": "boolean" }, "status": { "description": "`readOnly`\n\nEnum Type: `KalturaHouseholdUserStatus`\n\nThe status of the user in the household", "enum": [ "OK", "PENDING" ], "readOnly": true, "type": "string", "x-enumLabels": [ "OK", "PENDING" ], "x-enumType": "KalturaHouseholdUserStatus" }, "userId": { "description": "The identifier of the user", "type": "string" } }, "title": "KalturaHouseholdUser", "type": "object" }, "KalturaHouseholdUserFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "householdIdEqual": { "description": "The identifier of the household", "type": "integer" }, "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaHouseholdUserOrderBy" } }, "title": "KalturaHouseholdUserFilter", "type": "object" }, "KalturaHouseholdUserListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Household users list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaHouseholdUser" }, "type": "array" } }, "title": "KalturaHouseholdUserListResponse", "type": "object" }, "KalturaImage": { "properties": { "contentId": { "description": "`readOnly`\n\nImage content ID", "readOnly": true, "type": "string" }, "id": { "description": "`readOnly`\n\nImage ID", "readOnly": true, "type": "integer" }, "imageObjectId": { "description": "ID of the object the image is related to", "type": "integer" }, "imageObjectType": { "description": "Enum Type: `KalturaImageObjectType`\n\nType of the object the image is related to", "enum": [ "MEDIA_ASSET", "PROGRAM_ASSET", "CHANNEL", "CATEGORY", "PARTNER", "IMAGE_TYPE" ], "type": "string", "x-enumLabels": [ "MEDIA_ASSET", "PROGRAM_ASSET", "CHANNEL", "CATEGORY", "PARTNER", "IMAGE_TYPE" ], "x-enumType": "KalturaImageObjectType" }, "imageTypeId": { "description": "Image type ID", "type": "integer" }, "isDefault": { "description": "`readOnly`\n\nSpecifies if the image is default for atleast one image type.", "readOnly": true, "type": "boolean" }, "status": { "description": "`readOnly`\n\nEnum Type: `KalturaImageStatus`\n\nImage content status", "enum": [ "PENDING", "READY", "FAILED" ], "readOnly": true, "type": "string", "x-enumLabels": [ "PENDING", "READY", "FAILED" ], "x-enumType": "KalturaImageStatus" }, "url": { "description": "`readOnly`\n\nImage URL", "readOnly": true, "type": "string" }, "version": { "description": "`readOnly`\n\nImage version", "readOnly": true, "type": "string" } }, "title": "KalturaImage", "type": "object" }, "KalturaImageFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "idIn": { "description": "IDs to filter by", "type": "string" }, "imageObjectIdEqual": { "description": "ID of the object the is related to, to filter by", "type": "integer" }, "imageObjectTypeEqual": { "description": "Enum Type: `KalturaImageObjectType`\n\nType of the object the image is related to, to filter by", "enum": [ "MEDIA_ASSET", "PROGRAM_ASSET", "CHANNEL", "CATEGORY", "PARTNER", "IMAGE_TYPE" ], "type": "string", "x-enumLabels": [ "MEDIA_ASSET", "PROGRAM_ASSET", "CHANNEL", "CATEGORY", "PARTNER", "IMAGE_TYPE" ], "x-enumType": "KalturaImageObjectType" }, "isDefaultEqual": { "description": "Filter images that are default on atleast on image type or not default at any", "type": "boolean" }, "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaImageOrderBy" } }, "title": "KalturaImageFilter", "type": "object" }, "KalturaImageListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaImage" }, "type": "array" } }, "title": "KalturaImageListResponse", "type": "object" }, "KalturaImageType": { "description": "Image type", "properties": { "defaultImageId": { "description": "Default image ID", "type": "integer" }, "helpText": { "description": "Help text", "type": "string" }, "id": { "description": "`readOnly`\n\nImage type ID", "readOnly": true, "type": "integer" }, "name": { "description": "Name", "type": "string" }, "ratioId": { "description": "Ration ID", "type": "integer" }, "systemName": { "description": "System name", "type": "string" } }, "title": "KalturaImageType", "type": "object" }, "KalturaImageTypeFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "idIn": { "description": "IDs to filter by", "type": "string" }, "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaImageTypeOrderBy" }, "ratioIdIn": { "description": "Ratio IDs to filter by", "type": "string" } }, "title": "KalturaImageTypeFilter", "type": "object" }, "KalturaImageTypeListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaImageType" }, "type": "array" } }, "title": "KalturaImageTypeListResponse", "type": "object" }, "KalturaInboxMessage": { "properties": { "createdAt": { "description": "`readOnly`\n\nCreated at", "readOnly": true, "type": "integer" }, "id": { "description": "`readOnly`\n\nmessage id", "readOnly": true, "type": "string" }, "message": { "description": "message", "type": "string" }, "status": { "description": "`readOnly`\n\nEnum Type: `KalturaInboxMessageStatus`\n\nStatus", "enum": [ "Unread", "Read", "Deleted" ], "readOnly": true, "type": "string", "x-enumLabels": [ "UNREAD", "READ", "DELETED" ], "x-enumType": "KalturaInboxMessageStatus" }, "type": { "description": "Enum Type: `KalturaInboxMessageType`\n\nType", "enum": [ "SystemAnnouncement", "Followed", "Engagement", "Interest" ], "type": "string", "x-enumLabels": [ "SYSTEMANNOUNCEMENT", "FOLLOWED", "ENGAGEMENT", "INTEREST" ], "x-enumType": "KalturaInboxMessageType" }, "url": { "description": "url", "type": "string" } }, "title": "KalturaInboxMessage", "type": "object" }, "KalturaInboxMessageFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "createdAtGreaterThanOrEqual": { "description": "createdAtGreaterThanOrEqual", "type": "integer" }, "createdAtLessThanOrEqual": { "description": "createdAtLessThanOrEqual", "type": "integer" }, "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaInboxMessageOrderBy" }, "typeIn": { "description": "List of inbox message types to search within.", "type": "string" } }, "title": "KalturaInboxMessageFilter", "type": "object" }, "KalturaInboxMessageListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "List of inbox message.", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaInboxMessage" }, "type": "array" } }, "title": "KalturaInboxMessageListResponse", "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" }, "KalturaIntegerValueListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Integer list wrapper", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaIntegerValue" }, "type": "array" } }, "title": "KalturaIntegerValueListResponse", "type": "object" }, "KalturaKeyValue": { "properties": { "key": { "description": "Key", "type": "string" }, "value": { "description": "Value", "type": "string" } }, "title": "KalturaKeyValue", "type": "object" }, "KalturaLanguage": { "description": "Language details", "properties": { "code": { "description": "Language code", "type": "string" }, "direction": { "description": "Language direction (LTR/RTL)", "type": "string" }, "isDefault": { "description": "Is the default language of the account", "type": "boolean" }, "name": { "description": "Language name", "type": "string" }, "systemName": { "description": "Language system name", "type": "string" } }, "title": "KalturaLanguage", "type": "object" }, "KalturaLanguageFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "Language filter", "properties": { "codeIn": { "description": "Language codes", "type": "string" }, "orderBy": { "enum": [ "SYSTEM_NAME_ASC", "SYSTEM_NAME_DESC", "CODE_ASC", "CODE_DESC" ], "type": "string", "x-enumLabels": [ "SYSTEM_NAME_ASC", "SYSTEM_NAME_DESC", "CODE_ASC", "CODE_DESC" ], "x-enumType": "KalturaLanguageOrderBy" } }, "title": "KalturaLanguageFilter", "type": "object" }, "KalturaLanguageListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaLanguage" }, "type": "array" } }, "title": "KalturaLanguageListResponse", "type": "object" }, "KalturaLicensedUrl": { "properties": { "altUrl": { "description": "An alternate URL to use in case the main fails", "type": "string" }, "mainUrl": { "description": "Main licensed URL", "type": "string" } }, "title": "KalturaLicensedUrl", "type": "object" }, "KalturaLicensedUrlBaseRequest": { "properties": { "assetId": { "description": "Asset identifier", "type": "string" } }, "title": "KalturaLicensedUrlBaseRequest", "type": "object" }, "KalturaLicensedUrlEpgRequest": { "allOf": [ { "$ref": "#/definitions/KalturaLicensedUrlMediaRequest" } ], "properties": { "startDate": { "description": "The start date of the stream (epoch)", "type": "integer" }, "streamType": { "description": "Enum Type: `KalturaStreamType`\n\nThe stream type to get the URL for", "enum": [ "catchup", "start_over", "trick_play" ], "type": "string", "x-enumLabels": [ "CATCHUP", "START_OVER", "TRICK_PLAY" ], "x-enumType": "KalturaStreamType" } }, "title": "KalturaLicensedUrlEpgRequest", "type": "object" }, "KalturaLicensedUrlMediaRequest": { "allOf": [ { "$ref": "#/definitions/KalturaLicensedUrlBaseRequest" } ], "properties": { "baseUrl": { "description": "Base URL for the licensed URLs", "type": "string" }, "contentId": { "description": "Identifier of the content to get the link for (file identifier)", "type": "integer" } }, "title": "KalturaLicensedUrlMediaRequest", "type": "object" }, "KalturaLicensedUrlRecordingRequest": { "allOf": [ { "$ref": "#/definitions/KalturaLicensedUrlBaseRequest" } ], "properties": { "fileType": { "description": "The file type for the URL", "type": "string" } }, "title": "KalturaLicensedUrlRecordingRequest", "type": "object" }, "KalturaLinearMediaAsset": { "allOf": [ { "$ref": "#/definitions/KalturaMediaAsset" } ], "description": "Linear media asset info", "properties": { "epgChannelId": { "description": "Id of epg channel", "type": "integer" } }, "title": "KalturaLinearMediaAsset", "type": "object" }, "KalturaListResponse": { "description": "Base list wrapper", "properties": { "totalCount": { "description": "Total items", "type": "integer" } }, "title": "KalturaListResponse", "type": "object" }, "KalturaLoginResponse": { "properties": { "loginSession": { "$ref": "#/definitions/KalturaLoginSession" }, "user": { "$ref": "#/definitions/KalturaOTTUser" } }, "title": "KalturaLoginResponse", "type": "object" }, "KalturaLoginSession": { "description": "Login response", "properties": { "ks": { "description": "Access token in a KS format", "type": "string" } }, "title": "KalturaLoginSession", "type": "object" }, "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" }, "KalturaManualChannel": { "allOf": [ { "$ref": "#/definitions/KalturaChannel" } ], "properties": { "mediaIds": { "description": "A list of comma separated media ids associated with this channel, according to the order of the medias in the channel.", "type": "string" } }, "title": "KalturaManualChannel", "type": "object" }, "KalturaMediaAsset": { "allOf": [ { "$ref": "#/definitions/KalturaAsset" } ], "description": "Media-asset info", "properties": { "deviceRuleId": { "description": "Device rule identifier", "type": "integer" }, "entryId": { "description": "Entry Identifier", "type": "string" }, "externalIds": { "description": "External identifiers", "type": "string" }, "geoBlockRuleId": { "description": "Geo block rule identifier", "type": "integer" }, "status": { "description": "The media asset status", "type": "boolean" } }, "title": "KalturaMediaAsset", "type": "object" }, "KalturaMediaFile": { "description": "Media file details", "properties": { "additionalData": { "description": "Additional Data", "type": "string" }, "altExternalId": { "description": "Alternative external identifier for the media file", "type": "string" }, "altStreamingCode": { "description": "Alternative streaming code", "type": "string" }, "alternativeCdnAdapaterProfileId": { "description": "Alternative cdn adapter profile identifier", "type": "integer" }, "assetId": { "description": "Unique identifier for the asset", "type": "integer" }, "cdnAdapaterProfileId": { "description": "cdn adapter profile identifier", "type": "integer" }, "duration": { "description": "Duration of the media file", "type": "integer" }, "endDate": { "description": "EndDate", "type": "integer" }, "externalId": { "description": "External identifier for the media file", "type": "string" }, "externalStoreId": { "description": "ExternalStoreId", "type": "string" }, "fileSize": { "description": "File size", "type": "integer" }, "id": { "description": "`readOnly`\n\nFile unique identifier", "readOnly": true, "type": "integer" }, "isDefaultLanguage": { "description": "IsDefaultLanguage", "type": "boolean" }, "language": { "description": "Language", "type": "string" }, "orderNum": { "description": "OrderNum", "type": "integer" }, "outputProtecationLevel": { "description": "OutputProtecationLevel", "type": "string" }, "startDate": { "description": "StartDate", "type": "integer" }, "status": { "description": "The media file status", "type": "boolean" }, "typeId": { "description": "Device types identifier as defined in the system", "type": "integer" }, "url": { "description": "URL of the media file to be played", "type": "string" } }, "title": "KalturaMediaFile", "type": "object" }, "KalturaMediaFileFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "assetIdEqual": { "description": "Asset identifier to filter by", "type": "integer" }, "idEqual": { "description": "Asset file identifier to filter by", "type": "integer" }, "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaMediaFileOrderBy" } }, "title": "KalturaMediaFileFilter", "type": "object" }, "KalturaMediaFileListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Media-file list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaMediaFile" }, "type": "array" } }, "title": "KalturaMediaFileListResponse", "type": "object" }, "KalturaMediaFileType": { "description": "Media-file type", "properties": { "audioCodecs": { "description": "List of comma separated audio codecs", "type": "string" }, "createDate": { "description": "`readOnly`\n\nSpecifies when was the type was created. Date and time represented as epoch.", "readOnly": true, "type": "integer" }, "description": { "description": "Unique description", "type": "string" }, "drmProfileId": { "description": "`insertOnly`\n\nDRM adapter-profile identifier, use -1 for uDRM, 0 for no DRM.", "type": "integer" }, "id": { "description": "`readOnly`\n\nUnique identifier", "readOnly": true, "type": "integer" }, "isTrailer": { "description": "`insertOnly`\n\nSpecifies whether playback as trailer is allowed", "type": "boolean" }, "name": { "description": "Unique name", "type": "string" }, "quality": { "description": "Enum Type: `KalturaMediaFileTypeQuality`\n\nMedia file type quality", "enum": [ "ADAPTIVE", "SD", "HD_720", "HD_1080", "UHD_4K" ], "type": "string", "x-enumLabels": [ "ADAPTIVE", "SD", "HD_720", "HD_1080", "UHD_4K" ], "x-enumType": "KalturaMediaFileTypeQuality" }, "status": { "description": "Indicates if media-file type is active or disabled", "type": "boolean" }, "streamerType": { "description": "`insertOnly`\n\nEnum Type: `KalturaMediaFileStreamerType`\n\nDefines playback streamer type", "enum": [ "APPLE_HTTP", "MPEG_DASH", "URL", "SMOOTH_STREAMING" ], "type": "string", "x-enumLabels": [ "APPLE_HTTP", "MPEG_DASH", "URL", "SMOOTH_STREAMING" ], "x-enumType": "KalturaMediaFileStreamerType" }, "updateDate": { "description": "`readOnly`\n\nSpecifies when was the type last updated. Date and time represented as epoch.", "readOnly": true, "type": "integer" }, "videoCodecs": { "description": "List of comma separated video codecs", "type": "string" } }, "title": "KalturaMediaFileType", "type": "object" }, "KalturaMediaFileTypeListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Media-file types list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaMediaFileType" }, "type": "array" } }, "title": "KalturaMediaFileTypeListResponse", "type": "object" }, "KalturaMediaImage": { "description": "Image details", "properties": { "height": { "description": "Image height", "type": "integer" }, "id": { "description": "`readOnly`\n\nImage ID", "readOnly": true, "type": "string" }, "isDefault": { "description": "Determined whether image was taken from default configuration or not", "type": "boolean" }, "ratio": { "description": "Image aspect ratio", "type": "string" }, "url": { "description": "Image URL", "type": "string" }, "version": { "description": "Image Version", "type": "integer" }, "width": { "description": "Image width", "type": "integer" } }, "title": "KalturaMediaImage", "type": "object" }, "KalturaMessageTemplate": { "properties": { "action": { "description": "an optional action", "type": "string" }, "dateFormat": { "description": "Default date format for the date & time entries used in the template", "type": "string" }, "mailSubject": { "description": "Mail subject", "type": "string" }, "mailTemplate": { "description": "Mail template name", "type": "string" }, "message": { "description": "The message template with placeholders", "type": "string" }, "messageType": { "description": "Enum Type: `KalturaMessageTemplateType`\n\nTemplate type. Possible values: Series, Reminder,Churn, SeriesReminder", "enum": [ "Series", "Reminder", "Churn", "SeriesReminder", "InterestVod", "InterestEPG" ], "type": "string", "x-enumLabels": [ "SERIES", "REMINDER", "CHURN", "SERIESREMINDER", "INTERESTVOD", "INTERESTEPG" ], "x-enumType": "KalturaMessageTemplateType" }, "ratioId": { "description": "Ratio identifier", "type": "string" }, "sound": { "description": "Sound file name to play upon message arrival to the device (if supported by target device)", "type": "string" }, "url": { "description": "URL template for deep linking. Example - /app/location/{mediaId}", "type": "string" } }, "title": "KalturaMessageTemplate", "type": "object" }, "KalturaMeta": { "description": "Asset meta", "properties": { "createDate": { "description": "`readOnly`\n\nSpecifies when was the meta was created. Date and time represented as epoch.", "readOnly": true, "type": "integer" }, "dataType": { "description": "`insertOnly`\n\nEnum Type: `KalturaMetaDataType`\n\nMeta data type", "enum": [ "STRING", "MULTILINGUAL_STRING", "NUMBER", "BOOLEAN", "DATE" ], "type": "string", "x-enumLabels": [ "STRING", "MULTILINGUAL_STRING", "NUMBER", "BOOLEAN", "DATE" ], "x-enumType": "KalturaMetaDataType" }, "features": { "description": "List of supported features", "type": "string" }, "helpText": { "description": "The help text of the meta to be displayed on the UI.", "type": "string" }, "id": { "description": "`readOnly`\n\nMeta id", "readOnly": true, "type": "string" }, "isProtected": { "description": "`insertOnly`\n\nIs the meta protected by the system", "type": "boolean" }, "multilingualName": { "items": { "$ref": "#/definitions/KalturaTranslationToken" }, "type": "array" }, "multipleValue": { "description": "Does the meta contain multiple values", "type": "boolean" }, "name": { "description": "Meta name for the partner", "type": "string" }, "parentId": { "description": "Parent meta id", "type": "string" }, "systemName": { "description": "`insertOnly`\n\nMeta system name for the partner", "type": "string" }, "updateDate": { "description": "`readOnly`\n\nSpecifies when was the meta last updated. Date and time represented as epoch.", "readOnly": true, "type": "integer" } }, "title": "KalturaMeta", "type": "object" }, "KalturaMetaFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "Meta filter", "properties": { "assetStructIdEqual": { "description": "Filter Metas that are contained in a specific asset struct", "type": "integer" }, "dataTypeEqual": { "description": "Enum Type: `KalturaMetaDataType`\n\nMeta data type to filter by", "enum": [ "STRING", "MULTILINGUAL_STRING", "NUMBER", "BOOLEAN", "DATE" ], "type": "string", "x-enumLabels": [ "STRING", "MULTILINGUAL_STRING", "NUMBER", "BOOLEAN", "DATE" ], "x-enumType": "KalturaMetaDataType" }, "idIn": { "description": "Comma separated identifiers", "type": "string" }, "multipleValueEqual": { "description": "Filter metas by multipleValueEqual value", "type": "boolean" }, "orderBy": { "enum": [ "NAME_ASC", "NAME_DESC", "SYSTEM_NAME_ASC", "SYSTEM_NAME_DESC", "CREATE_DATE_ASC", "CREATE_DATE_DESC", "UPDATE_DATE_ASC", "UPDATE_DATE_DESC" ], "type": "string", "x-enumLabels": [ "NAME_ASC", "NAME_DESC", "SYSTEM_NAME_ASC", "SYSTEM_NAME_DESC", "CREATE_DATE_ASC", "CREATE_DATE_DESC", "UPDATE_DATE_ASC", "UPDATE_DATE_DESC" ], "x-enumType": "KalturaMetaOrderBy" } }, "title": "KalturaMetaFilter", "type": "object" }, "KalturaMetaListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Meta list response", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaMeta" }, "type": "array" } }, "title": "KalturaMetaListResponse", "type": "object" }, "KalturaMultilingualString": { "description": "Translated string", "properties": { "values": { "items": { "$ref": "#/definitions/KalturaTranslationToken" }, "type": "array" } }, "title": "KalturaMultilingualString", "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" }, "KalturaMultilingualStringValueArray": { "description": "Array of translated strings", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaMultilingualStringValue" }, "type": "array" } }, "title": "KalturaMultilingualStringValueArray", "type": "object" }, "KalturaNetworkActionStatus": { "properties": { "network": { "description": "Enum Type: `KalturaSocialNetwork`\n\nSocial network", "enum": [ "facebook" ], "type": "string", "x-enumLabels": [ "FACEBOOK" ], "x-enumType": "KalturaSocialNetwork" }, "status": { "description": "Enum Type: `KalturaSocialStatus`\n\nStatus", "enum": [ "error", "ok", "user_does_not_exist", "no_user_social_settings_found", "asset_already_liked", "not_allowed", "invalid_parameters", "no_facebook_action", "asset_already_rated", "asset_dose_not_exists", "invalid_platform_request", "invalid_access_token" ], "type": "string", "x-enumLabels": [ "ERROR", "OK", "USER_DOES_NOT_EXIST", "NO_USER_SOCIAL_SETTINGS_FOUND", "ASSET_ALREADY_LIKED", "NOT_ALLOWED", "INVALID_PARAMETERS", "NO_FACEBOOK_ACTION", "ASSET_ALREADY_RATED", "ASSET_DOSE_NOT_EXISTS", "INVALID_PLATFORM_REQUEST", "INVALID_ACCESS_TOKEN" ], "x-enumType": "KalturaSocialStatus" } }, "title": "KalturaNetworkActionStatus", "type": "object" }, "KalturaNotificationsPartnerSettings": { "properties": { "automaticIssueFollowNotification": { "description": "Automatic issue follow notification", "type": "boolean" }, "churnMailSubject": { "description": "Churn mail subject", "type": "string" }, "churnMailTemplateName": { "description": "Churn mail template name", "type": "string" }, "inboxEnabled": { "description": "Inbox enabled", "type": "boolean" }, "mailNotificationAdapterId": { "description": "Mail notification adapter identifier", "type": "integer" }, "mailSenderName": { "description": "Mail sender name", "type": "string" }, "messageTTLDays": { "description": "Message TTL in days", "type": "integer" }, "pushAdapterUrl": { "description": "Push adapter URL", "type": "string" }, "pushEndHour": { "description": "Window end time (UTC) for send automated push messages", "type": "integer" }, "pushNotificationEnabled": { "description": "Push notification capability is enabled for the account", "type": "boolean" }, "pushStartHour": { "description": "Window start time (UTC) for send automated push messages", "type": "integer" }, "pushSystemAnnouncementsEnabled": { "description": "System announcement capability is enabled for the account", "type": "boolean" }, "reminderEnabled": { "description": "Reminder enabled", "type": "boolean" }, "reminderOffsetSec": { "description": "Offset time (UTC) in seconds for send reminder", "type": "integer" }, "senderEmail": { "description": "Sender email", "type": "string" }, "smsEnabled": { "description": "SMS capability is enabled for the account", "type": "boolean" }, "topicExpirationDurationDays": { "description": "Topic expiration duration in days", "type": "integer" } }, "title": "KalturaNotificationsPartnerSettings", "type": "object" }, "KalturaNotificationsSettings": { "properties": { "mailEnabled": { "description": "Specify if the user wants to receive mail notifications or not", "type": "boolean" }, "pushFollowEnabled": { "description": "Specify if the user will be notified for followed content via push. (requires push_notification_enabled to be enabled)", "type": "boolean" }, "pushNotificationEnabled": { "description": "Specify if the user want to receive push notifications or not", "type": "boolean" }, "smsEnabled": { "description": "Specify if the user wants to receive SMS notifications or not", "type": "boolean" } }, "title": "KalturaNotificationsSettings", "type": "object" }, "KalturaNpvrPremiumService": { "allOf": [ { "$ref": "#/definitions/KalturaPremiumService" } ], "description": "Npvr Premium Service", "properties": { "quotaInMinutes": { "description": "`readOnly`\n\nQuota in minutes", "readOnly": true, "type": "integer" } }, "title": "KalturaNpvrPremiumService", "type": "object" }, "KalturaOSSAdapterBaseProfile": { "description": "OSS adapter basic", "properties": { "id": { "description": "`readOnly`\n\nOSS adapter id", "readOnly": true, "type": "integer" }, "name": { "description": "OSS adapter name", "type": "string" } }, "title": "KalturaOSSAdapterBaseProfile", "type": "object" }, "KalturaOSSAdapterProfile": { "allOf": [ { "$ref": "#/definitions/KalturaOSSAdapterBaseProfile" } ], "description": "OSS Adapter", "properties": { "adapterUrl": { "description": "OSS adapter adapter URL", "type": "string" }, "externalIdentifier": { "description": "OSS adapter external identifier", "type": "string" }, "isActive": { "description": "OSS adapter active status", "type": "boolean" }, "ossAdapterSettings": { "items": { "$ref": "#/definitions/KalturaStringValue" }, "type": "array" }, "sharedSecret": { "description": "`readOnly`\n\nShared Secret", "readOnly": true, "type": "string" } }, "title": "KalturaOSSAdapterProfile", "type": "object" }, "KalturaOSSAdapterProfileListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "OSS adapter-profiles list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaOSSAdapterProfile" }, "type": "array" } }, "title": "KalturaOSSAdapterProfileListResponse", "type": "object" }, "KalturaOTTCategory": { "description": "Category details", "properties": { "channels": { "items": { "$ref": "#/definitions/KalturaChannel" }, "type": "array" }, "childCategories": { "items": { "$ref": "#/definitions/KalturaOTTCategory" }, "type": "array" }, "id": { "description": "`readOnly`\n\nUnique identifier for the category", "readOnly": true, "type": "integer" }, "images": { "items": { "$ref": "#/definitions/KalturaMediaImage" }, "type": "array" }, "name": { "description": "Category name", "type": "string" }, "parentCategoryId": { "description": "Category parent identifier", "type": "integer" } }, "title": "KalturaOTTCategory", "type": "object" }, "KalturaOTTUser": { "allOf": [ { "$ref": "#/definitions/KalturaBaseOTTUser" } ], "description": "User", "properties": { "address": { "description": "Address", "type": "string" }, "affiliateCode": { "description": "`insertOnly`\n\nAffiliate 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`\n\nHousehold identifier", "readOnly": true, "type": "integer" }, "isHouseholdMaster": { "description": "`readOnly`\n\nIs the user the household master", "readOnly": true, "type": "boolean" }, "phone": { "description": "Phone", "type": "string" }, "suspensionState": { "description": "`readOnly`\n\nEnum Type: `KalturaHouseholdSuspensionState`\n\nSuspension state", "enum": [ "NOT_SUSPENDED", "SUSPENDED" ], "readOnly": true, "type": "string", "x-enumLabels": [ "NOT_SUSPENDED", "SUSPENDED" ], "x-enumType": "KalturaHouseholdSuspensionState" }, "userState": { "description": "`readOnly`\n\nEnum Type: `KalturaUserState`\n\nUser 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" }, "KalturaOTTUserDynamicData": { "description": "User dynamic data", "properties": { "key": { "description": "Key", "type": "string" }, "userId": { "description": "`readOnly`\n\nUser identifier", "readOnly": true, "type": "string" }, "value": { "$ref": "#/definitions/KalturaStringValue" } }, "title": "KalturaOTTUserDynamicData", "type": "object" }, "KalturaOTTUserFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "OTT User filter", "properties": { "externalIdEqual": { "description": "User external identifier", "type": "string" }, "idIn": { "description": "List of user identifiers separated by ','", "type": "string" }, "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaOTTUserOrderBy" }, "usernameEqual": { "description": "Username", "type": "string" } }, "title": "KalturaOTTUserFilter", "type": "object" }, "KalturaOTTUserListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Users list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaOTTUser" }, "type": "array" } }, "title": "KalturaOTTUserListResponse", "type": "object" }, "KalturaOTTUserType": { "description": "User type", "properties": { "description": { "description": "User type description", "type": "string" }, "id": { "description": "`readOnly`\n\nUser type identifier", "readOnly": true, "type": "integer" } }, "title": "KalturaOTTUserType", "type": "object" }, "KalturaObjectBase": {}, "KalturaPPVItemPriceDetails": { "description": "PPV item price details", "properties": { "collectionId": { "description": "The identifier of the relevant collection", "type": "string" }, "discountEndDate": { "description": "Discount end date", "type": "integer" }, "endDate": { "description": "If the item already purchased - until when the user can watch the item", "type": "integer" }, "firstDeviceName": { "description": "If the item already purchased and played - the name of the device on which it was first played", "type": "string" }, "fullPrice": { "$ref": "#/definitions/KalturaPrice" }, "isInCancelationPeriod": { "description": "If waiver period is enabled - donates whether the user is still in the cancelation window", "type": "boolean" }, "isSubscriptionOnly": { "description": "Denotes whether this object is available only as part of a subscription or can be sold separately", "type": "boolean" }, "ppvDescriptions": { "items": { "$ref": "#/definitions/KalturaTranslationToken" }, "type": "array" }, "ppvModuleId": { "description": "The associated PPV module identifier", "type": "string" }, "ppvProductCode": { "description": "The PPV product code", "type": "string" }, "prePaidId": { "description": "The identifier of the relevant pre paid", "type": "string" }, "price": { "$ref": "#/definitions/KalturaPrice" }, "purchaseStatus": { "description": "Enum Type: `KalturaPurchaseStatus`\n\nSubscription purchase status", "enum": [ "ppv_purchased", "free", "for_purchase_subscription_only", "subscription_purchased", "for_purchase", "subscription_purchased_wrong_currency", "pre_paid_purchased", "geo_commerce_blocked", "entitled_to_preview_module", "first_device_limitation", "collection_purchased", "user_suspended", "not_for_purchase", "invalid_currency", "currency_not_defined_on_price_code" ], "type": "string", "x-enumLabels": [ "PPV_PURCHASED", "FREE", "FOR_PURCHASE_SUBSCRIPTION_ONLY", "SUBSCRIPTION_PURCHASED", "FOR_PURCHASE", "SUBSCRIPTION_PURCHASED_WRONG_CURRENCY", "PRE_PAID_PURCHASED", "GEO_COMMERCE_BLOCKED", "ENTITLED_TO_PREVIEW_MODULE", "FIRST_DEVICE_LIMITATION", "COLLECTION_PURCHASED", "USER_SUSPENDED", "NOT_FOR_PURCHASE", "INVALID_CURRENCY", "CURRENCY_NOT_DEFINED_ON_PRICE_CODE" ], "x-enumType": "KalturaPurchaseStatus" }, "purchaseUserId": { "description": "If the item already purchased - the identifier of the user (in the household) who purchased this item", "type": "string" }, "purchasedMediaFileId": { "description": "If the item already purchased - the identifier of the purchased file", "type": "integer" }, "relatedMediaFileIds": { "items": { "$ref": "#/definitions/KalturaIntegerValue" }, "type": "array" }, "startDate": { "description": "If the item already purchased - since when the user can start watching the item", "type": "integer" }, "subscriptionId": { "description": "The identifier of the relevant subscription", "type": "string" } }, "title": "KalturaPPVItemPriceDetails", "type": "object" }, "KalturaParentalRule": { "description": "Parental rule", "properties": { "blockAnonymousAccess": { "description": "Content that correspond to this rule is not available for guests", "type": "boolean" }, "description": { "description": "Explanatory description", "type": "string" }, "epgTag": { "description": "EPG asset tag ID to in which to look for corresponding trigger values", "type": "integer" }, "epgTagValues": { "items": { "$ref": "#/definitions/KalturaStringValue" }, "type": "array" }, "id": { "description": "`readOnly`\n\nUnique parental rule identifier", "readOnly": true, "type": "integer" }, "isDefault": { "description": "Is the rule the default rule of the account", "type": "boolean" }, "mediaTag": { "description": "Media asset tag ID to in which to look for corresponding trigger values", "type": "integer" }, "mediaTagValues": { "items": { "$ref": "#/definitions/KalturaStringValue" }, "type": "array" }, "name": { "description": "Rule display name", "type": "string" }, "order": { "description": "Rule order within the full list of rules", "type": "integer" }, "origin": { "description": "Enum Type: `KalturaRuleLevel`\n\nWhere was this rule defined account, household or user", "enum": [ "invalid", "user", "household", "account" ], "type": "string", "x-enumLabels": [ "INVALID", "USER", "HOUSEHOLD", "ACCOUNT" ], "x-enumType": "KalturaRuleLevel" }, "ruleType": { "description": "Enum Type: `KalturaParentalRuleType`\n\nRule type – Movies, TV series or both", "enum": [ "ALL", "MOVIES", "TV_SERIES" ], "type": "string", "x-enumLabels": [ "ALL", "MOVIES", "TV_SERIES" ], "x-enumType": "KalturaParentalRuleType" } }, "title": "KalturaParentalRule", "type": "object" }, "KalturaParentalRuleFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "entityReferenceEqual": { "description": "Enum Type: `KalturaEntityReferenceBy`\n\nReference type to filter by", "enum": [ "user", "household" ], "type": "string", "x-enumLabels": [ "USER", "HOUSEHOLD" ], "x-enumType": "KalturaEntityReferenceBy" }, "orderBy": { "enum": [ "PARTNER_SORT_VALUE" ], "type": "string", "x-enumLabels": [ "PARTNER_SORT_VALUE" ], "x-enumType": "KalturaParentalRuleOrderBy" } }, "title": "KalturaParentalRuleFilter", "type": "object" }, "KalturaParentalRuleListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "ParentalRules list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaParentalRule" }, "type": "array" } }, "title": "KalturaParentalRuleListResponse", "type": "object" }, "KalturaPartnerConfiguration": { "description": "`abstract`\n\nPartner base configuration", "discriminator": "objectType", "oneOf": [ { "$ref": "#/definitions/KalturaBillingPartnerConfig" } ], "properties": { "objectType": { "enum": [ "KalturaBillingPartnerConfig" ], "type": "string" } }, "title": "KalturaPartnerConfiguration", "type": "object" }, "KalturaPartnerConfigurationHolder": { "description": "Holder object for channel enrichment enum", "properties": { "type": { "description": "Enum Type: `KalturaPartnerConfigurationType`\n\nPartner configuration type", "enum": [ "DefaultPaymentGateway", "EnablePaymentGatewaySelection", "OSSAdapter" ], "type": "string", "x-enumLabels": [ "DEFAULTPAYMENTGATEWAY", "ENABLEPAYMENTGATEWAYSELECTION", "OSSADAPTER" ], "x-enumType": "KalturaPartnerConfigurationType" } }, "title": "KalturaPartnerConfigurationHolder", "type": "object" }, "KalturaPaymentGatewayBaseProfile": { "description": "Payment gateway base profile", "properties": { "id": { "description": "`readOnly`\n\npayment gateway id", "readOnly": true, "type": "integer" }, "isDefault": { "description": "Payment gateway default (true/false)", "type": "boolean" }, "name": { "description": "payment gateway name", "type": "string" }, "selectedBy": { "description": "Enum Type: `KalturaHouseholdPaymentGatewaySelectedBy`\n\ndistinction payment gateway selected by account or household", "enum": [ "none", "account", "household" ], "type": "string", "x-enumLabels": [ "NONE", "ACCOUNT", "HOUSEHOLD" ], "x-enumType": "KalturaHouseholdPaymentGatewaySelectedBy" } }, "title": "KalturaPaymentGatewayBaseProfile", "type": "object" }, "KalturaPaymentGatewayConfiguration": { "properties": { "paymentGatewayConfiguration": { "items": { "$ref": "#/definitions/KalturaKeyValue" }, "type": "array" } }, "title": "KalturaPaymentGatewayConfiguration", "type": "object" }, "KalturaPaymentGatewayProfile": { "allOf": [ { "$ref": "#/definitions/KalturaPaymentGatewayBaseProfile" } ], "description": "Payment gateway profile", "properties": { "adapterUrl": { "description": "Payment gateway adapter URL", "type": "string" }, "externalIdentifier": { "description": "Payment gateway external identifier", "type": "string" }, "externalVerification": { "description": "Payment gateway external verification", "type": "boolean" }, "isActive": { "description": "Payment gateway is active status", "type": "integer" }, "paymentGatewaySettings": { "items": { "$ref": "#/definitions/KalturaStringValue" }, "type": "array" }, "pendingInterval": { "description": "Pending Interval in minutes", "type": "integer" }, "pendingRetries": { "description": "Pending Retries", "type": "integer" }, "renewIntervalMinutes": { "description": "Renew Interval Minutes", "type": "integer" }, "renewStartMinutes": { "description": "Renew Start Minutes", "type": "integer" }, "renewUrl": { "description": "Payment gateway renew URL", "type": "string" }, "sharedSecret": { "description": "Shared Secret", "type": "string" }, "statusUrl": { "description": "Payment gateway status URL", "type": "string" }, "transactUrl": { "description": "Payment gateway transact URL", "type": "string" } }, "title": "KalturaPaymentGatewayProfile", "type": "object" }, "KalturaPaymentGatewayProfileListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "PaymentGatewayProfile list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaPaymentGatewayProfile" }, "type": "array" } }, "title": "KalturaPaymentGatewayProfileListResponse", "type": "object" }, "KalturaPaymentMethodProfile": { "properties": { "allowMultiInstance": { "description": "Indicates whether the payment method allow multiple instances", "type": "boolean" }, "id": { "description": "`readOnly`\n\nPayment method identifier (internal)", "readOnly": true, "type": "integer" }, "name": { "description": "Payment method name", "type": "string" }, "paymentGatewayId": { "description": "Payment gateway identifier (internal)", "type": "integer" } }, "title": "KalturaPaymentMethodProfile", "type": "object" }, "KalturaPaymentMethodProfileFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaPaymentMethodProfileOrderBy" }, "paymentGatewayIdEqual": { "description": "Payment gateway identifier to list the payment methods for", "type": "integer" } }, "title": "KalturaPaymentMethodProfileFilter", "type": "object" }, "KalturaPaymentMethodProfileListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "List of payment method profiles.", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaPaymentMethodProfile" }, "type": "array" } }, "title": "KalturaPaymentMethodProfileListResponse", "type": "object" }, "KalturaPermission": { "properties": { "id": { "description": "`readOnly`\n\nPermission identifier", "readOnly": true, "type": "integer" }, "name": { "description": "Permission name", "type": "string" }, "permissionItems": { "items": { "$ref": "#/definitions/KalturaPermissionItem" }, "type": "array" } }, "title": "KalturaPermission", "type": "object" }, "KalturaPermissionItem": { "properties": { "id": { "description": "`readOnly`\n\nPermission item identifier", "readOnly": true, "type": "integer" }, "isExcluded": { "description": "Permission isExcluded", "type": "boolean" }, "name": { "description": "Permission item name", "type": "string" } }, "title": "KalturaPermissionItem", "type": "object" }, "KalturaPersistedFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "`abstract`", "discriminator": "objectType", "oneOf": [ { "$ref": "#/definitions/KalturaAssetFilter" } ], "properties": { "name": { "description": "Name for the presisted filter. If empty, no action will be done. If has value, the filter will be saved and persisted in user's search history.", "type": "string" }, "objectType": { "enum": [ "KalturaAssetFilter" ], "type": "string" } }, "title": "KalturaPersistedFilter", "type": "object" }, "KalturaPersonalFeed": { "allOf": [ { "$ref": "#/definitions/KalturaFeed" } ], "properties": {}, "title": "KalturaPersonalFeed", "type": "object" }, "KalturaPersonalFeedFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "orderBy": { "enum": [ "RELEVANCY_DESC", "NAME_ASC", "NAME_DESC", "VIEWS_DESC", "RATINGS_DESC", "VOTES_DESC", "START_DATE_DESC", "START_DATE_ASC" ], "type": "string", "x-enumLabels": [ "RELEVANCY_DESC", "NAME_ASC", "NAME_DESC", "VIEWS_DESC", "RATINGS_DESC", "VOTES_DESC", "START_DATE_DESC", "START_DATE_ASC" ], "x-enumType": "KalturaPersonalFeedOrderBy" } }, "title": "KalturaPersonalFeedFilter", "type": "object" }, "KalturaPersonalFeedListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "List of message follow data.", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaPersonalFeed" }, "type": "array" } }, "title": "KalturaPersonalFeedListResponse", "type": "object" }, "KalturaPin": { "description": "PIN and its origin of definition", "properties": { "origin": { "description": "Enum Type: `KalturaRuleLevel`\n\nWhere the PIN was defined at – account, household or user", "enum": [ "invalid", "user", "household", "account" ], "type": "string", "x-enumLabels": [ "INVALID", "USER", "HOUSEHOLD", "ACCOUNT" ], "x-enumType": "KalturaRuleLevel" }, "pin": { "description": "PIN code", "type": "string" }, "type": { "description": "Enum Type: `KalturaPinType`\n\nPIN type", "enum": [ "purchase", "parental" ], "type": "string", "x-enumLabels": [ "PURCHASE", "PARENTAL" ], "x-enumType": "KalturaPinType" } }, "title": "KalturaPin", "type": "object" }, "KalturaPinResponse": { "description": "PIN and its origin of definition", "properties": { "origin": { "description": "Enum Type: `KalturaRuleLevel`\n\nWhere the PIN was defined at – account, household or user", "enum": [ "invalid", "user", "household", "account" ], "type": "string", "x-enumLabels": [ "INVALID", "USER", "HOUSEHOLD", "ACCOUNT" ], "x-enumType": "KalturaRuleLevel" }, "pin": { "description": "PIN code", "type": "string" }, "type": { "description": "Enum Type: `KalturaPinType`\n\nPIN type", "enum": [ "purchase", "parental" ], "type": "string", "x-enumLabels": [ "PURCHASE", "PARENTAL" ], "x-enumType": "KalturaPinType" } }, "title": "KalturaPinResponse", "type": "object" }, "KalturaPlaybackContext": { "properties": { "actions": { "items": { "$ref": "#/definitions/KalturaRuleAction" }, "type": "array" }, "messages": { "items": { "$ref": "#/definitions/KalturaAccessControlMessage" }, "type": "array" }, "sources": { "items": { "$ref": "#/definitions/KalturaPlaybackSource" }, "type": "array" } }, "title": "KalturaPlaybackContext", "type": "object" }, "KalturaPlaybackContextOptions": { "properties": { "assetFileIds": { "description": "List of comma separated media file IDs", "type": "string" }, "context": { "description": "Enum Type: `KalturaPlaybackContextType`\n\nPlayback context type", "enum": [ "TRAILER", "CATCHUP", "START_OVER", "PLAYBACK" ], "type": "string", "x-enumLabels": [ "TRAILER", "CATCHUP", "START_OVER", "PLAYBACK" ], "x-enumType": "KalturaPlaybackContextType" }, "mediaProtocol": { "description": "Protocol of the specific media object (http / https).", "type": "string" }, "streamerType": { "description": "Playback streamer type: applehttp, mpegdash, url.", "type": "string" } }, "title": "KalturaPlaybackContextOptions", "type": "object" }, "KalturaPlaybackSource": { "allOf": [ { "$ref": "#/definitions/KalturaMediaFile" } ], "properties": { "drm": { "items": { "$ref": "#/definitions/KalturaDrmPlaybackPluginData" }, "type": "array" }, "format": { "description": "Source format according to delivery profile streamer type (applehttp, mpegdash etc.)", "type": "string" }, "protocols": { "description": "Comma separated string according to deliveryProfile media protocols ('http,https' etc.)", "type": "string" } }, "title": "KalturaPlaybackSource", "type": "object" }, "KalturaPlayerAssetData": { "description": "Kaltura bookmark data", "properties": { "action": { "description": "Action: HIT/PLAY/STOP/PAUSE/FIRST_PLAY/SWOOSH/FULL_SCREEN/SEND_TO_FRIEND/LOAD/FULL_SCREEN_EXIT/FINISH/BITRATE_CHANGE/ERROR/NONE", "type": "string" }, "averageBitrate": { "description": "Average Bitrate", "type": "integer" }, "currentBitrate": { "description": "Current Bitrate", "type": "integer" }, "location": { "description": "Location", "type": "integer" }, "totalBitrate": { "description": "Total Bitrate", "type": "integer" } }, "title": "KalturaPlayerAssetData", "type": "object" }, "KalturaPluginData": { "properties": {}, "title": "KalturaPluginData", "type": "object" }, "KalturaPpv": { "description": "PPV details", "properties": { "couponsGroup": { "$ref": "#/definitions/KalturaCouponsGroup" }, "descriptions": { "items": { "$ref": "#/definitions/KalturaTranslationToken" }, "type": "array" }, "discountModule": { "$ref": "#/definitions/KalturaDiscountModule" }, "fileTypes": { "items": { "$ref": "#/definitions/KalturaIntegerValue" }, "type": "array" }, "firstDeviceLimitation": { "description": "Indicates whether or not this ppv can be consumed only on the first device", "type": "boolean" }, "id": { "description": "PPV identifier", "type": "string" }, "isSubscriptionOnly": { "description": "Indicates whether or not this ppv can be purchased standalone or only as part of a subscription", "type": "boolean" }, "name": { "description": "the name for the ppv", "type": "string" }, "price": { "$ref": "#/definitions/KalturaPriceDetails" }, "productCode": { "description": "Product code for the ppv", "type": "string" }, "usageModule": { "$ref": "#/definitions/KalturaUsageModule" } }, "title": "KalturaPpv", "type": "object" }, "KalturaPpvEntitlement": { "allOf": [ { "$ref": "#/definitions/KalturaEntitlement" } ], "description": "KalturaPpvEntitlement", "properties": { "mediaFileId": { "description": "`readOnly`\n\nMedia file identifier", "readOnly": true, "type": "integer" }, "mediaId": { "description": "`readOnly`\n\nMedia identifier", "readOnly": true, "type": "integer" } }, "title": "KalturaPpvEntitlement", "type": "object" }, "KalturaPpvPrice": { "allOf": [ { "$ref": "#/definitions/KalturaProductPrice" } ], "description": "PPV price details", "properties": { "collectionId": { "description": "The identifier of the relevant collection", "type": "string" }, "discountEndDate": { "description": "Discount end date", "type": "integer" }, "endDate": { "description": "If the item already purchased - until when the user can watch the item", "type": "integer" }, "fileId": { "description": "Media file identifier", "type": "integer" }, "firstDeviceName": { "description": "If the item already purchased and played - the name of the device on which it was first played", "type": "string" }, "fullPrice": { "$ref": "#/definitions/KalturaPrice" }, "isInCancelationPeriod": { "description": "If waiver period is enabled - donates whether the user is still in the cancelation window", "type": "boolean" }, "isSubscriptionOnly": { "description": "Denotes whether this object is available only as part of a subscription or can be sold separately", "type": "boolean" }, "ppvDescriptions": { "items": { "$ref": "#/definitions/KalturaTranslationToken" }, "type": "array" }, "ppvModuleId": { "description": "The associated PPV module identifier", "type": "string" }, "ppvProductCode": { "description": "The PPV product code", "type": "string" }, "prePaidId": { "description": "The identifier of the relevant pre paid", "type": "string" }, "purchaseUserId": { "description": "If the item already purchased - the identifier of the user (in the household) who purchased this item", "type": "string" }, "purchasedMediaFileId": { "description": "If the item already purchased - the identifier of the purchased file", "type": "integer" }, "relatedMediaFileIds": { "items": { "$ref": "#/definitions/KalturaIntegerValue" }, "type": "array" }, "startDate": { "description": "If the item already purchased - since when the user can start watching the item", "type": "integer" }, "subscriptionId": { "description": "The identifier of the relevant subscription", "type": "string" } }, "title": "KalturaPpvPrice", "type": "object" }, "KalturaPremiumService": { "description": "Premium service", "properties": { "id": { "description": "`readOnly`\n\nService identifier", "readOnly": true, "type": "integer" }, "name": { "description": "Service name / description", "type": "string" } }, "title": "KalturaPremiumService", "type": "object" }, "KalturaPreviewModule": { "description": "Preview module", "properties": { "id": { "description": "`readOnly`\n\nPreview module identifier", "readOnly": true, "type": "integer" }, "lifeCycle": { "description": "Preview module life cycle - for how long the preview module is active", "type": "integer" }, "name": { "description": "Preview module name", "type": "string" }, "nonRenewablePeriod": { "description": "The time you can't buy the item to which the preview module is assigned to again", "type": "integer" } }, "title": "KalturaPreviewModule", "type": "object" }, "KalturaPrice": { "description": "Price", "properties": { "amount": { "description": "Price", "type": "number" }, "countryId": { "description": "Country ID", "type": "integer" }, "currency": { "description": "Currency", "type": "string" }, "currencySign": { "description": "Currency Sign", "type": "string" } }, "title": "KalturaPrice", "type": "object" }, "KalturaPriceDetails": { "description": "Price details", "properties": { "descriptions": { "items": { "$ref": "#/definitions/KalturaTranslationToken" }, "type": "array" }, "id": { "description": "`readOnly`\n\nThe price code identifier", "readOnly": true, "type": "integer" }, "multiCurrencyPrice": { "items": { "$ref": "#/definitions/KalturaPrice" }, "type": "array" }, "name": { "description": "The price code name", "type": "string" }, "price": { "$ref": "#/definitions/KalturaPrice" } }, "title": "KalturaPriceDetails", "type": "object" }, "KalturaPriceDetailsFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "idIn": { "description": "Comma separated price identifiers", "type": "string" }, "orderBy": { "enum": [ "NAME_ASC" ], "type": "string", "x-enumLabels": [ "NAME_ASC" ], "x-enumType": "KalturaPriceDetailsOrderBy" } }, "title": "KalturaPriceDetailsFilter", "type": "object" }, "KalturaPriceDetailsListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaPriceDetails" }, "type": "array" } }, "title": "KalturaPriceDetailsListResponse", "type": "object" }, "KalturaPricePlan": { "allOf": [ { "$ref": "#/definitions/KalturaUsageModule" } ], "description": "Price plan", "properties": { "discountId": { "description": "`readOnly`\n\nThe discount module identifier of the price plan", "readOnly": true, "type": "integer" }, "isRenewable": { "description": "`readOnly`\n\nDenotes whether or not this object can be renewed", "readOnly": true, "type": "boolean" }, "priceDetailsId": { "description": "The ID of the price details associated with this price plan", "type": "integer" }, "renewalsNumber": { "description": "`readOnly`\n\nDefines the number of times the module will be renewed (for the life_cycle period)", "readOnly": true, "type": "integer" } }, "title": "KalturaPricePlan", "type": "object" }, "KalturaPricePlanFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "idIn": { "description": "Comma separated price plans identifiers", "type": "string" }, "orderBy": { "enum": [ "CREATE_DATE_DESC" ], "type": "string", "x-enumLabels": [ "CREATE_DATE_DESC" ], "x-enumType": "KalturaPricePlanOrderBy" } }, "title": "KalturaPricePlanFilter", "type": "object" }, "KalturaPricePlanListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaPricePlan" }, "type": "array" } }, "title": "KalturaPricePlanListResponse", "type": "object" }, "KalturaProductCode": { "description": "Product Code", "properties": { "code": { "description": "Product Code", "type": "string" }, "inappProvider": { "description": "Provider Name", "type": "string" } }, "title": "KalturaProductCode", "type": "object" }, "KalturaProductPrice": { "description": "`abstract`", "discriminator": "objectType", "oneOf": [ { "$ref": "#/definitions/KalturaCollectionPrice" }, { "$ref": "#/definitions/KalturaPpvPrice" }, { "$ref": "#/definitions/KalturaSubscriptionPrice" } ], "properties": { "objectType": { "enum": [ "KalturaCollectionPrice", "KalturaPpvPrice", "KalturaSubscriptionPrice" ], "type": "string" }, "price": { "$ref": "#/definitions/KalturaPrice" }, "productId": { "description": "Product identifier", "type": "string" }, "productType": { "description": "Enum Type: `KalturaTransactionType`\n\nProduct Type", "enum": [ "ppv", "subscription", "collection" ], "type": "string", "x-enumLabels": [ "PPV", "SUBSCRIPTION", "COLLECTION" ], "x-enumType": "KalturaTransactionType" }, "purchaseStatus": { "description": "Enum Type: `KalturaPurchaseStatus`\n\nProduct purchase status", "enum": [ "ppv_purchased", "free", "for_purchase_subscription_only", "subscription_purchased", "for_purchase", "subscription_purchased_wrong_currency", "pre_paid_purchased", "geo_commerce_blocked", "entitled_to_preview_module", "first_device_limitation", "collection_purchased", "user_suspended", "not_for_purchase", "invalid_currency", "currency_not_defined_on_price_code" ], "type": "string", "x-enumLabels": [ "PPV_PURCHASED", "FREE", "FOR_PURCHASE_SUBSCRIPTION_ONLY", "SUBSCRIPTION_PURCHASED", "FOR_PURCHASE", "SUBSCRIPTION_PURCHASED_WRONG_CURRENCY", "PRE_PAID_PURCHASED", "GEO_COMMERCE_BLOCKED", "ENTITLED_TO_PREVIEW_MODULE", "FIRST_DEVICE_LIMITATION", "COLLECTION_PURCHASED", "USER_SUSPENDED", "NOT_FOR_PURCHASE", "INVALID_CURRENCY", "CURRENCY_NOT_DEFINED_ON_PRICE_CODE" ], "x-enumType": "KalturaPurchaseStatus" } }, "title": "KalturaProductPrice", "type": "object" }, "KalturaProductPriceFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "collectionIdIn": { "description": "Comma separated collections identifiers", "type": "string" }, "couponCodeEqual": { "description": "Discount coupon code", "type": "string" }, "fileIdIn": { "description": "Comma separated media files identifiers", "type": "string" }, "isLowest": { "description": "A flag that indicates if only the lowest price of an item should return", "type": "boolean" }, "orderBy": { "enum": [ "PRODUCT_ID_ASC", "PRODUCT_ID_DESC" ], "type": "string", "x-enumLabels": [ "PRODUCT_ID_ASC", "PRODUCT_ID_DESC" ], "x-enumType": "KalturaProductPriceOrderBy" }, "subscriptionIdIn": { "description": "Comma separated subscriptions identifiers", "type": "string" } }, "title": "KalturaProductPriceFilter", "type": "object" }, "KalturaProductPriceListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Prices list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaProductPrice" }, "type": "array" } }, "title": "KalturaProductPriceListResponse", "type": "object" }, "KalturaProductsPriceListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Prices list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaProductPrice" }, "type": "array" } }, "title": "KalturaProductsPriceListResponse", "type": "object" }, "KalturaProgramAsset": { "allOf": [ { "$ref": "#/definitions/KalturaAsset" } ], "description": "Program-asset info", "properties": { "crid": { "description": "Unique identifier for the program", "type": "string" }, "epgChannelId": { "description": "EPG channel identifier", "type": "integer" }, "epgId": { "description": "EPG identifier", "type": "string" }, "linearAssetId": { "description": "Id of linear media asset", "type": "integer" }, "relatedMediaId": { "description": "Ralated media identifier", "type": "integer" } }, "title": "KalturaProgramAsset", "type": "object" }, "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" }, "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`\n\nPackage type. Possible values: PPV, Subscription, Collection", "enum": [ "ppv", "subscription", "collection" ], "type": "string", "x-enumLabels": [ "PPV", "SUBSCRIPTION", "COLLECTION" ], "x-enumType": "KalturaTransactionType" } }, "title": "KalturaPurchaseBase", "type": "object" }, "KalturaPurchaseSession": { "allOf": [ { "$ref": "#/definitions/KalturaPurchase" } ], "properties": { "previewModuleId": { "description": "Preview module identifier (relevant only for subscription)", "type": "integer" } }, "title": "KalturaPurchaseSession", "type": "object" }, "KalturaPurchaseSettings": { "allOf": [ { "$ref": "#/definitions/KalturaPin" } ], "description": "Purchase settings and PIN", "properties": { "permission": { "description": "Enum Type: `KalturaPurchaseSettingsType`\n\nPurchase permission - block, ask or allow", "enum": [ "block", "ask", "allow" ], "type": "string", "x-enumLabels": [ "BLOCK", "ASK", "ALLOW" ], "x-enumType": "KalturaPurchaseSettingsType" } }, "title": "KalturaPurchaseSettings", "type": "object" }, "KalturaPushMessage": { "properties": { "action": { "description": "Optional. Used to change the default action of the application when a push is received.", "type": "string" }, "message": { "description": "The message that will be presented to the user.", "type": "string" }, "sound": { "description": "Optional. Can be used to change the default push sound on the user device.", "type": "string" }, "url": { "description": "Optional. Used to direct the application to the relevant page.", "type": "string" } }, "title": "KalturaPushMessage", "type": "object" }, "KalturaPushParams": { "properties": { "externalToken": { "description": "External device token as received from external push provider in exchange for the device token", "type": "string" }, "token": { "description": "Device-Application push token", "type": "string" } }, "title": "KalturaPushParams", "type": "object" }, "KalturaRatio": { "properties": { "height": { "description": "Height", "type": "integer" }, "id": { "description": "`readOnly`\n\nID", "readOnly": true, "type": "integer" }, "name": { "description": "Name", "type": "string" }, "precisionPrecentage": { "description": "Accepted error margin precentage of an image uploaded for this ratio\r\n 0 - no validation, everything accepted", "type": "integer" }, "width": { "description": "Width", "type": "integer" } }, "title": "KalturaRatio", "type": "object" }, "KalturaRatioListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaRatio" }, "type": "array" } }, "title": "KalturaRatioListResponse", "type": "object" }, "KalturaRecommendationProfile": { "description": "PaymentGW", "properties": { "adapterUrl": { "description": "recommendation engine adapter URL", "type": "string" }, "externalIdentifier": { "description": "recommendation engine external identifier", "type": "string" }, "id": { "description": "`readOnly`\n\nrecommendation engine id", "readOnly": true, "type": "integer" }, "isActive": { "description": "recommendation engine is active status", "type": "boolean" }, "name": { "description": "recommendation engine name", "type": "string" }, "recommendationEngineSettings": { "items": { "$ref": "#/definitions/KalturaStringValue" }, "type": "array" }, "sharedSecret": { "description": "`readOnly`\n\nShared Secret", "readOnly": true, "type": "string" } }, "title": "KalturaRecommendationProfile", "type": "object" }, "KalturaRecommendationProfileListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "List of recommendation profiles.", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaRecommendationProfile" }, "type": "array" } }, "title": "KalturaRecommendationProfileListResponse", "type": "object" }, "KalturaRecording": { "properties": { "assetId": { "description": "Kaltura unique ID representing the program identifier", "type": "integer" }, "createDate": { "description": "`readOnly`\n\nSpecifies when was the recording created. Date and time represented as epoch.", "readOnly": true, "type": "integer" }, "id": { "description": "`readOnly`\n\nKaltura unique ID representing the recording identifier", "readOnly": true, "type": "integer" }, "isProtected": { "description": "`readOnly`\n\nSpecifies whether or not the recording is protected", "readOnly": true, "type": "boolean" }, "status": { "description": "`readOnly`\n\nEnum Type: `KalturaRecordingStatus`\n\nRecording state: scheduled/recording/recorded/canceled/failed/does_not_exists/deleted", "enum": [ "SCHEDULED", "RECORDING", "RECORDED", "CANCELED", "FAILED", "DELETED" ], "readOnly": true, "type": "string", "x-enumLabels": [ "SCHEDULED", "RECORDING", "RECORDED", "CANCELED", "FAILED", "DELETED" ], "x-enumType": "KalturaRecordingStatus" }, "type": { "description": "`readOnly`\n\nEnum Type: `KalturaRecordingType`\n\nRecording Type: single/season/series", "enum": [ "SINGLE", "SEASON", "SERIES" ], "readOnly": true, "type": "string", "x-enumLabels": [ "SINGLE", "SEASON", "SERIES" ], "x-enumType": "KalturaRecordingType" }, "updateDate": { "description": "`readOnly`\n\nSpecifies when was the recording last updated. Date and time represented as epoch.", "readOnly": true, "type": "integer" }, "viewableUntilDate": { "description": "`readOnly`\n\nSpecifies until when the recording is available for viewing. Date and time represented as epoch.", "readOnly": true, "type": "integer" } }, "title": "KalturaRecording", "type": "object" }, "KalturaRecordingAsset": { "allOf": [ { "$ref": "#/definitions/KalturaProgramAsset" } ], "description": "Recording-asset info", "properties": { "recordingId": { "description": "Recording identifier", "type": "string" }, "recordingType": { "description": "Enum Type: `KalturaRecordingType`\n\nRecording Type: single/season/series", "enum": [ "SINGLE", "SEASON", "SERIES" ], "type": "string", "x-enumLabels": [ "SINGLE", "SEASON", "SERIES" ], "x-enumType": "KalturaRecordingType" } }, "title": "KalturaRecordingAsset", "type": "object" }, "KalturaRecordingContextFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "Filtering assets", "properties": { "assetIdIn": { "description": "Comma separated asset ids", "type": "string" }, "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaRecordingContextOrderBy" } }, "title": "KalturaRecordingContextFilter", "type": "object" }, "KalturaRecordingFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "Filtering recordings", "properties": { "filterExpression": { "description": "KSQL expression", "type": "string" }, "orderBy": { "enum": [ "TITLE_ASC", "TITLE_DESC", "START_DATE_ASC", "START_DATE_DESC" ], "type": "string", "x-enumLabels": [ "TITLE_ASC", "TITLE_DESC", "START_DATE_ASC", "START_DATE_DESC" ], "x-enumType": "KalturaRecordingOrderBy" }, "statusIn": { "description": "Recording Statuses", "type": "string" } }, "title": "KalturaRecordingFilter", "type": "object" }, "KalturaRecordingListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Recordings info wrapper", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaRecording" }, "type": "array" } }, "title": "KalturaRecordingListResponse", "type": "object" }, "KalturaRegion": { "properties": { "externalId": { "description": "Region external identifier", "type": "string" }, "id": { "description": "Region identifier", "type": "integer" }, "isDefault": { "description": "Indicates whether this is the default region for the partner", "type": "boolean" }, "linearChannels": { "items": { "$ref": "#/definitions/KalturaRegionalChannel" }, "type": "array" }, "name": { "description": "Region name", "type": "string" } }, "title": "KalturaRegion", "type": "object" }, "KalturaRegionFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "externalIdIn": { "description": "List of comma separated regions external identifiers", "type": "string" }, "orderBy": { "enum": [ "CREATE_DATE_ASC", "CREATE_DATE_DESC" ], "type": "string", "x-enumLabels": [ "CREATE_DATE_ASC", "CREATE_DATE_DESC" ], "x-enumType": "KalturaRegionOrderBy" } }, "title": "KalturaRegionFilter", "type": "object" }, "KalturaRegionListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Regions list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaRegion" }, "type": "array" } }, "title": "KalturaRegionListResponse", "type": "object" }, "KalturaRegionalChannel": { "properties": { "channelNumber": { "description": "The number of the channel", "type": "integer" }, "linearChannelId": { "description": "The identifier of the linear media representing the channel", "type": "integer" } }, "title": "KalturaRegionalChannel", "type": "object" }, "KalturaRegistryResponse": { "properties": { "announcementId": { "description": "Announcement Id", "type": "integer" }, "key": { "description": "Key", "type": "string" }, "url": { "description": "URL", "type": "string" } }, "title": "KalturaRegistryResponse", "type": "object" }, "KalturaRegistrySettings": { "properties": { "key": { "description": "Permission item identifier", "type": "string" }, "value": { "description": "Permission item name", "type": "string" } }, "title": "KalturaRegistrySettings", "type": "object" }, "KalturaRegistrySettingsListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "List of registry settings.", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaRegistrySettings" }, "type": "array" } }, "title": "KalturaRegistrySettingsListResponse", "type": "object" }, "KalturaRelatedExternalFilter": { "allOf": [ { "$ref": "#/definitions/KalturaAssetFilter" } ], "properties": { "freeText": { "description": "FreeText", "type": "string" }, "idEqual": { "description": "the External ID of the asset for which to return related assets", "type": "integer" }, "typeIn": { "description": "Comma separated list of asset types to search within. \r\n Possible values: 0 – EPG linear programs entries, any media type ID (according to media type IDs defined dynamically in the system).\r\n If omitted – all types should be included.", "type": "string" }, "utcOffsetEqual": { "description": "UtcOffsetEqual", "type": "integer" } }, "title": "KalturaRelatedExternalFilter", "type": "object" }, "KalturaRelatedFilter": { "allOf": [ { "$ref": "#/definitions/KalturaBaseSearchAssetFilter" } ], "properties": { "idEqual": { "description": "the ID of the asset for which to return related assets", "type": "integer" }, "kSql": { "description": "Search assets using dynamic criteria. Provided collection of nested expressions with key, comparison operators, value, and logical conjunction.\r\n Possible keys: any Tag or Meta defined in the system and the following reserved keys: start_date, end_date. \r\n epg_id, media_id - for specific asset IDs.\r\n geo_block - only valid value is "true": When enabled, only assets that are not restriced to the user by geo-block rules will return.\r\n parental_rules - only valid value is "true": When enabled, only assets that the user doesn't need to provide PIN code will return.\r\n user_interests - only valid value is "true". When enabled, only assets that the user defined as his interests (by tags and metas) will return.\r\n epg_channel_id – the channel identifier of the EPG program.\r\n entitled_assets - valid values: "free", "entitled", "both". free - gets only free to watch assets. entitled - only those that the user is implicitly entitled to watch.\r\n Comparison operators: for numerical fields =, >, >=, <, <=, : (in). \r\n For alpha-numerical fields =, != (not), ~ (like), !~, ^ (any word starts with), ^= (phrase starts with), + (exists), !+ (not exists).\r\n Logical conjunction: and, or. \r\n Search values are limited to 20 characters each.\r\n (maximum length of entire filter is 2048 characters)", "type": "string" }, "typeIn": { "description": "Comma separated list of asset types to search within. \r\n Possible values: any media type ID (according to media type IDs defined dynamically in the system).\r\n If omitted – same type as the provided asset.", "type": "string" } }, "title": "KalturaRelatedFilter", "type": "object" }, "KalturaRelatedObjectFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "`abstract`\n\nDefine KalturaRelatedObjectFilter", "discriminator": "objectType", "oneOf": [ { "$ref": "#/definitions/KalturaAggregationCountFilter" } ], "properties": { "objectType": { "enum": [ "KalturaAggregationCountFilter" ], "type": "string" } }, "title": "KalturaRelatedObjectFilter", "type": "object" }, "KalturaReminder": { "properties": { "id": { "description": "`readOnly`\n\nReminder id", "readOnly": true, "type": "integer" }, "name": { "description": "`readOnly`\n\nReminder name", "readOnly": true, "type": "string" }, "type": { "description": "Enum Type: `KalturaReminderType`\n\nReminder type", "enum": [ "ASSET", "SERIES" ], "type": "string", "x-enumLabels": [ "ASSET", "SERIES" ], "x-enumType": "KalturaReminderType" } }, "title": "KalturaReminder", "type": "object" }, "KalturaReminderFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "`abstract`", "discriminator": "objectType", "oneOf": [ { "$ref": "#/definitions/KalturaAssetReminderFilter" }, { "$ref": "#/definitions/KalturaSeriesReminderFilter" }, { "$ref": "#/definitions/KalturaSeasonsReminderFilter" } ], "properties": { "objectType": { "enum": [ "KalturaAssetReminderFilter", "KalturaSeriesReminderFilter", "KalturaSeasonsReminderFilter" ], "type": "string" } }, "title": "KalturaReminderFilter", "type": "object" }, "KalturaReminderListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "List of reminders from DB.", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaReminder" }, "type": "array" } }, "title": "KalturaReminderListResponse", "type": "object" }, "KalturaReport": { "properties": {}, "title": "KalturaReport", "type": "object" }, "KalturaReportFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "`abstract`\n\nReport filter", "discriminator": "objectType", "oneOf": [ { "$ref": "#/definitions/KalturaDeviceReportFilter" } ], "properties": { "objectType": { "enum": [ "KalturaDeviceReportFilter" ], "type": "string" }, "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaReportOrderBy" } }, "title": "KalturaReportFilter", "type": "object" }, "KalturaReportListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Reports info wrapper", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaReport" }, "type": "array" } }, "title": "KalturaReportListResponse", "type": "object" }, "KalturaRequestConfiguration": { "description": "Define client request optional configurations", "properties": { "currency": { "description": "Currency to be used", "type": "string" }, "ks": { "description": "Kaltura API session", "type": "string" }, "language": { "description": "Content language", "type": "string" }, "partnerId": { "description": "Impersonated partner id", "type": "integer" }, "responseProfile": { "$ref": "#/definitions/KalturaBaseResponseProfile" }, "userId": { "description": "Impersonated user id", "type": "integer" } }, "title": "KalturaRequestConfiguration", "type": "object" }, "KalturaRuleAction": { "properties": { "type": { "description": "Enum Type: `KalturaRuleActionType`\n\nThe type of the action", "enum": [ "BLOCK" ], "type": "string", "x-enumLabels": [ "BLOCK" ], "x-enumType": "KalturaRuleActionType" } }, "title": "KalturaRuleAction", "type": "object" }, "KalturaScheduledRecordingProgramFilter": { "allOf": [ { "$ref": "#/definitions/KalturaAssetFilter" } ], "properties": { "channelsIn": { "description": "Channels to filter by", "type": "string" }, "endDateLessThanOrNull": { "description": "end date", "type": "integer" }, "recordingTypeEqual": { "description": "Enum Type: `KalturaScheduledRecordingAssetType`\n\nThe type of recordings to return", "enum": [ "single", "series", "all" ], "type": "string", "x-enumLabels": [ "SINGLE", "SERIES", "ALL" ], "x-enumType": "KalturaScheduledRecordingAssetType" }, "startDateGreaterThanOrNull": { "description": "start date", "type": "integer" } }, "title": "KalturaScheduledRecordingProgramFilter", "type": "object" }, "KalturaSearchAssetFilter": { "allOf": [ { "$ref": "#/definitions/KalturaBaseSearchAssetFilter" } ], "properties": { "idIn": { "description": "Comma separated list of EPG channel ids to search within.", "type": "string" }, "kSql": { "description": "Search assets using dynamic criteria. Provided collection of nested expressions with key, comparison operators, value, and logical conjunction.\r\n Possible keys: any Tag or Meta defined in the system and the following reserved keys: start_date, end_date. \r\n epg_id, media_id - for specific asset IDs.\r\n geo_block - only valid value is "true": When enabled, only assets that are not restriced to the user by geo-block rules will return.\r\n parental_rules - only valid value is "true": When enabled, only assets that the user doesn't need to provide PIN code will return.\r\n user_interests - only valid value is "true". When enabled, only assets that the user defined as his interests (by tags and metas) will return.\r\n epg_channel_id – the channel identifier of the EPG program.\r\n entitled_assets - valid values: "free", "entitled", "both". free - gets only free to watch assets. entitled - only those that the user is implicitly entitled to watch.\r\n Comparison operators: for numerical fields =, >, >=, <, <=, : (in). \r\n For alpha-numerical fields =, != (not), ~ (like), !~, ^ (any word starts with), ^= (phrase starts with), + (exists), !+ (not exists).\r\n Logical conjunction: and, or. \r\n Search values are limited to 20 characters each.\r\n (maximum length of entire filter is 2048 characters)", "type": "string" }, "typeIn": { "description": "Comma separated list of asset types to search within. \r\n Possible values: 0 – EPG linear programs entries; 1 - Recordings; Any media type ID (according to media type IDs defined dynamically in the system).\r\n If omitted – all types should be included.", "type": "string" } }, "title": "KalturaSearchAssetFilter", "type": "object" }, "KalturaSearchExternalFilter": { "allOf": [ { "$ref": "#/definitions/KalturaAssetFilter" } ], "properties": { "query": { "description": "Query", "type": "string" }, "typeIn": { "description": "Comma separated list of asset types to search within. \r\n Possible values: 0 – EPG linear programs entries, any media type ID (according to media type IDs defined dynamically in the system).\r\n If omitted – all types should be included.", "type": "string" }, "utcOffsetEqual": { "description": "UtcOffsetEqual", "type": "integer" } }, "title": "KalturaSearchExternalFilter", "type": "object" }, "KalturaSearchHistory": { "description": "Search history info", "properties": { "action": { "description": "`readOnly`\n\nKaltura OTT Service Action", "readOnly": true, "type": "string" }, "createdAt": { "description": "`readOnly`\n\nWhen search was performed", "readOnly": true, "type": "integer" }, "deviceId": { "description": "`readOnly`\n\nUnique Device ID", "readOnly": true, "type": "string" }, "filter": { "description": "`readOnly`\n\nFilter", "readOnly": true, "type": "string" }, "id": { "description": "`readOnly`\n\nSearch ID", "readOnly": true, "type": "string" }, "language": { "description": "`readOnly`\n\nSearch language", "readOnly": true, "type": "string" }, "name": { "description": "`readOnly`\n\nSearch name", "readOnly": true, "type": "string" }, "service": { "description": "`readOnly`\n\nKaltura OTT Service", "readOnly": true, "type": "string" } }, "title": "KalturaSearchHistory", "type": "object" }, "KalturaSearchHistoryFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaSearchHistoryOrderBy" } }, "title": "KalturaSearchHistoryFilter", "type": "object" }, "KalturaSearchHistoryListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Search history wrapper", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaSearchHistory" }, "type": "array" } }, "title": "KalturaSearchHistoryListResponse", "type": "object" }, "KalturaSeasonsReminderFilter": { "allOf": [ { "$ref": "#/definitions/KalturaReminderFilter" } ], "properties": { "epgChannelIdEqual": { "description": "EPG channel ID", "type": "integer" }, "seasonNumberIn": { "description": "Comma separated season numbers", "type": "string" }, "seriesIdEqual": { "description": "Series ID", "type": "string" } }, "title": "KalturaSeasonsReminderFilter", "type": "object" }, "KalturaSeriesRecording": { "properties": { "channelId": { "description": "Kaltura ChannelId", "type": "integer" }, "createDate": { "description": "`readOnly`\n\nSpecifies when was the series recording created. Date and time represented as epoch.", "readOnly": true, "type": "integer" }, "epgId": { "description": "Kaltura EpgId", "type": "integer" }, "excludedSeasons": { "items": { "$ref": "#/definitions/KalturaIntegerValue" }, "type": "array" }, "id": { "description": "`readOnly`\n\nKaltura unique ID representing the series recording identifier", "readOnly": true, "type": "integer" }, "seasonNumber": { "description": "Kaltura SeasonNumber", "type": "integer" }, "seriesId": { "description": "Kaltura SeriesId", "type": "string" }, "type": { "description": "Enum Type: `KalturaRecordingType`\n\nRecording Type: single/series/season", "enum": [ "SINGLE", "SEASON", "SERIES" ], "type": "string", "x-enumLabels": [ "SINGLE", "SEASON", "SERIES" ], "x-enumType": "KalturaRecordingType" }, "updateDate": { "description": "`readOnly`\n\nSpecifies when was the series recording last updated. Date and time represented as epoch.", "readOnly": true, "type": "integer" } }, "title": "KalturaSeriesRecording", "type": "object" }, "KalturaSeriesRecordingFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "Filtering recordings", "properties": { "orderBy": { "enum": [ "START_DATE_ASC", "START_DATE_DESC", "ID_ASC", "ID_DESC", "SERIES_ID_ASC", "SERIES_ID_DESC" ], "type": "string", "x-enumLabels": [ "START_DATE_ASC", "START_DATE_DESC", "ID_ASC", "ID_DESC", "SERIES_ID_ASC", "SERIES_ID_DESC" ], "x-enumType": "KalturaSeriesRecordingOrderBy" } }, "title": "KalturaSeriesRecordingFilter", "type": "object" }, "KalturaSeriesRecordingListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Series Recordings info wrapper", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaSeriesRecording" }, "type": "array" } }, "title": "KalturaSeriesRecordingListResponse", "type": "object" }, "KalturaSeriesReminder": { "allOf": [ { "$ref": "#/definitions/KalturaReminder" } ], "properties": { "epgChannelId": { "description": "EPG channel identifier", "type": "integer" }, "seasonNumber": { "description": "Season number", "type": "integer" }, "seriesId": { "description": "Series identifier", "type": "string" } }, "title": "KalturaSeriesReminder", "type": "object" }, "KalturaSeriesReminderFilter": { "allOf": [ { "$ref": "#/definitions/KalturaReminderFilter" } ], "properties": { "epgChannelIdEqual": { "description": "EPG channel ID", "type": "integer" }, "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaSeriesReminderOrderBy" }, "seriesIdIn": { "description": "Comma separated series IDs", "type": "string" } }, "title": "KalturaSeriesReminderFilter", "type": "object" }, "KalturaSession": { "description": "Kaltura Session", "properties": { "createDate": { "description": "Create date", "type": "integer" }, "expiry": { "description": "Expiry", "type": "integer" }, "ks": { "description": "KS", "type": "string" }, "partnerId": { "description": "Partner identifier", "type": "integer" }, "privileges": { "description": "Privileges", "type": "string" }, "udid": { "description": "UDID", "type": "string" }, "userId": { "description": "User identifier", "type": "string" } }, "title": "KalturaSession", "type": "object" }, "KalturaSessionInfo": { "allOf": [ { "$ref": "#/definitions/KalturaSession" } ], "description": "Kaltura Session", "properties": {}, "title": "KalturaSessionInfo", "type": "object" }, "KalturaSlimAsset": { "description": "Slim Asset Details", "properties": { "id": { "description": "`insertOnly`\n\nInternal identifier of the asset", "type": "string" }, "type": { "description": "`insertOnly`\n\nEnum Type: `KalturaAssetType`\n\nThe type of the asset. Possible values: media, recording, epg", "enum": [ "media", "recording", "epg" ], "type": "string", "x-enumLabels": [ "MEDIA", "RECORDING", "EPG" ], "x-enumType": "KalturaAssetType" } }, "title": "KalturaSlimAsset", "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`\n\nFacebook 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`\n\nUser identifier", "readOnly": true, "type": "string" } }, "title": "KalturaSocial", "type": "object" }, "KalturaSocialAction": { "properties": { "actionType": { "description": "Enum Type: `KalturaSocialActionType`\n\nAction type", "enum": [ "LIKE", "WATCH", "RATE", "SHARE" ], "type": "string", "x-enumLabels": [ "LIKE", "WATCH", "RATE", "SHARE" ], "x-enumType": "KalturaSocialActionType" }, "assetId": { "description": "ID of the asset that was acted upon", "type": "integer" }, "assetType": { "description": "Enum Type: `KalturaAssetType`\n\nType of the asset that was acted upon, currently only VOD (media)", "enum": [ "media", "recording", "epg" ], "type": "string", "x-enumLabels": [ "MEDIA", "RECORDING", "EPG" ], "x-enumType": "KalturaAssetType" }, "id": { "description": "`readOnly`\n\nsocial action document id", "readOnly": true, "type": "string" }, "time": { "description": "EPOC based timestamp for when the action occurred", "type": "integer" }, "url": { "description": "`writeOnly`\n\nThe value of the url", "type": "string" } }, "title": "KalturaSocialAction", "type": "object" }, "KalturaSocialActionFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "actionTypeIn": { "description": "Comma separated list of social actions to filter by", "type": "string" }, "assetIdIn": { "description": "Comma separated list of asset identifiers.", "type": "string" }, "assetTypeEqual": { "description": "Enum Type: `KalturaAssetType`\n\nAsset Type", "enum": [ "media", "recording", "epg" ], "type": "string", "x-enumLabels": [ "MEDIA", "RECORDING", "EPG" ], "x-enumType": "KalturaAssetType" }, "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaSocialActionOrderBy" } }, "title": "KalturaSocialActionFilter", "type": "object" }, "KalturaSocialActionListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaSocialAction" }, "type": "array" } }, "title": "KalturaSocialActionListResponse", "type": "object" }, "KalturaSocialActionRate": { "allOf": [ { "$ref": "#/definitions/KalturaSocialAction" } ], "properties": { "rate": { "description": "The value of the rating", "type": "integer" } }, "title": "KalturaSocialActionRate", "type": "object" }, "KalturaSocialComment": { "properties": { "createDate": { "description": "Comment creation date", "type": "integer" }, "header": { "description": "Comment header", "type": "string" }, "text": { "description": "Comment body", "type": "string" }, "writer": { "description": "The writer of the comment", "type": "string" } }, "title": "KalturaSocialComment", "type": "object" }, "KalturaSocialCommentFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "assetIdEqual": { "description": "Asset ID to filter by", "type": "integer" }, "assetTypeEqual": { "description": "Enum Type: `KalturaAssetType`\n\nAsset type to filter by, currently only VOD (media)", "enum": [ "media", "recording", "epg" ], "type": "string", "x-enumLabels": [ "MEDIA", "RECORDING", "EPG" ], "x-enumType": "KalturaAssetType" }, "createDateGreaterThan": { "description": "The create date from which to get the comments", "type": "integer" }, "orderBy": { "enum": [ "CREATE_DATE_ASC", "CREATE_DATE_DESC" ], "type": "string", "x-enumLabels": [ "CREATE_DATE_ASC", "CREATE_DATE_DESC" ], "x-enumType": "KalturaSocialCommentOrderBy" }, "socialPlatformEqual": { "description": "Enum Type: `KalturaSocialPlatform`\n\nComma separated list of social actions to filter by", "enum": [ "IN_APP", "FACEBOOK", "TWITTER" ], "type": "string", "x-enumLabels": [ "IN_APP", "FACEBOOK", "TWITTER" ], "x-enumType": "KalturaSocialPlatform" } }, "title": "KalturaSocialCommentFilter", "type": "object" }, "KalturaSocialCommentListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaSocialComment" }, "type": "array" } }, "title": "KalturaSocialCommentListResponse", "type": "object" }, "KalturaSocialConfig": { "description": "Returns social configuration for the partner", "properties": {}, "title": "KalturaSocialConfig", "type": "object" }, "KalturaSocialFacebookConfig": { "allOf": [ { "$ref": "#/definitions/KalturaSocialConfig" } ], "description": "Returns social configuration for the partner", "properties": { "appId": { "description": "The application identifier", "type": "string" }, "permissions": { "description": "List of application permissions", "type": "string" } }, "title": "KalturaSocialFacebookConfig", "type": "object" }, "KalturaSocialFriendActivity": { "properties": { "socialAction": { "$ref": "#/definitions/KalturaSocialAction" }, "userFullName": { "description": "The full name of the user who did the social action", "type": "string" }, "userPictureUrl": { "description": "The URL of the profile picture of the user who did the social action", "type": "string" } }, "title": "KalturaSocialFriendActivity", "type": "object" }, "KalturaSocialFriendActivityFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "actionTypeIn": { "description": "Comma separated list of social actions to filter by", "type": "string" }, "assetIdEqual": { "description": "Asset ID to filter by", "type": "integer" }, "assetTypeEqual": { "description": "Enum Type: `KalturaAssetType`\n\nAsset type to filter by, currently only VOD (media)", "enum": [ "media", "recording", "epg" ], "type": "string", "x-enumLabels": [ "MEDIA", "RECORDING", "EPG" ], "x-enumType": "KalturaAssetType" }, "orderBy": { "enum": [ "NONE", "UPDATE_DATE_DESC" ], "type": "string", "x-enumLabels": [ "NONE", "UPDATE_DATE_DESC" ], "x-enumType": "KalturaSocialFriendActivityOrderBy" } }, "title": "KalturaSocialFriendActivityFilter", "type": "object" }, "KalturaSocialFriendActivityListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaSocialFriendActivity" }, "type": "array" } }, "title": "KalturaSocialFriendActivityListResponse", "type": "object" }, "KalturaSocialNetworkComment": { "allOf": [ { "$ref": "#/definitions/KalturaSocialComment" } ], "properties": { "authorImageUrl": { "description": "The URL of the profile picture of the author of the comment", "type": "string" }, "likeCounter": { "description": "Number of likes", "type": "string" } }, "title": "KalturaSocialNetworkComment", "type": "object" }, "KalturaSocialResponse": { "properties": { "data": { "description": "Data", "type": "string" }, "kalturaUsername": { "description": "Kaltura username", "type": "string" }, "minFriendsLimitation": { "description": "Minimum number of friends limitation", "type": "string" }, "pic": { "description": "Facebook profile picture", "type": "string" }, "socialUser": { "$ref": "#/definitions/KalturaSocialUser" }, "socialUsername": { "description": "Facebook username", "type": "string" }, "status": { "description": "User model status\r\n Possible values: UNKNOWN, OK, ERROR, NOACTION, NOTEXIST, CONFLICT, MERGE, MERGEOK, NEWUSER, MINFRIENDS, INVITEOK, INVITEERROR, ACCESSDENIED, WRONGPASSWORDORUSERNAME, UNMERGEOK", "type": "string" }, "token": { "description": "Facebook encrypted token", "type": "string" }, "userId": { "description": "User identifier", "type": "string" } }, "title": "KalturaSocialResponse", "type": "object" }, "KalturaSocialUser": { "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": "Facebook identifier", "type": "string" }, "lastName": { "description": "Last name", "type": "string" }, "name": { "description": "Full name", "type": "string" }, "userId": { "description": "User identifier", "type": "string" } }, "title": "KalturaSocialUser", "type": "object" }, "KalturaSocialUserConfig": { "allOf": [ { "$ref": "#/definitions/KalturaSocialConfig" } ], "properties": { "actionPermissionItems": { "items": { "$ref": "#/definitions/KalturaActionPermissionItem" }, "type": "array" } }, "title": "KalturaSocialUserConfig", "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" }, "KalturaStringValueArray": { "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaStringValue" }, "type": "array" } }, "title": "KalturaStringValueArray", "type": "object" }, "KalturaSubscription": { "description": "Subscription details", "properties": { "channels": { "items": { "$ref": "#/definitions/KalturaBaseChannel" }, "type": "array" }, "couponsGroups": { "items": { "$ref": "#/definitions/KalturaCouponsGroup" }, "type": "array" }, "dependencyType": { "description": "Enum Type: `KalturaSubscriptionDependencyType`\n\nDependency Type", "enum": [ "NOTAPPLICABLE", "BASE", "ADDON" ], "type": "string", "x-enumLabels": [ "NOTAPPLICABLE", "BASE", "ADDON" ], "x-enumType": "KalturaSubscriptionDependencyType" }, "description": { "description": "description of the subscription", "type": "string" }, "discountModule": { "$ref": "#/definitions/KalturaDiscountModule" }, "endDate": { "description": "The last date the subscription is available for purchasing", "type": "integer" }, "externalId": { "description": "External ID", "type": "string" }, "fileTypes": { "items": { "$ref": "#/definitions/KalturaIntegerValue" }, "type": "array" }, "gracePeriodMinutes": { "description": "The subscription grace period in minutes", "type": "integer" }, "householdLimitationsId": { "description": "The household limitation module identifier associated with this subscription", "type": "integer" }, "id": { "description": "Subscription identifier", "type": "string" }, "isCancellationBlocked": { "description": "Is cancellation blocked for the subscription", "type": "boolean" }, "isInfiniteRenewal": { "description": "Indicates whether the subscription will renew forever", "type": "boolean" }, "isRenewable": { "description": "Denotes whether or not this subscription can be renewed", "type": "boolean" }, "isWaiverEnabled": { "description": "Indicates whether or not the end user has the right to waive his rights to cancel a purchase", "type": "boolean" }, "maxViewsNumber": { "description": "The maximum number of times an item in this usage module can be viewed", "type": "integer" }, "mediaId": { "description": "Identifier of the media associated with the subscription", "type": "integer" }, "multilingualDescription": { "items": { "$ref": "#/definitions/KalturaTranslationToken" }, "type": "array" }, "multilingualName": { "items": { "$ref": "#/definitions/KalturaTranslationToken" }, "type": "array" }, "name": { "description": "Name of the subscription", "type": "string" }, "premiumServices": { "items": { "$ref": "#/definitions/KalturaPremiumService" }, "type": "array" }, "previewModule": { "$ref": "#/definitions/KalturaPreviewModule" }, "price": { "$ref": "#/definitions/KalturaPriceDetails" }, "pricePlanIds": { "description": "Comma separated subscription price plan IDs", "type": "string" }, "productCodes": { "items": { "$ref": "#/definitions/KalturaProductCode" }, "type": "array" }, "prorityInOrder": { "description": "Subscription order (when returned in methods that retrieve subscriptions)", "type": "integer" }, "renewalsNumber": { "description": "Defines the number of times this subscription will be renewed", "type": "integer" }, "startDate": { "description": "The first date the subscription is available for purchasing", "type": "integer" }, "userTypes": { "items": { "$ref": "#/definitions/KalturaOTTUserType" }, "type": "array" }, "viewLifeCycle": { "description": "The amount time an item is available for viewing since a user started watching the item", "type": "integer" }, "waiverPeriod": { "description": "Time period during which the end user can waive his rights to cancel a purchase. When the time period is passed, the purchase can no longer be cancelled", "type": "integer" } }, "title": "KalturaSubscription", "type": "object" }, "KalturaSubscriptionDependencySet": { "allOf": [ { "$ref": "#/definitions/KalturaSubscriptionSet" } ], "description": "Subscription Dependency Set", "properties": { "baseSubscriptionId": { "description": "Base Subscription identifier", "type": "integer" } }, "title": "KalturaSubscriptionDependencySet", "type": "object" }, "KalturaSubscriptionDependencySetFilter": { "allOf": [ { "$ref": "#/definitions/KalturaSubscriptionSetFilter" } ], "properties": { "baseSubscriptionIdIn": { "description": "Comma separated identifiers", "type": "string" } }, "title": "KalturaSubscriptionDependencySetFilter", "type": "object" }, "KalturaSubscriptionEntitlement": { "allOf": [ { "$ref": "#/definitions/KalturaEntitlement" } ], "description": "KalturaSubscriptionEntitlement", "properties": { "isInGracePeriod": { "description": "`readOnly`\n\nIndicates whether the user is currently in his grace period entitlement", "readOnly": true, "type": "boolean" }, "isRenewable": { "description": "`readOnly`\n\nIndicates whether a subscription is renewable (only for subscription)", "readOnly": true, "type": "boolean" }, "isRenewableForPurchase": { "description": "`readOnly`\n\nIndicates whether the subscription is renewable in this purchase (only for subscription)", "readOnly": true, "type": "boolean" }, "isSuspended": { "description": "`readOnly`\n\nIndicates if the subscription suspended", "readOnly": true, "type": "boolean" }, "nextRenewalDate": { "description": "`readOnly`\n\nThe date of the next renewal (only for subscription)", "readOnly": true, "type": "integer" }, "paymentGatewayId": { "description": "Payment Gateway identifier", "type": "integer" }, "paymentMethodId": { "description": "Payment Method identifier", "type": "integer" }, "scheduledSubscriptionId": { "description": "Scheduled Subscription Identifier", "type": "integer" }, "unifiedPaymentId": { "description": "Unified payment identifier", "type": "integer" } }, "title": "KalturaSubscriptionEntitlement", "type": "object" }, "KalturaSubscriptionFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "externalIdIn": { "description": "Comma separated subscription external IDs to get the subscriptions by", "type": "string" }, "mediaFileIdEqual": { "description": "Media-file ID to get the subscriptions by", "type": "integer" }, "orderBy": { "enum": [ "START_DATE_ASC", "START_DATE_DESC" ], "type": "string", "x-enumLabels": [ "START_DATE_ASC", "START_DATE_DESC" ], "x-enumType": "KalturaSubscriptionOrderBy" }, "subscriptionIdIn": { "description": "Comma separated subscription IDs to get the subscriptions by", "type": "string" } }, "title": "KalturaSubscriptionFilter", "type": "object" }, "KalturaSubscriptionListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "Subscriptions list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaSubscription" }, "type": "array" } }, "title": "KalturaSubscriptionListResponse", "type": "object" }, "KalturaSubscriptionPrice": { "allOf": [ { "$ref": "#/definitions/KalturaProductPrice" } ], "description": "Subscription price details", "properties": { "endDate": { "description": "If the item related to unified billing cycle purchased - until when the this price is relevant", "type": "integer" } }, "title": "KalturaSubscriptionPrice", "type": "object" }, "KalturaSubscriptionSet": { "description": "`abstract`\n\nSubscription details", "discriminator": "objectType", "oneOf": [ { "$ref": "#/definitions/KalturaSubscriptionDependencySet" }, { "$ref": "#/definitions/KalturaSubscriptionSwitchSet" } ], "properties": { "id": { "description": "`readOnly`\n\nSubscriptionSet identifier", "readOnly": true, "type": "integer" }, "name": { "description": "SubscriptionSet name", "type": "string" }, "objectType": { "enum": [ "KalturaSubscriptionDependencySet", "KalturaSubscriptionSwitchSet" ], "type": "string" }, "subscriptionIds": { "description": "A list of comma separated subscription ids associated with this set ordered by priority ascending", "type": "string" }, "type": { "description": "`readOnly`\n\nEnum Type: `KalturaSubscriptionSetType`\n\nType of the Subscription Set", "enum": [ "SWITCH", "DEPENDENCY" ], "readOnly": true, "type": "string", "x-enumLabels": [ "SWITCH", "DEPENDENCY" ], "x-enumType": "KalturaSubscriptionSetType" } }, "title": "KalturaSubscriptionSet", "type": "object" }, "KalturaSubscriptionSetFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "idIn": { "description": "Comma separated identifiers", "type": "string" }, "orderBy": { "enum": [ "NAME_ASC", "NAME_DESC" ], "type": "string", "x-enumLabels": [ "NAME_ASC", "NAME_DESC" ], "x-enumType": "KalturaSubscriptionSetOrderBy" }, "subscriptionIdContains": { "description": "Comma separated subscription identifiers", "type": "string" }, "typeEqual": { "description": "Enum Type: `KalturaSubscriptionSetType`\n\nSubscription Type", "enum": [ "SWITCH", "DEPENDENCY" ], "type": "string", "x-enumLabels": [ "SWITCH", "DEPENDENCY" ], "x-enumType": "KalturaSubscriptionSetType" } }, "title": "KalturaSubscriptionSetFilter", "type": "object" }, "KalturaSubscriptionSetListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "SubscriptionSets list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaSubscriptionSet" }, "type": "array" } }, "title": "KalturaSubscriptionSetListResponse", "type": "object" }, "KalturaSubscriptionSwitchSet": { "allOf": [ { "$ref": "#/definitions/KalturaSubscriptionSet" } ], "description": "Subscription details", "properties": {}, "title": "KalturaSubscriptionSwitchSet", "type": "object" }, "KalturaTag": { "properties": { "id": { "description": "`readOnly`\n\nTag id", "readOnly": true, "type": "integer" }, "multilingualTag": { "items": { "$ref": "#/definitions/KalturaTranslationToken" }, "type": "array" }, "tag": { "description": "Tag", "type": "string" }, "type": { "description": "Tag Type", "type": "integer" } }, "title": "KalturaTag", "type": "object" }, "KalturaTagFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "languageEqual": { "description": "Language to filter by", "type": "string" }, "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaTagOrderBy" }, "tagEqual": { "description": "Tag to filter by", "type": "string" }, "tagStartsWith": { "description": "Tag to filter by", "type": "string" }, "typeEqual": { "description": "Type identifier", "type": "integer" } }, "title": "KalturaTagFilter", "type": "object" }, "KalturaTagListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaTag" }, "type": "array" } }, "title": "KalturaTagListResponse", "type": "object" }, "KalturaTimeShiftedTvPartnerSettings": { "properties": { "catchUpBufferLength": { "description": "Catch-up buffer length", "type": "integer" }, "catchUpEnabled": { "description": "Is catch-up enabled", "type": "boolean" }, "cdvrEnabled": { "description": "Is c-dvr enabled", "type": "boolean" }, "cleanupNoticePeriod": { "description": "The time in days before the recording lifetime is due from which the client should be able to warn user about deletion.", "type": "integer" }, "nonEntitledChannelPlaybackEnabled": { "description": "Is recording playback for non-entitled channel enables", "type": "boolean" }, "nonExistingChannelPlaybackEnabled": { "description": "Is recording playback for non-existing channel enables", "type": "boolean" }, "paddingAfterProgramEnds": { "description": "Indicates how long (in seconds) after the program ends the recording will end", "type": "integer" }, "paddingBeforeProgramStarts": { "description": "Indicates how long (in seconds) before the program starts the recording will begin", "type": "integer" }, "protectionEnabled": { "description": "Is recording protection enabled", "type": "boolean" }, "protectionPeriod": { "description": "Specify the time in days that a recording should be protected. Start time begins at protection request.", "type": "integer" }, "protectionPolicy": { "description": "Enum Type: `KalturaProtectionPolicy`\n\nProtection Policy", "enum": [ "ExtendingRecordingLifetime", "LimitedByRecordingLifetime" ], "type": "string", "x-enumLabels": [ "EXTENDINGRECORDINGLIFETIME", "LIMITEDBYRECORDINGLIFETIME" ], "x-enumType": "KalturaProtectionPolicy" }, "protectionQuotaPercentage": { "description": "Indicates how many percent of the quota can be used for protection", "type": "integer" }, "quotaOveragePolicy": { "description": "Enum Type: `KalturaQuotaOveragePolicy`\n\nQuota Policy", "enum": [ "StopAtQuota", "FIFOAutoDelete" ], "type": "string", "x-enumLabels": [ "STOPATQUOTA", "FIFOAUTODELETE" ], "x-enumType": "KalturaQuotaOveragePolicy" }, "recordingLifetimePeriod": { "description": "Specify the time in days that a recording should be kept for user. Start time begins with the program end date.", "type": "integer" }, "recordingScheduleWindow": { "description": "Recording schedule window. Indicates how long (in minutes) after the program starts it is allowed to schedule the recording", "type": "integer" }, "recordingScheduleWindowEnabled": { "description": "Is recording schedule window enabled", "type": "boolean" }, "recoveryGracePeriod": { "description": "The time in days for recovery recording that was delete by Auto Delete .", "type": "integer" }, "seriesRecordingEnabled": { "description": "Is recording of series enabled", "type": "boolean" }, "startOverEnabled": { "description": "Is start-over enabled", "type": "boolean" }, "trickPlayBufferLength": { "description": "Trick play buffer length", "type": "integer" }, "trickPlayEnabled": { "description": "Is trick-play enabled", "type": "boolean" } }, "title": "KalturaTimeShiftedTvPartnerSettings", "type": "object" }, "KalturaTopic": { "properties": { "automaticIssueNotification": { "description": "Enum Type: `KalturaTopicAutomaticIssueNotification`\n\nautomaticIssueNotification", "enum": [ "Inherit", "Yes", "No" ], "type": "string", "x-enumLabels": [ "INHERIT", "YES", "NO" ], "x-enumType": "KalturaTopicAutomaticIssueNotification" }, "id": { "description": "`readOnly`\n\nmessage id", "readOnly": true, "type": "string" }, "lastMessageSentDateSec": { "description": "lastMessageSentDateSec", "type": "integer" }, "name": { "description": "message", "type": "string" }, "subscribersAmount": { "description": "message", "type": "string" } }, "title": "KalturaTopic", "type": "object" }, "KalturaTopicFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "properties": { "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaTopicOrderBy" } }, "title": "KalturaTopicFilter", "type": "object" }, "KalturaTopicListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "List of inbox message.", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaTopic" }, "type": "array" } }, "title": "KalturaTopicListResponse", "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" }, "KalturaTransactionHistoryFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "Transactions filter", "properties": { "endDateLessThanOrEqual": { "description": "Filter transactions earlier than specific date", "type": "integer" }, "entityReferenceEqual": { "description": "Enum Type: `KalturaEntityReferenceBy`\n\nReference type to filter by", "enum": [ "user", "household" ], "type": "string", "x-enumLabels": [ "USER", "HOUSEHOLD" ], "x-enumType": "KalturaEntityReferenceBy" }, "orderBy": { "enum": [ "CREATE_DATE_ASC", "CREATE_DATE_DESC" ], "type": "string", "x-enumLabels": [ "CREATE_DATE_ASC", "CREATE_DATE_DESC" ], "x-enumType": "KalturaTransactionHistoryOrderBy" }, "startDateGreaterThanOrEqual": { "description": "Filter transactions later than specific date", "type": "integer" } }, "title": "KalturaTransactionHistoryFilter", "type": "object" }, "KalturaTransactionStatus": { "properties": { "adapterTransactionStatus": { "description": "Enum Type: `KalturaTransactionAdapterStatus`\n\nPayment 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" }, "KalturaTranslationToken": { "description": "Container for translation", "properties": { "language": { "description": "Language code", "type": "string" }, "value": { "description": "Translated value", "type": "string" } }, "title": "KalturaTranslationToken", "type": "object" }, "KalturaTwitterTwit": { "allOf": [ { "$ref": "#/definitions/KalturaSocialNetworkComment" } ], "properties": {}, "title": "KalturaTwitterTwit", "type": "object" }, "KalturaUnifiedPaymentRenewal": { "properties": { "date": { "description": "Next renewal date", "type": "integer" }, "entitlements": { "items": { "$ref": "#/definitions/KalturaEntitlementRenewalBase" }, "type": "array" }, "price": { "$ref": "#/definitions/KalturaPrice" }, "unifiedPaymentId": { "description": "Unified payment ID", "type": "integer" } }, "title": "KalturaUnifiedPaymentRenewal", "type": "object" }, "KalturaUploadToken": { "properties": { "createDate": { "description": "`readOnly`\n\nSpecifies when was the Asset was created. Date and time represented as epoch.", "readOnly": true, "type": "integer" }, "fileSize": { "description": "`readOnly`\n\nFile size", "readOnly": true, "type": "number" }, "id": { "description": "`readOnly`\n\nUpload-token identifier", "readOnly": true, "type": "string" }, "status": { "description": "`readOnly`\n\nEnum Type: `KalturaUploadTokenStatus`\n\nStatus", "enum": [ "PENDING", "FULL_UPLOAD", "CLOSED" ], "readOnly": true, "type": "string", "x-enumLabels": [ "PENDING", "FULL_UPLOAD", "CLOSED" ], "x-enumType": "KalturaUploadTokenStatus" }, "updateDate": { "description": "`readOnly`\n\nSpecifies when was the Asset last updated. Date and time represented as epoch.", "readOnly": true, "type": "integer" } }, "title": "KalturaUploadToken", "type": "object" }, "KalturaUploadedFileTokenResource": { "allOf": [ { "$ref": "#/definitions/KalturaContentResource" } ], "properties": { "token": { "description": "Token that returned from uploadToken.add action", "type": "string" } }, "title": "KalturaUploadedFileTokenResource", "type": "object" }, "KalturaUrlResource": { "allOf": [ { "$ref": "#/definitions/KalturaContentResource" } ], "properties": { "url": { "description": "URL of the content", "type": "string" } }, "title": "KalturaUrlResource", "type": "object" }, "KalturaUsageModule": { "description": "Pricing usage module", "properties": { "couponId": { "description": "`readOnly`\n\nIdentifies a specific coupon linked to this object", "readOnly": true, "type": "integer" }, "fullLifeCycle": { "description": "`readOnly`\n\nThe amount time an item is available for viewing", "readOnly": true, "type": "integer" }, "id": { "description": "`readOnly`\n\nUsage module identifier", "readOnly": true, "type": "integer" }, "isOfflinePlayback": { "description": "`readOnly`\n\nIndicates that usage is targeted for offline playback", "readOnly": true, "type": "boolean" }, "isWaiverEnabled": { "description": "`readOnly`\n\nIndicates whether or not the end user has the right to waive his rights to cancel a purchase", "readOnly": true, "type": "boolean" }, "maxViewsNumber": { "description": "`readOnly`\n\nThe maximum number of times an item in this usage module can be viewed", "readOnly": true, "type": "integer" }, "name": { "description": "`readOnly`\n\nUsage module name", "readOnly": true, "type": "string" }, "viewLifeCycle": { "description": "`readOnly`\n\nThe amount time an item is available for viewing since a user started watching the item", "readOnly": true, "type": "integer" }, "waiverPeriod": { "description": "`readOnly`\n\nTime period during which the end user can waive his rights to cancel a purchase. When the time period is passed, the purchase can no longer be cancelled", "readOnly": true, "type": "integer" } }, "title": "KalturaUsageModule", "type": "object" }, "KalturaUserAssetRule": { "description": "User asset rule - representing different type of rules on an asset(Parental, Geo, User Type, Device)", "properties": { "description": { "description": "Additional description for the specific rule", "type": "string" }, "id": { "description": "`readOnly`\n\nUnique rule identifier", "readOnly": true, "type": "integer" }, "name": { "description": "Rule display name", "type": "string" }, "ruleType": { "description": "Enum Type: `KalturaRuleType`\n\nRule type - possible values: Rule type – Parental, Geo, UserType, Device", "enum": [ "parental", "geo", "user_type", "device" ], "type": "string", "x-enumLabels": [ "PARENTAL", "GEO", "USER_TYPE", "DEVICE" ], "x-enumType": "KalturaRuleType" } }, "title": "KalturaUserAssetRule", "type": "object" }, "KalturaUserAssetRuleFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "User asset rule filter", "properties": { "assetIdEqual": { "description": "Asset identifier to filter by", "type": "integer" }, "assetTypeEqual": { "description": "Asset type to filter by - 0 = EPG, 1 = media", "type": "integer" }, "orderBy": { "enum": [ "NAME_ASC", "NAME_DESC" ], "type": "string", "x-enumLabels": [ "NAME_ASC", "NAME_DESC" ], "x-enumType": "KalturaUserAssetRuleOrderBy" } }, "title": "KalturaUserAssetRuleFilter", "type": "object" }, "KalturaUserAssetRuleListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "GenericRules list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaUserAssetRule" }, "type": "array" } }, "title": "KalturaUserAssetRuleListResponse", "type": "object" }, "KalturaUserAssetsListItem": { "description": "An item of user asset list", "properties": { "id": { "description": "Asset identifier", "type": "string" }, "listType": { "description": "Enum Type: `KalturaUserAssetsListType`\n\nThe type of the list, all is not supported", "enum": [ "all", "watch", "purchase", "library" ], "type": "string", "x-enumLabels": [ "ALL", "WATCH", "PURCHASE", "LIBRARY" ], "x-enumType": "KalturaUserAssetsListType" }, "orderIndex": { "description": "The order index of the asset in the list", "type": "integer" }, "type": { "description": "Enum Type: `KalturaUserAssetsListItemType`\n\nThe type of the asset", "enum": [ "all", "media" ], "type": "string", "x-enumLabels": [ "ALL", "MEDIA" ], "x-enumType": "KalturaUserAssetsListItemType" }, "userId": { "description": "`readOnly`\n\nThe identifier of the user who added the item to the list", "readOnly": true, "type": "string" } }, "title": "KalturaUserAssetsListItem", "type": "object" }, "KalturaUserInterest": { "description": "User Interest", "properties": { "id": { "description": "Identifier", "type": "string" }, "topic": { "$ref": "#/definitions/KalturaUserInterestTopic" } }, "title": "KalturaUserInterest", "type": "object" }, "KalturaUserInterestListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "User interest list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaUserInterest" }, "type": "array" } }, "title": "KalturaUserInterestListResponse", "type": "object" }, "KalturaUserInterestTopic": { "description": "User interest topic", "properties": { "metaId": { "description": "Meta identifier", "type": "string" }, "parentTopic": { "$ref": "#/definitions/KalturaUserInterestTopic" }, "value": { "description": "Meta Value", "type": "string" } }, "title": "KalturaUserInterestTopic", "type": "object" }, "KalturaUserLoginPin": { "description": "Log in pin code details", "properties": { "expirationTime": { "description": "Login pin expiration time (epoch)", "type": "integer" }, "pinCode": { "description": "Generated login pin code", "type": "string" }, "userId": { "description": "`readOnly`\n\nUser Identifier", "readOnly": true, "type": "string" } }, "title": "KalturaUserLoginPin", "type": "object" }, "KalturaUserRole": { "properties": { "excludedPermissionNames": { "description": "permissions associated with the user role in is_exclueded = true", "type": "string" }, "id": { "description": "`readOnly`\n\nUser role identifier", "readOnly": true, "type": "integer" }, "name": { "description": "User role name", "type": "string" }, "permissionNames": { "description": "permissions associated with the user role", "type": "string" } }, "title": "KalturaUserRole", "type": "object" }, "KalturaUserRoleFilter": { "allOf": [ { "$ref": "#/definitions/KalturaFilter" } ], "description": "User roles filter", "properties": { "currentUserRoleIdsContains": { "description": "Indicates whether the results should be filtered by userId using the current", "type": "boolean" }, "idIn": { "description": "Comma separated roles identifiers", "type": "string" }, "orderBy": { "enum": [ "NONE" ], "type": "string", "x-enumLabels": [ "NONE" ], "x-enumType": "KalturaUserRoleOrderBy" } }, "title": "KalturaUserRoleFilter", "type": "object" }, "KalturaUserRoleListResponse": { "allOf": [ { "$ref": "#/definitions/KalturaListResponse" } ], "description": "User-roles list", "properties": { "objects": { "items": { "$ref": "#/definitions/KalturaUserRole" }, "type": "array" } }, "title": "KalturaUserRoleListResponse", "type": "object" }, "KalturaUserSocialActionResponse": { "properties": { "failStatus": { "items": { "$ref": "#/definitions/KalturaNetworkActionStatus" }, "type": "array" }, "socialAction": { "$ref": "#/definitions/KalturaSocialAction" } }, "title": "KalturaUserSocialActionResponse", "type": "object" }, "KalturaValue": { "description": "`abstract`\n\nA 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" }, "OTTRequest": { "properties": { "ks": { "type": "string" }, "version": { "default": "3.6.287.20720", "type": "string" } }, "type": "object" } }, "host": "tvpapi-us-preprod.ott.kaltura.com", "info": { "description": "The Kaltura OTT API", "title": "Kaltura OTT", "version": "3.6.287.20720" }, "parameters": { "format": { "description": "The format of the response", "enum": [ 1, 2, 3 ], "in": "query", "name": "format", "type": "integer", "x-consoleDefault": 1, "x-enumLabels": [ "JSON", "XML", "PHP" ], "x-global": true }, "ks": { "in": "query", "name": "ks", "type": "string", "x-global": true } }, "paths": { "/service/announcement/action/add": { "post": { "description": "Add a new future scheduled system announcement push notification", "operationId": "announcement.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "announcement": { "$ref": "#/definitions/KalturaAnnouncement" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaAnnouncement" } }, "x-Errors": { "description": "* `500039`\n* `FeatureDisabled`: undefined\n* `AnnouncementMessageIsEmpty`: undefined\n* `AnnouncementMessageTooLong`: undefined\n* `AnnouncementInvalidTimezone`: undefined" } }, "tags": [ "announcement" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "announcement" ] } }, "/service/announcement/action/delete": { "post": { "description": "Delete an existing announcing. Announcement cannot be delete while being sent.", "operationId": "announcement.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `AnnouncementNotFound`: undefined\n* `FeatureDisabled`: undefined" } }, "tags": [ "announcement" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/announcement/action/enableSystemAnnouncements": { "post": { "description": "Enable system announcements", "operationId": "announcement.enableSystemAnnouncements", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `FailCreateAnnouncement`: undefined\n* `FeatureDisabled`: undefined" } }, "tags": [ "announcement" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/announcement/action/list": { "post": { "description": "Lists all announcements in the system.", "operationId": "announcement.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaAnnouncementFilter" }, "pager": { "$ref": "#/definitions/KalturaFilterPager" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaAnnouncementListResponse" } }, "x-Errors": { "description": "* `FeatureDisabled`: undefined" } }, "tags": [ "announcement" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter", "pager" ] } }, "/service/announcement/action/update": { "post": { "description": "Update an existing future system announcement push notification. Announcement can only be updated only before sending", "operationId": "announcement.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "announcement": { "$ref": "#/definitions/KalturaAnnouncement" }, "announcementId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaAnnouncement" } }, "x-Errors": { "description": "* `AnnouncementMessageIsEmpty`: undefined\n* `AnnouncementInvalidTimezone`: undefined\n* `AnnouncementUpdateNotAllowed`: undefined\n* `AnnouncementMessageTooLong`: undefined\n* `500039`\n* `AnnouncementNotFound`: undefined\n* `FeatureDisabled`: undefined" } }, "tags": [ "announcement" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "announcementId", "announcement" ] } }, "/service/announcement/action/updateStatus": { "post": { "description": "Update a system announcement status", "operationId": "announcement.updateStatus", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" }, "status": { "type": "boolean" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `FeatureDisabled`: undefined\n* `AnnouncementUpdateNotAllowed`: undefined\n* `AnnouncementNotFound`: undefined" } }, "tags": [ "announcement" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "status" ] } }, "/service/apptoken/action/add": { "post": { "description": "Add new application authentication token", "operationId": "appToken.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "appToken": { "$ref": "#/definitions/KalturaAppToken" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaAppToken" } } }, "tags": [ "appToken" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "appToken" ] } }, "/service/apptoken/action/delete": { "post": { "description": "Delete application authentication token by id", "operationId": "appToken.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "appToken" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/apptoken/action/get": { "post": { "description": "Get application authentication token by id", "operationId": "appToken.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaAppToken" } } }, "tags": [ "appToken" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/apptoken/action/startSession": { "post": { "description": "Starts a new KS (Kaltura Session) based on application authentication token id", "operationId": "appToken.startSession", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "expiry": { "type": "integer" }, "id": { "type": "string" }, "tokenHash": { "type": "string" }, "udid": { "type": "string" }, "userId": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaSessionInfo" } }, "x-Errors": { "description": "* `50022`\n* `50023`\n* `50021`" } }, "tags": [ "appToken" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "tokenHash", "userId", "expiry", "udid" ] } }, "/service/asset/action/add": { "post": { "description": "Add a new asset", "operationId": "asset.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "asset": { "$ref": "#/definitions/KalturaAsset" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaAsset" } }, "x-Errors": { "description": "* `AssetStructDoesNotExist`: undefined\n* `InvalidMetaType`: undefined\n* `GeoBlockRuleDoesNotExistForGroup`: undefined\n* `InvalidValueSentForMeta`: undefined\n* `DeviceRuleDoesNotExistForGroup`: undefined\n* `AssetExternalIdMustBeUnique`: undefined" } }, "tags": [ "asset" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "asset" ] } }, "/service/asset/action/count": { "post": { "description": "Returns a group-by result for media or EPG according to given filter. Lists values of each field and their respective count.", "operationId": "asset.count", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaSearchAssetFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaAssetCount" } } }, "tags": [ "asset" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/asset/action/delete": { "post": { "description": "Delete an existing asset", "operationId": "asset.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "assetReferenceType": { "enum": [ "media", "epg_internal", "epg_external" ], "type": "string", "x-enumLabels": [ "MEDIA", "EPG_INTERNAL", "EPG_EXTERNAL" ], "x-enumType": "KalturaAssetReferenceType" }, "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `AssetDoesNotExist`: undefined" } }, "tags": [ "asset" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "assetReferenceType" ] } }, "/service/asset/action/get": { "post": { "description": "Returns media or EPG asset by media / EPG internal or external identifier", "operationId": "asset.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "assetReferenceType": { "enum": [ "media", "epg_internal", "epg_external" ], "type": "string", "x-enumLabels": [ "MEDIA", "EPG_INTERNAL", "EPG_EXTERNAL" ], "x-enumType": "KalturaAssetReferenceType" }, "id": { "type": "string", "x-dynamicEnum": { "array": "objects", "label": "id", "method": "post", "path": "/service/asset/action/list", "value": "id" } } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaAsset" } }, "x-Errors": { "description": "* `500007`" } }, "tags": [ "asset" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "assetReferenceType" ] } }, "/service/asset/action/getAdsContext": { "post": { "description": "Returns the data for ads control", "operationId": "asset.getAdsContext", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "assetId": { "type": "string" }, "assetType": { "enum": [ "media", "recording", "epg" ], "type": "string", "x-enumLabels": [ "MEDIA", "RECORDING", "EPG" ], "x-enumType": "KalturaAssetType" }, "contextDataParams": { "$ref": "#/definitions/KalturaPlaybackContextOptions" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaAdsContext" } }, "x-Errors": { "description": "* `RecordingStatusNotValid`: undefined\n* `RecordingPlaybackNotAllowedForNonExistingEpgChannel`: undefined\n* `RecordingNotFound`: undefined\n* `ProgramDoesntExist`: undefined\n* `DeviceNotInDomain`: undefined\n* `ServiceNotAllowed`: undefined\n* `NotEntitled`: undefined\n* `RecordingPlaybackNotAllowedForNotEntitledEpgChannel`: undefined" } }, "tags": [ "asset" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "assetId", "assetType", "contextDataParams" ] } }, "/service/asset/action/getPlaybackContext": { "post": { "description": "This action delivers all data relevant for player", "operationId": "asset.getPlaybackContext", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "assetId": { "type": "string" }, "assetType": { "enum": [ "media", "recording", "epg" ], "type": "string", "x-enumLabels": [ "MEDIA", "RECORDING", "EPG" ], "x-enumType": "KalturaAssetType" }, "contextDataParams": { "$ref": "#/definitions/KalturaPlaybackContextOptions" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaPlaybackContext" } }, "x-Errors": { "description": "* `ProgramDoesntExist`: undefined\n* `RecordingStatusNotValid`: undefined\n* `RecordingNotFound`: undefined\n* `DeviceNotInDomain`: undefined" } }, "tags": [ "asset" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "assetId", "assetType", "contextDataParams" ] } }, "/service/asset/action/list": { "post": { "description": "Returns media or EPG assets. Filters by media identifiers or by EPG internal or external identifier.", "operationId": "asset.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaAssetFilter" }, "pager": { "$ref": "#/definitions/KalturaFilterPager" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaAssetListResponse" } } }, "tags": [ "asset" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter", "pager" ] } }, "/service/asset/action/removeMetasAndTags": { "post": { "description": "remove metas and tags from asset", "operationId": "asset.removeMetasAndTags", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "assetReferenceType": { "enum": [ "media", "epg_internal", "epg_external" ], "type": "string", "x-enumLabels": [ "MEDIA", "EPG_INTERNAL", "EPG_EXTERNAL" ], "x-enumType": "KalturaAssetReferenceType" }, "id": { "type": "integer" }, "idIn": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `AssetDoesNotExist`: undefined\n* `CanNotRemoveBasicMetaIds`: undefined" } }, "tags": [ "asset" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "assetReferenceType", "idIn" ] } }, "/service/asset/action/update": { "post": { "description": "update an existing asset", "operationId": "asset.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "asset": { "$ref": "#/definitions/KalturaAsset" }, "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaAsset" } }, "x-Errors": { "description": "* `AssetDoesNotExist`: undefined\n* `AssetExternalIdMustBeUnique`: undefined\n* `GeoBlockRuleDoesNotExistForGroup`: undefined\n* `InvalidMetaType`: undefined\n* `DeviceRuleDoesNotExistForGroup`: undefined\n* `InvalidValueSentForMeta`: undefined" } }, "tags": [ "asset" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "asset" ] } }, "/service/assetcomment/action/add": { "post": { "description": "Add asset comments by asset id", "operationId": "assetComment.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "comment": { "$ref": "#/definitions/KalturaAssetComment" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaAssetComment" } } }, "tags": [ "assetComment" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "comment" ] } }, "/service/assetcomment/action/list": { "post": { "description": "Returns asset comments by asset id", "operationId": "assetComment.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaAssetCommentFilter" }, "pager": { "$ref": "#/definitions/KalturaFilterPager" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaAssetCommentListResponse" } } }, "tags": [ "assetComment" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter", "pager" ] } }, "/service/assetfile/action/getContext": { "post": { "description": "get KalturaAssetFileContext", "operationId": "assetFile.getContext", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "contextType": { "enum": [ "none", "recording" ], "type": "string", "x-enumLabels": [ "NONE", "RECORDING" ], "x-enumType": "KalturaContextType" }, "id": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaAssetFileContext" } } }, "tags": [ "assetFile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "contextType" ] } }, "/service/assetfile/action/playManifest": { "post": { "description": "Redirects to play manifest", "operationId": "assetFile.playManifest", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "assetFileId": { "type": "integer" }, "assetId": { "type": "string" }, "assetType": { "enum": [ "media", "recording", "epg" ], "type": "string", "x-enumLabels": [ "MEDIA", "RECORDING", "EPG" ], "x-enumType": "KalturaAssetType" }, "contextType": { "enum": [ "TRAILER", "CATCHUP", "START_OVER", "PLAYBACK" ], "type": "string", "x-enumLabels": [ "TRAILER", "CATCHUP", "START_OVER", "PLAYBACK" ], "x-enumType": "KalturaPlaybackContextType" }, "ks": { "type": "string" }, "partnerId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success" }, "x-Errors": { "description": "* `RecordingPlaybackNotAllowedForNonExistingEpgChannel`: undefined\n* `RecordingStatusNotValid`: undefined\n* `RecordingPlaybackNotAllowedForNotEntitledEpgChannel`: undefined\n* `ConcurrencyLimitation`: undefined\n* `ServiceNotAllowed`: undefined\n* `ProgramDoesntExist`: undefined\n* `RecordingNotFound`: undefined\n* `NotEntitled`: undefined\n* `DeviceTypeNotAllowed`: undefined\n* `DeviceNotInDomain`: undefined\n* `UserSuspended`: undefined\n* `MediaConcurrencyLimitation`: undefined" } }, "tags": [ "assetFile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "partnerId", "assetId", "assetType", "assetFileId", "contextType", "ks" ] } }, "/service/assethistory/action/clean": { "post": { "description": "Clean the user’s viewing history", "operationId": "assetHistory.clean", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaAssetHistoryFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success" } }, "tags": [ "assetHistory" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/assethistory/action/list": { "post": { "description": "Get recently watched media for user, ordered by recently watched first.", "operationId": "assetHistory.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaAssetHistoryFilter" }, "pager": { "$ref": "#/definitions/KalturaFilterPager" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaAssetHistoryListResponse" } } }, "tags": [ "assetHistory" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter", "pager" ] } }, "/service/assetstatistics/action/query": { "post": { "description": "Returns statistics for given list of assets by type and / or time period", "operationId": "assetStatistics.query", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "query": { "$ref": "#/definitions/KalturaAssetStatisticsQuery" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaAssetStatisticsListResponse" } } }, "tags": [ "assetStatistics" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "query" ] } }, "/service/assetstruct/action/add": { "post": { "description": "Add a new assetStruct", "operationId": "assetStruct.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "assetStruct": { "$ref": "#/definitions/KalturaAssetStruct" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaAssetStruct" } }, "x-Errors": { "description": "* `AssetStructMissingBasicMetaIds`: undefined\n* `MetaIdsDoesNotExist`: undefined\n* `AssetStructSystemNameAlreadyInUse`: undefined\n* `AssetStructNameAlreadyInUse`: undefined" } }, "tags": [ "assetStruct" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "assetStruct" ] } }, "/service/assetstruct/action/delete": { "post": { "description": "Delete an existing assetStruct", "operationId": "assetStruct.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `AssetStructDoesNotExist`: undefined\n* `CanNotDeletePredefinedAssetStruct`: undefined" } }, "tags": [ "assetStruct" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/assetstruct/action/list": { "post": { "description": "Return a list of asset structs for the account with optional filter", "operationId": "assetStruct.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaAssetStructFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaAssetStructListResponse" } } }, "tags": [ "assetStruct" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/assetstruct/action/update": { "post": { "description": "Update an existing assetStruct", "operationId": "assetStruct.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "assetStruct": { "$ref": "#/definitions/KalturaAssetStruct" }, "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaAssetStruct" } }, "x-Errors": { "description": "* `MetaIdsDoesNotExist`: undefined\n* `AssetStructDoesNotExist`: undefined\n* `AssetStructNameAlreadyInUse`: undefined\n* `AssetStructSystemNameAlreadyInUse`: undefined\n* `CanNotChangePredefinedAssetStructSystemName`: undefined\n* `AssetStructMissingBasicMetaIds`: undefined" } }, "tags": [ "assetStruct" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "assetStruct" ] } }, "/service/bookmark/action/add": { "post": { "description": "Report player position and action for the user on the watched asset. Player position is used to later allow resume watching.", "operationId": "bookmark.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "bookmark": { "$ref": "#/definitions/KalturaBookmark" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `InvalidAssetType`: undefined\n* `ConcurrencyLimitation`: undefined\n* `ProgramDoesntExist`: undefined\n* `ActionNotRecognized`: undefined\n* `InvalidAssetId`: undefined" } }, "tags": [ "bookmark" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "bookmark" ] } }, "/service/bookmark/action/list": { "post": { "description": "Returns player position record/s for the requested asset and the requesting user. \r\n If default user makes the request – player position records are provided for all of the users in the household.\r\n If non-default user makes the request - player position records are provided for the requesting user and the default user of the household.", "operationId": "bookmark.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaBookmarkFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaBookmarkListResponse" } }, "x-Errors": { "description": "* `InvalidUser`: undefined\n* `UserNotExistsInDomain`: undefined\n* `InvalidAssetType`: undefined" } }, "tags": [ "bookmark" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/cdnadapterprofile/action/add": { "post": { "description": "Insert new CDN adapter for partner", "operationId": "cdnAdapterProfile.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "adapter": { "$ref": "#/definitions/KalturaCDNAdapterProfile" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaCDNAdapterProfile" } }, "x-Errors": { "description": "* `NameRequired`: undefined\n* `AdapterUrlRequired`: undefined\n* `AliasRequired`: undefined\n* `AliasMustBeUnique`: undefined" } }, "tags": [ "cdnAdapterProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "adapter" ] } }, "/service/cdnadapterprofile/action/delete": { "post": { "description": "Delete CDN adapter by CDN adapter id", "operationId": "cdnAdapterProfile.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "adapterId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `AdapterNotExists`: undefined\n* `AdapterIdentifierRequired`: undefined" } }, "tags": [ "cdnAdapterProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "adapterId" ] } }, "/service/cdnadapterprofile/action/generateSharedSecret": { "post": { "description": "Generate CDN adapter shared secret", "operationId": "cdnAdapterProfile.generateSharedSecret", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "adapterId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaCDNAdapterProfile" } }, "x-Errors": { "description": "* `AdapterNotExists`: undefined\n* `AdapterIdentifierRequired`: undefined" } }, "tags": [ "cdnAdapterProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "adapterId" ] } }, "/service/cdnadapterprofile/action/list": { "post": { "description": "Returns all CDN adapters for partner", "operationId": "cdnAdapterProfile.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaCDNAdapterProfileListResponse" } } }, "tags": [ "cdnAdapterProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/cdnadapterprofile/action/update": { "post": { "description": "Update CDN adapter details", "operationId": "cdnAdapterProfile.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "adapter": { "$ref": "#/definitions/KalturaCDNAdapterProfile" }, "adapterId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaCDNAdapterProfile" } }, "x-Errors": { "description": "* `AdapterIdentifierRequired`: undefined\n* `AdapterUrlRequired`: undefined\n* `AliasMustBeUnique`: undefined\n* `AliasRequired`: undefined\n* `NameRequired`: undefined\n* `AdapterNotExists`: undefined" } }, "tags": [ "cdnAdapterProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "adapterId", "adapter" ] } }, "/service/cdnpartnersettings/action/get": { "post": { "description": "Retrieve the partner’s CDN settings (default adapters)", "operationId": "cdnPartnerSettings.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaCDNPartnerSettings" } }, "x-Errors": { "description": "* `CDNPartnerSettingsNotFound`: undefined" } }, "tags": [ "cdnPartnerSettings" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/cdnpartnersettings/action/update": { "post": { "description": "Configure the partner’s CDN settings (default adapters)", "operationId": "cdnPartnerSettings.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "settings": { "$ref": "#/definitions/KalturaCDNPartnerSettings" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaCDNPartnerSettings" } }, "x-Errors": { "description": "* `CDNPartnerSettingsNotFound`: undefined" } }, "tags": [ "cdnPartnerSettings" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "settings" ] } }, "/service/cdvradapterprofile/action/add": { "post": { "description": "Insert new C-DVR adapter for partner", "operationId": "cDVRAdapterProfile.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "adapter": { "$ref": "#/definitions/KalturaCDVRAdapterProfile" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaCDVRAdapterProfile" } }, "x-Errors": { "description": "* `NameRequired`: undefined\n* `ExternalIdentifierRequired`: undefined\n* `AdapterUrlRequired`: undefined\n* `ExternalIdentifierMustBeUnique`: undefined" } }, "tags": [ "cDVRAdapterProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "adapter" ] } }, "/service/cdvradapterprofile/action/delete": { "post": { "description": "Delete C-DVR adapter by C-DVR adapter id", "operationId": "cDVRAdapterProfile.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "adapterId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `AdapterNotExists`: undefined" } }, "tags": [ "cDVRAdapterProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "adapterId" ] } }, "/service/cdvradapterprofile/action/generateSharedSecret": { "post": { "description": "Generate C-DVR adapter shared secret", "operationId": "cDVRAdapterProfile.generateSharedSecret", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "adapterId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaCDVRAdapterProfile" } }, "x-Errors": { "description": "* `AdapterIdentifierRequired`: undefined\n* `AdapterNotExists`: undefined" } }, "tags": [ "cDVRAdapterProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "adapterId" ] } }, "/service/cdvradapterprofile/action/list": { "post": { "description": "Returns all C-DVR adapters for partner", "operationId": "cDVRAdapterProfile.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaCDVRAdapterProfileListResponse" } } }, "tags": [ "cDVRAdapterProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/cdvradapterprofile/action/update": { "post": { "description": "Update C-DVR adapter details", "operationId": "cDVRAdapterProfile.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "adapter": { "$ref": "#/definitions/KalturaCDVRAdapterProfile" }, "adapterId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaCDVRAdapterProfile" } }, "x-Errors": { "description": "* `AdapterUrlRequired`: undefined\n* `AdapterIdentifierRequired`: undefined\n* `NameRequired`: undefined\n* `ExternalIdentifierRequired`: undefined\n* `AdapterNotExists`: undefined" } }, "tags": [ "cDVRAdapterProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "adapterId", "adapter" ] } }, "/service/channel/action/add": { "post": { "description": "Insert new channel for partner. Supports KalturaDynamicChannel or KalturaManualChannel", "operationId": "channel.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "channel": { "$ref": "#/definitions/KalturaChannel" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaChannel" } }, "x-Errors": { "description": "* `ChannelSystemNameAlreadyInUse`: undefined\n* `NameRequired`: undefined\n* `NoObjectToInsert`: undefined\n* `AssetDoesNotExist`: undefined" } }, "tags": [ "channel" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "channel" ] } }, "/service/channel/action/delete": { "post": { "description": "Delete channel by its channel id", "operationId": "channel.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "channelId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `IdentifierRequired`: undefined\n* `ObjectNotExist`: undefined" } }, "tags": [ "channel" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "channelId" ] } }, "/service/channel/action/get": { "post": { "description": "Returns channel", "operationId": "channel.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer", "x-dynamicEnum": { "array": "objects", "label": "id", "method": "post", "path": "/service/channel/action/list", "value": "id" } } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaChannel" } }, "x-Errors": { "description": "" } }, "tags": [ "channel" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/channel/action/list": { "post": { "description": "Get the list of tags for the partner", "operationId": "channel.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaChannelsFilter" }, "pager": { "$ref": "#/definitions/KalturaFilterPager" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaChannelListResponse" } } }, "tags": [ "channel" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter", "pager" ] } }, "/service/channel/action/update": { "post": { "description": "Update channel details. Supports KalturaDynamicChannel or KalturaManualChannel", "operationId": "channel.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "channel": { "$ref": "#/definitions/KalturaChannel" }, "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaChannel" } }, "x-Errors": { "description": "* `NameRequired`: undefined\n* `ObjectNotExist`: undefined\n* `NoObjectToInsert`: undefined" } }, "tags": [ "channel" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "channel" ] } }, "/service/collection/action/list": { "post": { "description": "Returns a list of subscriptions requested by Subscription ID or file ID", "operationId": "collection.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaCollectionFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaCollectionListResponse" } } }, "tags": [ "collection" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/compensation/action/add": { "post": { "description": "Adds a new compensation for a household for a given number of iterations of a subscription renewal for a fixed amount / percentage of the renewal price.", "operationId": "compensation.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "compensation": { "$ref": "#/definitions/KalturaCompensation" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaCompensation" } }, "x-Errors": { "description": "* `SubscriptionNotRenewable`: undefined\n* `PaymentGatewayNotValid`: undefined\n* `InvalidUser`: undefined\n* `InvalidPurchase`: undefined\n* `NotEntitled`: undefined\n* `DomainSuspended`: undefined" } }, "tags": [ "compensation" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "compensation" ] } }, "/service/compensation/action/delete": { "post": { "description": "Delete a compensation by identifier", "operationId": "compensation.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success" }, "x-Errors": { "description": "" } }, "tags": [ "compensation" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/compensation/action/get": { "post": { "description": "Get a compensation by identifier", "operationId": "compensation.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaCompensation" } }, "x-Errors": { "description": "" } }, "tags": [ "compensation" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/configurationgroup/action/add": { "post": { "description": "Add a new configuration group", "operationId": "configurationGroup.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "configurationGroup": { "$ref": "#/definitions/KalturaConfigurationGroup" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaConfigurationGroup" } }, "x-Errors": { "description": "" } }, "tags": [ "configurationGroup" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "configurationGroup" ] } }, "/service/configurationgroup/action/delete": { "post": { "description": "Remove a configuration group, including its tags, device configurations and devices associations", "operationId": "configurationGroup.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "" } }, "tags": [ "configurationGroup" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/configurationgroup/action/get": { "post": { "description": "Return the configuration group details, including group identifiers, tags, and number of associated devices, and list of device configuration", "operationId": "configurationGroup.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "string", "x-dynamicEnum": { "array": "objects", "label": "id", "method": "post", "path": "/service/configurationgroup/action/list", "value": "id" } } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaConfigurationGroup" } }, "x-Errors": { "description": "" } }, "tags": [ "configurationGroup" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/configurationgroup/action/list": { "post": { "description": "Return the list of configuration groups", "operationId": "configurationGroup.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaConfigurationGroupListResponse" } }, "x-Errors": { "description": "" } }, "tags": [ "configurationGroup" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/configurationgroup/action/update": { "post": { "description": "Update configuration group name", "operationId": "configurationGroup.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "configurationGroup": { "$ref": "#/definitions/KalturaConfigurationGroup" }, "id": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaConfigurationGroup" } }, "x-Errors": { "description": "" } }, "tags": [ "configurationGroup" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "configurationGroup" ] } }, "/service/configurationgroupdevice/action/add": { "post": { "description": "Associate a collection of devices to a configuration group. If a device is already associated to another group – old association is replaced", "operationId": "configurationGroupDevice.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "configurationGroupDevice": { "$ref": "#/definitions/KalturaConfigurationGroupDevice" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "" } }, "tags": [ "configurationGroupDevice" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "configurationGroupDevice" ] } }, "/service/configurationgroupdevice/action/delete": { "post": { "description": "Remove a device association", "operationId": "configurationGroupDevice.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "udid": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "" } }, "tags": [ "configurationGroupDevice" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "udid" ] } }, "/service/configurationgroupdevice/action/get": { "post": { "description": "Return the configuration group to which a specific device is associated to", "operationId": "configurationGroupDevice.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "udid": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaConfigurationGroupDevice" } }, "x-Errors": { "description": "" } }, "tags": [ "configurationGroupDevice" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "udid" ] } }, "/service/configurationgroupdevice/action/list": { "post": { "description": "Return the list of associated devices for a given configuration group", "operationId": "configurationGroupDevice.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaConfigurationGroupDeviceFilter" }, "pager": { "$ref": "#/definitions/KalturaFilterPager" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaConfigurationGroupDeviceListResponse" } }, "x-Errors": { "description": "" } }, "tags": [ "configurationGroupDevice" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter", "pager" ] } }, "/service/configurationgrouptag/action/add": { "post": { "description": "Add a new tag to a configuration group. If this tag is already associated to another group, request fails", "operationId": "configurationGroupTag.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "configurationGroupTag": { "$ref": "#/definitions/KalturaConfigurationGroupTag" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaConfigurationGroupTag" } }, "x-Errors": { "description": "" } }, "tags": [ "configurationGroupTag" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "configurationGroupTag" ] } }, "/service/configurationgrouptag/action/delete": { "post": { "description": "Remove a tag association from configuration group", "operationId": "configurationGroupTag.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "tag": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "" } }, "tags": [ "configurationGroupTag" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "tag" ] } }, "/service/configurationgrouptag/action/get": { "post": { "description": "Return the configuration group the tag is associated to", "operationId": "configurationGroupTag.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "tag": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaConfigurationGroupTag" } }, "x-Errors": { "description": "" } }, "tags": [ "configurationGroupTag" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "tag" ] } }, "/service/configurationgrouptag/action/list": { "post": { "description": "Return list of tags for a configuration group", "operationId": "configurationGroupTag.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaConfigurationGroupTagFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaConfigurationGroupTagListResponse" } }, "x-Errors": { "description": "" } }, "tags": [ "configurationGroupTag" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/configurations/action/add": { "post": { "description": "Add a new device configuration to a configuration group", "operationId": "configurations.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "configurations": { "$ref": "#/definitions/KalturaConfigurations" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaConfigurations" } }, "x-Errors": { "description": "" } }, "tags": [ "configurations" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "configurations" ] } }, "/service/configurations/action/delete": { "post": { "description": "Delete a device configuration", "operationId": "configurations.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "" } }, "tags": [ "configurations" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/configurations/action/get": { "post": { "description": "Return the device configuration", "operationId": "configurations.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "string", "x-dynamicEnum": { "array": "objects", "label": "id", "method": "post", "path": "/service/configurations/action/list", "value": "id" } } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaConfigurations" } }, "x-Errors": { "description": "" } }, "tags": [ "configurations" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/configurations/action/list": { "post": { "description": "Return a list of device configurations of a configuration group", "operationId": "configurations.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaConfigurationsFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaConfigurationsListResponse" } }, "x-Errors": { "description": "" } }, "tags": [ "configurations" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/configurations/action/serveByDevice": { "post": { "description": "Return a device configuration applicable for a specific device (UDID), app name, software version, platform and optionally a configuration group’s tag", "operationId": "configurations.serveByDevice", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "applicationName": { "type": "string" }, "clientVersion": { "type": "string" }, "partnerId": { "default": 0, "type": "integer" }, "platform": { "type": "string" }, "tag": { "type": "string" }, "udid": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "string" } }, "x-Errors": { "description": "" } }, "tags": [ "configurations" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "applicationName", "clientVersion", "platform", "udid", "tag", "partnerId" ] } }, "/service/configurations/action/update": { "post": { "description": "Update device configuration", "operationId": "configurations.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "configurations": { "$ref": "#/definitions/KalturaConfigurations" }, "id": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaConfigurations" } }, "x-Errors": { "description": "" } }, "tags": [ "configurations" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "configurations" ] } }, "/service/country/action/list": { "post": { "description": "Get the list of countries for the partner with option to filter by countries identifiers", "operationId": "country.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaCountryFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaCountryListResponse" } } }, "tags": [ "country" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/coupon/action/get": { "post": { "description": "Returns information about a coupon", "operationId": "coupon.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "code": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaCoupon" } }, "x-Errors": { "description": "* `CouponNotValid`: undefined" } }, "tags": [ "coupon" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "code" ] } }, "/service/currency/action/list": { "post": { "description": "Get the list of currencies for the partner with option to filter by currency codes", "operationId": "currency.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaCurrencyFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaCurrencyListResponse" } } }, "tags": [ "currency" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/devicebrand/action/list": { "post": { "description": "Return a list of the available device brands.", "operationId": "deviceBrand.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaDeviceBrandListResponse" } } }, "tags": [ "deviceBrand" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/devicefamily/action/list": { "post": { "description": "Return a list of the available device families.", "operationId": "deviceFamily.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaDeviceFamilyListResponse" } } }, "tags": [ "deviceFamily" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/drmprofile/action/list": { "post": { "description": "Returns all DRM adapters for partner", "operationId": "drmProfile.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaDrmProfileListResponse" } } }, "tags": [ "drmProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/email/action/send": { "post": { "description": "Sends email notification", "operationId": "email.send", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "emailMessage": { "$ref": "#/definitions/KalturaEmailMessage" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "email" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "emailMessage" ] } }, "/service/engagement/action/add": { "post": { "description": "Insert new Engagement for partner", "operationId": "engagement.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "engagement": { "$ref": "#/definitions/KalturaEngagement" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaEngagement" } }, "x-Errors": { "description": "" } }, "tags": [ "engagement" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "engagement" ] } }, "/service/engagement/action/delete": { "post": { "description": "Delete engagement by engagement adapter id", "operationId": "engagement.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `ActionIsNotAllowed`: undefined" } }, "tags": [ "engagement" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/engagement/action/get": { "post": { "description": "Return engagement", "operationId": "engagement.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer", "x-dynamicEnum": { "array": "objects", "label": "id", "method": "post", "path": "/service/engagement/action/list", "value": "id" } } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaEngagement" } } }, "tags": [ "engagement" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/engagement/action/list": { "post": { "description": "Returns all Engagement for partner", "operationId": "engagement.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaEngagementFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaEngagementListResponse" } } }, "tags": [ "engagement" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/engagementadapter/action/add": { "post": { "description": "Insert new Engagement adapter for partner", "operationId": "engagementAdapter.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "engagementAdapter": { "$ref": "#/definitions/KalturaEngagementAdapter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaEngagementAdapter" } }, "x-Errors": { "description": "* `NameRequired`: undefined" } }, "tags": [ "engagementAdapter" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "engagementAdapter" ] } }, "/service/engagementadapter/action/delete": { "post": { "description": "Delete Engagement adapter by Engagement adapter id", "operationId": "engagementAdapter.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `ActionIsNotAllowed`: undefined" } }, "tags": [ "engagementAdapter" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/engagementadapter/action/generateSharedSecret": { "post": { "description": "Generate engagement adapter shared secret", "operationId": "engagementAdapter.generateSharedSecret", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaEngagementAdapter" } }, "x-Errors": { "description": "" } }, "tags": [ "engagementAdapter" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/engagementadapter/action/get": { "post": { "description": "Returns all Engagement adapters for partner : id + name", "operationId": "engagementAdapter.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer", "x-dynamicEnum": { "array": "objects", "label": "id", "method": "post", "path": "/service/engagementadapter/action/list", "value": "id" } } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaEngagementAdapter" } } }, "tags": [ "engagementAdapter" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/engagementadapter/action/list": { "post": { "description": "Returns all Engagement adapters for partner : id + name", "operationId": "engagementAdapter.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaEngagementAdapterListResponse" } } }, "tags": [ "engagementAdapter" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/engagementadapter/action/update": { "post": { "description": "Update Engagement adapter details", "operationId": "engagementAdapter.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "engagementAdapter": { "$ref": "#/definitions/KalturaEngagementAdapter" }, "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaEngagementAdapter" } }, "x-Errors": { "description": "* `NameRequired`: undefined" } }, "tags": [ "engagementAdapter" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "engagementAdapter" ] } }, "/service/entitlement/action/cancel": { "post": { "description": "Immediately cancel a subscription, PPV or collection. Cancel is possible only if within cancellation window and content not already consumed", "operationId": "entitlement.cancel", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "assetId": { "type": "integer" }, "productType": { "enum": [ "ppv", "subscription", "collection" ], "type": "string", "x-enumLabels": [ "PPV", "SUBSCRIPTION", "COLLECTION" ], "x-enumType": "KalturaTransactionType" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `CancelationWindowPeriodExpired`: undefined\n* `ContentAlreadyConsumed`: undefined\n* `PaymentGatewayNotValid`: undefined\n* `SubscriptionCancellationIsBlocked`: undefined\n* `DomainSuspended`: undefined\n* `InvalidPurchase`: undefined" } }, "tags": [ "entitlement" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "assetId", "productType" ] } }, "/service/entitlement/action/cancelRenewal": { "post": { "description": "Cancel a household service subscription at the next renewal. The subscription stays valid till the next renewal.", "operationId": "entitlement.cancelRenewal", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "subscriptionId": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success" }, "x-Errors": { "description": "* `SubscriptionCancellationIsBlocked`: undefined\n* `DomainSuspended`: undefined\n* `InvalidPurchase`: undefined\n* `SubscriptionNotRenewable`: undefined" } }, "tags": [ "entitlement" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "subscriptionId" ] } }, "/service/entitlement/action/cancelScheduledSubscription": { "post": { "description": "Cancel Scheduled Subscription", "operationId": "entitlement.cancelScheduledSubscription", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "scheduledSubscriptionId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `SubscriptionCancellationIsBlocked`: undefined" } }, "tags": [ "entitlement" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "scheduledSubscriptionId" ] } }, "/service/entitlement/action/externalReconcile": { "post": { "description": "Reconcile the user household's entitlements with an external entitlements source. This request is frequency protected to avoid too frequent calls per household.", "operationId": "entitlement.externalReconcile", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `UserDoesNotExist`: undefined\n* `AdapterAppFailure`: undefined\n* `UserNotInDomain`: undefined\n* `ReconciliationFrequencyLimitation`: undefined" } }, "tags": [ "entitlement" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/entitlement/action/forceCancel": { "post": { "description": "Immediately cancel a subscription, PPV or collection. Cancel applies regardless of cancellation window and content consumption status", "operationId": "entitlement.forceCancel", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "assetId": { "type": "integer" }, "productType": { "enum": [ "ppv", "subscription", "collection" ], "type": "string", "x-enumLabels": [ "PPV", "SUBSCRIPTION", "COLLECTION" ], "x-enumType": "KalturaTransactionType" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `InvalidPurchase`: undefined\n* `DomainSuspended`: undefined" } }, "tags": [ "entitlement" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "assetId", "productType" ] } }, "/service/entitlement/action/getNextRenewal": { "post": { "description": "Returns the data about the next renewal", "operationId": "entitlement.getNextRenewal", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaEntitlementRenewal" } } }, "tags": [ "entitlement" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/entitlement/action/grant": { "post": { "description": "Grant household for an entitlement for a PPV or Subscription.", "operationId": "entitlement.grant", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "contentId": { "default": 0, "type": "integer" }, "history": { "type": "boolean" }, "productId": { "type": "integer" }, "productType": { "enum": [ "ppv", "subscription", "collection" ], "type": "string", "x-enumLabels": [ "PPV", "SUBSCRIPTION", "COLLECTION" ], "x-enumType": "KalturaTransactionType" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `UserSuspended`: undefined\n* `UserNotInDomain`: undefined\n* `UserDoesNotExist`: undefined\n* `UnableToPurchaseSubscriptionPurchased`: undefined\n* `UnableToPurchaseFree`: undefined\n* `UnableToPurchaseForPurchaseSubscriptionOnly`: undefined\n* `UnableToPurchasePPVPurchased`: undefined\n* `NotForPurchase`: undefined\n* `UnableToPurchaseCollectionPurchased`: undefined\n* `UnKnownPPVModule`: undefined" } }, "tags": [ "entitlement" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "productId", "productType", "history", "contentId" ] } }, "/service/entitlement/action/list": { "post": { "description": "Gets all the entitled media items for a household", "operationId": "entitlement.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaEntitlementFilter" }, "pager": { "$ref": "#/definitions/KalturaFilterPager" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaEntitlementListResponse" } } }, "tags": [ "entitlement" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter", "pager" ] } }, "/service/entitlement/action/swap": { "post": { "description": "Swap current entitlement (subscription) with new entitlement (subscription) - only Grant", "operationId": "entitlement.swap", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "currentProductId": { "type": "integer" }, "history": { "type": "boolean" }, "newProductId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "entitlement" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "currentProductId", "newProductId", "history" ] } }, "/service/entitlement/action/update": { "post": { "description": "Update Kaltura Entitelment by Purchase id", "operationId": "entitlement.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "entitlement": { "$ref": "#/definitions/KalturaEntitlement" }, "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaEntitlement" } } }, "tags": [ "entitlement" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "entitlement" ] } }, "/service/exporttask/action/add": { "post": { "description": "Adds a new bulk export task", "operationId": "exportTask.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "task": { "$ref": "#/definitions/KalturaExportTask" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaExportTask" } } }, "tags": [ "exportTask" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "task" ] } }, "/service/exporttask/action/delete": { "post": { "description": "Deletes an existing bulk export task by task identifier", "operationId": "exportTask.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "exportTask" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/exporttask/action/get": { "post": { "description": "Gets an existing bulk export task by task identifier", "operationId": "exportTask.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer", "x-dynamicEnum": { "array": "objects", "label": "id", "method": "post", "path": "/service/exporttask/action/list", "value": "id" } } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaExportTask" } } }, "tags": [ "exportTask" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/exporttask/action/list": { "post": { "description": "Returns bulk export tasks by tasks identifiers", "operationId": "exportTask.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaExportTaskFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaExportTaskListResponse" } } }, "tags": [ "exportTask" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/exporttask/action/update": { "post": { "description": "Updates an existing bulk export task by task identifier", "operationId": "exportTask.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" }, "task": { "$ref": "#/definitions/KalturaExportTask" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaExportTask" } } }, "tags": [ "exportTask" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "task" ] } }, "/service/externalchannelprofile/action/add": { "post": { "description": "Insert new External channel for partner", "operationId": "externalChannelProfile.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "externalChannel": { "$ref": "#/definitions/KalturaExternalChannelProfile" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaExternalChannelProfile" } }, "x-Errors": { "description": "* `ExternalIdentifierRequired`: undefined\n* `ExternalIdentifierMustBeUnique`: undefined\n* `NameRequired`: undefined\n* `RecommendationEngineNotExist`: undefined\n* `RecommendationEngineIdentifierRequired`: undefined\n* `InactiveExternalChannelEnrichment`: undefined" } }, "tags": [ "externalChannelProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "externalChannel" ] } }, "/service/externalchannelprofile/action/delete": { "post": { "description": "Delete External channel by External channel id", "operationId": "externalChannelProfile.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "externalChannelId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `ExternalChannelIdentifierRequired`: undefined\n* `ExternalChannelNotExist`: undefined" } }, "tags": [ "externalChannelProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "externalChannelId" ] } }, "/service/externalchannelprofile/action/list": { "post": { "description": "Returns all External channels for partner", "operationId": "externalChannelProfile.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaExternalChannelProfileListResponse" } } }, "tags": [ "externalChannelProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/externalchannelprofile/action/update": { "post": { "description": "Update External channel details", "operationId": "externalChannelProfile.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "externalChannel": { "$ref": "#/definitions/KalturaExternalChannelProfile" }, "externalChannelId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaExternalChannelProfile" } }, "x-Errors": { "description": "* `ExternalIdentifierMustBeUnique`: undefined\n* `InactiveExternalChannelEnrichment`: undefined\n* `ExternalChannelNotExist`: undefined\n* `ExternalIdentifierRequired`: undefined\n* `ExternalChannelIdentifierRequired`: undefined\n* `NameRequired`: undefined" } }, "tags": [ "externalChannelProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "externalChannelId", "externalChannel" ] } }, "/service/favorite/action/add": { "post": { "description": "Add media to user's favorite list", "operationId": "favorite.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "favorite": { "$ref": "#/definitions/KalturaFavorite" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaFavorite" } }, "x-Errors": { "description": "* `UserDoesNotExist`: undefined\n* `UserSuspended`: undefined\n* `WrongPasswordOrUserName`: undefined" } }, "tags": [ "favorite" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "favorite" ] } }, "/service/favorite/action/delete": { "post": { "description": "Remove media from user's favorite list", "operationId": "favorite.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `WrongPasswordOrUserName`: undefined\n* `UserSuspended`: undefined\n* `UserDoesNotExist`: undefined" } }, "tags": [ "favorite" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/favorite/action/list": { "post": { "description": "Retrieving users' favorites", "operationId": "favorite.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaFavoriteFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaFavoriteListResponse" } }, "x-Errors": { "description": "* `UserSuspended`: undefined\n* `UserDoesNotExist`: undefined" } }, "tags": [ "favorite" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/followtvseries/action/add": { "post": { "description": "Add a user's tv series follow.\r\n Possible status codes: UserAlreadyFollowing = 8013, NotFound = 500007, InvalidAssetId = 4024", "operationId": "followTvSeries.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "followTvSeries": { "$ref": "#/definitions/KalturaFollowTvSeries" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaFollowTvSeries" } }, "x-Errors": { "description": "* `UserAlreadyFollowing`: undefined\n* `InvalidAssetId`: undefined" } }, "tags": [ "followTvSeries" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "followTvSeries" ] } }, "/service/followtvseries/action/delete": { "post": { "description": "Delete a user's tv series follow.\r\n Possible status codes: UserNotFollowing = 8012, NotFound = 500007, InvalidAssetId = 4024, AnnouncementNotFound = 8006", "operationId": "followTvSeries.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "assetId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `AnnouncementNotFound`: undefined\n* `UserNotFollowing`: undefined\n* `InvalidAssetId`: undefined" } }, "tags": [ "followTvSeries" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "assetId" ] } }, "/service/followtvseries/action/deleteWithToken": { "post": { "description": "Delete a user's tv series follow.", "operationId": "followTvSeries.deleteWithToken", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "assetId": { "type": "integer" }, "partnerId": { "type": "integer" }, "token": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success" }, "x-Errors": { "description": "" } }, "tags": [ "followTvSeries" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "assetId", "token", "partnerId" ] } }, "/service/followtvseries/action/list": { "post": { "description": "List user's tv series follows.\r\n Possible status codes:", "operationId": "followTvSeries.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaFollowTvSeriesFilter" }, "pager": { "$ref": "#/definitions/KalturaFilterPager" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaFollowTvSeriesListResponse" } } }, "tags": [ "followTvSeries" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter", "pager" ] } }, "/service/homenetwork/action/add": { "post": { "description": "Add a new home network to a household", "operationId": "homeNetwork.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "homeNetwork": { "$ref": "#/definitions/KalturaHomeNetwork" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaHomeNetwork" } }, "x-Errors": { "description": "* `ExternalIdentifierRequired`: undefined\n* `HomeNetworkAlreadyExists`: undefined\n* `HomeNetworkLimitation`: undefined" } }, "tags": [ "homeNetwork" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "homeNetwork" ] } }, "/service/homenetwork/action/delete": { "post": { "description": "Delete household’s existing home network", "operationId": "homeNetwork.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "externalId": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `ExternalIdentifierRequired`: undefined\n* `HomeNetworkFrequency`: undefined\n* `HomeNetworkDoesNotExist`: undefined" } }, "tags": [ "homeNetwork" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "externalId" ] } }, "/service/homenetwork/action/list": { "post": { "description": "Retrieve the household’s home networks", "operationId": "homeNetwork.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaHomeNetworkListResponse" } } }, "tags": [ "homeNetwork" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/homenetwork/action/update": { "post": { "description": "Update and existing home network for a household", "operationId": "homeNetwork.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "externalId": { "type": "string" }, "homeNetwork": { "$ref": "#/definitions/KalturaHomeNetwork" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaHomeNetwork" } }, "x-Errors": { "description": "* `HomeNetworkDoesNotExist`: undefined\n* `ExternalIdentifierRequired`: undefined" } }, "tags": [ "homeNetwork" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "externalId", "homeNetwork" ] } }, "/service/household/action/add": { "post": { "description": "Creates a household for the user", "operationId": "household.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "household": { "$ref": "#/definitions/KalturaHousehold" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaHousehold" } }, "x-Errors": { "description": "* `DomainNotExists`: undefined\n* `HouseholdUserFailed`: undefined" } }, "tags": [ "household" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "household" ] } }, "/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", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `DomainNotExists`: undefined" } }, "tags": [ "household" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/household/action/get": { "post": { "description": "Returns the household model", "operationId": "household.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaHousehold" } }, "x-Errors": { "description": "* `HouseholdUserFailed`: undefined\n* `DomainNotExists`: undefined" } }, "tags": [ "household" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/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", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `DomainNotExists`: undefined" } }, "tags": [ "household" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/household/action/resetFrequency": { "post": { "description": "Reset a household’s time limitation for removing user or device", "operationId": "household.resetFrequency", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "frequencyType": { "enum": [ "devices", "users" ], "type": "string", "x-enumLabels": [ "DEVICES", "USERS" ], "x-enumType": "KalturaHouseholdFrequencyType" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaHousehold" } } }, "tags": [ "household" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "frequencyType" ] } }, "/service/household/action/resume": { "post": { "description": "Resumed a given household service to its previous service settings", "operationId": "household.resume", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `DomainAlreadyActive`: undefined" } }, "tags": [ "household" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/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", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "roleId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `DomainAlreadySuspended`: undefined" } }, "tags": [ "household" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "roleId" ] } }, "/service/household/action/update": { "post": { "description": "Update the household name and description", "operationId": "household.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "household": { "$ref": "#/definitions/KalturaHousehold" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaHousehold" } } }, "tags": [ "household" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "household" ] } }, "/service/householddevice/action/add": { "post": { "description": "Add device to household", "operationId": "householdDevice.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "device": { "$ref": "#/definitions/KalturaHouseholdDevice" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaHouseholdDevice" } }, "x-Errors": { "description": "* `DomainSuspended`: undefined\n* `DomainNotExists`: undefined\n* `DeviceExistsInOtherDomains`: undefined\n* `NoUsersInDomain`: undefined" } }, "tags": [ "householdDevice" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "device" ] } }, "/service/householddevice/action/addByPin": { "post": { "description": "Registers a device to a household using pin code", "operationId": "householdDevice.addByPin", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "deviceName": { "type": "string" }, "pin": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaHouseholdDevice" } }, "x-Errors": { "description": "* `ExceededLimit`: undefined\n* `DuplicatePin`: undefined\n* `DeviceNotExists`: undefined" } }, "tags": [ "householdDevice" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "deviceName", "pin" ] } }, "/service/householddevice/action/delete": { "post": { "description": "Removes a device from household", "operationId": "householdDevice.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "udid": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `DeviceNotInDomain`: undefined\n* `DomainSuspended`: undefined\n* `LimitationPeriod`: undefined\n* `DeviceNotExists`: undefined" } }, "tags": [ "householdDevice" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "udid" ] } }, "/service/householddevice/action/generatePin": { "post": { "description": "Generates device pin to use when adding a device to household by pin", "operationId": "householdDevice.generatePin", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "brandId": { "type": "integer" }, "udid": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaDevicePin" } } }, "tags": [ "householdDevice" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "udid", "brandId" ] } }, "/service/householddevice/action/get": { "post": { "description": "Returns device registration status to the supplied household", "operationId": "householdDevice.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaHouseholdDevice" } }, "x-Errors": { "description": "* `DeviceExistsInOtherDomains`: undefined\n* `AdapterNotExists`: undefined\n* `AdapterAppFailure`: undefined\n* `DeviceNotExists`: undefined\n* `DeviceNotInDomain`: undefined" } }, "tags": [ "householdDevice" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/householddevice/action/list": { "post": { "description": "Returns the devices within the household", "operationId": "householdDevice.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaHouseholdDeviceFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaHouseholdDeviceListResponse" } }, "x-Errors": { "description": "* `DeviceNotExists`: undefined" } }, "tags": [ "householdDevice" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/householddevice/action/loginWithPin": { "post": { "description": "User sign-in via a time-expired sign-in PIN.", "operationId": "householdDevice.loginWithPin", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "partnerId": { "type": "integer" }, "pin": { "type": "string" }, "udid": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaLoginResponse" } }, "x-Errors": { "description": "* `UserNotInDomain`: undefined\n* `WrongPasswordOrUserName`: undefined\n* `PinNotExists`: undefined\n* `PinExpired`: undefined\n* `NoValidPin`: undefined\n* `SecretIsWrong`: undefined\n* `LoginViaPinNotAllowed`: undefined\n* `UserSuspended`: undefined\n* `InsideLockTime`: undefined\n* `UserNotActivated`: undefined\n* `UserAllreadyLoggedIn`: undefined\n* `UserDoubleLogIn`: undefined\n* `DeviceNotRegistered`: undefined\n* `ErrorOnInitUser`: undefined\n* `UserNotMasterApproved`: undefined\n* `UserWithNoDomain`: undefined\n* `UserDoesNotExist`: undefined\n* `DeviceNotExists`: undefined\n* `PinNotExists`: undefined\n* `DeviceNotInDomain`: undefined\n* `DomainNotExists`: undefined\n* `NoValidPin`: undefined" } }, "tags": [ "householdDevice" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "partnerId", "pin", "udid" ] } }, "/service/householddevice/action/update": { "post": { "description": "Update the name of the device by UDID", "operationId": "householdDevice.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "device": { "$ref": "#/definitions/KalturaHouseholdDevice" }, "udid": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaHouseholdDevice" } }, "x-Errors": { "description": "* `DeviceNotExists`: undefined" } }, "tags": [ "householdDevice" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "udid", "device" ] } }, "/service/householddevice/action/updateStatus": { "post": { "description": "Update the name of the device by UDID", "operationId": "householdDevice.updateStatus", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "status": { "enum": [ "PENDING", "ACTIVATED", "NOT_ACTIVATED" ], "type": "string", "x-enumLabels": [ "PENDING", "ACTIVATED", "NOT_ACTIVATED" ], "x-enumType": "KalturaDeviceStatus" }, "udid": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `ExceededLimit`: undefined\n* `LimitationPeriod`: undefined" } }, "tags": [ "householdDevice" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "udid", "status" ] } }, "/service/householdlimitations/action/get": { "post": { "description": "Get the limitation module by id", "operationId": "householdLimitations.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaHouseholdLimitations" } } }, "tags": [ "householdLimitations" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/householdpaymentgateway/action/disable": { "post": { "description": "Disable payment-gateway on the household", "operationId": "householdPaymentGateway.disable", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "paymentGatewayId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `UserSuspended`: undefined\n* `PaymentGatewayIdRequired`: undefined\n* `PaymentGatewayNotExist`: undefined\n* `HouseholdNotSetToPaymentGateway`: undefined\n* `PaymentGatewaySelectionIsDisabled`: undefined" } }, "tags": [ "householdPaymentGateway" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "paymentGatewayId" ] } }, "/service/householdpaymentgateway/action/enable": { "post": { "description": "Enable a payment-gateway provider for the household.", "operationId": "householdPaymentGateway.enable", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "paymentGatewayId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `PaymentGatewaySelectionIsDisabled`: undefined\n* `PaymentGatewayNotValid`: undefined\n* `UserSuspended`: undefined\n* `PaymentGatewayIdRequired`: undefined\n* `ErrorSavingPaymentGatewayHousehold`: undefined\n* `HouseholdAlreadySetToPaymentGateway`: undefined" } }, "tags": [ "householdPaymentGateway" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "paymentGatewayId" ] } }, "/service/householdpaymentgateway/action/getChargeID": { "post": { "description": "Get a household’s billing account identifier (charge ID) for a given payment gateway", "operationId": "householdPaymentGateway.getChargeID", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "paymentGatewayExternalId": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "string" } }, "x-Errors": { "description": "* `ChargeIdNotSetToHousehold`: undefined\n* `PaymentGatewayNotExist`: undefined\n* `ExternalIdentifierRequired`: undefined" } }, "tags": [ "householdPaymentGateway" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "paymentGatewayExternalId" ] } }, "/service/householdpaymentgateway/action/invoke": { "post": { "description": "Gets the Payment Gateway Configuration for the payment gateway identifier given", "operationId": "householdPaymentGateway.invoke", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "extraParameters": { "type": "array" }, "intent": { "type": "string" }, "paymentGatewayId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaPaymentGatewayConfiguration" } }, "x-Errors": { "description": "* `PaymentGatewayNotExist`: undefined\n* `SignatureMismatch`: undefined" } }, "tags": [ "householdPaymentGateway" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "paymentGatewayId", "intent", "extraParameters" ] } }, "/service/householdpaymentgateway/action/list": { "post": { "description": "Get a list of all configured Payment Gateways providers available for the account. For each payment is provided with the household associated payment methods.", "operationId": "householdPaymentGateway.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaHouseholdPaymentGatewayListResponse" } }, "x-Errors": { "description": "* `UserSuspended`: undefined" } }, "tags": [ "householdPaymentGateway" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/householdpaymentgateway/action/resume": { "post": { "description": "Resumes all the entitlements of the given payment gateway", "operationId": "householdPaymentGateway.resume", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "paymentGatewayId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success" }, "x-Errors": { "description": "* `PaymentGatewayNotExist`: undefined" } }, "tags": [ "householdPaymentGateway" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "paymentGatewayId" ] } }, "/service/householdpaymentgateway/action/setChargeID": { "post": { "description": "Set user billing account identifier (charge ID), for a specific household and a specific payment gateway", "operationId": "householdPaymentGateway.setChargeID", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "chargeId": { "type": "string" }, "paymentGatewayExternalId": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `PaymentGatewayNotExist`: undefined\n* `PaymentGatewayChargeIdRequired`: undefined\n* `ExternalIdentifierRequired`: undefined\n* `ErrorSavingPaymentGatewayHousehold`: undefined\n* `ChargeIdAlreadySetToHouseholdPaymentGateway`: undefined" } }, "tags": [ "householdPaymentGateway" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "paymentGatewayExternalId", "chargeId" ] } }, "/service/householdpaymentgateway/action/suspend": { "post": { "description": "Suspends all the entitlements of the given payment gateway", "operationId": "householdPaymentGateway.suspend", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "paymentGatewayId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success" }, "x-Errors": { "description": "* `PaymentGatewayNotExist`: undefined" } }, "tags": [ "householdPaymentGateway" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "paymentGatewayId" ] } }, "/service/householdpaymentmethod/action/add": { "post": { "description": "Add a new payment method for household", "operationId": "householdPaymentMethod.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "householdPaymentMethod": { "$ref": "#/definitions/KalturaHouseholdPaymentMethod" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaHouseholdPaymentMethod" } }, "x-Errors": { "description": "* `PaymentMethodNotSetForHousehold`: undefined\n* `ErrorSavingPaymentGatewayHouseholdPaymentMethod`: undefined\n* `PaymentGatewayNotValid`: undefined\n* `PaymentGatewayNotSetForHousehold`: undefined\n* `PaymentGatewayNotSupportPaymentMethod`: undefined" } }, "tags": [ "householdPaymentMethod" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "householdPaymentMethod" ] } }, "/service/householdpaymentmethod/action/forceRemove": { "post": { "description": "Force remove of a payment method of the household.", "operationId": "householdPaymentMethod.forceRemove", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "paymentGatewayId": { "type": "integer" }, "paymentMethodId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `PaymentGatewayNotSetForHousehold`: undefined\n* `PaymentGatewayNotExist`: undefined\n* `PaymentMethodNotSetForHousehold`: undefined" } }, "tags": [ "householdPaymentMethod" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "paymentGatewayId", "paymentMethodId" ] } }, "/service/householdpaymentmethod/action/list": { "post": { "description": "Get a list of all payment methods of the household.", "operationId": "householdPaymentMethod.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaHouseholdPaymentMethodListResponse" } }, "x-Errors": { "description": "* `UserSuspended`: undefined" } }, "tags": [ "householdPaymentMethod" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/householdpaymentmethod/action/remove": { "post": { "description": "Removes a payment method of the household.", "operationId": "householdPaymentMethod.remove", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "paymentGatewayId": { "type": "integer" }, "paymentMethodId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `PaymentMethodNotSetForHousehold`: undefined\n* `PaymentMethodIsUsedByHousehold`: undefined\n* `PaymentGatewayNotExist`: undefined\n* `PaymentGatewayNotSetForHousehold`: undefined" } }, "tags": [ "householdPaymentMethod" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "paymentGatewayId", "paymentMethodId" ] } }, "/service/householdpaymentmethod/action/setAsDefault": { "post": { "description": "Set a payment method as default for the household.", "operationId": "householdPaymentMethod.setAsDefault", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "paymentGatewayId": { "type": "integer" }, "paymentMethodId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `PaymentGatewayNotSetForHousehold`: undefined\n* `PaymentGatewayNotValid`: undefined\n* `PaymentMethodNotSetForHousehold`: undefined\n* `ErrorSavingPaymentGatewayHouseholdPaymentMethod`: undefined\n* `PaymentGatewayNotSupportPaymentMethod`: undefined" } }, "tags": [ "householdPaymentMethod" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "paymentGatewayId", "paymentMethodId" ] } }, "/service/householdpremiumservice/action/list": { "post": { "description": "Returns all the premium services allowed for the household", "operationId": "householdPremiumService.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaHouseholdPremiumServiceListResponse" } } }, "tags": [ "householdPremiumService" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/householdquota/action/get": { "post": { "description": "Returns the household's quota data", "operationId": "householdQuota.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaHouseholdQuota" } } }, "tags": [ "householdQuota" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/householduser/action/add": { "post": { "description": "Adds a user to household", "operationId": "householdUser.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "householdUser": { "$ref": "#/definitions/KalturaHouseholdUser" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaHouseholdUser" } }, "x-Errors": { "description": "* `UserNotAllowed`: undefined\n* `ExceededUserLimit`: undefined\n* `RequestFailed`: undefined\n* `InvalidUser`: undefined\n* `DomainSuspended`: undefined\n* `ActionUserNotMaster`: undefined\n* `UserExistsInOtherDomains`: undefined\n* `UserAlreadyInDomain`: undefined\n* `NoUsersInDomain`: undefined" } }, "tags": [ "householdUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "householdUser" ] } }, "/service/householduser/action/delete": { "post": { "description": "Removes a user from household", "operationId": "householdUser.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `NoUsersInDomain`: undefined\n* `UserNotAllowed`: undefined\n* `LimitationPeriod`: undefined\n* `DomainSuspended`: undefined\n* `DomainNotExists`: undefined\n* `UserNotExistsInDomain`: undefined\n* `InvalidUser`: undefined" } }, "tags": [ "householdUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/householduser/action/list": { "post": { "description": "Returns the users within the household", "operationId": "householdUser.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaHouseholdUserFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaHouseholdUserListResponse" } }, "x-Errors": { "description": "* `DomainNotExists`: undefined\n* `HouseholdUserFailed`: undefined" } }, "tags": [ "householdUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/image/action/add": { "post": { "description": "Add a new image", "operationId": "image.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "image": { "$ref": "#/definitions/KalturaImage" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaImage" } }, "x-Errors": { "description": "* `AssetDoesNotExist`: undefined" } }, "tags": [ "image" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "image" ] } }, "/service/image/action/delete": { "post": { "description": "Delete an existing image", "operationId": "image.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "" } }, "tags": [ "image" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/image/action/list": { "post": { "description": "Get the list of images by different filtering", "operationId": "image.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaImageFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaImageListResponse" } } }, "tags": [ "image" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/image/action/setContent": { "post": { "description": "Sets the content of an existing image", "operationId": "image.setContent", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "content": { "$ref": "#/definitions/KalturaContentResource" }, "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success" }, "x-Errors": { "description": "" } }, "tags": [ "image" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "content" ] } }, "/service/imagetype/action/add": { "post": { "description": "Add a new image type", "operationId": "imageType.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "imageType": { "$ref": "#/definitions/KalturaImageType" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaImageType" } }, "x-Errors": { "description": "" } }, "tags": [ "imageType" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "imageType" ] } }, "/service/imagetype/action/delete": { "post": { "description": "Delete an existing image type", "operationId": "imageType.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "" } }, "tags": [ "imageType" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/imagetype/action/list": { "post": { "description": "Get the list of image types for the partner", "operationId": "imageType.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaImageTypeFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaImageTypeListResponse" } } }, "tags": [ "imageType" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/imagetype/action/update": { "post": { "description": "Update an existing image type", "operationId": "imageType.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" }, "imageType": { "$ref": "#/definitions/KalturaImageType" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaImageType" } }, "x-Errors": { "description": "" } }, "tags": [ "imageType" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "imageType" ] } }, "/service/inboxmessage/action/get": { "post": { "description": "TBD", "operationId": "inboxMessage.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "string", "x-dynamicEnum": { "array": "objects", "label": "id", "method": "post", "path": "/service/inboxmessage/action/list", "value": "id" } } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaInboxMessage" } }, "x-Errors": { "description": "* `UserInboxMessagesNotExist`: undefined" } }, "tags": [ "inboxMessage" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/inboxmessage/action/list": { "post": { "description": "List inbox messages", "operationId": "inboxMessage.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaInboxMessageFilter" }, "pager": { "$ref": "#/definitions/KalturaFilterPager" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaInboxMessageListResponse" } }, "x-Errors": { "description": "* `UserInboxMessagesNotExist`: undefined\n* `MessageIdentifierRequired`: undefined" } }, "tags": [ "inboxMessage" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter", "pager" ] } }, "/service/inboxmessage/action/updateStatus": { "post": { "description": "Updates the message status.", "operationId": "inboxMessage.updateStatus", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "string" }, "status": { "enum": [ "Unread", "Read", "Deleted" ], "type": "string", "x-enumLabels": [ "UNREAD", "READ", "DELETED" ], "x-enumType": "KalturaInboxMessageStatus" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "inboxMessage" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "status" ] } }, "/service/language/action/list": { "post": { "description": "Get the list of languages for the partner with option to filter by language codes", "operationId": "language.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaLanguageFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaLanguageListResponse" } } }, "tags": [ "language" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/licensedurl/action/get": { "post": { "description": "Get the URL for playing an asset - program, media or recording", "operationId": "licensedUrl.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "request": { "$ref": "#/definitions/KalturaLicensedUrlBaseRequest" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaLicensedUrl" } }, "x-Errors": { "description": "* `RecordingPlaybackNotAllowedForNotEntitledEpgChannel`: undefined\n* `ServiceNotAllowed`: undefined\n* `NotEntitled`: undefined\n* `UserSuspended`: undefined\n* `RecordingStatusNotValid`: undefined\n* `ProgramDoesntExist`: undefined\n* `DomainSuspended`: undefined\n* `DeviceNotInDomain`: undefined\n* `InvalidBaseLink`: undefined\n* `RecordingNotFound`: undefined\n* `RecordingPlaybackNotAllowedForNonExistingEpgChannel`: undefined\n* `MediaConcurrencyLimitation`: undefined\n* `ConcurrencyLimitation`: undefined\n* `DeviceTypeNotAllowed`: undefined" } }, "tags": [ "licensedUrl" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "request" ] } }, "/service/mediafile/action/add": { "post": { "description": "Add a new media file", "operationId": "mediaFile.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "mediaFile": { "$ref": "#/definitions/KalturaMediaFile" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaMediaFile" } }, "x-Errors": { "description": "* `MediaFileTypeDoesNotExist`: undefined\n* `AssetDoesNotExist`: undefined" } }, "tags": [ "mediaFile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "mediaFile" ] } }, "/service/mediafile/action/delete": { "post": { "description": "Delete an existing media file", "operationId": "mediaFile.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `AssetDoesNotExist`: undefined" } }, "tags": [ "mediaFile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/mediafile/action/list": { "post": { "description": "Returns a list of media-file", "operationId": "mediaFile.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaMediaFileFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaMediaFileListResponse" } } }, "tags": [ "mediaFile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/mediafile/action/update": { "post": { "description": "update an existing media file", "operationId": "mediaFile.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" }, "mediaFile": { "$ref": "#/definitions/KalturaMediaFile" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaMediaFile" } }, "x-Errors": { "description": "" } }, "tags": [ "mediaFile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "mediaFile" ] } }, "/service/mediafiletype/action/add": { "post": { "description": "Add new media-file type", "operationId": "mediaFileType.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "mediaFileType": { "$ref": "#/definitions/KalturaMediaFileType" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaMediaFileType" } }, "x-Errors": { "description": "* `MediaFileTypeNameAlreadyInUse`: undefined" } }, "tags": [ "mediaFileType" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "mediaFileType" ] } }, "/service/mediafiletype/action/delete": { "post": { "description": "Delete media-file type by id", "operationId": "mediaFileType.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `MediaFileTypeDoesNotExist`: undefined" } }, "tags": [ "mediaFileType" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/mediafiletype/action/list": { "post": { "description": "Returns a list of media-file types", "operationId": "mediaFileType.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaMediaFileTypeListResponse" } } }, "tags": [ "mediaFileType" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/mediafiletype/action/update": { "post": { "description": "Update existing media-file type", "operationId": "mediaFileType.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" }, "mediaFileType": { "$ref": "#/definitions/KalturaMediaFileType" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaMediaFileType" } }, "x-Errors": { "description": "* `MediaFileTypeDoesNotExist`: undefined\n* `MediaFileTypeNameAlreadyInUse`: undefined" } }, "tags": [ "mediaFileType" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "mediaFileType" ] } }, "/service/messagetemplate/action/get": { "post": { "description": "Retrieve a message template used in push notifications and inbox", "operationId": "messageTemplate.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "messageType": { "enum": [ "Series", "Reminder", "Churn", "SeriesReminder", "InterestVod", "InterestEPG" ], "type": "string", "x-enumLabels": [ "SERIES", "REMINDER", "CHURN", "SERIESREMINDER", "INTERESTVOD", "INTERESTEPG" ], "x-enumType": "KalturaMessageTemplateType" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaMessageTemplate" } } }, "tags": [ "messageTemplate" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "messageType" ] } }, "/service/messagetemplate/action/update": { "post": { "description": "Set the account’s push notifications and inbox messages templates", "operationId": "messageTemplate.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "messageType": { "enum": [ "Series", "Reminder", "Churn", "SeriesReminder", "InterestVod", "InterestEPG" ], "type": "string", "x-enumLabels": [ "SERIES", "REMINDER", "CHURN", "SERIESREMINDER", "INTERESTVOD", "INTERESTEPG" ], "x-enumType": "KalturaMessageTemplateType" }, "template": { "$ref": "#/definitions/KalturaMessageTemplate" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaMessageTemplate" } } }, "tags": [ "messageTemplate" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "messageType", "template" ] } }, "/service/meta/action/add": { "post": { "description": "Add a new meta", "operationId": "meta.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "meta": { "$ref": "#/definitions/KalturaMeta" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaMeta" } }, "x-Errors": { "description": "* `InvalidMutlipleValueForMetaType`: undefined\n* `MetaSystemNameAlreadyInUse`: undefined" } }, "tags": [ "meta" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "meta" ] } }, "/service/meta/action/delete": { "post": { "description": "Delete an existing meta", "operationId": "meta.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `MetaDoesNotExist`: undefined\n* `CanNotDeletePredefinedMeta`: undefined" } }, "tags": [ "meta" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/meta/action/list": { "post": { "description": "Return a list of metas for the account with optional filter", "operationId": "meta.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaMetaFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaMetaListResponse" } } }, "tags": [ "meta" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/meta/action/update": { "post": { "description": "Update an existing meta", "operationId": "meta.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" }, "meta": { "$ref": "#/definitions/KalturaMeta" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaMeta" } }, "x-Errors": { "description": "* `CanNotChangePredefinedMetaSystemName`: undefined\n* `MetaDoesNotExist`: undefined\n* `MetaSystemNameAlreadyInUse`: undefined" } }, "tags": [ "meta" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "meta" ] } }, "/service/notification/action/register": { "post": { "description": "TBD", "operationId": "notification.register", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "identifier": { "type": "string" }, "type": { "enum": [ "announcement", "system", "Reminder", "series_reminder" ], "type": "string", "x-enumLabels": [ "ANNOUNCEMENT", "SYSTEM", "REMINDER", "SERIES_REMINDER" ], "x-enumType": "KalturaNotificationType" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaRegistryResponse" } } }, "tags": [ "notification" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "identifier", "type" ] } }, "/service/notification/action/sendPush": { "post": { "description": "Sends push notification to user devices", "operationId": "notification.sendPush", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "pushMessage": { "$ref": "#/definitions/KalturaPushMessage" }, "userId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "notification" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "userId", "pushMessage" ] } }, "/service/notification/action/sendSms": { "post": { "description": "Sends SMS notification to user", "operationId": "notification.sendSms", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "message": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "notification" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "message" ] } }, "/service/notification/action/setDevicePushToken": { "post": { "description": "Registers the device push token to the push service", "operationId": "notification.setDevicePushToken", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "pushToken": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "notification" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "pushToken" ] } }, "/service/notificationspartnersettings/action/get": { "post": { "description": "Retrieve the partner notification settings.", "operationId": "notificationsPartnerSettings.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaNotificationsPartnerSettings" } } }, "tags": [ "notificationsPartnerSettings" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/notificationspartnersettings/action/update": { "post": { "description": "Update the account notification settings", "operationId": "notificationsPartnerSettings.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "settings": { "$ref": "#/definitions/KalturaNotificationsPartnerSettings" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `PushNotificationFalse`: undefined" } }, "tags": [ "notificationsPartnerSettings" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "settings" ] } }, "/service/notificationssettings/action/get": { "post": { "description": "Retrieve the user’s notification settings.", "operationId": "notificationsSettings.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaNotificationsSettings" } } }, "tags": [ "notificationsSettings" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/notificationssettings/action/update": { "post": { "description": "Update the user’s notification settings.", "operationId": "notificationsSettings.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "settings": { "$ref": "#/definitions/KalturaNotificationsSettings" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "notificationsSettings" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "settings" ] } }, "/service/notificationssettings/action/updateWithToken": { "post": { "description": "Update the user’s notification settings.", "operationId": "notificationsSettings.updateWithToken", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "partnerId": { "type": "integer" }, "settings": { "$ref": "#/definitions/KalturaNotificationsSettings" }, "token": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "" } }, "tags": [ "notificationsSettings" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "settings", "token", "partnerId" ] } }, "/service/ossadapterprofile/action/add": { "post": { "description": "Insert new OSS adapter for partner", "operationId": "ossAdapterProfile.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "ossAdapter": { "$ref": "#/definitions/KalturaOSSAdapterProfile" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaOSSAdapterProfile" } }, "x-Errors": { "description": "* `NoOSSAdapterToInsert`: undefined\n* `NameRequired`: undefined\n* `ExternalIdentifierMustBeUnique`: undefined\n* `ExternalIdentifierRequired`: undefined\n* `AdapterUrlRequired`: undefined" } }, "tags": [ "ossAdapterProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "ossAdapter" ] } }, "/service/ossadapterprofile/action/delete": { "post": { "description": "Delete OSS adapter by OSS adapter id", "operationId": "ossAdapterProfile.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "ossAdapterId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `OSSAdapterIdentifierRequired`: undefined\n* `OSSAdapterNotExist`: undefined\n* `ActionIsNotAllowed`: undefined" } }, "tags": [ "ossAdapterProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "ossAdapterId" ] } }, "/service/ossadapterprofile/action/generateSharedSecret": { "post": { "description": "Generate oss adapter shared secret", "operationId": "ossAdapterProfile.generateSharedSecret", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "ossAdapterId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaOSSAdapterProfile" } }, "x-Errors": { "description": "* `OSSAdapterIdentifierRequired`: undefined\n* `OSSAdapterNotExist`: undefined" } }, "tags": [ "ossAdapterProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "ossAdapterId" ] } }, "/service/ossadapterprofile/action/get": { "post": { "description": "Returns all OSS adapters for partner : id + name", "operationId": "ossAdapterProfile.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer", "x-dynamicEnum": { "array": "objects", "label": "id", "method": "post", "path": "/service/ossadapterprofile/action/list", "value": "id" } } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaOSSAdapterProfile" } } }, "tags": [ "ossAdapterProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/ossadapterprofile/action/list": { "post": { "description": "Returns all OSS adapters for partner : id + name", "operationId": "ossAdapterProfile.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaOSSAdapterProfileListResponse" } } }, "tags": [ "ossAdapterProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/ossadapterprofile/action/update": { "post": { "description": "Update OSS adapter details", "operationId": "ossAdapterProfile.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "ossAdapter": { "$ref": "#/definitions/KalturaOSSAdapterProfile" }, "ossAdapterId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaOSSAdapterProfile" } }, "x-Errors": { "description": "* `AdapterUrlRequired`: undefined\n* `OSSAdapterIdentifierRequired`: undefined\n* `NameRequired`: undefined\n* `NoOSSAdapterToUpdate`: undefined\n* `ExternalIdentifierRequired`: undefined" } }, "tags": [ "ossAdapterProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "ossAdapterId", "ossAdapter" ] } }, "/service/ottcategory/action/get": { "post": { "description": "Retrieve the list of categories (hierarchical) and their associated channels", "operationId": "ottCategory.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaOTTCategory" } } }, "tags": [ "ottCategory" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/ottuser/action/activate": { "post": { "description": "Activate the account by activation token", "operationId": "ottUser.activate", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "activationToken": { "type": "string" }, "partnerId": { "type": "integer" }, "username": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaOTTUser" } } }, "tags": [ "ottUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "partnerId", "username", "activationToken" ] } }, "/service/ottuser/action/addRole": { "post": { "description": "Edit user details.", "operationId": "ottUser.addRole", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "roleId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "ottUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "roleId" ] } }, "/service/ottuser/action/anonymousLogin": { "post": { "description": "Returns tokens (KS and refresh token) for anonymous access", "operationId": "ottUser.anonymousLogin", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "partnerId": { "type": "integer" }, "udid": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaLoginSession" } } }, "tags": [ "ottUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "partnerId", "udid" ] } }, "/service/ottuser/action/delete": { "post": { "description": "Permanently delete a user. User to delete cannot be an exclusive household master, and cannot be default user.", "operationId": "ottUser.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `DomainSuspended`: undefined\n* `LimitationPeriod`: undefined\n* `UserDoesNotExist`: undefined\n* `DefaultUserCannotBeDeleted`: undefined\n* `ExclusiveMasterUserCannotBeDeleted`: undefined" } }, "tags": [ "ottUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/ottuser/action/get": { "post": { "description": "Retrieving users' data", "operationId": "ottUser.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaOTTUser" } }, "x-Errors": { "description": "* `UserDoesNotExist`: undefined" } }, "tags": [ "ottUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/ottuser/action/getEncryptedUserId": { "post": { "description": "Returns the identifier of the user encrypted with SHA1 using configured key", "operationId": "ottUser.getEncryptedUserId", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaStringValue" } } }, "tags": [ "ottUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/ottuser/action/list": { "post": { "description": "Retrieve user by external identifier or username or if filter is null all user in the master or the user itself", "operationId": "ottUser.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaOTTUserFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaOTTUserListResponse" } }, "x-Errors": { "description": "* `UserDoesNotExist`: undefined" } }, "tags": [ "ottUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/ottuser/action/login": { "post": { "description": "login with user name and password.", "operationId": "ottUser.login", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "extraParams": { "type": "object" }, "partnerId": { "type": "integer" }, "password": { "type": "string", "x-inputType": "password" }, "udid": { "type": "string" }, "username": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaLoginResponse" } }, "x-Errors": { "description": "* `UserNotInDomain`: undefined\n* `WrongPasswordOrUserName`: undefined\n* `UserSuspended`: undefined\n* `InsideLockTime`: undefined\n* `UserNotActivated`: undefined\n* `UserAllreadyLoggedIn`: undefined\n* `UserDoubleLogIn`: undefined\n* `DeviceNotRegistered`: undefined\n* `ErrorOnInitUser`: undefined\n* `UserNotMasterApproved`: undefined\n* `UserDoesNotExist`: undefined" } }, "tags": [ "ottUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "partnerId", "username", "password", "extraParams", "udid" ] } }, "/service/ottuser/action/loginWithPin": { "post": { "description": "User sign-in via a time-expired sign-in PIN.", "operationId": "ottUser.loginWithPin", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "partnerId": { "type": "integer" }, "pin": { "type": "string" }, "secret": { "type": "string" }, "udid": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaLoginResponse" } }, "x-Errors": { "description": "* `UserNotMasterApproved`: undefined\n* `ErrorOnInitUser`: undefined\n* `UserDoesNotExist`: undefined\n* `UserNotInDomain`: undefined\n* `WrongPasswordOrUserName`: undefined\n* `PinNotExists`: undefined\n* `PinExpired`: undefined\n* `NoValidPin`: undefined\n* `SecretIsWrong`: undefined\n* `LoginViaPinNotAllowed`: undefined\n* `UserSuspended`: undefined\n* `InsideLockTime`: undefined\n* `UserNotActivated`: undefined\n* `UserAllreadyLoggedIn`: undefined\n* `UserDoubleLogIn`: undefined\n* `DeviceNotRegistered`: undefined\n* `UserWithNoDomain`: undefined" } }, "tags": [ "ottUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "partnerId", "pin", "udid", "secret" ] } }, "/service/ottuser/action/logout": { "post": { "description": "Logout the calling user.", "operationId": "ottUser.logout", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "ottUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/ottuser/action/register": { "post": { "description": "Sign up a new user.", "operationId": "ottUser.register", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "partnerId": { "type": "integer" }, "password": { "type": "string", "x-inputType": "password" }, "user": { "$ref": "#/definitions/KalturaOTTUser" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaOTTUser" } }, "x-Errors": { "description": "* `WrongPasswordOrUserName`: undefined\n* `UserExists`: undefined\n* `ExternalIdAlreadyExists`: undefined" } }, "tags": [ "ottUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "partnerId", "user", "password" ] } }, "/service/ottuser/action/resendActivationToken": { "post": { "description": "Resend the activation token to a user", "operationId": "ottUser.resendActivationToken", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "partnerId": { "type": "integer" }, "username": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "ottUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "partnerId", "username" ] } }, "/service/ottuser/action/resetPassword": { "post": { "description": "Send an e-mail with URL to enable the user to set new password.", "operationId": "ottUser.resetPassword", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "partnerId": { "type": "integer" }, "username": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "ottUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "partnerId", "username" ] } }, "/service/ottuser/action/setInitialPassword": { "post": { "description": "Renew the user's password after validating the token that sent as part of URL in e-mail.", "operationId": "ottUser.setInitialPassword", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "partnerId": { "type": "integer" }, "password": { "type": "string", "x-inputType": "password" }, "token": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaOTTUser" } }, "x-Errors": { "description": "* `UserDoesNotExist`: undefined" } }, "tags": [ "ottUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "partnerId", "token", "password" ] } }, "/service/ottuser/action/update": { "post": { "description": "Update user information", "operationId": "ottUser.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "string" }, "user": { "$ref": "#/definitions/KalturaOTTUser" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaOTTUser" } }, "x-Errors": { "description": "* `UserSuspended`: undefined\n* `UserExists`: undefined\n* `ExternalIdAlreadyExists`: undefined\n* `UserDoesNotExist`: undefined" } }, "tags": [ "ottUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "user", "id" ] } }, "/service/ottuser/action/updateDynamicData": { "post": { "description": "Update user dynamic data", "operationId": "ottUser.updateDynamicData", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "key": { "type": "string" }, "value": { "$ref": "#/definitions/KalturaStringValue" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaOTTUserDynamicData" } } }, "tags": [ "ottUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "key", "value" ] } }, "/service/ottuser/action/updateLoginData": { "post": { "description": "Given a user name and existing password, change to a new password.", "operationId": "ottUser.updateLoginData", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "newPassword": { "type": "string" }, "oldPassword": { "type": "string" }, "username": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `WrongPasswordOrUserName`: undefined\n* `UserDoesNotExist`: undefined\n* `InsideLockTime`: undefined\n* `UserAllreadyLoggedIn`: undefined" } }, "tags": [ "ottUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "username", "oldPassword", "newPassword" ] } }, "/service/ottuser/action/updatePassword": { "post": { "description": "Update the user's existing password.", "operationId": "ottUser.updatePassword", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "password": { "type": "string", "x-inputType": "password" }, "userId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success" } }, "tags": [ "ottUser" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "userId", "password" ] } }, "/service/parentalrule/action/disable": { "post": { "description": "Disables a parental rule that was previously defined by the household master. Disable can be at specific user or household level.", "operationId": "parentalRule.disable", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "entityReference": { "enum": [ "user", "household" ], "type": "string", "x-enumLabels": [ "USER", "HOUSEHOLD" ], "x-enumType": "KalturaEntityReferenceBy" }, "ruleId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `DomainNotExists`: undefined\n* `UserDoesNotExist`: undefined\n* `UserWithNoDomain`: undefined\n* `UserSuspended`: undefined\n* `RuleNotExists`: undefined\n* `UserParentalRuleNotExists`: undefined" } }, "tags": [ "parentalRule" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "ruleId", "entityReference" ] } }, "/service/parentalrule/action/disableDefault": { "post": { "description": "Disables a parental rule that was defined at account level. Disable can be at specific user or household level.", "operationId": "parentalRule.disableDefault", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "entityReference": { "enum": [ "user", "household" ], "type": "string", "x-enumLabels": [ "USER", "HOUSEHOLD" ], "x-enumType": "KalturaEntityReferenceBy" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `UserWithNoDomain`: undefined\n* `UserSuspended`: undefined\n* `DomainNotExists`: undefined\n* `UserDoesNotExist`: undefined" } }, "tags": [ "parentalRule" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "entityReference" ] } }, "/service/parentalrule/action/enable": { "post": { "description": "Enable a parental rules for a user", "operationId": "parentalRule.enable", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "entityReference": { "enum": [ "user", "household" ], "type": "string", "x-enumLabels": [ "USER", "HOUSEHOLD" ], "x-enumType": "KalturaEntityReferenceBy" }, "ruleId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `RuleNotExists`: undefined\n* `DomainNotExists`: undefined\n* `UserDoesNotExist`: undefined\n* `UserSuspended`: undefined\n* `UserWithNoDomain`: undefined" } }, "tags": [ "parentalRule" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "ruleId", "entityReference" ] } }, "/service/parentalrule/action/list": { "post": { "description": "Return the parental rules that applies for the user or household. Can include rules that have been associated in account, household, or user level.\r\n Association level is also specified in the response.", "operationId": "parentalRule.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaParentalRuleFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaParentalRuleListResponse" } }, "x-Errors": { "description": "* `UserDoesNotExist`: undefined\n* `UserWithNoDomain`: undefined\n* `DomainNotExists`: undefined\n* `UserSuspended`: undefined" } }, "tags": [ "parentalRule" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/partnerconfiguration/action/update": { "post": { "description": "Update Partner Configuration", "operationId": "partnerConfiguration.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "configuration": { "$ref": "#/definitions/KalturaPartnerConfiguration" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "partnerConfiguration" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "configuration" ] } }, "/service/paymentgatewayprofile/action/add": { "post": { "description": "Insert new payment gateway for partner", "operationId": "paymentGatewayProfile.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "paymentGateway": { "$ref": "#/definitions/KalturaPaymentGatewayProfile" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaPaymentGatewayProfile" } }, "x-Errors": { "description": "* `NameRequired`: undefined\n* `ExternalIdentifierRequired`: undefined\n* `ExternalIdentifierMustBeUnique`: undefined\n* `SharedSecretRequired`: undefined\n* `NoPaymentGatewayToInsert`: undefined" } }, "tags": [ "paymentGatewayProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "paymentGateway" ] } }, "/service/paymentgatewayprofile/action/delete": { "post": { "description": "Delete payment gateway by payment gateway id", "operationId": "paymentGatewayProfile.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "paymentGatewayId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `PaymentGatewayNotExist`: undefined" } }, "tags": [ "paymentGatewayProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "paymentGatewayId" ] } }, "/service/paymentgatewayprofile/action/generateSharedSecret": { "post": { "description": "Generate payment gateway shared secret", "operationId": "paymentGatewayProfile.generateSharedSecret", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "paymentGatewayId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaPaymentGatewayProfile" } }, "x-Errors": { "description": "* `PaymentGatewayIdRequired`: undefined\n* `PaymentGatewayNotExist`: undefined" } }, "tags": [ "paymentGatewayProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "paymentGatewayId" ] } }, "/service/paymentgatewayprofile/action/getConfiguration": { "post": { "description": "Gets the Payment Gateway Configuration for the payment gateway identifier given", "operationId": "paymentGatewayProfile.getConfiguration", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "alias": { "type": "string" }, "extraParameters": { "type": "array" }, "intent": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaPaymentGatewayConfiguration" } }, "x-Errors": { "description": "* `SignatureMismatch`: undefined\n* `PaymentGatewayNotExist`: undefined" } }, "tags": [ "paymentGatewayProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "alias", "intent", "extraParameters" ] } }, "/service/paymentgatewayprofile/action/list": { "post": { "description": "Returns all payment gateways for partner : id + name", "operationId": "paymentGatewayProfile.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaPaymentGatewayProfileListResponse" } } }, "tags": [ "paymentGatewayProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/paymentgatewayprofile/action/update": { "post": { "description": "Update payment gateway details", "operationId": "paymentGatewayProfile.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "paymentGateway": { "$ref": "#/definitions/KalturaPaymentGatewayProfile" }, "paymentGatewayId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaPaymentGatewayProfile" } }, "x-Errors": { "description": "* `ExternalIdentifierRequired`: undefined\n* `NameRequired`: undefined\n* `SharedSecretRequired`: undefined\n* `ActionIsNotAllowed`: undefined\n* `PaymentGatewayIdRequired`: undefined\n* `ExternalIdentifierMustBeUnique`: undefined" } }, "tags": [ "paymentGatewayProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "paymentGatewayId", "paymentGateway" ] } }, "/service/paymentmethodprofile/action/add": { "post": { "description": "TBD", "operationId": "paymentMethodProfile.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "paymentMethod": { "$ref": "#/definitions/KalturaPaymentMethodProfile" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaPaymentMethodProfile" } }, "x-Errors": { "description": "* `PaymentGatewayIdRequired`: undefined\n* `PaymentMethodNameRequired`: undefined\n* `PaymentGatewayNotExist`: undefined" } }, "tags": [ "paymentMethodProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "paymentMethod" ] } }, "/service/paymentmethodprofile/action/delete": { "post": { "description": "Delete payment method profile", "operationId": "paymentMethodProfile.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "paymentMethodId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `PaymentMethodIdRequired`: undefined\n* `PaymentGatewayIdRequired`: undefined\n* `PaymentGatewayNotExist`: undefined\n* `PaymentMethodNotExist`: undefined" } }, "tags": [ "paymentMethodProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "paymentMethodId" ] } }, "/service/paymentmethodprofile/action/list": { "post": { "description": "TBD", "operationId": "paymentMethodProfile.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaPaymentMethodProfileFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaPaymentMethodProfileListResponse" } }, "x-Errors": { "description": "* `PaymentGatewayNotExist`: undefined" } }, "tags": [ "paymentMethodProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/paymentmethodprofile/action/update": { "post": { "description": "Update payment method", "operationId": "paymentMethodProfile.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "paymentMethod": { "$ref": "#/definitions/KalturaPaymentMethodProfile" }, "paymentMethodId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaPaymentMethodProfile" } }, "x-Errors": { "description": "* `PaymentGatewayIdRequired`: undefined\n* `PaymentMethodIdRequired`: undefined\n* `PaymentGatewayNotExist`: undefined\n* `PaymentMethodNotExist`: undefined" } }, "tags": [ "paymentMethodProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "paymentMethodId", "paymentMethod" ] } }, "/service/personalfeed/action/list": { "post": { "description": "List user's feeds.\r\n Possible status codes:", "operationId": "personalFeed.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaPersonalFeedFilter" }, "pager": { "$ref": "#/definitions/KalturaFilterPager" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaPersonalFeedListResponse" } } }, "tags": [ "personalFeed" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter", "pager" ] } }, "/service/pin/action/get": { "post": { "description": "Retrieve the parental or purchase PIN that applies for the household or user. Includes specification of where the PIN was defined at – account, household or user level", "operationId": "pin.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "by": { "enum": [ "user", "household" ], "type": "string", "x-enumLabels": [ "USER", "HOUSEHOLD" ], "x-enumType": "KalturaEntityReferenceBy" }, "ruleId": { "type": "integer" }, "type": { "enum": [ "purchase", "parental" ], "type": "string", "x-enumLabels": [ "PURCHASE", "PARENTAL" ], "x-enumType": "KalturaPinType" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaPin" } }, "x-Errors": { "description": "* `UserDoesNotExist`: undefined\n* `NoPinDefined`: undefined\n* `DomainNotExists`: undefined\n* `UserSuspended`: undefined\n* `UserWithNoDomain`: undefined" } }, "tags": [ "pin" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "by", "type", "ruleId" ] } }, "/service/pin/action/update": { "post": { "description": "Set the parental or purchase PIN that applies for the user or the household.", "operationId": "pin.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "by": { "enum": [ "user", "household" ], "type": "string", "x-enumLabels": [ "USER", "HOUSEHOLD" ], "x-enumType": "KalturaEntityReferenceBy" }, "pin": { "$ref": "#/definitions/KalturaPin" }, "ruleId": { "type": "integer" }, "type": { "enum": [ "purchase", "parental" ], "type": "string", "x-enumLabels": [ "PURCHASE", "PARENTAL" ], "x-enumType": "KalturaPinType" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaPin" } }, "x-Errors": { "description": "* `UserWithNoDomain`: undefined\n* `UserSuspended`: undefined\n* `UserDoesNotExist`: undefined" } }, "tags": [ "pin" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "by", "type", "pin", "ruleId" ] } }, "/service/pin/action/validate": { "post": { "description": "Validate a purchase or parental PIN for a user.", "operationId": "pin.validate", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "pin": { "type": "string" }, "ruleId": { "type": "integer" }, "type": { "enum": [ "purchase", "parental" ], "type": "string", "x-enumLabels": [ "PURCHASE", "PARENTAL" ], "x-enumType": "KalturaPinType" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `UserSuspended`: undefined\n* `UserWithNoDomain`: undefined\n* `NoPinDefined`: undefined\n* `UserDoesNotExist`: undefined\n* `PinMismatch`: undefined" } }, "tags": [ "pin" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "pin", "type", "ruleId" ] } }, "/service/ppv/action/get": { "post": { "description": "Returns ppv object by internal identifier", "operationId": "ppv.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaPpv" } } }, "tags": [ "ppv" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/pricedetails/action/list": { "post": { "description": "Returns the list of available prices, can be filtered by price IDs", "operationId": "priceDetails.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaPriceDetailsFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaPriceDetailsListResponse" } }, "x-Errors": { "description": "* `InvalidCurrency`: undefined" } }, "tags": [ "priceDetails" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/priceplan/action/list": { "post": { "description": "Returns a list of price plans by IDs", "operationId": "pricePlan.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaPricePlanFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaPricePlanListResponse" } } }, "tags": [ "pricePlan" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/priceplan/action/update": { "post": { "description": "Updates a price plan", "operationId": "pricePlan.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" }, "pricePlan": { "$ref": "#/definitions/KalturaPricePlan" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaPricePlan" } }, "x-Errors": { "description": "* `PriceDetailsDoesNotExist`: undefined\n* `PricePlanDoesNotExist`: undefined" } }, "tags": [ "pricePlan" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "pricePlan" ] } }, "/service/productprice/action/list": { "post": { "description": "Returns a price and a purchase status for each subscription or/and media file, for a given user (if passed) and with the consideration of a coupon code (if passed).", "operationId": "productPrice.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaProductPriceFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaProductPriceListResponse" } } }, "tags": [ "productPrice" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/purchasesettings/action/get": { "post": { "description": "Retrieve the purchase settings.\r\n Includes specification of where these settings were defined – account, household or user", "operationId": "purchaseSettings.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "by": { "enum": [ "user", "household" ], "type": "string", "x-enumLabels": [ "USER", "HOUSEHOLD" ], "x-enumType": "KalturaEntityReferenceBy" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaPurchaseSettings" } }, "x-Errors": { "description": "* `DomainNotExists`: undefined\n* `UserDoesNotExist`: undefined\n* `UserWithNoDomain`: undefined\n* `UserSuspended`: undefined" } }, "tags": [ "purchaseSettings" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "by" ] } }, "/service/purchasesettings/action/update": { "post": { "description": "Set a purchase PIN for the household or user", "operationId": "purchaseSettings.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "entityReference": { "enum": [ "user", "household" ], "type": "string", "x-enumLabels": [ "USER", "HOUSEHOLD" ], "x-enumType": "KalturaEntityReferenceBy" }, "settings": { "$ref": "#/definitions/KalturaPurchaseSettings" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaPurchaseSettings" } }, "x-Errors": { "description": "* `UserSuspended`: undefined\n* `UserWithNoDomain`: undefined\n* `PurchaseSettingsTypeInvalid`: undefined\n* `UserDoesNotExist`: undefined\n* `DomainNotExists`: undefined" } }, "tags": [ "purchaseSettings" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "entityReference", "settings" ] } }, "/service/ratio/action/add": { "post": { "description": "Add new group ratio", "operationId": "ratio.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "ratio": { "$ref": "#/definitions/KalturaRatio" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaRatio" } } }, "tags": [ "ratio" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "ratio" ] } }, "/service/ratio/action/list": { "post": { "description": "Get the list of available ratios", "operationId": "ratio.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaRatioListResponse" } } }, "tags": [ "ratio" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/recommendationprofile/action/add": { "post": { "description": "Insert new recommendation engine for partner", "operationId": "recommendationProfile.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "recommendationEngine": { "$ref": "#/definitions/KalturaRecommendationProfile" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaRecommendationProfile" } }, "x-Errors": { "description": "* `ExternalIdentifierRequired`: undefined\n* `ExternalIdentifierMustBeUnique`: undefined\n* `NameRequired`: undefined\n* `AdapterUrlRequired`: undefined" } }, "tags": [ "recommendationProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "recommendationEngine" ] } }, "/service/recommendationprofile/action/delete": { "post": { "description": "Delete recommendation engine by recommendation engine id", "operationId": "recommendationProfile.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `RecommendationEngineNotExist`: undefined\n* `RecommendationEngineIdentifierRequired`: undefined" } }, "tags": [ "recommendationProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/recommendationprofile/action/generateSharedSecret": { "post": { "description": "Generate recommendation engine shared secret", "operationId": "recommendationProfile.generateSharedSecret", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "recommendationEngineId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaRecommendationProfile" } }, "x-Errors": { "description": "* `RecommendationEngineIdentifierRequired`: undefined\n* `RecommendationEngineNotExist`: undefined" } }, "tags": [ "recommendationProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "recommendationEngineId" ] } }, "/service/recommendationprofile/action/list": { "post": { "description": "Returns all recommendation engines for partner", "operationId": "recommendationProfile.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaRecommendationProfileListResponse" } } }, "tags": [ "recommendationProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/recommendationprofile/action/update": { "post": { "description": "Update recommendation engine details", "operationId": "recommendationProfile.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "recommendationEngine": { "$ref": "#/definitions/KalturaRecommendationProfile" }, "recommendationEngineId": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaRecommendationProfile" } }, "x-Errors": { "description": "* `ExternalIdentifierMustBeUnique`: undefined\n* `RecommendationEngineNotExist`: undefined\n* `RecommendationEngineIdentifierRequired`: undefined\n* `NameRequired`: undefined\n* `ExternalIdentifierRequired`: undefined\n* `AdapterUrlRequired`: undefined" } }, "tags": [ "recommendationProfile" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "recommendationEngineId", "recommendationEngine" ] } }, "/service/recording/action/add": { "post": { "description": "Issue a record request for a program", "operationId": "recording.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "recording": { "$ref": "#/definitions/KalturaRecording" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaRecording" } }, "x-Errors": { "description": "* `AccountCatchUpNotEnabled`: undefined\n* `UserNotInDomain`: undefined\n* `UserDoesNotExist`: undefined\n* `UserSuspended`: undefined\n* `UserWithNoDomain`: undefined\n* `ServiceNotAllowed`: undefined\n* `NotEntitled`: undefined\n* `AccountCdvrNotEnabled`: undefined\n* `ProgramCdvrNotEnabled`: undefined\n* `ProgramCatchUpNotEnabled`: undefined\n* `CatchUpBufferLimitation`: undefined\n* `ProgramNotInRecordingScheduleWindow`: undefined\n* `ExceededQuota`: undefined\n* `AlreadyRecordedAsSeriesOrSeason`: undefined\n* `InvalidAssetId`: undefined" } }, "tags": [ "recording" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "recording" ] } }, "/service/recording/action/cancel": { "post": { "description": "Cancel a previously requested recording. Cancel recording can be called for recording in status Scheduled or Recording Only", "operationId": "recording.cancel", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaRecording" } }, "x-Errors": { "description": "* `RecordingStatusNotValid`: undefined\n* `UserNotInDomain`: undefined\n* `UserDoesNotExist`: undefined\n* `UserSuspended`: undefined\n* `UserWithNoDomain`: undefined\n* `RecordingNotFound`: undefined" } }, "tags": [ "recording" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/recording/action/delete": { "post": { "description": "Delete one or more user recording(s). Delete recording can be called only for recordings in status Recorded", "operationId": "recording.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaRecording" } }, "x-Errors": { "description": "* `RecordingStatusNotValid`: undefined\n* `UserDoesNotExist`: undefined\n* `UserSuspended`: undefined\n* `RecordingNotFound`: undefined\n* `UserNotInDomain`: undefined\n* `UserWithNoDomain`: undefined" } }, "tags": [ "recording" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/recording/action/get": { "post": { "description": "Returns recording object by internal identifier", "operationId": "recording.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer", "x-dynamicEnum": { "array": "objects", "label": "id", "method": "post", "path": "/service/recording/action/list", "value": "id" } } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaRecording" } }, "x-Errors": { "description": "* `RecordingNotFound`: undefined" } }, "tags": [ "recording" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/recording/action/list": { "post": { "description": "Return a list of recordings for the household with optional filter by status and KSQL.", "operationId": "recording.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaRecordingFilter" }, "pager": { "$ref": "#/definitions/KalturaFilterPager" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaRecordingListResponse" } }, "x-Errors": { "description": "* `UserWithNoDomain`: undefined\n* `UserNotInDomain`: undefined\n* `UserDoesNotExist`: undefined\n* `UserSuspended`: undefined" } }, "tags": [ "recording" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter", "pager" ] } }, "/service/recording/action/protect": { "post": { "description": "Protects an existing recording from the cleanup process for the defined protection period", "operationId": "recording.protect", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaRecording" } }, "x-Errors": { "description": "* `UserWithNoDomain`: undefined\n* `RecordingStatusNotValid`: undefined\n* `ExceededProtectionQuota`: undefined\n* `AccountProtectRecordNotEnabled`: undefined\n* `UserNotInDomain`: undefined\n* `UserDoesNotExist`: undefined\n* `RecordingNotFound`: undefined\n* `UserSuspended`: undefined" } }, "tags": [ "recording" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/region/action/list": { "post": { "description": "Returns all regions for the partner", "operationId": "region.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaRegionFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaRegionListResponse" } } }, "tags": [ "region" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/registrysettings/action/list": { "post": { "description": "Retrieve the registry settings.", "operationId": "registrySettings.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaRegistrySettingsListResponse" } } }, "tags": [ "registrySettings" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/reminder/action/add": { "post": { "description": "Add a new future reminder", "operationId": "reminder.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "reminder": { "$ref": "#/definitions/KalturaReminder" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaReminder" } }, "x-Errors": { "description": "* `InvalidAssetId`: undefined\n* `FeatureDisabled`: undefined\n* `FailCreateAnnouncement`: undefined\n* `500039`" } }, "tags": [ "reminder" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "reminder" ] } }, "/service/reminder/action/delete": { "post": { "description": "Delete a reminder. Reminder cannot be delete while being sent.", "operationId": "reminder.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" }, "type": { "enum": [ "ASSET", "SERIES" ], "type": "string", "x-enumLabels": [ "ASSET", "SERIES" ], "x-enumType": "KalturaReminderType" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "reminder" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "type" ] } }, "/service/reminder/action/deleteWithToken": { "post": { "description": "Delete a reminder. Reminder cannot be delete while being sent.", "operationId": "reminder.deleteWithToken", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" }, "partnerId": { "type": "integer" }, "token": { "type": "string" }, "type": { "enum": [ "ASSET", "SERIES" ], "type": "string", "x-enumLabels": [ "ASSET", "SERIES" ], "x-enumType": "KalturaReminderType" } }, "type": "object" } } ], "responses": { "200": { "description": "Success" }, "x-Errors": { "description": "" } }, "tags": [ "reminder" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "type", "token", "partnerId" ] } }, "/service/reminder/action/list": { "post": { "description": "Return a list of reminders with optional filter by KSQL.", "operationId": "reminder.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaReminderFilter" }, "pager": { "$ref": "#/definitions/KalturaFilterPager" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaReminderListResponse" } }, "x-Errors": { "description": "* `FeatureDisabled`: undefined\n* `SyntaxError`: undefined" } }, "tags": [ "reminder" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter", "pager" ] } }, "/service/report/action/get": { "post": { "description": "Return a device configuration retrieval log request for a specific device.", "operationId": "report.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "udid": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaReport" } }, "x-Errors": { "description": "" } }, "tags": [ "report" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "udid" ] } }, "/service/report/action/list": { "post": { "description": "Return device configurations retrieval log. Supports paging and can be filtered with the parameter "FromData".", "operationId": "report.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaReportFilter" }, "pager": { "$ref": "#/definitions/KalturaFilterPager" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaReportListResponse" } }, "x-Errors": { "description": "" } }, "tags": [ "report" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter", "pager" ] } }, "/service/searchhistory/action/clean": { "post": { "description": "Clean the user’s search history", "operationId": "searchHistory.clean", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaSearchHistoryFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "searchHistory" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/searchhistory/action/delete": { "post": { "description": "Delete a specific search history.\r\n Possible error code: 2032 - ItemNotFound", "operationId": "searchHistory.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "searchHistory" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/searchhistory/action/list": { "post": { "description": "Get user's last search requests", "operationId": "searchHistory.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaSearchHistoryFilter" }, "pager": { "$ref": "#/definitions/KalturaFilterPager" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaSearchHistoryListResponse" } } }, "tags": [ "searchHistory" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter", "pager" ] } }, "/service/seriesrecording/action/add": { "post": { "description": "Issue a record request for a complete season or series", "operationId": "seriesRecording.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "recording": { "$ref": "#/definitions/KalturaSeriesRecording" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaSeriesRecording" } }, "x-Errors": { "description": "* `ProgramCdvrNotEnabled`: undefined\n* `AccountSeriesRecordingNotEnabled`: undefined\n* `InvalidAssetId`: undefined\n* `UserNotInDomain`: undefined\n* `UserDoesNotExist`: undefined\n* `UserSuspended`: undefined\n* `UserWithNoDomain`: undefined\n* `ServiceNotAllowed`: undefined\n* `NotEntitled`: undefined\n* `AccountCdvrNotEnabled`: undefined\n* `AlreadyRecordedAsSeriesOrSeason`: undefined" } }, "tags": [ "seriesRecording" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "recording" ] } }, "/service/seriesrecording/action/cancel": { "post": { "description": "Cancel a previously requested series recording. Cancel series recording can be called for recording in status Scheduled or Recording Only", "operationId": "seriesRecording.cancel", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaSeriesRecording" } }, "x-Errors": { "description": "* `UserSuspended`: undefined\n* `RecordingStatusNotValid`: undefined\n* `SeriesRecordingNotFound`: undefined\n* `UserNotInDomain`: undefined\n* `RecordingNotFound`: undefined\n* `UserDoesNotExist`: undefined\n* `UserWithNoDomain`: undefined" } }, "tags": [ "seriesRecording" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/seriesrecording/action/cancelByEpgId": { "post": { "description": "Cancel EPG recording that was recorded as part of series", "operationId": "seriesRecording.cancelByEpgId", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "epgId": { "type": "integer" }, "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaSeriesRecording" } }, "x-Errors": { "description": "* `SeriesRecordingNotFound`: undefined\n* `EpgIdNotPartOfSeries`: undefined\n* `UserNotInDomain`: undefined\n* `RecordingStatusNotValid`: undefined\n* `UserDoesNotExist`: undefined\n* `UserSuspended`: undefined\n* `UserWithNoDomain`: undefined\n* `RecordingNotFound`: undefined" } }, "tags": [ "seriesRecording" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "epgId" ] } }, "/service/seriesrecording/action/cancelBySeasonNumber": { "post": { "description": "Cancel Season recording epgs that was recorded as part of series", "operationId": "seriesRecording.cancelBySeasonNumber", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" }, "seasonNumber": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaSeriesRecording" } }, "x-Errors": { "description": "* `UserSuspended`: undefined\n* `UserWithNoDomain`: undefined\n* `RecordingNotFound`: undefined\n* `RecordingStatusNotValid`: undefined\n* `SeriesRecordingNotFound`: undefined\n* `SeasonNumberNotMatch`: undefined\n* `UserNotInDomain`: undefined\n* `UserDoesNotExist`: undefined" } }, "tags": [ "seriesRecording" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "seasonNumber" ] } }, "/service/seriesrecording/action/delete": { "post": { "description": "Delete series recording(s). Delete series recording can be called recordings in any status", "operationId": "seriesRecording.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaSeriesRecording" } }, "x-Errors": { "description": "* `UserDoesNotExist`: undefined\n* `RecordingNotFound`: undefined\n* `RecordingStatusNotValid`: undefined\n* `SeriesRecordingNotFound`: undefined\n* `UserNotInDomain`: undefined\n* `UserWithNoDomain`: undefined\n* `UserSuspended`: undefined" } }, "tags": [ "seriesRecording" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/seriesrecording/action/deleteBySeasonNumber": { "post": { "description": "Delete Season recording epgs that was recorded as part of series", "operationId": "seriesRecording.deleteBySeasonNumber", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" }, "seasonNumber": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaSeriesRecording" } }, "x-Errors": { "description": "* `UserNotInDomain`: undefined\n* `UserWithNoDomain`: undefined\n* `UserSuspended`: undefined\n* `RecordingStatusNotValid`: undefined\n* `SeriesRecordingNotFound`: undefined\n* `SeasonNumberNotMatch`: undefined\n* `RecordingNotFound`: undefined\n* `UserDoesNotExist`: undefined" } }, "tags": [ "seriesRecording" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "seasonNumber" ] } }, "/service/seriesrecording/action/list": { "post": { "description": "Return a list of series recordings for the household with optional filter by status and KSQL.", "operationId": "seriesRecording.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaSeriesRecordingFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaSeriesRecordingListResponse" } }, "x-Errors": { "description": "* `UserWithNoDomain`: undefined\n* `UserNotInDomain`: undefined\n* `UserDoesNotExist`: undefined\n* `UserSuspended`: undefined" } }, "tags": [ "seriesRecording" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/session/action/get": { "post": { "description": "Parses KS", "operationId": "session.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "session": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaSession" } } }, "tags": [ "session" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "session" ] } }, "/service/session/action/revoke": { "post": { "description": "Revokes all the sessions (KS) of a given user", "operationId": "session.revoke", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "session" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/session/action/switchUser": { "post": { "description": "Switching the user in the session by generating a new session for a new user within the same household", "operationId": "session.switchUser", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "userIdToSwitch": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaLoginSession" } }, "x-Errors": { "description": "* `UserNotActivated`: undefined" } }, "tags": [ "session" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "userIdToSwitch" ] } }, "/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\n* `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\n* `WrongPasswordOrUserName`: undefined\n* `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\n* `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\n* `WrongPasswordOrUserName`: undefined\n* `Conflict`: undefined" } }, "tags": [ "social" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "type" ] } }, "/service/socialaction/action/add": { "post": { "description": "Insert new user social action", "operationId": "socialAction.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "socialAction": { "$ref": "#/definitions/KalturaSocialAction" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaUserSocialActionResponse" } } }, "tags": [ "socialAction" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "socialAction" ] } }, "/service/socialaction/action/delete": { "post": { "description": "delete user social action", "operationId": "socialAction.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "items": { "$ref": "#/definitions/KalturaNetworkActionStatus" }, "type": "array" } } }, "tags": [ "socialAction" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/socialaction/action/list": { "post": { "description": "Get list of user social actions", "operationId": "socialAction.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaSocialActionFilter" }, "pager": { "$ref": "#/definitions/KalturaFilterPager" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaSocialActionListResponse" } } }, "tags": [ "socialAction" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter", "pager" ] } }, "/service/socialcomment/action/list": { "post": { "description": "Get a list of all social comments filtered by asset ID and social platform", "operationId": "socialComment.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaSocialCommentFilter" }, "pager": { "$ref": "#/definitions/KalturaFilterPager" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaSocialCommentListResponse" } } }, "tags": [ "socialComment" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter", "pager" ] } }, "/service/socialfriendactivity/action/list": { "post": { "description": "Get a list of the social friends activity for a user", "operationId": "socialFriendActivity.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaSocialFriendActivityFilter" }, "pager": { "$ref": "#/definitions/KalturaFilterPager" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaSocialFriendActivityListResponse" } } }, "tags": [ "socialFriendActivity" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter", "pager" ] } }, "/service/subscription/action/list": { "post": { "description": "Returns a list of subscriptions requested by Subscription ID or file ID", "operationId": "subscription.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaSubscriptionFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaSubscriptionListResponse" } } }, "tags": [ "subscription" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/subscription/action/validateCoupon": { "post": { "description": "Returns information about a coupon for subscription", "operationId": "subscription.validateCoupon", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "code": { "type": "string" }, "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaCoupon" } } }, "tags": [ "subscription" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "code" ] } }, "/service/subscriptionset/action/add": { "post": { "description": "Add a new subscriptionSet", "operationId": "subscriptionSet.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "subscriptionSet": { "$ref": "#/definitions/KalturaSubscriptionSet" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaSubscriptionSet" } }, "x-Errors": { "description": "" } }, "tags": [ "subscriptionSet" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "subscriptionSet" ] } }, "/service/subscriptionset/action/delete": { "post": { "description": "Delete a subscriptionSet", "operationId": "subscriptionSet.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "" } }, "tags": [ "subscriptionSet" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/subscriptionset/action/get": { "post": { "description": "Get the subscriptionSet according to the Identifier", "operationId": "subscriptionSet.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer", "x-dynamicEnum": { "array": "objects", "label": "id", "method": "post", "path": "/service/subscriptionset/action/list", "value": "id" } } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaSubscriptionSet" } }, "x-Errors": { "description": "" } }, "tags": [ "subscriptionSet" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/subscriptionset/action/list": { "post": { "description": "Returns a list of subscriptionSets requested by ids or subscription ids", "operationId": "subscriptionSet.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaSubscriptionSetFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaSubscriptionSetListResponse" } } }, "tags": [ "subscriptionSet" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/subscriptionset/action/update": { "post": { "description": "Update the subscriptionSet", "operationId": "subscriptionSet.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" }, "subscriptionSet": { "$ref": "#/definitions/KalturaSubscriptionSet" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaSubscriptionSet" } }, "x-Errors": { "description": "" } }, "tags": [ "subscriptionSet" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "subscriptionSet" ] } }, "/service/system/action/getTime": { "post": { "description": "Returns current server timestamp", "operationId": "system.getTime", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "integer" } } }, "tags": [ "system" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/system/action/getVersion": { "post": { "description": "Returns current server version", "operationId": "system.getVersion", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "string" } } }, "tags": [ "system" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/system/action/ping": { "post": { "description": "Returns true", "operationId": "system.ping", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "system" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/tag/action/add": { "post": { "description": "Add a new tag", "operationId": "tag.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "tag": { "$ref": "#/definitions/KalturaTag" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaTag" } }, "x-Errors": { "description": "" } }, "tags": [ "tag" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "tag" ] } }, "/service/tag/action/delete": { "post": { "description": "Delete an existing tag", "operationId": "tag.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "" } }, "tags": [ "tag" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/tag/action/list": { "post": { "description": "Get the list of tags for the partner", "operationId": "tag.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaTagFilter" }, "pager": { "$ref": "#/definitions/KalturaFilterPager" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaTagListResponse" } } }, "tags": [ "tag" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter", "pager" ] } }, "/service/tag/action/update": { "post": { "description": "Update an existing tag", "operationId": "tag.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" }, "tag": { "$ref": "#/definitions/KalturaTag" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaTag" } }, "x-Errors": { "description": "" } }, "tags": [ "tag" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "tag" ] } }, "/service/timeshiftedtvpartnersettings/action/get": { "post": { "description": "Retrieve the account’s time-shifted TV settings (catch-up and C-DVR, Trick-play, Start-over)", "operationId": "timeShiftedTvPartnerSettings.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaTimeShiftedTvPartnerSettings" } }, "x-Errors": { "description": "* `TimeShiftedTvPartnerSettingsNotFound`: undefined" } }, "tags": [ "timeShiftedTvPartnerSettings" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/timeshiftedtvpartnersettings/action/update": { "post": { "description": "Configure the account’s time-shifted TV settings (catch-up and C-DVR, Trick-play, Start-over)", "operationId": "timeShiftedTvPartnerSettings.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "settings": { "$ref": "#/definitions/KalturaTimeShiftedTvPartnerSettings" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `TimeShiftedTvPartnerSettingsNotSent`: undefined\n* `TimeShiftedTvPartnerSettingsNegativeBufferSent`: undefined" } }, "tags": [ "timeShiftedTvPartnerSettings" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "settings" ] } }, "/service/topic/action/delete": { "post": { "description": "Deleted a topic", "operationId": "topic.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "topic" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/topic/action/get": { "post": { "description": "Gets a topic", "operationId": "topic.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer", "x-dynamicEnum": { "array": "objects", "label": "id", "method": "post", "path": "/service/topic/action/list", "value": "id" } } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaTopic" } } }, "tags": [ "topic" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/topic/action/list": { "post": { "description": "Get list of topics", "operationId": "topic.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaTopicFilter" }, "pager": { "$ref": "#/definitions/KalturaFilterPager" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaTopicListResponse" } } }, "tags": [ "topic" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter", "pager" ] } }, "/service/topic/action/updateStatus": { "post": { "description": "Updates a topic "automatic issue notification" behavior.", "operationId": "topic.updateStatus", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "automaticIssueNotification": { "enum": [ "Inherit", "Yes", "No" ], "type": "string", "x-enumLabels": [ "INHERIT", "YES", "NO" ], "x-enumType": "KalturaTopicAutomaticIssueNotification" }, "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "topic" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "automaticIssueNotification" ] } }, "/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\n* `UserNotInDomain`: undefined\n* `InvalidUser`: undefined\n* `UserDoesNotExist`: undefined\n* `UserSuspended`: undefined\n* `CouponNotValid`: undefined\n* `UnableToPurchasePPVPurchased`: undefined\n* `UnableToPurchaseFree`: undefined\n* `UnableToPurchaseForPurchaseSubscriptionOnly`: undefined\n* `UnableToPurchaseSubscriptionPurchased`: undefined\n* `PaymentGatewayChargeIdRequired`: undefined\n* `UnableToPurchaseCollectionPurchased`: undefined\n* `AdapterUrlRequired`: undefined\n* `IncorrectPrice`: undefined\n* `UnKnownPPVModule`: undefined\n* `PaymentGatewayNotSetForHousehold`: undefined\n* `PaymentGatewayNotExist`: undefined\n* `PaymentMethodNotSetForHousehold`: undefined\n* `SignatureMismatch`: undefined\n* `UnknownTransactionState`: undefined\n* `NoConfigurationFound`: undefined\n* `PaymentMethodNotExist`: undefined\n* `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\n* `NotForPurchase`: undefined\n* `UserNotInDomain`: undefined\n* `InvalidUser`: undefined\n* `UserDoesNotExist`: undefined\n* `UserSuspended`: undefined\n* `CouponNotValid`: undefined\n* `UnableToPurchasePPVPurchased`: undefined\n* `UnableToPurchaseFree`: undefined\n* `UnableToPurchaseForPurchaseSubscriptionOnly`: undefined\n* `UnableToPurchaseCollectionPurchased`: undefined\n* `AdapterUrlRequired`: undefined\n* `IncorrectPrice`: undefined\n* `UnKnownPPVModule`: undefined\n* `PaymentGatewayNotSetForHousehold`: undefined\n* `PaymentGatewayNotExist`: undefined\n* `PaymentGatewayChargeIdRequired`: undefined\n* `NoConfigurationFound`: undefined\n* `SignatureMismatch`: undefined\n* `UnknownTransactionState`: undefined\n* `PaymentMethodNotSetForHousehold`: undefined\n* `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\n* `AdapterUrlRequired`: undefined\n* `InvalidUser`: undefined\n* `UserDoesNotExist`: undefined\n* `UserSuspended`: undefined\n* `CouponNotValid`: undefined\n* `UnableToPurchasePPVPurchased`: undefined\n* `UnableToPurchaseFree`: undefined\n* `UnableToPurchaseForPurchaseSubscriptionOnly`: undefined\n* `UnableToPurchaseSubscriptionPurchased`: undefined\n* `NotForPurchase`: undefined\n* `UnableToPurchaseCollectionPurchased`: undefined\n* `IncorrectPrice`: undefined\n* `UnKnownPPVModule`: undefined\n* `PaymentGatewayNotSetForHousehold`: undefined\n* `PaymentGatewayNotExist`: undefined\n* `PaymentGatewayChargeIdRequired`: undefined\n* `NoConfigurationFound`: undefined\n* `SignatureMismatch`: undefined\n* `UnknownTransactionState`: undefined\n* `PaymentMethodNotSetForHousehold`: undefined\n* `PaymentMethodNotExist`: undefined\n* `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" ] } }, "/service/transactionhistory/action/list": { "post": { "description": "Gets user or household transaction history.", "operationId": "transactionHistory.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaTransactionHistoryFilter" }, "pager": { "$ref": "#/definitions/KalturaFilterPager" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaBillingTransactionListResponse" } } }, "tags": [ "transactionHistory" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter", "pager" ] } }, "/service/unifiedpayment/action/getNextRenewal": { "post": { "description": "Returns the data about the next renewal", "operationId": "unifiedPayment.getNextRenewal", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaUnifiedPaymentRenewal" } } }, "tags": [ "unifiedPayment" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/uploadtoken/action/add": { "post": { "description": "Adds new upload token to upload a file", "operationId": "uploadToken.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "uploadToken": { "$ref": "#/definitions/KalturaUploadToken" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaUploadToken" } } }, "tags": [ "uploadToken" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "uploadToken" ] } }, "/service/uploadtoken/action/upload": { "post": { "description": "Upload a file using the upload token id", "operationId": "uploadToken.upload", "parameters": [ { "$ref": "#/parameters/ks" }, { "$ref": "#/parameters/format" }, { "description": "Identifier of existing upload-token", "in": "query", "name": "uploadTokenId", "required": true, "type": "string" }, { "description": "File to upload", "in": "formData", "name": "fileData", "required": true, "type": "file" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaUploadToken" } } }, "tags": [ "uploadToken" ], "x-kaltura-format": "file" } }, "/service/userassetrule/action/list": { "post": { "description": "Retrieve all the rules (parental, geo, device or user-type) that applies for this user and asset.", "operationId": "userAssetRule.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaUserAssetRuleFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaUserAssetRuleListResponse" } }, "x-Errors": { "description": "* `DomainNotExists`: undefined\n* `UserSuspended`: undefined\n* `UserDoesNotExist`: undefined\n* `UserWithNoDomain`: undefined\n* `UserNotInDomain`: undefined" } }, "tags": [ "userAssetRule" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/userassetslistitem/action/add": { "post": { "description": "Adds a new item to user’s private asset list", "operationId": "userAssetsListItem.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "userAssetsListItem": { "$ref": "#/definitions/KalturaUserAssetsListItem" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaUserAssetsListItem" } } }, "tags": [ "userAssetsListItem" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "userAssetsListItem" ] } }, "/service/userassetslistitem/action/delete": { "post": { "description": "Deletes an item from user’s private asset list", "operationId": "userAssetsListItem.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "assetId": { "type": "string" }, "listType": { "enum": [ "all", "watch", "purchase", "library" ], "type": "string", "x-enumLabels": [ "ALL", "WATCH", "PURCHASE", "LIBRARY" ], "x-enumType": "KalturaUserAssetsListType" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } }, "x-Errors": { "description": "* `ItemNotFound`: undefined" } }, "tags": [ "userAssetsListItem" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "assetId", "listType" ] } }, "/service/userassetslistitem/action/get": { "post": { "description": "Get an item from user’s private asset list", "operationId": "userAssetsListItem.get", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "assetId": { "type": "string" }, "itemType": { "enum": [ "all", "media" ], "type": "string", "x-enumLabels": [ "ALL", "MEDIA" ], "x-enumType": "KalturaUserAssetsListItemType" }, "listType": { "enum": [ "all", "watch", "purchase", "library" ], "type": "string", "x-enumLabels": [ "ALL", "WATCH", "PURCHASE", "LIBRARY" ], "x-enumType": "KalturaUserAssetsListType" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaUserAssetsListItem" } }, "x-Errors": { "description": "* `ItemNotFound`: undefined" } }, "tags": [ "userAssetsListItem" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "assetId", "listType", "itemType" ] } }, "/service/userinterest/action/add": { "post": { "description": "Insert new user interest for partner user", "operationId": "userInterest.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "userInterest": { "$ref": "#/definitions/KalturaUserInterest" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaUserInterest" } }, "x-Errors": { "description": "" } }, "tags": [ "userInterest" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "userInterest" ] } }, "/service/userinterest/action/delete": { "post": { "description": "Delete new user interest for partner user", "operationId": "userInterest.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "userInterest" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/userinterest/action/deleteWithToken": { "post": { "description": "Delete new user interest for partner user", "operationId": "userInterest.deleteWithToken", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "string" }, "partnerId": { "type": "integer" }, "token": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success" }, "x-Errors": { "description": "" } }, "tags": [ "userInterest" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "token", "partnerId" ] } }, "/service/userinterest/action/list": { "post": { "description": "Returns all Engagement for partner", "operationId": "userInterest.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaUserInterestListResponse" } } }, "tags": [ "userInterest" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/userloginpin/action/add": { "post": { "description": "Generate a time and usage expiry login-PIN that can allow a single login per PIN. If an active login-PIN already exists. Calling this API again for same user will add another login-PIN", "operationId": "userLoginPin.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "secret": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaUserLoginPin" } }, "x-Errors": { "description": "* `UserDoesNotExist`: undefined\n* `UserSuspended`: undefined" } }, "tags": [ "userLoginPin" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "secret" ] } }, "/service/userloginpin/action/delete": { "post": { "description": "Immediately deletes a given pre set login pin code for the user.", "operationId": "userLoginPin.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "pinCode": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "userLoginPin" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "pinCode" ] } }, "/service/userloginpin/action/deleteAll": { "post": { "description": "Immediately expire all active login-PINs for a user", "operationId": "userLoginPin.deleteAll", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "userLoginPin" ], "x-kaltura-format": "post", "x-kaltura-parameters": [] } }, "/service/userloginpin/action/update": { "post": { "description": "Set a time and usage expiry login-PIN that can allow a single login per PIN. If an active login-PIN already exists. Calling this API again for same user will add another login-PIN", "operationId": "userLoginPin.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "pinCode": { "type": "string" }, "secret": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaUserLoginPin" } }, "x-Errors": { "description": "* `PinAlreadyExists`: undefined\n* `MissingSecurityParameter`: undefined\n* `LoginViaPinNotAllowed`: undefined\n* `PinNotInTheRightLength`: undefined" } }, "tags": [ "userLoginPin" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "pinCode", "secret" ] } }, "/service/userrole/action/add": { "post": { "description": "Creates a new role", "operationId": "userRole.add", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "role": { "$ref": "#/definitions/KalturaUserRole" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaUserRole" } } }, "tags": [ "userRole" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "role" ] } }, "/service/userrole/action/delete": { "post": { "description": "Delete role", "operationId": "userRole.delete", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "boolean" } } }, "tags": [ "userRole" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id" ] } }, "/service/userrole/action/list": { "post": { "description": "Retrieving user roles by identifiers, if filter is empty, returns all partner roles", "operationId": "userRole.list", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "filter": { "$ref": "#/definitions/KalturaUserRoleFilter" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaUserRoleListResponse" } } }, "tags": [ "userRole" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "filter" ] } }, "/service/userrole/action/update": { "post": { "description": "Update role", "operationId": "userRole.update", "parameters": [ { "in": "body", "name": "body", "schema": { "allOf": [ { "$ref": "#/definitions/OTTRequest" } ], "properties": { "id": { "type": "integer" }, "role": { "$ref": "#/definitions/KalturaUserRole" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/KalturaUserRole" } } }, "tags": [ "userRole" ], "x-kaltura-format": "post", "x-kaltura-parameters": [ "id", "role" ] } } }, "produces": [ "application/json", "text/xml" ], "schemes": [ "https", "http" ], "security": [ { "ks": [] } ], "securityDefinitions": { "ks": { "description": "A Kaltura session ID", "in": "body", "name": "ks", "type": "apiKey" } }, "swagger": "2.0", "tags": [ { "name": "announcement" }, { "name": "appToken" }, { "name": "asset" }, { "name": "assetComment" }, { "name": "assetFile" }, { "name": "assetHistory" }, { "name": "assetStatistics" }, { "name": "assetStruct" }, { "name": "bookmark" }, { "name": "cDVRAdapterProfile" }, { "name": "cdnAdapterProfile" }, { "name": "cdnPartnerSettings" }, { "name": "channel" }, { "name": "collection" }, { "name": "compensation" }, { "name": "configurationGroup" }, { "name": "configurationGroupDevice" }, { "name": "configurationGroupTag" }, { "name": "configurations" }, { "name": "country" }, { "name": "coupon" }, { "name": "currency" }, { "name": "deviceBrand" }, { "name": "deviceFamily" }, { "name": "drmProfile" }, { "name": "email" }, { "name": "engagement" }, { "name": "engagementAdapter" }, { "name": "entitlement" }, { "name": "exportTask" }, { "name": "externalChannelProfile" }, { "name": "favorite" }, { "name": "followTvSeries" }, { "name": "homeNetwork" }, { "name": "household" }, { "name": "householdDevice" }, { "name": "householdLimitations" }, { "name": "householdPaymentGateway" }, { "name": "householdPaymentMethod" }, { "name": "householdPremiumService" }, { "name": "householdQuota" }, { "name": "householdUser" }, { "name": "image" }, { "name": "imageType" }, { "name": "inboxMessage" }, { "name": "language" }, { "name": "licensedUrl" }, { "name": "mediaFile" }, { "name": "mediaFileType" }, { "name": "messageTemplate" }, { "name": "meta" }, { "name": "notification" }, { "name": "notificationsPartnerSettings" }, { "name": "notificationsSettings" }, { "name": "ossAdapterProfile" }, { "name": "ottCategory" }, { "name": "ottUser" }, { "name": "parentalRule" }, { "name": "partnerConfiguration" }, { "name": "paymentGatewayProfile" }, { "name": "paymentMethodProfile" }, { "name": "personalFeed" }, { "name": "pin" }, { "name": "ppv" }, { "name": "priceDetails" }, { "name": "pricePlan" }, { "name": "productPrice" }, { "name": "purchaseSettings" }, { "name": "ratio" }, { "name": "recommendationProfile" }, { "name": "recording" }, { "name": "region" }, { "name": "registrySettings" }, { "name": "reminder" }, { "name": "report" }, { "name": "searchHistory" }, { "name": "seriesRecording" }, { "name": "session" }, { "name": "social" }, { "name": "socialAction" }, { "name": "socialComment" }, { "name": "socialFriendActivity" }, { "name": "subscription" }, { "name": "subscriptionSet" }, { "name": "system" }, { "name": "tag" }, { "name": "timeShiftedTvPartnerSettings" }, { "name": "topic" }, { "name": "transaction" }, { "name": "transactionHistory" }, { "name": "unifiedPayment" }, { "name": "uploadToken" }, { "name": "userAssetRule" }, { "name": "userAssetsListItem" }, { "name": "userInterest" }, { "name": "userLoginPin" }, { "name": "userRole" } ], "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" ], "title": "GIFT" }, { "enum": [ "visa" ], "title": "VISA" }, { "enum": [ "master_card" ], "title": "MASTER_CARD" }, { "enum": [ "in_app" ], "title": "IN_APP" }, { "enum": [ "m1" ], "title": "M1" }, { "enum": [ "change_subscription" ], "title": "CHANGE_SUBSCRIPTION" }, { "enum": [ "offline" ], "title": "OFFLINE" } ], "title": "KalturaPaymentMethodType" }, "KalturaPersonalFeedOrderBy": { "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" } ], "title": "KalturaPersonalFeedOrderBy" }, "KalturaPinType": { "oneOf": [ { "enum": [ "purchase" ], "title": "PURCHASE" }, { "enum": [ "parental" ], "title": "PARENTAL" } ], "title": "KalturaPinType" }, "KalturaPlatform": { "oneOf": [ { "enum": [ "Android" ], "title": "ANDROID" }, { "enum": [ "iOS" ], "title": "IOS" }, { "enum": [ "WindowsPhone" ], "title": "WINDOWSPHONE" }, { "enum": [ "Blackberry" ], "title": "BLACKBERRY" }, { "enum": [ "STB" ], "title": "STB" }, { "enum": [ "CTV" ], "title": "CTV" }, { "enum": [ "Other" ], "title": "OTHER" } ], "title": "KalturaPlatform" }, "KalturaPlaybackContextType": { "oneOf": [ { "enum": [ "TRAILER" ], "title": "TRAILER" }, { "enum": [ "CATCHUP" ], "title": "CATCHUP" }, { "enum": [ "START_OVER" ], "title": "START_OVER" }, { "enum": [ "PLAYBACK" ], "title": "PLAYBACK" } ], "title": "KalturaPlaybackContextType" }, "KalturaPositionOwner": { "oneOf": [ { "enum": [ "household" ], "title": "HOUSEHOLD" }, { "enum": [ "user" ], "title": "USER" } ], "title": "KalturaPositionOwner" }, "KalturaPriceDetailsOrderBy": { "oneOf": [ { "enum": [ "NAME_ASC" ], "title": "NAME_ASC" } ], "title": "KalturaPriceDetailsOrderBy" }, "KalturaPricePlanOrderBy": { "oneOf": [ { "enum": [ "CREATE_DATE_DESC" ], "title": "CREATE_DATE_DESC" } ], "title": "KalturaPricePlanOrderBy" }, "KalturaProductPriceOrderBy": { "oneOf": [ { "enum": [ "PRODUCT_ID_ASC" ], "title": "PRODUCT_ID_ASC" }, { "enum": [ "PRODUCT_ID_DESC" ], "title": "PRODUCT_ID_DESC" } ], "title": "KalturaProductPriceOrderBy" }, "KalturaProtectionPolicy": { "oneOf": [ { "enum": [ "ExtendingRecordingLifetime" ], "title": "EXTENDINGRECORDINGLIFETIME" }, { "enum": [ "LimitedByRecordingLifetime" ], "title": "LIMITEDBYRECORDINGLIFETIME" } ], "title": "KalturaProtectionPolicy" }, "KalturaPurchaseSettingsType": { "oneOf": [ { "enum": [ "block" ], "title": "BLOCK" }, { "enum": [ "ask" ], "title": "ASK" }, { "enum": [ "allow" ], "title": "ALLOW" } ], "title": "KalturaPurchaseSettingsType" }, "KalturaPurchaseStatus": { "oneOf": [ { "enum": [ "ppv_purchased" ], "title": "PPV_PURCHASED" }, { "enum": [ "free" ], "title": "FREE" }, { "enum": [ "for_purchase_subscription_only" ], "title": "FOR_PURCHASE_SUBSCRIPTION_ONLY" }, { "enum": [ "subscription_purchased" ], "title": "SUBSCRIPTION_PURCHASED" }, { "enum": [ "for_purchase" ], "title": "FOR_PURCHASE" }, { "enum": [ "subscription_purchased_wrong_currency" ], "title": "SUBSCRIPTION_PURCHASED_WRONG_CURRENCY" }, { "enum": [ "pre_paid_purchased" ], "title": "PRE_PAID_PURCHASED" }, { "enum": [ "geo_commerce_blocked" ], "title": "GEO_COMMERCE_BLOCKED" }, { "enum": [ "entitled_to_preview_module" ], "title": "ENTITLED_TO_PREVIEW_MODULE" }, { "enum": [ "first_device_limitation" ], "title": "FIRST_DEVICE_LIMITATION" }, { "enum": [ "collection_purchased" ], "title": "COLLECTION_PURCHASED" }, { "enum": [ "user_suspended" ], "title": "USER_SUSPENDED" }, { "enum": [ "not_for_purchase" ], "title": "NOT_FOR_PURCHASE" }, { "enum": [ "invalid_currency" ], "title": "INVALID_CURRENCY" }, { "enum": [ "currency_not_defined_on_price_code" ], "title": "CURRENCY_NOT_DEFINED_ON_PRICE_CODE" } ], "title": "KalturaPurchaseStatus" }, "KalturaQuotaOveragePolicy": { "oneOf": [ { "enum": [ "StopAtQuota" ], "title": "STOPATQUOTA" }, { "enum": [ "FIFOAutoDelete" ], "title": "FIFOAUTODELETE" } ], "title": "KalturaQuotaOveragePolicy" }, "KalturaRecordingContextOrderBy": { "oneOf": [ { "enum": [ "NONE" ], "title": "NONE" } ], "title": "KalturaRecordingContextOrderBy" }, "KalturaRecordingOrderBy": { "oneOf": [ { "enum": [ "TITLE_ASC" ], "title": "TITLE_ASC" }, { "enum": [ "TITLE_DESC" ], "title": "TITLE_DESC" }, { "enum": [ "START_DATE_ASC" ], "title": "START_DATE_ASC" }, { "enum": [ "START_DATE_DESC" ], "title": "START_DATE_DESC" } ], "title": "KalturaRecordingOrderBy" }, "KalturaRecordingStatus": { "oneOf": [ { "enum": [ "SCHEDULED" ], "title": "SCHEDULED" }, { "enum": [ "RECORDING" ], "title": "RECORDING" }, { "enum": [ "RECORDED" ], "title": "RECORDED" }, { "enum": [ "CANCELED" ], "title": "CANCELED" }, { "enum": [ "FAILED" ], "title": "FAILED" }, { "enum": [ "DELETED" ], "title": "DELETED" } ], "title": "KalturaRecordingStatus" }, "KalturaRecordingType": { "oneOf": [ { "enum": [ "SINGLE" ], "title": "SINGLE" }, { "enum": [ "SEASON" ], "title": "SEASON" }, { "enum": [ "SERIES" ], "title": "SERIES" } ], "title": "KalturaRecordingType" }, "KalturaRegionOrderBy": { "oneOf": [ { "enum": [ "CREATE_DATE_ASC" ], "title": "CREATE_DATE_ASC" }, { "enum": [ "CREATE_DATE_DESC" ], "title": "CREATE_DATE_DESC" } ], "title": "KalturaRegionOrderBy" }, "KalturaReminderType": { "oneOf": [ { "enum": [ "ASSET" ], "title": "ASSET" }, { "enum": [ "SERIES" ], "title": "SERIES" } ], "title": "KalturaReminderType" }, "KalturaReportOrderBy": { "oneOf": [ { "enum": [ "NONE" ], "title": "NONE" } ], "title": "KalturaReportOrderBy" }, "KalturaRuleActionType": { "oneOf": [ { "enum": [ "BLOCK" ], "title": "BLOCK" } ], "title": "KalturaRuleActionType" }, "KalturaRuleLevel": { "oneOf": [ { "enum": [ "invalid" ], "title": "INVALID" }, { "enum": [ "user" ], "title": "USER" }, { "enum": [ "household" ], "title": "HOUSEHOLD" }, { "enum": [ "account" ], "title": "ACCOUNT" } ], "title": "KalturaRuleLevel" }, "KalturaRuleType": { "oneOf": [ { "enum": [ "parental" ], "title": "PARENTAL" }, { "enum": [ "geo" ], "title": "GEO" }, { "enum": [ "user_type" ], "title": "USER_TYPE" }, { "enum": [ "device" ], "title": "DEVICE" } ], "title": "KalturaRuleType" }, "KalturaScheduledRecordingAssetType": { "oneOf": [ { "enum": [ "single" ], "title": "SINGLE" }, { "enum": [ "series" ], "title": "SERIES" }, { "enum": [ "all" ], "title": "ALL" } ], "title": "KalturaScheduledRecordingAssetType" }, "KalturaSearchHistoryOrderBy": { "oneOf": [ { "enum": [ "NONE" ], "title": "NONE" } ], "title": "KalturaSearchHistoryOrderBy" }, "KalturaSeriesRecordingOrderBy": { "oneOf": [ { "enum": [ "START_DATE_ASC" ], "title": "START_DATE_ASC" }, { "enum": [ "START_DATE_DESC" ], "title": "START_DATE_DESC" }, { "enum": [ "ID_ASC" ], "title": "ID_ASC" }, { "enum": [ "ID_DESC" ], "title": "ID_DESC" }, { "enum": [ "SERIES_ID_ASC" ], "title": "SERIES_ID_ASC" }, { "enum": [ "SERIES_ID_DESC" ], "title": "SERIES_ID_DESC" } ], "title": "KalturaSeriesRecordingOrderBy" }, "KalturaSeriesReminderOrderBy": { "oneOf": [ { "enum": [ "NONE" ], "title": "NONE" } ], "title": "KalturaSeriesReminderOrderBy" }, "KalturaSocialActionOrderBy": { "oneOf": [ { "enum": [ "NONE" ], "title": "NONE" } ], "title": "KalturaSocialActionOrderBy" }, "KalturaSocialActionPrivacy": { "oneOf": [ { "enum": [ "ALLOW" ], "title": "ALLOW" }, { "enum": [ "DONT_ALLOW" ], "title": "DONT_ALLOW" } ], "title": "KalturaSocialActionPrivacy" }, "KalturaSocialActionType": { "oneOf": [ { "enum": [ "LIKE" ], "title": "LIKE" }, { "enum": [ "WATCH" ], "title": "WATCH" }, { "enum": [ "RATE" ], "title": "RATE" }, { "enum": [ "SHARE" ], "title": "SHARE" } ], "title": "KalturaSocialActionType" }, "KalturaSocialCommentOrderBy": { "oneOf": [ { "enum": [ "CREATE_DATE_ASC" ], "title": "CREATE_DATE_ASC" }, { "enum": [ "CREATE_DATE_DESC" ], "title": "CREATE_DATE_DESC" } ], "title": "KalturaSocialCommentOrderBy" }, "KalturaSocialFriendActivityOrderBy": { "oneOf": [ { "enum": [ "NONE" ], "title": "NONE" }, { "enum": [ "UPDATE_DATE_DESC" ], "title": "UPDATE_DATE_DESC" } ], "title": "KalturaSocialFriendActivityOrderBy" }, "KalturaSocialNetwork": { "oneOf": [ { "enum": [ "facebook" ], "title": "FACEBOOK" } ], "title": "KalturaSocialNetwork" }, "KalturaSocialPlatform": { "oneOf": [ { "enum": [ "IN_APP" ], "title": "IN_APP" }, { "enum": [ "FACEBOOK" ], "title": "FACEBOOK" }, { "enum": [ "TWITTER" ], "title": "TWITTER" } ], "title": "KalturaSocialPlatform" }, "KalturaSocialPrivacy": { "oneOf": [ { "enum": [ "UNKNOWN" ], "title": "UNKNOWN" }, { "enum": [ "EVERYONE" ], "title": "EVERYONE" }, { "enum": [ "ALL_FRIENDS" ], "title": "ALL_FRIENDS" }, { "enum": [ "FRIENDS_OF_FRIENDS" ], "title": "FRIENDS_OF_FRIENDS" }, { "enum": [ "SELF" ], "title": "SELF" }, { "enum": [ "CUSTOM" ], "title": "CUSTOM" } ], "title": "KalturaSocialPrivacy" }, "KalturaSocialStatus": { "oneOf": [ { "enum": [ "error" ], "title": "ERROR" }, { "enum": [ "ok" ], "title": "OK" }, { "enum": [ "user_does_not_exist" ], "title": "USER_DOES_NOT_EXIST" }, { "enum": [ "no_user_social_settings_found" ], "title": "NO_USER_SOCIAL_SETTINGS_FOUND" }, { "enum": [ "asset_already_liked" ], "title": "ASSET_ALREADY_LIKED" }, { "enum": [ "not_allowed" ], "title": "NOT_ALLOWED" }, { "enum": [ "invalid_parameters" ], "title": "INVALID_PARAMETERS" }, { "enum": [ "no_facebook_action" ], "title": "NO_FACEBOOK_ACTION" }, { "enum": [ "asset_already_rated" ], "title": "ASSET_ALREADY_RATED" }, { "enum": [ "asset_dose_not_exists" ], "title": "ASSET_DOSE_NOT_EXISTS" }, { "enum": [ "invalid_platform_request" ], "title": "INVALID_PLATFORM_REQUEST" }, { "enum": [ "invalid_access_token" ], "title": "INVALID_ACCESS_TOKEN" } ], "title": "KalturaSocialStatus" }, "KalturaStreamType": { "oneOf": [ { "enum": [ "catchup" ], "title": "CATCHUP" }, { "enum": [ "start_over" ], "title": "START_OVER" }, { "enum": [ "trick_play" ], "title": "TRICK_PLAY" } ], "title": "KalturaStreamType" }, "KalturaSubscriptionDependencyType": { "oneOf": [ { "enum": [ "NOTAPPLICABLE" ], "title": "NOTAPPLICABLE" }, { "enum": [ "BASE" ], "title": "BASE" }, { "enum": [ "ADDON" ], "title": "ADDON" } ], "title": "KalturaSubscriptionDependencyType" }, "KalturaSubscriptionOrderBy": { "oneOf": [ { "enum": [ "START_DATE_ASC" ], "title": "START_DATE_ASC" }, { "enum": [ "START_DATE_DESC" ], "title": "START_DATE_DESC" } ], "title": "KalturaSubscriptionOrderBy" }, "KalturaSubscriptionSetOrderBy": { "oneOf": [ { "enum": [ "NAME_ASC" ], "title": "NAME_ASC" }, { "enum": [ "NAME_DESC" ], "title": "NAME_DESC" } ], "title": "KalturaSubscriptionSetOrderBy" }, "KalturaSubscriptionSetType": { "oneOf": [ { "enum": [ "SWITCH" ], "title": "SWITCH" }, { "enum": [ "DEPENDENCY" ], "title": "DEPENDENCY" } ], "title": "KalturaSubscriptionSetType" }, "KalturaTagOrderBy": { "oneOf": [ { "enum": [ "NONE" ], "title": "NONE" } ], "title": "KalturaTagOrderBy" }, "KalturaTopicAutomaticIssueNotification": { "oneOf": [ { "enum": [ "Inherit" ], "title": "INHERIT" }, { "enum": [ "Yes" ], "title": "YES" }, { "enum": [ "No" ], "title": "NO" } ], "title": "KalturaTopicAutomaticIssueNotification" }, "KalturaTopicOrderBy": { "oneOf": [ { "enum": [ "NONE" ], "title": "NONE" } ], "title": "KalturaTopicOrderBy" }, "KalturaTransactionAdapterStatus": { "oneOf": [ { "enum": [ "OK" ], "title": "OK" }, { "enum": [ "PENDING" ], "title": "PENDING" }, { "enum": [ "FAILED" ], "title": "FAILED" } ], "title": "KalturaTransactionAdapterStatus" }, "KalturaTransactionHistoryOrderBy": { "oneOf": [ { "enum": [ "CREATE_DATE_ASC" ], "title": "CREATE_DATE_ASC" }, { "enum": [ "CREATE_DATE_DESC" ], "title": "CREATE_DATE_DESC" } ], "title": "KalturaTransactionHistoryOrderBy" }, "KalturaTransactionType": { "oneOf": [ { "enum": [ "ppv" ], "title": "PPV" }, { "enum": [ "subscription" ], "title": "SUBSCRIPTION" }, { "enum": [ "collection" ], "title": "COLLECTION" } ], "title": "KalturaTransactionType" }, "KalturaUploadTokenStatus": { "oneOf": [ { "enum": [ "PENDING" ], "title": "PENDING" }, { "enum": [ "FULL_UPLOAD" ], "title": "FULL_UPLOAD" }, { "enum": [ "CLOSED" ], "title": "CLOSED" } ], "title": "KalturaUploadTokenStatus" }, "KalturaUserAssetRuleOrderBy": { "oneOf": [ { "enum": [ "NAME_ASC" ], "title": "NAME_ASC" }, { "enum": [ "NAME_DESC" ], "title": "NAME_DESC" } ], "title": "KalturaUserAssetRuleOrderBy" }, "KalturaUserAssetsListItemType": { "oneOf": [ { "enum": [ "all" ], "title": "ALL" }, { "enum": [ "media" ], "title": "MEDIA" } ], "title": "KalturaUserAssetsListItemType" }, "KalturaUserAssetsListType": { "oneOf": [ { "enum": [ "all" ], "title": "ALL" }, { "enum": [ "watch" ], "title": "WATCH" }, { "enum": [ "purchase" ], "title": "PURCHASE" }, { "enum": [ "library" ], "title": "LIBRARY" } ], "title": "KalturaUserAssetsListType" }, "KalturaUserRoleOrderBy": { "oneOf": [ { "enum": [ "NONE" ], "title": "NONE" } ], "title": "KalturaUserRoleOrderBy" }, "KalturaUserState": { "oneOf": [ { "enum": [ "ok" ], "title": "OK" }, { "enum": [ "user_with_no_household" ], "title": "USER_WITH_NO_HOUSEHOLD" }, { "enum": [ "user_created_with_no_role" ], "title": "USER_CREATED_WITH_NO_ROLE" }, { "enum": [ "user_not_activated" ], "title": "USER_NOT_ACTIVATED" } ], "title": "KalturaUserState" }, "KalturaWatchStatus": { "oneOf": [ { "enum": [ "progress" ], "title": "PROGRESS" }, { "enum": [ "done" ], "title": "DONE" }, { "enum": [ "all" ], "title": "ALL" } ], "title": "KalturaWatchStatus" } }, "x-errors": [ { "code": "1000", "description": "The household you entered already exists in the system", "name": "DomainAlreadyExists" }, { "code": "1001", "description": "The number of devices or users has exceeded the household limit", "name": "ExceededLimit" }, { "code": "1002", "description": "The device type you selected is not supported by the system", "name": "DeviceTypeNotAllowed" }, { "code": "1003", "description": "The device you selected is not part of the current household", "name": "DeviceNotInDomain" }, { "code": "1004", "description": "The master email address you entered already exists in the system", "name": "MasterEmailAlreadyExists" }, { "code": "1005", "description": "The user you selected is not part of the current household", "name": "UserNotInDomain" }, { "code": "1006", "description": "The household you selected does not exist", "name": "DomainNotExists" }, { "code": "1007", "description": "The system was unable to register this household user", "name": "HouseholdUserFailed" }, { "code": "1008", "description": "The household was created without an external NPVR account", "name": "DomainCreatedWithoutNPVRAccount" }, { "code": "1009", "description": "Unable to perform the action requested because the household has been suspended", "name": "DomainSuspended" }, { "code": "1010", "description": "The device limitation module (DLM) you entered does not exist in the system", "name": "DlmNotExist" }, { "code": "1011", "description": "Unable to authenticate this user - the user name or password are incorrect. Please re-enter this information", "name": "WrongPasswordOrUserName" }, { "code": "1012", "description": "This household has already been suspended", "name": "DomainAlreadySuspended" }, { "code": "1013", "description": "This household has already been activated", "name": "DomainAlreadyActive" }, { "code": "1014", "description": "Unable to remove the device or user from the household at this time because of the limitation period", "name": "LimitationPeriod" }, { "code": "1015", "description": "The device you are trying to add already exists in the system", "name": "DeviceAlreadyExists" }, { "code": "1016", "description": "Unable to add this device to this household because the device is already associated with another household", "name": "DeviceExistsInOtherDomains" }, { "code": "1017", "description": "There are no users associated with this household", "name": "NoUsersInDomain" }, { "code": "1018", "description": "Unable to add this user to this household because the user is already associated with another household", "name": "UserExistsInOtherDomains" }, { "code": "1019", "description": "The device you selected for this action does not exist in the household", "name": "DeviceNotExists" }, { "code": "1020", "description": "The user you selected for this action does not exist in the household", "name": "UserNotExistsInDomain" }, { "code": "1021", "description": "Unable to perform this action: the user is not the household master", "name": "ActionUserNotMaster" }, { "code": "1022", "description": "Unable to perform this action: you have exceeded the number of users for this household", "name": "ExceededUserLimit" }, { "code": "1023", "description": "This household has not been initialized", "name": "DomainNotInitialized" }, { "code": "1024", "description": "Unable to confirm this device", "name": "DeviceNotConfirmed" }, { "code": "1025", "description": "The request you entered could not be completed at this time", "name": "RequestFailed" }, { "code": "1026", "description": "The user you selected for this action is not a valid user", "name": "InvalidUser" }, { "code": "1027", "description": "The user you selected for this action doesn't have the necessary permissions", "name": "UserNotAllowed" }, { "code": "1028", "description": "The PIN number you entered is already being used in this household", "name": "DuplicatePin" }, { "code": "1029", "description": "Unable to add a user to the same household twice", "name": "UserAlreadyInDomain" }, { "code": "1030", "description": "Unable to delete this user from the account due to permission limitations", "name": "NotAllowedToDelete" }, { "code": "1031", "description": "Unable to add a home network to the same household twice", "name": "HomeNetworkAlreadyExists" }, { "code": "1032", "description": "The number of home networks in the household has been exceeded", "name": "HomeNetworkLimitation" }, { "code": "1033", "description": "The home network you specified does not exis", "name": "HomeNetworkDoesNotExist" }, { "code": "1034", "description": "Unable to remove the home network from the household because of the frequency limitation", "name": "HomeNetworkFrequency" }, { "code": "2000", "description": "This user doesn't exist", "name": "UserDoesNotExist" }, { "code": "2001", "description": "Unable to perform this action due to a household suspension", "name": "UserSuspended" }, { "code": "2003", "description": "The PIN provided does not exist in the system", "name": "PinNotExists" }, { "code": "2004", "description": "The PIN provided has expired", "name": "PinExpired" }, { "code": "2006", "description": "The PIN provided is not valid", "name": "NoValidPin" }, { "code": "2007", "description": "The security answer for the PIN code is missing", "name": "MissingSecurityParameter" }, { "code": "2008", "description": "The secret provided is incorrect", "name": "SecretIsWrong" }, { "code": "2009", "description": "Log in using a PIN is not enabled for this account", "name": "LoginViaPinNotAllowed" }, { "code": "2010", "description": "The PIN provided is not valid.(does not match the required number of digits).", "name": "PinNotInTheRightLength" }, { "code": "2011", "description": "The PIN that you entered already exists in the system", "name": "PinAlreadyExists" }, { "code": "2014", "description": "The user you are trying to add already exists", "name": "UserExists" }, { "code": "2015", "description": "The account has been locked", "name": "InsideLockTime" }, { "code": "2016", "description": "The user must be activated to log in", "name": "UserNotActivated" }, { "code": "2017", "description": "This user is already logged in", "name": "UserAllreadyLoggedIn" }, { "code": "2018", "description": "The user can't be logged in on more than one device", "name": "UserDoubleLogIn" }, { "code": "2019", "description": "The device you are trying to connect is not registered", "name": "DeviceNotRegistered" }, { "code": "2021", "description": "", "name": "ErrorOnInitUser" }, { "code": "2023", "description": "The user must be approved by the household master", "name": "UserNotMasterApproved" }, { "code": "2024", "description": "This user is not associated with any household.", "name": "UserWithNoDomain" }, { "code": "2025", "description": "The specified user type does not exist", "name": "UserTypeDoesNotExist" }, { "code": "2026", "description": "The activation token is incorrec", "name": "ActivationTokenNotFound" }, { "code": "2027", "description": "This user has already been approved by the household master", "name": "UserAlreadyMasterApproved" }, { "code": "2028", "description": "The login server is not available. Please try again", "name": "LoginServerDown" }, { "code": "2029", "description": "This role has already been associated with this user", "name": "RoleAlreadyAssignedToUser" }, { "code": "2030", "description": "Unable to delete the default household user", "name": "DefaultUserCannotBeDeleted" }, { "code": "2031", "description": "The exclusive household master user can't be deleted", "name": "ExclusiveMasterUserCannotBeDeleted" }, { "code": "2032", "description": "Unable to find the item you requested", "name": "ItemNotFound" }, { "code": "2054", "description": "The external ID you are trying to add / update already exists", "name": "ExternalIdAlreadyExists" }, { "code": "500063", "message": "externalCode: [@externalCode@], externalMessage: [@externalMessage@]", "name": "ExternalError" }, { "code": "3000", "description": "Unable to complete the purchase of the item requested", "name": "InvalidPurchase" }, { "code": "3001", "description": "Unable to cancel the product request because the cancellation window has expired.", "name": "CancelationWindowPeriodExpired" }, { "code": "3002", "description": "Unable to perform this action on a subscription that is not renewable", "name": "SubscriptionNotRenewable" }, { "code": "3003", "description": "The user is not entitled to the premium service that he or she is trying to access", "name": "ServiceNotAllowed" }, { "code": "3004", "description": "The CDN code that was provided is incorrect", "name": "InvalidBaseLink" }, { "code": "3005", "description": "Unable to complete this request - content cannot be cancelled after being viewed.", "name": "ContentAlreadyConsumed" }, { "code": "3011", "description": "The request failed for an unknown reason", "name": "ReasonUnknown" }, { "code": "3015", "description": "The charge status for this purchase is unknown", "name": "ChargeStatusUnknown" }, { "code": "3016", "description": "The Content ID is missing", "name": "ContentIDMissing" }, { "code": "3017", "description": "There is no media for the file you requested.", "name": "NoMediaRelatedToFile" }, { "code": "3018", "description": "Please enter the content ID and try again", "name": "NoContentID" }, { "code": "3019", "description": "Please enter the product ID and try again", "name": "NoProductID" }, { "code": "3020", "description": "The coupon you entered is not valid", "name": "CouponNotValid" }, { "code": "3021", "description": "Pay-Per-View was already purchased by this household", "name": "UnableToPurchasePPVPurchased" }, { "code": "3022", "description": "The product you are trying to purchase is free", "name": "UnableToPurchaseFree" }, { "code": "3023", "description": "The product you are trying to purchase is restricted to subscription purchases only", "name": "UnableToPurchaseForPurchaseSubscriptionOnly" }, { "code": "3024", "description": "This subscription was already purchased by this household.", "name": "UnableToPurchaseSubscriptionPurchased" }, { "code": "3025", "description": "The Content ID entered is not available for purchase.", "name": "NotForPurchase" }, { "code": "3026", "description": "", "name": "Fail" }, { "code": "3027", "description": "This collection has already been purchased by this household", "name": "UnableToPurchaseCollectionPurchased" }, { "code": "3028", "description": "The file and media don't match", "name": "FileToMediaMismatch" }, { "code": "3029", "description": "", "name": "ReconciliationFrequencyLimitation" }, { "code": "3030", "description": "The custom data identifier you entered is invalid", "name": "InvalidCustomDataIdentifier" }, { "code": "3031", "description": "The file type provided is invalid", "name": "InvalidFileType" }, { "code": "3032", "description": "The user does not have permission to access this content", "name": "NotEntitled" }, { "code": "3033", "description": "Your account is not enabled for the C-DVR (recording) feature", "name": "AccountCdvrNotEnabled" }, { "code": "3034", "description": "Your account is not enabled for the catch-up feature", "name": "AccountCatchUpNotEnabled" }, { "code": "3035", "description": "This program is not recordable", "name": "ProgramCdvrNotEnabled" }, { "code": "3036", "description": "This program does not support catch-up", "name": "ProgramCatchUpNotEnabled" }, { "code": "3037", "description": "You've reach the maximum limit for the catch up buffer", "name": "CatchUpBufferLimitation" }, { "code": "3038", "description": "This program cannot be recorded because it is not in the recording schedule window", "name": "ProgramNotInRecordingScheduleWindow" }, { "code": "3039", "description": "The program ID provided is invalid", "name": "RecordingNotFound" }, { "code": "3040", "description": "The program recording failed", "name": "RecordingFailed" }, { "code": "3041", "description": "", "name": "PaymentMethodIsUsedByHousehold" }, { "code": "3042", "description": "You've reached the maximum quote buffer for your household", "name": "ExceededQuota" }, { "code": "3043", "description": "Unable to perform the action requested because of the current recording status. Actions are only allowed for these statuses:Recorded, Recording, Scheduled", "name": "RecordingStatusNotValid" }, { "code": "3044", "description": "You've reached the maximum quota on protected programs, and can't protect any additional programs", "name": "ExceededProtectionQuota" }, { "code": "3045", "description": "The account recording protection feature is disabled", "name": "AccountProtectRecordNotEnabled" }, { "code": "3046", "description": "The account series recording feature is disabled", "name": "AccountSeriesRecordingNotEnabled" }, { "code": "3047", "description": "This program has already been recorded as part of a series/season recording", "name": "AlreadyRecordedAsSeriesOrSeason" }, { "code": "3048", "description": "Unable to find the requested series recording", "name": "SeriesRecordingNotFound" }, { "code": "3049", "description": "Unable to cancel or delete an EPG program that is not part of the series", "name": "EpgIdNotPartOfSeries" }, { "code": "3050", "description": "Recording playback is not allowed for a non-existing linear channel", "name": "RecordingPlaybackNotAllowedForNonExistingEpgChannel" }, { "code": "3051", "description": "Recording playback is not allowed for non-entitled linear channels", "name": "RecordingPlaybackNotAllowedForNotEntitledEpgChannel" }, { "code": "3052", "description": "The season number you entered doesn't match the season number that was recorded", "name": "SeasonNumberNotMatch" }, { "code": "3074", "description": "", "name": "SubscriptionCancellationIsBlocked" }, { "code": "4000", "description": "Media concurrency limitation (according to DLM configuration)", "name": "MediaConcurrencyLimitation" }, { "code": "4001", "description": "Concurrency limitation (according to DLM configuration)", "name": "ConcurrencyLimitation" }, { "code": "4002", "description": "", "name": "BadSearchRequest" }, { "code": "4003", "description": "Relevant ElasticSearch index doesn't exist, either because it wasn't built or some other error.", "name": "IndexMissing" }, { "code": "4004", "description": "KSQL query string contains a syntax error. It is not in the correct and expected format.", "name": "SyntaxError" }, { "code": "4005", "description": "", "name": "InvalidSearchField" }, { "code": "4006", "description": "There's no available recommendation engine to connect", "name": "NoRecommendationEngineToInsert" }, { "code": "4007", "description": "The recommendation engine specified doesn't exist", "name": "RecommendationEngineNotExist" }, { "code": "4008", "description": "The mandatory recommendation engine identifier field is missing from the request", "name": "RecommendationEngineIdentifierRequired" }, { "code": "4009", "description": "The mandatory recommendation engine parameter fields are missing from the request", "name": "RecommendationEngineParamsRequired" }, { "code": "4010", "description": "There's no external channel to connect", "name": "NoExternalChannelToInsert" }, { "code": "4011", "description": "The external channel specified doesn't exist", "name": "ExternalChannelNotExist" }, { "code": "4012", "description": "There's no external channel to update", "name": "NoExternalChannelToUpdate" }, { "code": "4013", "description": "The mandatory external channel identifier field is missing from the request", "name": "ExternalChannelIdentifierRequired" }, { "code": "4014", "description": "The external channel isn't connected to a recommendation engine", "name": "ExternalChannelHasNoRecommendationEngine" }, { "code": "4015", "description": "There's no recommendation engine to update", "name": "NoRecommendationEngineToUpdate" }, { "code": "4016", "description": "The specified external channel enrichment is not available", "name": "InactiveExternalChannelEnrichment" }, { "code": "4017", "description": "Please specify the channel ID identifier", "name": "IdentifierRequired" }, { "code": "4018", "description": "The object requested doesn't exist", "name": "ObjectNotExist" }, { "code": "4019", "description": "There's no channel to add", "name": "NoObjectToInsert" }, { "code": "4020", "description": "The asset type does not match one of the group asset types", "name": "InvalidMediaType" }, { "code": "4021", "description": "The asset requested is not a valid asset type", "name": "InvalidAssetType" }, { "code": "4022", "description": "The EPG program requested doesn't exist", "name": "ProgramDoesntExist" }, { "code": "4023", "description": "Unable to recognize the action you specified", "name": "ActionNotRecognized" }, { "code": "4024", "description": "The specified asset ID is invalid", "name": "InvalidAssetId" }, { "code": "4025", "description": "Unable to find the country code specified", "name": "CountryNotFound" }, { "code": "4026", "description": "The asset struct name is already in use", "name": "AssetStructNameAlreadyInUse" }, { "code": "4027", "description": "The asset struct system name is already in use", "name": "AssetStructSystemNameAlreadyInUse" }, { "code": "4031", "description": "One or more of the specified meta ids does not exist", "name": "MetaIdsDoesNotExist" }, { "code": "4028", "description": "The specified asset strcut id does not exist", "name": "AssetStructDoesNotExist" }, { "code": "4029", "description": "can not change predefined asset struct name", "name": "CanNotChangePredefinedAssetStructSystemName" }, { "code": "4030", "description": "can not delete predefined asset struct", "name": "CanNotDeletePredefinedAssetStruct" }, { "code": "4032", "description": "The meta system name is already in use", "name": "MetaSystemNameAlreadyInUse" }, { "code": "4036", "description": "", "name": "InvalidMutlipleValueForMetaType" }, { "code": "4033", "description": "The specified meta id does not exist", "name": "MetaDoesNotExist" }, { "code": "4034", "description": "can not change predefined meta name", "name": "CanNotChangePredefinedMetaSystemName" }, { "code": "4035", "description": "can not delete predefined meta", "name": "CanNotDeletePredefinedMeta" }, { "code": "4037", "description": "One or more of the basic meta ids was not sent", "name": "AssetStructMissingBasicMetaIds" }, { "code": "4038", "description": "", "name": "AssetExternalIdMustBeUnique" }, { "code": "4040", "description": "", "name": "InvalidMetaType" }, { "code": "4041", "description": "", "name": "InvalidValueSentForMeta" }, { "code": "4042", "description": "", "name": "DeviceRuleDoesNotExistForGroup" }, { "code": "4043", "description": "", "name": "GeoBlockRuleDoesNotExistForGroup" }, { "code": "4039", "description": "", "name": "AssetDoesNotExist" }, { "code": "4050", "description": "One or more of the specified meta ids does not exist", "name": "MetaIdsDoesNotExistOnAsset" }, { "code": "4051", "description": "", "name": "MediaFileTypeNameAlreadyInUse" }, { "code": "4052", "description": "", "name": "MediaFileTypeDoesNotExist" }, { "code": "4055", "description": "", "name": "CanNotRemoveBasicMetaIds" }, { "code": "4049", "description": "", "name": "RatioAlreadyExist" }, { "code": "500064", "message": "languageCode: @lngCode@ has been sent more than once", "name": "DuplicateLanguageSent" }, { "code": "500065", "message": "Invalid value for feature: @feature@. feature can only contain alphanumeric values and/or underscore up until 64 characters", "name": "InvalidValueForFeature" }, { "code": "500066", "message": "Default language must be one of the values sent for @object@", "name": "DefaultLanguageMustBeSent" }, { "code": "500067", "message": "language: @lng@ is not part of group supported languages", "name": "GroupDoesNotContainLanguage" }, { "code": "500068", "message": "Global language parameter must be asterisk for write actions of multilingualName", "name": "GlobalLanguageParameterMustBeAsterisk" }, { "code": "500069", "message": "multipleValue property must have a value when KalturaMetaDataType equals STRING", "name": "MultiValueWasNotSentForMetaDataTypeString" }, { "code": "500070", "message": "Tag translations are not allowed using asset contoller, please use tag controller", "name": "TagTranslationNotAllowed" }, { "code": "4060", "description": "The channel system name is already in use", "name": "ChannelSystemNameAlreadyInUse" }, { "code": "5001", "description": "No parental PIN was defined for this user/household", "name": "NoPinDefined" }, { "code": "5002", "description": "The parental PIN provided doesn't match the user/household PIN", "name": "PinMismatch" }, { "code": "5003", "description": "This rule doesn't exist in the system", "name": "RuleNotExists" }, { "code": "5004", "description": "There's no OSS Adapater Profile to add to the system", "name": "NoOSSAdapterToInsert" }, { "code": "5005", "description": "The mandatory name field is missing from the request", "name": "NameRequired" }, { "code": "5006", "description": "The mandatory shared secret field is missing from the request", "name": "SharedSecretRequired" }, { "code": "5007", "description": "The mandatory OSS adapter identifier field is missing from the request", "name": "OSSAdapterIdentifierRequired" }, { "code": "5008", "description": "The requested OSS adapter doesn't exist", "name": "OSSAdapterNotExist" }, { "code": "5009", "description": "The mandatory OSS adapter parameter fields are missing from the request", "name": "OSSAdapterParamsRequired" }, { "code": "5010", "description": "The status of the OSS adapter is unknown", "name": "UnknownOSSAdapterState" }, { "code": "5011", "description": "The action requested is not allowed", "name": "ActionIsNotAllowed" }, { "code": "5012", "description": "There's no OSS adapter to update", "name": "NoOSSAdapterToUpdate" }, { "code": "5013", "description": "The mandatory adapter URL field is missing from the request", "name": "AdapterUrlRequired" }, { "code": "5014", "description": "The system has detected conflicts between parameters", "name": "ConflictedParams" }, { "code": "5015", "description": "The specified purchase settings type is Invalid", "name": "PurchaseSettingsTypeInvalid" }, { "code": "5016", "description": "The requested export task wasn't found", "name": "ExportTaskNotFound" }, { "code": "5017", "description": "The mandatory export notification URL field is missing from the request", "name": "ExportNotificationUrlRequired" }, { "code": "5018", "description": "The export frequency set is below the minimum allowed", "name": "ExportFrequencyMinValue" }, { "code": "5019", "description": "Invalid entry: the alias value must be unique", "name": "AliasMustBeUnique" }, { "code": "5020", "description": "The mandatory alias value field is missing from the request", "name": "AliasRequired" }, { "code": "5021", "description": "There is no parental rule associated with this user", "name": "UserParentalRuleNotExists" }, { "code": "5022", "description": "The system did not find any TimeShiftedTvPartner-related settings", "name": "TimeShiftedTvPartnerSettingsNotFound" }, { "code": "5023", "description": "The TimeShiftedTvPartner settings specified are null", "name": "TimeShiftedTvPartnerSettingsNotSent" }, { "code": "5024", "description": "You've configured a negative buffer value in the TimeShiftedTvPartnerr settings", "name": "TimeShiftedTvPartnerSettingsNegativeBufferSent" }, { "code": "5025", "description": "The system didn't find any CDN partner -related settings for the group account", "name": "CDNPartnerSettingsNotFound" }, { "code": "6000", "description": "The price shown for the item in the request is not the actual price.", "name": "IncorrectPrice" }, { "code": "6001", "description": "This PPVModule does not belong to the item.", "name": "UnKnownPPVModule" }, { "code": "6002", "description": "The specified credit card has expired.", "name": "ExpiredCard" }, { "code": "6003", "description": "Cellular Permissions Error", "name": "CellularPermissionsError" }, { "code": "6004", "description": "The billing provider specified is not a recognized provider.", "name": "UnKnownBillingProvider" }, { "code": "6005", "description": "The mandatory Payment Gateway ID field is missing from the request.", "name": "PaymentGatewayIdRequired" }, { "code": "6006", "description": "The mandatory Payment Gateway settings field is missing from the request.", "name": "PaymentGatewayParamsRequired" }, { "code": "6007", "description": "There's no Payment Gateway set up for this household.", "name": "PaymentGatewayNotSetForHousehold" }, { "code": "6008", "description": "The requested Payment Gateway doesn't exist.", "name": "PaymentGatewayNotExist" }, { "code": "6009", "description": "The mandatory Payment Gateway charge ID field is missing from the request.", "name": "PaymentGatewayChargeIdRequired" }, { "code": "6011", "description": "The configuration for the credit card clearing has not been set.", "name": "NoConfigurationFound" }, { "code": "6012", "description": "The adapter failed to complete the request.", "name": "AdapterAppFailure" }, { "code": "6013", "description": "The signature provide doesn't match the signature on record.", "name": "SignatureMismatch" }, { "code": "6014", "description": "An error occurred while trying to save the Payment Gateway transaction.", "name": "ErrorSavingPaymentGatewayTransaction" }, { "code": "6015", "description": "An error occurred while trying to save the pending Payment Gateway", "name": "ErrorSavingPaymentGatewayPending" }, { "code": "6016", "description": "The mandatory external identifier field is missing from the request.", "name": "ExternalIdentifierRequired" }, { "code": "6017", "description": "An error occurred while trying to set a Payment Gateway for this household.", "name": "ErrorSavingPaymentGatewayHousehold" }, { "code": "6018", "description": "No Payment Gateway specified in the request.", "name": "NoPaymentGateway" }, { "code": "6020", "description": "The mandatory Payment Gateway name field is missing from the request.", "name": "PaymentGatewayNameRequired" }, { "code": "6021", "description": "The mandatory Payment Gateway shared secret field is missing from the request.", "name": "PaymentGatewaySharedSecretRequired" }, { "code": "6024", "description": "The household is already set to a Payment Gateway.", "name": "HouseholdAlreadySetToPaymentGateway" }, { "code": "6025", "description": "The charge ID was already set for the household Payment Gateway.", "name": "ChargeIdAlreadySetToHouseholdPaymentGateway" }, { "code": "6026", "description": "There's no charge ID set for this household.", "name": "ChargeIdNotSetToHousehold" }, { "code": "6027", "description": "There's no Payment Gateway set for this household.", "name": "HouseholdNotSetToPaymentGateway" }, { "code": "6028", "description": "The multiple Payment Gateway selection feature is disabled.", "name": "PaymentGatewaySelectionIsDisabled" }, { "code": "6030", "description": "The Payment Gateway failed to respond to the request because of a problem with the Payment Gateway adapter.", "name": "NoResponseFromPaymentGateway" }, { "code": "6031", "description": "The account specified is invalid: there is a problem with the Payment Gateway adapter.", "name": "InvalidAccount" }, { "code": "6032", "description": "The payment method selected doesn't have sufficient funds for the transaction requested.", "name": "InsufficientFunds" }, { "code": "6033", "description": "An unknown error occurred with the Payment Gateway adapter.", "name": "UnknownPaymentGatewayResponse" }, { "code": "6034", "description": "", "name": "PaymentGatewayAdapterUserKnown" }, { "code": "6035", "description": "", "name": "PaymentGatewayAdapterReasonUnknown" }, { "code": "6036", "description": "The payment method signatures don't match.", "name": "SignatureDoesNotMatch" }, { "code": "6037", "description": "An error occurred when updating the pending transaction.", "name": "ErrorUpdatingPendingTransaction" }, { "code": "6038", "description": "The requested Payment Gateway transaction was not found.", "name": "PaymentGatewayTransactionNotFound" }, { "code": "6039", "description": "This transaction isn't in a Pending state.", "name": "PaymentGatewayTransactionIsNotPending" }, { "code": "6040", "description": "External identifier must be unique.", "name": "ExternalIdentifierMustBeUnique" }, { "code": "6041", "description": "Unable to complete the request: there's no new Payment Gateway to insert.", "name": "NoPaymentGatewayToInsert" }, { "code": "6042", "description": "The transaction's state is currently unknown.", "name": "UnknownTransactionState" }, { "code": "6043", "description": "The specified Payment Gateway is not valid.", "name": "PaymentGatewayNotValid" }, { "code": "6044", "description": "The mandatory household field is missing from the request.", "name": "HouseholdRequired" }, { "code": "6045", "description": "The Payment Gateway adapter failed for an unknown reason.", "name": "PaymentGatewayAdapterFailReasonUnknown" }, { "code": "6046", "description": "The partner configuration pair (type and configuration value) you've asked to update is an empty pair.", "name": "NoPartnerConfigurationToUpdate" }, { "code": "6047", "description": "The configuration value being updated is empty.", "name": "NoConfigurationValueToUpdate" }, { "code": "6048", "description": "No payment method was set for this household.", "name": "PaymentMethodNotSetForHousehold" }, { "code": "6049", "description": "The selected payment method doesn't exist.", "name": "PaymentMethodNotExist" }, { "code": "6050", "description": "The mandatory payment method ID field is missing from the request.", "name": "PaymentMethodIdRequired" }, { "code": "6051", "description": "The mandatory payment method external ID field is missing from the request.", "name": "PaymentMethodExternalIdRequired" }, { "code": "6052", "description": "An error occurred while trying to save the payment method of the household Payment Gateway. Please try again.", "name": "ErrorSavingPaymentGatewayHouseholdPaymentMethod" }, { "code": "6054", "description": "A payment method was already set for the household Payment Gateway.", "name": "PaymentMethodAlreadySetToHouseholdPaymentGateway" }, { "code": "6055", "description": "The mandatory payment method name field is missing in the request.", "name": "PaymentMethodNameRequired" }, { "code": "6056", "description": "The Payment Gateway doesn't support this payment method.", "name": "PaymentGatewayNotSupportPaymentMethod" }, { "code": "7000", "description": "A conflict has occurred.", "name": "Conflict" }, { "code": "7001", "description": "Minimum friends limitation", "name": "MinFriendsLimitation" }, { "code": "8000", "description": "The updated or new notification settings weren't received by the Web service because of an internal error.", "name": "NoNotificationSettingsSent" }, { "code": "8001", "description": "Push notifications are disabled.", "name": "PushNotificationFalse" }, { "code": "8002", "description": "The updated or new partner notification settings weren't received by the Web service because of an internal error.", "name": "NoNotificationPartnerSettings" }, { "code": "8003", "description": "The updated or new notification settings weren't received by the Web service because of an internal error.", "name": "NoNotificationSettings" }, { "code": "8004", "description": "The mandatory message field in the announcement message Is empty.", "name": "AnnouncementMessageIsEmpty" }, { "code": "8005", "description": "The announcement start time is invalid. Please check and try again.", "name": "AnnouncementInvalidStartTime" }, { "code": "8006", "description": "The announcement requested couldn't be found.", "name": "AnnouncementNotFound" }, { "code": "8007", "description": "Unable to update the announcement; the announcement was already sent.", "name": "AnnouncementUpdateNotAllowed" }, { "code": "8008", "description": "The announcement time zone is invalid (for example \"UTC\" or \"Pacific Standard Time\").", "name": "AnnouncementInvalidTimezone" }, { "code": "8009", "description": "This feature is disabled.", "name": "FeatureDisabled" }, { "code": "8010", "description": "The announcement message exceeds the permitted message length.", "name": "AnnouncementMessageTooLong" }, { "code": "8011", "description": "An error occurred while creating the announcement.", "name": "FailCreateAnnouncement" }, { "code": "8012", "description": "The user is not following this series.", "name": "UserNotFollowing" }, { "code": "8013", "description": "The user is already following the requested series.", "name": "UserAlreadyFollowing" }, { "code": "8014", "description": "The message placeholder is invalid.", "name": "MessagePlaceholdersInvalid" }, { "code": "8015", "description": "The message date-time format Is Invalid.", "name": "DatetimeFormatIsInvalid" }, { "code": "8016", "description": "Unable to find the message template.", "name": "MessageTemplateNotFound" }, { "code": "8017", "description": "The URL placeholder specified is invalid.", "name": "URLPlaceholdersInvalid" }, { "code": "8018", "description": "Invalid message TTL", "name": "InvalidMessageTTL" }, { "code": "8019", "description": "The mandatory message ID field is missing in the request.", "name": "MessageIdentifierRequired" }, { "code": "8020", "description": "Requested inbox message was not found.", "name": "UserInboxMessagesNotExist" }, { "code": "9000", "description": "Invalid price code: The price code entered doesn't exist for this account", "name": "InvalidPriceCode" }, { "code": "9001", "description": "The value specified, such as FullLifeCycle/ ViewLifeCycle, is invalid", "name": "InvalidValue" }, { "code": "9002", "description": "Invalid discount code: The discount code entered doesn't exist for this account", "name": "InvalidDiscountCode" }, { "code": "9003", "description": "Invalid price plan: The price plan entered isn't in use with this account", "name": "InvalidPricePlan" }, { "code": "9004", "description": "The billing code entered must be unique", "name": "CodeMustBeUnique" }, { "code": "9005", "description": "The billing code entered doesn't exist", "name": "CodeNotExist" }, { "code": "9006", "description": "The code entered is invalid", "name": "InvalidCodeNotExist" }, { "code": "9008", "description": "Invalid channel: This channel doesn't exist in this account", "name": "InvalidChannels" }, { "code": "9009", "description": "Invalid file type: This file type doesn't exist for this account", "name": "InvalidFileTypes" }, { "code": "9010", "description": "Invalid preview module: The preview module doesn't exist in this account", "name": "InvalidPreviewModule" }, { "code": "9011", "description": "Mandatory fields in a request must be completed", "name": "MandatoryField" }, { "code": "9012", "description": "", "name": "UniqueFiled" }, { "code": "9013", "description": "The usage module specified related to PPV doesn't exist in this account", "name": "InvalidUsageModule" }, { "code": "9014", "description": "Invalid coupon group: The coupon group specified doesn't exist in this account", "name": "InvalidCouponGroup" }, { "code": "9015", "description": "Invalid currency: The currency specified is not configured for this account", "name": "InvalidCurrency" }, { "code": "9016", "description": "The PPV module doesn't exist in the database", "name": "ModuleNotExists" }, { "code": "9017", "description": "The price plan doesn't exist in the database", "name": "PricePlanDoesNotExist" }, { "code": "9018", "description": "The price details doesn't exist in the database", "name": "PriceDetailsDoesNotExist" }, { "code": "10000", "description": "The adapter you're trying to connect doesn't exist", "name": "AdapterNotExists" }, { "code": "10001", "description": "The mandatory adapter ID field is missing from the request", "name": "AdapterIdentifierRequired" }, { "code": "10002", "description": "", "name": "AdapterIsRequired" }, { "code": "10003", "description": "", "name": "NoAdapterToInsert" }, { "code": "11000", "description": "The XML is formatted incorrectly. Please check the file for format errors", "name": "IllegalXml" }, { "code": "11001", "description": "The external ID is missing", "name": "MissingExternalIdentifier" }, { "code": "11002", "description": "The Ingest type is not known", "name": "UnknownIngestType" }, { "code": "11003", "description": "The EPG program dates specified are incorrectly formatted", "name": "EPGSProgramDatesError" }, { "code": "500003", "message": "Bad request", "name": "BadRequest" }, { "code": "500057", "message": "Invalid version [@version@]", "name": "InvalidVersion" }, { "code": "500004", "message": "Service Forbidden", "name": "ServiceForbidden" }, { "code": "500051", "message": "Action [@action@] is forbidden for property [@type@].[@property@]", "name": "PropertyActionForbidden" }, { "code": "500052", "message": "Argument [@argument@] in action [@service@].[@action@] is forbidden", "name": "ActionArgumentForbidden" }, { "code": "500015", "message": "Invalid KS format", "name": "InvalidKS" }, { "code": "500016", "message": "KS expired", "name": "ExpiredKS" }, { "code": "500008", "message": "Partner invalid", "name": "PartnerInvalid" }, { "code": "500017", "message": "Invalid refresh token", "name": "InvalidRefreshToken" }, { "code": "500034", "message": "Refresh token failed", "name": "RefreshTokenFailed" }, { "code": "500035", "message": "Invalid user [@id@]", "name": "UnauthorizedUser" }, { "code": "500060", "message": "Invalid UDID [@id@]", "name": "InvalidUdid" }, { "code": "500011", "message": "Service [@service@] not found", "name": "InvalidService" }, { "code": "500012", "message": "Action [@service@.@action@] not found", "name": "InvalidAction" }, { "code": "500033", "message": "Action not specified", "name": "ActionNotSpecified" }, { "code": "500054", "message": "Invalid action parameter [@parameter@]", "name": "InvalidActionParameter" }, { "code": "500013", "message": "Invalid action parameters", "name": "InvalidActionParameters" }, { "code": "50026", "message": "Argument [@argument@] is invalid", "name": "InvalidArgument" }, { "code": "500031", "message": "Argument [@argument@] must be numeric", "name": "ArgumentMustBeNumeric" }, { "code": "50027", "message": "Argument [@argument@] cannot be empty", "name": "ArgumentCannotBeEmpty" }, { "code": "500036", "message": "Argument [@argument@] is not writeable", "name": "ArgumentReadonly" }, { "code": "500037", "message": "Argument [@argument@] is not updateable", "name": "ArgumentInsertonly" }, { "code": "500041", "message": "Enumerator value [@value@] is not supported for argument [@argument@]", "name": "EnumValueNotSupported" }, { "code": "500044", "message": "Argument [@argument@] values must be of type [@enum@]", "name": "ArgumentShouldBeEnum" }, { "code": "500058", "message": "Argument [@argument@] values must have minimum value of [@value@]", "name": "ArgumentShouldContainMinValueCrossed" }, { "code": "500059", "message": "Argument [@argument@] values must have max value of [@value@]", "name": "ArgumentShouldContainMaxValueCrossed" }, { "code": "500056", "message": "One of the arguments [@arguments@] must have a value", "name": "ArgumentsCannotBeEmpty" }, { "code": "500038", "message": "Only one of @argument1@ or @argument2@ can be used, not both of them", "name": "ArgumentsConflictsEachOther" }, { "code": "500039", "message": "Argument [@argument@] time have passed", "name": "TimeInPast" }, { "code": "500045", "message": "Argument [@argument@] maximum length is [@value@]", "name": "ArgumentMaxLengthCrossed" }, { "code": "500046", "message": "Argument [@argument@] minimum length is [@value@]", "name": "ArgumentMinLengthCrossed" }, { "code": "500047", "message": "Argument [@argument@] maximum value is [@value@]", "name": "ArgumentMaxValueCrossed" }, { "code": "500048", "message": "Argument [@argument@] minimum value is [@value@]", "name": "ArgumentMinValueCrossed" }, { "code": "500061", "message": "Argument [@argument1@] value conflicts Argument [@argument2@] value", "name": "ArgumentsConflictEachOther" }, { "code": "500029", "message": "Media ids must be numeric", "name": "MediaIdsMustBeNumeric" }, { "code": "500030", "message": "EPG internal ids must be numeric", "name": "EpgInternalIdsMustBeNumeric" }, { "code": "500032", "message": "Argument [@argument@] cannot be empty or all", "name": "ListTypeCannotBeEmptyOrAll" }, { "code": "500049", "message": "Duplicate asset: id [@id@] type = [@type@]", "name": "DuplicateAsset" }, { "code": "500050", "message": "Duplicate file: id [@id@]", "name": "DuplicateFile" }, { "code": "500062", "message": "Unable to create household for role", "name": "UnableToCreateHouseholdForRole" }, { "code": "500028", "message": "Household [@household@] forbidden", "name": "HouseholdForbidden" }, { "code": "50024", "message": "Switching users is not allowed for partner", "name": "SwitchingUsersIsNotAllowedForPartner" }, { "code": "50023", "message": "Application-token [@id@] is not active", "name": "NotActiveAppToken" }, { "code": "50022", "message": "Invalid application-token hash", "name": "InvalidAppTokenHash" }, { "code": "50021", "message": "Application-token is expired", "name": "ExpiredAppToken" }, { "code": "7013", "message": "Action not allowed due to roleId [@roleId@]", "name": "NotAllowed" }, { "code": "1", "message": "error", "name": "Error" }, { "code": "500006", "message": "Missing configuration [@configuration@]", "name": "MissingConfiguration" }, { "code": "500007", "message": "@objectType@ not found", "name": "NotFound" }, { "code": "500055", "message": "@objectType@ id [@id@] not found", "name": "ObjectIdNotFound" }, { "code": "50025", "message": "Invalid multirequest token", "name": "InvalidMultirequestToken" }, { "code": "500018", "message": "Abstract parameter type [@type@]", "name": "AbstractParameter" }, { "code": "500053", "message": "Missing parameter [@parameter@]", "name": "MissingParameter" }, { "code": "500042", "message": "Invalid multirequest token, response index is not zero based", "name": "MultirequestIndexNotZeroBased" }, { "code": "500043", "message": "Invalid multirequest token, invalid response index", "name": "MultirequestInvalidIndex" } ] }