@edgeiq/edgeiq-api-js 1.4.12 → 1.4.13

package/dist/deviceTypes/models.d.ts

@@ -1,110 +1,112 @@
-import { Base, Filter, Filters, Pagination } from '../models';
-export declare type TypeDeviceType = 'gateway' | 'sensor' | 'cloud_native' | 'modem' | 'lwm2m';
-export declare type DeviceTypeRole = 'gateway' | 'endpoint';
-export interface NetworkConnection {
-    type: string;
-    interface?: string;
-    name: string;
-}
-export interface Peripheral {
-    type: string;
-    device: string;
-}
-export interface Firmware {
-    upgrade: boolean;
-    backup: boolean;
-}
-export interface Actions {
-    sms_at_command_status_request: boolean;
-    notification: boolean;
-    enable_data_restriction: boolean;
-    disable_data_restriction: boolean;
-    send_config: boolean;
-    deploy_deployment: boolean;
-    request_deployment_status: boolean;
-    data_restore: boolean;
-    update_edge: boolean;
-    update_firmware: boolean;
-    restore_backup: boolean;
-    backup: boolean;
-    log_level: boolean;
-    log_config: boolean;
-    log_upload: boolean;
-    reboot: boolean;
-    reset: boolean;
-    data_reset: boolean;
-    heartbeat: boolean;
-    status: boolean;
-    software_update: boolean;
-    provision_marmon_button: boolean;
-    greengrass_initialize: boolean;
-    greengrass_restart: boolean;
-    greengrass_redeploy: boolean;
-    amag_add_modify_card_holder: boolean;
-    amag_delete_card_holder: boolean;
-    activate_cloud_native_device: boolean;
-    deactivate_cloud_native_device: boolean;
-    lwm2m_request: boolean;
-    lwm2m_file: boolean;
-    log: boolean;
-    sms: boolean;
-    email: boolean;
-    relay: boolean;
-    http_request: boolean;
-    mqtt: boolean;
-    aws_iot: boolean;
-    bluemix_iot: boolean;
-    azure_iot: boolean;
-    tcp: boolean;
-    prtg: boolean;
-    tcp_modbus: boolean;
-    opcua: boolean;
-    bacnet: boolean;
-    remote_terminal: boolean;
-}
-export interface SMSATCommands {
-    status_commands: string[];
-    send_config_commands: string[];
-}
-export interface Capabilities {
-    network_connections: NetworkConnection[];
-    peripherals: Peripheral[];
-    iptables: boolean;
-    firmware: Firmware;
-    actions?: Actions;
-    sms_at_commands?: SMSATCommands;
-    observable_paths?: string[];
-}
-export interface DeviceTypeInput {
-    name: string;
-    company_id: string;
-    image?: string;
-    model: string;
-    manufacturer: string;
-    long_description?: string;
-    type: TypeDeviceType;
-    role: DeviceTypeRole;
-    capabilities: Capabilities;
-    heartbeat_values?: string[];
-    origin_id?: string;
-    ingestor_ids?: string[];
-    command_ids?: string[];
-    software_update_ids?: string[];
-    metadata?: {
-        [key: string]: string;
-    };
-}
-export interface DeviceType extends DeviceTypeInput, Base {
-}
-export interface DeviceTypesFilters extends Filters {
-    name?: Filter;
-    model?: Filter;
-    manufacturer?: Filter;
-    long_description?: string;
-    type?: Filter;
-    role?: Filter;
-}
-export interface PaginatedDeviceTypes {
-    deviceTypes: DeviceType[];
-    pagination: Pagination;
-}
+import { AwsThingGroup } from '../models';
+import { Base, Filter, Filters, Pagination } from '../models';
+export declare type TypeDeviceType = 'gateway' | 'sensor' | 'cloud_native' | 'modem' | 'lwm2m';
+export declare type DeviceTypeRole = 'gateway' | 'endpoint';
+export interface NetworkConnection {
+    type: string;
+    interface?: string;
+    name: string;
+}
+export interface Peripheral {
+    type: string;
+    device: string;
+}
+export interface Firmware {
+    upgrade: boolean;
+    backup: boolean;
+}
+export interface Actions {
+    sms_at_command_status_request: boolean;
+    notification: boolean;
+    enable_data_restriction: boolean;
+    disable_data_restriction: boolean;
+    send_config: boolean;
+    deploy_deployment: boolean;
+    request_deployment_status: boolean;
+    data_restore: boolean;
+    update_edge: boolean;
+    update_firmware: boolean;
+    restore_backup: boolean;
+    backup: boolean;
+    log_level: boolean;
+    log_config: boolean;
+    log_upload: boolean;
+    reboot: boolean;
+    reset: boolean;
+    data_reset: boolean;
+    heartbeat: boolean;
+    status: boolean;
+    software_update: boolean;
+    provision_marmon_button: boolean;
+    greengrass_initialize: boolean;
+    greengrass_restart: boolean;
+    greengrass_redeploy: boolean;
+    amag_add_modify_card_holder: boolean;
+    amag_delete_card_holder: boolean;
+    activate_cloud_native_device: boolean;
+    deactivate_cloud_native_device: boolean;
+    lwm2m_request: boolean;
+    lwm2m_file: boolean;
+    log: boolean;
+    sms: boolean;
+    email: boolean;
+    relay: boolean;
+    http_request: boolean;
+    mqtt: boolean;
+    aws_iot: boolean;
+    bluemix_iot: boolean;
+    azure_iot: boolean;
+    tcp: boolean;
+    prtg: boolean;
+    tcp_modbus: boolean;
+    opcua: boolean;
+    bacnet: boolean;
+    remote_terminal: boolean;
+}
+export interface SMSATCommands {
+    status_commands: string[];
+    send_config_commands: string[];
+}
+export interface Capabilities {
+    network_connections: NetworkConnection[];
+    peripherals: Peripheral[];
+    iptables: boolean;
+    firmware: Firmware;
+    actions?: Actions;
+    sms_at_commands?: SMSATCommands;
+    observable_paths?: string[];
+}
+export interface DeviceTypeInput {
+    name: string;
+    company_id: string;
+    image?: string;
+    model: string;
+    manufacturer: string;
+    long_description?: string;
+    type: TypeDeviceType;
+    role: DeviceTypeRole;
+    capabilities: Capabilities;
+    heartbeat_values?: string[];
+    origin_id?: string;
+    ingestor_ids?: string[];
+    command_ids?: string[];
+    software_update_ids?: string[];
+    metadata?: {
+        [key: string]: string;
+    };
+    default_thing_groups?: AwsThingGroup[];
+}
+export interface DeviceType extends DeviceTypeInput, Base {
+}
+export interface DeviceTypesFilters extends Filters {
+    name?: Filter;
+    model?: Filter;
+    manufacturer?: Filter;
+    long_description?: string;
+    type?: Filter;
+    role?: Filter;
+}
+export interface PaginatedDeviceTypes {
+    deviceTypes: DeviceType[];
+    pagination: Pagination;
+}

package/dist/deviceTypes/models.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/devices/index.d.ts

@@ -1,37 +1,39 @@
-import { Ingestor, Rule, Command, Log, EIQFile } from '..';
-import { BaseModelInterface } from '../core/ModelClass';
-import { GatewayCommand, GatewayCommandRequest } from '../gatewayCommands/models';
-import { BulkActionResponse, PaginationFilter } from '../models';
-import { Lwm2mObjectLinks } from '../lwm2m/models';
-import { DevicesFilters, Device, DeviceInput, PaginatedDevices } from './models';
-import { CommandExecutionsFilters, PaginatedCommandExecutions } from '../commandExecutions/models';
-interface DevicesInterface extends BaseModelInterface<Device, DeviceInput, DevicesFilters, PaginatedDevices> {
-    bulkCreate(uniqueIds: string[], deviceTypeId: string, namePrefix: string): Promise<BulkActionResponse>;
-    update(device: Device): Promise<Device>;
-    getOneByUniqueId(uniqueId: string): Promise<Device>;
-    deleteMultiple(ids: string[]): Promise<BulkActionResponse>;
-    attachIngestor(id: string, ingestorId: string): Promise<string>;
-    detachIngestor(id: string, ingestorId: string): Promise<string>;
-    getIngestors(id: string): Promise<Ingestor[]>;
-    attachRule(id: string, ruleId: string): Promise<string>;
-    bulkAttachRules(id: string, rulesIds: string[]): Promise<BulkActionResponse>;
-    detachRule(id: string, ruleId: string): Promise<string>;
-    getRules(id: string): Promise<Rule[]>;
-    getCommands(id: string): Promise<Command[]>;
-    csvBulkUpload(file: File): Promise<BulkActionResponse>;
-    csvBulkDownload(filters?: DevicesFilters): Promise<File>;
-    getLogs(id: string): Promise<Log[]>;
-    requestLogs(id: string): Promise<GatewayCommand>;
-    deviceLwm2mObjetLinks(id: string): Promise<Lwm2mObjectLinks[]>;
-    processGatewayCommand(deviceId: string, gatewayCommandRequest: GatewayCommandRequest): Promise<GatewayCommand>;
-    bulkExecuteGatewayCommand(ids: string[], gatewayCommandRequest: GatewayCommandRequest, generateChildCommandExecutions?: boolean): Promise<BulkActionResponse>;
-    bulkExecuteCommand(commandId: string, ids: string[], options?: {
-        [key: string]: string | number;
-    }, generateChildCommandExecutions?: boolean): Promise<BulkActionResponse>;
-    getFiles(id: string): Promise<EIQFile[]>;
-    getCommandExecutions(id: string, filters: CommandExecutionsFilters, pagination: PaginationFilter): Promise<PaginatedCommandExecutions>;
-    startRemoteTerminal(id: string, executable?: string): Promise<string>;
-    stopRemoteTerminal(id: string): Promise<string>;
-}
-export declare const Devices: DevicesInterface;
-export {};
+import { Ingestor, Rule, Command, Log, EIQFile } from '..';
+import { BaseModelInterface } from '../core/ModelClass';
+import { GatewayCommand, GatewayCommandRequest } from '../gatewayCommands/models';
+import { BulkActionResponse, PaginationFilter } from '../models';
+import { Lwm2mObjectLinks } from '../lwm2m/models';
+import { DevicesFilters, Device, DeviceInput, PaginatedDevices } from './models';
+import { CommandExecutionsFilters, PaginatedCommandExecutions } from '../commandExecutions/models';
+import { AwsThingGroup } from '../models';
+interface DevicesInterface extends BaseModelInterface<Device, DeviceInput, DevicesFilters, PaginatedDevices> {
+    bulkCreate(uniqueIds: string[], deviceTypeId: string, namePrefix: string): Promise<BulkActionResponse>;
+    update(device: Device): Promise<Device>;
+    getOneByUniqueId(uniqueId: string): Promise<Device>;
+    deleteMultiple(ids: string[]): Promise<BulkActionResponse>;
+    attachIngestor(id: string, ingestorId: string): Promise<string>;
+    detachIngestor(id: string, ingestorId: string): Promise<string>;
+    getIngestors(id: string): Promise<Ingestor[]>;
+    attachRule(id: string, ruleId: string): Promise<string>;
+    bulkAttachRules(id: string, rulesIds: string[]): Promise<BulkActionResponse>;
+    detachRule(id: string, ruleId: string): Promise<string>;
+    getRules(id: string): Promise<Rule[]>;
+    getAwsThingGroups(id: string): Promise<AwsThingGroup[]>;
+    getCommands(id: string): Promise<Command[]>;
+    csvBulkUpload(file: File): Promise<BulkActionResponse>;
+    csvBulkDownload(filters?: DevicesFilters): Promise<File>;
+    getLogs(id: string): Promise<Log[]>;
+    requestLogs(id: string): Promise<GatewayCommand>;
+    deviceLwm2mObjetLinks(id: string): Promise<Lwm2mObjectLinks[]>;
+    processGatewayCommand(deviceId: string, gatewayCommandRequest: GatewayCommandRequest): Promise<GatewayCommand>;
+    bulkExecuteGatewayCommand(ids: string[], gatewayCommandRequest: GatewayCommandRequest, generateChildCommandExecutions?: boolean): Promise<BulkActionResponse>;
+    bulkExecuteCommand(commandId: string, ids: string[], options?: {
+        [key: string]: string | number;
+    }, generateChildCommandExecutions?: boolean): Promise<BulkActionResponse>;
+    getFiles(id: string): Promise<EIQFile[]>;
+    getCommandExecutions(id: string, filters: CommandExecutionsFilters, pagination: PaginationFilter): Promise<PaginatedCommandExecutions>;
+    startRemoteTerminal(id: string, executable?: string): Promise<string>;
+    stopRemoteTerminal(id: string): Promise<string>;
+}
+export declare const Devices: DevicesInterface;
+export {};