@obniz/obniz-now-sdk 0.1.0

package/dist/sdk-core/apis/ThreadsApi.d.ts

@@ -0,0 +1,165 @@
+/**
+ * API EN
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { CreateThreadPostResponse, CreateThreadRequest, CreateThreadResponse, GetThreadEntitiesResponse, GetThreadResponse, ListThreadPostsResponse, ListThreadsResponse, UpdateThreadPostRequest, UpdateThreadPostResponse, UpdateThreadRequest, UpdateThreadResponse } from '../models/index';
+export interface ThreadsApiCreateThreadOperationRequest {
+    createThreadRequest: CreateThreadRequest;
+}
+export interface ThreadsApiCreateThreadPostRequest {
+    id: string;
+    content: string;
+    entities?: string;
+    files?: Array<Blob>;
+}
+export interface ThreadsApiDownloadThreadFileRequest {
+    threadId: string;
+    fileName: string;
+}
+export interface ThreadsApiGetThreadByIdRequest {
+    id: string;
+    groupId?: string;
+}
+export interface ThreadsApiGetThreadEntitiesRequest {
+    id: string;
+    entityType?: GetThreadEntitiesEntityTypeEnum;
+}
+export interface ThreadsApiListThreadPostsRequest {
+    id: string;
+}
+export interface ThreadsApiListThreadsRequest {
+    limit?: number;
+    offset?: number;
+    search?: string;
+    isOpen?: ListThreadsIsOpenEnum;
+    groupId?: string;
+}
+export interface ThreadsApiUpdateThreadOperationRequest {
+    id: string;
+    updateThreadRequest: UpdateThreadRequest;
+}
+export interface ThreadsApiUpdateThreadPostOperationRequest {
+    id: string;
+    number: number;
+    updateThreadPostRequest: UpdateThreadPostRequest;
+}
+/**
+ *
+ */
+export declare class ThreadsApi extends runtime.BaseAPI {
+    /**
+     * Create a new thread (field record). Supports both JSON and multipart/form-data requests.  Validation rules: - Title: required, max 255 characters - Content: required, max 1000 characters - Allowed file types: .jpg, .jpeg, .png, .pdf, .csv, .xlsx, .xls - Each entity must have exactly one of: machine_id, issue_id, or event_id  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `threads:write` permission is required
+     * Create new thread
+     */
+    createThreadRaw(requestParameters: ThreadsApiCreateThreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateThreadResponse>>;
+    /**
+     * Create a new thread (field record). Supports both JSON and multipart/form-data requests.  Validation rules: - Title: required, max 255 characters - Content: required, max 1000 characters - Allowed file types: .jpg, .jpeg, .png, .pdf, .csv, .xlsx, .xls - Each entity must have exactly one of: machine_id, issue_id, or event_id  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `threads:write` permission is required
+     * Create new thread
+     */
+    createThread(requestParameters: ThreadsApiCreateThreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateThreadResponse>;
+    /**
+     * Create a new post in a thread  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `threads:write` permission is required
+     * Create thread post
+     */
+    createThreadPostRaw(requestParameters: ThreadsApiCreateThreadPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateThreadPostResponse>>;
+    /**
+     * Create a new post in a thread  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `threads:write` permission is required
+     * Create thread post
+     */
+    createThreadPost(requestParameters: ThreadsApiCreateThreadPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateThreadPostResponse>;
+    /**
+     * Download a file attached to a thread post  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `threads:read` permission is required
+     * Download thread file
+     */
+    downloadThreadFileRaw(requestParameters: ThreadsApiDownloadThreadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Download a file attached to a thread post  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `threads:read` permission is required
+     * Download thread file
+     */
+    downloadThreadFile(requestParameters: ThreadsApiDownloadThreadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+    /**
+     * Get a specific thread by ID  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `threads:read` permission is required
+     * Get thread by ID
+     */
+    getThreadByIdRaw(requestParameters: ThreadsApiGetThreadByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetThreadResponse>>;
+    /**
+     * Get a specific thread by ID  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `threads:read` permission is required
+     * Get thread by ID
+     */
+    getThreadById(requestParameters: ThreadsApiGetThreadByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetThreadResponse>;
+    /**
+     * Get all entities related to a thread (machines, issues, events)  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `threads:read` permission is required
+     * Get thread entities
+     */
+    getThreadEntitiesRaw(requestParameters: ThreadsApiGetThreadEntitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetThreadEntitiesResponse>>;
+    /**
+     * Get all entities related to a thread (machines, issues, events)  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `threads:read` permission is required
+     * Get thread entities
+     */
+    getThreadEntities(requestParameters: ThreadsApiGetThreadEntitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetThreadEntitiesResponse>;
+    /**
+     * Get posts for a specific thread  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `threads:read` permission is required
+     * Get thread posts
+     */
+    listThreadPostsRaw(requestParameters: ThreadsApiListThreadPostsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListThreadPostsResponse>>;
+    /**
+     * Get posts for a specific thread  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `threads:read` permission is required
+     * Get thread posts
+     */
+    listThreadPosts(requestParameters: ThreadsApiListThreadPostsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListThreadPostsResponse>;
+    /**
+     * Get threads (field records) associated with the account and group  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `threads:read` permission is required
+     * Get threads list
+     */
+    listThreadsRaw(requestParameters: ThreadsApiListThreadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListThreadsResponse>>;
+    /**
+     * Get threads (field records) associated with the account and group  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `threads:read` permission is required
+     * Get threads list
+     */
+    listThreads(requestParameters?: ThreadsApiListThreadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListThreadsResponse>;
+    /**
+     * Update thread (change status)  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `threads:write` permission is required
+     * Update thread status
+     */
+    updateThreadRaw(requestParameters: ThreadsApiUpdateThreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateThreadResponse>>;
+    /**
+     * Update thread (change status)  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `threads:write` permission is required
+     * Update thread status
+     */
+    updateThread(requestParameters: ThreadsApiUpdateThreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateThreadResponse>;
+    /**
+     * Update a specific post in a thread  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `threads:write` permission is required
+     * Update thread post
+     */
+    updateThreadPostRaw(requestParameters: ThreadsApiUpdateThreadPostOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateThreadPostResponse>>;
+    /**
+     * Update a specific post in a thread  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `threads:write` permission is required
+     * Update thread post
+     */
+    updateThreadPost(requestParameters: ThreadsApiUpdateThreadPostOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateThreadPostResponse>;
+}
+/**
+ * @export
+ */
+export declare const GetThreadEntitiesEntityTypeEnum: {
+    readonly Machine: "machine";
+    readonly Issue: "issue";
+    readonly Event: "event";
+};
+export type GetThreadEntitiesEntityTypeEnum = typeof GetThreadEntitiesEntityTypeEnum[keyof typeof GetThreadEntitiesEntityTypeEnum];
+/**
+ * @export
+ */
+export declare const ListThreadsIsOpenEnum: {
+    readonly True: "true";
+    readonly False: "false";
+};
+export type ListThreadsIsOpenEnum = typeof ListThreadsIsOpenEnum[keyof typeof ListThreadsIsOpenEnum];

package/dist/sdk-core/apis/UnitsApi.d.ts

@@ -0,0 +1,151 @@
+/**
+ * API EN
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { StateHistoryResponse, UnitHistoryItem, UnitLoadResponse, UploadAssetResponse } from '../models/index';
+export interface UnitsApiDeleteUnitStateRequest {
+    unitId: string;
+    key: string;
+}
+export interface UnitsApiDownloadAssetRequest {
+    unitId: string;
+    assetId: string;
+    contentType?: DownloadAssetContentTypeEnum;
+}
+export interface UnitsApiGetUnitHistoryRequest {
+    unitId: string;
+    start?: string;
+    end?: string;
+    ratio?: number;
+}
+export interface UnitsApiGetUnitStateHistoryRequest {
+    unitId: string;
+    keys: string;
+    start?: string;
+    end?: string;
+    offset?: number;
+    limit?: number;
+}
+export interface UnitsApiGetUnitStatesRequest {
+    unitId: string;
+}
+export interface UnitsApiLoadUnitDataRequest {
+    unitId: string;
+    start?: string;
+    end?: string;
+    ratio?: number;
+}
+export interface UnitsApiUpdateUnitStatesRequest {
+    unitId: string;
+    requestBody: {
+        [key: string]: string;
+    };
+}
+export interface UnitsApiUploadAssetRequest {
+    unitId: string;
+    file?: Blob;
+}
+/**
+ *
+ */
+export declare class UnitsApi extends runtime.BaseAPI {
+    /**
+     * Permanently removes a specific state and its history for a unit  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `units:delete` permission is required
+     * Delete a unit state by key
+     */
+    deleteUnitStateRaw(requestParameters: UnitsApiDeleteUnitStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Permanently removes a specific state and its history for a unit  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `units:delete` permission is required
+     * Delete a unit state by key
+     */
+    deleteUnitState(requestParameters: UnitsApiDeleteUnitStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Downloads a file asset from S3 storage. Optional contentType query parameter to retrieve JSON content inline.  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `units:read` permission is required
+     * Download an asset file
+     */
+    downloadAssetRaw(requestParameters: UnitsApiDownloadAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Downloads a file asset from S3 storage. Optional contentType query parameter to retrieve JSON content inline.  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `units:read` permission is required
+     * Download an asset file
+     */
+    downloadAsset(requestParameters: UnitsApiDownloadAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+    /**
+     * Retrieves historical data for a specific unit within a specified time period with optional data sampling  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `units:read` permission is required
+     * Get unit history data
+     */
+    getUnitHistoryRaw(requestParameters: UnitsApiGetUnitHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<UnitHistoryItem>>>;
+    /**
+     * Retrieves historical data for a specific unit within a specified time period with optional data sampling  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `units:read` permission is required
+     * Get unit history data
+     */
+    getUnitHistory(requestParameters: UnitsApiGetUnitHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<UnitHistoryItem>>;
+    /**
+     * Retrieves historical state data for a specific unit.  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `units:read` permission is required  **Query Parameters** - `keys` is required (comma-separated or array) - `start` and `end` define the time range (ISO8601 format) - `offset` and `limit` control pagination
+     * Get unit state history
+     */
+    getUnitStateHistoryRaw(requestParameters: UnitsApiGetUnitStateHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StateHistoryResponse>>;
+    /**
+     * Retrieves historical state data for a specific unit.  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `units:read` permission is required  **Query Parameters** - `keys` is required (comma-separated or array) - `start` and `end` define the time range (ISO8601 format) - `offset` and `limit` control pagination
+     * Get unit state history
+     */
+    getUnitStateHistory(requestParameters: UnitsApiGetUnitStateHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StateHistoryResponse>;
+    /**
+     * Retrieves all state key-value pairs for a specific unit.  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `units:read` permission is required
+     * Get unit states
+     */
+    getUnitStatesRaw(requestParameters: UnitsApiGetUnitStatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: string;
+    }>>;
+    /**
+     * Retrieves all state key-value pairs for a specific unit.  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `units:read` permission is required
+     * Get unit states
+     */
+    getUnitStates(requestParameters: UnitsApiGetUnitStatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: string;
+    }>;
+    /**
+     * Retrieves historical data from Cassandra with double-parsed JSON data format and summary statistics (count, tail_date)  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `units:read` permission is required
+     * Load unit data with parsed format
+     */
+    loadUnitDataRaw(requestParameters: UnitsApiLoadUnitDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UnitLoadResponse>>;
+    /**
+     * Retrieves historical data from Cassandra with double-parsed JSON data format and summary statistics (count, tail_date)  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `units:read` permission is required
+     * Load unit data with parsed format
+     */
+    loadUnitData(requestParameters: UnitsApiLoadUnitDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UnitLoadResponse>;
+    /**
+     * Inserts or updates state key-value pairs for a specific unit.  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `units:write` permission is required  **Note** - Multiple key-value pairs can be updated in a single request - Each state change is recorded with a timestamp in history
+     * Update unit states
+     */
+    updateUnitStatesRaw(requestParameters: UnitsApiUpdateUnitStatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Inserts or updates state key-value pairs for a specific unit.  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `units:write` permission is required  **Note** - Multiple key-value pairs can be updated in a single request - Each state change is recorded with a timestamp in history
+     * Update unit states
+     */
+    updateUnitStates(requestParameters: UnitsApiUpdateUnitStatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Uploads a file asset to S3 storage for a specific unit.  Supports two methods: 1. multipart/form-data: For file uploads 2. application/json: For direct JSON content with {filename, content}  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `units:write` permission is required
+     * Upload an asset file
+     */
+    uploadAssetRaw(requestParameters: UnitsApiUploadAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UploadAssetResponse>>;
+    /**
+     * Uploads a file asset to S3 storage for a specific unit.  Supports two methods: 1. multipart/form-data: For file uploads 2. application/json: For direct JSON content with {filename, content}  **Authorization** - API token is required in the `Authorization` header  **Permissions** - `units:write` permission is required
+     * Upload an asset file
+     */
+    uploadAsset(requestParameters: UnitsApiUploadAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadAssetResponse>;
+}
+/**
+ * @export
+ */
+export declare const DownloadAssetContentTypeEnum: {
+    readonly Json: "json";
+};
+export type DownloadAssetContentTypeEnum = typeof DownloadAssetContentTypeEnum[keyof typeof DownloadAssetContentTypeEnum];

package/dist/sdk-core/apis/index.d.ts

@@ -0,0 +1,17 @@
+export * from './AnalyticsApi';
+export * from './ConnectionModelsApi';
+export * from './ConnectionsApi';
+export * from './ConvertersApi';
+export * from './EventsApi';
+export * from './GroupsApi';
+export * from './InboundConnectionsApi';
+export * from './InboundSourcesApi';
+export * from './IntegrationsApi';
+export * from './IntelligencesApi';
+export * from './IssuesApi';
+export * from './MachineApi';
+export * from './MachinesApi';
+export * from './NotificationsApi';
+export * from './ReportsApi';
+export * from './ThreadsApi';
+export * from './UnitsApi';

package/dist/sdk-core/index.d.ts

@@ -0,0 +1,3 @@
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';