Class Buckets

devices

amount

• amount(deviceID): Promise<number>

• Parameters

  • deviceID: string

  Returns Promise<number>

  Description

  Gets the amount of data stored for a device.

  Example

  If receive an error "Authorization Denied", check policy Device / Access in Access Management.

  // Use this instead of Buckets
  const amount = await Resources.devices.amount("device-id-123");
  console.log(amount);
  Copy

info

• info(deviceID): Promise<DeviceInfo>

• Parameters

  • deviceID: string

  Returns Promise<DeviceInfo>

  Description

  Retrieves detailed information about a specific device.

  Deprecated

  Use Resources.devices.info() instead

  Example

  If receive an error "Authorization Denied", check policy Device / Access in Access Management.

  // Use this instead of Buckets
  const deviceInfo = await Resources.devices.info("device-id-123");
  console.log(deviceInfo);
  Copy

list

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

• Type Parameters

  • T extends DeviceQuery

  Parameters

  • Optional queryObj: T

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

  Description

  Lists all devices from your application with pagination.

  Deprecated

  Use Resources.devices.list() instead

  Example

  If receive an error "Authorization Denied", check policy Device / Access in Access Management.

  // Use this instead of Buckets
  const list = await Resources.devices.list({
    page: 1,
    fields: ["id", "name"],
    amount: 10,
    orderBy: ["name", "asc"]
  });
  console.log(list);
  Copy