@paygentic/sdk 0.6.8 → 0.6.9

package/src/funcs/eventsIngest.ts

@@ -0,0 +1,175 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { PaygenticCore } from "../core.js";
+import { encodeJSON } 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";
+
+/**
+ * Ingest Event
+ *
+ * @remarks
+ * Ingest a raw metering event. The event is published to the meter-events PubSub topic for processing by the meters service.
+ */
+export function eventsIngest(
+  client: PaygenticCore,
+  request: operations.IngestEventRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.EventResponse,
+    | 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.IngestEventRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.EventResponse,
+      | errors.BadRequest
+      | errors.ErrorT
+      | PaygenticError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.IngestEventRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v0/events")();
+
+  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: "ingestEvent",
+    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", "401", "403", "422", "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.EventResponse,
+    | errors.BadRequest
+    | errors.ErrorT
+    | PaygenticError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(202, models.EventResponse$inboundSchema),
+    M.jsonErr(400, errors.BadRequest$inboundSchema),
+    M.jsonErr([401, 403, 422], 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

@@ -62,6 +62,6 @@ export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.1.0",
   sdkVersion: "0.6.4",
-  genVersion: "2.835.2",
-  userAgent: "speakeasy-sdk/typescript 0.6.4 2.835.2 0.1.0 @paygentic/sdk",
+  genVersion: "2.836.5",
+  userAgent: "speakeasy-sdk/typescript 0.6.4 2.836.5 0.1.0 @paygentic/sdk",
 } as const;

package/src/models/booleanentitlementdetail.ts

@@ -0,0 +1,121 @@
+/*
+ * 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 BooleanEntitlementDetailObject = {
+  Entitlement: "entitlement",
+} as const;
+export type BooleanEntitlementDetailObject = ClosedEnum<
+  typeof BooleanEntitlementDetailObject
+>;
+
+/**
+ * Current status of the entitlement.
+ */
+export const BooleanEntitlementDetailStatus = {
+  Active: "active",
+  Canceled: "canceled",
+  Expired: "expired",
+} as const;
+/**
+ * Current status of the entitlement.
+ */
+export type BooleanEntitlementDetailStatus = ClosedEnum<
+  typeof BooleanEntitlementDetailStatus
+>;
+
+/**
+ * Common fields shared by all entitlement types.
+ */
+export type BooleanEntitlementDetail = {
+  object: BooleanEntitlementDetailObject;
+  /**
+   * Unique identifier for the entitlement.
+   */
+  id: string;
+  /**
+   * Unique identifier for a customer
+   */
+  customerId: string;
+  /**
+   * The feature this entitlement grants access to.
+   */
+  featureId: string;
+  /**
+   * The unique key identifying the feature.
+   */
+  featureKey: string;
+  featureType: "boolean";
+  /**
+   * The subscription this entitlement is associated with, if any.
+   */
+  subscriptionId?: string | null | undefined;
+  /**
+   * Current status of the entitlement.
+   */
+  status: BooleanEntitlementDetailStatus;
+  /**
+   * When the entitlement becomes active.
+   */
+  activeFrom: Date;
+  /**
+   * When the entitlement expires. Null means no expiration.
+   */
+  activeTo?: Date | null | undefined;
+  /**
+   * Whether the customer currently has active access to this entitlement.
+   */
+  hasAccess: boolean;
+  /**
+   * Additional metadata for the entitlement.
+   */
+  metadata?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export const BooleanEntitlementDetailObject$inboundSchema: z.ZodNativeEnum<
+  typeof BooleanEntitlementDetailObject
+> = z.nativeEnum(BooleanEntitlementDetailObject);
+
+/** @internal */
+export const BooleanEntitlementDetailStatus$inboundSchema: z.ZodNativeEnum<
+  typeof BooleanEntitlementDetailStatus
+> = z.nativeEnum(BooleanEntitlementDetailStatus);
+
+/** @internal */
+export const BooleanEntitlementDetail$inboundSchema: z.ZodType<
+  BooleanEntitlementDetail,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: BooleanEntitlementDetailObject$inboundSchema.default("entitlement"),
+  id: z.string(),
+  customerId: z.string(),
+  featureId: z.string(),
+  featureKey: z.string(),
+  featureType: z.literal("boolean"),
+  subscriptionId: z.nullable(z.string()).optional(),
+  status: BooleanEntitlementDetailStatus$inboundSchema,
+  activeFrom: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  activeTo: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  hasAccess: z.boolean(),
+  metadata: z.record(z.string()).optional(),
+});
+
+export function booleanEntitlementDetailFromJSON(
+  jsonString: string,
+): SafeParseResult<BooleanEntitlementDetail, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BooleanEntitlementDetail$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BooleanEntitlementDetail' from JSON`,
+  );
+}

package/src/models/entitlementaccessresult.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 /**
  * The type of feature: `boolean` (on/off), `static` (with config), or `metered` (usage-based).
  */
-export const EntitlementAccessResultFeatureType = {
+export const FeatureTypeEnum = {
   Boolean: "boolean",
   Static: "static",
   Metered: "metered",
@@ -19,9 +19,7 @@ export const EntitlementAccessResultFeatureType = {
 /**
  * The type of feature: `boolean` (on/off), `static` (with config), or `metered` (usage-based).
  */
-export type EntitlementAccessResultFeatureType = ClosedEnum<
-  typeof EntitlementAccessResultFeatureType
->;
+export type FeatureTypeEnum = ClosedEnum<typeof FeatureTypeEnum>;
 
 /**
  * Current status of the entitlement.
@@ -53,7 +51,7 @@ export type EntitlementAccessResult = {
   /**
    * The type of feature: `boolean` (on/off), `static` (with config), or `metered` (usage-based).
    */
-  featureType: EntitlementAccessResultFeatureType;
+  featureType: FeatureTypeEnum;
   /**
    * Configuration values for `static` features. Null for other types.
    */
@@ -81,9 +79,9 @@ export type EntitlementAccessResult = {
 };
 
 /** @internal */
-export const EntitlementAccessResultFeatureType$inboundSchema: z.ZodNativeEnum<
-  typeof EntitlementAccessResultFeatureType
-> = z.nativeEnum(EntitlementAccessResultFeatureType);
+export const FeatureTypeEnum$inboundSchema: z.ZodNativeEnum<
+  typeof FeatureTypeEnum
+> = z.nativeEnum(FeatureTypeEnum);
 
 /** @internal */
 export const EntitlementAccessResultStatus$inboundSchema: z.ZodNativeEnum<
@@ -98,7 +96,7 @@ export const EntitlementAccessResult$inboundSchema: z.ZodType<
 > = z.object({
   hasAccess: z.boolean(),
   featureKey: z.string(),
-  featureType: EntitlementAccessResultFeatureType$inboundSchema,
+  featureType: FeatureTypeEnum$inboundSchema,
   config: z.nullable(z.record(z.any())).optional(),
   entitlementId: z.string(),
   productId: z.string(),

package/src/models/entitlementdetail.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 {
+  BooleanEntitlementDetail,
+  BooleanEntitlementDetail$inboundSchema,
+} from "./booleanentitlementdetail.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  MeteredEntitlementDetail,
+  MeteredEntitlementDetail$inboundSchema,
+} from "./meteredentitlementdetail.js";
+import {
+  StaticEntitlementDetail,
+  StaticEntitlementDetail$inboundSchema,
+} from "./staticentitlementdetail.js";
+
+/**
+ * A specific entitlement. The response shape varies by featureType.
+ */
+export type EntitlementDetail =
+  | BooleanEntitlementDetail
+  | StaticEntitlementDetail
+  | MeteredEntitlementDetail;
+
+/** @internal */
+export const EntitlementDetail$inboundSchema: z.ZodType<
+  EntitlementDetail,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  BooleanEntitlementDetail$inboundSchema,
+  StaticEntitlementDetail$inboundSchema,
+  MeteredEntitlementDetail$inboundSchema,
+]);
+
+export function entitlementDetailFromJSON(
+  jsonString: string,
+): SafeParseResult<EntitlementDetail, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EntitlementDetail$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntitlementDetail' from JSON`,
+  );
+}

package/src/models/entitlementtemplate.ts

@@ -0,0 +1,192 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type UsagePeriod = {
+  /**
+   * ISO 8601 duration for the usage period, e.g. P1D, P1W, P1M, P1Y.
+   */
+  interval: string;
+  /**
+   * Optional anchor date-time for period alignment.
+   */
+  anchor?: Date | undefined;
+};
+
+export type EntitlementTemplateMetered = {
+  type: "metered";
+  usagePeriod: UsagePeriod;
+  /**
+   * When true, access is granted even when balance is exhausted.
+   */
+  isSoftLimit?: boolean | undefined;
+  /**
+   * Amount of grants to issue after each period reset.
+   */
+  issueAfterReset?: number | undefined;
+  /**
+   * Priority for grants issued after reset.
+   */
+  issueAfterResetPriority?: number | undefined;
+  /**
+   * When true, overage from the previous period carries over.
+   */
+  preserveOverageAtReset?: boolean | undefined;
+  /**
+   * Maximum amount of unused balance that rolls over on reset.
+   */
+  resetMaxRollover?: number | undefined;
+  /**
+   * Minimum amount of balance guaranteed to roll over on reset.
+   */
+  resetMinRollover?: number | undefined;
+};
+
+export type EntitlementTemplateStatic = {
+  type: "static";
+  /**
+   * Configuration values for the entitlement.
+   */
+  config: { [k: string]: any };
+};
+
+export type EntitlementTemplateBoolean = {
+  type: "boolean";
+};
+
+/**
+ * Template for the entitlement. Boolean for simple on/off features, static for features with configuration, metered for usage-based features.
+ */
+export type EntitlementTemplate =
+  | EntitlementTemplateBoolean
+  | EntitlementTemplateStatic
+  | EntitlementTemplateMetered;
+
+/** @internal */
+export type UsagePeriod$Outbound = {
+  interval: string;
+  anchor?: string | undefined;
+};
+
+/** @internal */
+export const UsagePeriod$outboundSchema: z.ZodType<
+  UsagePeriod$Outbound,
+  z.ZodTypeDef,
+  UsagePeriod
+> = z.object({
+  interval: z.string(),
+  anchor: z.date().transform(v => v.toISOString()).optional(),
+});
+
+export function usagePeriodToJSON(usagePeriod: UsagePeriod): string {
+  return JSON.stringify(UsagePeriod$outboundSchema.parse(usagePeriod));
+}
+
+/** @internal */
+export type EntitlementTemplateMetered$Outbound = {
+  type: "metered";
+  usagePeriod: UsagePeriod$Outbound;
+  isSoftLimit?: boolean | undefined;
+  issueAfterReset?: number | undefined;
+  issueAfterResetPriority?: number | undefined;
+  preserveOverageAtReset?: boolean | undefined;
+  resetMaxRollover?: number | undefined;
+  resetMinRollover?: number | undefined;
+};
+
+/** @internal */
+export const EntitlementTemplateMetered$outboundSchema: z.ZodType<
+  EntitlementTemplateMetered$Outbound,
+  z.ZodTypeDef,
+  EntitlementTemplateMetered
+> = z.object({
+  type: z.literal("metered"),
+  usagePeriod: z.lazy(() => UsagePeriod$outboundSchema),
+  isSoftLimit: z.boolean().optional(),
+  issueAfterReset: z.number().optional(),
+  issueAfterResetPriority: z.number().int().optional(),
+  preserveOverageAtReset: z.boolean().optional(),
+  resetMaxRollover: z.number().optional(),
+  resetMinRollover: z.number().optional(),
+});
+
+export function entitlementTemplateMeteredToJSON(
+  entitlementTemplateMetered: EntitlementTemplateMetered,
+): string {
+  return JSON.stringify(
+    EntitlementTemplateMetered$outboundSchema.parse(entitlementTemplateMetered),
+  );
+}
+
+/** @internal */
+export type EntitlementTemplateStatic$Outbound = {
+  type: "static";
+  config: { [k: string]: any };
+};
+
+/** @internal */
+export const EntitlementTemplateStatic$outboundSchema: z.ZodType<
+  EntitlementTemplateStatic$Outbound,
+  z.ZodTypeDef,
+  EntitlementTemplateStatic
+> = z.object({
+  type: z.literal("static"),
+  config: z.record(z.any()),
+});
+
+export function entitlementTemplateStaticToJSON(
+  entitlementTemplateStatic: EntitlementTemplateStatic,
+): string {
+  return JSON.stringify(
+    EntitlementTemplateStatic$outboundSchema.parse(entitlementTemplateStatic),
+  );
+}
+
+/** @internal */
+export type EntitlementTemplateBoolean$Outbound = {
+  type: "boolean";
+};
+
+/** @internal */
+export const EntitlementTemplateBoolean$outboundSchema: z.ZodType<
+  EntitlementTemplateBoolean$Outbound,
+  z.ZodTypeDef,
+  EntitlementTemplateBoolean
+> = z.object({
+  type: z.literal("boolean"),
+});
+
+export function entitlementTemplateBooleanToJSON(
+  entitlementTemplateBoolean: EntitlementTemplateBoolean,
+): string {
+  return JSON.stringify(
+    EntitlementTemplateBoolean$outboundSchema.parse(entitlementTemplateBoolean),
+  );
+}
+
+/** @internal */
+export type EntitlementTemplate$Outbound =
+  | EntitlementTemplateBoolean$Outbound
+  | EntitlementTemplateStatic$Outbound
+  | EntitlementTemplateMetered$Outbound;
+
+/** @internal */
+export const EntitlementTemplate$outboundSchema: z.ZodType<
+  EntitlementTemplate$Outbound,
+  z.ZodTypeDef,
+  EntitlementTemplate
+> = z.union([
+  z.lazy(() => EntitlementTemplateBoolean$outboundSchema),
+  z.lazy(() => EntitlementTemplateStatic$outboundSchema),
+  z.lazy(() => EntitlementTemplateMetered$outboundSchema),
+]);
+
+export function entitlementTemplateToJSON(
+  entitlementTemplate: EntitlementTemplate,
+): string {
+  return JSON.stringify(
+    EntitlementTemplate$outboundSchema.parse(entitlementTemplate),
+  );
+}

package/src/models/eventresponse.ts

@@ -0,0 +1,60 @@
+/*
+ * 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 EventResponseObject = {
+  Event: "event",
+} as const;
+export type EventResponseObject = ClosedEnum<typeof EventResponseObject>;
+
+export type EventResponse = {
+  /**
+   * Server-generated event ID.
+   */
+  id?: string | undefined;
+  object: EventResponseObject;
+  type?: string | undefined;
+  source?: string | undefined;
+  subject?: string | undefined;
+  namespace?: string | undefined;
+  timestamp?: Date | undefined;
+  idempotencyKey?: string | undefined;
+};
+
+/** @internal */
+export const EventResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof EventResponseObject
+> = z.nativeEnum(EventResponseObject);
+
+/** @internal */
+export const EventResponse$inboundSchema: z.ZodType<
+  EventResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  object: EventResponseObject$inboundSchema.default("event"),
+  type: z.string().optional(),
+  source: z.string().optional(),
+  subject: z.string().optional(),
+  namespace: z.string().optional(),
+  timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  idempotencyKey: z.string().optional(),
+});
+
+export function eventResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<EventResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventResponse' from JSON`,
+  );
+}

package/src/models/index.ts

@@ -6,6 +6,7 @@ export * from "./activeentitlement.js";
 export * from "./address.js";
 export * from "./batchusageeventresponse.js";
 export * from "./billablemetric.js";
+export * from "./booleanentitlementdetail.js";
 export * from "./createdisputerequest.js";
 export * from "./createentitlementrequest.js";
 export * from "./createrulerequest.js";
@@ -15,12 +16,17 @@ export * from "./dispute.js";
 export * from "./disputewithcustomer.js";
 export * from "./entitlement.js";
 export * from "./entitlementaccessresult.js";
+export * from "./entitlementdetail.js";
+export * from "./entitlementtemplate.js";
+export * from "./eventresponse.js";
 export * from "./feature.js";
 export * from "./fee.js";
 export * from "./feeprice.js";
 export * from "./invoice.js";
 export * from "./invoicelineitem.js";
 export * from "./invoicelineitemsresponse.js";
+export * from "./issueentitlementrequest.js";
+export * from "./meteredentitlementdetail.js";
 export * from "./offsetpagination.js";
 export * from "./plan.js";
 export * from "./price.js";
@@ -32,11 +38,13 @@ export * from "./revenuestats.js";
 export * from "./revenuetimebucket.js";
 export * from "./revenuetimeseriesresponse.js";
 export * from "./rulecondition.js";
+export * from "./schemasentitlement.js";
 export * from "./schemasprice.js";
 export * from "./security.js";
 export * from "./source.js";
 export * from "./sourceevent.js";
 export * from "./sourcerule.js";
+export * from "./staticentitlementdetail.js";
 export * from "./subscription.js";
 export * from "./subscriptionportal.js";
 export * from "./testclock.js";