Hierarchy

Constructors

Methods

  • Get Amount of data on the Bucket

    Parameters

    • bucketID: string

      Bucket ID

    Returns Promise<number>

  • Generates and retrieves a new bucket for the account

    Parameters

    Returns Promise<{
        bucket: string;
    }>

  • Deletes a bucket from the account

    Parameters

    • bucketID: string

      Bucket ID

    Returns 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>

  • Modifies any property of the bucket.

    Parameters

    • bucketID: string

      Bucket ID

    • bucketObj: Partial<BucketCreateInfo>

      Bucket Object data to be replaced

    Returns Promise<string>

  • Retrieves a list with all buckets from account

    Parameters

    Returns Promise<BucketInfo[]>

    Default

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