@enfuce/nextgen-sdk 0.0.1 → 0.0.2
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
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# @enfuce/nextgen-sdk
|
|
2
|
+
|
|
3
|
+
Enfuce nextgen client SDK for TypeScript. One namespaced export per API, so
|
|
4
|
+
identically-named schemas across APIs never collide. Ships both CommonJS and ESM builds.
|
|
5
|
+
|
|
6
|
+
## Installation
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
npm install @enfuce/nextgen-sdk
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Usage
|
|
13
|
+
|
|
14
|
+
Each API is exposed under its own namespace:
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { card } from '@enfuce/nextgen-sdk';
|
|
18
|
+
|
|
19
|
+
const config = new card.Configuration({ basePath: 'https://api.example.com' });
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Available APIs
|
|
23
|
+
|
|
24
|
+
- `oauth` — OAuth2 `client_credentials` token-management helper
|
|
25
|
+
- `card`
|
|
26
|
+
- `wallet`
|
|
27
|
+
- `cardholder`
|
|
28
|
+
- `pin`
|
|
29
|
+
- `issuerEvents`
|
|
30
|
+
- `authorisationControl`
|
|
31
|
+
- `cards`
|
|
32
|
+
- `threeds`
|
|
33
|
+
- `threedsOob`
|
|
34
|
+
- `clearingFileCopy`
|
|
35
|
+
- `transactionEvent`
|
|
36
|
+
|
|
37
|
+
## Requirements
|
|
38
|
+
|
|
39
|
+
- Node.js `>=18`
|
|
40
|
+
- TypeScript `^4.0 || ^5.0` (works in Node and the browser)
|
|
41
|
+
|
|
42
|
+
## License
|
|
43
|
+
|
|
44
|
+
MIT
|
|
@@ -412,7 +412,7 @@ export interface MerchantCategory {
|
|
|
412
412
|
'group'?: string;
|
|
413
413
|
}
|
|
414
414
|
/**
|
|
415
|
-
* Message category sent in the transaction event webhook. Possible enums: - INITIAL_AUTHORIZATION: Initial authorisation of the card payment. - INCREMENTAL_AUTHORIZATION: Additional authorisation for a previously authorised transaction. - DECLINED_AUTHORIZATION: Scheme declined the transaction on behalf of Enfuce in the STIP mode. - ADJUSTMENT: Corrections to a previously authorised transaction. - REVERSAL: Reversal of a previously authorised transaction. - BALANCE_INQUIRY: Enquiring about the current balance of the funding account from the external application. - PIN_MANAGEMENT: Request to change the card PIN. - PIN_MANAGEMENT_REVERSAL: Reversal of a pin change request. - FINANCIAL: Clearing message of batch payments. - PURGE_AUTHORIZATION: Excluded authorisations are purged after a specific period. - VOID_AUTHORIZATION: When an initial authorisation or an incremental authorisation request times out, a `VOID_AUTHORIZATION` message is generated.
|
|
415
|
+
* Message category sent in the transaction event webhook. Possible enums: - INITIAL_AUTHORIZATION: Initial authorisation of the card payment. - INCREMENTAL_AUTHORIZATION: Additional authorisation for a previously authorised transaction. - DECLINED_AUTHORIZATION: Scheme declined the transaction on behalf of Enfuce in the STIP mode. - ADJUSTMENT: Corrections to a previously authorised transaction. - REVERSAL: Reversal of a previously authorised transaction. - BALANCE_INQUIRY: Enquiring about the current balance of the funding account from the external application. - PIN_MANAGEMENT: Request to change the card PIN. - PIN_MANAGEMENT_REVERSAL: Reversal of a pin change request. - FINANCIAL: Clearing message of batch payments. - PURGE_AUTHORIZATION: Excluded authorisations are purged after a specific period. - VOID_AUTHORIZATION: When an initial authorisation or an incremental authorisation request times out, a `VOID_AUTHORIZATION` message is generated. - ACCOUNT_STATUS_INQUIRY: When an account status is requested.
|
|
416
416
|
* @export
|
|
417
417
|
* @enum {string}
|
|
418
418
|
*/
|
|
@@ -436,6 +436,7 @@ export declare const MessageCategoryTransactionEvent: {
|
|
|
436
436
|
readonly Representment: "REPRESENTMENT";
|
|
437
437
|
readonly RepresentmentReversal: "REPRESENTMENT_REVERSAL";
|
|
438
438
|
readonly DocumentRequest: "DOCUMENT_REQUEST";
|
|
439
|
+
readonly AccountStatusInquiry: "ACCOUNT_STATUS_INQUIRY";
|
|
439
440
|
};
|
|
440
441
|
export type MessageCategoryTransactionEvent = typeof MessageCategoryTransactionEvent[keyof typeof MessageCategoryTransactionEvent];
|
|
441
442
|
/**
|
|
@@ -65,7 +65,7 @@ export const InterchangeFeeDirection = {
|
|
|
65
65
|
Unknown: 'UNKNOWN'
|
|
66
66
|
};
|
|
67
67
|
/**
|
|
68
|
-
* Message category sent in the transaction event webhook. Possible enums: - INITIAL_AUTHORIZATION: Initial authorisation of the card payment. - INCREMENTAL_AUTHORIZATION: Additional authorisation for a previously authorised transaction. - DECLINED_AUTHORIZATION: Scheme declined the transaction on behalf of Enfuce in the STIP mode. - ADJUSTMENT: Corrections to a previously authorised transaction. - REVERSAL: Reversal of a previously authorised transaction. - BALANCE_INQUIRY: Enquiring about the current balance of the funding account from the external application. - PIN_MANAGEMENT: Request to change the card PIN. - PIN_MANAGEMENT_REVERSAL: Reversal of a pin change request. - FINANCIAL: Clearing message of batch payments. - PURGE_AUTHORIZATION: Excluded authorisations are purged after a specific period. - VOID_AUTHORIZATION: When an initial authorisation or an incremental authorisation request times out, a `VOID_AUTHORIZATION` message is generated.
|
|
68
|
+
* Message category sent in the transaction event webhook. Possible enums: - INITIAL_AUTHORIZATION: Initial authorisation of the card payment. - INCREMENTAL_AUTHORIZATION: Additional authorisation for a previously authorised transaction. - DECLINED_AUTHORIZATION: Scheme declined the transaction on behalf of Enfuce in the STIP mode. - ADJUSTMENT: Corrections to a previously authorised transaction. - REVERSAL: Reversal of a previously authorised transaction. - BALANCE_INQUIRY: Enquiring about the current balance of the funding account from the external application. - PIN_MANAGEMENT: Request to change the card PIN. - PIN_MANAGEMENT_REVERSAL: Reversal of a pin change request. - FINANCIAL: Clearing message of batch payments. - PURGE_AUTHORIZATION: Excluded authorisations are purged after a specific period. - VOID_AUTHORIZATION: When an initial authorisation or an incremental authorisation request times out, a `VOID_AUTHORIZATION` message is generated. - ACCOUNT_STATUS_INQUIRY: When an account status is requested.
|
|
69
69
|
* @export
|
|
70
70
|
* @enum {string}
|
|
71
71
|
*/
|
|
@@ -88,7 +88,8 @@ export const MessageCategoryTransactionEvent = {
|
|
|
88
88
|
ChargebackReversal: 'CHARGEBACK_REVERSAL',
|
|
89
89
|
Representment: 'REPRESENTMENT',
|
|
90
90
|
RepresentmentReversal: 'REPRESENTMENT_REVERSAL',
|
|
91
|
-
DocumentRequest: 'DOCUMENT_REQUEST'
|
|
91
|
+
DocumentRequest: 'DOCUMENT_REQUEST',
|
|
92
|
+
AccountStatusInquiry: 'ACCOUNT_STATUS_INQUIRY'
|
|
92
93
|
};
|
|
93
94
|
/**
|
|
94
95
|
* Identifies the message function of the transaction event.
|
|
@@ -412,7 +412,7 @@ export interface MerchantCategory {
|
|
|
412
412
|
'group'?: string;
|
|
413
413
|
}
|
|
414
414
|
/**
|
|
415
|
-
* Message category sent in the transaction event webhook. Possible enums: - INITIAL_AUTHORIZATION: Initial authorisation of the card payment. - INCREMENTAL_AUTHORIZATION: Additional authorisation for a previously authorised transaction. - DECLINED_AUTHORIZATION: Scheme declined the transaction on behalf of Enfuce in the STIP mode. - ADJUSTMENT: Corrections to a previously authorised transaction. - REVERSAL: Reversal of a previously authorised transaction. - BALANCE_INQUIRY: Enquiring about the current balance of the funding account from the external application. - PIN_MANAGEMENT: Request to change the card PIN. - PIN_MANAGEMENT_REVERSAL: Reversal of a pin change request. - FINANCIAL: Clearing message of batch payments. - PURGE_AUTHORIZATION: Excluded authorisations are purged after a specific period. - VOID_AUTHORIZATION: When an initial authorisation or an incremental authorisation request times out, a `VOID_AUTHORIZATION` message is generated.
|
|
415
|
+
* Message category sent in the transaction event webhook. Possible enums: - INITIAL_AUTHORIZATION: Initial authorisation of the card payment. - INCREMENTAL_AUTHORIZATION: Additional authorisation for a previously authorised transaction. - DECLINED_AUTHORIZATION: Scheme declined the transaction on behalf of Enfuce in the STIP mode. - ADJUSTMENT: Corrections to a previously authorised transaction. - REVERSAL: Reversal of a previously authorised transaction. - BALANCE_INQUIRY: Enquiring about the current balance of the funding account from the external application. - PIN_MANAGEMENT: Request to change the card PIN. - PIN_MANAGEMENT_REVERSAL: Reversal of a pin change request. - FINANCIAL: Clearing message of batch payments. - PURGE_AUTHORIZATION: Excluded authorisations are purged after a specific period. - VOID_AUTHORIZATION: When an initial authorisation or an incremental authorisation request times out, a `VOID_AUTHORIZATION` message is generated. - ACCOUNT_STATUS_INQUIRY: When an account status is requested.
|
|
416
416
|
* @export
|
|
417
417
|
* @enum {string}
|
|
418
418
|
*/
|
|
@@ -436,6 +436,7 @@ export declare const MessageCategoryTransactionEvent: {
|
|
|
436
436
|
readonly Representment: "REPRESENTMENT";
|
|
437
437
|
readonly RepresentmentReversal: "REPRESENTMENT_REVERSAL";
|
|
438
438
|
readonly DocumentRequest: "DOCUMENT_REQUEST";
|
|
439
|
+
readonly AccountStatusInquiry: "ACCOUNT_STATUS_INQUIRY";
|
|
439
440
|
};
|
|
440
441
|
export type MessageCategoryTransactionEvent = typeof MessageCategoryTransactionEvent[keyof typeof MessageCategoryTransactionEvent];
|
|
441
442
|
/**
|
|
@@ -68,7 +68,7 @@ exports.InterchangeFeeDirection = {
|
|
|
68
68
|
Unknown: 'UNKNOWN'
|
|
69
69
|
};
|
|
70
70
|
/**
|
|
71
|
-
* Message category sent in the transaction event webhook. Possible enums: - INITIAL_AUTHORIZATION: Initial authorisation of the card payment. - INCREMENTAL_AUTHORIZATION: Additional authorisation for a previously authorised transaction. - DECLINED_AUTHORIZATION: Scheme declined the transaction on behalf of Enfuce in the STIP mode. - ADJUSTMENT: Corrections to a previously authorised transaction. - REVERSAL: Reversal of a previously authorised transaction. - BALANCE_INQUIRY: Enquiring about the current balance of the funding account from the external application. - PIN_MANAGEMENT: Request to change the card PIN. - PIN_MANAGEMENT_REVERSAL: Reversal of a pin change request. - FINANCIAL: Clearing message of batch payments. - PURGE_AUTHORIZATION: Excluded authorisations are purged after a specific period. - VOID_AUTHORIZATION: When an initial authorisation or an incremental authorisation request times out, a `VOID_AUTHORIZATION` message is generated.
|
|
71
|
+
* Message category sent in the transaction event webhook. Possible enums: - INITIAL_AUTHORIZATION: Initial authorisation of the card payment. - INCREMENTAL_AUTHORIZATION: Additional authorisation for a previously authorised transaction. - DECLINED_AUTHORIZATION: Scheme declined the transaction on behalf of Enfuce in the STIP mode. - ADJUSTMENT: Corrections to a previously authorised transaction. - REVERSAL: Reversal of a previously authorised transaction. - BALANCE_INQUIRY: Enquiring about the current balance of the funding account from the external application. - PIN_MANAGEMENT: Request to change the card PIN. - PIN_MANAGEMENT_REVERSAL: Reversal of a pin change request. - FINANCIAL: Clearing message of batch payments. - PURGE_AUTHORIZATION: Excluded authorisations are purged after a specific period. - VOID_AUTHORIZATION: When an initial authorisation or an incremental authorisation request times out, a `VOID_AUTHORIZATION` message is generated. - ACCOUNT_STATUS_INQUIRY: When an account status is requested.
|
|
72
72
|
* @export
|
|
73
73
|
* @enum {string}
|
|
74
74
|
*/
|
|
@@ -91,7 +91,8 @@ exports.MessageCategoryTransactionEvent = {
|
|
|
91
91
|
ChargebackReversal: 'CHARGEBACK_REVERSAL',
|
|
92
92
|
Representment: 'REPRESENTMENT',
|
|
93
93
|
RepresentmentReversal: 'REPRESENTMENT_REVERSAL',
|
|
94
|
-
DocumentRequest: 'DOCUMENT_REQUEST'
|
|
94
|
+
DocumentRequest: 'DOCUMENT_REQUEST',
|
|
95
|
+
AccountStatusInquiry: 'ACCOUNT_STATUS_INQUIRY'
|
|
95
96
|
};
|
|
96
97
|
/**
|
|
97
98
|
* Identifies the message function of the transaction event.
|
package/package.json
CHANGED
|
@@ -1,11 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@enfuce/nextgen-sdk",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.2",
|
|
4
4
|
"description": "Enfuce nextgen client SDK (TypeScript). One namespaced export per API.",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public"
|
|
7
7
|
},
|
|
8
8
|
"license": "MIT",
|
|
9
|
+
"engines": {
|
|
10
|
+
"node": ">=18"
|
|
11
|
+
},
|
|
9
12
|
"main": "./dist/index.js",
|
|
10
13
|
"typings": "./dist/index.d.ts",
|
|
11
14
|
"module": "./dist/esm/index.js",
|
|
@@ -449,7 +449,7 @@ export interface MerchantCategory {
|
|
|
449
449
|
'group'?: string;
|
|
450
450
|
}
|
|
451
451
|
/**
|
|
452
|
-
* Message category sent in the transaction event webhook. Possible enums: - INITIAL_AUTHORIZATION: Initial authorisation of the card payment. - INCREMENTAL_AUTHORIZATION: Additional authorisation for a previously authorised transaction. - DECLINED_AUTHORIZATION: Scheme declined the transaction on behalf of Enfuce in the STIP mode. - ADJUSTMENT: Corrections to a previously authorised transaction. - REVERSAL: Reversal of a previously authorised transaction. - BALANCE_INQUIRY: Enquiring about the current balance of the funding account from the external application. - PIN_MANAGEMENT: Request to change the card PIN. - PIN_MANAGEMENT_REVERSAL: Reversal of a pin change request. - FINANCIAL: Clearing message of batch payments. - PURGE_AUTHORIZATION: Excluded authorisations are purged after a specific period. - VOID_AUTHORIZATION: When an initial authorisation or an incremental authorisation request times out, a `VOID_AUTHORIZATION` message is generated.
|
|
452
|
+
* Message category sent in the transaction event webhook. Possible enums: - INITIAL_AUTHORIZATION: Initial authorisation of the card payment. - INCREMENTAL_AUTHORIZATION: Additional authorisation for a previously authorised transaction. - DECLINED_AUTHORIZATION: Scheme declined the transaction on behalf of Enfuce in the STIP mode. - ADJUSTMENT: Corrections to a previously authorised transaction. - REVERSAL: Reversal of a previously authorised transaction. - BALANCE_INQUIRY: Enquiring about the current balance of the funding account from the external application. - PIN_MANAGEMENT: Request to change the card PIN. - PIN_MANAGEMENT_REVERSAL: Reversal of a pin change request. - FINANCIAL: Clearing message of batch payments. - PURGE_AUTHORIZATION: Excluded authorisations are purged after a specific period. - VOID_AUTHORIZATION: When an initial authorisation or an incremental authorisation request times out, a `VOID_AUTHORIZATION` message is generated. - ACCOUNT_STATUS_INQUIRY: When an account status is requested.
|
|
453
453
|
* @export
|
|
454
454
|
* @enum {string}
|
|
455
455
|
*/
|
|
@@ -473,7 +473,8 @@ export const MessageCategoryTransactionEvent = {
|
|
|
473
473
|
ChargebackReversal: 'CHARGEBACK_REVERSAL',
|
|
474
474
|
Representment: 'REPRESENTMENT',
|
|
475
475
|
RepresentmentReversal: 'REPRESENTMENT_REVERSAL',
|
|
476
|
-
DocumentRequest: 'DOCUMENT_REQUEST'
|
|
476
|
+
DocumentRequest: 'DOCUMENT_REQUEST',
|
|
477
|
+
AccountStatusInquiry: 'ACCOUNT_STATUS_INQUIRY'
|
|
477
478
|
} as const;
|
|
478
479
|
|
|
479
480
|
export type MessageCategoryTransactionEvent = typeof MessageCategoryTransactionEvent[keyof typeof MessageCategoryTransactionEvent];
|