{
  story: Story
}

{
	"state" : "inactive" | "active",
  	"message": "last subscription response message",
  	"eligibleForStorePurchase", true | false,
  	"eligibleForSubscriptionUpgrade", true | false,
  	"store": "googleplay" | "amazon" | "itunes",
  	"userInfo" : {
    	userInfo response key-value pairs
  	},
  	"token": String
}

{ 
	"editionId" : String
}

{ 
	"editionId" : String
}

{
   	"type": String,
   	"action": “gotoSaved”  | “openAudioQueue” | null,
} 

• type is mandatory and must have matching theme keys within the config to appear.
• action in an enum more actions can be added with native work

[{
	"x" : Integer,
	"y": Integer,
	"w": Integer,
	"h": Integer
}]

You can have as many areas in a single call as you need. Calling forwardTouchesWithin adds the areas to the existing areas. Clear all areas with the clearForwardTouchesWithin bridge.

{
  "feedId1" : true | false,
  "feedId2": true | false,

  …
}

{ 
  	"stringId": String,
  	"datetime" : String
}

datetime must be an ISO-8601 format string

Date or time string with given id using the specified ISO-8601 format. The string can contain {{date}}, {{time}} or {{datetime}} and the appropriate format will be substituted.

Web additionally is able to process params but ios/android are not.

{ 
 	"stringId": String,
 	"quantity" : Integer,
 	"params" : [ String ]
}

params is optional

{ 
 	"stringId": String,
 	"datetime" : String,
 	"params" : [ String ]
}

params is optional

datetime must be an ISO-8601 format string

Relative time string with given id using the specified ISO-8601 format, parameters substituted as appropriate.

If the time is within 60 seconds, it uses the string key relative_date_now for the value. If the time is within 7 days, it's a relatively formatted value. If it's within the current year, it's a short day month string. Otherwise. it's a full absolute date.

{
 	"stringId": String, 
 	"params" : [ String ]
}

params is optional

{ 
 	"stringId": String
}

String with given id with price values substituted.

TODO: more detail

{
	"editionId" : String,
	"partition" : String,
	"autoDownload" : Bool,
	"skipTimeline": Bool
}

partition is optional

autoDownload is optional and defaults to true.

skipTimeline is optional and defaults to false.

{
  	"initialImage" : Integer,
  	"images" : [
    	{
      		"src": "relative-src-url",
      		"caption" : "caption-message",
      		"copyright": "copyright-message"
    	}
  	]
}

initialImage is the index to display first. You can have as many images as you like. All text fields must be defined, but can be blank.

 {
   	"url": URL,
   	"story?": Story,
   	"index?": Integer,
   	"action?": “openActions” | “playNow” | “playNext” | “addToQueue”, 
   	"title": String,
   	"subtitle?": String,
   	"artist?": String,
   	"album?": String,
   	"genre?": String,
   	"image?": String,
   	"url_source?": String,
   	"url_user?": String,
   	"length?": Integer,
   	"length_formatted?": String,
   	"pugpig_audio_source?": String,
   	"pugpig_audio_type?": String,
} 

• url and title are mandatory.
• story is a Story object
• action can be “openActions”, “playNow”, “playNext”, “addToQueue”. Defaults to “openActions”
• image is a url to the image

{
  	"providerName" : String,
  	"parameters" : { custom parameter object },
  	"callbackName" : String
}

Parameters will depend on the specific provider and action. By convention, one of the parameters is usually “command”, and that identifies the specific action to perform.

callbackName is called when the provider action completes. Some providers may not provide a callback.

[ {
   	"url": String,
   	"title": String,
   	"story": Story,
   	"index": Integer,
   	"subtitle?": String,
   	"artist?": String,
   	"album?": String,
   	"genre?": String,
   	"image?": String,
   	"url_source?": String,
   	"url_user?": String,
   	"length?": Integer,
   	"length_formatted?": String,
   	"pugpig_audio_source?": String,
   	"pugpig_audio_type?": String,
} ]

• url, title, story and index are mandatory.
• story is a Story object
• image is a url to the image

{

  "readStories" : [

    [ feed-id, story-id ],

    [ feed-id, story-id ],

    …

  ]

}

{

  "savedStories" : [

    [feed-id, story-id],

    [feed-id, story-id],

    …

  ]

}

{ 
 	"story": Story,
 	"saved" : Bool
}

iOS saves the story is “saved” is true and removes it if “saved” is false.

Android removes the story if it is already saved, otherwise adds it.

{
	story: Story
	index: Int?
}

{
	story: Story
}

{
   	"id": String,
   	"source": {
   		“x”: Float,
     	“y”: Float,
     	“w”: Float,
     	“h”: Float
   	}
} 

• All parameters are mandatory
• id must have matching theme keys within the config to appear
• source gives an area for the tail of the tooltip to point to

{
	"editionId" : String
}

{
	"key": String,
	"value": String
}

Specify null as the value to delete the string associated with the key.

{

  "stories" : [ JSON-Array of stories ]

}

{ 
	"editionId": String
}

{
    "ref": { feed-entry },
    "progress" : 0-1,
    "state": "downloading" | "idle",
    "downloadError": "current-download-error"
}

downloadError is optional (there may be no error)

{

  "timelineType", "SavedTimeline" | "Timeline",

  "themeURL" : [ array-of-additional-CSS-files ],

  "sourceURL" : "timeline-source-url",

  "feedReference": { full-feed-reference-from-feed },

  "metadata": { global-metadata-from-feed },

  "debugLogs": true | false

}

The source URL is in the /t/feedid format.

{
	"version" : “current-timeline-version”
}

{ 
	[String:String] 
}

The dictionary filters the list of timelines. A filter matches an entry if, for every pair in the filter:

• the key exists in the entry
• the string values match, or if the value for that key is a string array, one of those string values match

The timelines automatically filter out any entry that should not be visible for a given authorisation state (e.g. "private" timelines are filtered if you are not signed in).

{

  tab parameters, 

  "baseUrl" : “base url string”,

  "filter" : [String:String],

  "css" : [URL]?,

  "theme" : [String:AnyCodable]?,

  "darkTheme" : [String:AnyCodable]?,

  "debugLogs" : Bool?,

  "dynamic_filter" : [String:AnyCodable]?,

}

The "css" array is rewritten to be config-relative

{ 
	"name" : String,
	“type”: String,
	"category" : String?,
	“param”: String?
	"paramName" : String?,
	“story”: Story?
	“index”: “Int?”
	"dimensions" : { [String:String]} ,
	“feedid” : String?,
	"storyEntry" : Object?,
 }

storyEntry and feedid are optional

*paramName is the name of a dimension, e.g. paramName: ‘pugpigEditionID’, paramName: ‘pugpigPageName', etc.

name falls back to type

paramName falls back to param

storyEntry falls back to story

{
	"name" : String,
	"category" : String,
	"param" : String,
	"dimensions" : { [String:String] }
}

category and param are optional

{

  "dateTime", "time-last-updated",

  "lastCheckedDateTime" : "time-last-checked"

}

The times are in UTC, in format yyyy-MM-ddTHH:mm:ssZ

{
	"story": Story
}

{

  "baseUrl": url,
  "localeInfo" : {
    "locale": language-region,
    "direction": "ltr" | "rtl"
  },
  "collectionSets": ["set1", "set2", ...],

  "debugLogs": true|false
}

Locale language is the ISO 639-1 language code, region is the ISO 3166-1 region code. It's legal for there to be no region.

{
  "locale" : "language-region",
  "direction": "ltr" | "rtl"

}

Language is the ISO 639-1 language code, region is the ISO 3166-1 region code. It's legal for there to be no region.