sdk

package module
v0.0.1 Latest Latest
Warning

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

 Go to latest Published: Apr 17, 2021 License: MIT Imports: 22 Imported by: 0

README

Go API client for sdk

lighthouse 20210117

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

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

Put the package under your project folder and add the following in import:

import sw "./sdk"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)
Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identifield by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://lighthouse.lbry.com

Class Method HTTP request Description
LighthouseApi SearchAutoComplete Get /autocomplete 搜尋自動完成建議
LighthouseApi SearchByString Get /search 字串搜尋

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

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")

	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
	ContextHttpSignatureAuth = contextKey("httpsignature")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires 

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

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

func PtrBool 

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32 

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64 

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt 

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32 

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64 

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString 

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime 

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient 

type APIClient struct {
	LighthouseApi *LighthouseApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the lighthouse 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) 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 ApiSearchAutoCompleteRequest 

type ApiSearchAutoCompleteRequest struct {
	ApiService *LighthouseApiService
	// contains filtered or unexported fields
}

func (ApiSearchAutoCompleteRequest) Execute 

func (r ApiSearchAutoCompleteRequest) Execute() ([]string, *_nethttp.Response, error)

func (ApiSearchAutoCompleteRequest) From 

func (r ApiSearchAutoCompleteRequest) From(from int32) ApiSearchAutoCompleteRequest

func (ApiSearchAutoCompleteRequest) Nsfw 

func (r ApiSearchAutoCompleteRequest) Nsfw(nsfw bool) ApiSearchAutoCompleteRequest

func (ApiSearchAutoCompleteRequest) S 

func (r ApiSearchAutoCompleteRequest) S(s string) ApiSearchAutoCompleteRequest

func (ApiSearchAutoCompleteRequest) Size 

func (r ApiSearchAutoCompleteRequest) Size(size int32) ApiSearchAutoCompleteRequest

type ApiSearchByStringRequest 

type ApiSearchByStringRequest struct {
	ApiService *LighthouseApiService
	// contains filtered or unexported fields
}

func (ApiSearchByStringRequest) Channel 

func (r ApiSearchByStringRequest) Channel(channel string) ApiSearchByStringRequest

func (ApiSearchByStringRequest) ChannelId 

func (r ApiSearchByStringRequest) ChannelId(channelId string) ApiSearchByStringRequest

func (ApiSearchByStringRequest) Execute 

func (r ApiSearchByStringRequest) Execute() ([]SearchResponse, *_nethttp.Response, error)

func (ApiSearchByStringRequest) FreeOnly 

func (r ApiSearchByStringRequest) FreeOnly(freeOnly bool) ApiSearchByStringRequest

func (ApiSearchByStringRequest) From 

func (r ApiSearchByStringRequest) From(from int32) ApiSearchByStringRequest

func (ApiSearchByStringRequest) Include 

func (r ApiSearchByStringRequest) Include(include string) ApiSearchByStringRequest

func (ApiSearchByStringRequest) Nsfw 

func (r ApiSearchByStringRequest) Nsfw(nsfw bool) ApiSearchByStringRequest

func (ApiSearchByStringRequest) RelatedTo 

func (r ApiSearchByStringRequest) RelatedTo(relatedTo string) ApiSearchByStringRequest

func (ApiSearchByStringRequest) Resolve 

func (r ApiSearchByStringRequest) Resolve(resolve bool) ApiSearchByStringRequest

func (ApiSearchByStringRequest) S 

func (r ApiSearchByStringRequest) S(s string) ApiSearchByStringRequest

func (ApiSearchByStringRequest) Size 

func (r ApiSearchByStringRequest) Size(size int32) ApiSearchByStringRequest

func (ApiSearchByStringRequest) SortBy 

func (r ApiSearchByStringRequest) SortBy(sortBy string) ApiSearchByStringRequest

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 {
	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          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	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

func (*Configuration) ServerURLWithContext 

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

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 LighthouseApiService 

type LighthouseApiService service

LighthouseApiService LighthouseApi service

func (*LighthouseApiService) SearchAutoComplete 

func (a *LighthouseApiService) SearchAutoComplete(ctx _context.Context) ApiSearchAutoCompleteRequest

* SearchAutoComplete 搜尋自動完成建議 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @return ApiSearchAutoCompleteRequest

func (*LighthouseApiService) SearchAutoCompleteExecute 

func (a *LighthouseApiService) SearchAutoCompleteExecute(r ApiSearchAutoCompleteRequest) ([]string, *_nethttp.Response, error)

* Execute executes the request * @return []string

func (*LighthouseApiService) SearchByString 

func (a *LighthouseApiService) SearchByString(ctx _context.Context) ApiSearchByStringRequest

* SearchByString 字串搜尋 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @return ApiSearchByStringRequest

func (*LighthouseApiService) SearchByStringExecute 

func (a *LighthouseApiService) SearchByStringExecute(r ApiSearchByStringRequest) ([]SearchResponse, *_nethttp.Response, error)

* Execute executes the request * @return []SearchResponse

type NullableBool 

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

func NewNullableBool 

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get 

func (v NullableBool) Get() *bool

func (NullableBool) IsSet 

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON 

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set 

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON 

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset 

func (v *NullableBool) Unset()

type NullableFloat32 

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

func NewNullableFloat32 

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get 

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet 

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON 

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set 

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON 

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset 

func (v *NullableFloat32) Unset()

type NullableFloat64 

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

func NewNullableFloat64 

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get 

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet 

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON 

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set 

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON 

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset 

func (v *NullableFloat64) Unset()

type NullableInt 

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

func NewNullableInt 

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get 

func (v NullableInt) Get() *int

func (NullableInt) IsSet 

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON 

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set 

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON 

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset 

func (v *NullableInt) Unset()

type NullableInt32 

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

func NewNullableInt32 

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get 

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet 

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON 

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set 

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON 

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset 

func (v *NullableInt32) Unset()

type NullableInt64 

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

func NewNullableInt64 

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get 

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet 

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON 

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set 

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON 

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset 

func (v *NullableInt64) Unset()

type NullableSearchResponse 

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

func NewNullableSearchResponse 

func NewNullableSearchResponse(val *SearchResponse) *NullableSearchResponse

func (NullableSearchResponse) Get 

func (v NullableSearchResponse) Get() *SearchResponse

func (NullableSearchResponse) IsSet 

func (v NullableSearchResponse) IsSet() bool

func (NullableSearchResponse) MarshalJSON 

func (v NullableSearchResponse) MarshalJSON() ([]byte, error)

func (*NullableSearchResponse) Set 

func (v *NullableSearchResponse) Set(val *SearchResponse)

func (*NullableSearchResponse) UnmarshalJSON 

func (v *NullableSearchResponse) UnmarshalJSON(src []byte) error

func (*NullableSearchResponse) Unset 

func (v *NullableSearchResponse) Unset()

type NullableString 

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

func NewNullableString 

func NewNullableString(val *string) *NullableString

func (NullableString) Get 

func (v NullableString) Get() *string

func (NullableString) IsSet 

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON 

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set 

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON 

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset 

func (v *NullableString) Unset()

type NullableTime 

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

func NewNullableTime 

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get 

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet 

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON 

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set 

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON 

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset 

func (v *NullableTime) Unset()

type SearchResponse 

type SearchResponse struct {
	ClaimId *string `json:"claimId,omitempty"`
	Name    *string `json:"name,omitempty"`
}

SearchResponse struct for SearchResponse

func NewSearchResponse 

func NewSearchResponse() *SearchResponse

NewSearchResponse instantiates a new SearchResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSearchResponseWithDefaults 

func NewSearchResponseWithDefaults() *SearchResponse

NewSearchResponseWithDefaults instantiates a new SearchResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SearchResponse) GetClaimId 

func (o *SearchResponse) GetClaimId() string

GetClaimId returns the ClaimId field value if set, zero value otherwise.

func (*SearchResponse) GetClaimIdOk 

func (o *SearchResponse) GetClaimIdOk() (*string, bool)

GetClaimIdOk returns a tuple with the ClaimId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResponse) GetName 

func (o *SearchResponse) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*SearchResponse) GetNameOk 

func (o *SearchResponse) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResponse) HasClaimId 

func (o *SearchResponse) HasClaimId() bool

HasClaimId returns a boolean if a field has been set.

func (*SearchResponse) HasName 

func (o *SearchResponse) HasName() bool

HasName returns a boolean if a field has been set.

func (SearchResponse) MarshalJSON 

func (o SearchResponse) MarshalJSON() ([]byte, error)

func (*SearchResponse) SetClaimId 

func (o *SearchResponse) SetClaimId(v string)

SetClaimId gets a reference to the given string and assigns it to the ClaimId field.

func (*SearchResponse) SetName 

func (o *SearchResponse) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

type ServerConfiguration 

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

ServerConfiguration stores the information about a server

type ServerConfigurations 

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL 

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable 

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

ServerVariable stores the information about a server variable

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.