package
0.0.0-20241018170450-2e19a7b365b3
Repository: https://github.com/andriidiachuk/flow.git
Documentation: pkg.go.dev
# README
Go API client for swagger
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: 1.0.0
- 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 "./swagger"
Documentation for API Endpoints
All URIs are relative to https://rest-canary.onflow.org/v1/
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AccountsApi | AccountsAddressGet | Get /accounts/{address} | Get an Account By Address |
| AccountsApi | AccountsAddressKeysIndexGet | Get /accounts/{address}/keys/{index} | Get an individual Account Key By Address and Index |
| BlocksApi | BlocksGet | Get /blocks | Gets Blocks by Height |
| BlocksApi | BlocksIdGet | Get /blocks/{id} | Get Blocks by ID. |
| BlocksApi | BlocksIdPayloadGet | Get /blocks/{id}/payload | Get Block Payload by Block ID. |
| CollectionsApi | CollectionsIdGet | Get /collections/{id} | Gets a Collection by ID |
| EventsApi | EventsGet | Get /events | Get Events |
| ExecutionResultsApi | ExecutionResultsGet | Get /execution_results | Get Execution Results by Block ID |
| ExecutionResultsApi | ExecutionResultsIdGet | Get /execution_results/{id} | Get Execution Result by ID |
| NetworkApi | NetworkParametersGet | Get /network/parameters | Get Network Parameters |
| NodeVersionInfoApi | NodeVersionInfoGet | Get /node_version_info | Get Node Version Information |
| ScriptsApi | ScriptsPost | Post /scripts | Execute a Cadence Script |
| SubscribeEventsApi | SubscribeEventsGet | Get /subscribe_events | Subscribe events |
| TransactionsApi | TransactionResultsTransactionIdGet | Get /transaction_results/{transaction_id} | Get a Transaction Result by ID. |
| TransactionsApi | TransactionsIdGet | Get /transactions/{id} | Get a Transaction by ID. |
| TransactionsApi | TransactionsPost | Post /transactions | Submit a Transaction |
Documentation For Models
- Account
- AccountExpandable
- AccountPublicKey
- AggregatedSignature
- Block
- BlockEvents
- BlockExpandable
- BlockHeader
- BlockHeight
- BlockPayload
- BlockSeal
- Chunk
- Collection
- CollectionExpandable
- CollectionGuarantee
- CompatibleRange
- Event
- ExecutionResult
- HashingAlgorithm
- InlineResponse200
- Links
- ModelError
- NetworkParameters
- NodeVersionInfo
- ProposalKey
- ScriptsBody
- SigningAlgorithm
- SubscribeEvents
- Transaction
- TransactionExecution
- TransactionExpandable
- TransactionResult
- TransactionSignature
- TransactionStatus
- TransactionsBody
Documentation For Authorization
Endpoints do not require authorization.
Author
# Functions
CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
No description provided by the author
No description provided by the author
No description provided by the author
# Constants
List of SigningAlgorithm.
List of SigningAlgorithm.
List of SigningAlgorithm.
List of TransactionStatus.
List of TransactionStatus.
List of TransactionExecution.
List of TransactionStatus.
List of HashingAlgorithm.
List of TransactionExecution.
List of TransactionStatus.
List of TransactionStatus.
List of HashingAlgorithm.
List of HashingAlgorithm.
List of HashingAlgorithm.
List of HashingAlgorithm.
List of TransactionExecution.
# Variables
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIClient manages communication with the Access API API v1.0.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A compatible version range.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GenericSwaggerError Provides access to the body, error and model on returned errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Base64 encoded signature.
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TransactionExecution : This value indicates whether the transaction execution succeded or not, this value should be checked when determining transaction success.
No description provided by the author
TransactionStatus : This value indicates the state of the transaction execution.