verificationsession

Documentation

Overview

Package verificationsession provides the /identity/verification_sessions APIs

Index

• func Cancel(id string, params *stripe.IdentityVerificationSessionCancelParams) (*stripe.IdentityVerificationSession, error)
• func Get(id string, params *stripe.IdentityVerificationSessionParams) (*stripe.IdentityVerificationSession, error)
• func New(params *stripe.IdentityVerificationSessionParams) (*stripe.IdentityVerificationSession, error)
• func Redact(id string, params *stripe.IdentityVerificationSessionRedactParams) (*stripe.IdentityVerificationSession, error)
• func Update(id string, params *stripe.IdentityVerificationSessionParams) (*stripe.IdentityVerificationSession, error)
• type Client
  • func (c Client) Cancel(id string, params *stripe.IdentityVerificationSessionCancelParams) (*stripe.IdentityVerificationSession, error)
  • func (c Client) Get(id string, params *stripe.IdentityVerificationSessionParams) (*stripe.IdentityVerificationSession, error)
  • func (c Client) List(listParams *stripe.IdentityVerificationSessionListParams) *Iter
  • func (c Client) New(params *stripe.IdentityVerificationSessionParams) (*stripe.IdentityVerificationSession, error)
  • func (c Client) Redact(id string, params *stripe.IdentityVerificationSessionRedactParams) (*stripe.IdentityVerificationSession, error)
  • func (c Client) Update(id string, params *stripe.IdentityVerificationSessionParams) (*stripe.IdentityVerificationSession, error)
• type Iter
  • func List(params *stripe.IdentityVerificationSessionListParams) *Iter
  • func (i *Iter) IdentityVerificationSession() *stripe.IdentityVerificationSession
  • func (i *Iter) IdentityVerificationSessionList() *stripe.IdentityVerificationSessionList

Functions

func Cancel

func Cancel(id string, params *stripe.IdentityVerificationSessionCancelParams) (*stripe.IdentityVerificationSession, error)

Cancel is the method for the `POST /v1/identity/verification_sessions/{session}/cancel` API.

func Get

func Get(id string, params *stripe.IdentityVerificationSessionParams) (*stripe.IdentityVerificationSession, error)

Get returns the details of an identity verification session.

func New

func New(params *stripe.IdentityVerificationSessionParams) (*stripe.IdentityVerificationSession, error)

New creates a new identity verification session.

func Redact

func Redact(id string, params *stripe.IdentityVerificationSessionRedactParams) (*stripe.IdentityVerificationSession, error)

Redact is the method for the `POST /v1/identity/verification_sessions/{session}/redact` API.

func Update

func Update(id string, params *stripe.IdentityVerificationSessionParams) (*stripe.IdentityVerificationSession, error)

Update updates an identity verification session's properties.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /identity/verification_sessions APIs.

func (Client) Cancel

func (c Client) Cancel(id string, params *stripe.IdentityVerificationSessionCancelParams) (*stripe.IdentityVerificationSession, error)

Cancel is the method for the `POST /v1/identity/verification_sessions/{session}/cancel` API.

func (Client) Get

func (c Client) Get(id string, params *stripe.IdentityVerificationSessionParams) (*stripe.IdentityVerificationSession, error)

Get returns the details of an identity verification session.

func (Client) List

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

List returns a list of identity verification sessions.

func (Client) New

func (c Client) New(params *stripe.IdentityVerificationSessionParams) (*stripe.IdentityVerificationSession, error)

New creates a new identity verification session.

func (Client) Redact

func (c Client) Redact(id string, params *stripe.IdentityVerificationSessionRedactParams) (*stripe.IdentityVerificationSession, error)

Redact is the method for the `POST /v1/identity/verification_sessions/{session}/redact` API.

func (Client) Update

func (c Client) Update(id string, params *stripe.IdentityVerificationSessionParams) (*stripe.IdentityVerificationSession, error)

Update updates an identity verification session's properties.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for identity verification sessions.

func List

func List(params *stripe.IdentityVerificationSessionListParams) *Iter

List returns a list of identity verification sessions.

func (*Iter) IdentityVerificationSession

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

IdentityVerificationSession returns the identity verification session which the iterator is currently pointing to.

func (*Iter) IdentityVerificationSessionList

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

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