@stigg/api-client-js 2.412.2 → 2.415.0

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.
@@ -50,11 +50,16 @@ export declare enum AccountAccessMethod {
50
50
  }
51
51
  /** Account access role of the user */
52
52
  export declare enum AccountAccessRole {
53
+ /** User can view and manage environments they have been granted access to */
53
54
  Member = "MEMBER",
55
+ /** User has full ownership and control over the account */
54
56
  Owner = "OWNER"
55
57
  }
58
+ /** Account status */
56
59
  export declare enum AccountStatus {
60
+ /** The account is active and in use */
57
61
  Active = "ACTIVE",
62
+ /** The account is blocked and cannot be used */
58
63
  Blocked = "BLOCKED"
59
64
  }
60
65
  export declare type AddCompatibleAddonsToPlanInput = {
@@ -65,33 +70,45 @@ export declare type AddCompatibleAddonsToPlanInput = {
65
70
  };
66
71
  /** Archive addon input */
67
72
  export declare type AddonArchiveInput = {
68
- /** Environment id */
73
+ /** The unique identifier for the environment */
69
74
  environmentId?: InputMaybe<Scalars['String']>;
70
75
  /** Addon id */
71
76
  refId: Scalars['String'];
72
77
  };
73
78
  /** Query associated entities input */
74
79
  export declare type AddonAssociatedEntitiesInput = {
75
- /** Environment id */
80
+ /** The unique identifier for the environment */
76
81
  environmentId: Scalars['String'];
77
- /** Addon id */
82
+ /** Addon refId */
78
83
  refId: Scalars['String'];
79
84
  };
85
+ /** Input for creating an addon */
80
86
  export declare type AddonCreateInput = {
87
+ /** The additional meta data of the package */
81
88
  additionalMetaData?: InputMaybe<Scalars['JSON']>;
89
+ /** The AWS marketplace plan dimension of the package */
82
90
  awsMarketplacePlanDimension?: InputMaybe<Scalars['String']>;
91
+ /** The unique identifier for the entity in the billing provider */
83
92
  billingId?: InputMaybe<Scalars['String']>;
84
93
  /** List of addon ids this addon should be dependant on */
85
94
  dependencies?: InputMaybe<Array<Scalars['String']>>;
95
+ /** The description of the package */
86
96
  description?: InputMaybe<Scalars['String']>;
97
+ /** The display name of the package */
87
98
  displayName: Scalars['String'];
99
+ /** The unique identifier for the environment */
88
100
  environmentId?: InputMaybe<Scalars['String']>;
101
+ /** List of hidden widgets of the package */
89
102
  hiddenFromWidgets?: InputMaybe<Array<WidgetType>>;
90
103
  /** The maximum quantity of this addon that can be added to a subscription */
91
104
  maxQuantity?: InputMaybe<Scalars['Float']>;
105
+ /** The pricing type of the package */
92
106
  pricingType?: InputMaybe<PricingType>;
107
+ /** The product id of the package */
93
108
  productId: Scalars['String'];
109
+ /** The unique identifier for the entity */
94
110
  refId?: InputMaybe<Scalars['String']>;
111
+ /** The status of the package */
95
112
  status?: InputMaybe<PackageStatus>;
96
113
  };
97
114
  export declare type AddonFilter = {
@@ -133,7 +150,7 @@ export declare enum AddonSortFields {
133
150
  }
134
151
  /** Un-archive addon input */
135
152
  export declare type AddonUnArchiveInput = {
136
- /** Environment ID to unarchive the add-on in */
153
+ /** The unique identifier for the environment */
137
154
  environmentId?: InputMaybe<Scalars['String']>;
138
155
  /** Add-on ID to unarchive */
139
156
  id: Scalars['String'];
@@ -151,28 +168,47 @@ export declare type AddonUpdateInput = {
151
168
  maxQuantity?: InputMaybe<Scalars['Float']>;
152
169
  status?: InputMaybe<PackageStatus>;
153
170
  };
171
+ /** Customers address */
154
172
  export declare type Address = {
173
+ /** Address line 1 */
155
174
  addressLine1?: InputMaybe<Scalars['String']>;
175
+ /** Address line 2 */
156
176
  addressLine2?: InputMaybe<Scalars['String']>;
177
+ /** City */
157
178
  city?: InputMaybe<Scalars['String']>;
179
+ /** Country */
158
180
  country?: InputMaybe<Scalars['String']>;
181
+ /** Phone number */
159
182
  phoneNumber?: InputMaybe<Scalars['String']>;
183
+ /** Postal code */
160
184
  postalCode?: InputMaybe<Scalars['String']>;
185
+ /** State */
161
186
  state?: InputMaybe<Scalars['String']>;
162
187
  };
188
+ /** Input parameters for aggregating events by customer */
163
189
  export declare type AggregatedEventsByCustomerInput = {
190
+ /** Meter aggregation */
164
191
  aggregation: MeterAggregation;
192
+ /** Customer id */
165
193
  customerId?: InputMaybe<Scalars['String']>;
194
+ /** The unique identifier for the environment */
166
195
  environmentId: Scalars['String'];
196
+ /** List of event filters */
167
197
  filters: Array<MeterFilterDefinitionInput>;
168
198
  };
169
199
  /** Aggregation function */
170
200
  export declare enum AggregationFunction {
201
+ /** Average value */
171
202
  Avg = "AVG",
203
+ /** Count of the values */
172
204
  Count = "COUNT",
205
+ /** Maximum value */
173
206
  Max = "MAX",
207
+ /** Minimum value */
174
208
  Min = "MIN",
209
+ /** Sum of the values */
175
210
  Sum = "SUM",
211
+ /** Unique values */
176
212
  Unique = "UNIQUE"
177
213
  }
178
214
  /** Alignment */
@@ -194,12 +230,18 @@ export declare type ApiKeySort = {
194
230
  export declare enum ApiKeySortFields {
195
231
  Id = "id"
196
232
  }
233
+ /** The type of API key */
197
234
  export declare enum ApiKeyType {
235
+ /** Client-side API key */
198
236
  Client = "CLIENT",
237
+ /** Salesforce API key */
199
238
  Salesforce = "SALESFORCE",
239
+ /** Server-side API key */
200
240
  Server = "SERVER",
241
+ /** Workflow API key */
201
242
  Workflow = "WORKFLOW"
202
243
  }
244
+ /** Apply subscription changes input */
203
245
  export declare type ApplySubscriptionInput = {
204
246
  additionalMetaData?: InputMaybe<Scalars['JSON']>;
205
247
  addons?: InputMaybe<Array<SubscriptionAddonInput>>;
@@ -213,12 +255,15 @@ export declare type ApplySubscriptionInput = {
213
255
  billingPeriod?: InputMaybe<BillingPeriod>;
214
256
  /** Budget configuration */
215
257
  budget?: InputMaybe<BudgetConfigurationInput>;
258
+ /** Customer ID */
216
259
  customerId: Scalars['String'];
217
260
  /** The minimum spend configuration */
218
261
  minimumSpend?: InputMaybe<SubscriptionMinimumSpendValueInput>;
262
+ /** Paying customer ID */
219
263
  payingCustomerId?: InputMaybe<Scalars['String']>;
220
264
  /** Subscription payment collection method */
221
265
  paymentCollectionMethod?: InputMaybe<PaymentCollectionMethod>;
266
+ /** Payment method ID */
222
267
  paymentMethodId?: InputMaybe<Scalars['String']>;
223
268
  planId: Scalars['String'];
224
269
  /** Override the price of the subscription */
@@ -227,86 +272,132 @@ export declare type ApplySubscriptionInput = {
227
272
  resourceId?: InputMaybe<Scalars['String']>;
228
273
  salesforceId?: InputMaybe<Scalars['String']>;
229
274
  scheduleStrategy?: InputMaybe<ScheduleStrategy>;
275
+ /** Should skip trial */
230
276
  skipTrial?: InputMaybe<Scalars['Boolean']>;
231
277
  startDate?: InputMaybe<Scalars['DateTime']>;
232
278
  subscriptionEntitlements?: InputMaybe<Array<SubscriptionEntitlementInput>>;
233
279
  trialOverrideConfiguration?: InputMaybe<TrialOverrideConfigurationInput>;
234
280
  unitQuantity?: InputMaybe<Scalars['Float']>;
235
281
  };
282
+ /** Archive a coupon input */
236
283
  export declare type ArchiveCouponInput = {
284
+ /** The unique identifier for the environment */
237
285
  environmentId?: InputMaybe<Scalars['String']>;
286
+ /** The unique identifier for the entity */
238
287
  refId: Scalars['String'];
239
288
  };
240
289
  export declare type ArchiveCustomerInput = {
290
+ /** Customer slug */
241
291
  customerId: Scalars['String'];
292
+ /** The unique identifier for the environment */
242
293
  environmentId?: InputMaybe<Scalars['String']>;
243
294
  };
295
+ /** Input for archiving an environment */
244
296
  export declare type ArchiveEnvironmentInput = {
297
+ /** Unique identifier for the entity */
245
298
  id?: InputMaybe<Scalars['String']>;
299
+ /** A unique identifier for the environment */
246
300
  slug?: InputMaybe<Scalars['String']>;
247
301
  };
302
+ /** Input for archiving a feature */
248
303
  export declare type ArchiveFeatureInput = {
304
+ /** The unique identifier for the environment */
249
305
  environmentId?: InputMaybe<Scalars['String']>;
306
+ /** Unique identifier for the entity */
250
307
  id: Scalars['String'];
251
308
  };
252
- /** The input type for archiving package group */
309
+ /** The input type for archiving a package group */
253
310
  export declare type ArchivePackageGroup = {
254
- /** The environment id to get the package group in */
311
+ /** The unique identifier for the environment */
255
312
  environmentId: Scalars['String'];
256
313
  /** The id of the package group */
257
314
  packageGroupId: Scalars['String'];
258
315
  };
316
+ /** Input for archiving a plan */
259
317
  export declare type ArchivePlanInput = {
318
+ /** The unique identifier for the environment */
260
319
  environmentId?: InputMaybe<Scalars['String']>;
320
+ /** Plan ID to archive */
261
321
  id: Scalars['String'];
262
322
  };
323
+ /** Input for attaching a payment method to a customer */
263
324
  export declare type AttachCustomerPaymentMethodInput = {
264
325
  /** The currency to use for this payment method (only used for Zuora) */
265
326
  billingCurrency?: InputMaybe<Currency>;
327
+ /** Customer slug */
266
328
  customerId?: InputMaybe<Scalars['String']>;
329
+ /** The unique identifier for the environment */
267
330
  environmentId?: InputMaybe<Scalars['String']>;
268
331
  /** The billing integration to use for this payment method */
269
332
  integrationId?: InputMaybe<Scalars['String']>;
333
+ /** Billing provider payment method id */
270
334
  paymentMethodId: Scalars['String'];
335
+ /** Customer slug */
271
336
  refId?: InputMaybe<Scalars['String']>;
337
+ /** The integration type to attach the payment method to */
272
338
  vendorIdentifier: VendorIdentifier;
273
339
  };
274
- /** Auth0 application type. */
340
+ /** Auth0 application type */
275
341
  export declare enum Auth0ApplicationType {
342
+ /** Both individual and organization Auth0 application types */
276
343
  Both = "BOTH",
344
+ /** Individual Auth0 application type */
277
345
  Individual = "INDIVIDUAL",
346
+ /** Organization Auth0 application type */
278
347
  Organization = "ORGANIZATION"
279
348
  }
349
+ /** Input configuration for Auth0 integration */
280
350
  export declare type Auth0CredentialsInput = {
351
+ /** ID of the Auth0 application */
281
352
  applicationId: Scalars['String'];
353
+ /** Name of the Auth0 application */
282
354
  applicationName: Scalars['String'];
355
+ /** Type of the Auth0 application */
283
356
  applicationType: Auth0ApplicationType;
357
+ /** Domain of the Auth0 client */
284
358
  clientDomain: Scalars['String'];
359
+ /** ID of the Auth0 client */
285
360
  clientId: Scalars['String'];
361
+ /** Secret of the Auth0 client */
286
362
  clientSecret: Scalars['String'];
363
+ /** Initial plan ID for individual subscriptions */
287
364
  individualInitialPlanId?: InputMaybe<Scalars['String']>;
365
+ /** Setup for starting individual subscriptions */
288
366
  individualSubscriptionStartSetup?: InputMaybe<SubscriptionStartSetup>;
367
+ /** Initial plan ID for organization subscriptions */
289
368
  organizationInitialPlanId?: InputMaybe<Scalars['String']>;
369
+ /** Setup for starting organization subscriptions */
290
370
  organizationSubscriptionStartSetup?: InputMaybe<SubscriptionStartSetup>;
291
371
  };
292
- /** The input of the auto cancellation rule. */
372
+ /** Input for auto cancellation rule */
293
373
  export declare type AutoCancellationRuleInput = {
294
- /** The id of the source plan. */
374
+ /** ID of the source plan */
295
375
  sourcePlanId: Scalars['String'];
296
- /** The id of the target plan. */
376
+ /** ID of the target plan */
297
377
  targetPlanId: Scalars['String'];
298
378
  };
379
+ /** AWS Marketplace integration configuration for SaaS contract pricing model */
299
380
  export declare type AwsMarketplaceCredentialsInput = {
381
+ /** AWS IAM role ARN with StiggAWSMarketplaceAccess policy attached */
300
382
  awsRoleArn: Scalars['String'];
301
383
  };
384
+ /** Input configuration for Google BigQuery integration */
302
385
  export declare type BigQueryCredentialsInput = {
386
+ /** JSON credentials for Google BigQuery */
303
387
  credentialsJson: Scalars['String'];
388
+ /** ID of the BigQuery dataset */
304
389
  datasetId: Scalars['String'];
390
+ /** Location of the BigQuery dataset */
305
391
  datasetLocation: Scalars['String'];
392
+ /** Name of the Google Cloud Storage bucket */
306
393
  gcsBucketName: Scalars['String'];
394
+ /** Path within the Google Cloud Storage bucket */
307
395
  gcsBucketPath: Scalars['String'];
396
+ /** Access ID for the HMAC key */
308
397
  hmacKeyAccessId: Scalars['String'];
398
+ /** Secret for the HMAC key */
309
399
  hmacKeySecret: Scalars['String'];
400
+ /** ID of the Google Cloud project */
310
401
  projectId: Scalars['String'];
311
402
  };
312
403
  export declare type BillableFeatureInput = {
@@ -321,14 +412,20 @@ export declare type BillingAddress = {
321
412
  postalCode?: InputMaybe<Scalars['String']>;
322
413
  state?: InputMaybe<Scalars['String']>;
323
414
  };
415
+ /** Billing anchor for subscription billing */
324
416
  export declare enum BillingAnchor {
417
+ /** Billing will be anchored to the start of the month */
325
418
  StartOfTheMonth = "START_OF_THE_MONTH",
419
+ /** Subscriptions will consolidate billing to the start of the month */
326
420
  SubscriptionsConsolidateBilling = "SUBSCRIPTIONS_CONSOLIDATE_BILLING",
421
+ /** Billing will be anchored to the start of the subscription */
327
422
  SubscriptionStart = "SUBSCRIPTION_START"
328
423
  }
329
- /** Billing Cadence. */
424
+ /** Billing Cadence */
330
425
  export declare enum BillingCadence {
426
+ /** One off */
331
427
  OneOff = "ONE_OFF",
428
+ /** Recurring */
332
429
  Recurring = "RECURRING"
333
430
  }
334
431
  export declare type BillingCadenceFilterComparison = {
@@ -347,11 +444,15 @@ export declare type BillingCadenceFilterComparison = {
347
444
  notIn?: InputMaybe<Array<BillingCadence>>;
348
445
  notLike?: InputMaybe<BillingCadence>;
349
446
  };
350
- /** Billing model. */
447
+ /** Billing model */
351
448
  export declare enum BillingModel {
449
+ /** Flat fee */
352
450
  FlatFee = "FLAT_FEE",
451
+ /** Minimum spend */
353
452
  MinimumSpend = "MINIMUM_SPEND",
453
+ /** Per unit */
354
454
  PerUnit = "PER_UNIT",
455
+ /** Usage based */
355
456
  UsageBased = "USAGE_BASED"
356
457
  }
357
458
  export declare type BillingModelFilterComparison = {
@@ -370,9 +471,11 @@ export declare type BillingModelFilterComparison = {
370
471
  notIn?: InputMaybe<Array<BillingModel>>;
371
472
  notLike?: InputMaybe<BillingModel>;
372
473
  };
373
- /** Billing period. */
474
+ /** Billing period */
374
475
  export declare enum BillingPeriod {
476
+ /** Annually */
375
477
  Annually = "ANNUALLY",
478
+ /** Monthly */
376
479
  Monthly = "MONTHLY"
377
480
  }
378
481
  export declare type BillingPeriodFilterComparison = {
@@ -393,7 +496,7 @@ export declare type BillingPeriodFilterComparison = {
393
496
  };
394
497
  /** Billing vendor identifiers */
395
498
  export declare enum BillingVendorIdentifier {
396
- /** Stripe billing vendor */
499
+ /** Stripe */
397
500
  Stripe = "STRIPE"
398
501
  }
399
502
  export declare type BooleanFieldComparison = {
@@ -407,10 +510,15 @@ export declare type BudgetConfigurationInput = {
407
510
  /** The maximum spending limit */
408
511
  limit: Scalars['Float'];
409
512
  };
513
+ /** Change type enum */
410
514
  export declare enum ChangeType {
515
+ /** Added */
411
516
  Added = "ADDED",
517
+ /** Deleted */
412
518
  Deleted = "DELETED",
519
+ /** Modified */
413
520
  Modified = "MODIFIED",
521
+ /** Reordered */
414
522
  Reordered = "REORDERED"
415
523
  }
416
524
  /** Input for triggering an immediate usage charge for a subscription */
@@ -447,27 +555,42 @@ export declare type CheckoutPaletteInput = {
447
555
  summaryBackgroundColor?: InputMaybe<Scalars['String']>;
448
556
  textColor?: InputMaybe<Scalars['String']>;
449
557
  };
558
+ /** Checkout state input */
450
559
  export declare type CheckoutStateInput = {
560
+ /** The billing country code of the customer to checkout */
451
561
  billingCountryCode?: InputMaybe<Scalars['String']>;
562
+ /** Customer ID */
452
563
  customerId: Scalars['String'];
564
+ /** The plan ID to checkout */
453
565
  planId: Scalars['String'];
566
+ /** The Plan Product ID to checkout */
454
567
  productId?: InputMaybe<Scalars['String']>;
568
+ /** The resource ID to checkout */
455
569
  resourceId?: InputMaybe<Scalars['String']>;
456
570
  };
457
571
  export declare type ClearCustomerPersistentCacheInput = {
458
572
  customerId: Scalars['String'];
573
+ /** The unique identifier for the environment */
459
574
  environmentId?: InputMaybe<Scalars['String']>;
460
575
  resourceId?: InputMaybe<Scalars['String']>;
461
576
  };
462
577
  /** Condition operation */
463
578
  export declare enum ConditionOperation {
579
+ /** Equals operation */
464
580
  Equals = "EQUALS",
581
+ /** Greater than operation */
465
582
  GreaterThan = "GREATER_THAN",
583
+ /** Greater than or equal operation */
466
584
  GreaterThanOrEqual = "GREATER_THAN_OR_EQUAL",
585
+ /** Is not null operation */
467
586
  IsNotNull = "IS_NOT_NULL",
587
+ /** Is null operation */
468
588
  IsNull = "IS_NULL",
589
+ /** Less than operation */
469
590
  LessThan = "LESS_THAN",
591
+ /** Less than or equal operation */
470
592
  LessThanOrEqual = "LESS_THAN_OR_EQUAL",
593
+ /** Not equals operation */
471
594
  NotEquals = "NOT_EQUALS"
472
595
  }
473
596
  export declare type CouponFilter = {
@@ -524,8 +647,11 @@ export declare enum CouponSortFields {
524
647
  }
525
648
  /** The source of the coupon */
526
649
  export declare enum CouponSource {
650
+ /** Stigg */
527
651
  Stigg = "STIGG",
652
+ /** Stigg adhoc */
528
653
  StiggAdhoc = "STIGG_ADHOC",
654
+ /** Stripe */
529
655
  Stripe = "STRIPE"
530
656
  }
531
657
  export declare type CouponSourceFilterComparison = {
@@ -534,7 +660,9 @@ export declare type CouponSourceFilterComparison = {
534
660
  };
535
661
  /** The status of the coupon */
536
662
  export declare enum CouponStatus {
663
+ /** Active */
537
664
  Active = "ACTIVE",
665
+ /** Archived */
538
666
  Archived = "ARCHIVED"
539
667
  }
540
668
  export declare type CouponStatusFilterComparison = {
@@ -555,7 +683,9 @@ export declare type CouponStatusFilterComparison = {
555
683
  };
556
684
  /** The type of the coupon */
557
685
  export declare enum CouponType {
686
+ /** Fixed */
558
687
  Fixed = "FIXED",
688
+ /** Percentage */
559
689
  Percentage = "PERCENTAGE"
560
690
  }
561
691
  export declare type CouponTypeFilterComparison = {
@@ -574,72 +704,121 @@ export declare type CouponTypeFilterComparison = {
574
704
  notIn?: InputMaybe<Array<CouponType>>;
575
705
  notLike?: InputMaybe<CouponType>;
576
706
  };
707
+ /** Create a new coupon input */
577
708
  export declare type CreateCouponInput = {
709
+ /** Metadata associated with the entity */
578
710
  additionalMetaData?: InputMaybe<Scalars['JSON']>;
579
- /** Discount flat fee amounts off */
711
+ /** Fixed amount discounts in different currencies */
580
712
  amountsOff?: InputMaybe<Array<MoneyInputDto>>;
713
+ /** Description of the coupon */
581
714
  description?: InputMaybe<Scalars['String']>;
715
+ /** Discount value of the coupon (deprecated) */
582
716
  discountValue?: InputMaybe<Scalars['Float']>;
583
- /** The duration in months for which the coupon remains active. */
717
+ /** Duration of the coupon validity in months */
584
718
  durationInMonths?: InputMaybe<Scalars['Float']>;
719
+ /** The unique identifier for the environment */
585
720
  environmentId?: InputMaybe<Scalars['String']>;
721
+ /** Name of the coupon */
586
722
  name: Scalars['String'];
587
- /** Discount percent off */
723
+ /** Percentage discount off the original price */
588
724
  percentOff?: InputMaybe<Scalars['Float']>;
725
+ /** The unique identifier for the entity */
589
726
  refId: Scalars['String'];
727
+ /** Type of the coupon (percentage or fixed amount) */
590
728
  type?: InputMaybe<CouponType>;
591
729
  };
730
+ /** Input for creating a new environment */
592
731
  export declare type CreateEnvironment = {
732
+ /** The color used to distinguish this environment in the UI */
593
733
  color?: InputMaybe<Scalars['String']>;
734
+ /** The timestamp when the environment was created */
594
735
  createdAt?: InputMaybe<Scalars['DateTime']>;
736
+ /** Optional description of the environment */
595
737
  description?: InputMaybe<Scalars['String']>;
738
+ /** The name of the environment that will be displayed in the UI */
596
739
  displayName?: InputMaybe<Scalars['String']>;
740
+ /** Whether client-side security hardening is enabled for this environment */
597
741
  hardenClientAccessEnabled?: InputMaybe<Scalars['Boolean']>;
742
+ /** Unique identifier for the entity */
598
743
  id?: InputMaybe<Scalars['String']>;
744
+ /** The current provisioning status of the environment */
599
745
  provisionStatus?: InputMaybe<EnvironmentProvisionStatus>;
746
+ /** A unique identifier for the environment */
600
747
  slug?: InputMaybe<Scalars['String']>;
748
+ /** The type of environment (production or non-production) */
601
749
  type?: InputMaybe<EnvironmentType>;
602
750
  };
751
+ /** Additional options for environment creation */
603
752
  export declare type CreateEnvironmentOptions = {
753
+ /** Whether to automatically create a default product in the new environment */
604
754
  createDefaultProduct?: InputMaybe<Scalars['Boolean']>;
605
755
  };
756
+ /** Input parameters for creating a new experiment */
606
757
  export declare type CreateExperimentInput = {
758
+ /** Name for the control group */
607
759
  controlGroupName: Scalars['String'];
760
+ /** Description of the experiements */
608
761
  description?: InputMaybe<Scalars['String']>;
762
+ /** The unique identifier for the environment */
609
763
  environmentId?: InputMaybe<Scalars['String']>;
764
+ /** Name of the experiment */
610
765
  name: Scalars['String'];
766
+ /** Internal identifier for the product experiment is associated with */
611
767
  productId: Scalars['String'];
768
+ /** Product settings for the variant group */
612
769
  productSettings?: InputMaybe<ProductSettingsInput>;
770
+ /** Name for the variant group */
613
771
  variantGroupName: Scalars['String'];
772
+ /** Percentage of users in the variant group */
614
773
  variantPercentage: Scalars['Float'];
615
774
  };
616
775
  export declare type CreateHook = {
617
776
  /** A JSON containing the configuration for each event log type */
618
777
  configuration?: InputMaybe<Scalars['JSON']>;
778
+ /** Timestamp of when the record was created */
619
779
  createdAt?: InputMaybe<Scalars['DateTime']>;
780
+ /** Webhook description */
620
781
  description?: InputMaybe<Scalars['String']>;
782
+ /** The Webhook endpoint URL */
621
783
  endpoint?: InputMaybe<Scalars['String']>;
784
+ /** The unique identifier for the environment */
622
785
  environmentId?: InputMaybe<Scalars['String']>;
786
+ /** The event types that the webhook will be triggered on */
623
787
  eventLogTypes?: InputMaybe<Array<EventLogType>>;
788
+ /** Unique identifier for the entity */
624
789
  id?: InputMaybe<Scalars['String']>;
790
+ /** Secret key for the webhook */
625
791
  secretKey?: InputMaybe<Scalars['String']>;
792
+ /** The status of the webhook */
626
793
  status?: InputMaybe<HookStatus>;
627
794
  };
795
+ /** Create integration input */
628
796
  export declare type CreateIntegrationInput = {
797
+ /** Auth0 integration configuration */
629
798
  auth0Credentials?: InputMaybe<Auth0CredentialsInput>;
799
+ /** Amazon Web Services Marketplace integration configuration */
630
800
  awsMarketplaceCredentials?: InputMaybe<AwsMarketplaceCredentialsInput>;
801
+ /** Google BigQuery integration configuration */
631
802
  bigQueryCredentials?: InputMaybe<BigQueryCredentialsInput>;
803
+ /** The unique identifier for the environment */
632
804
  environmentId: Scalars['String'];
805
+ /** HubSpot integration configuration */
633
806
  hubspotCredentials?: InputMaybe<HubspotCredentialsInput>;
634
807
  /** The reference ID for the integration */
635
808
  integrationId?: InputMaybe<Scalars['String']>;
636
809
  /** Whether the integration is the default integration */
637
810
  isDefault?: InputMaybe<Scalars['Boolean']>;
811
+ /** OpenFGA integration configuration */
638
812
  openFGACredentials?: InputMaybe<OpenFgaCredentialsInput>;
813
+ /** Salesforce integration configuration */
639
814
  salesforceCredentials?: InputMaybe<SalesforceCredentialsInput>;
815
+ /** Snowflake integration configuration */
640
816
  snowflakeCredentials?: InputMaybe<SnowflakeCredentialsInput>;
817
+ /** Stripe integration configuration */
641
818
  stripeCredentials?: InputMaybe<StripeCredentialsInput>;
819
+ /** The vendor identifier of integration */
642
820
  vendorIdentifier: VendorIdentifier;
821
+ /** Zuora integration configuration */
643
822
  zuoraCredentials?: InputMaybe<ZuoraCredentialsInput>;
644
823
  };
645
824
  export declare type CreateManyPackageEntitlementsInput = {
@@ -650,12 +829,18 @@ export declare type CreateManyPromotionalEntitlementsInput = {
650
829
  /** Array of records to create */
651
830
  promotionalEntitlements: Array<PromotionalEntitlementInput>;
652
831
  };
832
+ /** A meter configuration that tracks and measures usage-based functionality */
653
833
  export declare type CreateMeter = {
834
+ /** Configuration specifying how to aggregate the meter data */
654
835
  aggregation: MeterAggregation;
836
+ /** List of filters that will be applied to the data */
655
837
  filters: Array<MeterFilterDefinitionInput>;
656
838
  };
839
+ /** Input for creating a single environment */
657
840
  export declare type CreateOneEnvironmentInput = {
841
+ /** The environment configuration details */
658
842
  environment: CreateEnvironment;
843
+ /** Additional options for environment creation */
659
844
  options?: InputMaybe<CreateEnvironmentOptions>;
660
845
  };
661
846
  export declare type CreateOneHookInput = {
@@ -666,37 +851,49 @@ export declare type CreateOneIntegrationInput = {
666
851
  /** The record to create */
667
852
  integration: CreateIntegrationInput;
668
853
  };
854
+ /** Input for creating a single product */
669
855
  export declare type CreateOneProductInput = {
670
- /** The record to create */
856
+ /** Record to create */
671
857
  product: ProductCreateInput;
672
858
  };
859
+ /** Create or update AWS Marketplace product input */
673
860
  export declare type CreateOrUpdateAwsMarketplaceProductInput = {
861
+ /** Additional metadata for the product */
674
862
  additionalMetaData?: InputMaybe<Scalars['JSON']>;
675
863
  /** Auto cancellation rules */
676
864
  autoCancellationRules?: InputMaybe<Array<AutoCancellationRuleInput>>;
865
+ /** Mapping between AWS dimensions and Stigg plans for entitlements */
677
866
  awsDimensionsMapping: Array<DimensionsMappingInput>;
867
+ /** AWS Marketplace product identifier */
678
868
  awsProductId?: InputMaybe<Scalars['String']>;
869
+ /** Description of the product */
679
870
  description?: InputMaybe<Scalars['String']>;
871
+ /** Display name of the product */
680
872
  displayName?: InputMaybe<Scalars['String']>;
873
+ /** The unique identifier for the environment */
681
874
  environmentId?: InputMaybe<Scalars['String']>;
875
+ /** Indicates if multiple subscriptions to this product are allowed */
682
876
  multipleSubscriptions?: InputMaybe<Scalars['Boolean']>;
877
+ /** Stigg product ID to be mapped to AWS Marketplace */
683
878
  productId?: InputMaybe<Scalars['String']>;
879
+ /** Settings for the product */
684
880
  productSettings?: InputMaybe<ProductSettingsInput>;
881
+ /** The unique identifier for the entity */
685
882
  refId?: InputMaybe<Scalars['String']>;
686
883
  /** Usage reset cutoff rule */
687
884
  usageResetCutoffRule?: InputMaybe<SubscriptionUpdateUsageResetCutoffRuleInput>;
688
885
  };
689
- /** The input type for creating an package group */
886
+ /** The input type for creating a package group */
690
887
  export declare type CreatePackageGroup = {
691
888
  /** The description of the package group */
692
889
  description?: InputMaybe<Scalars['String']>;
693
890
  /** The display name of the package group */
694
891
  displayName: Scalars['String'];
695
- /** The environment id to create the package group in */
892
+ /** The unique identifier for the environment */
696
893
  environmentId?: InputMaybe<Scalars['String']>;
697
894
  /** The id of the package group */
698
895
  packageGroupId: Scalars['String'];
699
- /** The id of the product */
896
+ /** The id of the related product */
700
897
  productId: Scalars['String'];
701
898
  };
702
899
  /** Create workflow trigger input */
@@ -705,7 +902,7 @@ export declare type CreateWorkflowTriggerInput = {
705
902
  configuration?: InputMaybe<Scalars['JSON']>;
706
903
  /** Workflow trigger endpoint */
707
904
  endpoint: Scalars['String'];
708
- /** Environment id */
905
+ /** The unique identifier for the environment */
709
906
  environmentId?: InputMaybe<Scalars['String']>;
710
907
  /** Event log types */
711
908
  eventLogTypes: Array<EventLogType>;
@@ -840,18 +1037,29 @@ export declare type CursorPaging = {
840
1037
  /** Paginate last */
841
1038
  last?: InputMaybe<Scalars['Int']>;
842
1039
  };
1040
+ /** Update customer billing information */
843
1041
  export declare type CustomerBillingInfo = {
1042
+ /** Customer billing address */
844
1043
  billingAddress?: InputMaybe<Address>;
1044
+ /** Customers selected currency */
845
1045
  currency?: InputMaybe<Currency>;
1046
+ /** Customer name */
846
1047
  customerName?: InputMaybe<Scalars['String']>;
847
1048
  /** The billing integration to use for this customer */
848
1049
  integrationId?: InputMaybe<Scalars['String']>;
1050
+ /** Invoice custom fields */
849
1051
  invoiceCustomFields?: InputMaybe<Scalars['JSON']>;
1052
+ /** Language to use for this customer */
850
1053
  language?: InputMaybe<Scalars['String']>;
1054
+ /** Additional metadata */
851
1055
  metadata?: InputMaybe<Scalars['JSON']>;
1056
+ /** Billing provider payment method id, attached to this customer */
852
1057
  paymentMethodId?: InputMaybe<Scalars['String']>;
1058
+ /** Customer shipping address */
853
1059
  shippingAddress?: InputMaybe<Address>;
1060
+ /** Tax IDs */
854
1061
  taxIds?: InputMaybe<Array<TaxExempt>>;
1062
+ /** Timezone to use for this customer */
855
1063
  timezone?: InputMaybe<Scalars['String']>;
856
1064
  };
857
1065
  export declare type CustomerFilter = {
@@ -911,20 +1119,35 @@ export declare type CustomerFilterPromotionalEntitlementFilter = {
911
1119
  status?: InputMaybe<PromotionalEntitlementStatusFilterComparison>;
912
1120
  updatedAt?: InputMaybe<DateFieldComparison>;
913
1121
  };
1122
+ /** Create a new customer */
914
1123
  export declare type CustomerInput = {
1124
+ /** Additional metadata */
915
1125
  additionalMetaData?: InputMaybe<Scalars['JSON']>;
1126
+ /** The AWS Marketplace integration id */
916
1127
  awsMarketplaceCustomerId?: InputMaybe<Scalars['String']>;
1128
+ /** The unique identifier for the entity in the billing provider */
917
1129
  billingId?: InputMaybe<Scalars['String']>;
1130
+ /** Customer billing information */
918
1131
  billingInformation?: InputMaybe<CustomerBillingInfo>;
1132
+ /** Customer level coupon */
919
1133
  couponRefId?: InputMaybe<Scalars['String']>;
1134
+ /** Timestamp of when the record was created */
920
1135
  createdAt?: InputMaybe<Scalars['DateTime']>;
1136
+ /** The unique identifier for the customer in Hubspot integration */
921
1137
  crmId?: InputMaybe<Scalars['String']>;
1138
+ /** Customer slug */
922
1139
  customerId?: InputMaybe<Scalars['String']>;
1140
+ /** The email of the customer */
923
1141
  email?: InputMaybe<Scalars['String']>;
1142
+ /** The unique identifier for the environment */
924
1143
  environmentId?: InputMaybe<Scalars['String']>;
1144
+ /** The name of the customer */
925
1145
  name?: InputMaybe<Scalars['String']>;
1146
+ /** Customer slug */
926
1147
  refId?: InputMaybe<Scalars['String']>;
1148
+ /** The unique identifier for the customer in Salesforce integration */
927
1149
  salesforceId?: InputMaybe<Scalars['String']>;
1150
+ /** Wether or not to sync free subscriptions to the billing provider */
928
1151
  shouldSyncFree?: InputMaybe<Scalars['Boolean']>;
929
1152
  };
930
1153
  export declare type CustomerPortalColorsPaletteInput = {
@@ -1189,6 +1412,7 @@ export declare type DateFieldComparisonBetween = {
1189
1412
  lower: Scalars['DateTime'];
1190
1413
  upper: Scalars['DateTime'];
1191
1414
  };
1415
+ /** Input type for default SSO roles */
1192
1416
  export declare type DefaultSsoRolesInput = {
1193
1417
  /** Account level access of the user */
1194
1418
  accountRole: AccountAccessRole;
@@ -1197,12 +1421,15 @@ export declare type DefaultSsoRolesInput = {
1197
1421
  /** Environment level access of the user */
1198
1422
  productionRole: EnvironmentAccessRole;
1199
1423
  };
1424
+ /** Default configuration for a trial */
1200
1425
  export declare type DefaultTrialConfigInputDto = {
1201
1426
  /** Budget configuration */
1202
1427
  budget?: InputMaybe<BudgetConfigurationInput>;
1428
+ /** The duration of the trial in the specified units */
1203
1429
  duration?: InputMaybe<Scalars['Float']>;
1204
1430
  /** Trial end behavior */
1205
1431
  trialEndBehavior?: InputMaybe<TrialEndBehavior>;
1432
+ /** The time unit for the trial duration (days or months) */
1206
1433
  units?: InputMaybe<TrialPeriodUnits>;
1207
1434
  };
1208
1435
  /** The input for delegating a subscription to a customer */
@@ -1214,8 +1441,11 @@ export declare type DelegateSubscriptionToCustomerInput = {
1214
1441
  /** The ID of the subscription to delegate */
1215
1442
  subscriptionId: Scalars['String'];
1216
1443
  };
1444
+ /** Input for deleting a feature */
1217
1445
  export declare type DeleteFeatureInput = {
1446
+ /** The unique identifier for the environment */
1218
1447
  environmentId?: InputMaybe<Scalars['String']>;
1448
+ /** Unique identifier for the entity */
1219
1449
  id: Scalars['String'];
1220
1450
  };
1221
1451
  export declare type DeleteOneHookInput = {
@@ -1234,8 +1464,9 @@ export declare type DeleteOnePriceInput = {
1234
1464
  /** The id of the record to delete. */
1235
1465
  id: Scalars['String'];
1236
1466
  };
1467
+ /** Input for deleting a product */
1237
1468
  export declare type DeleteOneProductInput = {
1238
- /** The id of the record to delete. */
1469
+ /** Unique identifier for the entity */
1239
1470
  id: Scalars['String'];
1240
1471
  };
1241
1472
  export declare type DeleteOnePromotionalEntitlementInput = {
@@ -1244,31 +1475,49 @@ export declare type DeleteOnePromotionalEntitlementInput = {
1244
1475
  };
1245
1476
  /** Delete workflow trigger input */
1246
1477
  export declare type DeleteWorkflowTriggerInput = {
1247
- /** Environment id */
1478
+ /** The unique identifier for the environment */
1248
1479
  environmentId?: InputMaybe<Scalars['String']>;
1249
1480
  /** Workflow trigger id */
1250
1481
  workflowTriggerId: Scalars['String'];
1251
1482
  };
1483
+ /** The department the user belongs to */
1252
1484
  export declare enum Department {
1485
+ /** CEO or Founder */
1253
1486
  CeoOrFounder = "CEO_OR_FOUNDER",
1487
+ /** Engineering */
1254
1488
  Engineering = "ENGINEERING",
1489
+ /** Growth */
1255
1490
  Growth = "GROWTH",
1491
+ /** Marketing */
1256
1492
  Marketing = "MARKETING",
1493
+ /** Monetization */
1257
1494
  Monetization = "MONETIZATION",
1495
+ /** Other */
1258
1496
  Other = "OTHER",
1497
+ /** Product */
1259
1498
  Product = "PRODUCT"
1260
1499
  }
1500
+ /** Remove a payment method from a customer */
1261
1501
  export declare type DetachCustomerPaymentMethodInput = {
1502
+ /** Customer slug */
1262
1503
  customerId: Scalars['String'];
1504
+ /** The unique identifier for the environment */
1263
1505
  environmentId?: InputMaybe<Scalars['String']>;
1264
1506
  };
1507
+ /** Configuration for mapping AWS Marketplace dimensions to Stigg plans */
1265
1508
  export declare type DimensionsMappingInput = {
1509
+ /** AWS dimension key for the mapping */
1266
1510
  key: Scalars['String'];
1511
+ /** Corresponding Stigg plan name for feature management */
1267
1512
  planName: Scalars['String'];
1513
+ /** Reference ID of the corresponding Stigg plan */
1268
1514
  planRefId: Scalars['String'];
1269
1515
  };
1516
+ /** Discard Package Draft Input */
1270
1517
  export declare type DiscardPackageDraftInput = {
1518
+ /** The unique identifier for the environment */
1271
1519
  environmentId: Scalars['String'];
1520
+ /** The unique identifier for the entity */
1272
1521
  refId: Scalars['String'];
1273
1522
  };
1274
1523
  /** The type of the discount duration */
@@ -1282,38 +1531,47 @@ export declare enum DiscountType {
1282
1531
  Fixed = "FIXED",
1283
1532
  Percentage = "PERCENTAGE"
1284
1533
  }
1534
+ /** Input for checking if a feature exists */
1285
1535
  export declare type DoesFeatureExist = {
1536
+ /** The unique identifier for the environment */
1286
1537
  environmentId: Scalars['String'];
1538
+ /** The unique identifier for the feature */
1287
1539
  refId: Scalars['String'];
1288
1540
  };
1289
- /** Input type for dumpEnvironmentForMergeComparison query. */
1541
+ /** Input for dumping two environments for comparison before a merge */
1290
1542
  export declare type DumpEnvironmentForForMergeComparisonInput = {
1291
- /** The slug of the environment to copy to. */
1543
+ /** Slug of the destination environment */
1292
1544
  destinationEnvironmentSlug: Scalars['String'];
1293
- /** Merge configuration. */
1545
+ /** Merge configuration */
1294
1546
  mergeConfiguration?: InputMaybe<EnvironmentMergeConfigurationInput>;
1295
- /** The slug of the environment to copy from. */
1547
+ /** Slug of the source environment */
1296
1548
  sourceEnvironmentSlug: Scalars['String'];
1297
1549
  };
1298
- /** Input type for dumpEnvironmentProductCatalog mutation. */
1550
+ /** Input type for dumpEnvironmentProductCatalog mutation */
1299
1551
  export declare type DumpEnvironmentProductCatalogInput = {
1300
- /** The slug of the environment to dump. */
1552
+ /** The slug of the environment to dump */
1301
1553
  environmentSlug: Scalars['String'];
1302
1554
  };
1555
+ /** Input for duplicating a product */
1303
1556
  export declare type DuplicateProductInput = {
1557
+ /** Description of the new product */
1304
1558
  description?: InputMaybe<Scalars['String']>;
1559
+ /** Display name of the new product */
1305
1560
  displayName?: InputMaybe<Scalars['String']>;
1561
+ /** The unique identifier for the environment */
1306
1562
  environmentId: Scalars['String'];
1563
+ /** The unique identifier for the entity */
1307
1564
  refId: Scalars['String'];
1565
+ /** ID of the product to duplicate */
1308
1566
  sourceProductId: Scalars['String'];
1309
1567
  };
1310
- /** The input type for editing package group details */
1568
+ /** The input type for editing a package group details */
1311
1569
  export declare type EditPackageGroupDetailsInput = {
1312
1570
  /** The description of the package group */
1313
1571
  description?: InputMaybe<Scalars['String']>;
1314
1572
  /** The display name of the package group */
1315
1573
  displayName: Scalars['String'];
1316
- /** The environment id of the package group to be edited */
1574
+ /** The unique identifier for the environment */
1317
1575
  environmentId?: InputMaybe<Scalars['String']>;
1318
1576
  /** The id of the package group */
1319
1577
  packageGroupId: Scalars['String'];
@@ -1349,25 +1607,38 @@ export declare type EntitlementCheckResult = {
1349
1607
  };
1350
1608
  export declare type EntitlementOptions = {
1351
1609
  requestedUsage?: InputMaybe<Scalars['Float']>;
1610
+ /** Not in use anymore */
1352
1611
  shouldTrack?: InputMaybe<Scalars['Boolean']>;
1353
1612
  };
1354
- /** Entitlement reset period. */
1613
+ /** Entitlement reset period */
1355
1614
  export declare enum EntitlementResetPeriod {
1615
+ /** Day */
1356
1616
  Day = "DAY",
1617
+ /** Hour */
1357
1618
  Hour = "HOUR",
1619
+ /** Month */
1358
1620
  Month = "MONTH",
1621
+ /** Week */
1359
1622
  Week = "WEEK",
1623
+ /** Year */
1360
1624
  Year = "YEAR"
1361
1625
  }
1626
+ /** Mode for selecting which entities to import */
1362
1627
  export declare enum EntitySelectionMode {
1628
+ /** Exclude specified entities from import */
1363
1629
  BlackList = "BLACK_LIST",
1630
+ /** Only import specified entities */
1364
1631
  WhiteList = "WHITE_LIST"
1365
1632
  }
1366
1633
  /** Environment access role of the user */
1367
1634
  export declare enum EnvironmentAccessRole {
1635
+ /** User has administrative access to the environment */
1368
1636
  Admin = "ADMIN",
1637
+ /** User has no access to the environment */
1369
1638
  None = "NONE",
1639
+ /** User has support-level access to the environment to manage customers and subscriptions */
1370
1640
  Support = "SUPPORT",
1641
+ /** User has read-only access to the environment */
1371
1642
  Viewer = "VIEWER"
1372
1643
  }
1373
1644
  export declare type EnvironmentFilter = {
@@ -1379,23 +1650,33 @@ export declare type EnvironmentFilter = {
1379
1650
  permanentDeletionDate?: InputMaybe<DateFieldComparison>;
1380
1651
  slug?: InputMaybe<StringFieldComparison>;
1381
1652
  };
1653
+ /** Input for updating an existing environment */
1382
1654
  export declare type EnvironmentInput = {
1655
+ /** The color used to distinguish this environment in the UI */
1383
1656
  color?: InputMaybe<Scalars['String']>;
1657
+ /** Optional description of the environment */
1384
1658
  description?: InputMaybe<Scalars['String']>;
1659
+ /** The name of the environment that will be displayed in the UI */
1385
1660
  displayName?: InputMaybe<Scalars['String']>;
1661
+ /** Whether client-side security hardening is enabled for this environment */
1386
1662
  hardenClientAccessEnabled?: InputMaybe<Scalars['Boolean']>;
1663
+ /** The current provisioning status of the environment */
1387
1664
  provisionStatus?: InputMaybe<EnvironmentProvisionStatus>;
1388
1665
  };
1389
- /** Merge configuration */
1666
+ /** Configuration options for customizing an environment merge or comparison process */
1390
1667
  export declare type EnvironmentMergeConfigurationInput = {
1391
- /** Whether to include coupons during the merge. */
1668
+ /** Whether to include coupons in the merge or comparison. Defaults to true if not specified */
1392
1669
  includeCoupons?: InputMaybe<Scalars['Boolean']>;
1393
1670
  };
1394
- /** EnvironmentProvisionStatus. */
1671
+ /** Represents the provisioning status of an environment */
1395
1672
  export declare enum EnvironmentProvisionStatus {
1673
+ /** The environment has been successfully provisioned */
1396
1674
  Done = "DONE",
1675
+ /** The environment provisioning process has failed */
1397
1676
  Failed = "FAILED",
1677
+ /** The environment provisioning process is currently in progress */
1398
1678
  InProgress = "IN_PROGRESS",
1679
+ /** The environment has not yet started the provisioning process */
1399
1680
  NotProvisioned = "NOT_PROVISIONED"
1400
1681
  }
1401
1682
  export declare type EnvironmentSort = {
@@ -1410,10 +1691,13 @@ export declare enum EnvironmentSortFields {
1410
1691
  PermanentDeletionDate = "permanentDeletionDate",
1411
1692
  Slug = "slug"
1412
1693
  }
1413
- /** EnvironmentType. */
1694
+ /** EnvironmentType */
1414
1695
  export declare enum EnvironmentType {
1696
+ /** Development environment, used for testing and development purposes */
1415
1697
  Development = "DEVELOPMENT",
1698
+ /** Production environment, used for live applications and services */
1416
1699
  Production = "PRODUCTION",
1700
+ /** Sandbox environment, used for isolated testing and experimentation */
1417
1701
  Sandbox = "SANDBOX"
1418
1702
  }
1419
1703
  /** error codes */
@@ -1731,80 +2015,150 @@ export declare enum EventLogSortFields {
1731
2015
  Id = "id",
1732
2016
  ParentEntityId = "parentEntityId"
1733
2017
  }
1734
- /** EventLogType */
2018
+ /** Event log type */
1735
2019
  export declare enum EventLogType {
2020
+ /** Addon created */
1736
2021
  AddonCreated = "ADDON_CREATED",
2022
+ /** Addon deleted */
1737
2023
  AddonDeleted = "ADDON_DELETED",
2024
+ /** Addon updated */
1738
2025
  AddonUpdated = "ADDON_UPDATED",
2026
+ /** Coupon archived */
1739
2027
  CouponArchived = "COUPON_ARCHIVED",
2028
+ /** Coupon created */
1740
2029
  CouponCreated = "COUPON_CREATED",
2030
+ /** Coupon updated */
1741
2031
  CouponUpdated = "COUPON_UPDATED",
2032
+ /** Create subscription failed */
1742
2033
  CreateSubscriptionFailed = "CREATE_SUBSCRIPTION_FAILED",
2034
+ /** Customer created */
1743
2035
  CustomerCreated = "CUSTOMER_CREATED",
2036
+ /** Customer deleted */
1744
2037
  CustomerDeleted = "CUSTOMER_DELETED",
2038
+ /** Customer entitlement calculation triggered */
1745
2039
  CustomerEntitlementCalculationTriggered = "CUSTOMER_ENTITLEMENT_CALCULATION_TRIGGERED",
2040
+ /** Customer payment failed */
1746
2041
  CustomerPaymentFailed = "CUSTOMER_PAYMENT_FAILED",
2042
+ /** Customer resource entitlement calculation triggered */
1747
2043
  CustomerResourceEntitlementCalculationTriggered = "CUSTOMER_RESOURCE_ENTITLEMENT_CALCULATION_TRIGGERED",
2044
+ /** Customer updated */
1748
2045
  CustomerUpdated = "CUSTOMER_UPDATED",
2046
+ /** Edge API customer data resync */
1749
2047
  EdgeApiCustomerDataResync = "EDGE_API_CUSTOMER_DATA_RESYNC",
2048
+ /** Edge API data resync */
1750
2049
  EdgeApiDataResync = "EDGE_API_DATA_RESYNC",
2050
+ /** Edge API Doggo resync */
1751
2051
  EdgeApiDoggoResync = "EDGE_API_DOGGO_RESYNC",
2052
+ /** Edge API package entitlements data resync */
1752
2053
  EdgeApiPackageEntitlementsDataResync = "EDGE_API_PACKAGE_ENTITLEMENTS_DATA_RESYNC",
2054
+ /** Edge API subscriptions data resync */
1753
2055
  EdgeApiSubscriptionsDataResync = "EDGE_API_SUBSCRIPTIONS_DATA_RESYNC",
2056
+ /** Entitlements updated */
1754
2057
  EntitlementsUpdated = "ENTITLEMENTS_UPDATED",
2058
+ /** Entitlement denied */
1755
2059
  EntitlementDenied = "ENTITLEMENT_DENIED",
2060
+ /** Entitlement granted */
1756
2061
  EntitlementGranted = "ENTITLEMENT_GRANTED",
2062
+ /** Entitlement requested */
1757
2063
  EntitlementRequested = "ENTITLEMENT_REQUESTED",
2064
+ /** Entitlement usage exceeded */
1758
2065
  EntitlementUsageExceeded = "ENTITLEMENT_USAGE_EXCEEDED",
2066
+ /** Environment deleted */
1759
2067
  EnvironmentDeleted = "ENVIRONMENT_DELETED",
2068
+ /** Feature archived */
1760
2069
  FeatureArchived = "FEATURE_ARCHIVED",
2070
+ /** Feature created */
1761
2071
  FeatureCreated = "FEATURE_CREATED",
2072
+ /** Feature deleted */
1762
2073
  FeatureDeleted = "FEATURE_DELETED",
2074
+ /** Feature updated */
1763
2075
  FeatureUpdated = "FEATURE_UPDATED",
2076
+ /** Import integration catalog triggered */
1764
2077
  ImportIntegrationCatalogTriggered = "IMPORT_INTEGRATION_CATALOG_TRIGGERED",
2078
+ /** Import integration customers triggered */
1765
2079
  ImportIntegrationCustomersTriggered = "IMPORT_INTEGRATION_CUSTOMERS_TRIGGERED",
2080
+ /** Import subscriptions bulk triggered */
1766
2081
  ImportSubscriptionsBulkTriggered = "IMPORT_SUBSCRIPTIONS_BULK_TRIGGERED",
2082
+ /** Measurement reported */
1767
2083
  MeasurementReported = "MEASUREMENT_REPORTED",
2084
+ /** Package group created */
1768
2085
  PackageGroupCreated = "PACKAGE_GROUP_CREATED",
2086
+ /** Package group updated */
1769
2087
  PackageGroupUpdated = "PACKAGE_GROUP_UPDATED",
2088
+ /** Package published */
1770
2089
  PackagePublished = "PACKAGE_PUBLISHED",
2090
+ /** Plan created */
1771
2091
  PlanCreated = "PLAN_CREATED",
2092
+ /** Plan deleted */
1772
2093
  PlanDeleted = "PLAN_DELETED",
2094
+ /** Plan updated */
1773
2095
  PlanUpdated = "PLAN_UPDATED",
2096
+ /** Product created */
1774
2097
  ProductCreated = "PRODUCT_CREATED",
2098
+ /** Product deleted */
1775
2099
  ProductDeleted = "PRODUCT_DELETED",
2100
+ /** Product updated */
1776
2101
  ProductUpdated = "PRODUCT_UPDATED",
2102
+ /** Promotional entitlement expired */
1777
2103
  PromotionalEntitlementExpired = "PROMOTIONAL_ENTITLEMENT_EXPIRED",
2104
+ /** Promotional entitlement granted */
1778
2105
  PromotionalEntitlementGranted = "PROMOTIONAL_ENTITLEMENT_GRANTED",
2106
+ /** Promotional entitlement revoked */
1779
2107
  PromotionalEntitlementRevoked = "PROMOTIONAL_ENTITLEMENT_REVOKED",
2108
+ /** Promotional entitlement updated */
1780
2109
  PromotionalEntitlementUpdated = "PROMOTIONAL_ENTITLEMENT_UPDATED",
2110
+ /** Recalculate entitlements triggered */
1781
2111
  RecalculateEntitlementsTriggered = "RECALCULATE_ENTITLEMENTS_TRIGGERED",
2112
+ /** Resync integration triggered */
1782
2113
  ResyncIntegrationTriggered = "RESYNC_INTEGRATION_TRIGGERED",
2114
+ /** Subscriptions migrated */
1783
2115
  SubscriptionsMigrated = "SUBSCRIPTIONS_MIGRATED",
2116
+ /** Subscriptions migration triggered */
1784
2117
  SubscriptionsMigrationTriggered = "SUBSCRIPTIONS_MIGRATION_TRIGGERED",
2118
+ /** Subscription billing month ends soon */
1785
2119
  SubscriptionBillingMonthEndsSoon = "SUBSCRIPTION_BILLING_MONTH_ENDS_SOON",
2120
+ /** Subscription canceled */
1786
2121
  SubscriptionCanceled = "SUBSCRIPTION_CANCELED",
2122
+ /** Subscription created */
1787
2123
  SubscriptionCreated = "SUBSCRIPTION_CREATED",
2124
+ /** Subscription expired */
1788
2125
  SubscriptionExpired = "SUBSCRIPTION_EXPIRED",
2126
+ /** Subscription spent limit exceeded */
1789
2127
  SubscriptionSpentLimitExceeded = "SUBSCRIPTION_SPENT_LIMIT_EXCEEDED",
2128
+ /** Subscription trial converted */
1790
2129
  SubscriptionTrialConverted = "SUBSCRIPTION_TRIAL_CONVERTED",
2130
+ /** Subscription trial ends soon */
1791
2131
  SubscriptionTrialEndsSoon = "SUBSCRIPTION_TRIAL_ENDS_SOON",
2132
+ /** Subscription trial expired */
1792
2133
  SubscriptionTrialExpired = "SUBSCRIPTION_TRIAL_EXPIRED",
2134
+ /** Subscription trial started */
1793
2135
  SubscriptionTrialStarted = "SUBSCRIPTION_TRIAL_STARTED",
2136
+ /** Subscription updated */
1794
2137
  SubscriptionUpdated = "SUBSCRIPTION_UPDATED",
2138
+ /** Subscription usage charge triggered */
1795
2139
  SubscriptionUsageChargeTriggered = "SUBSCRIPTION_USAGE_CHARGE_TRIGGERED",
2140
+ /** Subscription usage updated */
1796
2141
  SubscriptionUsageUpdated = "SUBSCRIPTION_USAGE_UPDATED",
2142
+ /** Sync failed */
1797
2143
  SyncFailed = "SYNC_FAILED",
2144
+ /** Widget configuration updated */
1798
2145
  WidgetConfigurationUpdated = "WIDGET_CONFIGURATION_UPDATED"
1799
2146
  }
2147
+ /** Input parameters for retrieving events fields */
1800
2148
  export declare type EventsFieldsInput = {
2149
+ /** Customer id */
1801
2150
  customerId?: InputMaybe<Scalars['String']>;
2151
+ /** The unique identifier for the environment */
1802
2152
  environmentId: Scalars['String'];
2153
+ /** Reference identifier for the feature */
1803
2154
  featureId?: InputMaybe<Scalars['String']>;
2155
+ /** Filters to apply to the events fields */
1804
2156
  filters?: InputMaybe<Array<MeterFilterDefinitionInput>>;
2157
+ /** Meter id */
1805
2158
  meterId?: InputMaybe<Scalars['String']>;
2159
+ /** Resource id */
1806
2160
  resourceId?: InputMaybe<Scalars['String']>;
1807
- /** Omit fields that have more than this number of unique values. */
2161
+ /** Exclude fields with more than this number of unique values */
1808
2162
  uniqueValuesLimit?: InputMaybe<Scalars['Float']>;
1809
2163
  };
1810
2164
  export declare type ExperimentFilter = {
@@ -1851,14 +2205,20 @@ export declare enum ExperimentSortFields {
1851
2205
  RefId = "refId",
1852
2206
  Status = "status"
1853
2207
  }
2208
+ /** Query parameters for retrieving experiment statistics */
1854
2209
  export declare type ExperimentStatsQuery = {
2210
+ /** The unique identifier for the environment */
1855
2211
  environmentId?: InputMaybe<Scalars['String']>;
2212
+ /** The unique identifier for the experiment */
1856
2213
  experimentRefId: Scalars['String'];
1857
2214
  };
1858
- /** The status of the EXPERIMENT */
2215
+ /** The status of the experiment */
1859
2216
  export declare enum ExperimentStatus {
2217
+ /** Experiment has been completed */
1860
2218
  Completed = "COMPLETED",
2219
+ /** Experiment is in draft state */
1861
2220
  Draft = "DRAFT",
2221
+ /** Experiment is currently running */
1862
2222
  InProgress = "IN_PROGRESS"
1863
2223
  }
1864
2224
  export declare type ExperimentStatusFilterComparison = {
@@ -1877,8 +2237,11 @@ export declare type ExperimentStatusFilterComparison = {
1877
2237
  notIn?: InputMaybe<Array<ExperimentStatus>>;
1878
2238
  notLike?: InputMaybe<ExperimentStatus>;
1879
2239
  };
2240
+ /** Input for getting the associated latest packages for a feature */
1880
2241
  export declare type FeatureAssociatedLatestPackages = {
2242
+ /** The unique identifier for the environment */
1881
2243
  environmentId: Scalars['String'];
2244
+ /** The ID of the feature */
1882
2245
  featureId: Scalars['String'];
1883
2246
  };
1884
2247
  export declare type FeatureFilter = {
@@ -1895,17 +2258,29 @@ export declare type FeatureFilter = {
1895
2258
  refId?: InputMaybe<StringFieldComparison>;
1896
2259
  updatedAt?: InputMaybe<DateFieldComparison>;
1897
2260
  };
2261
+ /** Input for creating a feature */
1898
2262
  export declare type FeatureInput = {
2263
+ /** The additional metadata for the feature */
1899
2264
  additionalMetaData?: InputMaybe<Scalars['JSON']>;
2265
+ /** The description for the feature */
1900
2266
  description?: InputMaybe<Scalars['String']>;
2267
+ /** The display name for the feature */
1901
2268
  displayName: Scalars['String'];
2269
+ /** The unique identifier for the environment */
1902
2270
  environmentId: Scalars['String'];
2271
+ /** The status of the feature */
1903
2272
  featureStatus?: InputMaybe<FeatureStatus>;
2273
+ /** The type of the feature */
1904
2274
  featureType: FeatureType;
2275
+ /** The units for the feature */
1905
2276
  featureUnits?: InputMaybe<Scalars['String']>;
2277
+ /** The plural units for the feature */
1906
2278
  featureUnitsPlural?: InputMaybe<Scalars['String']>;
2279
+ /** Input for creating a meter */
1907
2280
  meter?: InputMaybe<CreateMeter>;
2281
+ /** The meter type for the feature */
1908
2282
  meterType?: InputMaybe<MeterType>;
2283
+ /** The unique identifier for the feature */
1909
2284
  refId: Scalars['String'];
1910
2285
  /** Unit transformation to be applied to the reported usage */
1911
2286
  unitTransformation?: InputMaybe<UnitTransformationInput>;
@@ -1927,10 +2302,13 @@ export declare enum FeatureSortFields {
1927
2302
  RefId = "refId",
1928
2303
  UpdatedAt = "updatedAt"
1929
2304
  }
1930
- /** Feature status. */
2305
+ /** Feature status */
1931
2306
  export declare enum FeatureStatus {
2307
+ /** Active feature */
1932
2308
  Active = "ACTIVE",
2309
+ /** New feature */
1933
2310
  New = "NEW",
2311
+ /** Suspended feature */
1934
2312
  Suspended = "SUSPENDED"
1935
2313
  }
1936
2314
  export declare type FeatureStatusFilterComparison = {
@@ -1951,7 +2329,9 @@ export declare type FeatureStatusFilterComparison = {
1951
2329
  };
1952
2330
  /** The type of the feature */
1953
2331
  export declare enum FeatureType {
2332
+ /** Boolean feature type */
1954
2333
  Boolean = "BOOLEAN",
2334
+ /** Numeric feature type */
1955
2335
  Number = "NUMBER"
1956
2336
  }
1957
2337
  export declare type FeatureTypeFilterComparison = {
@@ -1997,38 +2377,59 @@ export declare type GetActiveSubscriptionsInput = {
1997
2377
  resourceId?: InputMaybe<Scalars['String']>;
1998
2378
  resourceIds?: InputMaybe<Array<Scalars['String']>>;
1999
2379
  };
2380
+ /** Input configuration for retrieving Auth0 applications */
2000
2381
  export declare type GetAuth0ApplicationsInput = {
2382
+ /** Domain of the Auth0 client */
2001
2383
  clientDomain: Scalars['String'];
2384
+ /** ID of the Auth0 client */
2002
2385
  clientId: Scalars['String'];
2386
+ /** Secret of the Auth0 client */
2003
2387
  clientSecret: Scalars['String'];
2388
+ /** The unique identifier for the environment */
2004
2389
  environmentId?: InputMaybe<Scalars['String']>;
2005
2390
  };
2391
+ /** Get a customer by slug */
2006
2392
  export declare type GetCustomerByRefIdInput = {
2393
+ /** Customer slug */
2007
2394
  customerId: Scalars['String'];
2395
+ /** The unique identifier for the environment */
2008
2396
  environmentId?: InputMaybe<Scalars['String']>;
2009
2397
  };
2398
+ /** Get Package By Ref Id Input */
2010
2399
  export declare type GetPackageByRefIdInput = {
2400
+ /** The unique identifier for the environment */
2011
2401
  environmentId: Scalars['String'];
2402
+ /** The unique identifier for the entity */
2012
2403
  refId: Scalars['String'];
2404
+ /** The version number of the package */
2013
2405
  versionNumber?: InputMaybe<Scalars['Float']>;
2014
2406
  };
2015
- /** The input type for getting an package group */
2407
+ /** The input type for getting a package group */
2016
2408
  export declare type GetPackageGroup = {
2017
- /** The environment id to get the package group in */
2409
+ /** The unique identifier for the environment */
2018
2410
  environmentId: Scalars['String'];
2019
- /** The id of the package group */
2411
+ /** The id of the package group to filter by */
2020
2412
  packageGroupId: Scalars['String'];
2021
- /** The version number of the package group */
2413
+ /** The version number of the package group to filter by */
2022
2414
  versionNumber?: InputMaybe<Scalars['Float']>;
2023
2415
  };
2416
+ /** Input for fetching the paywall */
2024
2417
  export declare type GetPaywallInput = {
2418
+ /** The country code for billing, e.g. US */
2025
2419
  billingCountryCode?: InputMaybe<Scalars['String']>;
2420
+ /** Context for the paywall, e.g. "checkout" or "subscription" */
2026
2421
  context?: InputMaybe<WidgetType>;
2422
+ /** The customer ID for whom the paywall is being fetched */
2027
2423
  customerId?: InputMaybe<Scalars['String']>;
2424
+ /** The unique identifier for the environment */
2028
2425
  environmentId?: InputMaybe<Scalars['String']>;
2426
+ /** Whether to fetch prices for all countries or just the specified billing country */
2029
2427
  fetchAllCountriesPrices?: InputMaybe<Scalars['Boolean']>;
2428
+ /** Whether to include hidden plans in the paywall */
2030
2429
  includeHiddenPlans?: InputMaybe<Scalars['Boolean']>;
2430
+ /** The product ID for which the paywall is being fetched */
2031
2431
  productId?: InputMaybe<Scalars['String']>;
2432
+ /** The resource ID for which the paywall is being fetched */
2032
2433
  resourceId?: InputMaybe<Scalars['String']>;
2033
2434
  };
2034
2435
  /** Get subscription input */
@@ -2039,33 +2440,50 @@ export declare type GetSubscriptionInput = {
2039
2440
  subscriptionId: Scalars['String'];
2040
2441
  };
2041
2442
  export declare type GetWidgetConfigurationInput = {
2443
+ /** The unique identifier for the environment */
2042
2444
  environmentId?: InputMaybe<Scalars['String']>;
2043
2445
  };
2044
2446
  /** Get workflow triggers input */
2045
2447
  export declare type GetWorkflowTriggersInput = {
2046
- /** Environment id */
2448
+ /** The unique identifier for the environment */
2047
2449
  environmentId?: InputMaybe<Scalars['String']>;
2048
2450
  /** Trigger id */
2049
2451
  triggerId?: InputMaybe<Scalars['String']>;
2050
2452
  /** Workflow trigger id */
2051
2453
  workflowTriggerId?: InputMaybe<Scalars['String']>;
2052
2454
  };
2455
+ /** Grant promotional entitlement input */
2053
2456
  export declare type GrantPromotionalEntitlementInput = {
2457
+ /** The custom end date of the promotional entitlement */
2054
2458
  customEndDate?: InputMaybe<Scalars['DateTime']>;
2459
+ /** The unique identifier of the entitlement feature */
2055
2460
  featureId: Scalars['String'];
2461
+ /** Whether the entitlement has a soft limit */
2056
2462
  hasSoftLimit?: InputMaybe<Scalars['Boolean']>;
2463
+ /** Whether the entitlement has an unlimited usage */
2057
2464
  hasUnlimitedUsage?: InputMaybe<Scalars['Boolean']>;
2465
+ /** Whether the entitlement is visible */
2058
2466
  isVisible?: InputMaybe<Scalars['Boolean']>;
2467
+ /** The monthly reset period configuration of the entitlement, defined when reset period is monthly */
2059
2468
  monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>;
2469
+ /** The grant period of the promotional entitlement */
2060
2470
  period: PromotionalEntitlementPeriod;
2471
+ /** The reset period of the entitlement */
2061
2472
  resetPeriod?: InputMaybe<EntitlementResetPeriod>;
2473
+ /** The usage limit of the entitlement */
2062
2474
  usageLimit?: InputMaybe<Scalars['Float']>;
2475
+ /** The weekly reset period configuration of the entitlement, defined when reset period is weekly */
2063
2476
  weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>;
2477
+ /** The yearly reset period configuration of the entitlement, defined when reset period is yearly */
2064
2478
  yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput>;
2065
2479
  };
2480
+ /** Grant multiple promotional entitlements input */
2066
2481
  export declare type GrantPromotionalEntitlementsInput = {
2482
+ /** The unique identifier of the entitlement customer */
2067
2483
  customerId: Scalars['String'];
2484
+ /** The unique identifier for the environment */
2068
2485
  environmentId?: InputMaybe<Scalars['String']>;
2486
+ /** Promotional entitlements to grant */
2069
2487
  promotionalEntitlements: Array<GrantPromotionalEntitlementInput>;
2070
2488
  };
2071
2489
  export declare type HookFilter = {
@@ -2089,9 +2507,11 @@ export declare enum HookSortFields {
2089
2507
  Id = "id",
2090
2508
  Status = "status"
2091
2509
  }
2092
- /** HookStatus. */
2510
+ /** Hook status */
2093
2511
  export declare enum HookStatus {
2512
+ /** Active */
2094
2513
  Active = "ACTIVE",
2514
+ /** Inactive */
2095
2515
  Inactive = "INACTIVE"
2096
2516
  }
2097
2517
  export declare type HookStatusFilterComparison = {
@@ -2110,45 +2530,79 @@ export declare type HookStatusFilterComparison = {
2110
2530
  notIn?: InputMaybe<Array<HookStatus>>;
2111
2531
  notLike?: InputMaybe<HookStatus>;
2112
2532
  };
2533
+ /** Input configuration for HubSpot integration */
2113
2534
  export declare type HubspotCredentialsInput = {
2535
+ /** Authorization code for HubSpot */
2114
2536
  authorizationCode: Scalars['String'];
2537
+ /** Refresh token for HubSpot */
2115
2538
  refreshToken?: InputMaybe<Scalars['String']>;
2116
2539
  };
2540
+ /** Input for importing a bulk of customers */
2117
2541
  export declare type ImportCustomerBulkInput = {
2542
+ /** List of customers to import */
2118
2543
  customers: Array<ImportCustomerInput>;
2544
+ /** The unique identifier for the environment */
2119
2545
  environmentId?: InputMaybe<Scalars['String']>;
2120
2546
  };
2547
+ /** Input for importing a customer */
2121
2548
  export declare type ImportCustomerInput = {
2549
+ /** Additional metadata */
2122
2550
  additionalMetaData?: InputMaybe<Scalars['JSON']>;
2551
+ /** Id in the billing provider */
2123
2552
  billingId?: InputMaybe<Scalars['String']>;
2553
+ /** Customer slug */
2124
2554
  customerId?: InputMaybe<Scalars['String']>;
2555
+ /** Customer email */
2125
2556
  email?: InputMaybe<Scalars['String']>;
2557
+ /** The unique identifier for the environment */
2126
2558
  environmentId?: InputMaybe<Scalars['String']>;
2559
+ /** Customer name */
2127
2560
  name?: InputMaybe<Scalars['String']>;
2561
+ /** Payment method Id in the billing provider */
2128
2562
  paymentMethodId?: InputMaybe<Scalars['String']>;
2563
+ /** Customer slug */
2129
2564
  refId?: InputMaybe<Scalars['String']>;
2565
+ /** The unique identifier for the customer in Salesforce integration */
2130
2566
  salesforceId?: InputMaybe<Scalars['String']>;
2131
2567
  /** Indicates the last update of the customer. In case there's already existing customer that was updated after that date, it will skip import this customer */
2132
2568
  updatedAt?: InputMaybe<Scalars['DateTime']>;
2133
2569
  };
2570
+ /** Input parameters for importing product catalog from an integration */
2134
2571
  export declare type ImportIntegrationCatalogInput = {
2572
+ /** Billing model configuration for the imported product */
2135
2573
  billingModel?: InputMaybe<BillingModel>;
2574
+ /** Mode for selecting plans to import (blacklist or whitelist) */
2136
2575
  entitySelectionMode: EntitySelectionMode;
2576
+ /** The unique identifier for the environment */
2137
2577
  environmentId: Scalars['String'];
2578
+ /** Singular name for the feature unit */
2138
2579
  featureUnitName?: InputMaybe<Scalars['String']>;
2580
+ /** Plural name for the feature unit */
2139
2581
  featureUnitPluralName?: InputMaybe<Scalars['String']>;
2582
+ /** List of plan IDs to exclude when using blacklist mode */
2140
2583
  plansSelectionBlacklist?: InputMaybe<Array<Scalars['String']>>;
2584
+ /** List of plan IDs to include when using whitelist mode */
2141
2585
  plansSelectionWhitelist?: InputMaybe<Array<Scalars['String']>>;
2586
+ /** Product ID to import from the integration */
2142
2587
  productId: Scalars['String'];
2588
+ /** List of addon billing IDs to import */
2143
2589
  selectedAddonBillingIds: Array<Scalars['String']>;
2590
+ /** The vendor identifier of integration */
2144
2591
  vendorIdentifier: VendorIdentifier;
2145
2592
  };
2593
+ /** Input parameters for importing customers from an integration */
2146
2594
  export declare type ImportIntegrationCustomersInput = {
2595
+ /** List of customer IDs to exclude when using blacklist mode */
2147
2596
  customersSelectionBlacklist?: InputMaybe<Array<Scalars['String']>>;
2597
+ /** List of customer IDs to include when using whitelist mode */
2148
2598
  customersSelectionWhitelist?: InputMaybe<Array<Scalars['String']>>;
2599
+ /** Mode for selecting customers to import (blacklist or whitelist) */
2149
2600
  entitySelectionMode: EntitySelectionMode;
2601
+ /** The unique identifier for the environment */
2150
2602
  environmentId: Scalars['String'];
2603
+ /** Product ID to import customers from */
2151
2604
  productId: Scalars['String'];
2605
+ /** The vendor identifier of integration */
2152
2606
  vendorIdentifier: VendorIdentifier;
2153
2607
  };
2154
2608
  export declare type ImportIntegrationTaskFilter = {
@@ -2194,8 +2648,11 @@ export declare type ImportSubscriptionsBulkInput = {
2194
2648
  environmentId?: InputMaybe<Scalars['String']>;
2195
2649
  subscriptions: Array<ImportSubscriptionInput>;
2196
2650
  };
2651
+ /** Input for initializing a payment method form for a customer */
2197
2652
  export declare type InitAddStripeCustomerPaymentMethodInput = {
2653
+ /** Customer slug */
2198
2654
  customerRefId: Scalars['String'];
2655
+ /** The unique identifier for the environment */
2199
2656
  environmentId?: InputMaybe<Scalars['String']>;
2200
2657
  /** The billing integration to use for this payment method */
2201
2658
  integrationId?: InputMaybe<Scalars['String']>;
@@ -2245,6 +2702,7 @@ export declare type IntegrationVendorTypeFilterComparison = {
2245
2702
  neq?: InputMaybe<VendorType>;
2246
2703
  notIn?: InputMaybe<Array<VendorType>>;
2247
2704
  };
2705
+ /** Input for inviting members */
2248
2706
  export declare type InviteMembersInput = {
2249
2707
  /** Account level access of the user, defaults to member role */
2250
2708
  accountRole?: InputMaybe<AccountAccessRole>;
@@ -2268,11 +2726,16 @@ export declare enum InvoiceLineItemType {
2268
2726
  TierCharge = "TierCharge",
2269
2727
  ZeroAmountBaseCharge = "ZeroAmountBaseCharge"
2270
2728
  }
2729
+ /** Input for retrieving AWS Marketplace product dimensions */
2271
2730
  export declare type ListAwsProductDimensionsInput = {
2731
+ /** The unique identifier for the environment */
2272
2732
  environmentId?: InputMaybe<Scalars['String']>;
2733
+ /** AWS product ID to fetch dimensions for */
2273
2734
  productId: Scalars['String'];
2274
2735
  };
2736
+ /** Input parameters for listing available AWS Marketplace products */
2275
2737
  export declare type ListAwsProductsInput = {
2738
+ /** The unique identifier for the environment */
2276
2739
  environmentId?: InputMaybe<Scalars['String']>;
2277
2740
  };
2278
2741
  /** Input for triggering the subscription invoice as paid */
@@ -2307,44 +2770,58 @@ export declare enum MemberSortFields {
2307
2770
  Email = "email",
2308
2771
  Id = "id"
2309
2772
  }
2310
- /** Member Status. */
2773
+ /** Member Status */
2311
2774
  export declare enum MemberStatus {
2775
+ /** User has been invited to the environment */
2312
2776
  Invited = "INVITED",
2777
+ /** User is a member of this environment */
2313
2778
  Registered = "REGISTERED"
2314
2779
  }
2315
- /** Input type for mergeEnvironment mutation. */
2780
+ /** Input type for mergeEnvironment mutation */
2316
2781
  export declare type MergeEnvironmentInput = {
2317
- /** The name of the new environment. Only relevant when `destinationEnvironmentSlug` is not passed. */
2782
+ /** Name for the new environment if destinationEnvironmentSlug is not provided */
2318
2783
  destinationEnvironmentName?: InputMaybe<Scalars['String']>;
2319
- /** The slug of the environment to merge into. Not passing this will create a new environment and requires passing `destinationEnvironmentName`. */
2784
+ /** Slug of the destination environment to merge into. If not provided, a new environment will be created */
2320
2785
  destinationEnvironmentSlug?: InputMaybe<Scalars['String']>;
2321
- /** The type of the new environment. only relevant when `destinationEnvironmentSlug` is not passed. */
2786
+ /** Type for the new environment if destinationEnvironmentSlug is not provided */
2322
2787
  destinationEnvironmentType?: InputMaybe<EnvironmentType>;
2323
- /** Merge configuration */
2788
+ /** Optional configuration to customize the merge process */
2324
2789
  mergeConfiguration?: InputMaybe<EnvironmentMergeConfigurationInput>;
2325
- /** How to migrate customers to newer plan version of updated plans. Default is not to migrate existing customers. */
2790
+ /** How to migrate customers to newer plan version of updated plans. Default is not to migrate existing customers */
2326
2791
  migrationType?: InputMaybe<PublishMigrationType>;
2327
- /** The slug of the environment to copy from. If missing `sourceTemplate` will be used. */
2792
+ /** Slug of the source environment to merge from. Either this or sourceTemplate must be provided */
2328
2793
  sourceEnvironmentSlug?: InputMaybe<Scalars['String']>;
2329
- /** The product catalog template to apply. Only relevant when `sourceEnvironmentSlug` is not passed. */
2794
+ /** A template dump of the source environment. Either this or sourceEnvironmentSlug must be provided */
2330
2795
  sourceTemplate?: InputMaybe<Scalars['JSON']>;
2331
2796
  };
2797
+ /** Defines how meter data should be aggregated using a specified aggregation function */
2332
2798
  export declare type MeterAggregation = {
2799
+ /** The data field to which the aggregation function will be applied */
2333
2800
  field?: InputMaybe<Scalars['String']>;
2801
+ /** The aggregation function to apply to the data (e.g. SUM, AVG, COUNT) */
2334
2802
  function: AggregationFunction;
2335
2803
  };
2804
+ /** A condition that will be used to filter the data */
2336
2805
  export declare type MeterConditionInput = {
2806
+ /** The field to filter on */
2337
2807
  field: Scalars['String'];
2808
+ /** The operation to perform on the field */
2338
2809
  operation: ConditionOperation;
2810
+ /** The value of the field to filter on */
2339
2811
  value?: InputMaybe<Scalars['String']>;
2340
2812
  };
2813
+ /** A configuration defining how to filter the data */
2341
2814
  export declare type MeterFilterDefinitionInput = {
2815
+ /** List of conditions that will be applied to the data */
2342
2816
  conditions: Array<MeterConditionInput>;
2343
2817
  };
2344
2818
  /** The meter type of the feature */
2345
2819
  export declare enum MeterType {
2820
+ /** Fluctuating */
2346
2821
  Fluctuating = "Fluctuating",
2822
+ /** Incremental */
2347
2823
  Incremental = "Incremental",
2824
+ /** None */
2348
2825
  None = "None"
2349
2826
  }
2350
2827
  export declare type MeterTypeFilterComparison = {
@@ -2365,21 +2842,28 @@ export declare type MeterTypeFilterComparison = {
2365
2842
  };
2366
2843
  /** Minimum spend input */
2367
2844
  export declare type MinimumSpendInput = {
2368
- /** The billing period of minimum spend */
2845
+ /** The billing period of the price */
2369
2846
  billingPeriod: BillingPeriod;
2370
2847
  /** The minimum spend value */
2371
2848
  minimum: MoneyInputDto;
2372
2849
  };
2850
+ /** Money Input */
2373
2851
  export declare type MoneyInputDto = {
2852
+ /** The price amount */
2374
2853
  amount: Scalars['Float'];
2854
+ /** The price currency */
2375
2855
  currency?: InputMaybe<Currency>;
2376
2856
  };
2377
2857
  /** Monthly reset period according to configuration */
2378
2858
  export declare enum MonthlyAccordingTo {
2859
+ /** Start of the month */
2379
2860
  StartOfTheMonth = "StartOfTheMonth",
2861
+ /** Subscription start */
2380
2862
  SubscriptionStart = "SubscriptionStart"
2381
2863
  }
2864
+ /** Monthly reset period config input */
2382
2865
  export declare type MonthlyResetPeriodConfigInput = {
2866
+ /** Monthly according to configuration */
2383
2867
  accordingTo: MonthlyAccordingTo;
2384
2868
  };
2385
2869
  export declare type NumberFieldComparison = {
@@ -2400,12 +2884,19 @@ export declare type NumberFieldComparisonBetween = {
2400
2884
  lower: Scalars['Float'];
2401
2885
  upper: Scalars['Float'];
2402
2886
  };
2887
+ /** Input configuration for OpenFGA integration */
2403
2888
  export declare type OpenFgaCredentialsInput = {
2889
+ /** Audience for the OpenFGA API */
2404
2890
  apiAudience: Scalars['String'];
2891
+ /** Issuer of the OpenFGA API token */
2405
2892
  apiTokenIssuer: Scalars['String'];
2893
+ /** URL of the OpenFGA API */
2406
2894
  apiUrl: Scalars['String'];
2895
+ /** Client ID for the OpenFGA API */
2407
2896
  clientId: Scalars['String'];
2897
+ /** Client secret for OpenFGA */
2408
2898
  clientSecret: Scalars['String'];
2899
+ /** ID of the OpenFGA store */
2409
2900
  storeId?: InputMaybe<Scalars['String']>;
2410
2901
  };
2411
2902
  /** Configures when the overage charge is billed. */
@@ -2413,28 +2904,48 @@ export declare enum OverageBillingPeriod {
2413
2904
  Monthly = "MONTHLY",
2414
2905
  OnSubscriptionRenewal = "ON_SUBSCRIPTION_RENEWAL"
2415
2906
  }
2907
+ /** Overage Entitlement Create Input */
2416
2908
  export declare type OverageEntitlementCreateInput = {
2417
2909
  /** The behavior of the entitlement */
2418
2910
  behavior?: InputMaybe<EntitlementBehavior>;
2911
+ /** The description of the entitlement */
2419
2912
  description?: InputMaybe<Scalars['String']>;
2913
+ /** The display name override of the entitlement */
2420
2914
  displayNameOverride?: InputMaybe<Scalars['String']>;
2915
+ /** The unique identifier of the entitlement feature */
2421
2916
  featureId: Scalars['String'];
2917
+ /** Whether the entitlement has a soft limit */
2422
2918
  hasSoftLimit?: InputMaybe<Scalars['Boolean']>;
2919
+ /** Whether the entitlement has an unlimited usage */
2423
2920
  hasUnlimitedUsage?: InputMaybe<Scalars['Boolean']>;
2921
+ /** Whether the entitlement is hidden from widgets */
2424
2922
  hiddenFromWidgets?: InputMaybe<Array<WidgetType>>;
2923
+ /** Whether the entitlement is a custom entitlement */
2425
2924
  isCustom?: InputMaybe<Scalars['Boolean']>;
2925
+ /** The monthly reset period configuration of the entitlement, defined when reset period is monthly */
2426
2926
  monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>;
2927
+ /** The order of the entitlement in the entitlement list */
2427
2928
  order?: InputMaybe<Scalars['Float']>;
2929
+ /** The reset period of the entitlement */
2428
2930
  resetPeriod?: InputMaybe<EntitlementResetPeriod>;
2931
+ /** The usage limit of the entitlement */
2429
2932
  usageLimit?: InputMaybe<Scalars['Float']>;
2933
+ /** The weekly reset period configuration of the entitlement, defined when reset period is weekly */
2430
2934
  weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>;
2935
+ /** The yearly reset period configuration of the entitlement, defined when reset period is yearly */
2431
2936
  yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput>;
2432
2937
  };
2938
+ /** Overage Pricing Model Create Input */
2433
2939
  export declare type OveragePricingModelCreateInput = {
2940
+ /** The billing cadence of the base pricing model */
2434
2941
  billingCadence?: InputMaybe<BillingCadence>;
2942
+ /** The billing model of the base pricing model */
2435
2943
  billingModel: BillingModel;
2944
+ /** The entitlement of the overage pricing model */
2436
2945
  entitlement?: InputMaybe<OverageEntitlementCreateInput>;
2946
+ /** The feature id of the base pricing model */
2437
2947
  featureId?: InputMaybe<Scalars['String']>;
2948
+ /** The price periods of the base pricing model */
2438
2949
  pricePeriods: Array<PricePeriodInput>;
2439
2950
  };
2440
2951
  export declare type PackageDtoFilter = {
@@ -2516,23 +3027,39 @@ export declare type PackageEntitlementFilterPackageDtoFilter = {
2516
3027
  updatedAt?: InputMaybe<DateFieldComparison>;
2517
3028
  versionNumber?: InputMaybe<IntFieldComparison>;
2518
3029
  };
3030
+ /** Package entitlement input */
2519
3031
  export declare type PackageEntitlementInput = {
2520
3032
  /** The behavior of the entitlement */
2521
3033
  behavior?: InputMaybe<EntitlementBehavior>;
3034
+ /** The description of the entitlement */
2522
3035
  description?: InputMaybe<Scalars['String']>;
3036
+ /** The display name override of the entitlement */
2523
3037
  displayNameOverride?: InputMaybe<Scalars['String']>;
3038
+ /** The unique identifier for the environment */
2524
3039
  environmentId: Scalars['String'];
3040
+ /** The unique identifier of the entitlement feature */
2525
3041
  featureId: Scalars['String'];
3042
+ /** Whether the entitlement has a soft limit */
2526
3043
  hasSoftLimit?: InputMaybe<Scalars['Boolean']>;
3044
+ /** Whether the entitlement has an unlimited usage */
2527
3045
  hasUnlimitedUsage?: InputMaybe<Scalars['Boolean']>;
3046
+ /** Whether the entitlement is hidden from widgets */
2528
3047
  hiddenFromWidgets?: InputMaybe<Array<WidgetType>>;
3048
+ /** Whether the entitlement is a custom entitlement */
2529
3049
  isCustom?: InputMaybe<Scalars['Boolean']>;
3050
+ /** The monthly reset period configuration of the entitlement, defined when reset period is monthly */
2530
3051
  monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>;
3052
+ /** The order of the entitlement in the entitlement list */
2531
3053
  order?: InputMaybe<Scalars['Float']>;
3054
+ /** The unique identifier of the entitlement package */
2532
3055
  packageId: Scalars['String'];
3056
+ /** The reset period of the entitlement */
2533
3057
  resetPeriod?: InputMaybe<EntitlementResetPeriod>;
3058
+ /** The usage limit of the entitlement */
2534
3059
  usageLimit?: InputMaybe<Scalars['Float']>;
3060
+ /** The weekly reset period configuration of the entitlement, defined when reset period is weekly */
2535
3061
  weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>;
3062
+ /** The yearly reset period configuration of the entitlement, defined when reset period is yearly */
2536
3063
  yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput>;
2537
3064
  };
2538
3065
  export declare type PackageEntitlementSort = {
@@ -2547,20 +3074,33 @@ export declare enum PackageEntitlementSortFields {
2547
3074
  PackageId = "packageId",
2548
3075
  UpdatedAt = "updatedAt"
2549
3076
  }
3077
+ /** Package entitlement update input */
2550
3078
  export declare type PackageEntitlementUpdateInput = {
2551
3079
  /** The behavior of the entitlement */
2552
3080
  behavior?: InputMaybe<EntitlementBehavior>;
3081
+ /** The description of the entitlement */
2553
3082
  description?: InputMaybe<Scalars['String']>;
3083
+ /** The display name override of the entitlement */
2554
3084
  displayNameOverride?: InputMaybe<Scalars['String']>;
3085
+ /** Whether the entitlement has a soft limit */
2555
3086
  hasSoftLimit?: InputMaybe<Scalars['Boolean']>;
3087
+ /** Whether the entitlement has an unlimited usage */
2556
3088
  hasUnlimitedUsage?: InputMaybe<Scalars['Boolean']>;
3089
+ /** Whether the entitlement is hidden from widgets */
2557
3090
  hiddenFromWidgets?: InputMaybe<Array<WidgetType>>;
3091
+ /** Whether the entitlement is a custom entitlement */
2558
3092
  isCustom?: InputMaybe<Scalars['Boolean']>;
3093
+ /** The monthly reset period configuration of the entitlement, defined when reset period is monthly */
2559
3094
  monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>;
3095
+ /** The order of the entitlement in the entitlement list */
2560
3096
  order?: InputMaybe<Scalars['Float']>;
3097
+ /** The reset period of the entitlement */
2561
3098
  resetPeriod?: InputMaybe<EntitlementResetPeriod>;
3099
+ /** The usage limit of the entitlement */
2562
3100
  usageLimit?: InputMaybe<Scalars['Float']>;
3101
+ /** The weekly reset period configuration of the entitlement, defined when reset period is weekly */
2563
3102
  weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>;
3103
+ /** The yearly reset period configuration of the entitlement, defined when reset period is yearly */
2564
3104
  yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput>;
2565
3105
  };
2566
3106
  export declare type PackageGroupFilter = {
@@ -2608,13 +3148,13 @@ export declare enum PackageGroupSortFields {
2608
3148
  UpdatedAt = "updatedAt",
2609
3149
  VersionNumber = "versionNumber"
2610
3150
  }
2611
- /** Package group status. */
3151
+ /** Package group status */
2612
3152
  export declare enum PackageGroupStatus {
2613
- /** The package group is archived. */
3153
+ /** The package group is archived */
2614
3154
  Archived = "ARCHIVED",
2615
- /** The package group is a draft. */
3155
+ /** The package group is a draft */
2616
3156
  Draft = "DRAFT",
2617
- /** The package group is published. */
3157
+ /** The package group is published */
2618
3158
  Published = "PUBLISHED"
2619
3159
  }
2620
3160
  export declare type PackageGroupStatusFilterComparison = {
@@ -2633,19 +3173,30 @@ export declare type PackageGroupStatusFilterComparison = {
2633
3173
  notIn?: InputMaybe<Array<PackageGroupStatus>>;
2634
3174
  notLike?: InputMaybe<PackageGroupStatus>;
2635
3175
  };
3176
+ /** Package Pricing Input */
2636
3177
  export declare type PackagePricingInput = {
3178
+ /** The unique identifier for the environment */
2637
3179
  environmentId: Scalars['String'];
2638
3180
  /** The minimum spend configuration per each billing period */
2639
3181
  minimumSpend?: InputMaybe<Array<MinimumSpendInput>>;
3182
+ /** The overage billing period of the package pricing */
2640
3183
  overageBillingPeriod?: InputMaybe<OverageBillingPeriod>;
3184
+ /** The list of overage pricing models of the package pricing */
2641
3185
  overagePricingModels?: InputMaybe<Array<OveragePricingModelCreateInput>>;
3186
+ /** The package id of the price */
2642
3187
  packageId: Scalars['String'];
3188
+ /** The pricing model of the package pricing */
2643
3189
  pricingModel?: InputMaybe<PricingModelCreateInput>;
3190
+ /** The list of pricing models of the package pricing */
2644
3191
  pricingModels?: InputMaybe<Array<PricingModelCreateInput>>;
3192
+ /** The pricing type of the package pricing */
2645
3193
  pricingType: PricingType;
2646
3194
  };
3195
+ /** Package Publish Input */
2647
3196
  export declare type PackagePublishInput = {
3197
+ /** Unique identifier for the entity */
2648
3198
  id: Scalars['ID'];
3199
+ /** The migration type of the package */
2649
3200
  migrationType: PublishMigrationType;
2650
3201
  };
2651
3202
  /** Package status. */
@@ -2704,8 +3255,11 @@ export declare enum PaymentCollectionMethod {
2704
3255
  }
2705
3256
  /** Type of a payment method */
2706
3257
  export declare enum PaymentMethodType {
3258
+ /** Bank Transfer */
2707
3259
  Bank = "BANK",
3260
+ /** Credit Card */
2708
3261
  Card = "CARD",
3262
+ /** Cash App */
2709
3263
  CashApp = "CASH_APP"
2710
3264
  }
2711
3265
  export declare type PaywallColorsPaletteInput = {
@@ -2736,18 +3290,31 @@ export declare enum PlanChangeType {
2736
3290
  /** Subscription upgrade to higher plan */
2737
3291
  Upgrade = "UPGRADE"
2738
3292
  }
3293
+ /** Input for creating a plan */
2739
3294
  export declare type PlanCreateInput = {
3295
+ /** The additional meta data of the package */
2740
3296
  additionalMetaData?: InputMaybe<Scalars['JSON']>;
3297
+ /** The AWS marketplace plan dimension of the package */
2741
3298
  awsMarketplacePlanDimension?: InputMaybe<Scalars['String']>;
3299
+ /** The unique identifier for the entity in the billing provider */
2742
3300
  billingId?: InputMaybe<Scalars['String']>;
3301
+ /** The description of the package */
2743
3302
  description?: InputMaybe<Scalars['String']>;
3303
+ /** The display name of the package */
2744
3304
  displayName: Scalars['String'];
3305
+ /** The unique identifier for the environment */
2745
3306
  environmentId?: InputMaybe<Scalars['String']>;
3307
+ /** List of hidden widgets of the package */
2746
3308
  hiddenFromWidgets?: InputMaybe<Array<WidgetType>>;
3309
+ /** The ID of the parent plan, if applicable */
2747
3310
  parentPlanId?: InputMaybe<Scalars['String']>;
3311
+ /** The pricing type of the package */
2748
3312
  pricingType?: InputMaybe<PricingType>;
3313
+ /** The product id of the package */
2749
3314
  productId: Scalars['String'];
3315
+ /** The unique identifier for the entity */
2750
3316
  refId?: InputMaybe<Scalars['String']>;
3317
+ /** The status of the package */
2751
3318
  status?: InputMaybe<PackageStatus>;
2752
3319
  };
2753
3320
  export declare type PlanFilter = {
@@ -2821,21 +3388,34 @@ export declare enum PlanSortFields {
2821
3388
  UpdatedAt = "updatedAt",
2822
3389
  VersionNumber = "versionNumber"
2823
3390
  }
3391
+ /** Input for updating a plan */
2824
3392
  export declare type PlanUpdateInput = {
3393
+ /** Additional metadata for the plan, e.g. features or tags */
2825
3394
  additionalMetaData?: InputMaybe<Scalars['JSON']>;
3395
+ /** The unique identifier for the entity in the billing provider */
2826
3396
  billingId?: InputMaybe<Scalars['String']>;
3397
+ /** Default trial configuration for the plan */
2827
3398
  defaultTrialConfig?: InputMaybe<DefaultTrialConfigInputDto>;
3399
+ /** The description of the plan */
2828
3400
  description?: InputMaybe<Scalars['String']>;
3401
+ /** The display name of the plan */
2829
3402
  displayName?: InputMaybe<Scalars['String']>;
3403
+ /** Indicates if the plan should be hidden from widgets */
2830
3404
  hiddenFromWidgets?: InputMaybe<Array<WidgetType>>;
3405
+ /** The ID of the plan to update */
2831
3406
  id: Scalars['String'];
2832
3407
  /** The minimum spend configuration per each billing period */
2833
3408
  minimumSpend?: InputMaybe<Array<MinimumSpendInput>>;
3409
+ /** The ID of the parent plan, if applicable */
2834
3410
  parentPlanId?: InputMaybe<Scalars['String']>;
3411
+ /** The status of the plan, e.g. "active" or "archived" */
2835
3412
  status?: InputMaybe<PackageStatus>;
2836
3413
  };
3414
+ /** Input for preparing a payment method form */
2837
3415
  export declare type PreparePaymentMethodFormInput = {
3416
+ /** Customer slug */
2838
3417
  customerId: Scalars['String'];
3418
+ /** The unique identifier for the environment */
2839
3419
  environmentId?: InputMaybe<Scalars['String']>;
2840
3420
  /** The billing integration to use for this payment method */
2841
3421
  integrationId?: InputMaybe<Scalars['String']>;
@@ -2902,19 +3482,26 @@ export declare type PriceOverrideInput = {
2902
3482
  addonId?: InputMaybe<Scalars['String']>;
2903
3483
  /** Whether the price is a base charge */
2904
3484
  baseCharge?: InputMaybe<Scalars['Boolean']>;
2905
- /** The number of units per block. Defaults to 1 unit. */
3485
+ /** The number of units per block. Defaults to 1 unit */
2906
3486
  blockSize?: InputMaybe<Scalars['Float']>;
2907
3487
  /** The corresponding feature id of the price */
2908
3488
  featureId?: InputMaybe<Scalars['String']>;
3489
+ /** The price of the price period */
2909
3490
  price?: InputMaybe<MoneyInputDto>;
3491
+ /** List of tiers of the price period */
2910
3492
  tiers?: InputMaybe<Array<PriceTierInput>>;
2911
3493
  };
3494
+ /** Price Period Input */
2912
3495
  export declare type PricePeriodInput = {
3496
+ /** The billing country code of the price */
2913
3497
  billingCountryCode?: InputMaybe<Scalars['String']>;
3498
+ /** The billing period of the price */
2914
3499
  billingPeriod: BillingPeriod;
2915
- /** The number of units per block. Defaults to 1 unit. */
3500
+ /** The number of units per block. Defaults to 1 unit */
2916
3501
  blockSize?: InputMaybe<Scalars['Float']>;
3502
+ /** The price of the price period */
2917
3503
  price?: InputMaybe<MoneyInputDto>;
3504
+ /** List of tiers of the price period */
2918
3505
  tiers?: InputMaybe<Array<PriceTierInput>>;
2919
3506
  };
2920
3507
  export declare type PriceSort = {
@@ -2931,22 +3518,38 @@ export declare enum PriceSortFields {
2931
3518
  Id = "id",
2932
3519
  TiersMode = "tiersMode"
2933
3520
  }
3521
+ /** Price Tier Input */
2934
3522
  export declare type PriceTierInput = {
3523
+ /** The flat fee price of the price tier */
2935
3524
  flatPrice?: InputMaybe<MoneyInputDto>;
3525
+ /** The unit price of the price tier */
2936
3526
  unitPrice?: InputMaybe<MoneyInputDto>;
3527
+ /** The up to quantity of the price tier */
2937
3528
  upTo?: InputMaybe<Scalars['Float']>;
2938
3529
  };
3530
+ /** Pricing Model Create Input */
2939
3531
  export declare type PricingModelCreateInput = {
3532
+ /** The billing cadence of the base pricing model */
2940
3533
  billingCadence?: InputMaybe<BillingCadence>;
3534
+ /** The billing model of the base pricing model */
2941
3535
  billingModel: BillingModel;
3536
+ /** The feature id of the base pricing model */
2942
3537
  featureId?: InputMaybe<Scalars['String']>;
3538
+ /** The maximum unit quantity of the pricing model */
2943
3539
  maxUnitQuantity?: InputMaybe<Scalars['Float']>;
3540
+ /** The minimum unit quantity of the pricing model */
2944
3541
  minUnitQuantity?: InputMaybe<Scalars['Float']>;
3542
+ /** The monthly reset period configuration of the pricing model */
2945
3543
  monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>;
3544
+ /** The price periods of the base pricing model */
2946
3545
  pricePeriods: Array<PricePeriodInput>;
3546
+ /** The reset period of the pricing model */
2947
3547
  resetPeriod?: InputMaybe<EntitlementResetPeriod>;
3548
+ /** The tiers mode of the pricing model */
2948
3549
  tiersMode?: InputMaybe<TiersMode>;
3550
+ /** The weekly reset period configuration of the pricing model */
2949
3551
  weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>;
3552
+ /** The yearly reset period configuration of the pricing model */
2950
3553
  yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput>;
2951
3554
  };
2952
3555
  /** Pricing Type. */
@@ -2971,12 +3574,19 @@ export declare type PricingTypeFilterComparison = {
2971
3574
  notIn?: InputMaybe<Array<PricingType>>;
2972
3575
  notLike?: InputMaybe<PricingType>;
2973
3576
  };
3577
+ /** Input for creating a product */
2974
3578
  export declare type ProductCreateInput = {
3579
+ /** Additional metadata for the product */
2975
3580
  additionalMetaData?: InputMaybe<Scalars['JSON']>;
3581
+ /** Description of the product */
2976
3582
  description?: InputMaybe<Scalars['String']>;
3583
+ /** Display name of the product */
2977
3584
  displayName?: InputMaybe<Scalars['String']>;
3585
+ /** The unique identifier for the environment */
2978
3586
  environmentId: Scalars['String'];
3587
+ /** Indicates if multiple subscriptions to this product are allowed */
2979
3588
  multipleSubscriptions?: InputMaybe<Scalars['Boolean']>;
3589
+ /** The unique identifier for the entity */
2980
3590
  refId: Scalars['String'];
2981
3591
  };
2982
3592
  export declare type ProductFilter = {
@@ -2994,13 +3604,21 @@ export declare type ProductFilter = {
2994
3604
  refId?: InputMaybe<StringFieldComparison>;
2995
3605
  updatedAt?: InputMaybe<DateFieldComparison>;
2996
3606
  };
3607
+ /** Input for product settings */
2997
3608
  export declare type ProductSettingsInput = {
3609
+ /** Indicates if the subscription should be downgraded at the end of the billing period */
2998
3610
  downgradeAtEndOfBillingPeriod?: InputMaybe<Scalars['String']>;
3611
+ /** ID of the plan to downgrade to at the end of the billing period */
2999
3612
  downgradePlanId?: InputMaybe<Scalars['String']>;
3613
+ /** Indicates if the subscription should be prorated at the end of the billing period */
3000
3614
  prorateAtEndOfBillingPeriod?: InputMaybe<Scalars['Boolean']>;
3615
+ /** Time when the subscription will be cancelled */
3001
3616
  subscriptionCancellationTime: SubscriptionCancellationTime;
3617
+ /** Setup for the end of the subscription */
3002
3618
  subscriptionEndSetup: SubscriptionEndSetup;
3619
+ /** ID of the plan to start the subscription with */
3003
3620
  subscriptionStartPlanId?: InputMaybe<Scalars['String']>;
3621
+ /** Setup for the start of the subscription */
3004
3622
  subscriptionStartSetup: SubscriptionStartSetup;
3005
3623
  };
3006
3624
  export declare type ProductSort = {
@@ -3021,13 +3639,19 @@ export declare enum ProductSortFields {
3021
3639
  RefId = "refId",
3022
3640
  UpdatedAt = "updatedAt"
3023
3641
  }
3642
+ /** Input for updating a product */
3024
3643
  export declare type ProductUpdateInput = {
3644
+ /** Additional metadata for the product */
3025
3645
  additionalMetaData?: InputMaybe<Scalars['JSON']>;
3026
3646
  /** Auto cancellation rules */
3027
3647
  autoCancellationRules?: InputMaybe<Array<AutoCancellationRuleInput>>;
3648
+ /** Description of the product */
3028
3649
  description?: InputMaybe<Scalars['String']>;
3650
+ /** Display name of the product */
3029
3651
  displayName?: InputMaybe<Scalars['String']>;
3652
+ /** Indicates if multiple subscriptions to this product are allowed */
3030
3653
  multipleSubscriptions?: InputMaybe<Scalars['Boolean']>;
3654
+ /** Settings for the product */
3031
3655
  productSettings?: InputMaybe<ProductSettingsInput>;
3032
3656
  /** Usage reset cutoff rule */
3033
3657
  usageResetCutoffRule?: InputMaybe<SubscriptionUpdateUsageResetCutoffRuleInput>;
@@ -3041,29 +3665,49 @@ export declare type PromotionalEntitlementFilter = {
3041
3665
  status?: InputMaybe<PromotionalEntitlementStatusFilterComparison>;
3042
3666
  updatedAt?: InputMaybe<DateFieldComparison>;
3043
3667
  };
3668
+ /** Promotional entitlement input */
3044
3669
  export declare type PromotionalEntitlementInput = {
3670
+ /** The unique identifier of the entitlement customer */
3045
3671
  customerId: Scalars['String'];
3672
+ /** The description of the entitlement */
3046
3673
  description?: InputMaybe<Scalars['String']>;
3674
+ /** The end date of the promotional entitlement */
3047
3675
  endDate?: InputMaybe<Scalars['DateTime']>;
3676
+ /** The unique identifier for the environment */
3048
3677
  environmentId: Scalars['String'];
3678
+ /** The unique identifier of the entitlement feature */
3049
3679
  featureId: Scalars['String'];
3680
+ /** Whether the entitlement has a soft limit */
3050
3681
  hasSoftLimit?: InputMaybe<Scalars['Boolean']>;
3682
+ /** Whether the entitlement has an unlimited usage */
3051
3683
  hasUnlimitedUsage?: InputMaybe<Scalars['Boolean']>;
3684
+ /** Whether the entitlement is visible */
3052
3685
  isVisible: Scalars['Boolean'];
3686
+ /** The monthly reset period configuration of the entitlement, defined when reset period is monthly */
3053
3687
  monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>;
3688
+ /** The grant period of the promotional entitlement */
3054
3689
  period: PromotionalEntitlementPeriod;
3690
+ /** The reset period of the entitlement */
3055
3691
  resetPeriod?: InputMaybe<EntitlementResetPeriod>;
3692
+ /** The usage limit of the entitlement */
3056
3693
  usageLimit?: InputMaybe<Scalars['Float']>;
3694
+ /** The weekly reset period configuration of the entitlement, defined when reset period is weekly */
3057
3695
  weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>;
3696
+ /** The yearly reset period configuration of the entitlement, defined when reset period is yearly */
3058
3697
  yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput>;
3059
3698
  };
3060
3699
  /** Promotional entitlement duration */
3061
3700
  export declare enum PromotionalEntitlementPeriod {
3062
3701
  Custom = "CUSTOM",
3702
+ /** Lifetime */
3063
3703
  Lifetime = "LIFETIME",
3704
+ /** One month */
3064
3705
  OneMonth = "ONE_MONTH",
3706
+ /** One week */
3065
3707
  OneWeek = "ONE_WEEK",
3708
+ /** One year */
3066
3709
  OneYear = "ONE_YEAR",
3710
+ /** Six months */
3067
3711
  SixMonth = "SIX_MONTH"
3068
3712
  }
3069
3713
  export declare type PromotionalEntitlementSort = {
@@ -3080,8 +3724,11 @@ export declare enum PromotionalEntitlementSortFields {
3080
3724
  }
3081
3725
  /** Promotional entitlement status */
3082
3726
  export declare enum PromotionalEntitlementStatus {
3727
+ /** Active */
3083
3728
  Active = "Active",
3729
+ /** Expired */
3084
3730
  Expired = "Expired",
3731
+ /** Paused */
3085
3732
  Paused = "Paused"
3086
3733
  }
3087
3734
  export declare type PromotionalEntitlementStatusFilterComparison = {
@@ -3100,40 +3747,72 @@ export declare type PromotionalEntitlementStatusFilterComparison = {
3100
3747
  notIn?: InputMaybe<Array<PromotionalEntitlementStatus>>;
3101
3748
  notLike?: InputMaybe<PromotionalEntitlementStatus>;
3102
3749
  };
3750
+ /** Promotional entitlement update input */
3103
3751
  export declare type PromotionalEntitlementUpdateInput = {
3752
+ /** The description of the entitlement */
3104
3753
  description?: InputMaybe<Scalars['String']>;
3754
+ /** The end date of the promotional entitlement */
3105
3755
  endDate?: InputMaybe<Scalars['DateTime']>;
3756
+ /** Whether the entitlement has a soft limit */
3106
3757
  hasSoftLimit?: InputMaybe<Scalars['Boolean']>;
3758
+ /** Whether the entitlement has an unlimited usage */
3107
3759
  hasUnlimitedUsage?: InputMaybe<Scalars['Boolean']>;
3760
+ /** Whether the entitlement is visible */
3108
3761
  isVisible: Scalars['Boolean'];
3762
+ /** The monthly reset period configuration of the entitlement, defined when reset period is monthly */
3109
3763
  monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>;
3764
+ /** The grant period of the promotional entitlement */
3110
3765
  period: PromotionalEntitlementPeriod;
3766
+ /** The reset period of the entitlement */
3111
3767
  resetPeriod?: InputMaybe<EntitlementResetPeriod>;
3768
+ /** The usage limit of the entitlement */
3112
3769
  usageLimit?: InputMaybe<Scalars['Float']>;
3770
+ /** The weekly reset period configuration of the entitlement, defined when reset period is weekly */
3113
3771
  weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>;
3114
3772
  };
3773
+ /** Proration behavior for subscription billing */
3115
3774
  export declare enum ProrationBehavior {
3775
+ /** Create proration invoice items for changes in the subscription */
3116
3776
  CreateProrations = "CREATE_PRORATIONS",
3777
+ /** Invoice immediately for changes in the subscription without proration */
3117
3778
  InvoiceImmediately = "INVOICE_IMMEDIATELY"
3118
3779
  }
3780
+ /** Input to provision a customer and subscription */
3119
3781
  export declare type ProvisionCustomerInput = {
3782
+ /** Additional metadata */
3120
3783
  additionalMetaData?: InputMaybe<Scalars['JSON']>;
3784
+ /** The AWS Marketplace integration id */
3121
3785
  awsMarketplaceCustomerId?: InputMaybe<Scalars['String']>;
3786
+ /** The unique identifier for the entity in the billing provider */
3122
3787
  billingId?: InputMaybe<Scalars['String']>;
3788
+ /** Customer billing information */
3123
3789
  billingInformation?: InputMaybe<CustomerBillingInfo>;
3790
+ /** Customer level coupon */
3124
3791
  couponRefId?: InputMaybe<Scalars['String']>;
3792
+ /** Timestamp of when the record was created */
3125
3793
  createdAt?: InputMaybe<Scalars['DateTime']>;
3794
+ /** The unique identifier for the customer in Hubspot integration */
3126
3795
  crmId?: InputMaybe<Scalars['String']>;
3796
+ /** Customer slug */
3127
3797
  customerId?: InputMaybe<Scalars['String']>;
3798
+ /** The email of the customer */
3128
3799
  email?: InputMaybe<Scalars['String']>;
3800
+ /** The unique identifier for the environment */
3129
3801
  environmentId?: InputMaybe<Scalars['String']>;
3802
+ /** Wether the customer should be excluded from the experiment */
3130
3803
  excludeFromExperiment?: InputMaybe<Scalars['Boolean']>;
3804
+ /** The name of the customer */
3131
3805
  name?: InputMaybe<Scalars['String']>;
3806
+ /** Customer slug */
3132
3807
  refId?: InputMaybe<Scalars['String']>;
3808
+ /** The unique identifier for the customer in Salesforce integration */
3133
3809
  salesforceId?: InputMaybe<Scalars['String']>;
3810
+ /** Wether or not to sync free subscriptions to the billing provider */
3134
3811
  shouldSyncFree?: InputMaybe<Scalars['Boolean']>;
3812
+ /** Subscription parameters */
3135
3813
  subscriptionParams?: InputMaybe<ProvisionCustomerSubscriptionInput>;
3136
3814
  };
3815
+ /** Provision a new subscription for a customer */
3137
3816
  export declare type ProvisionCustomerSubscriptionInput = {
3138
3817
  additionalMetaData?: InputMaybe<Scalars['JSON']>;
3139
3818
  addons?: InputMaybe<Array<SubscriptionAddonInput>>;
@@ -3165,8 +3844,11 @@ export declare type ProvisionCustomerSubscriptionInput = {
3165
3844
  trialOverrideConfiguration?: InputMaybe<TrialOverrideConfigurationInput>;
3166
3845
  unitQuantity?: InputMaybe<Scalars['Float']>;
3167
3846
  };
3847
+ /** Input for provisioning a sandbox environment */
3168
3848
  export declare type ProvisionSandboxInput = {
3849
+ /** The billing model to use for the sandbox environment */
3169
3850
  billingModel: BillingModel;
3851
+ /** The name of the sandbox environment */
3170
3852
  displayName: Scalars['String'];
3171
3853
  };
3172
3854
  export declare type ProvisionSubscription = {
@@ -3246,9 +3928,11 @@ export declare enum ProvisionSubscriptionStatus {
3246
3928
  PaymentRequired = "PAYMENT_REQUIRED",
3247
3929
  Success = "SUCCESS"
3248
3930
  }
3249
- /** PublishMigrationType */
3931
+ /** The migration type, either publish the new version to new customers or all customers */
3250
3932
  export declare enum PublishMigrationType {
3933
+ /** Publish to all customers */
3251
3934
  AllCustomers = "ALL_CUSTOMERS",
3935
+ /** Publish only to new customers */
3252
3936
  NewCustomers = "NEW_CUSTOMERS"
3253
3937
  }
3254
3938
  export declare type RecalculateEntitlementsInput = {
@@ -3293,45 +3977,72 @@ export declare type RemoveExperimentFromCustomerSubscriptionInput = {
3293
3977
  /** The id of relation. */
3294
3978
  relationId: Scalars['String'];
3295
3979
  };
3980
+ /** Report usage base input */
3296
3981
  export declare type ReportUsageBaseInput = {
3982
+ /** Timestamp of when the record was created */
3297
3983
  createdAt?: InputMaybe<Scalars['DateTime']>;
3984
+ /** Customer id */
3298
3985
  customerId: Scalars['String'];
3986
+ /** Additional dimensions for the usage report */
3299
3987
  dimensions?: InputMaybe<Scalars['JSON']>;
3988
+ /** Feature id */
3300
3989
  featureId: Scalars['String'];
3990
+ /** Resource id */
3301
3991
  resourceId?: InputMaybe<Scalars['String']>;
3992
+ /** The method by which the usage value should be updated */
3302
3993
  updateBehavior?: InputMaybe<UsageUpdateBehavior>;
3994
+ /** The value to report for usage */
3303
3995
  value: Scalars['Float'];
3304
3996
  };
3997
+ /** Input for reporting usage in bulk */
3305
3998
  export declare type ReportUsageBulkInput = {
3999
+ /** The unique identifier for the environment */
3306
4000
  environmentId?: InputMaybe<Scalars['String']>;
4001
+ /** A list of usage reports to be submitted in bulk */
3307
4002
  usages: Array<ReportUsageBaseInput>;
3308
4003
  };
4004
+ /** Input parameters for reporting usage */
3309
4005
  export declare type ReportUsageInput = {
4006
+ /** Timestamp of when the record was created */
3310
4007
  createdAt?: InputMaybe<Scalars['DateTime']>;
4008
+ /** Customer id */
3311
4009
  customerId: Scalars['String'];
4010
+ /** Additional dimensions for the usage report */
3312
4011
  dimensions?: InputMaybe<Scalars['JSON']>;
4012
+ /** The unique identifier for the environment */
3313
4013
  environmentId?: InputMaybe<Scalars['String']>;
4014
+ /** Feature id */
3314
4015
  featureId: Scalars['String'];
4016
+ /** Resource id */
3315
4017
  resourceId?: InputMaybe<Scalars['String']>;
4018
+ /** The method by which the usage value should be updated */
3316
4019
  updateBehavior?: InputMaybe<UsageUpdateBehavior>;
4020
+ /** The value to report for usage */
3317
4021
  value: Scalars['Float'];
3318
4022
  };
4023
+ /** Input for re-syncing an integration */
3319
4024
  export declare type ResyncIntegrationInput = {
3320
- /** ID of the environment to re-sync */
4025
+ /** The unique identifier for the environment */
3321
4026
  environmentId: Scalars['String'];
3322
4027
  /** Internal ID of the integration to re-sync */
3323
4028
  integrationId: Scalars['String'];
3324
4029
  /** Allow skipping entitlement recalculation */
3325
4030
  recalculateEntitlements?: InputMaybe<Scalars['Boolean']>;
3326
- /** Type of integration to re-sync */
4031
+ /** The vendor identifier of integration */
3327
4032
  vendorIdentifier?: InputMaybe<VendorIdentifier>;
3328
4033
  };
4034
+ /** Revoke promotional entitlement input */
3329
4035
  export declare type RevokePromotionalEntitlementInput = {
4036
+ /** The unique identifier of the entitlement customer */
3330
4037
  customerId: Scalars['String'];
4038
+ /** The unique identifier for the environment */
3331
4039
  environmentId?: InputMaybe<Scalars['String']>;
4040
+ /** The unique identifier of the entitlement feature */
3332
4041
  featureId: Scalars['String'];
3333
4042
  };
4043
+ /** Input configuration for Salesforce Integration */
3334
4044
  export declare type SalesforceCredentialsInput = {
4045
+ /** Domain of the Salesforce account */
3335
4046
  domain?: InputMaybe<Scalars['String']>;
3336
4047
  };
3337
4048
  /** Options for when a change for a paid subscription should take effect */
@@ -3343,6 +4054,7 @@ export declare enum ScheduleStrategy {
3343
4054
  /** Apply the change immediately */
3344
4055
  Immediate = "IMMEDIATE"
3345
4056
  }
4057
+ /** Input for setting access roles for a user */
3346
4058
  export declare type SetAccessRolesInput = {
3347
4059
  /** Account level access of the user */
3348
4060
  accountRole: AccountAccessRole;
@@ -3387,19 +4099,19 @@ export declare type SetExperimentOnCustomerSubscriptionInput = {
3387
4099
  export declare type SetPackageGroupAddons = {
3388
4100
  /** The addons to set on the package group */
3389
4101
  addons: Array<Scalars['String']>;
3390
- /** The environment id to set the addons of the package group in */
4102
+ /** The unique identifier for the environment */
3391
4103
  environmentId?: InputMaybe<Scalars['String']>;
3392
4104
  /** The id of the package group */
3393
4105
  packageGroupId: Scalars['String'];
3394
4106
  };
3395
- /** Set plan compatible package group input */
4107
+ /** Set plan compatible package groups input */
3396
4108
  export declare type SetPlanCompatiblePackageGroup = {
3397
4109
  /** The options for the package group */
3398
4110
  options?: InputMaybe<SetPlanCompatiblePackageGroupOptions>;
3399
4111
  /** The package group id */
3400
4112
  packageGroupId: Scalars['String'];
3401
4113
  };
3402
- /** Set plan compatible package group options input */
4114
+ /** Set plan compatible package groups input */
3403
4115
  export declare type SetPlanCompatiblePackageGroupOptions = {
3404
4116
  /** Number of free items from packageGroup */
3405
4117
  freeItems?: InputMaybe<Scalars['Float']>;
@@ -3408,20 +4120,28 @@ export declare type SetPlanCompatiblePackageGroupOptions = {
3408
4120
  };
3409
4121
  /** Set plan compatible package groups input */
3410
4122
  export declare type SetPlanCompatiblePackageGroups = {
3411
- /** The environment id */
4123
+ /** The unique identifier for the environment */
3412
4124
  environmentId?: InputMaybe<Scalars['String']>;
3413
4125
  /** The id of the plan */
3414
4126
  id: Scalars['String'];
3415
4127
  /** The package groups with optional options */
3416
4128
  packageGroups: Array<SetPlanCompatiblePackageGroup>;
3417
4129
  };
4130
+ /** Input configuration for Snowflake integration */
3418
4131
  export declare type SnowflakeCredentialsInput = {
4132
+ /** The database you specified when creating the Stigg entities in Snowflake, for example: STIGG_DATABASE */
3419
4133
  database: Scalars['String'];
4134
+ /** The Snowflake account URL, for example: https://ab12345.us-east-2.aws.snowflakecomputing.com */
3420
4135
  host: Scalars['String'];
4136
+ /** The password you specified when creating the Stigg entities in Snowflake */
3421
4137
  password: Scalars['String'];
4138
+ /** The role you specified when creating the Stigg entities in Snowflake, for example: STIGG_ROLE */
3422
4139
  role: Scalars['String'];
4140
+ /** The schema you specified when creating the Stigg entities in Snowflake, for example: STIGG_SCHEMA */
3423
4141
  schemaName: Scalars['String'];
4142
+ /** The username you specified when creating the Stigg entities in Snowflake, for example: STIGG_USER */
3424
4143
  username: Scalars['String'];
4144
+ /** The warehouse you specified when creating the Stigg entities in Snowflake, for example: STIGG_WAREHOUSE */
3425
4145
  warehouse: Scalars['String'];
3426
4146
  };
3427
4147
  /** Sort Directions */
@@ -3439,12 +4159,18 @@ export declare enum SourceType {
3439
4159
  NodeServerSdk = "NODE_SERVER_SDK",
3440
4160
  PersistentCacheService = "PERSISTENT_CACHE_SERVICE"
3441
4161
  }
4162
+ /** Input parameters for starting an experiment */
3442
4163
  export declare type StartExperimentInput = {
4164
+ /** The unique identifier for the environment */
3443
4165
  environmentId?: InputMaybe<Scalars['String']>;
4166
+ /** The unique identifier for the experiment */
3444
4167
  refId: Scalars['String'];
3445
4168
  };
4169
+ /** Input parameters for stopping an experiment */
3446
4170
  export declare type StopExperimentInput = {
4171
+ /** The unique identifier for the environment */
3447
4172
  environmentId?: InputMaybe<Scalars['String']>;
4173
+ /** The unique identifier for the experiment */
3448
4174
  refId: Scalars['String'];
3449
4175
  };
3450
4176
  export declare type StringFieldComparison = {
@@ -3463,24 +4189,40 @@ export declare type StringFieldComparison = {
3463
4189
  notIn?: InputMaybe<Array<Scalars['String']>>;
3464
4190
  notLike?: InputMaybe<Scalars['String']>;
3465
4191
  };
4192
+ /** Input configuration for Stripe integration */
3466
4193
  export declare type StripeCredentialsInput = {
4194
+ /** ID of the Stripe account */
3467
4195
  accountId?: InputMaybe<Scalars['String']>;
4196
+ /** Authorization code for Stripe */
3468
4197
  authorizationCode: Scalars['String'];
4198
+ /** Whether tax is enabled for the Stripe account */
3469
4199
  isTaxEnabled?: InputMaybe<Scalars['Boolean']>;
4200
+ /** Whether the Stripe account is in test mode */
3470
4201
  isTestMode: Scalars['Boolean'];
3471
4202
  };
4203
+ /** Input parameters for searching Stripe customers */
3472
4204
  export declare type StripeCustomerSearchInput = {
4205
+ /** Name of the customer to search for */
3473
4206
  customerName?: InputMaybe<Scalars['String']>;
4207
+ /** The unique identifier for the environment */
3474
4208
  environmentId: Scalars['String'];
4209
+ /** Token for retrieving the next page of results */
3475
4210
  nextPage?: InputMaybe<Scalars['String']>;
3476
4211
  };
4212
+ /** Input parameters for searching Stripe products */
3477
4213
  export declare type StripeProductSearchInput = {
4214
+ /** The unique identifier for the environment */
3478
4215
  environmentId: Scalars['String'];
4216
+ /** Token for retrieving the next page of results */
3479
4217
  nextPage?: InputMaybe<Scalars['String']>;
4218
+ /** Name of the product to search for */
3480
4219
  productName?: InputMaybe<Scalars['String']>;
3481
4220
  };
4221
+ /** Input parameters for searching Stripe subscriptions */
3482
4222
  export declare type StripeSubscriptionSearchInput = {
4223
+ /** The unique identifier for the environment */
3483
4224
  environmentId: Scalars['String'];
4225
+ /** Token for retrieving the next page of results */
3484
4226
  nextPage?: InputMaybe<Scalars['String']>;
3485
4227
  };
3486
4228
  export declare type SubscriptionAddonFilter = {
@@ -3590,8 +4332,11 @@ export declare type SubscriptionCancelReasonFilterComparison = {
3590
4332
  notIn?: InputMaybe<Array<SubscriptionCancelReason>>;
3591
4333
  notLike?: InputMaybe<SubscriptionCancelReason>;
3592
4334
  };
4335
+ /** Action to take when a subscription is cancelled */
3593
4336
  export declare enum SubscriptionCancellationAction {
4337
+ /** Default action */
3594
4338
  Default = "DEFAULT",
4339
+ /** Revoke entitlements action */
3595
4340
  RevokeEntitlements = "REVOKE_ENTITLEMENTS"
3596
4341
  }
3597
4342
  export declare type SubscriptionCancellationInput = {
@@ -3603,9 +4348,13 @@ export declare type SubscriptionCancellationInput = {
3603
4348
  subscriptionCancellationTime?: InputMaybe<SubscriptionCancellationTime>;
3604
4349
  subscriptionRefId: Scalars['String'];
3605
4350
  };
4351
+ /** When the subscription will be cancelled */
3606
4352
  export declare enum SubscriptionCancellationTime {
4353
+ /** At the end of the billing period */
3607
4354
  EndOfBillingPeriod = "END_OF_BILLING_PERIOD",
4355
+ /** Immediately */
3608
4356
  Immediate = "IMMEDIATE",
4357
+ /** On a specific date */
3609
4358
  SpecificDate = "SPECIFIC_DATE"
3610
4359
  }
3611
4360
  /** Subscription coupon configuration input */
@@ -3652,8 +4401,11 @@ export declare enum SubscriptionDecisionStrategy {
3652
4401
  RequestedPlan = "REQUESTED_PLAN",
3653
4402
  SkippedSubscriptionCreation = "SKIPPED_SUBSCRIPTION_CREATION"
3654
4403
  }
4404
+ /** Setup for the end of the subscription */
3655
4405
  export declare enum SubscriptionEndSetup {
4406
+ /** Cancel subscription */
3656
4407
  CancelSubscription = "CANCEL_SUBSCRIPTION",
4408
+ /** Downgrade to free plan */
3657
4409
  DowngradeToFree = "DOWNGRADE_TO_FREE"
3658
4410
  }
3659
4411
  export declare type SubscriptionEntitlementFilter = {
@@ -3709,15 +4461,25 @@ export declare type SubscriptionEntitlementFilterFeatureFilter = {
3709
4461
  refId?: InputMaybe<StringFieldComparison>;
3710
4462
  updatedAt?: InputMaybe<DateFieldComparison>;
3711
4463
  };
4464
+ /** Subscription entitlement input */
3712
4465
  export declare type SubscriptionEntitlementInput = {
4466
+ /** The description of the entitlement */
3713
4467
  description?: InputMaybe<Scalars['String']>;
4468
+ /** The unique identifier of the entitlement feature */
3714
4469
  featureId: Scalars['String'];
4470
+ /** Whether the entitlement has a soft limit */
3715
4471
  hasSoftLimit?: InputMaybe<Scalars['Boolean']>;
4472
+ /** Whether the entitlement has an unlimited usage */
3716
4473
  hasUnlimitedUsage?: InputMaybe<Scalars['Boolean']>;
4474
+ /** The monthly reset period configuration of the entitlement, defined when reset period is monthly */
3717
4475
  monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>;
4476
+ /** The reset period of the entitlement */
3718
4477
  resetPeriod?: InputMaybe<EntitlementResetPeriod>;
4478
+ /** The usage limit of the entitlement */
3719
4479
  usageLimit?: InputMaybe<Scalars['Float']>;
4480
+ /** The weekly reset period configuration of the entitlement, defined when reset period is weekly */
3720
4481
  weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>;
4482
+ /** The yearly reset period configuration of the entitlement, defined when reset period is yearly */
3721
4483
  yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput>;
3722
4484
  };
3723
4485
  export declare type SubscriptionEntitlementSort = {
@@ -3825,9 +4587,9 @@ export declare enum SubscriptionMigrationTime {
3825
4587
  EndOfBillingPeriod = "END_OF_BILLING_PERIOD",
3826
4588
  Immediate = "IMMEDIATE"
3827
4589
  }
3828
- /** Subscription minimum spend */
4590
+ /** Subscription minimum spend input */
3829
4591
  export declare type SubscriptionMinimumSpendValueInput = {
3830
- /** The minimum spend */
4592
+ /** The subscription minimum spend */
3831
4593
  minimum?: InputMaybe<MoneyInputDto>;
3832
4594
  };
3833
4595
  export declare type SubscriptionPriceFilter = {
@@ -3927,9 +4689,13 @@ export declare enum SubscriptionScheduleType {
3927
4689
  /** Unit amount change */
3928
4690
  UnitAmount = "UnitAmount"
3929
4691
  }
4692
+ /** Setup for the start of the subscription */
3930
4693
  export declare enum SubscriptionStartSetup {
4694
+ /** Start with a free plan */
3931
4695
  FreePlan = "FREE_PLAN",
4696
+ /** Select a plan */
3932
4697
  PlanSelection = "PLAN_SELECTION",
4698
+ /** Start with a trial period */
3933
4699
  TrialPeriod = "TRIAL_PERIOD"
3934
4700
  }
3935
4701
  /** Subscription status */
@@ -3971,27 +4737,38 @@ export declare enum SubscriptionUpdateUsageCutoffBehavior {
3971
4737
  /** Never reset */
3972
4738
  NeverReset = "NEVER_RESET"
3973
4739
  }
3974
- /** The input of the usage reset cutoff rule. */
4740
+ /** Input for usage reset cutoff rule */
3975
4741
  export declare type SubscriptionUpdateUsageResetCutoffRuleInput = {
3976
- /** The behavior of the usage reset cutoff rule. */
4742
+ /** Behavior of the usage reset cutoff rule */
3977
4743
  behavior: SubscriptionUpdateUsageCutoffBehavior;
3978
4744
  };
3979
4745
  /** Status of the integration sync */
3980
4746
  export declare enum SyncStatus {
4747
+ /** Error sync status */
3981
4748
  Error = "ERROR",
4749
+ /** No sync required status */
3982
4750
  NoSyncRequired = "NO_SYNC_REQUIRED",
4751
+ /** Pending sync status */
3983
4752
  Pending = "PENDING",
4753
+ /** Successful sync status */
3984
4754
  Success = "SUCCESS"
3985
4755
  }
3986
4756
  export declare type SyncTaxRatesInput = {
3987
4757
  environmentId?: InputMaybe<Scalars['String']>;
3988
4758
  };
4759
+ /** The status of the task */
3989
4760
  export declare enum TaskStatus {
4761
+ /** The task is canceled */
3990
4762
  Canceled = "CANCELED",
4763
+ /** The task is completed */
3991
4764
  Completed = "COMPLETED",
4765
+ /** The task is failed */
3992
4766
  Failed = "FAILED",
4767
+ /** The task is in progress */
3993
4768
  InProgress = "IN_PROGRESS",
4769
+ /** The task is partially failed */
3994
4770
  PartiallyFailed = "PARTIALLY_FAILED",
4771
+ /** The task is pending */
3995
4772
  Pending = "PENDING"
3996
4773
  }
3997
4774
  export declare type TaskStatusFilterComparison = {
@@ -4010,14 +4787,23 @@ export declare type TaskStatusFilterComparison = {
4010
4787
  notIn?: InputMaybe<Array<TaskStatus>>;
4011
4788
  notLike?: InputMaybe<TaskStatus>;
4012
4789
  };
4790
+ /** The type of the task */
4013
4791
  export declare enum TaskType {
4792
+ /** The task is an import of product catalog from integration */
4014
4793
  ImportIntegrationCatalog = "IMPORT_INTEGRATION_CATALOG",
4794
+ /** The task is an import of customers from integration */
4015
4795
  ImportIntegrationCustomers = "IMPORT_INTEGRATION_CUSTOMERS",
4796
+ /** The task is an import of subscriptions in bulk */
4016
4797
  ImportSubscriptionsBulk = "IMPORT_SUBSCRIPTIONS_BULK",
4798
+ /** The task is a batch recalculation of entitlements */
4017
4799
  RecalculateBatchEntitlements = "RECALCULATE_BATCH_ENTITLEMENTS",
4800
+ /** The task is a recalculation of entitlements */
4018
4801
  RecalculateEntitlements = "RECALCULATE_ENTITLEMENTS",
4802
+ /** The task is a resync integration */
4019
4803
  ResyncIntegration = "RESYNC_INTEGRATION",
4804
+ /** The task is a subscription migration v1 */
4020
4805
  SubscriptionMigration = "SUBSCRIPTION_MIGRATION",
4806
+ /** The task is a subscription migration v2 */
4021
4807
  SubscriptionMigrationV2 = "SUBSCRIPTION_MIGRATION_V2"
4022
4808
  }
4023
4809
  export declare type TaskTypeFilterComparison = {
@@ -4040,23 +4826,29 @@ export declare type TaxExempt = {
4040
4826
  type: Scalars['String'];
4041
4827
  value: Scalars['String'];
4042
4828
  };
4829
+ /** TestHookInput object */
4043
4830
  export declare type TestHookInput = {
4831
+ /** The endpoint URL for the webhook */
4044
4832
  endpointUrl: Scalars['String'];
4833
+ /** The unique identifier for the environment */
4045
4834
  environmentId: Scalars['String'];
4835
+ /** The event log type to test */
4046
4836
  hookEventType: EventLogType;
4047
4837
  };
4048
- /** Trigger workflow with test eventinput */
4838
+ /** Trigger workflow with test event input */
4049
4839
  export declare type TestWorkflowInput = {
4050
- /** The endpoint url of the trigger */
4840
+ /** Workflow trigger endpoint */
4051
4841
  endpointUrl: Scalars['String'];
4052
- /** The environment id to trigger the workflow on */
4842
+ /** The unique identifier for the environment */
4053
4843
  environmentId?: InputMaybe<Scalars['String']>;
4054
4844
  /** The event type to trigger the workflow on */
4055
4845
  hookEventType: EventLogType;
4056
4846
  };
4057
- /** Tiers mode. */
4847
+ /** Tiers mode */
4058
4848
  export declare enum TiersMode {
4849
+ /** Tiered */
4059
4850
  Graduated = "GRADUATED",
4851
+ /** Volume */
4060
4852
  Volume = "VOLUME"
4061
4853
  }
4062
4854
  export declare type TiersModeFilterComparison = {
@@ -4112,9 +4904,13 @@ export declare type TriggerSubscriptionBillingMonthEndsSoonWebhookInput = {
4112
4904
  /** The subscription reference id to trigger the webhook for */
4113
4905
  subscriptionId: Scalars['String'];
4114
4906
  };
4907
+ /** Trigger a subscription migration */
4115
4908
  export declare type TriggerSubscriptionMigrationInput = {
4909
+ /** The unique identifier for the environment */
4116
4910
  environmentId: Scalars['String'];
4911
+ /** The unique identifier for the entity */
4117
4912
  refId: Scalars['String'];
4913
+ /** The version number of the plan to migrate */
4118
4914
  versionNumber: Scalars['Float'];
4119
4915
  };
4120
4916
  /** Input for triggering usage sync */
@@ -4144,24 +4940,30 @@ export declare type TypographyConfigurationInput = {
4144
4940
  };
4145
4941
  /** Input for un-archiving a feature */
4146
4942
  export declare type UnArchiveFeatureInput = {
4147
- /** Environment ID to unarchive the feature in */
4943
+ /** The unique identifier for the environment */
4148
4944
  environmentId?: InputMaybe<Scalars['String']>;
4149
- /** Feature ID to unarchive */
4945
+ /** Unique identifier for the entity */
4150
4946
  id: Scalars['String'];
4151
4947
  };
4152
4948
  /** Input for un-archiving a plan */
4153
4949
  export declare type UnArchivePlanInput = {
4154
- /** Environment ID to unarchive the plan in */
4950
+ /** The unique identifier for the environment */
4155
4951
  environmentId?: InputMaybe<Scalars['String']>;
4156
4952
  /** Plan ID to unarchive */
4157
4953
  id: Scalars['String'];
4158
4954
  };
4955
+ /** Unarchive a customer */
4159
4956
  export declare type UnarchiveCustomerInput = {
4957
+ /** Customer slug */
4160
4958
  customerId: Scalars['String'];
4959
+ /** The unique identifier for the environment */
4161
4960
  environmentId?: InputMaybe<Scalars['String']>;
4162
4961
  };
4962
+ /** Input for unarchiving an environment */
4163
4963
  export declare type UnarchiveEnvironmentInput = {
4964
+ /** Unique identifier for the entity */
4164
4965
  id?: InputMaybe<Scalars['String']>;
4966
+ /** A unique identifier for the environment */
4165
4967
  slug?: InputMaybe<Scalars['String']>;
4166
4968
  };
4167
4969
  /** Input for unit transformation to be applied to the reported usage */
@@ -4182,58 +4984,103 @@ export declare enum UnitTransformationRound {
4182
4984
  /** Apply round up after transformation */
4183
4985
  Up = "UP"
4184
4986
  }
4987
+ /** Input type for updating an account */
4185
4988
  export declare type UpdateAccountInput = {
4186
4989
  /** The method of adding new members to this account */
4187
4990
  accessMethod?: InputMaybe<AccountAccessMethod>;
4188
4991
  /** Email domain to be used for sso and authorized domain configuration */
4189
4992
  accountEmailDomain?: InputMaybe<Scalars['String']>;
4993
+ /** Default SSO roles for the account */
4190
4994
  defaultSSORoles?: InputMaybe<DefaultSsoRolesInput>;
4995
+ /** The display name of the account */
4191
4996
  displayName: Scalars['String'];
4997
+ /** The billing anchor for the subscription, e.g. "START_OF_THE_MONTH" */
4192
4998
  subscriptionBillingAnchor?: InputMaybe<BillingAnchor>;
4999
+ /** The proration behavior for the subscription, e.g. "CREATE_PRORATIONS" */
4193
5000
  subscriptionProrationBehavior?: InputMaybe<ProrationBehavior>;
5001
+ /** The timezone of the account, e.g. "America/New_York" */
4194
5002
  timezone?: InputMaybe<Scalars['String']>;
4195
5003
  };
5004
+ /** Update a coupon input */
4196
5005
  export declare type UpdateCouponInput = {
5006
+ /** Metadata associated with the entity */
4197
5007
  additionalMetaData?: InputMaybe<Scalars['JSON']>;
5008
+ /** Description of the coupon */
4198
5009
  description?: InputMaybe<Scalars['String']>;
5010
+ /** The unique identifier for the environment */
4199
5011
  environmentId?: InputMaybe<Scalars['String']>;
4200
- name: Scalars['String'];
5012
+ /** Name of the coupon */
5013
+ name?: InputMaybe<Scalars['String']>;
5014
+ /** The unique identifier for the entity */
4201
5015
  refId: Scalars['String'];
4202
5016
  };
5017
+ /** Update customer information */
4203
5018
  export declare type UpdateCustomerInput = {
5019
+ /** Additional metadata update */
4204
5020
  additionalMetaData?: InputMaybe<Scalars['JSON']>;
5021
+ /** The AWS Marketplace integration id */
4205
5022
  awsMarketplaceCustomerId?: InputMaybe<Scalars['String']>;
5023
+ /** The unique identifier for the entity in the billing provider */
4206
5024
  billingId?: InputMaybe<Scalars['String']>;
5025
+ /** Billing information update */
4207
5026
  billingInformation?: InputMaybe<CustomerBillingInfo>;
5027
+ /** Update a customer level coupon */
4208
5028
  couponRefId?: InputMaybe<Scalars['String']>;
5029
+ /** The unique identifier for the customer in Hubspot integration */
4209
5030
  crmId?: InputMaybe<Scalars['String']>;
5031
+ /** Customer slug */
4210
5032
  customerId?: InputMaybe<Scalars['String']>;
5033
+ /** The email of the customer */
4211
5034
  email?: InputMaybe<Scalars['String']>;
5035
+ /** The unique identifier for the environment */
4212
5036
  environmentId?: InputMaybe<Scalars['String']>;
5037
+ /** The name of the customer */
4213
5038
  name?: InputMaybe<Scalars['String']>;
5039
+ /** Customer slug */
4214
5040
  refId?: InputMaybe<Scalars['String']>;
5041
+ /** The unique identifier for the customer in Salesforce integration */
4215
5042
  salesforceId?: InputMaybe<Scalars['String']>;
5043
+ /** Should wait for sync to complete before returning a response */
4216
5044
  shouldWaitSync?: InputMaybe<Scalars['Boolean']>;
4217
5045
  };
5046
+ /** Input parameters for updating an existing experiment */
4218
5047
  export declare type UpdateExperimentInput = {
5048
+ /** Name for the control group */
4219
5049
  controlGroupName?: InputMaybe<Scalars['String']>;
5050
+ /** Description of the experiements */
4220
5051
  description?: InputMaybe<Scalars['String']>;
5052
+ /** The unique identifier for the environment */
4221
5053
  environmentId?: InputMaybe<Scalars['String']>;
5054
+ /** Name of the experiment */
4222
5055
  name?: InputMaybe<Scalars['String']>;
5056
+ /** Internal identifier for the product experiment is associated with */
4223
5057
  productId?: InputMaybe<Scalars['String']>;
5058
+ /** Product settings for the variant group */
4224
5059
  productSettings?: InputMaybe<ProductSettingsInput>;
5060
+ /** The unique identifier for the experiment */
4225
5061
  refId: Scalars['String'];
5062
+ /** Name for the variant group */
4226
5063
  variantGroupName?: InputMaybe<Scalars['String']>;
5064
+ /** Percentage of users in the variant group */
4227
5065
  variantPercentage?: InputMaybe<Scalars['Float']>;
4228
5066
  };
5067
+ /** Input for updating a feature */
4229
5068
  export declare type UpdateFeatureInput = {
5069
+ /** The additional metadata for the feature */
4230
5070
  additionalMetaData?: InputMaybe<Scalars['JSON']>;
5071
+ /** The description for the feature */
4231
5072
  description?: InputMaybe<Scalars['String']>;
5073
+ /** The display name for the feature */
4232
5074
  displayName?: InputMaybe<Scalars['String']>;
5075
+ /** The unique identifier for the environment */
4233
5076
  environmentId: Scalars['String'];
5077
+ /** The units for the feature */
4234
5078
  featureUnits?: InputMaybe<Scalars['String']>;
5079
+ /** The plural units for the feature */
4235
5080
  featureUnitsPlural?: InputMaybe<Scalars['String']>;
5081
+ /** Input for creating a meter */
4236
5082
  meter?: InputMaybe<CreateMeter>;
5083
+ /** The unique identifier for the feature */
4237
5084
  refId: Scalars['String'];
4238
5085
  /** Unit transformation to be applied to the reported usage */
4239
5086
  unitTransformation?: InputMaybe<UnitTransformationInput>;
@@ -4241,26 +5088,40 @@ export declare type UpdateFeatureInput = {
4241
5088
  export declare type UpdateHook = {
4242
5089
  /** A JSON containing the configuration for each event log type */
4243
5090
  configuration?: InputMaybe<Scalars['JSON']>;
5091
+ /** Timestamp of when the record was created */
4244
5092
  createdAt?: InputMaybe<Scalars['DateTime']>;
5093
+ /** Webhook description */
4245
5094
  description?: InputMaybe<Scalars['String']>;
5095
+ /** The Webhook endpoint URL */
4246
5096
  endpoint?: InputMaybe<Scalars['String']>;
5097
+ /** The unique identifier for the environment */
4247
5098
  environmentId?: InputMaybe<Scalars['String']>;
5099
+ /** The event types that the webhook will be triggered on */
4248
5100
  eventLogTypes?: InputMaybe<Array<EventLogType>>;
5101
+ /** Unique identifier for the entity */
4249
5102
  id?: InputMaybe<Scalars['String']>;
5103
+ /** Secret key for the webhook */
4250
5104
  secretKey?: InputMaybe<Scalars['String']>;
5105
+ /** The status of the webhook */
4251
5106
  status?: InputMaybe<HookStatus>;
4252
5107
  };
5108
+ /** Update integration input */
4253
5109
  export declare type UpdateIntegrationInput = {
5110
+ /** Auth0 integration configuration */
4254
5111
  auth0Credentials?: InputMaybe<Auth0CredentialsInput>;
4255
5112
  /** The reference ID for the integration */
4256
5113
  integrationId?: InputMaybe<Scalars['String']>;
4257
5114
  /** Whether the integration is the default integration */
4258
5115
  isDefault?: InputMaybe<Scalars['Boolean']>;
5116
+ /** OpenFGA integration configuration */
4259
5117
  openFGACredentials?: InputMaybe<OpenFgaCredentialsInput>;
4260
5118
  /** Salesforce integration configuration */
4261
5119
  salesforceCredentials?: InputMaybe<SalesforceCredentialsInput>;
5120
+ /** Stripe integration configuration */
4262
5121
  stripeCredentials?: InputMaybe<UpdateStripeCredentialsInput>;
5122
+ /** The vendor identifier of integration */
4263
5123
  vendorIdentifier: VendorIdentifier;
5124
+ /** Zuora integration configuration */
4264
5125
  zuoraCredentials?: InputMaybe<ZuoraCredentialsInput>;
4265
5126
  };
4266
5127
  export declare type UpdateOneEnvironmentInput = {
@@ -4299,27 +5160,46 @@ export declare type UpdateOnePromotionalEntitlementInput = {
4299
5160
  /** The update to apply. */
4300
5161
  update: PromotionalEntitlementUpdateInput;
4301
5162
  };
5163
+ /** Update package entitlement order input */
4302
5164
  export declare type UpdatePackageEntitlementOrderInput = {
5165
+ /** Entitlements to update */
4303
5166
  entitlements: Array<UpdatePackageEntitlementOrderItemInput>;
5167
+ /** The unique identifier for the environment */
4304
5168
  environmentId?: InputMaybe<Scalars['String']>;
5169
+ /** The unique identifier of the entitlement package */
4305
5170
  packageId: Scalars['String'];
4306
5171
  };
5172
+ /** Update package entitlement order item input */
4307
5173
  export declare type UpdatePackageEntitlementOrderItemInput = {
5174
+ /** Unique identifier for the entity */
4308
5175
  id: Scalars['String'];
5176
+ /** The order of the entitlement in the entitlement list */
4309
5177
  order?: InputMaybe<Scalars['Float']>;
4310
5178
  };
5179
+ /** Input configuration for updating Stripe integration */
4311
5180
  export declare type UpdateStripeCredentialsInput = {
5181
+ /** Whether tax is enabled for the Stripe account */
4312
5182
  isTaxEnabled?: InputMaybe<Scalars['Boolean']>;
4313
5183
  };
5184
+ /** Update subscription entitlement input */
4314
5185
  export declare type UpdateSubscriptionEntitlementInput = {
5186
+ /** The unique identifier of the entitlement feature */
4315
5187
  featureId?: InputMaybe<Scalars['String']>;
5188
+ /** Whether the entitlement has a soft limit */
4316
5189
  hasSoftLimit?: InputMaybe<Scalars['Boolean']>;
5190
+ /** Whether the entitlement has an unlimited usage */
4317
5191
  hasUnlimitedUsage?: InputMaybe<Scalars['Boolean']>;
5192
+ /** Unique identifier for the entity */
4318
5193
  id?: InputMaybe<Scalars['String']>;
5194
+ /** The monthly reset period configuration of the entitlement, defined when reset period is monthly */
4319
5195
  monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>;
5196
+ /** The reset period of the entitlement */
4320
5197
  resetPeriod?: InputMaybe<EntitlementResetPeriod>;
5198
+ /** The usage limit of the entitlement */
4321
5199
  usageLimit?: InputMaybe<Scalars['Float']>;
5200
+ /** The weekly reset period configuration of the entitlement, defined when reset period is weekly */
4322
5201
  weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>;
5202
+ /** The yearly reset period configuration of the entitlement, defined when reset period is yearly */
4323
5203
  yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput>;
4324
5204
  };
4325
5205
  export declare type UpdateSubscriptionInput = {
@@ -4346,18 +5226,29 @@ export declare type UpdateSubscriptionInput = {
4346
5226
  trialEndDate?: InputMaybe<Scalars['DateTime']>;
4347
5227
  unitQuantity?: InputMaybe<Scalars['Float']>;
4348
5228
  };
5229
+ /** Update the users information */
4349
5230
  export declare type UpdateUserInput = {
5231
+ /** User selected department */
4350
5232
  department?: InputMaybe<Department>;
5233
+ /** User first and last name */
4351
5234
  name: Scalars['String'];
4352
5235
  };
5236
+ /** Input parameters for reporting usage events */
4353
5237
  export declare type UsageEventReportInput = {
5238
+ /** Customer id */
4354
5239
  customerId: Scalars['String'];
5240
+ /** Dimensions to include in the events fields */
4355
5241
  dimensions?: InputMaybe<Scalars['JSON']>;
5242
+ /** Name of the event */
4356
5243
  eventName: Scalars['String'];
5244
+ /** Idempotency key */
4357
5245
  idempotencyKey: Scalars['String'];
5246
+ /** Resource id */
4358
5247
  resourceId?: InputMaybe<Scalars['String']>;
5248
+ /** Timestamp */
4359
5249
  timestamp?: InputMaybe<Scalars['DateTime']>;
4360
5250
  };
5251
+ /** Input for usage events */
4361
5252
  export declare type UsageEventsInput = {
4362
5253
  /** Customer id filter */
4363
5254
  customerId?: InputMaybe<Scalars['String']>;
@@ -4366,37 +5257,53 @@ export declare type UsageEventsInput = {
4366
5257
  /** List of event filters */
4367
5258
  filters?: InputMaybe<Array<MeterFilterDefinitionInput>>;
4368
5259
  };
5260
+ /** Input parameters for reporting usage events */
4369
5261
  export declare type UsageEventsReportInput = {
5262
+ /** The unique identifier for the environment */
4370
5263
  environmentId?: InputMaybe<Scalars['String']>;
5264
+ /** A list of usage events to report */
4371
5265
  usageEvents: Array<UsageEventReportInput>;
4372
5266
  };
5267
+ /** Input parameters for retrieving usage history */
4373
5268
  export declare type UsageHistoryInput = {
5269
+ /** Reference identifier for the customer */
4374
5270
  customerRefId: Scalars['String'];
5271
+ /** The end date of the range */
4375
5272
  endDate?: InputMaybe<Scalars['DateTime']>;
5273
+ /** The unique identifier for the environment */
4376
5274
  environmentId?: InputMaybe<Scalars['String']>;
5275
+ /** Reference identifier for the feature */
4377
5276
  featureRefId: Scalars['String'];
5277
+ /** Criteria by which to group the usage history */
4378
5278
  groupBy?: InputMaybe<Array<Scalars['String']>>;
5279
+ /** Monthly reset period configuration */
4379
5280
  monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>;
5281
+ /** Reset period */
4380
5282
  resetPeriod?: InputMaybe<EntitlementResetPeriod>;
5283
+ /** Reference identifier for the resource */
4381
5284
  resourceRefId?: InputMaybe<Scalars['String']>;
5285
+ /** The start date of the range */
4382
5286
  startDate: Scalars['DateTime'];
5287
+ /** Weekly reset period configuration */
4383
5288
  weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>;
5289
+ /** Yearly reset period configuration */
4384
5290
  yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput>;
4385
5291
  };
4386
- /** Input for fetching usage history */
5292
+ /** Input parameters for retrieving usage history */
4387
5293
  export declare type UsageHistoryV2Input = {
4388
- /** Customer ID */
5294
+ /** Customer id */
4389
5295
  customerId: Scalars['String'];
4390
- /** End date of the usage history */
5296
+ /** The end date of the range */
4391
5297
  endDate?: InputMaybe<Scalars['DateTime']>;
5298
+ /** The unique identifier for the environment */
4392
5299
  environmentId?: InputMaybe<Scalars['String']>;
4393
- /** Feature ID */
5300
+ /** Feature id */
4394
5301
  featureId: Scalars['String'];
4395
- /** Group usage per keys */
5302
+ /** Criteria by which to group the usage history */
4396
5303
  groupBy?: InputMaybe<Array<Scalars['String']>>;
4397
- /** Resource ID */
5304
+ /** Resource id */
4398
5305
  resourceId?: InputMaybe<Scalars['String']>;
4399
- /** Start date of the usage history */
5306
+ /** The start date of the range */
4400
5307
  startDate: Scalars['DateTime'];
4401
5308
  };
4402
5309
  /** Type of marker for a usage history point */
@@ -4406,14 +5313,23 @@ export declare enum UsageMarkerType {
4406
5313
  /** Usage was reset due to a subscription change */
4407
5314
  SubscriptionChangeReset = "SUBSCRIPTION_CHANGE_RESET"
4408
5315
  }
5316
+ /** Input for creating a usage measurement */
4409
5317
  export declare type UsageMeasurementCreateInput = {
5318
+ /** Timestamp of when the record was created */
4410
5319
  createdAt?: InputMaybe<Scalars['DateTime']>;
5320
+ /** Customer id */
4411
5321
  customerId: Scalars['String'];
5322
+ /** Additional dimensions for the usage report */
4412
5323
  dimensions?: InputMaybe<Scalars['JSON']>;
5324
+ /** The unique identifier for the environment */
4413
5325
  environmentId?: InputMaybe<Scalars['String']>;
5326
+ /** Feature id */
4414
5327
  featureId: Scalars['String'];
5328
+ /** Resource id */
4415
5329
  resourceId?: InputMaybe<Scalars['String']>;
5330
+ /** The method by which the usage value should be updated */
4416
5331
  updateBehavior?: InputMaybe<UsageUpdateBehavior>;
5332
+ /** The value to report for usage */
4417
5333
  value: Scalars['Float'];
4418
5334
  };
4419
5335
  export declare type UsageMeasurementFilter = {
@@ -4467,28 +5383,41 @@ export declare enum UsageMeasurementSortFields {
4467
5383
  EnvironmentId = "environmentId",
4468
5384
  Id = "id"
4469
5385
  }
5386
+ /** Update behavior */
4470
5387
  export declare enum UsageUpdateBehavior {
5388
+ /** Delta update */
4471
5389
  Delta = "DELTA",
5390
+ /** Set update */
4472
5391
  Set = "SET"
4473
5392
  }
4474
- /** Input type for validateMergeEnvironment query. */
5393
+ /** Input type for validateMergeEnvironment query */
4475
5394
  export declare type ValidateMergeEnvironmentInput = {
4476
- /** The slug of the environment to copy to. */
5395
+ /** Slug of the destination environment */
4477
5396
  destinationEnvironmentSlug: Scalars['String'];
4478
- /** Merge configuration */
5397
+ /** Optional configuration to customize how the validation is performed */
4479
5398
  mergeConfiguration?: InputMaybe<EnvironmentMergeConfigurationInput>;
4480
- /** The slug of the environment to copy from. */
5399
+ /** Slug of the source environment */
4481
5400
  sourceEnvironmentSlug: Scalars['String'];
4482
5401
  };
5402
+ /** A vendor identifier object */
4483
5403
  export declare enum VendorIdentifier {
5404
+ /** Auth0 integration vendor identifier */
4484
5405
  Auth0 = "AUTH0",
5406
+ /** AWS Marketplace integration vendor identifier */
4485
5407
  AwsMarketplace = "AWS_MARKETPLACE",
5408
+ /** Google BigQuery integration vendor identifier */
4486
5409
  BigQuery = "BIG_QUERY",
5410
+ /** HubSpot integration vendor identifier */
4487
5411
  Hubspot = "HUBSPOT",
5412
+ /** OpenFGA integration vendor identifier */
4488
5413
  OpenFga = "OPEN_FGA",
5414
+ /** Salesforce integration vendor identifier */
4489
5415
  Salesforce = "SALESFORCE",
5416
+ /** Snowflake integration vendor identifier */
4490
5417
  Snowflake = "SNOWFLAKE",
5418
+ /** Stripe integration vendor identifier */
4491
5419
  Stripe = "STRIPE",
5420
+ /** Zuora integration vendor identifier */
4492
5421
  Zuora = "ZUORA"
4493
5422
  }
4494
5423
  export declare type VendorIdentifierFilterComparison = {
@@ -4523,20 +5452,29 @@ export declare enum VendorType {
4523
5452
  /** Weekly reset period according to configuration */
4524
5453
  export declare enum WeeklyAccordingTo {
4525
5454
  EveryFriday = "EveryFriday",
5455
+ /** Every Monday */
4526
5456
  EveryMonday = "EveryMonday",
4527
5457
  EverySaturday = "EverySaturday",
5458
+ /** Every Sunday */
4528
5459
  EverySunday = "EverySunday",
5460
+ /** Every Thursday */
4529
5461
  EveryThursday = "EveryThursday",
5462
+ /** Every Tuesday */
4530
5463
  EveryTuesday = "EveryTuesday",
5464
+ /** Every Wednesday */
4531
5465
  EveryWednesday = "EveryWednesday",
5466
+ /** Subscription start */
4532
5467
  SubscriptionStart = "SubscriptionStart"
4533
5468
  }
5469
+ /** Weekly reset period config input */
4534
5470
  export declare type WeeklyResetPeriodConfigInput = {
5471
+ /** Weekly according to configuration */
4535
5472
  accordingTo: WeeklyAccordingTo;
4536
5473
  };
4537
5474
  export declare type WidgetConfigurationUpdateInput = {
4538
5475
  checkoutConfiguration?: InputMaybe<CheckoutConfigurationInput>;
4539
5476
  customerPortalConfiguration?: InputMaybe<CustomerPortalConfigurationInput>;
5477
+ /** The unique identifier for the environment */
4540
5478
  environmentId?: InputMaybe<Scalars['String']>;
4541
5479
  paywallConfiguration?: InputMaybe<PaywallConfigurationInput>;
4542
5480
  };
@@ -4548,28 +5486,39 @@ export declare enum WidgetType {
4548
5486
  }
4549
5487
  /** Workflow login input */
4550
5488
  export declare type WorkflowsLoginInput = {
4551
- /** Environment id */
5489
+ /** The unique identifier for the environment */
4552
5490
  environmentId?: InputMaybe<Scalars['String']>;
4553
5491
  };
4554
5492
  /** Yearly reset period according to configuration */
4555
5493
  export declare enum YearlyAccordingTo {
5494
+ /** Subscription start */
4556
5495
  SubscriptionStart = "SubscriptionStart"
4557
5496
  }
5497
+ /** Yearly reset period config input */
4558
5498
  export declare type YearlyResetPeriodConfigInput = {
5499
+ /** Yearly according to configuration */
4559
5500
  accordingTo: YearlyAccordingTo;
4560
5501
  };
5502
+ /** Input configuration for Zuora integration */
4561
5503
  export declare type ZuoraCredentialsInput = {
5504
+ /** REST Base URL of the Zuora account */
4562
5505
  baseUrl: Scalars['String'];
5506
+ /** Client ID for the Zuora account */
4563
5507
  clientId: Scalars['String'];
5508
+ /** Client secret for the Zuora account */
4564
5509
  clientSecret: Scalars['String'];
4565
5510
  /** The ID of the payment page to use */
4566
5511
  paymentPageId?: InputMaybe<Scalars['String']>;
5512
+ /** Stripe publishable key for the Zuora payment page */
4567
5513
  stripePublishableKey?: InputMaybe<Scalars['String']>;
5514
+ /** Stripe secret key for the Zuora payment page */
4568
5515
  stripeSecretKey?: InputMaybe<Scalars['String']>;
4569
5516
  };
4570
- /** The group of the experiment */
5517
+ /** The group type of the experiment */
4571
5518
  export declare enum ExperimentGroupType {
5519
+ /** Control group of the experiment */
4572
5520
  Control = "CONTROL",
5521
+ /** Variant group of the experiment */
4573
5522
  Variant = "VARIANT"
4574
5523
  }
4575
5524
  export declare type CouponFragment = {