@moovio/sdk 0.16.4 → 0.16.5

package/src/models/operations/listproducts.ts

@@ -0,0 +1,227 @@
+/*
+ * 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 ListProductsGlobals = {
+  /**
+   * 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 ListProductsRequest = {
+  accountID: string;
+  skip?: number | undefined;
+  count?: number | undefined;
+};
+
+export type ListProductsResponse = {
+  headers: { [k: string]: Array<string> };
+  result: Array<components.Product>;
+};
+
+/** @internal */
+export const ListProductsGlobals$inboundSchema: z.ZodType<
+  ListProductsGlobals,
+  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 ListProductsGlobals$Outbound = {
+  "x-moov-version": string;
+};
+
+/** @internal */
+export const ListProductsGlobals$outboundSchema: z.ZodType<
+  ListProductsGlobals$Outbound,
+  z.ZodTypeDef,
+  ListProductsGlobals
+> = 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 ListProductsGlobals$ {
+  /** @deprecated use `ListProductsGlobals$inboundSchema` instead. */
+  export const inboundSchema = ListProductsGlobals$inboundSchema;
+  /** @deprecated use `ListProductsGlobals$outboundSchema` instead. */
+  export const outboundSchema = ListProductsGlobals$outboundSchema;
+  /** @deprecated use `ListProductsGlobals$Outbound` instead. */
+  export type Outbound = ListProductsGlobals$Outbound;
+}
+
+export function listProductsGlobalsToJSON(
+  listProductsGlobals: ListProductsGlobals,
+): string {
+  return JSON.stringify(
+    ListProductsGlobals$outboundSchema.parse(listProductsGlobals),
+  );
+}
+
+export function listProductsGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<ListProductsGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListProductsGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListProductsGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListProductsRequest$inboundSchema: z.ZodType<
+  ListProductsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountID: z.string(),
+  skip: z.number().int().optional(),
+  count: z.number().int().optional(),
+});
+
+/** @internal */
+export type ListProductsRequest$Outbound = {
+  accountID: string;
+  skip?: number | undefined;
+  count?: number | undefined;
+};
+
+/** @internal */
+export const ListProductsRequest$outboundSchema: z.ZodType<
+  ListProductsRequest$Outbound,
+  z.ZodTypeDef,
+  ListProductsRequest
+> = z.object({
+  accountID: z.string(),
+  skip: z.number().int().optional(),
+  count: z.number().int().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListProductsRequest$ {
+  /** @deprecated use `ListProductsRequest$inboundSchema` instead. */
+  export const inboundSchema = ListProductsRequest$inboundSchema;
+  /** @deprecated use `ListProductsRequest$outboundSchema` instead. */
+  export const outboundSchema = ListProductsRequest$outboundSchema;
+  /** @deprecated use `ListProductsRequest$Outbound` instead. */
+  export type Outbound = ListProductsRequest$Outbound;
+}
+
+export function listProductsRequestToJSON(
+  listProductsRequest: ListProductsRequest,
+): string {
+  return JSON.stringify(
+    ListProductsRequest$outboundSchema.parse(listProductsRequest),
+  );
+}
+
+export function listProductsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListProductsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListProductsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListProductsRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListProductsResponse$inboundSchema: z.ZodType<
+  ListProductsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())),
+  Result: z.array(components.Product$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type ListProductsResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: Array<components.Product$Outbound>;
+};
+
+/** @internal */
+export const ListProductsResponse$outboundSchema: z.ZodType<
+  ListProductsResponse$Outbound,
+  z.ZodTypeDef,
+  ListProductsResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: z.array(components.Product$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 ListProductsResponse$ {
+  /** @deprecated use `ListProductsResponse$inboundSchema` instead. */
+  export const inboundSchema = ListProductsResponse$inboundSchema;
+  /** @deprecated use `ListProductsResponse$outboundSchema` instead. */
+  export const outboundSchema = ListProductsResponse$outboundSchema;
+  /** @deprecated use `ListProductsResponse$Outbound` instead. */
+  export type Outbound = ListProductsResponse$Outbound;
+}
+
+export function listProductsResponseToJSON(
+  listProductsResponse: ListProductsResponse,
+): string {
+  return JSON.stringify(
+    ListProductsResponse$outboundSchema.parse(listProductsResponse),
+  );
+}
+
+export function listProductsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListProductsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListProductsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListProductsResponse' from JSON`,
+  );
+}

package/src/models/operations/updateproduct.ts

@@ -0,0 +1,235 @@
+/*
+ * 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 UpdateProductGlobals = {
+  /**
+   * 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 UpdateProductRequest = {
+  accountID: string;
+  productID: string;
+  productRequest: components.ProductRequest;
+};
+
+export type UpdateProductResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.Product;
+};
+
+/** @internal */
+export const UpdateProductGlobals$inboundSchema: z.ZodType<
+  UpdateProductGlobals,
+  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 UpdateProductGlobals$Outbound = {
+  "x-moov-version": string;
+};
+
+/** @internal */
+export const UpdateProductGlobals$outboundSchema: z.ZodType<
+  UpdateProductGlobals$Outbound,
+  z.ZodTypeDef,
+  UpdateProductGlobals
+> = 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 UpdateProductGlobals$ {
+  /** @deprecated use `UpdateProductGlobals$inboundSchema` instead. */
+  export const inboundSchema = UpdateProductGlobals$inboundSchema;
+  /** @deprecated use `UpdateProductGlobals$outboundSchema` instead. */
+  export const outboundSchema = UpdateProductGlobals$outboundSchema;
+  /** @deprecated use `UpdateProductGlobals$Outbound` instead. */
+  export type Outbound = UpdateProductGlobals$Outbound;
+}
+
+export function updateProductGlobalsToJSON(
+  updateProductGlobals: UpdateProductGlobals,
+): string {
+  return JSON.stringify(
+    UpdateProductGlobals$outboundSchema.parse(updateProductGlobals),
+  );
+}
+
+export function updateProductGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateProductGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateProductGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateProductGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const UpdateProductRequest$inboundSchema: z.ZodType<
+  UpdateProductRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountID: z.string(),
+  productID: z.string(),
+  ProductRequest: components.ProductRequest$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "ProductRequest": "productRequest",
+  });
+});
+
+/** @internal */
+export type UpdateProductRequest$Outbound = {
+  accountID: string;
+  productID: string;
+  ProductRequest: components.ProductRequest$Outbound;
+};
+
+/** @internal */
+export const UpdateProductRequest$outboundSchema: z.ZodType<
+  UpdateProductRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateProductRequest
+> = z.object({
+  accountID: z.string(),
+  productID: z.string(),
+  productRequest: components.ProductRequest$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    productRequest: "ProductRequest",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateProductRequest$ {
+  /** @deprecated use `UpdateProductRequest$inboundSchema` instead. */
+  export const inboundSchema = UpdateProductRequest$inboundSchema;
+  /** @deprecated use `UpdateProductRequest$outboundSchema` instead. */
+  export const outboundSchema = UpdateProductRequest$outboundSchema;
+  /** @deprecated use `UpdateProductRequest$Outbound` instead. */
+  export type Outbound = UpdateProductRequest$Outbound;
+}
+
+export function updateProductRequestToJSON(
+  updateProductRequest: UpdateProductRequest,
+): string {
+  return JSON.stringify(
+    UpdateProductRequest$outboundSchema.parse(updateProductRequest),
+  );
+}
+
+export function updateProductRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateProductRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateProductRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateProductRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const UpdateProductResponse$inboundSchema: z.ZodType<
+  UpdateProductResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())),
+  Result: components.Product$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type UpdateProductResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.Product$Outbound;
+};
+
+/** @internal */
+export const UpdateProductResponse$outboundSchema: z.ZodType<
+  UpdateProductResponse$Outbound,
+  z.ZodTypeDef,
+  UpdateProductResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: components.Product$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 UpdateProductResponse$ {
+  /** @deprecated use `UpdateProductResponse$inboundSchema` instead. */
+  export const inboundSchema = UpdateProductResponse$inboundSchema;
+  /** @deprecated use `UpdateProductResponse$outboundSchema` instead. */
+  export const outboundSchema = UpdateProductResponse$outboundSchema;
+  /** @deprecated use `UpdateProductResponse$Outbound` instead. */
+  export type Outbound = UpdateProductResponse$Outbound;
+}
+
+export function updateProductResponseToJSON(
+  updateProductResponse: UpdateProductResponse,
+): string {
+  return JSON.stringify(
+    UpdateProductResponse$outboundSchema.parse(updateProductResponse),
+  );
+}
+
+export function updateProductResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateProductResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateProductResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateProductResponse' from JSON`,
+  );
+}

package/src/sdk/products.ts

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { productsCreate } from "../funcs/productsCreate.js";
+import { productsDisable } from "../funcs/productsDisable.js";
+import { productsGet } from "../funcs/productsGet.js";
+import { productsList } from "../funcs/productsList.js";
+import { productsUpdate } from "../funcs/productsUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Products extends ClientSDK {
+  /**
+   * List active (non-disabled) products for an account.
+   */
+  async list(
+    request: operations.ListProductsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListProductsResponse> {
+    return unwrapAsync(productsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Creates a new product for the specified account.
+   */
+  async create(
+    request: operations.CreateProductRequest,
+    options?: RequestOptions,
+  ): Promise<operations.CreateProductResponse> {
+    return unwrapAsync(productsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a product by ID.
+   */
+  async get(
+    request: operations.GetProductRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetProductResponse> {
+    return unwrapAsync(productsGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a product and its options.
+   */
+  async update(
+    request: operations.UpdateProductRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateProductResponse> {
+    return unwrapAsync(productsUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Disable a product by ID.
+   *
+   * The product will no longer be available, but will remain in the system for historical and reporting purposes.
+   */
+  async disable(
+    request: operations.DisableProductRequest,
+    options?: RequestOptions,
+  ): Promise<operations.DisableProductResponse | undefined> {
+    return unwrapAsync(productsDisable(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -28,6 +28,7 @@ import { Onboarding } from "./onboarding.js";
 import { PaymentLinks } from "./paymentlinks.js";
 import { PaymentMethods } from "./paymentmethods.js";
 import { Ping } from "./ping.js";
+import { Products } from "./products.js";
 import { Receipts } from "./receipts.js";
 import { Representatives } from "./representatives.js";
 import { Scheduling } from "./scheduling.js";
@@ -106,6 +107,11 @@ export class Moov extends ClientSDK {
     return (this._paymentMethods ??= new PaymentMethods(this._options));
   }
 
+  private _products?: Products;
+  get products(): Products {
+    return (this._products ??= new Products(this._options));
+  }
+
   private _representatives?: Representatives;
   get representatives(): Representatives {
     return (this._representatives ??= new Representatives(this._options));