Documentation ¶
Overview ¶
Package sync_stream contains auto-generated files. DO NOT MODIFY
Package sync_stream contains auto-generated files. DO NOT MODIFY
Package sync_stream contains auto-generated files. DO NOT MODIFY
Package sync_stream contains auto-generated files. DO NOT MODIFY
Index ¶
- type Client
- func (c Client) Delete() error
- func (c Client) DeleteWithContext(context context.Context) error
- func (c Client) Fetch() (*FetchSyncStreamResponse, error)
- func (c Client) FetchWithContext(context context.Context) (*FetchSyncStreamResponse, error)
- func (c Client) Update(input *UpdateSyncStreamInput) (*UpdateSyncStreamResponse, error)
- func (c Client) UpdateWithContext(context context.Context, input *UpdateSyncStreamInput) (*UpdateSyncStreamResponse, error)
- type ClientProperties
- type FetchSyncStreamResponse
- type UpdateSyncStreamInput
- type UpdateSyncStreamResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
Client for managing a specific stream resource See https://www.twilio.com/docs/sync/api/stream-resource for more details
func New ¶
func New(client *client.Client, properties ClientProperties) *Client
New creates a new instance of the syncstream client
func (Client) Delete ¶
Delete removes a stream resource from the account See https://www.twilio.com/docs/sync/api/stream-resource#delete-a-sync-stream-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information
func (Client) DeleteWithContext ¶
DeleteWithContext removes a stream resource from the account See https://www.twilio.com/docs/sync/api/stream-resource#delete-a-sync-stream-resource for more details
func (Client) Fetch ¶
func (c Client) Fetch() (*FetchSyncStreamResponse, error)
Fetch retrieves an stream resource See https://www.twilio.com/docs/sync/api/stream-resource#fetch-a-sync-stream-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) (*FetchSyncStreamResponse, error)
FetchWithContext retrieves an stream resource See https://www.twilio.com/docs/sync/api/stream-resource#fetch-a-sync-stream-resource for more details
func (Client) Update ¶
func (c Client) Update(input *UpdateSyncStreamInput) (*UpdateSyncStreamResponse, error)
Update modifies an stream resource See https://www.twilio.com/docs/sync/api/stream-resource#update-a-sync-stream-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 *UpdateSyncStreamInput) (*UpdateSyncStreamResponse, error)
UpdateWithContext modifies an stream resource See https://www.twilio.com/docs/sync/api/stream-resource#update-a-sync-stream-resource for more details
type ClientProperties ¶
ClientProperties are the properties required to manage the syncstream resources
type FetchSyncStreamResponse ¶
type FetchSyncStreamResponse struct { AccountSid string `json:"account_sid"` CreatedBy string `json:"created_by"` DateCreated time.Time `json:"date_created"` DateExpires *time.Time `json:"date_expires,omitempty"` DateUpdated *time.Time `json:"date_updated,omitempty"` ServiceSid string `json:"service_Sid"` Sid string `json:"sid"` URL string `json:"url"` UniqueName *string `json:"unique_name,omitempty"` }
FetchSyncStreamResponse defines the response fields for the retrieved stream
type UpdateSyncStreamInput ¶
type UpdateSyncStreamInput struct {
Ttl *int `form:"Ttl,omitempty"`
}
UpdateSyncStreamInput defines input fields for updating a stream resource
type UpdateSyncStreamResponse ¶
type UpdateSyncStreamResponse struct { AccountSid string `json:"account_sid"` CreatedBy string `json:"created_by"` DateCreated time.Time `json:"date_created"` DateExpires *time.Time `json:"date_expires,omitempty"` DateUpdated *time.Time `json:"date_updated,omitempty"` ServiceSid string `json:"service_Sid"` Sid string `json:"sid"` URL string `json:"url"` UniqueName *string `json:"unique_name,omitempty"` }
UpdateSyncStreamResponse defines the response fields for the updated stream