@obniz/obniz-now-sdk 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/README.md +8 -0
  2. package/dist/ObnizApiError.d.ts +62 -0
  3. package/dist/ObnizNow.d.ts +104 -0
  4. package/dist/ObnizNow.test.d.ts +1 -0
  5. package/dist/ObnizNowApiError.d.ts +62 -0
  6. package/dist/index.browser.mjs +3253 -0
  7. package/dist/index.browser.mjs.map +1 -0
  8. package/dist/index.d.ts +2 -0
  9. package/dist/index.js +3379 -0
  10. package/dist/index.js.map +1 -0
  11. package/dist/index.mjs +3376 -0
  12. package/dist/index.mjs.map +1 -0
  13. package/dist/sdk-core/apis/AnalyticsApi.d.ts +35 -0
  14. package/dist/sdk-core/apis/ConnectionModelsApi.d.ts +89 -0
  15. package/dist/sdk-core/apis/ConnectionsApi.d.ts +61 -0
  16. package/dist/sdk-core/apis/ConvertersApi.d.ts +28 -0
  17. package/dist/sdk-core/apis/EventsApi.d.ts +49 -0
  18. package/dist/sdk-core/apis/GroupsApi.d.ts +62 -0
  19. package/dist/sdk-core/apis/InboundConnectionsApi.d.ts +47 -0
  20. package/dist/sdk-core/apis/InboundSourcesApi.d.ts +113 -0
  21. package/dist/sdk-core/apis/IntegrationsApi.d.ts +121 -0
  22. package/dist/sdk-core/apis/IntelligencesApi.d.ts +84 -0
  23. package/dist/sdk-core/apis/IssuesApi.d.ts +63 -0
  24. package/dist/sdk-core/apis/MachineApi.d.ts +142 -0
  25. package/dist/sdk-core/apis/MachinesApi.d.ts +97 -0
  26. package/dist/sdk-core/apis/NotificationsApi.d.ts +72 -0
  27. package/dist/sdk-core/apis/ReportsApi.d.ts +85 -0
  28. package/dist/sdk-core/apis/ThreadsApi.d.ts +165 -0
  29. package/dist/sdk-core/apis/UnitsApi.d.ts +151 -0
  30. package/dist/sdk-core/apis/index.d.ts +17 -0
  31. package/dist/sdk-core/index.d.ts +3 -0
  32. package/dist/sdk-core/models/index.d.ts +5368 -0
  33. package/dist/sdk-core/runtime.d.ts +181 -0
  34. package/package.json +49 -0
@@ -0,0 +1,84 @@
1
+ /**
2
+ * API EN
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { GetIntelligenceResponse, Intelligence, IntelligenceInput, IntelligenceSuccessResponse } from '../models/index';
14
+ export interface IntelligencesApiAddIntelligenceRequest {
15
+ intelligenceInput: IntelligenceInput;
16
+ }
17
+ export interface IntelligencesApiDeleteIntelligenceRequest {
18
+ name: string;
19
+ version: number;
20
+ }
21
+ export interface IntelligencesApiEditIntelligenceRequest {
22
+ name: string;
23
+ version: number;
24
+ intelligenceInput: IntelligenceInput;
25
+ }
26
+ export interface IntelligencesApiGetIntelligenceRequest {
27
+ name: string;
28
+ version: number;
29
+ }
30
+ /**
31
+ *
32
+ */
33
+ export declare class IntelligencesApi extends runtime.BaseAPI {
34
+ /**
35
+ * Creates a new intelligence controller. **Authorization** - API token is required in the `Authorization` header **Permissions** - `intelligences:write` permission is required **Validation** - Name and version combination must be unique - Version must be a positive integer - All required fields must be provided - `type` must be a valid ControllerType - `publishment` must be a valid ControllerPublishment - `code_type` must be a valid CodeType
36
+ * Add intelligence
37
+ */
38
+ addIntelligenceRaw(requestParameters: IntelligencesApiAddIntelligenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IntelligenceSuccessResponse>>;
39
+ /**
40
+ * Creates a new intelligence controller. **Authorization** - API token is required in the `Authorization` header **Permissions** - `intelligences:write` permission is required **Validation** - Name and version combination must be unique - Version must be a positive integer - All required fields must be provided - `type` must be a valid ControllerType - `publishment` must be a valid ControllerPublishment - `code_type` must be a valid CodeType
41
+ * Add intelligence
42
+ */
43
+ addIntelligence(requestParameters: IntelligencesApiAddIntelligenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IntelligenceSuccessResponse>;
44
+ /**
45
+ * Deletes an intelligence controller and its associated authority. **Authorization** - API token is required in the `Authorization` header **Permissions** - `intelligences:delete` permission is required
46
+ * Delete intelligence
47
+ */
48
+ deleteIntelligenceRaw(requestParameters: IntelligencesApiDeleteIntelligenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
49
+ /**
50
+ * Deletes an intelligence controller and its associated authority. **Authorization** - API token is required in the `Authorization` header **Permissions** - `intelligences:delete` permission is required
51
+ * Delete intelligence
52
+ */
53
+ deleteIntelligence(requestParameters: IntelligencesApiDeleteIntelligenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
54
+ /**
55
+ * Updates an existing intelligence controller. **Authorization** - API token is required in the `Authorization` header **Permissions** - `intelligences:write` permission is required **Validation** - Version must be a positive integer - All required fields must be provided - `type` must be a valid ControllerType - `publishment` must be a valid ControllerPublishment - `code_type` must be a valid CodeType
56
+ * Edit intelligence
57
+ */
58
+ editIntelligenceRaw(requestParameters: IntelligencesApiEditIntelligenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IntelligenceSuccessResponse>>;
59
+ /**
60
+ * Updates an existing intelligence controller. **Authorization** - API token is required in the `Authorization` header **Permissions** - `intelligences:write` permission is required **Validation** - Version must be a positive integer - All required fields must be provided - `type` must be a valid ControllerType - `publishment` must be a valid ControllerPublishment - `code_type` must be a valid CodeType
61
+ * Edit intelligence
62
+ */
63
+ editIntelligence(requestParameters: IntelligencesApiEditIntelligenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IntelligenceSuccessResponse>;
64
+ /**
65
+ * Returns a list of all available intelligence controllers. **Authorization** - API token is required in the `Authorization` header **Permissions** - `intelligences:read` permission is required **Visibility Rules** - Public intelligences are visible to all users - Private intelligences are visible only if user has authority
66
+ * List all intelligences
67
+ */
68
+ getAllIntelligencesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Intelligence>>>;
69
+ /**
70
+ * Returns a list of all available intelligence controllers. **Authorization** - API token is required in the `Authorization` header **Permissions** - `intelligences:read` permission is required **Visibility Rules** - Public intelligences are visible to all users - Private intelligences are visible only if user has authority
71
+ * List all intelligences
72
+ */
73
+ getAllIntelligences(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Intelligence>>;
74
+ /**
75
+ * Retrieves a specific intelligence controller by name and version. **Authorization** - API token is required in the `Authorization` header **Permissions** - `intelligences:read` permission is required **Responce** - Returns `allowedToEdit: true` if user\'s account owns the intelligence - Returns `allowedToEdit: false` otherwise
76
+ * Get intelligence
77
+ */
78
+ getIntelligenceRaw(requestParameters: IntelligencesApiGetIntelligenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetIntelligenceResponse>>;
79
+ /**
80
+ * Retrieves a specific intelligence controller by name and version. **Authorization** - API token is required in the `Authorization` header **Permissions** - `intelligences:read` permission is required **Responce** - Returns `allowedToEdit: true` if user\'s account owns the intelligence - Returns `allowedToEdit: false` otherwise
81
+ * Get intelligence
82
+ */
83
+ getIntelligence(requestParameters: IntelligencesApiGetIntelligenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetIntelligenceResponse>;
84
+ }
@@ -0,0 +1,63 @@
1
+ /**
2
+ * API EN
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { CloseIssueResponse, ListIssuesResponse } from '../models/index';
14
+ export interface IssuesApiCloseIssueRequest {
15
+ id: string;
16
+ }
17
+ export interface IssuesApiListIssuesRequest {
18
+ limit?: number;
19
+ offset?: number;
20
+ searchFilter?: ListIssuesSearchFilterEnum;
21
+ searchWord?: string;
22
+ isOpen?: ListIssuesIsOpenEnum;
23
+ }
24
+ /**
25
+ *
26
+ */
27
+ export declare class IssuesApi extends runtime.BaseAPI {
28
+ /**
29
+ * Marks an issue as closed by setting the closed_at timestamp **Authorization** - API token is required in the `Authorization` header **Permissions** - `issues:write` permission is required
30
+ * Close an issue
31
+ */
32
+ closeIssueRaw(requestParameters: IssuesApiCloseIssueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CloseIssueResponse>>;
33
+ /**
34
+ * Marks an issue as closed by setting the closed_at timestamp **Authorization** - API token is required in the `Authorization` header **Permissions** - `issues:write` permission is required
35
+ * Close an issue
36
+ */
37
+ closeIssue(requestParameters: IssuesApiCloseIssueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CloseIssueResponse>;
38
+ /**
39
+ * Retrieves issues associated with the account and group with optional filtering and pagination **Authorization** - API token is required in the `Authorization` header **Permissions** - `issues:read` permission is required
40
+ * Get issues list
41
+ */
42
+ listIssuesRaw(requestParameters: IssuesApiListIssuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListIssuesResponse>>;
43
+ /**
44
+ * Retrieves issues associated with the account and group with optional filtering and pagination **Authorization** - API token is required in the `Authorization` header **Permissions** - `issues:read` permission is required
45
+ * Get issues list
46
+ */
47
+ listIssues(requestParameters?: IssuesApiListIssuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListIssuesResponse>;
48
+ }
49
+ /**
50
+ * @export
51
+ */
52
+ export declare const ListIssuesSearchFilterEnum: {
53
+ readonly Name: "name";
54
+ };
55
+ export type ListIssuesSearchFilterEnum = typeof ListIssuesSearchFilterEnum[keyof typeof ListIssuesSearchFilterEnum];
56
+ /**
57
+ * @export
58
+ */
59
+ export declare const ListIssuesIsOpenEnum: {
60
+ readonly True: "true";
61
+ readonly False: "false";
62
+ };
63
+ export type ListIssuesIsOpenEnum = typeof ListIssuesIsOpenEnum[keyof typeof ListIssuesIsOpenEnum];
@@ -0,0 +1,142 @@
1
+ /**
2
+ * API EN
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { AvailableController, ConnectionModelDetailed, DeleteMachineResponse, MachineGroupsResponse, MachineWithState, UpdateConnectionModelsRequest, UpdateConnectionModelsResponse, UpdateInstallConfigRequest, UpdateInstallConfigResponse, UpdateMachinePublicRequest, UpdateMachinePublicResponse } from '../models/index';
14
+ export interface MachineApiDeleteMachineRequest {
15
+ machineId: string;
16
+ }
17
+ export interface MachineApiGetAvailableConnectionModelsRequest {
18
+ machineId: string;
19
+ }
20
+ export interface MachineApiGetConnectionModelByNameRequest {
21
+ machineId: string;
22
+ modelName: string;
23
+ modelVersion?: number;
24
+ }
25
+ export interface MachineApiGetMachineRequest {
26
+ machineId: string;
27
+ }
28
+ export interface MachineApiGetMachineConnectionModelsRequest {
29
+ machineId: string;
30
+ }
31
+ export interface MachineApiGetMachineGroupsRequest {
32
+ machineId: string;
33
+ }
34
+ export interface MachineApiUpdateConnectionModelInstallConfigRequest {
35
+ machineId: string;
36
+ modelName: string;
37
+ updateInstallConfigRequest: UpdateInstallConfigRequest;
38
+ modelVersion?: number;
39
+ }
40
+ export interface MachineApiUpdateConnectionModelsOperationRequest {
41
+ machineId: string;
42
+ updateConnectionModelsRequest: UpdateConnectionModelsRequest;
43
+ }
44
+ export interface MachineApiUpdateMachinePublicOperationRequest {
45
+ machineId: string;
46
+ updateMachinePublicRequest: UpdateMachinePublicRequest;
47
+ }
48
+ /**
49
+ *
50
+ */
51
+ export declare class MachineApi extends runtime.BaseAPI {
52
+ /**
53
+ * Permanently deletes a machine and all its associated data. **Authorization** - API token is required in the `Authorization` header **Permissions** - `machines:delete` permission is required **Side effects**: - Deletes the machine from the database - Cascades deletion to related records (connections, events, etc.) **Warning**: This operation is irreversible!
54
+ * Delete a machine
55
+ */
56
+ deleteMachineRaw(requestParameters: MachineApiDeleteMachineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteMachineResponse>>;
57
+ /**
58
+ * Permanently deletes a machine and all its associated data. **Authorization** - API token is required in the `Authorization` header **Permissions** - `machines:delete` permission is required **Side effects**: - Deletes the machine from the database - Cascades deletion to related records (connections, events, etc.) **Warning**: This operation is irreversible!
59
+ * Delete a machine
60
+ */
61
+ deleteMachine(requestParameters: MachineApiDeleteMachineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteMachineResponse>;
62
+ /**
63
+ * Retrieves all connection models (controllers) that are available for installation on a specific machine. This endpoint filters out models that are already installed on the machine. **Authorization** - API token is required in the `Authorization` header **Permissions** - `connections:read` permission is required **Response includes**: - Available controller metadata (identity, version, title, etc.) - Install configuration structure - Installation conditions and requirements - Controller type and capabilities **Filtering**: - Excludes models already installed on the machine - Only shows models where user\'s role allows installation (based on `installRole`) - Includes intelligence controllers from the account
64
+ * List available connection models for installation
65
+ */
66
+ getAvailableConnectionModelsRaw(requestParameters: MachineApiGetAvailableConnectionModelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AvailableController>>>;
67
+ /**
68
+ * Retrieves all connection models (controllers) that are available for installation on a specific machine. This endpoint filters out models that are already installed on the machine. **Authorization** - API token is required in the `Authorization` header **Permissions** - `connections:read` permission is required **Response includes**: - Available controller metadata (identity, version, title, etc.) - Install configuration structure - Installation conditions and requirements - Controller type and capabilities **Filtering**: - Excludes models already installed on the machine - Only shows models where user\'s role allows installation (based on `installRole`) - Includes intelligence controllers from the account
69
+ * List available connection models for installation
70
+ */
71
+ getAvailableConnectionModels(requestParameters: MachineApiGetAvailableConnectionModelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AvailableController>>;
72
+ /**
73
+ * Retrieves detailed information about a specific connection model installed on a machine. **Authorization** - API token is required in the `Authorization` header **Permissions** - `connections:read` permission is required **Response includes**: - Connection model metadata - Install configuration structure - Current install configuration values - Permissions indicating whether the user can delete the model **Query parameters**: Can specify `model_version` (defaults to 1)
74
+ * Get specific connection model details
75
+ */
76
+ getConnectionModelByNameRaw(requestParameters: MachineApiGetConnectionModelByNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConnectionModelDetailed>>;
77
+ /**
78
+ * Retrieves detailed information about a specific connection model installed on a machine. **Authorization** - API token is required in the `Authorization` header **Permissions** - `connections:read` permission is required **Response includes**: - Connection model metadata - Install configuration structure - Current install configuration values - Permissions indicating whether the user can delete the model **Query parameters**: Can specify `model_version` (defaults to 1)
79
+ * Get specific connection model details
80
+ */
81
+ getConnectionModelByName(requestParameters: MachineApiGetConnectionModelByNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConnectionModelDetailed>;
82
+ /**
83
+ * Retrieves detailed information about a specific machine, including its current state. **Authorization** - API token is required in the `Authorization` header **Permissions** - `machines:read` permission is required **Response includes**: - Machine metadata (name, id, connection models, etc.) - Current machine state (`machine_stat`) - key-value pairs of the latest state data
84
+ * Get machine details
85
+ */
86
+ getMachineRaw(requestParameters: MachineApiGetMachineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MachineWithState>>;
87
+ /**
88
+ * Retrieves detailed information about a specific machine, including its current state. **Authorization** - API token is required in the `Authorization` header **Permissions** - `machines:read` permission is required **Response includes**: - Machine metadata (name, id, connection models, etc.) - Current machine state (`machine_stat`) - key-value pairs of the latest state data
89
+ * Get machine details
90
+ */
91
+ getMachine(requestParameters: MachineApiGetMachineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MachineWithState>;
92
+ /**
93
+ * Retrieves all connection models (controllers) installed on a specific machine. **Authorization** - API token is required in the `Authorization` header **Permissions** - `connections:read` permission is required **Response includes**: - Connection model metadata (model_name, model_version, etc.) - Install configuration structure for each model - Permissions indicating whether the user can delete each model - Controller conditions for installation **Role-based filtering** - Only returns models where user\'s role ≤ model\'s `view_role_level`
94
+ * List machine\'s connection models
95
+ */
96
+ getMachineConnectionModelsRaw(requestParameters: MachineApiGetMachineConnectionModelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ConnectionModelDetailed>>>;
97
+ /**
98
+ * Retrieves all connection models (controllers) installed on a specific machine. **Authorization** - API token is required in the `Authorization` header **Permissions** - `connections:read` permission is required **Response includes**: - Connection model metadata (model_name, model_version, etc.) - Install configuration structure for each model - Permissions indicating whether the user can delete each model - Controller conditions for installation **Role-based filtering** - Only returns models where user\'s role ≤ model\'s `view_role_level`
99
+ * List machine\'s connection models
100
+ */
101
+ getMachineConnectionModels(requestParameters: MachineApiGetMachineConnectionModelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ConnectionModelDetailed>>;
102
+ /**
103
+ * Retrieves a list of groups that the specified machine is assigned to. **Authorization** - API token is required in the `Authorization` header - User must have access to the account that owns the machine **Permissions** - `machines:read` permission is required **Response includes**: - Machine ID - List of groups (id and name) that the machine belongs to
104
+ * Get machine groups
105
+ */
106
+ getMachineGroupsRaw(requestParameters: MachineApiGetMachineGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MachineGroupsResponse>>;
107
+ /**
108
+ * Retrieves a list of groups that the specified machine is assigned to. **Authorization** - API token is required in the `Authorization` header - User must have access to the account that owns the machine **Permissions** - `machines:read` permission is required **Response includes**: - Machine ID - List of groups (id and name) that the machine belongs to
109
+ * Get machine groups
110
+ */
111
+ getMachineGroups(requestParameters: MachineApiGetMachineGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MachineGroupsResponse>;
112
+ /**
113
+ * Updates the install configuration for a specific connection model on a machine. This allows changing controller settings without reinstalling the entire model. **Authorization** - API token is required in the `Authorization` header **Permissions** - `connections:write` permission is required **Use case**: Modify controller parameters after installation (e.g., changing thresholds, intervals, etc.) **Query parameters**: Can specify `model_version` (defaults to 1)
114
+ * Update connection model install configuration
115
+ */
116
+ updateConnectionModelInstallConfigRaw(requestParameters: MachineApiUpdateConnectionModelInstallConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateInstallConfigResponse>>;
117
+ /**
118
+ * Updates the install configuration for a specific connection model on a machine. This allows changing controller settings without reinstalling the entire model. **Authorization** - API token is required in the `Authorization` header **Permissions** - `connections:write` permission is required **Use case**: Modify controller parameters after installation (e.g., changing thresholds, intervals, etc.) **Query parameters**: Can specify `model_version` (defaults to 1)
119
+ * Update connection model install configuration
120
+ */
121
+ updateConnectionModelInstallConfig(requestParameters: MachineApiUpdateConnectionModelInstallConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateInstallConfigResponse>;
122
+ /**
123
+ * Performs batch operations (add, update, delete) on connection models for a specific machine. This endpoint allows you to manage all connection models in a single request. **Authorization** - API token is required in the `Authorization` header **Permissions** - `connections:delete` permission is required for deletions - `connections:write` permission is required for additions and updates **Operations**: - **Add**: If model doesn\'t exist, creates a new connection model - **Update**: If model already exists, updates `view_role_level` and `install_config` - **Delete**: Models not included in the request but currently installed will be deleted **Side effects**: - Updates the machine\'s `connection_models` array
124
+ * Batch update connection models
125
+ */
126
+ updateConnectionModelsRaw(requestParameters: MachineApiUpdateConnectionModelsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateConnectionModelsResponse>>;
127
+ /**
128
+ * Performs batch operations (add, update, delete) on connection models for a specific machine. This endpoint allows you to manage all connection models in a single request. **Authorization** - API token is required in the `Authorization` header **Permissions** - `connections:delete` permission is required for deletions - `connections:write` permission is required for additions and updates **Operations**: - **Add**: If model doesn\'t exist, creates a new connection model - **Update**: If model already exists, updates `view_role_level` and `install_config` - **Delete**: Models not included in the request but currently installed will be deleted **Side effects**: - Updates the machine\'s `connection_models` array
129
+ * Batch update connection models
130
+ */
131
+ updateConnectionModels(requestParameters: MachineApiUpdateConnectionModelsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateConnectionModelsResponse>;
132
+ /**
133
+ * Updates the public visibility status of a machine. When a machine is public, its data can be accessed without authentication through public endpoints. **Authorization** - API token is required in the `Authorization` header **Permissions** - `machines:write` permission is required **Side effects** - Updates `is_public` flag on the machine
134
+ * Update machine public visibility
135
+ */
136
+ updateMachinePublicRaw(requestParameters: MachineApiUpdateMachinePublicOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateMachinePublicResponse>>;
137
+ /**
138
+ * Updates the public visibility status of a machine. When a machine is public, its data can be accessed without authentication through public endpoints. **Authorization** - API token is required in the `Authorization` header **Permissions** - `machines:write` permission is required **Side effects** - Updates `is_public` flag on the machine
139
+ * Update machine public visibility
140
+ */
141
+ updateMachinePublic(requestParameters: MachineApiUpdateMachinePublicOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateMachinePublicResponse>;
142
+ }
@@ -0,0 +1,97 @@
1
+ /**
2
+ * API EN
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { AddBleMachineRequest, AddBleMachineResponse, AddMachineRequest, AddMachineResponse, ListMachinesResponse, SimpleMachine, UnregisterObnizRequest } from '../models/index';
14
+ export interface MachinesApiAddBleMachineOperationRequest {
15
+ addBleMachineRequest: AddBleMachineRequest;
16
+ }
17
+ export interface MachinesApiAddMachineOperationRequest {
18
+ addMachineRequest: AddMachineRequest;
19
+ }
20
+ export interface MachinesApiGetAvailableMachinesForModelRequest {
21
+ modelName: string;
22
+ modelVersion: string;
23
+ }
24
+ export interface MachinesApiListMachinesRequest {
25
+ limit?: number;
26
+ offset?: number;
27
+ searchFilter?: ListMachinesSearchFilterEnum;
28
+ searchWord?: string;
29
+ states?: string;
30
+ }
31
+ export interface MachinesApiUnregisterObnizOperationRequest {
32
+ unregisterObnizRequest: UnregisterObnizRequest;
33
+ }
34
+ /**
35
+ *
36
+ */
37
+ export declare class MachinesApi extends runtime.BaseAPI {
38
+ /**
39
+ * Creates a new machine for a Bluetooth Low Energy (BLE) device. This operation performs the following steps: - Creates a new machine within the account - Optionally installs a controller based on the specified `parts` value - Assigns the machine to one or more groups - Creates a BLE converter linking the device address to the machine **Authorization** - API token is required in the `Authorization` header **Permissions** - `machines:write` permission is required **Notes** - If the specified `parts` value does not have a corresponding controller, the machine is created without installing a controller - The BLE address must be unique within the account
40
+ * Add a BLE device as a machine
41
+ */
42
+ addBleMachineRaw(requestParameters: MachinesApiAddBleMachineOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AddBleMachineResponse>>;
43
+ /**
44
+ * Creates a new machine for a Bluetooth Low Energy (BLE) device. This operation performs the following steps: - Creates a new machine within the account - Optionally installs a controller based on the specified `parts` value - Assigns the machine to one or more groups - Creates a BLE converter linking the device address to the machine **Authorization** - API token is required in the `Authorization` header **Permissions** - `machines:write` permission is required **Notes** - If the specified `parts` value does not have a corresponding controller, the machine is created without installing a controller - The BLE address must be unique within the account
45
+ * Add a BLE device as a machine
46
+ */
47
+ addBleMachine(requestParameters: MachinesApiAddBleMachineOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AddBleMachineResponse>;
48
+ /**
49
+ * Registers an obniz device and creates a new machine linked to it. Checks device availability, registers it if needed, sets up configuration, and installs the app. **Authorization** - API token is required in the `Authorization` header **Permissions** - `machines:write` permission is required
50
+ * Add an obniz device as a machine
51
+ */
52
+ addMachineRaw(requestParameters: MachinesApiAddMachineOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AddMachineResponse>>;
53
+ /**
54
+ * Registers an obniz device and creates a new machine linked to it. Checks device availability, registers it if needed, sets up configuration, and installs the app. **Authorization** - API token is required in the `Authorization` header **Permissions** - `machines:write` permission is required
55
+ * Add an obniz device as a machine
56
+ */
57
+ addMachine(requestParameters: MachinesApiAddMachineOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AddMachineResponse>;
58
+ /**
59
+ * Retrieves all machines in the account that don\'t have a specified model/version installed. Used to find machines where a model can be added. **Authorization** - API token is required in the `Authorization` header **Permissions** - `machines:read` permission is required
60
+ * Get machines without a specific model
61
+ */
62
+ getAvailableMachinesForModelRaw(requestParameters: MachinesApiGetAvailableMachinesForModelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SimpleMachine>>>;
63
+ /**
64
+ * Retrieves all machines in the account that don\'t have a specified model/version installed. Used to find machines where a model can be added. **Authorization** - API token is required in the `Authorization` header **Permissions** - `machines:read` permission is required
65
+ * Get machines without a specific model
66
+ */
67
+ getAvailableMachinesForModel(requestParameters: MachinesApiGetAvailableMachinesForModelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SimpleMachine>>;
68
+ /**
69
+ * Retrieves machines within the account with optional filtering by name, obniz ID, group, or state conditions **Authorization** - API token is required in the `Authorization` header **Permissions** - `machines:read` permission is required
70
+ * Get machines list
71
+ */
72
+ listMachinesRaw(requestParameters: MachinesApiListMachinesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListMachinesResponse>>;
73
+ /**
74
+ * Retrieves machines within the account with optional filtering by name, obniz ID, group, or state conditions **Authorization** - API token is required in the `Authorization` header **Permissions** - `machines:read` permission is required
75
+ * Get machines list
76
+ */
77
+ listMachines(requestParameters?: MachinesApiListMachinesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListMachinesResponse>;
78
+ /**
79
+ * Removes the association between machines and an obniz device by setting connected_obniz_id to null for all machines linked to the specified obniz ID **Authorization** - API token is required in the `Authorization` header **Permissions** - `machines:write` permission is required
80
+ * Unregister obniz device from machines
81
+ */
82
+ unregisterObnizRaw(requestParameters: MachinesApiUnregisterObnizOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
83
+ /**
84
+ * Removes the association between machines and an obniz device by setting connected_obniz_id to null for all machines linked to the specified obniz ID **Authorization** - API token is required in the `Authorization` header **Permissions** - `machines:write` permission is required
85
+ * Unregister obniz device from machines
86
+ */
87
+ unregisterObniz(requestParameters: MachinesApiUnregisterObnizOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
88
+ }
89
+ /**
90
+ * @export
91
+ */
92
+ export declare const ListMachinesSearchFilterEnum: {
93
+ readonly MachineName: "machine_name";
94
+ readonly ObnizId: "obniz_id";
95
+ readonly GroupName: "group_name";
96
+ };
97
+ export type ListMachinesSearchFilterEnum = typeof ListMachinesSearchFilterEnum[keyof typeof ListMachinesSearchFilterEnum];
@@ -0,0 +1,72 @@
1
+ /**
2
+ * API EN
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { CreateNotificationRequest, CreateNotificationResponse, ListNotificationsResponse, TestNotificationResponse } from '../models/index';
14
+ export interface NotificationsApiCreateNotificationOperationRequest {
15
+ createNotificationRequest: CreateNotificationRequest;
16
+ }
17
+ export interface NotificationsApiDeleteNotificationRequest {
18
+ id: string;
19
+ }
20
+ export interface NotificationsApiListNotificationsRequest {
21
+ limit?: number;
22
+ offset?: number;
23
+ groupId?: string;
24
+ }
25
+ export interface NotificationsApiTestNotificationRequest {
26
+ id: string;
27
+ }
28
+ /**
29
+ *
30
+ */
31
+ export declare class NotificationsApi extends runtime.BaseAPI {
32
+ /**
33
+ * Creates a new notification destination with validation for email addresses (checks format and duplicates) **Authorization** - API token is required in the `Authorization` header **Permissions** - `notifications:write` permission is required
34
+ * Create a notification destination
35
+ */
36
+ createNotificationRaw(requestParameters: NotificationsApiCreateNotificationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateNotificationResponse>>;
37
+ /**
38
+ * Creates a new notification destination with validation for email addresses (checks format and duplicates) **Authorization** - API token is required in the `Authorization` header **Permissions** - `notifications:write` permission is required
39
+ * Create a notification destination
40
+ */
41
+ createNotification(requestParameters: NotificationsApiCreateNotificationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateNotificationResponse>;
42
+ /**
43
+ * Permanently removes a notification destination from the account **Authorization** - API token is required in the `Authorization` header **Permissions** - `notifications:delete` permission is required
44
+ * Delete a notification destination
45
+ */
46
+ deleteNotificationRaw(requestParameters: NotificationsApiDeleteNotificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
47
+ /**
48
+ * Permanently removes a notification destination from the account **Authorization** - API token is required in the `Authorization` header **Permissions** - `notifications:delete` permission is required
49
+ * Delete a notification destination
50
+ */
51
+ deleteNotification(requestParameters: NotificationsApiDeleteNotificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
52
+ /**
53
+ * Retrieves notification destinations within the account with pagination **Authorization** - API token is required in the `Authorization` header **Permissions** - `notifications:read` permission is required
54
+ * Get notifications list
55
+ */
56
+ listNotificationsRaw(requestParameters: NotificationsApiListNotificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListNotificationsResponse>>;
57
+ /**
58
+ * Retrieves notification destinations within the account with pagination **Authorization** - API token is required in the `Authorization` header **Permissions** - `notifications:read` permission is required
59
+ * Get notifications list
60
+ */
61
+ listNotifications(requestParameters?: NotificationsApiListNotificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListNotificationsResponse>;
62
+ /**
63
+ * Sends a test notification to verify the configuration is working correctly **Authorization** - API token is required in the `Authorization` header **Permissions** - `notifications:write` permission is required
64
+ * Test a notification destination
65
+ */
66
+ testNotificationRaw(requestParameters: NotificationsApiTestNotificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TestNotificationResponse>>;
67
+ /**
68
+ * Sends a test notification to verify the configuration is working correctly **Authorization** - API token is required in the `Authorization` header **Permissions** - `notifications:write` permission is required
69
+ * Test a notification destination
70
+ */
71
+ testNotification(requestParameters: NotificationsApiTestNotificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TestNotificationResponse>;
72
+ }
@@ -0,0 +1,85 @@
1
+ /**
2
+ * API EN
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { CSVExportStatusResponse, CreateCSVExportRequest, CreateCSVExportResponse, ListCSVExportsResponse, ListReportsResponse } from '../models/index';
14
+ export interface ReportsApiCreateCSVExportOperationRequest {
15
+ createCSVExportRequest: CreateCSVExportRequest;
16
+ }
17
+ export interface ReportsApiGetCSVExportStatusRequest {
18
+ exportId: string;
19
+ }
20
+ export interface ReportsApiListCSVExportsRequest {
21
+ limit?: number;
22
+ offset?: number;
23
+ groupId?: string;
24
+ status?: ListCSVExportsStatusEnum;
25
+ }
26
+ export interface ReportsApiListReportsRequest {
27
+ limit?: number;
28
+ offset?: number;
29
+ groupId?: string;
30
+ }
31
+ /**
32
+ *
33
+ */
34
+ export declare class ReportsApi extends runtime.BaseAPI {
35
+ /**
36
+ * Creates a new CSV export job for the specified units and properties. **Authorization** - API token is required in the `Authorization` header **Permissions** - `reports:write` permission is required **Plan Limitations** - Subject to plan limits for report generation - Maximum concurrent CSV exports applies **Validation** - units array must not be empty - properties array must not be empty - start_date and end_date are required - Each unit must have unit_id and label - Each property must have a key
37
+ * Create CSV export
38
+ */
39
+ createCSVExportRaw(requestParameters: ReportsApiCreateCSVExportOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateCSVExportResponse>>;
40
+ /**
41
+ * Creates a new CSV export job for the specified units and properties. **Authorization** - API token is required in the `Authorization` header **Permissions** - `reports:write` permission is required **Plan Limitations** - Subject to plan limits for report generation - Maximum concurrent CSV exports applies **Validation** - units array must not be empty - properties array must not be empty - start_date and end_date are required - Each unit must have unit_id and label - Each property must have a key
42
+ * Create CSV export
43
+ */
44
+ createCSVExport(requestParameters: ReportsApiCreateCSVExportOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateCSVExportResponse>;
45
+ /**
46
+ * Retrieves the status and details of a specific CSV export job. - User must own the export (account_id must match) **Authorization** - API token is required in the `Authorization` header **Permissions** - `reports:read` permission is required **Export Status** - pending: Export queued but not started - processing: Export in progress - completed: Export finished, file available for download - failed: Export failed
47
+ * Get CSV export status
48
+ */
49
+ getCSVExportStatusRaw(requestParameters: ReportsApiGetCSVExportStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CSVExportStatusResponse>>;
50
+ /**
51
+ * Retrieves the status and details of a specific CSV export job. - User must own the export (account_id must match) **Authorization** - API token is required in the `Authorization` header **Permissions** - `reports:read` permission is required **Export Status** - pending: Export queued but not started - processing: Export in progress - completed: Export finished, file available for download - failed: Export failed
52
+ * Get CSV export status
53
+ */
54
+ getCSVExportStatus(requestParameters: ReportsApiGetCSVExportStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CSVExportStatusResponse>;
55
+ /**
56
+ * Returns a paginated list of CSV export jobs for the account. **Authorization** - API token is required in the `Authorization` header **Permissions** - `reports:read` permission is required **Filtering** - Filter by group_id (optional) - Filter by status (optional)
57
+ * List CSV exports
58
+ */
59
+ listCSVExportsRaw(requestParameters: ReportsApiListCSVExportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListCSVExportsResponse>>;
60
+ /**
61
+ * Returns a paginated list of CSV export jobs for the account. **Authorization** - API token is required in the `Authorization` header **Permissions** - `reports:read` permission is required **Filtering** - Filter by group_id (optional) - Filter by status (optional)
62
+ * List CSV exports
63
+ */
64
+ listCSVExports(requestParameters?: ReportsApiListCSVExportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListCSVExportsResponse>;
65
+ /**
66
+ * Retrieves export reports associated with the account and group with pagination **Authorization** - API token is required in the `Authorization` header **Permissions** - `reports:read` permission is required
67
+ * Get reports list
68
+ */
69
+ listReportsRaw(requestParameters: ReportsApiListReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListReportsResponse>>;
70
+ /**
71
+ * Retrieves export reports associated with the account and group with pagination **Authorization** - API token is required in the `Authorization` header **Permissions** - `reports:read` permission is required
72
+ * Get reports list
73
+ */
74
+ listReports(requestParameters?: ReportsApiListReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListReportsResponse>;
75
+ }
76
+ /**
77
+ * @export
78
+ */
79
+ export declare const ListCSVExportsStatusEnum: {
80
+ readonly Pending: "pending";
81
+ readonly Processing: "processing";
82
+ readonly Completed: "completed";
83
+ readonly Failed: "failed";
84
+ };
85
+ export type ListCSVExportsStatusEnum = typeof ListCSVExportsStatusEnum[keyof typeof ListCSVExportsStatusEnum];