api

type Access = []AccessItem

type AccessIncoming struct {
	// Actions The types of actions the client instance will take at the RS as an array of strings.
	Actions []AccessIncomingActions `json:"actions"`

	// Identifier A string identifier indicating a specific resource at the RS.
	Identifier *string `json:"identifier,omitempty"`

	// Type The type of resource request as a string.  This field defines which other fields are allowed in the request object.
	Type AccessIncomingType `json:"type"`
}

type AccessIncomingActions string

type AccessIncomingType string

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

type AccessOutgoing struct {
	// Actions The types of actions the client instance will take at the RS as an array of strings.
	Actions []AccessOutgoingActions `json:"actions"`

	// Identifier A string identifier indicating a specific resource at the RS.
	Identifier string `json:"identifier"`

	// Limits Open Payments specific property that defines the limits under which outgoing payments can be created.
	Limits *LimitsOutgoing `json:"limits,omitempty"`

	// Type The type of resource request as a string.  This field defines which other fields are allowed in the request object.
	Type AccessOutgoingType `json:"type"`
}

type AccessOutgoingActions string

type AccessOutgoingType string

type AccessQuote struct {
	// Actions The types of actions the client instance will take at the RS as an array of strings.
	Actions []AccessQuoteActions `json:"actions"`

	// Type The type of resource request as a string.  This field defines which other fields are allowed in the request object.
	Type AccessQuoteType `json:"type"`
}

type AccessQuoteActions string

type AccessQuoteType string

type AccessToken struct {
	// Access A description of the rights associated with this access token.
	Access Access `json:"access"`

	// ExpiresIn The number of seconds in which the access will expire.  The client instance MUST NOT use the access token past this time.  An RS MUST NOT accept an access token past this time.
	ExpiresIn *int `json:"expires_in,omitempty"`

	// Manage The management URI for this access token. This URI MUST NOT include the access token value and SHOULD be different for each access token issued in a request.
	Manage string `json:"manage"`

	// Value The value of the access token as a string.  The value is opaque to the client instance.  The value SHOULD be limited to ASCII characters to facilitate transmission over HTTP headers within other protocols without requiring additional encoding.
	Value string `json:"value"`
}

type AccessTokenRequest struct {
	// Access A description of the rights associated with this access token.
	Access Access `json:"access"`
}

type Amount 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"`

	// Value The value is an unsigned 64-bit integer amount, represented as a string.
	Value string `json:"value"`
}

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

type ClientDirectedIdentity struct {
	// Jwk A JWK representation of an Ed25519 Public Key
	Jwk JsonWebKey `json:"jwk"`
}

type ClientWalletAddress struct {
	// WalletAddress Wallet address of the client instance that is making this request.
	WalletAddress string `json:"walletAddress"`
}

type ClientWalletAddressString = string

type ContinuationRequest struct {
	// InteractRef The interaction reference generated for this
	// interaction by the AS.
	InteractRef *string `json:"interact_ref,omitempty"`
}

type Continue struct {
	// AccessToken A unique access token for continuing the request, called the "continuation access token".
	AccessToken struct {
		Value string `json:"value"`
	} `json:"access_token"`

	// Uri The URI at which the client instance can make continuation requests.
	Uri string `json:"uri"`

	// Wait The amount of time in integer seconds the client instance MUST wait after receiving this request continuation response and calling the continuation URI.
	Wait *int `json:"wait,omitempty"`
}

type ErrorInvalidClient struct {
	Error *struct {
		Code        *ErrorInvalidClientErrorCode `json:"code,omitempty"`
		Description *string                      `json:"description,omitempty"`
	} `json:"error,omitempty"`
}

type ErrorInvalidClientErrorCode string

type ErrorInvalidContinuation struct {
	Error *struct {
		Code        *ErrorInvalidContinuationErrorCode `json:"code,omitempty"`
		Description *string                            `json:"description,omitempty"`
	} `json:"error,omitempty"`
}

type ErrorInvalidContinuationErrorCode string

type ErrorInvalidRequest struct {
	Error *struct {
		Code        *ErrorInvalidRequestErrorCode `json:"code,omitempty"`
		Description *string                       `json:"description,omitempty"`
	} `json:"error,omitempty"`
}

type ErrorInvalidRequestErrorCode string

type ErrorInvalidRotation struct {
	Error *struct {
		Code        *ErrorInvalidRotationErrorCode `json:"code,omitempty"`
		Description *string                        `json:"description,omitempty"`
	} `json:"error,omitempty"`
}

type ErrorInvalidRotationErrorCode string

type ErrorRequestDenied struct {
	Error *struct {
		Code        *ErrorRequestDeniedErrorCode `json:"code,omitempty"`
		Description *string                      `json:"description,omitempty"`
	} `json:"error,omitempty"`
}

type ErrorRequestDeniedErrorCode string

type ErrorTooFast struct {
	Error *struct {
		Code        *ErrorTooFastErrorCode `json:"code,omitempty"`
		Description *string                `json:"description,omitempty"`
	} `json:"error,omitempty"`
}

type ErrorTooFastErrorCode string

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

type GrantRequestWithAccessToken struct {
	// AccessToken The requested access permissions for the grant.
	AccessToken AccessTokenRequest `json:"access_token"`

	// Client Client identification for grant requests.
	//
	// When sending a non-continuation request to the AS, the client instance MUST identify itself by including the client field of the request and by signing the request.
	//
	// Can be either:
	// - A wallet address string (backwards compatible format)
	// - An object with either `jwk` (for directed identity) or `walletAddress` (mutually exclusive)
	//
	// When using a wallet address string or the `walletAddress` property:
	// A JSON Web Key Set document, including the public key that the client instance will use to protect this request and any continuation requests at the AS and any user-facing information about the client instance used in interactions, MUST be available at the wallet address + `/jwks.json` url.
	//
	// When using the `jwk` property (directed identity approach):
	// The client instance provides its public key directly in the request, eliminating the need for the AS to fetch it from a wallet address. This approach enhances privacy by not requiring the client to expose a persistent wallet address identifier. The `jwk` property can only be used for non-interactive grant requests (i.e.: incoming payments).
	//
	// If sending a grant initiation request that requires RO interaction, the wallet address MUST serve necessary client display information.
	Client Client `json:"client"`

	// Interact The client instance declares the parameters for interaction methods that it can support using the interact field.
	Interact *InteractRequest `json:"interact,omitempty"`

	// Subject Information about the subject for which the client is requesting information.
	Subject *Subject `json:"subject,omitempty"`
}

type GrantRequestWithSubject struct {
	// AccessToken The requested access permissions for the grant.
	AccessToken *AccessTokenRequest `json:"access_token,omitempty"`

	// Client Client identification for grant requests.
	//
	// When sending a non-continuation request to the AS, the client instance MUST identify itself by including the client field of the request and by signing the request.
	//
	// Can be either:
	// - A wallet address string (backwards compatible format)
	// - An object with either `jwk` (for directed identity) or `walletAddress` (mutually exclusive)
	//
	// When using a wallet address string or the `walletAddress` property:
	// A JSON Web Key Set document, including the public key that the client instance will use to protect this request and any continuation requests at the AS and any user-facing information about the client instance used in interactions, MUST be available at the wallet address + `/jwks.json` url.
	//
	// When using the `jwk` property (directed identity approach):
	// The client instance provides its public key directly in the request, eliminating the need for the AS to fetch it from a wallet address. This approach enhances privacy by not requiring the client to expose a persistent wallet address identifier. The `jwk` property can only be used for non-interactive grant requests (i.e.: incoming payments).
	//
	// If sending a grant initiation request that requires RO interaction, the wallet address MUST serve necessary client display information.
	Client Client `json:"client"`

	// Interact The client instance declares the parameters for interaction methods that it can support using the interact field.
	Interact InteractRequest `json:"interact"`

	// Subject Information about the subject for which the client is requesting information.
	Subject Subject `json:"subject"`
}

type InteractRequest struct {
	// Finish Indicates how the client instance can receive an indication that interaction has finished at the AS.
	Finish *struct {
		// Method The callback method that the AS will use to contact the client instance.
		Method InteractRequestFinishMethod `json:"method"`

		// Nonce Unique value to be used in the calculation of the "hash" query parameter sent to the callback URI, must be sufficiently random to be unguessable by an attacker.  MUST be generated by the client instance as a unique value for this request.
		Nonce string `json:"nonce"`

		// Uri Indicates the URI that the AS will either send the RO to after interaction or send an HTTP POST request.
		Uri string `json:"uri"`
	} `json:"finish,omitempty"`

	// Start Indicates how the client instance can start an interaction.
	Start []InteractRequestStart `json:"start"`
}

type InteractRequestFinishMethod string

type InteractRequestStart string

type InteractResponse struct {
	// Finish Unique key to secure the callback.
	Finish string `json:"finish"`

	// Redirect The URI to direct the end user to.
	Redirect string `json:"redirect"`
}

type Interval = string

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. This parameter identifies the elliptic curve (for EC keys) or the Edwards curve (for OKP keys). The only allowed value is `Ed25519`.
	Crv JsonWebKeyCrv  `json:"crv"`
	Kid string         `json:"kid"`
	Kty JsonWebKeyKty  `json:"kty"`
	Use *JsonWebKeyUse `json:"use,omitempty"`

	// X The base64 url-encoded public key.
	X string `json:"x"`
}

type JsonWebKeyAlg string

type JsonWebKeyCrv string

type JsonWebKeyKty string

type JsonWebKeyUse string

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

type LimitsOutgoingDebitAmount struct {
	DebitAmount Amount `json:"debitAmount"`

	// Interval [ISO8601 repeating interval](https://en.wikipedia.org/wiki/ISO_8601#Repeating_intervals)
	Interval *Interval `json:"interval,omitempty"`

	// Receiver The URL of the incoming payment that is being paid.
	Receiver *Receiver `json:"receiver,omitempty"`
}

type LimitsOutgoingNoAmount struct {
	// Interval [ISO8601 repeating interval](https://en.wikipedia.org/wiki/ISO_8601#Repeating_intervals)
	Interval *Interval `json:"interval,omitempty"`

	// Receiver The URL of the incoming payment that is being paid.
	Receiver *Receiver `json:"receiver,omitempty"`
}

type LimitsOutgoingReceiveAmount struct {
	// Interval [ISO8601 repeating interval](https://en.wikipedia.org/wiki/ISO_8601#Repeating_intervals)
	Interval      *Interval `json:"interval,omitempty"`
	ReceiveAmount Amount    `json:"receiveAmount"`

	// Receiver The URL of the incoming payment that is being paid.
	Receiver *Receiver `json:"receiver,omitempty"`
}

type PostContinueJSONRequestBody = ContinuationRequest

type PostRequestJSONRequestBody = GrantRequest

type Receiver = string

type Subject struct {
	// SubIds A list of subject identifiers.
	SubIds []struct {
		// Format The format of subject identifier that the client can accept.
		Format SubjectSubIdsFormat `json:"format"`

		// Id Specific identifier for the subject for which the client is requesting information.
		Id string `json:"id"`
	} `json:"sub_ids"`
}

type SubjectSubIdsFormat string