@moovio/sdk 26.7.0-dev.5 → 26.7.0

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 {

package/src/models/components/transferfeepaidby.ts

@@ -0,0 +1,63 @@
+/*
+ * 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 {
+  FeePaidBy,
+  FeePaidBy$inboundSchema,
+  FeePaidBy$outboundSchema,
+} from "./feepaidby.js";
+
+/**
+ * Indicates which party bears fees for a transfer, keyed by fee type.
+ */
+export type TransferFeePaidBy = {
+  /**
+   * For payouts, indicates which party bears the fee. Defaults to `source`.
+   */
+  payout?: FeePaidBy | undefined;
+};
+
+/** @internal */
+export const TransferFeePaidBy$inboundSchema: z.ZodType<
+  TransferFeePaidBy,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  payout: types.optional(FeePaidBy$inboundSchema),
+});
+/** @internal */
+export type TransferFeePaidBy$Outbound = {
+  payout?: string | undefined;
+};
+
+/** @internal */
+export const TransferFeePaidBy$outboundSchema: z.ZodType<
+  TransferFeePaidBy$Outbound,
+  z.ZodTypeDef,
+  TransferFeePaidBy
+> = z.object({
+  payout: FeePaidBy$outboundSchema.optional(),
+});
+
+export function transferFeePaidByToJSON(
+  transferFeePaidBy: TransferFeePaidBy,
+): string {
+  return JSON.stringify(
+    TransferFeePaidBy$outboundSchema.parse(transferFeePaidBy),
+  );
+}
+export function transferFeePaidByFromJSON(
+  jsonString: string,
+): SafeParseResult<TransferFeePaidBy, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransferFeePaidBy$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransferFeePaidBy' from JSON`,
+  );
+}

package/src/models/errors/productrequestvalidationerror.ts

@@ -17,6 +17,7 @@ export type ProductRequestValidationErrorData = {
   optionGroups?:
     | { [k: string]: components.ProductOptionGroupValidationError }
     | undefined;
+  categoryID?: string | undefined;
 };
 
 export class ProductRequestValidationError extends MoovError {
@@ -29,6 +30,7 @@ export class ProductRequestValidationError extends MoovError {
   optionGroups?:
     | { [k: string]: components.ProductOptionGroupValidationError }
     | undefined;
+  categoryID?: string | undefined;
 
   /** The original data that was passed to this error instance. */
   data$: ProductRequestValidationErrorData;
@@ -47,6 +49,7 @@ export class ProductRequestValidationError extends MoovError {
     if (err.basePrice != null) this.basePrice = err.basePrice;
     if (err.images != null) this.images = err.images;
     if (err.optionGroups != null) this.optionGroups = err.optionGroups;
+    if (err.categoryID != null) this.categoryID = err.categoryID;
 
     this.name = "ProductRequestValidationError";
   }
@@ -69,6 +72,7 @@ export const ProductRequestValidationError$inboundSchema: z.ZodType<
   optionGroups: types.optional(
     z.record(components.ProductOptionGroupValidationError$inboundSchema),
   ),
+  categoryID: types.optional(types.string()),
   request$: z.instanceof(Request),
   response$: z.instanceof(Response),
   body$: z.string(),
@@ -92,6 +96,7 @@ export type ProductRequestValidationError$Outbound = {
   optionGroups?: {
     [k: string]: components.ProductOptionGroupValidationError$Outbound;
   } | undefined;
+  categoryID?: string | undefined;
 };
 
 /** @internal */
@@ -112,4 +117,5 @@ export const ProductRequestValidationError$outboundSchema: z.ZodType<
     optionGroups: z.record(
       components.ProductOptionGroupValidationError$outboundSchema,
     ).optional(),
+    categoryID: z.string().optional(),
   }));

package/src/models/operations/deleteavatar.ts

@@ -0,0 +1,154 @@
+/*
+ * 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 types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type DeleteAvatarSecurity = {
+  username?: string | undefined;
+  password?: string | undefined;
+};
+
+export type DeleteAvatarRequest = {
+  /**
+   * The accountID to delete the avatar for. Only accountID values are accepted for writes.
+   */
+  uniqueID: string;
+};
+
+export type DeleteAvatarResponse = {
+  headers: { [k: string]: Array<string> };
+};
+
+/** @internal */
+export const DeleteAvatarSecurity$inboundSchema: z.ZodType<
+  DeleteAvatarSecurity,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  username: types.optional(types.string()),
+  password: types.optional(types.string()),
+});
+/** @internal */
+export type DeleteAvatarSecurity$Outbound = {
+  username?: string | undefined;
+  password?: string | undefined;
+};
+
+/** @internal */
+export const DeleteAvatarSecurity$outboundSchema: z.ZodType<
+  DeleteAvatarSecurity$Outbound,
+  z.ZodTypeDef,
+  DeleteAvatarSecurity
+> = z.object({
+  username: z.string().optional(),
+  password: z.string().optional(),
+});
+
+export function deleteAvatarSecurityToJSON(
+  deleteAvatarSecurity: DeleteAvatarSecurity,
+): string {
+  return JSON.stringify(
+    DeleteAvatarSecurity$outboundSchema.parse(deleteAvatarSecurity),
+  );
+}
+export function deleteAvatarSecurityFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteAvatarSecurity, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteAvatarSecurity$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteAvatarSecurity' from JSON`,
+  );
+}
+
+/** @internal */
+export const DeleteAvatarRequest$inboundSchema: z.ZodType<
+  DeleteAvatarRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  uniqueID: types.string(),
+});
+/** @internal */
+export type DeleteAvatarRequest$Outbound = {
+  uniqueID: string;
+};
+
+/** @internal */
+export const DeleteAvatarRequest$outboundSchema: z.ZodType<
+  DeleteAvatarRequest$Outbound,
+  z.ZodTypeDef,
+  DeleteAvatarRequest
+> = z.object({
+  uniqueID: z.string(),
+});
+
+export function deleteAvatarRequestToJSON(
+  deleteAvatarRequest: DeleteAvatarRequest,
+): string {
+  return JSON.stringify(
+    DeleteAvatarRequest$outboundSchema.parse(deleteAvatarRequest),
+  );
+}
+export function deleteAvatarRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteAvatarRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteAvatarRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteAvatarRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const DeleteAvatarResponse$inboundSchema: z.ZodType<
+  DeleteAvatarResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+  });
+});
+/** @internal */
+export type DeleteAvatarResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+};
+
+/** @internal */
+export const DeleteAvatarResponse$outboundSchema: z.ZodType<
+  DeleteAvatarResponse$Outbound,
+  z.ZodTypeDef,
+  DeleteAvatarResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+  });
+});
+
+export function deleteAvatarResponseToJSON(
+  deleteAvatarResponse: DeleteAvatarResponse,
+): string {
+  return JSON.stringify(
+    DeleteAvatarResponse$outboundSchema.parse(deleteAvatarResponse),
+  );
+}
+export function deleteAvatarResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteAvatarResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteAvatarResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteAvatarResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -35,6 +35,7 @@ export * from "./createtransferconfig.js";
 export * from "./createtransferoptions.js";
 export * from "./createwallet.js";
 export * from "./createwebhook.js";
+export * from "./deleteavatar.js";
 export * from "./deletedisputeevidencefile.js";
 export * from "./deleteimage.js";
 export * from "./deleteinvoice.js";
@@ -138,6 +139,7 @@ export * from "./listonboardinginvites.js";
 export * from "./listpartnerpricingagreements.js";
 export * from "./listpaymentlinks.js";
 export * from "./listpaymentmethods.js";
+export * from "./listproductcategories.js";
 export * from "./listproducts.js";
 export * from "./listreceipts.js";
 export * from "./listrefunds.js";
@@ -186,6 +188,7 @@ export * from "./updatetransfer.js";
 export * from "./updatetransferconfig.js";
 export * from "./updatewallet.js";
 export * from "./updatewebhook.js";
+export * from "./uploadavatar.js";
 export * from "./uploaddisputeevidencefile.js";
 export * from "./uploaddisputeevidencetext.js";
 export * from "./uploadfile.js";

package/src/models/operations/listproductcategories.ts

@@ -0,0 +1,69 @@
+/*
+ * 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 ListProductCategoriesResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.ProductCategories;
+};
+
+/** @internal */
+export const ListProductCategoriesResponse$inboundSchema: z.ZodType<
+  ListProductCategoriesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: components.ProductCategories$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+/** @internal */
+export type ListProductCategoriesResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.ProductCategories$Outbound;
+};
+
+/** @internal */
+export const ListProductCategoriesResponse$outboundSchema: z.ZodType<
+  ListProductCategoriesResponse$Outbound,
+  z.ZodTypeDef,
+  ListProductCategoriesResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: components.ProductCategories$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+export function listProductCategoriesResponseToJSON(
+  listProductCategoriesResponse: ListProductCategoriesResponse,
+): string {
+  return JSON.stringify(
+    ListProductCategoriesResponse$outboundSchema.parse(
+      listProductCategoriesResponse,
+    ),
+  );
+}
+export function listProductCategoriesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListProductCategoriesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListProductCategoriesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListProductCategoriesResponse' from JSON`,
+  );
+}

package/src/models/operations/listproducts.ts

@@ -16,6 +16,14 @@ export type ListProductsRequest = {
    * Allows filtering products by title. This supports partial matches and is case-insensitive
    */
   title?: string | undefined;
+  /**
+   * Filter products by category. Accepts a category ID at any level of the taxonomy;
+   *
+   * @remarks
+   * a product matches when the given category is anywhere in its category's breadcrumb
+   * (i.e. filtering by a top-level category returns products in any of its descendants).
+   */
+  category?: string | undefined;
   skip?: number | undefined;
   count?: number | undefined;
 };
@@ -33,6 +41,7 @@ export const ListProductsRequest$inboundSchema: z.ZodType<
 > = z.object({
   accountID: types.string(),
   title: types.optional(types.string()),
+  category: types.optional(types.string()),
   skip: types.optional(types.number()),
   count: types.optional(types.number()),
 });
@@ -40,6 +49,7 @@ export const ListProductsRequest$inboundSchema: z.ZodType<
 export type ListProductsRequest$Outbound = {
   accountID: string;
   title?: string | undefined;
+  category?: string | undefined;
   skip?: number | undefined;
   count?: number | undefined;
 };
@@ -52,6 +62,7 @@ export const ListProductsRequest$outboundSchema: z.ZodType<
 > = z.object({
   accountID: z.string(),
   title: z.string().optional(),
+  category: z.string().optional(),
   skip: z.number().int().optional(),
   count: z.number().int().optional(),
 });