Class RestClient

constructor

• new RestClient(opts: RestClientOptions): RestClient

  Parameters

  • opts: RestClientOptions

    The options for the RestClient.

  Returns RestClient

  Classdesc

  Represents a RestClient object.

ReadonlycertificationUrl

ReadonlydeviceListUrl

ReadonlydeviceQuotaUrl

requestHandler

restApiHost

ReadonlysetCmdUrl

getDevice

• getDevice<T extends string>(sn: T): DeviceFactoryReturnType<T>

  Retrieves a device class instance.

  Type Parameters

  • T extends string

  Parameters

  • sn: T

  Returns DeviceFactoryReturnType<T>

getDevicePropertiesPlain

• getDevicePropertiesPlain(
      sn: string,
  ): Promise<{ code: "0"; data?: Record<string, any>; message: "Success" }>

  Requests all device properties.

  Parameters

  • sn: string

    Device serial number

  Returns Promise<{ code: "0"; data?: Record<string, any>; message: "Success" }>

  • Promise that resolves to the device properties response

getDevices

• getDevices(): Promise<UnknownDevice[]>

  Retrieves a list of device class instances. To narrow down a device-type you may use the instanceOf operator.

  const devices = await restClient.getDevices();
  
  for (const device of devices) {
    if (device instanceof SmartPlug) {
      await device.switchOn();
    }
  }
  Copy

  Returns Promise<UnknownDevice[]>

  A promise that resolves to an array of devices.

getDevicesPlain

• getDevicesPlain(): Promise<
      {
          code: "0";
          data: objectOutputType<
              {
                  deviceName: ZodOptional<ZodString>;
                  online: ZodUnion<[ZodLiteral<0>, ZodLiteral<1>]>;
                  productName: ZodString;
                  sn: ZodString;
              },
              ZodTypeAny,
              "passthrough",
          >[];
          message: "Success";
      },
  >

  Receive a list of all devices connected to the account.

  Returns Promise<
      {
          code: "0";
          data: objectOutputType<
              {
                  deviceName: ZodOptional<ZodString>;
                  online: ZodUnion<[ZodLiteral<0>, ZodLiteral<1>]>;
                  productName: ZodString;
                  sn: ZodString;
              },
              ZodTypeAny,
              "passthrough",
          >[];
          message: "Success";
      },
  >

  A promise that resolves to the device list response.

getMqttCredentials

• getMqttCredentials(): Promise<
      {
          certificateAccount: string;
          certificatePassword: string;
          port: number;
          protocol: "mqtts";
          url: string;
      },
  >

  Requests credentials required to establish an MQTT connection.

  Returns Promise<
      {
          certificateAccount: string;
          certificatePassword: string;
          port: number;
          protocol: "mqtts";
          url: string;
      },
  >

  An object containing the MQTT credentials. - certificateAccount: The certificate account. - certificatePassword: The certificate password. - url: The MQTT broker URL. - protocol: The MQTT protocol (e.g., MQTT or MQTT over WebSocket). - port: The MQTT broker port.

  Throws

  If there is an error retrieving the credentials or if the response contains an error message.

getSerialNumbers

• getSerialNumbers(): Promise<string[]>

  Returns an array of all serial numbers bound to the connected account.

  Returns Promise<string[]>

  An array of serial numbers.

parseResponse

• parseResponse<T extends ZodTypeAny>(data: unknown, schema: T): inferSchema<T>

  Parses the given response data using the provided schema.

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • data: unknown

    The response data to be parsed.
  • schema: T

    The schema to be used for parsing.

  Returns inferSchema<T>

  • The parsed response data.

  Throws

  • If an error is detected in the response data.

setCommandPlain

• setCommandPlain(
      payload: Record<string, any>,
  ): Promise<
      | {
          code: "0";
          eagleEyeTraceId: string;
          message: "Success";
          tid: string;
      }
      | { code: string; eagleEyeTraceId: string; message: string; tid: string },
  >

  Update device settings. Depending on the device type different settings can be updated.

  Parameters

  • payload: Record<string, any>

  Returns Promise<
      | {
          code: "0";
          eagleEyeTraceId: string;
          message: "Success";
          tid: string;
      }
      | { code: string; eagleEyeTraceId: string; message: string; tid: string },
  >