github.com/twilio/twilio-go@v1.20.1/rest/notify/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://notify.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *CredentialsApi* | [**CreateCredential**](docs/CredentialsApi.md#createcredential) | **Post** /v1/Credentials | 
    35  *CredentialsApi* | [**DeleteCredential**](docs/CredentialsApi.md#deletecredential) | **Delete** /v1/Credentials/{Sid} | 
    36  *CredentialsApi* | [**FetchCredential**](docs/CredentialsApi.md#fetchcredential) | **Get** /v1/Credentials/{Sid} | 
    37  *CredentialsApi* | [**ListCredential**](docs/CredentialsApi.md#listcredential) | **Get** /v1/Credentials | 
    38  *CredentialsApi* | [**UpdateCredential**](docs/CredentialsApi.md#updatecredential) | **Post** /v1/Credentials/{Sid} | 
    39  *ServicesApi* | [**CreateService**](docs/ServicesApi.md#createservice) | **Post** /v1/Services | 
    40  *ServicesApi* | [**DeleteService**](docs/ServicesApi.md#deleteservice) | **Delete** /v1/Services/{Sid} | 
    41  *ServicesApi* | [**FetchService**](docs/ServicesApi.md#fetchservice) | **Get** /v1/Services/{Sid} | 
    42  *ServicesApi* | [**ListService**](docs/ServicesApi.md#listservice) | **Get** /v1/Services | 
    43  *ServicesApi* | [**UpdateService**](docs/ServicesApi.md#updateservice) | **Post** /v1/Services/{Sid} | 
    44  *ServicesBindingsApi* | [**CreateBinding**](docs/ServicesBindingsApi.md#createbinding) | **Post** /v1/Services/{ServiceSid}/Bindings | 
    45  *ServicesBindingsApi* | [**DeleteBinding**](docs/ServicesBindingsApi.md#deletebinding) | **Delete** /v1/Services/{ServiceSid}/Bindings/{Sid} | 
    46  *ServicesBindingsApi* | [**FetchBinding**](docs/ServicesBindingsApi.md#fetchbinding) | **Get** /v1/Services/{ServiceSid}/Bindings/{Sid} | 
    47  *ServicesBindingsApi* | [**ListBinding**](docs/ServicesBindingsApi.md#listbinding) | **Get** /v1/Services/{ServiceSid}/Bindings | 
    48  *ServicesNotificationsApi* | [**CreateNotification**](docs/ServicesNotificationsApi.md#createnotification) | **Post** /v1/Services/{ServiceSid}/Notifications | 
    49  
    50  
    51  ## Documentation For Models
    52  
    53   - [NotifyV1Credential](docs/NotifyV1Credential.md)
    54   - [ListBindingResponseMeta](docs/ListBindingResponseMeta.md)
    55   - [NotifyV1Notification](docs/NotifyV1Notification.md)
    56   - [NotifyV1Service](docs/NotifyV1Service.md)
    57   - [NotifyV1Binding](docs/NotifyV1Binding.md)
    58   - [ListBindingResponse](docs/ListBindingResponse.md)
    59   - [ListCredentialResponse](docs/ListCredentialResponse.md)
    60   - [ListServiceResponse](docs/ListServiceResponse.md)
    61  
    62  
    63  ## Documentation For Authorization
    64  
    65  
    66  
    67  ## accountSid_authToken
    68  
    69  - **Type**: HTTP basic authentication
    70  
    71  Example
    72  
    73  ```golang
    74  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    75      UserName: "username",
    76      Password: "password",
    77  })
    78  r, err := client.Service.Operation(auth, args)
    79  ```
    80