@naturalpay/sdk 1.6.35 → 1.6.37

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 +0 -1
  3. package/dist/cjs/api/resources/agents/types/CreateCustomerAgentsRequestPermissionsItem.js +0 -1
  4. package/dist/cjs/api/resources/cardSessions/types/ClaimCardSessionsResponse.d.ts +1 -1
  5. package/dist/cjs/api/resources/cardSessions/types/ClaimCardSessionsResponseCard.d.ts +1 -1
  6. package/dist/cjs/api/resources/cardSessions/types/CreateCardSessionsResponse.d.ts +3 -1
  7. package/dist/cjs/api/resources/cardSessions/types/CreateCardSessionsResponseCardSource.d.ts +1 -1
  8. package/dist/cjs/api/resources/cardSessions/types/CreateCardSessionsResponseCardSource.js +1 -1
  9. package/dist/cjs/api/resources/cardSessions/types/CreateCardSessionsResponseNote.d.ts +6 -0
  10. package/dist/cjs/api/resources/cardSessions/types/CreateCardSessionsResponseNote.js +3 -0
  11. package/dist/cjs/api/resources/cardSessions/types/GetCardSessionsResponse.d.ts +3 -1
  12. package/dist/cjs/api/resources/cardSessions/types/GetCardSessionsResponseCardSource.d.ts +1 -1
  13. package/dist/cjs/api/resources/cardSessions/types/GetCardSessionsResponseCardSource.js +1 -1
  14. package/dist/cjs/api/resources/cardSessions/types/GetCardSessionsResponseNote.d.ts +6 -0
  15. package/dist/cjs/api/resources/cardSessions/types/GetCardSessionsResponseNote.js +3 -0
  16. package/dist/cjs/api/resources/cardSessions/types/index.d.ts +2 -0
  17. package/dist/cjs/api/resources/cardSessions/types/index.js +2 -0
  18. package/dist/cjs/api/resources/customers/types/CreateInvitationsCustomersRequestAgentsItemPermissionsZeroItem.d.ts +0 -1
  19. package/dist/cjs/api/resources/customers/types/CreateInvitationsCustomersRequestAgentsItemPermissionsZeroItem.js +0 -1
  20. package/dist/cjs/api/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.d.ts +0 -1
  21. package/dist/cjs/api/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.js +0 -1
  22. package/dist/cjs/api/resources/simulations/client/Client.d.ts +1 -1
  23. package/dist/cjs/api/resources/simulations/client/Client.js +1 -1
  24. package/dist/cjs/api/resources/simulations/client/requests/InviteCustomerSimulationsRequest.d.ts +1 -1
  25. package/dist/cjs/api/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsZeroItem.d.ts +0 -1
  26. package/dist/cjs/api/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsZeroItem.js +0 -1
  27. package/dist/cjs/api/resources/transfers/client/requests/NewDepositParams.d.ts +2 -2
  28. package/dist/cjs/serialization/resources/agents/types/CreateCustomerAgentsRequestPermissionsItem.d.ts +1 -1
  29. package/dist/cjs/serialization/resources/agents/types/CreateCustomerAgentsRequestPermissionsItem.js +0 -1
  30. package/dist/cjs/serialization/resources/cardSessions/types/CreateCardSessionsResponse.d.ts +2 -0
  31. package/dist/cjs/serialization/resources/cardSessions/types/CreateCardSessionsResponse.js +2 -0
  32. package/dist/cjs/serialization/resources/cardSessions/types/CreateCardSessionsResponseNote.d.ts +10 -0
  33. package/dist/cjs/serialization/resources/cardSessions/types/CreateCardSessionsResponseNote.js +42 -0
  34. package/dist/cjs/serialization/resources/cardSessions/types/GetCardSessionsResponse.d.ts +2 -0
  35. package/dist/cjs/serialization/resources/cardSessions/types/GetCardSessionsResponse.js +2 -0
  36. package/dist/cjs/serialization/resources/cardSessions/types/GetCardSessionsResponseNote.d.ts +10 -0
  37. package/dist/cjs/serialization/resources/cardSessions/types/GetCardSessionsResponseNote.js +42 -0
  38. package/dist/cjs/serialization/resources/cardSessions/types/index.d.ts +2 -0
  39. package/dist/cjs/serialization/resources/cardSessions/types/index.js +2 -0
  40. package/dist/cjs/serialization/resources/customers/types/CreateInvitationsCustomersRequestAgentsItemPermissionsZeroItem.d.ts +1 -1
  41. package/dist/cjs/serialization/resources/customers/types/CreateInvitationsCustomersRequestAgentsItemPermissionsZeroItem.js +0 -1
  42. package/dist/cjs/serialization/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.d.ts +1 -1
  43. package/dist/cjs/serialization/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.js +0 -1
  44. package/dist/cjs/serialization/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsZeroItem.d.ts +1 -1
  45. package/dist/cjs/serialization/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsZeroItem.js +0 -1
  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 +0 -1
  50. package/dist/esm/api/resources/agents/types/CreateCustomerAgentsRequestPermissionsItem.mjs +0 -1
  51. package/dist/esm/api/resources/cardSessions/types/ClaimCardSessionsResponse.d.mts +1 -1
  52. package/dist/esm/api/resources/cardSessions/types/ClaimCardSessionsResponseCard.d.mts +1 -1
  53. package/dist/esm/api/resources/cardSessions/types/CreateCardSessionsResponse.d.mts +3 -1
  54. package/dist/esm/api/resources/cardSessions/types/CreateCardSessionsResponseCardSource.d.mts +1 -1
  55. package/dist/esm/api/resources/cardSessions/types/CreateCardSessionsResponseCardSource.mjs +1 -1
  56. package/dist/esm/api/resources/cardSessions/types/CreateCardSessionsResponseNote.d.mts +6 -0
  57. package/dist/esm/api/resources/cardSessions/types/CreateCardSessionsResponseNote.mjs +2 -0
  58. package/dist/esm/api/resources/cardSessions/types/GetCardSessionsResponse.d.mts +3 -1
  59. package/dist/esm/api/resources/cardSessions/types/GetCardSessionsResponseCardSource.d.mts +1 -1
  60. package/dist/esm/api/resources/cardSessions/types/GetCardSessionsResponseCardSource.mjs +1 -1
  61. package/dist/esm/api/resources/cardSessions/types/GetCardSessionsResponseNote.d.mts +6 -0
  62. package/dist/esm/api/resources/cardSessions/types/GetCardSessionsResponseNote.mjs +2 -0
  63. package/dist/esm/api/resources/cardSessions/types/index.d.mts +2 -0
  64. package/dist/esm/api/resources/cardSessions/types/index.mjs +2 -0
  65. package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestAgentsItemPermissionsZeroItem.d.mts +0 -1
  66. package/dist/esm/api/resources/customers/types/CreateInvitationsCustomersRequestAgentsItemPermissionsZeroItem.mjs +0 -1
  67. package/dist/esm/api/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.d.mts +0 -1
  68. package/dist/esm/api/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.mjs +0 -1
  69. package/dist/esm/api/resources/simulations/client/Client.d.mts +1 -1
  70. package/dist/esm/api/resources/simulations/client/Client.mjs +1 -1
  71. package/dist/esm/api/resources/simulations/client/requests/InviteCustomerSimulationsRequest.d.mts +1 -1
  72. package/dist/esm/api/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsZeroItem.d.mts +0 -1
  73. package/dist/esm/api/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsZeroItem.mjs +0 -1
  74. package/dist/esm/api/resources/transfers/client/requests/NewDepositParams.d.mts +2 -2
  75. package/dist/esm/serialization/resources/agents/types/CreateCustomerAgentsRequestPermissionsItem.d.mts +1 -1
  76. package/dist/esm/serialization/resources/agents/types/CreateCustomerAgentsRequestPermissionsItem.mjs +0 -1
  77. package/dist/esm/serialization/resources/cardSessions/types/CreateCardSessionsResponse.d.mts +2 -0
  78. package/dist/esm/serialization/resources/cardSessions/types/CreateCardSessionsResponse.mjs +2 -0
  79. package/dist/esm/serialization/resources/cardSessions/types/CreateCardSessionsResponseNote.d.mts +10 -0
  80. package/dist/esm/serialization/resources/cardSessions/types/CreateCardSessionsResponseNote.mjs +6 -0
  81. package/dist/esm/serialization/resources/cardSessions/types/GetCardSessionsResponse.d.mts +2 -0
  82. package/dist/esm/serialization/resources/cardSessions/types/GetCardSessionsResponse.mjs +2 -0
  83. package/dist/esm/serialization/resources/cardSessions/types/GetCardSessionsResponseNote.d.mts +10 -0
  84. package/dist/esm/serialization/resources/cardSessions/types/GetCardSessionsResponseNote.mjs +6 -0
  85. package/dist/esm/serialization/resources/cardSessions/types/index.d.mts +2 -0
  86. package/dist/esm/serialization/resources/cardSessions/types/index.mjs +2 -0
  87. package/dist/esm/serialization/resources/customers/types/CreateInvitationsCustomersRequestAgentsItemPermissionsZeroItem.d.mts +1 -1
  88. package/dist/esm/serialization/resources/customers/types/CreateInvitationsCustomersRequestAgentsItemPermissionsZeroItem.mjs +0 -1
  89. package/dist/esm/serialization/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.d.mts +1 -1
  90. package/dist/esm/serialization/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.mjs +0 -1
  91. package/dist/esm/serialization/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsZeroItem.d.mts +1 -1
  92. package/dist/esm/serialization/resources/simulations/types/InviteCustomerSimulationsRequestPermissionsZeroItem.mjs +0 -1
  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 +1 -1
@@ -3,7 +3,7 @@ export interface ClaimCardSessionsResponse {
3
3
  sessionId: string;
4
4
  cardId: string;
5
5
  card: Natural.ClaimCardSessionsResponseCard;
6
- /** The card's billing address on file, for filling the merchant's checkout (the ZIP drives the bank's AVS check). Null for Natural-issued cards, which store none. */
6
+ /** The card's billing address on file, for filling the merchant's checkout (the ZIP drives the bank's AVS check). Null for agent cards, which store none. */
7
7
  billingAddress: Natural.ClaimCardSessionsResponseBillingAddress | null;
8
8
  proxy: Natural.ClaimCardSessionsResponseProxy;
9
9
  allowedHosts: string[];
@@ -5,6 +5,6 @@ export interface ClaimCardSessionsResponseCard {
5
5
  cvc: string;
6
6
  expirationMonth: number;
7
7
  expirationYear: number;
8
- /** Cardholder name as printed on the card, for the merchant's checkout name field. Null for Natural-issued cards, which have none on file. */
8
+ /** Cardholder name as printed on the card, for the merchant's checkout name field. Null for agent cards, which have none on file. */
9
9
  holderName: string | null;
10
10
  }
@@ -2,7 +2,7 @@ import type * as Natural from "../../../index.mjs";
2
2
  export interface CreateCardSessionsResponse {
3
3
  sessionId: string;
4
4
  cardId: string;
5
- /** natural_issued: a Natural-issued card. external: a card the user added on the dashboard. */
5
+ /** natural_issued: an agent card Natural issued to you. external: a card the user added on the dashboard. */
6
6
  cardSource: Natural.CreateCardSessionsResponseCardSource;
7
7
  /** pending_approval: waiting for the user; keep polling. approved: claim it now. declined: the user said no. claimed: already collected. expired: open a new session. */
8
8
  status: Natural.CreateCardSessionsResponseStatus;
@@ -13,6 +13,8 @@ export interface CreateCardSessionsResponse {
13
13
  /** When the claimed proxy login stops working. */
14
14
  credentialExpiresAt: string | null;
15
15
  createdAt: string;
16
+ /** Cards the user added only, once the purchase is approved: a suggestion to pass on to the user. Null when there's nothing to suggest. */
17
+ note: Natural.CreateCardSessionsResponseNote | null;
16
18
  /** Cards the user added only: send the user here to approve the purchase. Returned only in this response; it can't be fetched again. */
17
19
  approvalUrl: string | null;
18
20
  }
@@ -1,4 +1,4 @@
1
- /** natural_issued: a Natural-issued card. external: a card the user added on the dashboard. */
1
+ /** natural_issued: an agent card Natural issued to you. external: a card the user added on the dashboard. */
2
2
  export declare const CreateCardSessionsResponseCardSource: {
3
3
  readonly NaturalIssued: "natural_issued";
4
4
  readonly External: "external";
@@ -1,5 +1,5 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
- /** natural_issued: a Natural-issued card. external: a card the user added on the dashboard. */
2
+ /** natural_issued: an agent card Natural issued to you. external: a card the user added on the dashboard. */
3
3
  export const CreateCardSessionsResponseCardSource = {
4
4
  NaturalIssued: "natural_issued",
5
5
  External: "external",
@@ -0,0 +1,6 @@
1
+ export interface CreateCardSessionsResponseNote {
2
+ /** What to tell the user: what would let them skip the security code next time, such as verifying their identity or adding money to Natural. */
3
+ message: string;
4
+ /** A page to send the user to for that step. Null when there's nothing to do yet. */
5
+ url: string | null;
6
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -2,7 +2,7 @@ import type * as Natural from "../../../index.mjs";
2
2
  export interface GetCardSessionsResponse {
3
3
  sessionId: string;
4
4
  cardId: string;
5
- /** natural_issued: a Natural-issued card. external: a card the user added on the dashboard. */
5
+ /** natural_issued: an agent card Natural issued to you. external: a card the user added on the dashboard. */
6
6
  cardSource: Natural.GetCardSessionsResponseCardSource;
7
7
  /** pending_approval: waiting for the user; keep polling. approved: claim it now. declined: the user said no. claimed: already collected. expired: open a new session. */
8
8
  status: Natural.GetCardSessionsResponseStatus;
@@ -13,4 +13,6 @@ export interface GetCardSessionsResponse {
13
13
  /** When the claimed proxy login stops working. */
14
14
  credentialExpiresAt: string | null;
15
15
  createdAt: string;
16
+ /** Cards the user added only, once the purchase is approved: a suggestion to pass on to the user. Null when there's nothing to suggest. */
17
+ note: Natural.GetCardSessionsResponseNote | null;
16
18
  }
@@ -1,4 +1,4 @@
1
- /** natural_issued: a Natural-issued card. external: a card the user added on the dashboard. */
1
+ /** natural_issued: an agent card Natural issued to you. external: a card the user added on the dashboard. */
2
2
  export declare const GetCardSessionsResponseCardSource: {
3
3
  readonly NaturalIssued: "natural_issued";
4
4
  readonly External: "external";
@@ -1,5 +1,5 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
- /** natural_issued: a Natural-issued card. external: a card the user added on the dashboard. */
2
+ /** natural_issued: an agent card Natural issued to you. external: a card the user added on the dashboard. */
3
3
  export const GetCardSessionsResponseCardSource = {
4
4
  NaturalIssued: "natural_issued",
5
5
  External: "external",
@@ -0,0 +1,6 @@
1
+ export interface GetCardSessionsResponseNote {
2
+ /** What to tell the user: what would let them skip the security code next time, such as verifying their identity or adding money to Natural. */
3
+ message: string;
4
+ /** A page to send the user to for that step. Null when there's nothing to do yet. */
5
+ url: string | null;
6
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -6,7 +6,9 @@ export * from "./ClaimCardSessionsResponseProxyProtocol.mjs";
6
6
  export * from "./CreateCardSessionsRequestPurchase.mjs";
7
7
  export * from "./CreateCardSessionsResponse.mjs";
8
8
  export * from "./CreateCardSessionsResponseCardSource.mjs";
9
+ export * from "./CreateCardSessionsResponseNote.mjs";
9
10
  export * from "./CreateCardSessionsResponseStatus.mjs";
10
11
  export * from "./GetCardSessionsResponse.mjs";
11
12
  export * from "./GetCardSessionsResponseCardSource.mjs";
13
+ export * from "./GetCardSessionsResponseNote.mjs";
12
14
  export * from "./GetCardSessionsResponseStatus.mjs";
@@ -6,7 +6,9 @@ export * from "./ClaimCardSessionsResponseProxyProtocol.mjs";
6
6
  export * from "./CreateCardSessionsRequestPurchase.mjs";
7
7
  export * from "./CreateCardSessionsResponse.mjs";
8
8
  export * from "./CreateCardSessionsResponseCardSource.mjs";
9
+ export * from "./CreateCardSessionsResponseNote.mjs";
9
10
  export * from "./CreateCardSessionsResponseStatus.mjs";
10
11
  export * from "./GetCardSessionsResponse.mjs";
11
12
  export * from "./GetCardSessionsResponseCardSource.mjs";
13
+ export * from "./GetCardSessionsResponseNote.mjs";
12
14
  export * from "./GetCardSessionsResponseStatus.mjs";
@@ -13,7 +13,6 @@ export declare const CreateInvitationsCustomersRequestAgentsItemPermissionsZeroI
13
13
  readonly WalletsCreate: "wallets.create";
14
14
  readonly WalletsUpdate: "wallets.update";
15
15
  readonly WalletsFund: "wallets.fund";
16
- readonly WalletsDeposit: "wallets.deposit";
17
16
  readonly WalletsTransfer: "wallets.transfer";
18
17
  readonly WalletsWithdraw: "wallets.withdraw";
19
18
  readonly PartyRead: "party.read";
@@ -14,7 +14,6 @@ export const CreateInvitationsCustomersRequestAgentsItemPermissionsZeroItem = {
14
14
  WalletsCreate: "wallets.create",
15
15
  WalletsUpdate: "wallets.update",
16
16
  WalletsFund: "wallets.fund",
17
- WalletsDeposit: "wallets.deposit",
18
17
  WalletsTransfer: "wallets.transfer",
19
18
  WalletsWithdraw: "wallets.withdraw",
20
19
  PartyRead: "party.read",
@@ -13,7 +13,6 @@ export declare const CreateInvitationLinksRequestProposedAgentsItemPermissionsIt
13
13
  readonly WalletsCreate: "wallets.create";
14
14
  readonly WalletsUpdate: "wallets.update";
15
15
  readonly WalletsFund: "wallets.fund";
16
- readonly WalletsDeposit: "wallets.deposit";
17
16
  readonly WalletsTransfer: "wallets.transfer";
18
17
  readonly WalletsWithdraw: "wallets.withdraw";
19
18
  readonly PartyRead: "party.read";
@@ -14,7 +14,6 @@ export const CreateInvitationLinksRequestProposedAgentsItemPermissionsItem = {
14
14
  WalletsCreate: "wallets.create",
15
15
  WalletsUpdate: "wallets.update",
16
16
  WalletsFund: "wallets.fund",
17
- WalletsDeposit: "wallets.deposit",
18
17
  WalletsTransfer: "wallets.transfer",
19
18
  WalletsWithdraw: "wallets.withdraw",
20
19
  PartyRead: "party.read",
@@ -38,7 +38,7 @@ export declare class SimulationsClient {
38
38
  * await client.simulations.inviteCustomer({
39
39
  * idempotencyKey: "Idempotency-Key",
40
40
  * agentIds: ["agt_019cd1798d637a4da75dce386343931d"],
41
- * permissions: ["wallets.create", "wallets.deposit", "wallets.withdraw", "wallets.transfer"],
41
+ * permissions: ["wallets.create", "wallets.withdraw", "wallets.transfer"],
42
42
  * type: "ORG",
43
43
  * message: "Please review the agent access request."
44
44
  * })
@@ -60,7 +60,7 @@ export class SimulationsClient {
60
60
  * await client.simulations.inviteCustomer({
61
61
  * idempotencyKey: "Idempotency-Key",
62
62
  * agentIds: ["agt_019cd1798d637a4da75dce386343931d"],
63
- * permissions: ["wallets.create", "wallets.deposit", "wallets.withdraw", "wallets.transfer"],
63
+ * permissions: ["wallets.create", "wallets.withdraw", "wallets.transfer"],
64
64
  * type: "ORG",
65
65
  * message: "Please review the agent access request."
66
66
  * })
@@ -4,7 +4,7 @@ import type * as Natural from "../../../../index.mjs";
4
4
  * {
5
5
  * idempotencyKey: "Idempotency-Key",
6
6
  * agentIds: ["agt_019cd1798d637a4da75dce386343931d"],
7
- * permissions: ["wallets.create", "wallets.deposit", "wallets.withdraw", "wallets.transfer"],
7
+ * permissions: ["wallets.create", "wallets.withdraw", "wallets.transfer"],
8
8
  * type: "ORG",
9
9
  * message: "Please review the agent access request."
10
10
  * }
@@ -13,7 +13,6 @@ export declare const InviteCustomerSimulationsRequestPermissionsZeroItem: {
13
13
  readonly WalletsCreate: "wallets.create";
14
14
  readonly WalletsUpdate: "wallets.update";
15
15
  readonly WalletsFund: "wallets.fund";
16
- readonly WalletsDeposit: "wallets.deposit";
17
16
  readonly WalletsTransfer: "wallets.transfer";
18
17
  readonly WalletsWithdraw: "wallets.withdraw";
19
18
  readonly PartyRead: "party.read";
@@ -14,7 +14,6 @@ export const InviteCustomerSimulationsRequestPermissionsZeroItem = {
14
14
  WalletsCreate: "wallets.create",
15
15
  WalletsUpdate: "wallets.update",
16
16
  WalletsFund: "wallets.fund",
17
- WalletsDeposit: "wallets.deposit",
18
17
  WalletsTransfer: "wallets.transfer",
19
18
  WalletsWithdraw: "wallets.withdraw",
20
19
  PartyRead: "party.read",
@@ -15,7 +15,7 @@ import type * as Natural from "../../../../index.mjs";
15
15
  export interface NewDepositParams {
16
16
  /** Unique key for safely retrying a request without creating duplicates. */
17
17
  idempotencyKey: string;
18
- /** Customer party to act for (pty_*). Omit to act as your own party. To act for another party, pass the ID of a party that has authorized you to act on its behalf. */
18
+ /** Omit or pass your own party ID (pty_*). Deposits on behalf of customers are not supported. */
19
19
  customerPartyId?: string;
20
20
  /** Amount in cents. */
21
21
  amount: number;
@@ -23,7 +23,7 @@ export interface NewDepositParams {
23
23
  currency?: Natural.InitiateDepositTransfersRequestCurrency;
24
24
  /** External account ID (eac_*). */
25
25
  externalAccountId: string;
26
- /** Wallet (wal_*) to deposit into. Omit to use the party default for user or party API calls, or the agent default for the current customer connection when acting through a connected agent. Owned agents use their own agent default. */
26
+ /** Your party's wallet (wal_*) to deposit into. Omit to use the party default for user or party API calls, or the agent default for owned agents. */
27
27
  walletId?: string;
28
28
  /** Transfer description. Maximum 80 characters. */
29
29
  description?: string;
@@ -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 = "disputes.read" | "disputes.create" | "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" | "payment_intents.create" | "payment_intents.read" | "card_payments.read" | "refunds.read" | "refunds.create" | "voice_sessions.read" | "voice_sessions.create" | "chargebacks.read" | "chargebacks.respond" | "mandates.read" | "enrollment.read" | "cards.read" | "saved_cards.use";
6
+ type Raw = "disputes.read" | "disputes.create" | "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.transfer" | "wallets.withdraw" | "party.read" | "party.update" | "payment_intents.create" | "payment_intents.read" | "card_payments.read" | "refunds.read" | "refunds.create" | "voice_sessions.read" | "voice_sessions.create" | "chargebacks.read" | "chargebacks.respond" | "mandates.read" | "enrollment.read" | "cards.read" | "saved_cards.use";
7
7
  }
@@ -15,7 +15,6 @@ export const CreateCustomerAgentsRequestPermissionsItem = core.serialization.enu
15
15
  "wallets.create",
16
16
  "wallets.update",
17
17
  "wallets.fund",
18
- "wallets.deposit",
19
18
  "wallets.transfer",
20
19
  "wallets.withdraw",
21
20
  "party.read",
@@ -2,6 +2,7 @@ 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
4
  import { CreateCardSessionsResponseCardSource } from "./CreateCardSessionsResponseCardSource.mjs";
5
+ import { CreateCardSessionsResponseNote } from "./CreateCardSessionsResponseNote.mjs";
5
6
  import { CreateCardSessionsResponseStatus } from "./CreateCardSessionsResponseStatus.mjs";
6
7
  export declare const CreateCardSessionsResponse: core.serialization.ObjectSchema<serializers.CreateCardSessionsResponse.Raw, Natural.CreateCardSessionsResponse>;
7
8
  export declare namespace CreateCardSessionsResponse {
@@ -15,6 +16,7 @@ export declare namespace CreateCardSessionsResponse {
15
16
  claimedAt?: string | null;
16
17
  credentialExpiresAt?: string | null;
17
18
  createdAt: string;
19
+ note?: CreateCardSessionsResponseNote.Raw | null;
18
20
  approvalUrl?: string | null;
19
21
  }
20
22
  }
@@ -1,6 +1,7 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
2
  import * as core from "../../../../core/index.mjs";
3
3
  import { CreateCardSessionsResponseCardSource } from "./CreateCardSessionsResponseCardSource.mjs";
4
+ import { CreateCardSessionsResponseNote } from "./CreateCardSessionsResponseNote.mjs";
4
5
  import { CreateCardSessionsResponseStatus } from "./CreateCardSessionsResponseStatus.mjs";
5
6
  export const CreateCardSessionsResponse = core.serialization.object({
6
7
  sessionId: core.serialization.string(),
@@ -12,5 +13,6 @@ export const CreateCardSessionsResponse = core.serialization.object({
12
13
  claimedAt: core.serialization.string().nullable(),
13
14
  credentialExpiresAt: core.serialization.string().nullable(),
14
15
  createdAt: core.serialization.string(),
16
+ note: CreateCardSessionsResponseNote.nullable(),
15
17
  approvalUrl: core.serialization.string().nullable(),
16
18
  });
@@ -0,0 +1,10 @@
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 CreateCardSessionsResponseNote: core.serialization.ObjectSchema<serializers.CreateCardSessionsResponseNote.Raw, Natural.CreateCardSessionsResponseNote>;
5
+ export declare namespace CreateCardSessionsResponseNote {
6
+ interface Raw {
7
+ message: string;
8
+ url?: string | null;
9
+ }
10
+ }
@@ -0,0 +1,6 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ import * as core from "../../../../core/index.mjs";
3
+ export const CreateCardSessionsResponseNote = core.serialization.object({
4
+ message: core.serialization.string(),
5
+ url: core.serialization.string().nullable(),
6
+ });
@@ -2,6 +2,7 @@ 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
4
  import { GetCardSessionsResponseCardSource } from "./GetCardSessionsResponseCardSource.mjs";
5
+ import { GetCardSessionsResponseNote } from "./GetCardSessionsResponseNote.mjs";
5
6
  import { GetCardSessionsResponseStatus } from "./GetCardSessionsResponseStatus.mjs";
6
7
  export declare const GetCardSessionsResponse: core.serialization.ObjectSchema<serializers.GetCardSessionsResponse.Raw, Natural.GetCardSessionsResponse>;
7
8
  export declare namespace GetCardSessionsResponse {
@@ -15,5 +16,6 @@ export declare namespace GetCardSessionsResponse {
15
16
  claimedAt?: string | null;
16
17
  credentialExpiresAt?: string | null;
17
18
  createdAt: string;
19
+ note?: GetCardSessionsResponseNote.Raw | null;
18
20
  }
19
21
  }
@@ -1,6 +1,7 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
2
  import * as core from "../../../../core/index.mjs";
3
3
  import { GetCardSessionsResponseCardSource } from "./GetCardSessionsResponseCardSource.mjs";
4
+ import { GetCardSessionsResponseNote } from "./GetCardSessionsResponseNote.mjs";
4
5
  import { GetCardSessionsResponseStatus } from "./GetCardSessionsResponseStatus.mjs";
5
6
  export const GetCardSessionsResponse = core.serialization.object({
6
7
  sessionId: core.serialization.string(),
@@ -12,4 +13,5 @@ export const GetCardSessionsResponse = core.serialization.object({
12
13
  claimedAt: core.serialization.string().nullable(),
13
14
  credentialExpiresAt: core.serialization.string().nullable(),
14
15
  createdAt: core.serialization.string(),
16
+ note: GetCardSessionsResponseNote.nullable(),
15
17
  });
@@ -0,0 +1,10 @@
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 GetCardSessionsResponseNote: core.serialization.ObjectSchema<serializers.GetCardSessionsResponseNote.Raw, Natural.GetCardSessionsResponseNote>;
5
+ export declare namespace GetCardSessionsResponseNote {
6
+ interface Raw {
7
+ message: string;
8
+ url?: string | null;
9
+ }
10
+ }
@@ -0,0 +1,6 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ import * as core from "../../../../core/index.mjs";
3
+ export const GetCardSessionsResponseNote = core.serialization.object({
4
+ message: core.serialization.string(),
5
+ url: core.serialization.string().nullable(),
6
+ });
@@ -6,7 +6,9 @@ export * from "./ClaimCardSessionsResponseProxyProtocol.mjs";
6
6
  export * from "./CreateCardSessionsRequestPurchase.mjs";
7
7
  export * from "./CreateCardSessionsResponse.mjs";
8
8
  export * from "./CreateCardSessionsResponseCardSource.mjs";
9
+ export * from "./CreateCardSessionsResponseNote.mjs";
9
10
  export * from "./CreateCardSessionsResponseStatus.mjs";
10
11
  export * from "./GetCardSessionsResponse.mjs";
11
12
  export * from "./GetCardSessionsResponseCardSource.mjs";
13
+ export * from "./GetCardSessionsResponseNote.mjs";
12
14
  export * from "./GetCardSessionsResponseStatus.mjs";
@@ -6,7 +6,9 @@ export * from "./ClaimCardSessionsResponseProxyProtocol.mjs";
6
6
  export * from "./CreateCardSessionsRequestPurchase.mjs";
7
7
  export * from "./CreateCardSessionsResponse.mjs";
8
8
  export * from "./CreateCardSessionsResponseCardSource.mjs";
9
+ export * from "./CreateCardSessionsResponseNote.mjs";
9
10
  export * from "./CreateCardSessionsResponseStatus.mjs";
10
11
  export * from "./GetCardSessionsResponse.mjs";
11
12
  export * from "./GetCardSessionsResponseCardSource.mjs";
13
+ export * from "./GetCardSessionsResponseNote.mjs";
12
14
  export * from "./GetCardSessionsResponseStatus.mjs";
@@ -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 CreateInvitationsCustomersRequestAgentsItemPermissionsZeroItem: core.serialization.Schema<serializers.CreateInvitationsCustomersRequestAgentsItemPermissionsZeroItem.Raw, Natural.CreateInvitationsCustomersRequestAgentsItemPermissionsZeroItem>;
5
5
  export declare namespace CreateInvitationsCustomersRequestAgentsItemPermissionsZeroItem {
6
- type Raw = "disputes.read" | "disputes.create" | "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" | "payment_intents.create" | "payment_intents.read" | "card_payments.read" | "refunds.read" | "refunds.create" | "voice_sessions.read" | "voice_sessions.create" | "chargebacks.read" | "chargebacks.respond" | "mandates.read" | "enrollment.read" | "cards.read" | "saved_cards.use";
6
+ type Raw = "disputes.read" | "disputes.create" | "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.transfer" | "wallets.withdraw" | "party.read" | "party.update" | "payment_intents.create" | "payment_intents.read" | "card_payments.read" | "refunds.read" | "refunds.create" | "voice_sessions.read" | "voice_sessions.create" | "chargebacks.read" | "chargebacks.respond" | "mandates.read" | "enrollment.read" | "cards.read" | "saved_cards.use";
7
7
  }
@@ -15,7 +15,6 @@ export const CreateInvitationsCustomersRequestAgentsItemPermissionsZeroItem = co
15
15
  "wallets.create",
16
16
  "wallets.update",
17
17
  "wallets.fund",
18
- "wallets.deposit",
19
18
  "wallets.transfer",
20
19
  "wallets.withdraw",
21
20
  "party.read",
@@ -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 = "disputes.read" | "disputes.create" | "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" | "payment_intents.create" | "payment_intents.read" | "card_payments.read" | "refunds.read" | "refunds.create" | "voice_sessions.read" | "voice_sessions.create" | "chargebacks.read" | "chargebacks.respond" | "mandates.read" | "enrollment.read" | "cards.read" | "saved_cards.use";
6
+ type Raw = "disputes.read" | "disputes.create" | "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.transfer" | "wallets.withdraw" | "party.read" | "party.update" | "payment_intents.create" | "payment_intents.read" | "card_payments.read" | "refunds.read" | "refunds.create" | "voice_sessions.read" | "voice_sessions.create" | "chargebacks.read" | "chargebacks.respond" | "mandates.read" | "enrollment.read" | "cards.read" | "saved_cards.use";
7
7
  }
@@ -15,7 +15,6 @@ export const CreateInvitationLinksRequestProposedAgentsItemPermissionsItem = cor
15
15
  "wallets.create",
16
16
  "wallets.update",
17
17
  "wallets.fund",
18
- "wallets.deposit",
19
18
  "wallets.transfer",
20
19
  "wallets.withdraw",
21
20
  "party.read",
@@ -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 InviteCustomerSimulationsRequestPermissionsZeroItem: core.serialization.Schema<serializers.InviteCustomerSimulationsRequestPermissionsZeroItem.Raw, Natural.InviteCustomerSimulationsRequestPermissionsZeroItem>;
5
5
  export declare namespace InviteCustomerSimulationsRequestPermissionsZeroItem {
6
- type Raw = "disputes.read" | "disputes.create" | "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" | "payment_intents.create" | "payment_intents.read" | "card_payments.read" | "refunds.read" | "refunds.create" | "voice_sessions.read" | "voice_sessions.create" | "chargebacks.read" | "chargebacks.respond" | "mandates.read" | "enrollment.read" | "cards.read" | "saved_cards.use";
6
+ type Raw = "disputes.read" | "disputes.create" | "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.transfer" | "wallets.withdraw" | "party.read" | "party.update" | "payment_intents.create" | "payment_intents.read" | "card_payments.read" | "refunds.read" | "refunds.create" | "voice_sessions.read" | "voice_sessions.create" | "chargebacks.read" | "chargebacks.respond" | "mandates.read" | "enrollment.read" | "cards.read" | "saved_cards.use";
7
7
  }
@@ -15,7 +15,6 @@ export const InviteCustomerSimulationsRequestPermissionsZeroItem = core.serializ
15
15
  "wallets.create",
16
16
  "wallets.update",
17
17
  "wallets.fund",
18
- "wallets.deposit",
19
18
  "wallets.transfer",
20
19
  "wallets.withdraw",
21
20
  "party.read",
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.6.35";
1
+ export declare const SDK_VERSION = "1.6.37";
@@ -1 +1 @@
1
- export const SDK_VERSION = "1.6.35";
1
+ export const SDK_VERSION = "1.6.37";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@naturalpay/sdk",
3
- "version": "1.6.35",
3
+ "version": "1.6.37",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
package/reference.md CHANGED
@@ -9754,7 +9754,7 @@ Create a test customer and a pending invitation for each agent you name
9754
9754
  await client.simulations.inviteCustomer({
9755
9755
  idempotencyKey: "Idempotency-Key",
9756
9756
  agentIds: ["agt_019cd1798d637a4da75dce386343931d"],
9757
- permissions: ["wallets.create", "wallets.deposit", "wallets.withdraw", "wallets.transfer"],
9757
+ permissions: ["wallets.create", "wallets.withdraw", "wallets.transfer"],
9758
9758
  type: "ORG",
9759
9759
  message: "Please review the agent access request."
9760
9760
  });