configuration

Documentation

Overview

Package configuration contains auto-generated files. DO NOT MODIFY

Package configuration contains auto-generated files. DO NOT MODIFY

Package configuration contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Fetch() (*FetchConfigurationResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchConfigurationResponse, error)
  • func (c Client) Update(input *UpdateConfigurationInput) (*UpdateConfigurationResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateConfigurationInput) (*UpdateConfigurationResponse, error)
• type ClientProperties
• type FetchConfigurationResponse
• type UpdateConfigurationInput
• type UpdateConfigurationResponse

Types

type Client

type Client struct {
	Notification func() *notification.Client
	// contains filtered or unexported fields
}

Client for managing service configuration See https://www.twilio.com/docs/conversations/api/service-configuration-resource for more details

func New

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

New creates a new instance of the configuration client

func (Client) Fetch

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

Fetch retrieves service configuration resource See https://www.twilio.com/docs/conversations/api/service-configuration-resource#fetch-a-serviceconfiguration-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) (*FetchConfigurationResponse, error)

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

func (Client) Update

func (c Client) Update(input *UpdateConfigurationInput) (*UpdateConfigurationResponse, error)

Update modifies a service configuration resource See https://www.twilio.com/docs/conversations/api/service-configuration-resource#update-a-serviceconfiguration-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 *UpdateConfigurationInput) (*UpdateConfigurationResponse, error)

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

type ClientProperties

type ClientProperties struct {
	ServiceSid string
}

ClientProperties are the properties required to manage the configuration resources

type FetchConfigurationResponse

type FetchConfigurationResponse struct {
	ChatServiceSid                    string `json:"chat_service_sid"`
	DefaultChatServiceRoleSid         string `json:"default_chat_service_role_sid"`
	DefaultConversationCreatorRoleSid string `json:"default_conversation_creator_role_sid"`
	DefaultConversationRoleSid        string `json:"default_conversation_role_sid"`
	URL                               string `json:"url"`
}

FetchConfigurationResponse defines the response fields for the retrieved service configuration

type UpdateConfigurationInput

type UpdateConfigurationInput struct {
	DefaultChatServiceRoleSid         *string `form:"DefaultChatServiceRoleSid,omitempty"`
	DefaultConversationCreatorRoleSid *string `form:"DefaultConversationCreatorRoleSid,omitempty"`
	DefaultConversationRoleSid        *string `form:"DefaultConversationRoleSid,omitempty"`
}

UpdateConfigurationInput defines input fields for updating a service configuration resource

type UpdateConfigurationResponse

type UpdateConfigurationResponse struct {
	ChatServiceSid                    string `json:"chat_service_sid"`
	DefaultChatServiceRoleSid         string `json:"default_chat_service_role_sid"`
	DefaultConversationCreatorRoleSid string `json:"default_conversation_creator_role_sid"`
	DefaultConversationRoleSid        string `json:"default_conversation_role_sid"`
	URL                               string `json:"url"`
}

UpdateConfigurationResponse defines the response fields for the updated service configuration