morpheusmarketplace

package module
v0.0.0-...-5bc9c7f Latest Latest
Warning

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

 Go to latest Published: Nov 12, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

README

Morpheus Marketplace Go API Library

Go Reference

The Morpheus Marketplace Go library provides convenient access to the Morpheus Marketplace REST API from applications written in Go. The full API of this library can be found in api.md.

It is generated with Stainless.

Installation

import (
	"github.com/srt0422/morpheus-marketplace-go" // imported as morpheusmarketplace
)

Or to pin the version:

go get -u 'github.com/srt0422/morpheus-marketplace-go@v0.0.1-alpha.0'

Requirements

This library requires Go 1.18+.

Usage

The full API of this library can be found in api.md.

package main

import (
	"context"
	"fmt"

	"github.com/srt0422/morpheus-marketplace-go"
	"github.com/srt0422/morpheus-marketplace-go/option"
)

func main() {
	client := morpheusmarketplace.NewClient(
		option.WithAPIKey("My API Key"), // defaults to os.LookupEnv("X_API_KEY")
	)
	balance, err := client.Blockchain.Balance.Get(context.TODO())
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", balance.Balance)
}
Request fields

All request parameters are wrapped in a generic Field type, which we use to distinguish zero values from null or omitted fields.

This prevents accidentally sending a zero value if you forget a required parameter, and enables explicitly sending null, false, '', or 0 on optional parameters. Any field not specified is not sent.

To construct fields with values, use the helpers String(), Int(), Float(), or most commonly, the generic F[T](). To send a null, use Null[T](), and to send a nonconforming value, use Raw[T](any). For example:

params := FooParams{
	Name: morpheusmarketplace.F("hello"),

	// Explicitly send `"description": null`
	Description: morpheusmarketplace.Null[string](),

	Point: morpheusmarketplace.F(morpheusmarketplace.Point{
		X: morpheusmarketplace.Int(0),
		Y: morpheusmarketplace.Int(1),

		// In cases where the API specifies a given type,
		// but you want to send something else, use `Raw`:
		Z: morpheusmarketplace.Raw[int64](0.01), // sends a float
	}),
}
Response objects

All fields in response structs are value types (not pointers or wrappers).

If a given field is null, not present, or invalid, the corresponding field will simply be its zero value.

All response structs also include a special JSON field, containing more detailed information about each property, which you can use like so:

if res.Name == "" {
	// true if `"name"` is either not present or explicitly null
	res.JSON.Name.IsNull()

	// true if the `"name"` key was not present in the repsonse JSON at all
	res.JSON.Name.IsMissing()

	// When the API returns data that cannot be coerced to the expected type:
	if res.JSON.Name.IsInvalid() {
		raw := res.JSON.Name.Raw()

		legacyName := struct{
			First string `json:"first"`
			Last  string `json:"last"`
		}{}
		json.Unmarshal([]byte(raw), &legacyName)
		name = legacyName.First + " " + legacyName.Last
	}
}

These .JSON structs also include an Extras map containing any properties in the json response that were not specified in the struct. This can be useful for API features not yet present in the SDK.

body := res.JSON.ExtraFields["my_unexpected_field"].Raw()
RequestOptions

This library uses the functional options pattern. Functions defined in the option package return a RequestOption, which is a closure that mutates a RequestConfig. These options can be supplied to the client or at individual requests. For example:

client := morpheusmarketplace.NewClient(
	// Adds a header to every request made by the client
	option.WithHeader("X-Some-Header", "custom_header_info"),
)

client.Blockchain.Balance.Get(context.TODO(), ...,
	// Override the header
	option.WithHeader("X-Some-Header", "some_other_custom_header_info"),
	// Add an undocumented field to the request body, using sjson syntax
	option.WithJSONSet("some.json.path", map[string]string{"my": "object"}),
)

See the full list of request options.

Pagination

This library provides some conveniences for working with paginated list endpoints.

You can use .ListAutoPaging() methods to iterate through items across all pages:

Or you can use simple .List() methods to fetch a single page and receive a standard response object with additional helper methods like .GetNextPage(), e.g.:

Errors

When the API returns a non-success status code, we return an error with type *morpheusmarketplace.Error. This contains the StatusCode, *http.Request, and *http.Response values of the request, as well as the JSON of the error body (much like other response objects in the SDK).

To handle errors, we recommend that you use the errors.As pattern:

_, err := client.Blockchain.Balance.Get(context.TODO())
if err != nil {
	var apierr *morpheusmarketplace.Error
	if errors.As(err, &apierr) {
		println(string(apierr.DumpRequest(true)))  // Prints the serialized HTTP request
		println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response
	}
	panic(err.Error()) // GET "/blockchain/balance": 400 Bad Request { ... }
}

When other errors occur, they are returned unwrapped; for example, if HTTP transport fails, you might receive *url.Error wrapping *net.OpError.

Timeouts

Requests do not time out by default; use context to configure a timeout for a request lifecycle.

Note that if a request is retried, the context timeout does not start over. To set a per-retry timeout, use option.WithRequestTimeout().

// This sets the timeout for the request, including all the retries.
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
defer cancel()
client.Blockchain.Balance.Get(
	ctx,
	// This sets the per-retry timeout
	option.WithRequestTimeout(20*time.Second),
)
File uploads

Request parameters that correspond to file uploads in multipart requests are typed as param.Field[io.Reader]. The contents of the io.Reader will by default be sent as a multipart form part with the file name of "anonymous_file" and content-type of "application/octet-stream".

The file name and content-type can be customized by implementing Name() string or ContentType() string on the run-time type of io.Reader. Note that os.File implements Name() string, so a file returned by os.Open will be sent with the file name on disk.

We also provide a helper morpheusmarketplace.FileParam(reader io.Reader, filename string, contentType string) which can be used to wrap any io.Reader with the appropriate file name and content type.

Retries

Certain errors will be automatically retried 2 times by default, with a short exponential backoff. We retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors.

You can use the WithMaxRetries option to configure or disable this:

// Configure the default for all requests:
client := morpheusmarketplace.NewClient(
	option.WithMaxRetries(0), // default is 2
)

// Override per-request:
client.Blockchain.Balance.Get(context.TODO(), option.WithMaxRetries(5))
Making custom/undocumented requests

This library is typed for convenient access to the documented API. If you need to access undocumented endpoints, params, or response properties, the library can still be used.

Undocumented endpoints

To make requests to undocumented endpoints, you can use client.Get, client.Post, and other HTTP verbs. RequestOptions on the client, such as retries, will be respected when making these requests.

var (
    // params can be an io.Reader, a []byte, an encoding/json serializable object,
    // or a "…Params" struct defined in this library.
    params map[string]interface{}

    // result can be an []byte, *http.Response, a encoding/json deserializable object,
    // or a model defined in this library.
    result *http.Response
)
err := client.Post(context.Background(), "/unspecified", params, &result)
if err != nil {
    …
}
Undocumented request params

To make requests using undocumented parameters, you may use either the option.WithQuerySet() or the option.WithJSONSet() methods.

params := FooNewParams{
    ID:   morpheusmarketplace.F("id_xxxx"),
    Data: morpheusmarketplace.F(FooNewParamsData{
        FirstName: morpheusmarketplace.F("John"),
    }),
}
client.Foo.New(context.Background(), params, option.WithJSONSet("data.last_name", "Doe"))
Undocumented response properties

To access undocumented response properties, you may either access the raw JSON of the response as a string with result.JSON.RawJSON(), or get the raw JSON of a particular field on the result with result.JSON.Foo.Raw().

Any fields that are not present on the response struct will be saved and can be accessed by result.JSON.ExtraFields() which returns the extra fields as a map[string]Field.

Middleware

We provide option.WithMiddleware which applies the given middleware to requests.

func Logger(req *http.Request, next option.MiddlewareNext) (res *http.Response, err error) {
	// Before the request
	start := time.Now()
	LogReq(req)

	// Forward the request to the next handler
	res, err = next(req)

	// Handle stuff after the request
	end := time.Now()
	LogRes(res, err, start - end)

    return res, err
}

client := morpheusmarketplace.NewClient(
	option.WithMiddleware(Logger),
)

When multiple middlewares are provided as variadic arguments, the middlewares are applied left to right. If option.WithMiddleware is given multiple times, for example first in the client then the method, the middleware in the client will run first and the middleware given in the method will run next.

You may also replace the default http.Client with option.WithHTTPClient(client). Only one http client is accepted (this overwrites any previous client) and receives requests after any middleware has been applied.

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

  1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals).
  2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Contributing

See the contributing documentation.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Bool 

func Bool(value bool) param.Field[bool]

Bool is a param field helper which helps specify bools.

func F 

func F[T any](value T) param.Field[T]

F is a param field helper used to initialize a param.Field generic struct. This helps specify null, zero values, and overrides, as well as normal values. You can read more about this in our README.

func FileParam 

func FileParam(reader io.Reader, filename string, contentType string) param.Field[io.Reader]

FileParam is a param field helper which helps files with a mime content-type.

func Float 

func Float(value float64) param.Field[float64]

Float is a param field helper which helps specify floats.

func Int 

func Int(value int64) param.Field[int64]

Int is a param field helper which helps specify integers. This is particularly helpful when specifying integer constants for fields.

func Null 

func Null[T any]() param.Field[T]

Null is a param field helper which explicitly sends null to the API.

func Raw 

func Raw[T any](value any) param.Field[T]

Raw is a param field helper for specifying values for fields when the type you are looking to send is different from the type that is specified in the SDK. For example, if the type of the field is an integer, but you want to send a float, you could do that by setting the corresponding field with Raw[int](0.5).

func String 

func String(value string) param.Field[string]

String is a param field helper which helps specify strings.

Types

type Allowance 

type Allowance struct {
	// Current allowance amount
	Allowance string        `json:"allowance,required"`
	JSON      allowanceJSON `json:"-"`
}

func (*Allowance) UnmarshalJSON 

func (r *Allowance) UnmarshalJSON(data []byte) (err error)

type Balance 

type Balance = shared.Balance

This is an alias to an internal type.

type Bid 

type Bid struct {
	// Unique identifier of the bid
	ID string `json:"id,required"`
	// ID of the model the bid is for
	ModelID string `json:"modelID,required"`
	// Bid price per second
	PricePerSecond string  `json:"pricePerSecond,required"`
	JSON           bidJSON `json:"-"`
}

func (*Bid) UnmarshalJSON 

func (r *Bid) UnmarshalJSON(data []byte) (err error)

type BidList 

type BidList = shared.BidList

This is an alias to an internal type.

type BlockchainAllowanceGetParams 

type BlockchainAllowanceGetParams struct {
	// Spender Ethereum address
	Spender param.Field[string] `query:"spender,required"`
}

func (BlockchainAllowanceGetParams) URLQuery 

func (r BlockchainAllowanceGetParams) URLQuery() (v url.Values)

URLQuery serializes BlockchainAllowanceGetParams's query parameters as `url.Values`.

type BlockchainAllowanceService 

type BlockchainAllowanceService struct {
	Options []option.RequestOption
}

BlockchainAllowanceService contains methods and other services that help with interacting with the morpheus-marketplace API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBlockchainAllowanceService method instead.

func NewBlockchainAllowanceService 

func NewBlockchainAllowanceService(opts ...option.RequestOption) (r *BlockchainAllowanceService)

NewBlockchainAllowanceService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BlockchainAllowanceService) Get 

func (r *BlockchainAllowanceService) Get(ctx context.Context, query BlockchainAllowanceGetParams, opts ...option.RequestOption) (res *Allowance, err error)

Retrieve allowance

type BlockchainBalanceService 

type BlockchainBalanceService struct {
	Options []option.RequestOption
}

BlockchainBalanceService contains methods and other services that help with interacting with the morpheus-marketplace API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBlockchainBalanceService method instead.

func NewBlockchainBalanceService 

func NewBlockchainBalanceService(opts ...option.RequestOption) (r *BlockchainBalanceService)

NewBlockchainBalanceService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BlockchainBalanceService) Get 

func (r *BlockchainBalanceService) Get(ctx context.Context, opts ...option.RequestOption) (res *shared.Balance, err error)

Retrieve balance

type BlockchainBidNewParams 

type BlockchainBidNewParams struct {
	// ID of the model to bid on
	ModelID param.Field[string] `json:"modelID,required"`
	// Bid price per second
	PricePerSecond param.Field[string] `json:"pricePerSecond,required"`
}

func (BlockchainBidNewParams) MarshalJSON 

func (r BlockchainBidNewParams) MarshalJSON() (data []byte, err error)

type BlockchainBidService 

type BlockchainBidService struct {
	Options []option.RequestOption
}

BlockchainBidService contains methods and other services that help with interacting with the morpheus-marketplace API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBlockchainBidService method instead.

func NewBlockchainBidService 

func NewBlockchainBidService(opts ...option.RequestOption) (r *BlockchainBidService)

NewBlockchainBidService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BlockchainBidService) Delete 

func (r *BlockchainBidService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (err error)

Delete a bid

func (*BlockchainBidService) Get 

func (r *BlockchainBidService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *Bid, err error)

Retrieve a bid

func (*BlockchainBidService) New 

func (r *BlockchainBidService) New(ctx context.Context, body BlockchainBidNewParams, opts ...option.RequestOption) (res *Bid, err error)

Create a new bid

func (*BlockchainBidService) Session 

func (r *BlockchainBidService) Session(ctx context.Context, id string, body BlockchainBidSessionParams, opts ...option.RequestOption) (res *shared.Session, err error)

Start a session for a bid

type BlockchainBidSessionParams 

type BlockchainBidSessionParams struct {
	// Duration of the session
	SessionDuration param.Field[string] `json:"sessionDuration,required"`
}

func (BlockchainBidSessionParams) MarshalJSON 

func (r BlockchainBidSessionParams) MarshalJSON() (data []byte, err error)

type BlockchainLatestBlockService 

type BlockchainLatestBlockService struct {
	Options []option.RequestOption
}

BlockchainLatestBlockService contains methods and other services that help with interacting with the morpheus-marketplace API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBlockchainLatestBlockService method instead.

func NewBlockchainLatestBlockService 

func NewBlockchainLatestBlockService(opts ...option.RequestOption) (r *BlockchainLatestBlockService)

NewBlockchainLatestBlockService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BlockchainLatestBlockService) Get 

func (r *BlockchainLatestBlockService) Get(ctx context.Context, opts ...option.RequestOption) (res *LatestBlock, err error)

Get latest block number

type BlockchainModelBidActiveService 

type BlockchainModelBidActiveService struct {
	Options []option.RequestOption
}

BlockchainModelBidActiveService contains methods and other services that help with interacting with the morpheus-marketplace API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBlockchainModelBidActiveService method instead.

func NewBlockchainModelBidActiveService 

func NewBlockchainModelBidActiveService(opts ...option.RequestOption) (r *BlockchainModelBidActiveService)

NewBlockchainModelBidActiveService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BlockchainModelBidActiveService) List 

func (r *BlockchainModelBidActiveService) List(ctx context.Context, id string, opts ...option.RequestOption) (res *shared.BidList, err error)

List active bids for a model

type BlockchainModelBidListParams 

type BlockchainModelBidListParams struct {
	// Maximum number of results to return
	Limit param.Field[int64] `query:"limit"`
	// Number of results to skip
	Offset param.Field[int64] `query:"offset"`
}

func (BlockchainModelBidListParams) URLQuery 

func (r BlockchainModelBidListParams) URLQuery() (v url.Values)

URLQuery serializes BlockchainModelBidListParams's query parameters as `url.Values`.

type BlockchainModelBidRatedService 

type BlockchainModelBidRatedService struct {
	Options []option.RequestOption
}

BlockchainModelBidRatedService contains methods and other services that help with interacting with the morpheus-marketplace API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBlockchainModelBidRatedService method instead.

func NewBlockchainModelBidRatedService 

func NewBlockchainModelBidRatedService(opts ...option.RequestOption) (r *BlockchainModelBidRatedService)

NewBlockchainModelBidRatedService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BlockchainModelBidRatedService) List 

func (r *BlockchainModelBidRatedService) List(ctx context.Context, id string, opts ...option.RequestOption) (res *shared.BidList, err error)

List rated bids for a model

type BlockchainModelBidService 

type BlockchainModelBidService struct {
	Options []option.RequestOption
	Active  *BlockchainModelBidActiveService
	Rated   *BlockchainModelBidRatedService
}

BlockchainModelBidService contains methods and other services that help with interacting with the morpheus-marketplace API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBlockchainModelBidService method instead.

func NewBlockchainModelBidService 

func NewBlockchainModelBidService(opts ...option.RequestOption) (r *BlockchainModelBidService)

NewBlockchainModelBidService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BlockchainModelBidService) List 

func (r *BlockchainModelBidService) List(ctx context.Context, id string, query BlockchainModelBidListParams, opts ...option.RequestOption) (res *shared.BidList, err error)

List bids for a model

type BlockchainModelNewParams 

type BlockchainModelNewParams struct {
	// Fee for using the model
	Fee param.Field[string] `json:"fee,required"`
	// IPFS ID where the model is stored
	IpfsID param.Field[string] `json:"ipfsID,required"`
	// Model ID provided by the user
	ModelID param.Field[string] `json:"modelID,required"`
	// Name of the model
	Name param.Field[string] `json:"name,required"`
	// Amount to stake for the model
	Stake param.Field[string] `json:"stake,required"`
	// Tags associated with the model
	Tags param.Field[[]string] `json:"tags"`
}

func (BlockchainModelNewParams) MarshalJSON 

func (r BlockchainModelNewParams) MarshalJSON() (data []byte, err error)

type BlockchainModelService 

type BlockchainModelService struct {
	Options  []option.RequestOption
	Sessions *BlockchainModelSessionService
	Bids     *BlockchainModelBidService
	Stats    *BlockchainModelStatService
}

BlockchainModelService contains methods and other services that help with interacting with the morpheus-marketplace API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBlockchainModelService method instead.

func NewBlockchainModelService 

func NewBlockchainModelService(opts ...option.RequestOption) (r *BlockchainModelService)

NewBlockchainModelService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BlockchainModelService) Delete 

func (r *BlockchainModelService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (err error)

Delete a model

func (*BlockchainModelService) List 

func (r *BlockchainModelService) List(ctx context.Context, opts ...option.RequestOption) (res *[]Model, err error)

List all available models

func (*BlockchainModelService) New 

func (r *BlockchainModelService) New(ctx context.Context, body BlockchainModelNewParams, opts ...option.RequestOption) (res *Model, err error)

Create a new model

type BlockchainModelSessionNewParams 

type BlockchainModelSessionNewParams struct {
	// Duration of the session
	SessionDuration param.Field[string] `json:"sessionDuration,required"`
}

func (BlockchainModelSessionNewParams) MarshalJSON 

func (r BlockchainModelSessionNewParams) MarshalJSON() (data []byte, err error)

type BlockchainModelSessionService 

type BlockchainModelSessionService struct {
	Options []option.RequestOption
}

BlockchainModelSessionService contains methods and other services that help with interacting with the morpheus-marketplace API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBlockchainModelSessionService method instead.

func NewBlockchainModelSessionService 

func NewBlockchainModelSessionService(opts ...option.RequestOption) (r *BlockchainModelSessionService)

NewBlockchainModelSessionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BlockchainModelSessionService) New 

func (r *BlockchainModelSessionService) New(ctx context.Context, id string, body BlockchainModelSessionNewParams, opts ...option.RequestOption) (res *shared.Session, err error)

Start a session for a model

type BlockchainModelStatService 

type BlockchainModelStatService struct {
	Options []option.RequestOption
}

BlockchainModelStatService contains methods and other services that help with interacting with the morpheus-marketplace API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBlockchainModelStatService method instead.

func NewBlockchainModelStatService 

func NewBlockchainModelStatService(opts ...option.RequestOption) (r *BlockchainModelStatService)

NewBlockchainModelStatService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BlockchainModelStatService) Get 

func (r *BlockchainModelStatService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *ModelStats, err error)

Retrieve statistics for a model

type BlockchainProviderBidActiveService 

type BlockchainProviderBidActiveService struct {
	Options []option.RequestOption
}

BlockchainProviderBidActiveService contains methods and other services that help with interacting with the morpheus-marketplace API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBlockchainProviderBidActiveService method instead.

func NewBlockchainProviderBidActiveService 

func NewBlockchainProviderBidActiveService(opts ...option.RequestOption) (r *BlockchainProviderBidActiveService)

NewBlockchainProviderBidActiveService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BlockchainProviderBidActiveService) List 

func (r *BlockchainProviderBidActiveService) List(ctx context.Context, id string, opts ...option.RequestOption) (res *shared.BidList, err error)

List active bids for a provider

type BlockchainProviderBidListParams 

type BlockchainProviderBidListParams struct {
	// Maximum number of results to return
	Limit param.Field[int64] `query:"limit"`
	// Number of results to skip
	Offset param.Field[int64] `query:"offset"`
}

func (BlockchainProviderBidListParams) URLQuery 

func (r BlockchainProviderBidListParams) URLQuery() (v url.Values)

URLQuery serializes BlockchainProviderBidListParams's query parameters as `url.Values`.

type BlockchainProviderBidService 

type BlockchainProviderBidService struct {
	Options []option.RequestOption
	Active  *BlockchainProviderBidActiveService
}

BlockchainProviderBidService contains methods and other services that help with interacting with the morpheus-marketplace API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBlockchainProviderBidService method instead.

func NewBlockchainProviderBidService 

func NewBlockchainProviderBidService(opts ...option.RequestOption) (r *BlockchainProviderBidService)

NewBlockchainProviderBidService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BlockchainProviderBidService) List 

func (r *BlockchainProviderBidService) List(ctx context.Context, id string, query BlockchainProviderBidListParams, opts ...option.RequestOption) (res *shared.BidList, err error)

List bids for a provider

type BlockchainProviderNewParams 

type BlockchainProviderNewParams struct {
	// Endpoint URL of the provider
	Endpoint param.Field[string] `json:"endpoint,required"`
	// Amount to stake for the provider
	Stake param.Field[string] `json:"stake,required"`
}

func (BlockchainProviderNewParams) MarshalJSON 

func (r BlockchainProviderNewParams) MarshalJSON() (data []byte, err error)

type BlockchainProviderService 

type BlockchainProviderService struct {
	Options []option.RequestOption
	Bids    *BlockchainProviderBidService
}

BlockchainProviderService contains methods and other services that help with interacting with the morpheus-marketplace API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBlockchainProviderService method instead.

func NewBlockchainProviderService 

func NewBlockchainProviderService(opts ...option.RequestOption) (r *BlockchainProviderService)

NewBlockchainProviderService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BlockchainProviderService) Delete 

func (r *BlockchainProviderService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (err error)

Delete a provider

func (*BlockchainProviderService) List 

func (r *BlockchainProviderService) List(ctx context.Context, opts ...option.RequestOption) (res *[]Provider, err error)

List providers

func (*BlockchainProviderService) New 

func (r *BlockchainProviderService) New(ctx context.Context, body BlockchainProviderNewParams, opts ...option.RequestOption) (res *Provider, err error)

Create a new provider

type BlockchainSendEthParams 

type BlockchainSendEthParams struct {
	// Amount of ETH to send
	Amount param.Field[string] `json:"amount,required"`
	// Ethereum address to send ETH to
	To param.Field[string] `json:"to,required"`
}

func (BlockchainSendEthParams) MarshalJSON 

func (r BlockchainSendEthParams) MarshalJSON() (data []byte, err error)

type BlockchainSendMorParams 

type BlockchainSendMorParams struct {
	// Amount of MOR to send
	Amount param.Field[string] `json:"amount,required"`
	// Ethereum address to send MOR to
	To param.Field[string] `json:"to,required"`
}

func (BlockchainSendMorParams) MarshalJSON 

func (r BlockchainSendMorParams) MarshalJSON() (data []byte, err error)

type BlockchainService 

type BlockchainService struct {
	Options []option.RequestOption
	Models  *BlockchainModelService
}

BlockchainService contains methods and other services that help with interacting with the morpheus-marketplace API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBlockchainService method instead.

func NewBlockchainService 

func NewBlockchainService(opts ...option.RequestOption) (r *BlockchainService)

NewBlockchainService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BlockchainService) SendEth 

func (r *BlockchainService) SendEth(ctx context.Context, body BlockchainSendEthParams, opts ...option.RequestOption) (res *shared.Balance, err error)

Send ETH to a specified address

func (*BlockchainService) SendMor 

func (r *BlockchainService) SendMor(ctx context.Context, body BlockchainSendMorParams, opts ...option.RequestOption) (res *shared.Balance, err error)

Send MOR to a specified address

type BlockchainSessionNewParams 

type BlockchainSessionNewParams struct {
	// Approval identifier
	Approval param.Field[string] `json:"approval,required"`
	// Signature for the approval
	ApprovalSig param.Field[string] `json:"approvalSig,required"`
	// Stake amount for the session
	Stake param.Field[string] `json:"stake,required"`
}

func (BlockchainSessionNewParams) MarshalJSON 

func (r BlockchainSessionNewParams) MarshalJSON() (data []byte, err error)

type BlockchainSessionProviderParams 

type BlockchainSessionProviderParams struct {
	// Provider identifier
	Provider param.Field[string] `query:"provider,required"`
	// Maximum number of results to return
	Limit param.Field[int64] `query:"limit"`
	// Number of results to skip
	Offset param.Field[int64] `query:"offset"`
}

func (BlockchainSessionProviderParams) URLQuery 

func (r BlockchainSessionProviderParams) URLQuery() (v url.Values)

URLQuery serializes BlockchainSessionProviderParams's query parameters as `url.Values`.

type BlockchainSessionService 

type BlockchainSessionService struct {
	Options []option.RequestOption
}

BlockchainSessionService contains methods and other services that help with interacting with the morpheus-marketplace API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBlockchainSessionService method instead.

func NewBlockchainSessionService 

func NewBlockchainSessionService(opts ...option.RequestOption) (r *BlockchainSessionService)

NewBlockchainSessionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BlockchainSessionService) Budget 

func (r *BlockchainSessionService) Budget(ctx context.Context, opts ...option.RequestOption) (res *Budget, err error)

Get session budget

func (*BlockchainSessionService) Close 

func (r *BlockchainSessionService) Close(ctx context.Context, id string, opts ...option.RequestOption) (err error)

Close a session

func (*BlockchainSessionService) Get 

func (r *BlockchainSessionService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *shared.Session, err error)

Retrieve a session

func (*BlockchainSessionService) New 

func (r *BlockchainSessionService) New(ctx context.Context, body BlockchainSessionNewParams, opts ...option.RequestOption) (res *shared.Session, err error)

Create a new session

func (*BlockchainSessionService) Provider 

func (r *BlockchainSessionService) Provider(ctx context.Context, query BlockchainSessionProviderParams, opts ...option.RequestOption) (res *SessionList, err error)

List provider sessions

func (*BlockchainSessionService) User 

func (r *BlockchainSessionService) User(ctx context.Context, query BlockchainSessionUserParams, opts ...option.RequestOption) (res *SessionList, err error)

List user sessions

type BlockchainSessionUserParams 

type BlockchainSessionUserParams struct {
	// User identifier
	User param.Field[string] `query:"user,required"`
	// Maximum number of results to return
	Limit param.Field[int64] `query:"limit"`
	// Number of results to skip
	Offset param.Field[int64] `query:"offset"`
}

func (BlockchainSessionUserParams) URLQuery 

func (r BlockchainSessionUserParams) URLQuery() (v url.Values)

URLQuery serializes BlockchainSessionUserParams's query parameters as `url.Values`.

type BlockchainTokenService 

type BlockchainTokenService struct {
	Options []option.RequestOption
	Supply  *BlockchainTokenSupplyService
}

BlockchainTokenService contains methods and other services that help with interacting with the morpheus-marketplace API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBlockchainTokenService method instead.

func NewBlockchainTokenService 

func NewBlockchainTokenService(opts ...option.RequestOption) (r *BlockchainTokenService)

NewBlockchainTokenService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type BlockchainTokenSupplyService 

type BlockchainTokenSupplyService struct {
	Options []option.RequestOption
}

BlockchainTokenSupplyService contains methods and other services that help with interacting with the morpheus-marketplace API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBlockchainTokenSupplyService method instead.

func NewBlockchainTokenSupplyService 

func NewBlockchainTokenSupplyService(opts ...option.RequestOption) (r *BlockchainTokenSupplyService)

NewBlockchainTokenSupplyService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BlockchainTokenSupplyService) Get 

func (r *BlockchainTokenSupplyService) Get(ctx context.Context, opts ...option.RequestOption) (res *TokenSupply, err error)

Get token supply

type BlockchainTransactionService 

type BlockchainTransactionService struct {
	Options []option.RequestOption
}

BlockchainTransactionService contains methods and other services that help with interacting with the morpheus-marketplace API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBlockchainTransactionService method instead.

func NewBlockchainTransactionService 

func NewBlockchainTransactionService(opts ...option.RequestOption) (r *BlockchainTransactionService)

NewBlockchainTransactionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BlockchainTransactionService) List 

func (r *BlockchainTransactionService) List(ctx context.Context, opts ...option.RequestOption) (res *TransactionList, err error)

List transactions

type Budget 

type Budget struct {
	// Current session budget
	Budget string     `json:"budget,required"`
	JSON   budgetJSON `json:"-"`
}

func (*Budget) UnmarshalJSON 

func (r *Budget) UnmarshalJSON(data []byte) (err error)

type ClaimableBalance 

type ClaimableBalance struct {
	// Amount claimable by the provider
	Balance string               `json:"balance,required"`
	JSON    claimableBalanceJSON `json:"-"`
}

func (*ClaimableBalance) UnmarshalJSON 

func (r *ClaimableBalance) UnmarshalJSON(data []byte) (err error)

type Client 

type Client struct {
	Options            []option.RequestOption
	Blockchains        *BlockchainService
	BlockchainBids     *BlockchainBidService
	BlockchainSessions *BlockchainSessionService
	Blockchain         *BlockchainService
	Proxy              *ProxyService
}

Client creates a struct with services and top level methods that help with interacting with the morpheus-marketplace API. You should not instantiate this client directly, and instead use the NewClient method instead.

func NewClient 

func NewClient(opts ...option.RequestOption) (r *Client)

NewClient generates a new client with the default option read from the environment (X_API_KEY). The option passed in as arguments are applied after these default arguments, and all option will be passed down to the services and requests that this client makes.

func (*Client) Delete 

func (r *Client) Delete(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Delete makes a DELETE request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Execute 

func (r *Client) Execute(ctx context.Context, method string, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Execute makes a request with the given context, method, URL, request params, response, and request options. This is useful for hitting undocumented endpoints while retaining the base URL, auth, retries, and other options from the client.

If a byte slice or an io.Reader is supplied to params, it will be used as-is for the request body.

The params is by default serialized into the body using encoding/json. If your type implements a MarshalJSON function, it will be used instead to serialize the request. If a URLQuery method is implemented, the returned url.Values will be used as query strings to the url.

If your params struct uses param.Field, you must provide either [MarshalJSON], [URLQuery], and/or [MarshalForm] functions. It is undefined behavior to use a struct uses param.Field without specifying how it is serialized.

Any "…Params" object defined in this library can be used as the request argument. Note that 'path' arguments will not be forwarded into the url.

The response body will be deserialized into the res variable, depending on its type:

  • A pointer to a *http.Response is populated by the raw response.
  • A pointer to a byte array will be populated with the contents of the request body.
  • A pointer to any other type uses this library's default JSON decoding, which respects UnmarshalJSON if it is defined on the type.
  • A nil value will not read the response body.

For even greater flexibility, see option.WithResponseInto and option.WithResponseBodyInto.

func (*Client) Get 

func (r *Client) Get(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Get makes a GET request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Patch 

func (r *Client) Patch(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Patch makes a PATCH request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Post 

func (r *Client) Post(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Post makes a POST request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Put 

func (r *Client) Put(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Put makes a PUT request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

type Error 

type Error = apierror.Error

type LatestBlock 

type LatestBlock struct {
	// Latest block number on the blockchain
	BlockNumber string          `json:"blockNumber,required"`
	JSON        latestBlockJSON `json:"-"`
}

func (*LatestBlock) UnmarshalJSON 

func (r *LatestBlock) UnmarshalJSON(data []byte) (err error)

type Model 

type Model struct {
	// Unique identifier of the model
	ID string `json:"id,required"`
	// Fee for using the model
	Fee string `json:"fee,required"`
	// IPFS ID where the model is stored
	IpfsID string `json:"ipfsID,required"`
	// Model ID provided by the user
	ModelID string `json:"modelID,required"`
	// Name of the model
	Name string `json:"name,required"`
	// Amount staked for the model
	Stake string `json:"stake,required"`
	// Tags associated with the model
	Tags []string  `json:"tags"`
	JSON modelJSON `json:"-"`
}

func (*Model) UnmarshalJSON 

func (r *Model) UnmarshalJSON(data []byte) (err error)

type ModelStats 

type ModelStats struct {
	// ID of the model
	ModelID string `json:"modelID,required"`
	// Statistics related to the model
	Stats map[string]interface{} `json:"stats,required"`
	JSON  modelStatsJSON         `json:"-"`
}

func (*ModelStats) UnmarshalJSON 

func (r *ModelStats) UnmarshalJSON(data []byte) (err error)

type Provider 

type Provider struct {
	// Unique identifier of the provider
	ID string `json:"id,required"`
	// Endpoint URL of the provider
	Endpoint string `json:"endpoint,required"`
	// Amount staked by the provider
	Stake string       `json:"stake,required"`
	JSON  providerJSON `json:"-"`
}

func (*Provider) UnmarshalJSON 

func (r *Provider) UnmarshalJSON(data []byte) (err error)

type ProxyService 

type ProxyService struct {
	Options  []option.RequestOption
	Sessions *ProxySessionService
}

ProxyService contains methods and other services that help with interacting with the morpheus-marketplace API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewProxyService method instead.

func NewProxyService 

func NewProxyService(opts ...option.RequestOption) (r *ProxyService)

NewProxyService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type ProxySessionInitiateParams 

type ProxySessionInitiateParams struct {
	// Model ID to initiate session with
	ModelID param.Field[string] `json:"modelId,required"`
	// Duration of the session
	SessionDuration param.Field[string] `json:"sessionDuration,required"`
}

func (ProxySessionInitiateParams) MarshalJSON 

func (r ProxySessionInitiateParams) MarshalJSON() (data []byte, err error)

type ProxySessionProviderClaimParams 

type ProxySessionProviderClaimParams struct {
	// Claim identifier
	Claim param.Field[string] `json:"claim,required"`
}

func (ProxySessionProviderClaimParams) MarshalJSON 

func (r ProxySessionProviderClaimParams) MarshalJSON() (data []byte, err error)

type ProxySessionService 

type ProxySessionService struct {
	Options []option.RequestOption
}

ProxySessionService contains methods and other services that help with interacting with the morpheus-marketplace API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewProxySessionService method instead.

func NewProxySessionService 

func NewProxySessionService(opts ...option.RequestOption) (r *ProxySessionService)

NewProxySessionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ProxySessionService) Initiate 

func (r *ProxySessionService) Initiate(ctx context.Context, body ProxySessionInitiateParams, opts ...option.RequestOption) (res *shared.Session, err error)

Initiate a proxy session

func (*ProxySessionService) ProviderClaim 

func (r *ProxySessionService) ProviderClaim(ctx context.Context, id string, body ProxySessionProviderClaimParams, opts ...option.RequestOption) (res *ClaimableBalance, err error)

Claim provider balance

func (*ProxySessionService) ProviderClaimableBalance 

func (r *ProxySessionService) ProviderClaimableBalance(ctx context.Context, id string, opts ...option.RequestOption) (res *ClaimableBalance, err error)

Get provider claimable balance

type Session 

type Session = shared.Session

This is an alias to an internal type.

type SessionList 

type SessionList struct {
	// List of sessions
	Sessions []shared.Session `json:"sessions,required"`
	JSON     sessionListJSON  `json:"-"`
}

func (*SessionList) UnmarshalJSON 

func (r *SessionList) UnmarshalJSON(data []byte) (err error)

type TokenSupply 

type TokenSupply struct {
	// Total supply of the token
	Supply string          `json:"supply,required"`
	JSON   tokenSupplyJSON `json:"-"`
}

func (*TokenSupply) UnmarshalJSON 

func (r *TokenSupply) UnmarshalJSON(data []byte) (err error)

type TransactionList 

type TransactionList struct {
	// List of transactions
	Transactions []TransactionListTransaction `json:"transactions,required"`
	JSON         transactionListJSON          `json:"-"`
}

func (*TransactionList) UnmarshalJSON 

func (r *TransactionList) UnmarshalJSON(data []byte) (err error)

type TransactionListTransaction 

type TransactionListTransaction struct {
	// Transaction ID
	ID string `json:"id,required"`
	// Amount involved in the transaction
	Amount string `json:"amount,required"`
	// Type of transaction
	Type string                         `json:"type,required"`
	JSON transactionListTransactionJSON `json:"-"`
}

func (*TransactionListTransaction) UnmarshalJSON 

func (r *TransactionListTransaction) UnmarshalJSON(data []byte) (err error)

Source Files

View all Source files

Directories

Path Synopsis
apierror
apiform
apijson
apiquery
param
requestconfig
testutil

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.