Class Buckets

Hierarchy

TagoIOModule<GenericModuleParams>
- Buckets

Index

Constructors

Methods

amount create delete deleteVariable edit exportData getDevicesAssociated info list listVariables

Constructors

constructor

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

Methods

amount

amount(bucketID): Promise<number>
Get Amount of data on the Bucket
Parameters
- bucketID: string
  
  Bucket ID
Returns Promise<number>
- Defined in modules/Resources/Buckets.ts:108

create

create(bucketObj): Promise<{
bucket: string;
}>
Generates and retrieves a new bucket for the account
Parameters
- bucketObj: BucketCreateInfo
  
  Object with data to create new bucket
Returns Promise<{
bucket: string;
}>
- Defined in modules/Resources/Buckets.ts:52

delete

delete(bucketID): Promise<string>
Deletes a bucket from the account
Parameters
- bucketID: string
  
  Bucket ID
Returns Promise<string>
- Defined in modules/Resources/Buckets.ts:81

deleteVariable

deleteVariable(bucketID, deleteParams): Promise<string>
Delete a bucket variable
Parameters
- bucketID: string
  
  Bucket ID
- deleteParams: {
  origin: string;
  variable: string;
  }
  
  Variable Details
  - origin: string
  - variable: string
Returns Promise<string>
- Defined in modules/Resources/Buckets.ts:149

edit

edit(bucketID, bucketObj): Promise<string>
Modifies any property of the bucket.
Parameters
- bucketID: string
  
  Bucket ID
- bucketObj: Partial<BucketCreateInfo>
  
  Bucket Object data to be replaced
Returns Promise<string>
- Defined in modules/Resources/Buckets.ts:67

exportData

exportData(buckets, output, optionsObj?): Promise<string>
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>
- Defined in modules/Resources/Buckets.ts:181

getDevicesAssociated

getDevicesAssociated(bucketID): Promise<BucketDeviceInfo[]>
Get all device associated with bucket
Parameters
- bucketID: string
  
  Bucket ID
Returns Promise<BucketDeviceInfo[]>
- Defined in modules/Resources/Buckets.ts:166

info

info(bucketID): Promise<BucketInfo>
Gets information about the bucket
Parameters
- bucketID: string
  
  Bucket ID
Returns Promise<BucketInfo>
- Defined in modules/Resources/Buckets.ts:94

list

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

listVariables

listVariables(bucketID, optionsObj?): Promise<VariablesInfo[]>
List variables inside the bucket
Parameters
- bucketID: string
  
  Bucket ID
- Optional optionsObj: ListVariablesOptions
  
  Request options
Returns Promise<VariablesInfo[]>
Default
```
optionsObj: {
  showAmount: false
  showDeleted: false
  resolveOriginName: false
}
```
- Defined in modules/Resources/Buckets.ts:130