rest

package

v0.0.181 Latest Latest Go to latest Published: Jun 18, 2023 License: MIT Imports: 20 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/synapsecns/sanguine

Links

Open Source Insights

README ¶

Go API client for rest

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

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: version not set
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 "./rest"

Documentation for API Endpoints

All URIs are relative to /

Class	Method	HTTP request	Description
ScribeServiceApi	ScribeServiceCheck	Post /grpc/v1/health_check	see: https://github.com/grpc/grpc/blob/master/doc/health-checking.md
ScribeServiceApi	ScribeServiceFilterLogs	Post /grpc/v1/filter_logs
ScribeServiceApi	ScribeServiceStreamLogs	Post /grpc/v1/stream_logs
ScribeServiceApi	ScribeServiceWatch	Post /grpc/v1/health_watch

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation ¶

Overview ¶

* types/v1/service.proto * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: version not set * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type BasicAuth
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type HealthCheckResponseServingStatus
type LogServiceApiService
- func (a *LogServiceApiService) LogServiceFilterLogs(ctx context.Context, body V1FilterLogsRequest) (V1FilterLogsResponse, *http.Response, error)
type ProtobufNullValue
type RpcStatus
type ScribeServiceApiService
- func (a *ScribeServiceApiService) ScribeServiceCheck(ctx context.Context, body V1HealthCheckRequest) (V1HealthCheckResponse, *http.Response, error)
- func (a *ScribeServiceApiService) ScribeServiceFilterLogs(ctx context.Context, body V1FilterLogsRequest) (V1FilterLogsResponse, *http.Response, error)
- func (a *ScribeServiceApiService) ScribeServiceStreamLogs(ctx context.Context, body V1StreamLogsRequest) (StreamResultOfV1StreamLogsResponse, *http.Response, error)
- func (a *ScribeServiceApiService) ScribeServiceWatch(ctx context.Context, body V1HealthCheckRequest) (StreamResultOfV1HealthCheckResponse, *http.Response, error)
type StreamResultOfV1HealthCheckResponse
type StreamResultOfV1StreamLogsResponse
type V1Address
type V1FilterLogsRequest
type V1FilterLogsResponse
type V1Hash
type V1HealthCheckRequest
type V1HealthCheckResponse
type V1Log
type V1LogFilter
type V1NullableBool
type V1NullableString
type V1NullableUint32
type V1NullableUint64
type V1StreamLogsRequest
type V1StreamLogsResponse

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a 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 {
	ScribeServiceApi *ScribeServiceApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the types/v1/service.proto API vversion not set 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)

Change base path to allow switching to mocks

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 swagger 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:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

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"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

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

type GenericSwaggerError ¶

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

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

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

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

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type HealthCheckResponseServingStatus ¶

type HealthCheckResponseServingStatus string

const (
	UNKNOWN_HealthCheckResponseServingStatus         HealthCheckResponseServingStatus = "UNKNOWN"
	SERVING_HealthCheckResponseServingStatus         HealthCheckResponseServingStatus = "SERVING"
	NOT_SERVING_HealthCheckResponseServingStatus     HealthCheckResponseServingStatus = "NOT_SERVING"
	SERVICE_UNKNOWN_HealthCheckResponseServingStatus HealthCheckResponseServingStatus = "SERVICE_UNKNOWN"
)

List of HealthCheckResponseServingStatus

type LogServiceApiService ¶

type LogServiceApiService service

func (*LogServiceApiService) LogServiceFilterLogs ¶

func (a *LogServiceApiService) LogServiceFilterLogs(ctx context.Context, body V1FilterLogsRequest) (V1FilterLogsResponse, *http.Response, error)

LogServiceApiService

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return V1FilterLogsResponse.

type ProtobufNullValue ¶

type ProtobufNullValue string

ProtobufNullValue : `NullValue` is a singleton enumeration to represent the null value for the `Value` type union. The JSON representation for `NullValue` is JSON `null`. - NULL_VALUE: Null value.

const (
	NULL_VALUE_ProtobufNullValue ProtobufNullValue = "NULL_VALUE"
)

List of protobufNullValue

type RpcStatus ¶

type RpcStatus struct {
	Code    int32                    `json:"code,omitempty"`
	Message string                   `json:"message,omitempty"`
	Details []map[string]interface{} `json:"details,omitempty"`
}

type ScribeServiceApiService ¶

type ScribeServiceApiService service

func (*ScribeServiceApiService) ScribeServiceCheck ¶

func (a *ScribeServiceApiService) ScribeServiceCheck(ctx context.Context, body V1HealthCheckRequest) (V1HealthCheckResponse, *http.Response, error)

ScribeServiceApiService see: https://github.com/grpc/grpc/blob/master/doc/health-checking.md

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return V1HealthCheckResponse

func (*ScribeServiceApiService) ScribeServiceFilterLogs ¶

func (a *ScribeServiceApiService) ScribeServiceFilterLogs(ctx context.Context, body V1FilterLogsRequest) (V1FilterLogsResponse, *http.Response, error)

ScribeServiceApiService

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return V1FilterLogsResponse

func (*ScribeServiceApiService) ScribeServiceStreamLogs ¶ added in v0.0.73

func (a *ScribeServiceApiService) ScribeServiceStreamLogs(ctx context.Context, body V1StreamLogsRequest) (StreamResultOfV1StreamLogsResponse, *http.Response, error)

ScribeServiceApiService

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return StreamResultOfV1StreamLogsResponse

func (*ScribeServiceApiService) ScribeServiceWatch ¶

func (a *ScribeServiceApiService) ScribeServiceWatch(ctx context.Context, body V1HealthCheckRequest) (StreamResultOfV1HealthCheckResponse, *http.Response, error)

ScribeServiceApiService

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return StreamResultOfV1HealthCheckResponse

type StreamResultOfV1HealthCheckResponse ¶

type StreamResultOfV1HealthCheckResponse struct {
	Result *V1HealthCheckResponse `json:"result,omitempty"`
	Error_ *RpcStatus             `json:"error,omitempty"`
}

type StreamResultOfV1StreamLogsResponse ¶ added in v0.0.73

type StreamResultOfV1StreamLogsResponse struct {
	Result *V1StreamLogsResponse `json:"result,omitempty"`
	Error_ *RpcStatus            `json:"error,omitempty"`
}

type V1Address ¶

type V1Address struct {
	Bytes string `json:"bytes,omitempty"`
}

type V1FilterLogsRequest ¶

type V1FilterLogsRequest struct {
	Filter *V1LogFilter `json:"filter,omitempty"`
	Page   int64        `json:"page,omitempty"`
}

type V1FilterLogsResponse ¶

type V1FilterLogsResponse struct {
	Logs []V1Log `json:"logs,omitempty"`
}

type V1Hash ¶

type V1Hash struct {
	Bytes string `json:"bytes,omitempty"`
}

type V1HealthCheckRequest ¶

type V1HealthCheckRequest struct {
	Service string `json:"service,omitempty"`
}

type V1HealthCheckResponse ¶

type V1HealthCheckResponse struct {
	Status *HealthCheckResponseServingStatus `json:"status,omitempty"`
}

type V1Log ¶

type V1Log struct {
	Address     *V1Address `json:"address,omitempty"`
	Topics      []V1Hash   `json:"topics,omitempty"`
	Data        string     `json:"data,omitempty"`
	BlockNumber string     `json:"blockNumber,omitempty"`
	TxHash      *V1Hash    `json:"txHash,omitempty"`
	TxIndex     string     `json:"txIndex,omitempty"`
	BlockHash   *V1Hash    `json:"blockHash,omitempty"`
	Index       string     `json:"index,omitempty"`
	Removed     bool       `json:"removed,omitempty"`
}

type V1LogFilter ¶

type V1LogFilter struct {
	ContractAddress *V1NullableString `json:"contractAddress,omitempty"`
	ChainId         int64             `json:"chainId,omitempty"`
	BlockNumber     *V1NullableUint64 `json:"blockNumber,omitempty"`
	TxHash          *V1NullableString `json:"txHash,omitempty"`
	TxIndex         *V1NullableUint64 `json:"txIndex,omitempty"`
	BlockHash       *V1NullableString `json:"blockHash,omitempty"`
	Index           *V1NullableUint64 `json:"index,omitempty"`
	Confirmed       *V1NullableBool   `json:"confirmed,omitempty"`
}

type V1NullableBool ¶

type V1NullableBool struct {
	Null string `json:"null,omitempty"`
	Data bool   `json:"data,omitempty"`
}

type V1NullableString ¶

type V1NullableString struct {
	Null string `json:"null,omitempty"`
	Data string `json:"data,omitempty"`
}

type V1NullableUint32 ¶

type V1NullableUint32 struct {
	Null string `json:"null,omitempty"`
	Data int64  `json:"data,omitempty"`
}

type V1NullableUint64 ¶

type V1NullableUint64 struct {
	Null string `json:"null,omitempty"`
	Data string `json:"data,omitempty"`
}

type V1StreamLogsRequest ¶ added in v0.0.73

type V1StreamLogsRequest struct {
	Filter    *V1LogFilter `json:"filter,omitempty"`
	FromBlock string       `json:"fromBlock,omitempty"`
	ToBlock   string       `json:"toBlock,omitempty"`
}

type V1StreamLogsResponse ¶ added in v0.0.73

type V1StreamLogsResponse struct {
	Log *V1Log `json:"log,omitempty"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL