github.com/twilio/twilio-go@v1.20.1/rest/monitor/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://monitor.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *AlertsApi* | [**FetchAlert**](docs/AlertsApi.md#fetchalert) | **Get** /v1/Alerts/{Sid} | 
    35  *AlertsApi* | [**ListAlert**](docs/AlertsApi.md#listalert) | **Get** /v1/Alerts | 
    36  *EventsApi* | [**FetchEvent**](docs/EventsApi.md#fetchevent) | **Get** /v1/Events/{Sid} | 
    37  *EventsApi* | [**ListEvent**](docs/EventsApi.md#listevent) | **Get** /v1/Events | 
    38  
    39  
    40  ## Documentation For Models
    41  
    42   - [ListAlertResponse](docs/ListAlertResponse.md)
    43   - [MonitorV1AlertInstance](docs/MonitorV1AlertInstance.md)
    44   - [MonitorV1Event](docs/MonitorV1Event.md)
    45   - [MonitorV1Alert](docs/MonitorV1Alert.md)
    46   - [ListEventResponse](docs/ListEventResponse.md)
    47   - [ListAlertResponseMeta](docs/ListAlertResponseMeta.md)
    48  
    49  
    50  ## Documentation For Authorization
    51  
    52  
    53  
    54  ## accountSid_authToken
    55  
    56  - **Type**: HTTP basic authentication
    57  
    58  Example
    59  
    60  ```golang
    61  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    62      UserName: "username",
    63      Password: "password",
    64  })
    65  r, err := client.Service.Operation(auth, args)
    66  ```
    67