@paygentic/sdk 0.3.1-beta.0

package/src/models/paymentoptions.ts

@@ -0,0 +1,96 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+/**
+ * Payment options for the plan, pre/post paid, pay as you go, outOfBand payments.
+ */
+export type PaymentOptions = {
+  /**
+   * Set to true if payment for this plan are not done with the paygentic wallet
+   */
+  outOfBand?: boolean | undefined;
+  /**
+   * Use paygentic wallet for pay-as-you-go payments, cannot be used with outOfBand
+   */
+  payAsYouGo?: boolean | undefined;
+  /**
+   * Charge the customer at the start of each billing cycle and grant them credits.
+   */
+  prePaid?: boolean | undefined;
+  /**
+   * Collect usage and invoice at the end of the billing cycle
+   */
+  postPaid?: boolean | undefined;
+  /**
+   * Amount of prepaid credits offered with this plan. Positive dollar amounts only, max precision in 9 digits.
+   */
+  credits?: string | undefined;
+};
+
+/** @internal */
+export const PaymentOptions$inboundSchema: z.ZodType<
+  PaymentOptions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  outOfBand: z.boolean().optional(),
+  payAsYouGo: z.boolean().default(true),
+  prePaid: z.boolean().default(false),
+  postPaid: z.boolean().default(false),
+  credits: z.string().default(""),
+});
+
+/** @internal */
+export type PaymentOptions$Outbound = {
+  outOfBand?: boolean | undefined;
+  payAsYouGo: boolean;
+  prePaid: boolean;
+  postPaid: boolean;
+  credits: string;
+};
+
+/** @internal */
+export const PaymentOptions$outboundSchema: z.ZodType<
+  PaymentOptions$Outbound,
+  z.ZodTypeDef,
+  PaymentOptions
+> = z.object({
+  outOfBand: z.boolean().optional(),
+  payAsYouGo: z.boolean().default(true),
+  prePaid: z.boolean().default(false),
+  postPaid: z.boolean().default(false),
+  credits: z.string().default(""),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PaymentOptions$ {
+  /** @deprecated use `PaymentOptions$inboundSchema` instead. */
+  export const inboundSchema = PaymentOptions$inboundSchema;
+  /** @deprecated use `PaymentOptions$outboundSchema` instead. */
+  export const outboundSchema = PaymentOptions$outboundSchema;
+  /** @deprecated use `PaymentOptions$Outbound` instead. */
+  export type Outbound = PaymentOptions$Outbound;
+}
+
+export function paymentOptionsToJSON(paymentOptions: PaymentOptions): string {
+  return JSON.stringify(PaymentOptions$outboundSchema.parse(paymentOptions));
+}
+
+export function paymentOptionsFromJSON(
+  jsonString: string,
+): SafeParseResult<PaymentOptions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PaymentOptions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaymentOptions' from JSON`,
+  );
+}

package/src/models/payout.ts

@@ -0,0 +1,286 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+/**
+ * Type of the object
+ */
+export const PayoutObject = {
+  Payout: "payout",
+} as const;
+/**
+ * Type of the object
+ */
+export type PayoutObject = ClosedEnum<typeof PayoutObject>;
+
+/**
+ * Current status of the payout
+ */
+export const PayoutStatus = {
+  Pending: "pending",
+  Success: "success",
+  Failed: "failed",
+  Cancelled: "cancelled",
+} as const;
+/**
+ * Current status of the payout
+ */
+export type PayoutStatus = ClosedEnum<typeof PayoutStatus>;
+
+/**
+ * Method of payout.
+ */
+export const PayoutMethodEnum = {
+  BankTransfer: "bank_transfer",
+} as const;
+/**
+ * Method of payout.
+ */
+export type PayoutMethodEnum = ClosedEnum<typeof PayoutMethodEnum>;
+
+export type Payout = {
+  /**
+   * Unique identifier for a payout
+   */
+  id?: string | undefined;
+  /**
+   * Type of the object
+   */
+  object?: PayoutObject | undefined;
+  /**
+   * Unique identifier for an organization
+   */
+  organizationId?: string | undefined;
+  /**
+   * Current status of the payout
+   */
+  status?: PayoutStatus | undefined;
+  /**
+   * Description of the payout
+   */
+  description?: string | undefined;
+  /**
+   * Amount in cents
+   */
+  amountInCents?: number | undefined;
+  /**
+   * 3-letter currency code
+   */
+  currency?: string | undefined;
+  /**
+   * Method of payout.
+   */
+  method?: PayoutMethodEnum | undefined;
+  /**
+   * ID of the source (wallet, etc)
+   */
+  sourceId?: string | undefined;
+  /**
+   * ID of the destination (bank account, card, etc)
+   */
+  destinationId?: string | undefined;
+  /**
+   * Key-value pairs for storing additional data related to the payout.
+   */
+  metadata?: { [k: string]: string } | undefined;
+  /**
+   * Timestamp when the payout was created
+   */
+  createdAt?: Date | undefined;
+  /**
+   * Timestamp when the payout was last updated
+   */
+  updatedAt?: Date | undefined;
+  /**
+   * Platform fee in cents
+   */
+  platformFee?: number | undefined;
+  /**
+   * Method fee in cents
+   */
+  methodFee?: number | undefined;
+  /**
+   * Transaction ID
+   */
+  transactionId?: string | undefined;
+  /**
+   * Failure code
+   */
+  failureCode?: string | undefined;
+  /**
+   * Failure message
+   */
+  failureMessage?: string | undefined;
+  /**
+   * Final amount in cents that was transferred
+   */
+  transferredAmountInCents?: number | undefined;
+};
+
+/** @internal */
+export const PayoutObject$inboundSchema: z.ZodNativeEnum<typeof PayoutObject> =
+  z.nativeEnum(PayoutObject);
+
+/** @internal */
+export const PayoutObject$outboundSchema: z.ZodNativeEnum<typeof PayoutObject> =
+  PayoutObject$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PayoutObject$ {
+  /** @deprecated use `PayoutObject$inboundSchema` instead. */
+  export const inboundSchema = PayoutObject$inboundSchema;
+  /** @deprecated use `PayoutObject$outboundSchema` instead. */
+  export const outboundSchema = PayoutObject$outboundSchema;
+}
+
+/** @internal */
+export const PayoutStatus$inboundSchema: z.ZodNativeEnum<typeof PayoutStatus> =
+  z.nativeEnum(PayoutStatus);
+
+/** @internal */
+export const PayoutStatus$outboundSchema: z.ZodNativeEnum<typeof PayoutStatus> =
+  PayoutStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PayoutStatus$ {
+  /** @deprecated use `PayoutStatus$inboundSchema` instead. */
+  export const inboundSchema = PayoutStatus$inboundSchema;
+  /** @deprecated use `PayoutStatus$outboundSchema` instead. */
+  export const outboundSchema = PayoutStatus$outboundSchema;
+}
+
+/** @internal */
+export const PayoutMethodEnum$inboundSchema: z.ZodNativeEnum<
+  typeof PayoutMethodEnum
+> = z.nativeEnum(PayoutMethodEnum);
+
+/** @internal */
+export const PayoutMethodEnum$outboundSchema: z.ZodNativeEnum<
+  typeof PayoutMethodEnum
+> = PayoutMethodEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PayoutMethodEnum$ {
+  /** @deprecated use `PayoutMethodEnum$inboundSchema` instead. */
+  export const inboundSchema = PayoutMethodEnum$inboundSchema;
+  /** @deprecated use `PayoutMethodEnum$outboundSchema` instead. */
+  export const outboundSchema = PayoutMethodEnum$outboundSchema;
+}
+
+/** @internal */
+export const Payout$inboundSchema: z.ZodType<Payout, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.string().optional(),
+    object: PayoutObject$inboundSchema.optional(),
+    organizationId: z.string().optional(),
+    status: PayoutStatus$inboundSchema.optional(),
+    description: z.string().optional(),
+    amountInCents: z.number().int().optional(),
+    currency: z.string().optional(),
+    method: PayoutMethodEnum$inboundSchema.optional(),
+    sourceId: z.string().optional(),
+    destinationId: z.string().optional(),
+    metadata: z.record(z.string()).optional(),
+    createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
+      .optional(),
+    updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
+      .optional(),
+    platformFee: z.number().int().optional(),
+    methodFee: z.number().int().optional(),
+    transactionId: z.string().optional(),
+    failureCode: z.string().optional(),
+    failureMessage: z.string().optional(),
+    transferredAmountInCents: z.number().int().optional(),
+  });
+
+/** @internal */
+export type Payout$Outbound = {
+  id?: string | undefined;
+  object?: string | undefined;
+  organizationId?: string | undefined;
+  status?: string | undefined;
+  description?: string | undefined;
+  amountInCents?: number | undefined;
+  currency?: string | undefined;
+  method?: string | undefined;
+  sourceId?: string | undefined;
+  destinationId?: string | undefined;
+  metadata?: { [k: string]: string } | undefined;
+  createdAt?: string | undefined;
+  updatedAt?: string | undefined;
+  platformFee?: number | undefined;
+  methodFee?: number | undefined;
+  transactionId?: string | undefined;
+  failureCode?: string | undefined;
+  failureMessage?: string | undefined;
+  transferredAmountInCents?: number | undefined;
+};
+
+/** @internal */
+export const Payout$outboundSchema: z.ZodType<
+  Payout$Outbound,
+  z.ZodTypeDef,
+  Payout
+> = z.object({
+  id: z.string().optional(),
+  object: PayoutObject$outboundSchema.optional(),
+  organizationId: z.string().optional(),
+  status: PayoutStatus$outboundSchema.optional(),
+  description: z.string().optional(),
+  amountInCents: z.number().int().optional(),
+  currency: z.string().optional(),
+  method: PayoutMethodEnum$outboundSchema.optional(),
+  sourceId: z.string().optional(),
+  destinationId: z.string().optional(),
+  metadata: z.record(z.string()).optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+  platformFee: z.number().int().optional(),
+  methodFee: z.number().int().optional(),
+  transactionId: z.string().optional(),
+  failureCode: z.string().optional(),
+  failureMessage: z.string().optional(),
+  transferredAmountInCents: 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 Payout$ {
+  /** @deprecated use `Payout$inboundSchema` instead. */
+  export const inboundSchema = Payout$inboundSchema;
+  /** @deprecated use `Payout$outboundSchema` instead. */
+  export const outboundSchema = Payout$outboundSchema;
+  /** @deprecated use `Payout$Outbound` instead. */
+  export type Outbound = Payout$Outbound;
+}
+
+export function payoutToJSON(payout: Payout): string {
+  return JSON.stringify(Payout$outboundSchema.parse(payout));
+}
+
+export function payoutFromJSON(
+  jsonString: string,
+): SafeParseResult<Payout, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Payout$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Payout' from JSON`,
+  );
+}

package/src/models/payoutmethod.ts

@@ -0,0 +1,133 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+/**
+ * The type of object.
+ */
+export const PayoutMethodObject = {
+  PayoutMethod: "payoutMethod",
+} as const;
+/**
+ * The type of object.
+ */
+export type PayoutMethodObject = ClosedEnum<typeof PayoutMethodObject>;
+
+export type PayoutMethod = {
+  /**
+   * The type of object.
+   */
+  object: PayoutMethodObject;
+  /**
+   * Method of payout.
+   */
+  method: string;
+  /**
+   * Pretty name for the payout method.
+   */
+  prettyName: string;
+  /**
+   * Fee in cents for this payout method.
+   */
+  feeInCents: number;
+  /**
+   * Minimum amount in cents for this payout method.
+   */
+  minAmountInCents: number;
+  /**
+   * Description of the payout method.
+   */
+  description: string;
+};
+
+/** @internal */
+export const PayoutMethodObject$inboundSchema: z.ZodNativeEnum<
+  typeof PayoutMethodObject
+> = z.nativeEnum(PayoutMethodObject);
+
+/** @internal */
+export const PayoutMethodObject$outboundSchema: z.ZodNativeEnum<
+  typeof PayoutMethodObject
+> = PayoutMethodObject$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PayoutMethodObject$ {
+  /** @deprecated use `PayoutMethodObject$inboundSchema` instead. */
+  export const inboundSchema = PayoutMethodObject$inboundSchema;
+  /** @deprecated use `PayoutMethodObject$outboundSchema` instead. */
+  export const outboundSchema = PayoutMethodObject$outboundSchema;
+}
+
+/** @internal */
+export const PayoutMethod$inboundSchema: z.ZodType<
+  PayoutMethod,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: PayoutMethodObject$inboundSchema,
+  method: z.string(),
+  prettyName: z.string(),
+  feeInCents: z.number().int(),
+  minAmountInCents: z.number().int(),
+  description: z.string(),
+});
+
+/** @internal */
+export type PayoutMethod$Outbound = {
+  object: string;
+  method: string;
+  prettyName: string;
+  feeInCents: number;
+  minAmountInCents: number;
+  description: string;
+};
+
+/** @internal */
+export const PayoutMethod$outboundSchema: z.ZodType<
+  PayoutMethod$Outbound,
+  z.ZodTypeDef,
+  PayoutMethod
+> = z.object({
+  object: PayoutMethodObject$outboundSchema,
+  method: z.string(),
+  prettyName: z.string(),
+  feeInCents: z.number().int(),
+  minAmountInCents: z.number().int(),
+  description: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PayoutMethod$ {
+  /** @deprecated use `PayoutMethod$inboundSchema` instead. */
+  export const inboundSchema = PayoutMethod$inboundSchema;
+  /** @deprecated use `PayoutMethod$outboundSchema` instead. */
+  export const outboundSchema = PayoutMethod$outboundSchema;
+  /** @deprecated use `PayoutMethod$Outbound` instead. */
+  export type Outbound = PayoutMethod$Outbound;
+}
+
+export function payoutMethodToJSON(payoutMethod: PayoutMethod): string {
+  return JSON.stringify(PayoutMethod$outboundSchema.parse(payoutMethod));
+}
+
+export function payoutMethodFromJSON(
+  jsonString: string,
+): SafeParseResult<PayoutMethod, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PayoutMethod$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PayoutMethod' from JSON`,
+  );
+}

package/src/models/plan.ts

@@ -0,0 +1,171 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  PaymentOptions,
+  PaymentOptions$inboundSchema,
+  PaymentOptions$Outbound,
+  PaymentOptions$outboundSchema,
+} from "./paymentoptions.js";
+import {
+  SchemasPrice,
+  SchemasPrice$inboundSchema,
+  SchemasPrice$Outbound,
+  SchemasPrice$outboundSchema,
+} from "./schemasprice.js";
+
+export const PlanObject = {
+  Plan: "plan",
+} as const;
+export type PlanObject = ClosedEnum<typeof PlanObject>;
+
+export type Plan = {
+  /**
+   * Unique identifier for a plan
+   */
+  id?: string | undefined;
+  object?: PlanObject | undefined;
+  name?: string | undefined;
+  /**
+   * Payment options for the plan, pre/post paid, pay as you go, outOfBand payments.
+   */
+  paymentOptions?: PaymentOptions | undefined;
+  invoiceDisplayName?: string | undefined;
+  description?: string | undefined;
+  billingInterval?: string | undefined;
+  currency?: string | undefined;
+  /**
+   * Unique identifier for an organization
+   */
+  merchantId?: string | undefined;
+  /**
+   * Unique identifier for a product
+   */
+  productId?: string | undefined;
+  /**
+   * Unique identifier for a wallet namespace
+   */
+  walletNamespaceId?: string | undefined;
+  tax?: { [k: string]: any } | undefined;
+  prices?: Array<SchemasPrice> | undefined;
+  createdAt?: Date | undefined;
+  updatedAt?: Date | undefined;
+  deletedAt?: Date | undefined;
+};
+
+/** @internal */
+export const PlanObject$inboundSchema: z.ZodNativeEnum<typeof PlanObject> = z
+  .nativeEnum(PlanObject);
+
+/** @internal */
+export const PlanObject$outboundSchema: z.ZodNativeEnum<typeof PlanObject> =
+  PlanObject$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PlanObject$ {
+  /** @deprecated use `PlanObject$inboundSchema` instead. */
+  export const inboundSchema = PlanObject$inboundSchema;
+  /** @deprecated use `PlanObject$outboundSchema` instead. */
+  export const outboundSchema = PlanObject$outboundSchema;
+}
+
+/** @internal */
+export const Plan$inboundSchema: z.ZodType<Plan, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.string().optional(),
+    object: PlanObject$inboundSchema.optional(),
+    name: z.string().optional(),
+    paymentOptions: PaymentOptions$inboundSchema.optional(),
+    invoiceDisplayName: z.string().optional(),
+    description: z.string().optional(),
+    billingInterval: z.string().optional(),
+    currency: z.string().optional(),
+    merchantId: z.string().optional(),
+    productId: z.string().optional(),
+    walletNamespaceId: z.string().optional(),
+    tax: z.record(z.any()).optional(),
+    prices: z.array(SchemasPrice$inboundSchema).optional(),
+    createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
+      .optional(),
+    updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
+      .optional(),
+    deletedAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
+      .optional(),
+  });
+
+/** @internal */
+export type Plan$Outbound = {
+  id?: string | undefined;
+  object?: string | undefined;
+  name?: string | undefined;
+  paymentOptions?: PaymentOptions$Outbound | undefined;
+  invoiceDisplayName?: string | undefined;
+  description?: string | undefined;
+  billingInterval?: string | undefined;
+  currency?: string | undefined;
+  merchantId?: string | undefined;
+  productId?: string | undefined;
+  walletNamespaceId?: string | undefined;
+  tax?: { [k: string]: any } | undefined;
+  prices?: Array<SchemasPrice$Outbound> | undefined;
+  createdAt?: string | undefined;
+  updatedAt?: string | undefined;
+  deletedAt?: string | undefined;
+};
+
+/** @internal */
+export const Plan$outboundSchema: z.ZodType<Plan$Outbound, z.ZodTypeDef, Plan> =
+  z.object({
+    id: z.string().optional(),
+    object: PlanObject$outboundSchema.optional(),
+    name: z.string().optional(),
+    paymentOptions: PaymentOptions$outboundSchema.optional(),
+    invoiceDisplayName: z.string().optional(),
+    description: z.string().optional(),
+    billingInterval: z.string().optional(),
+    currency: z.string().optional(),
+    merchantId: z.string().optional(),
+    productId: z.string().optional(),
+    walletNamespaceId: z.string().optional(),
+    tax: z.record(z.any()).optional(),
+    prices: z.array(SchemasPrice$outboundSchema).optional(),
+    createdAt: z.date().transform(v => v.toISOString()).optional(),
+    updatedAt: z.date().transform(v => v.toISOString()).optional(),
+    deletedAt: z.date().transform(v => v.toISOString()).optional(),
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Plan$ {
+  /** @deprecated use `Plan$inboundSchema` instead. */
+  export const inboundSchema = Plan$inboundSchema;
+  /** @deprecated use `Plan$outboundSchema` instead. */
+  export const outboundSchema = Plan$outboundSchema;
+  /** @deprecated use `Plan$Outbound` instead. */
+  export type Outbound = Plan$Outbound;
+}
+
+export function planToJSON(plan: Plan): string {
+  return JSON.stringify(Plan$outboundSchema.parse(plan));
+}
+
+export function planFromJSON(
+  jsonString: string,
+): SafeParseResult<Plan, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Plan$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Plan' from JSON`,
+  );
+}