Class Buckets

constructor

• new Buckets(params: GenericModuleParams): Buckets

  Parameters

  • params: GenericModuleParams

  Returns Buckets

devices

amount

• amount(deviceID: string): 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: string): 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 extends DeviceQuery>(
      queryObj?: T,
  ): Promise<
      DeviceListItem<
          T["fields"] extends (
              | "updated_at"
              | "profile"
              | "connector"
              | "network"
              | "name"
              | "active"
              | "created_at"
              | "bucket"
              | "id"
              | "description"
              | "tags"
              | "visible"
              | "last_input"
              | "type"
              | "payload_decoder"
              | "rpm"
          )[]
              ? any[any][number]
              : "name"
              | "id",
      >[],
  >

  Type Parameters

  • T extends DeviceQuery

  Parameters

  • OptionalqueryObj: T

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

  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