Class Buckets

Hierarchy

TagoIOModule<GenericModuleParams>
- Buckets

Index

Constructors

constructor

Methods

Constructors

constructor

new Buckets(params: GenericModuleParams): Buckets

Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in src/common/TagoIOModule.ts:79
Parameters
- params: GenericModuleParams
Returns Buckets

Methods

amount

amount(bucketID: string): Promise<number>

- Defined in src/modules/Account/Buckets.ts:108
Get Amount of data on the Bucket

Parameters
- bucketID: string
  
  Bucket ID
Returns Promise<number>

create

create(bucketObj: BucketCreateInfo): Promise<{ bucket: string }>

- Defined in src/modules/Account/Buckets.ts:52
Generates and retrieves a new bucket for the account

Parameters
- bucketObj: BucketCreateInfo
  
  Object with data to create new bucket
Returns Promise<{ bucket: string }>

delete

delete(bucketID: string): Promise<string>

- Defined in src/modules/Account/Buckets.ts:81
Deletes a bucket from the account

Parameters
- bucketID: string
  
  Bucket ID
Returns Promise<string>

deleteVariable

deleteVariable(bucketID: string, deleteParams: { origin: string; variable: string }): Promise<string>

- Defined in src/modules/Account/Buckets.ts:149
Delete a bucket variable

Parameters
- bucketID: string
  
  Bucket ID
- deleteParams: { origin: string; variable: string }
  
  Variable Details
  - origin: string
  - variable: string
Returns Promise<string>

edit

edit(bucketID: string, bucketObj: Partial<BucketCreateInfo>): Promise<string>

- Defined in src/modules/Account/Buckets.ts:67
Modifies any property of the bucket.

Parameters
- bucketID: string
  
  Bucket ID
- bucketObj: Partial<BucketCreateInfo>
  
  Bucket Object data to be replaced
Returns Promise<string>

exportData

exportData(buckets: ExportBucket, output: ExportOption, optionsObj?: ExportBucketOption): Promise<string>

- Defined in src/modules/Account/Buckets.ts:181
Export Data from Bucket

Parameters
- buckets: ExportBucket
  
  Array of JSON with get details
- output: ExportOption
  
  Type of output
- Optional optionsObj: ExportBucketOption
  
  Options of request
Returns Promise<string>

getDevicesAssociated

getDevicesAssociated(bucketID: string): Promise<BucketDeviceInfo[]>

- Defined in src/modules/Account/Buckets.ts:166
Get all device associated with bucket

Parameters
- bucketID: string
  
  Bucket ID
Returns Promise<BucketDeviceInfo[]>

info

info(bucketID: string): Promise<BucketInfo>

- Defined in src/modules/Account/Buckets.ts:94
Gets information about the bucket

Parameters
- bucketID: string
  
  Bucket ID
Returns Promise<BucketInfo>

list

list(queryObj?: BucketQuery): Promise<BucketInfo[]>

- Defined in src/modules/Account/Buckets.ts:30
Retrieves a list with all buckets from account
default
```
queryObj: {
  page: 1,
  fields: ["id", "name"],
  filter: {},
  amount: 20,
  orderBy: "name,asc",
}
```
Parameters
- Optional queryObj: BucketQuery
  
  Search query params
Returns Promise<BucketInfo[]>

listVariables

listVariables(bucketID: string, optionsObj?: ListVariablesOptions): Promise<VariablesInfo[]>

- Defined in src/modules/Account/Buckets.ts:130
List variables inside the bucket
default
```
optionsObj: {
  showAmount: false
  showDeleted: false
  resolveOriginName: false
}
```
Parameters
- bucketID: string
  
  Bucket ID
- Optional optionsObj: ListVariablesOptions
  
  Request options
Returns Promise<VariablesInfo[]>