fireblocks-sdk-js icon indicating copy to clipboard operation
fireblocks-sdk-js copied to clipboard

[Bug] `type` field in `AddressResponse` is `number`, but was `string` in soon-to-be-deprecated `DepositAddressResponse`

Open vihangpatil opened this issue 1 year ago • 0 comments

Describe the bug getDepositAddresses is being deprecated and replaced by its paginated version getPaginatedAddresses.
Original interface DepositAddressResponse had type?: string but the replacement interface AddressResponse has type?: number.
The raw json has string values such as Permanent.

API documentation shows correct datatype - type?: string. But the Response 200 object is array of AddressResponse instead of object which has 2 fields - addresses: AddressResponse[] and paging...

paging?: {
  before?: string;
  after?: string;
};

Deprecated API: https://developers.fireblocks.com/reference/get_vault-accounts-vaultaccountid-assetid-addresses

Replacement API: https://developers.fireblocks.com/reference/get_vault-accounts-vaultaccountid-assetid-addresses-paginated

To Reproduce Steps to reproduce the behavior:

  • Check raw json response for replacement API.

Expected behavior

  • In interface AddressResponse, type?: number should be changed to type?: string.
  • 200 Response documentation to be updated for replacement API.

Version:

  • fireblocks-sdk version: 5.21.0

vihangpatil avatar Mar 04 '24 12:03 vihangpatil