|
| 1 | +# |
| 2 | + |
| 3 | +<!-- Start SDK Installation --> |
| 4 | +## SDK Installation |
| 5 | + |
| 6 | +```bash |
| 7 | +pip install |
| 8 | +``` |
| 9 | +<!-- End SDK Installation --> |
| 10 | + |
| 11 | +## SDK Example Usage |
| 12 | +<!-- Start SDK Example Usage --> |
| 13 | +```python |
| 14 | +import sdk |
| 15 | +from sdk.models import operations, shared |
| 16 | + |
| 17 | +s = sdk.SDK() |
| 18 | +s.config_security( |
| 19 | + security=shared.Security( |
| 20 | + authorization=shared.SchemeAuthorization( |
| 21 | + authorization="Bearer YOUR_ACCESS_TOKEN_HERE", |
| 22 | + ), |
| 23 | + ) |
| 24 | +) |
| 25 | + |
| 26 | +res = s.get_server_info() |
| 27 | + |
| 28 | +if res.server_info is not None: |
| 29 | + # handle response |
| 30 | +``` |
| 31 | +<!-- End SDK Example Usage --> |
| 32 | + |
| 33 | +<!-- Start SDK Available Operations --> |
| 34 | +## SDK Available Operations |
| 35 | + |
| 36 | +### SDK SDK |
| 37 | + |
| 38 | +* `get_server_info` - Get server info |
| 39 | +* `paymentsget_server_info` - Get server info |
| 40 | +* `searchget_server_info` - Get server info |
| 41 | + |
| 42 | +### accounts |
| 43 | + |
| 44 | +* `add_metadata_to_account` - Add metadata to an account |
| 45 | +* `count_accounts` - Count the accounts from a ledger |
| 46 | +* `get_account` - Get account by its address |
| 47 | +* `list_accounts` - List accounts from a ledger |
| 48 | + |
| 49 | +### balances |
| 50 | + |
| 51 | +* `get_balances` - Get the balances from a ledger's account |
| 52 | +* `get_balances_aggregated` - Get the aggregated balances from selected accounts |
| 53 | + |
| 54 | +### clients |
| 55 | + |
| 56 | +* `add_scope_to_client` - Add scope to client |
| 57 | +* `create_client` - Create client |
| 58 | +* `create_secret` - Add a secret to a client |
| 59 | +* `delete_client` - Delete client |
| 60 | +* `delete_scope_from_client` - Delete scope from client |
| 61 | +* `delete_secret` - Delete a secret from a client |
| 62 | +* `list_clients` - List clients |
| 63 | +* `read_client` - Read client |
| 64 | +* `update_client` - Update client |
| 65 | + |
| 66 | +### ledger |
| 67 | + |
| 68 | +* `get_ledger_info` - Get information about a ledger |
| 69 | + |
| 70 | +### logs |
| 71 | + |
| 72 | +* `list_logs` - List the logs from a ledger |
| 73 | + |
| 74 | +### mapping |
| 75 | + |
| 76 | +* `get_mapping` - Get the mapping of a ledger |
| 77 | +* `update_mapping` - Update the mapping of a ledger |
| 78 | + |
| 79 | +### orchestration |
| 80 | + |
| 81 | +* `create_workflow` - Create workflow |
| 82 | +* `get_flow` - Get a flow by id |
| 83 | +* `get_workflow_occurrence` - Get a workflow occurrence by id |
| 84 | +* `list_flows` - List registered flows |
| 85 | +* `list_runs` - List occurrences of a workflow |
| 86 | +* `orchestrationget_server_info` - Get server info |
| 87 | +* `run_workflow` - Run workflow |
| 88 | + |
| 89 | +### payments |
| 90 | + |
| 91 | +* `connectors_stripe_transfer` - Transfer funds between Stripe accounts |
| 92 | +* `get_connector_task` - Read a specific task of the connector |
| 93 | +* `get_payment` - Get a payment |
| 94 | +* `install_connector` - Install a connector |
| 95 | +* `list_all_connectors` - List all installed connectors |
| 96 | +* `list_configs_available_connectors` - List the configs of each available connector |
| 97 | +* `list_connector_tasks` - List tasks from a connector |
| 98 | +* `list_payments` - List payments |
| 99 | +* `paymentslist_accounts` - List accounts |
| 100 | +* `read_connector_config` - Read the config of a connector |
| 101 | +* `reset_connector` - Reset a connector |
| 102 | +* `uninstall_connector` - Uninstall a connector |
| 103 | + |
| 104 | +### scopes |
| 105 | + |
| 106 | +* `add_transient_scope` - Add a transient scope to a scope |
| 107 | +* `create_scope` - Create scope |
| 108 | +* `delete_scope` - Delete scope |
| 109 | +* `delete_transient_scope` - Delete a transient scope from a scope |
| 110 | +* `list_scopes` - List scopes |
| 111 | +* `read_scope` - Read scope |
| 112 | +* `update_scope` - Update scope |
| 113 | + |
| 114 | +### script |
| 115 | + |
| 116 | +* `run_script` - Execute a Numscript |
| 117 | + |
| 118 | +### search |
| 119 | + |
| 120 | +* `search` - Search |
| 121 | + |
| 122 | +### server |
| 123 | + |
| 124 | +* `get_info` - Show server information |
| 125 | + |
| 126 | +### stats |
| 127 | + |
| 128 | +* `read_stats` - Get statistics from a ledger |
| 129 | + |
| 130 | +### transactions |
| 131 | + |
| 132 | +* `create_transactions` - Create a new batch of transactions to a ledger |
| 133 | +* `add_metadata_on_transaction` - Set the metadata of a transaction by its ID |
| 134 | +* `count_transactions` - Count the transactions from a ledger |
| 135 | +* `create_transaction` - Create a new transaction to a ledger |
| 136 | +* `get_transaction` - Get transaction from a ledger by its ID |
| 137 | +* `list_transactions` - List transactions from a ledger |
| 138 | +* `revert_transaction` - Revert a ledger transaction by its ID |
| 139 | + |
| 140 | +### users |
| 141 | + |
| 142 | +* `list_users` - List users |
| 143 | +* `read_user` - Read user |
| 144 | + |
| 145 | +### wallets |
| 146 | + |
| 147 | +* `confirm_hold` - Confirm a hold |
| 148 | +* `create_balance` - Create a balance |
| 149 | +* `create_wallet` - Create a new wallet |
| 150 | +* `credit_wallet` - Credit a wallet |
| 151 | +* `debit_wallet` - Debit a wallet |
| 152 | +* `get_balance` - Get detailed balance |
| 153 | +* `get_hold` - Get a hold |
| 154 | +* `get_holds` - Get all holds for a wallet |
| 155 | +* `get_transactions` |
| 156 | +* `get_wallet` - Get a wallet |
| 157 | +* `list_balances` - List balances of a wallet |
| 158 | +* `list_wallets` - List all wallets |
| 159 | +* `update_wallet` - Update a wallet |
| 160 | +* `void_hold` - Cancel a hold |
| 161 | +* `walletsget_server_info` - Get server info |
| 162 | + |
| 163 | +### webhooks |
| 164 | + |
| 165 | +* `activate_config` - Activate one config |
| 166 | +* `change_config_secret` - Change the signing secret of a config |
| 167 | +* `deactivate_config` - Deactivate one config |
| 168 | +* `delete_config` - Delete one config |
| 169 | +* `get_many_configs` - Get many configs |
| 170 | +* `insert_config` - Insert a new config |
| 171 | +* `test_config` - Test one config |
| 172 | +<!-- End SDK Available Operations --> |
| 173 | + |
| 174 | +### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks) |
0 commit comments