Skip to content

Commit

Permalink
Generated SDK #4496
Browse files Browse the repository at this point in the history
  • Loading branch information
fireblocks_dx_team committed Jul 3, 2024
1 parent 0eabdac commit dad11ac
Show file tree
Hide file tree
Showing 22 changed files with 86 additions and 113 deletions.
45 changes: 23 additions & 22 deletions .github/workflows/publish-npm.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,29 +42,29 @@ jobs:
git tag --force $TAG_NAME
git push --force origin $TAG_NAME
# publish:
# needs: bump-version
# runs-on: ubuntu-latest
# steps:
# - name: Check out repository code
# uses: actions/checkout@v4
# with:
# ref: master
# fetch-depth: 0
# - name: Set up Node
# uses: actions/setup-node@v2
# with:
# node-version: '16.x'
# registry-url: 'https://registry.npmjs.org'
# - name: Install dependencies
# run: npm install
# - name: Publish package
# run: npm publish
# env:
# NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
publish:
needs: bump-version
runs-on: ubuntu-latest
steps:
- name: Check out repository code
uses: actions/checkout@v4
with:
ref: master
fetch-depth: 0
- name: Set up Node
uses: actions/setup-node@v2
with:
node-version: '16.x'
registry-url: 'https://registry.npmjs.org'
- name: Install dependencies
run: npm install
- name: Publish package
run: npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

publish-to-private-registry:
needs: bump-version
needs: publish
runs-on: ubuntu-latest
steps:
- name: Check out repository code
Expand All @@ -85,6 +85,7 @@ jobs:
node-version: '16.x'
registry-url: 'https://gitlab.com/api/v4/projects/20565764/packages/npm/'
- name: Publish package
run: npm publish --tag beta
run: npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.GITLAB_NPM_REG_TOKEN }}
SKIP_POSTVERSION: true
51 changes: 0 additions & 51 deletions CHANGELOG.md

This file was deleted.

8 changes: 4 additions & 4 deletions api/blockchains-assets-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ export const BlockchainsAssetsApiAxiosParamCreator = function (configuration?: C
};
},
/**
* Register a new asset to a workspace and return the newly created asset\'s details. Currently supported chains are: - EVM based chains - Stellar - Algorand - TRON - NEAR
* Register a new asset to a workspace and return the newly created asset\'s details. Currently supported chains are: - EVM based chains - Stellar - Algorand - TRON - NEAR - Solana
* @summary Register an asset
* @param {RegisterNewAssetRequest} [registerNewAssetRequest]
* @param {string} [idempotencyKey] 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.
Expand Down Expand Up @@ -142,7 +142,7 @@ export const BlockchainsAssetsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
},
/**
* Register a new asset to a workspace and return the newly created asset\'s details. Currently supported chains are: - EVM based chains - Stellar - Algorand - TRON - NEAR
* Register a new asset to a workspace and return the newly created asset\'s details. Currently supported chains are: - EVM based chains - Stellar - Algorand - TRON - NEAR - Solana
* @summary Register an asset
* @param {RegisterNewAssetRequest} [registerNewAssetRequest]
* @param {string} [idempotencyKey] 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.
Expand Down Expand Up @@ -175,7 +175,7 @@ export const BlockchainsAssetsApiFactory = function (configuration?: Configurati
return localVarFp.getSupportedAssets(options).then((request) => request(axios, basePath));
},
/**
* Register a new asset to a workspace and return the newly created asset\'s details. Currently supported chains are: - EVM based chains - Stellar - Algorand - TRON - NEAR
* Register a new asset to a workspace and return the newly created asset\'s details. Currently supported chains are: - EVM based chains - Stellar - Algorand - TRON - NEAR - Solana
* @summary Register an asset
* @param {BlockchainsAssetsApiRegisterNewAssetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
Expand Down Expand Up @@ -227,7 +227,7 @@ export class BlockchainsAssetsApi extends BaseAPI {
}

/**
* Register a new asset to a workspace and return the newly created asset\'s details. Currently supported chains are: - EVM based chains - Stellar - Algorand - TRON - NEAR
* Register a new asset to a workspace and return the newly created asset\'s details. Currently supported chains are: - EVM based chains - Stellar - Algorand - TRON - NEAR - Solana
* @summary Register an asset
* @param {BlockchainsAssetsApiRegisterNewAssetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
Expand Down
8 changes: 4 additions & 4 deletions api/nfts-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -946,7 +946,7 @@ export interface NFTsApiGetNFTsRequest {
export interface NFTsApiGetOwnershipTokensRequest {
/**
* Blockchain descriptor filter
* @type {'ETH' | 'ETH_TEST3' | 'ETH_TEST5' | 'ETH_TEST6' | 'POLYGON' | 'POLYGON_TEST_MUMBAI' | 'AMOY_POLYGON_TEST' | 'XTZ' | 'XTZ_TEST' | 'BASECHAIN_ETH'}
* @type {'ETH' | 'ETH_TEST3' | 'ETH_TEST5' | 'ETH_TEST6' | 'POLYGON' | 'POLYGON_TEST_MUMBAI' | 'AMOY_POLYGON_TEST' | 'XTZ' | 'XTZ_TEST' | 'BASECHAIN_ETH' | 'BASECHAIN_ETH_TEST3'}
* @memberof NFTsApiGetOwnershipTokens
*/
readonly blockchainDescriptor?: GetOwnershipTokensBlockchainDescriptorEnum
Expand Down Expand Up @@ -1205,7 +1205,7 @@ export interface NFTsApiRefreshNFTMetadataRequest {
export interface NFTsApiUpdateOwnershipTokensRequest {
/**
* Blockchain descriptor filter
* @type {'ETH' | 'ETH_TEST3' | 'ETH_TEST5' | 'ETH_TEST6' | 'POLYGON' | 'POLYGON_TEST_MUMBAI' | 'AMOY_POLYGON_TEST' | 'BASECHAIN_ETH'}
* @type {'ETH' | 'ETH_TEST5' | 'ETH_TEST6' | 'POLYGON' | 'POLYGON_TEST_MUMBAI' | 'AMOY_POLYGON_TEST' | 'BASECHAIN_ETH'}
* @memberof NFTsApiUpdateOwnershipTokens
*/
readonly blockchainDescriptor: UpdateOwnershipTokensBlockchainDescriptorEnum
Expand Down Expand Up @@ -1453,7 +1453,8 @@ export const GetOwnershipTokensBlockchainDescriptorEnum = {
AmoyPolygonTest: 'AMOY_POLYGON_TEST',
Xtz: 'XTZ',
XtzTest: 'XTZ_TEST',
BasechainEth: 'BASECHAIN_ETH'
BasechainEth: 'BASECHAIN_ETH',
BasechainEthTest3: 'BASECHAIN_ETH_TEST3'
} as const;
export type GetOwnershipTokensBlockchainDescriptorEnum = typeof GetOwnershipTokensBlockchainDescriptorEnum[keyof typeof GetOwnershipTokensBlockchainDescriptorEnum];
/**
Expand Down Expand Up @@ -1575,7 +1576,6 @@ export type ListOwnedTokensSpamEnum = typeof ListOwnedTokensSpamEnum[keyof typeo
*/
export const UpdateOwnershipTokensBlockchainDescriptorEnum = {
Eth: 'ETH',
EthTest3: 'ETH_TEST3',
EthTest5: 'ETH_TEST5',
EthTest6: 'ETH_TEST6',
Polygon: 'POLYGON',
Expand Down
6 changes: 3 additions & 3 deletions docs/apis/BlockchainsAssetsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ No authorization required
# **registerNewAsset**
> AssetResponse registerNewAsset()
Register a new asset to a workspace and return the newly created asset\'s details. Currently supported chains are: - EVM based chains - Stellar - Algorand - TRON - NEAR
Register a new asset to a workspace and return the newly created asset\'s details. Currently supported chains are: - EVM based chains - Stellar - Algorand - TRON - NEAR - Solana

### Example

Expand Down Expand Up @@ -121,8 +121,8 @@ No authorization required
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | A new asset has been created successfully | - |
**400** | - Listing an asset on the requested blockchain is not supported. Error code: 1000 - The asset address is invalid. Error code: 1003 - Self serve listing an asset on the requested blockchain is currently not supported, please contact support. Error code: 1004 | - |
**403** | - The asset creation quota reached. Error code: 1005 | - |
**400** | - Listing an asset on the requested blockchain is not supported. Error code: 1000 - The asset address is invalid. Error code: 1003 - Self serve listing an asset on the requested blockchain is currently not supported, please contact support. Error code: 1004 - Blockchain is deprecated. Error code: 1006 - The asset\'s standard is not supported. Error code: 1007 | - |
**403** | - The asset creation quota reached. Error code: 1005 - Tenant is not allowed to create testnet assets. Error code: 1008 - Tenant is not allowed to create mainnet assets. Error code: 1009 | - |
**404** | - Invalid address, could not get asset information. Error code 1003 | - |
**409** | - The asset is already supported globally. Error code: 1001 - The asset has already been added to this workspace. Error code: 1002 | - |
**500** | Failed to create asset | - |
Expand Down
8 changes: 4 additions & 4 deletions docs/apis/NFTsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf
const fireblocks = new Fireblocks();

let body: NFTsApiGetOwnershipTokensRequest = {
// 'ETH' | 'ETH_TEST3' | 'ETH_TEST5' | 'ETH_TEST6' | 'POLYGON' | 'POLYGON_TEST_MUMBAI' | 'AMOY_POLYGON_TEST' | 'XTZ' | 'XTZ_TEST' | 'BASECHAIN_ETH' | Blockchain descriptor filter (optional)
// 'ETH' | 'ETH_TEST3' | 'ETH_TEST5' | 'ETH_TEST6' | 'POLYGON' | 'POLYGON_TEST_MUMBAI' | 'AMOY_POLYGON_TEST' | 'XTZ' | 'XTZ_TEST' | 'BASECHAIN_ETH' | 'BASECHAIN_ETH_TEST3' | Blockchain descriptor filter (optional)
blockchainDescriptor: blockchainDescriptor_example,
// string | A comma separated list of Vault Account IDs. Up to 100 are allowed in a single request. This field will be ignored when walletType=END_USER_WALLET or ncwId is provided. (optional)
vaultAccountIds: vaultAccountIds_example,
Expand Down Expand Up @@ -207,7 +207,7 @@ fireblocks.nfts.getOwnershipTokens(body).then((res: FireblocksResponse<GetOwners

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**blockchainDescriptor** | [**&#39;ETH&#39; | &#39;ETH_TEST3&#39; | &#39;ETH_TEST5&#39; | &#39;ETH_TEST6&#39; | &#39;POLYGON&#39; | &#39;POLYGON_TEST_MUMBAI&#39; | &#39;AMOY_POLYGON_TEST&#39; | &#39;XTZ&#39; | &#39;XTZ_TEST&#39; | &#39;BASECHAIN_ETH&#39;**]**Array<&#39;ETH&#39; &#124; &#39;ETH_TEST3&#39; &#124; &#39;ETH_TEST5&#39; &#124; &#39;ETH_TEST6&#39; &#124; &#39;POLYGON&#39; &#124; &#39;POLYGON_TEST_MUMBAI&#39; &#124; &#39;AMOY_POLYGON_TEST&#39; &#124; &#39;XTZ&#39; &#124; &#39;XTZ_TEST&#39; &#124; &#39;BASECHAIN_ETH&#39;>** | Blockchain descriptor filter | (optional) defaults to undefined
**blockchainDescriptor** | [**&#39;ETH&#39; | &#39;ETH_TEST3&#39; | &#39;ETH_TEST5&#39; | &#39;ETH_TEST6&#39; | &#39;POLYGON&#39; | &#39;POLYGON_TEST_MUMBAI&#39; | &#39;AMOY_POLYGON_TEST&#39; | &#39;XTZ&#39; | &#39;XTZ_TEST&#39; | &#39;BASECHAIN_ETH&#39; | &#39;BASECHAIN_ETH_TEST3&#39;**]**Array<&#39;ETH&#39; &#124; &#39;ETH_TEST3&#39; &#124; &#39;ETH_TEST5&#39; &#124; &#39;ETH_TEST6&#39; &#124; &#39;POLYGON&#39; &#124; &#39;POLYGON_TEST_MUMBAI&#39; &#124; &#39;AMOY_POLYGON_TEST&#39; &#124; &#39;XTZ&#39; &#124; &#39;XTZ_TEST&#39; &#124; &#39;BASECHAIN_ETH&#39; &#124; &#39;BASECHAIN_ETH_TEST3&#39;>** | Blockchain descriptor filter | (optional) defaults to undefined
**vaultAccountIds** | [**string**] | A comma separated list of Vault Account IDs. Up to 100 are allowed in a single request. This field will be ignored when walletType&#x3D;END_USER_WALLET or ncwId is provided. | (optional) defaults to undefined
**ncwId** | [**string**] | Tenant\&#39;s Non-Custodial Wallet ID | (optional) defaults to undefined
**ncwAccountIds** | [**string**] | A comma separated list of Non-Custodial account IDs. Up to 100 are allowed in a single request. This field will be ignored when walletType&#x3D;VAULT_ACCOUNT or ncwId is not provided. | (optional) defaults to undefined
Expand Down Expand Up @@ -490,7 +490,7 @@ process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf
const fireblocks = new Fireblocks();

let body: NFTsApiUpdateOwnershipTokensRequest = {
// 'ETH' | 'ETH_TEST3' | 'ETH_TEST5' | 'ETH_TEST6' | 'POLYGON' | 'POLYGON_TEST_MUMBAI' | 'AMOY_POLYGON_TEST' | 'BASECHAIN_ETH' | Blockchain descriptor filter
// 'ETH' | 'ETH_TEST5' | 'ETH_TEST6' | 'POLYGON' | 'POLYGON_TEST_MUMBAI' | 'AMOY_POLYGON_TEST' | 'BASECHAIN_ETH' | Blockchain descriptor filter
blockchainDescriptor: blockchainDescriptor_example,
// string | Vault account filter
vaultAccountId: vaultAccountId_example,
Expand All @@ -508,7 +508,7 @@ fireblocks.nfts.updateOwnershipTokens(body).then((res: FireblocksResponse<any>)

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**blockchainDescriptor** | [**&#39;ETH&#39; | &#39;ETH_TEST3&#39; | &#39;ETH_TEST5&#39; | &#39;ETH_TEST6&#39; | &#39;POLYGON&#39; | &#39;POLYGON_TEST_MUMBAI&#39; | &#39;AMOY_POLYGON_TEST&#39; | &#39;BASECHAIN_ETH&#39;**]**Array<&#39;ETH&#39; &#124; &#39;ETH_TEST3&#39; &#124; &#39;ETH_TEST5&#39; &#124; &#39;ETH_TEST6&#39; &#124; &#39;POLYGON&#39; &#124; &#39;POLYGON_TEST_MUMBAI&#39; &#124; &#39;AMOY_POLYGON_TEST&#39; &#124; &#39;BASECHAIN_ETH&#39;>** | Blockchain descriptor filter | defaults to undefined
**blockchainDescriptor** | [**&#39;ETH&#39; | &#39;ETH_TEST5&#39; | &#39;ETH_TEST6&#39; | &#39;POLYGON&#39; | &#39;POLYGON_TEST_MUMBAI&#39; | &#39;AMOY_POLYGON_TEST&#39; | &#39;BASECHAIN_ETH&#39;**]**Array<&#39;ETH&#39; &#124; &#39;ETH_TEST5&#39; &#124; &#39;ETH_TEST6&#39; &#124; &#39;POLYGON&#39; &#124; &#39;POLYGON_TEST_MUMBAI&#39; &#124; &#39;AMOY_POLYGON_TEST&#39; &#124; &#39;BASECHAIN_ETH&#39;>** | Blockchain descriptor filter | defaults to undefined
**vaultAccountId** | [**string**] | Vault account filter | defaults to undefined
**idempotencyKey** | [**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. | (optional) defaults to undefined

Expand Down
2 changes: 1 addition & 1 deletion docs/models/AssetResponseOnchain.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
|**symbol** | **string** | The asset symbol | [default to undefined]|
|**name** | **string** | The asset name | [default to undefined]|
|**decimals** | **number** | Number of decimals | [default to undefined]|
|**standard** | **string** | The asset standard | [default to undefined]|
|**address** | **string** | The asset address | [optional] [default to undefined]|
|**standard** | **string** | The asset standard | [optional] [default to undefined]|



Expand Down
2 changes: 2 additions & 0 deletions docs/models/CollectionOwnershipResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@

* `BasechainEth` (value: `'BASECHAIN_ETH'`)

* `BasechainEthTest3` (value: `'BASECHAIN_ETH_TEST3'`)




Expand Down
1 change: 1 addition & 0 deletions docs/models/DestinationTransferPeerPathResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
|**id** | **string** | The ID of the peer. You can retrieve the ID of each venue object using the endpoints for [listing vault accounts](https://developers.fireblocks.com/reference/get_vault-accounts-paged), [listing exchange account](https://developers.fireblocks.com/reference/get_exchange-accounts), [listing fiat accounts](https://developers.fireblocks.com/reference/get_fiat-accounts), [listing internal wallets](https://developers.fireblocks.com/reference/get_internal-wallets), [listing external wallets](https://developers.fireblocks.com/reference/get_external-wallets), [listing network connections](https://developers.fireblocks.com/reference/get_network-connections). For the other types, this parameter is not needed. | [optional] [default to undefined]|
|**name** | **string** | The name of the peer. | [optional] [default to undefined]|
|**walletId** | **string** | | [optional] [default to undefined]|
|**tradingAccount** | **string** | If this transaction is an exchange internal transfer, this field will be populated with the type of that trading account. | [optional] [default to undefined]|



Expand Down
2 changes: 1 addition & 1 deletion docs/models/RegisterNewAssetRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
|Name | Type | Description | Notes|
|------------ | ------------- | ------------- | -------------|
|**blockchainId** | **string** | Native asset ID of the blockchain | [default to undefined]|
|**address** | **string** | Asset address. - For EVM based chains this should be the token contract address. - For Stellar (XLM) this should be the issuer address. - For Algorand (ALGO) this should be the asset ID. - For TRON (TRX) this should be the token contract address. - For NEAR this will be the token address. | [default to undefined]|
|**address** | **string** | Asset address. - EVM-based chains: token contract address - Stellar (XLM): issuer address - Algorand (ALGO): asset ID - TRON (TRX): token contract address - NEAR: token address - Solana: token\&#39;s mint account address | [default to undefined]|
|**symbol** | **string** | Required for Stellar only, asset code is expected. | [optional] [default to undefined]|


Expand Down
1 change: 1 addition & 0 deletions docs/models/SourceTransferPeerPathResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
|**id** | **string** | The ID of the peer. You can retrieve the ID of each venue object using the endpoints for [listing vault accounts](https://developers.fireblocks.com/reference/get_vault-accounts-paged), [listing exchange account](https://developers.fireblocks.com/reference/get_exchange-accounts), [listing fiat accounts](https://developers.fireblocks.com/reference/get_fiat-accounts), [listing internal wallets](https://developers.fireblocks.com/reference/get_internal-wallets), [listing external wallets](https://developers.fireblocks.com/reference/get_external-wallets), [listing network connections](https://developers.fireblocks.com/reference/get_network-connections). For the other types, this parameter is not needed. | [optional] [default to undefined]|
|**name** | **string** | The name of the peer. | [optional] [default to undefined]|
|**walletId** | **string** | | [optional] [default to undefined]|
|**tradingAccount** | **string** | If this transaction is an exchange internal transfer, this field will be populated with the type of that trading account. | [optional] [default to undefined]|



Expand Down
2 changes: 2 additions & 0 deletions docs/models/TokenOwnershipResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@

* `BasechainEth` (value: `'BASECHAIN_ETH'`)

* `BasechainEthTest3` (value: `'BASECHAIN_ETH_TEST3'`)



## Enum: TokenOwnershipResponseStatusEnum
Expand Down
Loading

0 comments on commit dad11ac

Please sign in to comment.