@moovio/sdk 26.7.0-dev.4 → 26.7.0-dev.5

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 (180) hide show
  1. package/README.md +81 -61
  2. package/bin/mcp-server.js +1304 -954
  3. package/bin/mcp-server.js.map +41 -31
  4. package/funcs/bankAccountsLink.d.ts +1 -1
  5. package/funcs/bankAccountsLink.js +1 -1
  6. package/funcs/depositViewCreate.d.ts +22 -0
  7. package/funcs/depositViewCreate.d.ts.map +1 -0
  8. package/funcs/depositViewCreate.js +136 -0
  9. package/funcs/depositViewCreate.js.map +1 -0
  10. package/jsr.json +1 -1
  11. package/lib/config.d.ts +3 -3
  12. package/lib/config.js +3 -3
  13. package/mcp-server/mcp-server.js +1 -1
  14. package/mcp-server/server.d.ts.map +1 -1
  15. package/mcp-server/server.js +3 -1
  16. package/mcp-server/server.js.map +1 -1
  17. package/mcp-server/tools/bankAccountsLink.js +1 -1
  18. package/mcp-server/tools/depositViewCreate.d.ts +8 -0
  19. package/mcp-server/tools/depositViewCreate.d.ts.map +1 -0
  20. package/mcp-server/tools/depositViewCreate.js +69 -0
  21. package/mcp-server/tools/depositViewCreate.js.map +1 -0
  22. package/models/components/capabilityid.d.ts +1 -0
  23. package/models/components/capabilityid.d.ts.map +1 -1
  24. package/models/components/capabilityid.js +1 -0
  25. package/models/components/capabilityid.js.map +1 -1
  26. package/models/components/cardtransactiondetails.d.ts +7 -0
  27. package/models/components/cardtransactiondetails.d.ts.map +1 -1
  28. package/models/components/cardtransactiondetails.js +4 -0
  29. package/models/components/cardtransactiondetails.js.map +1 -1
  30. package/models/components/cardtransactionstatus.d.ts +1 -0
  31. package/models/components/cardtransactionstatus.d.ts.map +1 -1
  32. package/models/components/cardtransactionstatus.js +1 -0
  33. package/models/components/cardtransactionstatus.js.map +1 -1
  34. package/models/components/createtransferdestinationcard.d.ts +5 -0
  35. package/models/components/createtransferdestinationcard.d.ts.map +1 -1
  36. package/models/components/createtransferdestinationcard.js +2 -0
  37. package/models/components/createtransferdestinationcard.js.map +1 -1
  38. package/models/components/depositaccountingestedresponse.d.ts +39 -0
  39. package/models/components/depositaccountingestedresponse.d.ts.map +1 -0
  40. package/models/components/depositaccountingestedresponse.js +66 -0
  41. package/models/components/depositaccountingestedresponse.js.map +1 -0
  42. package/models/components/fullissuedcard.d.ts +1 -3
  43. package/models/components/fullissuedcard.d.ts.map +1 -1
  44. package/models/components/fullissuedcard.js.map +1 -1
  45. package/models/components/index.d.ts +6 -0
  46. package/models/components/index.d.ts.map +1 -1
  47. package/models/components/index.js +6 -0
  48. package/models/components/index.js.map +1 -1
  49. package/models/components/invoice.d.ts +5 -0
  50. package/models/components/invoice.d.ts.map +1 -1
  51. package/models/components/invoice.js +2 -0
  52. package/models/components/invoice.js.map +1 -1
  53. package/models/components/issuedcard.d.ts +1 -3
  54. package/models/components/issuedcard.d.ts.map +1 -1
  55. package/models/components/issuedcard.js.map +1 -1
  56. package/models/components/issuedcardstate.d.ts +2 -8
  57. package/models/components/issuedcardstate.d.ts.map +1 -1
  58. package/models/components/issuedcardstate.js +1 -5
  59. package/models/components/issuedcardstate.js.map +1 -1
  60. package/models/components/manualtermsofservice.d.ts +1 -1
  61. package/models/components/manualtermsofserviceupdate.d.ts +1 -1
  62. package/models/components/patchtransfer.d.ts +5 -2
  63. package/models/components/patchtransfer.d.ts.map +1 -1
  64. package/models/components/patchtransfer.js +2 -2
  65. package/models/components/patchtransfer.js.map +1 -1
  66. package/models/components/patchwallet.d.ts +4 -7
  67. package/models/components/patchwallet.d.ts.map +1 -1
  68. package/models/components/patchwallet.js +4 -4
  69. package/models/components/patchwallet.js.map +1 -1
  70. package/models/components/paymentlinkpayoutdetails.d.ts +11 -0
  71. package/models/components/paymentlinkpayoutdetails.d.ts.map +1 -1
  72. package/models/components/paymentlinkpayoutdetails.js +3 -0
  73. package/models/components/paymentlinkpayoutdetails.js.map +1 -1
  74. package/models/components/paymentlinkpayoutdetailsupdate.d.ts +11 -0
  75. package/models/components/paymentlinkpayoutdetailsupdate.d.ts.map +1 -1
  76. package/models/components/paymentlinkpayoutdetailsupdate.js +3 -0
  77. package/models/components/paymentlinkpayoutdetailsupdate.js.map +1 -1
  78. package/models/components/paymentmethodscard.d.ts +8 -0
  79. package/models/components/paymentmethodscard.d.ts.map +1 -1
  80. package/models/components/paymentmethodscard.js +2 -0
  81. package/models/components/paymentmethodscard.js.map +1 -1
  82. package/models/components/payoutdetailserror.d.ts +3 -0
  83. package/models/components/payoutdetailserror.d.ts.map +1 -1
  84. package/models/components/payoutdetailserror.js +3 -0
  85. package/models/components/payoutdetailserror.js.map +1 -1
  86. package/models/components/pushdeliveryspeed.d.ts +18 -0
  87. package/models/components/pushdeliveryspeed.d.ts.map +1 -0
  88. package/models/components/pushdeliveryspeed.js +52 -0
  89. package/models/components/pushdeliveryspeed.js.map +1 -0
  90. package/models/components/pushoptions.d.ts +35 -0
  91. package/models/components/pushoptions.d.ts.map +1 -0
  92. package/models/components/pushoptions.js +62 -0
  93. package/models/components/pushoptions.js.map +1 -0
  94. package/models/components/pushoptionserror.d.ts +19 -0
  95. package/models/components/pushoptionserror.d.ts.map +1 -0
  96. package/models/components/pushoptionserror.js +61 -0
  97. package/models/components/pushoptionserror.js.map +1 -0
  98. package/models/components/pushoptionsupdate.d.ts +35 -0
  99. package/models/components/pushoptionsupdate.d.ts.map +1 -0
  100. package/models/components/pushoptionsupdate.js +62 -0
  101. package/models/components/pushoptionsupdate.js.map +1 -0
  102. package/models/components/sourcesystem.d.ts +29 -0
  103. package/models/components/sourcesystem.d.ts.map +1 -0
  104. package/models/components/sourcesystem.js +58 -0
  105. package/models/components/sourcesystem.js.map +1 -0
  106. package/models/components/termsofservice.d.ts +1 -1
  107. package/models/components/updatepaymentlinkamountdetails.d.ts +60 -5
  108. package/models/components/updatepaymentlinkamountdetails.d.ts.map +1 -1
  109. package/models/components/updatepaymentlinkamountdetails.js +43 -6
  110. package/models/components/updatepaymentlinkamountdetails.js.map +1 -1
  111. package/models/errors/depositaccountvalidationerror.d.ts +41 -0
  112. package/models/errors/depositaccountvalidationerror.d.ts.map +1 -0
  113. package/models/errors/depositaccountvalidationerror.js +81 -0
  114. package/models/errors/depositaccountvalidationerror.js.map +1 -0
  115. package/models/errors/index.d.ts +1 -0
  116. package/models/errors/index.d.ts.map +1 -1
  117. package/models/errors/index.js +1 -0
  118. package/models/errors/index.js.map +1 -1
  119. package/models/operations/createdepositaccount.d.ts +44 -0
  120. package/models/operations/createdepositaccount.d.ts.map +1 -0
  121. package/models/operations/createdepositaccount.js +113 -0
  122. package/models/operations/createdepositaccount.js.map +1 -0
  123. package/models/operations/index.d.ts +1 -0
  124. package/models/operations/index.d.ts.map +1 -1
  125. package/models/operations/index.js +1 -0
  126. package/models/operations/index.js.map +1 -1
  127. package/models/operations/linkbankaccount.d.ts +1 -1
  128. package/models/operations/listissuedcards.d.ts +1 -1
  129. package/package.json +1 -1
  130. package/sdk/bankaccounts.d.ts +1 -1
  131. package/sdk/bankaccounts.js +1 -1
  132. package/sdk/depositview.d.ts +16 -0
  133. package/sdk/depositview.d.ts.map +1 -0
  134. package/sdk/depositview.js +26 -0
  135. package/sdk/depositview.js.map +1 -0
  136. package/sdk/sdk.d.ts +3 -0
  137. package/sdk/sdk.d.ts.map +1 -1
  138. package/sdk/sdk.js +4 -0
  139. package/sdk/sdk.js.map +1 -1
  140. package/src/funcs/bankAccountsLink.ts +1 -1
  141. package/src/funcs/depositViewCreate.ts +201 -0
  142. package/src/lib/config.ts +3 -3
  143. package/src/mcp-server/mcp-server.ts +1 -1
  144. package/src/mcp-server/server.ts +3 -1
  145. package/src/mcp-server/tools/bankAccountsLink.ts +1 -1
  146. package/src/mcp-server/tools/depositViewCreate.ts +43 -0
  147. package/src/models/components/capabilityid.ts +1 -0
  148. package/src/models/components/cardtransactiondetails.ts +11 -0
  149. package/src/models/components/cardtransactionstatus.ts +1 -0
  150. package/src/models/components/createtransferdestinationcard.ts +7 -0
  151. package/src/models/components/depositaccountingestedresponse.ts +86 -0
  152. package/src/models/components/fullissuedcard.ts +1 -3
  153. package/src/models/components/index.ts +6 -0
  154. package/src/models/components/invoice.ts +7 -0
  155. package/src/models/components/issuedcard.ts +1 -3
  156. package/src/models/components/issuedcardstate.ts +2 -8
  157. package/src/models/components/manualtermsofservice.ts +1 -1
  158. package/src/models/components/manualtermsofserviceupdate.ts +1 -1
  159. package/src/models/components/patchtransfer.ts +7 -4
  160. package/src/models/components/patchwallet.ts +8 -11
  161. package/src/models/components/paymentlinkpayoutdetails.ts +18 -0
  162. package/src/models/components/paymentlinkpayoutdetailsupdate.ts +18 -0
  163. package/src/models/components/paymentmethodscard.ts +10 -0
  164. package/src/models/components/payoutdetailserror.ts +10 -0
  165. package/src/models/components/pushdeliveryspeed.ts +32 -0
  166. package/src/models/components/pushoptions.ts +72 -0
  167. package/src/models/components/pushoptionserror.ts +56 -0
  168. package/src/models/components/pushoptionsupdate.ts +76 -0
  169. package/src/models/components/sourcesystem.ts +43 -0
  170. package/src/models/components/termsofservice.ts +1 -1
  171. package/src/models/components/updatepaymentlinkamountdetails.ts +114 -14
  172. package/src/models/errors/depositaccountvalidationerror.ts +86 -0
  173. package/src/models/errors/index.ts +1 -0
  174. package/src/models/operations/createdepositaccount.ts +146 -0
  175. package/src/models/operations/index.ts +1 -0
  176. package/src/models/operations/linkbankaccount.ts +1 -1
  177. package/src/models/operations/listissuedcards.ts +1 -1
  178. package/src/sdk/bankaccounts.ts +1 -1
  179. package/src/sdk/depositview.ts +31 -0
  180. package/src/sdk/sdk.ts +6 -0
@@ -0,0 +1,43 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { depositViewCreate } from "../../funcs/depositViewCreate.js";
6
+ import * as operations from "../../models/operations/index.js";
7
+ import { formatResult, ToolDefinition } from "../tools.js";
8
+
9
+ const args = {
10
+ request: operations.CreateDepositAccountRequest$inboundSchema,
11
+ };
12
+
13
+ export const tool$depositViewCreate: ToolDefinition<typeof args> = {
14
+ name: "deposit-view-create",
15
+ description:
16
+ `Ingest a deposit account into the deposit view from a core banking source system.
17
+
18
+ The request body is a raw byte payload whose format depends on the core banking
19
+ system that produced it. Set the \`X-Source-System\` header to identify that system
20
+ so the payload can be parsed correctly.
21
+
22
+ To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
23
+ you'll need to specify the \`/accounts/{accountID}/profile.write\` scope.`,
24
+ args,
25
+ tool: async (client, args, ctx) => {
26
+ const [result, apiCall] = await depositViewCreate(
27
+ client,
28
+ args.request,
29
+ { fetchOptions: { signal: ctx.signal } },
30
+ ).$inspect();
31
+
32
+ if (!result.ok) {
33
+ return {
34
+ content: [{ type: "text", text: result.error.message }],
35
+ isError: true,
36
+ };
37
+ }
38
+
39
+ const value = result.value.result;
40
+
41
+ return formatResult(value, apiCall);
42
+ },
43
+ };
@@ -34,6 +34,7 @@ export const CapabilityID = {
34
34
  Wallet: "wallet",
35
35
  WalletBalance: "wallet.balance",
36
36
  CardIssuing: "card-issuing",
37
+ IssuingCardholder: "issuing.cardholder",
37
38
  ProductionApp: "production-app",
38
39
  PlatformProductionApp: "platform.production-app",
39
40
  PlatformWalletTransfers: "platform.wallet-transfers",
@@ -36,6 +36,10 @@ export type CardTransactionDetails = {
36
36
  * An optional override of the default card statement descriptor for a transfer. Accounts must be enabled by Moov to set this field.
37
37
  */
38
38
  dynamicDescriptor?: string | undefined;
39
+ /**
40
+ * The scheduled date and time for the transfer to be delivered. This field is only valid for push-to-card transfers. Must be between 24 and 48 hours in the future in production. In sandbox mode, any future time up to 48 hours is accepted so integrations can test deferred delivery using the sandbox test cards with relaxed wait times.
41
+ */
42
+ scheduledDeliveryOn?: Date | undefined;
39
43
  /**
40
44
  * Specifies the nature and initiator of a transaction.
41
45
  *
@@ -51,6 +55,7 @@ export type CardTransactionDetails = {
51
55
  failedOn?: Date | undefined;
52
56
  canceledOn?: Date | undefined;
53
57
  completedOn?: Date | undefined;
58
+ deferredOn?: Date | undefined;
54
59
  /**
55
60
  * The program assigned by the card network that determines the interchange rate for the transfer.
56
61
  *
@@ -76,6 +81,7 @@ export const CardTransactionDetails$inboundSchema: z.ZodType<
76
81
  status: types.optional(CardTransactionStatus$inboundSchema),
77
82
  failureCode: types.optional(CardTransactionFailureCode$inboundSchema),
78
83
  dynamicDescriptor: types.optional(types.string()),
84
+ scheduledDeliveryOn: types.optional(types.date()),
79
85
  transactionSource: types.optional(TransactionSource$inboundSchema),
80
86
  initiatedOn: types.optional(types.date()),
81
87
  confirmedOn: types.optional(types.date()),
@@ -83,6 +89,7 @@ export const CardTransactionDetails$inboundSchema: z.ZodType<
83
89
  failedOn: types.optional(types.date()),
84
90
  canceledOn: types.optional(types.date()),
85
91
  completedOn: types.optional(types.date()),
92
+ deferredOn: types.optional(types.date()),
86
93
  interchangeQualification: types.optional(types.string()),
87
94
  feeProgram: types.optional(types.string()),
88
95
  authorizationCode: types.optional(types.string()),
@@ -92,6 +99,7 @@ export type CardTransactionDetails$Outbound = {
92
99
  status?: string | undefined;
93
100
  failureCode?: string | undefined;
94
101
  dynamicDescriptor?: string | undefined;
102
+ scheduledDeliveryOn?: string | undefined;
95
103
  transactionSource?: string | undefined;
96
104
  initiatedOn?: string | undefined;
97
105
  confirmedOn?: string | undefined;
@@ -99,6 +107,7 @@ export type CardTransactionDetails$Outbound = {
99
107
  failedOn?: string | undefined;
100
108
  canceledOn?: string | undefined;
101
109
  completedOn?: string | undefined;
110
+ deferredOn?: string | undefined;
102
111
  interchangeQualification?: string | undefined;
103
112
  feeProgram?: string | undefined;
104
113
  authorizationCode?: string | undefined;
@@ -113,6 +122,7 @@ export const CardTransactionDetails$outboundSchema: z.ZodType<
113
122
  status: CardTransactionStatus$outboundSchema.optional(),
114
123
  failureCode: CardTransactionFailureCode$outboundSchema.optional(),
115
124
  dynamicDescriptor: z.string().optional(),
125
+ scheduledDeliveryOn: z.date().transform(v => v.toISOString()).optional(),
116
126
  transactionSource: TransactionSource$outboundSchema.optional(),
117
127
  initiatedOn: z.date().transform(v => v.toISOString()).optional(),
118
128
  confirmedOn: z.date().transform(v => v.toISOString()).optional(),
@@ -120,6 +130,7 @@ export const CardTransactionDetails$outboundSchema: z.ZodType<
120
130
  failedOn: z.date().transform(v => v.toISOString()).optional(),
121
131
  canceledOn: z.date().transform(v => v.toISOString()).optional(),
122
132
  completedOn: z.date().transform(v => v.toISOString()).optional(),
133
+ deferredOn: z.date().transform(v => v.toISOString()).optional(),
123
134
  interchangeQualification: z.string().optional(),
124
135
  feeProgram: z.string().optional(),
125
136
  authorizationCode: z.string().optional(),
@@ -16,6 +16,7 @@ export const CardTransactionStatus = {
16
16
  Settled: "settled",
17
17
  Failed: "failed",
18
18
  Completed: "completed",
19
+ Deferred: "deferred",
19
20
  } as const;
20
21
  /**
21
22
  * Status of a transaction within the card payment lifecycle.
@@ -18,6 +18,10 @@ export type CreateTransferDestinationCard = {
18
18
  * An optional override of the default card statement descriptor for a transfer. Accounts must be enabled by Moov to set this field.
19
19
  */
20
20
  dynamicDescriptor?: string | undefined;
21
+ /**
22
+ * The scheduled date and time for the transfer to be delivered. This field is only valid for push-to-card transfers. Must be between 24 and 48 hours in the future in production. In sandbox mode, any future time up to 48 hours is accepted so integrations can test deferred delivery using the sandbox test cards with relaxed wait times.
23
+ */
24
+ scheduledDeliveryOn?: Date | undefined;
21
25
  /**
22
26
  * An optional field to specify the type of card payout, used to route the transfer with the appropriate business application identifier (BAI).
23
27
  */
@@ -31,11 +35,13 @@ export const CreateTransferDestinationCard$inboundSchema: z.ZodType<
31
35
  unknown
32
36
  > = z.object({
33
37
  dynamicDescriptor: types.optional(types.string()),
38
+ scheduledDeliveryOn: types.optional(types.date()),
34
39
  payoutType: types.optional(CardPayoutType$inboundSchema),
35
40
  });
36
41
  /** @internal */
37
42
  export type CreateTransferDestinationCard$Outbound = {
38
43
  dynamicDescriptor?: string | undefined;
44
+ scheduledDeliveryOn?: string | undefined;
39
45
  payoutType?: string | undefined;
40
46
  };
41
47
 
@@ -46,6 +52,7 @@ export const CreateTransferDestinationCard$outboundSchema: z.ZodType<
46
52
  CreateTransferDestinationCard
47
53
  > = z.object({
48
54
  dynamicDescriptor: z.string().optional(),
55
+ scheduledDeliveryOn: z.date().transform(v => v.toISOString()).optional(),
49
56
  payoutType: CardPayoutType$outboundSchema.optional(),
50
57
  });
51
58
 
@@ -0,0 +1,86 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import * as types from "../../types/primitives.js";
9
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
+ import {
11
+ SourceSystem,
12
+ SourceSystem$inboundSchema,
13
+ SourceSystem$outboundSchema,
14
+ } from "./sourcesystem.js";
15
+
16
+ /**
17
+ * The result of ingesting a deposit account into the deposit view.
18
+ */
19
+ export type DepositAccountIngestedResponse = {
20
+ /**
21
+ * The Moov account that owns the deposit view the account was ingested into.
22
+ */
23
+ moovAccountID: string;
24
+ /**
25
+ * The core banking source system that produced the ingested payload.
26
+ */
27
+ sourceSystem: SourceSystem;
28
+ /**
29
+ * The identifier of the deposit account within the source system.
30
+ */
31
+ sourceAccountID: string;
32
+ /**
33
+ * The date and time the deposit account was ingested.
34
+ */
35
+ ingestedAt: Date;
36
+ };
37
+
38
+ /** @internal */
39
+ export const DepositAccountIngestedResponse$inboundSchema: z.ZodType<
40
+ DepositAccountIngestedResponse,
41
+ z.ZodTypeDef,
42
+ unknown
43
+ > = z.object({
44
+ moovAccountID: types.string(),
45
+ sourceSystem: SourceSystem$inboundSchema,
46
+ sourceAccountID: types.string(),
47
+ ingestedAt: types.date(),
48
+ });
49
+ /** @internal */
50
+ export type DepositAccountIngestedResponse$Outbound = {
51
+ moovAccountID: string;
52
+ sourceSystem: string;
53
+ sourceAccountID: string;
54
+ ingestedAt: string;
55
+ };
56
+
57
+ /** @internal */
58
+ export const DepositAccountIngestedResponse$outboundSchema: z.ZodType<
59
+ DepositAccountIngestedResponse$Outbound,
60
+ z.ZodTypeDef,
61
+ DepositAccountIngestedResponse
62
+ > = z.object({
63
+ moovAccountID: z.string(),
64
+ sourceSystem: SourceSystem$outboundSchema,
65
+ sourceAccountID: z.string(),
66
+ ingestedAt: z.date().transform(v => v.toISOString()),
67
+ });
68
+
69
+ export function depositAccountIngestedResponseToJSON(
70
+ depositAccountIngestedResponse: DepositAccountIngestedResponse,
71
+ ): string {
72
+ return JSON.stringify(
73
+ DepositAccountIngestedResponse$outboundSchema.parse(
74
+ depositAccountIngestedResponse,
75
+ ),
76
+ );
77
+ }
78
+ export function depositAccountIngestedResponseFromJSON(
79
+ jsonString: string,
80
+ ): SafeParseResult<DepositAccountIngestedResponse, SDKValidationError> {
81
+ return safeParse(
82
+ jsonString,
83
+ (x) => DepositAccountIngestedResponse$inboundSchema.parse(JSON.parse(x)),
84
+ `Failed to parse 'DepositAccountIngestedResponse' from JSON`,
85
+ );
86
+ }
@@ -80,10 +80,8 @@ export type FullIssuedCard = {
80
80
  *
81
81
  * @remarks
82
82
  *
83
- * - `active`: The card is operational and approves authorizations. Generally becomes active shortly after card creation.
84
- * - `inactive`: The card cannot approve authorizations. This is currently a temporary state assigned post-creation during the activation process.
83
+ * - `active`: The card is operational and can approve authorizations.
85
84
  * - `closed`: The card is permanently deactivated and cannot approve authorizations. A card can be closed by request or when it expires.
86
- * - `pending-verification`: Awaiting additional authorized user verification before the card can be activated.
87
85
  */
88
86
  state: IssuedCardState;
89
87
  /**
@@ -216,6 +216,7 @@ export * from "./customamountpaymentdetailserror.js";
216
216
  export * from "./customersupport.js";
217
217
  export * from "./customersupporterror.js";
218
218
  export * from "./debitholdperiod.js";
219
+ export * from "./depositaccountingestedresponse.js";
219
220
  export * from "./disbursementpaymentmethodtype.js";
220
221
  export * from "./displayoptionserror.js";
221
222
  export * from "./dispute.js";
@@ -425,6 +426,10 @@ export * from "./pullfromcardpaymentmethod.js";
425
426
  export * from "./pullfromcardtransferpaymentmethod.js";
426
427
  export * from "./pullfromgooglepaypaymentmethod.js";
427
428
  export * from "./pullfromgooglepaytransferpaymentmethod.js";
429
+ export * from "./pushdeliveryspeed.js";
430
+ export * from "./pushoptions.js";
431
+ export * from "./pushoptionserror.js";
432
+ export * from "./pushoptionsupdate.js";
428
433
  export * from "./pushtoapplepaypaymentmethod.js";
429
434
  export * from "./pushtoapplepaytransferpaymentmethod.js";
430
435
  export * from "./pushtocardpaymentmethod.js";
@@ -493,6 +498,7 @@ export * from "./sentreceipt.js";
493
498
  export * from "./settings.js";
494
499
  export * from "./sharescopes.js";
495
500
  export * from "./sourcedestinationoptions.js";
501
+ export * from "./sourcesystem.js";
496
502
  export * from "./statement.js";
497
503
  export * from "./submissionintent.js";
498
504
  export * from "./sweep.js";
@@ -88,6 +88,10 @@ export type Invoice = {
88
88
  */
89
89
  disputedAmount: AmountDecimal;
90
90
  paymentLinkCode?: string | undefined;
91
+ /**
92
+ * URL to the hosted payment link for the invoice.
93
+ */
94
+ paymentLinkURL?: string | undefined;
91
95
  /**
92
96
  * Payment made towards an invoice, will be either a transfer or an external payment.
93
97
  */
@@ -121,6 +125,7 @@ export const Invoice$inboundSchema: z.ZodType<Invoice, z.ZodTypeDef, unknown> =
121
125
  refundedAmount: AmountDecimal$inboundSchema,
122
126
  disputedAmount: AmountDecimal$inboundSchema,
123
127
  paymentLinkCode: types.optional(types.string()),
128
+ paymentLinkURL: types.optional(types.string()),
124
129
  invoicePayments: types.optional(z.array(InvoicePayment$inboundSchema)),
125
130
  createdOn: types.date(),
126
131
  invoiceDate: types.optional(types.date()),
@@ -149,6 +154,7 @@ export type Invoice$Outbound = {
149
154
  refundedAmount: AmountDecimal$Outbound;
150
155
  disputedAmount: AmountDecimal$Outbound;
151
156
  paymentLinkCode?: string | undefined;
157
+ paymentLinkURL?: string | undefined;
152
158
  invoicePayments?: Array<InvoicePayment$Outbound> | undefined;
153
159
  createdOn: string;
154
160
  invoiceDate?: string | undefined;
@@ -182,6 +188,7 @@ export const Invoice$outboundSchema: z.ZodType<
182
188
  refundedAmount: AmountDecimal$outboundSchema,
183
189
  disputedAmount: AmountDecimal$outboundSchema,
184
190
  paymentLinkCode: z.string().optional(),
191
+ paymentLinkURL: z.string().optional(),
185
192
  invoicePayments: z.array(InvoicePayment$outboundSchema).optional(),
186
193
  createdOn: z.date().transform(v => v.toISOString()),
187
194
  invoiceDate: z.date().transform(v => v.toISOString()).optional(),
@@ -77,10 +77,8 @@ export type IssuedCard = {
77
77
  *
78
78
  * @remarks
79
79
  *
80
- * - `active`: The card is operational and approves authorizations. Generally becomes active shortly after card creation.
81
- * - `inactive`: The card cannot approve authorizations. This is currently a temporary state assigned post-creation during the activation process.
80
+ * - `active`: The card is operational and can approve authorizations.
82
81
  * - `closed`: The card is permanently deactivated and cannot approve authorizations. A card can be closed by request or when it expires.
83
- * - `pending-verification`: Awaiting additional authorized user verification before the card can be activated.
84
82
  */
85
83
  state: IssuedCardState;
86
84
  /**
@@ -11,15 +11,11 @@ import { OpenEnum } from "../../types/enums.js";
11
11
  *
12
12
  * @remarks
13
13
  *
14
- * - `active`: The card is operational and approves authorizations. Generally becomes active shortly after card creation.
15
- * - `inactive`: The card cannot approve authorizations. This is currently a temporary state assigned post-creation during the activation process.
14
+ * - `active`: The card is operational and can approve authorizations.
16
15
  * - `closed`: The card is permanently deactivated and cannot approve authorizations. A card can be closed by request or when it expires.
17
- * - `pending-verification`: Awaiting additional authorized user verification before the card can be activated.
18
16
  */
19
17
  export const IssuedCardState = {
20
18
  Active: "active",
21
- Inactive: "inactive",
22
- PendingVerification: "pending-verification",
23
19
  Closed: "closed",
24
20
  } as const;
25
21
  /**
@@ -27,10 +23,8 @@ export const IssuedCardState = {
27
23
  *
28
24
  * @remarks
29
25
  *
30
- * - `active`: The card is operational and approves authorizations. Generally becomes active shortly after card creation.
31
- * - `inactive`: The card cannot approve authorizations. This is currently a temporary state assigned post-creation during the activation process.
26
+ * - `active`: The card is operational and can approve authorizations.
32
27
  * - `closed`: The card is permanently deactivated and cannot approve authorizations. A card can be closed by request or when it expires.
33
- * - `pending-verification`: Awaiting additional authorized user verification before the card can be activated.
34
28
  */
35
29
  export type IssuedCardState = OpenEnum<typeof IssuedCardState>;
36
30
 
@@ -17,7 +17,7 @@ export type ManualTermsOfService = {
17
17
  */
18
18
  acceptedDate: Date;
19
19
  /**
20
- * The IP address from which the terms of service were accepted.
20
+ * The IP address (IPv4 or IPv6) from which the terms of service were accepted.
21
21
  */
22
22
  acceptedIP: string;
23
23
  /**
@@ -17,7 +17,7 @@ export type ManualTermsOfServiceUpdate = {
17
17
  */
18
18
  acceptedDate?: Date | undefined;
19
19
  /**
20
- * The IP address from which the terms of service were accepted.
20
+ * The IP address (IPv4 or IPv6) from which the terms of service were accepted.
21
21
  */
22
22
  acceptedIP?: string | undefined;
23
23
  /**
@@ -9,11 +9,14 @@ import * as types from "../../types/primitives.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
10
 
11
11
  export type PatchTransfer = {
12
+ /**
13
+ * Free-form key-value pair list. Useful for storing information that is not captured elsewhere.
14
+ */
12
15
  metadata?: { [k: string]: string } | null | undefined;
13
16
  /**
14
17
  * Optional alias from a foreign/external system which can be used to reference this resource.
15
18
  */
16
- foreignID?: string | undefined;
19
+ foreignID?: string | null | undefined;
17
20
  };
18
21
 
19
22
  /** @internal */
@@ -23,12 +26,12 @@ export const PatchTransfer$inboundSchema: z.ZodType<
23
26
  unknown
24
27
  > = z.object({
25
28
  metadata: z.nullable(z.record(types.string())).optional(),
26
- foreignID: types.optional(types.string()),
29
+ foreignID: z.nullable(types.string()).optional(),
27
30
  });
28
31
  /** @internal */
29
32
  export type PatchTransfer$Outbound = {
30
33
  metadata?: { [k: string]: string } | null | undefined;
31
- foreignID?: string | undefined;
34
+ foreignID?: string | null | undefined;
32
35
  };
33
36
 
34
37
  /** @internal */
@@ -38,7 +41,7 @@ export const PatchTransfer$outboundSchema: z.ZodType<
38
41
  PatchTransfer
39
42
  > = z.object({
40
43
  metadata: z.nullable(z.record(z.string())).optional(),
41
- foreignID: z.string().optional(),
44
+ foreignID: z.nullable(z.string()).optional(),
42
45
  });
43
46
 
44
47
  export function patchTransferToJSON(patchTransfer: PatchTransfer): string {
@@ -23,11 +23,8 @@ export type PatchWallet = {
23
23
  * - `closed`: The wallet is no longer active and the corresponding payment method has been disabled.
24
24
  */
25
25
  status?: WalletStatus | undefined;
26
- description?: string | undefined;
27
- /**
28
- * Free-form key-value pair list. Useful for storing information that is not captured elsewhere.
29
- */
30
- metadata?: { [k: string]: string } | undefined;
26
+ description?: string | null | undefined;
27
+ metadata?: { [k: string]: string } | null | undefined;
31
28
  };
32
29
 
33
30
  /** @internal */
@@ -38,15 +35,15 @@ export const PatchWallet$inboundSchema: z.ZodType<
38
35
  > = z.object({
39
36
  name: types.optional(types.string()),
40
37
  status: types.optional(WalletStatus$inboundSchema),
41
- description: types.optional(types.string()),
42
- metadata: types.optional(z.record(types.string())),
38
+ description: z.nullable(types.string()).optional(),
39
+ metadata: z.nullable(z.record(types.string())).optional(),
43
40
  });
44
41
  /** @internal */
45
42
  export type PatchWallet$Outbound = {
46
43
  name?: string | undefined;
47
44
  status?: string | undefined;
48
- description?: string | undefined;
49
- metadata?: { [k: string]: string } | undefined;
45
+ description?: string | null | undefined;
46
+ metadata?: { [k: string]: string } | null | undefined;
50
47
  };
51
48
 
52
49
  /** @internal */
@@ -57,8 +54,8 @@ export const PatchWallet$outboundSchema: z.ZodType<
57
54
  > = z.object({
58
55
  name: z.string().optional(),
59
56
  status: WalletStatus$outboundSchema.optional(),
60
- description: z.string().optional(),
61
- metadata: z.record(z.string()).optional(),
57
+ description: z.nullable(z.string()).optional(),
58
+ metadata: z.nullable(z.record(z.string())).optional(),
62
59
  });
63
60
 
64
61
  export function patchWalletToJSON(patchWallet: PatchWallet): string {
@@ -18,6 +18,12 @@ import {
18
18
  PayoutRecipient$Outbound,
19
19
  PayoutRecipient$outboundSchema,
20
20
  } from "./payoutrecipient.js";
21
+ import {
22
+ PushOptions,
23
+ PushOptions$inboundSchema,
24
+ PushOptions$Outbound,
25
+ PushOptions$outboundSchema,
26
+ } from "./pushoptions.js";
21
27
 
22
28
  export type PaymentLinkPayoutDetails = {
23
29
  /**
@@ -37,6 +43,15 @@ export type PaymentLinkPayoutDetails = {
37
43
  * Optional free-form metadata for the transfer.
38
44
  */
39
45
  metadata?: { [k: string]: string } | undefined;
46
+ /**
47
+ * Delivery options for push-to-card payouts. Only applies when `allowedMethods` includes `push-to-card`.
48
+ *
49
+ * @remarks
50
+ *
51
+ * The `deferred` speed and `deferredBy` apply to `push-to-card` only. Other push methods
52
+ * (`push-to-apple-pay`, `push-to-google-pay`) are always delivered instantly regardless of these options.
53
+ */
54
+ pushOptions?: PushOptions | undefined;
40
55
  };
41
56
 
42
57
  /** @internal */
@@ -48,12 +63,14 @@ export const PaymentLinkPayoutDetails$inboundSchema: z.ZodType<
48
63
  allowedMethods: z.array(DisbursementPaymentMethodType$inboundSchema),
49
64
  recipient: PayoutRecipient$inboundSchema,
50
65
  metadata: types.optional(z.record(types.string())),
66
+ pushOptions: types.optional(PushOptions$inboundSchema),
51
67
  });
52
68
  /** @internal */
53
69
  export type PaymentLinkPayoutDetails$Outbound = {
54
70
  allowedMethods: Array<string>;
55
71
  recipient: PayoutRecipient$Outbound;
56
72
  metadata?: { [k: string]: string } | undefined;
73
+ pushOptions?: PushOptions$Outbound | undefined;
57
74
  };
58
75
 
59
76
  /** @internal */
@@ -65,6 +82,7 @@ export const PaymentLinkPayoutDetails$outboundSchema: z.ZodType<
65
82
  allowedMethods: z.array(DisbursementPaymentMethodType$outboundSchema),
66
83
  recipient: PayoutRecipient$outboundSchema,
67
84
  metadata: z.record(z.string()).optional(),
85
+ pushOptions: PushOptions$outboundSchema.optional(),
68
86
  });
69
87
 
70
88
  export function paymentLinkPayoutDetailsToJSON(
@@ -18,6 +18,12 @@ import {
18
18
  PayoutRecipient$Outbound,
19
19
  PayoutRecipient$outboundSchema,
20
20
  } from "./payoutrecipient.js";
21
+ import {
22
+ PushOptionsUpdate,
23
+ PushOptionsUpdate$inboundSchema,
24
+ PushOptionsUpdate$Outbound,
25
+ PushOptionsUpdate$outboundSchema,
26
+ } from "./pushoptionsupdate.js";
21
27
 
22
28
  export type PaymentLinkPayoutDetailsUpdate = {
23
29
  /**
@@ -37,6 +43,15 @@ export type PaymentLinkPayoutDetailsUpdate = {
37
43
  * Optional free-form metadata for the transfer.
38
44
  */
39
45
  metadata?: { [k: string]: string } | undefined;
46
+ /**
47
+ * Delivery options for push-to-card payouts. Only applies when `allowedMethods` includes `push-to-card`.
48
+ *
49
+ * @remarks
50
+ *
51
+ * The `deferred` speed and `deferredBy` apply to `push-to-card` only. Other push methods
52
+ * (`push-to-apple-pay`, `push-to-google-pay`) are always delivered instantly regardless of these options.
53
+ */
54
+ pushOptions?: PushOptionsUpdate | undefined;
40
55
  };
41
56
 
42
57
  /** @internal */
@@ -50,12 +65,14 @@ export const PaymentLinkPayoutDetailsUpdate$inboundSchema: z.ZodType<
50
65
  ),
51
66
  recipient: types.optional(PayoutRecipient$inboundSchema),
52
67
  metadata: types.optional(z.record(types.string())),
68
+ pushOptions: types.optional(PushOptionsUpdate$inboundSchema),
53
69
  });
54
70
  /** @internal */
55
71
  export type PaymentLinkPayoutDetailsUpdate$Outbound = {
56
72
  allowedMethods?: Array<string> | undefined;
57
73
  recipient?: PayoutRecipient$Outbound | undefined;
58
74
  metadata?: { [k: string]: string } | undefined;
75
+ pushOptions?: PushOptionsUpdate$Outbound | undefined;
59
76
  };
60
77
 
61
78
  /** @internal */
@@ -68,6 +85,7 @@ export const PaymentLinkPayoutDetailsUpdate$outboundSchema: z.ZodType<
68
85
  .optional(),
69
86
  recipient: PayoutRecipient$outboundSchema.optional(),
70
87
  metadata: z.record(z.string()).optional(),
88
+ pushOptions: PushOptionsUpdate$outboundSchema.optional(),
71
89
  });
72
90
 
73
91
  export function paymentLinkPayoutDetailsUpdateToJSON(
@@ -131,6 +131,13 @@ export type PaymentMethodsCard = {
131
131
  * Indicates if the card supports domestic pull-from-card transfer.
132
132
  */
133
133
  domesticPullFromCard?: DomesticPullFromCard | undefined;
134
+ /**
135
+ * The category or level of the card defined by the issuer.
136
+ *
137
+ * @remarks
138
+ * Examples include, but not limited to, "REWARDS", "TRADITIONAL REWARDS", "CLASSIC", and "CORPORATE PURCHASING".
139
+ */
140
+ cardCategory?: string | undefined;
134
141
  };
135
142
 
136
143
  /** @internal */
@@ -156,6 +163,7 @@ export const PaymentMethodsCard$inboundSchema: z.ZodType<
156
163
  cardAccountUpdater: types.optional(CardAccountUpdater$inboundSchema),
157
164
  domesticPushToCard: types.optional(DomesticPushToCard$inboundSchema),
158
165
  domesticPullFromCard: types.optional(DomesticPullFromCard$inboundSchema),
166
+ cardCategory: types.optional(types.string()),
159
167
  });
160
168
  /** @internal */
161
169
  export type PaymentMethodsCard$Outbound = {
@@ -176,6 +184,7 @@ export type PaymentMethodsCard$Outbound = {
176
184
  cardAccountUpdater?: CardAccountUpdater$Outbound | undefined;
177
185
  domesticPushToCard?: string | undefined;
178
186
  domesticPullFromCard?: string | undefined;
187
+ cardCategory?: string | undefined;
179
188
  };
180
189
 
181
190
  /** @internal */
@@ -201,6 +210,7 @@ export const PaymentMethodsCard$outboundSchema: z.ZodType<
201
210
  cardAccountUpdater: CardAccountUpdater$outboundSchema.optional(),
202
211
  domesticPushToCard: DomesticPushToCard$outboundSchema.optional(),
203
212
  domesticPullFromCard: DomesticPullFromCard$outboundSchema.optional(),
213
+ cardCategory: z.string().optional(),
204
214
  });
205
215
 
206
216
  export function paymentMethodsCardToJSON(
@@ -13,11 +13,18 @@ import {
13
13
  PayoutRecipientError$Outbound,
14
14
  PayoutRecipientError$outboundSchema,
15
15
  } from "./payoutrecipienterror.js";
16
+ import {
17
+ PushOptionsError,
18
+ PushOptionsError$inboundSchema,
19
+ PushOptionsError$Outbound,
20
+ PushOptionsError$outboundSchema,
21
+ } from "./pushoptionserror.js";
16
22
 
17
23
  export type PayoutDetailsError = {
18
24
  allowedMethods?: string | undefined;
19
25
  recipient?: PayoutRecipientError | undefined;
20
26
  metadata?: string | undefined;
27
+ pushOptions?: PushOptionsError | undefined;
21
28
  };
22
29
 
23
30
  /** @internal */
@@ -29,12 +36,14 @@ export const PayoutDetailsError$inboundSchema: z.ZodType<
29
36
  allowedMethods: types.optional(types.string()),
30
37
  recipient: types.optional(PayoutRecipientError$inboundSchema),
31
38
  metadata: types.optional(types.string()),
39
+ pushOptions: types.optional(PushOptionsError$inboundSchema),
32
40
  });
33
41
  /** @internal */
34
42
  export type PayoutDetailsError$Outbound = {
35
43
  allowedMethods?: string | undefined;
36
44
  recipient?: PayoutRecipientError$Outbound | undefined;
37
45
  metadata?: string | undefined;
46
+ pushOptions?: PushOptionsError$Outbound | undefined;
38
47
  };
39
48
 
40
49
  /** @internal */
@@ -46,6 +55,7 @@ export const PayoutDetailsError$outboundSchema: z.ZodType<
46
55
  allowedMethods: z.string().optional(),
47
56
  recipient: PayoutRecipientError$outboundSchema.optional(),
48
57
  metadata: z.string().optional(),
58
+ pushOptions: PushOptionsError$outboundSchema.optional(),
49
59
  });
50
60
 
51
61
  export function payoutDetailsErrorToJSON(