github.com/grokify/go-ringcentral-client@v0.3.31/engagevoice/v1/client/README.md (about)

     1  # Go API client for engagevoice
     2  
     3  No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
     4  
     5  ## Overview
     6  This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  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
     9  - Package version: 1.0.0
    10  - Build package: org.openapitools.codegen.languages.GoClientCodegen
    11  
    12  ## Installation
    13  
    14  Install the following dependencies:
    15  
    16  ```shell
    17  go get github.com/stretchr/testify/assert
    18  go get golang.org/x/oauth2
    19  go get golang.org/x/net/context
    20  go get github.com/antihax/optional
    21  ```
    22  
    23  Put the package under your project folder and add the following in import:
    24  
    25  ```golang
    26  import "./engagevoice"
    27  ```
    28  
    29  ## Documentation for API Endpoints
    30  
    31  All URIs are relative to *https://portal.vacd.biz/api/v1*
    32  
    33  Class | Method | HTTP request | Description
    34  ------------ | ------------- | ------------- | -------------
    35  *AgentsApi* | [**GetAgentGroups**](docs/AgentsApi.md#getagentgroups) | **Get** /admin/accounts/{accountId}/agentGroups | Get Agent Groups
    36  *AgentsApi* | [**GetAgents**](docs/AgentsApi.md#getagents) | **Get** /admin/accounts/{accountId}/agentGroups/{agentGroupId}/agents | Get Group Agents
    37  *AuthApi* | [**GetTokens**](docs/AuthApi.md#gettokens) | **Get** /admin/token | Get Tokens
    38  *CampaignLeadsApi* | [**GetLeadStates**](docs/CampaignLeadsApi.md#getleadstates) | **Get** /admin/accounts/{accountId}/campaignLeads/leadStates | Get Lead States
    39  *CampaignLeadsApi* | [**GetSystemDispositions**](docs/CampaignLeadsApi.md#getsystemdispositions) | **Get** /admin/accounts/{accountId}/campaignLeads/systemDispositions | Get Systems Dispositions
    40  *CampaignLeadsApi* | [**SearchLeads**](docs/CampaignLeadsApi.md#searchleads) | **Post** /admin/accounts/{accountId}/campaignLeads/leadSearch | Search Leads
    41  *CampaignsApi* | [**PatchCampaignLead**](docs/CampaignsApi.md#patchcampaignlead) | **Patch** /admin/accounts/{accountId}/campaignLeads/{leadId} | Patch Campaign Lead
    42  *CampaignsApi* | [**UpdateCampaignLead**](docs/CampaignsApi.md#updatecampaignlead) | **Put** /admin/accounts/{accountId}/campaignLeads/{leadId} | Update Campaign Lead
    43  *CampaignsApi* | [**UploadLeads**](docs/CampaignsApi.md#uploadleads) | **Post** /admin/accounts/{accountId}/campaigns/{campaignId}/leadLoader/direct | Upload Leads
    44  *CountriesApi* | [**GetAvailableCountries**](docs/CountriesApi.md#getavailablecountries) | **Get** /admin/accounts/{accountId}/countries/available | Get Available Countries
    45  *DialGroupsApi* | [**ClearCampaignCache**](docs/DialGroupsApi.md#clearcampaigncache) | **Post** /admin/accounts/{accountId}/dialGroups/{dialGroupId}/campaigns/{campaignId}/clearCache | Clear Campaign Cache
    46  *DialGroupsApi* | [**GetCampaigns**](docs/DialGroupsApi.md#getcampaigns) | **Get** /admin/accounts/{accountId}/dialGroups/{dialGroupId}/campaigns | Get Campaigns
    47  *DialGroupsApi* | [**GetDialGroups**](docs/DialGroupsApi.md#getdialgroups) | **Get** /admin/accounts/{accountId}/dialGroups | Get Dial Groups
    48  *UsersApi* | [**GetUsers**](docs/UsersApi.md#getusers) | **Get** /admin/users | Get Users
    49  
    50  
    51  ## Documentation For Models
    52  
    53   - [Agent](docs/Agent.md)
    54   - [AgentGroup](docs/AgentGroup.md)
    55   - [Campaign](docs/Campaign.md)
    56   - [CampaignLead](docs/CampaignLead.md)
    57   - [CampaignLeadSearchCriteria](docs/CampaignLeadSearchCriteria.md)
    58   - [CampaignLeadSearchResultsView](docs/CampaignLeadSearchResultsView.md)
    59   - [ComparableSearchField](docs/ComparableSearchField.md)
    60   - [Country](docs/Country.md)
    61   - [DateTimeComparableSearchField](docs/DateTimeComparableSearchField.md)
    62   - [DialGroup](docs/DialGroup.md)
    63   - [Error](docs/Error.md)
    64   - [ExtendedLeadData](docs/ExtendedLeadData.md)
    65   - [Generic](docs/Generic.md)
    66   - [Lead](docs/Lead.md)
    67   - [SuppressedType](docs/SuppressedType.md)
    68   - [Timezone](docs/Timezone.md)
    69   - [UploadLeadsRequest](docs/UploadLeadsRequest.md)
    70   - [UploadLeadsResponse](docs/UploadLeadsResponse.md)
    71   - [User](docs/User.md)
    72  
    73  
    74  ## Documentation For Authorization
    75  
    76  
    77  
    78  ## ApiKeyAuth
    79  
    80  - **Type**: API key
    81  
    82  Example
    83  
    84  ```golang
    85  auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
    86      Key: "APIKEY",
    87      Prefix: "Bearer", // Omit if not necessary.
    88  })
    89  r, err := client.Service.Operation(auth, args)
    90  ```
    91  
    92  
    93  ## Author
    94  
    95  
    96