services

Documentation

Overview

Package services contains auto-generated files. DO NOT MODIFY

Package services contains auto-generated files. DO NOT MODIFY

Package services contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client) *Client
  • func (c Client) Create(input *CreateServiceInput) (*CreateServiceResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateServiceInput) (*CreateServiceResponse, error)
  • func (c *Client) NewServicesPaginator() *ServicesPaginator
  • func (c *Client) NewServicesPaginatorWithOptions(options *ServicesPageOptions) *ServicesPaginator
  • func (c Client) Page(options *ServicesPageOptions) (*ServicesPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *ServicesPageOptions) (*ServicesPageResponse, error)
• type CreateServiceInput
• type CreateServicePushInput
• type CreateServicePushResponse
• type CreateServiceResponse
• type CreateServiceTotpInput
• type CreateServiceTotpResponse
• type PageMetaResponse
• type PageServicePushResponse
• type PageServiceResponse
• type PageServiceTotpResponse
• type ServicesPage
• type ServicesPageOptions
• type ServicesPageResponse
• type ServicesPaginator
  • func (p *ServicesPaginator) CurrentPage() *ServicesPageResponse
  • func (p *ServicesPaginator) Error() error
  • func (p *ServicesPaginator) Next() bool
  • func (p *ServicesPaginator) NextWithContext(context context.Context) bool

Types

type Client

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

Client for managing service resources See https://www.twilio.com/docs/verify/api/service for more details

func New

func New(client *client.Client) *Client

New creates a new instance of the services client

func (Client) Create

func (c Client) Create(input *CreateServiceInput) (*CreateServiceResponse, error)

Create creates a new service See https://www.twilio.com/docs/verify/api/service#create-a-verification-service for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) CreateWithContext

func (c Client) CreateWithContext(context context.Context, input *CreateServiceInput) (*CreateServiceResponse, error)

CreateWithContext creates a new service See https://www.twilio.com/docs/verify/api/service#create-a-verification-service for more details

func (*Client) NewServicesPaginator

func (c *Client) NewServicesPaginator() *ServicesPaginator

NewServicesPaginator creates a new instance of the paginator for Page.

func (*Client) NewServicesPaginatorWithOptions

func (c *Client) NewServicesPaginatorWithOptions(options *ServicesPageOptions) *ServicesPaginator

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

func (Client) Page

func (c Client) Page(options *ServicesPageOptions) (*ServicesPageResponse, error)

Page retrieves a page of services See https://www.twilio.com/docs/verify/api/service#list-all-services for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) PageWithContext

func (c Client) PageWithContext(context context.Context, options *ServicesPageOptions) (*ServicesPageResponse, error)

PageWithContext retrieves a page of services See https://www.twilio.com/docs/verify/api/service#list-all-services for more details

type CreateServiceInput

type CreateServiceInput struct {
	CodeLength               *int                    `form:"CodeLength,omitempty"`
	CustomCodeEnabled        *bool                   `form:"CustomCodeEnabled,omitempty"`
	DefaultTemplateSid       *string                 `form:"DefaultTemplateSid,omitempty"`
	DoNotShareWarningEnabled *bool                   `form:"DoNotShareWarningEnabled,omitempty"`
	DtmfInputRequired        *bool                   `form:"DtmfInputRequired,omitempty"`
	FriendlyName             string                  `validate:"required" form:"FriendlyName"`
	LookupEnabled            *bool                   `form:"LookupEnabled,omitempty"`
	Psd2Enabled              *bool                   `form:"Psd2Enabled,omitempty"`
	Push                     *CreateServicePushInput `form:"Push,omitempty"`
	SkipSmsToLandlines       *bool                   `form:"SkipSmsToLandlines,omitempty"`
	Totp                     *CreateServiceTotpInput `form:"Totp,omitempty"`
	TtsName                  *string                 `form:"TtsName,omitempty"`
}

CreateServiceInput defines the input fields for creating a new service

type CreateServicePushInput

type CreateServicePushInput struct {
	ApnCredentialSid *string `form:"ApnCredentialSid,omitempty"`
	FcmCredentialSid *string `form:"FcmCredentialSid,omitempty"`
	IncludeDate      *bool   `form:"IncludeDate,omitempty"`
}

type CreateServicePushResponse

type CreateServicePushResponse struct {
	ApnCredentialSid *string `json:"apn_credential_sid,omitempty"`
	FcmCredentialSid *string `json:"fcm_credential_sid,omitempty"`
	IncludeDate      bool    `json:"include_date"`
}

type CreateServiceResponse

type CreateServiceResponse struct {
	AccountSid               string                    `json:"account_sid"`
	CodeLength               int                       `json:"code_length"`
	CustomCodeEnabled        bool                      `json:"custom_code_enabled"`
	DateCreated              time.Time                 `json:"date_created"`
	DateUpdated              *time.Time                `json:"date_updated,omitempty"`
	DefaultTemplateSid       *string                   `json:"default_template_sid,omitempty"`
	DoNotShareWarningEnabled bool                      `json:"do_not_share_warning_enabled"`
	DtmfInputRequired        bool                      `json:"dtmf_input_required"`
	FriendlyName             string                    `json:"friendly_name"`
	LookupEnabled            bool                      `json:"lookup_enabled"`
	MailerSid                *string                   `json:"mailer_sid,omitempty"`
	Psd2Enabled              bool                      `json:"psd2_enabled"`
	Push                     CreateServicePushResponse `json:"push"`
	Sid                      string                    `json:"sid"`
	SkipSmsToLandlines       bool                      `json:"skip_sms_to_landlines"`
	Totp                     CreateServiceTotpResponse `json:"totp"`
	TtsName                  *string                   `json:"tts_name,omitempty"`
	URL                      string                    `json:"url"`
}

CreateServiceResponse defines the response fields for the created service

type CreateServiceTotpInput

type CreateServiceTotpInput struct {
	CodeLength *int    `form:"CodeLength,omitempty"`
	Issuer     *string `form:"Issuer,omitempty"`
	Skew       *int    `form:"Skew,omitempty"`
	TimeStep   *int    `form:"TimeStep,omitempty"`
}

type CreateServiceTotpResponse

type CreateServiceTotpResponse struct {
	CodeLength int    `json:"code_length"`
	Issuer     string `json:"issuer"`
	Skew       int    `json:"skew"`
	TimeStep   int    `json:"time_step"`
}

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

type PageServicePushResponse

type PageServicePushResponse struct {
	ApnCredentialSid *string `json:"apn_credential_sid,omitempty"`
	FcmCredentialSid *string `json:"fcm_credential_sid,omitempty"`
	IncludeDate      bool    `json:"include_date"`
}

type PageServiceResponse

type PageServiceResponse struct {
	AccountSid               string                  `json:"account_sid"`
	CodeLength               int                     `json:"code_length"`
	CustomCodeEnabled        bool                    `json:"custom_code_enabled"`
	DateCreated              time.Time               `json:"date_created"`
	DateUpdated              *time.Time              `json:"date_updated,omitempty"`
	DefaultTemplateSid       *string                 `json:"default_template_sid,omitempty"`
	DoNotShareWarningEnabled bool                    `json:"do_not_share_warning_enabled"`
	DtmfInputRequired        bool                    `json:"dtmf_input_required"`
	FriendlyName             string                  `json:"friendly_name"`
	LookupEnabled            bool                    `json:"lookup_enabled"`
	MailerSid                *string                 `json:"mailer_sid,omitempty"`
	Psd2Enabled              bool                    `json:"psd2_enabled"`
	Push                     PageServicePushResponse `json:"push"`
	Sid                      string                  `json:"sid"`
	SkipSmsToLandlines       bool                    `json:"skip_sms_to_landlines"`
	Totp                     PageServiceTotpResponse `json:"totp"`
	TtsName                  *string                 `json:"tts_name,omitempty"`
	URL                      string                  `json:"url"`
}

type PageServiceTotpResponse

type PageServiceTotpResponse struct {
	CodeLength int    `json:"code_length"`
	Issuer     string `json:"issuer"`
	Skew       int    `json:"skew"`
	TimeStep   int    `json:"time_step"`
}

type ServicesPage

type ServicesPage struct {
	CurrentPage *ServicesPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type ServicesPageOptions

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

ServicesPageOptions defines the query options for the api operation

type ServicesPageResponse

type ServicesPageResponse struct {
	Meta     PageMetaResponse      `json:"meta"`
	Services []PageServiceResponse `json:"services"`
}

ServicesPageResponse defines the response fields for the services page

type ServicesPaginator

type ServicesPaginator struct {
	Page     *ServicesPage
	Services []PageServiceResponse
	// contains filtered or unexported fields
}

ServicesPaginator defines the fields for makings paginated api calls Services is an array of services that have been returned from all of the page calls

func (*ServicesPaginator) CurrentPage

func (p *ServicesPaginator) CurrentPage() *ServicesPageResponse

CurrentPage retrieves the results for the current page

func (*ServicesPaginator) Error

func (p *ServicesPaginator) Error() error

Error retrieves the error returned from the page

func (*ServicesPaginator) Next

func (p *ServicesPaginator) 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 (*ServicesPaginator) NextWithContext

func (p *ServicesPaginator) 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