Skip to content

Update TransactionsApi.md #144

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update TransactionsApi.md #144

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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 0 additions & 66 deletions docs/apis/TransactionsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -692,72 +692,6 @@ No authorization required

[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)

# **setConfirmationThresholdByTransactionHash**
> SetConfirmationsThresholdResponse setConfirmationThresholdByTransactionHash()

Overrides the required number of confirmations for transaction completion by transaction hash.

### Example


```typescript
import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TransactionsApiSetConfirmationThresholdByTransactionHashRequest, SetConfirmationsThresholdResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TransactionsApiSetConfirmationThresholdByTransactionHashRequest = {
// string | The TxHash
txHash: txHash_example,
// SetConfirmationsThresholdRequest (optional)
setConfirmationsThresholdRequest: param_value,
// 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)
idempotencyKey: idempotencyKey_example,
};

fireblocks.transactions.setConfirmationThresholdByTransactionHash(body).then((res: FireblocksResponse<SetConfirmationsThresholdResponse>) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));
```


### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**setConfirmationsThresholdRequest** | **[SetConfirmationsThresholdRequest](../models/SetConfirmationsThresholdRequest.md)**| |
**txHash** | [**string**] | The TxHash | 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


### Return type

**[SetConfirmationsThresholdResponse](../models/SetConfirmationsThresholdResponse.md)**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | A list of transactions affected by the change | * X-Request-ID - <br> |
**0** | Error Response | * X-Request-ID - <br> |

[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)

# **setTransactionConfirmationThreshold**
> SetConfirmationsThresholdResponse setTransactionConfirmationThreshold()

Expand Down