@naturalpay/sdk 1.2.0 → 1.2.1
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/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/customers/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/customers/client/Client.js +3 -3
- package/dist/cjs/api/resources/invitationLinks/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/invitationLinks/client/Client.js +4 -4
- package/dist/cjs/api/resources/simulations/client/Client.d.ts +9 -9
- package/dist/cjs/api/resources/simulations/client/Client.js +9 -9
- package/dist/cjs/api/resources/simulations/client/requests/AcceptCustomerInvitationSimulationsRequest.d.ts +1 -1
- package/dist/cjs/api/resources/simulations/client/requests/DeclineCustomerInvitationSimulationsRequest.d.ts +1 -1
- package/dist/cjs/api/resources/simulations/client/requests/InviteCustomerSimulationsRequest.d.ts +2 -2
- package/dist/cjs/api/resources/simulations/types/InviteCustomerSimulationsRequestType.d.ts +1 -1
- package/dist/cjs/api/resources/simulations/types/InviteCustomerSimulationsRequestType.js +1 -1
- package/dist/cjs/api/resources/simulations/types/InviteCustomerSimulationsResponse.d.ts +1 -1
- package/dist/cjs/api/resources/simulations/types/InviteCustomerSimulationsResponseMetaCustomer.d.ts +3 -3
- package/dist/cjs/api/resources/simulations/types/InviteCustomerSimulationsResponseMetaCustomerPartyType.d.ts +1 -1
- package/dist/cjs/api/resources/simulations/types/InviteCustomerSimulationsResponseMetaCustomerPartyType.js +1 -1
- package/dist/cjs/api/resources/wallets/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/wallets/client/Client.js +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/customers/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/customers/client/Client.mjs +3 -3
- package/dist/esm/api/resources/invitationLinks/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/invitationLinks/client/Client.mjs +4 -4
- package/dist/esm/api/resources/simulations/client/Client.d.mts +9 -9
- package/dist/esm/api/resources/simulations/client/Client.mjs +9 -9
- package/dist/esm/api/resources/simulations/client/requests/AcceptCustomerInvitationSimulationsRequest.d.mts +1 -1
- package/dist/esm/api/resources/simulations/client/requests/DeclineCustomerInvitationSimulationsRequest.d.mts +1 -1
- package/dist/esm/api/resources/simulations/client/requests/InviteCustomerSimulationsRequest.d.mts +2 -2
- package/dist/esm/api/resources/simulations/types/InviteCustomerSimulationsRequestType.d.mts +1 -1
- package/dist/esm/api/resources/simulations/types/InviteCustomerSimulationsRequestType.mjs +1 -1
- package/dist/esm/api/resources/simulations/types/InviteCustomerSimulationsResponse.d.mts +1 -1
- package/dist/esm/api/resources/simulations/types/InviteCustomerSimulationsResponseMetaCustomer.d.mts +3 -3
- package/dist/esm/api/resources/simulations/types/InviteCustomerSimulationsResponseMetaCustomerPartyType.d.mts +1 -1
- package/dist/esm/api/resources/simulations/types/InviteCustomerSimulationsResponseMetaCustomerPartyType.mjs +1 -1
- package/dist/esm/api/resources/wallets/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/wallets/client/Client.mjs +1 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +17 -17
package/dist/cjs/BaseClient.js
CHANGED
|
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
|
|
|
43
43
|
const headers = (0, headers_js_1.mergeHeaders)({
|
|
44
44
|
"X-Fern-Language": "JavaScript",
|
|
45
45
|
"X-Fern-SDK-Name": "@naturalpay/sdk",
|
|
46
|
-
"X-Fern-SDK-Version": "1.2.
|
|
47
|
-
"User-Agent": "@naturalpay/sdk/1.2.
|
|
46
|
+
"X-Fern-SDK-Version": "1.2.1",
|
|
47
|
+
"User-Agent": "@naturalpay/sdk/1.2.1",
|
|
48
48
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
49
49
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
50
50
|
"X-Agent-ID": options === null || options === void 0 ? void 0 : options.agentId,
|
|
@@ -67,7 +67,7 @@ export declare class CustomersClient {
|
|
|
67
67
|
get(request: Natural.GetCustomersRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<Natural.CustomerDetail>;
|
|
68
68
|
private __get;
|
|
69
69
|
/**
|
|
70
|
-
* List pending
|
|
70
|
+
* List pending invitations addressed to specific customers
|
|
71
71
|
*
|
|
72
72
|
* @param {Natural.ListInvitationsCustomersRequest} request
|
|
73
73
|
* @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -93,7 +93,7 @@ export declare class CustomersClient {
|
|
|
93
93
|
listInvitations(request?: Natural.ListInvitationsCustomersRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<Natural.ListInvitationsCustomersResponse>;
|
|
94
94
|
private __listInvitations;
|
|
95
95
|
/**
|
|
96
|
-
* Invite customers to
|
|
96
|
+
* Invite specific customers by email or phone to approve a set of your agents, each with its own permissions and limits
|
|
97
97
|
*
|
|
98
98
|
* @param {Natural.CreateInvitationsCustomersRequest} request
|
|
99
99
|
* @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -135,7 +135,7 @@ export declare class CustomersClient {
|
|
|
135
135
|
createInvitations(request: Natural.CreateInvitationsCustomersRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<Natural.CreateInvitationsCustomersResponse>;
|
|
136
136
|
private __createInvitations;
|
|
137
137
|
/**
|
|
138
|
-
* Revoke a pending customer
|
|
138
|
+
* Revoke a pending invitation addressed to a specific customer, so it can no longer be accepted
|
|
139
139
|
*
|
|
140
140
|
* @param {Natural.RevokeInvitationCustomersRequest} request
|
|
141
141
|
* @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -280,7 +280,7 @@ class CustomersClient {
|
|
|
280
280
|
});
|
|
281
281
|
}
|
|
282
282
|
/**
|
|
283
|
-
* List pending
|
|
283
|
+
* List pending invitations addressed to specific customers
|
|
284
284
|
*
|
|
285
285
|
* @param {Natural.ListInvitationsCustomersRequest} request
|
|
286
286
|
* @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -384,7 +384,7 @@ class CustomersClient {
|
|
|
384
384
|
});
|
|
385
385
|
}
|
|
386
386
|
/**
|
|
387
|
-
* Invite customers to
|
|
387
|
+
* Invite specific customers by email or phone to approve a set of your agents, each with its own permissions and limits
|
|
388
388
|
*
|
|
389
389
|
* @param {Natural.CreateInvitationsCustomersRequest} request
|
|
390
390
|
* @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -501,7 +501,7 @@ class CustomersClient {
|
|
|
501
501
|
});
|
|
502
502
|
}
|
|
503
503
|
/**
|
|
504
|
-
* Revoke a pending customer
|
|
504
|
+
* Revoke a pending invitation addressed to a specific customer, so it can no longer be accepted
|
|
505
505
|
*
|
|
506
506
|
* @param {Natural.RevokeInvitationCustomersRequest} request
|
|
507
507
|
* @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -14,7 +14,7 @@ export declare class InvitationLinksClient {
|
|
|
14
14
|
protected readonly _options: NormalizedClientOptionsWithAuth<InvitationLinksClient.Options>;
|
|
15
15
|
constructor(options?: InvitationLinksClient.Options);
|
|
16
16
|
/**
|
|
17
|
-
* List the invitation links
|
|
17
|
+
* List the invitation links you have created, with masked tokens
|
|
18
18
|
*
|
|
19
19
|
* @param {Natural.ListInvitationLinksRequest} request
|
|
20
20
|
* @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -40,7 +40,7 @@ export declare class InvitationLinksClient {
|
|
|
40
40
|
list(request?: Natural.ListInvitationLinksRequest, requestOptions?: InvitationLinksClient.RequestOptions): core.HttpResponsePromise<Natural.ListInvitationLinksResponse>;
|
|
41
41
|
private __list;
|
|
42
42
|
/**
|
|
43
|
-
* Create a shareable link
|
|
43
|
+
* Create a shareable link offering your agents, with the permissions and limits you set, to any customer who opens it
|
|
44
44
|
*
|
|
45
45
|
* @param {Natural.CreateInvitationLinksRequest} request
|
|
46
46
|
* @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -75,7 +75,7 @@ export declare class InvitationLinksClient {
|
|
|
75
75
|
create(request: Natural.CreateInvitationLinksRequest, requestOptions?: InvitationLinksClient.RequestOptions): core.HttpResponsePromise<Natural.CreateInvitationLinksResponse>;
|
|
76
76
|
private __create;
|
|
77
77
|
/**
|
|
78
|
-
* Get an invitation link
|
|
78
|
+
* Get an invitation link and its offered agents, with a masked token
|
|
79
79
|
*
|
|
80
80
|
* @param {Natural.GetInvitationLinksRequest} request
|
|
81
81
|
* @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -103,7 +103,7 @@ export declare class InvitationLinksClient {
|
|
|
103
103
|
get(request: Natural.GetInvitationLinksRequest, requestOptions?: InvitationLinksClient.RequestOptions): core.HttpResponsePromise<Natural.GetInvitationLinksResponse>;
|
|
104
104
|
private __get;
|
|
105
105
|
/**
|
|
106
|
-
*
|
|
106
|
+
* Revoke an invitation link so it stops connecting new customers
|
|
107
107
|
*
|
|
108
108
|
* @param {Natural.RevokeInvitationLinksRequest} request
|
|
109
109
|
* @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -61,7 +61,7 @@ class InvitationLinksClient {
|
|
|
61
61
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
62
62
|
}
|
|
63
63
|
/**
|
|
64
|
-
* List the invitation links
|
|
64
|
+
* List the invitation links you have created, with masked tokens
|
|
65
65
|
*
|
|
66
66
|
* @param {Natural.ListInvitationLinksRequest} request
|
|
67
67
|
* @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -171,7 +171,7 @@ class InvitationLinksClient {
|
|
|
171
171
|
});
|
|
172
172
|
}
|
|
173
173
|
/**
|
|
174
|
-
* Create a shareable link
|
|
174
|
+
* Create a shareable link offering your agents, with the permissions and limits you set, to any customer who opens it
|
|
175
175
|
*
|
|
176
176
|
* @param {Natural.CreateInvitationLinksRequest} request
|
|
177
177
|
* @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -281,7 +281,7 @@ class InvitationLinksClient {
|
|
|
281
281
|
});
|
|
282
282
|
}
|
|
283
283
|
/**
|
|
284
|
-
* Get an invitation link
|
|
284
|
+
* Get an invitation link and its offered agents, with a masked token
|
|
285
285
|
*
|
|
286
286
|
* @param {Natural.GetInvitationLinksRequest} request
|
|
287
287
|
* @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -379,7 +379,7 @@ class InvitationLinksClient {
|
|
|
379
379
|
});
|
|
380
380
|
}
|
|
381
381
|
/**
|
|
382
|
-
*
|
|
382
|
+
* Revoke an invitation link so it stops connecting new customers
|
|
383
383
|
*
|
|
384
384
|
* @param {Natural.RevokeInvitationLinksRequest} request
|
|
385
385
|
* @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -14,7 +14,7 @@ export declare class SimulationsClient {
|
|
|
14
14
|
protected readonly _options: NormalizedClientOptionsWithAuth<SimulationsClient.Options>;
|
|
15
15
|
constructor(options?: SimulationsClient.Options);
|
|
16
16
|
/**
|
|
17
|
-
* Create a
|
|
17
|
+
* Create a test customer and a pending invitation for each agent you name
|
|
18
18
|
*
|
|
19
19
|
* @param {Natural.InviteCustomerSimulationsRequest} request
|
|
20
20
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -44,7 +44,7 @@ export declare class SimulationsClient {
|
|
|
44
44
|
inviteCustomer(request: Natural.InviteCustomerSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.InviteCustomerSimulationsResponse>;
|
|
45
45
|
private __inviteCustomer;
|
|
46
46
|
/**
|
|
47
|
-
* Add test funds to a connected customer's wallet
|
|
47
|
+
* Add test funds to a connected customer's wallet
|
|
48
48
|
*
|
|
49
49
|
* @param {Natural.FundCustomerSimulationsRequest} request
|
|
50
50
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -76,7 +76,7 @@ export declare class SimulationsClient {
|
|
|
76
76
|
fundCustomer(request: Natural.FundCustomerSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.FundCustomerSimulationsResponse>;
|
|
77
77
|
private __fundCustomer;
|
|
78
78
|
/**
|
|
79
|
-
* Link a test bank account to your own party
|
|
79
|
+
* Link a test bank account to your own party
|
|
80
80
|
*
|
|
81
81
|
* @param {Natural.LinkExternalAccountSimulationsRequest} request
|
|
82
82
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -104,7 +104,7 @@ export declare class SimulationsClient {
|
|
|
104
104
|
linkExternalAccount(request: Natural.LinkExternalAccountSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.LinkExternalAccountSimulationsResponse>;
|
|
105
105
|
private __linkExternalAccount;
|
|
106
106
|
/**
|
|
107
|
-
* Simulate the recipient of a held payment joining and receiving the funds
|
|
107
|
+
* Simulate the recipient of a held payment joining Natural and receiving the funds
|
|
108
108
|
*
|
|
109
109
|
* @param {Natural.CompletePaymentClaimSimulationsRequest} request
|
|
110
110
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -133,7 +133,7 @@ export declare class SimulationsClient {
|
|
|
133
133
|
completePaymentClaim(request: Natural.CompletePaymentClaimSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.CompletePaymentClaimSimulationsResponse>;
|
|
134
134
|
private __completePaymentClaim;
|
|
135
135
|
/**
|
|
136
|
-
*
|
|
136
|
+
* Fulfill an open payment request addressed to your test payer
|
|
137
137
|
*
|
|
138
138
|
* @param {Natural.FulfillPaymentRequestSimulationsRequest} request
|
|
139
139
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -163,7 +163,7 @@ export declare class SimulationsClient {
|
|
|
163
163
|
fulfillPaymentRequest(request: Natural.FulfillPaymentRequestSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.FulfillPaymentRequestSimulationsResponse>;
|
|
164
164
|
private __fulfillPaymentRequest;
|
|
165
165
|
/**
|
|
166
|
-
* Decline an
|
|
166
|
+
* Decline an open payment request addressed to your test payer
|
|
167
167
|
*
|
|
168
168
|
* @param {Natural.DeclinePaymentRequestSimulationsRequest} request
|
|
169
169
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -192,7 +192,7 @@ export declare class SimulationsClient {
|
|
|
192
192
|
declinePaymentRequest(request: Natural.DeclinePaymentRequestSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.DeclinePaymentRequestSimulationsResponse>;
|
|
193
193
|
private __declinePaymentRequest;
|
|
194
194
|
/**
|
|
195
|
-
* Accept a pending customer invitation as
|
|
195
|
+
* Accept a pending customer invitation as the test customer it is addressed to
|
|
196
196
|
*
|
|
197
197
|
* @param {Natural.AcceptCustomerInvitationSimulationsRequest} request
|
|
198
198
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -223,7 +223,7 @@ export declare class SimulationsClient {
|
|
|
223
223
|
acceptCustomerInvitation(request: Natural.AcceptCustomerInvitationSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.AcceptCustomerInvitationSimulationsResponse>;
|
|
224
224
|
private __acceptCustomerInvitation;
|
|
225
225
|
/**
|
|
226
|
-
* Decline a pending customer invitation as
|
|
226
|
+
* Decline a pending customer invitation as the test customer it is addressed to
|
|
227
227
|
*
|
|
228
228
|
* @param {Natural.DeclineCustomerInvitationSimulationsRequest} request
|
|
229
229
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -254,7 +254,7 @@ export declare class SimulationsClient {
|
|
|
254
254
|
declineCustomerInvitation(request: Natural.DeclineCustomerInvitationSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.DeclineCustomerInvitationSimulationsResponse>;
|
|
255
255
|
private __declineCustomerInvitation;
|
|
256
256
|
/**
|
|
257
|
-
*
|
|
257
|
+
* Remove an agent's access to a test customer, acting as the customer
|
|
258
258
|
*
|
|
259
259
|
* @param {Natural.RevokeAgentConnectionSimulationsRequest} request
|
|
260
260
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -72,7 +72,7 @@ class SimulationsClient {
|
|
|
72
72
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
73
73
|
}
|
|
74
74
|
/**
|
|
75
|
-
* Create a
|
|
75
|
+
* Create a test customer and a pending invitation for each agent you name
|
|
76
76
|
*
|
|
77
77
|
* @param {Natural.InviteCustomerSimulationsRequest} request
|
|
78
78
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -179,7 +179,7 @@ class SimulationsClient {
|
|
|
179
179
|
});
|
|
180
180
|
}
|
|
181
181
|
/**
|
|
182
|
-
* Add test funds to a connected customer's wallet
|
|
182
|
+
* Add test funds to a connected customer's wallet
|
|
183
183
|
*
|
|
184
184
|
* @param {Natural.FundCustomerSimulationsRequest} request
|
|
185
185
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -290,7 +290,7 @@ class SimulationsClient {
|
|
|
290
290
|
});
|
|
291
291
|
}
|
|
292
292
|
/**
|
|
293
|
-
* Link a test bank account to your own party
|
|
293
|
+
* Link a test bank account to your own party
|
|
294
294
|
*
|
|
295
295
|
* @param {Natural.LinkExternalAccountSimulationsRequest} request
|
|
296
296
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -389,7 +389,7 @@ class SimulationsClient {
|
|
|
389
389
|
});
|
|
390
390
|
}
|
|
391
391
|
/**
|
|
392
|
-
* Simulate the recipient of a held payment joining and receiving the funds
|
|
392
|
+
* Simulate the recipient of a held payment joining Natural and receiving the funds
|
|
393
393
|
*
|
|
394
394
|
* @param {Natural.CompletePaymentClaimSimulationsRequest} request
|
|
395
395
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -490,7 +490,7 @@ class SimulationsClient {
|
|
|
490
490
|
});
|
|
491
491
|
}
|
|
492
492
|
/**
|
|
493
|
-
*
|
|
493
|
+
* Fulfill an open payment request addressed to your test payer
|
|
494
494
|
*
|
|
495
495
|
* @param {Natural.FulfillPaymentRequestSimulationsRequest} request
|
|
496
496
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -593,7 +593,7 @@ class SimulationsClient {
|
|
|
593
593
|
});
|
|
594
594
|
}
|
|
595
595
|
/**
|
|
596
|
-
* Decline an
|
|
596
|
+
* Decline an open payment request addressed to your test payer
|
|
597
597
|
*
|
|
598
598
|
* @param {Natural.DeclinePaymentRequestSimulationsRequest} request
|
|
599
599
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -693,7 +693,7 @@ class SimulationsClient {
|
|
|
693
693
|
});
|
|
694
694
|
}
|
|
695
695
|
/**
|
|
696
|
-
* Accept a pending customer invitation as
|
|
696
|
+
* Accept a pending customer invitation as the test customer it is addressed to
|
|
697
697
|
*
|
|
698
698
|
* @param {Natural.AcceptCustomerInvitationSimulationsRequest} request
|
|
699
699
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -803,7 +803,7 @@ class SimulationsClient {
|
|
|
803
803
|
});
|
|
804
804
|
}
|
|
805
805
|
/**
|
|
806
|
-
* Decline a pending customer invitation as
|
|
806
|
+
* Decline a pending customer invitation as the test customer it is addressed to
|
|
807
807
|
*
|
|
808
808
|
* @param {Natural.DeclineCustomerInvitationSimulationsRequest} request
|
|
809
809
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -913,7 +913,7 @@ class SimulationsClient {
|
|
|
913
913
|
});
|
|
914
914
|
}
|
|
915
915
|
/**
|
|
916
|
-
*
|
|
916
|
+
* Remove an agent's access to a test customer, acting as the customer
|
|
917
917
|
*
|
|
918
918
|
* @param {Natural.RevokeAgentConnectionSimulationsRequest} request
|
|
919
919
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -10,6 +10,6 @@ export interface AcceptCustomerInvitationSimulationsRequest {
|
|
|
10
10
|
invitationId: string;
|
|
11
11
|
/** Unique key for safely retrying a request without creating duplicates. */
|
|
12
12
|
idempotencyKey: string;
|
|
13
|
-
/**
|
|
13
|
+
/** Party ID (pty_*) of the test customer the invitation is addressed to. */
|
|
14
14
|
partyId: string;
|
|
15
15
|
}
|
|
@@ -10,6 +10,6 @@ export interface DeclineCustomerInvitationSimulationsRequest {
|
|
|
10
10
|
invitationId: string;
|
|
11
11
|
/** Unique key for safely retrying a request without creating duplicates. */
|
|
12
12
|
idempotencyKey: string;
|
|
13
|
-
/**
|
|
13
|
+
/** Party ID (pty_*) of the test customer the invitation is addressed to. */
|
|
14
14
|
partyId: string;
|
|
15
15
|
}
|
package/dist/cjs/api/resources/simulations/client/requests/InviteCustomerSimulationsRequest.d.ts
CHANGED
|
@@ -10,8 +10,8 @@ import type * as Natural from "../../../../index.js";
|
|
|
10
10
|
export interface InviteCustomerSimulationsRequest {
|
|
11
11
|
/** Unique key for safely retrying a request without creating duplicates. */
|
|
12
12
|
idempotencyKey: string;
|
|
13
|
-
/**
|
|
13
|
+
/** Agents to grant access to. The test customer receives a pending invitation for each agent listed. */
|
|
14
14
|
agentIds: string[];
|
|
15
|
-
/**
|
|
15
|
+
/** Test customer party type. Defaults to PERSON. */
|
|
16
16
|
type?: Natural.InviteCustomerSimulationsRequestType;
|
|
17
17
|
}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.InviteCustomerSimulationsRequestType = void 0;
|
|
5
|
-
/**
|
|
5
|
+
/** Test customer party type. Defaults to PERSON. */
|
|
6
6
|
exports.InviteCustomerSimulationsRequestType = {
|
|
7
7
|
Person: "PERSON",
|
|
8
8
|
Org: "ORG",
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type * as Natural from "../../../index.js";
|
|
2
2
|
export interface InviteCustomerSimulationsResponse {
|
|
3
|
-
/** Pending invitations created for
|
|
3
|
+
/** Pending invitations created, one for each agent listed. */
|
|
4
4
|
data: Natural.InviteCustomerSimulationsResponseDataItem[];
|
|
5
5
|
meta: Natural.InviteCustomerSimulationsResponseMeta;
|
|
6
6
|
}
|
package/dist/cjs/api/resources/simulations/types/InviteCustomerSimulationsResponseMetaCustomer.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import type * as Natural from "../../../index.js";
|
|
2
2
|
export interface InviteCustomerSimulationsResponseMetaCustomer {
|
|
3
|
-
/**
|
|
3
|
+
/** Customer party ID (pty_*). */
|
|
4
4
|
partyId: string;
|
|
5
|
-
/**
|
|
5
|
+
/** The test customer's handle (@name), assigned automatically. */
|
|
6
6
|
handle: string;
|
|
7
|
-
/**
|
|
7
|
+
/** Test customer party type. */
|
|
8
8
|
partyType: Natural.InviteCustomerSimulationsResponseMetaCustomerPartyType;
|
|
9
9
|
}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.InviteCustomerSimulationsResponseMetaCustomerPartyType = void 0;
|
|
5
|
-
/**
|
|
5
|
+
/** Test customer party type. */
|
|
6
6
|
exports.InviteCustomerSimulationsResponseMetaCustomerPartyType = {
|
|
7
7
|
Person: "PERSON",
|
|
8
8
|
Org: "ORG",
|
|
@@ -129,7 +129,7 @@ export declare class WalletsClient {
|
|
|
129
129
|
update(request: Natural.UpdateWalletsRequest, requestOptions?: WalletsClient.RequestOptions): core.HttpResponsePromise<Natural.UpdateWalletsResponse>;
|
|
130
130
|
private __update;
|
|
131
131
|
/**
|
|
132
|
-
*
|
|
132
|
+
* Set the party's default wallet, where payments addressed to their email, phone number, or handle land
|
|
133
133
|
*
|
|
134
134
|
* @param {Natural.SetDefaultWalletsRequest} request
|
|
135
135
|
* @param {WalletsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -488,7 +488,7 @@ class WalletsClient {
|
|
|
488
488
|
});
|
|
489
489
|
}
|
|
490
490
|
/**
|
|
491
|
-
*
|
|
491
|
+
* Set the party's default wallet, where payments addressed to their email, phone number, or handle land
|
|
492
492
|
*
|
|
493
493
|
* @param {Natural.SetDefaultWalletsRequest} request
|
|
494
494
|
* @param {WalletsClient.RequestOptions} requestOptions - Request-specific configuration.
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.2.
|
|
1
|
+
export declare const SDK_VERSION = "1.2.1";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
|
|
|
6
6
|
const headers = mergeHeaders({
|
|
7
7
|
"X-Fern-Language": "JavaScript",
|
|
8
8
|
"X-Fern-SDK-Name": "@naturalpay/sdk",
|
|
9
|
-
"X-Fern-SDK-Version": "1.2.
|
|
10
|
-
"User-Agent": "@naturalpay/sdk/1.2.
|
|
9
|
+
"X-Fern-SDK-Version": "1.2.1",
|
|
10
|
+
"User-Agent": "@naturalpay/sdk/1.2.1",
|
|
11
11
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
12
12
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
13
13
|
"X-Agent-ID": options === null || options === void 0 ? void 0 : options.agentId,
|
|
@@ -67,7 +67,7 @@ export declare class CustomersClient {
|
|
|
67
67
|
get(request: Natural.GetCustomersRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<Natural.CustomerDetail>;
|
|
68
68
|
private __get;
|
|
69
69
|
/**
|
|
70
|
-
* List pending
|
|
70
|
+
* List pending invitations addressed to specific customers
|
|
71
71
|
*
|
|
72
72
|
* @param {Natural.ListInvitationsCustomersRequest} request
|
|
73
73
|
* @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -93,7 +93,7 @@ export declare class CustomersClient {
|
|
|
93
93
|
listInvitations(request?: Natural.ListInvitationsCustomersRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<Natural.ListInvitationsCustomersResponse>;
|
|
94
94
|
private __listInvitations;
|
|
95
95
|
/**
|
|
96
|
-
* Invite customers to
|
|
96
|
+
* Invite specific customers by email or phone to approve a set of your agents, each with its own permissions and limits
|
|
97
97
|
*
|
|
98
98
|
* @param {Natural.CreateInvitationsCustomersRequest} request
|
|
99
99
|
* @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -135,7 +135,7 @@ export declare class CustomersClient {
|
|
|
135
135
|
createInvitations(request: Natural.CreateInvitationsCustomersRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<Natural.CreateInvitationsCustomersResponse>;
|
|
136
136
|
private __createInvitations;
|
|
137
137
|
/**
|
|
138
|
-
* Revoke a pending customer
|
|
138
|
+
* Revoke a pending invitation addressed to a specific customer, so it can no longer be accepted
|
|
139
139
|
*
|
|
140
140
|
* @param {Natural.RevokeInvitationCustomersRequest} request
|
|
141
141
|
* @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -244,7 +244,7 @@ export class CustomersClient {
|
|
|
244
244
|
});
|
|
245
245
|
}
|
|
246
246
|
/**
|
|
247
|
-
* List pending
|
|
247
|
+
* List pending invitations addressed to specific customers
|
|
248
248
|
*
|
|
249
249
|
* @param {Natural.ListInvitationsCustomersRequest} request
|
|
250
250
|
* @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -348,7 +348,7 @@ export class CustomersClient {
|
|
|
348
348
|
});
|
|
349
349
|
}
|
|
350
350
|
/**
|
|
351
|
-
* Invite customers to
|
|
351
|
+
* Invite specific customers by email or phone to approve a set of your agents, each with its own permissions and limits
|
|
352
352
|
*
|
|
353
353
|
* @param {Natural.CreateInvitationsCustomersRequest} request
|
|
354
354
|
* @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -465,7 +465,7 @@ export class CustomersClient {
|
|
|
465
465
|
});
|
|
466
466
|
}
|
|
467
467
|
/**
|
|
468
|
-
* Revoke a pending customer
|
|
468
|
+
* Revoke a pending invitation addressed to a specific customer, so it can no longer be accepted
|
|
469
469
|
*
|
|
470
470
|
* @param {Natural.RevokeInvitationCustomersRequest} request
|
|
471
471
|
* @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -14,7 +14,7 @@ export declare class InvitationLinksClient {
|
|
|
14
14
|
protected readonly _options: NormalizedClientOptionsWithAuth<InvitationLinksClient.Options>;
|
|
15
15
|
constructor(options?: InvitationLinksClient.Options);
|
|
16
16
|
/**
|
|
17
|
-
* List the invitation links
|
|
17
|
+
* List the invitation links you have created, with masked tokens
|
|
18
18
|
*
|
|
19
19
|
* @param {Natural.ListInvitationLinksRequest} request
|
|
20
20
|
* @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -40,7 +40,7 @@ export declare class InvitationLinksClient {
|
|
|
40
40
|
list(request?: Natural.ListInvitationLinksRequest, requestOptions?: InvitationLinksClient.RequestOptions): core.HttpResponsePromise<Natural.ListInvitationLinksResponse>;
|
|
41
41
|
private __list;
|
|
42
42
|
/**
|
|
43
|
-
* Create a shareable link
|
|
43
|
+
* Create a shareable link offering your agents, with the permissions and limits you set, to any customer who opens it
|
|
44
44
|
*
|
|
45
45
|
* @param {Natural.CreateInvitationLinksRequest} request
|
|
46
46
|
* @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -75,7 +75,7 @@ export declare class InvitationLinksClient {
|
|
|
75
75
|
create(request: Natural.CreateInvitationLinksRequest, requestOptions?: InvitationLinksClient.RequestOptions): core.HttpResponsePromise<Natural.CreateInvitationLinksResponse>;
|
|
76
76
|
private __create;
|
|
77
77
|
/**
|
|
78
|
-
* Get an invitation link
|
|
78
|
+
* Get an invitation link and its offered agents, with a masked token
|
|
79
79
|
*
|
|
80
80
|
* @param {Natural.GetInvitationLinksRequest} request
|
|
81
81
|
* @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -103,7 +103,7 @@ export declare class InvitationLinksClient {
|
|
|
103
103
|
get(request: Natural.GetInvitationLinksRequest, requestOptions?: InvitationLinksClient.RequestOptions): core.HttpResponsePromise<Natural.GetInvitationLinksResponse>;
|
|
104
104
|
private __get;
|
|
105
105
|
/**
|
|
106
|
-
*
|
|
106
|
+
* Revoke an invitation link so it stops connecting new customers
|
|
107
107
|
*
|
|
108
108
|
* @param {Natural.RevokeInvitationLinksRequest} request
|
|
109
109
|
* @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -25,7 +25,7 @@ export class InvitationLinksClient {
|
|
|
25
25
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
26
26
|
}
|
|
27
27
|
/**
|
|
28
|
-
* List the invitation links
|
|
28
|
+
* List the invitation links you have created, with masked tokens
|
|
29
29
|
*
|
|
30
30
|
* @param {Natural.ListInvitationLinksRequest} request
|
|
31
31
|
* @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -135,7 +135,7 @@ export class InvitationLinksClient {
|
|
|
135
135
|
});
|
|
136
136
|
}
|
|
137
137
|
/**
|
|
138
|
-
* Create a shareable link
|
|
138
|
+
* Create a shareable link offering your agents, with the permissions and limits you set, to any customer who opens it
|
|
139
139
|
*
|
|
140
140
|
* @param {Natural.CreateInvitationLinksRequest} request
|
|
141
141
|
* @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -245,7 +245,7 @@ export class InvitationLinksClient {
|
|
|
245
245
|
});
|
|
246
246
|
}
|
|
247
247
|
/**
|
|
248
|
-
* Get an invitation link
|
|
248
|
+
* Get an invitation link and its offered agents, with a masked token
|
|
249
249
|
*
|
|
250
250
|
* @param {Natural.GetInvitationLinksRequest} request
|
|
251
251
|
* @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -343,7 +343,7 @@ export class InvitationLinksClient {
|
|
|
343
343
|
});
|
|
344
344
|
}
|
|
345
345
|
/**
|
|
346
|
-
*
|
|
346
|
+
* Revoke an invitation link so it stops connecting new customers
|
|
347
347
|
*
|
|
348
348
|
* @param {Natural.RevokeInvitationLinksRequest} request
|
|
349
349
|
* @param {InvitationLinksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -14,7 +14,7 @@ export declare class SimulationsClient {
|
|
|
14
14
|
protected readonly _options: NormalizedClientOptionsWithAuth<SimulationsClient.Options>;
|
|
15
15
|
constructor(options?: SimulationsClient.Options);
|
|
16
16
|
/**
|
|
17
|
-
* Create a
|
|
17
|
+
* Create a test customer and a pending invitation for each agent you name
|
|
18
18
|
*
|
|
19
19
|
* @param {Natural.InviteCustomerSimulationsRequest} request
|
|
20
20
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -44,7 +44,7 @@ export declare class SimulationsClient {
|
|
|
44
44
|
inviteCustomer(request: Natural.InviteCustomerSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.InviteCustomerSimulationsResponse>;
|
|
45
45
|
private __inviteCustomer;
|
|
46
46
|
/**
|
|
47
|
-
* Add test funds to a connected customer's wallet
|
|
47
|
+
* Add test funds to a connected customer's wallet
|
|
48
48
|
*
|
|
49
49
|
* @param {Natural.FundCustomerSimulationsRequest} request
|
|
50
50
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -76,7 +76,7 @@ export declare class SimulationsClient {
|
|
|
76
76
|
fundCustomer(request: Natural.FundCustomerSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.FundCustomerSimulationsResponse>;
|
|
77
77
|
private __fundCustomer;
|
|
78
78
|
/**
|
|
79
|
-
* Link a test bank account to your own party
|
|
79
|
+
* Link a test bank account to your own party
|
|
80
80
|
*
|
|
81
81
|
* @param {Natural.LinkExternalAccountSimulationsRequest} request
|
|
82
82
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -104,7 +104,7 @@ export declare class SimulationsClient {
|
|
|
104
104
|
linkExternalAccount(request: Natural.LinkExternalAccountSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.LinkExternalAccountSimulationsResponse>;
|
|
105
105
|
private __linkExternalAccount;
|
|
106
106
|
/**
|
|
107
|
-
* Simulate the recipient of a held payment joining and receiving the funds
|
|
107
|
+
* Simulate the recipient of a held payment joining Natural and receiving the funds
|
|
108
108
|
*
|
|
109
109
|
* @param {Natural.CompletePaymentClaimSimulationsRequest} request
|
|
110
110
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -133,7 +133,7 @@ export declare class SimulationsClient {
|
|
|
133
133
|
completePaymentClaim(request: Natural.CompletePaymentClaimSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.CompletePaymentClaimSimulationsResponse>;
|
|
134
134
|
private __completePaymentClaim;
|
|
135
135
|
/**
|
|
136
|
-
*
|
|
136
|
+
* Fulfill an open payment request addressed to your test payer
|
|
137
137
|
*
|
|
138
138
|
* @param {Natural.FulfillPaymentRequestSimulationsRequest} request
|
|
139
139
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -163,7 +163,7 @@ export declare class SimulationsClient {
|
|
|
163
163
|
fulfillPaymentRequest(request: Natural.FulfillPaymentRequestSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.FulfillPaymentRequestSimulationsResponse>;
|
|
164
164
|
private __fulfillPaymentRequest;
|
|
165
165
|
/**
|
|
166
|
-
* Decline an
|
|
166
|
+
* Decline an open payment request addressed to your test payer
|
|
167
167
|
*
|
|
168
168
|
* @param {Natural.DeclinePaymentRequestSimulationsRequest} request
|
|
169
169
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -192,7 +192,7 @@ export declare class SimulationsClient {
|
|
|
192
192
|
declinePaymentRequest(request: Natural.DeclinePaymentRequestSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.DeclinePaymentRequestSimulationsResponse>;
|
|
193
193
|
private __declinePaymentRequest;
|
|
194
194
|
/**
|
|
195
|
-
* Accept a pending customer invitation as
|
|
195
|
+
* Accept a pending customer invitation as the test customer it is addressed to
|
|
196
196
|
*
|
|
197
197
|
* @param {Natural.AcceptCustomerInvitationSimulationsRequest} request
|
|
198
198
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -223,7 +223,7 @@ export declare class SimulationsClient {
|
|
|
223
223
|
acceptCustomerInvitation(request: Natural.AcceptCustomerInvitationSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.AcceptCustomerInvitationSimulationsResponse>;
|
|
224
224
|
private __acceptCustomerInvitation;
|
|
225
225
|
/**
|
|
226
|
-
* Decline a pending customer invitation as
|
|
226
|
+
* Decline a pending customer invitation as the test customer it is addressed to
|
|
227
227
|
*
|
|
228
228
|
* @param {Natural.DeclineCustomerInvitationSimulationsRequest} request
|
|
229
229
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -254,7 +254,7 @@ export declare class SimulationsClient {
|
|
|
254
254
|
declineCustomerInvitation(request: Natural.DeclineCustomerInvitationSimulationsRequest, requestOptions?: SimulationsClient.RequestOptions): core.HttpResponsePromise<Natural.DeclineCustomerInvitationSimulationsResponse>;
|
|
255
255
|
private __declineCustomerInvitation;
|
|
256
256
|
/**
|
|
257
|
-
*
|
|
257
|
+
* Remove an agent's access to a test customer, acting as the customer
|
|
258
258
|
*
|
|
259
259
|
* @param {Natural.RevokeAgentConnectionSimulationsRequest} request
|
|
260
260
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -36,7 +36,7 @@ export class SimulationsClient {
|
|
|
36
36
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
37
37
|
}
|
|
38
38
|
/**
|
|
39
|
-
* Create a
|
|
39
|
+
* Create a test customer and a pending invitation for each agent you name
|
|
40
40
|
*
|
|
41
41
|
* @param {Natural.InviteCustomerSimulationsRequest} request
|
|
42
42
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -143,7 +143,7 @@ export class SimulationsClient {
|
|
|
143
143
|
});
|
|
144
144
|
}
|
|
145
145
|
/**
|
|
146
|
-
* Add test funds to a connected customer's wallet
|
|
146
|
+
* Add test funds to a connected customer's wallet
|
|
147
147
|
*
|
|
148
148
|
* @param {Natural.FundCustomerSimulationsRequest} request
|
|
149
149
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -254,7 +254,7 @@ export class SimulationsClient {
|
|
|
254
254
|
});
|
|
255
255
|
}
|
|
256
256
|
/**
|
|
257
|
-
* Link a test bank account to your own party
|
|
257
|
+
* Link a test bank account to your own party
|
|
258
258
|
*
|
|
259
259
|
* @param {Natural.LinkExternalAccountSimulationsRequest} request
|
|
260
260
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -353,7 +353,7 @@ export class SimulationsClient {
|
|
|
353
353
|
});
|
|
354
354
|
}
|
|
355
355
|
/**
|
|
356
|
-
* Simulate the recipient of a held payment joining and receiving the funds
|
|
356
|
+
* Simulate the recipient of a held payment joining Natural and receiving the funds
|
|
357
357
|
*
|
|
358
358
|
* @param {Natural.CompletePaymentClaimSimulationsRequest} request
|
|
359
359
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -454,7 +454,7 @@ export class SimulationsClient {
|
|
|
454
454
|
});
|
|
455
455
|
}
|
|
456
456
|
/**
|
|
457
|
-
*
|
|
457
|
+
* Fulfill an open payment request addressed to your test payer
|
|
458
458
|
*
|
|
459
459
|
* @param {Natural.FulfillPaymentRequestSimulationsRequest} request
|
|
460
460
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -557,7 +557,7 @@ export class SimulationsClient {
|
|
|
557
557
|
});
|
|
558
558
|
}
|
|
559
559
|
/**
|
|
560
|
-
* Decline an
|
|
560
|
+
* Decline an open payment request addressed to your test payer
|
|
561
561
|
*
|
|
562
562
|
* @param {Natural.DeclinePaymentRequestSimulationsRequest} request
|
|
563
563
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -657,7 +657,7 @@ export class SimulationsClient {
|
|
|
657
657
|
});
|
|
658
658
|
}
|
|
659
659
|
/**
|
|
660
|
-
* Accept a pending customer invitation as
|
|
660
|
+
* Accept a pending customer invitation as the test customer it is addressed to
|
|
661
661
|
*
|
|
662
662
|
* @param {Natural.AcceptCustomerInvitationSimulationsRequest} request
|
|
663
663
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -767,7 +767,7 @@ export class SimulationsClient {
|
|
|
767
767
|
});
|
|
768
768
|
}
|
|
769
769
|
/**
|
|
770
|
-
* Decline a pending customer invitation as
|
|
770
|
+
* Decline a pending customer invitation as the test customer it is addressed to
|
|
771
771
|
*
|
|
772
772
|
* @param {Natural.DeclineCustomerInvitationSimulationsRequest} request
|
|
773
773
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -877,7 +877,7 @@ export class SimulationsClient {
|
|
|
877
877
|
});
|
|
878
878
|
}
|
|
879
879
|
/**
|
|
880
|
-
*
|
|
880
|
+
* Remove an agent's access to a test customer, acting as the customer
|
|
881
881
|
*
|
|
882
882
|
* @param {Natural.RevokeAgentConnectionSimulationsRequest} request
|
|
883
883
|
* @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -10,6 +10,6 @@ export interface AcceptCustomerInvitationSimulationsRequest {
|
|
|
10
10
|
invitationId: string;
|
|
11
11
|
/** Unique key for safely retrying a request without creating duplicates. */
|
|
12
12
|
idempotencyKey: string;
|
|
13
|
-
/**
|
|
13
|
+
/** Party ID (pty_*) of the test customer the invitation is addressed to. */
|
|
14
14
|
partyId: string;
|
|
15
15
|
}
|
|
@@ -10,6 +10,6 @@ export interface DeclineCustomerInvitationSimulationsRequest {
|
|
|
10
10
|
invitationId: string;
|
|
11
11
|
/** Unique key for safely retrying a request without creating duplicates. */
|
|
12
12
|
idempotencyKey: string;
|
|
13
|
-
/**
|
|
13
|
+
/** Party ID (pty_*) of the test customer the invitation is addressed to. */
|
|
14
14
|
partyId: string;
|
|
15
15
|
}
|
package/dist/esm/api/resources/simulations/client/requests/InviteCustomerSimulationsRequest.d.mts
CHANGED
|
@@ -10,8 +10,8 @@ import type * as Natural from "../../../../index.mjs";
|
|
|
10
10
|
export interface InviteCustomerSimulationsRequest {
|
|
11
11
|
/** Unique key for safely retrying a request without creating duplicates. */
|
|
12
12
|
idempotencyKey: string;
|
|
13
|
-
/**
|
|
13
|
+
/** Agents to grant access to. The test customer receives a pending invitation for each agent listed. */
|
|
14
14
|
agentIds: string[];
|
|
15
|
-
/**
|
|
15
|
+
/** Test customer party type. Defaults to PERSON. */
|
|
16
16
|
type?: Natural.InviteCustomerSimulationsRequestType;
|
|
17
17
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
-
/**
|
|
2
|
+
/** Test customer party type. Defaults to PERSON. */
|
|
3
3
|
export const InviteCustomerSimulationsRequestType = {
|
|
4
4
|
Person: "PERSON",
|
|
5
5
|
Org: "ORG",
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type * as Natural from "../../../index.mjs";
|
|
2
2
|
export interface InviteCustomerSimulationsResponse {
|
|
3
|
-
/** Pending invitations created for
|
|
3
|
+
/** Pending invitations created, one for each agent listed. */
|
|
4
4
|
data: Natural.InviteCustomerSimulationsResponseDataItem[];
|
|
5
5
|
meta: Natural.InviteCustomerSimulationsResponseMeta;
|
|
6
6
|
}
|
package/dist/esm/api/resources/simulations/types/InviteCustomerSimulationsResponseMetaCustomer.d.mts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import type * as Natural from "../../../index.mjs";
|
|
2
2
|
export interface InviteCustomerSimulationsResponseMetaCustomer {
|
|
3
|
-
/**
|
|
3
|
+
/** Customer party ID (pty_*). */
|
|
4
4
|
partyId: string;
|
|
5
|
-
/**
|
|
5
|
+
/** The test customer's handle (@name), assigned automatically. */
|
|
6
6
|
handle: string;
|
|
7
|
-
/**
|
|
7
|
+
/** Test customer party type. */
|
|
8
8
|
partyType: Natural.InviteCustomerSimulationsResponseMetaCustomerPartyType;
|
|
9
9
|
}
|
|
@@ -129,7 +129,7 @@ export declare class WalletsClient {
|
|
|
129
129
|
update(request: Natural.UpdateWalletsRequest, requestOptions?: WalletsClient.RequestOptions): core.HttpResponsePromise<Natural.UpdateWalletsResponse>;
|
|
130
130
|
private __update;
|
|
131
131
|
/**
|
|
132
|
-
*
|
|
132
|
+
* Set the party's default wallet, where payments addressed to their email, phone number, or handle land
|
|
133
133
|
*
|
|
134
134
|
* @param {Natural.SetDefaultWalletsRequest} request
|
|
135
135
|
* @param {WalletsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -452,7 +452,7 @@ export class WalletsClient {
|
|
|
452
452
|
});
|
|
453
453
|
}
|
|
454
454
|
/**
|
|
455
|
-
*
|
|
455
|
+
* Set the party's default wallet, where payments addressed to their email, phone number, or handle land
|
|
456
456
|
*
|
|
457
457
|
* @param {Natural.SetDefaultWalletsRequest} request
|
|
458
458
|
* @param {WalletsClient.RequestOptions} requestOptions - Request-specific configuration.
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.2.
|
|
1
|
+
export declare const SDK_VERSION = "1.2.1";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "1.2.
|
|
1
|
+
export const SDK_VERSION = "1.2.1";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -830,7 +830,7 @@ await client.customers.get({
|
|
|
830
830
|
<dl>
|
|
831
831
|
<dd>
|
|
832
832
|
|
|
833
|
-
List pending
|
|
833
|
+
List pending invitations addressed to specific customers
|
|
834
834
|
</dd>
|
|
835
835
|
</dl>
|
|
836
836
|
</dd>
|
|
@@ -893,7 +893,7 @@ await client.customers.listInvitations();
|
|
|
893
893
|
<dl>
|
|
894
894
|
<dd>
|
|
895
895
|
|
|
896
|
-
Invite customers to
|
|
896
|
+
Invite specific customers by email or phone to approve a set of your agents, each with its own permissions and limits
|
|
897
897
|
</dd>
|
|
898
898
|
</dl>
|
|
899
899
|
</dd>
|
|
@@ -972,7 +972,7 @@ await client.customers.createInvitations({
|
|
|
972
972
|
<dl>
|
|
973
973
|
<dd>
|
|
974
974
|
|
|
975
|
-
Revoke a pending customer
|
|
975
|
+
Revoke a pending invitation addressed to a specific customer, so it can no longer be accepted
|
|
976
976
|
</dd>
|
|
977
977
|
</dl>
|
|
978
978
|
</dd>
|
|
@@ -1104,7 +1104,7 @@ await client.customers.revokeAgent({
|
|
|
1104
1104
|
<dl>
|
|
1105
1105
|
<dd>
|
|
1106
1106
|
|
|
1107
|
-
List the invitation links
|
|
1107
|
+
List the invitation links you have created, with masked tokens
|
|
1108
1108
|
</dd>
|
|
1109
1109
|
</dl>
|
|
1110
1110
|
</dd>
|
|
@@ -1167,7 +1167,7 @@ await client.invitationLinks.list();
|
|
|
1167
1167
|
<dl>
|
|
1168
1168
|
<dd>
|
|
1169
1169
|
|
|
1170
|
-
Create a shareable link
|
|
1170
|
+
Create a shareable link offering your agents, with the permissions and limits you set, to any customer who opens it
|
|
1171
1171
|
</dd>
|
|
1172
1172
|
</dl>
|
|
1173
1173
|
</dd>
|
|
@@ -1239,7 +1239,7 @@ await client.invitationLinks.create({
|
|
|
1239
1239
|
<dl>
|
|
1240
1240
|
<dd>
|
|
1241
1241
|
|
|
1242
|
-
Get an invitation link
|
|
1242
|
+
Get an invitation link and its offered agents, with a masked token
|
|
1243
1243
|
</dd>
|
|
1244
1244
|
</dl>
|
|
1245
1245
|
</dd>
|
|
@@ -1304,7 +1304,7 @@ await client.invitationLinks.get({
|
|
|
1304
1304
|
<dl>
|
|
1305
1305
|
<dd>
|
|
1306
1306
|
|
|
1307
|
-
|
|
1307
|
+
Revoke an invitation link so it stops connecting new customers
|
|
1308
1308
|
</dd>
|
|
1309
1309
|
</dl>
|
|
1310
1310
|
</dd>
|
|
@@ -3924,7 +3924,7 @@ await client.wallets.update({
|
|
|
3924
3924
|
<dl>
|
|
3925
3925
|
<dd>
|
|
3926
3926
|
|
|
3927
|
-
|
|
3927
|
+
Set the party's default wallet, where payments addressed to their email, phone number, or handle land
|
|
3928
3928
|
</dd>
|
|
3929
3929
|
</dl>
|
|
3930
3930
|
</dd>
|
|
@@ -5756,7 +5756,7 @@ await client.events.get({
|
|
|
5756
5756
|
<dl>
|
|
5757
5757
|
<dd>
|
|
5758
5758
|
|
|
5759
|
-
Create a
|
|
5759
|
+
Create a test customer and a pending invitation for each agent you name
|
|
5760
5760
|
</dd>
|
|
5761
5761
|
</dl>
|
|
5762
5762
|
</dd>
|
|
@@ -5823,7 +5823,7 @@ await client.simulations.inviteCustomer({
|
|
|
5823
5823
|
<dl>
|
|
5824
5824
|
<dd>
|
|
5825
5825
|
|
|
5826
|
-
Add test funds to a connected customer's wallet
|
|
5826
|
+
Add test funds to a connected customer's wallet
|
|
5827
5827
|
</dd>
|
|
5828
5828
|
</dl>
|
|
5829
5829
|
</dd>
|
|
@@ -5891,7 +5891,7 @@ await client.simulations.fundCustomer({
|
|
|
5891
5891
|
<dl>
|
|
5892
5892
|
<dd>
|
|
5893
5893
|
|
|
5894
|
-
Link a test bank account to your own party
|
|
5894
|
+
Link a test bank account to your own party
|
|
5895
5895
|
</dd>
|
|
5896
5896
|
</dl>
|
|
5897
5897
|
</dd>
|
|
@@ -5956,7 +5956,7 @@ await client.simulations.linkExternalAccount({
|
|
|
5956
5956
|
<dl>
|
|
5957
5957
|
<dd>
|
|
5958
5958
|
|
|
5959
|
-
Simulate the recipient of a held payment joining and receiving the funds
|
|
5959
|
+
Simulate the recipient of a held payment joining Natural and receiving the funds
|
|
5960
5960
|
</dd>
|
|
5961
5961
|
</dl>
|
|
5962
5962
|
</dd>
|
|
@@ -6021,7 +6021,7 @@ await client.simulations.completePaymentClaim({
|
|
|
6021
6021
|
<dl>
|
|
6022
6022
|
<dd>
|
|
6023
6023
|
|
|
6024
|
-
|
|
6024
|
+
Fulfill an open payment request addressed to your test payer
|
|
6025
6025
|
</dd>
|
|
6026
6026
|
</dl>
|
|
6027
6027
|
</dd>
|
|
@@ -6087,7 +6087,7 @@ await client.simulations.fulfillPaymentRequest({
|
|
|
6087
6087
|
<dl>
|
|
6088
6088
|
<dd>
|
|
6089
6089
|
|
|
6090
|
-
Decline an
|
|
6090
|
+
Decline an open payment request addressed to your test payer
|
|
6091
6091
|
</dd>
|
|
6092
6092
|
</dl>
|
|
6093
6093
|
</dd>
|
|
@@ -6153,7 +6153,7 @@ await client.simulations.declinePaymentRequest({
|
|
|
6153
6153
|
<dl>
|
|
6154
6154
|
<dd>
|
|
6155
6155
|
|
|
6156
|
-
Accept a pending customer invitation as
|
|
6156
|
+
Accept a pending customer invitation as the test customer it is addressed to
|
|
6157
6157
|
</dd>
|
|
6158
6158
|
</dl>
|
|
6159
6159
|
</dd>
|
|
@@ -6220,7 +6220,7 @@ await client.simulations.acceptCustomerInvitation({
|
|
|
6220
6220
|
<dl>
|
|
6221
6221
|
<dd>
|
|
6222
6222
|
|
|
6223
|
-
Decline a pending customer invitation as
|
|
6223
|
+
Decline a pending customer invitation as the test customer it is addressed to
|
|
6224
6224
|
</dd>
|
|
6225
6225
|
</dl>
|
|
6226
6226
|
</dd>
|
|
@@ -6287,7 +6287,7 @@ await client.simulations.declineCustomerInvitation({
|
|
|
6287
6287
|
<dl>
|
|
6288
6288
|
<dd>
|
|
6289
6289
|
|
|
6290
|
-
|
|
6290
|
+
Remove an agent's access to a test customer, acting as the customer
|
|
6291
6291
|
</dd>
|
|
6292
6292
|
</dl>
|
|
6293
6293
|
</dd>
|