You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-7Lines changed: 12 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -313,7 +313,6 @@ run();
313
313
*[getBankAccount](docs/sdks/v3/README.md#getbankaccount) - Get a Bank Account by ID
314
314
*[getConnectorConfig](docs/sdks/v3/README.md#getconnectorconfig) - Get a connector configuration by ID
315
315
*[getConnectorSchedule](docs/sdks/v3/README.md#getconnectorschedule) - Get a connector schedule by ID
316
-
*[getInfo](docs/sdks/v3/README.md#getinfo) - Show server information
317
316
*[getPayment](docs/sdks/v3/README.md#getpayment) - Get a payment by ID
318
317
*[getPaymentInitiation](docs/sdks/v3/README.md#getpaymentinitiation) - Get a payment initiation by ID
319
318
*[getPool](docs/sdks/v3/README.md#getpool) - Get a pool by ID
@@ -493,12 +492,17 @@ In some rare cases, the SDK can fail to get a response from the server or even m
493
492
494
493
You can override the default server globally by passing a server index to the `serverIdx: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
|`environment`|`environment: models.ServerEnvironment`| - `"eu.sandbox"`<br/>- `"sandbox"`<br/>- `"eu-west-1"`<br/>- `"us-east-1"`|`"eu.sandbox"`| The environment name. Defaults to the production environment. |
505
+
|`organization`|`organization: string`| string |`"orgID-stackID"`| The organization name. Defaults to a generic organization. |
502
506
503
507
#### Example
504
508
@@ -507,6 +511,8 @@ import { SDK } from "@formance/formance-sdk";
507
511
508
512
const sdk =newSDK({
509
513
serverIdx: 1,
514
+
environment: "us-east-1",
515
+
organization: "<value>",
510
516
security: {
511
517
clientID: "<YOUR_CLIENT_ID_HERE>",
512
518
clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
@@ -796,7 +802,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
796
802
-[`paymentsV3GetBankAccount`](docs/sdks/v3/README.md#getbankaccount) - Get a Bank Account by ID
797
803
-[`paymentsV3GetConnectorConfig`](docs/sdks/v3/README.md#getconnectorconfig) - Get a connector configuration by ID
798
804
-[`paymentsV3GetConnectorSchedule`](docs/sdks/v3/README.md#getconnectorschedule) - Get a connector schedule by ID
799
-
-[`paymentsV3GetInfo`](docs/sdks/v3/README.md#getinfo) - Show server information
800
805
-[`paymentsV3GetPayment`](docs/sdks/v3/README.md#getpayment) - Get a payment by ID
801
806
-[`paymentsV3GetPaymentInitiation`](docs/sdks/v3/README.md#getpaymentinitiation) - Get a payment initiation by ID
802
807
-[`paymentsV3GetPool`](docs/sdks/v3/README.md#getpool) - Get a pool by ID
0 commit comments