testclock

Documentation

Overview

Package testclock provides the /test_helpers/test_clocks APIs

Index

• func Advance(id string, params *stripe.TestHelpersTestClockAdvanceParams) (*stripe.TestHelpersTestClock, error)
• func Del(id string, params *stripe.TestHelpersTestClockParams) (*stripe.TestHelpersTestClock, error)
• func Get(id string, params *stripe.TestHelpersTestClockParams) (*stripe.TestHelpersTestClock, error)
• func New(params *stripe.TestHelpersTestClockParams) (*stripe.TestHelpersTestClock, error)
• type Client
  • func (c Client) Advance(id string, params *stripe.TestHelpersTestClockAdvanceParams) (*stripe.TestHelpersTestClock, error)
  • func (c Client) Del(id string, params *stripe.TestHelpersTestClockParams) (*stripe.TestHelpersTestClock, error)
  • func (c Client) Get(id string, params *stripe.TestHelpersTestClockParams) (*stripe.TestHelpersTestClock, error)
  • func (c Client) List(listParams *stripe.TestHelpersTestClockListParams) *Iter
  • func (c Client) New(params *stripe.TestHelpersTestClockParams) (*stripe.TestHelpersTestClock, error)
• type Iter
  • func List(params *stripe.TestHelpersTestClockListParams) *Iter
  • func (i *Iter) TestHelpersTestClock() *stripe.TestHelpersTestClock
  • func (i *Iter) TestHelpersTestClockList() *stripe.TestHelpersTestClockList

Functions

func Advance

func Advance(id string, params *stripe.TestHelpersTestClockAdvanceParams) (*stripe.TestHelpersTestClock, error)

Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.

func Del

func Del(id string, params *stripe.TestHelpersTestClockParams) (*stripe.TestHelpersTestClock, error)

Deletes a test clock.

func Get

func Get(id string, params *stripe.TestHelpersTestClockParams) (*stripe.TestHelpersTestClock, error)

Retrieves a test clock.

func New

func New(params *stripe.TestHelpersTestClockParams) (*stripe.TestHelpersTestClock, error)

Creates a new test clock that can be attached to new customers and quotes.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /test_helpers/test_clocks APIs.

func (Client) Advance

func (c Client) Advance(id string, params *stripe.TestHelpersTestClockAdvanceParams) (*stripe.TestHelpersTestClock, error)

Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.

func (Client) Del

func (c Client) Del(id string, params *stripe.TestHelpersTestClockParams) (*stripe.TestHelpersTestClock, error)

Deletes a test clock.

func (Client) Get

func (c Client) Get(id string, params *stripe.TestHelpersTestClockParams) (*stripe.TestHelpersTestClock, error)

Retrieves a test clock.

func (Client) List

func (c Client) List(listParams *stripe.TestHelpersTestClockListParams) *Iter

Returns a list of your test clocks.

func (Client) New

func (c Client) New(params *stripe.TestHelpersTestClockParams) (*stripe.TestHelpersTestClock, error)

Creates a new test clock that can be attached to new customers and quotes.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for test helpers test clocks.

func List

func List(params *stripe.TestHelpersTestClockListParams) *Iter

Returns a list of your test clocks.

func (*Iter) TestHelpersTestClock

func (i *Iter) TestHelpersTestClock() *stripe.TestHelpersTestClock

TestHelpersTestClock returns the test helpers test clock which the iterator is currently pointing to.

func (*Iter) TestHelpersTestClockList

func (i *Iter) TestHelpersTestClockList() *stripe.TestHelpersTestClockList

TestHelpersTestClockList returns the current list object which the iterator is currently using. List objects will change as new API calls are made to continue pagination.