@spaciv/sdk 0.1.0 → 0.1.1

package/src/models/AssistantTranscriptMessage.ts

@@ -0,0 +1,175 @@
+/* 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 { AssistantTranscriptToolCall } from './AssistantTranscriptToolCall';
+import {
+    AssistantTranscriptToolCallFromJSON,
+    AssistantTranscriptToolCallFromJSONTyped,
+    AssistantTranscriptToolCallToJSON,
+    AssistantTranscriptToolCallToJSONTyped,
+} from './AssistantTranscriptToolCall';
+import type { AssistantChatPollAttachment } from './AssistantChatPollAttachment';
+import {
+    AssistantChatPollAttachmentFromJSON,
+    AssistantChatPollAttachmentFromJSONTyped,
+    AssistantChatPollAttachmentToJSON,
+    AssistantChatPollAttachmentToJSONTyped,
+} from './AssistantChatPollAttachment';
+
+/**
+ * 
+ * @export
+ * @interface AssistantTranscriptMessage
+ */
+export interface AssistantTranscriptMessage {
+    /**
+     * Files attached to a user message. Empty on every other message.
+     * @type {Array<AssistantChatPollAttachment>}
+     * @memberof AssistantTranscriptMessage
+     */
+    attachments: Array<AssistantChatPollAttachment>;
+    /**
+     * 
+     * @type {string}
+     * @memberof AssistantTranscriptMessage
+     */
+    createdAt: string;
+    /**
+     * Whether the tool call a tool message answers failed: the tool refused it, returned an error, or was not available.
+     * @type {boolean}
+     * @memberof AssistantTranscriptMessage
+     */
+    failed: boolean;
+    /**
+     * The message's index in the conversation. A poll's message ids start with it.
+     * @type {string}
+     * @memberof AssistantTranscriptMessage
+     */
+    id: string;
+    /**
+     * Why a notice was given, as the id a poll shows it with.
+     * @type {string}
+     * @memberof AssistantTranscriptMessage
+     */
+    reason: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AssistantTranscriptMessage
+     */
+    requestId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AssistantTranscriptMessage
+     */
+    role: AssistantTranscriptMessageRoleEnum;
+    /**
+     * For a tool message, the result the assistant was given.
+     * @type {string}
+     * @memberof AssistantTranscriptMessage
+     */
+    text: string;
+    /**
+     * The id of the tool call a tool message is the result of.
+     * @type {string}
+     * @memberof AssistantTranscriptMessage
+     */
+    toolCallId: string;
+    /**
+     * The tools an assistant message called. Empty on every other message.
+     * @type {Array<AssistantTranscriptToolCall>}
+     * @memberof AssistantTranscriptMessage
+     */
+    toolCalls: Array<AssistantTranscriptToolCall>;
+}
+
+
+/**
+ * @export
+ */
+export const AssistantTranscriptMessageRoleEnum = {
+    User: 'user',
+    Assistant: 'assistant',
+    Tool: 'tool',
+    Notice: 'notice'
+} as const;
+export type AssistantTranscriptMessageRoleEnum = typeof AssistantTranscriptMessageRoleEnum[keyof typeof AssistantTranscriptMessageRoleEnum];
+
+
+/**
+ * Check if a given object implements the AssistantTranscriptMessage interface.
+ */
+export function instanceOfAssistantTranscriptMessage(value: object): value is AssistantTranscriptMessage {
+    if (!('attachments' in value) || value['attachments'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('failed' in value) || value['failed'] === undefined) return false;
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('reason' in value) || value['reason'] === undefined) return false;
+    if (!('requestId' in value) || value['requestId'] === undefined) return false;
+    if (!('role' in value) || value['role'] === undefined) return false;
+    if (!('text' in value) || value['text'] === undefined) return false;
+    if (!('toolCallId' in value) || value['toolCallId'] === undefined) return false;
+    if (!('toolCalls' in value) || value['toolCalls'] === undefined) return false;
+    return true;
+}
+
+export function AssistantTranscriptMessageFromJSON(json: any): AssistantTranscriptMessage {
+    return AssistantTranscriptMessageFromJSONTyped(json, false);
+}
+
+export function AssistantTranscriptMessageFromJSONTyped(json: any, ignoreDiscriminator: boolean): AssistantTranscriptMessage {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'attachments': ((json['attachments'] as Array<any>).map(AssistantChatPollAttachmentFromJSON)),
+        'createdAt': json['createdAt'],
+        'failed': json['failed'],
+        'id': json['id'],
+        'reason': json['reason'],
+        'requestId': json['requestId'],
+        'role': json['role'],
+        'text': json['text'],
+        'toolCallId': json['toolCallId'],
+        'toolCalls': ((json['toolCalls'] as Array<any>).map(AssistantTranscriptToolCallFromJSON)),
+    };
+}
+
+export function AssistantTranscriptMessageToJSON(json: any): AssistantTranscriptMessage {
+    return AssistantTranscriptMessageToJSONTyped(json, false);
+}
+
+export function AssistantTranscriptMessageToJSONTyped(value?: AssistantTranscriptMessage | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'attachments': ((value['attachments'] as Array<any>).map(AssistantChatPollAttachmentToJSON)),
+        'createdAt': value['createdAt'],
+        'failed': value['failed'],
+        'id': value['id'],
+        'reason': value['reason'],
+        'requestId': value['requestId'],
+        'role': value['role'],
+        'text': value['text'],
+        'toolCallId': value['toolCallId'],
+        'toolCalls': ((value['toolCalls'] as Array<any>).map(AssistantTranscriptToolCallToJSON)),
+    };
+}
+

package/src/models/AssistantTranscriptToolCall.ts

@@ -0,0 +1,84 @@
+/* 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 AssistantTranscriptToolCall
+ */
+export interface AssistantTranscriptToolCall {
+    /**
+     * The call's JSON arguments.
+     * @type {string}
+     * @memberof AssistantTranscriptToolCall
+     */
+    arguments: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AssistantTranscriptToolCall
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AssistantTranscriptToolCall
+     */
+    name: string;
+}
+
+/**
+ * Check if a given object implements the AssistantTranscriptToolCall interface.
+ */
+export function instanceOfAssistantTranscriptToolCall(value: object): value is AssistantTranscriptToolCall {
+    if (!('arguments' in value) || value['arguments'] === undefined) return false;
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function AssistantTranscriptToolCallFromJSON(json: any): AssistantTranscriptToolCall {
+    return AssistantTranscriptToolCallFromJSONTyped(json, false);
+}
+
+export function AssistantTranscriptToolCallFromJSONTyped(json: any, ignoreDiscriminator: boolean): AssistantTranscriptToolCall {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'arguments': json['arguments'],
+        'id': json['id'],
+        'name': json['name'],
+    };
+}
+
+export function AssistantTranscriptToolCallToJSON(json: any): AssistantTranscriptToolCall {
+    return AssistantTranscriptToolCallToJSONTyped(json, false);
+}
+
+export function AssistantTranscriptToolCallToJSONTyped(value?: AssistantTranscriptToolCall | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'arguments': value['arguments'],
+        'id': value['id'],
+        'name': value['name'],
+    };
+}
+

package/src/models/index.ts

@@ -39,6 +39,9 @@ export * from './AssistantConversationFailureBody';
 export * from './AssistantConversationListEntry';
 export * from './AssistantConversationListRes';
 export * from './AssistantModelListBody';
+export * from './AssistantTranscriptBody';
+export * from './AssistantTranscriptMessage';
+export * from './AssistantTranscriptToolCall';
 export * from './AuthAPIKeyTokenReqBody';
 export * from './AuthAPIKeyTokenResBody';
 export * from './AuthLoginPassReqBody';