@naturalpay/sdk 1.6.0 → 1.6.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.
Files changed (24) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/customers/client/Client.d.ts +1 -50
  3. package/dist/cjs/api/resources/customers/client/Client.js +1 -50
  4. package/dist/cjs/api/resources/customers/client/requests/CreateInvitationsCustomersRequest.d.ts +2 -51
  5. package/dist/cjs/api/resources/externalAccounts/client/Client.d.ts +5 -3
  6. package/dist/cjs/api/resources/externalAccounts/client/Client.js +5 -3
  7. package/dist/cjs/api/resources/externalAccounts/client/requests/CreateFromProcessorTokenExternalAccountsRequest.d.ts +3 -3
  8. package/dist/cjs/api/resources/paymentRequests/client/requests/NewPayReqParams.d.ts +1 -1
  9. package/dist/cjs/api/resources/payments/client/requests/NewPaymentParams.d.ts +1 -1
  10. package/dist/cjs/version.d.ts +1 -1
  11. package/dist/cjs/version.js +1 -1
  12. package/dist/esm/BaseClient.mjs +2 -2
  13. package/dist/esm/api/resources/customers/client/Client.d.mts +1 -50
  14. package/dist/esm/api/resources/customers/client/Client.mjs +1 -50
  15. package/dist/esm/api/resources/customers/client/requests/CreateInvitationsCustomersRequest.d.mts +2 -51
  16. package/dist/esm/api/resources/externalAccounts/client/Client.d.mts +5 -3
  17. package/dist/esm/api/resources/externalAccounts/client/Client.mjs +5 -3
  18. package/dist/esm/api/resources/externalAccounts/client/requests/CreateFromProcessorTokenExternalAccountsRequest.d.mts +3 -3
  19. package/dist/esm/api/resources/paymentRequests/client/requests/NewPayReqParams.d.mts +1 -1
  20. package/dist/esm/api/resources/payments/client/requests/NewPaymentParams.d.mts +1 -1
  21. package/dist/esm/version.d.mts +1 -1
  22. package/dist/esm/version.mjs +1 -1
  23. package/package.json +1 -1
  24. package/reference.md +4 -53
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.6.0",
47
- "User-Agent": "@naturalpay/sdk/1.6.0",
46
+ "X-Fern-SDK-Version": "1.6.1",
47
+ "User-Agent": "@naturalpay/sdk/1.6.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,
package/dist/cjs/api/resources/customers/client/Client.d.ts CHANGED
@@ -117,56 +117,7 @@ export declare class CustomersClient {
117
117
  * await client.customers.createInvitations({
118
118
  * recipients: [{
119
119
  * type: "email",
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
- * beneficialOwners: [{
152
- * firstName: "Morgan",
153
- * lastName: "Lee",
154
- * email: "morgan.lee@acme.com",
155
- * phone: "+14155550176",
156
- * dateOfBirth: "1985-09-02",
157
- * address: {
158
- * streetLine1: "128 Alamo Square",
159
- * city: "San Francisco",
160
- * subdivision: "CA",
161
- * postalCode: "94117",
162
- * country: "US"
163
- * },
164
- * ownershipPercentage: 60,
165
- * title: "ceo",
166
- * countryOfCitizenship: "US",
167
- * employmentStatus: "employed"
168
- * }]
169
- * }
120
+ * value: "ops@acme.com"
170
121
  * }],
171
122
  * agents: [{
172
123
  * agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
package/dist/cjs/api/resources/customers/client/Client.js CHANGED
@@ -408,56 +408,7 @@ class CustomersClient {
408
408
  * await client.customers.createInvitations({
409
409
  * recipients: [{
410
410
  * type: "email",
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
- * beneficialOwners: [{
443
- * firstName: "Morgan",
444
- * lastName: "Lee",
445
- * email: "morgan.lee@acme.com",
446
- * phone: "+14155550176",
447
- * dateOfBirth: "1985-09-02",
448
- * address: {
449
- * streetLine1: "128 Alamo Square",
450
- * city: "San Francisco",
451
- * subdivision: "CA",
452
- * postalCode: "94117",
453
- * country: "US"
454
- * },
455
- * ownershipPercentage: 60,
456
- * title: "ceo",
457
- * countryOfCitizenship: "US",
458
- * employmentStatus: "employed"
459
- * }]
460
- * }
411
+ * value: "ops@acme.com"
461
412
  * }],
462
413
  * agents: [{
463
414
  * agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
package/dist/cjs/api/resources/customers/client/requests/CreateInvitationsCustomersRequest.d.ts CHANGED
@@ -4,56 +4,7 @@ import type * as Natural from "../../../../index.js";
4
4
  * {
5
5
  * recipients: [{
6
6
  * type: "email",
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
- * beneficialOwners: [{
39
- * firstName: "Morgan",
40
- * lastName: "Lee",
41
- * email: "morgan.lee@acme.com",
42
- * phone: "+14155550176",
43
- * dateOfBirth: "1985-09-02",
44
- * address: {
45
- * streetLine1: "128 Alamo Square",
46
- * city: "San Francisco",
47
- * subdivision: "CA",
48
- * postalCode: "94117",
49
- * country: "US"
50
- * },
51
- * ownershipPercentage: 60,
52
- * title: "ceo",
53
- * countryOfCitizenship: "US",
54
- * employmentStatus: "employed"
55
- * }]
56
- * }
7
+ * value: "ops@acme.com"
57
8
  * }],
58
9
  * agents: [{
59
10
  * agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
@@ -80,6 +31,6 @@ export interface CreateInvitationsCustomersRequest {
80
31
  message?: string;
81
32
  /** Tags applied to each invitation. */
82
33
  tags?: Record<string, string>;
83
- /** Set to ["recipient"] to skip our notification to the counterparty and deliver the returned link yourself. */
34
+ /** Deprecated. Previously skipped our notification to the counterparty; Natural now always sends its own notifications and this field is accepted but ignored. The returned link is unaffected. */
84
35
  disableNotifications?: Natural.CreateInvitationsCustomersRequestDisableNotificationsItem[];
85
36
  }
package/dist/cjs/api/resources/externalAccounts/client/Client.d.ts CHANGED
@@ -14,6 +14,8 @@ export declare class ExternalAccountsClient {
14
14
  protected readonly _options: NormalizedClientOptionsWithAuth<ExternalAccountsClient.Options>;
15
15
  constructor(options?: ExternalAccountsClient.Options);
16
16
  /**
17
+ * @deprecated
18
+ *
17
19
  * Link or refresh a bank account using a Plaid processor token
18
20
  *
19
21
  * @param {Natural.CreateFromProcessorTokenExternalAccountsRequest} request
@@ -37,11 +39,11 @@ export declare class ExternalAccountsClient {
37
39
  * @example
38
40
  * await client.externalAccounts.createFromProcessorToken({
39
41
  * idempotencyKey: "Idempotency-Key",
40
- * partyId: "pty_7c9e6679e29b41d4a716446655440001",
42
+ * partyId: "pty_550e8400e29b41d4a716446655440000",
41
43
  * processorToken: "processor-sandbox-abc123",
42
- * institutionName: "Chase",
44
+ * institutionName: "Plaid Sandbox",
43
45
  * tags: {
44
- * "environment": "production"
46
+ * "environment": "sandbox"
45
47
  * }
46
48
  * })
47
49
  */
package/dist/cjs/api/resources/externalAccounts/client/Client.js CHANGED
@@ -72,6 +72,8 @@ class ExternalAccountsClient {
72
72
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
73
73
  }
74
74
  /**
75
+ * @deprecated
76
+ *
75
77
  * Link or refresh a bank account using a Plaid processor token
76
78
  *
77
79
  * @param {Natural.CreateFromProcessorTokenExternalAccountsRequest} request
@@ -95,11 +97,11 @@ class ExternalAccountsClient {
95
97
  * @example
96
98
  * await client.externalAccounts.createFromProcessorToken({
97
99
  * idempotencyKey: "Idempotency-Key",
98
- * partyId: "pty_7c9e6679e29b41d4a716446655440001",
100
+ * partyId: "pty_550e8400e29b41d4a716446655440000",
99
101
  * processorToken: "processor-sandbox-abc123",
100
- * institutionName: "Chase",
102
+ * institutionName: "Plaid Sandbox",
101
103
  * tags: {
102
- * "environment": "production"
104
+ * "environment": "sandbox"
103
105
  * }
104
106
  * })
105
107
  */
package/dist/cjs/api/resources/externalAccounts/client/requests/CreateFromProcessorTokenExternalAccountsRequest.d.ts CHANGED
@@ -2,11 +2,11 @@
2
2
  * @example
3
3
  * {
4
4
  * idempotencyKey: "Idempotency-Key",
5
- * partyId: "pty_7c9e6679e29b41d4a716446655440001",
5
+ * partyId: "pty_550e8400e29b41d4a716446655440000",
6
6
  * processorToken: "processor-sandbox-abc123",
7
- * institutionName: "Chase",
7
+ * institutionName: "Plaid Sandbox",
8
8
  * tags: {
9
- * "environment": "production"
9
+ * "environment": "sandbox"
10
10
  * }
11
11
  * }
12
12
  */
package/dist/cjs/api/resources/paymentRequests/client/requests/NewPayReqParams.d.ts CHANGED
@@ -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
- /** Set to ["recipient"] to skip our notification to the counterparty and deliver the returned link yourself. */
37
+ /** Deprecated. Previously skipped our notification to the counterparty; Natural now always sends its own notifications and this field is accepted but ignored. The returned link is unaffected. */
38
38
  disableNotifications?: Natural.CreatePaymentRequestsRequestDisableNotificationsItem[];
39
39
  }
package/dist/cjs/api/resources/payments/client/requests/NewPaymentParams.d.ts CHANGED
@@ -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
- /** Set to ["recipient"] to skip our notification to the counterparty and deliver the returned link yourself. */
35
+ /** Deprecated. Previously skipped our notification to the counterparty; Natural now always sends its own notifications and this field is accepted but ignored. The returned link is unaffected. */
36
36
  disableNotifications?: Natural.CreatePaymentsRequestDisableNotificationsItem[];
37
37
  }
package/dist/cjs/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.6.0";
1
+ export declare const SDK_VERSION = "1.6.1";
package/dist/cjs/version.js CHANGED
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "1.6.0";
4
+ exports.SDK_VERSION = "1.6.1";
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.6.0",
10
- "User-Agent": "@naturalpay/sdk/1.6.0",
9
+ "X-Fern-SDK-Version": "1.6.1",
10
+ "User-Agent": "@naturalpay/sdk/1.6.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,
package/dist/esm/api/resources/customers/client/Client.d.mts CHANGED
@@ -117,56 +117,7 @@ export declare class CustomersClient {
117
117
  * await client.customers.createInvitations({
118
118
  * recipients: [{
119
119
  * type: "email",
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
- * beneficialOwners: [{
152
- * firstName: "Morgan",
153
- * lastName: "Lee",
154
- * email: "morgan.lee@acme.com",
155
- * phone: "+14155550176",
156
- * dateOfBirth: "1985-09-02",
157
- * address: {
158
- * streetLine1: "128 Alamo Square",
159
- * city: "San Francisco",
160
- * subdivision: "CA",
161
- * postalCode: "94117",
162
- * country: "US"
163
- * },
164
- * ownershipPercentage: 60,
165
- * title: "ceo",
166
- * countryOfCitizenship: "US",
167
- * employmentStatus: "employed"
168
- * }]
169
- * }
120
+ * value: "ops@acme.com"
170
121
  * }],
171
122
  * agents: [{
172
123
  * agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
package/dist/esm/api/resources/customers/client/Client.mjs CHANGED
@@ -372,56 +372,7 @@ export class CustomersClient {
372
372
  * await client.customers.createInvitations({
373
373
  * recipients: [{
374
374
  * type: "email",
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
- * beneficialOwners: [{
407
- * firstName: "Morgan",
408
- * lastName: "Lee",
409
- * email: "morgan.lee@acme.com",
410
- * phone: "+14155550176",
411
- * dateOfBirth: "1985-09-02",
412
- * address: {
413
- * streetLine1: "128 Alamo Square",
414
- * city: "San Francisco",
415
- * subdivision: "CA",
416
- * postalCode: "94117",
417
- * country: "US"
418
- * },
419
- * ownershipPercentage: 60,
420
- * title: "ceo",
421
- * countryOfCitizenship: "US",
422
- * employmentStatus: "employed"
423
- * }]
424
- * }
375
+ * value: "ops@acme.com"
425
376
  * }],
426
377
  * agents: [{
427
378
  * agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
package/dist/esm/api/resources/customers/client/requests/CreateInvitationsCustomersRequest.d.mts CHANGED
@@ -4,56 +4,7 @@ import type * as Natural from "../../../../index.mjs";
4
4
  * {
5
5
  * recipients: [{
6
6
  * type: "email",
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
- * beneficialOwners: [{
39
- * firstName: "Morgan",
40
- * lastName: "Lee",
41
- * email: "morgan.lee@acme.com",
42
- * phone: "+14155550176",
43
- * dateOfBirth: "1985-09-02",
44
- * address: {
45
- * streetLine1: "128 Alamo Square",
46
- * city: "San Francisco",
47
- * subdivision: "CA",
48
- * postalCode: "94117",
49
- * country: "US"
50
- * },
51
- * ownershipPercentage: 60,
52
- * title: "ceo",
53
- * countryOfCitizenship: "US",
54
- * employmentStatus: "employed"
55
- * }]
56
- * }
7
+ * value: "ops@acme.com"
57
8
  * }],
58
9
  * agents: [{
59
10
  * agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
@@ -80,6 +31,6 @@ export interface CreateInvitationsCustomersRequest {
80
31
  message?: string;
81
32
  /** Tags applied to each invitation. */
82
33
  tags?: Record<string, string>;
83
- /** Set to ["recipient"] to skip our notification to the counterparty and deliver the returned link yourself. */
34
+ /** Deprecated. Previously skipped our notification to the counterparty; Natural now always sends its own notifications and this field is accepted but ignored. The returned link is unaffected. */
84
35
  disableNotifications?: Natural.CreateInvitationsCustomersRequestDisableNotificationsItem[];
85
36
  }
package/dist/esm/api/resources/externalAccounts/client/Client.d.mts CHANGED
@@ -14,6 +14,8 @@ export declare class ExternalAccountsClient {
14
14
  protected readonly _options: NormalizedClientOptionsWithAuth<ExternalAccountsClient.Options>;
15
15
  constructor(options?: ExternalAccountsClient.Options);
16
16
  /**
17
+ * @deprecated
18
+ *
17
19
  * Link or refresh a bank account using a Plaid processor token
18
20
  *
19
21
  * @param {Natural.CreateFromProcessorTokenExternalAccountsRequest} request
@@ -37,11 +39,11 @@ export declare class ExternalAccountsClient {
37
39
  * @example
38
40
  * await client.externalAccounts.createFromProcessorToken({
39
41
  * idempotencyKey: "Idempotency-Key",
40
- * partyId: "pty_7c9e6679e29b41d4a716446655440001",
42
+ * partyId: "pty_550e8400e29b41d4a716446655440000",
41
43
  * processorToken: "processor-sandbox-abc123",
42
- * institutionName: "Chase",
44
+ * institutionName: "Plaid Sandbox",
43
45
  * tags: {
44
- * "environment": "production"
46
+ * "environment": "sandbox"
45
47
  * }
46
48
  * })
47
49
  */
package/dist/esm/api/resources/externalAccounts/client/Client.mjs CHANGED
@@ -36,6 +36,8 @@ export class ExternalAccountsClient {
36
36
  this._options = normalizeClientOptionsWithAuth(options);
37
37
  }
38
38
  /**
39
+ * @deprecated
40
+ *
39
41
  * Link or refresh a bank account using a Plaid processor token
40
42
  *
41
43
  * @param {Natural.CreateFromProcessorTokenExternalAccountsRequest} request
@@ -59,11 +61,11 @@ export class ExternalAccountsClient {
59
61
  * @example
60
62
  * await client.externalAccounts.createFromProcessorToken({
61
63
  * idempotencyKey: "Idempotency-Key",
62
- * partyId: "pty_7c9e6679e29b41d4a716446655440001",
64
+ * partyId: "pty_550e8400e29b41d4a716446655440000",
63
65
  * processorToken: "processor-sandbox-abc123",
64
- * institutionName: "Chase",
66
+ * institutionName: "Plaid Sandbox",
65
67
  * tags: {
66
- * "environment": "production"
68
+ * "environment": "sandbox"
67
69
  * }
68
70
  * })
69
71
  */
package/dist/esm/api/resources/externalAccounts/client/requests/CreateFromProcessorTokenExternalAccountsRequest.d.mts CHANGED
@@ -2,11 +2,11 @@
2
2
  * @example
3
3
  * {
4
4
  * idempotencyKey: "Idempotency-Key",
5
- * partyId: "pty_7c9e6679e29b41d4a716446655440001",
5
+ * partyId: "pty_550e8400e29b41d4a716446655440000",
6
6
  * processorToken: "processor-sandbox-abc123",
7
- * institutionName: "Chase",
7
+ * institutionName: "Plaid Sandbox",
8
8
  * tags: {
9
- * "environment": "production"
9
+ * "environment": "sandbox"
10
10
  * }
11
11
  * }
12
12
  */
package/dist/esm/api/resources/paymentRequests/client/requests/NewPayReqParams.d.mts CHANGED
@@ -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
- /** Set to ["recipient"] to skip our notification to the counterparty and deliver the returned link yourself. */
37
+ /** Deprecated. Previously skipped our notification to the counterparty; Natural now always sends its own notifications and this field is accepted but ignored. The returned link is unaffected. */
38
38
  disableNotifications?: Natural.CreatePaymentRequestsRequestDisableNotificationsItem[];
39
39
  }
package/dist/esm/api/resources/payments/client/requests/NewPaymentParams.d.mts CHANGED
@@ -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
- /** Set to ["recipient"] to skip our notification to the counterparty and deliver the returned link yourself. */
35
+ /** Deprecated. Previously skipped our notification to the counterparty; Natural now always sends its own notifications and this field is accepted but ignored. The returned link is unaffected. */
36
36
  disableNotifications?: Natural.CreatePaymentsRequestDisableNotificationsItem[];
37
37
  }
package/dist/esm/version.d.mts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.6.0";
1
+ export declare const SDK_VERSION = "1.6.1";
package/dist/esm/version.mjs CHANGED
@@ -1 +1 @@
1
- export const SDK_VERSION = "1.6.0";
1
+ export const SDK_VERSION = "1.6.1";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@naturalpay/sdk",
3
- "version": "1.6.0",
3
+ "version": "1.6.1",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
package/reference.md CHANGED
@@ -917,56 +917,7 @@ 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",
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
- beneficialOwners: [{
952
- firstName: "Morgan",
953
- lastName: "Lee",
954
- email: "morgan.lee@acme.com",
955
- phone: "+14155550176",
956
- dateOfBirth: "1985-09-02",
957
- address: {
958
- streetLine1: "128 Alamo Square",
959
- city: "San Francisco",
960
- subdivision: "CA",
961
- postalCode: "94117",
962
- country: "US"
963
- },
964
- ownershipPercentage: 60,
965
- title: "ceo",
966
- countryOfCitizenship: "US",
967
- employmentStatus: "employed"
968
- }]
969
- }
920
+ value: "ops@acme.com"
970
921
  }],
971
922
  agents: [{
972
923
  agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
@@ -4492,11 +4443,11 @@ Link or refresh a bank account using a Plaid processor token
4492
4443
  ```typescript
4493
4444
  await client.externalAccounts.createFromProcessorToken({
4494
4445
  idempotencyKey: "Idempotency-Key",
4495
- partyId: "pty_7c9e6679e29b41d4a716446655440001",
4446
+ partyId: "pty_550e8400e29b41d4a716446655440000",
4496
4447
  processorToken: "processor-sandbox-abc123",
4497
- institutionName: "Chase",
4448
+ institutionName: "Plaid Sandbox",
4498
4449
  tags: {
4499
- "environment": "production"
4450
+ "environment": "sandbox"
4500
4451
  }
4501
4452
  });
4502
4453