@aventurevc/api-schemas 0.8.161 → 0.8.164

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -11,6 +11,7 @@ declare const BillingCatalogPlanSchemaDefinition: z.ZodObject<{
11
11
  PRO_MONTHLY: "PRO_MONTHLY";
12
12
  PRO_YEARLY: "PRO_YEARLY";
13
13
  PRO_YEARLY_PROMOTION: "PRO_YEARLY_PROMOTION";
14
+ UNLIMITED_MONTHLY: "UNLIMITED_MONTHLY";
14
15
  }>, z.ZodString]>;
15
16
  tier: z.ZodEnum<{
16
17
  ESSENTIAL: "ESSENTIAL";
@@ -8,6 +8,7 @@ declare const BillingCatalogTierSchemaDefinition: z.ZodObject<{
8
8
  limit?: number | null | undefined;
9
9
  type: "COMPANY" | "ENTITY_BRAND" | "ENTITY_VIEW" | "PERSON" | "PERSON_VIEW" | "WEB_SEARCH";
10
10
  }, import("./catalog-allowance.ts").BillingCatalogAllowanceSchemaInput>>>;
11
+ description: z.ZodString;
11
12
  displayName: z.ZodString;
12
13
  tier: z.ZodEnum<{
13
14
  ESSENTIAL: "ESSENTIAL";
@@ -5,6 +5,8 @@ const BillingCatalogTierSchemaDefinition = z.object({
5
5
  /** Researchly AI credits per Researchly billing period; 0 withholds them and absent means uncapped. */
6
6
  aiCreditLimit: z.int().nullish(),
7
7
  allowance: z.array(BillingCatalogAllowanceSchema),
8
+ /** Who the tier is for, in one or two sentences; it states no caps or prices, which allowance and plan carry. */
9
+ description: z.string(),
8
10
  displayName: z.string(),
9
11
  tier: z.enum(["ESSENTIAL", "PLUS", "PRO", "UNLIMITED"]),
10
12
  });
@@ -40,6 +40,7 @@ declare const BillingCatalogSchemaDefinition: z.ZodObject<{
40
40
  limit?: number | null | undefined;
41
41
  type: "COMPANY" | "ENTITY_BRAND" | "ENTITY_VIEW" | "PERSON" | "PERSON_VIEW" | "WEB_SEARCH";
42
42
  }[];
43
+ description: string;
43
44
  displayName: string;
44
45
  tier: "ESSENTIAL" | "PLUS" | "PRO" | "UNLIMITED";
45
46
  }, import("./catalog-tier.ts").BillingCatalogTierSchemaInput, z.core.$ZodTypeInternals<{
@@ -48,6 +49,7 @@ declare const BillingCatalogSchemaDefinition: z.ZodObject<{
48
49
  limit?: number | null | undefined;
49
50
  type: "COMPANY" | "ENTITY_BRAND" | "ENTITY_VIEW" | "PERSON" | "PERSON_VIEW" | "WEB_SEARCH";
50
51
  }[];
52
+ description: string;
51
53
  displayName: string;
52
54
  tier: "ESSENTIAL" | "PLUS" | "PRO" | "UNLIMITED";
53
55
  }, import("./catalog-tier.ts").BillingCatalogTierSchemaInput>>>;
@@ -6,6 +6,7 @@ declare const BillingCheckoutMutationSchemaDefinition: z.ZodObject<{
6
6
  PRO_MONTHLY: "PRO_MONTHLY";
7
7
  PRO_YEARLY: "PRO_YEARLY";
8
8
  PRO_YEARLY_PROMOTION: "PRO_YEARLY_PROMOTION";
9
+ UNLIMITED_MONTHLY: "UNLIMITED_MONTHLY";
9
10
  }>, z.ZodString]>;
10
11
  uiMode: z.ZodOptional<z.ZodEnum<{
11
12
  ELEMENTS: "ELEMENTS";
@@ -8,6 +8,7 @@ declare const BillingCheckoutSchemaDefinition: z.ZodObject<{
8
8
  PRO_MONTHLY: "PRO_MONTHLY";
9
9
  PRO_YEARLY: "PRO_YEARLY";
10
10
  PRO_YEARLY_PROMOTION: "PRO_YEARLY_PROMOTION";
11
+ UNLIMITED_MONTHLY: "UNLIMITED_MONTHLY";
11
12
  }>, z.ZodString]>;
12
13
  publishableKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
13
14
  url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -3,13 +3,17 @@ import { z } from "zod/v4";
3
3
  * Card on file that pays the subscription.
4
4
  *
5
5
  * @openapiSchema BillingPaymentMethod
6
+ * @endpoint GET /v1/billing/subscription/payment-profile
6
7
  * @endpoint POST /v1/billing/plan-change-previews
8
+ * @usedBySchema BillingPaymentProfileSchema
7
9
  * @usedBySchema BillingPlanChangePreviewSchema
8
10
  * @contractShape billing.payment-method
9
11
  * @contractRole canonical
10
12
  */
11
13
  export declare const BillingPaymentMethodSchema: z.ZodObject<{
12
14
  brand: z.ZodString;
15
+ expiryMonth: z.ZodInt;
16
+ expiryYear: z.ZodInt;
13
17
  last4: z.ZodString;
14
18
  }, z.core.$strip>;
15
19
  export type BillingPaymentMethod = z.infer<typeof BillingPaymentMethodSchema>;
@@ -4,7 +4,9 @@ import { z } from "zod/v4";
4
4
  * Card on file that pays the subscription.
5
5
  *
6
6
  * @openapiSchema BillingPaymentMethod
7
+ * @endpoint GET /v1/billing/subscription/payment-profile
7
8
  * @endpoint POST /v1/billing/plan-change-previews
9
+ * @usedBySchema BillingPaymentProfileSchema
8
10
  * @usedBySchema BillingPlanChangePreviewSchema
9
11
  * @contractShape billing.payment-method
10
12
  * @contractRole canonical
@@ -12,6 +14,10 @@ import { z } from "zod/v4";
12
14
  export const BillingPaymentMethodSchema = z.object({
13
15
  /** Card brand as Stripe reports it */
14
16
  brand: z.string(),
17
+ /** Expiry month, 1 through 12 */
18
+ expiryMonth: z.int(),
19
+ /** Four-digit expiry year */
20
+ expiryYear: z.int(),
15
21
  /** Last four digits of the card number */
16
22
  last4: z.string(),
17
23
  });
@@ -0,0 +1,25 @@
1
+ import { z } from "zod/v4";
2
+ declare const BillingPaymentProfileSchemaDefinition: z.ZodObject<{
3
+ introductoryOfferEligible: z.ZodBoolean;
4
+ paymentMethod: z.ZodOptional<z.ZodNullable<z.ZodObject<{
5
+ brand: z.ZodString;
6
+ expiryMonth: z.ZodInt;
7
+ expiryYear: z.ZodInt;
8
+ last4: z.ZodString;
9
+ }, z.core.$strip>>>;
10
+ }, z.core.$strip>;
11
+ type BillingPaymentProfileDefinition = z.infer<typeof BillingPaymentProfileSchemaDefinition>;
12
+ export interface BillingPaymentProfileSchemaInput extends z.input<typeof BillingPaymentProfileSchemaDefinition> {
13
+ }
14
+ /**
15
+ * The caller's card on file and whether Checkout would charge each plan's introductoryAmount on the first payment, read live from Stripe.
16
+ *
17
+ * @openapiSchema BillingPaymentProfile
18
+ * @endpoint GET /v1/billing/subscription/payment-profile
19
+ * @contractShape billing.payment-profile
20
+ * @contractRole canonical
21
+ */
22
+ export declare const BillingPaymentProfileSchema: z.ZodType<BillingPaymentProfileDefinition, BillingPaymentProfileSchemaInput>;
23
+ export type BillingPaymentProfile = z.infer<typeof BillingPaymentProfileSchema>;
24
+ export {};
25
+ //# sourceMappingURL=payment-profile.d.ts.map
@@ -0,0 +1,19 @@
1
+ // 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
2
+ import { z } from "zod/v4";
3
+ import { BillingPaymentMethodSchema } from "./payment-method.js";
4
+ const BillingPaymentProfileSchemaDefinition = z.object({
5
+ /** 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 */
6
+ introductoryOfferEligible: z.boolean(),
7
+ /** Card that pays the continuing Stripe subscription; absent without one or when it is paid by something other than a card */
8
+ paymentMethod: BillingPaymentMethodSchema.nullish(),
9
+ });
10
+ /**
11
+ * The caller's card on file and whether Checkout would charge each plan's introductoryAmount on the first payment, read live from Stripe.
12
+ *
13
+ * @openapiSchema BillingPaymentProfile
14
+ * @endpoint GET /v1/billing/subscription/payment-profile
15
+ * @contractShape billing.payment-profile
16
+ * @contractRole canonical
17
+ */
18
+ export const BillingPaymentProfileSchema = BillingPaymentProfileSchemaDefinition;
19
+ //# sourceMappingURL=payment-profile.js.map
@@ -6,6 +6,7 @@ declare const BillingPlanChangeMutationSchemaDefinition: z.ZodObject<{
6
6
  PRO_MONTHLY: "PRO_MONTHLY";
7
7
  PRO_YEARLY: "PRO_YEARLY";
8
8
  PRO_YEARLY_PROMOTION: "PRO_YEARLY_PROMOTION";
9
+ UNLIMITED_MONTHLY: "UNLIMITED_MONTHLY";
9
10
  }>, z.ZodString]>;
10
11
  prorationDate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
11
12
  }, z.core.$strip>;
@@ -5,6 +5,8 @@ declare const BillingPlanChangePreviewSchemaDefinition: z.ZodObject<{
5
5
  effectiveAt: z.ZodISODateTime;
6
6
  paymentMethod: z.ZodOptional<z.ZodNullable<z.ZodObject<{
7
7
  brand: z.ZodString;
8
+ expiryMonth: z.ZodInt;
9
+ expiryYear: z.ZodInt;
8
10
  last4: z.ZodString;
9
11
  }, z.core.$strip>>>;
10
12
  prorationDate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
@@ -9,6 +9,7 @@ declare const BillingPlanChangeSchemaDefinition: z.ZodObject<{
9
9
  PRO_MONTHLY: "PRO_MONTHLY";
10
10
  PRO_YEARLY: "PRO_YEARLY";
11
11
  PRO_YEARLY_PROMOTION: "PRO_YEARLY_PROMOTION";
12
+ UNLIMITED_MONTHLY: "UNLIMITED_MONTHLY";
12
13
  }>, z.ZodString]>;
13
14
  publishableKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
14
15
  }, z.core.$strip>;
@@ -23,6 +23,7 @@ export declare const BillingPlanTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
23
23
  PRO_MONTHLY: "PRO_MONTHLY";
24
24
  PRO_YEARLY: "PRO_YEARLY";
25
25
  PRO_YEARLY_PROMOTION: "PRO_YEARLY_PROMOTION";
26
+ UNLIMITED_MONTHLY: "UNLIMITED_MONTHLY";
26
27
  }>, z.ZodString]>;
27
28
  export type BillingPlanType = z.infer<typeof BillingPlanTypeSchema>;
28
29
  //# sourceMappingURL=plan-type.d.ts.map
@@ -19,7 +19,14 @@ import { z } from "zod/v4";
19
19
  * @contractRole canonical
20
20
  */
21
21
  export const BillingPlanTypeSchema = z.union([
22
- z.enum(["PLUS_MONTHLY", "PLUS_YEARLY", "PRO_MONTHLY", "PRO_YEARLY", "PRO_YEARLY_PROMOTION"]),
22
+ z.enum([
23
+ "PLUS_MONTHLY",
24
+ "PLUS_YEARLY",
25
+ "PRO_MONTHLY",
26
+ "PRO_YEARLY",
27
+ "PRO_YEARLY_PROMOTION",
28
+ "UNLIMITED_MONTHLY",
29
+ ]),
23
30
  z.string(),
24
31
  ]);
25
32
  //# sourceMappingURL=plan-type.js.map
@@ -155,6 +155,7 @@ declare const BillingSubscriptionSchemaDefinition: z.ZodObject<{
155
155
  };
156
156
  }, import("../research/allowance-usage.ts").ResearchAllowanceUsageSchemaInput>>;
157
157
  cancelAtPeriodEnd: z.ZodBoolean;
158
+ creditPurchasable: z.ZodBoolean;
158
159
  entitled: z.ZodBoolean;
159
160
  originalStart: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
160
161
  pendingPlan: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
@@ -163,6 +164,7 @@ declare const BillingSubscriptionSchemaDefinition: z.ZodObject<{
163
164
  PRO_MONTHLY: "PRO_MONTHLY";
164
165
  PRO_YEARLY: "PRO_YEARLY";
165
166
  PRO_YEARLY_PROMOTION: "PRO_YEARLY_PROMOTION";
167
+ UNLIMITED_MONTHLY: "UNLIMITED_MONTHLY";
166
168
  }>, z.ZodString]>>>;
167
169
  pendingPlanAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
168
170
  periodEnd: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
@@ -173,6 +175,7 @@ declare const BillingSubscriptionSchemaDefinition: z.ZodObject<{
173
175
  PRO_MONTHLY: "PRO_MONTHLY";
174
176
  PRO_YEARLY: "PRO_YEARLY";
175
177
  PRO_YEARLY_PROMOTION: "PRO_YEARLY_PROMOTION";
178
+ UNLIMITED_MONTHLY: "UNLIMITED_MONTHLY";
176
179
  }>, z.ZodString]>>>;
177
180
  provider: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
178
181
  APP_STORE: "APP_STORE";
@@ -10,6 +10,8 @@ const BillingSubscriptionSchemaDefinition = z.object({
10
10
  allowance: ResearchAllowanceUsageSchema,
11
11
  /** True when the plan is cancelled and ends at periodEnd */
12
12
  cancelAtPeriodEnd: z.boolean(),
13
+ /** 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) */
14
+ creditPurchasable: z.boolean(),
13
15
  /** True while the subscription grants its paid tier */
14
16
  entitled: z.boolean(),
15
17
  /** Original start of the continuing paid subscription; absent when the provider did not supply it */
@@ -17,7 +17,7 @@ const EntityAcquisitionSchemaDefinition = z.object({
17
17
  .string()
18
18
  .regex(/^(?!0000)[0-9]{4}(?:-(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[12][0-9]|3[01])(?:T(?:[01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9](?:\.[0-9]{1,9})?)?(?:Z|[+-](?:(?:0[0-9]|1[0-7]):[0-5][0-9]|18:00)))?)?)?$/)
19
19
  .nullish(),
20
- /** Effective acquisition date or instant, retaining its stored precision. */
20
+ /** Effective acquisition date the server derives on write: announcedAt, else completedAt, else the submitted asOf, as a calendar day; it can differ from the asOf written. */
21
21
  asOf: z
22
22
  .string()
23
23
  .regex(/^(?!0000)[0-9]{4}(?:-(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[12][0-9]|3[01])(?:T(?:[01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9](?:\.[0-9]{1,9})?)?(?:Z|[+-](?:(?:0[0-9]|1[0-7]):[0-5][0-9]|18:00)))?)?)?$/)
@@ -21,7 +21,7 @@ const FederatedNaturalSearchSchemaDefinition = z.object({
21
21
  personSize: z.int().nullish(),
22
22
  /** Plain-English search request. */
23
23
  query: z.string().min(1),
24
- /** Optional reasoning effort for every model call this search makes: the query planner and the synthesis answer. Each call sends the nearest level its model supports, the lower one on a tie. Callers without private-data access are capped at `medium`. Null keeps the configured per-call and per-model defaults. */
24
+ /** Optional reasoning effort for every model call this search makes: the query planner and the synthesis answer. Each call sends the nearest level its model supports, the lower one on a tie. Callers without private-data access are capped at `medium`: an explicit value above it is lowered, and when it is null the resolved effort — the per-model default, the tier default, or, absent an app default, the gateway's own — is still bounded at `medium`. */
25
25
  reasoningEffort: ReasoningEffortSchema.nullish(),
26
26
  /** Search catalog revision this search reads its qualifier prompts and startup vocabulary from, to compare catalog edits; null reads the current revision. Callers without private-data access always read the current revision. An unknown revision returns 404. */
27
27
  searchCatalogRevision: z.int().nullish(),
@@ -14,7 +14,7 @@ const NaturalSearchSchemaDefinition = z.object({
14
14
  model: z.string().nullish(),
15
15
  /** Plain-English search request. */
16
16
  query: z.string().min(1),
17
- /** Optional reasoning effort for every model call this search makes: the query planner and the synthesis answer. Each call sends the nearest level its model supports, the lower one on a tie. Callers without private-data access are capped at `medium`. Null keeps the configured per-call and per-model defaults. */
17
+ /** Optional reasoning effort for every model call this search makes: the query planner and the synthesis answer. Each call sends the nearest level its model supports, the lower one on a tie. Callers without private-data access are capped at `medium`: an explicit value above it is lowered, and when it is null the resolved effort — the per-model default, the tier default, or, absent an app default, the gateway's own — is still bounded at `medium`. */
18
18
  reasoningEffort: ReasoningEffortSchema.nullish(),
19
19
  /** Search catalog revision this search reads its qualifier prompts and startup vocabulary from, to compare catalog edits; null reads the current revision. Callers without private-data access always read the current revision. An unknown revision returns 404. */
20
20
  searchCatalogRevision: z.int().nullish(),
@@ -113,6 +113,10 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
113
113
  modulePath: "billing/payment-method",
114
114
  schemaName: "BillingPaymentMethodSchema",
115
115
  },
116
+ BillingPaymentProfile: {
117
+ modulePath: "billing/payment-profile",
118
+ schemaName: "BillingPaymentProfileSchema",
119
+ },
116
120
  BillingPlanChange: { modulePath: "billing/plan-change", schemaName: "BillingPlanChangeSchema" },
117
121
  BillingPlanChangeMutation: {
118
122
  modulePath: "billing/plan-change-mutation",
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * 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.
3
+ * 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.
4
4
  *
5
5
  * @openapiSchema ResearchParagraphShape
6
6
  * @endpoint GET /v1/entities/research-snippets/types
@@ -1,7 +1,7 @@
1
1
  // 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
2
2
  import { z } from "zod/v4";
3
3
  /**
4
- * 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.
4
+ * 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.
5
5
  *
6
6
  * @openapiSchema ResearchParagraphShape
7
7
  * @endpoint GET /v1/entities/research-snippets/types
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aventurevc/api-schemas",
3
- "version": "0.8.161",
3
+ "version": "0.8.164",
4
4
  "private": false,
5
5
  "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
6
6
  "license": "Apache-2.0",