@guardian/content-api-models 4.0.1-SNAPSHOT

package/v1/audioElementFields.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 AudioElementFields {
+    html?: string;
+    source?: string;
+    description?: string;
+    title?: string;
+    credit?: string;
+    caption?: string;
+    durationMinutes?: number;
+    durationSeconds?: number;
+    clean?: boolean;
+    explicit?: boolean;
+    role?: string;
+    sourceDomain?: string;
+    isMandatory?: boolean;
+}
+export declare class AudioElementFieldsSerde {
+    static read(protocol: TProtocol): AudioElementFields;
+    static write(protocol: TProtocol, value0: AudioElementFields): void;
+}

package/v1/audioElementFields.js

@@ -0,0 +1,235 @@
+"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.AudioElementFieldsSerde = void 0;
+var thrift_1 = require("thrift");
+var AudioElementFieldsSerde = /** @class */ (function () {
+    function AudioElementFieldsSerde() {
+    }
+    AudioElementFieldsSerde.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.STRING) {
+                        var value1 = protocol.readString();
+                        result.html = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 2:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.source = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 3:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.description = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 4:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.title = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 5:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.credit = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 6:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.caption = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 7:
+                    if (ftype === thrift_1.Thrift.Type.I32) {
+                        var value1 = protocol.readI32();
+                        result.durationMinutes = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 8:
+                    if (ftype === thrift_1.Thrift.Type.I32) {
+                        var value1 = protocol.readI32();
+                        result.durationSeconds = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 9:
+                    if (ftype === thrift_1.Thrift.Type.BOOL) {
+                        var value1 = protocol.readBool();
+                        result.clean = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 10:
+                    if (ftype === thrift_1.Thrift.Type.BOOL) {
+                        var value1 = protocol.readBool();
+                        result.explicit = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 11:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.role = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 14:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.sourceDomain = value1;
+                    }
+                    else {
+                        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);
+            }
+            protocol.readFieldEnd();
+        }
+        protocol.readStructEnd();
+        // @ts-ignore
+        return result;
+    };
+    AudioElementFieldsSerde.write = function (protocol, value0) {
+        protocol.writeStructBegin('AudioElementFields');
+        if (value0.html !== null && value0.html !== undefined) {
+            var value1 = value0.html;
+            protocol.writeFieldBegin('html', thrift_1.Thrift.Type.STRING, 1);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.source !== null && value0.source !== undefined) {
+            var value1 = value0.source;
+            protocol.writeFieldBegin('source', thrift_1.Thrift.Type.STRING, 2);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.description !== null && value0.description !== undefined) {
+            var value1 = value0.description;
+            protocol.writeFieldBegin('description', thrift_1.Thrift.Type.STRING, 3);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.title !== null && value0.title !== undefined) {
+            var value1 = value0.title;
+            protocol.writeFieldBegin('title', thrift_1.Thrift.Type.STRING, 4);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.credit !== null && value0.credit !== undefined) {
+            var value1 = value0.credit;
+            protocol.writeFieldBegin('credit', thrift_1.Thrift.Type.STRING, 5);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.caption !== null && value0.caption !== undefined) {
+            var value1 = value0.caption;
+            protocol.writeFieldBegin('caption', thrift_1.Thrift.Type.STRING, 6);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.durationMinutes !== null && value0.durationMinutes !== undefined) {
+            var value1 = value0.durationMinutes;
+            protocol.writeFieldBegin('durationMinutes', thrift_1.Thrift.Type.I32, 7);
+            protocol.writeI32(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.durationSeconds !== null && value0.durationSeconds !== undefined) {
+            var value1 = value0.durationSeconds;
+            protocol.writeFieldBegin('durationSeconds', thrift_1.Thrift.Type.I32, 8);
+            protocol.writeI32(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.clean !== null && value0.clean !== undefined) {
+            var value1 = value0.clean;
+            protocol.writeFieldBegin('clean', thrift_1.Thrift.Type.BOOL, 9);
+            protocol.writeBool(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.explicit !== null && value0.explicit !== undefined) {
+            var value1 = value0.explicit;
+            protocol.writeFieldBegin('explicit', thrift_1.Thrift.Type.BOOL, 10);
+            protocol.writeBool(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.role !== null && value0.role !== undefined) {
+            var value1 = value0.role;
+            protocol.writeFieldBegin('role', thrift_1.Thrift.Type.STRING, 11);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.sourceDomain !== null && value0.sourceDomain !== undefined) {
+            var value1 = value0.sourceDomain;
+            protocol.writeFieldBegin('sourceDomain', thrift_1.Thrift.Type.STRING, 14);
+            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();
+    };
+    return AudioElementFieldsSerde;
+}());
+exports.AudioElementFieldsSerde = AudioElementFieldsSerde;

package/v1/block.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Autogenerated by scrooge-generator-extras
+ *
+ * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+ */
+import { TProtocol } from 'thrift';
+import { BlockAttributes } from './blockAttributes';
+import { BlockElement } from './blockElement';
+import { CapiDateTime } from './capiDateTime';
+import { User } from './user';
+export interface Block {
+    id: string;
+    bodyHtml: string;
+    bodyTextSummary: string;
+    title?: string;
+    attributes: BlockAttributes;
+    published: boolean;
+    createdDate?: CapiDateTime;
+    firstPublishedDate?: CapiDateTime;
+    publishedDate?: CapiDateTime;
+    lastModifiedDate?: CapiDateTime;
+    contributors: string[];
+    createdBy?: User;
+    lastModifiedBy?: User;
+    elements: BlockElement[];
+}
+export declare class BlockSerde {
+    static read(protocol: TProtocol): Block;
+    static write(protocol: TProtocol, value0: Block): void;
+}

package/v1/block.js

@@ -0,0 +1,283 @@
+"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.BlockSerde = void 0;
+var thrift_1 = require("thrift");
+var blockAttributes_1 = require("./blockAttributes");
+var blockElement_1 = require("./blockElement");
+var capiDateTime_1 = require("./capiDateTime");
+var user_1 = require("./user");
+var BlockSerde = /** @class */ (function () {
+    function BlockSerde() {
+    }
+    BlockSerde.read = function (protocol) {
+        var _a, _b;
+        protocol.readStructBegin();
+        var result = {
+            elements: [],
+        };
+        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.STRING) {
+                        var value1 = protocol.readString();
+                        result.id = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 2:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.bodyHtml = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 3:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.bodyTextSummary = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 4:
+                    if (ftype === thrift_1.Thrift.Type.STRING) {
+                        var value1 = protocol.readString();
+                        result.title = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 5:
+                    if (ftype === thrift_1.Thrift.Type.STRUCT) {
+                        var value1 = blockAttributes_1.BlockAttributesSerde.read(protocol);
+                        result.attributes = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 6:
+                    if (ftype === thrift_1.Thrift.Type.BOOL) {
+                        var value1 = protocol.readBool();
+                        result.published = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 7:
+                    if (ftype === thrift_1.Thrift.Type.STRUCT) {
+                        var value1 = capiDateTime_1.CapiDateTimeSerde.read(protocol);
+                        result.createdDate = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 8:
+                    if (ftype === thrift_1.Thrift.Type.STRUCT) {
+                        var value1 = capiDateTime_1.CapiDateTimeSerde.read(protocol);
+                        result.firstPublishedDate = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 9:
+                    if (ftype === thrift_1.Thrift.Type.STRUCT) {
+                        var value1 = capiDateTime_1.CapiDateTimeSerde.read(protocol);
+                        result.publishedDate = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 10:
+                    if (ftype === thrift_1.Thrift.Type.STRUCT) {
+                        var value1 = capiDateTime_1.CapiDateTimeSerde.read(protocol);
+                        result.lastModifiedDate = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 11:
+                    if (ftype === thrift_1.Thrift.Type.LIST) {
+                        var listInfo1 = protocol.readListBegin();
+                        var listSize1 = (_a = listInfo1.size) !== null && _a !== void 0 ? _a : 0;
+                        var value1 = [];
+                        if (listInfo1.etype === thrift_1.Thrift.Type.STRING) {
+                            for (var i = 0; i < listSize1; i++) {
+                                var value2 = protocol.readString();
+                                value1.push(value2);
+                            }
+                        }
+                        protocol.readListEnd();
+                        result.contributors = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 12:
+                    if (ftype === thrift_1.Thrift.Type.STRUCT) {
+                        var value1 = user_1.UserSerde.read(protocol);
+                        result.createdBy = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 13:
+                    if (ftype === thrift_1.Thrift.Type.STRUCT) {
+                        var value1 = user_1.UserSerde.read(protocol);
+                        result.lastModifiedBy = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                case 14:
+                    if (ftype === thrift_1.Thrift.Type.LIST) {
+                        var listInfo1 = protocol.readListBegin();
+                        var listSize1 = (_b = listInfo1.size) !== null && _b !== void 0 ? _b : 0;
+                        var value1 = [];
+                        if (listInfo1.etype === thrift_1.Thrift.Type.STRUCT) {
+                            for (var i = 0; i < listSize1; i++) {
+                                var value2 = blockElement_1.BlockElementSerde.read(protocol);
+                                value1.push(value2);
+                            }
+                        }
+                        protocol.readListEnd();
+                        result.elements = value1;
+                    }
+                    else {
+                        protocol.skip(ftype);
+                    }
+                    break;
+                default:
+                    protocol.skip(ftype);
+            }
+            protocol.readFieldEnd();
+        }
+        protocol.readStructEnd();
+        // @ts-ignore
+        return result;
+    };
+    BlockSerde.write = function (protocol, value0) {
+        protocol.writeStructBegin('Block');
+        if (value0.id !== null && value0.id !== undefined) {
+            var value1 = value0.id;
+            protocol.writeFieldBegin('id', thrift_1.Thrift.Type.STRING, 1);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.bodyHtml !== null && value0.bodyHtml !== undefined) {
+            var value1 = value0.bodyHtml;
+            protocol.writeFieldBegin('bodyHtml', thrift_1.Thrift.Type.STRING, 2);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.bodyTextSummary !== null && value0.bodyTextSummary !== undefined) {
+            var value1 = value0.bodyTextSummary;
+            protocol.writeFieldBegin('bodyTextSummary', thrift_1.Thrift.Type.STRING, 3);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.title !== null && value0.title !== undefined) {
+            var value1 = value0.title;
+            protocol.writeFieldBegin('title', thrift_1.Thrift.Type.STRING, 4);
+            protocol.writeString(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.attributes !== null && value0.attributes !== undefined) {
+            var value1 = value0.attributes;
+            protocol.writeFieldBegin('attributes', thrift_1.Thrift.Type.STRUCT, 5);
+            blockAttributes_1.BlockAttributesSerde.write(protocol, value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.published !== null && value0.published !== undefined) {
+            var value1 = value0.published;
+            protocol.writeFieldBegin('published', thrift_1.Thrift.Type.BOOL, 6);
+            protocol.writeBool(value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.createdDate !== null && value0.createdDate !== undefined) {
+            var value1 = value0.createdDate;
+            protocol.writeFieldBegin('createdDate', thrift_1.Thrift.Type.STRUCT, 7);
+            capiDateTime_1.CapiDateTimeSerde.write(protocol, value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.firstPublishedDate !== null && value0.firstPublishedDate !== undefined) {
+            var value1 = value0.firstPublishedDate;
+            protocol.writeFieldBegin('firstPublishedDate', thrift_1.Thrift.Type.STRUCT, 8);
+            capiDateTime_1.CapiDateTimeSerde.write(protocol, value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.publishedDate !== null && value0.publishedDate !== undefined) {
+            var value1 = value0.publishedDate;
+            protocol.writeFieldBegin('publishedDate', thrift_1.Thrift.Type.STRUCT, 9);
+            capiDateTime_1.CapiDateTimeSerde.write(protocol, value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.lastModifiedDate !== null && value0.lastModifiedDate !== undefined) {
+            var value1 = value0.lastModifiedDate;
+            protocol.writeFieldBegin('lastModifiedDate', thrift_1.Thrift.Type.STRUCT, 10);
+            capiDateTime_1.CapiDateTimeSerde.write(protocol, value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.contributors !== null && value0.contributors !== undefined) {
+            var value1 = value0.contributors;
+            protocol.writeFieldBegin('contributors', thrift_1.Thrift.Type.LIST, 11);
+            protocol.writeListBegin(thrift_1.Thrift.Type.STRING, value1.length);
+            value1.forEach(function (value2) {
+                protocol.writeString(value2);
+            });
+            protocol.writeListEnd();
+            protocol.writeFieldEnd();
+        }
+        if (value0.createdBy !== null && value0.createdBy !== undefined) {
+            var value1 = value0.createdBy;
+            protocol.writeFieldBegin('createdBy', thrift_1.Thrift.Type.STRUCT, 12);
+            user_1.UserSerde.write(protocol, value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.lastModifiedBy !== null && value0.lastModifiedBy !== undefined) {
+            var value1 = value0.lastModifiedBy;
+            protocol.writeFieldBegin('lastModifiedBy', thrift_1.Thrift.Type.STRUCT, 13);
+            user_1.UserSerde.write(protocol, value1);
+            protocol.writeFieldEnd();
+        }
+        if (value0.elements !== null && value0.elements !== undefined) {
+            var value1 = value0.elements;
+            protocol.writeFieldBegin('elements', thrift_1.Thrift.Type.LIST, 14);
+            protocol.writeListBegin(thrift_1.Thrift.Type.STRUCT, value1.length);
+            value1.forEach(function (value2) {
+                blockElement_1.BlockElementSerde.write(protocol, value2);
+            });
+            protocol.writeListEnd();
+            protocol.writeFieldEnd();
+        }
+        protocol.writeFieldStop();
+        protocol.writeStructEnd();
+    };
+    return BlockSerde;
+}());
+exports.BlockSerde = BlockSerde;

package/v1/blockAttributes.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Autogenerated by scrooge-generator-extras
+ *
+ * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+ */
+import { TProtocol } from 'thrift';
+import { MembershipPlaceholder } from './membershipPlaceholder';
+export interface BlockAttributes {
+    keyEvent?: boolean;
+    summary?: boolean;
+    title?: string;
+    pinned?: boolean;
+    membershipPlaceholder?: MembershipPlaceholder;
+}
+export declare class BlockAttributesSerde {
+    static read(protocol: TProtocol): BlockAttributes;
+    static write(protocol: TProtocol, value0: BlockAttributes): void;
+}