entities

Documentation

Overview

Package entities contains auto-generated files. DO NOT MODIFY

Package entities contains auto-generated files. DO NOT MODIFY

Package entities contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateEntityInput) (*CreateEntityResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateEntityInput) (*CreateEntityResponse, error)
  • func (c *Client) NewEntitiesPaginator() *EntitiesPaginator
  • func (c *Client) NewEntitiesPaginatorWithOptions(options *EntitiesPageOptions) *EntitiesPaginator
  • func (c Client) Page(options *EntitiesPageOptions) (*EntitiesPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *EntitiesPageOptions) (*EntitiesPageResponse, error)
• type ClientProperties
• type CreateEntityInput
• type CreateEntityResponse
• type EntitiesPage
• type EntitiesPageOptions
• type EntitiesPageResponse
• type EntitiesPaginator
  • func (p *EntitiesPaginator) CurrentPage() *EntitiesPageResponse
  • func (p *EntitiesPaginator) Error() error
  • func (p *EntitiesPaginator) Next() bool
  • func (p *EntitiesPaginator) NextWithContext(context context.Context) bool
• type PageEntityResponse
• type PageMetaResponse

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client for managing entity resources 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 entities client

func (Client) Create

func (c Client) Create(input *CreateEntityInput) (*CreateEntityResponse, error)

Create creates a new entity See https://www.twilio.com/docs/verify/api/entity#create-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) CreateWithContext

func (c Client) CreateWithContext(context context.Context, input *CreateEntityInput) (*CreateEntityResponse, error)

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

func (*Client) NewEntitiesPaginator

func (c *Client) NewEntitiesPaginator() *EntitiesPaginator

NewEntitiesPaginator creates a new instance of the paginator for Page.

func (*Client) NewEntitiesPaginatorWithOptions

func (c *Client) NewEntitiesPaginatorWithOptions(options *EntitiesPageOptions) *EntitiesPaginator

NewEntitiesPaginatorWithOptions creates a new instance of the paginator for Page with options.

func (Client) Page

func (c Client) Page(options *EntitiesPageOptions) (*EntitiesPageResponse, error)

Page retrieves a page of entities See https://www.twilio.com/docs/verify/api/entity#read-multiple-entity-resources 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) PageWithContext

func (c Client) PageWithContext(context context.Context, options *EntitiesPageOptions) (*EntitiesPageResponse, error)

PageWithContext retrieves a page of entities See https://www.twilio.com/docs/verify/api/entity#read-multiple-entity-resources for more details This resource is currently in beta and subject to change. Please use with caution

type ClientProperties

type ClientProperties struct {
	ServiceSid string
}

ClientProperties are the properties required to manage the entities resources

type CreateEntityInput

type CreateEntityInput struct {
	Identity string `validate:"required" form:"Identity"`
}

CreateEntityInput defines the input fields for creating a new entity

type CreateEntityResponse

type CreateEntityResponse 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"`
}

CreateEntityResponse defines the response fields for the created entity

type EntitiesPage

type EntitiesPage struct {
	CurrentPage *EntitiesPageResponse
	Error       error
	// contains filtered or unexported fields
}

EntitiesPage defines the fields for the page The CurrentPage and Error fields can be used to access the PageEntityResponse or error that is returned from the api call(s)

type EntitiesPageOptions

type EntitiesPageOptions struct {
	PageSize  *int
	Page      *int
	PageToken *string
}

EntitiesPageOptions defines the query options for the api operation

type EntitiesPageResponse

type EntitiesPageResponse struct {
	Entities []PageEntityResponse `json:"entities"`
	Meta     PageMetaResponse     `json:"meta"`
}

EntitiesPageResponse defines the response fields for the entities page

type EntitiesPaginator

type EntitiesPaginator struct {
	Page     *EntitiesPage
	Entities []PageEntityResponse
	// contains filtered or unexported fields
}

EntitiesPaginator defines the fields for makings paginated api calls Entities is an array of entities that have been returned from all of the page calls

func (*EntitiesPaginator) CurrentPage

func (p *EntitiesPaginator) CurrentPage() *EntitiesPageResponse

CurrentPage retrieves the results for the current page

func (*EntitiesPaginator) Error

func (p *EntitiesPaginator) Error() error

Error retrieves the error returned from the page

func (*EntitiesPaginator) Next

func (p *EntitiesPaginator) Next() bool

Next retrieves the next page of results. Next will return false when either an error occurs or there are no more pages to iterate Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (*EntitiesPaginator) NextWithContext

func (p *EntitiesPaginator) NextWithContext(context context.Context) bool

NextWithContext retrieves the next page of results. NextWithContext will return false when either an error occurs or there are no more pages to iterate

type PageEntityResponse

type PageEntityResponse 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"`
}

type PageMetaResponse

type PageMetaResponse struct {
	FirstPageURL    string  `json:"first_page_url"`
	Key             string  `json:"key"`
	NextPageURL     *string `json:"next_page_url,omitempty"`
	Page            int     `json:"page"`
	PageSize        int     `json:"page_size"`
	PreviousPageURL *string `json:"previous_page_url,omitempty"`
	URL             string  `json:"url"`
}