@naturalpay/sdk 1.6.0 → 1.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/agents/types/CreateCustomerAgentsRequestPermissionsItem.d.ts +1 -0
  3. package/dist/cjs/api/resources/agents/types/CreateCustomerAgentsRequestPermissionsItem.js +1 -0
  4. package/dist/cjs/api/resources/apiKeys/types/CreateApiKeysRequestScopesItem.d.ts +1 -0
  5. package/dist/cjs/api/resources/apiKeys/types/CreateApiKeysRequestScopesItem.js +1 -0
  6. package/dist/cjs/api/resources/customers/client/Client.d.ts +1 -50
  7. package/dist/cjs/api/resources/customers/client/Client.js +1 -50
  8. package/dist/cjs/api/resources/customers/client/requests/CreateInvitationsCustomersRequest.d.ts +2 -51
  9. package/dist/cjs/api/resources/customers/types/CreateInvitationsCustomersRequestAgentsItemPermissionsItem.d.ts +1 -0
  10. package/dist/cjs/api/resources/customers/types/CreateInvitationsCustomersRequestAgentsItemPermissionsItem.js +1 -0
  11. package/dist/cjs/api/resources/externalAccounts/client/Client.d.ts +5 -3
  12. package/dist/cjs/api/resources/externalAccounts/client/Client.js +5 -3
  13. package/dist/cjs/api/resources/externalAccounts/client/requests/CreateFromProcessorTokenExternalAccountsRequest.d.ts +3 -3
  14. package/dist/cjs/api/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.d.ts +1 -0
  15. package/dist/cjs/api/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.js +1 -0
  16. package/dist/cjs/api/resources/invitationLinks/types/CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.ts +1 -0
  17. package/dist/cjs/api/resources/invitationLinks/types/CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.js +1 -0
  18. package/dist/cjs/api/resources/invitationLinks/types/GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.ts +1 -0
  19. package/dist/cjs/api/resources/invitationLinks/types/GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.js +1 -0
  20. package/dist/cjs/api/resources/invitationLinks/types/ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem.d.ts +1 -0
  21. package/dist/cjs/api/resources/invitationLinks/types/ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem.js +1 -0
  22. package/dist/cjs/api/resources/invitationLinks/types/RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.ts +1 -0
  23. package/dist/cjs/api/resources/invitationLinks/types/RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.js +1 -0
  24. package/dist/cjs/api/resources/paymentRequests/client/requests/NewPayReqParams.d.ts +1 -1
  25. package/dist/cjs/api/resources/payments/client/requests/NewPaymentParams.d.ts +1 -1
  26. package/dist/cjs/api/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.d.ts +1 -0
  27. package/dist/cjs/api/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.js +1 -0
  28. package/dist/cjs/serialization/resources/agents/types/CreateCustomerAgentsRequestPermissionsItem.d.ts +1 -1
  29. package/dist/cjs/serialization/resources/agents/types/CreateCustomerAgentsRequestPermissionsItem.js +1 -0
  30. package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeysRequestScopesItem.d.ts +1 -1
  31. package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeysRequestScopesItem.js +1 -0
  32. package/dist/cjs/serialization/resources/customers/types/CreateInvitationsCustomersRequestAgentsItemPermissionsItem.d.ts +1 -1
  33. package/dist/cjs/serialization/resources/customers/types/CreateInvitationsCustomersRequestAgentsItemPermissionsItem.js +1 -0
  34. package/dist/cjs/serialization/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.d.ts +1 -1
  35. package/dist/cjs/serialization/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.js +1 -0
  36. package/dist/cjs/serialization/resources/invitationLinks/types/CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.ts +1 -1
  37. package/dist/cjs/serialization/resources/invitationLinks/types/CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.js +1 -0
  38. package/dist/cjs/serialization/resources/invitationLinks/types/GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.ts +1 -1
  39. package/dist/cjs/serialization/resources/invitationLinks/types/GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.js +1 -0
  40. package/dist/cjs/serialization/resources/invitationLinks/types/ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem.d.ts +1 -1
  41. package/dist/cjs/serialization/resources/invitationLinks/types/ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem.js +1 -0
  42. package/dist/cjs/serialization/resources/invitationLinks/types/RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.ts +1 -1
  43. package/dist/cjs/serialization/resources/invitationLinks/types/RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.js +1 -0
  44. package/dist/cjs/serialization/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.d.ts +1 -1
  45. package/dist/cjs/serialization/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.js +1 -0
  46. package/dist/cjs/version.d.ts +1 -1
  47. package/dist/cjs/version.js +1 -1
  48. package/dist/esm/BaseClient.mjs +2 -2
  49. package/dist/esm/api/resources/agents/types/CreateCustomerAgentsRequestPermissionsItem.d.mts +1 -0
  50. package/dist/esm/api/resources/agents/types/CreateCustomerAgentsRequestPermissionsItem.mjs +1 -0
  51. package/dist/esm/api/resources/apiKeys/types/CreateApiKeysRequestScopesItem.d.mts +1 -0
  52. package/dist/esm/api/resources/apiKeys/types/CreateApiKeysRequestScopesItem.mjs +1 -0
  53. package/dist/esm/api/resources/customers/client/Client.d.mts +1 -50
  54. package/dist/esm/api/resources/customers/client/Client.mjs +1 -50
  55. package/dist/esm/api/resources/customers/client/requests/CreateInvitationsCustomersRequest.d.mts +2 -51
  56. package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestAgentsItemPermissionsItem.d.mts +1 -0
  57. package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestAgentsItemPermissionsItem.mjs +1 -0
  58. package/dist/esm/api/resources/externalAccounts/client/Client.d.mts +5 -3
  59. package/dist/esm/api/resources/externalAccounts/client/Client.mjs +5 -3
  60. package/dist/esm/api/resources/externalAccounts/client/requests/CreateFromProcessorTokenExternalAccountsRequest.d.mts +3 -3
  61. package/dist/esm/api/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.d.mts +1 -0
  62. package/dist/esm/api/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.mjs +1 -0
  63. package/dist/esm/api/resources/invitationLinks/types/CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.mts +1 -0
  64. package/dist/esm/api/resources/invitationLinks/types/CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.mjs +1 -0
  65. package/dist/esm/api/resources/invitationLinks/types/GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.mts +1 -0
  66. package/dist/esm/api/resources/invitationLinks/types/GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.mjs +1 -0
  67. package/dist/esm/api/resources/invitationLinks/types/ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem.d.mts +1 -0
  68. package/dist/esm/api/resources/invitationLinks/types/ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem.mjs +1 -0
  69. package/dist/esm/api/resources/invitationLinks/types/RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.mts +1 -0
  70. package/dist/esm/api/resources/invitationLinks/types/RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.mjs +1 -0
  71. package/dist/esm/api/resources/paymentRequests/client/requests/NewPayReqParams.d.mts +1 -1
  72. package/dist/esm/api/resources/payments/client/requests/NewPaymentParams.d.mts +1 -1
  73. package/dist/esm/api/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.d.mts +1 -0
  74. package/dist/esm/api/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.mjs +1 -0
  75. package/dist/esm/serialization/resources/agents/types/CreateCustomerAgentsRequestPermissionsItem.d.mts +1 -1
  76. package/dist/esm/serialization/resources/agents/types/CreateCustomerAgentsRequestPermissionsItem.mjs +1 -0
  77. package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeysRequestScopesItem.d.mts +1 -1
  78. package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeysRequestScopesItem.mjs +1 -0
  79. package/dist/esm/serialization/resources/customers/types/CreateInvitationsCustomersRequestAgentsItemPermissionsItem.d.mts +1 -1
  80. package/dist/esm/serialization/resources/customers/types/CreateInvitationsCustomersRequestAgentsItemPermissionsItem.mjs +1 -0
  81. package/dist/esm/serialization/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.d.mts +1 -1
  82. package/dist/esm/serialization/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.mjs +1 -0
  83. package/dist/esm/serialization/resources/invitationLinks/types/CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.mts +1 -1
  84. package/dist/esm/serialization/resources/invitationLinks/types/CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.mjs +1 -0
  85. package/dist/esm/serialization/resources/invitationLinks/types/GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.mts +1 -1
  86. package/dist/esm/serialization/resources/invitationLinks/types/GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.mjs +1 -0
  87. package/dist/esm/serialization/resources/invitationLinks/types/ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem.d.mts +1 -1
  88. package/dist/esm/serialization/resources/invitationLinks/types/ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem.mjs +1 -0
  89. package/dist/esm/serialization/resources/invitationLinks/types/RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.mts +1 -1
  90. package/dist/esm/serialization/resources/invitationLinks/types/RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.mjs +1 -0
  91. package/dist/esm/serialization/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.d.mts +1 -1
  92. package/dist/esm/serialization/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsItem.mjs +1 -0
  93. package/dist/esm/version.d.mts +1 -1
  94. package/dist/esm/version.mjs +1 -1
  95. package/package.json +1 -1
  96. package/reference.md +4 -53
@@ -45,6 +45,7 @@ exports.InviteCustomerSimulationsRequestPermissionsItem = core.serialization.enu
45
45
  "direct.create",
46
46
  "external_accounts.create",
47
47
  "wallets.read",
48
+ "wallets.balance",
48
49
  "wallets.create",
49
50
  "wallets.update",
50
51
  "wallets.fund",
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.6.0";
1
+ export declare const SDK_VERSION = "1.6.2";
@@ -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.2";
@@ -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.2",
10
+ "User-Agent": "@naturalpay/sdk/1.6.2",
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,
@@ -7,6 +7,7 @@ export declare const CreateCustomerAgentsRequestPermissionsItem: {
7
7
  readonly DirectCreate: "direct.create";
8
8
  readonly ExternalAccountsCreate: "external_accounts.create";
9
9
  readonly WalletsRead: "wallets.read";
10
+ readonly WalletsBalance: "wallets.balance";
10
11
  readonly WalletsCreate: "wallets.create";
11
12
  readonly WalletsUpdate: "wallets.update";
12
13
  readonly WalletsFund: "wallets.fund";
@@ -8,6 +8,7 @@ export const CreateCustomerAgentsRequestPermissionsItem = {
8
8
  DirectCreate: "direct.create",
9
9
  ExternalAccountsCreate: "external_accounts.create",
10
10
  WalletsRead: "wallets.read",
11
+ WalletsBalance: "wallets.balance",
11
12
  WalletsCreate: "wallets.create",
12
13
  WalletsUpdate: "wallets.update",
13
14
  WalletsFund: "wallets.fund",
@@ -17,6 +17,7 @@ export declare const CreateApiKeysRequestScopesItem: {
17
17
  readonly DirectRead: "direct.read";
18
18
  readonly ExternalAccountsCreate: "external_accounts.create";
19
19
  readonly WalletsRead: "wallets.read";
20
+ readonly WalletsBalance: "wallets.balance";
20
21
  readonly WalletsCreate: "wallets.create";
21
22
  readonly WalletsUpdate: "wallets.update";
22
23
  readonly WalletsDelete: "wallets.delete";
@@ -18,6 +18,7 @@ export const CreateApiKeysRequestScopesItem = {
18
18
  DirectRead: "direct.read",
19
19
  ExternalAccountsCreate: "external_accounts.create",
20
20
  WalletsRead: "wallets.read",
21
+ WalletsBalance: "wallets.balance",
21
22
  WalletsCreate: "wallets.create",
22
23
  WalletsUpdate: "wallets.update",
23
24
  WalletsDelete: "wallets.delete",
@@ -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",
@@ -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",
@@ -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
  }
@@ -7,6 +7,7 @@ export declare const CreateInvitationsCustomersRequestAgentsItemPermissionsItem:
7
7
  readonly DirectCreate: "direct.create";
8
8
  readonly ExternalAccountsCreate: "external_accounts.create";
9
9
  readonly WalletsRead: "wallets.read";
10
+ readonly WalletsBalance: "wallets.balance";
10
11
  readonly WalletsCreate: "wallets.create";
11
12
  readonly WalletsUpdate: "wallets.update";
12
13
  readonly WalletsFund: "wallets.fund";
@@ -8,6 +8,7 @@ export const CreateInvitationsCustomersRequestAgentsItemPermissionsItem = {
8
8
  DirectCreate: "direct.create",
9
9
  ExternalAccountsCreate: "external_accounts.create",
10
10
  WalletsRead: "wallets.read",
11
+ WalletsBalance: "wallets.balance",
11
12
  WalletsCreate: "wallets.create",
12
13
  WalletsUpdate: "wallets.update",
13
14
  WalletsFund: "wallets.fund",
@@ -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
  */
@@ -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
  */
@@ -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
  */
@@ -7,6 +7,7 @@ export declare const CreateInvitationLinksRequestProposedAgentsItemPermissionsIt
7
7
  readonly DirectCreate: "direct.create";
8
8
  readonly ExternalAccountsCreate: "external_accounts.create";
9
9
  readonly WalletsRead: "wallets.read";
10
+ readonly WalletsBalance: "wallets.balance";
10
11
  readonly WalletsCreate: "wallets.create";
11
12
  readonly WalletsUpdate: "wallets.update";
12
13
  readonly WalletsFund: "wallets.fund";
@@ -8,6 +8,7 @@ export const CreateInvitationLinksRequestProposedAgentsItemPermissionsItem = {
8
8
  DirectCreate: "direct.create",
9
9
  ExternalAccountsCreate: "external_accounts.create",
10
10
  WalletsRead: "wallets.read",
11
+ WalletsBalance: "wallets.balance",
11
12
  WalletsCreate: "wallets.create",
12
13
  WalletsUpdate: "wallets.update",
13
14
  WalletsFund: "wallets.fund",
@@ -7,6 +7,7 @@ export declare const CreateInvitationLinksResponseDataAttributesProposedAgentsIt
7
7
  readonly DirectCreate: "direct.create";
8
8
  readonly ExternalAccountsCreate: "external_accounts.create";
9
9
  readonly WalletsRead: "wallets.read";
10
+ readonly WalletsBalance: "wallets.balance";
10
11
  readonly WalletsCreate: "wallets.create";
11
12
  readonly WalletsUpdate: "wallets.update";
12
13
  readonly WalletsFund: "wallets.fund";
@@ -8,6 +8,7 @@ export const CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermis
8
8
  DirectCreate: "direct.create",
9
9
  ExternalAccountsCreate: "external_accounts.create",
10
10
  WalletsRead: "wallets.read",
11
+ WalletsBalance: "wallets.balance",
11
12
  WalletsCreate: "wallets.create",
12
13
  WalletsUpdate: "wallets.update",
13
14
  WalletsFund: "wallets.fund",
@@ -7,6 +7,7 @@ export declare const GetInvitationLinksResponseDataAttributesProposedAgentsItemP
7
7
  readonly DirectCreate: "direct.create";
8
8
  readonly ExternalAccountsCreate: "external_accounts.create";
9
9
  readonly WalletsRead: "wallets.read";
10
+ readonly WalletsBalance: "wallets.balance";
10
11
  readonly WalletsCreate: "wallets.create";
11
12
  readonly WalletsUpdate: "wallets.update";
12
13
  readonly WalletsFund: "wallets.fund";
@@ -8,6 +8,7 @@ export const GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissio
8
8
  DirectCreate: "direct.create",
9
9
  ExternalAccountsCreate: "external_accounts.create",
10
10
  WalletsRead: "wallets.read",
11
+ WalletsBalance: "wallets.balance",
11
12
  WalletsCreate: "wallets.create",
12
13
  WalletsUpdate: "wallets.update",
13
14
  WalletsFund: "wallets.fund",
@@ -7,6 +7,7 @@ export declare const ListInvitationLinksResponseDataItemAttributesProposedAgents
7
7
  readonly DirectCreate: "direct.create";
8
8
  readonly ExternalAccountsCreate: "external_accounts.create";
9
9
  readonly WalletsRead: "wallets.read";
10
+ readonly WalletsBalance: "wallets.balance";
10
11
  readonly WalletsCreate: "wallets.create";
11
12
  readonly WalletsUpdate: "wallets.update";
12
13
  readonly WalletsFund: "wallets.fund";
@@ -8,6 +8,7 @@ export const ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPerm
8
8
  DirectCreate: "direct.create",
9
9
  ExternalAccountsCreate: "external_accounts.create",
10
10
  WalletsRead: "wallets.read",
11
+ WalletsBalance: "wallets.balance",
11
12
  WalletsCreate: "wallets.create",
12
13
  WalletsUpdate: "wallets.update",
13
14
  WalletsFund: "wallets.fund",
@@ -7,6 +7,7 @@ export declare const RevokeInvitationLinksResponseDataAttributesProposedAgentsIt
7
7
  readonly DirectCreate: "direct.create";
8
8
  readonly ExternalAccountsCreate: "external_accounts.create";
9
9
  readonly WalletsRead: "wallets.read";
10
+ readonly WalletsBalance: "wallets.balance";
10
11
  readonly WalletsCreate: "wallets.create";
11
12
  readonly WalletsUpdate: "wallets.update";
12
13
  readonly WalletsFund: "wallets.fund";
@@ -8,6 +8,7 @@ export const RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermis
8
8
  DirectCreate: "direct.create",
9
9
  ExternalAccountsCreate: "external_accounts.create",
10
10
  WalletsRead: "wallets.read",
11
+ WalletsBalance: "wallets.balance",
11
12
  WalletsCreate: "wallets.create",
12
13
  WalletsUpdate: "wallets.update",
13
14
  WalletsFund: "wallets.fund",
@@ -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
  }
@@ -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
  }
@@ -7,6 +7,7 @@ export declare const InviteCustomerSimulationsRequestPermissionsItem: {
7
7
  readonly DirectCreate: "direct.create";
8
8
  readonly ExternalAccountsCreate: "external_accounts.create";
9
9
  readonly WalletsRead: "wallets.read";
10
+ readonly WalletsBalance: "wallets.balance";
10
11
  readonly WalletsCreate: "wallets.create";
11
12
  readonly WalletsUpdate: "wallets.update";
12
13
  readonly WalletsFund: "wallets.fund";
@@ -8,6 +8,7 @@ export const InviteCustomerSimulationsRequestPermissionsItem = {
8
8
  DirectCreate: "direct.create",
9
9
  ExternalAccountsCreate: "external_accounts.create",
10
10
  WalletsRead: "wallets.read",
11
+ WalletsBalance: "wallets.balance",
11
12
  WalletsCreate: "wallets.create",
12
13
  WalletsUpdate: "wallets.update",
13
14
  WalletsFund: "wallets.fund",
@@ -3,5 +3,5 @@ import * as core from "../../../../core/index.mjs";
3
3
  import type * as serializers from "../../../index.mjs";
4
4
  export declare const CreateCustomerAgentsRequestPermissionsItem: core.serialization.Schema<serializers.CreateCustomerAgentsRequestPermissionsItem.Raw, Natural.CreateCustomerAgentsRequestPermissionsItem>;
5
5
  export declare namespace CreateCustomerAgentsRequestPermissionsItem {
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";
6
+ type Raw = "payments.read" | "payments.create" | "external_parties.read" | "external_parties.create" | "direct.read" | "direct.create" | "external_accounts.create" | "wallets.read" | "wallets.balance" | "wallets.create" | "wallets.update" | "wallets.fund" | "wallets.deposit" | "wallets.transfer" | "wallets.withdraw" | "party.read" | "party.update";
7
7
  }
@@ -9,6 +9,7 @@ export const CreateCustomerAgentsRequestPermissionsItem = core.serialization.enu
9
9
  "direct.create",
10
10
  "external_accounts.create",
11
11
  "wallets.read",
12
+ "wallets.balance",
12
13
  "wallets.create",
13
14
  "wallets.update",
14
15
  "wallets.fund",
@@ -3,5 +3,5 @@ import * as core from "../../../../core/index.mjs";
3
3
  import type * as serializers from "../../../index.mjs";
4
4
  export declare const CreateApiKeysRequestScopesItem: core.serialization.Schema<serializers.CreateApiKeysRequestScopesItem.Raw, Natural.CreateApiKeysRequestScopesItem>;
5
5
  export declare namespace CreateApiKeysRequestScopesItem {
6
- type Raw = "party.read" | "party.update" | "invite.read" | "invite.create" | "invite.update" | "invite.delete" | "membership.create" | "membership.read" | "membership.update" | "membership.delete" | "payments.create" | "payments.read" | "external_parties.create" | "external_parties.read" | "direct.create" | "direct.read" | "external_accounts.create" | "wallets.read" | "wallets.create" | "wallets.update" | "wallets.delete" | "wallets.fund" | "wallets.deposit" | "wallets.transfer" | "wallets.withdraw" | "delegations.read" | "delegations.create" | "delegations.update" | "delegations.delete" | "api_keys.read" | "api_keys.create" | "api_keys.delete" | "agents.read" | "agents.create" | "agents.update" | "agents.delete" | "disputes.read" | "disputes.create";
6
+ type Raw = "party.read" | "party.update" | "invite.read" | "invite.create" | "invite.update" | "invite.delete" | "membership.create" | "membership.read" | "membership.update" | "membership.delete" | "payments.create" | "payments.read" | "external_parties.create" | "external_parties.read" | "direct.create" | "direct.read" | "external_accounts.create" | "wallets.read" | "wallets.balance" | "wallets.create" | "wallets.update" | "wallets.delete" | "wallets.fund" | "wallets.deposit" | "wallets.transfer" | "wallets.withdraw" | "delegations.read" | "delegations.create" | "delegations.update" | "delegations.delete" | "api_keys.read" | "api_keys.create" | "api_keys.delete" | "agents.read" | "agents.create" | "agents.update" | "agents.delete" | "disputes.read" | "disputes.create";
7
7
  }
@@ -19,6 +19,7 @@ export const CreateApiKeysRequestScopesItem = core.serialization.enum_([
19
19
  "direct.read",
20
20
  "external_accounts.create",
21
21
  "wallets.read",
22
+ "wallets.balance",
22
23
  "wallets.create",
23
24
  "wallets.update",
24
25
  "wallets.delete",
@@ -3,5 +3,5 @@ import * as core from "../../../../core/index.mjs";
3
3
  import type * as serializers from "../../../index.mjs";
4
4
  export declare const CreateInvitationsCustomersRequestAgentsItemPermissionsItem: core.serialization.Schema<serializers.CreateInvitationsCustomersRequestAgentsItemPermissionsItem.Raw, Natural.CreateInvitationsCustomersRequestAgentsItemPermissionsItem>;
5
5
  export declare namespace CreateInvitationsCustomersRequestAgentsItemPermissionsItem {
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";
6
+ type Raw = "payments.read" | "payments.create" | "external_parties.read" | "external_parties.create" | "direct.read" | "direct.create" | "external_accounts.create" | "wallets.read" | "wallets.balance" | "wallets.create" | "wallets.update" | "wallets.fund" | "wallets.deposit" | "wallets.transfer" | "wallets.withdraw" | "party.read" | "party.update";
7
7
  }
@@ -9,6 +9,7 @@ export const CreateInvitationsCustomersRequestAgentsItemPermissionsItem = core.s
9
9
  "direct.create",
10
10
  "external_accounts.create",
11
11
  "wallets.read",
12
+ "wallets.balance",
12
13
  "wallets.create",
13
14
  "wallets.update",
14
15
  "wallets.fund",
@@ -3,5 +3,5 @@ import * as core from "../../../../core/index.mjs";
3
3
  import type * as serializers from "../../../index.mjs";
4
4
  export declare const CreateInvitationLinksRequestProposedAgentsItemPermissionsItem: core.serialization.Schema<serializers.CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.Raw, Natural.CreateInvitationLinksRequestProposedAgentsItemPermissionsItem>;
5
5
  export declare namespace CreateInvitationLinksRequestProposedAgentsItemPermissionsItem {
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";
6
+ type Raw = "payments.read" | "payments.create" | "external_parties.read" | "external_parties.create" | "direct.read" | "direct.create" | "external_accounts.create" | "wallets.read" | "wallets.balance" | "wallets.create" | "wallets.update" | "wallets.fund" | "wallets.deposit" | "wallets.transfer" | "wallets.withdraw" | "party.read" | "party.update";
7
7
  }
@@ -9,6 +9,7 @@ export const CreateInvitationLinksRequestProposedAgentsItemPermissionsItem = cor
9
9
  "direct.create",
10
10
  "external_accounts.create",
11
11
  "wallets.read",
12
+ "wallets.balance",
12
13
  "wallets.create",
13
14
  "wallets.update",
14
15
  "wallets.fund",
@@ -3,5 +3,5 @@ import * as core from "../../../../core/index.mjs";
3
3
  import type * as serializers from "../../../index.mjs";
4
4
  export declare const CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem: core.serialization.Schema<serializers.CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.Raw, Natural.CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem>;
5
5
  export declare namespace CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem {
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";
6
+ type Raw = "payments.read" | "payments.create" | "external_parties.read" | "external_parties.create" | "direct.read" | "direct.create" | "external_accounts.create" | "wallets.read" | "wallets.balance" | "wallets.create" | "wallets.update" | "wallets.fund" | "wallets.deposit" | "wallets.transfer" | "wallets.withdraw" | "party.read" | "party.update";
7
7
  }
@@ -9,6 +9,7 @@ export const CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermis
9
9
  "direct.create",
10
10
  "external_accounts.create",
11
11
  "wallets.read",
12
+ "wallets.balance",
12
13
  "wallets.create",
13
14
  "wallets.update",
14
15
  "wallets.fund",
@@ -3,5 +3,5 @@ import * as core from "../../../../core/index.mjs";
3
3
  import type * as serializers from "../../../index.mjs";
4
4
  export declare const GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem: core.serialization.Schema<serializers.GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.Raw, Natural.GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem>;
5
5
  export declare namespace GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem {
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";
6
+ type Raw = "payments.read" | "payments.create" | "external_parties.read" | "external_parties.create" | "direct.read" | "direct.create" | "external_accounts.create" | "wallets.read" | "wallets.balance" | "wallets.create" | "wallets.update" | "wallets.fund" | "wallets.deposit" | "wallets.transfer" | "wallets.withdraw" | "party.read" | "party.update";
7
7
  }
@@ -9,6 +9,7 @@ export const GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissio
9
9
  "direct.create",
10
10
  "external_accounts.create",
11
11
  "wallets.read",
12
+ "wallets.balance",
12
13
  "wallets.create",
13
14
  "wallets.update",
14
15
  "wallets.fund",
@@ -3,5 +3,5 @@ import * as core from "../../../../core/index.mjs";
3
3
  import type * as serializers from "../../../index.mjs";
4
4
  export declare const ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem: core.serialization.Schema<serializers.ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem.Raw, Natural.ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem>;
5
5
  export declare namespace ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem {
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";
6
+ type Raw = "payments.read" | "payments.create" | "external_parties.read" | "external_parties.create" | "direct.read" | "direct.create" | "external_accounts.create" | "wallets.read" | "wallets.balance" | "wallets.create" | "wallets.update" | "wallets.fund" | "wallets.deposit" | "wallets.transfer" | "wallets.withdraw" | "party.read" | "party.update";
7
7
  }
@@ -9,6 +9,7 @@ export const ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPerm
9
9
  "direct.create",
10
10
  "external_accounts.create",
11
11
  "wallets.read",
12
+ "wallets.balance",
12
13
  "wallets.create",
13
14
  "wallets.update",
14
15
  "wallets.fund",
@@ -3,5 +3,5 @@ import * as core from "../../../../core/index.mjs";
3
3
  import type * as serializers from "../../../index.mjs";
4
4
  export declare const RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem: core.serialization.Schema<serializers.RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.Raw, Natural.RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem>;
5
5
  export declare namespace RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem {
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";
6
+ type Raw = "payments.read" | "payments.create" | "external_parties.read" | "external_parties.create" | "direct.read" | "direct.create" | "external_accounts.create" | "wallets.read" | "wallets.balance" | "wallets.create" | "wallets.update" | "wallets.fund" | "wallets.deposit" | "wallets.transfer" | "wallets.withdraw" | "party.read" | "party.update";
7
7
  }