factor

Documentation

Overview

Package factor contains auto-generated files. DO NOT MODIFY

Package factor contains auto-generated files. DO NOT MODIFY

Package factor contains auto-generated files. DO NOT MODIFY

Package factor 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() (*FetchFactorResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchFactorResponse, error)
  • func (c Client) Update(input *UpdateFactorInput) (*UpdateFactorResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateFactorInput) (*UpdateFactorResponse, error)
• type ClientProperties
• type FetchFactorConfigResponse
• type FetchFactorResponse
• type UpdateFactorConfigInput
• type UpdateFactorConfigResponse
• type UpdateFactorInput
• type UpdateFactorResponse

Types

type Client

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

Client for managing a specific factor resource See https://www.twilio.com/docs/verify/api/factor 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 factor client

func (Client) Delete

func (c Client) Delete() error

Delete removes a factor resource from the account See https://www.twilio.com/docs/verify/api/factor#delete-a-factor-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 factor resource from the account See https://www.twilio.com/docs/verify/api/factor#delete-a-factor-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() (*FetchFactorResponse, error)

Fetch retrieves a factor resource See https://www.twilio.com/docs/verify/api/factor#fetch-a-factor-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) (*FetchFactorResponse, error)

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

func (Client) Update

func (c Client) Update(input *UpdateFactorInput) (*UpdateFactorResponse, error)

Update modifies a factor resource See https://www.twilio.com/docs/verify/api/factor#update-a-factor-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) UpdateWithContext

func (c Client) UpdateWithContext(context context.Context, input *UpdateFactorInput) (*UpdateFactorResponse, error)

UpdateWithContext modifies a factor resource See https://www.twilio.com/docs/verify/api/factor#update-a-factor-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
	Sid        string
}

ClientProperties are the properties required to manage the factor resources

type FetchFactorConfigResponse

type FetchFactorConfigResponse struct {
	AppId                string  `json:"app_id"`
	NotificationPlatform string  `json:"notification_platform"`
	NotificationToken    string  `json:"notification_token"`
	SdkVersion           *string `json:"sdk_version,omitempty"`
}

type FetchFactorResponse

type FetchFactorResponse struct {
	AccountSid   string                    `json:"account_sid"`
	Config       FetchFactorConfigResponse `json:"config"`
	DateCreated  time.Time                 `json:"date_created"`
	DateUpdated  *time.Time                `json:"date_updated,omitempty"`
	EntitySid    string                    `json:"entity_sid"`
	FactorType   string                    `json:"factor_type"`
	FriendlyName string                    `json:"friendly_name"`
	Identity     string                    `json:"identity"`
	ServiceSid   string                    `json:"service_sid"`
	Sid          string                    `json:"sid"`
	Status       string                    `json:"status"`
	URL          string                    `json:"url"`
}

FetchFactorResponse defines the response fields for the retrieved factor

type UpdateFactorConfigInput

type UpdateFactorConfigInput struct {
	NotificationToken *string `form:"NotificationToken,omitempty"`
	SdkVersion        *string `form:"SdkVersion,omitempty"`
}

type UpdateFactorConfigResponse

type UpdateFactorConfigResponse struct {
	AppId                string  `json:"app_id"`
	NotificationPlatform string  `json:"notification_platform"`
	NotificationToken    string  `json:"notification_token"`
	SdkVersion           *string `json:"sdk_version,omitempty"`
}

type UpdateFactorInput

type UpdateFactorInput struct {
	AuthPayload  *string                  `form:"AuthPayload,omitempty"`
	Config       *UpdateFactorConfigInput `form:"Config,omitempty"`
	FriendlyName *string                  `form:"FriendlyName,omitempty"`
}

UpdateFactorInput defines input fields for updating a factor resource

type UpdateFactorResponse

type UpdateFactorResponse struct {
	AccountSid   string                     `json:"account_sid"`
	Config       UpdateFactorConfigResponse `json:"config"`
	DateCreated  time.Time                  `json:"date_created"`
	DateUpdated  *time.Time                 `json:"date_updated,omitempty"`
	EntitySid    string                     `json:"entity_sid"`
	FactorType   string                     `json:"factor_type"`
	FriendlyName string                     `json:"friendly_name"`
	Identity     string                     `json:"identity"`
	ServiceSid   string                     `json:"service_sid"`
	Sid          string                     `json:"sid"`
	Status       string                     `json:"status"`
	URL          string                     `json:"url"`
}

UpdateFactorResponse defines the response fields for the updated factor