package
0.1.27
Repository: https://github.com/grokify/go-simplekpi.git
Documentation: pkg.go.dev

# README

Go API client for simplekpi

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 "./simplekpi"

Documentation for API Endpoints

All URIs are relative to https://YOURDOMAIN.simplekpi.com/api

ClassMethodHTTP requestDescription
KPIEntriesApiAddKPIEntryPost /kpientriesAdd KPI Entry
KPIEntriesApiDeleteKPIEntryDelete /kpientries/{kpientryid}Delete KPI Entry
KPIEntriesApiGetAllKPIEntriesGet /kpientriesGet all KPI Entries
KPIEntriesApiGetKPIEntryGet /kpientries/{kpientryid}Get KPI Entry
KPIEntriesApiUpdateKPIEntryPut /kpientries/{kpientryid}Update KPI Entry
KPIsApiGetAllKPIsGet /kpisGet all KPIs
KPIsApiGetKPIGet /kpis/{kpiId}Get a KPI
UsersApiGetAllUsersGet /usersGet all Users

Documentation For Models

Documentation For Authorization

basicAuth

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
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

APIClient manages communication with the SimpleKPI 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
Entry
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

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author