@spaciv/sdk 0.1.13 → 0.1.14

package/src/models/ClientMessage.ts

@@ -0,0 +1,114 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * spaciv API
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires.  ## Getting started  1. Exchange credentials for an access token using one of the operations under    **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one    before the old one expires.  ## Conventions  Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for.  Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for.  Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@spaciv.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ClientMessage
+ */
+export interface ClientMessage {
+    [key: string]: any | any;
+    /**
+     * 
+     * @type {string}
+     * @memberof ClientMessage
+     */
+    token?: string;
+    /**
+     * Between 1 and 100 topics for subscribe and unsubscribe. A message must fit within 128 KiB as sent, so topics whose JSON encoding is long go in several messages.
+     * @type {Array<string>}
+     * @memberof ClientMessage
+     */
+    topics?: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof ClientMessage
+     */
+    type: ClientMessageTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof ClientMessage
+     */
+    v: ClientMessageVEnum;
+}
+
+
+/**
+ * @export
+ */
+export const ClientMessageTypeEnum = {
+    Auth: 'auth',
+    Subscribe: 'subscribe',
+    Unsubscribe: 'unsubscribe'
+} as const;
+export type ClientMessageTypeEnum = typeof ClientMessageTypeEnum[keyof typeof ClientMessageTypeEnum];
+
+/**
+ * @export
+ */
+export const ClientMessageVEnum = {
+    NUMBER_1: 1
+} as const;
+export type ClientMessageVEnum = typeof ClientMessageVEnum[keyof typeof ClientMessageVEnum];
+
+
+/**
+ * Check if a given object implements the ClientMessage interface.
+ */
+export function instanceOfClientMessage(value: object): value is ClientMessage {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('v' in value) || value['v'] === undefined) return false;
+    return true;
+}
+
+export function ClientMessageFromJSON(json: any): ClientMessage {
+    return ClientMessageFromJSONTyped(json, false);
+}
+
+export function ClientMessageFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClientMessage {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+            ...json,
+        'token': json['token'] == null ? undefined : json['token'],
+        'topics': json['topics'] == null ? undefined : json['topics'],
+        'type': json['type'],
+        'v': json['v'],
+    };
+}
+
+export function ClientMessageToJSON(json: any): ClientMessage {
+    return ClientMessageToJSONTyped(json, false);
+}
+
+export function ClientMessageToJSONTyped(value?: ClientMessage | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+            ...value,
+        'token': value['token'],
+        'topics': value['topics'],
+        'type': value['type'],
+        'v': value['v'],
+    };
+}
+

package/src/models/EntityChangeActor.ts

@@ -0,0 +1,108 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * spaciv API
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires.  ## Getting started  1. Exchange credentials for an access token using one of the operations under    **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one    before the old one expires.  ## Conventions  Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for.  Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for.  Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@spaciv.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface EntityChangeActor
+ */
+export interface EntityChangeActor {
+    [key: string]: any | any;
+    /**
+     * 
+     * @type {string}
+     * @memberof EntityChangeActor
+     */
+    clientId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EntityChangeActor
+     */
+    session: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EntityChangeActor
+     */
+    type: EntityChangeActorTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof EntityChangeActor
+     */
+    user: number;
+}
+
+
+/**
+ * @export
+ */
+export const EntityChangeActorTypeEnum = {
+    User: 'user',
+    System: 'system',
+    Anonymous: 'anonymous',
+    Unknown: 'unknown'
+} as const;
+export type EntityChangeActorTypeEnum = typeof EntityChangeActorTypeEnum[keyof typeof EntityChangeActorTypeEnum];
+
+
+/**
+ * Check if a given object implements the EntityChangeActor interface.
+ */
+export function instanceOfEntityChangeActor(value: object): value is EntityChangeActor {
+    if (!('session' in value) || value['session'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('user' in value) || value['user'] === undefined) return false;
+    return true;
+}
+
+export function EntityChangeActorFromJSON(json: any): EntityChangeActor {
+    return EntityChangeActorFromJSONTyped(json, false);
+}
+
+export function EntityChangeActorFromJSONTyped(json: any, ignoreDiscriminator: boolean): EntityChangeActor {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+            ...json,
+        'clientId': json['clientId'] == null ? undefined : json['clientId'],
+        'session': json['session'],
+        'type': json['type'],
+        'user': json['user'],
+    };
+}
+
+export function EntityChangeActorToJSON(json: any): EntityChangeActor {
+    return EntityChangeActorToJSONTyped(json, false);
+}
+
+export function EntityChangeActorToJSONTyped(value?: EntityChangeActor | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+            ...value,
+        'clientId': value['clientId'],
+        'session': value['session'],
+        'type': value['type'],
+        'user': value['user'],
+    };
+}
+

package/src/models/EntityChangedEvent.ts

@@ -0,0 +1,149 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * spaciv API
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires.  ## Getting started  1. Exchange credentials for an access token using one of the operations under    **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one    before the old one expires.  ## Conventions  Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for.  Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for.  Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@spaciv.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { EntityChangeActor } from './EntityChangeActor';
+import {
+    EntityChangeActorFromJSON,
+    EntityChangeActorFromJSONTyped,
+    EntityChangeActorToJSON,
+    EntityChangeActorToJSONTyped,
+} from './EntityChangeActor';
+
+/**
+ * 
+ * @export
+ * @interface EntityChangedEvent
+ */
+export interface EntityChangedEvent {
+    [key: string]: any | any;
+    /**
+     * 
+     * @type {number}
+     * @memberof EntityChangedEvent
+     */
+    account: number;
+    /**
+     * 
+     * @type {EntityChangeActor}
+     * @memberof EntityChangedEvent
+     */
+    actor: EntityChangeActor;
+    /**
+     * 
+     * @type {string}
+     * @memberof EntityChangedEvent
+     */
+    at: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EntityChangedEvent
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EntityChangedEvent
+     */
+    op: EntityChangedEventOpEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof EntityChangedEvent
+     */
+    project?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof EntityChangedEvent
+     */
+    type: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EntityChangedEvent
+     */
+    version?: string;
+}
+
+
+/**
+ * @export
+ */
+export const EntityChangedEventOpEnum = {
+    Upsert: 'upsert',
+    Delete: 'delete'
+} as const;
+export type EntityChangedEventOpEnum = typeof EntityChangedEventOpEnum[keyof typeof EntityChangedEventOpEnum];
+
+
+/**
+ * Check if a given object implements the EntityChangedEvent interface.
+ */
+export function instanceOfEntityChangedEvent(value: object): value is EntityChangedEvent {
+    if (!('account' in value) || value['account'] === undefined) return false;
+    if (!('actor' in value) || value['actor'] === undefined) return false;
+    if (!('at' in value) || value['at'] === undefined) return false;
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('op' in value) || value['op'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function EntityChangedEventFromJSON(json: any): EntityChangedEvent {
+    return EntityChangedEventFromJSONTyped(json, false);
+}
+
+export function EntityChangedEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): EntityChangedEvent {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+            ...json,
+        'account': json['account'],
+        'actor': EntityChangeActorFromJSON(json['actor']),
+        'at': json['at'],
+        'id': json['id'],
+        'op': json['op'],
+        'project': json['project'] == null ? undefined : json['project'],
+        'type': json['type'],
+        'version': json['version'] == null ? undefined : json['version'],
+    };
+}
+
+export function EntityChangedEventToJSON(json: any): EntityChangedEvent {
+    return EntityChangedEventToJSONTyped(json, false);
+}
+
+export function EntityChangedEventToJSONTyped(value?: EntityChangedEvent | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+            ...value,
+        'account': value['account'],
+        'actor': EntityChangeActorToJSON(value['actor']),
+        'at': value['at'],
+        'id': value['id'],
+        'op': value['op'],
+        'project': value['project'],
+        'type': value['type'],
+        'version': value['version'],
+    };
+}
+

package/src/models/ServerMessage.ts

@@ -0,0 +1,151 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * spaciv API
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires.  ## Getting started  1. Exchange credentials for an access token using one of the operations under    **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one    before the old one expires.  ## Conventions  Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for.  Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for.  Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@spaciv.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { EntityChangedEvent } from './EntityChangedEvent';
+import {
+    EntityChangedEventFromJSON,
+    EntityChangedEventFromJSONTyped,
+    EntityChangedEventToJSON,
+    EntityChangedEventToJSONTyped,
+} from './EntityChangedEvent';
+
+/**
+ * 
+ * @export
+ * @interface ServerMessage
+ */
+export interface ServerMessage {
+    [key: string]: any | any;
+    /**
+     * 
+     * @type {string}
+     * @memberof ServerMessage
+     */
+    code?: ServerMessageCodeEnum;
+    /**
+     * 
+     * @type {Array<EntityChangedEvent>}
+     * @memberof ServerMessage
+     */
+    events?: Array<EntityChangedEvent>;
+    /**
+     * 
+     * @type {string}
+     * @memberof ServerMessage
+     */
+    message?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ServerMessage
+     */
+    topic?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ServerMessage
+     */
+    type: ServerMessageTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof ServerMessage
+     */
+    v: ServerMessageVEnum;
+}
+
+
+/**
+ * @export
+ */
+export const ServerMessageCodeEnum = {
+    InvalidTopic: 'invalid_topic',
+    Forbidden: 'forbidden',
+    NotFound: 'not_found',
+    TooManySubscriptions: 'too_many_subscriptions',
+    Unavailable: 'unavailable'
+} as const;
+export type ServerMessageCodeEnum = typeof ServerMessageCodeEnum[keyof typeof ServerMessageCodeEnum];
+
+/**
+ * @export
+ */
+export const ServerMessageTypeEnum = {
+    Changed: 'changed',
+    Subscribed: 'subscribed',
+    Resync: 'resync',
+    Error: 'error'
+} as const;
+export type ServerMessageTypeEnum = typeof ServerMessageTypeEnum[keyof typeof ServerMessageTypeEnum];
+
+/**
+ * @export
+ */
+export const ServerMessageVEnum = {
+    NUMBER_1: 1
+} as const;
+export type ServerMessageVEnum = typeof ServerMessageVEnum[keyof typeof ServerMessageVEnum];
+
+
+/**
+ * Check if a given object implements the ServerMessage interface.
+ */
+export function instanceOfServerMessage(value: object): value is ServerMessage {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('v' in value) || value['v'] === undefined) return false;
+    return true;
+}
+
+export function ServerMessageFromJSON(json: any): ServerMessage {
+    return ServerMessageFromJSONTyped(json, false);
+}
+
+export function ServerMessageFromJSONTyped(json: any, ignoreDiscriminator: boolean): ServerMessage {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+            ...json,
+        'code': json['code'] == null ? undefined : json['code'],
+        'events': json['events'] == null ? undefined : ((json['events'] as Array<any>).map(EntityChangedEventFromJSON)),
+        'message': json['message'] == null ? undefined : json['message'],
+        'topic': json['topic'] == null ? undefined : json['topic'],
+        'type': json['type'],
+        'v': json['v'],
+    };
+}
+
+export function ServerMessageToJSON(json: any): ServerMessage {
+    return ServerMessageToJSONTyped(json, false);
+}
+
+export function ServerMessageToJSONTyped(value?: ServerMessage | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+            ...value,
+        'code': value['code'],
+        'events': value['events'] == null ? undefined : ((value['events'] as Array<any>).map(EntityChangedEventToJSON)),
+        'message': value['message'],
+        'topic': value['topic'],
+        'type': value['type'],
+        'v': value['v'],
+    };
+}
+

package/src/models/index.ts

@@ -83,6 +83,7 @@ export * from './CalcTreeValue';
 export * from './CalcTypeSingleValue';
 export * from './ChangelogOption';
 export * from './ChangelogValueOption';
+export * from './ClientMessage';
 export * from './ConfidentialityData';
 export * from './Contribution';
 export * from './ContributionChangelogBody';
@@ -168,6 +169,8 @@ export * from './DatasetDataOneOf2';
 export * from './DatasetModify';
 export * from './DatasetRes';
 export * from './DaysOffData';
+export * from './EntityChangeActor';
+export * from './EntityChangedEvent';
 export * from './EntryPatch';
 export * from './EntryPatchPropertiesValue';
 export * from './ErrorDetail';
@@ -321,6 +324,7 @@ export * from './ScriptUsageResBody';
 export * from './ScriptWebhookResBody';
 export * from './SendPasswordPutReqBody';
 export * from './SerializedEvent';
+export * from './ServerMessage';
 export * from './SingleSelectChangelogData';
 export * from './SingleSelectContributionData';
 export * from './SingleSelectData';