openapi

package
v0.22.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 23, 2022 License: MIT Imports: 6 Imported by: 1

README

Go API client for openapi

This is the public Twilio REST API.

Overview

This API client was generated by the OpenAPI Generator project from the OpenAPI specs located at twilio/twilio-oai. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.27.1
  • Package version: 1.0.0
  • Build package: com.twilio.oai.TwilioGoGenerator For more information, please visit https://support.twilio.com

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import "./openapi"

Documentation for API Endpoints

All URIs are relative to https://events.twilio.com

Class Method HTTP request Description
SchemasApi FetchSchema Get /v1/Schemas/{Id}
SchemasVersionsApi FetchSchemaVersion Get /v1/Schemas/{Id}/Versions/{SchemaVersion}
SchemasVersionsApi ListSchemaVersion Get /v1/Schemas/{Id}/Versions
SinksApi CreateSink Post /v1/Sinks
SinksApi DeleteSink Delete /v1/Sinks/{Sid}
SinksApi FetchSink Get /v1/Sinks/{Sid}
SinksApi ListSink Get /v1/Sinks
SinksApi UpdateSink Post /v1/Sinks/{Sid}
SinksTestApi CreateSinkTest Post /v1/Sinks/{Sid}/Test
SinksValidateApi CreateSinkValidate Post /v1/Sinks/{Sid}/Validate
SubscriptionsApi CreateSubscription Post /v1/Subscriptions
SubscriptionsApi DeleteSubscription Delete /v1/Subscriptions/{Sid}
SubscriptionsApi FetchSubscription Get /v1/Subscriptions/{Sid}
SubscriptionsApi ListSubscription Get /v1/Subscriptions
SubscriptionsApi UpdateSubscription Post /v1/Subscriptions/{Sid}
SubscriptionsSubscribedEventsApi CreateSubscribedEvent Post /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents
SubscriptionsSubscribedEventsApi DeleteSubscribedEvent Delete /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents/{Type}
SubscriptionsSubscribedEventsApi FetchSubscribedEvent Get /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents/{Type}
SubscriptionsSubscribedEventsApi ListSubscribedEvent Get /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents
SubscriptionsSubscribedEventsApi UpdateSubscribedEvent Post /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents/{Type}
TypesApi FetchEventType Get /v1/Types/{Type}
TypesApi ListEventType Get /v1/Types

Documentation For Models

Documentation For Authorization

accountSid_authToken

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiService added in v0.11.0 

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

func NewApiService added in v0.11.0 

func NewApiService(requestHandler *twilio.RequestHandler) *ApiService

func NewApiServiceWithClient added in v0.11.0 

func NewApiServiceWithClient(client twilio.BaseClient) *ApiService

func (*ApiService) CreateSink added in v0.11.0 

func (c *ApiService) CreateSink(params *CreateSinkParams) (*EventsV1Sink, error)

Create a new Sink

func (*ApiService) CreateSinkTest added in v0.11.0 

func (c *ApiService) CreateSinkTest(Sid string) (*EventsV1SinkTest, error)

Create a new Sink Test Event for the given Sink.

func (*ApiService) CreateSinkValidate added in v0.11.0 

func (c *ApiService) CreateSinkValidate(Sid string, params *CreateSinkValidateParams) (*EventsV1SinkValidate, error)

Validate that a test event for a Sink was received.

func (*ApiService) CreateSubscribedEvent added in v0.11.0 

func (c *ApiService) CreateSubscribedEvent(SubscriptionSid string, params *CreateSubscribedEventParams) (*EventsV1SubscribedEvent, error)

Create a new Subscribed Event type for the subscription

func (*ApiService) CreateSubscription added in v0.11.0 

func (c *ApiService) CreateSubscription(params *CreateSubscriptionParams) (*EventsV1Subscription, error)

Create a new Subscription.

func (*ApiService) DeleteSink added in v0.11.0 

func (c *ApiService) DeleteSink(Sid string) error

Delete a specific Sink.

func (*ApiService) DeleteSubscribedEvent added in v0.11.0 

func (c *ApiService) DeleteSubscribedEvent(SubscriptionSid string, Type string) error

Remove an event type from a subscription.

func (*ApiService) DeleteSubscription added in v0.11.0 

func (c *ApiService) DeleteSubscription(Sid string) error

Delete a specific Subscription.

func (*ApiService) FetchEventType added in v0.11.0 

func (c *ApiService) FetchEventType(Type string) (*EventsV1EventType, error)

Fetch a specific Event Type.

func (*ApiService) FetchSchema added in v0.11.0 

func (c *ApiService) FetchSchema(Id string) (*EventsV1Schema, error)

Fetch a specific schema with its nested versions.

func (*ApiService) FetchSchemaVersion added in v0.11.0 

func (c *ApiService) FetchSchemaVersion(Id string, SchemaVersion int) (*EventsV1SchemaVersion, error)

Fetch a specific schema and version.

func (*ApiService) FetchSink added in v0.11.0 

func (c *ApiService) FetchSink(Sid string) (*EventsV1Sink, error)

Fetch a specific Sink.

func (*ApiService) FetchSubscribedEvent added in v0.11.0 

func (c *ApiService) FetchSubscribedEvent(SubscriptionSid string, Type string) (*EventsV1SubscribedEvent, error)

Read an Event for a Subscription.

func (*ApiService) FetchSubscription added in v0.11.0 

func (c *ApiService) FetchSubscription(Sid string) (*EventsV1Subscription, error)

Fetch a specific Subscription.

func (*ApiService) ListEventType added in v0.11.0 

func (c *ApiService) ListEventType(params *ListEventTypeParams) ([]EventsV1EventType, error)

Lists EventType records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListSchemaVersion added in v0.11.0 

func (c *ApiService) ListSchemaVersion(Id string, params *ListSchemaVersionParams) ([]EventsV1SchemaVersion, error)

Lists SchemaVersion records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListSink added in v0.11.0 

func (c *ApiService) ListSink(params *ListSinkParams) ([]EventsV1Sink, error)

Lists Sink records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListSubscribedEvent added in v0.11.0 

func (c *ApiService) ListSubscribedEvent(SubscriptionSid string, params *ListSubscribedEventParams) ([]EventsV1SubscribedEvent, error)

Lists SubscribedEvent records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListSubscription added in v0.11.0 

func (c *ApiService) ListSubscription(params *ListSubscriptionParams) ([]EventsV1Subscription, error)

Lists Subscription records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) PageEventType added in v0.13.0 

func (c *ApiService) PageEventType(params *ListEventTypeParams, pageToken, pageNumber string) (*ListEventTypeResponse, error)

Retrieve a single page of EventType records from the API. Request is executed immediately.

func (*ApiService) PageSchemaVersion added in v0.13.0 

func (c *ApiService) PageSchemaVersion(Id string, params *ListSchemaVersionParams, pageToken, pageNumber string) (*ListSchemaVersionResponse, error)

Retrieve a single page of SchemaVersion records from the API. Request is executed immediately.

func (*ApiService) PageSink added in v0.13.0 

func (c *ApiService) PageSink(params *ListSinkParams, pageToken, pageNumber string) (*ListSinkResponse, error)

Retrieve a single page of Sink records from the API. Request is executed immediately.

func (*ApiService) PageSubscribedEvent added in v0.13.0 

func (c *ApiService) PageSubscribedEvent(SubscriptionSid string, params *ListSubscribedEventParams, pageToken, pageNumber string) (*ListSubscribedEventResponse, error)

Retrieve a single page of SubscribedEvent records from the API. Request is executed immediately.

func (*ApiService) PageSubscription added in v0.13.0 

func (c *ApiService) PageSubscription(params *ListSubscriptionParams, pageToken, pageNumber string) (*ListSubscriptionResponse, error)

Retrieve a single page of Subscription records from the API. Request is executed immediately.

func (*ApiService) StreamEventType added in v0.13.0 

func (c *ApiService) StreamEventType(params *ListEventTypeParams) (chan EventsV1EventType, error)

Streams EventType records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamSchemaVersion added in v0.13.0 

func (c *ApiService) StreamSchemaVersion(Id string, params *ListSchemaVersionParams) (chan EventsV1SchemaVersion, error)

Streams SchemaVersion records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamSink added in v0.13.0 

func (c *ApiService) StreamSink(params *ListSinkParams) (chan EventsV1Sink, error)

Streams Sink records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamSubscribedEvent added in v0.13.0 

func (c *ApiService) StreamSubscribedEvent(SubscriptionSid string, params *ListSubscribedEventParams) (chan EventsV1SubscribedEvent, error)

Streams SubscribedEvent records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamSubscription added in v0.13.0 

func (c *ApiService) StreamSubscription(params *ListSubscriptionParams) (chan EventsV1Subscription, error)

Streams Subscription records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) UpdateSink added in v0.11.0 

func (c *ApiService) UpdateSink(Sid string, params *UpdateSinkParams) (*EventsV1Sink, error)

Update a specific Sink

func (*ApiService) UpdateSubscribedEvent added in v0.11.0 

func (c *ApiService) UpdateSubscribedEvent(SubscriptionSid string, Type string, params *UpdateSubscribedEventParams) (*EventsV1SubscribedEvent, error)

Update an Event for a Subscription.

func (*ApiService) UpdateSubscription added in v0.11.0 

func (c *ApiService) UpdateSubscription(Sid string, params *UpdateSubscriptionParams) (*EventsV1Subscription, error)

Update a Subscription.

type CreateSinkParams 

type CreateSinkParams struct {
	// A human readable description for the Sink **This value should not contain PII.**
	Description *string `json:"Description,omitempty"`
	// The information required for Twilio to connect to the provided Sink encoded as JSON.
	SinkConfiguration *map[string]interface{} `json:"SinkConfiguration,omitempty"`
	// The Sink type. Can only be \\\"kinesis\\\" or \\\"webhook\\\" currently.
	SinkType *string `json:"SinkType,omitempty"`
}

Optional parameters for the method 'CreateSink'

func (*CreateSinkParams) SetDescription 

func (params *CreateSinkParams) SetDescription(Description string) *CreateSinkParams

func (*CreateSinkParams) SetSinkConfiguration 

func (params *CreateSinkParams) SetSinkConfiguration(SinkConfiguration map[string]interface{}) *CreateSinkParams

func (*CreateSinkParams) SetSinkType 

func (params *CreateSinkParams) SetSinkType(SinkType string) *CreateSinkParams

type CreateSinkValidateParams 

type CreateSinkValidateParams struct {
	// A 34 character string that uniquely identifies the test event for a Sink being validated.
	TestId *string `json:"TestId,omitempty"`
}

Optional parameters for the method 'CreateSinkValidate'

func (*CreateSinkValidateParams) SetTestId 

func (params *CreateSinkValidateParams) SetTestId(TestId string) *CreateSinkValidateParams

type CreateSubscribedEventParams 

type CreateSubscribedEventParams struct {
	// The schema version that the subscription should use.
	SchemaVersion *int `json:"SchemaVersion,omitempty"`
	// Type of event being subscribed to.
	Type *string `json:"Type,omitempty"`
}

Optional parameters for the method 'CreateSubscribedEvent'

func (*CreateSubscribedEventParams) SetSchemaVersion 

func (params *CreateSubscribedEventParams) SetSchemaVersion(SchemaVersion int) *CreateSubscribedEventParams

func (*CreateSubscribedEventParams) SetType 

func (params *CreateSubscribedEventParams) SetType(Type string) *CreateSubscribedEventParams

type CreateSubscriptionParams 

type CreateSubscriptionParams struct {
	// A human readable description for the Subscription **This value should not contain PII.**
	Description *string `json:"Description,omitempty"`
	// The SID of the sink that events selected by this subscription should be sent to. Sink must be active for the subscription to be created.
	SinkSid *string `json:"SinkSid,omitempty"`
	// An array of objects containing the subscribed Event Types
	Types *[]map[string]interface{} `json:"Types,omitempty"`
}

Optional parameters for the method 'CreateSubscription'

func (*CreateSubscriptionParams) SetDescription 

func (params *CreateSubscriptionParams) SetDescription(Description string) *CreateSubscriptionParams

func (*CreateSubscriptionParams) SetSinkSid 

func (params *CreateSubscriptionParams) SetSinkSid(SinkSid string) *CreateSubscriptionParams

func (*CreateSubscriptionParams) SetTypes 

func (params *CreateSubscriptionParams) SetTypes(Types []map[string]interface{}) *CreateSubscriptionParams

type EventsV1EventType 

type EventsV1EventType struct {
	// The date this Event Type was created.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date this Event Type was updated.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// Event Type description.
	Description *string                 `json:"description,omitempty"`
	Links       *map[string]interface{} `json:"links,omitempty"`
	// The Schema identifier for this Event Type.
	SchemaId *string `json:"schema_id,omitempty"`
	// The Event Type identifier.
	Type *string `json:"type,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
}

EventsV1EventType struct for EventsV1EventType

type EventsV1Schema 

type EventsV1Schema struct {
	// Schema Identifier.
	Id *string `json:"id,omitempty"`
	// Latest schema version.
	LatestVersion *int `json:"latest_version,omitempty"`
	// The date that the latest schema version was created.
	LatestVersionDateCreated *time.Time `json:"latest_version_date_created,omitempty"`
	// Nested resource URLs.
	Links *map[string]interface{} `json:"links,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
}

EventsV1Schema struct for EventsV1Schema

type EventsV1SchemaVersion added in v0.14.0 

type EventsV1SchemaVersion struct {
	// The date the schema version was created.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The unique identifier of the schema.
	Id  *string `json:"id,omitempty"`
	Raw *string `json:"raw,omitempty"`
	// The version of this schema.
	SchemaVersion *int `json:"schema_version,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
}

EventsV1SchemaVersion struct for EventsV1SchemaVersion

type EventsV1Sink 

type EventsV1Sink struct {
	// The date this Sink was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date this Sink was updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// Sink Description
	Description *string `json:"description,omitempty"`
	// Nested resource URLs.
	Links *map[string]interface{} `json:"links,omitempty"`
	// A string that uniquely identifies this Sink.
	Sid *string `json:"sid,omitempty"`
	// JSON Sink configuration.
	SinkConfiguration *map[string]interface{} `json:"sink_configuration,omitempty"`
	// Sink type.
	SinkType *string `json:"sink_type,omitempty"`
	// The Status of this Sink
	Status *string `json:"status,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
}

EventsV1Sink struct for EventsV1Sink

type EventsV1SinkTest added in v0.14.0 

type EventsV1SinkTest struct {
	// Feedback indicating whether the test event was generated.
	Result *string `json:"result,omitempty"`
}

EventsV1SinkTest struct for EventsV1SinkTest

type EventsV1SinkValidate added in v0.14.0 

type EventsV1SinkValidate struct {
	// Feedback indicating whether the given Sink was validated.
	Result *string `json:"result,omitempty"`
}

EventsV1SinkValidate struct for EventsV1SinkValidate

type EventsV1SubscribedEvent added in v0.14.0 

type EventsV1SubscribedEvent struct {
	// Account SID.
	AccountSid *string `json:"account_sid,omitempty"`
	// The schema version that the subscription should use.
	SchemaVersion *int `json:"schema_version,omitempty"`
	// Subscription SID.
	SubscriptionSid *string `json:"subscription_sid,omitempty"`
	// Type of event being subscribed to.
	Type *string `json:"type,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
}

EventsV1SubscribedEvent struct for EventsV1SubscribedEvent

type EventsV1Subscription 

type EventsV1Subscription struct {
	// Account SID.
	AccountSid *string `json:"account_sid,omitempty"`
	// The date this Subscription was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date this Subscription was updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// Subscription description
	Description *string `json:"description,omitempty"`
	// Nested resource URLs.
	Links *map[string]interface{} `json:"links,omitempty"`
	// A string that uniquely identifies this Subscription.
	Sid *string `json:"sid,omitempty"`
	// Sink SID.
	SinkSid *string `json:"sink_sid,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
}

EventsV1Subscription struct for EventsV1Subscription

type ListEventTypeParams 

type ListEventTypeParams struct {
	// A string parameter filtering the results to return only the Event Types using a given schema.
	SchemaId *string `json:"SchemaId,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListEventType'

func (*ListEventTypeParams) SetLimit added in v0.13.0 

func (params *ListEventTypeParams) SetLimit(Limit int) *ListEventTypeParams

func (*ListEventTypeParams) SetPageSize 

func (params *ListEventTypeParams) SetPageSize(PageSize int) *ListEventTypeParams

func (*ListEventTypeParams) SetSchemaId 

func (params *ListEventTypeParams) SetSchemaId(SchemaId string) *ListEventTypeParams

type ListEventTypeResponse 

type ListEventTypeResponse struct {
	Meta  ListSchemaVersionResponseMeta `json:"meta,omitempty"`
	Types []EventsV1EventType           `json:"types,omitempty"`
}

ListEventTypeResponse struct for ListEventTypeResponse

type ListSchemaVersionParams 

type ListSchemaVersionParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListSchemaVersion'

func (*ListSchemaVersionParams) SetLimit added in v0.13.0 

func (params *ListSchemaVersionParams) SetLimit(Limit int) *ListSchemaVersionParams

func (*ListSchemaVersionParams) SetPageSize 

func (params *ListSchemaVersionParams) SetPageSize(PageSize int) *ListSchemaVersionParams

type ListSchemaVersionResponse 

type ListSchemaVersionResponse struct {
	Meta           ListSchemaVersionResponseMeta `json:"meta,omitempty"`
	SchemaVersions []EventsV1SchemaVersion       `json:"schema_versions,omitempty"`
}

ListSchemaVersionResponse struct for ListSchemaVersionResponse

type ListSchemaVersionResponseMeta 

type ListSchemaVersionResponseMeta struct {
	FirstPageUrl    string `json:"first_page_url,omitempty"`
	Key             string `json:"key,omitempty"`
	NextPageUrl     string `json:"next_page_url,omitempty"`
	Page            int    `json:"page,omitempty"`
	PageSize        int    `json:"page_size,omitempty"`
	PreviousPageUrl string `json:"previous_page_url,omitempty"`
	Url             string `json:"url,omitempty"`
}

ListSchemaVersionResponseMeta struct for ListSchemaVersionResponseMeta

type ListSinkParams 

type ListSinkParams struct {
	// A boolean query parameter filtering the results to return sinks used/not used by a subscription.
	InUse *bool `json:"InUse,omitempty"`
	// A String query parameter filtering the results by status `initialized`, `validating`, `active` or `failed`.
	Status *string `json:"Status,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListSink'

func (*ListSinkParams) SetInUse 

func (params *ListSinkParams) SetInUse(InUse bool) *ListSinkParams

func (*ListSinkParams) SetLimit added in v0.13.0 

func (params *ListSinkParams) SetLimit(Limit int) *ListSinkParams

func (*ListSinkParams) SetPageSize 

func (params *ListSinkParams) SetPageSize(PageSize int) *ListSinkParams

func (*ListSinkParams) SetStatus 

func (params *ListSinkParams) SetStatus(Status string) *ListSinkParams

type ListSinkResponse 

type ListSinkResponse struct {
	Meta  ListSchemaVersionResponseMeta `json:"meta,omitempty"`
	Sinks []EventsV1Sink                `json:"sinks,omitempty"`
}

ListSinkResponse struct for ListSinkResponse

type ListSubscribedEventParams 

type ListSubscribedEventParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListSubscribedEvent'

func (*ListSubscribedEventParams) SetLimit added in v0.13.0 

func (params *ListSubscribedEventParams) SetLimit(Limit int) *ListSubscribedEventParams

func (*ListSubscribedEventParams) SetPageSize 

func (params *ListSubscribedEventParams) SetPageSize(PageSize int) *ListSubscribedEventParams

type ListSubscribedEventResponse 

type ListSubscribedEventResponse struct {
	Meta  ListSchemaVersionResponseMeta `json:"meta,omitempty"`
	Types []EventsV1SubscribedEvent     `json:"types,omitempty"`
}

ListSubscribedEventResponse struct for ListSubscribedEventResponse

type ListSubscriptionParams 

type ListSubscriptionParams struct {
	// The SID of the sink that the list of Subscriptions should be filtered by.
	SinkSid *string `json:"SinkSid,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListSubscription'

func (*ListSubscriptionParams) SetLimit added in v0.13.0 

func (params *ListSubscriptionParams) SetLimit(Limit int) *ListSubscriptionParams

func (*ListSubscriptionParams) SetPageSize 

func (params *ListSubscriptionParams) SetPageSize(PageSize int) *ListSubscriptionParams

func (*ListSubscriptionParams) SetSinkSid 

func (params *ListSubscriptionParams) SetSinkSid(SinkSid string) *ListSubscriptionParams

type ListSubscriptionResponse 

type ListSubscriptionResponse struct {
	Meta          ListSchemaVersionResponseMeta `json:"meta,omitempty"`
	Subscriptions []EventsV1Subscription        `json:"subscriptions,omitempty"`
}

ListSubscriptionResponse struct for ListSubscriptionResponse

type UpdateSinkParams 

type UpdateSinkParams struct {
	// A human readable description for the Sink **This value should not contain PII.**
	Description *string `json:"Description,omitempty"`
}

Optional parameters for the method 'UpdateSink'

func (*UpdateSinkParams) SetDescription 

func (params *UpdateSinkParams) SetDescription(Description string) *UpdateSinkParams

type UpdateSubscribedEventParams 

type UpdateSubscribedEventParams struct {
	// The schema version that the subscription should use.
	SchemaVersion *int `json:"SchemaVersion,omitempty"`
}

Optional parameters for the method 'UpdateSubscribedEvent'

func (*UpdateSubscribedEventParams) SetSchemaVersion 

func (params *UpdateSubscribedEventParams) SetSchemaVersion(SchemaVersion int) *UpdateSubscribedEventParams

type UpdateSubscriptionParams 

type UpdateSubscriptionParams struct {
	// A human readable description for the Subscription.
	Description *string `json:"Description,omitempty"`
	// The SID of the sink that events selected by this subscription should be sent to. Sink must be active for the subscription to be created.
	SinkSid *string `json:"SinkSid,omitempty"`
}

Optional parameters for the method 'UpdateSubscription'

func (*UpdateSubscriptionParams) SetDescription 

func (params *UpdateSubscriptionParams) SetDescription(Description string) *UpdateSubscriptionParams

func (*UpdateSubscriptionParams) SetSinkSid 

func (params *UpdateSubscriptionParams) SetSinkSid(SinkSid string) *UpdateSubscriptionParams

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.