@burdenoff/microfe-planmagnet 2026.511.1 → 2026.518.1

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.
@@ -363,13 +363,19 @@ export type Addon = {
363
363
  createdAt?: Maybe<Scalars['DateTime']['output']>;
364
364
  /** The currency in which the addon is priced. Defaults to 'USD'. */
365
365
  currency?: Maybe<Scalars['String']['output']>;
366
- /** Prices for all supported currencies with beautiful rounding. Example: { "USD": 2.00, "INR": 199, "EUR": 1.99, "GBP": 1.79 } */
366
+ /**
367
+ * Prices for all supported currencies with beautiful rounding.
368
+ * Example: { "USD": 2.00, "INR": 199, "EUR": 1.99, "GBP": 1.79 }
369
+ */
367
370
  currencyPrices?: Maybe<Scalars['JSON']['output']>;
368
371
  /** The duration for which the addon is valid (e.g., monthly, yearly). Defaults to 'monthly'. */
369
372
  duration?: Maybe<PlanDuration>;
370
373
  /** A list of features provided by this addon, such as extra quotas or special services. */
371
374
  features?: Maybe<Array<Maybe<SubscriptionFeatures>>>;
372
- /** Geography-specific price overrides. The billing account's country/state/region plus currency decide whether one of these overrides applies. */
375
+ /**
376
+ * Geography-specific price overrides. The billing account's country/state/region plus
377
+ * currency decide whether one of these overrides applies.
378
+ */
373
379
  geoPricingOverrides: Array<GeoPricingOverride>;
374
380
  /** The unique identifier for the Addon, automatically generated as a UUID. */
375
381
  id?: Maybe<Scalars['ID']['output']>;
@@ -386,7 +392,10 @@ export type Addon = {
386
392
  /** The timestamp when the addon was last updated. */
387
393
  updatedAt?: Maybe<Scalars['DateTime']['output']>;
388
394
  };
389
- /** Tracks historical price changes for an Addon. A new record is created whenever an addon's price is updated. */
395
+ /**
396
+ * Tracks historical price changes for an Addon.
397
+ * A new record is created whenever an addon's price is updated.
398
+ */
390
399
  export type AddonPriceHistory = {
391
400
  __typename?: 'AddonPriceHistory';
392
401
  /** The addon this price change belongs to */
@@ -1291,7 +1300,10 @@ export type BatchOperationResult = {
1291
1300
  failedIds?: Maybe<Array<Scalars['ID']['output']>>;
1292
1301
  success: Scalars['Boolean']['output'];
1293
1302
  };
1294
- /** BillingAccount entity - resolvable via Federation Gateway. Other services (e.g., store-svc) can reference BillingAccount by id. */
1303
+ /**
1304
+ * BillingAccount entity - resolvable via Federation Gateway.
1305
+ * Other services (e.g., store-svc) can reference BillingAccount by id.
1306
+ */
1295
1307
  export type BillingAccount = {
1296
1308
  __typename?: 'BillingAccount';
1297
1309
  /** The billing addresses associated with this billing account */
@@ -1422,7 +1434,10 @@ export type BillingOrder = {
1422
1434
  /** External order ID from the service (e.g., "store-order-12345") */
1423
1435
  id: Scalars['ID']['output'];
1424
1436
  items: Scalars['JSON']['output'];
1425
- /** Tax is calculated at payment time and stored in Transaction/Payment, not BillingOrder. Tax info can be found in metadata.paymentTaxAmount, metadata.paymentTaxRate, metadata.paymentTotal */
1437
+ /**
1438
+ * Tax is calculated at payment time and stored in Transaction/Payment, not BillingOrder.
1439
+ * Tax info can be found in metadata.paymentTaxAmount, metadata.paymentTaxRate, metadata.paymentTotal
1440
+ */
1426
1441
  metadata?: Maybe<Scalars['JSON']['output']>;
1427
1442
  orgId: Scalars['String']['output'];
1428
1443
  status: BillingOrderStatus;
@@ -2545,7 +2560,10 @@ export declare enum ContentVisibility {
2545
2560
  Internal = "INTERNAL",
2546
2561
  Public = "PUBLIC"
2547
2562
  }
2548
- /** Context filter input for querying records by context. Supports exact match filtering on context fields. */
2563
+ /**
2564
+ * Context filter input for querying records by context.
2565
+ * Supports exact match filtering on context fields.
2566
+ */
2549
2567
  export type ContextFilterInput = {
2550
2568
  /** Filter by organization ID */
2551
2569
  organizationId?: InputMaybe<Scalars['ID']['input']>;
@@ -2556,7 +2574,10 @@ export type ContextFilterInput = {
2556
2574
  /** Filter by workspace ID */
2557
2575
  workspaceId?: InputMaybe<Scalars['ID']['input']>;
2558
2576
  };
2559
- /** Operation context for filtering and scoping data. All fields are optional and can be extended as needed. */
2577
+ /**
2578
+ * Operation context for filtering and scoping data.
2579
+ * All fields are optional and can be extended as needed.
2580
+ */
2560
2581
  export type ContextInput = {
2561
2582
  /** Additional custom context as JSON */
2562
2583
  custom?: InputMaybe<Scalars['JSON']['input']>;
@@ -3825,7 +3846,10 @@ export type CreditRate = {
3825
3846
  rateUSD: Scalars['Float']['output'];
3826
3847
  updatedAt: Scalars['DateTime']['output'];
3827
3848
  };
3828
- /** CreditTransaction entity - resolvable via Federation Gateway. Other services (e.g., store-svc) can reference CreditTransaction by id. */
3849
+ /**
3850
+ * CreditTransaction entity - resolvable via Federation Gateway.
3851
+ * Other services (e.g., store-svc) can reference CreditTransaction by id.
3852
+ */
3829
3853
  export type CreditTransaction = {
3830
3854
  __typename?: 'CreditTransaction';
3831
3855
  amount: Scalars['Float']['output'];
@@ -5114,13 +5138,26 @@ export type GrantDelegationInput = {
5114
5138
  userId?: InputMaybe<Scalars['String']['input']>;
5115
5139
  workspaceIds?: InputMaybe<Array<Scalars['String']['input']>>;
5116
5140
  };
5117
- /** GraphQL callback configuration for external service notifications Supports two authentication methods (controlled by CALLBACK_AUTH_METHOD env var): 1. token (default): Direct HTTP with authToken 2. internal-gateway: Service credentials via internal gateway */
5141
+ /**
5142
+ * GraphQL callback configuration for external service notifications
5143
+ * Supports two authentication methods (controlled by CALLBACK_AUTH_METHOD env var):
5144
+ * 1. token (default): Direct HTTP with authToken
5145
+ * 2. internal-gateway: Service credentials via internal gateway
5146
+ */
5118
5147
  export type GraphQlCallbackInput = {
5119
- /** Authentication token for callback (optional) Required only when CALLBACK_AUTH_METHOD=token (default) Not needed when CALLBACK_AUTH_METHOD=internal-gateway Example: Bearer store-service-webhook-secret-xyz */
5148
+ /**
5149
+ * Authentication token for callback (optional)
5150
+ * Required only when CALLBACK_AUTH_METHOD=token (default)
5151
+ * Not needed when CALLBACK_AUTH_METHOD=internal-gateway
5152
+ * Example: Bearer store-service-webhook-secret-xyz
5153
+ */
5120
5154
  authToken?: InputMaybe<Scalars['String']['input']>;
5121
5155
  /** GraphQL endpoint URL of the external service Must be HTTPS and match BILLING_CALLBACK_ALLOWED_ENDPOINTS/HOSTS/SUFFIXES. Localhost is allowed only outside production for local development. Example: https://graphqlworkspaces.burdenoff.com/workspaces/graphql */
5122
5156
  endpoint: Scalars['String']['input'];
5123
- /** Name of the GraphQL mutation to call on payment completion Example: updateOrderPaymentStatus */
5157
+ /**
5158
+ * Name of the GraphQL mutation to call on payment completion
5159
+ * Example: updateOrderPaymentStatus
5160
+ */
5124
5161
  mutationName: Scalars['String']['input'];
5125
5162
  };
5126
5163
  export type Group = {
@@ -5366,7 +5403,10 @@ export type InitiatePaymentInput = {
5366
5403
  amount: Scalars['Float']['input'];
5367
5404
  /** For PLAN purchase: enable automatic renewal when subscription expires */
5368
5405
  autoRenew?: InputMaybe<Scalars['Boolean']['input']>;
5369
- /** For PLAN purchase with autoRenew: payment method ID to use for auto-renewal Must be a verified saved payment method. Required if autoRenew is true. */
5406
+ /**
5407
+ * For PLAN purchase with autoRenew: payment method ID to use for auto-renewal
5408
+ * Must be a verified saved payment method. Required if autoRenew is true.
5409
+ */
5370
5410
  autoRenewPaymentMethodId?: InputMaybe<Scalars['ID']['input']>;
5371
5411
  /** Billing account ID (required for tax calculation) */
5372
5412
  billingAccountId: Scalars['ID']['input'];
@@ -5374,7 +5414,11 @@ export type InitiatePaymentInput = {
5374
5414
  creditAmount?: InputMaybe<Scalars['Int']['input']>;
5375
5415
  /** Currency code (e.g., INR, USD) */
5376
5416
  currency: Scalars['String']['input'];
5377
- /** For PLAN downgrade: the active higher-tier subscription ID being replaced. Old subscription is left active until natural expiry — no cancellation, no refund. User retains old plan quotas during overlap; continues on new plan after expiry. */
5417
+ /**
5418
+ * For PLAN downgrade: the active higher-tier subscription ID being replaced.
5419
+ * Old subscription is left active until natural expiry — no cancellation, no refund.
5420
+ * User retains old plan quotas during overlap; continues on new plan after expiry.
5421
+ */
5378
5422
  downgradeFromSubscriptionId?: InputMaybe<Scalars['ID']['input']>;
5379
5423
  /** For PLAN purchase: whether this is an annual subscription (12 months with discount) */
5380
5424
  isAnnual?: InputMaybe<Scalars['Boolean']['input']>;
@@ -5400,9 +5444,16 @@ export type InitiatePaymentInput = {
5400
5444
  quantity?: InputMaybe<Scalars['Int']['input']>;
5401
5445
  /** Whether to save the card for future purchases (only for new card payments) */
5402
5446
  saveCard?: InputMaybe<Scalars['Boolean']['input']>;
5403
- /** For ADDON purchase: subscription ID to attach addon to. Required if billing account has multiple active subscriptions. If only one active subscription exists, it will be auto-selected. */
5447
+ /**
5448
+ * For ADDON purchase: subscription ID to attach addon to.
5449
+ * Required if billing account has multiple active subscriptions.
5450
+ * If only one active subscription exists, it will be auto-selected.
5451
+ */
5404
5452
  subscriptionId?: InputMaybe<Scalars['ID']['input']>;
5405
- /** For PLAN upgrade: the subscription ID being upgraded from. If provided, this is an upgrade - old quotas will be moved to new subscription. */
5453
+ /**
5454
+ * For PLAN upgrade: the subscription ID being upgraded from.
5455
+ * If provided, this is an upgrade - old quotas will be moved to new subscription.
5456
+ */
5406
5457
  upgradeFromSubscriptionId?: InputMaybe<Scalars['ID']['input']>;
5407
5458
  };
5408
5459
  /** Response from initiatePayment mutation */
@@ -6255,7 +6306,10 @@ export type Mutation = {
6255
6306
  approveReview: ProductReview;
6256
6307
  approveTranslation: Translation;
6257
6308
  approveWaitlist: NewsletterWaitlist;
6258
- /** Soft archive a billing account. Financial history is preserved and the account is removed from active billing operations. */
6309
+ /**
6310
+ * Soft archive a billing account. Financial history is preserved and the account is removed
6311
+ * from active billing operations.
6312
+ */
6259
6313
  archiveBillingAccount: BillingAccount;
6260
6314
  /** Archive a channel */
6261
6315
  archiveChannel: Channel;
@@ -6330,7 +6384,10 @@ export type Mutation = {
6330
6384
  cancelPayout: DeveloperOrgPayout;
6331
6385
  /** Cancel a scheduled notification */
6332
6386
  cancelScheduledNotification: Scalars['Boolean']['output'];
6333
- /** Cancel a subscription - disables auto-renewal but keeps subscription active until endDate. The subscription will not renew when it expires. */
6387
+ /**
6388
+ * Cancel a subscription - disables auto-renewal but keeps subscription active until endDate.
6389
+ * The subscription will not renew when it expires.
6390
+ */
6334
6391
  cancelSubscription: BillingSubscription;
6335
6392
  changePassword: Scalars['Boolean']['output'];
6336
6393
  /** Check push MFA challenge status (polling) */
@@ -6371,7 +6428,10 @@ export type Mutation = {
6371
6428
  createAutomationStep: AutomationStep;
6372
6429
  /** Create a new billing account for the current org (from context) */
6373
6430
  createBillingAccount: BillingAccount;
6374
- /** Create a billing order for external service (e.g., store) Stores order details + GraphQL callback endpoint for payment notifications */
6431
+ /**
6432
+ * Create a billing order for external service (e.g., store)
6433
+ * Stores order details + GraphQL callback endpoint for payment notifications
6434
+ */
6375
6435
  createBillingOrder: CreateBillingOrderResponse;
6376
6436
  createCampaign: NewsletterCampaign;
6377
6437
  createCannedResponse: CannedResponse;
@@ -6510,7 +6570,11 @@ export type Mutation = {
6510
6570
  deactivateResource: Scalars['Boolean']['output'];
6511
6571
  /** Deactivate a tour schedule */
6512
6572
  deactivateTourSchedule: TourSchedule;
6513
- /** Pure quota decrement — called by wspace-activity-svc after writing a UsageRecord. Only decrements QuotaAssignment.limits.value. Does NOT write back to activity-svc. Requires the quotaAssignmentId already resolved by checkQuotaExhausted. */
6573
+ /**
6574
+ * Pure quota decrement — called by wspace-activity-svc after writing a UsageRecord.
6575
+ * Only decrements QuotaAssignment.limits.value. Does NOT write back to activity-svc.
6576
+ * Requires the quotaAssignmentId already resolved by checkQuotaExhausted.
6577
+ */
6514
6578
  decrementQuota: Scalars['Boolean']['output'];
6515
6579
  /** Delete current user's account permanently Requires password confirmation */
6516
6580
  deleteAccount: AccountActionResult;
@@ -6720,7 +6784,11 @@ export type Mutation = {
6720
6784
  initiateKerberosAuth: KerberosChallengeResult;
6721
6785
  /** Initiate NTLM authentication (returns Type 2 challenge) */
6722
6786
  initiateNTLMChallenge: NtlmChallengeResult;
6723
- /** Initiate a payment for credits, plans, or addons This creates a Stripe PaymentIntent or Razorpay Order with tax included Returns client secret (Stripe) or order ID (Razorpay) for frontend to complete payment */
6787
+ /**
6788
+ * Initiate a payment for credits, plans, or addons
6789
+ * This creates a Stripe PaymentIntent or Razorpay Order with tax included
6790
+ * Returns client secret (Stripe) or order ID (Razorpay) for frontend to complete payment
6791
+ */
6724
6792
  initiatePayment: InitiatePaymentResponse;
6725
6793
  /** Install an application */
6726
6794
  installApp: AppInstallation;
@@ -6943,7 +7011,10 @@ export type Mutation = {
6943
7011
  resumeDeveloperOrgSubscription: DeveloperOrgSubscription;
6944
7012
  resumeSLA: SupportTicket;
6945
7013
  resumeScheduledJob: ScheduledJob;
6946
- /** Manually retry GraphQL callback for a failed billing order (admin only) Useful for retrying after fixing issues in external service */
7014
+ /**
7015
+ * Manually retry GraphQL callback for a failed billing order (admin only)
7016
+ * Useful for retrying after fixing issues in external service
7017
+ */
6947
7018
  retryBillingOrderCallback: RetryBillingOrderCallbackResponse;
6948
7019
  /** Retry a failed delivery attempt */
6949
7020
  retryDelivery: MessageDeliveryResult;
@@ -7007,7 +7078,11 @@ export type Mutation = {
7007
7078
  setAgentOnline: AgentProfile;
7008
7079
  /** Set or update billing address for a billing account */
7009
7080
  setBillingAddress: BillingAddress;
7010
- /** Set a billing account as the default for an org. Only one billing account can be default per org. If another account is currently default, it will be unset. */
7081
+ /**
7082
+ * Set a billing account as the default for an org.
7083
+ * Only one billing account can be default per org.
7084
+ * If another account is currently default, it will be unset.
7085
+ */
7011
7086
  setDefaultBillingAccount: BillingAccount;
7012
7087
  setDefaultLanguage: Language;
7013
7088
  /** Set a payment method as default */
@@ -7232,7 +7307,10 @@ export type Mutation = {
7232
7307
  /** Update order payment status (called by billing service callback) This is a PUBLIC mutation called by the billing service after payment completion */
7233
7308
  updateStoreOrderPaymentStatus: UpdateStoreOrderPaymentStatusResponse;
7234
7309
  updateSubscriber: NewsletterSubscriber;
7235
- /** Update the seat count on an active PER_SEAT subscription. Syncs quantity to the payment gateway and updates the seat quota ceiling. */
7310
+ /**
7311
+ * Update the seat count on an active PER_SEAT subscription.
7312
+ * Syncs quantity to the payment gateway and updates the seat quota ceiling.
7313
+ */
7236
7314
  updateSubscriptionSeats: BillingSubscription;
7237
7315
  updateSupportMessage: SupportMessage;
7238
7316
  updateSupportTicket: SupportTicket;
@@ -11307,7 +11385,10 @@ export type OidcHybridConfig = {
11307
11385
  supportedGrantTypes: Array<Scalars['String']['output']>;
11308
11386
  supportedResponseTypes: Array<Scalars['String']['output']>;
11309
11387
  };
11310
- /** Operation context output type. Returns the stored context for each record. */
11388
+ /**
11389
+ * Operation context output type.
11390
+ * Returns the stored context for each record.
11391
+ */
11311
11392
  export type OperationContext = {
11312
11393
  __typename?: 'OperationContext';
11313
11394
  /** App ID for app-level scoping */
@@ -11574,7 +11655,10 @@ export type PageInfo = {
11574
11655
  hasPreviousPage: Scalars['Boolean']['output'];
11575
11656
  startCursor?: Maybe<Scalars['String']['output']>;
11576
11657
  };
11577
- /** Response type for getTransactionsByBillingAccount query Contains basic billing account info and paginated transactions */
11658
+ /**
11659
+ * Response type for getTransactionsByBillingAccount query
11660
+ * Contains basic billing account info and paginated transactions
11661
+ */
11578
11662
  export type PaginatedBillingAccountTransactions = {
11579
11663
  __typename?: 'PaginatedBillingAccountTransactions';
11580
11664
  /** Billing-specific email (for invoices) */
@@ -11813,7 +11897,10 @@ export declare enum PaymentMethodType {
11813
11897
  Paypal = "PAYPAL",
11814
11898
  Wallet = "WALLET"
11815
11899
  }
11816
- /** Payment provider configuration for frontend integration Contains only public keys safe to expose to the client */
11900
+ /**
11901
+ * Payment provider configuration for frontend integration
11902
+ * Contains only public keys safe to expose to the client
11903
+ */
11817
11904
  export type PaymentProviderConfig = {
11818
11905
  __typename?: 'PaymentProviderConfig';
11819
11906
  /** Whether Razorpay is configured and available */
@@ -12061,13 +12148,19 @@ export type Plan = {
12061
12148
  createdAt?: Maybe<Scalars['DateTime']['output']>;
12062
12149
  /** The currency in which the plan is priced. Defaults to 'USD'. */
12063
12150
  currency?: Maybe<Scalars['String']['output']>;
12064
- /** Prices for all supported currencies with beautiful rounding. Example: { "USD": 2.00, "INR": 199, "EUR": 1.99, "GBP": 1.79 } */
12151
+ /**
12152
+ * Prices for all supported currencies with beautiful rounding.
12153
+ * Example: { "USD": 2.00, "INR": 199, "EUR": 1.99, "GBP": 1.79 }
12154
+ */
12065
12155
  currencyPrices?: Maybe<Scalars['JSON']['output']>;
12066
12156
  /** The duration for which the plan is valid (e.g., monthly, yearly). Defaults to 'monthly'. */
12067
12157
  duration?: Maybe<PlanDuration>;
12068
12158
  /** A list of features provided by this plan, such as quotas or special services. */
12069
12159
  features?: Maybe<Array<Maybe<SubscriptionFeatures>>>;
12070
- /** Geography-specific price overrides. The billing account's country/state/region plus currency decide whether one of these overrides applies. */
12160
+ /**
12161
+ * Geography-specific price overrides. The billing account's country/state/region plus
12162
+ * currency decide whether one of these overrides applies.
12163
+ */
12071
12164
  geoPricingOverrides: Array<GeoPricingOverride>;
12072
12165
  /** The unique identifier for the Plan, automatically generated as a UUID. */
12073
12166
  id?: Maybe<Scalars['ID']['output']>;
@@ -12085,9 +12178,15 @@ export type Plan = {
12085
12178
  price?: Maybe<Scalars['Float']['output']>;
12086
12179
  /** Historical record of price changes for this plan */
12087
12180
  priceHistory: Array<PlanPriceHistory>;
12088
- /** Per-seat rate used when pricingModel is PER_SEAT. Total charge = pricePerSeat × seatCount. */
12181
+ /**
12182
+ * Per-seat rate used when pricingModel is PER_SEAT.
12183
+ * Total charge = pricePerSeat × seatCount.
12184
+ */
12089
12185
  pricePerSeat?: Maybe<Scalars['Float']['output']>;
12090
- /** Whether this plan bills at a flat rate or per seat. PER_SEAT plans pass seatCount as quantity to Stripe/Razorpay. */
12186
+ /**
12187
+ * Whether this plan bills at a flat rate or per seat.
12188
+ * PER_SEAT plans pass seatCount as quantity to Stripe/Razorpay.
12189
+ */
12091
12190
  pricingModel?: Maybe<PlanPricingModel>;
12092
12191
  /** Which product the plan belongs to (reference to product microservice) */
12093
12192
  productID?: Maybe<Scalars['String']['output']>;
@@ -12100,7 +12199,10 @@ export declare enum PlanDuration {
12100
12199
  Monthly = "monthly",
12101
12200
  Yearly = "yearly"
12102
12201
  }
12103
- /** Tracks historical price changes for a Plan. A new record is created whenever a plan's price is updated. */
12202
+ /**
12203
+ * Tracks historical price changes for a Plan.
12204
+ * A new record is created whenever a plan's price is updated.
12205
+ */
12104
12206
  export type PlanPriceHistory = {
12105
12207
  __typename?: 'PlanPriceHistory';
12106
12208
  /** Who made the price change (actor ID) */
@@ -12839,7 +12941,10 @@ export type Query = {
12839
12941
  bounceStats: BounceStats;
12840
12942
  /** Browse store products with unified filtering, sorting, and pagination. Search is treated as a filter - all filters combine with AND logic. Example usage: ```graphql query { browseStore(input: { filter: { search: "ai notification" type: NODE pricingModel: FREE minRating: 4.0 compatibleWith: "workspaces" } sortBy: RELEVANCE pagination: { limit: 20, offset: 0 } }) { products { id name rating downloads } totalCount hasMore facets { categories { value count } } } } ``` */
12841
12943
  browseStore: BrowseStoreResult;
12842
- /** Calculate tax for a purchase (preview without creating payment) Used by checkout to show tax breakdown before payment */
12944
+ /**
12945
+ * Calculate tax for a purchase (preview without creating payment)
12946
+ * Used by checkout to show tax breakdown before payment
12947
+ */
12843
12948
  calculateTax: TaxCalculationResult;
12844
12949
  campaign?: Maybe<NewsletterCampaign>;
12845
12950
  campaignBounces: Array<NewsletterBounce>;
@@ -12889,7 +12994,10 @@ export type Query = {
12889
12994
  contentPageBySlug?: Maybe<ProductContentPage>;
12890
12995
  /** List content pages with optional filtering by product */
12891
12996
  contentPages: ProductContentPageList;
12892
- /** Convert an amount from one currency to another (uses live exchange rates) Default fromCurrency is USD */
12997
+ /**
12998
+ * Convert an amount from one currency to another (uses live exchange rates)
12999
+ * Default fromCurrency is USD
13000
+ */
12893
13001
  convertCurrency: CurrencyConversion;
12894
13002
  currentUser?: Maybe<User>;
12895
13003
  currentUserApps: Array<App>;
@@ -12975,7 +13083,10 @@ export type Query = {
12975
13083
  featuredProducts: Array<StoreProduct>;
12976
13084
  /** Get available filter options for a given context. Useful for populating filter dropdowns in UI. */
12977
13085
  filterOptions: FilterOptionsResult;
12978
- /** Get active subscriptions for a billing account (optimized for dashboard) Only returns subscriptions with status = 'active' */
13086
+ /**
13087
+ * Get active subscriptions for a billing account (optimized for dashboard)
13088
+ * Only returns subscriptions with status = 'active'
13089
+ */
12979
13090
  getActiveSubscriptions: Array<BillingSubscription>;
12980
13091
  /** Get the price change history for a specific addon */
12981
13092
  getAddonPriceHistory: Array<AddonPriceHistory>;
@@ -12993,7 +13104,11 @@ export type Query = {
12993
13104
  /** Get a billing account by ID */
12994
13105
  getBillingAccount?: Maybe<BillingAccount>;
12995
13106
  getBillingAccountCreditTransactions: PaginatedCreditTransactions;
12996
- /** Get usage summary for all quotas of a billing account. Returns both subscription (PRODUCT_SPECIFIC) and pooled quotas. If productId is provided, filters subscription quotas by that product. */
13107
+ /**
13108
+ * Get usage summary for all quotas of a billing account.
13109
+ * Returns both subscription (PRODUCT_SPECIFIC) and pooled quotas.
13110
+ * If productId is provided, filters subscription quotas by that product.
13111
+ */
12997
13112
  getBillingAccountQuotasSummary: BillingAccountQuotasSummary;
12998
13113
  /** Get all billing accounts for the current org (from context) */
12999
13114
  getBillingAccountsByOrg: Array<BillingAccount>;
@@ -13047,7 +13162,12 @@ export type Query = {
13047
13162
  getCreditTransactionDetails: CreditTransaction;
13048
13163
  /** Get the default/first billing account for the current org (from context) */
13049
13164
  getDefaultBillingAccount?: Maybe<BillingAccount>;
13050
- /** Get the default billing account for a specific organization by orgId. Returns the billing account where isDefault = true for the given orgId. If no default is set, returns the first active billing account. Used by gateway for automatic billing account resolution in usage tracking. */
13165
+ /**
13166
+ * Get the default billing account for a specific organization by orgId.
13167
+ * Returns the billing account where isDefault = true for the given orgId.
13168
+ * If no default is set, returns the first active billing account.
13169
+ * Used by gateway for automatic billing account resolution in usage tracking.
13170
+ */
13051
13171
  getDefaultBillingAccountByOrgId?: Maybe<BillingAccount>;
13052
13172
  /** Get the default payment method for a billing account */
13053
13173
  getDefaultPaymentMethod?: Maybe<PaymentMethod>;
@@ -13065,7 +13185,10 @@ export type Query = {
13065
13185
  getEntitlement?: Maybe<SubscriptionEntitlement>;
13066
13186
  /** Get external OIDC configuration for a tenant (Google, Microsoft, etc.) */
13067
13187
  getExternalOIDCConfig?: Maybe<ExternalOidcConfiguration>;
13068
- /** Get billing orders with failed callbacks (admin only) Useful for monitoring and manual retry */
13188
+ /**
13189
+ * Get billing orders with failed callbacks (admin only)
13190
+ * Useful for monitoring and manual retry
13191
+ */
13069
13192
  getFailedBillingOrderCallbacks: FailedBillingOrderCallbacksResponse;
13070
13193
  /** Get failed delivery attempts for retry. Supports cursor pagination — pass `cursor` from the previous page's `nextCursor`. */
13071
13194
  getFailedDeliveryAttempts: DeliveryAttemptList;
@@ -13095,7 +13218,10 @@ export type Query = {
13095
13218
  getPaymentFailures: Array<PaymentFailure>;
13096
13219
  /** Get payment methods for a billing account */
13097
13220
  getPaymentMethods: Array<PaymentMethod>;
13098
- /** Get payment provider configuration for frontend integration Returns public keys only (safe to expose to client) */
13221
+ /**
13222
+ * Get payment provider configuration for frontend integration
13223
+ * Returns public keys only (safe to expose to client)
13224
+ */
13099
13225
  getPaymentProviderConfig: PaymentProviderConfig;
13100
13226
  /** Get all payments for the current org (from context), optionally filtered by status */
13101
13227
  getPayments: Array<Payment>;
@@ -13118,7 +13244,10 @@ export type Query = {
13118
13244
  getReferralCodeByCode?: Maybe<ReferralCode>;
13119
13245
  /** Get a single refund record by ID */
13120
13246
  getRefundRecord?: Maybe<RefundRecord>;
13121
- /** Get refund records with filters and pagination (for admin dashboard). Uses orgId from context by default. Super admins can override with orgIdFilter. */
13247
+ /**
13248
+ * Get refund records with filters and pagination (for admin dashboard).
13249
+ * Uses orgId from context by default. Super admins can override with orgIdFilter.
13250
+ */
13122
13251
  getRefundRecords: PaginatedRefundRecords;
13123
13252
  /** Get refund statistics (counts and amounts) */
13124
13253
  getRefundStats: RefundStats;
@@ -13135,7 +13264,12 @@ export type Query = {
13135
13264
  getStoreProductTags: Array<StoreProductTagAssignment>;
13136
13265
  /** Get a subscription by ID */
13137
13266
  getSubscription?: Maybe<BillingSubscription>;
13138
- /** Enhanced subscription overview with better pagination and filtering @param includeExpired - Include past/canceled/expired subscriptions (default: false) @param onlyExpired - Only fetch past subscriptions for lazy loading (default: false) @param searchQuery - Search quotas by name in database (case-insensitive) */
13267
+ /**
13268
+ * Enhanced subscription overview with better pagination and filtering
13269
+ * @param includeExpired - Include past/canceled/expired subscriptions (default: false)
13270
+ * @param onlyExpired - Only fetch past subscriptions for lazy loading (default: false)
13271
+ * @param searchQuery - Search quotas by name in database (case-insensitive)
13272
+ */
13139
13273
  getSubscriptionUsageOverview?: Maybe<Array<SubscriptionWithQuotas>>;
13140
13274
  getSubscriptionUsages: SubscriptionQuotaUsageWithFilter;
13141
13275
  /** Get tax rates */
@@ -13369,13 +13503,21 @@ export type Query = {
13369
13503
  productTourStatistics: ProductTourStatistics;
13370
13504
  products: Array<StoreProduct>;
13371
13505
  pseudoLocaleStats: PseudoLocaleStats;
13372
- /** Get all active addons for a specific product (public, no authentication required). Used by product website pricing pages. Only returns active addons. */
13506
+ /**
13507
+ * Get all active addons for a specific product (public, no authentication required).
13508
+ * Used by product website pricing pages.
13509
+ * Only returns active addons.
13510
+ */
13373
13511
  publicAddons: Array<Addon>;
13374
13512
  /** Get a public content page by slug and optional product ID. Only returns pages with visibility=PUBLIC and isPublished=true. */
13375
13513
  publicContentPage?: Maybe<ProductContentPage>;
13376
13514
  /** List public content pages for a product. Only returns pages with visibility=PUBLIC and isPublished=true. */
13377
13515
  publicContentPages: ProductContentPageList;
13378
- /** Get all active plans for a specific product (public, no authentication required). Used by product website pricing pages. Only returns active plans with their features. */
13516
+ /**
13517
+ * Get all active plans for a specific product (public, no authentication required).
13518
+ * Used by product website pricing pages.
13519
+ * Only returns active plans with their features.
13520
+ */
13379
13521
  publicPlans: Array<Plan>;
13380
13522
  /** Get a platform product by slug (public, no auth required). Returns only ACTIVE or WAITLIST products. Does NOT expose sensitive fields like recaptchaSecretKey. */
13381
13523
  publicProduct?: Maybe<PlatformProduct>;
@@ -15882,7 +16024,12 @@ export type Quota = {
15882
16024
  name?: Maybe<Scalars['String']['output']>;
15883
16025
  /** Defines whether this quota template is pooled (shared across products) or product-specific. */
15884
16026
  quotaType?: Maybe<QuotaType>;
15885
- /** When does usage reset for assignments of this quota? NEVER = static limit (seats, agents, storage cap) DAILY = resets each day at midnight UTC (API requests/day, AI sessions/day) MONTHLY = resets at the start of each billing cycle */
16027
+ /**
16028
+ * When does usage reset for assignments of this quota?
16029
+ * NEVER = static limit (seats, agents, storage cap)
16030
+ * DAILY = resets each day at midnight UTC (API requests/day, AI sessions/day)
16031
+ * MONTHLY = resets at the start of each billing cycle
16032
+ */
15886
16033
  resetPeriod?: Maybe<QuotaResetPeriod>;
15887
16034
  /** A Quota is reusable or not (e.g., bot,seats). */
15888
16035
  reusable?: Maybe<Scalars['Boolean']['output']>;
@@ -15907,7 +16054,11 @@ export type QuotaAssignment = {
15907
16054
  endtime?: Maybe<Scalars['DateTime']['output']>;
15908
16055
  /** The unique identifier for the QuotaAssignment, automatically generated as a UUID. */
15909
16056
  id?: Maybe<Scalars['ID']['output']>;
15910
- /** When limits were last restored to their original value by the reset job. Null means this assignment has never been reset in-place. The daily QuotaResetWorkflow uses this to find assignments that need resetting. */
16057
+ /**
16058
+ * When limits were last restored to their original value by the reset job.
16059
+ * Null means this assignment has never been reset in-place.
16060
+ * The daily QuotaResetWorkflow uses this to find assignments that need resetting.
16061
+ */
15911
16062
  lastResetAt?: Maybe<Scalars['DateTime']['output']>;
15912
16063
  /** A JSON object defining the limits associated with the assigned quota (e.g., data caps, usage limits). */
15913
16064
  limits?: Maybe<Scalars['JSON']['output']>;
@@ -15915,7 +16066,10 @@ export type QuotaAssignment = {
15915
16066
  name?: Maybe<Scalars['String']['output']>;
15916
16067
  /** The type of quota - POOLED (billing account level) or PRODUCT_SPECIFIC (subscription level). */
15917
16068
  quotaType?: Maybe<QuotaType>;
15918
- /** Copied from parent Quota.resetPeriod at creation. Tells the reset job how often limits.value should be restored. DAILY = restore every midnight UTC. */
16069
+ /**
16070
+ * Copied from parent Quota.resetPeriod at creation. Tells the reset job how often
16071
+ * limits.value should be restored. DAILY = restore every midnight UTC.
16072
+ */
15919
16073
  resetPeriod?: Maybe<QuotaResetPeriod>;
15920
16074
  /** A Quota is reusable or not (e.g., bot,seats). */
15921
16075
  reusable?: Maybe<Scalars['Boolean']['output']>;
@@ -17451,17 +17605,32 @@ export type SpendCreditResponse = {
17451
17605
  export type SpendCreditsInput = {
17452
17606
  addOnIds?: InputMaybe<Array<InputMaybe<AddOnInputPayment>>>;
17453
17607
  billingAccountId: Scalars['String']['input'];
17454
- /** For plan downgrades — the active higher-tier subscription ID. Old subscription's auto-renewal is cancelled so it won't charge again; it stays active until natural expiry and then the new plan continues. */
17608
+ /**
17609
+ * For plan downgrades — the active higher-tier subscription ID.
17610
+ * Old subscription's auto-renewal is cancelled so it won't charge again;
17611
+ * it stays active until natural expiry and then the new plan continues.
17612
+ */
17455
17613
  downgradeFromSubscriptionId?: InputMaybe<Scalars['String']['input']>;
17456
17614
  isAnnual?: InputMaybe<Scalars['Boolean']['input']>;
17457
17615
  /** Order ID to purchase using credits (for store orders, etc.) */
17458
17616
  orderId?: InputMaybe<Scalars['String']['input']>;
17459
17617
  planId?: InputMaybe<Scalars['String']['input']>;
17460
- /** Number of seats for PER_SEAT plans. Stored on the created subscription. Credits required = pricePerSeat × seatCount × creditsPerUSD (instead of plan.price). Ignored for FLAT_RATE plans. */
17618
+ /**
17619
+ * Number of seats for PER_SEAT plans. Stored on the created subscription.
17620
+ * Credits required = pricePerSeat × seatCount × creditsPerUSD (instead of plan.price).
17621
+ * Ignored for FLAT_RATE plans.
17622
+ */
17461
17623
  seatCount?: InputMaybe<Scalars['Int']['input']>;
17462
- /** For addon purchases - the subscription ID to attach addons to. Required if billing account has multiple active subscriptions. If only one active subscription exists, it will be auto-selected. */
17624
+ /**
17625
+ * For addon purchases - the subscription ID to attach addons to.
17626
+ * Required if billing account has multiple active subscriptions.
17627
+ * If only one active subscription exists, it will be auto-selected.
17628
+ */
17463
17629
  subscriptionId?: InputMaybe<Scalars['String']['input']>;
17464
- /** For plan upgrades - the subscription ID to upgrade from. Old quotas will be moved to the new subscription. */
17630
+ /**
17631
+ * For plan upgrades - the subscription ID to upgrade from.
17632
+ * Old quotas will be moved to the new subscription.
17633
+ */
17465
17634
  upgradeFromSubscriptionId?: InputMaybe<Scalars['String']['input']>;
17466
17635
  };
17467
17636
  export type Store = {
@@ -17594,7 +17763,12 @@ export declare enum StoreInstallationStatus {
17594
17763
  Pending = "PENDING",
17595
17764
  Uninstalled = "UNINSTALLED"
17596
17765
  }
17597
- /** StoreItem entity reference. The actual StoreItem is defined in the Store service. In Federation 2 setup, this will be marked with @key directive. For now, this is a reference type that returns the itemId for the Gateway to resolve. */
17766
+ /**
17767
+ * StoreItem entity reference.
17768
+ * The actual StoreItem is defined in the Store service.
17769
+ * In Federation 2 setup, this will be marked with @key directive.
17770
+ * For now, this is a reference type that returns the itemId for the Gateway to resolve.
17771
+ */
17598
17772
  export type StoreItem = {
17599
17773
  __typename?: 'StoreItem';
17600
17774
  /** The unique identifier for the store item */
@@ -17621,7 +17795,11 @@ export type StoreLineItemInput = {
17621
17795
  /** Product version at time of purchase */
17622
17796
  version?: InputMaybe<Scalars['String']['input']>;
17623
17797
  };
17624
- /** External entity stub for StoreOrder from store-svc. Federation gateway will resolve full StoreOrder data from store-svc. Used by: BillingAccount.storeOrders (if extended), Transaction.storeOrder */
17798
+ /**
17799
+ * External entity stub for StoreOrder from store-svc.
17800
+ * Federation gateway will resolve full StoreOrder data from store-svc.
17801
+ * Used by: BillingAccount.storeOrders (if extended), Transaction.storeOrder
17802
+ */
17625
17803
  export type StoreOrder = {
17626
17804
  __typename?: 'StoreOrder';
17627
17805
  appliedEntitlementId?: Maybe<Scalars['String']['output']>;
@@ -17669,7 +17847,11 @@ export type StorePaginationInput = {
17669
17847
  /** Number of items to skip (for offset pagination) */
17670
17848
  offset?: InputMaybe<Scalars['Int']['input']>;
17671
17849
  };
17672
- /** External entity stub for StoreProduct from store-svc. Federation gateway will resolve full StoreProduct data from store-svc. Used by: SubscriptionEntitlement.storeProduct */
17850
+ /**
17851
+ * External entity stub for StoreProduct from store-svc.
17852
+ * Federation gateway will resolve full StoreProduct data from store-svc.
17853
+ * Used by: SubscriptionEntitlement.storeProduct
17854
+ */
17673
17855
  export type StoreProduct = {
17674
17856
  __typename?: 'StoreProduct';
17675
17857
  /** Allow orders when out of stock (physical products) */
@@ -18113,7 +18295,10 @@ export type SubscriptionWebhookDeliveryUpdatedArgs = {
18113
18295
  export type SubscriptionWebhookReceivedArgs = {
18114
18296
  channelId: Scalars['ID']['input'];
18115
18297
  };
18116
- /** SubscriptionEntitlement defines what store items a plan grants access to. This allows plans to provide discounts or free access to store items. */
18298
+ /**
18299
+ * SubscriptionEntitlement defines what store items a plan grants access to.
18300
+ * This allows plans to provide discounts or free access to store items.
18301
+ */
18117
18302
  export type SubscriptionEntitlement = {
18118
18303
  __typename?: 'SubscriptionEntitlement';
18119
18304
  /** The type of access granted (FREE_ACCESS or DISCOUNT) */
@@ -18128,7 +18313,10 @@ export type SubscriptionEntitlement = {
18128
18313
  id: Scalars['ID']['output'];
18129
18314
  /** Reference to the store item entity (resolved via Federation) */
18130
18315
  item?: Maybe<StoreItem>;
18131
- /** Reference to the store item (external entity from Store service) Resolved via Federation 2 Gateway */
18316
+ /**
18317
+ * Reference to the store item (external entity from Store service)
18318
+ * Resolved via Federation 2 Gateway
18319
+ */
18132
18320
  itemId: Scalars['String']['output'];
18133
18321
  /** The plan that grants this entitlement */
18134
18322
  plan: Plan;
@@ -19037,7 +19225,10 @@ export type ToursResponse = {
19037
19225
  total: Scalars['Int']['output'];
19038
19226
  tours: Array<Tour>;
19039
19227
  };
19040
- /** Transaction entity - resolvable via Federation Gateway. Other services (e.g., store-svc) can reference Transaction by id. */
19228
+ /**
19229
+ * Transaction entity - resolvable via Federation Gateway.
19230
+ * Other services (e.g., store-svc) can reference Transaction by id.
19231
+ */
19041
19232
  export type Transaction = {
19042
19233
  __typename?: 'Transaction';
19043
19234
  amount: Scalars['Float']['output'];
@@ -20052,7 +20243,10 @@ export type UpdateSubscriptionInput = {
20052
20243
  planName?: InputMaybe<Scalars['String']['input']>;
20053
20244
  };
20054
20245
  export type UpdateSubscriptionSeatsInput = {
20055
- /** New seat count. Must be >= plan.minSeats. Applied immediately on Stripe (with proration) and at next cycle on Razorpay (proration delta charged as a separate one-time order). */
20246
+ /**
20247
+ * New seat count. Must be >= plan.minSeats. Applied immediately on Stripe (with proration)
20248
+ * and at next cycle on Razorpay (proration delta charged as a separate one-time order).
20249
+ */
20056
20250
  seatCount: Scalars['Int']['input'];
20057
20251
  subscriptionId: Scalars['ID']['input'];
20058
20252
  };
@@ -20390,7 +20584,11 @@ export type UsageTrends = {
20390
20584
  /** Predicted usage for next period */
20391
20585
  predictedUsage?: Maybe<Scalars['Float']['output']>;
20392
20586
  };
20393
- /** User type stub - represents a user entity from the auth/user service This service doesn't own the User model, but references it in usage tracking Federation gateway will resolve full User data from auth/user service. */
20587
+ /**
20588
+ * User type stub - represents a user entity from the auth/user service
20589
+ * This service doesn't own the User model, but references it in usage tracking
20590
+ * Federation gateway will resolve full User data from auth/user service.
20591
+ */
20394
20592
  export type User = {
20395
20593
  __typename?: 'User';
20396
20594
  /** Tickets assigned to this user (if support agent) */
@@ -20418,13 +20616,21 @@ export type User = {
20418
20616
  updatedAt: Scalars['DateTime']['output'];
20419
20617
  username: Scalars['String']['output'];
20420
20618
  };
20421
- /** User type stub - represents a user entity from the auth/user service This service doesn't own the User model, but references it in usage tracking Federation gateway will resolve full User data from auth/user service. */
20619
+ /**
20620
+ * User type stub - represents a user entity from the auth/user service
20621
+ * This service doesn't own the User model, but references it in usage tracking
20622
+ * Federation gateway will resolve full User data from auth/user service.
20623
+ */
20422
20624
  export type UserAssignedTicketsArgs = {
20423
20625
  filter?: InputMaybe<SupportTicketFilterInput>;
20424
20626
  limit?: InputMaybe<Scalars['Int']['input']>;
20425
20627
  offset?: InputMaybe<Scalars['Int']['input']>;
20426
20628
  };
20427
- /** User type stub - represents a user entity from the auth/user service This service doesn't own the User model, but references it in usage tracking Federation gateway will resolve full User data from auth/user service. */
20629
+ /**
20630
+ * User type stub - represents a user entity from the auth/user service
20631
+ * This service doesn't own the User model, but references it in usage tracking
20632
+ * Federation gateway will resolve full User data from auth/user service.
20633
+ */
20428
20634
  export type UserTicketsArgs = {
20429
20635
  filter?: InputMaybe<SupportTicketFilterInput>;
20430
20636
  limit?: InputMaybe<Scalars['Int']['input']>;