@naturalpay/sdk 1.2.6 → 1.2.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/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/customers/client/Client.d.ts +50 -1
- package/dist/cjs/api/resources/customers/client/Client.js +50 -1
- package/dist/cjs/api/resources/customers/client/requests/CreateInvitationsCustomersRequest.d.ts +51 -2
- package/dist/cjs/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemEmail.d.ts +2 -2
- package/dist/cjs/api/resources/customers/types/CustomerInvitationAccountType.d.ts +1 -1
- package/dist/cjs/api/resources/customers/types/CustomerInvitationAccountType.js +1 -1
- package/dist/cjs/api/resources/paymentRequests/client/requests/NewPayReqParams.d.ts +1 -1
- package/dist/cjs/api/resources/payments/client/requests/NewPaymentParams.d.ts +1 -1
- package/dist/cjs/api/resources/simulations/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/simulations/client/Client.js +1 -0
- package/dist/cjs/api/resources/simulations/client/requests/InviteCustomerSimulationsRequest.d.ts +3 -0
- package/dist/cjs/api/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.d.ts +19 -0
- package/dist/cjs/api/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.js +22 -0
- package/dist/cjs/api/resources/simulations/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/simulations/types/index.js +1 -0
- package/dist/cjs/serialization/resources/simulations/client/requests/InviteCustomerSimulationsRequest.d.ts +2 -0
- package/dist/cjs/serialization/resources/simulations/client/requests/InviteCustomerSimulationsRequest.js +2 -0
- package/dist/cjs/serialization/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.d.ts +7 -0
- package/dist/cjs/serialization/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.js +56 -0
- package/dist/cjs/serialization/resources/simulations/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/simulations/types/index.js +1 -0
- 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 +50 -1
- package/dist/esm/api/resources/customers/client/Client.mjs +50 -1
- package/dist/esm/api/resources/customers/client/requests/CreateInvitationsCustomersRequest.d.mts +51 -2
- package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestRecipientsItemEmail.d.mts +2 -2
- package/dist/esm/api/resources/customers/types/CustomerInvitationAccountType.d.mts +1 -1
- package/dist/esm/api/resources/customers/types/CustomerInvitationAccountType.mjs +1 -1
- package/dist/esm/api/resources/paymentRequests/client/requests/NewPayReqParams.d.mts +1 -1
- package/dist/esm/api/resources/payments/client/requests/NewPaymentParams.d.mts +1 -1
- package/dist/esm/api/resources/simulations/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/simulations/client/Client.mjs +1 -0
- package/dist/esm/api/resources/simulations/client/requests/InviteCustomerSimulationsRequest.d.mts +3 -0
- package/dist/esm/api/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.d.mts +19 -0
- package/dist/esm/api/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.mjs +19 -0
- package/dist/esm/api/resources/simulations/types/index.d.mts +1 -0
- package/dist/esm/api/resources/simulations/types/index.mjs +1 -0
- package/dist/esm/serialization/resources/simulations/client/requests/InviteCustomerSimulationsRequest.d.mts +2 -0
- package/dist/esm/serialization/resources/simulations/client/requests/InviteCustomerSimulationsRequest.mjs +2 -0
- package/dist/esm/serialization/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.d.mts +7 -0
- package/dist/esm/serialization/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.mjs +20 -0
- package/dist/esm/serialization/resources/simulations/types/index.d.mts +1 -0
- package/dist/esm/serialization/resources/simulations/types/index.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +51 -1
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.7",
|
|
47
|
+
"User-Agent": "@naturalpay/sdk/1.2.7",
|
|
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,
|
|
@@ -117,7 +117,56 @@ export declare class CustomersClient {
|
|
|
117
117
|
* await client.customers.createInvitations({
|
|
118
118
|
* recipients: [{
|
|
119
119
|
* type: "email",
|
|
120
|
-
* value: "ops@acme.com"
|
|
120
|
+
* value: "ops@acme.com",
|
|
121
|
+
* accountType: "business",
|
|
122
|
+
* firstName: "Morgan",
|
|
123
|
+
* lastName: "Lee",
|
|
124
|
+
* phone: "+14155550176",
|
|
125
|
+
* business: {
|
|
126
|
+
* legalName: "Acme Logistics LLC",
|
|
127
|
+
* displayName: "Acme Logistics",
|
|
128
|
+
* website: "https://acmelogistics.com",
|
|
129
|
+
* hasTradeName: true,
|
|
130
|
+
* tradeName: "Acme Freight",
|
|
131
|
+
* businessType: "llc",
|
|
132
|
+
* industry: "513210",
|
|
133
|
+
* stateOfIncorporation: "DE",
|
|
134
|
+
* incorporationDate: "2018-03-12",
|
|
135
|
+
* registeredAddress: {
|
|
136
|
+
* streetLine1: "251 Little Falls Dr",
|
|
137
|
+
* city: "Wilmington",
|
|
138
|
+
* subdivision: "DE",
|
|
139
|
+
* postalCode: "19808",
|
|
140
|
+
* country: "US"
|
|
141
|
+
* },
|
|
142
|
+
* physicalAddress: {
|
|
143
|
+
* streetLine1: "900 Harrison St",
|
|
144
|
+
* city: "San Francisco",
|
|
145
|
+
* subdivision: "CA",
|
|
146
|
+
* postalCode: "94107",
|
|
147
|
+
* country: "US"
|
|
148
|
+
* },
|
|
149
|
+
* sourceOfFunds: ["business_revenue"],
|
|
150
|
+
* countriesOfOperations: ["US", "CA"]
|
|
151
|
+
* },
|
|
152
|
+
* beneficialOwners: [{
|
|
153
|
+
* firstName: "Morgan",
|
|
154
|
+
* lastName: "Lee",
|
|
155
|
+
* email: "morgan.lee@acme.com",
|
|
156
|
+
* phone: "+14155550176",
|
|
157
|
+
* dateOfBirth: "1985-09-02",
|
|
158
|
+
* address: {
|
|
159
|
+
* streetLine1: "128 Alamo Square",
|
|
160
|
+
* city: "San Francisco",
|
|
161
|
+
* subdivision: "CA",
|
|
162
|
+
* postalCode: "94117",
|
|
163
|
+
* country: "US"
|
|
164
|
+
* },
|
|
165
|
+
* ownershipPercentage: 60,
|
|
166
|
+
* title: "ceo",
|
|
167
|
+
* countryOfCitizenship: "US",
|
|
168
|
+
* employmentStatus: "employed"
|
|
169
|
+
* }]
|
|
121
170
|
* }],
|
|
122
171
|
* agents: [{
|
|
123
172
|
* agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
|
|
@@ -408,7 +408,56 @@ class CustomersClient {
|
|
|
408
408
|
* await client.customers.createInvitations({
|
|
409
409
|
* recipients: [{
|
|
410
410
|
* type: "email",
|
|
411
|
-
* value: "ops@acme.com"
|
|
411
|
+
* value: "ops@acme.com",
|
|
412
|
+
* accountType: "business",
|
|
413
|
+
* firstName: "Morgan",
|
|
414
|
+
* lastName: "Lee",
|
|
415
|
+
* phone: "+14155550176",
|
|
416
|
+
* business: {
|
|
417
|
+
* legalName: "Acme Logistics LLC",
|
|
418
|
+
* displayName: "Acme Logistics",
|
|
419
|
+
* website: "https://acmelogistics.com",
|
|
420
|
+
* hasTradeName: true,
|
|
421
|
+
* tradeName: "Acme Freight",
|
|
422
|
+
* businessType: "llc",
|
|
423
|
+
* industry: "513210",
|
|
424
|
+
* stateOfIncorporation: "DE",
|
|
425
|
+
* incorporationDate: "2018-03-12",
|
|
426
|
+
* registeredAddress: {
|
|
427
|
+
* streetLine1: "251 Little Falls Dr",
|
|
428
|
+
* city: "Wilmington",
|
|
429
|
+
* subdivision: "DE",
|
|
430
|
+
* postalCode: "19808",
|
|
431
|
+
* country: "US"
|
|
432
|
+
* },
|
|
433
|
+
* physicalAddress: {
|
|
434
|
+
* streetLine1: "900 Harrison St",
|
|
435
|
+
* city: "San Francisco",
|
|
436
|
+
* subdivision: "CA",
|
|
437
|
+
* postalCode: "94107",
|
|
438
|
+
* country: "US"
|
|
439
|
+
* },
|
|
440
|
+
* sourceOfFunds: ["business_revenue"],
|
|
441
|
+
* countriesOfOperations: ["US", "CA"]
|
|
442
|
+
* },
|
|
443
|
+
* beneficialOwners: [{
|
|
444
|
+
* firstName: "Morgan",
|
|
445
|
+
* lastName: "Lee",
|
|
446
|
+
* email: "morgan.lee@acme.com",
|
|
447
|
+
* phone: "+14155550176",
|
|
448
|
+
* dateOfBirth: "1985-09-02",
|
|
449
|
+
* address: {
|
|
450
|
+
* streetLine1: "128 Alamo Square",
|
|
451
|
+
* city: "San Francisco",
|
|
452
|
+
* subdivision: "CA",
|
|
453
|
+
* postalCode: "94117",
|
|
454
|
+
* country: "US"
|
|
455
|
+
* },
|
|
456
|
+
* ownershipPercentage: 60,
|
|
457
|
+
* title: "ceo",
|
|
458
|
+
* countryOfCitizenship: "US",
|
|
459
|
+
* employmentStatus: "employed"
|
|
460
|
+
* }]
|
|
412
461
|
* }],
|
|
413
462
|
* agents: [{
|
|
414
463
|
* agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
|
package/dist/cjs/api/resources/customers/client/requests/CreateInvitationsCustomersRequest.d.ts
CHANGED
|
@@ -4,7 +4,56 @@ import type * as Natural from "../../../../index.js";
|
|
|
4
4
|
* {
|
|
5
5
|
* recipients: [{
|
|
6
6
|
* type: "email",
|
|
7
|
-
* value: "ops@acme.com"
|
|
7
|
+
* value: "ops@acme.com",
|
|
8
|
+
* accountType: "business",
|
|
9
|
+
* firstName: "Morgan",
|
|
10
|
+
* lastName: "Lee",
|
|
11
|
+
* phone: "+14155550176",
|
|
12
|
+
* business: {
|
|
13
|
+
* legalName: "Acme Logistics LLC",
|
|
14
|
+
* displayName: "Acme Logistics",
|
|
15
|
+
* website: "https://acmelogistics.com",
|
|
16
|
+
* hasTradeName: true,
|
|
17
|
+
* tradeName: "Acme Freight",
|
|
18
|
+
* businessType: "llc",
|
|
19
|
+
* industry: "513210",
|
|
20
|
+
* stateOfIncorporation: "DE",
|
|
21
|
+
* incorporationDate: "2018-03-12",
|
|
22
|
+
* registeredAddress: {
|
|
23
|
+
* streetLine1: "251 Little Falls Dr",
|
|
24
|
+
* city: "Wilmington",
|
|
25
|
+
* subdivision: "DE",
|
|
26
|
+
* postalCode: "19808",
|
|
27
|
+
* country: "US"
|
|
28
|
+
* },
|
|
29
|
+
* physicalAddress: {
|
|
30
|
+
* streetLine1: "900 Harrison St",
|
|
31
|
+
* city: "San Francisco",
|
|
32
|
+
* subdivision: "CA",
|
|
33
|
+
* postalCode: "94107",
|
|
34
|
+
* country: "US"
|
|
35
|
+
* },
|
|
36
|
+
* sourceOfFunds: ["business_revenue"],
|
|
37
|
+
* countriesOfOperations: ["US", "CA"]
|
|
38
|
+
* },
|
|
39
|
+
* beneficialOwners: [{
|
|
40
|
+
* firstName: "Morgan",
|
|
41
|
+
* lastName: "Lee",
|
|
42
|
+
* email: "morgan.lee@acme.com",
|
|
43
|
+
* phone: "+14155550176",
|
|
44
|
+
* dateOfBirth: "1985-09-02",
|
|
45
|
+
* address: {
|
|
46
|
+
* streetLine1: "128 Alamo Square",
|
|
47
|
+
* city: "San Francisco",
|
|
48
|
+
* subdivision: "CA",
|
|
49
|
+
* postalCode: "94117",
|
|
50
|
+
* country: "US"
|
|
51
|
+
* },
|
|
52
|
+
* ownershipPercentage: 60,
|
|
53
|
+
* title: "ceo",
|
|
54
|
+
* countryOfCitizenship: "US",
|
|
55
|
+
* employmentStatus: "employed"
|
|
56
|
+
* }]
|
|
8
57
|
* }],
|
|
9
58
|
* agents: [{
|
|
10
59
|
* agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
|
|
@@ -31,6 +80,6 @@ export interface CreateInvitationsCustomersRequest {
|
|
|
31
80
|
message?: string;
|
|
32
81
|
/** Tags applied to each invitation. */
|
|
33
82
|
tags?: Record<string, string>;
|
|
34
|
-
/**
|
|
83
|
+
/** Set to ["recipient"] to skip our notification to the counterparty and deliver the returned link yourself. */
|
|
35
84
|
disableNotifications?: Natural.CreateInvitationsCustomersRequestDisableNotificationsItem[];
|
|
36
85
|
}
|
|
@@ -2,13 +2,13 @@ import type * as Natural from "../../../index.js";
|
|
|
2
2
|
export interface CreateInvitationsCustomersRequestRecipientsItemEmail {
|
|
3
3
|
/** Email address. */
|
|
4
4
|
value: string;
|
|
5
|
-
/**
|
|
5
|
+
/** Account type */
|
|
6
6
|
accountType?: Natural.CustomerInvitationAccountType;
|
|
7
7
|
/** Legal first name of the person signing up. */
|
|
8
8
|
firstName?: string;
|
|
9
9
|
/** Legal last name of the person signing up. */
|
|
10
10
|
lastName?: string;
|
|
11
|
-
/** Phone number of the person signing up (E.164)
|
|
11
|
+
/** Phone number of the person signing up (E.164) */
|
|
12
12
|
phone?: string;
|
|
13
13
|
/** Identity-verification details for individual accounts. */
|
|
14
14
|
individual?: Natural.CustomerInvitationIndividual;
|
|
@@ -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.CustomerInvitationAccountType = void 0;
|
|
5
|
-
/**
|
|
5
|
+
/** Account type */
|
|
6
6
|
exports.CustomerInvitationAccountType = {
|
|
7
7
|
Individual: "individual",
|
|
8
8
|
Business: "business",
|
|
@@ -34,6 +34,6 @@ export interface NewPayReqParams {
|
|
|
34
34
|
payerName?: string;
|
|
35
35
|
/** Who pays: exactly one typed email, phone, party ID, agent ID, or handle value. */
|
|
36
36
|
payer: Natural.CreatePaymentRequestsRequestPayer;
|
|
37
|
-
/**
|
|
37
|
+
/** Set to ["recipient"] to skip our notification to the counterparty and deliver the returned link yourself. */
|
|
38
38
|
disableNotifications?: Natural.CreatePaymentRequestsRequestDisableNotificationsItem[];
|
|
39
39
|
}
|
|
@@ -32,6 +32,6 @@ export interface NewPaymentParams {
|
|
|
32
32
|
tags?: Record<string, string>;
|
|
33
33
|
/** Source wallet ID (wal_*). Omit to pay from the sender party's default wallet. */
|
|
34
34
|
walletId?: string;
|
|
35
|
-
/**
|
|
35
|
+
/** Set to ["recipient"] to skip our notification to the counterparty and deliver the returned link yourself. */
|
|
36
36
|
disableNotifications?: Natural.CreatePaymentsRequestDisableNotificationsItem[];
|
|
37
37
|
}
|
|
@@ -38,6 +38,7 @@ export declare class SimulationsClient {
|
|
|
38
38
|
* await client.simulations.inviteCustomer({
|
|
39
39
|
* idempotencyKey: "Idempotency-Key",
|
|
40
40
|
* agentIds: ["agt_550e8400e29b41d4a716446655440000"],
|
|
41
|
+
* permissions: ["wallets.create", "wallets.deposit", "wallets.withdraw", "wallets.transfer"],
|
|
41
42
|
* type: "ORG"
|
|
42
43
|
* })
|
|
43
44
|
*/
|
|
@@ -96,6 +96,7 @@ class SimulationsClient {
|
|
|
96
96
|
* await client.simulations.inviteCustomer({
|
|
97
97
|
* idempotencyKey: "Idempotency-Key",
|
|
98
98
|
* agentIds: ["agt_550e8400e29b41d4a716446655440000"],
|
|
99
|
+
* permissions: ["wallets.create", "wallets.deposit", "wallets.withdraw", "wallets.transfer"],
|
|
99
100
|
* type: "ORG"
|
|
100
101
|
* })
|
|
101
102
|
*/
|
package/dist/cjs/api/resources/simulations/client/requests/InviteCustomerSimulationsRequest.d.ts
CHANGED
|
@@ -4,6 +4,7 @@ import type * as Natural from "../../../../index.js";
|
|
|
4
4
|
* {
|
|
5
5
|
* idempotencyKey: "Idempotency-Key",
|
|
6
6
|
* agentIds: ["agt_550e8400e29b41d4a716446655440000"],
|
|
7
|
+
* permissions: ["wallets.create", "wallets.deposit", "wallets.withdraw", "wallets.transfer"],
|
|
7
8
|
* type: "ORG"
|
|
8
9
|
* }
|
|
9
10
|
*/
|
|
@@ -12,6 +13,8 @@ export interface InviteCustomerSimulationsRequest {
|
|
|
12
13
|
idempotencyKey: string;
|
|
13
14
|
/** Agents to grant access to. The test customer receives a pending invitation for each agent listed. */
|
|
14
15
|
agentIds: string[];
|
|
16
|
+
/** Permissions to request for each agent. Defaults to send and view payments, and view wallets. */
|
|
17
|
+
permissions?: Natural.InviteCustomerSimulationsRequestPermissionsItem[];
|
|
15
18
|
/** Test customer party type. Defaults to PERSON. */
|
|
16
19
|
type?: Natural.InviteCustomerSimulationsRequestType;
|
|
17
20
|
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
export declare const InviteCustomerSimulationsRequestPermissionsItem: {
|
|
2
|
+
readonly PaymentsRead: "payments.read";
|
|
3
|
+
readonly PaymentsCreate: "payments.create";
|
|
4
|
+
readonly ExternalPartiesRead: "external_parties.read";
|
|
5
|
+
readonly ExternalPartiesCreate: "external_parties.create";
|
|
6
|
+
readonly DirectRead: "direct.read";
|
|
7
|
+
readonly DirectCreate: "direct.create";
|
|
8
|
+
readonly ExternalAccountsCreate: "external_accounts.create";
|
|
9
|
+
readonly WalletsRead: "wallets.read";
|
|
10
|
+
readonly WalletsCreate: "wallets.create";
|
|
11
|
+
readonly WalletsUpdate: "wallets.update";
|
|
12
|
+
readonly WalletsFund: "wallets.fund";
|
|
13
|
+
readonly WalletsDeposit: "wallets.deposit";
|
|
14
|
+
readonly WalletsTransfer: "wallets.transfer";
|
|
15
|
+
readonly WalletsWithdraw: "wallets.withdraw";
|
|
16
|
+
readonly PartyRead: "party.read";
|
|
17
|
+
readonly PartyUpdate: "party.update";
|
|
18
|
+
};
|
|
19
|
+
export type InviteCustomerSimulationsRequestPermissionsItem = (typeof InviteCustomerSimulationsRequestPermissionsItem)[keyof typeof InviteCustomerSimulationsRequestPermissionsItem];
|
package/dist/cjs/api/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.js
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.InviteCustomerSimulationsRequestPermissionsItem = void 0;
|
|
5
|
+
exports.InviteCustomerSimulationsRequestPermissionsItem = {
|
|
6
|
+
PaymentsRead: "payments.read",
|
|
7
|
+
PaymentsCreate: "payments.create",
|
|
8
|
+
ExternalPartiesRead: "external_parties.read",
|
|
9
|
+
ExternalPartiesCreate: "external_parties.create",
|
|
10
|
+
DirectRead: "direct.read",
|
|
11
|
+
DirectCreate: "direct.create",
|
|
12
|
+
ExternalAccountsCreate: "external_accounts.create",
|
|
13
|
+
WalletsRead: "wallets.read",
|
|
14
|
+
WalletsCreate: "wallets.create",
|
|
15
|
+
WalletsUpdate: "wallets.update",
|
|
16
|
+
WalletsFund: "wallets.fund",
|
|
17
|
+
WalletsDeposit: "wallets.deposit",
|
|
18
|
+
WalletsTransfer: "wallets.transfer",
|
|
19
|
+
WalletsWithdraw: "wallets.withdraw",
|
|
20
|
+
PartyRead: "party.read",
|
|
21
|
+
PartyUpdate: "party.update",
|
|
22
|
+
};
|
|
@@ -125,6 +125,7 @@ export * from "./FundCustomerSimulationsResponseDataRelationshipsWallet.js";
|
|
|
125
125
|
export * from "./FundCustomerSimulationsResponseDataRelationshipsWalletData.js";
|
|
126
126
|
export * from "./FundCustomerSimulationsResponseDataRelationshipsWalletDataType.js";
|
|
127
127
|
export * from "./FundCustomerSimulationsResponseDataType.js";
|
|
128
|
+
export * from "./InviteCustomerSimulationsRequestPermissionsItem.js";
|
|
128
129
|
export * from "./InviteCustomerSimulationsRequestType.js";
|
|
129
130
|
export * from "./InviteCustomerSimulationsResponse.js";
|
|
130
131
|
export * from "./InviteCustomerSimulationsResponseDataItem.js";
|
|
@@ -141,6 +141,7 @@ __exportStar(require("./FundCustomerSimulationsResponseDataRelationshipsWallet.j
|
|
|
141
141
|
__exportStar(require("./FundCustomerSimulationsResponseDataRelationshipsWalletData.js"), exports);
|
|
142
142
|
__exportStar(require("./FundCustomerSimulationsResponseDataRelationshipsWalletDataType.js"), exports);
|
|
143
143
|
__exportStar(require("./FundCustomerSimulationsResponseDataType.js"), exports);
|
|
144
|
+
__exportStar(require("./InviteCustomerSimulationsRequestPermissionsItem.js"), exports);
|
|
144
145
|
__exportStar(require("./InviteCustomerSimulationsRequestType.js"), exports);
|
|
145
146
|
__exportStar(require("./InviteCustomerSimulationsResponse.js"), exports);
|
|
146
147
|
__exportStar(require("./InviteCustomerSimulationsResponseDataItem.js"), exports);
|
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
import type * as Natural from "../../../../../api/index.js";
|
|
2
2
|
import * as core from "../../../../../core/index.js";
|
|
3
3
|
import type * as serializers from "../../../../index.js";
|
|
4
|
+
import { InviteCustomerSimulationsRequestPermissionsItem } from "../../types/InviteCustomerSimulationsRequestPermissionsItem.js";
|
|
4
5
|
import { InviteCustomerSimulationsRequestType } from "../../types/InviteCustomerSimulationsRequestType.js";
|
|
5
6
|
export declare const InviteCustomerSimulationsRequest: core.serialization.Schema<serializers.InviteCustomerSimulationsRequest.Raw, Omit<Natural.InviteCustomerSimulationsRequest, "idempotencyKey">>;
|
|
6
7
|
export declare namespace InviteCustomerSimulationsRequest {
|
|
7
8
|
interface Raw {
|
|
8
9
|
agentIds: string[];
|
|
10
|
+
permissions?: InviteCustomerSimulationsRequestPermissionsItem.Raw[] | null;
|
|
9
11
|
type?: InviteCustomerSimulationsRequestType.Raw | null;
|
|
10
12
|
}
|
|
11
13
|
}
|
|
@@ -36,8 +36,10 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
36
36
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
37
37
|
exports.InviteCustomerSimulationsRequest = void 0;
|
|
38
38
|
const core = __importStar(require("../../../../../core/index.js"));
|
|
39
|
+
const InviteCustomerSimulationsRequestPermissionsItem_js_1 = require("../../types/InviteCustomerSimulationsRequestPermissionsItem.js");
|
|
39
40
|
const InviteCustomerSimulationsRequestType_js_1 = require("../../types/InviteCustomerSimulationsRequestType.js");
|
|
40
41
|
exports.InviteCustomerSimulationsRequest = core.serialization.object({
|
|
41
42
|
agentIds: core.serialization.list(core.serialization.string()),
|
|
43
|
+
permissions: core.serialization.list(InviteCustomerSimulationsRequestPermissionsItem_js_1.InviteCustomerSimulationsRequestPermissionsItem).optional(),
|
|
42
44
|
type: InviteCustomerSimulationsRequestType_js_1.InviteCustomerSimulationsRequestType.optional(),
|
|
43
45
|
});
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type * as Natural from "../../../../api/index.js";
|
|
2
|
+
import * as core from "../../../../core/index.js";
|
|
3
|
+
import type * as serializers from "../../../index.js";
|
|
4
|
+
export declare const InviteCustomerSimulationsRequestPermissionsItem: core.serialization.Schema<serializers.InviteCustomerSimulationsRequestPermissionsItem.Raw, Natural.InviteCustomerSimulationsRequestPermissionsItem>;
|
|
5
|
+
export declare namespace InviteCustomerSimulationsRequestPermissionsItem {
|
|
6
|
+
type Raw = "payments.read" | "payments.create" | "external_parties.read" | "external_parties.create" | "direct.read" | "direct.create" | "external_accounts.create" | "wallets.read" | "wallets.create" | "wallets.update" | "wallets.fund" | "wallets.deposit" | "wallets.transfer" | "wallets.withdraw" | "party.read" | "party.update";
|
|
7
|
+
}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
15
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
16
|
+
}) : function(o, v) {
|
|
17
|
+
o["default"] = v;
|
|
18
|
+
});
|
|
19
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
20
|
+
var ownKeys = function(o) {
|
|
21
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
22
|
+
var ar = [];
|
|
23
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
24
|
+
return ar;
|
|
25
|
+
};
|
|
26
|
+
return ownKeys(o);
|
|
27
|
+
};
|
|
28
|
+
return function (mod) {
|
|
29
|
+
if (mod && mod.__esModule) return mod;
|
|
30
|
+
var result = {};
|
|
31
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
32
|
+
__setModuleDefault(result, mod);
|
|
33
|
+
return result;
|
|
34
|
+
};
|
|
35
|
+
})();
|
|
36
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
37
|
+
exports.InviteCustomerSimulationsRequestPermissionsItem = void 0;
|
|
38
|
+
const core = __importStar(require("../../../../core/index.js"));
|
|
39
|
+
exports.InviteCustomerSimulationsRequestPermissionsItem = core.serialization.enum_([
|
|
40
|
+
"payments.read",
|
|
41
|
+
"payments.create",
|
|
42
|
+
"external_parties.read",
|
|
43
|
+
"external_parties.create",
|
|
44
|
+
"direct.read",
|
|
45
|
+
"direct.create",
|
|
46
|
+
"external_accounts.create",
|
|
47
|
+
"wallets.read",
|
|
48
|
+
"wallets.create",
|
|
49
|
+
"wallets.update",
|
|
50
|
+
"wallets.fund",
|
|
51
|
+
"wallets.deposit",
|
|
52
|
+
"wallets.transfer",
|
|
53
|
+
"wallets.withdraw",
|
|
54
|
+
"party.read",
|
|
55
|
+
"party.update",
|
|
56
|
+
]);
|
|
@@ -125,6 +125,7 @@ export * from "./FundCustomerSimulationsResponseDataRelationshipsWallet.js";
|
|
|
125
125
|
export * from "./FundCustomerSimulationsResponseDataRelationshipsWalletData.js";
|
|
126
126
|
export * from "./FundCustomerSimulationsResponseDataRelationshipsWalletDataType.js";
|
|
127
127
|
export * from "./FundCustomerSimulationsResponseDataType.js";
|
|
128
|
+
export * from "./InviteCustomerSimulationsRequestPermissionsItem.js";
|
|
128
129
|
export * from "./InviteCustomerSimulationsRequestType.js";
|
|
129
130
|
export * from "./InviteCustomerSimulationsResponse.js";
|
|
130
131
|
export * from "./InviteCustomerSimulationsResponseDataItem.js";
|
|
@@ -141,6 +141,7 @@ __exportStar(require("./FundCustomerSimulationsResponseDataRelationshipsWallet.j
|
|
|
141
141
|
__exportStar(require("./FundCustomerSimulationsResponseDataRelationshipsWalletData.js"), exports);
|
|
142
142
|
__exportStar(require("./FundCustomerSimulationsResponseDataRelationshipsWalletDataType.js"), exports);
|
|
143
143
|
__exportStar(require("./FundCustomerSimulationsResponseDataType.js"), exports);
|
|
144
|
+
__exportStar(require("./InviteCustomerSimulationsRequestPermissionsItem.js"), exports);
|
|
144
145
|
__exportStar(require("./InviteCustomerSimulationsRequestType.js"), exports);
|
|
145
146
|
__exportStar(require("./InviteCustomerSimulationsResponse.js"), exports);
|
|
146
147
|
__exportStar(require("./InviteCustomerSimulationsResponseDataItem.js"), exports);
|
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.7";
|
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.7",
|
|
10
|
+
"User-Agent": "@naturalpay/sdk/1.2.7",
|
|
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,
|
|
@@ -117,7 +117,56 @@ export declare class CustomersClient {
|
|
|
117
117
|
* await client.customers.createInvitations({
|
|
118
118
|
* recipients: [{
|
|
119
119
|
* type: "email",
|
|
120
|
-
* value: "ops@acme.com"
|
|
120
|
+
* value: "ops@acme.com",
|
|
121
|
+
* accountType: "business",
|
|
122
|
+
* firstName: "Morgan",
|
|
123
|
+
* lastName: "Lee",
|
|
124
|
+
* phone: "+14155550176",
|
|
125
|
+
* business: {
|
|
126
|
+
* legalName: "Acme Logistics LLC",
|
|
127
|
+
* displayName: "Acme Logistics",
|
|
128
|
+
* website: "https://acmelogistics.com",
|
|
129
|
+
* hasTradeName: true,
|
|
130
|
+
* tradeName: "Acme Freight",
|
|
131
|
+
* businessType: "llc",
|
|
132
|
+
* industry: "513210",
|
|
133
|
+
* stateOfIncorporation: "DE",
|
|
134
|
+
* incorporationDate: "2018-03-12",
|
|
135
|
+
* registeredAddress: {
|
|
136
|
+
* streetLine1: "251 Little Falls Dr",
|
|
137
|
+
* city: "Wilmington",
|
|
138
|
+
* subdivision: "DE",
|
|
139
|
+
* postalCode: "19808",
|
|
140
|
+
* country: "US"
|
|
141
|
+
* },
|
|
142
|
+
* physicalAddress: {
|
|
143
|
+
* streetLine1: "900 Harrison St",
|
|
144
|
+
* city: "San Francisco",
|
|
145
|
+
* subdivision: "CA",
|
|
146
|
+
* postalCode: "94107",
|
|
147
|
+
* country: "US"
|
|
148
|
+
* },
|
|
149
|
+
* sourceOfFunds: ["business_revenue"],
|
|
150
|
+
* countriesOfOperations: ["US", "CA"]
|
|
151
|
+
* },
|
|
152
|
+
* beneficialOwners: [{
|
|
153
|
+
* firstName: "Morgan",
|
|
154
|
+
* lastName: "Lee",
|
|
155
|
+
* email: "morgan.lee@acme.com",
|
|
156
|
+
* phone: "+14155550176",
|
|
157
|
+
* dateOfBirth: "1985-09-02",
|
|
158
|
+
* address: {
|
|
159
|
+
* streetLine1: "128 Alamo Square",
|
|
160
|
+
* city: "San Francisco",
|
|
161
|
+
* subdivision: "CA",
|
|
162
|
+
* postalCode: "94117",
|
|
163
|
+
* country: "US"
|
|
164
|
+
* },
|
|
165
|
+
* ownershipPercentage: 60,
|
|
166
|
+
* title: "ceo",
|
|
167
|
+
* countryOfCitizenship: "US",
|
|
168
|
+
* employmentStatus: "employed"
|
|
169
|
+
* }]
|
|
121
170
|
* }],
|
|
122
171
|
* agents: [{
|
|
123
172
|
* agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
|
|
@@ -372,7 +372,56 @@ export class CustomersClient {
|
|
|
372
372
|
* await client.customers.createInvitations({
|
|
373
373
|
* recipients: [{
|
|
374
374
|
* type: "email",
|
|
375
|
-
* value: "ops@acme.com"
|
|
375
|
+
* value: "ops@acme.com",
|
|
376
|
+
* accountType: "business",
|
|
377
|
+
* firstName: "Morgan",
|
|
378
|
+
* lastName: "Lee",
|
|
379
|
+
* phone: "+14155550176",
|
|
380
|
+
* business: {
|
|
381
|
+
* legalName: "Acme Logistics LLC",
|
|
382
|
+
* displayName: "Acme Logistics",
|
|
383
|
+
* website: "https://acmelogistics.com",
|
|
384
|
+
* hasTradeName: true,
|
|
385
|
+
* tradeName: "Acme Freight",
|
|
386
|
+
* businessType: "llc",
|
|
387
|
+
* industry: "513210",
|
|
388
|
+
* stateOfIncorporation: "DE",
|
|
389
|
+
* incorporationDate: "2018-03-12",
|
|
390
|
+
* registeredAddress: {
|
|
391
|
+
* streetLine1: "251 Little Falls Dr",
|
|
392
|
+
* city: "Wilmington",
|
|
393
|
+
* subdivision: "DE",
|
|
394
|
+
* postalCode: "19808",
|
|
395
|
+
* country: "US"
|
|
396
|
+
* },
|
|
397
|
+
* physicalAddress: {
|
|
398
|
+
* streetLine1: "900 Harrison St",
|
|
399
|
+
* city: "San Francisco",
|
|
400
|
+
* subdivision: "CA",
|
|
401
|
+
* postalCode: "94107",
|
|
402
|
+
* country: "US"
|
|
403
|
+
* },
|
|
404
|
+
* sourceOfFunds: ["business_revenue"],
|
|
405
|
+
* countriesOfOperations: ["US", "CA"]
|
|
406
|
+
* },
|
|
407
|
+
* beneficialOwners: [{
|
|
408
|
+
* firstName: "Morgan",
|
|
409
|
+
* lastName: "Lee",
|
|
410
|
+
* email: "morgan.lee@acme.com",
|
|
411
|
+
* phone: "+14155550176",
|
|
412
|
+
* dateOfBirth: "1985-09-02",
|
|
413
|
+
* address: {
|
|
414
|
+
* streetLine1: "128 Alamo Square",
|
|
415
|
+
* city: "San Francisco",
|
|
416
|
+
* subdivision: "CA",
|
|
417
|
+
* postalCode: "94117",
|
|
418
|
+
* country: "US"
|
|
419
|
+
* },
|
|
420
|
+
* ownershipPercentage: 60,
|
|
421
|
+
* title: "ceo",
|
|
422
|
+
* countryOfCitizenship: "US",
|
|
423
|
+
* employmentStatus: "employed"
|
|
424
|
+
* }]
|
|
376
425
|
* }],
|
|
377
426
|
* agents: [{
|
|
378
427
|
* agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
|
package/dist/esm/api/resources/customers/client/requests/CreateInvitationsCustomersRequest.d.mts
CHANGED
|
@@ -4,7 +4,56 @@ import type * as Natural from "../../../../index.mjs";
|
|
|
4
4
|
* {
|
|
5
5
|
* recipients: [{
|
|
6
6
|
* type: "email",
|
|
7
|
-
* value: "ops@acme.com"
|
|
7
|
+
* value: "ops@acme.com",
|
|
8
|
+
* accountType: "business",
|
|
9
|
+
* firstName: "Morgan",
|
|
10
|
+
* lastName: "Lee",
|
|
11
|
+
* phone: "+14155550176",
|
|
12
|
+
* business: {
|
|
13
|
+
* legalName: "Acme Logistics LLC",
|
|
14
|
+
* displayName: "Acme Logistics",
|
|
15
|
+
* website: "https://acmelogistics.com",
|
|
16
|
+
* hasTradeName: true,
|
|
17
|
+
* tradeName: "Acme Freight",
|
|
18
|
+
* businessType: "llc",
|
|
19
|
+
* industry: "513210",
|
|
20
|
+
* stateOfIncorporation: "DE",
|
|
21
|
+
* incorporationDate: "2018-03-12",
|
|
22
|
+
* registeredAddress: {
|
|
23
|
+
* streetLine1: "251 Little Falls Dr",
|
|
24
|
+
* city: "Wilmington",
|
|
25
|
+
* subdivision: "DE",
|
|
26
|
+
* postalCode: "19808",
|
|
27
|
+
* country: "US"
|
|
28
|
+
* },
|
|
29
|
+
* physicalAddress: {
|
|
30
|
+
* streetLine1: "900 Harrison St",
|
|
31
|
+
* city: "San Francisco",
|
|
32
|
+
* subdivision: "CA",
|
|
33
|
+
* postalCode: "94107",
|
|
34
|
+
* country: "US"
|
|
35
|
+
* },
|
|
36
|
+
* sourceOfFunds: ["business_revenue"],
|
|
37
|
+
* countriesOfOperations: ["US", "CA"]
|
|
38
|
+
* },
|
|
39
|
+
* beneficialOwners: [{
|
|
40
|
+
* firstName: "Morgan",
|
|
41
|
+
* lastName: "Lee",
|
|
42
|
+
* email: "morgan.lee@acme.com",
|
|
43
|
+
* phone: "+14155550176",
|
|
44
|
+
* dateOfBirth: "1985-09-02",
|
|
45
|
+
* address: {
|
|
46
|
+
* streetLine1: "128 Alamo Square",
|
|
47
|
+
* city: "San Francisco",
|
|
48
|
+
* subdivision: "CA",
|
|
49
|
+
* postalCode: "94117",
|
|
50
|
+
* country: "US"
|
|
51
|
+
* },
|
|
52
|
+
* ownershipPercentage: 60,
|
|
53
|
+
* title: "ceo",
|
|
54
|
+
* countryOfCitizenship: "US",
|
|
55
|
+
* employmentStatus: "employed"
|
|
56
|
+
* }]
|
|
8
57
|
* }],
|
|
9
58
|
* agents: [{
|
|
10
59
|
* agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
|
|
@@ -31,6 +80,6 @@ export interface CreateInvitationsCustomersRequest {
|
|
|
31
80
|
message?: string;
|
|
32
81
|
/** Tags applied to each invitation. */
|
|
33
82
|
tags?: Record<string, string>;
|
|
34
|
-
/**
|
|
83
|
+
/** Set to ["recipient"] to skip our notification to the counterparty and deliver the returned link yourself. */
|
|
35
84
|
disableNotifications?: Natural.CreateInvitationsCustomersRequestDisableNotificationsItem[];
|
|
36
85
|
}
|
|
@@ -2,13 +2,13 @@ import type * as Natural from "../../../index.mjs";
|
|
|
2
2
|
export interface CreateInvitationsCustomersRequestRecipientsItemEmail {
|
|
3
3
|
/** Email address. */
|
|
4
4
|
value: string;
|
|
5
|
-
/**
|
|
5
|
+
/** Account type */
|
|
6
6
|
accountType?: Natural.CustomerInvitationAccountType;
|
|
7
7
|
/** Legal first name of the person signing up. */
|
|
8
8
|
firstName?: string;
|
|
9
9
|
/** Legal last name of the person signing up. */
|
|
10
10
|
lastName?: string;
|
|
11
|
-
/** Phone number of the person signing up (E.164)
|
|
11
|
+
/** Phone number of the person signing up (E.164) */
|
|
12
12
|
phone?: string;
|
|
13
13
|
/** Identity-verification details for individual accounts. */
|
|
14
14
|
individual?: Natural.CustomerInvitationIndividual;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
-
/**
|
|
2
|
+
/** Account type */
|
|
3
3
|
export const CustomerInvitationAccountType = {
|
|
4
4
|
Individual: "individual",
|
|
5
5
|
Business: "business",
|
|
@@ -34,6 +34,6 @@ export interface NewPayReqParams {
|
|
|
34
34
|
payerName?: string;
|
|
35
35
|
/** Who pays: exactly one typed email, phone, party ID, agent ID, or handle value. */
|
|
36
36
|
payer: Natural.CreatePaymentRequestsRequestPayer;
|
|
37
|
-
/**
|
|
37
|
+
/** Set to ["recipient"] to skip our notification to the counterparty and deliver the returned link yourself. */
|
|
38
38
|
disableNotifications?: Natural.CreatePaymentRequestsRequestDisableNotificationsItem[];
|
|
39
39
|
}
|
|
@@ -32,6 +32,6 @@ export interface NewPaymentParams {
|
|
|
32
32
|
tags?: Record<string, string>;
|
|
33
33
|
/** Source wallet ID (wal_*). Omit to pay from the sender party's default wallet. */
|
|
34
34
|
walletId?: string;
|
|
35
|
-
/**
|
|
35
|
+
/** Set to ["recipient"] to skip our notification to the counterparty and deliver the returned link yourself. */
|
|
36
36
|
disableNotifications?: Natural.CreatePaymentsRequestDisableNotificationsItem[];
|
|
37
37
|
}
|
|
@@ -38,6 +38,7 @@ export declare class SimulationsClient {
|
|
|
38
38
|
* await client.simulations.inviteCustomer({
|
|
39
39
|
* idempotencyKey: "Idempotency-Key",
|
|
40
40
|
* agentIds: ["agt_550e8400e29b41d4a716446655440000"],
|
|
41
|
+
* permissions: ["wallets.create", "wallets.deposit", "wallets.withdraw", "wallets.transfer"],
|
|
41
42
|
* type: "ORG"
|
|
42
43
|
* })
|
|
43
44
|
*/
|
|
@@ -60,6 +60,7 @@ export class SimulationsClient {
|
|
|
60
60
|
* await client.simulations.inviteCustomer({
|
|
61
61
|
* idempotencyKey: "Idempotency-Key",
|
|
62
62
|
* agentIds: ["agt_550e8400e29b41d4a716446655440000"],
|
|
63
|
+
* permissions: ["wallets.create", "wallets.deposit", "wallets.withdraw", "wallets.transfer"],
|
|
63
64
|
* type: "ORG"
|
|
64
65
|
* })
|
|
65
66
|
*/
|
package/dist/esm/api/resources/simulations/client/requests/InviteCustomerSimulationsRequest.d.mts
CHANGED
|
@@ -4,6 +4,7 @@ import type * as Natural from "../../../../index.mjs";
|
|
|
4
4
|
* {
|
|
5
5
|
* idempotencyKey: "Idempotency-Key",
|
|
6
6
|
* agentIds: ["agt_550e8400e29b41d4a716446655440000"],
|
|
7
|
+
* permissions: ["wallets.create", "wallets.deposit", "wallets.withdraw", "wallets.transfer"],
|
|
7
8
|
* type: "ORG"
|
|
8
9
|
* }
|
|
9
10
|
*/
|
|
@@ -12,6 +13,8 @@ export interface InviteCustomerSimulationsRequest {
|
|
|
12
13
|
idempotencyKey: string;
|
|
13
14
|
/** Agents to grant access to. The test customer receives a pending invitation for each agent listed. */
|
|
14
15
|
agentIds: string[];
|
|
16
|
+
/** Permissions to request for each agent. Defaults to send and view payments, and view wallets. */
|
|
17
|
+
permissions?: Natural.InviteCustomerSimulationsRequestPermissionsItem[];
|
|
15
18
|
/** Test customer party type. Defaults to PERSON. */
|
|
16
19
|
type?: Natural.InviteCustomerSimulationsRequestType;
|
|
17
20
|
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
export declare const InviteCustomerSimulationsRequestPermissionsItem: {
|
|
2
|
+
readonly PaymentsRead: "payments.read";
|
|
3
|
+
readonly PaymentsCreate: "payments.create";
|
|
4
|
+
readonly ExternalPartiesRead: "external_parties.read";
|
|
5
|
+
readonly ExternalPartiesCreate: "external_parties.create";
|
|
6
|
+
readonly DirectRead: "direct.read";
|
|
7
|
+
readonly DirectCreate: "direct.create";
|
|
8
|
+
readonly ExternalAccountsCreate: "external_accounts.create";
|
|
9
|
+
readonly WalletsRead: "wallets.read";
|
|
10
|
+
readonly WalletsCreate: "wallets.create";
|
|
11
|
+
readonly WalletsUpdate: "wallets.update";
|
|
12
|
+
readonly WalletsFund: "wallets.fund";
|
|
13
|
+
readonly WalletsDeposit: "wallets.deposit";
|
|
14
|
+
readonly WalletsTransfer: "wallets.transfer";
|
|
15
|
+
readonly WalletsWithdraw: "wallets.withdraw";
|
|
16
|
+
readonly PartyRead: "party.read";
|
|
17
|
+
readonly PartyUpdate: "party.update";
|
|
18
|
+
};
|
|
19
|
+
export type InviteCustomerSimulationsRequestPermissionsItem = (typeof InviteCustomerSimulationsRequestPermissionsItem)[keyof typeof InviteCustomerSimulationsRequestPermissionsItem];
|
package/dist/esm/api/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.mjs
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
export const InviteCustomerSimulationsRequestPermissionsItem = {
|
|
3
|
+
PaymentsRead: "payments.read",
|
|
4
|
+
PaymentsCreate: "payments.create",
|
|
5
|
+
ExternalPartiesRead: "external_parties.read",
|
|
6
|
+
ExternalPartiesCreate: "external_parties.create",
|
|
7
|
+
DirectRead: "direct.read",
|
|
8
|
+
DirectCreate: "direct.create",
|
|
9
|
+
ExternalAccountsCreate: "external_accounts.create",
|
|
10
|
+
WalletsRead: "wallets.read",
|
|
11
|
+
WalletsCreate: "wallets.create",
|
|
12
|
+
WalletsUpdate: "wallets.update",
|
|
13
|
+
WalletsFund: "wallets.fund",
|
|
14
|
+
WalletsDeposit: "wallets.deposit",
|
|
15
|
+
WalletsTransfer: "wallets.transfer",
|
|
16
|
+
WalletsWithdraw: "wallets.withdraw",
|
|
17
|
+
PartyRead: "party.read",
|
|
18
|
+
PartyUpdate: "party.update",
|
|
19
|
+
};
|
|
@@ -125,6 +125,7 @@ export * from "./FundCustomerSimulationsResponseDataRelationshipsWallet.mjs";
|
|
|
125
125
|
export * from "./FundCustomerSimulationsResponseDataRelationshipsWalletData.mjs";
|
|
126
126
|
export * from "./FundCustomerSimulationsResponseDataRelationshipsWalletDataType.mjs";
|
|
127
127
|
export * from "./FundCustomerSimulationsResponseDataType.mjs";
|
|
128
|
+
export * from "./InviteCustomerSimulationsRequestPermissionsItem.mjs";
|
|
128
129
|
export * from "./InviteCustomerSimulationsRequestType.mjs";
|
|
129
130
|
export * from "./InviteCustomerSimulationsResponse.mjs";
|
|
130
131
|
export * from "./InviteCustomerSimulationsResponseDataItem.mjs";
|
|
@@ -125,6 +125,7 @@ export * from "./FundCustomerSimulationsResponseDataRelationshipsWallet.mjs";
|
|
|
125
125
|
export * from "./FundCustomerSimulationsResponseDataRelationshipsWalletData.mjs";
|
|
126
126
|
export * from "./FundCustomerSimulationsResponseDataRelationshipsWalletDataType.mjs";
|
|
127
127
|
export * from "./FundCustomerSimulationsResponseDataType.mjs";
|
|
128
|
+
export * from "./InviteCustomerSimulationsRequestPermissionsItem.mjs";
|
|
128
129
|
export * from "./InviteCustomerSimulationsRequestType.mjs";
|
|
129
130
|
export * from "./InviteCustomerSimulationsResponse.mjs";
|
|
130
131
|
export * from "./InviteCustomerSimulationsResponseDataItem.mjs";
|
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
import type * as Natural from "../../../../../api/index.mjs";
|
|
2
2
|
import * as core from "../../../../../core/index.mjs";
|
|
3
3
|
import type * as serializers from "../../../../index.mjs";
|
|
4
|
+
import { InviteCustomerSimulationsRequestPermissionsItem } from "../../types/InviteCustomerSimulationsRequestPermissionsItem.mjs";
|
|
4
5
|
import { InviteCustomerSimulationsRequestType } from "../../types/InviteCustomerSimulationsRequestType.mjs";
|
|
5
6
|
export declare const InviteCustomerSimulationsRequest: core.serialization.Schema<serializers.InviteCustomerSimulationsRequest.Raw, Omit<Natural.InviteCustomerSimulationsRequest, "idempotencyKey">>;
|
|
6
7
|
export declare namespace InviteCustomerSimulationsRequest {
|
|
7
8
|
interface Raw {
|
|
8
9
|
agentIds: string[];
|
|
10
|
+
permissions?: InviteCustomerSimulationsRequestPermissionsItem.Raw[] | null;
|
|
9
11
|
type?: InviteCustomerSimulationsRequestType.Raw | null;
|
|
10
12
|
}
|
|
11
13
|
}
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
2
|
import * as core from "../../../../../core/index.mjs";
|
|
3
|
+
import { InviteCustomerSimulationsRequestPermissionsItem } from "../../types/InviteCustomerSimulationsRequestPermissionsItem.mjs";
|
|
3
4
|
import { InviteCustomerSimulationsRequestType } from "../../types/InviteCustomerSimulationsRequestType.mjs";
|
|
4
5
|
export const InviteCustomerSimulationsRequest = core.serialization.object({
|
|
5
6
|
agentIds: core.serialization.list(core.serialization.string()),
|
|
7
|
+
permissions: core.serialization.list(InviteCustomerSimulationsRequestPermissionsItem).optional(),
|
|
6
8
|
type: InviteCustomerSimulationsRequestType.optional(),
|
|
7
9
|
});
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type * as Natural from "../../../../api/index.mjs";
|
|
2
|
+
import * as core from "../../../../core/index.mjs";
|
|
3
|
+
import type * as serializers from "../../../index.mjs";
|
|
4
|
+
export declare const InviteCustomerSimulationsRequestPermissionsItem: core.serialization.Schema<serializers.InviteCustomerSimulationsRequestPermissionsItem.Raw, Natural.InviteCustomerSimulationsRequestPermissionsItem>;
|
|
5
|
+
export declare namespace InviteCustomerSimulationsRequestPermissionsItem {
|
|
6
|
+
type Raw = "payments.read" | "payments.create" | "external_parties.read" | "external_parties.create" | "direct.read" | "direct.create" | "external_accounts.create" | "wallets.read" | "wallets.create" | "wallets.update" | "wallets.fund" | "wallets.deposit" | "wallets.transfer" | "wallets.withdraw" | "party.read" | "party.update";
|
|
7
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
import * as core from "../../../../core/index.mjs";
|
|
3
|
+
export const InviteCustomerSimulationsRequestPermissionsItem = core.serialization.enum_([
|
|
4
|
+
"payments.read",
|
|
5
|
+
"payments.create",
|
|
6
|
+
"external_parties.read",
|
|
7
|
+
"external_parties.create",
|
|
8
|
+
"direct.read",
|
|
9
|
+
"direct.create",
|
|
10
|
+
"external_accounts.create",
|
|
11
|
+
"wallets.read",
|
|
12
|
+
"wallets.create",
|
|
13
|
+
"wallets.update",
|
|
14
|
+
"wallets.fund",
|
|
15
|
+
"wallets.deposit",
|
|
16
|
+
"wallets.transfer",
|
|
17
|
+
"wallets.withdraw",
|
|
18
|
+
"party.read",
|
|
19
|
+
"party.update",
|
|
20
|
+
]);
|
|
@@ -125,6 +125,7 @@ export * from "./FundCustomerSimulationsResponseDataRelationshipsWallet.mjs";
|
|
|
125
125
|
export * from "./FundCustomerSimulationsResponseDataRelationshipsWalletData.mjs";
|
|
126
126
|
export * from "./FundCustomerSimulationsResponseDataRelationshipsWalletDataType.mjs";
|
|
127
127
|
export * from "./FundCustomerSimulationsResponseDataType.mjs";
|
|
128
|
+
export * from "./InviteCustomerSimulationsRequestPermissionsItem.mjs";
|
|
128
129
|
export * from "./InviteCustomerSimulationsRequestType.mjs";
|
|
129
130
|
export * from "./InviteCustomerSimulationsResponse.mjs";
|
|
130
131
|
export * from "./InviteCustomerSimulationsResponseDataItem.mjs";
|
|
@@ -125,6 +125,7 @@ export * from "./FundCustomerSimulationsResponseDataRelationshipsWallet.mjs";
|
|
|
125
125
|
export * from "./FundCustomerSimulationsResponseDataRelationshipsWalletData.mjs";
|
|
126
126
|
export * from "./FundCustomerSimulationsResponseDataRelationshipsWalletDataType.mjs";
|
|
127
127
|
export * from "./FundCustomerSimulationsResponseDataType.mjs";
|
|
128
|
+
export * from "./InviteCustomerSimulationsRequestPermissionsItem.mjs";
|
|
128
129
|
export * from "./InviteCustomerSimulationsRequestType.mjs";
|
|
129
130
|
export * from "./InviteCustomerSimulationsResponse.mjs";
|
|
130
131
|
export * from "./InviteCustomerSimulationsResponseDataItem.mjs";
|
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.7";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "1.2.
|
|
1
|
+
export const SDK_VERSION = "1.2.7";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -917,7 +917,56 @@ Invite specific customers by email or phone to approve a set of your agents, eac
|
|
|
917
917
|
await client.customers.createInvitations({
|
|
918
918
|
recipients: [{
|
|
919
919
|
type: "email",
|
|
920
|
-
value: "ops@acme.com"
|
|
920
|
+
value: "ops@acme.com",
|
|
921
|
+
accountType: "business",
|
|
922
|
+
firstName: "Morgan",
|
|
923
|
+
lastName: "Lee",
|
|
924
|
+
phone: "+14155550176",
|
|
925
|
+
business: {
|
|
926
|
+
legalName: "Acme Logistics LLC",
|
|
927
|
+
displayName: "Acme Logistics",
|
|
928
|
+
website: "https://acmelogistics.com",
|
|
929
|
+
hasTradeName: true,
|
|
930
|
+
tradeName: "Acme Freight",
|
|
931
|
+
businessType: "llc",
|
|
932
|
+
industry: "513210",
|
|
933
|
+
stateOfIncorporation: "DE",
|
|
934
|
+
incorporationDate: "2018-03-12",
|
|
935
|
+
registeredAddress: {
|
|
936
|
+
streetLine1: "251 Little Falls Dr",
|
|
937
|
+
city: "Wilmington",
|
|
938
|
+
subdivision: "DE",
|
|
939
|
+
postalCode: "19808",
|
|
940
|
+
country: "US"
|
|
941
|
+
},
|
|
942
|
+
physicalAddress: {
|
|
943
|
+
streetLine1: "900 Harrison St",
|
|
944
|
+
city: "San Francisco",
|
|
945
|
+
subdivision: "CA",
|
|
946
|
+
postalCode: "94107",
|
|
947
|
+
country: "US"
|
|
948
|
+
},
|
|
949
|
+
sourceOfFunds: ["business_revenue"],
|
|
950
|
+
countriesOfOperations: ["US", "CA"]
|
|
951
|
+
},
|
|
952
|
+
beneficialOwners: [{
|
|
953
|
+
firstName: "Morgan",
|
|
954
|
+
lastName: "Lee",
|
|
955
|
+
email: "morgan.lee@acme.com",
|
|
956
|
+
phone: "+14155550176",
|
|
957
|
+
dateOfBirth: "1985-09-02",
|
|
958
|
+
address: {
|
|
959
|
+
streetLine1: "128 Alamo Square",
|
|
960
|
+
city: "San Francisco",
|
|
961
|
+
subdivision: "CA",
|
|
962
|
+
postalCode: "94117",
|
|
963
|
+
country: "US"
|
|
964
|
+
},
|
|
965
|
+
ownershipPercentage: 60,
|
|
966
|
+
title: "ceo",
|
|
967
|
+
countryOfCitizenship: "US",
|
|
968
|
+
employmentStatus: "employed"
|
|
969
|
+
}]
|
|
921
970
|
}],
|
|
922
971
|
agents: [{
|
|
923
972
|
agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
|
|
@@ -5891,6 +5940,7 @@ Create a test customer and a pending invitation for each agent you name
|
|
|
5891
5940
|
await client.simulations.inviteCustomer({
|
|
5892
5941
|
idempotencyKey: "Idempotency-Key",
|
|
5893
5942
|
agentIds: ["agt_550e8400e29b41d4a716446655440000"],
|
|
5943
|
+
permissions: ["wallets.create", "wallets.deposit", "wallets.withdraw", "wallets.transfer"],
|
|
5894
5944
|
type: "ORG"
|
|
5895
5945
|
});
|
|
5896
5946
|
|