openapi

package module
v0.0.0-...-36be2b3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 27, 2020 License: Apache-2.0 Imports: 23 Imported by: 0

README

Go API client for openapi

An openAPI 3.0 specification that defines how files are stored and accessed on ant investor products

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.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://antinvestor.com

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

Documentation for API Endpoints

All URIs are relative to http://api.antinvestor.com/files

Class Method HTTP request Description
DefaultApi AddFile Post /
DefaultApi DeleteFile Delete /{id}
DefaultApi FindFileById Get /{id}
DefaultApi FindFiles Get /

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

info@antinvestor.com

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	DefaultApi *DefaultApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Ant Investor Files API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type AddFileOpts 

type AddFileOpts struct {
	InlineObject optional.Interface
}

AddFileOpts Optional parameters for the method 'AddFile'

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerUrl 

func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

ServerUrl returns URL based on server settings

type DefaultApiService 

type DefaultApiService service

DefaultApiService DefaultApi service

func (*DefaultApiService) AddFile 

func (a *DefaultApiService) AddFile(ctx _context.Context, localVarOptionals *AddFileOpts) (File, *_nethttp.Response, error)

AddFile Method for AddFile Stores a new file. Duplicates are going to be ignored if the hash of the file and meta data both match an existing file

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AddFileOpts - Optional Parameters:
  • @param "InlineObject" (optional.Interface of InlineObject) -

@return File

func (*DefaultApiService) DeleteFile 

func (a *DefaultApiService) DeleteFile(ctx _context.Context, id string) (*_nethttp.Response, error)

DeleteFile Method for DeleteFile deletes a single file based on the ID supplied

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of file to delete

func (*DefaultApiService) FindFileById 

func (a *DefaultApiService) FindFileById(ctx _context.Context, id string) (*os.File, *_nethttp.Response, error)

FindFileById Method for FindFileById Returns a file based on supplied ID

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID of file to fetch

@return *os.File

func (*DefaultApiService) FindFiles 

func (a *DefaultApiService) FindFiles(ctx _context.Context, localVarOptionals *FindFilesOpts) ([]File, *_nethttp.Response, error)

FindFiles Method for FindFiles Returns all files from the system that the user has access to

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *FindFilesOpts - Optional Parameters:
  • @param "SubscriptionId" (optional.String) - filters the files by the subscription by
  • @param "GroupId" (optional.String) - filters the files by the grouping id
  • @param "Limit" (optional.Int32) - maximum number of results to return

@return []File

type Error 

type Error struct {
	Code    int32  `json:"code"`
	Message string `json:"message"`
}

Error struct for Error

type File 

type File struct {
	Id             string `json:"id,omitempty"`
	GroupId        string `json:"group_id,omitempty"`
	SubscriptionId string `json:"subscription_id,omitempty"`
	Public         bool   `json:"public,omitempty"`
	Name           string `json:"name"`
	Url            string `json:"url,omitempty"`
}

File struct for File

type FindFilesOpts 

type FindFilesOpts struct {
	SubscriptionId optional.String
	GroupId        optional.String
	Limit          optional.Int32
}

FindFilesOpts Optional parameters for the method 'FindFiles'

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type InlineObject 

type InlineObject struct {
	GroupId        string   `json:"group_id,omitempty"`
	SubscriptionId string   `json:"subscription_id,omitempty"`
	Public         bool     `json:"public,omitempty"`
	Name           string   `json:"name,omitempty"`
	FileObject     *os.File `json:"fileObject,omitempty"`
}

InlineObject struct for InlineObject

type ServerConfiguration 

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type UnauthorizedError 

type UnauthorizedError struct {
}

Access token is missing or invalid

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.