Skip to content

Latest commit

 

History

History

art19

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
index.js
index.js
 
 
openapi.json
openapi.json
 
 
package.json
package.json
 
 

README.md

@datafire/art19

Client library for ART19 Content

Installation and Usage

npm install --save @datafire/art19
let art19 = require('@datafire/art19').create({
  api_key: ""
});

.then(data => {
  console.log(data);
});

Description

The ART19 Content API conforms to the JSON-API specification. Details and examples can be found at http://jsonapi.org.

API requests MUST use the HTTP Accept header:
Accept: application/vnd.api+json

API requests MUST be authenticated using the HTTP Authorization header:
Authorization: Token token="your-token", credential="your-credential"

Actions

classification_inclusions.get

Fetch resource collection

art19.classification_inclusions.get({}, context)

Input

  • input object
    • ids[] string: Filter by ID's
    • page[number] integer: Filter by page number
    • page[size] integer: Change page size
    • sort string: Sort by created_at

Output

classification_inclusions.id.get

Fetch resource

art19.classification_inclusions.id.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: UUID

Output

classifications.get

Fetch resource collection

art19.classifications.get({}, context)

Input

  • input object
    • ids[] string: Filter by ID's
    • type string: Filter by type
    • q string: Filter by value
    • page[number] integer: Filter by page number
    • page[size] integer: Change page size
    • sort string: Sort by created_at, value, updated_at

Output

classifications.id.get

Fetch resource

art19.classifications.id.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: UUID

Output

credits.get

Fetch resource collection

art19.credits.get({}, context)

Input

  • input object
    • ids[] string: Filter by ID's
    • creditable_id string: Filter by creditable_id
    • creditable_type string: Filter by creditable_type
    • page[number] integer: Filter by page number
    • page[size] integer: Change page size
    • sort string: Sort by created_at, position, updated_at

Output

credits.id.get

Fetch resource

art19.credits.id.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: UUID

Output

episodes.get

Fetch resource collection

art19.episodes.get({}, context)

Input

  • input object
    • ids[] string: Filter by ID's
    • page[number] integer: Filter by page number
    • page[size] integer: Change page size
    • series_id string: Filter by Series
    • season_id string: Filter by Season
    • q string: Filter by title
    • year string: Filter by released_at year
    • month string: Filter by released_at month
    • rss boolean: Filter by RSS episodes only
    • sort string: Sort by created_at, released_at, released_or_created_at, sort_title, title, updated_at

Output

episodes.id.get

Fetch resource

art19.episodes.id.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: UUID

Output

episodes.id.next_sibling.get

Fetch next resource

art19.episodes.id.next_sibling.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: UUID
    • rss boolean: Filter by RSS episodes only

Output

episodes.id.previous_sibling.get

Fetch previous resource

art19.episodes.id.previous_sibling.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: UUID
    • rss boolean: Filter by RSS episodes only

Output

images.get

Fetch resource collection

art19.images.get({
  "ids[]": ""
}, context)

Input

  • input object
    • ids[] required string: Filter by ID's
    • page[number] integer: Filter by page number
    • page[size] integer: Change page size
    • sort string: Sort by created_at

Output

images.id.get

Fetch resource

art19.images.id.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: UUID

Output

media_assets.get

Fetch resource collection

art19.media_assets.get({
  "ids[]": ""
}, context)

Input

  • input object
    • ids[] required string: Filter by ID's
    • page[number] integer: Filter by page number
    • page[size] integer: Change page size
    • sort string: Sort by created_at

Output

media_assets.id.get

Fetch resource

art19.media_assets.id.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: UUID

Output

networks.get

Fetch resource collection

art19.networks.get({}, context)

Input

  • input object
    • ids[] string: Filter by ID's
    • q string: Filter by name
    • page[number] integer: Filter by page number
    • page[size] integer: Change page size
    • sort string: Sort by created_at, name, updated_at

Output

networks.id.get

Fetch resource

art19.networks.id.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: UUID

Output

people.get

Fetch resource collection

art19.people.get({}, context)

Input

  • input object
    • ids[] string: Filter by ID's
    • q string: Filter by first_name and last_name
    • page[number] integer: Filter by page number
    • exclude_ids[] integer: Filter by excluding ids
    • page[size] integer: Change page size
    • sort string: Sort by created_at, first_name, last_name, updated_at

Output

people.id.get

Fetch resource

art19.people.id.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: UUID

Output

seasons.get

Fetch resource collection

art19.seasons.get({}, context)

Input

  • input object
    • ids[] string: Filter by ID's
    • series_id string: Filter by Series
    • page[number] integer: Filter by page number
    • page[size] integer: Change page size
    • sort string: Sort by created_at, sort_title, title, updated_at

Output

seasons.id.get

Fetch resource

art19.seasons.id.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: UUID

Output

series.get

Fetch resource collection

art19.series.get({}, context)

Input

  • input object
    • ids[] string: Filter by ID's
    • network_id string: Filter by Network
    • page[number] integer: Filter by page number
    • page[size] integer: Change page size
    • q string: Filter by title
    • sort string: Sort by created_at, episode_released_at, sort_title, title, updated_at

Output

series.id.get

Fetch resource

art19.series.id.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: UUID

Output

Definitions

Classification

  • Classification object
    • data object
      • attributes object
        • created_at string
        • metadata object
        • parent_id string
        • tree_path array
          • items string
        • type string
        • updated_at string
        • value string
        • value_path string
      • id string
      • type string

ClassificationDocument

ClassificationInclusion

  • ClassificationInclusion object
    • data object
      • attributes object
        • classification_id string
        • classification_type string
        • classified_id string
        • classified_type string
        • created_at string
        • primary boolean
        • updated_at string
      • id string
      • relationships object
      • type string

ClassificationInclusionDocument

Credit

  • Credit object
    • data object
      • attributes object
        • created_at string
        • creditable_id string
        • creditable_type string
        • position integer
        • type string
        • updated_at string
      • id string
      • relationships object
      • type string

CreditDocument

  • CreditDocument object

Episode

  • Episode object
    • data object
      • attributes object
        • allow_user_comments boolean: Credential must own the series
        • cascaded_cover_image_id string
        • cover_image_id string
        • created_at string
        • description string
        • description_is_html boolean
        • description_plain string
        • file_name string
        • listen_count integer: Credential must have stats access to series
        • premium_status string
        • published boolean
        • release_immediately boolean: Credential must own the series
        • released_at string
        • rss_guid string
        • sort_title string
        • status string
        • title string
        • updated_at string
      • id string
      • relationships object
      • type string

EpisodesDocument

  • EpisodesDocument object

Image

  • Image object
    • data object
      • attributes object
        • bucket_id string
        • bucket_type string
        • created_at string
        • crop_data object
          • height number
          • left number
          • top number
          • width number
        • status string
        • updated_at string
      • id string
      • relationships object
      • type string

ImageDocument

  • ImageDocument object

Links

  • Links object
    • first string
    • last string
    • next string
    • prev string
    • self string

MediaAsset

  • MediaAsset object
    • data object
      • attributes object
        • attachment_id string
        • attachment_type string
        • cdn_url string
        • created_at string
        • file_name string
        • file_size string
        • size_height integer
        • size_width integer
        • style string
        • updated_at string
      • id string
      • type string

MediaAssetDocument

Network

  • Network object
    • data object
      • attributes object
        • copyright string
        • cover_image_id string
        • created_at string
        • description string
        • facebook_url string
        • global_id string
        • linkedin_url string
        • name string
        • public_email string
        • public_page_enabled boolean
        • slug string
        • tumblr_url string
        • twitter_url string
        • updated_at string
        • website_url string
      • id string
      • relationships object
      • type string

NetworkDocument

  • NetworkDocument object

Person

  • Person object
    • data object
      • attributes object
        • avatar_id string
        • biography string
        • born string
        • created_at string
        • died string
        • first_name string
        • from_country string
        • from_locality string
        • from_region string
        • last_name string
        • public_email string
        • updated_at string
      • id string
      • type string

PersonDocument

  • PersonDocument object

ResourceIdentifier

  • ResourceIdentifier object
    • id string
    • type string

Season

  • Season object
    • data object
      • attributes object
        • cascaded_cover_image_id string
        • cover_image_id string
        • created_at string
        • description string
        • description_is_html boolean
        • description_plain string
        • first_released_episode_id string
        • last_released_episode_id string
        • sort_title string
        • status string
        • title string
        • updated_at string
      • id string
      • relationships object
      • type string

SeasonDocument

  • SeasonDocument object

Series

  • Series object
    • data object
      • attributes object
        • cover_image_id string
        • created_at string
        • description string
        • description_is_html boolean
        • description_plain string
        • facebook_url string
        • global_id string
        • itunes_subscription_url string
        • linkedin_url string
        • podcast_subscription_url string
        • public_page_enabled boolean
        • rss_author string
        • rss_copyright string
        • rss_email string
        • rss_owner string
        • slug string
        • sort_title string
        • status string
        • stitcher_subscription_url string
        • title string
        • tumblr_url string
        • twitter_url string
        • updated_at string
        • website_url string
      • id string
      • relationships object
      • type string

SeriesDocument

  • SeriesDocument object