@paygentic/sdk 0.10.3 → 0.10.5

package/src/models/mecredential.ts

@@ -0,0 +1,58 @@
+/*
+ * 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 MeCredentialType = {
+  Session: "session",
+  ApiKey: "apiKey",
+  Oauth: "oauth",
+  System: "system",
+} as const;
+export type MeCredentialType = ClosedEnum<typeof MeCredentialType>;
+
+/**
+ * The credential of the call. clientId is set for an OAuth token and apiKeyId for an API key.
+ */
+export type MeCredential = {
+  type: MeCredentialType;
+  /**
+   * The OAuth client of the token.
+   */
+  clientId?: string | undefined;
+  /**
+   * The API key of the call.
+   */
+  apiKeyId?: string | undefined;
+};
+
+/** @internal */
+export const MeCredentialType$inboundSchema: z.ZodNativeEnum<
+  typeof MeCredentialType
+> = z.nativeEnum(MeCredentialType);
+
+/** @internal */
+export const MeCredential$inboundSchema: z.ZodType<
+  MeCredential,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: MeCredentialType$inboundSchema,
+  clientId: z.string().optional(),
+  apiKeyId: z.string().optional(),
+});
+
+export function meCredentialFromJSON(
+  jsonString: string,
+): SafeParseResult<MeCredential, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MeCredential$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MeCredential' from JSON`,
+  );
+}

package/src/models/operations/createsubscription.ts

@@ -130,7 +130,7 @@ export type CreateSubscriptionRequest = {
    */
   metadata?: { [k: string]: models.SubscriptionMetadata } | undefined;
   /**
-   * Why a change was made. `correction` fixes data to match what was agreed; `migration` moves a contract from another system; `commercial` is a real change to the deal. Defaults to `unspecified`.
+   * Why a change was made. `correction` repairs data that was entered wrong; `migration` moves a contract from another system; `commercial` is a real change to the deal; `contractual` applies a step the original contract scheduled, such as an annual uplift. Defaults to `unspecified`.
    */
   changeReason?: models.ChangeReason | undefined;
   /**

package/src/models/operations/terminatesubscription.ts

@@ -12,7 +12,7 @@ export type TerminateSubscriptionRequestBody = {
    */
   reason: string;
   /**
-   * Why a change was made. `correction` fixes data to match what was agreed; `migration` moves a contract from another system; `commercial` is a real change to the deal. Defaults to `unspecified`.
+   * Why a change was made. `correction` repairs data that was entered wrong; `migration` moves a contract from another system; `commercial` is a real change to the deal; `contractual` applies a step the original contract scheduled, such as an annual uplift. Defaults to `unspecified`.
    */
   changeReason?: models.ChangeReason | undefined;
 };

package/src/models/operations/updateprice.ts

@@ -5,23 +5,10 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 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 * as models from "../index.js";
 
-/**
- * Billing timing preference: 'in_advance' (prepaid — charged upfront or drawn from a prepaid commitment) or 'in_arrears' (charged at period end).
- */
-export const UpdatePricePaymentTerm = {
-  InArrears: "in_arrears",
-  InAdvance: "in_advance",
-} as const;
-/**
- * Billing timing preference: 'in_advance' (prepaid — charged upfront or drawn from a prepaid commitment) or 'in_arrears' (charged at period end).
- */
-export type UpdatePricePaymentTerm = ClosedEnum<typeof UpdatePricePaymentTerm>;
-
 export type UpdatePriceRequestBody = {
   /**
    * Unique identifier for a billable metric
@@ -44,14 +31,6 @@ export type UpdatePriceRequestBody = {
    */
   model?: models.PriceModelInput | undefined;
   properties?: models.PriceProperties | undefined;
-  /**
-   * Billing timing preference: 'in_advance' (prepaid — charged upfront or drawn from a prepaid commitment) or 'in_arrears' (charged at period end).
-   */
-  paymentTerm?: UpdatePricePaymentTerm | undefined;
-  /**
-   * ISO 8601 duration for recurring fees (e.g., 'P1M' for monthly, 'P1Y' for yearly, or 'P0D' for one-time)
-   */
-  billingCadence?: string | null | undefined;
   /**
    * Feature to associate. Set to null to remove existing feature. Omit to leave unchanged.
    */
@@ -92,11 +71,6 @@ export type UpdatePriceDetails = {
   subscriptionCount?: number | undefined;
 };
 
-/** @internal */
-export const UpdatePricePaymentTerm$outboundSchema: z.ZodNativeEnum<
-  typeof UpdatePricePaymentTerm
-> = z.nativeEnum(UpdatePricePaymentTerm);
-
 /** @internal */
 export type UpdatePriceRequestBody$Outbound = {
   billableMetricId?: string | undefined;
@@ -105,8 +79,6 @@ export type UpdatePriceRequestBody$Outbound = {
   invoiceDisplayGroup?: string | null | undefined;
   model?: string | undefined;
   properties?: models.PriceProperties$Outbound | undefined;
-  paymentTerm?: string | undefined;
-  billingCadence?: string | null | undefined;
   feature?: models.PriceFeatureInput$Outbound | null | undefined;
   grantDiscountEnabled?: boolean | undefined;
   isObligation?: boolean | undefined;
@@ -127,8 +99,6 @@ export const UpdatePriceRequestBody$outboundSchema: z.ZodType<
   invoiceDisplayGroup: z.nullable(z.string()).optional(),
   model: models.PriceModelInput$outboundSchema.optional(),
   properties: models.PriceProperties$outboundSchema.optional(),
-  paymentTerm: UpdatePricePaymentTerm$outboundSchema.optional(),
-  billingCadence: z.nullable(z.string()).optional(),
   feature: z.nullable(models.PriceFeatureInput$outboundSchema).optional(),
   grantDiscountEnabled: z.boolean().optional(),
   isObligation: z.boolean().optional(),

package/src/models/outstandingblock.ts

@@ -9,7 +9,7 @@ import { AccountFigure, AccountFigure$inboundSchema } from "./accountfigure.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
 /**
- * What is owed, gross of tax, from any date. `awaitingPayment` and `paymentFailed` add up to it, in count and amount.
+ * What is owed, gross of tax, from any date. `awaitingPayment` and `paymentFailed` add up to it, in count and amount. `overdue` is a part of `awaitingPayment`.
  */
 export type OutstandingBlock = {
   /**
@@ -28,6 +28,10 @@ export type OutstandingBlock = {
    * The part with status `PAYMENT_FAILED`: collection has ended
    */
   paymentFailed: AccountFigure;
+  /**
+   * The invoices of `awaitingPayment` past their due date: status `ISSUED`, no card retry scheduled, and a due date before the start of today, UTC. Today is the subscription's test clock when test clocks are enabled. A subset of `awaitingPayment` by count. A credit invoice is never overdue, so the amount can exceed `awaitingPayment.amount`.
+   */
+  overdue: AccountFigure;
 };
 
 /** @internal */
@@ -40,6 +44,7 @@ export const OutstandingBlock$inboundSchema: z.ZodType<
   amount: z.string(),
   awaitingPayment: AccountFigure$inboundSchema,
   paymentFailed: AccountFigure$inboundSchema,
+  overdue: AccountFigure$inboundSchema,
 });
 
 export function outstandingBlockFromJSON(

package/src/models/permission.ts

@@ -0,0 +1,123 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * A permission of the catalog: a resource read or write, or a sensitive action.
+ */
+export const Permission = {
+  OrganizationRead: "organization:read",
+  MembersRead: "members:read",
+  ProfileRead: "profile:read",
+  ApiKeysRead: "apiKeys:read",
+  MerchantsRead: "merchants:read",
+  ConsumersRead: "consumers:read",
+  CustomersRead: "customers:read",
+  PlansRead: "plans:read",
+  PricesRead: "prices:read",
+  ProductsRead: "products:read",
+  FeaturesRead: "features:read",
+  FeesRead: "fees:read",
+  BillableMetricsRead: "billableMetrics:read",
+  ItemsRead: "items:read",
+  PricingUnitsRead: "pricingUnits:read",
+  SubscriptionsRead: "subscriptions:read",
+  SubscriptionAdjustmentsRead: "subscriptionAdjustments:read",
+  DiscountsRead: "discounts:read",
+  GrantsRead: "grants:read",
+  EntitlementsRead: "entitlements:read",
+  CreditPoolsRead: "creditPools:read",
+  OrdersRead: "orders:read",
+  BillingSchedulesRead: "billingSchedules:read",
+  InvoicesRead: "invoices:read",
+  PaymentsRead: "payments:read",
+  PaymentSessionsRead: "paymentSessions:read",
+  PortalSessionsRead: "portalSessions:read",
+  PlatformUsersRead: "platformUsers:read",
+  PlatformAdminRead: "platformAdmin:read",
+  LoginLockoutRead: "loginLockout:read",
+  PlatformSystemRead: "platformSystem:read",
+  OrganizationCreationRead: "organizationCreation:read",
+  ComplianceRead: "compliance:read",
+  TaxSettingsRead: "taxSettings:read",
+  CostsRead: "costs:read",
+  PaymentAccountsRead: "paymentAccounts:read",
+  PayoutsRead: "payouts:read",
+  ExternalAccountsRead: "externalAccounts:read",
+  ExternalReferencesRead: "externalReferences:read",
+  MerchantIntegrationsRead: "merchantIntegrations:read",
+  WebhooksRead: "webhooks:read",
+  TestClocksRead: "testClocks:read",
+  ApprovalsRead: "approvals:read",
+  SourcesRead: "sources:read",
+  RevenueRead: "revenue:read",
+  OrganizationWrite: "organization:write",
+  MembersWrite: "members:write",
+  ProfileWrite: "profile:write",
+  ApiKeysWrite: "apiKeys:write",
+  MerchantsWrite: "merchants:write",
+  ConsumersWrite: "consumers:write",
+  CustomersWrite: "customers:write",
+  PlansWrite: "plans:write",
+  PricesWrite: "prices:write",
+  ProductsWrite: "products:write",
+  FeaturesWrite: "features:write",
+  FeesWrite: "fees:write",
+  BillableMetricsWrite: "billableMetrics:write",
+  ItemsWrite: "items:write",
+  PricingUnitsWrite: "pricingUnits:write",
+  SubscriptionsWrite: "subscriptions:write",
+  SubscriptionAdjustmentsWrite: "subscriptionAdjustments:write",
+  DiscountsWrite: "discounts:write",
+  GrantsWrite: "grants:write",
+  EntitlementsWrite: "entitlements:write",
+  CreditPoolsWrite: "creditPools:write",
+  OrdersWrite: "orders:write",
+  BillingSchedulesWrite: "billingSchedules:write",
+  InvoicesWrite: "invoices:write",
+  PaymentsWrite: "payments:write",
+  PaymentSessionsWrite: "paymentSessions:write",
+  PortalSessionsWrite: "portalSessions:write",
+  PlatformUsersWrite: "platformUsers:write",
+  PlatformAdminWrite: "platformAdmin:write",
+  LoginLockoutWrite: "loginLockout:write",
+  PlatformSystemWrite: "platformSystem:write",
+  OrganizationCreationWrite: "organizationCreation:write",
+  ComplianceWrite: "compliance:write",
+  TaxSettingsWrite: "taxSettings:write",
+  CostsWrite: "costs:write",
+  PaymentAccountsWrite: "paymentAccounts:write",
+  PayoutsWrite: "payouts:write",
+  ExternalAccountsWrite: "externalAccounts:write",
+  ExternalReferencesWrite: "externalReferences:write",
+  MerchantIntegrationsWrite: "merchantIntegrations:write",
+  WebhooksWrite: "webhooks:write",
+  TestClocksWrite: "testClocks:write",
+  ApprovalsWrite: "approvals:write",
+  SourcesWrite: "sources:write",
+  EventsWrite: "events:write",
+  InvoicesIssue: "invoices:issue",
+  InvoicesVoid: "invoices:void",
+  PaymentsRefund: "payments:refund",
+  OrganizationDelete: "organization:delete",
+  OwnershipTransfer: "ownership:transfer",
+  SubscriptionsTerminate: "subscriptions:terminate",
+  SubscriptionsTerminateWithReason: "subscriptions:terminateWithReason",
+  SubscriptionsReconcile: "subscriptions:reconcile",
+  SubscriptionsUpdate: "subscriptions:update",
+  SubscriptionsDelete: "subscriptions:delete",
+  SubscriptionsTaxExempt: "subscriptions:taxExempt",
+  SubscriptionsAutoApprove: "subscriptions:autoApprove",
+  OrganizationResetData: "organization:resetData",
+} as const;
+/**
+ * A permission of the catalog: a resource read or write, or a sensitive action.
+ */
+export type Permission = ClosedEnum<typeof Permission>;
+
+/** @internal */
+export const Permission$inboundSchema: z.ZodNativeEnum<typeof Permission> = z
+  .nativeEnum(Permission);

package/src/models/revenueaccountrow.ts

@@ -25,7 +25,7 @@ export type RevenueAccountRow = {
    */
   currency: string;
   /**
-   * What is owed, gross of tax, from any date. `awaitingPayment` and `paymentFailed` add up to it, in count and amount.
+   * What is owed, gross of tax, from any date. `awaitingPayment` and `paymentFailed` add up to it, in count and amount. `overdue` is a part of `awaitingPayment`.
    */
   outstanding: OutstandingBlock;
 };

package/src/models/revenueaccounttotal.ts

@@ -17,7 +17,7 @@ export type RevenueAccountTotal = {
    */
   currency: string;
   /**
-   * What is owed, gross of tax, from any date. `awaitingPayment` and `paymentFailed` add up to it, in count and amount.
+   * What is owed, gross of tax, from any date. `awaitingPayment` and `paymentFailed` add up to it, in count and amount. `overdue` is a part of `awaitingPayment`.
    */
   outstanding: OutstandingBlock;
 };

package/src/models/subscription.ts

@@ -136,6 +136,7 @@ export const TerminationChangeReason = {
   Correction: "correction",
   Migration: "migration",
   Unspecified: "unspecified",
+  Contractual: "contractual",
 } as const;
 /**
  * Why the subscription was terminated. Null while it is not terminated.

package/src/models/subscriptionintervalchange.ts

@@ -24,7 +24,7 @@ export type SubscriptionIntervalChange = {
   merchantId: string;
   subscriptionId: string;
   /**
-   * Why a change was made. `correction` fixes data to match what was agreed; `migration` moves a contract from another system; `commercial` is a real change to the deal. Defaults to `unspecified`.
+   * Why a change was made. `correction` repairs data that was entered wrong; `migration` moves a contract from another system; `commercial` is a real change to the deal; `contractual` applies a step the original contract scheduled, such as an annual uplift. Defaults to `unspecified`.
    */
   changeReason: ChangeReason;
   description: string | null;

package/src/sdk/me.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { meGetMe } from "../funcs/meGetMe.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Me extends ClientSDK {
+  /**
+   * Get the caller
+   *
+   * @remarks
+   * Returns the caller's identity in its active organization, its roles, and the permissions that its credential holds there. The permissions are the effective set for the credential of the call: for a session or an API key, those of the principal; for an OAuth token, those of the principal narrowed to the scopes of the token.
+   */
+  async getMe(
+    options?: RequestOptions,
+  ): Promise<models.Me> {
+    return unwrapAsync(meGetMe(
+      this,
+      options,
+    ));
+  }
+}

package/src/sdk/prices.ts

@@ -57,6 +57,9 @@ export class Prices extends ClientSDK {
 
   /**
    * Update
+   *
+   * @remarks
+   * Updates a price. `paymentTerm` and `billingCadence` are fixed when the price is created: a request that sends either one is refused with a 400. To change them, create a new price.
    */
   async update(
     request: operations.UpdatePriceRequest,

package/src/sdk/sdk.ts

@@ -15,6 +15,7 @@ import { Features } from "./features.js";
 import { Fees } from "./fees.js";
 import { InvoicesV2 } from "./invoicesv2.js";
 import { Items } from "./items.js";
+import { Me } from "./me.js";
 import { MerchantIntegrations } from "./merchantintegrations.js";
 import { Merchants } from "./merchants.js";
 import { Orders } from "./orders.js";
@@ -33,6 +34,11 @@ import { Users } from "./users.js";
 import { Webhooks } from "./webhooks.js";
 
 export class Paygentic extends ClientSDK {
+  private _me?: Me;
+  get me(): Me {
+    return (this._me ??= new Me(this._options));
+  }
+
   private _billableMetrics?: BillableMetrics;
   get billableMetrics(): BillableMetrics {
     return (this._billableMetrics ??= new BillableMetrics(this._options));