diff --git a/api-spec-scalar.yml b/api-spec-scalar.yml index 6c7060d..91324ee 100644 --- a/api-spec-scalar.yml +++ b/api-spec-scalar.yml @@ -18217,17 +18217,17 @@ components: description: >- 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), + accounts](https://developers.fireblocks.com/reference/getpagedvaultaccounts), [listing exchange - account](https://developers.fireblocks.com/reference/get_exchange-accounts), + account](https://developers.fireblocks.com/reference/getexchangeaccounts), [listing fiat - accounts](https://developers.fireblocks.com/reference/get_fiat-accounts), + accounts](https://developers.fireblocks.com/reference/getfiataccounts), [listing internal - wallets](https://developers.fireblocks.com/reference/get_internal-wallets), + wallets](https://developers.fireblocks.com/reference/getinternalwallets), [listing external - wallets](https://developers.fireblocks.com/reference/get_external-wallets), + wallets](https://developers.fireblocks.com/reference/getexternalwallets), [listing network - connections](https://developers.fireblocks.com/reference/get_network-connections). + connections](https://developers.fireblocks.com/reference/getnetworkconnections). For the other types, this parameter is not needed. name: type: string @@ -18271,17 +18271,17 @@ components: description: >- 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), + accounts](https://developers.fireblocks.com/reference/getpagedvaultaccounts), [listing exchange - account](https://developers.fireblocks.com/reference/get_exchange-accounts), + account](https://developers.fireblocks.com/reference/getexchangeaccounts), [listing fiat - accounts](https://developers.fireblocks.com/reference/get_fiat-accounts), + accounts](https://developers.fireblocks.com/reference/getfiataccounts), [listing internal - wallets](https://developers.fireblocks.com/reference/get_internal-wallets), + wallets](https://developers.fireblocks.com/reference/getinternalwallets), [listing external - wallets](https://developers.fireblocks.com/reference/get_external-wallets), + wallets](https://developers.fireblocks.com/reference/getexternalwallets), [listing network - connections](https://developers.fireblocks.com/reference/get_network-connections). + connections](https://developers.fireblocks.com/reference/getnetworkconnections). For the other types, this parameter is not needed. name: type: string diff --git a/api-spec-v2.yaml b/api-spec-v2.yaml index 74e40ed..5a09c66 100644 --- a/api-spec-v2.yaml +++ b/api-spec-v2.yaml @@ -13449,565 +13449,6 @@ paths: fireblocks.tokenization().getLinkedToken(id); - lang: Python source: response = fireblocks.tokenization.get_linked_token(id); - /swap/providers: - get: - operationId: getSwapProviders - summary: Get Providers List - description: |- - Return a list of all supported swap providers. - - Note: These endpoints are currently in beta and might be subject to changes. - - Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. - tags: - - Swap (Beta) - x-rate-limit-category: query - parameters: - - name: pageCursor - required: false - in: query - description: Cursor of the required page - schema: - type: string - - name: pageSize - required: false - in: query - description: >- - Number of items in a page, Acceptable values are 1-100. Maximum - value is 100 - example: 10 - schema: - minimum: 1 - maximum: 100 - default: 10 - type: number - responses: - '200': - description: A paginated response containing ProviderDto objects - content: - application/json: - schema: - $ref: '#/components/schemas/SwapProvidersPaginatedResponse' - default: - $ref: '#/components/responses/Error' - x-readme: - code-samples: - - language: typescript - code: >- - const response: - Promise> = - fireblocks.swapBeta.getSwapProviders(swapBetaApiGetSwapProvidersRequest); - name: Fireblocks SDK TypeScript example - - language: java - code: >- - CompletableFuture> - response = fireblocks.swapBeta().getSwapProviders(pageCursor, - pageSize); - name: Fireblocks SDK Java example - - language: python - code: >- - response = fireblocks.swap_beta.get_swap_providers(page_cursor, - page_size); - name: Fireblocks SDK Python example - x-codeSamples: - - lang: TypeScript - source: >- - const response: - Promise> = - fireblocks.swapBeta.getSwapProviders(swapBetaApiGetSwapProvidersRequest); - - lang: Java - source: >- - CompletableFuture> - response = fireblocks.swapBeta().getSwapProviders(pageCursor, - pageSize); - - lang: Python - source: >- - response = fireblocks.swap_beta.get_swap_providers(page_cursor, - page_size); - /swap/providers/{providerId}/approve_terms: - post: - operationId: approveTermsOfService - summary: Approve terms of service - description: |- - Approve the terms of service for a swap provider. Some providers require this approval before performing a swap action for the first time. - - Note: These endpoints are currently in beta and might be subject to changes. If you want to participate in the beta and learn more about the Fireblocks Swap, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. - - Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. - tags: - - Swap (Beta) - x-rate-limit-category: write - parameters: - - name: providerId - required: true - in: path - schema: - type: string - - $ref: '#/components/parameters/X-Idempotency-Key' - responses: - '200': - description: successfully approve terms of service - content: - application/json: - schema: - $ref: '#/components/schemas/SwapProvider' - default: - $ref: '#/components/responses/Error' - x-readme: - code-samples: - - language: typescript - code: >- - const response: Promise> = - fireblocks.swapBeta.approveTermsOfService(swapBetaApiApproveTermsOfServiceRequest); - name: Fireblocks SDK TypeScript example - - language: java - code: >- - CompletableFuture> response = - fireblocks.swapBeta().approveTermsOfService(providerId, - idempotencyKey); - name: Fireblocks SDK Java example - - language: python - code: >- - response = - fireblocks.swap_beta.approve_terms_of_service(provider_id, - idempotency_key); - name: Fireblocks SDK Python example - x-codeSamples: - - lang: TypeScript - source: >- - const response: Promise> = - fireblocks.swapBeta.approveTermsOfService(swapBetaApiApproveTermsOfServiceRequest); - - lang: Java - source: >- - CompletableFuture> response = - fireblocks.swapBeta().approveTermsOfService(providerId, - idempotencyKey); - - lang: Python - source: >- - response = - fireblocks.swap_beta.approve_terms_of_service(provider_id, - idempotency_key); - /swap/providers/{providerId}/quote: - post: - operationId: createQuote - summary: Create a quote - description: |- - Create a quote from a specific swap provider. - - Note: These endpoints are currently in beta and might be subject to changes. If you want to participate in the beta and learn more about the Fireblocks Swap, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. - - Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. - tags: - - Swap (Beta) - x-rate-limit-category: write - parameters: - - name: providerId - required: true - in: path - schema: - type: string - - $ref: '#/components/parameters/X-Idempotency-Key' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/QuoteRequest' - responses: - '201': - description: >- - The response can be one of two possible DTOs, depending on whether the - request contains the accountId property. - content: - application/json: - schema: - $ref: '#/components/schemas/QuoteResponse' - default: - $ref: '#/components/responses/Error' - x-readme: - code-samples: - - language: typescript - code: >- - const response: Promise> = - fireblocks.swapBeta.createQuote(swapBetaApiCreateQuoteRequest); - name: Fireblocks SDK TypeScript example - - language: java - code: >- - CompletableFuture> response = - fireblocks.swapBeta().createQuote(quoteRequest, providerId, - idempotencyKey); - name: Fireblocks SDK Java example - - language: python - code: >- - response = fireblocks.swap_beta.create_quote(quote_request, - provider_id, idempotency_key); - name: Fireblocks SDK Python example - x-codeSamples: - - lang: TypeScript - source: >- - const response: Promise> = - fireblocks.swapBeta.createQuote(swapBetaApiCreateQuoteRequest); - - lang: Java - source: >- - CompletableFuture> response = - fireblocks.swapBeta().createQuote(quoteRequest, providerId, - idempotencyKey); - - lang: Python - source: >- - response = fireblocks.swap_beta.create_quote(quote_request, - provider_id, idempotency_key); - /swap/operations: - post: - operationId: createSwapOperation - summary: Create swap operation - x-rate-limit-category: write - description: |- - Create a swap operation based on a provided quote ID. - - Note: These endpoints are currently in beta and might be subject to changes. If you want to participate in the beta and learn more about the Fireblocks Swap, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. - - Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. - tags: - - Swap (Beta) - parameters: - - $ref: '#/components/parameters/X-Idempotency-Key' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SwapOperationRequest' - responses: - '201': - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/SwapOperation' - default: - $ref: '#/components/responses/Error' - x-readme: - code-samples: - - language: typescript - code: >- - const response: Promise> = - fireblocks.swapBeta.createSwapOperation(swapBetaApiCreateSwapOperationRequest); - name: Fireblocks SDK TypeScript example - - language: java - code: >- - CompletableFuture> response = - fireblocks.swapBeta().createSwapOperation(swapOperationRequest, - idempotencyKey); - name: Fireblocks SDK Java example - - language: python - code: >- - response = - fireblocks.swap_beta.create_swap_operation(swap_operation_request, - idempotency_key); - name: Fireblocks SDK Python example - x-codeSamples: - - lang: TypeScript - source: >- - const response: Promise> = - fireblocks.swapBeta.createSwapOperation(swapBetaApiCreateSwapOperationRequest); - - lang: Java - source: >- - CompletableFuture> response = - fireblocks.swapBeta().createSwapOperation(swapOperationRequest, - idempotencyKey); - - lang: Python - source: >- - response = - fireblocks.swap_beta.create_swap_operation(swap_operation_request, - idempotency_key); - get: - operationId: getSwapOperations - summary: Get Operations list - x-rate-limit-category: read - description: |- - Return a list of swap operations for the specific workspace. The operations are sorted by creation date in descending order, meaning the most recent operation appears first. - - Note: These endpoints are currently in beta and might be subject to changes. If you want to participate in the beta and learn more about the Fireblocks Swap, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. - - Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. - tags: - - Swap (Beta) - parameters: - - name: pageCursor - required: false - in: query - description: Cursor of the required page - schema: - type: string - - name: pageSize - required: false - in: query - description: >- - Number of items in a page, Acceptable values are 1-100. Maximum - value is 100 - example: 10 - schema: - minimum: 1 - maximum: 100 - default: 10 - type: number - responses: - '200': - description: A paginated response containing OperationDto objects - content: - application/json: - schema: - $ref: '#/components/schemas/SwapOperationsPaginatedResponse' - default: - $ref: '#/components/responses/Error' - x-readme: - code-samples: - - language: typescript - code: >- - const response: - Promise> = - fireblocks.swapBeta.getSwapOperations(swapBetaApiGetSwapOperationsRequest); - name: Fireblocks SDK TypeScript example - - language: java - code: >- - CompletableFuture> - response = fireblocks.swapBeta().getSwapOperations(pageCursor, - pageSize); - name: Fireblocks SDK Java example - - language: python - code: >- - response = fireblocks.swap_beta.get_swap_operations(page_cursor, - page_size); - name: Fireblocks SDK Python example - x-codeSamples: - - lang: TypeScript - source: >- - const response: - Promise> = - fireblocks.swapBeta.getSwapOperations(swapBetaApiGetSwapOperationsRequest); - - lang: Java - source: >- - CompletableFuture> - response = fireblocks.swapBeta().getSwapOperations(pageCursor, - pageSize); - - lang: Python - source: >- - response = fireblocks.swap_beta.get_swap_operations(page_cursor, - page_size); - /swap/operations/{operationId}: - get: - operationId: getSwapOperationById - summary: Get operation details - description: |- - Get swap operation Details by ID. - - Note: These endpoints are currently in beta and might be subject to changes. If you want to participate in the beta and learn more about the Fireblocks Swap, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com. - - Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. - tags: - - Swap (Beta) - x-rate-limit-category: read - parameters: - - name: operationId - required: true - in: path - schema: - type: string - responses: - '200': - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/SwapOperation' - default: - $ref: '#/components/responses/Error' - x-readme: - code-samples: - - language: typescript - code: >- - const response: Promise> = - fireblocks.swapBeta.getSwapOperationById(swapBetaApiGetSwapOperationByIdRequest); - name: Fireblocks SDK TypeScript example - - language: java - code: >- - CompletableFuture> response = - fireblocks.swapBeta().getSwapOperationById(operationId); - name: Fireblocks SDK Java example - - language: python - code: >- - response = - fireblocks.swap_beta.get_swap_operation_by_id(operation_id); - name: Fireblocks SDK Python example - x-codeSamples: - - lang: TypeScript - source: >- - const response: Promise> = - fireblocks.swapBeta.getSwapOperationById(swapBetaApiGetSwapOperationByIdRequest); - - lang: Java - source: >- - CompletableFuture> response = - fireblocks.swapBeta().getSwapOperationById(operationId); - - lang: Python - source: >- - response = - fireblocks.swap_beta.get_swap_operation_by_id(operation_id); - /tags: - post: - summary: Create a tag - description: Create a new tag. - tags: - - Tags - x-rate-limit-category: write - parameters: - - $ref: '#/components/parameters/X-Idempotency-Key' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/CreateTagRequest' - responses: - "200": - description: A tag object - headers: - X-Request-ID: - $ref: '#/components/headers/X-Request-ID' - content: - application/json: - schema: - $ref: '#/components/schemas/Tag' - operationId: createTag - get: - summary: Get list of tags - description: Retrieve a paged list of all tags according to filters. - tags: - - Tags - x-rate-limit-category: query - parameters: - - in: query - name: pageCursor - description: Page cursor to get the next page. - example: "MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==" - required: false - schema: - type: string - - in: query - name: pageSize - required: false - description: Maximum number of items in the page - schema: - type: number - minimum: 1 - maximum: 100 - default: 100 - - in: query - name: label - required: false - description: Label prefix to filter by. - example: VIP - schema: - type: string - - in: query - name: tagIds - required: false - description: List of tag IDs to filter by. - schema: - type: array - items: - type: string - format: uuid - maxItems: 100 - responses: - "200": - description: A TagsPagedResponse object - headers: - X-Request-ID: - $ref: '#/components/headers/X-Request-ID' - content: - application/json: - schema: - $ref: '#/components/schemas/TagsPagedResponse' - operationId: getTags - /tags/{tagId}: - get: - summary: Get a tag - description: Retrieve an existing tag by ID. - tags: - - Tags - x-rate-limit-category: read - parameters: - - in: path - name: tagId - required: true - description: The ID of the tag to retrieve - schema: - type: string - format: uuid - responses: - "200": - description: A tag object - headers: - X-Request-ID: - $ref: '#/components/headers/X-Request-ID' - content: - application/json: - schema: - $ref: '#/components/schemas/Tag' - operationId: getTag - patch: - summary: Update a tag - description: Update an existing specified tag. - tags: - - Tags - x-rate-limit-category: write - parameters: - - in: path - name: tagId - required: true - description: The ID of the tag to update - schema: - type: string - format: uuid - - $ref: '#/components/parameters/X-Idempotency-Key' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateTagRequest' - responses: - "200": - description: A tag object - headers: - X-Request-ID: - $ref: '#/components/headers/X-Request-ID' - content: - application/json: - schema: - $ref: '#/components/schemas/Tag' - operationId: updateTag - delete: - summary: Delete a tag - description: Delete the specified tag. - tags: - - Tags - x-rate-limit-category: write - parameters: - - in: path - name: tagId - required: true - description: The ID of the tag to retrieve - schema: - type: string - format: uuid - responses: - "204": - description: Tag was deleted successfully - headers: - X-Request-ID: - $ref: '#/components/headers/X-Request-ID' - operationId: deleteTag /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions: get: operationId: getDeployedContractAbi