Billing_groups {sevenbridges2}R Documentation

R6 Class representing billing groups endpoints

Description

R6 Class representing billing groups resource endpoints.

Super class

sevenbridges2::Resource -> Billing_groups

Public fields

URL

List of URL endpoints for this resource.

Methods

Public methods

Inherited methods

Method new()

Create a new Billing_groups object.

Usage
Billing_groups$new(...)
Arguments
...

Other response arguments.

Method query()

List all your billing groups, including groups that are pending or have been disabled.

Usage
Billing_groups$query(
  limit = getOption("sevenbridges2")$limit,
  offset = getOption("sevenbridges2")$offset,
  ...
)
Arguments
limit

The maximum number of collection items to return for a single request. Minimum value is 1. The maximum value is 100 and the default value is 50. This is a pagination-specific attribute.

offset

The zero-based starting index in the entire collection of the first item to return. The default value is 0. This is a pagination-specific attribute.

...

Other arguments that can be passed to core api() function like query parameters, 'fields', etc.

Returns

Collection of Billing groups.

Examples
\dontrun{
 billing_groups_object <- Billing_groups$new(
   auth = auth
 )

 # List all your billing groups
 billing_groups_object$query()
}

Method get()

Retrieve a single billing group, specified by its id. To find the billing_group, use the call Billing_groups$query() to list all your billing groups. The information returned includes the billing group owner, the total balance, and the status of the billing group (pending or confirmed).

Usage
Billing_groups$get(id, ...)
Arguments
id

The ID of the billing group you are querying.

...

Other arguments that can be passed to core api() function like 'fields', etc.

Returns

Billing object.

Examples
\dontrun{
 billing_groups_object <- Billing_groups$new(
   auth = auth
 )

 # Get single billing group
 billing_groups_object$get(id = id)
}

Method clone()

The objects of this class are cloneable with this method.

Usage
Billing_groups$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples


## ------------------------------------------------
## Method `Billing_groups$query`
## ------------------------------------------------

## Not run: 
 billing_groups_object <- Billing_groups$new(
   auth = auth
 )

 # List all your billing groups
 billing_groups_object$query()

## End(Not run)


## ------------------------------------------------
## Method `Billing_groups$get`
## ------------------------------------------------

## Not run: 
 billing_groups_object <- Billing_groups$new(
   auth = auth
 )

 # Get single billing group
 billing_groups_object$get(id = id)

## End(Not run)
[Package sevenbridges2 version 0.2.0 Index]