fortispay-typescript-sdk 1.0.4 → 1.0.5

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.
Files changed (2) hide show
  1. package/README.md +58 -58
  2. 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 fortispay-typescript-sdk@1.0.4
9
+ npm install fortispay-typescript-sdk@1.0.5
10
10
  ```
11
11
 
12
- For additional package details, see the [Npm page for the fortispay-typescript-sdk@1.0.4 npm](https://www.npmjs.com/package/fortispay-typescript-sdk/v/1.0.4).
12
+ For additional package details, see the [Npm page for the fortispay-typescript-sdk@1.0.5 npm](https://www.npmjs.com/package/fortispay-typescript-sdk/v/1.0.5).
13
13
 
14
14
  ## Test the SDK
15
15
 
@@ -29,20 +29,20 @@ 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/fortispay/typescriptsdk/tree/1.0.4/doc/client.md)
32
+ **_Note:_** Documentation for the client can be found [here.](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/client.md)
33
33
 
34
34
  The following parameters are configurable for the API Client:
35
35
 
36
36
  | Parameter | Type | Description |
37
37
  | --- | --- | --- |
38
- | environment | [`Environment`](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/README.md#environments) | The API environment. <br> **Default: `Environment.Sandbox`** |
38
+ | environment | [`Environment`](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/README.md#environments) | The API environment. <br> **Default: `Environment.Sandbox`** |
39
39
  | timeout | `number` | Timeout for API calls.<br>*Default*: `0` |
40
- | httpClientOptions | [`Partial<HttpClientOptions>`](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/http-client-options.md) | Stable configurable http client options. |
40
+ | httpClientOptions | [`Partial<HttpClientOptions>`](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/http-client-options.md) | Stable configurable http client options. |
41
41
  | unstableHttpClientOptions | `any` | Unstable configurable http client options. |
42
- | userIdCredentials | [`UserIdCredentials`](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/auth/custom-header-signature.md) | The credential object for userId |
43
- | userApiKeyCredentials | [`UserApiKeyCredentials`](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/auth/custom-header-signature-1.md) | The credential object for userApiKey |
44
- | developerIdCredentials | [`DeveloperIdCredentials`](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/auth/custom-header-signature-2.md) | The credential object for developerId |
45
- | accessTokenCredentials | [`AccessTokenCredentials`](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/auth/custom-header-signature-3.md) | The credential object for accessToken |
42
+ | userIdCredentials | [`UserIdCredentials`](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/auth/custom-header-signature.md) | The credential object for userId |
43
+ | userApiKeyCredentials | [`UserApiKeyCredentials`](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/auth/custom-header-signature-1.md) | The credential object for userApiKey |
44
+ | developerIdCredentials | [`DeveloperIdCredentials`](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/auth/custom-header-signature-2.md) | The credential object for developerId |
45
+ | accessTokenCredentials | [`AccessTokenCredentials`](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/auth/custom-header-signature-3.md) | The credential object for accessToken |
46
46
 
47
47
  The API client can be initialized as follows:
48
48
 
@@ -86,7 +86,7 @@ const fileContent = fs.readFileSync(absolutePath, 'utf-8');
86
86
  const client = Client.fromJsonConfig(fileContent);
87
87
  ```
88
88
 
89
- See the [Configuration-Based Client Initialization](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/configuration-based-client-initialization.md) section for details.
89
+ See the [Configuration-Based Client Initialization](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/configuration-based-client-initialization.md) section for details.
90
90
 
91
91
  ### Environment-Based Client Initialization
92
92
 
@@ -108,7 +108,7 @@ if (fs.existsSync(absolutePath)) {
108
108
  const client = Client.fromEnvironment(process.env);
109
109
  ```
110
110
 
111
- See the [Environment-Based Client Initialization](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/environment-based-client-initialization.md) section for details.
111
+ See the [Environment-Based Client Initialization](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/environment-based-client-initialization.md) section for details.
112
112
 
113
113
  ## Environments
114
114
 
@@ -125,65 +125,65 @@ The SDK can be configured to use a different environment for making API calls. A
125
125
 
126
126
  This API uses the following authentication schemes.
127
127
 
128
- * [`user-id (Custom Header Signature)`](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/auth/custom-header-signature.md)
129
- * [`user-api-key (Custom Header Signature)`](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/auth/custom-header-signature-1.md)
130
- * [`developer-id (Custom Header Signature)`](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/auth/custom-header-signature-2.md)
131
- * [`access-token (Custom Header Signature)`](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/auth/custom-header-signature-3.md)
128
+ * [`user-id (Custom Header Signature)`](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/auth/custom-header-signature.md)
129
+ * [`user-api-key (Custom Header Signature)`](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/auth/custom-header-signature-1.md)
130
+ * [`developer-id (Custom Header Signature)`](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/auth/custom-header-signature-2.md)
131
+ * [`access-token (Custom Header Signature)`](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/auth/custom-header-signature-3.md)
132
132
 
133
133
  ## List of APIs
134
134
 
135
- * [Async Processing](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/async-processing.md)
136
- * [Declined Recurring Transactions](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/declined-recurring-transactions.md)
137
- * [Device Terms](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/device-terms.md)
138
- * [Full Boarding](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/full-boarding.md)
139
- * [3 DS Authentication](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/3-ds-authentication.md)
140
- * [3 DS Transactions](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/3-ds-transactions.md)
141
- * [Merchant Deposits](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/merchant-deposits.md)
142
- * [Enterprise Link Redirect](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/enterprise-link-redirect.md)
143
- * [On Boarding](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/on-boarding.md)
144
- * [Payment Card Reader Token](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/payment-card-reader-token.md)
145
- * [Calculate Surcharge](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/calculate-surcharge.md)
146
- * [Quick Invoices](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/quick-invoices.md)
147
- * [Transaction ACH Retries](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/transaction-ach-retries.md)
148
- * [Transactions-ACH](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/transactions-ach.md)
149
- * [Transactions-Cash](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/transactions-cash.md)
150
- * [Transactions-Credit Card](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/transactions-credit-card.md)
151
- * [Transactions-EBT Card](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/transactions-ebt-card.md)
152
- * [Transactions-Read](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/transactions-read.md)
153
- * [Level 3 Data](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/level-3-data.md)
154
- * [Transactions-Updates](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/transactions-updates.md)
155
- * [Apple Pay Validate Merchant](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/apple-pay-validate-merchant.md)
156
- * [Merchant Details](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/merchant-details.md)
157
- * [Batches](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/batches.md)
158
- * [Contacts](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/contacts.md)
159
- * [Elements](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/elements.md)
160
- * [Locations](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/locations.md)
161
- * [Paylinks](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/paylinks.md)
162
- * [Recurring](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/recurring.md)
163
- * [Reports](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/reports.md)
164
- * [Signatures](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/signatures.md)
165
- * [Tags](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/tags.md)
166
- * [Terminals](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/terminals.md)
167
- * [Tickets](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/tickets.md)
168
- * [Tokens](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/tokens.md)
169
- * [Webhooks](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/controllers/webhooks.md)
135
+ * [Async Processing](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/async-processing.md)
136
+ * [Declined Recurring Transactions](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/declined-recurring-transactions.md)
137
+ * [Device Terms](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/device-terms.md)
138
+ * [Full Boarding](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/full-boarding.md)
139
+ * [3 DS Authentication](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/3-ds-authentication.md)
140
+ * [3 DS Transactions](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/3-ds-transactions.md)
141
+ * [Merchant Deposits](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/merchant-deposits.md)
142
+ * [Enterprise Link Redirect](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/enterprise-link-redirect.md)
143
+ * [On Boarding](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/on-boarding.md)
144
+ * [Payment Card Reader Token](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/payment-card-reader-token.md)
145
+ * [Calculate Surcharge](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/calculate-surcharge.md)
146
+ * [Quick Invoices](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/quick-invoices.md)
147
+ * [Transaction ACH Retries](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/transaction-ach-retries.md)
148
+ * [Transactions-ACH](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/transactions-ach.md)
149
+ * [Transactions-Cash](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/transactions-cash.md)
150
+ * [Transactions-Credit Card](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/transactions-credit-card.md)
151
+ * [Transactions-EBT Card](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/transactions-ebt-card.md)
152
+ * [Transactions-Read](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/transactions-read.md)
153
+ * [Level 3 Data](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/level-3-data.md)
154
+ * [Transactions-Updates](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/transactions-updates.md)
155
+ * [Apple Pay Validate Merchant](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/apple-pay-validate-merchant.md)
156
+ * [Merchant Details](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/merchant-details.md)
157
+ * [Batches](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/batches.md)
158
+ * [Contacts](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/contacts.md)
159
+ * [Elements](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/elements.md)
160
+ * [Locations](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/locations.md)
161
+ * [Paylinks](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/paylinks.md)
162
+ * [Recurring](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/recurring.md)
163
+ * [Reports](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/reports.md)
164
+ * [Signatures](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/signatures.md)
165
+ * [Tags](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/tags.md)
166
+ * [Terminals](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/terminals.md)
167
+ * [Tickets](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/tickets.md)
168
+ * [Tokens](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/tokens.md)
169
+ * [Webhooks](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/controllers/webhooks.md)
170
170
 
171
171
  ## SDK Infrastructure
172
172
 
173
173
  ### Configuration
174
174
 
175
- * [HttpClientOptions](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/http-client-options.md)
176
- * [RetryConfiguration](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/retry-configuration.md)
177
- * [ProxySettings](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/proxy-settings.md)
178
- * [Configuration-Based Client Initialization](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/configuration-based-client-initialization.md)
179
- * [Environment-Based Client Initialization](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/environment-based-client-initialization.md)
175
+ * [HttpClientOptions](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/http-client-options.md)
176
+ * [RetryConfiguration](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/retry-configuration.md)
177
+ * [ProxySettings](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/proxy-settings.md)
178
+ * [Configuration-Based Client Initialization](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/configuration-based-client-initialization.md)
179
+ * [Environment-Based Client Initialization](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/environment-based-client-initialization.md)
180
180
 
181
181
  ### HTTP
182
182
 
183
- * [HttpRequest](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/http-request.md)
183
+ * [HttpRequest](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/http-request.md)
184
184
 
185
185
  ### Utilities
186
186
 
187
- * [ApiResponse](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/api-response.md)
188
- * [ApiError](https://www.github.com/fortispay/typescriptsdk/tree/1.0.4/doc/api-error.md)
187
+ * [ApiResponse](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/api-response.md)
188
+ * [ApiError](https://www.github.com/fortispay/typescriptsdk/tree/1.0.5/doc/api-error.md)
189
189
 
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.0.4",
2
+ "version": "1.0.5",
3
3
  "license": "MIT",
4
4
  "sideEffects": false,
5
5
  "main": "dist/cjs/index.js",