@aventurevc/api-schemas 0.8.163 → 0.8.165

package/dist/billing/catalog-tier.d.ts

@@ -8,6 +8,7 @@ declare const BillingCatalogTierSchemaDefinition: z.ZodObject<{
         limit?: number | null | undefined;
         type: "COMPANY" | "ENTITY_BRAND" | "ENTITY_VIEW" | "PERSON" | "PERSON_VIEW" | "WEB_SEARCH";
     }, import("./catalog-allowance.ts").BillingCatalogAllowanceSchemaInput>>>;
+    description: z.ZodString;
     displayName: z.ZodString;
     tier: z.ZodEnum<{
         ESSENTIAL: "ESSENTIAL";

package/dist/billing/catalog-tier.js

@@ -5,6 +5,8 @@ const BillingCatalogTierSchemaDefinition = z.object({
     /** Researchly AI credits per Researchly billing period; 0 withholds them and absent means uncapped. */
     aiCreditLimit: z.int().nullish(),
     allowance: z.array(BillingCatalogAllowanceSchema),
+    /** Who the tier is for, in one or two sentences; it states no caps or prices, which allowance and plan carry. */
+    description: z.string(),
     displayName: z.string(),
     tier: z.enum(["ESSENTIAL", "PLUS", "PRO", "UNLIMITED"]),
 });

package/dist/billing/catalog.d.ts

@@ -40,6 +40,7 @@ declare const BillingCatalogSchemaDefinition: z.ZodObject<{
             limit?: number | null | undefined;
             type: "COMPANY" | "ENTITY_BRAND" | "ENTITY_VIEW" | "PERSON" | "PERSON_VIEW" | "WEB_SEARCH";
         }[];
+        description: string;
         displayName: string;
         tier: "ESSENTIAL" | "PLUS" | "PRO" | "UNLIMITED";
     }, import("./catalog-tier.ts").BillingCatalogTierSchemaInput, z.core.$ZodTypeInternals<{
@@ -48,6 +49,7 @@ declare const BillingCatalogSchemaDefinition: z.ZodObject<{
             limit?: number | null | undefined;
             type: "COMPANY" | "ENTITY_BRAND" | "ENTITY_VIEW" | "PERSON" | "PERSON_VIEW" | "WEB_SEARCH";
         }[];
+        description: string;
         displayName: string;
         tier: "ESSENTIAL" | "PLUS" | "PRO" | "UNLIMITED";
     }, import("./catalog-tier.ts").BillingCatalogTierSchemaInput>>>;

package/dist/billing/payment-method.d.ts

@@ -3,13 +3,17 @@ import { z } from "zod/v4";
  * Card on file that pays the subscription.
  *
  * @openapiSchema BillingPaymentMethod
+ * @endpoint GET /v1/billing/subscription/payment-profile
  * @endpoint POST /v1/billing/plan-change-previews
+ * @usedBySchema BillingPaymentProfileSchema
  * @usedBySchema BillingPlanChangePreviewSchema
  * @contractShape billing.payment-method
  * @contractRole canonical
  */
 export declare const BillingPaymentMethodSchema: z.ZodObject<{
     brand: z.ZodString;
+    expiryMonth: z.ZodInt;
+    expiryYear: z.ZodInt;
     last4: z.ZodString;
 }, z.core.$strip>;
 export type BillingPaymentMethod = z.infer<typeof BillingPaymentMethodSchema>;

package/dist/billing/payment-method.js

@@ -4,7 +4,9 @@ import { z } from "zod/v4";
  * Card on file that pays the subscription.
  *
  * @openapiSchema BillingPaymentMethod
+ * @endpoint GET /v1/billing/subscription/payment-profile
  * @endpoint POST /v1/billing/plan-change-previews
+ * @usedBySchema BillingPaymentProfileSchema
  * @usedBySchema BillingPlanChangePreviewSchema
  * @contractShape billing.payment-method
  * @contractRole canonical
@@ -12,6 +14,10 @@ import { z } from "zod/v4";
 export const BillingPaymentMethodSchema = z.object({
     /** Card brand as Stripe reports it */
     brand: z.string(),
+    /** Expiry month, 1 through 12 */
+    expiryMonth: z.int(),
+    /** Four-digit expiry year */
+    expiryYear: z.int(),
     /** Last four digits of the card number */
     last4: z.string(),
 });

package/dist/billing/payment-profile.d.ts

@@ -0,0 +1,25 @@
+import { z } from "zod/v4";
+declare const BillingPaymentProfileSchemaDefinition: z.ZodObject<{
+    introductoryOfferEligible: z.ZodBoolean;
+    paymentMethod: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        brand: z.ZodString;
+        expiryMonth: z.ZodInt;
+        expiryYear: z.ZodInt;
+        last4: z.ZodString;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+type BillingPaymentProfileDefinition = z.infer<typeof BillingPaymentProfileSchemaDefinition>;
+export interface BillingPaymentProfileSchemaInput extends z.input<typeof BillingPaymentProfileSchemaDefinition> {
+}
+/**
+ * The caller's card on file and whether Checkout would charge each plan's introductoryAmount on the first payment, read live from Stripe.
+ *
+ * @openapiSchema BillingPaymentProfile
+ * @endpoint GET /v1/billing/subscription/payment-profile
+ * @contractShape billing.payment-profile
+ * @contractRole canonical
+ */
+export declare const BillingPaymentProfileSchema: z.ZodType<BillingPaymentProfileDefinition, BillingPaymentProfileSchemaInput>;
+export type BillingPaymentProfile = z.infer<typeof BillingPaymentProfileSchema>;
+export {};
+//# sourceMappingURL=payment-profile.d.ts.map

package/dist/billing/payment-profile.js

@@ -0,0 +1,19 @@
+// LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
+import { z } from "zod/v4";
+import { BillingPaymentMethodSchema } from "./payment-method.js";
+const BillingPaymentProfileSchemaDefinition = z.object({
+    /** True when the catalog offers introductoryAmount, the App Store does not bill the account, and it has no earlier subscription, payment, or unvoided invoice; false otherwise */
+    introductoryOfferEligible: z.boolean(),
+    /** Card that pays the continuing Stripe subscription; absent without one or when it is paid by something other than a card */
+    paymentMethod: BillingPaymentMethodSchema.nullish(),
+});
+/**
+ * The caller's card on file and whether Checkout would charge each plan's introductoryAmount on the first payment, read live from Stripe.
+ *
+ * @openapiSchema BillingPaymentProfile
+ * @endpoint GET /v1/billing/subscription/payment-profile
+ * @contractShape billing.payment-profile
+ * @contractRole canonical
+ */
+export const BillingPaymentProfileSchema = BillingPaymentProfileSchemaDefinition;
+//# sourceMappingURL=payment-profile.js.map

package/dist/billing/plan-change-preview.d.ts

@@ -5,6 +5,8 @@ declare const BillingPlanChangePreviewSchemaDefinition: z.ZodObject<{
     effectiveAt: z.ZodISODateTime;
     paymentMethod: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         brand: z.ZodString;
+        expiryMonth: z.ZodInt;
+        expiryYear: z.ZodInt;
         last4: z.ZodString;
     }, z.core.$strip>>>;
     prorationDate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;

package/dist/billing/subscription-mutation.d.ts

@@ -1,12 +1,13 @@
 import { z } from "zod/v4";
 declare const BillingSubscriptionMutationSchemaDefinition: z.ZodObject<{
     cancelAtPeriodEnd: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    paused: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
 }, z.core.$strip>;
 type BillingSubscriptionMutationDefinition = z.infer<typeof BillingSubscriptionMutationSchemaDefinition>;
 export interface BillingSubscriptionMutationSchemaInput extends z.input<typeof BillingSubscriptionMutationSchemaDefinition> {
 }
 /**
- * Merge patch of a continuing AI Plus or AI Pro subscription: cancel it at the period end or resume it.
+ * Merge patch of a continuing AI Plus or AI Pro subscription: cancel it at the period end or resume it, including one Stripe paused.
  *
  * @openapiSchema BillingSubscriptionMutation
  * @endpoint PATCH /v1/billing/subscription

package/dist/billing/subscription-mutation.js

@@ -3,9 +3,11 @@ import { z } from "zod/v4";
 const BillingSubscriptionMutationSchemaDefinition = z.object({
     /** true ends the subscription at the current period end and drops a scheduled plan change; false resumes it and restores the plan change scheduled before the cancellation. Omit to change nothing. */
     cancelAtPeriodEnd: z.boolean().nullish(),
+    /** false resumes a subscription Stripe paused because its trial ended without a payment method; add one with POST /v1/billing/portal-sessions first. The resumption starts a new billing period now and charges the plan to that card; a declined or authentication-held charge answers 409. true, or cancelAtPeriodEnd in the same request, is refused. Omit to change nothing. */
+    paused: z.boolean().nullish(),
 });
 /**
- * Merge patch of a continuing AI Plus or AI Pro subscription: cancel it at the period end or resume it.
+ * Merge patch of a continuing AI Plus or AI Pro subscription: cancel it at the period end or resume it, including one Stripe paused.
  *
  * @openapiSchema BillingSubscriptionMutation
  * @endpoint PATCH /v1/billing/subscription

package/dist/billing/subscription.d.ts

@@ -155,6 +155,7 @@ declare const BillingSubscriptionSchemaDefinition: z.ZodObject<{
         };
     }, import("../research/allowance-usage.ts").ResearchAllowanceUsageSchemaInput>>;
     cancelAtPeriodEnd: z.ZodBoolean;
+    creditPurchasable: z.ZodBoolean;
     entitled: z.ZodBoolean;
     originalStart: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
     pendingPlan: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{

package/dist/billing/subscription.js

@@ -10,6 +10,8 @@ const BillingSubscriptionSchemaDefinition = z.object({
     allowance: ResearchAllowanceUsageSchema,
     /** True when the plan is cancelled and ends at periodEnd */
     cancelAtPeriodEnd: z.boolean(),
+    /** True when POST /v1/billing/credit-purchases sells this account a prepaid credit pack; false for an operator, a plan the App Store bills, an Unlimited plan, or a continuing paid plan that is not entitled (INCOMPLETE, PAST_DUE, UNPAID, or PAUSED) */
+    creditPurchasable: z.boolean(),
     /** True while the subscription grants its paid tier */
     entitled: z.boolean(),
     /** Original start of the continuing paid subscription; absent when the provider did not supply it */

package/dist/entity/text.js

@@ -8,7 +8,9 @@ const EntityTextSchemaDefinition = z.object({
     createdAt: z.iso.datetime({ offset: true }).nullish(),
     /** Type-safe identifier for text records */
     id: z.int(),
+    /** Whether this is the owner's current text of its textType; setting it clears the flag on the owner's other texts of that type. */
     isCurrent: z.boolean().nullish(),
+    /** Whether this is the owner's primary text of its textType; setting it clears the flag on the owner's other texts of that type. */
     isPrimary: z.boolean().nullish(),
     language: z.string().nullish(),
     /** Owning record, nested ids only: owner.entityId or owner.personId — exactly one is set, and no name fields. Writes are scoped by the owning entity/person route; owner is never a write field. */

package/dist/http/problem-detail.js

@@ -28,7 +28,7 @@ const ProblemDetailSchemaDefinition = z.object({
             "subscription_canceled",
             /** Caller's subscription has a failed or unfinished payment, so it does not include this operation until the payment succeeds. Agent action: surface ProblemDetail.detail and stop; the account must update its payment method through the resolution's Billing Portal endpoint. */
             "subscription_past_due",
-            /** Caller's subscription is paused, so it does not include this operation. Agent action: surface ProblemDetail.detail and stop; the account must resume the subscription through the resolution's Billing Portal endpoint. */
+            /** Caller's subscription is paused, so it does not include this operation. Agent action: surface ProblemDetail.detail and stop; the account must add a payment method through the resolution's Billing Portal endpoint, then resume with PATCH /v1/billing/subscription and paused false. */
             "subscription_paused",
             /** The caller's metered allowance for this operation is spent for the current period. Agent action: stop and report ProblemDetail.allowanceType, limit, used, remaining, and resetAt; resetAt is when the meter refills and is typically weeks away. Do not retry inside the period even though the status is 429. */
             "billing_allowance_exhausted",

package/dist/openapi-component-manifest.js

@@ -113,6 +113,10 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
         modulePath: "billing/payment-method",
         schemaName: "BillingPaymentMethodSchema",
     },
+    BillingPaymentProfile: {
+        modulePath: "billing/payment-profile",
+        schemaName: "BillingPaymentProfileSchema",
+    },
     BillingPlanChange: { modulePath: "billing/plan-change", schemaName: "BillingPlanChangeSchema" },
     BillingPlanChangeMutation: {
         modulePath: "billing/plan-change-mutation",

package/dist/research/paragraph-shape.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod/v4";
 /**
- * Write-time per-paragraph shape rule for governed text bodies. Paragraphs split on `\n\n` (one blank line). Each paragraph must satisfy minChars..maxChars and minSentences..maxSentences; whole body must satisfy minParagraphs..maxParagraphs (null maxParagraphs = unbounded). Sentence boundaries follow Unicode rules (java.text.BreakIterator), so 'Inc.' and 'U.S.' do not split a sentence.
+ * Write-time per-paragraph shape rule for governed text bodies. Paragraphs split on `\n\n` (one blank line). Each paragraph must satisfy minChars..maxChars and minSentences..maxSentences; whole body must satisfy minParagraphs..maxParagraphs (null maxParagraphs = unbounded). Sentence boundaries follow Unicode rules (java.text.BreakIterator), so 'Inc.' and 'U.S.' do not split a sentence. Each paragraph ends in terminal punctuation (. ! ? or the CJK full stop, exclamation, and question marks), optionally followed by a closing quote, parenthesis, bracket, or guillemet.
  *
  * @openapiSchema ResearchParagraphShape
  * @endpoint GET /v1/entities/research-snippets/types

package/dist/research/paragraph-shape.js

@@ -1,7 +1,7 @@
 // LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
 import { z } from "zod/v4";
 /**
- * Write-time per-paragraph shape rule for governed text bodies. Paragraphs split on `\n\n` (one blank line). Each paragraph must satisfy minChars..maxChars and minSentences..maxSentences; whole body must satisfy minParagraphs..maxParagraphs (null maxParagraphs = unbounded). Sentence boundaries follow Unicode rules (java.text.BreakIterator), so 'Inc.' and 'U.S.' do not split a sentence.
+ * Write-time per-paragraph shape rule for governed text bodies. Paragraphs split on `\n\n` (one blank line). Each paragraph must satisfy minChars..maxChars and minSentences..maxSentences; whole body must satisfy minParagraphs..maxParagraphs (null maxParagraphs = unbounded). Sentence boundaries follow Unicode rules (java.text.BreakIterator), so 'Inc.' and 'U.S.' do not split a sentence. Each paragraph ends in terminal punctuation (. ! ? or the CJK full stop, exclamation, and question marks), optionally followed by a closing quote, parenthesis, bracket, or guillemet.
  *
  * @openapiSchema ResearchParagraphShape
  * @endpoint GET /v1/entities/research-snippets/types

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aventurevc/api-schemas",
-  "version": "0.8.163",
+  "version": "0.8.165",
   "private": false,
   "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
   "license": "Apache-2.0",