entity

Documentation

Overview

Package entity contains auto-generated files. DO NOT MODIFY

Package entity contains auto-generated files. DO NOT MODIFY

Package entity contains auto-generated files. DO NOT MODIFY

Index

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

Types

type Client

type Client struct {
	Challenge  func(string) *challenge.Client
	Challenges *challenges.Client
	Factor     func(string) *factor.Client
	Factors    *factors.Client
	// contains filtered or unexported fields
}

Client for managing a specific entity resource See https://www.twilio.com/docs/verify/api/entity for more details This client is currently in beta and subject to change. Please use with caution

func New

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

New creates a new instance of the entity client

func (Client) Delete

func (c Client) Delete() error

Delete removes a entity resource from the account See https://www.twilio.com/docs/verify/api/entity#delete-an-entity-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information This resource is currently in beta and subject to change. Please use with caution

func (Client) DeleteWithContext

func (c Client) DeleteWithContext(context context.Context) error

DeleteWithContext removes a entity resource from the account See https://www.twilio.com/docs/verify/api/entity#delete-an-entity-resource for more details This resource is currently in beta and subject to change. Please use with caution

func (Client) Fetch

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

Fetch retrieves an entity resource See https://www.twilio.com/docs/verify/api/entity#fetch-an-entity-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information This resource is currently in beta and subject to change. Please use with caution

func (Client) FetchWithContext

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

FetchWithContext retrieves an entity resource See https://www.twilio.com/docs/verify/api/entity#fetch-an-entity-resource for more details This resource is currently in beta and subject to change. Please use with caution

type ClientProperties

type ClientProperties struct {
	Identity   string
	ServiceSid string
}

ClientProperties are the properties required to manage the entity resources

type FetchEntityResponse

type FetchEntityResponse struct {
	AccountSid  string     `json:"account_sid"`
	DateCreated time.Time  `json:"date_created"`
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	Identity    string     `json:"identity"`
	ServiceSid  string     `json:"service_sid"`
	Sid         string     `json:"sid"`
	URL         string     `json:"url"`
}

FetchEntityResponse defines the response fields for the retrieved entity