actionPOSTv1.0.0
activateSaveOffer
Activates the discount for a user. Only Stripe platform is currently supported.
actionPOSTv1.0.0
addPaymentMethod
Add a new payment method to an account.
actionPOSTv1.0.0
assignMsisdn
Assigns a msisdn to a profile on ITV side.
actionPOSTv1.0.0
authorizeDevice
Authorize a device from a generated device authorization code. This is the second step in the process of authorizing a device by pin code. Firstly the device must request a generated authorization code via the `/authorization/device/code` endpoint. This endpoint then authorizes the device associated with the code to sign in to a user account. Typically this endpoint will be called from a page presented in the web app under the account section. Once authorized, the device will then be able to sign in to that account via the `/authorization/device` endpoint, without needing to provide the credentials of the user.
actionDELETEv1.0.0
cancelSubscription
Cancel a plan subscription. A cancelled subscription will continue to be valid until the subscription expiry date or next renewal date.
actionPOSTv1.0.0
changeEmail
Change email address related to account/profile. The expected token scope is Settings.
actionPOSTv1.0.0
changeMarketing
Change marketing preferences related to account/profile. The expected token scope is Settings.
actionGETv1.0.0
checkEeBtEligibility
Check whether or not a user is eligible for switching to Bt or EE offers.
actionGETv1.0.0
checkPreviousEntitlements
Check whether the user has been previously entitled.
actionPOSTv1.0.0
checkVoucher
Validates the coupon/voucher for specified payment platform.
actionPOSTv1.0.0
confirmPurchase
Confirms purchase and returns the details of purchased subscription for specified payment platform.
actionPOSTv1.0.0
confirmPurchaseStrong
Confirms purchase and returns the details of purchased subscription for specified payment platform.
actionPOSTv1.0.0
confirmPurchaseWithOffer
Confirms purchase and returns the details of purchased subscription for specified payment platform.
actionPUTv1.0.0
createPinRequest
Creates a PIN request that will send an SMS to the given msisdn. This call is to validate MSISDN entered by a user not comming through EE network. This call should be followed by POST ee/pin.
actionPOSTv1.0.0
createProfile
Create a new profile under the active account.
actionDELETEv1.0.0
delete_itv_purchase_platform
Cancel a plan subscription. A cancelled subscription will continue to be valid until the subscription expiry date or next renewal date.
actionPOSTv1.0.0
deleteAccount
Delete account in compliance with GDPR. The expected token scope is Settings.
actionDELETEv1.0.0
deleteItemBookmark
Unbookmark an item under the active profile.
actionDELETEv1.0.0
deleteProfileWithId
Delete a profile with a specific id under the active account. Note that you cannot delete the primary profile.
actionDELETEv1.0.0
deleteWatched
Remove the watched status of items under the active profile. Passing in specific `itemId`s to the `item_ids` query parameter will cause only these items to be removed. **If this list is missing all watched items will be removed**
actionPOSTv1.0.0
executeTransaction
Sends request to execute specified transaction.
actionPOSTv1.0.0
forgotPassword
Request the password of an account's primary profile be reset. Should be called when a user has forgotten their password. This will send an email with a password reset link to the email address of the primary profile of an account. The link, once clicked, should take the user to the "reset-password" page of the website. Here they will enter their new password and submit to the /reset-password endpoint here, along with the password reset token provided in the original link.
actionPOSTv1.0.0
generateDeviceAuthorizationCode
Get a generated device authorization code. This is the first step in the process of authorizing a device by pin code. The device will make a request to this endpoint providing a unique identifier for the device such as a serial number. This endpoint will then return a generated code which is tied to the given device. The code may subsequently be used to authorize the device to sign in to an account via the `/account/devices/authorization` endpoint. Typically this will be from a page presented in the web app under the account section. Once authorized, the device will then be able to sign in to that account via the `/authorization/device` endpoint, without needing to provide the credentials of the user.
actionGETv1.0.0
generateNonce
Generate a new account nonce. A nonce may be required to help sign a response from a third party service which will be passed back to these services. For example a Facebook single-sign-on request initiated by a client application may first get a nonce from here to include in the request. Facebook will then include the nonce in the auth token it issues. This token can be passed back to our services and the nonce checked for validity.
actionGETv1.0.0
get_ee_plans
Returns all the plans available for EE flow including additional description data.
actionGETv1.0.0
get_itv_itemsummary_externalId
Redirects to corresponding Axis Item details page.
actionGETv1.0.0
get_itv_plans_platform
Returns the plans available for specified payment platform.
actionGETv1.0.0
get_itv_profile
Returns the ITV profile object.
actionGETv1.0.0
get_itv_roku_plans
Gets available Roku plans.
actionGETv1.0.0
get_plans_id
Returns the details of a Plan with the specified id.
actionGETv1.0.0
getAccount
Get the details of an account along with the profiles and entitlements under it.
actionGETv1.0.0
getAnonNextPlaybackItem
Identical to GET /account/profile/items/{itemId}/next route but for users that are not logged in i.e. this endpoint does not require authorisation
actionGETv1.0.0
getAppConfig
Get the global configuration for an application. Should be called during app statup. This includes things like device and playback rules, classifications, sitemap and subscriptions. You have the option to select specific configuration objects using the 'include' parameter, or if unspecified, getting all configuration.
actionPOSTv1.0.0
getBillingHistory
Returns the list of billing records for specified payment platform.
actionGETv1.0.0
getBookmarkList
Returns the list of bookmarked items under the active profile.
actionGETv1.0.0
getBookmarks
Get the map of bookmarked item ids (itemId => creationDate) under the active profile.
actionPOSTv1.0.0
getCardDetails
Get payment card details.
actionGETv1.0.0
getContinueWatchingList
Returns a list of items which have been watched but not completed under the active profile. Multiple episodes under the same show may be watched or in progress, however only a single item belonging to a particular show will be included in the returned list. The next episode to continue watching for a particular show will be the most recent incompletely watched episode, or the next episode following the most recently completely watched episode. Based on the specified `show_item_type` type, either the next episode, the season of the next episode, or the show will be included in the list.
actionGETv1.0.0
getCurrentEntitlement
Returns current entitlement.
actionGETv1.0.0
getCurrentSubscription
Returns the details of current subscription for specified payment platform.
actionGETv1.0.0
getDevice
Get a registered device.
actionGETv1.0.0
getDevices
Get all devices registered under this account. Also includes information around device registration and deregistration limits.
actionPOSTv1.0.0
getEligibleOffers
Returns eligible partner specific offers for the querying partner for an EE MSISDN. This call is supposed to be called after we have MSISDN accired. This call should be followed by POST /ee/msisdn.
actionGETv1.0.0
getEntitlements
Get all entitlements under the account. This list is returned under the call to get account information so a call here is only required when wishing to refresh a local copy of entitlements.
actionGETv1.0.0
getEntitlementsHistory
Returns the state of subscription for any payment platform.
actionGETv1.0.0
getFeatureFlag
Gets info whether or not a feature is enabled or disabled using a feature flag. Feature flags are set as a custom field within PM. It also supports custom feature flag data if needed. Such data can be return as well.
actionGETv1.0.0
getFullPriceRenewal
Returns full price renewal state and reason for specific user.
actionGETv1.0.0
getItem
Returns the details of an item with the specified id.
actionGETv1.0.0
getItemBookmark
Get the bookmark for an item under the active profile.
actionGETv1.0.0
getItemChildrenList
Returns the List of child summary items under an item. If the item is a Season then the children will be episodes and ordered by episode number. If the item is a Show then the children will be Seasons and ordered by season number. Returns 404 if no children found.
actionGETv1.0.0
getItemMediaFiles
Get the video files associated with an item given maximum resolution, device type and one or more delivery types. This endpoint accepts an Account Catalog token, however if when requesting playback files you receive an *403 status code with error code 1* then the file you're requesting is classification restricted. This means you should switch to target the `/account/items/{id}/videos-guarded` endpoint, passing it an Account Playback token. If not already obtained, this token can be requested via the `/itv/pinauthorization` endpoint with an account level pin. For convenience you may also access free / public files through this endpoint instead of the /items/{id}/videos endpoint, when authenticated. Returns an array of video file objects which each include a url to a video. The first entry in the array contains what is predicted to be the best match. The remainder of the entries, if any, may contain resolutions below what was requests. For example if you request HD-720 the response may also contain SD entries. If you specify multiple delivery types, then the response array will insert types in the order you specify them in the query. For example `stream,progressive` would return an array with 0 or more stream files followed by 0 or more progressive files. If no files are found a 404 is returned.
actionGETv1.0.0
getItemMediaFilesGuarded
Get the video files associated with an item given maximum resolution, device type and one or more delivery types. This endpoint is identical to the `/account/items/{id}/videos` however it expects an Account Playback token. This token, and in association this endpoint, is specifically for use when playback files are classification restricted and require an account level pin to access them. Returns an array of video file objects which each include a url to a video. The first entry in the array contains what is predicted to be the best match. The remainder of the entries, if any, may contain resolutions below what was requests. For example if you request HD-720 the response may also contain SD entries. If you specify multiple delivery types, then the response array will insert types in the order you specify them in the query. For example `stream,progressive` would return an array with 0 or more stream files followed by 0 or more progressive files. If no files are found a 404 is returned.
actionGETv1.0.0
getItemRating
Get the rating info for an item under the active profile.
actionGETv1.0.0
getItemRelatedList
Returns the list of items related to the parent item. Note for now, due to the size of the list being unknown, only a single page will be returned.
actionPOSTv1.0.0
getItemsMediaClipFiles
Get the media clip files associated with items.
actionGETv1.0.0
getItemWatchedStatus
Get the watched status info for an item under the active profile.
actionGETv1.0.0
getItvPage
Returns a page with the specified id. This is a cut down version for low memory devices.123 If targeting the search page you must url encode the search term as a parameter using the `q` key. For example if your browser path looks like `/search?q=the` then what you pass to this endpoint would look like `/itv/page?path=/search%3Fq%3Dthe`.
actionGETv1.0.0
getList
Returns a list of items under the specified item list
actionGETv1.0.0
getLists
Returns an array of item lists with their first page of content resolved.
actionGETv1.0.0
getNextPlaybackItem
Returns the next item to play given a source item id. For an unwatched show it returns the first episode available to the account. For a watched show it returns the last incompletely watched episode by the profile, or the episode that immediately follows the last completely watched episode or nothing. For an episode it always returns the immediately following episode, if available to the account, or nothing. If the response does not contain a `next` property then no item was found.
actionGETv1.0.0
getPage
Returns a page with the specified id. If targeting the search page you must url encode the search term as a parameter using the `q` key. For example if your browser path looks like `/search?q=the` then what you pass to this endpoint would look like `/page?path=/search%3Fq%3Dthe`.
actionGETv1.0.0
getPaymentMethod
Get a payment method under an account.
actionGETv1.0.0
getPaymentMethods
Get the available payment methods under an account.
actionGETv1.0.0
getPlan
Returns the plan description for EE flow including additional description data.
actionGETv1.0.0
getPlans
Returns all the plans available for BT flow including additional description data.
actionGETv1.0.0
getProfile
Get the details of the active profile, including watched, bookmarked and rated items.
actionGETv1.0.0
getProfileWithId
Get the summary of a profile with a specific id under the active account.
actionGETv1.0.0
getPublicItemMediaFiles
Get the free / public video files associated with an item given maximum resolution, device type and one or more delivery types. Returns an array of video file objects which each include a url to a video. The first entry in the array contains what is predicted to be the best match. The remainder of the entries, if any, may contain resolutions below what was requests. For example if you request HD-720 the response may also contain SD entries. If you specify multiple delivery types, then the response array will insert types in the order you specify them in the query. For example `stream,progressive` would return an array with 0 or more stream files followed by 0 or more progressive files. If no files are found a 404 is returned.
actionGETv1.0.0
getPublicPreview
Returns public preview for Samsung based on the page '/samsung-preview' configured in PresentationManager. There is a hard limit of max 40 items to be returned. It splits evenly items count into the page rows, remaining items are added into the first row.
actionGETv1.0.0
getPurchases
Get a list of all purchases made under an account.
actionGETv1.0.0
getRatings
Get the map of rated item ids (itemId => rating out of 10) under the active profile.
actionGETv1.0.0
getRatingsList
Returns the list of rated items under the active profile.
actionGETv1.0.0
getRecommendedList
Get the list of recommended items under the active profile.
actionGETv1.0.0
getSaveOffer
Checks the provided coupon id for a user. Only Stripe platform is currently supported.
actionGETv1.0.0
getSchedules
Returns schedules for a defined set of channels over a requested period. Schedules are requested in hour blocks and returned grouped by the channel they belong to. For example, to load 12 hours of schedules for channels `4343` and `5234`, on 21/2/2017 starting from 08:00. ``` channels=4343,5234 date=2017-02-21 hour=8 duration=12 ``` Please remember that `date` and `hour` combined represent a normal datetime, so they should be converted to UTC on the client - this will help to avoid issues with EPG schedules near midnight. If a channel id is passed which doesn't exist then this endpoint will return an empty schedule list for it. If instead we returned 404, this would invalidate all other channel schedules in the same request which would be unfriendly for clients presenting these channel schedules.
actionGETv1.0.0
getSubscriptionData
Returns the details of subscription data for a user with specified id.
actionGETv1.0.0
getSubscriptionState
Returns the state of subscription for any payment platform.
actionGETv1.0.0
getSubscriptionStatus
Returns status of latest payment intent.
actionGETv1.0.0
getUpcomingInvoice
Returns an upcoming invoice
actionGETv1.0.0
getVoucherById
Checks the provided coupon id for a user. Only Stripe platform is currently supported.
actionGETv1.0.0
getWatched
Get the map of watched item ids (itemId => last playhead position) under the active profile.
actionGETv1.0.0
getWatchedList
Returns the list of watched items under the active profile.
actionPOSTv1.0.0
googlePaySubscription
Get the list of recommended items under the active profile.
actionPOSTv1.0.0
makePurchase
Purchase a plan or item offer. The result of a successful transaction is a new entitlement.
actionPOSTv1.0.0
register
Register a new user, creating them an account. Registration, when successful, will return an array of access tokens so the user is immediately signed in. It returns Catalog and Commerce scoped tokens for both Account and Profile. The Commerce ones are intended to allow the purchase of a subscription plan in the step after registration, without the user being prompted to enter their username and password again. An email will also be sent with a link they need to click to confirm their email address. This confirmation is done via the /verify-email endpoint.
actionPOSTv1.0.0
registerDevice
Register a playback device under an account. If a device with the same id already exists a `409` conflict will be returned.
actionPOSTv1.0.0
requestEmailVerification
Request that the email address tied to an account be verified. This will send a verification email to the email address of the primary profile containing a link which, once clicked, completes the verification process via the /verify-email endpoint. Note that when an account is created this email is sent automatically so there's no need to call this directly. If the user doesn't click the link before it expires then this endpoint can be called to request a new verification email. In the future it may also be used if we add support for changing an account email address.
actionPOSTv1.0.0
resetPassword
When a user requests to reset their password via the /request-password-reset endpoint, an email is sent to the email address of the primary profile of the account. This email contains a link with a reset token as query parameter. The link should take the user to the "reset-password" page of the website. From the reset-password page a user should enter the new password they wish to use. It should then be submitted to this endpoint, along with the reset token from the email link. The token should be provided in the body as resetToken property.
actionPOSTv1.0.0
resubscribe
Resubscription for a user.
actionGETv1.0.0
search
Search the catalog of items and people.
actionPOSTv1.0.0
singleSignOn
Exchange a third party single-sign-on token for our own authorization tokens.
actionPATCHv1.0.0
updateAccount
Update the details of an account. With the exception of the address, this supports partial updates, so you can send just the properties you wish to update. When the address is provided any properties which are omitted from the address will be cleared.
actionPUTv1.0.0
updatePaymentIntentStrong
Change payment method details.
actionPUTv1.0.0
updatePaymentMethodStrong
Change payment method details.
actionPUTv1.0.0
updateProfile
Update ITV profile. The expected token scope is Settings.
actionPATCHv1.0.0
updateProfileWithId
Update the summary of a profile with a specific id under the active account. This supports partial updates so you can send just the properties you wish to update.
actionPUTv1.0.0
updateSubscription
Renew a cancelled subscription or switch subscription to a different plan. When renewing a cancelled subscription membership, hit this endpoint with the id of subscription to renew. To switch plans provide the id of the current active subscription membership of the account, and in the query specify the id of the plan to switch to.
actionPOSTv1.0.0
upgradePlan
Upgrades the plan for the current user.
actionPOSTv1.0.0
validatePinRequest
Validate PIN request created by calling POST /ee/pin This call is to validate MSISDN entered by a user not comming through EE network. This call should be called after PUT /ee/pin. This call should be followed by POST /ee/offers.
actionPOSTv1.0.0
verifyEmail
When an account is created an email is sent to the email address of the new account. This contains a link, which once clicked, verifies the email address of the account is correct. The link contains a token as a query parameter which should be passed as the authorization bearer token to this endpoint to complete email verification. The token has en expiry, so if the link is not clicked before it expires, the account holder may need to request a new verification email be sent. This can be done via the endpoint /account/request-email-verification.
Beyond the catalog
Any provider, on request.
01
Request it
Tell us which provider you need, and we will ship it in the registry.
02
Generate it
Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.
acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec