review

Documentation

Overview

Package review provides the /reviews APIs

Index

• func Approve(id string, params *stripe.ReviewApproveParams) (*stripe.Review, error)
• func Get(id string, params *stripe.ReviewParams) (*stripe.Review, error)
• type Client
  • func (c Client) Approve(id string, params *stripe.ReviewApproveParams) (*stripe.Review, error)
  • func (c Client) Get(id string, params *stripe.ReviewParams) (*stripe.Review, error)
  • func (c Client) List(listParams *stripe.ReviewListParams) *Iter
• type Iter
  • func List(params *stripe.ReviewListParams) *Iter
  • func (i *Iter) Review() *stripe.Review
  • func (i *Iter) ReviewList() *stripe.ReviewList

Functions

func Approve

func Approve(id string, params *stripe.ReviewApproveParams) (*stripe.Review, error)

Approves a Review object, closing it and removing it from the list of reviews.

func Get

func Get(id string, params *stripe.ReviewParams) (*stripe.Review, error)

Retrieves a Review object.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /reviews APIs.

func (Client) Approve

func (c Client) Approve(id string, params *stripe.ReviewApproveParams) (*stripe.Review, error)

Approves a Review object, closing it and removing it from the list of reviews.

func (Client) Get

func (c Client) Get(id string, params *stripe.ReviewParams) (*stripe.Review, error)

Retrieves a Review object.

func (Client) List

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

Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for reviews.

func List

func List(params *stripe.ReviewListParams) *Iter

Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

func (*Iter) Review

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

Review returns the review which the iterator is currently pointing to.

func (*Iter) ReviewList

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

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