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 FetchServiceResponse
• type UpdateServiceInput
• type UpdateServiceResponse

Types

type Client

type Client struct {
	AlphaSender  func(string) *alpha_sender.Client
	AlphaSenders *alpha_senders.Client
	PhoneNumber  func(string) *phone_number.Client
	PhoneNumbers *phone_numbers.Client
	ShortCode    func(string) *short_code.Client
	ShortCodes   *short_codes.Client
	// contains filtered or unexported fields
}

Client for managing a specific messaging resource See https://www.twilio.com/docs/sms/services/api 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 messaging resource from the account See https://www.twilio.com/docs/sms/services/api#delete-a-service-resource 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 messaging resource from the account See https://www.twilio.com/docs/sms/services/api#delete-a-service-resource for more details

func (Client) Fetch

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

Fetch retrieves a messaging resource See https://www.twilio.com/docs/sms/services/api#fetch-a-service-resource 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 messaging resource See https://www.twilio.com/docs/sms/services/api#fetch-a-service-resource for more details

func (Client) Update

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

Update modifies a messaging resource See https://www.twilio.com/docs/sms/services/api#update-a-service-resource 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 messaging resource See https://www.twilio.com/docs/sms/services/api#update-a-service-resource for more details

type ClientProperties

type ClientProperties struct {
	Sid string
}

ClientProperties are the properties required to manage the service resources

type FetchServiceResponse

type FetchServiceResponse struct {
	AccountSid            string     `json:"account_sid"`
	AreaCodeGeomatch      bool       `json:"area_code_geomatch"`
	DateCreated           time.Time  `json:"date_created"`
	DateUpdated           *time.Time `json:"date_updated,omitempty"`
	FallbackMethod        string     `json:"fallback_method"`
	FallbackToLongCode    bool       `json:"fallback_to_long_code"`
	FallbackURL           *string    `json:"fallback_url,omitempty"`
	FriendlyName          string     `json:"friendly_name"`
	InboundMethod         string     `json:"inbound_method"`
	InboundRequestURL     *string    `json:"inbound_request_url,omitempty"`
	MmsConverter          bool       `json:"mms_converter"`
	ScanMessageContent    string     `json:"scan_message_content"`
	Sid                   string     `json:"sid"`
	SmartEncoding         bool       `json:"smart_encoding"`
	StatusCallback        *string    `json:"status_callback,omitempty"`
	StickySender          bool       `json:"sticky_sender"`
	SynchronousValidation bool       `json:"synchronous_validation"`
	URL                   string     `json:"url"`
	ValidityPeriod        int        `json:"validity_period"`
}

FetchServiceResponse defines the response fields for the retrieved messaging

type UpdateServiceInput

type UpdateServiceInput struct {
	AreaCodeGeomatch      *bool   `form:"AreaCodeGeomatch,omitempty"`
	FallbackMethod        *string `form:"FallbackMethod,omitempty"`
	FallbackToLongCode    *bool   `form:"FallbackToLongCode,omitempty"`
	FallbackURL           *string `form:"FallbackUrl,omitempty"`
	FriendlyName          *string `form:"FriendlyName,omitempty"`
	InboundMethod         *string `form:"InboundMethod,omitempty"`
	InboundRequestURL     *string `form:"InboundRequestUrl,omitempty"`
	MmsConverter          *bool   `form:"MmsConverter,omitempty"`
	ScanMessageContent    *string `form:"ScanMessageContent,omitempty"`
	SmartEncoding         *bool   `form:"SmartEncoding,omitempty"`
	StatusCallback        *string `form:"StatusCallback,omitempty"`
	StickySender          *bool   `form:"StickySender,omitempty"`
	SynchronousValidation *bool   `form:"SynchronousValidation,omitempty"`
	ValidityPeriod        *int    `form:"ValidityPeriod,omitempty"`
}

UpdateServiceInput defines input fields for updating a messaging resource

type UpdateServiceResponse

type UpdateServiceResponse struct {
	AccountSid            string     `json:"account_sid"`
	AreaCodeGeomatch      bool       `json:"area_code_geomatch"`
	DateCreated           time.Time  `json:"date_created"`
	DateUpdated           *time.Time `json:"date_updated,omitempty"`
	FallbackMethod        string     `json:"fallback_method"`
	FallbackToLongCode    bool       `json:"fallback_to_long_code"`
	FallbackURL           *string    `json:"fallback_url,omitempty"`
	FriendlyName          string     `json:"friendly_name"`
	InboundMethod         string     `json:"inbound_method"`
	InboundRequestURL     *string    `json:"inbound_request_url,omitempty"`
	MmsConverter          bool       `json:"mms_converter"`
	ScanMessageContent    string     `json:"scan_message_content"`
	Sid                   string     `json:"sid"`
	SmartEncoding         bool       `json:"smart_encoding"`
	StatusCallback        *string    `json:"status_callback,omitempty"`
	StickySender          bool       `json:"sticky_sender"`
	SynchronousValidation bool       `json:"synchronous_validation"`
	URL                   string     `json:"url"`
	ValidityPeriod        int        `json:"validity_period"`
}

UpdateServiceResponse defines the response fields for the updated messaging