github.com/twilio/twilio-go@v1.20.1/rest/events/v1/README.md (about)

     1  # Go API client for openapi
     2  
     3  This is the public Twilio REST API.
     4  
     5  ## Overview
     6  This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project from the OpenAPI specs located at [twilio/twilio-oai](https://github.com/twilio/twilio-oai/tree/main/spec).  By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
     7  
     8  - API version: 1.0.0
     9  - Package version: 1.0.0
    10  - Build package: com.twilio.oai.TwilioGoGenerator
    11  For more information, please visit [https://support.twilio.com](https://support.twilio.com)
    12  
    13  ## Installation
    14  
    15  Install the following dependencies:
    16  
    17  ```shell
    18  go get github.com/stretchr/testify/assert
    19  go get golang.org/x/net/context
    20  ```
    21  
    22  Put the package under your project folder and add the following in import:
    23  
    24  ```golang
    25  import "./openapi"
    26  ```
    27  
    28  ## Documentation for API Endpoints
    29  
    30  All URIs are relative to *https://events.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *SchemasApi* | [**FetchSchema**](docs/SchemasApi.md#fetchschema) | **Get** /v1/Schemas/{Id} | 
    35  *SchemasVersionsApi* | [**FetchSchemaVersion**](docs/SchemasVersionsApi.md#fetchschemaversion) | **Get** /v1/Schemas/{Id}/Versions/{SchemaVersion} | 
    36  *SchemasVersionsApi* | [**ListSchemaVersion**](docs/SchemasVersionsApi.md#listschemaversion) | **Get** /v1/Schemas/{Id}/Versions | 
    37  *SinksApi* | [**CreateSink**](docs/SinksApi.md#createsink) | **Post** /v1/Sinks | 
    38  *SinksApi* | [**DeleteSink**](docs/SinksApi.md#deletesink) | **Delete** /v1/Sinks/{Sid} | 
    39  *SinksApi* | [**FetchSink**](docs/SinksApi.md#fetchsink) | **Get** /v1/Sinks/{Sid} | 
    40  *SinksApi* | [**ListSink**](docs/SinksApi.md#listsink) | **Get** /v1/Sinks | 
    41  *SinksApi* | [**UpdateSink**](docs/SinksApi.md#updatesink) | **Post** /v1/Sinks/{Sid} | 
    42  *SinksTestApi* | [**CreateSinkTest**](docs/SinksTestApi.md#createsinktest) | **Post** /v1/Sinks/{Sid}/Test | 
    43  *SinksValidateApi* | [**CreateSinkValidate**](docs/SinksValidateApi.md#createsinkvalidate) | **Post** /v1/Sinks/{Sid}/Validate | 
    44  *SubscriptionsApi* | [**CreateSubscription**](docs/SubscriptionsApi.md#createsubscription) | **Post** /v1/Subscriptions | 
    45  *SubscriptionsApi* | [**DeleteSubscription**](docs/SubscriptionsApi.md#deletesubscription) | **Delete** /v1/Subscriptions/{Sid} | 
    46  *SubscriptionsApi* | [**FetchSubscription**](docs/SubscriptionsApi.md#fetchsubscription) | **Get** /v1/Subscriptions/{Sid} | 
    47  *SubscriptionsApi* | [**ListSubscription**](docs/SubscriptionsApi.md#listsubscription) | **Get** /v1/Subscriptions | 
    48  *SubscriptionsApi* | [**UpdateSubscription**](docs/SubscriptionsApi.md#updatesubscription) | **Post** /v1/Subscriptions/{Sid} | 
    49  *SubscriptionsSubscribedEventsApi* | [**CreateSubscribedEvent**](docs/SubscriptionsSubscribedEventsApi.md#createsubscribedevent) | **Post** /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents | 
    50  *SubscriptionsSubscribedEventsApi* | [**DeleteSubscribedEvent**](docs/SubscriptionsSubscribedEventsApi.md#deletesubscribedevent) | **Delete** /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents/{Type} | 
    51  *SubscriptionsSubscribedEventsApi* | [**FetchSubscribedEvent**](docs/SubscriptionsSubscribedEventsApi.md#fetchsubscribedevent) | **Get** /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents/{Type} | 
    52  *SubscriptionsSubscribedEventsApi* | [**ListSubscribedEvent**](docs/SubscriptionsSubscribedEventsApi.md#listsubscribedevent) | **Get** /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents | 
    53  *SubscriptionsSubscribedEventsApi* | [**UpdateSubscribedEvent**](docs/SubscriptionsSubscribedEventsApi.md#updatesubscribedevent) | **Post** /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents/{Type} | 
    54  *TypesApi* | [**FetchEventType**](docs/TypesApi.md#fetcheventtype) | **Get** /v1/Types/{Type} | 
    55  *TypesApi* | [**ListEventType**](docs/TypesApi.md#listeventtype) | **Get** /v1/Types | 
    56  
    57  
    58  ## Documentation For Models
    59  
    60   - [EventsV1SinkValidate](docs/EventsV1SinkValidate.md)
    61   - [EventsV1EventType](docs/EventsV1EventType.md)
    62   - [EventsV1SchemaVersion](docs/EventsV1SchemaVersion.md)
    63   - [EventsV1Sink](docs/EventsV1Sink.md)
    64   - [ListSubscriptionResponse](docs/ListSubscriptionResponse.md)
    65   - [EventsV1Schema](docs/EventsV1Schema.md)
    66   - [EventsV1Subscription](docs/EventsV1Subscription.md)
    67   - [ListEventTypeResponse](docs/ListEventTypeResponse.md)
    68   - [ListSubscribedEventResponse](docs/ListSubscribedEventResponse.md)
    69   - [EventsV1SubscribedEvent](docs/EventsV1SubscribedEvent.md)
    70   - [ListSchemaVersionResponse](docs/ListSchemaVersionResponse.md)
    71   - [EventsV1SinkTest](docs/EventsV1SinkTest.md)
    72   - [ListEventTypeResponseMeta](docs/ListEventTypeResponseMeta.md)
    73   - [ListSinkResponse](docs/ListSinkResponse.md)
    74  
    75  
    76  ## Documentation For Authorization
    77  
    78  
    79  
    80  ## accountSid_authToken
    81  
    82  - **Type**: HTTP basic authentication
    83  
    84  Example
    85  
    86  ```golang
    87  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    88      UserName: "username",
    89      Password: "password",
    90  })
    91  r, err := client.Service.Operation(auth, args)
    92  ```
    93