@moovio/sdk 0.12.6 → 0.13.0

package/src/models/errors/upsertunderwritingerror.ts

@@ -0,0 +1,185 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import * as components from "../components/index.js";
+import { MoovError } from "./mooverror.js";
+
+export type UpsertUnderwritingErrorData = {
+  geographicReach?: string | undefined;
+  businessPresence?: string | undefined;
+  pendingLitigation?: string | undefined;
+  volumeShareByCustomerType?:
+    | components.VolumeShareByCustomerTypeError
+    | undefined;
+  collectFunds?: components.CollectFundsError | undefined;
+  moneyTransfer?: components.MoneyTransferError | undefined;
+  sendFunds?: components.SendFundsError | undefined;
+  averageMonthlyTransactionVolume?: string | undefined;
+  averageTransactionSize?: string | undefined;
+  maxTransactionSize?: string | undefined;
+  volumeByCustomerType?: components.VolumeByCustomerTypeError | undefined;
+  cardVolumeDistribution?: components.CardVolumeDistributionError | undefined;
+  fulfillment?: components.FulfillmentDetailsError | undefined;
+};
+
+export class UpsertUnderwritingError extends MoovError {
+  geographicReach?: string | undefined;
+  businessPresence?: string | undefined;
+  pendingLitigation?: string | undefined;
+  volumeShareByCustomerType?:
+    | components.VolumeShareByCustomerTypeError
+    | undefined;
+  collectFunds?: components.CollectFundsError | undefined;
+  moneyTransfer?: components.MoneyTransferError | undefined;
+  sendFunds?: components.SendFundsError | undefined;
+  averageMonthlyTransactionVolume?: string | undefined;
+  averageTransactionSize?: string | undefined;
+  maxTransactionSize?: string | undefined;
+  volumeByCustomerType?: components.VolumeByCustomerTypeError | undefined;
+  cardVolumeDistribution?: components.CardVolumeDistributionError | undefined;
+  fulfillment?: components.FulfillmentDetailsError | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: UpsertUnderwritingErrorData;
+
+  constructor(
+    err: UpsertUnderwritingErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    if (err.geographicReach != null) this.geographicReach = err.geographicReach;
+    if (err.businessPresence != null) {
+      this.businessPresence = err.businessPresence;
+    }
+    if (err.pendingLitigation != null) {
+      this.pendingLitigation = err.pendingLitigation;
+    }
+    if (err.volumeShareByCustomerType != null) {
+      this.volumeShareByCustomerType = err.volumeShareByCustomerType;
+    }
+    if (err.collectFunds != null) this.collectFunds = err.collectFunds;
+    if (err.moneyTransfer != null) this.moneyTransfer = err.moneyTransfer;
+    if (err.sendFunds != null) this.sendFunds = err.sendFunds;
+    if (err.averageMonthlyTransactionVolume != null) {
+      this.averageMonthlyTransactionVolume =
+        err.averageMonthlyTransactionVolume;
+    }
+    if (err.averageTransactionSize != null) {
+      this.averageTransactionSize = err.averageTransactionSize;
+    }
+    if (err.maxTransactionSize != null) {
+      this.maxTransactionSize = err.maxTransactionSize;
+    }
+    if (err.volumeByCustomerType != null) {
+      this.volumeByCustomerType = err.volumeByCustomerType;
+    }
+    if (err.cardVolumeDistribution != null) {
+      this.cardVolumeDistribution = err.cardVolumeDistribution;
+    }
+    if (err.fulfillment != null) this.fulfillment = err.fulfillment;
+
+    this.name = "UpsertUnderwritingError";
+  }
+}
+
+/** @internal */
+export const UpsertUnderwritingError$inboundSchema: z.ZodType<
+  UpsertUnderwritingError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  geographicReach: z.string().optional(),
+  businessPresence: z.string().optional(),
+  pendingLitigation: z.string().optional(),
+  volumeShareByCustomerType: components
+    .VolumeShareByCustomerTypeError$inboundSchema.optional(),
+  collectFunds: components.CollectFundsError$inboundSchema.optional(),
+  moneyTransfer: components.MoneyTransferError$inboundSchema.optional(),
+  sendFunds: components.SendFundsError$inboundSchema.optional(),
+  averageMonthlyTransactionVolume: z.string().optional(),
+  averageTransactionSize: z.string().optional(),
+  maxTransactionSize: z.string().optional(),
+  volumeByCustomerType: components.VolumeByCustomerTypeError$inboundSchema
+    .optional(),
+  cardVolumeDistribution: components.CardVolumeDistributionError$inboundSchema
+    .optional(),
+  fulfillment: components.FulfillmentDetailsError$inboundSchema.optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new UpsertUnderwritingError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type UpsertUnderwritingError$Outbound = {
+  geographicReach?: string | undefined;
+  businessPresence?: string | undefined;
+  pendingLitigation?: string | undefined;
+  volumeShareByCustomerType?:
+    | components.VolumeShareByCustomerTypeError$Outbound
+    | undefined;
+  collectFunds?: components.CollectFundsError$Outbound | undefined;
+  moneyTransfer?: components.MoneyTransferError$Outbound | undefined;
+  sendFunds?: components.SendFundsError$Outbound | undefined;
+  averageMonthlyTransactionVolume?: string | undefined;
+  averageTransactionSize?: string | undefined;
+  maxTransactionSize?: string | undefined;
+  volumeByCustomerType?:
+    | components.VolumeByCustomerTypeError$Outbound
+    | undefined;
+  cardVolumeDistribution?:
+    | components.CardVolumeDistributionError$Outbound
+    | undefined;
+  fulfillment?: components.FulfillmentDetailsError$Outbound | undefined;
+};
+
+/** @internal */
+export const UpsertUnderwritingError$outboundSchema: z.ZodType<
+  UpsertUnderwritingError$Outbound,
+  z.ZodTypeDef,
+  UpsertUnderwritingError
+> = z.instanceof(UpsertUnderwritingError)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    geographicReach: z.string().optional(),
+    businessPresence: z.string().optional(),
+    pendingLitigation: z.string().optional(),
+    volumeShareByCustomerType: components
+      .VolumeShareByCustomerTypeError$outboundSchema.optional(),
+    collectFunds: components.CollectFundsError$outboundSchema.optional(),
+    moneyTransfer: components.MoneyTransferError$outboundSchema.optional(),
+    sendFunds: components.SendFundsError$outboundSchema.optional(),
+    averageMonthlyTransactionVolume: z.string().optional(),
+    averageTransactionSize: z.string().optional(),
+    maxTransactionSize: z.string().optional(),
+    volumeByCustomerType: components.VolumeByCustomerTypeError$outboundSchema
+      .optional(),
+    cardVolumeDistribution: components
+      .CardVolumeDistributionError$outboundSchema.optional(),
+    fulfillment: components.FulfillmentDetailsError$outboundSchema.optional(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpsertUnderwritingError$ {
+  /** @deprecated use `UpsertUnderwritingError$inboundSchema` instead. */
+  export const inboundSchema = UpsertUnderwritingError$inboundSchema;
+  /** @deprecated use `UpsertUnderwritingError$outboundSchema` instead. */
+  export const outboundSchema = UpsertUnderwritingError$outboundSchema;
+  /** @deprecated use `UpsertUnderwritingError$Outbound` instead. */
+  export type Outbound = UpsertUnderwritingError$Outbound;
+}

package/src/models/operations/index.ts

@@ -120,6 +120,7 @@ export * from "./requestcard.js";
 export * from "./retrievefees.js";
 export * from "./revokeaccesstoken.js";
 export * from "./revokeonboardinginvite.js";
+export * from "./saveunderwriting.js";
 export * from "./searchinstitutions.js";
 export * from "./submitdisputeevidence.js";
 export * from "./testendtoendtoken.js";

package/src/models/operations/listtransfers.ts

@@ -63,6 +63,10 @@ export type ListTransfersRequest = {
    * Optional parameter to only return disputed transfers.
    */
   disputed?: boolean | undefined;
+  /**
+   * Optional alias from a foreign/external system which can be used to reference this resource.
+   */
+  foreignID?: string | undefined;
   skip?: number | undefined;
   count?: number | undefined;
   accountID: string;
@@ -153,6 +157,7 @@ export const ListTransfersRequest$inboundSchema: z.ZodType<
   paymentLinkCode: z.string().optional(),
   refunded: z.boolean().optional(),
   disputed: z.boolean().optional(),
+  foreignID: z.string().optional(),
   skip: z.number().int().optional(),
   count: z.number().int().optional(),
   accountID: z.string(),
@@ -169,6 +174,7 @@ export type ListTransfersRequest$Outbound = {
   paymentLinkCode?: string | undefined;
   refunded?: boolean | undefined;
   disputed?: boolean | undefined;
+  foreignID?: string | undefined;
   skip?: number | undefined;
   count?: number | undefined;
   accountID: string;
@@ -189,6 +195,7 @@ export const ListTransfersRequest$outboundSchema: z.ZodType<
   paymentLinkCode: z.string().optional(),
   refunded: z.boolean().optional(),
   disputed: z.boolean().optional(),
+  foreignID: z.string().optional(),
   skip: z.number().int().optional(),
   count: z.number().int().optional(),
   accountID: z.string(),

package/src/models/operations/saveunderwriting.ts

@@ -0,0 +1,231 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type SaveUnderwritingGlobals = {
+  /**
+   * Specify an API version.
+   *
+   * @remarks
+   *
+   * API versioning follows the format `vYYYY.QQ.BB`, where
+   *   - `YYYY` is the year
+   *   - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
+   *   - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter.
+   *     - For example, `v2024.01.00` is the initial release of the first quarter of 2024.
+   *
+   * The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
+   */
+  xMoovVersion?: string | undefined;
+};
+
+export type SaveUnderwritingRequest = {
+  accountID: string;
+  upsertUnderwriting: components.UpsertUnderwriting;
+};
+
+export type SaveUnderwritingResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.Underwriting;
+};
+
+/** @internal */
+export const SaveUnderwritingGlobals$inboundSchema: z.ZodType<
+  SaveUnderwritingGlobals,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "x-moov-version": z.string().default("v2024.01.00"),
+}).transform((v) => {
+  return remap$(v, {
+    "x-moov-version": "xMoovVersion",
+  });
+});
+
+/** @internal */
+export type SaveUnderwritingGlobals$Outbound = {
+  "x-moov-version": string;
+};
+
+/** @internal */
+export const SaveUnderwritingGlobals$outboundSchema: z.ZodType<
+  SaveUnderwritingGlobals$Outbound,
+  z.ZodTypeDef,
+  SaveUnderwritingGlobals
+> = z.object({
+  xMoovVersion: z.string().default("v2024.01.00"),
+}).transform((v) => {
+  return remap$(v, {
+    xMoovVersion: "x-moov-version",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SaveUnderwritingGlobals$ {
+  /** @deprecated use `SaveUnderwritingGlobals$inboundSchema` instead. */
+  export const inboundSchema = SaveUnderwritingGlobals$inboundSchema;
+  /** @deprecated use `SaveUnderwritingGlobals$outboundSchema` instead. */
+  export const outboundSchema = SaveUnderwritingGlobals$outboundSchema;
+  /** @deprecated use `SaveUnderwritingGlobals$Outbound` instead. */
+  export type Outbound = SaveUnderwritingGlobals$Outbound;
+}
+
+export function saveUnderwritingGlobalsToJSON(
+  saveUnderwritingGlobals: SaveUnderwritingGlobals,
+): string {
+  return JSON.stringify(
+    SaveUnderwritingGlobals$outboundSchema.parse(saveUnderwritingGlobals),
+  );
+}
+
+export function saveUnderwritingGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<SaveUnderwritingGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SaveUnderwritingGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SaveUnderwritingGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const SaveUnderwritingRequest$inboundSchema: z.ZodType<
+  SaveUnderwritingRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountID: z.string(),
+  UpsertUnderwriting: components.UpsertUnderwriting$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "UpsertUnderwriting": "upsertUnderwriting",
+  });
+});
+
+/** @internal */
+export type SaveUnderwritingRequest$Outbound = {
+  accountID: string;
+  UpsertUnderwriting: components.UpsertUnderwriting$Outbound;
+};
+
+/** @internal */
+export const SaveUnderwritingRequest$outboundSchema: z.ZodType<
+  SaveUnderwritingRequest$Outbound,
+  z.ZodTypeDef,
+  SaveUnderwritingRequest
+> = z.object({
+  accountID: z.string(),
+  upsertUnderwriting: components.UpsertUnderwriting$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    upsertUnderwriting: "UpsertUnderwriting",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SaveUnderwritingRequest$ {
+  /** @deprecated use `SaveUnderwritingRequest$inboundSchema` instead. */
+  export const inboundSchema = SaveUnderwritingRequest$inboundSchema;
+  /** @deprecated use `SaveUnderwritingRequest$outboundSchema` instead. */
+  export const outboundSchema = SaveUnderwritingRequest$outboundSchema;
+  /** @deprecated use `SaveUnderwritingRequest$Outbound` instead. */
+  export type Outbound = SaveUnderwritingRequest$Outbound;
+}
+
+export function saveUnderwritingRequestToJSON(
+  saveUnderwritingRequest: SaveUnderwritingRequest,
+): string {
+  return JSON.stringify(
+    SaveUnderwritingRequest$outboundSchema.parse(saveUnderwritingRequest),
+  );
+}
+
+export function saveUnderwritingRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<SaveUnderwritingRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SaveUnderwritingRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SaveUnderwritingRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const SaveUnderwritingResponse$inboundSchema: z.ZodType<
+  SaveUnderwritingResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())),
+  Result: components.Underwriting$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type SaveUnderwritingResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.Underwriting$Outbound;
+};
+
+/** @internal */
+export const SaveUnderwritingResponse$outboundSchema: z.ZodType<
+  SaveUnderwritingResponse$Outbound,
+  z.ZodTypeDef,
+  SaveUnderwritingResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: components.Underwriting$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SaveUnderwritingResponse$ {
+  /** @deprecated use `SaveUnderwritingResponse$inboundSchema` instead. */
+  export const inboundSchema = SaveUnderwritingResponse$inboundSchema;
+  /** @deprecated use `SaveUnderwritingResponse$outboundSchema` instead. */
+  export const outboundSchema = SaveUnderwritingResponse$outboundSchema;
+  /** @deprecated use `SaveUnderwritingResponse$Outbound` instead. */
+  export type Outbound = SaveUnderwritingResponse$Outbound;
+}
+
+export function saveUnderwritingResponseToJSON(
+  saveUnderwritingResponse: SaveUnderwritingResponse,
+): string {
+  return JSON.stringify(
+    SaveUnderwritingResponse$outboundSchema.parse(saveUnderwritingResponse),
+  );
+}
+
+export function saveUnderwritingResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SaveUnderwritingResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SaveUnderwritingResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SaveUnderwritingResponse' from JSON`,
+  );
+}

package/src/sdk/underwriting.ts

@@ -3,6 +3,7 @@
  */
 
 import { underwritingGet } from "../funcs/underwritingGet.js";
+import { underwritingSave } from "../funcs/underwritingSave.js";
 import { underwritingUpsert } from "../funcs/underwritingUpsert.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
@@ -28,6 +29,25 @@ export class Underwriting extends ClientSDK {
     ));
   }
 
+  /**
+   * Create or update the account's underwriting.
+   *
+   * Read our [underwriting guide](https://docs.moov.io/guides/accounts/requirements/underwriting/) to learn more.
+   *
+   * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+   * you'll need to specify the `/accounts/{accountID}/profile.write` scope.
+   */
+  async save(
+    request: operations.SaveUnderwritingRequest,
+    options?: RequestOptions,
+  ): Promise<operations.SaveUnderwritingResponse> {
+    return unwrapAsync(underwritingSave(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Create or update the account's underwriting.
    *