# README
Go API client for engagevoice
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Overview
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 1.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
Installation
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional
Put the package under your project folder and add the following in import:
import "./engagevoice"
Documentation for API Endpoints
All URIs are relative to https://portal.vacd.biz/api/v1
Class | Method | HTTP request | Description |
---|---|---|---|
AgentsApi | GetAgentGroups | Get /admin/accounts/{accountId}/agentGroups | Get Agent Groups |
AgentsApi | GetAgents | Get /admin/accounts/{accountId}/agentGroups/{agentGroupId}/agents | Get Group Agents |
AuthApi | GetTokens | Get /admin/token | Get Tokens |
CampaignLeadsApi | GetLeadStates | Get /admin/accounts/{accountId}/campaignLeads/leadStates | Get Lead States |
CampaignLeadsApi | GetSystemDispositions | Get /admin/accounts/{accountId}/campaignLeads/systemDispositions | Get Systems Dispositions |
CampaignLeadsApi | SearchLeads | Post /admin/accounts/{accountId}/campaignLeads/leadSearch | Search Leads |
CampaignsApi | PatchCampaignLead | Patch /admin/accounts/{accountId}/campaignLeads/{leadId} | Patch Campaign Lead |
CampaignsApi | UpdateCampaignLead | Put /admin/accounts/{accountId}/campaignLeads/{leadId} | Update Campaign Lead |
CampaignsApi | UploadLeads | Post /admin/accounts/{accountId}/campaigns/{campaignId}/leadLoader/direct | Upload Leads |
CountriesApi | GetAvailableCountries | Get /admin/accounts/{accountId}/countries/available | Get Available Countries |
DialGroupsApi | ClearCampaignCache | Post /admin/accounts/{accountId}/dialGroups/{dialGroupId}/campaigns/{campaignId}/clearCache | Clear Campaign Cache |
DialGroupsApi | GetCampaigns | Get /admin/accounts/{accountId}/dialGroups/{dialGroupId}/campaigns | Get Campaigns |
DialGroupsApi | GetDialGroups | Get /admin/accounts/{accountId}/dialGroups | Get Dial Groups |
UsersApi | GetUsers | Get /admin/users | Get Users |
Documentation For Models
- Agent
- AgentGroup
- Campaign
- CampaignLead
- CampaignLeadSearchCriteria
- CampaignLeadSearchResultsView
- ComparableSearchField
- Country
- DateTimeComparableSearchField
- DialGroup
- Error
- ExtendedLeadData
- Generic
- Lead
- SuppressedType
- Timezone
- UploadLeadsRequest
- UploadLeadsResponse
- User
Documentation For Authorization
ApiKeyAuth
- Type: API key
Example
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)
Author
# Functions
CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
# Structs
No description provided by the author
WIP: `permissions` is an array that needs definition.
APIClient manages communication with the RingCentral Engage Voice API API v1.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GenericOpenAPIError Provides access to the body, error and model on returned errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Children field is still needed.
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author