@guardian/content-api-models 17.4.0-beta.0 → 17.5.0-beta.0

package/crier/event/v1/eventPayload.d.ts

@@ -8,7 +8,7 @@ import { Content } from '../../../v1/content';
 import { DeletedContent } from './deletedContent';
 import { RetrievableContent } from './retrievableContent';
 import { Atom } from '@guardian/content-atom-model/atom';
-export declare type EventPayload = {
+export type EventPayload = {
     kind: "content";
     content: Content;
 } | {

package/package.json

@@ -1,7 +1,7 @@
 
 {
   "name": "@guardian/content-api-models",
-  "version": "17.4.0-beta.0",
+  "version": "17.5.0-beta.0",
   "description": "Typescript library built from the content api thrift definitions",
   "repository": {
     "type": "git",

package/v1/audioElementFields.d.ts

@@ -17,6 +17,7 @@ export interface AudioElementFields {
     explicit?: boolean;
     role?: string;
     sourceDomain?: string;
+    isMandatory?: boolean;
 }
 export declare class AudioElementFieldsSerde {
     static read(protocol: TProtocol): AudioElementFields;

package/v1/audioElementFields.js

@@ -129,6 +129,15 @@ var AudioElementFieldsSerde = /** @class */ (function () {
                         protocol.skip(ftype);
                     }
                     break;
+                case 15:
+                    if (ftype === thrift_1.Thrift.Type.BOOL) {
+                        var value1 = protocol.readBool();
+                        result.isMandatory = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
                 default:
                     protocol.skip(ftype);
             }
@@ -212,6 +221,12 @@ var AudioElementFieldsSerde = /** @class */ (function () {
             protocol.writeString(value1);
             protocol.writeFieldEnd();
         }
+        if (value0.isMandatory !== null && value0.isMandatory !== undefined) {
+            var value1 = value0.isMandatory;
+            protocol.writeFieldBegin('isMandatory', thrift_1.Thrift.Type.BOOL, 15);
+            protocol.writeBool(value1);
+            protocol.writeFieldEnd();
+        }
         protocol.writeFieldStop();
         protocol.writeStructEnd();
     };

package/v1/blockElement.d.ts

@@ -6,6 +6,7 @@
 import { TProtocol } from 'thrift';
 import { Asset } from './asset';
 import { AudioElementFields } from './audioElementFields';
+import { CalloutElementFields } from './calloutElementFields';
 import { CodeElementFields } from './codeElementFields';
 import { CommentElementFields } from './commentElementFields';
 import { ContentAtomElementFields } from './contentAtomElementFields';
@@ -47,6 +48,7 @@ export interface BlockElement {
     contentAtomTypeData?: ContentAtomElementFields;
     tracking?: EmbedTracking;
     codeTypeData?: CodeElementFields;
+    calloutTypeData?: CalloutElementFields;
 }
 export declare class BlockElementSerde {
     static read(protocol: TProtocol): BlockElement;

package/v1/blockElement.js

@@ -9,6 +9,7 @@ exports.BlockElementSerde = void 0;
 var thrift_1 = require("thrift");
 var asset_1 = require("./asset");
 var audioElementFields_1 = require("./audioElementFields");
+var calloutElementFields_1 = require("./calloutElementFields");
 var codeElementFields_1 = require("./codeElementFields");
 var commentElementFields_1 = require("./commentElementFields");
 var contentAtomElementFields_1 = require("./contentAtomElementFields");
@@ -248,6 +249,15 @@ var BlockElementSerde = /** @class */ (function () {
                         protocol.skip(ftype);
                     }
                     break;
+                case 23:
+                    if (ftype === thrift_1.Thrift.Type.STRUCT) {
+                        var value1 = calloutElementFields_1.CalloutElementFieldsSerde.read(protocol);
+                        result.calloutTypeData = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
                 default:
                     protocol.skip(ftype);
             }
@@ -395,6 +405,12 @@ var BlockElementSerde = /** @class */ (function () {
             codeElementFields_1.CodeElementFieldsSerde.write(protocol, value1);
             protocol.writeFieldEnd();
         }
+        if (value0.calloutTypeData !== null && value0.calloutTypeData !== undefined) {
+            var value1 = value0.calloutTypeData;
+            protocol.writeFieldBegin('calloutTypeData', thrift_1.Thrift.Type.STRUCT, 23);
+            calloutElementFields_1.CalloutElementFieldsSerde.write(protocol, value1);
+            protocol.writeFieldEnd();
+        }
         protocol.writeFieldStop();
         protocol.writeStructEnd();
     };

package/v1/calloutElementFields.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Autogenerated by scrooge-generator-extras
+ *
+ * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+ */
+import { TProtocol } from 'thrift';
+export interface CalloutElementFields {
+    campaignId?: string;
+    isNonCollapsible?: boolean;
+}
+export declare class CalloutElementFieldsSerde {
+    static read(protocol: TProtocol): CalloutElementFields;
+    static write(protocol: TProtocol, value0: CalloutElementFields): void;
+}

package/v1/{contentChannel.js → calloutElementFields.js}

@@ -5,13 +5,12 @@
  * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContentChannelSerde = void 0;
+exports.CalloutElementFieldsSerde = void 0;
 var thrift_1 = require("thrift");
-var channelFields_1 = require("./channelFields");
-var ContentChannelSerde = /** @class */ (function () {
-    function ContentChannelSerde() {
+var CalloutElementFieldsSerde = /** @class */ (function () {
+    function CalloutElementFieldsSerde() {
     }
-    ContentChannelSerde.read = function (protocol) {
+    CalloutElementFieldsSerde.read = function (protocol) {
         protocol.readStructBegin();
         var result = {};
         while (true) {
@@ -25,16 +24,16 @@ var ContentChannelSerde = /** @class */ (function () {
                 case 1:
                     if (ftype === thrift_1.Thrift.Type.STRING) {
                         var value1 = protocol.readString();
-                        result.channelId = value1;
+                        result.campaignId = value1;
                     }
                     else {
                         protocol.skip(ftype);
                     }
                     break;
                 case 2:
-                    if (ftype === thrift_1.Thrift.Type.STRUCT) {
-                        var value1 = channelFields_1.ChannelFieldsSerde.read(protocol);
-                        result.fields = value1;
+                    if (ftype === thrift_1.Thrift.Type.BOOL) {
+                        var value1 = protocol.readBool();
+                        result.isNonCollapsible = value1;
                     }
                     else {
                         protocol.skip(ftype);
@@ -49,23 +48,23 @@ var ContentChannelSerde = /** @class */ (function () {
         // @ts-ignore
         return result;
     };
-    ContentChannelSerde.write = function (protocol, value0) {
-        protocol.writeStructBegin('ContentChannel');
-        if (value0.channelId !== null && value0.channelId !== undefined) {
-            var value1 = value0.channelId;
-            protocol.writeFieldBegin('channelId', thrift_1.Thrift.Type.STRING, 1);
+    CalloutElementFieldsSerde.write = function (protocol, value0) {
+        protocol.writeStructBegin('CalloutElementFields');
+        if (value0.campaignId !== null && value0.campaignId !== undefined) {
+            var value1 = value0.campaignId;
+            protocol.writeFieldBegin('campaignId', thrift_1.Thrift.Type.STRING, 1);
             protocol.writeString(value1);
             protocol.writeFieldEnd();
         }
-        if (value0.fields !== null && value0.fields !== undefined) {
-            var value1 = value0.fields;
-            protocol.writeFieldBegin('fields', thrift_1.Thrift.Type.STRUCT, 2);
-            channelFields_1.ChannelFieldsSerde.write(protocol, value1);
+        if (value0.isNonCollapsible !== null && value0.isNonCollapsible !== undefined) {
+            var value1 = value0.isNonCollapsible;
+            protocol.writeFieldBegin('isNonCollapsible', thrift_1.Thrift.Type.BOOL, 2);
+            protocol.writeBool(value1);
             protocol.writeFieldEnd();
         }
         protocol.writeFieldStop();
         protocol.writeStructEnd();
     };
-    return ContentChannelSerde;
+    return CalloutElementFieldsSerde;
 }());
-exports.ContentChannelSerde = ContentChannelSerde;
+exports.CalloutElementFieldsSerde = CalloutElementFieldsSerde;

package/v1/commentElementFields.d.ts

@@ -16,6 +16,7 @@ export interface CommentElementFields {
     authorName?: string;
     commentId?: number;
     role?: string;
+    isMandatory?: boolean;
 }
 export declare class CommentElementFieldsSerde {
     static read(protocol: TProtocol): CommentElementFields;

package/v1/commentElementFields.js

@@ -120,6 +120,15 @@ var CommentElementFieldsSerde = /** @class */ (function () {
                         protocol.skip(ftype);
                     }
                     break;
+                case 12:
+                    if (ftype === thrift_1.Thrift.Type.BOOL) {
+                        var value1 = protocol.readBool();
+                        result.isMandatory = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
                 default:
                     protocol.skip(ftype);
             }
@@ -197,6 +206,12 @@ var CommentElementFieldsSerde = /** @class */ (function () {
             protocol.writeString(value1);
             protocol.writeFieldEnd();
         }
+        if (value0.isMandatory !== null && value0.isMandatory !== undefined) {
+            var value1 = value0.isMandatory;
+            protocol.writeFieldBegin('isMandatory', thrift_1.Thrift.Type.BOOL, 12);
+            protocol.writeBool(value1);
+            protocol.writeFieldEnd();
+        }
         protocol.writeFieldStop();
         protocol.writeStructEnd();
     };

package/v1/content.d.ts

@@ -8,7 +8,6 @@ import { AliasPath } from './aliasPath';
 import { Atoms } from './atoms';
 import { Blocks } from './blocks';
 import { CapiDateTime } from './capiDateTime';
-import { ContentChannel } from './contentChannel';
 import { ContentFields } from './contentFields';
 import { ContentStats } from './contentStats';
 import { ContentType } from './contentType';
@@ -45,7 +44,6 @@ export interface Content {
     pillarId?: string;
     pillarName?: string;
     aliasPaths?: AliasPath[];
-    channels?: ContentChannel[];
 }
 export declare class ContentSerde {
     static read(protocol: TProtocol): Content;

package/v1/content.js

@@ -11,7 +11,6 @@ var aliasPath_1 = require("./aliasPath");
 var atoms_1 = require("./atoms");
 var blocks_1 = require("./blocks");
 var capiDateTime_1 = require("./capiDateTime");
-var contentChannel_1 = require("./contentChannel");
 var contentFields_1 = require("./contentFields");
 var contentStats_1 = require("./contentStats");
 var contentType_1 = require("./contentType");
@@ -26,7 +25,7 @@ var ContentSerde = /** @class */ (function () {
     function ContentSerde() {
     }
     ContentSerde.read = function (protocol) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d;
         protocol.readStructBegin();
         var result = {
             type: contentType_1.ContentType.ARTICLE,
@@ -303,24 +302,6 @@ var ContentSerde = /** @class */ (function () {
                         protocol.skip(ftype);
                     }
                     break;
-                case 28:
-                    if (ftype === thrift_1.Thrift.Type.LIST) {
-                        var listInfo1 = protocol.readListBegin();
-                        var listSize1 = (_e = listInfo1.size) !== null && _e !== void 0 ? _e : 0;
-                        var value1 = [];
-                        if (listInfo1.etype === thrift_1.Thrift.Type.STRUCT) {
-                            for (var i = 0; i < listSize1; i++) {
-                                var value2 = contentChannel_1.ContentChannelSerde.read(protocol);
-                                value1.push(value2);
-                            }
-                        }
-                        protocol.readListEnd();
-                        result.channels = value1;
-                    }
-                    else {
-                        protocol.skip(ftype);
-                    }
-                    break;
                 default:
                     protocol.skip(ftype);
             }
@@ -498,16 +479,6 @@ var ContentSerde = /** @class */ (function () {
             protocol.writeListEnd();
             protocol.writeFieldEnd();
         }
-        if (value0.channels !== null && value0.channels !== undefined) {
-            var value1 = value0.channels;
-            protocol.writeFieldBegin('channels', thrift_1.Thrift.Type.LIST, 28);
-            protocol.writeListBegin(thrift_1.Thrift.Type.STRUCT, value1.length);
-            value1.forEach(function (value2) {
-                contentChannel_1.ContentChannelSerde.write(protocol, value2);
-            });
-            protocol.writeListEnd();
-            protocol.writeFieldEnd();
-        }
         protocol.writeFieldStop();
         protocol.writeStructEnd();
     };

package/v1/contentAtomElementFields.d.ts

@@ -8,6 +8,7 @@ export interface ContentAtomElementFields {
     atomId: string;
     atomType: string;
     role?: string;
+    isMandatory?: boolean;
 }
 export declare class ContentAtomElementFieldsSerde {
     static read(protocol: TProtocol): ContentAtomElementFields;

package/v1/contentAtomElementFields.js

@@ -48,6 +48,15 @@ var ContentAtomElementFieldsSerde = /** @class */ (function () {
                         protocol.skip(ftype);
                     }
                     break;
+                case 4:
+                    if (ftype === thrift_1.Thrift.Type.BOOL) {
+                        var value1 = protocol.readBool();
+                        result.isMandatory = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
                 default:
                     protocol.skip(ftype);
             }
@@ -77,6 +86,12 @@ var ContentAtomElementFieldsSerde = /** @class */ (function () {
             protocol.writeString(value1);
             protocol.writeFieldEnd();
         }
+        if (value0.isMandatory !== null && value0.isMandatory !== undefined) {
+            var value1 = value0.isMandatory;
+            protocol.writeFieldBegin('isMandatory', thrift_1.Thrift.Type.BOOL, 4);
+            protocol.writeBool(value1);
+            protocol.writeFieldEnd();
+        }
         protocol.writeFieldStop();
         protocol.writeStructEnd();
     };

package/v1/contentStats.d.ts

@@ -19,6 +19,7 @@ export interface ContentStats {
     comments: number;
     instagram: number;
     vines: number;
+    callouts: number;
 }
 export declare class ContentStatsSerde {
     static read(protocol: TProtocol): ContentStats;

package/v1/contentStats.js

@@ -147,6 +147,15 @@ var ContentStatsSerde = /** @class */ (function () {
                         protocol.skip(ftype);
                     }
                     break;
+                case 15:
+                    if (ftype === thrift_1.Thrift.Type.I32) {
+                        var value1 = protocol.readI32();
+                        result.callouts = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
                 default:
                     protocol.skip(ftype);
             }
@@ -242,6 +251,12 @@ var ContentStatsSerde = /** @class */ (function () {
             protocol.writeI32(value1);
             protocol.writeFieldEnd();
         }
+        if (value0.callouts !== null && value0.callouts !== undefined) {
+            var value1 = value0.callouts;
+            protocol.writeFieldBegin('callouts', thrift_1.Thrift.Type.I32, 15);
+            protocol.writeI32(value1);
+            protocol.writeFieldEnd();
+        }
         protocol.writeFieldStop();
         protocol.writeStructEnd();
     };

package/v1/elementType.d.ts

@@ -23,5 +23,6 @@ export declare enum ElementType {
     MEMBERSHIP = 16,
     INSTAGRAM = 17,
     CONTENTATOM = 18,
-    VINE = 19
+    VINE = 19,
+    CALLOUT = 20
 }

package/v1/elementType.js

@@ -28,4 +28,5 @@ var ElementType;
     ElementType[ElementType["INSTAGRAM"] = 17] = "INSTAGRAM";
     ElementType[ElementType["CONTENTATOM"] = 18] = "CONTENTATOM";
     ElementType[ElementType["VINE"] = 19] = "VINE";
+    ElementType[ElementType["CALLOUT"] = 20] = "CALLOUT";
 })(ElementType = exports.ElementType || (exports.ElementType = {}));

package/v1/tweetElementFields.d.ts

@@ -12,6 +12,7 @@ export interface TweetElementFields {
     originalUrl?: string;
     role?: string;
     sourceDomain?: string;
+    isMandatory?: boolean;
 }
 export declare class TweetElementFieldsSerde {
     static read(protocol: TProtocol): TweetElementFields;

package/v1/tweetElementFields.js

@@ -84,6 +84,15 @@ var TweetElementFieldsSerde = /** @class */ (function () {
                         protocol.skip(ftype);
                     }
                     break;
+                case 10:
+                    if (ftype === thrift_1.Thrift.Type.BOOL) {
+                        var value1 = protocol.readBool();
+                        result.isMandatory = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
                 default:
                     protocol.skip(ftype);
             }
@@ -137,6 +146,12 @@ var TweetElementFieldsSerde = /** @class */ (function () {
             protocol.writeString(value1);
             protocol.writeFieldEnd();
         }
+        if (value0.isMandatory !== null && value0.isMandatory !== undefined) {
+            var value1 = value0.isMandatory;
+            protocol.writeFieldBegin('isMandatory', thrift_1.Thrift.Type.BOOL, 10);
+            protocol.writeBool(value1);
+            protocol.writeFieldEnd();
+        }
         protocol.writeFieldStop();
         protocol.writeStructEnd();
     };

package/v1/videoElementFields.d.ts

@@ -25,6 +25,7 @@ export interface VideoElementFields {
     role?: string;
     originalUrl?: string;
     sourceDomain?: string;
+    isMandatory?: boolean;
 }
 export declare class VideoElementFieldsSerde {
     static read(protocol: TProtocol): VideoElementFields;

package/v1/videoElementFields.js

@@ -201,6 +201,15 @@ var VideoElementFieldsSerde = /** @class */ (function () {
                         protocol.skip(ftype);
                     }
                     break;
+                case 21:
+                    if (ftype === thrift_1.Thrift.Type.BOOL) {
+                        var value1 = protocol.readBool();
+                        result.isMandatory = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
                 default:
                     protocol.skip(ftype);
             }
@@ -332,6 +341,12 @@ var VideoElementFieldsSerde = /** @class */ (function () {
             protocol.writeString(value1);
             protocol.writeFieldEnd();
         }
+        if (value0.isMandatory !== null && value0.isMandatory !== undefined) {
+            var value1 = value0.isMandatory;
+            protocol.writeFieldBegin('isMandatory', thrift_1.Thrift.Type.BOOL, 21);
+            protocol.writeBool(value1);
+            protocol.writeFieldEnd();
+        }
         protocol.writeFieldStop();
         protocol.writeStructEnd();
     };

package/v1/channelFields.d.ts

@@ -1,15 +0,0 @@
-/**
- * Autogenerated by scrooge-generator-extras
- *
- * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
- */
-import { TProtocol } from 'thrift';
-import { CapiDateTime } from './capiDateTime';
-export interface ChannelFields {
-    isAvailable: boolean;
-    publicationDate?: CapiDateTime;
-}
-export declare class ChannelFieldsSerde {
-    static read(protocol: TProtocol): ChannelFields;
-    static write(protocol: TProtocol, value0: ChannelFields): void;
-}

package/v1/channelFields.js

@@ -1,71 +0,0 @@
-"use strict";
-/**
- * Autogenerated by scrooge-generator-extras
- *
- * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChannelFieldsSerde = void 0;
-var thrift_1 = require("thrift");
-var capiDateTime_1 = require("./capiDateTime");
-var ChannelFieldsSerde = /** @class */ (function () {
-    function ChannelFieldsSerde() {
-    }
-    ChannelFieldsSerde.read = function (protocol) {
-        protocol.readStructBegin();
-        var result = {};
-        while (true) {
-            var ret = protocol.readFieldBegin();
-            var ftype = ret.ftype;
-            var fid = ret.fid;
-            if (ftype === thrift_1.Thrift.Type.STOP) {
-                break;
-            }
-            switch (fid) {
-                case 1:
-                    if (ftype === thrift_1.Thrift.Type.BOOL) {
-                        var value1 = protocol.readBool();
-                        result.isAvailable = value1;
-                    }
-                    else {
-                        protocol.skip(ftype);
-                    }
-                    break;
-                case 2:
-                    if (ftype === thrift_1.Thrift.Type.STRUCT) {
-                        var value1 = capiDateTime_1.CapiDateTimeSerde.read(protocol);
-                        result.publicationDate = value1;
-                    }
-                    else {
-                        protocol.skip(ftype);
-                    }
-                    break;
-                default:
-                    protocol.skip(ftype);
-            }
-            protocol.readFieldEnd();
-        }
-        protocol.readStructEnd();
-        // @ts-ignore
-        return result;
-    };
-    ChannelFieldsSerde.write = function (protocol, value0) {
-        protocol.writeStructBegin('ChannelFields');
-        if (value0.isAvailable !== null && value0.isAvailable !== undefined) {
-            var value1 = value0.isAvailable;
-            protocol.writeFieldBegin('isAvailable', thrift_1.Thrift.Type.BOOL, 1);
-            protocol.writeBool(value1);
-            protocol.writeFieldEnd();
-        }
-        if (value0.publicationDate !== null && value0.publicationDate !== undefined) {
-            var value1 = value0.publicationDate;
-            protocol.writeFieldBegin('publicationDate', thrift_1.Thrift.Type.STRUCT, 2);
-            capiDateTime_1.CapiDateTimeSerde.write(protocol, value1);
-            protocol.writeFieldEnd();
-        }
-        protocol.writeFieldStop();
-        protocol.writeStructEnd();
-    };
-    return ChannelFieldsSerde;
-}());
-exports.ChannelFieldsSerde = ChannelFieldsSerde;

package/v1/contentChannel.d.ts

@@ -1,15 +0,0 @@
-/**
- * Autogenerated by scrooge-generator-extras
- *
- * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
- */
-import { TProtocol } from 'thrift';
-import { ChannelFields } from './channelFields';
-export interface ContentChannel {
-    channelId: string;
-    fields: ChannelFields;
-}
-export declare class ContentChannelSerde {
-    static read(protocol: TProtocol): ContentChannel;
-    static write(protocol: TProtocol, value0: ContentChannel): void;
-}