splitit-payments-sdk 1.0.6 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -15
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,10 +6,10 @@
|
|
|
6
6
|
Run the following command from your project directory to install the package from npm:
|
|
7
7
|
|
|
8
8
|
```bash
|
|
9
|
-
npm install splitit-payments-sdk@1.0.
|
|
9
|
+
npm install splitit-payments-sdk@1.0.7
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
For additional package details, see the [Npm page for the splitit-payments-sdk@1.0.
|
|
12
|
+
For additional package details, see the [Npm page for the splitit-payments-sdk@1.0.7 npm](https://www.npmjs.com/package/splitit-payments-sdk/v/1.0.7).
|
|
13
13
|
|
|
14
14
|
## Test the SDK
|
|
15
15
|
|
|
@@ -29,7 +29,7 @@ npm run test:coverage
|
|
|
29
29
|
|
|
30
30
|
## Initialize the API Client
|
|
31
31
|
|
|
32
|
-
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.
|
|
32
|
+
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.7/doc/client.md)
|
|
33
33
|
|
|
34
34
|
The following parameters are configurable for the API Client:
|
|
35
35
|
|
|
@@ -37,10 +37,10 @@ The following parameters are configurable for the API Client:
|
|
|
37
37
|
| --- | --- | --- |
|
|
38
38
|
| environment | `Environment` | The API environment. <br> **Default: `Environment.Production`** |
|
|
39
39
|
| timeout | `number` | Timeout for API calls.<br>*Default*: `0` |
|
|
40
|
-
| httpClientOptions | [`Partial<HttpClientOptions>`](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.
|
|
40
|
+
| httpClientOptions | [`Partial<HttpClientOptions>`](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.7/doc/http-client-options.md) | Stable configurable http client options. |
|
|
41
41
|
| unstableHttpClientOptions | `any` | Unstable configurable http client options. |
|
|
42
|
-
| oAuth2SandboxCredentials | [`OAuth2SandboxCredentials`](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.
|
|
43
|
-
| oAuth2ProductionCredentials | [`OAuth2ProductionCredentials`](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.
|
|
42
|
+
| oAuth2SandboxCredentials | [`OAuth2SandboxCredentials`](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.7/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for oAuth2Sandbox |
|
|
43
|
+
| oAuth2ProductionCredentials | [`OAuth2ProductionCredentials`](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.7/doc/auth/oauth-2-client-credentials-grant-1.md) | The credential object for oAuth2Production |
|
|
44
44
|
|
|
45
45
|
The API client can be initialized as follows:
|
|
46
46
|
|
|
@@ -87,27 +87,27 @@ The SDK can be configured to use a different environment for making API calls. A
|
|
|
87
87
|
|
|
88
88
|
This API uses the following authentication schemes.
|
|
89
89
|
|
|
90
|
-
* [`OAuth2-sandbox (OAuth 2 Client Credentials Grant)`](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.
|
|
91
|
-
* [`OAuth2-production (OAuth 2 Client Credentials Grant)`](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.
|
|
90
|
+
* [`OAuth2-sandbox (OAuth 2 Client Credentials Grant)`](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.7/doc/auth/oauth-2-client-credentials-grant.md)
|
|
91
|
+
* [`OAuth2-production (OAuth 2 Client Credentials Grant)`](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.7/doc/auth/oauth-2-client-credentials-grant-1.md)
|
|
92
92
|
|
|
93
93
|
## List of APIs
|
|
94
94
|
|
|
95
|
-
* [Installment Plan](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.
|
|
95
|
+
* [Installment Plan](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.7/doc/controllers/installment-plan.md)
|
|
96
96
|
|
|
97
97
|
## SDK Infrastructure
|
|
98
98
|
|
|
99
99
|
### Configuration
|
|
100
100
|
|
|
101
|
-
* [HttpClientOptions](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.
|
|
102
|
-
* [RetryConfiguration](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.
|
|
103
|
-
* [ProxySettings](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.
|
|
101
|
+
* [HttpClientOptions](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.7/doc/http-client-options.md)
|
|
102
|
+
* [RetryConfiguration](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.7/doc/retry-configuration.md)
|
|
103
|
+
* [ProxySettings](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.7/doc/proxy-settings.md)
|
|
104
104
|
|
|
105
105
|
### HTTP
|
|
106
106
|
|
|
107
|
-
* [HttpRequest](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.
|
|
107
|
+
* [HttpRequest](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.7/doc/http-request.md)
|
|
108
108
|
|
|
109
109
|
### Utilities
|
|
110
110
|
|
|
111
|
-
* [ApiResponse](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.
|
|
112
|
-
* [ApiError](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.
|
|
111
|
+
* [ApiResponse](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.7/doc/api-response.md)
|
|
112
|
+
* [ApiError](https://www.github.com/Splitit/TypeScript-SDK/tree/1.0.7/doc/api-error.md)
|
|
113
113
|
|
package/package.json
CHANGED