valuelist

Documentation

Overview

Package valuelist provides the /radar/value_lists APIs

Index

• func Del(id string, params *stripe.RadarValueListParams) (*stripe.RadarValueList, error)
• func Get(id string, params *stripe.RadarValueListParams) (*stripe.RadarValueList, error)
• func New(params *stripe.RadarValueListParams) (*stripe.RadarValueList, error)
• func Update(id string, params *stripe.RadarValueListParams) (*stripe.RadarValueList, error)
• type Client
  • func (c Client) Del(id string, params *stripe.RadarValueListParams) (*stripe.RadarValueList, error)
  • func (c Client) Get(id string, params *stripe.RadarValueListParams) (*stripe.RadarValueList, error)
  • func (c Client) List(listParams *stripe.RadarValueListListParams) *Iter
  • func (c Client) New(params *stripe.RadarValueListParams) (*stripe.RadarValueList, error)
  • func (c Client) Update(id string, params *stripe.RadarValueListParams) (*stripe.RadarValueList, error)
• type Iter
  • func List(params *stripe.RadarValueListListParams) *Iter
  • func (i *Iter) RadarValueList() *stripe.RadarValueList
  • func (i *Iter) RadarValueListList() *stripe.RadarValueListList

Functions

func Del

func Del(id string, params *stripe.RadarValueListParams) (*stripe.RadarValueList, error)

Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

func Get

func Get(id string, params *stripe.RadarValueListParams) (*stripe.RadarValueList, error)

Retrieves a ValueList object.

func New

func New(params *stripe.RadarValueListParams) (*stripe.RadarValueList, error)

Creates a new ValueList object, which can then be referenced in rules.

func Update

func Update(id string, params *stripe.RadarValueListParams) (*stripe.RadarValueList, error)

Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /radar/value_lists APIs.

func (Client) Del

func (c Client) Del(id string, params *stripe.RadarValueListParams) (*stripe.RadarValueList, error)

Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

func (Client) Get

func (c Client) Get(id string, params *stripe.RadarValueListParams) (*stripe.RadarValueList, error)

Retrieves a ValueList object.

func (Client) List

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

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

func (Client) New

func (c Client) New(params *stripe.RadarValueListParams) (*stripe.RadarValueList, error)

Creates a new ValueList object, which can then be referenced in rules.

func (Client) Update

func (c Client) Update(id string, params *stripe.RadarValueListParams) (*stripe.RadarValueList, error)

Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for radar value lists.

func List

func List(params *stripe.RadarValueListListParams) *Iter

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

func (*Iter) RadarValueList

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

RadarValueList returns the radar value list which the iterator is currently pointing to.

func (*Iter) RadarValueListList

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

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