@paygentic/sdk 0.6.19 → 0.6.21

package/src/funcs/entitlementsGrantsPurchase.ts

@@ -0,0 +1,189 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { PaygenticCore } from "../core.js";
+import { encodeJSON, encodeSimple } 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";
+
+/**
+ * Purchase Grant
+ *
+ * @remarks
+ * Create an ad-hoc invoice with a payment session for a grant purchase. The customer pays via the returned payment URL; the grant is created automatically on payment completion. If payment expires, the invoice is cancelled and no grant is created.
+ *
+ * After the consumer completes payment, the grant is created automatically. To confirm payment completion, poll `GET /v2/invoices/{invoiceId}` using the `invoiceId` from the response and check for `status === "PAID"`. Recommended polling interval: 2 seconds, timeout: 60 seconds.
+ */
+export function entitlementsGrantsPurchase(
+  client: PaygenticCore,
+  request: operations.PurchaseEntitlementGrantRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.PurchaseGrantResponse,
+    | 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.PurchaseEntitlementGrantRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.PurchaseGrantResponse,
+      | errors.BadRequest
+      | errors.ErrorT
+      | PaygenticError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.PurchaseEntitlementGrantRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.PurchaseGrantRequest, {
+    explode: true,
+  });
+
+  const pathParams = {
+    entitlementId: encodeSimple("entitlementId", payload.entitlementId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v1/entitlements/{entitlementId}/grants/purchase")(
+    pathParams,
+  );
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    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: "purchaseEntitlementGrant",
+    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: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    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", "403", "404", "409", "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.PurchaseGrantResponse,
+    | errors.BadRequest
+    | errors.ErrorT
+    | PaygenticError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(201, models.PurchaseGrantResponse$inboundSchema),
+    M.jsonErr(400, errors.BadRequest$inboundSchema),
+    M.jsonErr([403, 404, 409], 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/entitlementsGrantsVoid.ts

@@ -0,0 +1,188 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { PaygenticCore } from "../core.js";
+import { encodeSimple } 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";
+
+/**
+ * Void Grant
+ *
+ * @remarks
+ * Void a grant, removing it from the customer's balance. This operation is idempotent — voiding an already-voided grant returns the voided grant without error.
+ */
+export function entitlementsGrantsVoid(
+  client: PaygenticCore,
+  request: operations.VoidEntitlementGrantRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.Grant,
+    | 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.VoidEntitlementGrantRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.Grant,
+      | errors.BadRequest
+      | errors.ErrorT
+      | PaygenticError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.VoidEntitlementGrantRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    entitlementId: encodeSimple("entitlementId", payload.entitlementId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    grantId: encodeSimple("grantId", payload.grantId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v1/entitlements/{entitlementId}/grants/{grantId}")(
+    pathParams,
+  );
+
+  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: "voidEntitlementGrant",
+    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: "DELETE",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    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", "403", "404", "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.Grant,
+    | errors.BadRequest
+    | errors.ErrorT
+    | PaygenticError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.Grant$inboundSchema),
+    M.jsonErr(400, errors.BadRequest$inboundSchema),
+    M.jsonErr([403, 404], 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/revenueGet.ts

@@ -27,10 +27,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get revenue time series
+ * Get revenue summary
  *
  * @remarks
- * Returns time-bucketed revenue data including usage charges, fee charges, and refunds. Data is aggregated by subscription with an optional 'other' bucket for subscriptions outside the top N.
+ * Returns revenue summary with invoice and payment breakdowns (outstanding/paid/writtenOff), plus a time-series trend. Revenue is sourced from all issued invoices (v0 + v1) and completed payments.
  */
 export function revenueGet(
   client: PaygenticCore,
@@ -38,7 +38,7 @@ export function revenueGet(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    models.RevenueTimeSeriesResponse,
+    models.RevenueSummaryResponse,
     | errors.BadRequest
     | errors.ErrorT
     | PaygenticError
@@ -65,7 +65,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      models.RevenueTimeSeriesResponse,
+      models.RevenueSummaryResponse,
       | errors.BadRequest
       | errors.ErrorT
       | PaygenticError
@@ -97,10 +97,10 @@ async function $do(
     "bucketWidth": payload.bucketWidth,
     "customerId": payload.customerId,
     "endTime": payload.endTime,
+    "groupBy": payload.groupBy,
     "merchantId": payload.merchantId,
     "startTime": payload.startTime,
     "subscriptionIds": payload.subscriptionIds,
-    "topN": payload.topN,
   });
 
   const headers = new Headers(compactMap({
@@ -158,7 +158,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    models.RevenueTimeSeriesResponse,
+    models.RevenueSummaryResponse,
     | errors.BadRequest
     | errors.ErrorT
     | PaygenticError
@@ -170,7 +170,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, models.RevenueTimeSeriesResponse$inboundSchema),
+    M.json(200, models.RevenueSummaryResponse$inboundSchema),
     M.jsonErr(400, errors.BadRequest$inboundSchema),
     M.jsonErr([401, 403], errors.ErrorT$inboundSchema),
     M.jsonErr(500, errors.ErrorT$inboundSchema),

package/src/funcs/subscriptionsList.ts

@@ -95,9 +95,11 @@ async function $do(
   const query = encodeFormQuery({
     "consumerId": payload?.consumerId,
     "customerId": payload?.customerId,
+    "include": payload?.include,
     "limit": payload?.limit,
     "merchantId": payload?.merchantId,
     "offset": payload?.offset,
+    "startedBefore": payload?.startedBefore,
     "status": payload?.status,
   });
 

package/src/lib/config.ts

@@ -61,7 +61,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.1.0",
-  sdkVersion: "0.6.17",
-  genVersion: "2.859.2",
-  userAgent: "speakeasy-sdk/typescript 0.6.17 2.859.2 0.1.0 @paygentic/sdk",
+  sdkVersion: "0.6.20",
+  genVersion: "2.865.2",
+  userAgent: "speakeasy-sdk/typescript 0.6.20 2.865.2 0.1.0 @paygentic/sdk",
 } as const;

package/src/models/creategrantrequest.ts

@@ -0,0 +1,52 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type CreateGrantRequest = {
+  /**
+   * The number of credits to grant.
+   */
+  amount: number;
+  /**
+   * When the grant becomes effective. Defaults to now.
+   */
+  effectiveAt?: Date | undefined;
+  /**
+   * When the grant expires. If omitted, the grant does not expire.
+   */
+  expiresAt?: Date | null | undefined;
+  /**
+   * Idempotency key to prevent duplicate grants. Must be unique per entitlement.
+   */
+  idempotencyKey: string;
+};
+
+/** @internal */
+export type CreateGrantRequest$Outbound = {
+  amount: number;
+  effectiveAt?: string | undefined;
+  expiresAt?: string | null | undefined;
+  idempotencyKey: string;
+};
+
+/** @internal */
+export const CreateGrantRequest$outboundSchema: z.ZodType<
+  CreateGrantRequest$Outbound,
+  z.ZodTypeDef,
+  CreateGrantRequest
+> = z.object({
+  amount: z.number(),
+  effectiveAt: z.date().transform(v => v.toISOString()).optional(),
+  expiresAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  idempotencyKey: z.string(),
+});
+
+export function createGrantRequestToJSON(
+  createGrantRequest: CreateGrantRequest,
+): string {
+  return JSON.stringify(
+    CreateGrantRequest$outboundSchema.parse(createGrantRequest),
+  );
+}

package/src/models/grant.ts

@@ -0,0 +1,81 @@
+/*
+ * 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 GrantObject = {
+  Grant: "grant",
+} as const;
+export type GrantObject = ClosedEnum<typeof GrantObject>;
+
+export type Grant = {
+  object: GrantObject;
+  /**
+   * Unique identifier for the grant.
+   */
+  id: string;
+  /**
+   * The entitlement this grant belongs to.
+   */
+  entitlementId: string;
+  /**
+   * The number of credits granted.
+   */
+  amount: number;
+  /**
+   * When the grant becomes effective.
+   */
+  effectiveAt: Date;
+  /**
+   * When the grant expires. Null means no expiration.
+   */
+  expiresAt?: Date | null | undefined;
+  /**
+   * When the grant was voided. Null means the grant is active.
+   */
+  voidedAt?: Date | null | undefined;
+  /**
+   * When the grant was created.
+   */
+  createdAt: Date;
+};
+
+/** @internal */
+export const GrantObject$inboundSchema: z.ZodNativeEnum<typeof GrantObject> = z
+  .nativeEnum(GrantObject);
+
+/** @internal */
+export const Grant$inboundSchema: z.ZodType<Grant, z.ZodTypeDef, unknown> = z
+  .object({
+    object: GrantObject$inboundSchema.default("grant"),
+    id: z.string(),
+    entitlementId: z.string(),
+    amount: z.number(),
+    effectiveAt: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    expiresAt: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
+    voidedAt: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
+    createdAt: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+  });
+
+export function grantFromJSON(
+  jsonString: string,
+): SafeParseResult<Grant, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Grant$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Grant' from JSON`,
+  );
+}

package/src/models/groupinvoicesummary.ts

@@ -0,0 +1,49 @@
+/*
+ * 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 {
+  InvoiceCategorySummary,
+  InvoiceCategorySummary$inboundSchema,
+} from "./invoicecategorysummary.js";
+
+export type GroupInvoiceSummary = {
+  /**
+   * Unique identifier for the group (e.g. plan ID, or 'other')
+   */
+  groupKey: string;
+  /**
+   * Human-readable label for the group (e.g. plan name)
+   */
+  groupLabel: string;
+  outstanding: InvoiceCategorySummary;
+  paid: InvoiceCategorySummary;
+  writtenOff: InvoiceCategorySummary;
+};
+
+/** @internal */
+export const GroupInvoiceSummary$inboundSchema: z.ZodType<
+  GroupInvoiceSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  groupKey: z.string(),
+  groupLabel: z.string(),
+  outstanding: InvoiceCategorySummary$inboundSchema,
+  paid: InvoiceCategorySummary$inboundSchema,
+  writtenOff: InvoiceCategorySummary$inboundSchema,
+});
+
+export function groupInvoiceSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<GroupInvoiceSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GroupInvoiceSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GroupInvoiceSummary' from JSON`,
+  );
+}

package/src/models/grouptrendentry.ts

@@ -0,0 +1,44 @@
+/*
+ * 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";
+
+export type GroupTrendEntry = {
+  /**
+   * Unique identifier for the group (e.g. plan ID, or 'other')
+   */
+  groupKey: string;
+  /**
+   * Human-readable label for the group (e.g. plan name)
+   */
+  groupLabel: string;
+  /**
+   * Total issued invoice amount in dollars for this group in this bucket
+   */
+  issuedInvoices: string;
+};
+
+/** @internal */
+export const GroupTrendEntry$inboundSchema: z.ZodType<
+  GroupTrendEntry,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  groupKey: z.string(),
+  groupLabel: z.string(),
+  issuedInvoices: z.string(),
+});
+
+export function groupTrendEntryFromJSON(
+  jsonString: string,
+): SafeParseResult<GroupTrendEntry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GroupTrendEntry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GroupTrendEntry' from JSON`,
+  );
+}