github.com/twilio/twilio-go@v1.20.1/rest/bulkexports/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://bulkexports.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *ExportsApi* | [**FetchExport**](docs/ExportsApi.md#fetchexport) | **Get** /v1/Exports/{ResourceType} | 
    35  *ExportsConfigurationApi* | [**FetchExportConfiguration**](docs/ExportsConfigurationApi.md#fetchexportconfiguration) | **Get** /v1/Exports/{ResourceType}/Configuration | 
    36  *ExportsConfigurationApi* | [**UpdateExportConfiguration**](docs/ExportsConfigurationApi.md#updateexportconfiguration) | **Post** /v1/Exports/{ResourceType}/Configuration | 
    37  *ExportsDaysApi* | [**FetchDay**](docs/ExportsDaysApi.md#fetchday) | **Get** /v1/Exports/{ResourceType}/Days/{Day} | 
    38  *ExportsDaysApi* | [**ListDay**](docs/ExportsDaysApi.md#listday) | **Get** /v1/Exports/{ResourceType}/Days | 
    39  *ExportsJobsApi* | [**CreateExportCustomJob**](docs/ExportsJobsApi.md#createexportcustomjob) | **Post** /v1/Exports/{ResourceType}/Jobs | 
    40  *ExportsJobsApi* | [**DeleteJob**](docs/ExportsJobsApi.md#deletejob) | **Delete** /v1/Exports/Jobs/{JobSid} | 
    41  *ExportsJobsApi* | [**FetchJob**](docs/ExportsJobsApi.md#fetchjob) | **Get** /v1/Exports/Jobs/{JobSid} | 
    42  *ExportsJobsApi* | [**ListExportCustomJob**](docs/ExportsJobsApi.md#listexportcustomjob) | **Get** /v1/Exports/{ResourceType}/Jobs | 
    43  
    44  
    45  ## Documentation For Models
    46  
    47   - [BulkexportsV1ExportConfiguration](docs/BulkexportsV1ExportConfiguration.md)
    48   - [BulkexportsV1Export](docs/BulkexportsV1Export.md)
    49   - [BulkexportsV1Job](docs/BulkexportsV1Job.md)
    50   - [BulkexportsV1Day](docs/BulkexportsV1Day.md)
    51   - [ListDayResponseMeta](docs/ListDayResponseMeta.md)
    52   - [BulkexportsV1DayInstance](docs/BulkexportsV1DayInstance.md)
    53   - [ListDayResponse](docs/ListDayResponse.md)
    54   - [ListExportCustomJobResponse](docs/ListExportCustomJobResponse.md)
    55   - [BulkexportsV1ExportCustomJob](docs/BulkexportsV1ExportCustomJob.md)
    56  
    57  
    58  ## Documentation For Authorization
    59  
    60  
    61  
    62  ## accountSid_authToken
    63  
    64  - **Type**: HTTP basic authentication
    65  
    66  Example
    67  
    68  ```golang
    69  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    70      UserName: "username",
    71      Password: "password",
    72  })
    73  r, err := client.Service.Operation(auth, args)
    74  ```
    75