service

Documentation

Overview

Package service contains auto-generated files. DO NOT MODIFY

Package service contains auto-generated files. DO NOT MODIFY

Package service contains auto-generated files. DO NOT MODIFY

Package service 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() (*FetchServiceResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchServiceResponse, error)
  • func (c Client) Update(input *UpdateServiceInput) (*UpdateServiceResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateServiceInput) (*UpdateServiceResponse, error)
• type ClientProperties
• type FetchServicePushResponse
• type FetchServiceResponse
• type FetchServiceTotpResponse
• type UpdateServiceInput
• type UpdateServicePushInput
• type UpdateServicePushResponse
• type UpdateServiceResponse
• type UpdateServiceTotpInput
• type UpdateServiceTotpResponse

Types

type Client

type Client struct {
	AccessTokens            *access_tokens.Client
	Entities                *entities.Client
	Entity                  func(string) *entity.Client
	MessagingConfiguration  func(string) *messaging_configuration.Client
	MessagingConfigurations *messaging_configurations.Client
	RateLimit               func(string) *rate_limit.Client
	RateLimits              *rate_limits.Client
	Verification            func(string) *verification.Client
	VerificationCheck       *verification_check.Client
	Verifications           *verifications.Client
	Webhook                 func(string) *webhook.Client
	Webhooks                *webhooks.Client
	// contains filtered or unexported fields
}

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

func New

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

New creates a new instance of the service client

func (Client) Delete

func (c Client) Delete() error

Delete removes a service resource from the account See https://www.twilio.com/docs/verify/api/service#delete-a-service for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) DeleteWithContext

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

DeleteWithContext removes a service resource from the account See https://www.twilio.com/docs/verify/api/service#delete-a-service for more details

func (Client) Fetch

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

Fetch retrieves a service resource See https://www.twilio.com/docs/verify/api/service#fetch-a-service for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) FetchWithContext

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

FetchWithContext retrieves a service resource See https://www.twilio.com/docs/verify/api/service#fetch-a-service for more details

func (Client) Update

func (c Client) Update(input *UpdateServiceInput) (*UpdateServiceResponse, error)

Update modifies a service resource See https://www.twilio.com/docs/verify/api/service#update-a-service for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) UpdateWithContext

func (c Client) UpdateWithContext(context context.Context, input *UpdateServiceInput) (*UpdateServiceResponse, error)

UpdateWithContext modifies a service resource See https://www.twilio.com/docs/verify/api/service#update-a-service for more details

type ClientProperties

type ClientProperties struct {
	Sid string
}

ClientProperties are the properties required to manage the service resources

type FetchServicePushResponse

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

type FetchServiceResponse

type FetchServiceResponse 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                     FetchServicePushResponse `json:"push"`
	Sid                      string                   `json:"sid"`
	SkipSmsToLandlines       bool                     `json:"skip_sms_to_landlines"`
	Totp                     FetchServiceTotpResponse `json:"totp"`
	TtsName                  *string                  `json:"tts_name,omitempty"`
	URL                      string                   `json:"url"`
}

FetchServiceResponse defines the response fields for the retrieved service

type FetchServiceTotpResponse

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

type UpdateServiceInput

type UpdateServiceInput 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                 `form:"FriendlyName,omitempty"`
	LookupEnabled            *bool                   `form:"LookupEnabled,omitempty"`
	MailerSid                *string                 `form:"MailerSid,omitempty"`
	Psd2Enabled              *bool                   `form:"Psd2Enabled,omitempty"`
	Push                     *UpdateServicePushInput `form:"Push,omitempty"`
	SkipSmsToLandlines       *bool                   `form:"SkipSmsToLandlines,omitempty"`
	Totp                     *UpdateServiceTotpInput `form:"Totp,omitempty"`
	TtsName                  *string                 `form:"TtsName,omitempty"`
}

UpdateServiceInput defines input fields for updating a service resource

type UpdateServicePushInput

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

type UpdateServicePushResponse

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

type UpdateServiceResponse

type UpdateServiceResponse 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                     UpdateServicePushResponse `json:"push"`
	Sid                      string                    `json:"sid"`
	SkipSmsToLandlines       bool                      `json:"skip_sms_to_landlines"`
	Totp                     UpdateServiceTotpResponse `json:"totp"`
	TtsName                  *string                   `json:"tts_name,omitempty"`
	URL                      string                    `json:"url"`
}

UpdateServiceResponse defines the response fields for the updated service

type UpdateServiceTotpInput

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

type UpdateServiceTotpResponse

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