seatsio 75.1.0 → 76.1.0

package/README.md

@@ -15,10 +15,12 @@ This is the official JavaScript client library for the [Seats.io V2 REST API](ht
 > **Only use this in browser code if you know what you're doing (e.g. if you're building a password-protected backoffice application for admins)**. You have been warned :) 
 
 ## Installing
-For Node, you can install using npm:
+For Node, you can install using yarn or npm:
 
 ```sh
-npm install seatsio
+yarn add seatsio
+# or
+npm install seatsio --save
 ```
 
 ## Usage
@@ -309,3 +311,7 @@ let client = new SeatsioClient(Region.EU(), <WORKSPACE SECRET KEY>).setMaxRetrie
 ```
 
 Passing in 0 disables exponential backoff completely. In that case, the client will never retry a failed request.
+
+## TypeScript
+
+Since v76, this package contains TypeScript definitions.

package/dist/src/Accounts/Account.d.ts

@@ -1,10 +1,14 @@
+import { AccountSettings } from './AccountSettings';
+import { Dict } from '../Dict';
+type AccountJson = Dict<any>;
 export declare class Account {
     company: any;
-    designerKey: any;
-    email: any;
-    publicKey: any;
-    role: any;
-    secretKey: any;
-    settings: any;
-    constructor(account: any);
+    designerKey: string;
+    email: string;
+    publicKey: string;
+    role: string;
+    secretKey: string;
+    settings: AccountSettings;
+    constructor(json: AccountJson);
 }
+export {};

package/dist/src/Accounts/Account.js

@@ -3,14 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Account = void 0;
 var AccountSettings_1 = require("./AccountSettings");
 var Account = /** @class */ (function () {
-    function Account(account) {
-        this.secretKey = account.secretKey;
-        this.designerKey = account.designerKey;
-        this.publicKey = account.publicKey;
-        this.settings = new AccountSettings_1.AccountSettings(account.settings);
-        this.company = account.company;
-        this.email = account.email;
-        this.role = account.role;
+    function Account(json) {
+        this.secretKey = json.secretKey;
+        this.designerKey = json.designerKey;
+        this.publicKey = json.publicKey;
+        this.settings = new AccountSettings_1.AccountSettings(json.settings);
+        this.company = json.company;
+        this.email = json.email;
+        this.role = json.role;
     }
     return Account;
 }());

package/dist/src/Accounts/AccountSettings.d.ts

@@ -1,8 +1,13 @@
+import { ChartValidationSettings } from './ChartValidationSettings';
+import { DefaultRendererSettings } from './DefaultRendererSettings';
+import { Dict } from '../Dict';
+type AccountSettingsJson = Dict<any>;
 export declare class AccountSettings {
-    chartValidation: any;
-    defaultRendererSettings: any;
-    draftChartDrawingsEnabled: any;
-    holdOnSelectForGAs: any;
-    holdPeriodInMinutes: any;
-    constructor(settings: any);
+    chartValidation: ChartValidationSettings;
+    defaultRendererSettings: DefaultRendererSettings;
+    draftChartDrawingsEnabled: boolean;
+    holdOnSelectForGAs: boolean;
+    holdPeriodInMinutes: number;
+    constructor(settings: AccountSettingsJson);
 }
+export {};

package/dist/src/Accounts/Accounts.d.ts

@@ -1,12 +1,14 @@
+import { Account } from './Account';
+import { Axios } from 'axios';
 export declare class Accounts {
     private client;
-    constructor(client: any);
-    retrieveMyAccount(): any;
-    regenerateSecretKey(): any;
-    regenerateDesignerKey(): any;
-    enableDraftChartDrawings(): any;
-    disableDraftChartDrawings(): any;
-    changePassword(password: any): any;
-    changeHoldPeriod(holdPeriodInMinutes: any): any;
-    updateSetting(key: any, value: any): any;
+    constructor(client: Axios);
+    retrieveMyAccount(): Promise<Account>;
+    regenerateSecretKey(): Promise<any>;
+    regenerateDesignerKey(): Promise<any>;
+    enableDraftChartDrawings(): Promise<import("axios").AxiosResponse<any, any>>;
+    disableDraftChartDrawings(): Promise<import("axios").AxiosResponse<any, any>>;
+    changePassword(password: string): Promise<import("axios").AxiosResponse<any, any>>;
+    changeHoldPeriod(holdPeriodInMinutes: number): Promise<import("axios").AxiosResponse<any, any>>;
+    updateSetting(key: string, value: string): Promise<import("axios").AxiosResponse<any, any>>;
 }

package/dist/src/Accounts/ChartValidationSettings.d.ts

@@ -1,9 +1,12 @@
+import { Dict } from '../Dict';
+type ChartValidationSettingsJson = Dict<any>;
 export declare class ChartValidationSettings {
-    VALIDATE_DUPLICATE_LABELS: any;
-    VALIDATE_EMPTY_FLOOR: any;
-    VALIDATE_FOCAL_POINT: any;
-    VALIDATE_OBJECTS_WITHOUT_CATEGORIES: any;
-    VALIDATE_OBJECT_TYPES_PER_CATEGORY: any;
-    VALIDATE_UNLABELED_OBJECTS: any;
-    constructor(chartValidations: any);
+    VALIDATE_DUPLICATE_LABELS: string;
+    VALIDATE_EMPTY_FLOOR: string;
+    VALIDATE_FOCAL_POINT: string;
+    VALIDATE_OBJECTS_WITHOUT_CATEGORIES: string;
+    VALIDATE_OBJECT_TYPES_PER_CATEGORY: string;
+    VALIDATE_UNLABELED_OBJECTS: string;
+    constructor(json: ChartValidationSettingsJson);
 }
+export {};

package/dist/src/Accounts/ChartValidationSettings.js

@@ -2,13 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChartValidationSettings = void 0;
 var ChartValidationSettings = /** @class */ (function () {
-    function ChartValidationSettings(chartValidations) {
-        this.VALIDATE_DUPLICATE_LABELS = chartValidations.VALIDATE_DUPLICATE_LABELS;
-        this.VALIDATE_OBJECTS_WITHOUT_CATEGORIES = chartValidations.VALIDATE_OBJECTS_WITHOUT_CATEGORIES;
-        this.VALIDATE_UNLABELED_OBJECTS = chartValidations.VALIDATE_UNLABELED_OBJECTS;
-        this.VALIDATE_FOCAL_POINT = chartValidations.VALIDATE_FOCAL_POINT;
-        this.VALIDATE_OBJECT_TYPES_PER_CATEGORY = chartValidations.VALIDATE_OBJECT_TYPES_PER_CATEGORY;
-        this.VALIDATE_EMPTY_FLOOR = chartValidations.VALIDATE_EMPTY_FLOOR;
+    function ChartValidationSettings(json) {
+        this.VALIDATE_DUPLICATE_LABELS = json.VALIDATE_DUPLICATE_LABELS;
+        this.VALIDATE_OBJECTS_WITHOUT_CATEGORIES = json.VALIDATE_OBJECTS_WITHOUT_CATEGORIES;
+        this.VALIDATE_UNLABELED_OBJECTS = json.VALIDATE_UNLABELED_OBJECTS;
+        this.VALIDATE_FOCAL_POINT = json.VALIDATE_FOCAL_POINT;
+        this.VALIDATE_OBJECT_TYPES_PER_CATEGORY = json.VALIDATE_OBJECT_TYPES_PER_CATEGORY;
+        this.VALIDATE_EMPTY_FLOOR = json.VALIDATE_EMPTY_FLOOR;
     }
     return ChartValidationSettings;
 }());

package/dist/src/Accounts/DefaultRendererSettings.d.ts

@@ -1,5 +1,8 @@
+import { Dict } from '../Dict';
+type DefaultRendererSettingsJson = Dict<any>;
 export declare class DefaultRendererSettings {
-    multiSelectEnabled: any;
-    showFullScreenButton: any;
-    constructor(defaultRendererSettings: any);
+    multiSelectEnabled: boolean;
+    showFullScreenButton: boolean;
+    constructor(json: DefaultRendererSettingsJson);
 }
+export {};

package/dist/src/Accounts/DefaultRendererSettings.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DefaultRendererSettings = void 0;
 var DefaultRendererSettings = /** @class */ (function () {
-    function DefaultRendererSettings(defaultRendererSettings) {
-        this.showFullScreenButton = defaultRendererSettings.showFullScreenButton;
-        this.multiSelectEnabled = defaultRendererSettings.multiSelectEnabled;
+    function DefaultRendererSettings(json) {
+        this.showFullScreenButton = json.showFullScreenButton;
+        this.multiSelectEnabled = json.multiSelectEnabled;
     }
     return DefaultRendererSettings;
 }());

package/dist/src/AsyncIterator.d.ts

@@ -1,25 +1,42 @@
-export declare class AsyncIterator {
-    client: any;
-    index: any;
-    items: any;
-    nextPageMustBeFetched: any;
-    nextPageStartsAfter: any;
-    objType: any;
-    pages: any;
-    params: any;
-    url: any;
-    constructor(url: any, client: any, objType: any, params?: {});
-    charts(data: any): void;
-    events(data: any): void;
-    seasons(data: any): void;
-    statusChanges(data: any): void;
-    subaccounts(data: any): void;
-    workspaces(data: any): void;
-    users(data: any): void;
-    fetch(fetchParams?: {}): any;
+import { SeasonJson } from './Seasons/Season';
+import { ChartJson } from './Charts/Chart';
+import { Page } from './Page';
+import { StatusChangeJson } from './Events/StatusChange';
+import { SubaccountJson } from './Subaccounts/Subaccount';
+import { WorkspaceJson } from './Workspaces/Workspace';
+import { UserJson } from './Users/User';
+import { EventJson } from './Events/Event';
+import { Axios } from 'axios';
+export interface PaginatedJson<T> {
+    items: T[];
+    next_page_starts_after?: number;
+    previous_page_ends_before?: number;
+}
+interface PaginationParams {
+    start_after_id?: number;
+    end_before_id?: number;
+}
+export declare class AsyncIterator<T> {
+    client: Axios;
+    index: number;
+    items: T[];
+    nextPageMustBeFetched: boolean;
+    nextPageStartsAfter?: number;
+    objType: string;
+    pages: Page<T>[];
+    params: PaginationParams;
+    url: string;
+    constructor(url: string, client: Axios, objType: string, params?: {});
+    charts(json: PaginatedJson<ChartJson>): void;
+    events(data: PaginatedJson<EventJson>): void;
+    seasons(data: PaginatedJson<SeasonJson>): void;
+    statusChanges(data: PaginatedJson<StatusChangeJson>): void;
+    subaccounts(data: PaginatedJson<SubaccountJson>): void;
+    workspaces(data: PaginatedJson<WorkspaceJson>): void;
+    users(data: PaginatedJson<UserJson>): void;
+    fetch(fetchParams?: {}): Promise<void>;
     [Symbol.asyncIterator](): {
-        next(): Promise<{
-            done: boolean;
-        }>;
+        next(): Promise<any>;
     };
 }
+export {};

package/dist/src/AsyncIterator.js

@@ -57,24 +57,28 @@ var AsyncIterator = /** @class */ (function () {
         this.index = 0;
         this.nextPageMustBeFetched = true;
     }
-    AsyncIterator.prototype.charts = function (data) {
+    AsyncIterator.prototype.charts = function (json) {
         var _this_1 = this;
         var charts = [];
-        data.items.forEach(function (chartData) {
+        json.items.forEach(function (chartData) {
             var chart = new Chart_1.Chart(chartData);
+            // @ts-ignore
             _this_1.items.push(chart);
             charts.push(chart);
         });
-        this.pages.push(new Page_1.Page(charts, data.next_page_starts_after, data.previous_page_ends_before));
+        // @ts-ignore
+        this.pages.push(new Page_1.Page(charts, json.next_page_starts_after, json.previous_page_ends_before));
     };
     AsyncIterator.prototype.events = function (data) {
         var _this_1 = this;
         var events = [];
         data.items.forEach(function (eventData) {
             var event = new EventDeserializer_1.EventDeserializer().fromJson(eventData);
+            // @ts-ignore
             _this_1.items.push(event);
             events.push(event);
         });
+        // @ts-ignore
         this.pages.push(new Page_1.Page(events, data.next_page_starts_after, data.previous_page_ends_before));
     };
     AsyncIterator.prototype.seasons = function (data) {
@@ -82,19 +86,23 @@ var AsyncIterator = /** @class */ (function () {
         var seasons = [];
         data.items.forEach(function (seasonData) {
             var season = new Season_1.Season(seasonData);
+            // @ts-ignore
             _this_1.items.push(season);
             seasons.push(season);
         });
+        // @ts-ignore
         this.pages.push(new Page_1.Page(seasons, data.next_page_starts_after, data.previous_page_ends_before));
     };
     AsyncIterator.prototype.statusChanges = function (data) {
         var _this_1 = this;
         var statusChanges = [];
         data.items.forEach(function (statusData) {
-            var status = new StatusChange_1.StatusChange(statusData);
-            _this_1.items.push(status);
-            statusChanges.push(status);
+            var statusChange = new StatusChange_1.StatusChange(statusData);
+            // @ts-ignore
+            _this_1.items.push(statusChange);
+            statusChanges.push(statusChange);
         });
+        // @ts-ignore
         this.pages.push(new Page_1.Page(statusChanges, data.next_page_starts_after, data.previous_page_ends_before));
     };
     AsyncIterator.prototype.subaccounts = function (data) {
@@ -102,9 +110,11 @@ var AsyncIterator = /** @class */ (function () {
         var subaccounts = [];
         data.items.forEach(function (subaccountData) {
             var subaccount = new Subaccount_1.Subaccount(subaccountData);
+            // @ts-ignore
             _this_1.items.push(subaccount);
             subaccounts.push(subaccount);
         });
+        // @ts-ignore
         this.pages.push(new Page_1.Page(subaccounts, data.next_page_starts_after, data.previous_page_ends_before));
     };
     AsyncIterator.prototype.workspaces = function (data) {
@@ -112,9 +122,11 @@ var AsyncIterator = /** @class */ (function () {
         var workspaces = [];
         data.items.forEach(function (json) {
             var workspace = new Workspace_1.Workspace(json);
+            // @ts-ignore
             _this_1.items.push(workspace);
             workspaces.push(workspace);
         });
+        // @ts-ignore
         this.pages.push(new Page_1.Page(workspaces, data.next_page_starts_after, data.previous_page_ends_before));
     };
     AsyncIterator.prototype.users = function (data) {
@@ -122,9 +134,11 @@ var AsyncIterator = /** @class */ (function () {
         var users = [];
         data.items.forEach(function (userData) {
             var user = new User_1.User(userData);
+            // @ts-ignore
             _this_1.items.push(user);
             users.push(user);
         });
+        // @ts-ignore
         this.pages.push(new Page_1.Page(users, data.next_page_starts_after, data.previous_page_ends_before));
     };
     AsyncIterator.prototype.fetch = function (fetchParams) {

package/dist/src/Charts/Category.d.ts

@@ -1,12 +1,15 @@
+import { Dict } from '../Dict';
+export type CategoryJson = Dict<any>;
+export type CategoryKey = string | number;
 export declare class Category {
-    accessible: any;
-    color: any;
-    key: any;
-    label: any;
-    constructor(key: any, label: any, color: any, accessible?: boolean);
-    setKey(key: any): this;
-    setLabel(label: any): this;
-    setColor(color: any): this;
-    setAccessible(accessible: any): this;
-    static fromJson(json: any): Category;
+    accessible: boolean;
+    color: string;
+    key: CategoryKey;
+    label: string;
+    constructor(key: string | number, label: string, color: string, accessible: boolean);
+    setKey(key: string | number): this;
+    setLabel(label: string): this;
+    setColor(color: string): this;
+    setAccessible(accessible: boolean): this;
+    static fromJson(json: CategoryJson): Category;
 }

package/dist/src/Charts/Category.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Category = void 0;
 var Category = /** @class */ (function () {
     function Category(key, label, color, accessible) {
-        if (accessible === void 0) { accessible = false; }
         this.key = key;
         this.label = label;
         this.color = color;

package/dist/src/Charts/Chart.d.ts

@@ -1,15 +1,20 @@
+import { ChartValidation } from './ChartValidation';
+import { SocialDistancingRuleset, SocialDistancingRulesetJson } from './SocialDistancingRuleset';
+import { Event } from '../Events/Event';
+import { Dict } from '../Dict';
+export type ChartJson = Dict<any>;
 export declare class Chart {
-    archived: any;
-    draftVersionThumbnailUrl: any;
-    events: any;
-    id: any;
-    key: any;
-    name: any;
-    publishedVersionThumbnailUrl: any;
-    socialDistancingRulesets: any;
-    status: any;
-    tags: any;
-    validation: any;
-    constructor(chart: any);
-    static socialDistancingRulesetsFromJson(json: any): {} | undefined;
+    archived: boolean;
+    draftVersionThumbnailUrl: string | null;
+    events: Event[];
+    id: number;
+    key: string;
+    name: string;
+    publishedVersionThumbnailUrl: string;
+    socialDistancingRulesets?: Dict<SocialDistancingRuleset>;
+    status: string;
+    tags: string[];
+    validation?: ChartValidation;
+    constructor(chart: ChartJson);
+    static socialDistancingRulesetsFromJson(json: SocialDistancingRulesetJson): Dict<SocialDistancingRuleset> | undefined;
 }

package/dist/src/Charts/Chart.js

@@ -25,7 +25,6 @@ var Chart = /** @class */ (function () {
         }
         var result = {};
         for (var key in json) {
-            // @ts-expect-error TS(7053): Element implicitly has an 'any' type because expre... Remove this comment to see the full error message
             result[key] = SocialDistancingRuleset_1.SocialDistancingRuleset.fromJson(json[key]);
         }
         return result;

package/dist/src/Charts/ChartListParams.d.ts

@@ -1,20 +1,19 @@
 export declare class ChartListParams {
-    eventsLimit: any;
-    expand: any;
-    filter: any;
-    tag: any;
-    validation: any;
-    constructor(filter?: null, tag?: null, expandEvents?: null, withValidation?: boolean, eventsLimit?: null);
-    withFilter(filter: any): this;
-    withTag(tag: any): this;
-    withExpandEvents(expandEvents: any): this;
-    withEventsLimit(eventsLimit: any): this;
-    withValidation(validation: any): this;
+    eventsLimit?: number;
+    expand?: string;
+    filter?: string;
+    tag?: string;
+    validation?: boolean;
+    withFilter(filter: string): this;
+    withTag(tag: string): this;
+    withExpandEvents(expandEvents: boolean): this;
+    withEventsLimit(eventsLimit: number): this;
+    withValidation(validation: boolean): this;
     serialize(): {
-        tag: any;
-        expand: any;
-        filter: any;
-        validation: any;
-        eventsLimit: any;
+        tag: string | undefined;
+        expand: string | undefined;
+        filter: string | undefined;
+        validation: boolean | undefined;
+        eventsLimit: number | undefined;
     };
 }

package/dist/src/Charts/ChartListParams.js

@@ -2,19 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChartListParams = void 0;
 var ChartListParams = /** @class */ (function () {
-    function ChartListParams(filter, tag, expandEvents, withValidation, eventsLimit) {
-        if (filter === void 0) { filter = null; }
-        if (tag === void 0) { tag = null; }
-        if (expandEvents === void 0) { expandEvents = null; }
-        if (withValidation === void 0) { withValidation = false; }
-        if (eventsLimit === void 0) { eventsLimit = null; }
-        this.filter = filter;
-        this.tag = tag;
-        this.validation = withValidation;
-        this.eventsLimit = eventsLimit;
-        if (expandEvents === true) {
-            this.expand = 'events';
-        }
+    function ChartListParams() {
     }
     ChartListParams.prototype.withFilter = function (filter) {
         this.filter = filter;
@@ -25,7 +13,7 @@ var ChartListParams = /** @class */ (function () {
         return this;
     };
     ChartListParams.prototype.withExpandEvents = function (expandEvents) {
-        if (expandEvents === true) {
+        if (expandEvents) {
             this.expand = 'events';
         }
         return this;

package/dist/src/Charts/ChartObjectInfo.d.ts

@@ -1,17 +1,24 @@
+import { IDs } from '../Common/IDs';
+import { Labels } from '../Common/Labels';
+import { Dict } from '../Dict';
+export type ChartObjectInfoJson = Dict<any>;
 export declare class ChartObjectInfo {
-    bookAsAWhole: any;
-    capacity: any;
-    categoryKey: any;
-    categoryLabel: any;
-    distanceToFocalPoint: any;
-    entrance: any;
-    ids: any;
-    label: any;
-    labels: any;
-    leftNeighbour: any;
-    numSeats: any;
-    objectType: any;
-    rightNeighbour: any;
-    section: any;
-    constructor(chartReport: any);
+    bookAsAWhole?: boolean;
+    capacity?: number;
+    categoryKey?: string;
+    categoryLabel: string;
+    distanceToFocalPoint?: number;
+    entrance?: string;
+    ids: IDs;
+    label: string;
+    labels: Labels;
+    leftNeighbour?: string;
+    numSeats?: number;
+    objectType: string;
+    rightNeighbour?: string;
+    section?: string;
+    isAccessible?: boolean;
+    isCompanionSeat?: boolean;
+    hasRestrictedView?: boolean;
+    constructor(json: ChartObjectInfoJson);
 }

package/dist/src/Charts/ChartObjectInfo.js

@@ -4,21 +4,24 @@ exports.ChartObjectInfo = void 0;
 var helperFunctions_1 = require("../utilities/helperFunctions");
 var IDs_1 = require("../Common/IDs");
 var ChartObjectInfo = /** @class */ (function () {
-    function ChartObjectInfo(chartReport) {
-        this.label = chartReport.label;
-        this.labels = helperFunctions_1.HelperFunctions.labelCreator(chartReport);
-        this.ids = new IDs_1.IDs(chartReport.ids.own, chartReport.ids.parent, chartReport.ids.section);
-        this.categoryLabel = chartReport.categoryLabel;
-        this.categoryKey = chartReport.categoryKey;
-        this.entrance = chartReport.entrance;
-        this.objectType = chartReport.objectType;
-        this.section = chartReport.section;
-        this.capacity = chartReport.capacity;
-        this.bookAsAWhole = chartReport.bookAsAWhole;
-        this.leftNeighbour = chartReport.leftNeighbour;
-        this.rightNeighbour = chartReport.rightNeighbour;
-        this.distanceToFocalPoint = chartReport.distanceToFocalPoint;
-        this.numSeats = chartReport.numSeats;
+    function ChartObjectInfo(json) {
+        this.label = json.label;
+        this.labels = helperFunctions_1.HelperFunctions.labelCreator(json);
+        this.ids = new IDs_1.IDs(json.ids.own, json.ids.parent, json.ids.section);
+        this.categoryLabel = json.categoryLabel;
+        this.categoryKey = json.categoryKey;
+        this.entrance = json.entrance;
+        this.objectType = json.objectType;
+        this.section = json.section;
+        this.capacity = json.capacity;
+        this.bookAsAWhole = json.bookAsAWhole;
+        this.leftNeighbour = json.leftNeighbour;
+        this.rightNeighbour = json.rightNeighbour;
+        this.distanceToFocalPoint = json.distanceToFocalPoint;
+        this.numSeats = json.numSeats;
+        this.isAccessible = json.isAccessible;
+        this.isCompanionSeat = json.isCompanionSeat;
+        this.hasRestrictedView = json.hasRestrictedView;
     }
     return ChartObjectInfo;
 }());

package/dist/src/Charts/ChartValidation.d.ts

@@ -1,5 +1,6 @@
+import { Dict } from '../Dict';
 export declare class ChartValidation {
-    errors: any;
-    warnings: any;
-    constructor(validation: any);
+    errors: string[];
+    warnings: string[];
+    constructor(json: Dict<any>);
 }

package/dist/src/Charts/ChartValidation.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChartValidation = void 0;
 var ChartValidation = /** @class */ (function () {
-    function ChartValidation(validation) {
-        this.errors = validation.errors;
-        this.warnings = validation.warnings;
+    function ChartValidation(json) {
+        this.errors = json.errors;
+        this.warnings = json.warnings;
     }
     return ChartValidation;
 }());