Documentation
¶
Overview ¶
Package api provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.0 DO NOT EDIT.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type JsonWebKey ¶
type JsonWebKey struct {
// Alg The cryptographic algorithm family used with the key. The only allowed value is `EdDSA`.
Alg JsonWebKeyAlg `json:"alg"`
// Crv The cryptographic curve used with the key. The only allowed value is `Ed25519`.
Crv JsonWebKeyCrv `json:"crv"`
// Kid A unique identifier for the key.
Kid string `json:"kid"`
// Kty The key type. Identifies the cryptographic algorithm family. The only allowed value is `OKP` (Octet Key Pair).
Kty JsonWebKeyKty `json:"kty"`
// Use The intended use of the key. The only allowed value is `sig` (signature).
Use *JsonWebKeyUse `json:"use,omitempty"`
// X The base64 url-encoded public key.
X string `json:"x"`
}
JsonWebKey A JWK representation of an Ed25519 Public Key
type JsonWebKeyAlg ¶
type JsonWebKeyAlg string
JsonWebKeyAlg The cryptographic algorithm family used with the key. The only allowed value is `EdDSA`.
const (
EdDSA JsonWebKeyAlg = "EdDSA"
)
Defines values for JsonWebKeyAlg.
type JsonWebKeyCrv ¶
type JsonWebKeyCrv string
JsonWebKeyCrv The cryptographic curve used with the key. The only allowed value is `Ed25519`.
const (
Ed25519 JsonWebKeyCrv = "Ed25519"
)
Defines values for JsonWebKeyCrv.
type JsonWebKeyKty ¶
type JsonWebKeyKty string
JsonWebKeyKty The key type. Identifies the cryptographic algorithm family. The only allowed value is `OKP` (Octet Key Pair).
const (
OKP JsonWebKeyKty = "OKP"
)
Defines values for JsonWebKeyKty.
type JsonWebKeySet ¶
type JsonWebKeySet struct {
Keys *[]JsonWebKey `json:"keys,omitempty"`
}
JsonWebKeySet A JSON Web Key Set document according to [rfc7517](https://datatracker.ietf.org/doc/html/rfc7517) listing the keys associated with this wallet address. These keys are used to sign requests made by this wallet address.
type JsonWebKeyUse ¶
type JsonWebKeyUse string
JsonWebKeyUse The intended use of the key. The only allowed value is `sig` (signature).
const (
Sig JsonWebKeyUse = "sig"
)
Defines values for JsonWebKeyUse.
type WalletAddress ¶
type WalletAddress struct {
// AssetCode The assetCode is a code that indicates the underlying asset. An ISO4217 currency code should be used whenever possible. The ISO4217 representation of the US Dollar is USD.
AssetCode string `json:"assetCode"`
// AssetScale The number of decimal places that defines the scale of the smallest divisible unit for the given asset code. It determines how an integer amount is scaled to derive the actual monetary value. For example, USD has an asset scale of 2 with the smallest unit being 0.01. An integer amount of `1000` with an `assetCode` of `USD` and `assetScale` of `2` translates to $10.00.
AssetScale int `json:"assetScale"`
// AuthServer The URL of the authorization server endpoint for getting grants and access tokens for this wallet address.
AuthServer *string `json:"authServer,omitempty"`
// Id The URL identifying the wallet address.
Id *string `json:"id,omitempty"`
// PublicName A public name for the account. This should be set by the account holder with their provider to provide a hint to counterparties as to the identity of the account holder.
PublicName *string `json:"publicName,omitempty"`
// ResourceServer The URL of the resource server endpoint for performing Open Payments with this wallet address.
ResourceServer *string `json:"resourceServer,omitempty"`
AdditionalProperties map[string]interface{} `json:"-"`
}
WalletAddress A **wallet address** resource is the root of the API and contains the public details of the financial account represented by the Wallet Address that is also the service endpoint URL.
func (WalletAddress) Get ¶
func (a WalletAddress) Get(fieldName string) (value interface{}, found bool)
Getter for additional properties for WalletAddress. Returns the specified element and whether it was found
func (WalletAddress) MarshalJSON ¶
func (a WalletAddress) MarshalJSON() ([]byte, error)
Override default JSON handling for WalletAddress to handle AdditionalProperties
func (*WalletAddress) Set ¶
func (a *WalletAddress) Set(fieldName string, value interface{})
Setter for additional properties for WalletAddress
func (*WalletAddress) UnmarshalJSON ¶
func (a *WalletAddress) UnmarshalJSON(b []byte) error
Override default JSON handling for WalletAddress to handle AdditionalProperties
Source Files