@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,35 @@
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 { AnalyticsResult } from '../models/index';
14
+ export interface AnalyticsApiGetAnalyticsResultsRequest {
15
+ analyticsModelId: string;
16
+ unitId: string;
17
+ start?: string;
18
+ end?: string;
19
+ params?: string;
20
+ }
21
+ /**
22
+ *
23
+ */
24
+ export declare class AnalyticsApi extends runtime.BaseAPI {
25
+ /**
26
+ * Executes the specified analytics model and returns calculation results. The structure of the result objects depends on the analytics model implementation. If start or end is omitted, the analytics model is executed once without interval splitting. **Authorization** - API token is required in the `Authorization` header **Permissions** - `analytics:read` permission is required
27
+ * Get analytics results for a specific model
28
+ */
29
+ getAnalyticsResultsRaw(requestParameters: AnalyticsApiGetAnalyticsResultsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AnalyticsResult>>>;
30
+ /**
31
+ * Executes the specified analytics model and returns calculation results. The structure of the result objects depends on the analytics model implementation. If start or end is omitted, the analytics model is executed once without interval splitting. **Authorization** - API token is required in the `Authorization` header **Permissions** - `analytics:read` permission is required
32
+ * Get analytics results for a specific model
33
+ */
34
+ getAnalyticsResults(requestParameters: AnalyticsApiGetAnalyticsResultsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AnalyticsResult>>;
35
+ }
@@ -0,0 +1,89 @@
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, UpdateConnectionModelsRequest, UpdateConnectionModelsResponse, UpdateInstallConfigRequest, UpdateInstallConfigResponse } from '../models/index';
14
+ export interface ConnectionModelsApiGetAvailableConnectionModelsRequest {
15
+ machineId: string;
16
+ }
17
+ export interface ConnectionModelsApiGetConnectionModelByNameRequest {
18
+ machineId: string;
19
+ modelName: string;
20
+ modelVersion?: number;
21
+ }
22
+ export interface ConnectionModelsApiGetMachineConnectionModelsRequest {
23
+ machineId: string;
24
+ }
25
+ export interface ConnectionModelsApiUpdateConnectionModelInstallConfigRequest {
26
+ machineId: string;
27
+ modelName: string;
28
+ updateInstallConfigRequest: UpdateInstallConfigRequest;
29
+ modelVersion?: number;
30
+ }
31
+ export interface ConnectionModelsApiUpdateConnectionModelsOperationRequest {
32
+ machineId: string;
33
+ updateConnectionModelsRequest: UpdateConnectionModelsRequest;
34
+ }
35
+ /**
36
+ *
37
+ */
38
+ export declare class ConnectionModelsApi extends runtime.BaseAPI {
39
+ /**
40
+ * 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
41
+ * List available connection models for installation
42
+ */
43
+ getAvailableConnectionModelsRaw(requestParameters: ConnectionModelsApiGetAvailableConnectionModelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AvailableController>>>;
44
+ /**
45
+ * 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
46
+ * List available connection models for installation
47
+ */
48
+ getAvailableConnectionModels(requestParameters: ConnectionModelsApiGetAvailableConnectionModelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AvailableController>>;
49
+ /**
50
+ * 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)
51
+ * Get specific connection model details
52
+ */
53
+ getConnectionModelByNameRaw(requestParameters: ConnectionModelsApiGetConnectionModelByNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConnectionModelDetailed>>;
54
+ /**
55
+ * 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)
56
+ * Get specific connection model details
57
+ */
58
+ getConnectionModelByName(requestParameters: ConnectionModelsApiGetConnectionModelByNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConnectionModelDetailed>;
59
+ /**
60
+ * 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`
61
+ * List machine\'s connection models
62
+ */
63
+ getMachineConnectionModelsRaw(requestParameters: ConnectionModelsApiGetMachineConnectionModelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ConnectionModelDetailed>>>;
64
+ /**
65
+ * 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`
66
+ * List machine\'s connection models
67
+ */
68
+ getMachineConnectionModels(requestParameters: ConnectionModelsApiGetMachineConnectionModelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ConnectionModelDetailed>>;
69
+ /**
70
+ * 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)
71
+ * Update connection model install configuration
72
+ */
73
+ updateConnectionModelInstallConfigRaw(requestParameters: ConnectionModelsApiUpdateConnectionModelInstallConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateInstallConfigResponse>>;
74
+ /**
75
+ * 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)
76
+ * Update connection model install configuration
77
+ */
78
+ updateConnectionModelInstallConfig(requestParameters: ConnectionModelsApiUpdateConnectionModelInstallConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateInstallConfigResponse>;
79
+ /**
80
+ * 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
81
+ * Batch update connection models
82
+ */
83
+ updateConnectionModelsRaw(requestParameters: ConnectionModelsApiUpdateConnectionModelsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateConnectionModelsResponse>>;
84
+ /**
85
+ * 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
86
+ * Batch update connection models
87
+ */
88
+ updateConnectionModels(requestParameters: ConnectionModelsApiUpdateConnectionModelsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateConnectionModelsResponse>;
89
+ }
@@ -0,0 +1,61 @@
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 { AddConnectionsRequest, AddConnectionsResponse, ListConnectionsResponse } from '../models/index';
14
+ export interface ConnectionsApiAddConnectionsOperationRequest {
15
+ addConnectionsRequest: AddConnectionsRequest;
16
+ }
17
+ export interface ConnectionsApiDeleteConnectionRequest {
18
+ machineId: string;
19
+ modelName: string;
20
+ modelVersion: number;
21
+ }
22
+ export interface ConnectionsApiListConnectionsRequest {
23
+ limit?: number;
24
+ offset?: number;
25
+ types?: string;
26
+ }
27
+ /**
28
+ *
29
+ */
30
+ export declare class ConnectionsApi extends runtime.BaseAPI {
31
+ /**
32
+ * Creates new connection models linking a controller model to one or more machines. Can target specific machines by ID or all machines that don\'t have this model installed. Automatically handles pagination when using \'all\' to process large numbers of machines. **Authorization** - API token is required in the `Authorization` header - Only account owners can access this endpoint **Permissions** - `connections:write` permission is required
33
+ * Add model connections to machines
34
+ */
35
+ addConnectionsRaw(requestParameters: ConnectionsApiAddConnectionsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AddConnectionsResponse>>;
36
+ /**
37
+ * Creates new connection models linking a controller model to one or more machines. Can target specific machines by ID or all machines that don\'t have this model installed. Automatically handles pagination when using \'all\' to process large numbers of machines. **Authorization** - API token is required in the `Authorization` header - Only account owners can access this endpoint **Permissions** - `connections:write` permission is required
38
+ * Add model connections to machines
39
+ */
40
+ addConnections(requestParameters: ConnectionsApiAddConnectionsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AddConnectionsResponse>;
41
+ /**
42
+ * Removes a connection model linking a controller to a machine. This disconnects the specified controller model from the machine. **Authorization** - API token is required in the `Authorization` header - Only account owners can access this endpoint **Permissions** - `connections:delete` permission is required
43
+ * Delete a connection model
44
+ */
45
+ deleteConnectionRaw(requestParameters: ConnectionsApiDeleteConnectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
46
+ /**
47
+ * Removes a connection model linking a controller to a machine. This disconnects the specified controller model from the machine. **Authorization** - API token is required in the `Authorization` header - Only account owners can access this endpoint **Permissions** - `connections:delete` permission is required
48
+ * Delete a connection model
49
+ */
50
+ deleteConnection(requestParameters: ConnectionsApiDeleteConnectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
51
+ /**
52
+ * Retrieves a paginated list of connection models associated with machines in the account. Connections link controller models to machines, enabling specific functionality. Results can be filtered by controller type. **Authorization** - API token is required in the `Authorization` header **Permissions** - `connections:read` permission is required
53
+ * Get list of connections
54
+ */
55
+ listConnectionsRaw(requestParameters: ConnectionsApiListConnectionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListConnectionsResponse>>;
56
+ /**
57
+ * Retrieves a paginated list of connection models associated with machines in the account. Connections link controller models to machines, enabling specific functionality. Results can be filtered by controller type. **Authorization** - API token is required in the `Authorization` header **Permissions** - `connections:read` permission is required
58
+ * Get list of connections
59
+ */
60
+ listConnections(requestParameters?: ConnectionsApiListConnectionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListConnectionsResponse>;
61
+ }
@@ -0,0 +1,28 @@
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 { Converter } from '../models/index';
14
+ /**
15
+ *
16
+ */
17
+ export declare class ConvertersApi extends runtime.BaseAPI {
18
+ /**
19
+ * Retrieves all converter mappings for the authenticated account. Converters are used to map external device identifiers (e.g., Bluetooth addresses, RFID tags) to internal unit IDs (typically machine IDs) for data routing and processing. **Authorization** - API token is required in the `Authorization` header **Permissions** - `converters:read` permission is required
20
+ * Get all converters
21
+ */
22
+ listConvertersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Converter>>>;
23
+ /**
24
+ * Retrieves all converter mappings for the authenticated account. Converters are used to map external device identifiers (e.g., Bluetooth addresses, RFID tags) to internal unit IDs (typically machine IDs) for data routing and processing. **Authorization** - API token is required in the `Authorization` header **Permissions** - `converters:read` permission is required
25
+ * Get all converters
26
+ */
27
+ listConverters(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Converter>>;
28
+ }
@@ -0,0 +1,49 @@
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 { ListEventsResponse } from '../models/index';
14
+ export interface EventsApiListEventsRequest {
15
+ limit?: number;
16
+ offset?: number;
17
+ start?: string;
18
+ end?: string;
19
+ machineIds?: Array<string>;
20
+ groupId?: string;
21
+ minLevel?: ListEventsMinLevelEnum;
22
+ name?: string;
23
+ }
24
+ /**
25
+ *
26
+ */
27
+ export declare class EventsApi extends runtime.BaseAPI {
28
+ /**
29
+ * Retrieves events in reverse chronological order with optional filtering and pagination **Authorization** - API token is required in the `Authorization` header **Permissions** - `events:read` permission is required
30
+ * Get events list
31
+ */
32
+ listEventsRaw(requestParameters: EventsApiListEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListEventsResponse>>;
33
+ /**
34
+ * Retrieves events in reverse chronological order with optional filtering and pagination **Authorization** - API token is required in the `Authorization` header **Permissions** - `events:read` permission is required
35
+ * Get events list
36
+ */
37
+ listEvents(requestParameters?: EventsApiListEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListEventsResponse>;
38
+ }
39
+ /**
40
+ * @export
41
+ */
42
+ export declare const ListEventsMinLevelEnum: {
43
+ readonly None: "none";
44
+ readonly Debug: "debug";
45
+ readonly Info: "info";
46
+ readonly Warning: "warning";
47
+ readonly Emergency: "emergency";
48
+ };
49
+ export type ListEventsMinLevelEnum = typeof ListEventsMinLevelEnum[keyof typeof ListEventsMinLevelEnum];
@@ -0,0 +1,62 @@
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 { GetGroupResponse, ListGroupsResponse, UpdateGroupCustomFieldsRequest, UpdateGroupCustomFieldsResponse } from '../models/index';
14
+ export interface GroupsApiGetGroupRequest {
15
+ groupId: string;
16
+ limit?: number;
17
+ offset?: number;
18
+ }
19
+ export interface GroupsApiListGroupsRequest {
20
+ searchWord?: string;
21
+ offset?: number;
22
+ limit?: number;
23
+ }
24
+ export interface GroupsApiUpdateGroupCustomFieldsOperationRequest {
25
+ groupId: string;
26
+ updateGroupCustomFieldsRequest: UpdateGroupCustomFieldsRequest;
27
+ }
28
+ /**
29
+ *
30
+ */
31
+ export declare class GroupsApi extends runtime.BaseAPI {
32
+ /**
33
+ * Returns group information along with machines belonging to the group. The user must belong to the same account and have sufficient permissions (owner role or explicit membership in the requested group). Pagination is applied to the machines list using limit and offset. **Authorization** - API token is required in the `Authorization` header **Permissions** - `groups:read` permission is required
34
+ * Get group information
35
+ */
36
+ getGroupRaw(requestParameters: GroupsApiGetGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetGroupResponse>>;
37
+ /**
38
+ * Returns group information along with machines belonging to the group. The user must belong to the same account and have sufficient permissions (owner role or explicit membership in the requested group). Pagination is applied to the machines list using limit and offset. **Authorization** - API token is required in the `Authorization` header **Permissions** - `groups:read` permission is required
39
+ * Get group information
40
+ */
41
+ getGroup(requestParameters: GroupsApiGetGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetGroupResponse>;
42
+ /**
43
+ * Returns a paginated list of groups accessible to the user. Access scope depends on user role: - Owner: all groups in the account - Member: only the group the user belongs to Results can be filtered by group name using a case-insensitive partial match. **Authorization** - API token is required in the `Authorization` header **Permissions** - `groups:read` permission is required
44
+ * Get group list
45
+ */
46
+ listGroupsRaw(requestParameters: GroupsApiListGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListGroupsResponse>>;
47
+ /**
48
+ * Returns a paginated list of groups accessible to the user. Access scope depends on user role: - Owner: all groups in the account - Member: only the group the user belongs to Results can be filtered by group name using a case-insensitive partial match. **Authorization** - API token is required in the `Authorization` header **Permissions** - `groups:read` permission is required
49
+ * Get group list
50
+ */
51
+ listGroups(requestParameters?: GroupsApiListGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListGroupsResponse>;
52
+ /**
53
+ * Replaces custom fields for the specified group. The user must be an account owner or belong to the target group. Existing custom fields are fully replaced by the provided object. **Authorization** - API token is required in the `Authorization` header **Permissions** - `groups:write` permission is required
54
+ * Update group custom fields
55
+ */
56
+ updateGroupCustomFieldsRaw(requestParameters: GroupsApiUpdateGroupCustomFieldsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateGroupCustomFieldsResponse>>;
57
+ /**
58
+ * Replaces custom fields for the specified group. The user must be an account owner or belong to the target group. Existing custom fields are fully replaced by the provided object. **Authorization** - API token is required in the `Authorization` header **Permissions** - `groups:write` permission is required
59
+ * Update group custom fields
60
+ */
61
+ updateGroupCustomFields(requestParameters: GroupsApiUpdateGroupCustomFieldsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateGroupCustomFieldsResponse>;
62
+ }
@@ -0,0 +1,47 @@
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 { BatchCreateConnectionsRequest, BatchCreateConnectionsResponse, ListInboundConnectionsResponse } from '../models/index';
14
+ export interface InboundConnectionsApiBatchCreateConnectionsOperationRequest {
15
+ id: string;
16
+ batchCreateConnectionsRequest: BatchCreateConnectionsRequest;
17
+ }
18
+ export interface InboundConnectionsApiListInboundConnectionsRequest {
19
+ id: string;
20
+ limit?: number;
21
+ offset?: number;
22
+ }
23
+ /**
24
+ *
25
+ */
26
+ export declare class InboundConnectionsApi extends runtime.BaseAPI {
27
+ /**
28
+ * Creates multiple machines and their inbound connections in a single request. **Authorization** - API token is required in the `Authorization` header **Permissions** - `inbound_sources:write` permission is required **Results** Each unit in the request gets a result indicating success or error.
29
+ * Batch create inbound connections
30
+ */
31
+ batchCreateConnectionsRaw(requestParameters: InboundConnectionsApiBatchCreateConnectionsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BatchCreateConnectionsResponse>>;
32
+ /**
33
+ * Creates multiple machines and their inbound connections in a single request. **Authorization** - API token is required in the `Authorization` header **Permissions** - `inbound_sources:write` permission is required **Results** Each unit in the request gets a result indicating success or error.
34
+ * Batch create inbound connections
35
+ */
36
+ batchCreateConnections(requestParameters: InboundConnectionsApiBatchCreateConnectionsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BatchCreateConnectionsResponse>;
37
+ /**
38
+ * Returns a paginated list of inbound connections for a specific inbound source. **Authorization** - API token is required in the `Authorization` header **Permissions** - `inbound_sources:read` permission is required
39
+ * List inbound connections
40
+ */
41
+ listInboundConnectionsRaw(requestParameters: InboundConnectionsApiListInboundConnectionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListInboundConnectionsResponse>>;
42
+ /**
43
+ * Returns a paginated list of inbound connections for a specific inbound source. **Authorization** - API token is required in the `Authorization` header **Permissions** - `inbound_sources:read` permission is required
44
+ * List inbound connections
45
+ */
46
+ listInboundConnections(requestParameters: InboundConnectionsApiListInboundConnectionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListInboundConnectionsResponse>;
47
+ }
@@ -0,0 +1,113 @@
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 { AddInboundSourceRequest, AddInboundSourceResponse, InboundSource, ListInboundSourcesResponse, ReceiveDataResponse, RemoveDetectionRequest, UpdateInboundSourceRequest } from '../models/index';
14
+ export interface InboundSourcesApiAddInboundSourceOperationRequest {
15
+ addInboundSourceRequest: AddInboundSourceRequest;
16
+ }
17
+ export interface InboundSourcesApiDeleteInboundSourceRequest {
18
+ id: string;
19
+ }
20
+ export interface InboundSourcesApiGetInboundSourceRequest {
21
+ id: string;
22
+ }
23
+ export interface InboundSourcesApiListInboundSourcesRequest {
24
+ name?: string;
25
+ limit?: number;
26
+ offset?: number;
27
+ }
28
+ export interface InboundSourcesApiReceiveInboundDataRequest {
29
+ id: string;
30
+ }
31
+ export interface InboundSourcesApiRemoveDetectionOperationRequest {
32
+ id: string;
33
+ removeDetectionRequest: RemoveDetectionRequest;
34
+ }
35
+ export interface InboundSourcesApiUpdateInboundSourceOperationRequest {
36
+ id: string;
37
+ updateInboundSourceRequest: UpdateInboundSourceRequest;
38
+ }
39
+ /**
40
+ *
41
+ */
42
+ export declare class InboundSourcesApi extends runtime.BaseAPI {
43
+ /**
44
+ * Creates a new inbound data source. **Authorization** - API token is required in the `Authorization` header **Permissions** - `inbound_sources:write` permission is required **Supported Gateway Models** - SLGW_01 - Salta Gateway **Supported Formats** - application/x-www-form-urlencoded - application/json
45
+ * Create inbound source
46
+ */
47
+ addInboundSourceRaw(requestParameters: InboundSourcesApiAddInboundSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AddInboundSourceResponse>>;
48
+ /**
49
+ * Creates a new inbound data source. **Authorization** - API token is required in the `Authorization` header **Permissions** - `inbound_sources:write` permission is required **Supported Gateway Models** - SLGW_01 - Salta Gateway **Supported Formats** - application/x-www-form-urlencoded - application/json
50
+ * Create inbound source
51
+ */
52
+ addInboundSource(requestParameters: InboundSourcesApiAddInboundSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AddInboundSourceResponse>;
53
+ /**
54
+ * Deletes an existing inbound source by ID. **Authorization** - API token is required in the `Authorization` header **Permissions** - `inbound_sources:delete` permission is required
55
+ * Delete inbound source
56
+ */
57
+ deleteInboundSourceRaw(requestParameters: InboundSourcesApiDeleteInboundSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
58
+ /**
59
+ * Deletes an existing inbound source by ID. **Authorization** - API token is required in the `Authorization` header **Permissions** - `inbound_sources:delete` permission is required
60
+ * Delete inbound source
61
+ */
62
+ deleteInboundSource(requestParameters: InboundSourcesApiDeleteInboundSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
63
+ /**
64
+ * Retrieves a single inbound source by ID. **Authorization** - API token is required in the `Authorization` header **Permissions** - `inbound_sources:read` permission is required
65
+ * Get inbound source
66
+ */
67
+ getInboundSourceRaw(requestParameters: InboundSourcesApiGetInboundSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InboundSource>>;
68
+ /**
69
+ * Retrieves a single inbound source by ID. **Authorization** - API token is required in the `Authorization` header **Permissions** - `inbound_sources:read` permission is required
70
+ * Get inbound source
71
+ */
72
+ getInboundSource(requestParameters: InboundSourcesApiGetInboundSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InboundSource>;
73
+ /**
74
+ * Returns a paginated list of inbound sources. **Authorization** - API token is required in the `Authorization` header **Permissions** - `inbound_sources:read` permission is required **Filtering** - Filter by name (partial match)
75
+ * List inbound sources
76
+ */
77
+ listInboundSourcesRaw(requestParameters: InboundSourcesApiListInboundSourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListInboundSourcesResponse>>;
78
+ /**
79
+ * Returns a paginated list of inbound sources. **Authorization** - API token is required in the `Authorization` header **Permissions** - `inbound_sources:read` permission is required **Filtering** - Filter by name (partial match)
80
+ * List inbound sources
81
+ */
82
+ listInboundSources(requestParameters?: InboundSourcesApiListInboundSourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListInboundSourcesResponse>;
83
+ /**
84
+ * Receives sensor data from external gateway devices. **Authorization** - API token is required in the `Authorization` header **Permissions** - `inbound_sources_upload:write` permission is required **Rate Limiting** - Limited by account plan (InboundSourcesUpload limit) - Returns 402 when limit is exceeded **Supported Formats** - application/x-www-form-urlencoded (SLGW_01 gateway) - application/json (not yet supported - returns 501)
85
+ * Receive sensor data
86
+ */
87
+ receiveInboundDataRaw(requestParameters: InboundSourcesApiReceiveInboundDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReceiveDataResponse>>;
88
+ /**
89
+ * Receives sensor data from external gateway devices. **Authorization** - API token is required in the `Authorization` header **Permissions** - `inbound_sources_upload:write` permission is required **Rate Limiting** - Limited by account plan (InboundSourcesUpload limit) - Returns 402 when limit is exceeded **Supported Formats** - application/x-www-form-urlencoded (SLGW_01 gateway) - application/json (not yet supported - returns 501)
90
+ * Receive sensor data
91
+ */
92
+ receiveInboundData(requestParameters: InboundSourcesApiReceiveInboundDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReceiveDataResponse | null | undefined>;
93
+ /**
94
+ * Removes a sensor ID from the inbound source\'s external_detections list. **Authorization** - API token is required in the `Authorization` header **Permissions** - `inbound_sources:delete` permission is required
95
+ * Remove sensor detection
96
+ */
97
+ removeDetectionRaw(requestParameters: InboundSourcesApiRemoveDetectionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
98
+ /**
99
+ * Removes a sensor ID from the inbound source\'s external_detections list. **Authorization** - API token is required in the `Authorization` header **Permissions** - `inbound_sources:delete` permission is required
100
+ * Remove sensor detection
101
+ */
102
+ removeDetection(requestParameters: InboundSourcesApiRemoveDetectionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
103
+ /**
104
+ * Partially updates an existing inbound source. **Authorization** - API token is required in the `Authorization` header **Permissions** - `inbound_sources:write` permission is required **Updatable Fields** - id - account_id - name - format - gateway_id - gateway_model - created_at - updated_at
105
+ * Update inbound source
106
+ */
107
+ updateInboundSourceRaw(requestParameters: InboundSourcesApiUpdateInboundSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
108
+ /**
109
+ * Partially updates an existing inbound source. **Authorization** - API token is required in the `Authorization` header **Permissions** - `inbound_sources:write` permission is required **Updatable Fields** - id - account_id - name - format - gateway_id - gateway_model - created_at - updated_at
110
+ * Update inbound source
111
+ */
112
+ updateInboundSource(requestParameters: InboundSourcesApiUpdateInboundSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
113
+ }
@@ -0,0 +1,121 @@
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 { AddIntegrationsRequest, AddIntegrationsResponse, Integration, ListIntegrationsResponse, TransformIntegrationRequest, UpdateIntegrationRequest } from '../models/index';
14
+ export interface IntegrationsApiAddIntegrationsOperationRequest {
15
+ addIntegrationsRequest: AddIntegrationsRequest;
16
+ }
17
+ export interface IntegrationsApiDeleteIntegrationRequest {
18
+ id: string;
19
+ }
20
+ export interface IntegrationsApiGetIntegrationRequest {
21
+ id: string;
22
+ }
23
+ export interface IntegrationsApiGetIntegrationDataRequest {
24
+ id: string;
25
+ }
26
+ export interface IntegrationsApiListIntegrationsRequest {
27
+ machineIds?: string;
28
+ name?: string;
29
+ limit?: number;
30
+ offset?: number;
31
+ }
32
+ export interface IntegrationsApiTransformIntegrationOperationRequest {
33
+ transformIntegrationRequest: TransformIntegrationRequest;
34
+ }
35
+ export interface IntegrationsApiUpdateIntegrationOperationRequest {
36
+ id: string;
37
+ updateIntegrationRequest: UpdateIntegrationRequest;
38
+ }
39
+ /**
40
+ *
41
+ */
42
+ export declare class IntegrationsApi extends runtime.BaseAPI {
43
+ /**
44
+ * Creates integrations for multiple machines in a single request. One integration is created per machine. **Authorization** - API token is required in the `Authorization` header **Permissions** - `integrations:write` permission is required
45
+ * Add integrations for multiple machines
46
+ */
47
+ addIntegrationsRaw(requestParameters: IntegrationsApiAddIntegrationsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AddIntegrationsResponse>>;
48
+ /**
49
+ * Creates integrations for multiple machines in a single request. One integration is created per machine. **Authorization** - API token is required in the `Authorization` header **Permissions** - `integrations:write` permission is required
50
+ * Add integrations for multiple machines
51
+ */
52
+ addIntegrations(requestParameters: IntegrationsApiAddIntegrationsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AddIntegrationsResponse>;
53
+ /**
54
+ * Deletes an existing integration by ID. **Authorization** - API token is required in the `Authorization` header **Permissions** - `integrations:delete` permission is required
55
+ * Delete integration
56
+ */
57
+ deleteIntegrationRaw(requestParameters: IntegrationsApiDeleteIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
58
+ /**
59
+ * Deletes an existing integration by ID. **Authorization** - API token is required in the `Authorization` header **Permissions** - `integrations:delete` permission is required
60
+ * Delete integration
61
+ */
62
+ deleteIntegration(requestParameters: IntegrationsApiDeleteIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
63
+ /**
64
+ * Returns detailed information about a specific integration. **Authorization** - API token is required in the `Authorization` header **Permissions** - `integrations:read` permission is required
65
+ * Get integration by ID
66
+ */
67
+ getIntegrationRaw(requestParameters: IntegrationsApiGetIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Integration>>;
68
+ /**
69
+ * Returns detailed information about a specific integration. **Authorization** - API token is required in the `Authorization` header **Permissions** - `integrations:read` permission is required
70
+ * Get integration by ID
71
+ */
72
+ getIntegration(requestParameters: IntegrationsApiGetIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Integration>;
73
+ /**
74
+ * Retrieves transformed machine data through an API Pull integration. This endpoint: - Validates the integration exists and is enabled - Collects machine state data since last usage - Transforms data according to integration schema **Authorization** - API token is required in the `Authorization` header **Permissions** - `integrations:read` permission is required **Rate Limiting** - Rate limits are based on account plan - Returns X-RateLimit-Limit and X-RateLimit-Remaining headers **Notes** - Only works with APIPull type integrations - Returns data collected since the integration was last used (or last 30 minutes)
75
+ * Get integration data
76
+ */
77
+ getIntegrationDataRaw(requestParameters: IntegrationsApiGetIntegrationDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
78
+ [key: string]: any;
79
+ }>>;
80
+ /**
81
+ * Retrieves transformed machine data through an API Pull integration. This endpoint: - Validates the integration exists and is enabled - Collects machine state data since last usage - Transforms data according to integration schema **Authorization** - API token is required in the `Authorization` header **Permissions** - `integrations:read` permission is required **Rate Limiting** - Rate limits are based on account plan - Returns X-RateLimit-Limit and X-RateLimit-Remaining headers **Notes** - Only works with APIPull type integrations - Returns data collected since the integration was last used (or last 30 minutes)
82
+ * Get integration data
83
+ */
84
+ getIntegrationData(requestParameters: IntegrationsApiGetIntegrationDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
85
+ [key: string]: any;
86
+ }>;
87
+ /**
88
+ * Returns a paginated list of integrations. **Authorization**: - API token is required in the `Authorization` header **Permissions** - `integrations:read` permission is required **Filtering**: - Filter by machine IDs - Filter by integration name (partial match)
89
+ * List integrations
90
+ */
91
+ listIntegrationsRaw(requestParameters: IntegrationsApiListIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListIntegrationsResponse>>;
92
+ /**
93
+ * Returns a paginated list of integrations. **Authorization**: - API token is required in the `Authorization` header **Permissions** - `integrations:read` permission is required **Filtering**: - Filter by machine IDs - Filter by integration name (partial match)
94
+ * List integrations
95
+ */
96
+ listIntegrations(requestParameters?: IntegrationsApiListIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListIntegrationsResponse>;
97
+ /**
98
+ * Tests an integration schema by transforming sample or provided data. This endpoint allows you to: - Validate integration schema before creating an integration - Test data transformation with sample controller data - Provide custom data to test transformation - Preview the output format **Authorization** - API token is required in the `Authorization` header **Permissions** - `integrations:write` permission is required **Supported Integration Types** - PubSub - Transforms data for Google Cloud Pub/Sub - APIPull - Transforms data for API Pull endpoints - APIPush - Transforms data for API Push endpoints
99
+ * Test integration transformation
100
+ */
101
+ transformIntegrationRaw(requestParameters: IntegrationsApiTransformIntegrationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
102
+ [key: string]: any;
103
+ }>>;
104
+ /**
105
+ * Tests an integration schema by transforming sample or provided data. This endpoint allows you to: - Validate integration schema before creating an integration - Test data transformation with sample controller data - Provide custom data to test transformation - Preview the output format **Authorization** - API token is required in the `Authorization` header **Permissions** - `integrations:write` permission is required **Supported Integration Types** - PubSub - Transforms data for Google Cloud Pub/Sub - APIPull - Transforms data for API Pull endpoints - APIPush - Transforms data for API Push endpoints
106
+ * Test integration transformation
107
+ */
108
+ transformIntegration(requestParameters: IntegrationsApiTransformIntegrationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
109
+ [key: string]: any;
110
+ }>;
111
+ /**
112
+ * Partially updates an existing integration. **Authorization** - API token is required in the `Authorization` header **Permissions** - `integrations:write` permission is required **Updatable Fields** - Any field from the Integration schema can be updated using this endpoint. - Common fields include name, enabled, schema, configuration, service, credentials.
113
+ * Update integration
114
+ */
115
+ updateIntegrationRaw(requestParameters: IntegrationsApiUpdateIntegrationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
116
+ /**
117
+ * Partially updates an existing integration. **Authorization** - API token is required in the `Authorization` header **Permissions** - `integrations:write` permission is required **Updatable Fields** - Any field from the Integration schema can be updated using this endpoint. - Common fields include name, enabled, schema, configuration, service, credentials.
118
+ * Update integration
119
+ */
120
+ updateIntegration(requestParameters: IntegrationsApiUpdateIntegrationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
121
+ }