balance

Documentation

Overview

Package balance contains auto-generated files. DO NOT MODIFY

Package balance contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Fetch() (*FetchBalanceResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchBalanceResponse, error)
• type ClientProperties
• type FetchBalanceResponse

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client for managing a specific account balance resource

func New

func New(client *client.Client, properties ClientProperties) *Client

New creates a new instance of the balance client

func (Client) Fetch

func (c Client) Fetch() (*FetchBalanceResponse, error)

Fetch retrieves the balance resource for the account Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) FetchWithContext

func (c Client) FetchWithContext(context context.Context) (*FetchBalanceResponse, error)

FetchWithContext retrieves the balance resource for the account

type ClientProperties

type ClientProperties struct {
	AccountSid string
}

ClientProperties are the properties required to manage the balance resources

type FetchBalanceResponse

type FetchBalanceResponse struct {
	AccountSid string `json:"account_sid"`
	Balance    string `json:"balance"`
	Currency   string `json:"currency"`
}

FetchBalanceResponse defines the response fields for retrieving an account balance