# README
Go API client for swagger
Service for interacting with Connection Manager resources
Overview
This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.
- API version: v1
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen
Installation
Put the package under your project folder and add the following in import:
import "./swagger"
Documentation for API Endpoints
All URIs are relative to /
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ConnectApi | ConnectConsumerToken | Post /v1/consumers:consumerToken | Consumer Token |
| ConnectApi | ConnectCreateConnector | Post /v1/connectors | Create connector |
| ConnectApi | ConnectCreateConnectorLink | Post /v1/connectors/{connector}/links | CreateConnectorLink |
| ConnectApi | ConnectCreateLinkedAccount | Post /v1/connectors/{connector}/linkedaccounts | Create LinkedAccount |
| ConnectApi | ConnectCreateLinkedAccountLog | Post /v1/connectors/{connector}/linkedaccounts/{linkedaccount}/logs | Create LinkedAccountLog |
| ConnectApi | ConnectCredentials | Post /v1/connectors/{connector}/linkedaccounts/{linkedaccount}:credentials | LinkedAccount Credentials |
| ConnectApi | ConnectDisableLinkedAccount | Post /v1/connectors/{connector}/linkedaccounts/{linkedaccount}:disable | DisableLinkedAccount |
| ConnectApi | ConnectGetConnector | Get /v1/connectors/{connector} | Get Connector |
| ConnectApi | ConnectGetConnectorTemplate | Get /v1/connectortemplates/{connectortemplate} | Get ConnectorTemplate |
| ConnectApi | ConnectGetLinkedAccount | Get /v1/connectors/{connector}/linkedaccounts/{linkedaccount} | Get LinkedAccount |
| ConnectApi | ConnectListConnectors | Get /v1/connectors | List Connectors |
| ConnectApi | ConnectListLinkedAccountLogs | Get /v1/connectors/{connector}/linkedaccounts/{linkedaccount}/logs | ListLinkedAccountLogs |
| ConnectApi | ConnectListLinkedAccounts | Get /v1/connectors/{connector}/linkedaccounts | List LinkedAccounts |
| ConnectApi | ConnectLoadConnectorLink | Post /v1/connectors:loadLink | LoadConnectorLink |
| ConnectApi | ConnectLoadCredentials | Get /v1/connectors/{connector}/consumers/{consumer}:credentials | LoadCredentials |
| ConnectApi | ConnectUpdateConnector | Patch /v1/connectors/{connector} | Update Connector |
| ConnectApi | ConnectUpdateLinkedAccount | Patch /v1/connectors/{connector}/linkedaccounts/{linkedaccount} | Update LinkedAccount |
Documentation For Models
- Connector
- ConnectorAgentConfig
- ConnectorApiKeyConfig
- ConnectorBasicAuthConfig
- ConnectorLink
- ConnectorOauth2Config
- ConnectorTemplate
- ConsumerMetadata
- ConsumerTokenRequest
- ConsumerTokenResponse
- CredentialsRequest
- CredentialsResponse
- CredentialsResponseCredentials
- DisableLinkedAccountRequest
- LinkedAccount
- LinkedAccountAgentAuthData
- LinkedAccountLog
- ListConnectorsResponse
- ListLinkedAccountLogsResponse
- ListLinkedAccountsResponse
- LoadConnectorLinkRequest
- LoadConnectorLinkResponse
- Status
Documentation For Authorization
Endpoints do not require authorization.
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 a oauth2.TokenSource as authentication for the request.
# Structs
APIClient manages communication with the Connect API API vv1 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
A representation of a Connector.
On prem agent configuration.
API Key Config message.
Basic Auth Config message.
response message.
Oauth2 config message.
Connector Template Resource.
consumer metadata.
Request for a consumer token.
Response for a consumer token.
Returns the linked account's access token.
Credentials associated with the LinkedAccount.
Message for linked account credentials.
Request to disable linked account.
GenericSwaggerError Provides access to the body, error and model on returned errors.
LinkedAccount to a connector.
Agent auth data is set when the connector type is AGENT.
LinkedAccountLogs.
Response for listAPIsResponse.
List linked accounts logs response.
Response for listLinkedAccountsResponse.
Request for a connector link.
Data to be used in the embedded marketplace to present the consumer with a UI to link a connector.
The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
# Interfaces
ModelMaps is a placeholder definition for the undefined status maps.
# Type aliases
No description provided by the author
Deprecated: ConsumerTokenRequestConsumerMetadata is deprecated, use ConsumerMetadata instead.