@moovio/sdk 0.22.7 → 0.22.8

package/src/models/components/sharescopes.ts

@@ -0,0 +1,65 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ApplicationScope,
+  ApplicationScope$inboundSchema,
+  ApplicationScope$outboundSchema,
+} from "./applicationscope.js";
+
+/**
+ * Describes the scopes being shared from a subject account to a principal account.
+ */
+export type ShareScopes = {
+  /**
+   * The account ID that will receive access to the scopes.
+   */
+  principalAccountID: string;
+  /**
+   * The list of scopes to share with the principal account. If none are provided, all intersecting scopes are added.
+   */
+  allowScopes?: Array<ApplicationScope> | undefined;
+};
+
+/** @internal */
+export const ShareScopes$inboundSchema: z.ZodType<
+  ShareScopes,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  principalAccountID: z.string(),
+  allowScopes: z.array(ApplicationScope$inboundSchema).optional(),
+});
+/** @internal */
+export type ShareScopes$Outbound = {
+  principalAccountID: string;
+  allowScopes?: Array<string> | undefined;
+};
+
+/** @internal */
+export const ShareScopes$outboundSchema: z.ZodType<
+  ShareScopes$Outbound,
+  z.ZodTypeDef,
+  ShareScopes
+> = z.object({
+  principalAccountID: z.string(),
+  allowScopes: z.array(ApplicationScope$outboundSchema).optional(),
+});
+
+export function shareScopesToJSON(shareScopes: ShareScopes): string {
+  return JSON.stringify(ShareScopes$outboundSchema.parse(shareScopes));
+}
+export function shareScopesFromJSON(
+  jsonString: string,
+): SafeParseResult<ShareScopes, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ShareScopes$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ShareScopes' from JSON`,
+  );
+}

package/src/models/errors/connectaccountrequestvalidationerror.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { MoovError } from "./mooverror.js";
+
+export type ConnectAccountRequestValidationErrorData = {
+  principalAccountID?: string | undefined;
+  allowScopes?: { [k: string]: string } | undefined;
+};
+
+export class ConnectAccountRequestValidationError extends MoovError {
+  principalAccountID?: string | undefined;
+  allowScopes?: { [k: string]: string } | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: ConnectAccountRequestValidationErrorData;
+
+  constructor(
+    err: ConnectAccountRequestValidationErrorData,
+    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.principalAccountID != null) {
+      this.principalAccountID = err.principalAccountID;
+    }
+    if (err.allowScopes != null) this.allowScopes = err.allowScopes;
+
+    this.name = "ConnectAccountRequestValidationError";
+  }
+}
+
+/** @internal */
+export const ConnectAccountRequestValidationError$inboundSchema: z.ZodType<
+  ConnectAccountRequestValidationError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  principalAccountID: z.string().optional(),
+  allowScopes: z.record(z.string()).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new ConnectAccountRequestValidationError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type ConnectAccountRequestValidationError$Outbound = {
+  principalAccountID?: string | undefined;
+  allowScopes?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export const ConnectAccountRequestValidationError$outboundSchema: z.ZodType<
+  ConnectAccountRequestValidationError$Outbound,
+  z.ZodTypeDef,
+  ConnectAccountRequestValidationError
+> = z.instanceof(ConnectAccountRequestValidationError)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    principalAccountID: z.string().optional(),
+    allowScopes: z.record(z.string()).optional(),
+  }));

package/src/models/errors/index.ts

@@ -10,6 +10,7 @@ export * from "./authtokenrequesterror.js";
 export * from "./bankaccountvalidationerror.js";
 export * from "./brandvalidationerror.js";
 export * from "./cardacquiringrefund.js";
+export * from "./connectaccountrequestvalidationerror.js";
 export * from "./createaccounterror.js";
 export * from "./createinvoiceerror.js";
 export * from "./createpaymentlinkerror.js";

package/src/models/operations/connectaccount.ts

@@ -0,0 +1,181 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 ConnectAccountGlobals = {
+  /**
+   * 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.
+   * When no version is specified, the API defaults to `v2024.01.00`.
+   */
+  xMoovVersion?: string | undefined;
+};
+
+export type ConnectAccountRequest = {
+  accountID: string;
+  shareScopes: components.ShareScopes;
+};
+
+export type ConnectAccountResponse = {
+  headers: { [k: string]: Array<string> };
+};
+
+/** @internal */
+export const ConnectAccountGlobals$inboundSchema: z.ZodType<
+  ConnectAccountGlobals,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "X-Moov-Version": z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "X-Moov-Version": "xMoovVersion",
+  });
+});
+/** @internal */
+export type ConnectAccountGlobals$Outbound = {
+  "X-Moov-Version"?: string | undefined;
+};
+
+/** @internal */
+export const ConnectAccountGlobals$outboundSchema: z.ZodType<
+  ConnectAccountGlobals$Outbound,
+  z.ZodTypeDef,
+  ConnectAccountGlobals
+> = z.object({
+  xMoovVersion: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    xMoovVersion: "X-Moov-Version",
+  });
+});
+
+export function connectAccountGlobalsToJSON(
+  connectAccountGlobals: ConnectAccountGlobals,
+): string {
+  return JSON.stringify(
+    ConnectAccountGlobals$outboundSchema.parse(connectAccountGlobals),
+  );
+}
+export function connectAccountGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<ConnectAccountGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConnectAccountGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConnectAccountGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const ConnectAccountRequest$inboundSchema: z.ZodType<
+  ConnectAccountRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountID: z.string(),
+  ShareScopes: components.ShareScopes$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "ShareScopes": "shareScopes",
+  });
+});
+/** @internal */
+export type ConnectAccountRequest$Outbound = {
+  accountID: string;
+  ShareScopes: components.ShareScopes$Outbound;
+};
+
+/** @internal */
+export const ConnectAccountRequest$outboundSchema: z.ZodType<
+  ConnectAccountRequest$Outbound,
+  z.ZodTypeDef,
+  ConnectAccountRequest
+> = z.object({
+  accountID: z.string(),
+  shareScopes: components.ShareScopes$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    shareScopes: "ShareScopes",
+  });
+});
+
+export function connectAccountRequestToJSON(
+  connectAccountRequest: ConnectAccountRequest,
+): string {
+  return JSON.stringify(
+    ConnectAccountRequest$outboundSchema.parse(connectAccountRequest),
+  );
+}
+export function connectAccountRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ConnectAccountRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConnectAccountRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConnectAccountRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const ConnectAccountResponse$inboundSchema: z.ZodType<
+  ConnectAccountResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+  });
+});
+/** @internal */
+export type ConnectAccountResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+};
+
+/** @internal */
+export const ConnectAccountResponse$outboundSchema: z.ZodType<
+  ConnectAccountResponse$Outbound,
+  z.ZodTypeDef,
+  ConnectAccountResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+  });
+});
+
+export function connectAccountResponseToJSON(
+  connectAccountResponse: ConnectAccountResponse,
+): string {
+  return JSON.stringify(
+    ConnectAccountResponse$outboundSchema.parse(connectAccountResponse),
+  );
+}
+export function connectAccountResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ConnectAccountResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConnectAccountResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConnectAccountResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -7,6 +7,7 @@ export * from "./assignaccountcountries.js";
 export * from "./cancelschedule.js";
 export * from "./completebankaccountverification.js";
 export * from "./completemicrodeposits.js";
+export * from "./connectaccount.js";
 export * from "./createaccesstoken.js";
 export * from "./createaccount.js";
 export * from "./createapplepaysession.js";
@@ -99,6 +100,7 @@ export * from "./listadjustments.js";
 export * from "./listbankaccounts.js";
 export * from "./listcapabilities.js";
 export * from "./listcards.js";
+export * from "./listconnectedaccountsforaccount.js";
 export * from "./listdisputeevidence.js";
 export * from "./listdisputes.js";
 export * from "./listfeeplanagreements.js";

package/src/models/operations/listconnectedaccountsforaccount.ts

@@ -0,0 +1,276 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 ListConnectedAccountsForAccountGlobals = {
+  /**
+   * 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.
+   * When no version is specified, the API defaults to `v2024.01.00`.
+   */
+  xMoovVersion?: string | undefined;
+};
+
+export type ListConnectedAccountsForAccountRequest = {
+  accountID: string;
+  /**
+   * Filter connected accounts by name.
+   *
+   * @remarks
+   *
+   * If provided, this query will attempt to find matches against the following Account and Profile fields:
+   * <ul>
+   *   <li>Account `displayName`</li>
+   *   <li>Individual Profile `firstName`, `middleName`, and `lastName`</li>
+   *   <li>Business Profile `legalBusinessName`</li>
+   * </ul>
+   *
+   * Filtering by Guest Profile `name` is not currently supported.
+   */
+  name?: string | undefined;
+  /**
+   *   Filter connected accounts by email address.
+   *
+   * @remarks
+   *
+   *   Provide the full email address to filter by email.
+   */
+  email?: string | undefined;
+  /**
+   *   Filter connected accounts by AccountType.
+   *
+   * @remarks
+   *
+   *   If the `type` parameter is used in combination with `name`, only the corresponding type's name fields will
+   *   be searched. For example, if `type=business` and `name=moov`, the search will attempt to find matches against
+   *   the display name and Business Profile name fields (`legalBusinessName`, and `doingBusinessAs`).
+   *
+   *   Filtering by `type=guest` is not currently supported.
+   */
+  type?: components.CreateAccountType | undefined;
+  /**
+   *   Serves as an optional alias from a foreign/external system which can be used to reference this resource.
+   */
+  foreignID?: string | undefined;
+  /**
+   * Filter disconnected accounts.
+   *
+   * @remarks
+   *
+   * If true, the response will include disconnected accounts.
+   */
+  includeDisconnected?: boolean | undefined;
+  /**
+   *   Filter connected accounts by the capability.
+   */
+  capability?: components.CapabilityID | undefined;
+  /**
+   *   Filter connected accounts by the capability.
+   */
+  capabilityStatus?: components.CapabilityStatus | undefined;
+  skip?: number | undefined;
+  count?: number | undefined;
+};
+
+export type ListConnectedAccountsForAccountResponse = {
+  headers: { [k: string]: Array<string> };
+  result: Array<components.Account>;
+};
+
+/** @internal */
+export const ListConnectedAccountsForAccountGlobals$inboundSchema: z.ZodType<
+  ListConnectedAccountsForAccountGlobals,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "X-Moov-Version": z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "X-Moov-Version": "xMoovVersion",
+  });
+});
+/** @internal */
+export type ListConnectedAccountsForAccountGlobals$Outbound = {
+  "X-Moov-Version"?: string | undefined;
+};
+
+/** @internal */
+export const ListConnectedAccountsForAccountGlobals$outboundSchema: z.ZodType<
+  ListConnectedAccountsForAccountGlobals$Outbound,
+  z.ZodTypeDef,
+  ListConnectedAccountsForAccountGlobals
+> = z.object({
+  xMoovVersion: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    xMoovVersion: "X-Moov-Version",
+  });
+});
+
+export function listConnectedAccountsForAccountGlobalsToJSON(
+  listConnectedAccountsForAccountGlobals:
+    ListConnectedAccountsForAccountGlobals,
+): string {
+  return JSON.stringify(
+    ListConnectedAccountsForAccountGlobals$outboundSchema.parse(
+      listConnectedAccountsForAccountGlobals,
+    ),
+  );
+}
+export function listConnectedAccountsForAccountGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<ListConnectedAccountsForAccountGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListConnectedAccountsForAccountGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListConnectedAccountsForAccountGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListConnectedAccountsForAccountRequest$inboundSchema: z.ZodType<
+  ListConnectedAccountsForAccountRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountID: z.string(),
+  name: z.string().optional(),
+  email: z.string().optional(),
+  type: components.CreateAccountType$inboundSchema.optional(),
+  foreignID: z.string().optional(),
+  includeDisconnected: z.boolean().optional(),
+  capability: components.CapabilityID$inboundSchema.optional(),
+  capabilityStatus: components.CapabilityStatus$inboundSchema.optional(),
+  skip: z.number().int().optional(),
+  count: z.number().int().optional(),
+});
+/** @internal */
+export type ListConnectedAccountsForAccountRequest$Outbound = {
+  accountID: string;
+  name?: string | undefined;
+  email?: string | undefined;
+  type?: string | undefined;
+  foreignID?: string | undefined;
+  includeDisconnected?: boolean | undefined;
+  capability?: string | undefined;
+  capabilityStatus?: string | undefined;
+  skip?: number | undefined;
+  count?: number | undefined;
+};
+
+/** @internal */
+export const ListConnectedAccountsForAccountRequest$outboundSchema: z.ZodType<
+  ListConnectedAccountsForAccountRequest$Outbound,
+  z.ZodTypeDef,
+  ListConnectedAccountsForAccountRequest
+> = z.object({
+  accountID: z.string(),
+  name: z.string().optional(),
+  email: z.string().optional(),
+  type: components.CreateAccountType$outboundSchema.optional(),
+  foreignID: z.string().optional(),
+  includeDisconnected: z.boolean().optional(),
+  capability: components.CapabilityID$outboundSchema.optional(),
+  capabilityStatus: components.CapabilityStatus$outboundSchema.optional(),
+  skip: z.number().int().optional(),
+  count: z.number().int().optional(),
+});
+
+export function listConnectedAccountsForAccountRequestToJSON(
+  listConnectedAccountsForAccountRequest:
+    ListConnectedAccountsForAccountRequest,
+): string {
+  return JSON.stringify(
+    ListConnectedAccountsForAccountRequest$outboundSchema.parse(
+      listConnectedAccountsForAccountRequest,
+    ),
+  );
+}
+export function listConnectedAccountsForAccountRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListConnectedAccountsForAccountRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListConnectedAccountsForAccountRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListConnectedAccountsForAccountRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListConnectedAccountsForAccountResponse$inboundSchema: z.ZodType<
+  ListConnectedAccountsForAccountResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: z.array(components.Account$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+/** @internal */
+export type ListConnectedAccountsForAccountResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: Array<components.Account$Outbound>;
+};
+
+/** @internal */
+export const ListConnectedAccountsForAccountResponse$outboundSchema: z.ZodType<
+  ListConnectedAccountsForAccountResponse$Outbound,
+  z.ZodTypeDef,
+  ListConnectedAccountsForAccountResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: z.array(components.Account$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+export function listConnectedAccountsForAccountResponseToJSON(
+  listConnectedAccountsForAccountResponse:
+    ListConnectedAccountsForAccountResponse,
+): string {
+  return JSON.stringify(
+    ListConnectedAccountsForAccountResponse$outboundSchema.parse(
+      listConnectedAccountsForAccountResponse,
+    ),
+  );
+}
+export function listConnectedAccountsForAccountResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListConnectedAccountsForAccountResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListConnectedAccountsForAccountResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListConnectedAccountsForAccountResponse' from JSON`,
+  );
+}

package/src/sdk/accounts.ts

@@ -3,6 +3,7 @@
  */
 
 import { accountsAssignCountries } from "../funcs/accountsAssignCountries.js";
+import { accountsConnect } from "../funcs/accountsConnect.js";
 import { accountsCreate } from "../funcs/accountsCreate.js";
 import { accountsDisconnect } from "../funcs/accountsDisconnect.js";
 import { accountsGet } from "../funcs/accountsGet.js";
@@ -10,6 +11,7 @@ import { accountsGetCountries } from "../funcs/accountsGetCountries.js";
 import { accountsGetMerchantProcessingAgreement } from "../funcs/accountsGetMerchantProcessingAgreement.js";
 import { accountsGetTermsOfServiceToken } from "../funcs/accountsGetTermsOfServiceToken.js";
 import { accountsList } from "../funcs/accountsList.js";
+import { accountsListConnected } from "../funcs/accountsListConnected.js";
 import { accountsUpdate } from "../funcs/accountsUpdate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
@@ -127,6 +129,42 @@ export class Accounts extends ClientSDK {
     ));
   }
 
+  /**
+   * List or search accounts to which the caller is connected.
+   *
+   * All supported query parameters are optional. If none are provided the response will include all connected accounts.
+   * Pagination is supported via the `skip` and `count` query parameters. Searching by name and email will overlap and
+   * return results based on relevance. Accounts with AccountType `guest` will not be included in the response.
+   *
+   * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need
+   * to specify the `/accounts.read` scope.
+   */
+  async listConnected(
+    request: operations.ListConnectedAccountsForAccountRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListConnectedAccountsForAccountResponse> {
+    return unwrapAsync(accountsListConnected(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Shares access scopes from the account specified to the caller, establishing a connection
+   * between the two accounts with the specified permissions.
+   */
+  async connect(
+    request: operations.ConnectAccountRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ConnectAccountResponse | undefined> {
+    return unwrapAsync(accountsConnect(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Retrieve the specified countries of operation for an account.
    *