Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generated SDK for version v1.0.0 GA #8

Merged
merged 1 commit into from
Apr 7, 2024
Merged

Generated SDK for version v1.0.0 GA #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
159 changes: 139 additions & 20 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

2,378 changes: 2,079 additions & 299 deletions api/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ apply plugin: 'eclipse'
apply plugin: 'com.diffplug.spotless'

group = 'com.fireblocks.sdk'
version = '1.6.2'
version = '1.0.0'

buildscript {
repositories {
Expand Down
18 changes: 18 additions & 0 deletions docs/APIUser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@


# APIUser


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**id** | **String** | The unique identifier of the user | [optional] |
|**name** | **String** | The name of the user | [optional] |
|**role** | **UserRole** | | [optional] |
|**enabled** | **Boolean** | Whether the user is enabled | [optional] |
|**status** | **UserStatus** | | [optional] |
|**userType** | **UserType** | | [optional] |



14 changes: 14 additions & 0 deletions docs/Account.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# Account


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**accountId** | **String** | | |
|**accountType** | **AccountType** | | |



19 changes: 19 additions & 0 deletions docs/AccountType.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@


# AccountType

## Enum


* `EXCHANGE_ACCOUNT` (value: `"EXCHANGE_ACCOUNT"`)

* `UNMANAGED_WALLET` (value: `"UNMANAGED_WALLET"`)

* `VAULT_ACCOUNT` (value: `"VAULT_ACCOUNT"`)

* `NETWORK_CONNECTION` (value: `"NETWORK_CONNECTION"`)

* `FIAT_ACCOUNT` (value: `"FIAT_ACCOUNT"`)



88 changes: 0 additions & 88 deletions docs/AdminQuorumApi.md
View file
Open in desktop

This file was deleted.

43 changes: 27 additions & 16 deletions docs/ApiUserApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ApiUserApi

All URIs are relative to *https://api.fireblocks.io/v1*
All URIs are relative to https://developers.fireblocks.com/reference/

| Method | HTTP request | Description |
|------------- | ------------- | -------------|
Expand All @@ -24,21 +24,26 @@ creates api user
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.Configuration;
import com.fireblocks.sdk.models.*;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.ApiUserApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.fireblocks.io/v1");
ConfigurationOptions configurationOptions = new ConfigurationOptions()
.basePath(BasePath.Sandbox)
.apiKey("my-api-key")
.secretKey("my-secret-key");
Fireblocks fireblocks = new Fireblocks(configurationOptions);

ApiUserApi apiInstance = new ApiUserApi(defaultClient);
CreateAPIUser createAPIUser = new CreateAPIUser(); // CreateAPIUser |
String idempotencyKey = "idempotencyKey_example"; // String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.
try {
CompletableFuture<ApiResponse<Void>> response = apiInstance.createApiUser(createAPIUser, idempotencyKey);
CompletableFuture<ApiResponse<Void>> response = fireblocks.apiUser().createApiUser(createAPIUser, idempotencyKey);
System.out.println("Status code: " + response.get().getStatusCode());
System.out.println("Response headers: " + response.get().getHeaders());
} catch (InterruptedException | ExecutionException e) {
Expand Down Expand Up @@ -84,7 +89,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **204** | User sent for creation | * X-Request-ID - <br> |
| **200** | User sent for creation | * X-Request-ID - <br> |
| **401** | Unauthorized. Missing / invalid JWT token in Authorization header. | * X-Request-ID - <br> |
| **403** | Lacking permissions. | * X-Request-ID - <br> |
| **5XX** | Internal error. | * X-Request-ID - <br> |
Expand All @@ -93,7 +98,7 @@ No authorization required

## getApiUsers

> CompletableFuture<ApiResponse<Void>> getApiUsers getApiUsers()
> CompletableFuture<ApiResponse<GetAPIUsersResponse>> getApiUsers getApiUsers()

get api users

Expand All @@ -106,21 +111,27 @@ get api users from the current tenant
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.Configuration;
import com.fireblocks.sdk.models.*;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.ApiUserApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.fireblocks.io/v1");
ConfigurationOptions configurationOptions = new ConfigurationOptions()
.basePath(BasePath.Sandbox)
.apiKey("my-api-key")
.secretKey("my-secret-key");
Fireblocks fireblocks = new Fireblocks(configurationOptions);

ApiUserApi apiInstance = new ApiUserApi(defaultClient);
try {
CompletableFuture<ApiResponse<Void>> response = apiInstance.getApiUsers();
CompletableFuture<ApiResponse<GetAPIUsersResponse>> response = fireblocks.apiUser().getApiUsers();
System.out.println("Status code: " + response.get().getStatusCode());
System.out.println("Response headers: " + response.get().getHeaders());
System.out.println("Response body: " + response.get().getData());
} catch (InterruptedException | ExecutionException e) {
ApiException apiException = (ApiException)e.getCause();
System.err.println("Exception when calling ApiUserApi#getApiUsers");
Expand All @@ -145,8 +156,8 @@ This endpoint does not need any parameter.

### Return type

CompletableFuture<ApiResponse<[**GetAPIUsersResponse**](GetAPIUsersResponse.md)>>

CompletableFuture<ApiResponse<Void>>

### Authorization

Expand Down
14 changes: 14 additions & 0 deletions docs/AssetAmount.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# AssetAmount


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**amount** | **String** | | |
|**assetId** | **String** | | |



14 changes: 14 additions & 0 deletions docs/AssetBadRequestErrorResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# AssetBadRequestErrorResponse


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**message** | **String** | Bad request error code | |
|**code** | **String** | Error code | |



14 changes: 14 additions & 0 deletions docs/AssetConflictErrorResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# AssetConflictErrorResponse


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**message** | **String** | Conflict error code | |
|**code** | **String** | Error code | |



14 changes: 14 additions & 0 deletions docs/AssetInternalServerErrorResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# AssetInternalServerErrorResponse


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**message** | **String** | Internal server error code | |
|**code** | **String** | Error code | |



14 changes: 14 additions & 0 deletions docs/AssetNotFoundErrorResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# AssetNotFoundErrorResponse


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**message** | **String** | Not found error code | |
|**code** | **String** | Error code | |



27 changes: 27 additions & 0 deletions docs/AssetResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@


# AssetResponse


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**legacyId** | **String** | | |
|**assetClass** | [**AssetClassEnum**](#AssetClassEnum) | | |
|**onchain** | [**AssetResponseOnchain**](AssetResponseOnchain.md) | | |
|**metadata** | [**AssetResponseMetadata**](AssetResponseMetadata.md) | | |



## Enum: AssetClassEnum

| Name | Value |
|---- | -----|
| NATIVE | &quot;NATIVE&quot; |
| FT | &quot;FT&quot; |
| NFT | &quot;NFT&quot; |
| SFT | &quot;SFT&quot; |



23 changes: 23 additions & 0 deletions docs/AssetResponseMetadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@


# AssetResponseMetadata


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**scope** | [**ScopeEnum**](#ScopeEnum) | The scope of the asset | |
|**deprecated** | **Boolean** | Is asset deprecated | |



## Enum: ScopeEnum

| Name | Value |
|---- | -----|
| GLOBAL | &quot;Global&quot; |
| LOCAL | &quot;Local&quot; |



17 changes: 17 additions & 0 deletions docs/AssetResponseOnchain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@


# AssetResponseOnchain


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**symbol** | **String** | The asset symbol | |
|**name** | **String** | The asset name | |
|**address** | **String** | The asset address | [optional] |
|**decimals** | **BigDecimal** | Number of decimals | |
|**standard** | **String** | The asset standard | |



Loading
Loading