@moovio/sdk 0.0.0-dev.26 → 0.0.0-dev.28

package/src/models/components/merchantentryerror.ts

@@ -0,0 +1,56 @@
+/*
+ * 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 * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type MerchantEntryError = {
+  mid?: string | undefined;
+  descriptorPattern?: string | undefined;
+};
+
+/** @internal */
+export const MerchantEntryError$inboundSchema: z.ZodType<
+  MerchantEntryError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  mid: types.optional(types.string()),
+  descriptorPattern: types.optional(types.string()),
+});
+/** @internal */
+export type MerchantEntryError$Outbound = {
+  mid?: string | undefined;
+  descriptorPattern?: string | undefined;
+};
+
+/** @internal */
+export const MerchantEntryError$outboundSchema: z.ZodType<
+  MerchantEntryError$Outbound,
+  z.ZodTypeDef,
+  MerchantEntryError
+> = z.object({
+  mid: z.string().optional(),
+  descriptorPattern: z.string().optional(),
+});
+
+export function merchantEntryErrorToJSON(
+  merchantEntryError: MerchantEntryError,
+): string {
+  return JSON.stringify(
+    MerchantEntryError$outboundSchema.parse(merchantEntryError),
+  );
+}
+export function merchantEntryErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<MerchantEntryError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MerchantEntryError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MerchantEntryError' from JSON`,
+  );
+}

package/src/models/components/merchantrestrictions.ts

@@ -0,0 +1,75 @@
+/*
+ * 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 {
+  IssuingControlsRestrictionMode,
+  IssuingControlsRestrictionMode$inboundSchema,
+  IssuingControlsRestrictionMode$outboundSchema,
+} from "./issuingcontrolsrestrictionmode.js";
+import {
+  MerchantEntry,
+  MerchantEntry$inboundSchema,
+  MerchantEntry$Outbound,
+  MerchantEntry$outboundSchema,
+} from "./merchantentry.js";
+
+/**
+ * Restricts card usage to specific merchants, independent of merchant category.
+ */
+export type MerchantRestrictions = {
+  /**
+   * Whether the listed merchants are the only ones allowed, or the ones to block.
+   */
+  mode: IssuingControlsRestrictionMode;
+  /**
+   * The merchants to allow or block.
+   */
+  merchants: Array<MerchantEntry>;
+};
+
+/** @internal */
+export const MerchantRestrictions$inboundSchema: z.ZodType<
+  MerchantRestrictions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  mode: IssuingControlsRestrictionMode$inboundSchema,
+  merchants: z.array(MerchantEntry$inboundSchema),
+});
+/** @internal */
+export type MerchantRestrictions$Outbound = {
+  mode: string;
+  merchants: Array<MerchantEntry$Outbound>;
+};
+
+/** @internal */
+export const MerchantRestrictions$outboundSchema: z.ZodType<
+  MerchantRestrictions$Outbound,
+  z.ZodTypeDef,
+  MerchantRestrictions
+> = z.object({
+  mode: IssuingControlsRestrictionMode$outboundSchema,
+  merchants: z.array(MerchantEntry$outboundSchema),
+});
+
+export function merchantRestrictionsToJSON(
+  merchantRestrictions: MerchantRestrictions,
+): string {
+  return JSON.stringify(
+    MerchantRestrictions$outboundSchema.parse(merchantRestrictions),
+  );
+}
+export function merchantRestrictionsFromJSON(
+  jsonString: string,
+): SafeParseResult<MerchantRestrictions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MerchantRestrictions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MerchantRestrictions' from JSON`,
+  );
+}

package/src/models/components/merchantrestrictionserror.ts

@@ -0,0 +1,62 @@
+/*
+ * 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 * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  MerchantEntryError,
+  MerchantEntryError$inboundSchema,
+  MerchantEntryError$Outbound,
+  MerchantEntryError$outboundSchema,
+} from "./merchantentryerror.js";
+
+export type MerchantRestrictionsError = {
+  mode?: string | undefined;
+  merchants?: { [k: string]: MerchantEntryError } | undefined;
+};
+
+/** @internal */
+export const MerchantRestrictionsError$inboundSchema: z.ZodType<
+  MerchantRestrictionsError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  mode: types.optional(types.string()),
+  merchants: types.optional(z.record(MerchantEntryError$inboundSchema)),
+});
+/** @internal */
+export type MerchantRestrictionsError$Outbound = {
+  mode?: string | undefined;
+  merchants?: { [k: string]: MerchantEntryError$Outbound } | undefined;
+};
+
+/** @internal */
+export const MerchantRestrictionsError$outboundSchema: z.ZodType<
+  MerchantRestrictionsError$Outbound,
+  z.ZodTypeDef,
+  MerchantRestrictionsError
+> = z.object({
+  mode: z.string().optional(),
+  merchants: z.record(MerchantEntryError$outboundSchema).optional(),
+});
+
+export function merchantRestrictionsErrorToJSON(
+  merchantRestrictionsError: MerchantRestrictionsError,
+): string {
+  return JSON.stringify(
+    MerchantRestrictionsError$outboundSchema.parse(merchantRestrictionsError),
+  );
+}
+export function merchantRestrictionsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<MerchantRestrictionsError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MerchantRestrictionsError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MerchantRestrictionsError' from JSON`,
+  );
+}

package/src/models/components/onboardinginvite.ts

@@ -40,7 +40,7 @@ export type OnboardingInvite = {
    */
   link: string;
   /**
-   * The scopes requested by the inviter.
+   * Optional URL to redirect the user to after they complete the onboarding process.
    */
   returnURL?: string | undefined;
   /**

package/src/models/components/partnerriskoutcomesresponse.ts

@@ -0,0 +1,77 @@
+/*
+ * 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 * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ContributingRule,
+  ContributingRule$inboundSchema,
+  ContributingRule$Outbound,
+  ContributingRule$outboundSchema,
+} from "./contributingrule.js";
+
+/**
+ * The risk rules that contributed to a transfer's risk decision.
+ *
+ * @remarks
+ *
+ * This information has limited availability and must be enabled for your account by Moov.
+ */
+export type PartnerRiskOutcomesResponse = {
+  /**
+   * Identifier of the transfer these outcomes belong to.
+   */
+  transferID: string;
+  /**
+   * The risk rules that contributed to the decision. May be empty when no rules are disclosed.
+   */
+  contributingRules: Array<ContributingRule>;
+};
+
+/** @internal */
+export const PartnerRiskOutcomesResponse$inboundSchema: z.ZodType<
+  PartnerRiskOutcomesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  transferID: types.string(),
+  contributingRules: z.array(ContributingRule$inboundSchema),
+});
+/** @internal */
+export type PartnerRiskOutcomesResponse$Outbound = {
+  transferID: string;
+  contributingRules: Array<ContributingRule$Outbound>;
+};
+
+/** @internal */
+export const PartnerRiskOutcomesResponse$outboundSchema: z.ZodType<
+  PartnerRiskOutcomesResponse$Outbound,
+  z.ZodTypeDef,
+  PartnerRiskOutcomesResponse
+> = z.object({
+  transferID: z.string(),
+  contributingRules: z.array(ContributingRule$outboundSchema),
+});
+
+export function partnerRiskOutcomesResponseToJSON(
+  partnerRiskOutcomesResponse: PartnerRiskOutcomesResponse,
+): string {
+  return JSON.stringify(
+    PartnerRiskOutcomesResponse$outboundSchema.parse(
+      partnerRiskOutcomesResponse,
+    ),
+  );
+}
+export function partnerRiskOutcomesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PartnerRiskOutcomesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PartnerRiskOutcomesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PartnerRiskOutcomesResponse' from JSON`,
+  );
+}

package/src/models/components/paymentlinkpayoutdetails.ts

@@ -12,6 +12,11 @@ import {
   DisbursementPaymentMethodType$inboundSchema,
   DisbursementPaymentMethodType$outboundSchema,
 } from "./disbursementpaymentmethodtype.js";
+import {
+  FeePaidBy,
+  FeePaidBy$inboundSchema,
+  FeePaidBy$outboundSchema,
+} from "./feepaidby.js";
 import {
   PayoutRecipient,
   PayoutRecipient$inboundSchema,
@@ -52,6 +57,14 @@ export type PaymentLinkPayoutDetails = {
    * (`push-to-apple-pay`, `push-to-google-pay`) are always delivered instantly regardless of these options.
    */
   pushOptions?: PushOptions | undefined;
+  /**
+   * Indicates which party bears the fee, keyed by disbursement payment method (`DisbursementPaymentMethodType`).
+   *
+   * @remarks
+   *
+   * Sparse — include only the methods you want to attribute. Any method left unset defaults to `source`.
+   */
+  feePaidBy?: { [k: string]: FeePaidBy } | undefined;
 };
 
 /** @internal */
@@ -64,6 +77,7 @@ export const PaymentLinkPayoutDetails$inboundSchema: z.ZodType<
   recipient: PayoutRecipient$inboundSchema,
   metadata: types.optional(z.record(types.string())),
   pushOptions: types.optional(PushOptions$inboundSchema),
+  feePaidBy: types.optional(z.record(FeePaidBy$inboundSchema)),
 });
 /** @internal */
 export type PaymentLinkPayoutDetails$Outbound = {
@@ -71,6 +85,7 @@ export type PaymentLinkPayoutDetails$Outbound = {
   recipient: PayoutRecipient$Outbound;
   metadata?: { [k: string]: string } | undefined;
   pushOptions?: PushOptions$Outbound | undefined;
+  feePaidBy?: { [k: string]: string } | undefined;
 };
 
 /** @internal */
@@ -83,6 +98,7 @@ export const PaymentLinkPayoutDetails$outboundSchema: z.ZodType<
   recipient: PayoutRecipient$outboundSchema,
   metadata: z.record(z.string()).optional(),
   pushOptions: PushOptions$outboundSchema.optional(),
+  feePaidBy: z.record(FeePaidBy$outboundSchema).optional(),
 });
 
 export function paymentLinkPayoutDetailsToJSON(

package/src/models/components/paymentlinkpayoutdetailsupdate.ts

@@ -12,6 +12,11 @@ import {
   DisbursementPaymentMethodType$inboundSchema,
   DisbursementPaymentMethodType$outboundSchema,
 } from "./disbursementpaymentmethodtype.js";
+import {
+  FeePaidBy,
+  FeePaidBy$inboundSchema,
+  FeePaidBy$outboundSchema,
+} from "./feepaidby.js";
 import {
   PayoutRecipient,
   PayoutRecipient$inboundSchema,
@@ -52,6 +57,14 @@ export type PaymentLinkPayoutDetailsUpdate = {
    * (`push-to-apple-pay`, `push-to-google-pay`) are always delivered instantly regardless of these options.
    */
   pushOptions?: PushOptionsUpdate | undefined;
+  /**
+   * Indicates which party bears the fee, keyed by disbursement payment method (`DisbursementPaymentMethodType`).
+   *
+   * @remarks
+   *
+   * Sparse — include only the methods you want to attribute. Any method left unset defaults to `source`.
+   */
+  feePaidBy?: { [k: string]: FeePaidBy } | undefined;
 };
 
 /** @internal */
@@ -66,6 +79,7 @@ export const PaymentLinkPayoutDetailsUpdate$inboundSchema: z.ZodType<
   recipient: types.optional(PayoutRecipient$inboundSchema),
   metadata: types.optional(z.record(types.string())),
   pushOptions: types.optional(PushOptionsUpdate$inboundSchema),
+  feePaidBy: types.optional(z.record(FeePaidBy$inboundSchema)),
 });
 /** @internal */
 export type PaymentLinkPayoutDetailsUpdate$Outbound = {
@@ -73,6 +87,7 @@ export type PaymentLinkPayoutDetailsUpdate$Outbound = {
   recipient?: PayoutRecipient$Outbound | undefined;
   metadata?: { [k: string]: string } | undefined;
   pushOptions?: PushOptionsUpdate$Outbound | undefined;
+  feePaidBy?: { [k: string]: string } | undefined;
 };
 
 /** @internal */
@@ -86,6 +101,7 @@ export const PaymentLinkPayoutDetailsUpdate$outboundSchema: z.ZodType<
   recipient: PayoutRecipient$outboundSchema.optional(),
   metadata: z.record(z.string()).optional(),
   pushOptions: PushOptionsUpdate$outboundSchema.optional(),
+  feePaidBy: z.record(FeePaidBy$outboundSchema).optional(),
 });
 
 export function paymentLinkPayoutDetailsUpdateToJSON(

package/src/models/components/payoutdetailserror.ts

@@ -25,6 +25,7 @@ export type PayoutDetailsError = {
   recipient?: PayoutRecipientError | undefined;
   metadata?: string | undefined;
   pushOptions?: PushOptionsError | undefined;
+  feePaidBy?: string | undefined;
 };
 
 /** @internal */
@@ -37,6 +38,7 @@ export const PayoutDetailsError$inboundSchema: z.ZodType<
   recipient: types.optional(PayoutRecipientError$inboundSchema),
   metadata: types.optional(types.string()),
   pushOptions: types.optional(PushOptionsError$inboundSchema),
+  feePaidBy: types.optional(types.string()),
 });
 /** @internal */
 export type PayoutDetailsError$Outbound = {
@@ -44,6 +46,7 @@ export type PayoutDetailsError$Outbound = {
   recipient?: PayoutRecipientError$Outbound | undefined;
   metadata?: string | undefined;
   pushOptions?: PushOptionsError$Outbound | undefined;
+  feePaidBy?: string | undefined;
 };
 
 /** @internal */
@@ -56,6 +59,7 @@ export const PayoutDetailsError$outboundSchema: z.ZodType<
   recipient: PayoutRecipientError$outboundSchema.optional(),
   metadata: z.string().optional(),
   pushOptions: PushOptionsError$outboundSchema.optional(),
+  feePaidBy: z.string().optional(),
 });
 
 export function payoutDetailsErrorToJSON(

package/src/models/components/product.ts

@@ -13,6 +13,12 @@ import {
   AmountDecimal$Outbound,
   AmountDecimal$outboundSchema,
 } from "./amountdecimal.js";
+import {
+  ProductCategory,
+  ProductCategory$inboundSchema,
+  ProductCategory$Outbound,
+  ProductCategory$outboundSchema,
+} from "./productcategory.js";
 import {
   ProductImageMetadata,
   ProductImageMetadata$inboundSchema,
@@ -57,6 +63,10 @@ export type Product = {
    * Optional images associated with the product.
    */
   images?: Array<ProductImageMetadata> | undefined;
+  /**
+   * The product taxonomy category associated with the product, if any.
+   */
+  category?: ProductCategory | undefined;
   /**
    * The date and time when the product was added.
    */
@@ -80,6 +90,7 @@ export const Product$inboundSchema: z.ZodType<Product, z.ZodTypeDef, unknown> =
     basePrice: AmountDecimal$inboundSchema,
     optionGroups: types.optional(z.array(ProductOptionGroup$inboundSchema)),
     images: types.optional(z.array(ProductImageMetadata$inboundSchema)),
+    category: types.optional(ProductCategory$inboundSchema),
     createdOn: types.date(),
     updatedOn: types.date(),
     disabledOn: types.optional(types.date()),
@@ -92,6 +103,7 @@ export type Product$Outbound = {
   basePrice: AmountDecimal$Outbound;
   optionGroups?: Array<ProductOptionGroup$Outbound> | undefined;
   images?: Array<ProductImageMetadata$Outbound> | undefined;
+  category?: ProductCategory$Outbound | undefined;
   createdOn: string;
   updatedOn: string;
   disabledOn?: string | undefined;
@@ -109,6 +121,7 @@ export const Product$outboundSchema: z.ZodType<
   basePrice: AmountDecimal$outboundSchema,
   optionGroups: z.array(ProductOptionGroup$outboundSchema).optional(),
   images: z.array(ProductImageMetadata$outboundSchema).optional(),
+  category: ProductCategory$outboundSchema.optional(),
   createdOn: z.date().transform(v => v.toISOString()),
   updatedOn: z.date().transform(v => v.toISOString()),
   disabledOn: z.date().transform(v => v.toISOString()).optional(),

package/src/models/components/productcategories.ts

@@ -0,0 +1,60 @@
+/*
+ * 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 {
+  ProductCategory,
+  ProductCategory$inboundSchema,
+  ProductCategory$Outbound,
+  ProductCategory$outboundSchema,
+} from "./productcategory.js";
+
+/**
+ * A list of product categories from the product taxonomy.
+ */
+export type ProductCategories = {
+  categories: Array<ProductCategory>;
+};
+
+/** @internal */
+export const ProductCategories$inboundSchema: z.ZodType<
+  ProductCategories,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  categories: z.array(ProductCategory$inboundSchema),
+});
+/** @internal */
+export type ProductCategories$Outbound = {
+  categories: Array<ProductCategory$Outbound>;
+};
+
+/** @internal */
+export const ProductCategories$outboundSchema: z.ZodType<
+  ProductCategories$Outbound,
+  z.ZodTypeDef,
+  ProductCategories
+> = z.object({
+  categories: z.array(ProductCategory$outboundSchema),
+});
+
+export function productCategoriesToJSON(
+  productCategories: ProductCategories,
+): string {
+  return JSON.stringify(
+    ProductCategories$outboundSchema.parse(productCategories),
+  );
+}
+export function productCategoriesFromJSON(
+  jsonString: string,
+): SafeParseResult<ProductCategories, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProductCategories$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProductCategories' from JSON`,
+  );
+}

package/src/models/components/productcategory.ts

@@ -0,0 +1,84 @@
+/*
+ * 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 * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * A product category from the product taxonomy.
+ */
+export type ProductCategory = {
+  /**
+   * The unique identifier for the category.
+   */
+  categoryID: string;
+  /**
+   * The short display name of the category.
+   */
+  name: string;
+  /**
+   * The full taxonomy path name of the category.
+   */
+  fullName: string;
+  /**
+   * The depth of the category in the taxonomy tree (1 = top-level).
+   */
+  level: number;
+  /**
+   * The identifier of the parent category, if any. Absent for top-level categories.
+   */
+  parentID?: string | undefined;
+};
+
+/** @internal */
+export const ProductCategory$inboundSchema: z.ZodType<
+  ProductCategory,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  categoryID: types.string(),
+  name: types.string(),
+  fullName: types.string(),
+  level: types.number(),
+  parentID: types.optional(types.string()),
+});
+/** @internal */
+export type ProductCategory$Outbound = {
+  categoryID: string;
+  name: string;
+  fullName: string;
+  level: number;
+  parentID?: string | undefined;
+};
+
+/** @internal */
+export const ProductCategory$outboundSchema: z.ZodType<
+  ProductCategory$Outbound,
+  z.ZodTypeDef,
+  ProductCategory
+> = z.object({
+  categoryID: z.string(),
+  name: z.string(),
+  fullName: z.string(),
+  level: z.number().int(),
+  parentID: z.string().optional(),
+});
+
+export function productCategoryToJSON(
+  productCategory: ProductCategory,
+): string {
+  return JSON.stringify(ProductCategory$outboundSchema.parse(productCategory));
+}
+export function productCategoryFromJSON(
+  jsonString: string,
+): SafeParseResult<ProductCategory, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProductCategory$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProductCategory' from JSON`,
+  );
+}

package/src/models/components/productrequest.ts

@@ -53,6 +53,10 @@ export type ProductRequest = {
    * Optional configuration options for a product, such as size or color.
    */
   optionGroups?: Array<CreateProductOptionGroup> | undefined;
+  /**
+   * The ID of a product taxonomy category to associate with the product.
+   */
+  categoryID?: string | undefined;
 };
 
 /** @internal */
@@ -66,6 +70,7 @@ export const ProductRequest$inboundSchema: z.ZodType<
   basePrice: AmountDecimal$inboundSchema,
   images: types.optional(z.array(AssignProductImage$inboundSchema)),
   optionGroups: types.optional(z.array(CreateProductOptionGroup$inboundSchema)),
+  categoryID: types.optional(types.string()),
 });
 /** @internal */
 export type ProductRequest$Outbound = {
@@ -74,6 +79,7 @@ export type ProductRequest$Outbound = {
   basePrice: AmountDecimal$Outbound;
   images?: Array<AssignProductImage$Outbound> | undefined;
   optionGroups?: Array<CreateProductOptionGroup$Outbound> | undefined;
+  categoryID?: string | undefined;
 };
 
 /** @internal */
@@ -87,6 +93,7 @@ export const ProductRequest$outboundSchema: z.ZodType<
   basePrice: AmountDecimal$outboundSchema,
   images: z.array(AssignProductImage$outboundSchema).optional(),
   optionGroups: z.array(CreateProductOptionGroup$outboundSchema).optional(),
+  categoryID: z.string().optional(),
 });
 
 export function productRequestToJSON(productRequest: ProductRequest): string {