@paygentic/sdk 0.6.11 → 0.6.13

package/src/models/payment.ts

@@ -0,0 +1,149 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+export const PaymentObject = {
+  Payment: "payment",
+} as const;
+export type PaymentObject = ClosedEnum<typeof PaymentObject>;
+
+export type LineItem = {
+  description?: string | undefined;
+  amount?: string | undefined;
+  quantity?: number | undefined;
+};
+
+/**
+ * Current status of the payment.
+ */
+export const PaymentStatus = {
+  Pending: "pending",
+  Processing: "processing",
+  Completed: "completed",
+  Expired: "expired",
+  Cancelled: "cancelled",
+} as const;
+/**
+ * Current status of the payment.
+ */
+export type PaymentStatus = ClosedEnum<typeof PaymentStatus>;
+
+export type Payment = {
+  /**
+   * Unique payment identifier (pay_* prefixed).
+   */
+  id: string;
+  object: PaymentObject;
+  /**
+   * Payment amount in decimal format (e.g. '10.50').
+   */
+  amount: string;
+  /**
+   * ISO 4217 currency code (e.g. 'USD').
+   */
+  currency: string;
+  /**
+   * URL for the customer to complete the payment.
+   */
+  paymentUrl?: string | undefined;
+  /**
+   * Customer ID if provided.
+   */
+  customerId?: string | undefined;
+  /**
+   * Client-provided idempotency key.
+   */
+  idempotencyKey?: string | undefined;
+  /**
+   * Merchant-defined reference for this payment.
+   */
+  reference?: string | undefined;
+  /**
+   * Merchant-provided key-value metadata.
+   */
+  metadata?: { [k: string]: string } | undefined;
+  /**
+   * Breakdown of what the customer is being charged for.
+   */
+  lineItems?: Array<LineItem> | undefined;
+  /**
+   * Current status of the payment.
+   */
+  status: PaymentStatus;
+  /**
+   * When the payment expires.
+   */
+  expiresAt?: Date | undefined;
+  /**
+   * When the payment was created.
+   */
+  createdAt: Date;
+};
+
+/** @internal */
+export const PaymentObject$inboundSchema: z.ZodNativeEnum<
+  typeof PaymentObject
+> = z.nativeEnum(PaymentObject);
+
+/** @internal */
+export const LineItem$inboundSchema: z.ZodType<
+  LineItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  description: z.string().optional(),
+  amount: z.string().optional(),
+  quantity: z.number().int().optional(),
+});
+
+export function lineItemFromJSON(
+  jsonString: string,
+): SafeParseResult<LineItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LineItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LineItem' from JSON`,
+  );
+}
+
+/** @internal */
+export const PaymentStatus$inboundSchema: z.ZodNativeEnum<
+  typeof PaymentStatus
+> = z.nativeEnum(PaymentStatus);
+
+/** @internal */
+export const Payment$inboundSchema: z.ZodType<Payment, z.ZodTypeDef, unknown> =
+  z.object({
+    id: z.string(),
+    object: PaymentObject$inboundSchema.default("payment"),
+    amount: z.string(),
+    currency: z.string(),
+    paymentUrl: z.string().optional(),
+    customerId: z.string().optional(),
+    idempotencyKey: z.string().optional(),
+    reference: z.string().optional(),
+    metadata: z.record(z.string()).optional(),
+    lineItems: z.array(z.lazy(() => LineItem$inboundSchema)).optional(),
+    status: PaymentStatus$inboundSchema,
+    expiresAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
+      .optional(),
+    createdAt: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+  });
+
+export function paymentFromJSON(
+  jsonString: string,
+): SafeParseResult<Payment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Payment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Payment' from JSON`,
+  );
+}

package/src/models/subscription.ts

@@ -41,7 +41,7 @@ export type StatusPending = ClosedEnum<typeof StatusPending>;
 /**
  * Payment session details when upfront payment is required
  */
-export type Payment = {
+export type SubscriptionPayment = {
   /**
    * Total payment amount in decimal dollar format. Sample values: '250.00' equals $250.00, '99.99' equals $99.99
    */
@@ -54,6 +54,10 @@ export type Payment = {
    * Checkout page URL for customer payment completion. Sample values: 'https://checkout.paygentic.com/session/ps_abc123', 'https://pay.example.com/checkout/xyz789'
    */
   checkoutUrl: string;
+  /**
+   * ID of the invoice linked to this payment.
+   */
+  invoiceId?: string | undefined;
   /**
    * Payment session identifier for upfront payment processing. Sample values: 'ps_abc123xyz', 'ps_789def456'
    */
@@ -93,7 +97,7 @@ export type Subscription = {
   /**
    * Payment session details when upfront payment is required
    */
-  payment?: Payment | undefined;
+  payment?: SubscriptionPayment | undefined;
   planId: string;
   /**
    * @deprecated Use minimumAccountBalance instead. Minimum required wallet balance in atomic units. Sample values: '200000000000' equals $200.00 minimum, '1000000000000' equals $1000.00 minimum
@@ -164,22 +168,26 @@ export const StatusPending$inboundSchema: z.ZodNativeEnum<
 > = z.nativeEnum(StatusPending);
 
 /** @internal */
-export const Payment$inboundSchema: z.ZodType<Payment, z.ZodTypeDef, unknown> =
-  z.object({
-    amount: z.string(),
-    breakdown: z.lazy(() => Breakdown$inboundSchema),
-    checkoutUrl: z.string(),
-    paymentSessionId: z.string(),
-    status: StatusPending$inboundSchema,
-  });
-
-export function paymentFromJSON(
+export const SubscriptionPayment$inboundSchema: z.ZodType<
+  SubscriptionPayment,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amount: z.string(),
+  breakdown: z.lazy(() => Breakdown$inboundSchema),
+  checkoutUrl: z.string(),
+  invoiceId: z.string().optional(),
+  paymentSessionId: z.string(),
+  status: StatusPending$inboundSchema,
+});
+
+export function subscriptionPaymentFromJSON(
   jsonString: string,
-): SafeParseResult<Payment, SDKValidationError> {
+): SafeParseResult<SubscriptionPayment, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Payment$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Payment' from JSON`,
+    (x) => SubscriptionPayment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionPayment' from JSON`,
   );
 }
 
@@ -204,7 +212,7 @@ export const Subscription$inboundSchema: z.ZodType<
   estimatedTaxRate: z.number().optional(),
   taxExempt: z.boolean().default(false),
   name: z.string(),
-  payment: z.lazy(() => Payment$inboundSchema).optional(),
+  payment: z.lazy(() => SubscriptionPayment$inboundSchema).optional(),
   planId: z.string(),
   prefundAmount: z.string().optional(),
   minimumAccountBalance: z.string().optional(),

package/src/models/usageresponse.ts

@@ -0,0 +1,116 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+export const UsageResponseObject = {
+  Meter: "meter",
+} as const;
+export type UsageResponseObject = ClosedEnum<typeof UsageResponseObject>;
+
+export type WindowedValue = {
+  windowStart: Date;
+  windowEnd: Date;
+  value: number;
+};
+
+export type GroupedValue = {
+  groupBy: { [k: string]: string };
+  value: number;
+};
+
+export type UsageResponse = {
+  object: UsageResponseObject;
+  /**
+   * Unique identifier for a billable metric
+   */
+  billableMetricId: string;
+  /**
+   * Total aggregated value across the query window
+   */
+  totalValue: number;
+  /**
+   * Time-bucketed values. Only present when windowSize is specified.
+   */
+  windowedValues?: Array<WindowedValue> | undefined;
+  /**
+   * Dimension-grouped values. Only present when groupBy is specified.
+   */
+  groupedValues?: Array<GroupedValue> | undefined;
+};
+
+/** @internal */
+export const UsageResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof UsageResponseObject
+> = z.nativeEnum(UsageResponseObject);
+
+/** @internal */
+export const WindowedValue$inboundSchema: z.ZodType<
+  WindowedValue,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  windowStart: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  windowEnd: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  value: z.number(),
+});
+
+export function windowedValueFromJSON(
+  jsonString: string,
+): SafeParseResult<WindowedValue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WindowedValue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WindowedValue' from JSON`,
+  );
+}
+
+/** @internal */
+export const GroupedValue$inboundSchema: z.ZodType<
+  GroupedValue,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  groupBy: z.record(z.string()),
+  value: z.number(),
+});
+
+export function groupedValueFromJSON(
+  jsonString: string,
+): SafeParseResult<GroupedValue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GroupedValue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GroupedValue' from JSON`,
+  );
+}
+
+/** @internal */
+export const UsageResponse$inboundSchema: z.ZodType<
+  UsageResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: UsageResponseObject$inboundSchema.default("meter"),
+  billableMetricId: z.string(),
+  totalValue: z.number(),
+  windowedValues: z.array(z.lazy(() => WindowedValue$inboundSchema)).optional(),
+  groupedValues: z.array(z.lazy(() => GroupedValue$inboundSchema)).optional(),
+});
+
+export function usageResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<UsageResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UsageResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UsageResponse' from JSON`,
+  );
+}

package/src/sdk/billablemetrics.ts

@@ -5,6 +5,7 @@
 import { billableMetricsCreate } from "../funcs/billableMetricsCreate.js";
 import { billableMetricsGet } from "../funcs/billableMetricsGet.js";
 import { billableMetricsList } from "../funcs/billableMetricsList.js";
+import { billableMetricsMeter } from "../funcs/billableMetricsMeter.js";
 import { billableMetricsUpdate } from "../funcs/billableMetricsUpdate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as models from "../models/index.js";
@@ -70,4 +71,21 @@ export class BillableMetrics extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Query Meter Usage
+   *
+   * @remarks
+   * Query aggregated usage data for a billable metric from the metering service.
+   */
+  async meter(
+    request: operations.GetBillableMetricMeterRequest,
+    options?: RequestOptions,
+  ): Promise<models.UsageResponse> {
+    return unwrapAsync(billableMetricsMeter(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/customers.ts

@@ -3,7 +3,7 @@
  */
 
 import { customersCreate } from "../funcs/customersCreate.js";
-import { customersDeleteCustomer } from "../funcs/customersDeleteCustomer.js";
+import { customersDelete } from "../funcs/customersDelete.js";
 import { customersGet } from "../funcs/customersGet.js";
 import { customersList } from "../funcs/customersList.js";
 import { customersUpdate } from "../funcs/customersUpdate.js";
@@ -61,11 +61,11 @@ export class Customers extends ClientSDK {
   /**
    * Delete
    */
-  async deleteCustomer(
+  async delete(
     request: operations.DeleteCustomerRequest,
     options?: RequestOptions,
   ): Promise<void> {
-    return unwrapAsync(customersDeleteCustomer(
+    return unwrapAsync(customersDelete(
       this,
       request,
       options,

package/src/sdk/payments.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { paymentsCreate } from "../funcs/paymentsCreate.js";
+import { paymentsGet } from "../funcs/paymentsGet.js";
+import { paymentsList } from "../funcs/paymentsList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Payments extends ClientSDK {
+  /**
+   * List Payments
+   *
+   * @remarks
+   * List payments for the authenticated merchant with optional filters.
+   */
+  async list(
+    request?: operations.ListPaymentsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.ListPaymentsResponse> {
+    return unwrapAsync(paymentsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create Payment
+   *
+   * @remarks
+   * Create a new payment for collecting a one-off charge. Returns a payment URL that can be shared with the customer.
+   */
+  async create(
+    request: operations.CreatePaymentRequest,
+    options?: RequestOptions,
+  ): Promise<models.Payment> {
+    return unwrapAsync(paymentsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Payment
+   *
+   * @remarks
+   * Retrieve a single payment by ID.
+   */
+  async get(
+    request: operations.GetPaymentRequest,
+    options?: RequestOptions,
+  ): Promise<models.Payment> {
+    return unwrapAsync(paymentsGet(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -12,6 +12,7 @@ import { Events } from "./events.js";
 import { Features } from "./features.js";
 import { Fees } from "./fees.js";
 import { InvoicesV2 } from "./invoicesv2.js";
+import { Payments } from "./payments.js";
 import { Plans } from "./plans.js";
 import { Prices } from "./prices.js";
 import { Products } from "./products.js";
@@ -98,6 +99,11 @@ export class Paygentic extends ClientSDK {
     return (this._invoicesV2 ??= new InvoicesV2(this._options));
   }
 
+  private _payments?: Payments;
+  get payments(): Payments {
+    return (this._payments ??= new Payments(this._options));
+  }
+
   private _events?: Events;
   get events(): Events {
     return (this._events ??= new Events(this._options));

package/.devcontainer/devcontainer.json

@@ -1,45 +0,0 @@
-// For format details, see https://aka.ms/devcontainer.json. For config options, see the
-// README at: https://github.com/devcontainers/images/tree/main/src/typescript-node
-{
-    "name": "TypeScript",
-    "image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bullseye",
-    // Features to add to the dev container. More info: https://containers.dev/features.
-    // "features": {},
-    // Use 'forwardPorts' to make a list of ports inside the container available locally.
-    // "forwardPorts": [],
-    // Use 'postCreateCommand' to run commands after the container is created.
-    "postCreateCommand": "sudo chmod +x ./.devcontainer/setup.sh && ./.devcontainer/setup.sh",
-    "customizations": {
-        "vscode": {
-            "extensions": [
-                "ms-vscode.vscode-typescript-tslint-plugin",
-                "esbenp.prettier-vscode",
-                "github.vscode-pull-request-github"
-            ],
-            "settings": {
-                "files.eol": "\n",
-                "editor.formatOnSave": true,
-                "typescript.tsc.autoDetect": "on",
-                "typescript.updateImportsOnFileMove.enabled": "always",
-                "typescript.preferences.importModuleSpecifier": "relative",
-                "[typescript]": {
-                    "editor.codeActionsOnSave": {
-                        "source.organizeImports": true
-                    }
-                },
-                "[typescriptreact]": {
-                    "editor.codeActionsOnSave": {
-                        "source.organizeImports": true
-                    }
-                }
-            }
-        },
-        "codespaces": {
-            "openFiles": [
-                ".devcontainer/README.md"
-            ]
-        }
-    }
-    // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
-    // "remoteUser": "root"
-}