@paygentic/sdk 0.7.1 → 0.7.2

package/src/funcs/paymentSessionsListPaymentSessions.ts

@@ -0,0 +1,183 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { PaygenticCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { PaygenticError } from "../models/errors/paygenticerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * List
+ *
+ * @remarks
+ * List payment sessions for the authenticated merchant with optional filters. Supports filtering by subscriptionId, customerId, status, and entityType. When subscriptionId is provided the result includes both the subscription's own activation session (entityType='subscription') and any session attached to invoices for that subscription (entityType='invoice').
+ */
+export function paymentSessionsListPaymentSessions(
+  client: PaygenticCore,
+  request?: operations.ListPaymentSessionsRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.ListPaymentSessionsResponse,
+    | errors.ErrorT
+    | PaygenticError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: PaygenticCore,
+  request?: operations.ListPaymentSessionsRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.ListPaymentSessionsResponse,
+      | errors.ErrorT
+      | PaygenticError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.ListPaymentSessionsRequest$outboundSchema.optional().parse(
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v0/paymentSessions")();
+
+  const query = encodeFormQuery({
+    "customerId": payload?.customerId,
+    "entityType": payload?.entityType,
+    "limit": payload?.limit,
+    "merchantId": payload?.merchantId,
+    "offset": payload?.offset,
+    "status": payload?.status,
+    "subscriptionId": payload?.subscriptionId,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.bearerAuth);
+  const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "listPaymentSessions",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.bearerAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["401", "403", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.ListPaymentSessionsResponse,
+    | errors.ErrorT
+    | PaygenticError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ListPaymentSessionsResponse$inboundSchema),
+    M.jsonErr([401, 403], errors.ErrorT$inboundSchema),
+    M.jsonErr(500, errors.ErrorT$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/profitabilityGetProfitability.ts

@@ -0,0 +1,184 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { PaygenticCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { PaygenticError } from "../models/errors/paygenticerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get profitability summary
+ *
+ * @remarks
+ * Returns a per-customer profitability summary for a merchant over a date range. Each row aggregates revenue (from issued + paid invoices), cost (from metered cost discovery), profit, and margin. Customers are ranked by profit descending and capped at topN; the remainder is rolled into a single self-consistent 'Other' row whose revenue, cost, and profit reflect the same set of customers. Rows are inner-joined against the merchant's customer list, so orphaned meter subjects from deleted or unknown customers are dropped.
+ */
+export function profitabilityGetProfitability(
+  client: PaygenticCore,
+  request: operations.GetProfitabilityRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.ProfitabilitySummaryResponse,
+    | errors.BadRequest
+    | errors.ErrorT
+    | PaygenticError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: PaygenticCore,
+  request: operations.GetProfitabilityRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.ProfitabilitySummaryResponse,
+      | errors.BadRequest
+      | errors.ErrorT
+      | PaygenticError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.GetProfitabilityRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v0/profitability")();
+
+  const query = encodeFormQuery({
+    "bucketWidth": payload.bucketWidth,
+    "currency": payload.currency,
+    "from": payload.from,
+    "merchantId": payload.merchantId,
+    "to": payload.to,
+    "topN": payload.topN,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.bearerAuth);
+  const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getProfitability",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.bearerAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "403", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    models.ProfitabilitySummaryResponse,
+    | errors.BadRequest
+    | errors.ErrorT
+    | PaygenticError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.ProfitabilitySummaryResponse$inboundSchema),
+    M.jsonErr(400, errors.BadRequest$inboundSchema),
+    M.jsonErr([401, 403], errors.ErrorT$inboundSchema),
+    M.jsonErr(500, errors.ErrorT$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -65,7 +65,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.1.0",
-  sdkVersion: "0.7.1",
+  sdkVersion: "0.7.2",
   genVersion: "2.879.13",
-  userAgent: "speakeasy-sdk/typescript 0.7.1 2.879.13 0.1.0 @paygentic/sdk",
+  userAgent: "speakeasy-sdk/typescript 0.7.2 2.879.13 0.1.0 @paygentic/sdk",
 } as const;

package/src/models/index.ts

@@ -40,6 +40,7 @@ export * from "./meterevent.js";
 export * from "./metereventlist.js";
 export * from "./offsetpagination.js";
 export * from "./payment.js";
+export * from "./paymentsession.js";
 export * from "./paymentsummary.js";
 export * from "./plan.js";
 export * from "./price.js";
@@ -47,6 +48,9 @@ export * from "./pricefeature.js";
 export * from "./pricefeatureinput.js";
 export * from "./pricepropertiesunion.js";
 export * from "./product.js";
+export * from "./profitabilityrow.js";
+export * from "./profitabilitysummaryresponse.js";
+export * from "./profitabilitytrend.js";
 export * from "./purchasegrantrequest.js";
 export * from "./purchasegrantresponse.js";
 export * from "./revenuesummaryresponse.js";

package/src/models/offsetpagination.ts

@@ -12,17 +12,17 @@ import { SDKValidationError } from "./errors/sdkvalidationerror.js";
  */
 export type OffsetPagination = {
   /**
-   * Number of items returned in the current page.
+   * Requested page size.
    */
-  limit?: number | undefined;
+  limit: number;
   /**
    * Number of items skipped.
    */
-  offset?: number | undefined;
+  offset: number;
   /**
    * Total number of items available.
    */
-  total?: number | undefined;
+  total: number;
 };
 
 /** @internal */
@@ -31,9 +31,9 @@ export const OffsetPagination$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  limit: z.number().int().optional(),
-  offset: z.number().int().optional(),
-  total: z.number().int().optional(),
+  limit: z.number().int(),
+  offset: z.number().int(),
+  total: z.number().int(),
 });
 
 export function offsetPaginationFromJSON(

package/src/models/operations/createplan.ts

@@ -121,6 +121,10 @@ export type CreatePlanRequest = {
    * Billing engine version. 0 = legacy fee-schedule billing (Legacy), 1 = line-item billing with metered usage support (Standard).
    */
   billingVersion?: BillingVersion | undefined;
+  /**
+   * ISO 8601 datetime reference point for billing period alignment. Must be in the past or present. When set, subscriptions created under this plan align their first billing period to the next recurrence of this anchor.
+   */
+  billingAnchor?: Date | null | undefined;
 };
 
 /** @internal */
@@ -160,6 +164,7 @@ export type CreatePlanRequest$Outbound = {
   renewalReminderEnabled: boolean;
   renewalReminderDays: number;
   billingVersion: number;
+  billingAnchor?: string | null | undefined;
 };
 
 /** @internal */
@@ -183,6 +188,8 @@ export const CreatePlanRequest$outboundSchema: z.ZodType<
   renewalReminderEnabled: z.boolean().default(true),
   renewalReminderDays: z.number().int().default(3),
   billingVersion: BillingVersion$outboundSchema.default(0),
+  billingAnchor: z.nullable(z.date().transform(v => v.toISOString()))
+    .optional(),
 });
 
 export function createPlanRequestToJSON(

package/src/models/operations/getprofitability.ts

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Time bucket granularity for the per-customer revenue trend. When omitted, the server picks a reasonable bucket from the window length.
+ */
+export const GetProfitabilityBucketWidth = {
+  Hour: "hour",
+  Day: "day",
+  Week: "week",
+} as const;
+/**
+ * Time bucket granularity for the per-customer revenue trend. When omitted, the server picks a reasonable bucket from the window length.
+ */
+export type GetProfitabilityBucketWidth = ClosedEnum<
+  typeof GetProfitabilityBucketWidth
+>;
+
+export type GetProfitabilityRequest = {
+  /**
+   * Merchant whose customers to summarize
+   */
+  merchantId: string;
+  /**
+   * Start of the time range (ISO 8601 format)
+   */
+  from: Date;
+  /**
+   * End of the time range (ISO 8601 format)
+   */
+  to: Date;
+  /**
+   * Number of top customers (by profit) to return individually. The rest are rolled into a single 'Other' row.
+   */
+  topN?: number | undefined;
+  /**
+   * ISO 4217 currency code to scope the summary. Defaults to the merchant's primary currency.
+   */
+  currency?: string | undefined;
+  /**
+   * Time bucket granularity for the per-customer revenue trend. When omitted, the server picks a reasonable bucket from the window length.
+   */
+  bucketWidth?: GetProfitabilityBucketWidth | undefined;
+};
+
+/** @internal */
+export const GetProfitabilityBucketWidth$outboundSchema: z.ZodNativeEnum<
+  typeof GetProfitabilityBucketWidth
+> = z.nativeEnum(GetProfitabilityBucketWidth);
+
+/** @internal */
+export type GetProfitabilityRequest$Outbound = {
+  merchantId: string;
+  from: string;
+  to: string;
+  topN: number;
+  currency?: string | undefined;
+  bucketWidth: string;
+};
+
+/** @internal */
+export const GetProfitabilityRequest$outboundSchema: z.ZodType<
+  GetProfitabilityRequest$Outbound,
+  z.ZodTypeDef,
+  GetProfitabilityRequest
+> = z.object({
+  merchantId: z.string(),
+  from: z.date().transform(v => v.toISOString()),
+  to: z.date().transform(v => v.toISOString()),
+  topN: z.number().int().default(10),
+  currency: z.string().optional(),
+  bucketWidth: GetProfitabilityBucketWidth$outboundSchema.default("day"),
+});
+
+export function getProfitabilityRequestToJSON(
+  getProfitabilityRequest: GetProfitabilityRequest,
+): string {
+  return JSON.stringify(
+    GetProfitabilityRequest$outboundSchema.parse(getProfitabilityRequest),
+  );
+}

package/src/models/operations/getrevenue.ts

@@ -8,7 +8,7 @@ import { ClosedEnum } from "../../types/enums.js";
 /**
  * Time bucket granularity for trend data
  */
-export const BucketWidth = {
+export const GetRevenueBucketWidth = {
   Hour: "hour",
   Day: "day",
   Week: "week",
@@ -16,7 +16,7 @@ export const BucketWidth = {
 /**
  * Time bucket granularity for trend data
  */
-export type BucketWidth = ClosedEnum<typeof BucketWidth>;
+export type GetRevenueBucketWidth = ClosedEnum<typeof GetRevenueBucketWidth>;
 
 /**
  * Group invoice data by dimension. Allowed values: 'plan' (max 5 groups, top 4 + 'other' when exceeding), 'customer' (max 25 groups, top 24 + 'other' when exceeding, sorted by revenue descending), 'currency' (one entry per currency, primary currency first then alphabetical). Note: groupBy values are mutually exclusive — combining them returns a 400 error. When groupBy=currency is active, top-level netRevenue, invoices, and payments fields are omitted; currencyBreakdown is the sole data source.
@@ -43,7 +43,7 @@ export type GetRevenueRequest = {
   /**
    * Time bucket granularity for trend data
    */
-  bucketWidth?: BucketWidth | undefined;
+  bucketWidth?: GetRevenueBucketWidth | undefined;
   /**
    * Filter by merchant ID. At least one of merchantId, subscriptionIds, or customerId must be provided.
    */
@@ -67,8 +67,9 @@ export type GetRevenueRequest = {
 };
 
 /** @internal */
-export const BucketWidth$outboundSchema: z.ZodNativeEnum<typeof BucketWidth> = z
-  .nativeEnum(BucketWidth);
+export const GetRevenueBucketWidth$outboundSchema: z.ZodNativeEnum<
+  typeof GetRevenueBucketWidth
+> = z.nativeEnum(GetRevenueBucketWidth);
 
 /** @internal */
 export const GroupBy$outboundSchema: z.ZodNativeEnum<typeof GroupBy> = z
@@ -94,7 +95,7 @@ export const GetRevenueRequest$outboundSchema: z.ZodType<
 > = z.object({
   startTime: z.date().transform(v => v.toISOString()),
   endTime: z.date().transform(v => v.toISOString()),
-  bucketWidth: BucketWidth$outboundSchema.default("day"),
+  bucketWidth: GetRevenueBucketWidth$outboundSchema.default("day"),
   merchantId: z.string().optional(),
   customerId: z.string().optional(),
   subscriptionIds: z.array(z.string()).optional(),

package/src/models/operations/index.ts

@@ -45,6 +45,7 @@ export * from "./getpayment.js";
 export * from "./getplan.js";
 export * from "./getprice.js";
 export * from "./getproduct.js";
+export * from "./getprofitability.js";
 export * from "./getrevenue.js";
 export * from "./getsource.js";
 export * from "./getsourcerule.js";
@@ -64,6 +65,7 @@ export * from "./listfees.js";
 export * from "./listinvoices.js";
 export * from "./listlineitems.js";
 export * from "./listpayments.js";
+export * from "./listpaymentsessions.js";
 export * from "./listplans.js";
 export * from "./listprices.js";
 export * from "./listproducts.js";

package/src/models/operations/listinvoices.ts

@@ -46,6 +46,10 @@ export type ListInvoicesRequest = {
    * Maximum number of invoices to return
    */
   limit?: number | undefined;
+  /**
+   * Number of invoices to skip for pagination
+   */
+  offset?: number | undefined;
   /**
    * Filter for invoices ready for processing (platform only)
    */
@@ -75,6 +79,10 @@ export type ListInvoicesObject = ClosedEnum<typeof ListInvoicesObject>;
 export type ListInvoicesResponse = {
   object: ListInvoicesObject;
   data: Array<models.Invoice>;
+  /**
+   * Offset-based pagination response.
+   */
+  pagination?: models.OffsetPagination | undefined;
 };
 
 /** @internal */
@@ -89,6 +97,7 @@ export const ListInvoicesStatus$outboundSchema: z.ZodNativeEnum<
 /** @internal */
 export type ListInvoicesRequest$Outbound = {
   limit: number;
+  offset: number;
   nextActionAt?: string | undefined;
   status?: string | undefined;
   subscriptionId?: string | undefined;
@@ -102,6 +111,7 @@ export const ListInvoicesRequest$outboundSchema: z.ZodType<
   ListInvoicesRequest
 > = z.object({
   limit: z.number().int().default(10),
+  offset: z.number().int().default(0),
   nextActionAt: NextActionAt$outboundSchema.optional(),
   status: ListInvoicesStatus$outboundSchema.optional(),
   subscriptionId: z.string().optional(),
@@ -129,6 +139,7 @@ export const ListInvoicesResponse$inboundSchema: z.ZodType<
 > = z.object({
   object: ListInvoicesObject$inboundSchema,
   data: z.array(models.Invoice$inboundSchema),
+  pagination: models.OffsetPagination$inboundSchema.optional(),
 });
 
 export function listInvoicesResponseFromJSON(