Class Buckets

devices

amount

• amount(deviceID): Promise<number>

• Get amount of data on the Device.

  Parameters

  • deviceID: string

    Device ID

  Returns Promise<number>

  Deprecated

  Use the method from Resources.devices instead.

info

• info(deviceID): Promise<DeviceInfo>

• Get information about the Device.

  Parameters

  • deviceID: string

    Device ID

  Returns Promise<DeviceInfo>

  Deprecated

  Use the method from Resources.devices instead.

list

• list<T>(queryObj?): Promise<DeviceListItem<T["fields"] extends ("type" | "id" | "active" | "network" | "name" | "visible" | "description" | "created_at" | "profile" | "updated_at" | "tags" | "connector" | "last_input" | "bucket" | "payload_decoder" | "rpm")[]
      ? any[any][number]
      : "id" | "name">[]>

• List Devices in the profile according to filters and pagination.

  Type Parameters

  • T extends DeviceQuery

  Parameters

  • Optional queryObj: T

    Search query params

  Returns Promise<DeviceListItem<T["fields"] extends ("type" | "id" | "active" | "network" | "name" | "visible" | "description" | "created_at" | "profile" | "updated_at" | "tags" | "connector" | "last_input" | "bucket" | "payload_decoder" | "rpm")[]
      ? any[any][number]
      : "id" | "name">[]>

  Default

  queryObj: {
    page: 1,
    fields: ["id", "name"],
    filter: {},
    amount: 20,
    orderBy: "name,asc",
  }
  Copy

  Deprecated

  Use the method from Resources.devices instead.