stigg-api-client-v2 3.34.1__py3-none-any.whl → 3.38.0__py3-none-any.whl

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.

Potentially problematic release.


This version of stigg-api-client-v2 might be problematic. Click here for more details.

@@ -15,6 +15,7 @@ from .enums import (
15
15
  BillingVendorIdentifier,
16
16
  CouponStatus,
17
17
  CouponType,
18
+ CreditGrantType,
18
19
  Currency,
19
20
  DiscountDurationType,
20
21
  DiscountType,
@@ -228,258 +229,6 @@ class AddonFragmentDependencies(AddonDependencyFragment):
228
229
  pass
229
230
 
230
231
 
231
- class FeatureFragment(BaseModel):
232
- typename__: str = Field(alias="__typename")
233
- feature_type: FeatureType = Field(alias="featureType")
234
- meter_type: Optional[MeterType] = Field(alias="meterType", default=None)
235
- feature_units: Optional[str] = Field(alias="featureUnits", default=None)
236
- feature_units_plural: Optional[str] = Field(
237
- alias="featureUnitsPlural", default=None
238
- )
239
- description: Optional[str] = Field(default=None)
240
- display_name: str = Field(alias="displayName")
241
- ref_id: str = Field(alias="refId")
242
- unit_transformation: Optional["FeatureFragmentUnitTransformation"] = Field(
243
- alias="unitTransformation", default=None
244
- )
245
-
246
-
247
- class FeatureFragmentUnitTransformation(BaseModel):
248
- divide: float
249
- round: UnitTransformationRound
250
-
251
-
252
- class EntitlementFragment(BaseModel):
253
- typename__: str = Field(alias="__typename")
254
- is_granted: bool = Field(alias="isGranted")
255
- access_denied_reason: Optional[AccessDeniedReason] = Field(
256
- alias="accessDeniedReason", default=None
257
- )
258
- customer_id: Optional[str] = Field(alias="customerId", default=None)
259
- resource_id: Optional[str] = Field(alias="resourceId", default=None)
260
- usage_limit: Optional[float] = Field(alias="usageLimit", default=None)
261
- has_unlimited_usage: bool = Field(alias="hasUnlimitedUsage")
262
- has_soft_limit: Optional[bool] = Field(alias="hasSoftLimit", default=None)
263
- current_usage: Optional[float] = Field(alias="currentUsage", default=None)
264
- requested_usage: Optional[float] = Field(alias="requestedUsage", default=None)
265
- requested_values: Optional[List[str]] = Field(alias="requestedValues", default=None)
266
- enum_values: Optional[List[str]] = Field(alias="enumValues", default=None)
267
- entitlement_updated_at: Optional[Any] = Field(
268
- alias="entitlementUpdatedAt", default=None
269
- )
270
- usage_updated_at: Optional[Any] = Field(alias="usageUpdatedAt", default=None)
271
- usage_period_anchor: Optional[Any] = Field(alias="usagePeriodAnchor", default=None)
272
- usage_period_start: Optional[Any] = Field(alias="usagePeriodStart", default=None)
273
- usage_period_end: Optional[Any] = Field(alias="usagePeriodEnd", default=None)
274
- next_reset_date: Optional[Any] = Field(alias="nextResetDate", default=None)
275
- reset_period: Optional[EntitlementResetPeriod] = Field(
276
- alias="resetPeriod", default=None
277
- )
278
- reset_period_configuration: Optional[
279
- Annotated[
280
- Union[
281
- "EntitlementFragmentResetPeriodConfigurationMonthlyResetPeriodConfig",
282
- "EntitlementFragmentResetPeriodConfigurationWeeklyResetPeriodConfig",
283
- "EntitlementFragmentResetPeriodConfigurationYearlyResetPeriodConfig",
284
- ],
285
- Field(discriminator="typename__"),
286
- ]
287
- ] = Field(alias="resetPeriodConfiguration", default=None)
288
- feature: Optional["EntitlementFragmentFeature"] = Field(default=None)
289
-
290
-
291
- class EntitlementFragmentResetPeriodConfigurationMonthlyResetPeriodConfig(BaseModel):
292
- typename__: Literal["MonthlyResetPeriodConfig"] = Field(alias="__typename")
293
- monthly_according_to: Optional[MonthlyAccordingTo] = Field(
294
- alias="monthlyAccordingTo", default=None
295
- )
296
-
297
-
298
- class EntitlementFragmentResetPeriodConfigurationWeeklyResetPeriodConfig(BaseModel):
299
- typename__: Literal["WeeklyResetPeriodConfig"] = Field(alias="__typename")
300
- weekly_according_to: Optional[WeeklyAccordingTo] = Field(
301
- alias="weeklyAccordingTo", default=None
302
- )
303
-
304
-
305
- class EntitlementFragmentResetPeriodConfigurationYearlyResetPeriodConfig(BaseModel):
306
- typename__: Literal["YearlyResetPeriodConfig"] = Field(alias="__typename")
307
- yearly_according_to: Optional[YearlyAccordingTo] = Field(
308
- alias="yearlyAccordingTo", default=None
309
- )
310
-
311
-
312
- class EntitlementFragmentFeature(FeatureFragment):
313
- pass
314
-
315
-
316
- class TotalPriceFragment(BaseModel):
317
- sub_total: "TotalPriceFragmentSubTotal" = Field(alias="subTotal")
318
- total: "TotalPriceFragmentTotal"
319
-
320
-
321
- class TotalPriceFragmentSubTotal(BaseModel):
322
- amount: float
323
- currency: Currency
324
-
325
-
326
- class TotalPriceFragmentTotal(BaseModel):
327
- amount: float
328
- currency: Currency
329
-
330
-
331
- class CustomerResourceFragment(BaseModel):
332
- resource_id: str = Field(alias="resourceId")
333
-
334
-
335
- class SubscriptionInvoiceFragment(BaseModel):
336
- billing_id: str = Field(alias="billingId")
337
- status: SubscriptionInvoiceStatus
338
- created_at: Any = Field(alias="createdAt")
339
- due_date: Optional[Any] = Field(alias="dueDate", default=None)
340
- updated_at: Any = Field(alias="updatedAt")
341
- error_message: Optional[str] = Field(alias="errorMessage", default=None)
342
- requires_action: bool = Field(alias="requiresAction")
343
- payment_secret: Optional[str] = Field(alias="paymentSecret", default=None)
344
- payment_url: Optional[str] = Field(alias="paymentUrl", default=None)
345
- pdf_url: Optional[str] = Field(alias="pdfUrl", default=None)
346
- billing_reason: Optional[SubscriptionInvoiceBillingReason] = Field(
347
- alias="billingReason", default=None
348
- )
349
- currency: Optional[str] = Field(default=None)
350
- sub_total: Optional[float] = Field(alias="subTotal", default=None)
351
- sub_total_excluding_tax: Optional[float] = Field(
352
- alias="subTotalExcludingTax", default=None
353
- )
354
- total: Optional[float] = Field(default=None)
355
- total_excluding_tax: Optional[float] = Field(
356
- alias="totalExcludingTax", default=None
357
- )
358
- tax: Optional[float] = Field(default=None)
359
- amount_due: Optional[float] = Field(alias="amountDue", default=None)
360
- attempt_count: Optional[float] = Field(alias="attemptCount", default=None)
361
-
362
-
363
- class ProductFragment(BaseModel):
364
- ref_id: str = Field(alias="refId")
365
- display_name: Optional[str] = Field(alias="displayName", default=None)
366
- description: Optional[str] = Field(default=None)
367
- additional_meta_data: Optional[Any] = Field(
368
- alias="additionalMetaData", default=None
369
- )
370
- product_settings: "ProductFragmentProductSettings" = Field(alias="productSettings")
371
-
372
-
373
- class ProductFragmentProductSettings(BaseModel):
374
- downgrade_plan: Optional["ProductFragmentProductSettingsDowngradePlan"] = Field(
375
- alias="downgradePlan", default=None
376
- )
377
-
378
-
379
- class ProductFragmentProductSettingsDowngradePlan(BaseModel):
380
- ref_id: str = Field(alias="refId")
381
- display_name: str = Field(alias="displayName")
382
-
383
-
384
- class PlanCompatiblePackageGroupsFragment(BaseModel):
385
- package_group_id: str = Field(alias="packageGroupId")
386
- display_name: str = Field(alias="displayName")
387
- addons: Optional[List["PlanCompatiblePackageGroupsFragmentAddons"]] = Field(
388
- default=None
389
- )
390
- options: "PlanCompatiblePackageGroupsFragmentOptions"
391
-
392
-
393
- class PlanCompatiblePackageGroupsFragmentAddons(AddonFragment):
394
- pass
395
-
396
-
397
- class PlanCompatiblePackageGroupsFragmentOptions(BaseModel):
398
- min_items: Optional[float] = Field(alias="minItems", default=None)
399
- free_items: Optional[float] = Field(alias="freeItems", default=None)
400
-
401
-
402
- class PlanFragment(BaseModel):
403
- id: Any
404
- ref_id: str = Field(alias="refId")
405
- display_name: str = Field(alias="displayName")
406
- description: Optional[str] = Field(default=None)
407
- billing_id: Optional[str] = Field(alias="billingId", default=None)
408
- version_number: int = Field(alias="versionNumber")
409
- additional_meta_data: Optional[Any] = Field(
410
- alias="additionalMetaData", default=None
411
- )
412
- hidden_from_widgets: Optional[List[WidgetType]] = Field(
413
- alias="hiddenFromWidgets", default=None
414
- )
415
- product: "PlanFragmentProduct"
416
- base_plan: Optional["PlanFragmentBasePlan"] = Field(alias="basePlan", default=None)
417
- entitlements: Optional[List["PlanFragmentEntitlements"]] = Field(default=None)
418
- inherited_entitlements: Optional[List["PlanFragmentInheritedEntitlements"]] = Field(
419
- alias="inheritedEntitlements", default=None
420
- )
421
- compatible_addons: Optional[List["PlanFragmentCompatibleAddons"]] = Field(
422
- alias="compatibleAddons", default=None
423
- )
424
- compatible_package_groups: Optional[
425
- List["PlanFragmentCompatiblePackageGroups"]
426
- ] = Field(alias="compatiblePackageGroups", default=None)
427
- prices: Optional[List["PlanFragmentPrices"]] = Field(default=None)
428
- overage_prices: Optional[List["PlanFragmentOveragePrices"]] = Field(
429
- alias="overagePrices", default=None
430
- )
431
- pricing_type: Optional[PricingType] = Field(alias="pricingType", default=None)
432
- default_trial_config: Optional["PlanFragmentDefaultTrialConfig"] = Field(
433
- alias="defaultTrialConfig", default=None
434
- )
435
-
436
-
437
- class PlanFragmentProduct(ProductFragment):
438
- pass
439
-
440
-
441
- class PlanFragmentBasePlan(BaseModel):
442
- ref_id: str = Field(alias="refId")
443
- display_name: str = Field(alias="displayName")
444
-
445
-
446
- class PlanFragmentEntitlements(PackageEntitlementFragment):
447
- pass
448
-
449
-
450
- class PlanFragmentInheritedEntitlements(PackageEntitlementFragment):
451
- pass
452
-
453
-
454
- class PlanFragmentCompatibleAddons(AddonFragment):
455
- pass
456
-
457
-
458
- class PlanFragmentCompatiblePackageGroups(PlanCompatiblePackageGroupsFragment):
459
- pass
460
-
461
-
462
- class PlanFragmentPrices(PriceFragment):
463
- pass
464
-
465
-
466
- class PlanFragmentOveragePrices(OveragePriceFragment):
467
- pass
468
-
469
-
470
- class PlanFragmentDefaultTrialConfig(BaseModel):
471
- duration: float
472
- units: TrialPeriodUnits
473
- budget: Optional["PlanFragmentDefaultTrialConfigBudget"] = Field(default=None)
474
- trial_end_behavior: Optional[TrialEndBehavior] = Field(
475
- alias="trialEndBehavior", default=None
476
- )
477
-
478
-
479
- class PlanFragmentDefaultTrialConfigBudget(BaseModel):
480
- limit: float
481
-
482
-
483
232
  class SubscriptionScheduledUpdateData(BaseModel):
484
233
  subscription_schedule_type: SubscriptionScheduleType = Field(
485
234
  alias="subscriptionScheduleType"
@@ -642,6 +391,10 @@ class SubscriptionScheduledUpdateDataScheduleVariablesUnitAmountChangeVariables(
642
391
  feature_id: Optional[str] = Field(alias="featureId", default=None)
643
392
 
644
393
 
394
+ class CustomerResourceFragment(BaseModel):
395
+ resource_id: str = Field(alias="resourceId")
396
+
397
+
645
398
  class SlimCustomerFragment(BaseModel):
646
399
  id: Any
647
400
  name: Optional[str] = Field(default=None)
@@ -779,42 +532,205 @@ class SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariables(BaseModel
779
532
  ] = Field(alias="priceOverrides", default=None)
780
533
 
781
534
 
782
- class SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariablesBillableFeatures(
783
- BaseModel
784
- ):
785
- feature_id: str = Field(alias="featureId")
786
- quantity: float
535
+ class SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariablesBillableFeatures(
536
+ BaseModel
537
+ ):
538
+ feature_id: str = Field(alias="featureId")
539
+ quantity: float
540
+
541
+
542
+ class SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariablesAddons(BaseModel):
543
+ addon_ref_id: str = Field(alias="addonRefId")
544
+ quantity: float
545
+
546
+
547
+ class SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariablesPriceOverrides(
548
+ BaseModel
549
+ ):
550
+ plan_ref_id: Optional[str] = Field(alias="planRefId", default=None)
551
+ addon_ref_id: Optional[str] = Field(alias="addonRefId", default=None)
552
+ feature_id: Optional[str] = Field(alias="featureId", default=None)
553
+
554
+
555
+ class SubscriptionFutureUpdateDataScheduleVariablesPlanPriceOverrideChangeVariables(
556
+ BaseModel
557
+ ):
558
+ typename__: Literal["PlanPriceOverrideChangeVariables"] = Field(alias="__typename")
559
+ plan_ref_id: str = Field(alias="planRefId")
560
+ feature_id: Optional[str] = Field(alias="featureId", default=None)
561
+
562
+
563
+ class SubscriptionFutureUpdateDataScheduleVariablesUnitAmountChangeVariables(BaseModel):
564
+ typename__: Literal["UnitAmountChangeVariables"] = Field(alias="__typename")
565
+ new_unit_amount: Optional[float] = Field(alias="newUnitAmount", default=None)
566
+ feature_id: Optional[str] = Field(alias="featureId", default=None)
567
+
568
+
569
+ class SubscriptionTrialConfigurationFragment(BaseModel):
570
+ trial_end_behavior: TrialEndBehavior = Field(alias="trialEndBehavior")
571
+
572
+
573
+ class SubscriptionInvoiceFragment(BaseModel):
574
+ billing_id: str = Field(alias="billingId")
575
+ status: SubscriptionInvoiceStatus
576
+ created_at: Any = Field(alias="createdAt")
577
+ due_date: Optional[Any] = Field(alias="dueDate", default=None)
578
+ updated_at: Any = Field(alias="updatedAt")
579
+ error_message: Optional[str] = Field(alias="errorMessage", default=None)
580
+ requires_action: bool = Field(alias="requiresAction")
581
+ payment_secret: Optional[str] = Field(alias="paymentSecret", default=None)
582
+ payment_url: Optional[str] = Field(alias="paymentUrl", default=None)
583
+ pdf_url: Optional[str] = Field(alias="pdfUrl", default=None)
584
+ billing_reason: Optional[SubscriptionInvoiceBillingReason] = Field(
585
+ alias="billingReason", default=None
586
+ )
587
+ currency: Optional[str] = Field(default=None)
588
+ sub_total: Optional[float] = Field(alias="subTotal", default=None)
589
+ sub_total_excluding_tax: Optional[float] = Field(
590
+ alias="subTotalExcludingTax", default=None
591
+ )
592
+ total: Optional[float] = Field(default=None)
593
+ total_excluding_tax: Optional[float] = Field(
594
+ alias="totalExcludingTax", default=None
595
+ )
596
+ tax: Optional[float] = Field(default=None)
597
+ amount_due: Optional[float] = Field(alias="amountDue", default=None)
598
+ attempt_count: Optional[float] = Field(alias="attemptCount", default=None)
599
+
600
+
601
+ class ProductFragment(BaseModel):
602
+ ref_id: str = Field(alias="refId")
603
+ display_name: Optional[str] = Field(alias="displayName", default=None)
604
+ description: Optional[str] = Field(default=None)
605
+ additional_meta_data: Optional[Any] = Field(
606
+ alias="additionalMetaData", default=None
607
+ )
608
+ product_settings: "ProductFragmentProductSettings" = Field(alias="productSettings")
609
+
610
+
611
+ class ProductFragmentProductSettings(BaseModel):
612
+ downgrade_plan: Optional["ProductFragmentProductSettingsDowngradePlan"] = Field(
613
+ alias="downgradePlan", default=None
614
+ )
615
+
616
+
617
+ class ProductFragmentProductSettingsDowngradePlan(BaseModel):
618
+ ref_id: str = Field(alias="refId")
619
+ display_name: str = Field(alias="displayName")
620
+
621
+
622
+ class PlanCompatiblePackageGroupsFragment(BaseModel):
623
+ package_group_id: str = Field(alias="packageGroupId")
624
+ display_name: str = Field(alias="displayName")
625
+ addons: Optional[List["PlanCompatiblePackageGroupsFragmentAddons"]] = Field(
626
+ default=None
627
+ )
628
+ options: "PlanCompatiblePackageGroupsFragmentOptions"
629
+
630
+
631
+ class PlanCompatiblePackageGroupsFragmentAddons(AddonFragment):
632
+ pass
633
+
634
+
635
+ class PlanCompatiblePackageGroupsFragmentOptions(BaseModel):
636
+ min_items: Optional[float] = Field(alias="minItems", default=None)
637
+ free_items: Optional[float] = Field(alias="freeItems", default=None)
638
+
639
+
640
+ class PlanFragment(BaseModel):
641
+ id: Any
642
+ ref_id: str = Field(alias="refId")
643
+ display_name: str = Field(alias="displayName")
644
+ description: Optional[str] = Field(default=None)
645
+ billing_id: Optional[str] = Field(alias="billingId", default=None)
646
+ version_number: int = Field(alias="versionNumber")
647
+ additional_meta_data: Optional[Any] = Field(
648
+ alias="additionalMetaData", default=None
649
+ )
650
+ hidden_from_widgets: Optional[List[WidgetType]] = Field(
651
+ alias="hiddenFromWidgets", default=None
652
+ )
653
+ product: "PlanFragmentProduct"
654
+ base_plan: Optional["PlanFragmentBasePlan"] = Field(alias="basePlan", default=None)
655
+ entitlements: Optional[List["PlanFragmentEntitlements"]] = Field(default=None)
656
+ inherited_entitlements: Optional[List["PlanFragmentInheritedEntitlements"]] = Field(
657
+ alias="inheritedEntitlements", default=None
658
+ )
659
+ compatible_addons: Optional[List["PlanFragmentCompatibleAddons"]] = Field(
660
+ alias="compatibleAddons", default=None
661
+ )
662
+ compatible_package_groups: Optional[
663
+ List["PlanFragmentCompatiblePackageGroups"]
664
+ ] = Field(alias="compatiblePackageGroups", default=None)
665
+ prices: Optional[List["PlanFragmentPrices"]] = Field(default=None)
666
+ overage_prices: Optional[List["PlanFragmentOveragePrices"]] = Field(
667
+ alias="overagePrices", default=None
668
+ )
669
+ pricing_type: Optional[PricingType] = Field(alias="pricingType", default=None)
670
+ default_trial_config: Optional["PlanFragmentDefaultTrialConfig"] = Field(
671
+ alias="defaultTrialConfig", default=None
672
+ )
673
+
674
+
675
+ class PlanFragmentProduct(ProductFragment):
676
+ pass
677
+
678
+
679
+ class PlanFragmentBasePlan(BaseModel):
680
+ ref_id: str = Field(alias="refId")
681
+ display_name: str = Field(alias="displayName")
682
+
683
+
684
+ class PlanFragmentEntitlements(PackageEntitlementFragment):
685
+ pass
686
+
687
+
688
+ class PlanFragmentInheritedEntitlements(PackageEntitlementFragment):
689
+ pass
690
+
691
+
692
+ class PlanFragmentCompatibleAddons(AddonFragment):
693
+ pass
694
+
695
+
696
+ class PlanFragmentCompatiblePackageGroups(PlanCompatiblePackageGroupsFragment):
697
+ pass
698
+
699
+
700
+ class PlanFragmentPrices(PriceFragment):
701
+ pass
702
+
703
+
704
+ class PlanFragmentOveragePrices(OveragePriceFragment):
705
+ pass
787
706
 
788
707
 
789
- class SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariablesAddons(BaseModel):
790
- addon_ref_id: str = Field(alias="addonRefId")
791
- quantity: float
708
+ class PlanFragmentDefaultTrialConfig(BaseModel):
709
+ duration: float
710
+ units: TrialPeriodUnits
711
+ budget: Optional["PlanFragmentDefaultTrialConfigBudget"] = Field(default=None)
712
+ trial_end_behavior: Optional[TrialEndBehavior] = Field(
713
+ alias="trialEndBehavior", default=None
714
+ )
792
715
 
793
716
 
794
- class SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariablesPriceOverrides(
795
- BaseModel
796
- ):
797
- plan_ref_id: Optional[str] = Field(alias="planRefId", default=None)
798
- addon_ref_id: Optional[str] = Field(alias="addonRefId", default=None)
799
- feature_id: Optional[str] = Field(alias="featureId", default=None)
717
+ class PlanFragmentDefaultTrialConfigBudget(BaseModel):
718
+ limit: float
800
719
 
801
720
 
802
- class SubscriptionFutureUpdateDataScheduleVariablesPlanPriceOverrideChangeVariables(
803
- BaseModel
804
- ):
805
- typename__: Literal["PlanPriceOverrideChangeVariables"] = Field(alias="__typename")
806
- plan_ref_id: str = Field(alias="planRefId")
807
- feature_id: Optional[str] = Field(alias="featureId", default=None)
721
+ class TotalPriceFragment(BaseModel):
722
+ sub_total: "TotalPriceFragmentSubTotal" = Field(alias="subTotal")
723
+ total: "TotalPriceFragmentTotal"
808
724
 
809
725
 
810
- class SubscriptionFutureUpdateDataScheduleVariablesUnitAmountChangeVariables(BaseModel):
811
- typename__: Literal["UnitAmountChangeVariables"] = Field(alias="__typename")
812
- new_unit_amount: Optional[float] = Field(alias="newUnitAmount", default=None)
813
- feature_id: Optional[str] = Field(alias="featureId", default=None)
726
+ class TotalPriceFragmentSubTotal(BaseModel):
727
+ amount: float
728
+ currency: Currency
814
729
 
815
730
 
816
- class SubscriptionTrialConfigurationFragment(BaseModel):
817
- trial_end_behavior: TrialEndBehavior = Field(alias="trialEndBehavior")
731
+ class TotalPriceFragmentTotal(BaseModel):
732
+ amount: float
733
+ currency: Currency
818
734
 
819
735
 
820
736
  class SubscriptionFragment(BaseModel):
@@ -926,6 +842,91 @@ class SubscriptionFragmentTrialConfiguration(SubscriptionTrialConfigurationFragm
926
842
  pass
927
843
 
928
844
 
845
+ class FeatureFragment(BaseModel):
846
+ typename__: str = Field(alias="__typename")
847
+ feature_type: FeatureType = Field(alias="featureType")
848
+ meter_type: Optional[MeterType] = Field(alias="meterType", default=None)
849
+ feature_units: Optional[str] = Field(alias="featureUnits", default=None)
850
+ feature_units_plural: Optional[str] = Field(
851
+ alias="featureUnitsPlural", default=None
852
+ )
853
+ description: Optional[str] = Field(default=None)
854
+ display_name: str = Field(alias="displayName")
855
+ ref_id: str = Field(alias="refId")
856
+ unit_transformation: Optional["FeatureFragmentUnitTransformation"] = Field(
857
+ alias="unitTransformation", default=None
858
+ )
859
+
860
+
861
+ class FeatureFragmentUnitTransformation(BaseModel):
862
+ divide: float
863
+ round: UnitTransformationRound
864
+
865
+
866
+ class EntitlementFragment(BaseModel):
867
+ typename__: str = Field(alias="__typename")
868
+ is_granted: bool = Field(alias="isGranted")
869
+ access_denied_reason: Optional[AccessDeniedReason] = Field(
870
+ alias="accessDeniedReason", default=None
871
+ )
872
+ customer_id: Optional[str] = Field(alias="customerId", default=None)
873
+ resource_id: Optional[str] = Field(alias="resourceId", default=None)
874
+ usage_limit: Optional[float] = Field(alias="usageLimit", default=None)
875
+ has_unlimited_usage: bool = Field(alias="hasUnlimitedUsage")
876
+ has_soft_limit: Optional[bool] = Field(alias="hasSoftLimit", default=None)
877
+ current_usage: Optional[float] = Field(alias="currentUsage", default=None)
878
+ requested_usage: Optional[float] = Field(alias="requestedUsage", default=None)
879
+ requested_values: Optional[List[str]] = Field(alias="requestedValues", default=None)
880
+ enum_values: Optional[List[str]] = Field(alias="enumValues", default=None)
881
+ entitlement_updated_at: Optional[Any] = Field(
882
+ alias="entitlementUpdatedAt", default=None
883
+ )
884
+ usage_updated_at: Optional[Any] = Field(alias="usageUpdatedAt", default=None)
885
+ usage_period_anchor: Optional[Any] = Field(alias="usagePeriodAnchor", default=None)
886
+ usage_period_start: Optional[Any] = Field(alias="usagePeriodStart", default=None)
887
+ usage_period_end: Optional[Any] = Field(alias="usagePeriodEnd", default=None)
888
+ next_reset_date: Optional[Any] = Field(alias="nextResetDate", default=None)
889
+ reset_period: Optional[EntitlementResetPeriod] = Field(
890
+ alias="resetPeriod", default=None
891
+ )
892
+ reset_period_configuration: Optional[
893
+ Annotated[
894
+ Union[
895
+ "EntitlementFragmentResetPeriodConfigurationMonthlyResetPeriodConfig",
896
+ "EntitlementFragmentResetPeriodConfigurationWeeklyResetPeriodConfig",
897
+ "EntitlementFragmentResetPeriodConfigurationYearlyResetPeriodConfig",
898
+ ],
899
+ Field(discriminator="typename__"),
900
+ ]
901
+ ] = Field(alias="resetPeriodConfiguration", default=None)
902
+ feature: Optional["EntitlementFragmentFeature"] = Field(default=None)
903
+
904
+
905
+ class EntitlementFragmentResetPeriodConfigurationMonthlyResetPeriodConfig(BaseModel):
906
+ typename__: Literal["MonthlyResetPeriodConfig"] = Field(alias="__typename")
907
+ monthly_according_to: Optional[MonthlyAccordingTo] = Field(
908
+ alias="monthlyAccordingTo", default=None
909
+ )
910
+
911
+
912
+ class EntitlementFragmentResetPeriodConfigurationWeeklyResetPeriodConfig(BaseModel):
913
+ typename__: Literal["WeeklyResetPeriodConfig"] = Field(alias="__typename")
914
+ weekly_according_to: Optional[WeeklyAccordingTo] = Field(
915
+ alias="weeklyAccordingTo", default=None
916
+ )
917
+
918
+
919
+ class EntitlementFragmentResetPeriodConfigurationYearlyResetPeriodConfig(BaseModel):
920
+ typename__: Literal["YearlyResetPeriodConfig"] = Field(alias="__typename")
921
+ yearly_according_to: Optional[YearlyAccordingTo] = Field(
922
+ alias="yearlyAccordingTo", default=None
923
+ )
924
+
925
+
926
+ class EntitlementFragmentFeature(FeatureFragment):
927
+ pass
928
+
929
+
929
930
  class ApplySubscriptionFragment(BaseModel):
930
931
  subscription: Optional["ApplySubscriptionFragmentSubscription"] = Field(
931
932
  default=None
@@ -1168,6 +1169,50 @@ class CheckoutStateFragmentBillingIntegrationCredentials(BaseModel):
1168
1169
  public_key: str = Field(alias="publicKey")
1169
1170
 
1170
1171
 
1172
+ class CreditGrantFragment(BaseModel):
1173
+ grant_id: str = Field(alias="grantId")
1174
+ amount: float
1175
+ comment: Optional[str] = Field(default=None)
1176
+ currency_id: str = Field(alias="currencyId")
1177
+ customer_id: str = Field(alias="customerId")
1178
+ display_name: str = Field(alias="displayName")
1179
+ effective_at: Any = Field(alias="effectiveAt")
1180
+ expire_at: Optional[Any] = Field(alias="expireAt", default=None)
1181
+ grant_type: CreditGrantType = Field(alias="grantType")
1182
+ priority: float
1183
+ consumed_amount: float = Field(alias="consumedAmount")
1184
+ cost: "CreditGrantFragmentCost"
1185
+ created_at: Any = Field(alias="createdAt")
1186
+ updated_at: Any = Field(alias="updatedAt")
1187
+ resource_id: Optional[str] = Field(alias="resourceId", default=None)
1188
+ additional_meta_data: Optional[Any] = Field(
1189
+ alias="additionalMetaData", default=None
1190
+ )
1191
+
1192
+
1193
+ class CreditGrantFragmentCost(BaseModel):
1194
+ amount: float
1195
+ currency: Currency
1196
+
1197
+
1198
+ class CreditsBalanceSummaryFragment(BaseModel):
1199
+ customer_id: str = Field(alias="customerId")
1200
+ balances: List["CreditsBalanceSummaryFragmentBalances"]
1201
+
1202
+
1203
+ class CreditsBalanceSummaryFragmentBalances(BaseModel):
1204
+ currency: "CreditsBalanceSummaryFragmentBalancesCurrency"
1205
+ current_balance: float = Field(alias="currentBalance")
1206
+ total_consumed: float = Field(alias="totalConsumed")
1207
+ total_granted: float = Field(alias="totalGranted")
1208
+
1209
+
1210
+ class CreditsBalanceSummaryFragmentBalancesCurrency(BaseModel):
1211
+ currency_id: str = Field(alias="currencyId")
1212
+ display_name: str = Field(alias="displayName")
1213
+ symbol: Optional[str] = Field(default=None)
1214
+
1215
+
1171
1216
  class CustomerPortalBillingInformationFragment(BaseModel):
1172
1217
  email: Optional[str] = Field(default=None)
1173
1218
  name: Optional[str] = Field(default=None)
@@ -1282,13 +1327,6 @@ class CustomerPortalPromotionalEntitlementFragment(BaseModel):
1282
1327
  end_date: Optional[Any] = Field(alias="endDate", default=None)
1283
1328
 
1284
1329
 
1285
- class CustomerPortalSubscriptionAddonFragment(BaseModel):
1286
- addon_id: str = Field(alias="addonId")
1287
- description: Optional[str] = Field(default=None)
1288
- display_name: str = Field(alias="displayName")
1289
- quantity: int
1290
-
1291
-
1292
1330
  class CustomerPortalSubscriptionPriceFragment(BaseModel):
1293
1331
  billing_period: Optional[BillingPeriod] = Field(alias="billingPeriod", default=None)
1294
1332
  billing_model: Optional[BillingModel] = Field(alias="billingModel", default=None)
@@ -1493,6 +1531,13 @@ class CustomerPortalSubscriptionScheduledUpdateDataFragmentScheduleVariablesUnit
1493
1531
  feature_id: Optional[str] = Field(alias="featureId", default=None)
1494
1532
 
1495
1533
 
1534
+ class CustomerPortalSubscriptionAddonFragment(BaseModel):
1535
+ addon_id: str = Field(alias="addonId")
1536
+ description: Optional[str] = Field(default=None)
1537
+ display_name: str = Field(alias="displayName")
1538
+ quantity: int
1539
+
1540
+
1496
1541
  class CustomerPortalSubscriptionFragment(BaseModel):
1497
1542
  subscription_id: str = Field(alias="subscriptionId")
1498
1543
  plan_id: str = Field(alias="planId")
@@ -1824,40 +1869,6 @@ class MockPaywallAddonDependencyFragment(BaseModel):
1824
1869
  description: Optional[str] = Field(default=None)
1825
1870
 
1826
1871
 
1827
- class MockPaywallPackageEntitlementFragment(BaseModel):
1828
- usage_limit: Optional[float] = Field(alias="usageLimit", default=None)
1829
- has_unlimited_usage: bool = Field(alias="hasUnlimitedUsage")
1830
- has_soft_limit: Optional[bool] = Field(alias="hasSoftLimit", default=None)
1831
- reset_period: Optional[EntitlementResetPeriod] = Field(
1832
- alias="resetPeriod", default=None
1833
- )
1834
- hidden_from_widgets: Optional[List[WidgetType]] = Field(
1835
- alias="hiddenFromWidgets", default=None
1836
- )
1837
- display_name_override: Optional[str] = Field(
1838
- alias="displayNameOverride", default=None
1839
- )
1840
- enum_values: Optional[List[str]] = Field(alias="enumValues", default=None)
1841
- feature: Optional["MockPaywallPackageEntitlementFragmentFeature"] = Field(
1842
- default=None
1843
- )
1844
-
1845
-
1846
- class MockPaywallPackageEntitlementFragmentFeature(BaseModel):
1847
- feature_type: FeatureType = Field(alias="featureType")
1848
- meter_type: Optional[MeterType] = Field(alias="meterType", default=None)
1849
- feature_units: Optional[str] = Field(alias="featureUnits", default=None)
1850
- feature_units_plural: Optional[str] = Field(
1851
- alias="featureUnitsPlural", default=None
1852
- )
1853
- display_name: str = Field(alias="displayName")
1854
- description: Optional[str] = Field(default=None)
1855
- ref_id: str = Field(alias="refId")
1856
- additional_meta_data: Optional[Any] = Field(
1857
- alias="additionalMetaData", default=None
1858
- )
1859
-
1860
-
1861
1872
  class MockPaywallPriceFragment(BaseModel):
1862
1873
  billing_model: BillingModel = Field(alias="billingModel")
1863
1874
  billing_period: BillingPeriod = Field(alias="billingPeriod")
@@ -1900,6 +1911,40 @@ class MockPaywallPriceFragmentFeature(BaseModel):
1900
1911
  display_name: str = Field(alias="displayName")
1901
1912
 
1902
1913
 
1914
+ class MockPaywallPackageEntitlementFragment(BaseModel):
1915
+ usage_limit: Optional[float] = Field(alias="usageLimit", default=None)
1916
+ has_unlimited_usage: bool = Field(alias="hasUnlimitedUsage")
1917
+ has_soft_limit: Optional[bool] = Field(alias="hasSoftLimit", default=None)
1918
+ reset_period: Optional[EntitlementResetPeriod] = Field(
1919
+ alias="resetPeriod", default=None
1920
+ )
1921
+ hidden_from_widgets: Optional[List[WidgetType]] = Field(
1922
+ alias="hiddenFromWidgets", default=None
1923
+ )
1924
+ display_name_override: Optional[str] = Field(
1925
+ alias="displayNameOverride", default=None
1926
+ )
1927
+ enum_values: Optional[List[str]] = Field(alias="enumValues", default=None)
1928
+ feature: Optional["MockPaywallPackageEntitlementFragmentFeature"] = Field(
1929
+ default=None
1930
+ )
1931
+
1932
+
1933
+ class MockPaywallPackageEntitlementFragmentFeature(BaseModel):
1934
+ feature_type: FeatureType = Field(alias="featureType")
1935
+ meter_type: Optional[MeterType] = Field(alias="meterType", default=None)
1936
+ feature_units: Optional[str] = Field(alias="featureUnits", default=None)
1937
+ feature_units_plural: Optional[str] = Field(
1938
+ alias="featureUnitsPlural", default=None
1939
+ )
1940
+ display_name: str = Field(alias="displayName")
1941
+ description: Optional[str] = Field(default=None)
1942
+ ref_id: str = Field(alias="refId")
1943
+ additional_meta_data: Optional[Any] = Field(
1944
+ alias="additionalMetaData", default=None
1945
+ )
1946
+
1947
+
1903
1948
  class MockPaywallAddonFragment(BaseModel):
1904
1949
  ref_id: str = Field(alias="refId")
1905
1950
  display_name: str = Field(alias="displayName")
@@ -2878,19 +2923,19 @@ PriceTierFragment.model_rebuild()
2878
2923
  PriceFragment.model_rebuild()
2879
2924
  OveragePriceFragment.model_rebuild()
2880
2925
  AddonFragment.model_rebuild()
2881
- FeatureFragment.model_rebuild()
2882
- EntitlementFragment.model_rebuild()
2883
- TotalPriceFragment.model_rebuild()
2926
+ SubscriptionScheduledUpdateData.model_rebuild()
2884
2927
  CustomerResourceFragment.model_rebuild()
2928
+ SlimCustomerFragment.model_rebuild()
2929
+ SubscriptionFutureUpdateData.model_rebuild()
2930
+ SubscriptionTrialConfigurationFragment.model_rebuild()
2885
2931
  SubscriptionInvoiceFragment.model_rebuild()
2886
2932
  ProductFragment.model_rebuild()
2887
2933
  PlanCompatiblePackageGroupsFragment.model_rebuild()
2888
2934
  PlanFragment.model_rebuild()
2889
- SubscriptionScheduledUpdateData.model_rebuild()
2890
- SlimCustomerFragment.model_rebuild()
2891
- SubscriptionFutureUpdateData.model_rebuild()
2892
- SubscriptionTrialConfigurationFragment.model_rebuild()
2935
+ TotalPriceFragment.model_rebuild()
2893
2936
  SubscriptionFragment.model_rebuild()
2937
+ FeatureFragment.model_rebuild()
2938
+ EntitlementFragment.model_rebuild()
2894
2939
  ApplySubscriptionFragment.model_rebuild()
2895
2940
  FontVariantFragment.model_rebuild()
2896
2941
  TypographyConfigurationFragment.model_rebuild()
@@ -2899,13 +2944,15 @@ PromotionalEntitlementFragment.model_rebuild()
2899
2944
  CouponFragment.model_rebuild()
2900
2945
  CustomerFragment.model_rebuild()
2901
2946
  CheckoutStateFragment.model_rebuild()
2947
+ CreditGrantFragment.model_rebuild()
2948
+ CreditsBalanceSummaryFragment.model_rebuild()
2902
2949
  CustomerPortalBillingInformationFragment.model_rebuild()
2903
2950
  CustomerPortalConfigurationFragment.model_rebuild()
2904
2951
  CustomerPortalEntitlementFragment.model_rebuild()
2905
2952
  CustomerPortalPromotionalEntitlementFragment.model_rebuild()
2906
- CustomerPortalSubscriptionAddonFragment.model_rebuild()
2907
2953
  CustomerPortalSubscriptionPriceFragment.model_rebuild()
2908
2954
  CustomerPortalSubscriptionScheduledUpdateDataFragment.model_rebuild()
2955
+ CustomerPortalSubscriptionAddonFragment.model_rebuild()
2909
2956
  CustomerPortalSubscriptionFragment.model_rebuild()
2910
2957
  CustomerPortalFragment.model_rebuild()
2911
2958
  CustomerStatisticsFragment.model_rebuild()
@@ -2916,8 +2963,8 @@ EntitlementsUpdatedPayload.model_rebuild()
2916
2963
  ImmediateSubscriptionPreviewInvoiceFragment.model_rebuild()
2917
2964
  LayoutConfigurationFragment.model_rebuild()
2918
2965
  MockPaywallAddonDependencyFragment.model_rebuild()
2919
- MockPaywallPackageEntitlementFragment.model_rebuild()
2920
2966
  MockPaywallPriceFragment.model_rebuild()
2967
+ MockPaywallPackageEntitlementFragment.model_rebuild()
2921
2968
  MockPaywallAddonFragment.model_rebuild()
2922
2969
  MockPaywallPlanCompatiblePackageGroupsFragment.model_rebuild()
2923
2970
  MockPaywallPlanFragment.model_rebuild()