stigg-api-client-v2 2.488.0__py3-none-any.whl → 2.491.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.

stigg/generated/enums.py CHANGED
@@ -456,6 +456,7 @@ class ErrorCode(str, Enum):
456
456
  DuplicateProductValidationError = "DuplicateProductValidationError"
457
457
  DuplicatedEntityNotAllowed = "DuplicatedEntityNotAllowed"
458
458
  EditAllowedOnDraftPackageOnlyError = "EditAllowedOnDraftPackageOnlyError"
459
+ EntitlementBelongsToFeatureGroupError = "EntitlementBelongsToFeatureGroupError"
459
460
  EntitlementLimitExceededError = "EntitlementLimitExceededError"
460
461
  EntitlementUsageOutOfRangeError = "EntitlementUsageOutOfRangeError"
461
462
  EntitlementsMustBelongToSamePackage = "EntitlementsMustBelongToSamePackage"
@@ -116,6 +116,38 @@ class PriceFragmentFeature(BaseModel):
116
116
  description: Optional[str] = Field(default=None)
117
117
 
118
118
 
119
+ class OveragePriceFragment(BaseModel):
120
+ billing_model: BillingModel = Field(alias="billingModel")
121
+ billing_period: BillingPeriod = Field(alias="billingPeriod")
122
+ billing_id: Optional[str] = Field(alias="billingId", default=None)
123
+ billing_country_code: Optional[str] = Field(
124
+ alias="billingCountryCode", default=None
125
+ )
126
+ price: Optional["OveragePriceFragmentPrice"] = Field(default=None)
127
+ tiers_mode: Optional[TiersMode] = Field(alias="tiersMode", default=None)
128
+ tiers: Optional[List["OveragePriceFragmentTiers"]] = Field(default=None)
129
+ feature: Optional["OveragePriceFragmentFeature"] = Field(default=None)
130
+
131
+
132
+ class OveragePriceFragmentPrice(BaseModel):
133
+ amount: float
134
+ currency: Currency
135
+
136
+
137
+ class OveragePriceFragmentTiers(PriceTierFragment):
138
+ pass
139
+
140
+
141
+ class OveragePriceFragmentFeature(BaseModel):
142
+ ref_id: str = Field(alias="refId")
143
+ feature_units: Optional[str] = Field(alias="featureUnits", default=None)
144
+ feature_units_plural: Optional[str] = Field(
145
+ alias="featureUnitsPlural", default=None
146
+ )
147
+ display_name: str = Field(alias="displayName")
148
+ description: Optional[str] = Field(default=None)
149
+
150
+
119
151
  class PackageEntitlementFragment(BaseModel):
120
152
  usage_limit: Optional[float] = Field(alias="usageLimit", default=None)
121
153
  has_unlimited_usage: Optional[bool] = Field(alias="hasUnlimitedUsage", default=None)
@@ -150,38 +182,6 @@ class PackageEntitlementFragmentFeature(BaseModel):
150
182
  )
151
183
 
152
184
 
153
- class OveragePriceFragment(BaseModel):
154
- billing_model: BillingModel = Field(alias="billingModel")
155
- billing_period: BillingPeriod = Field(alias="billingPeriod")
156
- billing_id: Optional[str] = Field(alias="billingId", default=None)
157
- billing_country_code: Optional[str] = Field(
158
- alias="billingCountryCode", default=None
159
- )
160
- price: Optional["OveragePriceFragmentPrice"] = Field(default=None)
161
- tiers_mode: Optional[TiersMode] = Field(alias="tiersMode", default=None)
162
- tiers: Optional[List["OveragePriceFragmentTiers"]] = Field(default=None)
163
- feature: Optional["OveragePriceFragmentFeature"] = Field(default=None)
164
-
165
-
166
- class OveragePriceFragmentPrice(BaseModel):
167
- amount: float
168
- currency: Currency
169
-
170
-
171
- class OveragePriceFragmentTiers(PriceTierFragment):
172
- pass
173
-
174
-
175
- class OveragePriceFragmentFeature(BaseModel):
176
- ref_id: str = Field(alias="refId")
177
- feature_units: Optional[str] = Field(alias="featureUnits", default=None)
178
- feature_units_plural: Optional[str] = Field(
179
- alias="featureUnitsPlural", default=None
180
- )
181
- display_name: str = Field(alias="displayName")
182
- description: Optional[str] = Field(default=None)
183
-
184
-
185
185
  class AddonFragment(BaseModel):
186
186
  id: Any
187
187
  ref_id: str = Field(alias="refId")
@@ -220,31 +220,89 @@ class AddonFragmentDependencies(AddonDependencyFragment):
220
220
  pass
221
221
 
222
222
 
223
- class SubscriptionInvoiceFragment(BaseModel):
224
- billing_id: str = Field(alias="billingId")
225
- status: SubscriptionInvoiceStatus
226
- created_at: Any = Field(alias="createdAt")
227
- updated_at: Any = Field(alias="updatedAt")
228
- error_message: Optional[str] = Field(alias="errorMessage", default=None)
229
- requires_action: bool = Field(alias="requiresAction")
230
- payment_secret: Optional[str] = Field(alias="paymentSecret", default=None)
231
- payment_url: Optional[str] = Field(alias="paymentUrl", default=None)
232
- pdf_url: Optional[str] = Field(alias="pdfUrl", default=None)
233
- billing_reason: Optional[SubscriptionInvoiceBillingReason] = Field(
234
- alias="billingReason", default=None
223
+ class FeatureFragment(BaseModel):
224
+ typename__: str = Field(alias="__typename")
225
+ feature_type: FeatureType = Field(alias="featureType")
226
+ meter_type: Optional[MeterType] = Field(alias="meterType", default=None)
227
+ feature_units: Optional[str] = Field(alias="featureUnits", default=None)
228
+ feature_units_plural: Optional[str] = Field(
229
+ alias="featureUnitsPlural", default=None
235
230
  )
236
- currency: Optional[str] = Field(default=None)
237
- sub_total: Optional[float] = Field(alias="subTotal", default=None)
238
- sub_total_excluding_tax: Optional[float] = Field(
239
- alias="subTotalExcludingTax", default=None
231
+ description: Optional[str] = Field(default=None)
232
+ display_name: str = Field(alias="displayName")
233
+ ref_id: str = Field(alias="refId")
234
+ unit_transformation: Optional["FeatureFragmentUnitTransformation"] = Field(
235
+ alias="unitTransformation", default=None
240
236
  )
241
- total: Optional[float] = Field(default=None)
242
- total_excluding_tax: Optional[float] = Field(
243
- alias="totalExcludingTax", default=None
237
+
238
+
239
+ class FeatureFragmentUnitTransformation(BaseModel):
240
+ divide: float
241
+ round: UnitTransformationRound
242
+
243
+
244
+ class EntitlementFragment(BaseModel):
245
+ typename__: str = Field(alias="__typename")
246
+ is_granted: bool = Field(alias="isGranted")
247
+ access_denied_reason: Optional[AccessDeniedReason] = Field(
248
+ alias="accessDeniedReason", default=None
244
249
  )
245
- tax: Optional[float] = Field(default=None)
246
- amount_due: Optional[float] = Field(alias="amountDue", default=None)
247
- attempt_count: Optional[float] = Field(alias="attemptCount", default=None)
250
+ customer_id: Optional[str] = Field(alias="customerId", default=None)
251
+ resource_id: Optional[str] = Field(alias="resourceId", default=None)
252
+ usage_limit: Optional[float] = Field(alias="usageLimit", default=None)
253
+ has_unlimited_usage: bool = Field(alias="hasUnlimitedUsage")
254
+ has_soft_limit: Optional[bool] = Field(alias="hasSoftLimit", default=None)
255
+ current_usage: Optional[float] = Field(alias="currentUsage", default=None)
256
+ requested_usage: Optional[float] = Field(alias="requestedUsage", default=None)
257
+ requested_values: Optional[List[str]] = Field(alias="requestedValues", default=None)
258
+ enum_values: Optional[List[str]] = Field(alias="enumValues", default=None)
259
+ entitlement_updated_at: Optional[Any] = Field(
260
+ alias="entitlementUpdatedAt", default=None
261
+ )
262
+ usage_updated_at: Optional[Any] = Field(alias="usageUpdatedAt", default=None)
263
+ usage_period_anchor: Optional[Any] = Field(alias="usagePeriodAnchor", default=None)
264
+ usage_period_start: Optional[Any] = Field(alias="usagePeriodStart", default=None)
265
+ usage_period_end: Optional[Any] = Field(alias="usagePeriodEnd", default=None)
266
+ next_reset_date: Optional[Any] = Field(alias="nextResetDate", default=None)
267
+ reset_period: Optional[EntitlementResetPeriod] = Field(
268
+ alias="resetPeriod", default=None
269
+ )
270
+ reset_period_configuration: Optional[
271
+ Annotated[
272
+ Union[
273
+ "EntitlementFragmentResetPeriodConfigurationMonthlyResetPeriodConfig",
274
+ "EntitlementFragmentResetPeriodConfigurationWeeklyResetPeriodConfig",
275
+ "EntitlementFragmentResetPeriodConfigurationYearlyResetPeriodConfig",
276
+ ],
277
+ Field(discriminator="typename__"),
278
+ ]
279
+ ] = Field(alias="resetPeriodConfiguration", default=None)
280
+ feature: Optional["EntitlementFragmentFeature"] = Field(default=None)
281
+
282
+
283
+ class EntitlementFragmentResetPeriodConfigurationMonthlyResetPeriodConfig(BaseModel):
284
+ typename__: Literal["MonthlyResetPeriodConfig"] = Field(alias="__typename")
285
+ monthly_according_to: Optional[MonthlyAccordingTo] = Field(
286
+ alias="monthlyAccordingTo", default=None
287
+ )
288
+
289
+
290
+ class EntitlementFragmentResetPeriodConfigurationWeeklyResetPeriodConfig(BaseModel):
291
+ typename__: Literal["WeeklyResetPeriodConfig"] = Field(alias="__typename")
292
+ weekly_according_to: Optional[WeeklyAccordingTo] = Field(
293
+ alias="weeklyAccordingTo", default=None
294
+ )
295
+
296
+
297
+ class EntitlementFragmentResetPeriodConfigurationYearlyResetPeriodConfig(BaseModel):
298
+ typename__: Literal["YearlyResetPeriodConfig"] = Field(alias="__typename")
299
+ yearly_according_to: Optional[YearlyAccordingTo] = Field(
300
+ alias="yearlyAccordingTo", default=None
301
+ )
302
+
303
+
304
+ class EntitlementFragmentFeature(FeatureFragment):
305
+ pass
248
306
 
249
307
 
250
308
  class SlimCustomerFragment(BaseModel):
@@ -264,14 +322,145 @@ class SlimCustomerFragment(BaseModel):
264
322
  )
265
323
 
266
324
 
267
- class CustomerResourceFragment(BaseModel):
268
- resource_id: str = Field(alias="resourceId")
269
-
270
-
271
325
  class SubscriptionTrialConfigurationFragment(BaseModel):
272
326
  trial_end_behavior: TrialEndBehavior = Field(alias="trialEndBehavior")
273
327
 
274
328
 
329
+ class TotalPriceFragment(BaseModel):
330
+ sub_total: "TotalPriceFragmentSubTotal" = Field(alias="subTotal")
331
+ total: "TotalPriceFragmentTotal"
332
+
333
+
334
+ class TotalPriceFragmentSubTotal(BaseModel):
335
+ amount: float
336
+ currency: Currency
337
+
338
+
339
+ class TotalPriceFragmentTotal(BaseModel):
340
+ amount: float
341
+ currency: Currency
342
+
343
+
344
+ class PlanCompatiblePackageGroupsFragment(BaseModel):
345
+ package_group_id: str = Field(alias="packageGroupId")
346
+ display_name: str = Field(alias="displayName")
347
+ addons: Optional[List["PlanCompatiblePackageGroupsFragmentAddons"]] = Field(
348
+ default=None
349
+ )
350
+ options: "PlanCompatiblePackageGroupsFragmentOptions"
351
+
352
+
353
+ class PlanCompatiblePackageGroupsFragmentAddons(AddonFragment):
354
+ pass
355
+
356
+
357
+ class PlanCompatiblePackageGroupsFragmentOptions(BaseModel):
358
+ min_items: Optional[float] = Field(alias="minItems", default=None)
359
+ free_items: Optional[float] = Field(alias="freeItems", default=None)
360
+
361
+
362
+ class ProductFragment(BaseModel):
363
+ ref_id: str = Field(alias="refId")
364
+ display_name: Optional[str] = Field(alias="displayName", default=None)
365
+ description: Optional[str] = Field(default=None)
366
+ additional_meta_data: Optional[Any] = Field(
367
+ alias="additionalMetaData", default=None
368
+ )
369
+ product_settings: "ProductFragmentProductSettings" = Field(alias="productSettings")
370
+
371
+
372
+ class ProductFragmentProductSettings(BaseModel):
373
+ downgrade_plan: Optional["ProductFragmentProductSettingsDowngradePlan"] = Field(
374
+ alias="downgradePlan", default=None
375
+ )
376
+
377
+
378
+ class ProductFragmentProductSettingsDowngradePlan(BaseModel):
379
+ ref_id: str = Field(alias="refId")
380
+ display_name: str = Field(alias="displayName")
381
+
382
+
383
+ class PlanFragment(BaseModel):
384
+ id: Any
385
+ ref_id: str = Field(alias="refId")
386
+ display_name: str = Field(alias="displayName")
387
+ description: Optional[str] = Field(default=None)
388
+ billing_id: Optional[str] = Field(alias="billingId", default=None)
389
+ version_number: int = Field(alias="versionNumber")
390
+ additional_meta_data: Optional[Any] = Field(
391
+ alias="additionalMetaData", default=None
392
+ )
393
+ hidden_from_widgets: Optional[List[WidgetType]] = Field(
394
+ alias="hiddenFromWidgets", default=None
395
+ )
396
+ product: "PlanFragmentProduct"
397
+ base_plan: Optional["PlanFragmentBasePlan"] = Field(alias="basePlan", default=None)
398
+ entitlements: Optional[List["PlanFragmentEntitlements"]] = Field(default=None)
399
+ inherited_entitlements: Optional[List["PlanFragmentInheritedEntitlements"]] = Field(
400
+ alias="inheritedEntitlements", default=None
401
+ )
402
+ compatible_addons: Optional[List["PlanFragmentCompatibleAddons"]] = Field(
403
+ alias="compatibleAddons", default=None
404
+ )
405
+ compatible_package_groups: Optional[
406
+ List["PlanFragmentCompatiblePackageGroups"]
407
+ ] = Field(alias="compatiblePackageGroups", default=None)
408
+ prices: Optional[List["PlanFragmentPrices"]] = Field(default=None)
409
+ overage_prices: Optional[List["PlanFragmentOveragePrices"]] = Field(
410
+ alias="overagePrices", default=None
411
+ )
412
+ pricing_type: Optional[PricingType] = Field(alias="pricingType", default=None)
413
+ default_trial_config: Optional["PlanFragmentDefaultTrialConfig"] = Field(
414
+ alias="defaultTrialConfig", default=None
415
+ )
416
+
417
+
418
+ class PlanFragmentProduct(ProductFragment):
419
+ pass
420
+
421
+
422
+ class PlanFragmentBasePlan(BaseModel):
423
+ ref_id: str = Field(alias="refId")
424
+ display_name: str = Field(alias="displayName")
425
+
426
+
427
+ class PlanFragmentEntitlements(PackageEntitlementFragment):
428
+ pass
429
+
430
+
431
+ class PlanFragmentInheritedEntitlements(PackageEntitlementFragment):
432
+ pass
433
+
434
+
435
+ class PlanFragmentCompatibleAddons(AddonFragment):
436
+ pass
437
+
438
+
439
+ class PlanFragmentCompatiblePackageGroups(PlanCompatiblePackageGroupsFragment):
440
+ pass
441
+
442
+
443
+ class PlanFragmentPrices(PriceFragment):
444
+ pass
445
+
446
+
447
+ class PlanFragmentOveragePrices(OveragePriceFragment):
448
+ pass
449
+
450
+
451
+ class PlanFragmentDefaultTrialConfig(BaseModel):
452
+ duration: float
453
+ units: TrialPeriodUnits
454
+ budget: Optional["PlanFragmentDefaultTrialConfigBudget"] = Field(default=None)
455
+ trial_end_behavior: Optional[TrialEndBehavior] = Field(
456
+ alias="trialEndBehavior", default=None
457
+ )
458
+
459
+
460
+ class PlanFragmentDefaultTrialConfigBudget(BaseModel):
461
+ limit: float
462
+
463
+
275
464
  class SubscriptionFutureUpdateData(BaseModel):
276
465
  subscription_schedule_type: SubscriptionScheduleType = Field(
277
466
  alias="subscriptionScheduleType"
@@ -426,6 +615,37 @@ class SubscriptionFutureUpdateDataScheduleVariablesUnitAmountChangeVariables(Bas
426
615
  feature_id: Optional[str] = Field(alias="featureId", default=None)
427
616
 
428
617
 
618
+ class SubscriptionInvoiceFragment(BaseModel):
619
+ billing_id: str = Field(alias="billingId")
620
+ status: SubscriptionInvoiceStatus
621
+ created_at: Any = Field(alias="createdAt")
622
+ updated_at: Any = Field(alias="updatedAt")
623
+ error_message: Optional[str] = Field(alias="errorMessage", default=None)
624
+ requires_action: bool = Field(alias="requiresAction")
625
+ payment_secret: Optional[str] = Field(alias="paymentSecret", default=None)
626
+ payment_url: Optional[str] = Field(alias="paymentUrl", default=None)
627
+ pdf_url: Optional[str] = Field(alias="pdfUrl", default=None)
628
+ billing_reason: Optional[SubscriptionInvoiceBillingReason] = Field(
629
+ alias="billingReason", default=None
630
+ )
631
+ currency: Optional[str] = Field(default=None)
632
+ sub_total: Optional[float] = Field(alias="subTotal", default=None)
633
+ sub_total_excluding_tax: Optional[float] = Field(
634
+ alias="subTotalExcludingTax", default=None
635
+ )
636
+ total: Optional[float] = Field(default=None)
637
+ total_excluding_tax: Optional[float] = Field(
638
+ alias="totalExcludingTax", default=None
639
+ )
640
+ tax: Optional[float] = Field(default=None)
641
+ amount_due: Optional[float] = Field(alias="amountDue", default=None)
642
+ attempt_count: Optional[float] = Field(alias="attemptCount", default=None)
643
+
644
+
645
+ class CustomerResourceFragment(BaseModel):
646
+ resource_id: str = Field(alias="resourceId")
647
+
648
+
429
649
  class SubscriptionScheduledUpdateData(BaseModel):
430
650
  subscription_schedule_type: SubscriptionScheduleType = Field(
431
651
  alias="subscriptionScheduleType"
@@ -513,214 +733,79 @@ class SubscriptionScheduledUpdateDataScheduleVariablesDowngradeChangeVariablesBi
513
733
  quantity: float
514
734
 
515
735
 
516
- class SubscriptionScheduledUpdateDataScheduleVariablesDowngradeChangeVariablesAddons(
517
- BaseModel
518
- ):
519
- addon_ref_id: str = Field(alias="addonRefId")
520
- quantity: float
521
-
522
-
523
- class SubscriptionScheduledUpdateDataScheduleVariablesDowngradeChangeVariablesPriceOverrides(
524
- BaseModel
525
- ):
526
- plan_ref_id: Optional[str] = Field(alias="planRefId", default=None)
527
- addon_ref_id: Optional[str] = Field(alias="addonRefId", default=None)
528
- feature_id: Optional[str] = Field(alias="featureId", default=None)
529
-
530
-
531
- class SubscriptionScheduledUpdateDataScheduleVariablesPlanChangeVariables(BaseModel):
532
- typename__: Literal["PlanChangeVariables"] = Field(alias="__typename")
533
- plan_ref_id: str = Field(alias="planRefId")
534
- change_type: PlanChangeType = Field(alias="changeType")
535
- billing_period: Optional[BillingPeriod] = Field(alias="billingPeriod", default=None)
536
- billable_features: Optional[
537
- List[
538
- "SubscriptionScheduledUpdateDataScheduleVariablesPlanChangeVariablesBillableFeatures"
539
- ]
540
- ] = Field(alias="billableFeatures", default=None)
541
- addons: Optional[
542
- List[
543
- "SubscriptionScheduledUpdateDataScheduleVariablesPlanChangeVariablesAddons"
544
- ]
545
- ] = Field(default=None)
546
- price_overrides: Optional[
547
- List[
548
- "SubscriptionScheduledUpdateDataScheduleVariablesPlanChangeVariablesPriceOverrides"
549
- ]
550
- ] = Field(alias="priceOverrides", default=None)
551
-
552
-
553
- class SubscriptionScheduledUpdateDataScheduleVariablesPlanChangeVariablesBillableFeatures(
554
- BaseModel
555
- ):
556
- feature_id: str = Field(alias="featureId")
557
- quantity: float
558
-
559
-
560
- class SubscriptionScheduledUpdateDataScheduleVariablesPlanChangeVariablesAddons(
561
- BaseModel
562
- ):
563
- addon_ref_id: str = Field(alias="addonRefId")
564
- quantity: float
565
-
566
-
567
- class SubscriptionScheduledUpdateDataScheduleVariablesPlanChangeVariablesPriceOverrides(
568
- BaseModel
569
- ):
570
- plan_ref_id: Optional[str] = Field(alias="planRefId", default=None)
571
- addon_ref_id: Optional[str] = Field(alias="addonRefId", default=None)
572
- feature_id: Optional[str] = Field(alias="featureId", default=None)
573
-
574
-
575
- class SubscriptionScheduledUpdateDataScheduleVariablesPlanPriceOverrideChangeVariables(
576
- BaseModel
577
- ):
578
- typename__: Literal["PlanPriceOverrideChangeVariables"] = Field(alias="__typename")
579
- plan_ref_id: str = Field(alias="planRefId")
580
- feature_id: Optional[str] = Field(alias="featureId", default=None)
581
-
582
-
583
- class SubscriptionScheduledUpdateDataScheduleVariablesUnitAmountChangeVariables(
584
- BaseModel
585
- ):
586
- typename__: Literal["UnitAmountChangeVariables"] = Field(alias="__typename")
587
- new_unit_amount: Optional[float] = Field(alias="newUnitAmount", default=None)
588
- feature_id: Optional[str] = Field(alias="featureId", default=None)
589
-
590
-
591
- class TotalPriceFragment(BaseModel):
592
- sub_total: "TotalPriceFragmentSubTotal" = Field(alias="subTotal")
593
- total: "TotalPriceFragmentTotal"
594
-
595
-
596
- class TotalPriceFragmentSubTotal(BaseModel):
597
- amount: float
598
- currency: Currency
599
-
600
-
601
- class TotalPriceFragmentTotal(BaseModel):
602
- amount: float
603
- currency: Currency
604
-
605
-
606
- class ProductFragment(BaseModel):
607
- ref_id: str = Field(alias="refId")
608
- display_name: Optional[str] = Field(alias="displayName", default=None)
609
- description: Optional[str] = Field(default=None)
610
- additional_meta_data: Optional[Any] = Field(
611
- alias="additionalMetaData", default=None
612
- )
613
- product_settings: "ProductFragmentProductSettings" = Field(alias="productSettings")
614
-
615
-
616
- class ProductFragmentProductSettings(BaseModel):
617
- downgrade_plan: Optional["ProductFragmentProductSettingsDowngradePlan"] = Field(
618
- alias="downgradePlan", default=None
619
- )
620
-
621
-
622
- class ProductFragmentProductSettingsDowngradePlan(BaseModel):
623
- ref_id: str = Field(alias="refId")
624
- display_name: str = Field(alias="displayName")
625
-
626
-
627
- class PlanCompatiblePackageGroupsFragment(BaseModel):
628
- package_group_id: str = Field(alias="packageGroupId")
629
- display_name: str = Field(alias="displayName")
630
- addons: Optional[List["PlanCompatiblePackageGroupsFragmentAddons"]] = Field(
631
- default=None
632
- )
633
- options: "PlanCompatiblePackageGroupsFragmentOptions"
634
-
635
-
636
- class PlanCompatiblePackageGroupsFragmentAddons(AddonFragment):
637
- pass
638
-
639
-
640
- class PlanCompatiblePackageGroupsFragmentOptions(BaseModel):
641
- min_items: Optional[float] = Field(alias="minItems", default=None)
642
- free_items: Optional[float] = Field(alias="freeItems", default=None)
643
-
644
-
645
- class PlanFragment(BaseModel):
646
- id: Any
647
- ref_id: str = Field(alias="refId")
648
- display_name: str = Field(alias="displayName")
649
- description: Optional[str] = Field(default=None)
650
- billing_id: Optional[str] = Field(alias="billingId", default=None)
651
- version_number: int = Field(alias="versionNumber")
652
- additional_meta_data: Optional[Any] = Field(
653
- alias="additionalMetaData", default=None
654
- )
655
- hidden_from_widgets: Optional[List[WidgetType]] = Field(
656
- alias="hiddenFromWidgets", default=None
657
- )
658
- product: "PlanFragmentProduct"
659
- base_plan: Optional["PlanFragmentBasePlan"] = Field(alias="basePlan", default=None)
660
- entitlements: Optional[List["PlanFragmentEntitlements"]] = Field(default=None)
661
- inherited_entitlements: Optional[List["PlanFragmentInheritedEntitlements"]] = Field(
662
- alias="inheritedEntitlements", default=None
663
- )
664
- compatible_addons: Optional[List["PlanFragmentCompatibleAddons"]] = Field(
665
- alias="compatibleAddons", default=None
666
- )
667
- compatible_package_groups: Optional[
668
- List["PlanFragmentCompatiblePackageGroups"]
669
- ] = Field(alias="compatiblePackageGroups", default=None)
670
- prices: Optional[List["PlanFragmentPrices"]] = Field(default=None)
671
- overage_prices: Optional[List["PlanFragmentOveragePrices"]] = Field(
672
- alias="overagePrices", default=None
673
- )
674
- pricing_type: Optional[PricingType] = Field(alias="pricingType", default=None)
675
- default_trial_config: Optional["PlanFragmentDefaultTrialConfig"] = Field(
676
- alias="defaultTrialConfig", default=None
677
- )
678
-
679
-
680
- class PlanFragmentProduct(ProductFragment):
681
- pass
682
-
683
-
684
- class PlanFragmentBasePlan(BaseModel):
685
- ref_id: str = Field(alias="refId")
686
- display_name: str = Field(alias="displayName")
687
-
688
-
689
- class PlanFragmentEntitlements(PackageEntitlementFragment):
690
- pass
691
-
736
+ class SubscriptionScheduledUpdateDataScheduleVariablesDowngradeChangeVariablesAddons(
737
+ BaseModel
738
+ ):
739
+ addon_ref_id: str = Field(alias="addonRefId")
740
+ quantity: float
692
741
 
693
- class PlanFragmentInheritedEntitlements(PackageEntitlementFragment):
694
- pass
695
742
 
743
+ class SubscriptionScheduledUpdateDataScheduleVariablesDowngradeChangeVariablesPriceOverrides(
744
+ BaseModel
745
+ ):
746
+ plan_ref_id: Optional[str] = Field(alias="planRefId", default=None)
747
+ addon_ref_id: Optional[str] = Field(alias="addonRefId", default=None)
748
+ feature_id: Optional[str] = Field(alias="featureId", default=None)
696
749
 
697
- class PlanFragmentCompatibleAddons(AddonFragment):
698
- pass
699
750
 
751
+ class SubscriptionScheduledUpdateDataScheduleVariablesPlanChangeVariables(BaseModel):
752
+ typename__: Literal["PlanChangeVariables"] = Field(alias="__typename")
753
+ plan_ref_id: str = Field(alias="planRefId")
754
+ change_type: PlanChangeType = Field(alias="changeType")
755
+ billing_period: Optional[BillingPeriod] = Field(alias="billingPeriod", default=None)
756
+ billable_features: Optional[
757
+ List[
758
+ "SubscriptionScheduledUpdateDataScheduleVariablesPlanChangeVariablesBillableFeatures"
759
+ ]
760
+ ] = Field(alias="billableFeatures", default=None)
761
+ addons: Optional[
762
+ List[
763
+ "SubscriptionScheduledUpdateDataScheduleVariablesPlanChangeVariablesAddons"
764
+ ]
765
+ ] = Field(default=None)
766
+ price_overrides: Optional[
767
+ List[
768
+ "SubscriptionScheduledUpdateDataScheduleVariablesPlanChangeVariablesPriceOverrides"
769
+ ]
770
+ ] = Field(alias="priceOverrides", default=None)
700
771
 
701
- class PlanFragmentCompatiblePackageGroups(PlanCompatiblePackageGroupsFragment):
702
- pass
703
772
 
773
+ class SubscriptionScheduledUpdateDataScheduleVariablesPlanChangeVariablesBillableFeatures(
774
+ BaseModel
775
+ ):
776
+ feature_id: str = Field(alias="featureId")
777
+ quantity: float
704
778
 
705
- class PlanFragmentPrices(PriceFragment):
706
- pass
707
779
 
780
+ class SubscriptionScheduledUpdateDataScheduleVariablesPlanChangeVariablesAddons(
781
+ BaseModel
782
+ ):
783
+ addon_ref_id: str = Field(alias="addonRefId")
784
+ quantity: float
708
785
 
709
- class PlanFragmentOveragePrices(OveragePriceFragment):
710
- pass
711
786
 
787
+ class SubscriptionScheduledUpdateDataScheduleVariablesPlanChangeVariablesPriceOverrides(
788
+ BaseModel
789
+ ):
790
+ plan_ref_id: Optional[str] = Field(alias="planRefId", default=None)
791
+ addon_ref_id: Optional[str] = Field(alias="addonRefId", default=None)
792
+ feature_id: Optional[str] = Field(alias="featureId", default=None)
712
793
 
713
- class PlanFragmentDefaultTrialConfig(BaseModel):
714
- duration: float
715
- units: TrialPeriodUnits
716
- budget: Optional["PlanFragmentDefaultTrialConfigBudget"] = Field(default=None)
717
- trial_end_behavior: Optional[TrialEndBehavior] = Field(
718
- alias="trialEndBehavior", default=None
719
- )
720
794
 
795
+ class SubscriptionScheduledUpdateDataScheduleVariablesPlanPriceOverrideChangeVariables(
796
+ BaseModel
797
+ ):
798
+ typename__: Literal["PlanPriceOverrideChangeVariables"] = Field(alias="__typename")
799
+ plan_ref_id: str = Field(alias="planRefId")
800
+ feature_id: Optional[str] = Field(alias="featureId", default=None)
721
801
 
722
- class PlanFragmentDefaultTrialConfigBudget(BaseModel):
723
- limit: float
802
+
803
+ class SubscriptionScheduledUpdateDataScheduleVariablesUnitAmountChangeVariables(
804
+ BaseModel
805
+ ):
806
+ typename__: Literal["UnitAmountChangeVariables"] = Field(alias="__typename")
807
+ new_unit_amount: Optional[float] = Field(alias="newUnitAmount", default=None)
808
+ feature_id: Optional[str] = Field(alias="featureId", default=None)
724
809
 
725
810
 
726
811
  class SubscriptionFragment(BaseModel):
@@ -832,91 +917,6 @@ class SubscriptionFragmentTrialConfiguration(SubscriptionTrialConfigurationFragm
832
917
  pass
833
918
 
834
919
 
835
- class FeatureFragment(BaseModel):
836
- typename__: str = Field(alias="__typename")
837
- feature_type: FeatureType = Field(alias="featureType")
838
- meter_type: Optional[MeterType] = Field(alias="meterType", default=None)
839
- feature_units: Optional[str] = Field(alias="featureUnits", default=None)
840
- feature_units_plural: Optional[str] = Field(
841
- alias="featureUnitsPlural", default=None
842
- )
843
- description: Optional[str] = Field(default=None)
844
- display_name: str = Field(alias="displayName")
845
- ref_id: str = Field(alias="refId")
846
- unit_transformation: Optional["FeatureFragmentUnitTransformation"] = Field(
847
- alias="unitTransformation", default=None
848
- )
849
-
850
-
851
- class FeatureFragmentUnitTransformation(BaseModel):
852
- divide: float
853
- round: UnitTransformationRound
854
-
855
-
856
- class EntitlementFragment(BaseModel):
857
- typename__: str = Field(alias="__typename")
858
- is_granted: bool = Field(alias="isGranted")
859
- access_denied_reason: Optional[AccessDeniedReason] = Field(
860
- alias="accessDeniedReason", default=None
861
- )
862
- customer_id: Optional[str] = Field(alias="customerId", default=None)
863
- resource_id: Optional[str] = Field(alias="resourceId", default=None)
864
- usage_limit: Optional[float] = Field(alias="usageLimit", default=None)
865
- has_unlimited_usage: bool = Field(alias="hasUnlimitedUsage")
866
- has_soft_limit: Optional[bool] = Field(alias="hasSoftLimit", default=None)
867
- current_usage: Optional[float] = Field(alias="currentUsage", default=None)
868
- requested_usage: Optional[float] = Field(alias="requestedUsage", default=None)
869
- requested_values: Optional[List[str]] = Field(alias="requestedValues", default=None)
870
- enum_values: Optional[List[str]] = Field(alias="enumValues", default=None)
871
- entitlement_updated_at: Optional[Any] = Field(
872
- alias="entitlementUpdatedAt", default=None
873
- )
874
- usage_updated_at: Optional[Any] = Field(alias="usageUpdatedAt", default=None)
875
- usage_period_anchor: Optional[Any] = Field(alias="usagePeriodAnchor", default=None)
876
- usage_period_start: Optional[Any] = Field(alias="usagePeriodStart", default=None)
877
- usage_period_end: Optional[Any] = Field(alias="usagePeriodEnd", default=None)
878
- next_reset_date: Optional[Any] = Field(alias="nextResetDate", default=None)
879
- reset_period: Optional[EntitlementResetPeriod] = Field(
880
- alias="resetPeriod", default=None
881
- )
882
- reset_period_configuration: Optional[
883
- Annotated[
884
- Union[
885
- "EntitlementFragmentResetPeriodConfigurationMonthlyResetPeriodConfig",
886
- "EntitlementFragmentResetPeriodConfigurationWeeklyResetPeriodConfig",
887
- "EntitlementFragmentResetPeriodConfigurationYearlyResetPeriodConfig",
888
- ],
889
- Field(discriminator="typename__"),
890
- ]
891
- ] = Field(alias="resetPeriodConfiguration", default=None)
892
- feature: Optional["EntitlementFragmentFeature"] = Field(default=None)
893
-
894
-
895
- class EntitlementFragmentResetPeriodConfigurationMonthlyResetPeriodConfig(BaseModel):
896
- typename__: Literal["MonthlyResetPeriodConfig"] = Field(alias="__typename")
897
- monthly_according_to: Optional[MonthlyAccordingTo] = Field(
898
- alias="monthlyAccordingTo", default=None
899
- )
900
-
901
-
902
- class EntitlementFragmentResetPeriodConfigurationWeeklyResetPeriodConfig(BaseModel):
903
- typename__: Literal["WeeklyResetPeriodConfig"] = Field(alias="__typename")
904
- weekly_according_to: Optional[WeeklyAccordingTo] = Field(
905
- alias="weeklyAccordingTo", default=None
906
- )
907
-
908
-
909
- class EntitlementFragmentResetPeriodConfigurationYearlyResetPeriodConfig(BaseModel):
910
- typename__: Literal["YearlyResetPeriodConfig"] = Field(alias="__typename")
911
- yearly_according_to: Optional[YearlyAccordingTo] = Field(
912
- alias="yearlyAccordingTo", default=None
913
- )
914
-
915
-
916
- class EntitlementFragmentFeature(FeatureFragment):
917
- pass
918
-
919
-
920
920
  class ApplySubscriptionFragment(BaseModel):
921
921
  subscription: Optional["ApplySubscriptionFragmentSubscription"] = Field(
922
922
  default=None
@@ -994,6 +994,35 @@ class CheckoutConfigurationFragmentContent(BaseModel):
994
994
  )
995
995
 
996
996
 
997
+ class PromotionalEntitlementFragment(BaseModel):
998
+ status: PromotionalEntitlementStatus
999
+ usage_limit: Optional[float] = Field(alias="usageLimit", default=None)
1000
+ feature_id: Any = Field(alias="featureId")
1001
+ has_unlimited_usage: Optional[bool] = Field(alias="hasUnlimitedUsage", default=None)
1002
+ has_soft_limit: Optional[bool] = Field(alias="hasSoftLimit", default=None)
1003
+ reset_period: Optional[EntitlementResetPeriod] = Field(
1004
+ alias="resetPeriod", default=None
1005
+ )
1006
+ end_date: Optional[Any] = Field(alias="endDate", default=None)
1007
+ is_visible: bool = Field(alias="isVisible")
1008
+ feature: "PromotionalEntitlementFragmentFeature"
1009
+
1010
+
1011
+ class PromotionalEntitlementFragmentFeature(BaseModel):
1012
+ feature_type: FeatureType = Field(alias="featureType")
1013
+ meter_type: Optional[MeterType] = Field(alias="meterType", default=None)
1014
+ feature_units: Optional[str] = Field(alias="featureUnits", default=None)
1015
+ feature_units_plural: Optional[str] = Field(
1016
+ alias="featureUnitsPlural", default=None
1017
+ )
1018
+ display_name: str = Field(alias="displayName")
1019
+ description: Optional[str] = Field(default=None)
1020
+ ref_id: str = Field(alias="refId")
1021
+ additional_meta_data: Optional[Any] = Field(
1022
+ alias="additionalMetaData", default=None
1023
+ )
1024
+
1025
+
997
1026
  class CouponFragment(BaseModel):
998
1027
  id: Any
999
1028
  discount_value: float = Field(alias="discountValue")
@@ -1028,35 +1057,6 @@ class CouponFragmentSyncStates(BaseModel):
1028
1057
  status: SyncStatus
1029
1058
 
1030
1059
 
1031
- class PromotionalEntitlementFragment(BaseModel):
1032
- status: PromotionalEntitlementStatus
1033
- usage_limit: Optional[float] = Field(alias="usageLimit", default=None)
1034
- feature_id: Any = Field(alias="featureId")
1035
- has_unlimited_usage: Optional[bool] = Field(alias="hasUnlimitedUsage", default=None)
1036
- has_soft_limit: Optional[bool] = Field(alias="hasSoftLimit", default=None)
1037
- reset_period: Optional[EntitlementResetPeriod] = Field(
1038
- alias="resetPeriod", default=None
1039
- )
1040
- end_date: Optional[Any] = Field(alias="endDate", default=None)
1041
- is_visible: bool = Field(alias="isVisible")
1042
- feature: "PromotionalEntitlementFragmentFeature"
1043
-
1044
-
1045
- class PromotionalEntitlementFragmentFeature(BaseModel):
1046
- feature_type: FeatureType = Field(alias="featureType")
1047
- meter_type: Optional[MeterType] = Field(alias="meterType", default=None)
1048
- feature_units: Optional[str] = Field(alias="featureUnits", default=None)
1049
- feature_units_plural: Optional[str] = Field(
1050
- alias="featureUnitsPlural", default=None
1051
- )
1052
- display_name: str = Field(alias="displayName")
1053
- description: Optional[str] = Field(default=None)
1054
- ref_id: str = Field(alias="refId")
1055
- additional_meta_data: Optional[Any] = Field(
1056
- alias="additionalMetaData", default=None
1057
- )
1058
-
1059
-
1060
1060
  class CustomerFragment(SlimCustomerFragment):
1061
1061
  has_payment_method: bool = Field(alias="hasPaymentMethod")
1062
1062
  has_active_subscription: bool = Field(alias="hasActiveSubscription")
@@ -1273,13 +1273,6 @@ class CustomerPortalPromotionalEntitlementFragment(BaseModel):
1273
1273
  end_date: Optional[Any] = Field(alias="endDate", default=None)
1274
1274
 
1275
1275
 
1276
- class CustomerPortalSubscriptionAddonFragment(BaseModel):
1277
- addon_id: str = Field(alias="addonId")
1278
- description: Optional[str] = Field(default=None)
1279
- display_name: str = Field(alias="displayName")
1280
- quantity: int
1281
-
1282
-
1283
1276
  class CustomerPortalSubscriptionPriceFragment(BaseModel):
1284
1277
  billing_period: Optional[BillingPeriod] = Field(alias="billingPeriod", default=None)
1285
1278
  billing_model: Optional[BillingModel] = Field(alias="billingModel", default=None)
@@ -1307,6 +1300,13 @@ class CustomerPortalSubscriptionPriceFragmentFeature(BaseModel):
1307
1300
  )
1308
1301
 
1309
1302
 
1303
+ class CustomerPortalSubscriptionAddonFragment(BaseModel):
1304
+ addon_id: str = Field(alias="addonId")
1305
+ description: Optional[str] = Field(default=None)
1306
+ display_name: str = Field(alias="displayName")
1307
+ quantity: int
1308
+
1309
+
1310
1310
  class CustomerPortalSubscriptionScheduledUpdateDataFragment(BaseModel):
1311
1311
  subscription_schedule_type: SubscriptionScheduleType = Field(
1312
1312
  alias="subscriptionScheduleType"
@@ -2842,36 +2842,36 @@ class UsageHistoryV2FragmentSeriesPoints(BaseModel):
2842
2842
  AddonDependencyFragment.model_rebuild()
2843
2843
  PriceTierFragment.model_rebuild()
2844
2844
  PriceFragment.model_rebuild()
2845
- PackageEntitlementFragment.model_rebuild()
2846
2845
  OveragePriceFragment.model_rebuild()
2846
+ PackageEntitlementFragment.model_rebuild()
2847
2847
  AddonFragment.model_rebuild()
2848
- SubscriptionInvoiceFragment.model_rebuild()
2848
+ FeatureFragment.model_rebuild()
2849
+ EntitlementFragment.model_rebuild()
2849
2850
  SlimCustomerFragment.model_rebuild()
2850
- CustomerResourceFragment.model_rebuild()
2851
2851
  SubscriptionTrialConfigurationFragment.model_rebuild()
2852
- SubscriptionFutureUpdateData.model_rebuild()
2853
- SubscriptionScheduledUpdateData.model_rebuild()
2854
2852
  TotalPriceFragment.model_rebuild()
2855
- ProductFragment.model_rebuild()
2856
2853
  PlanCompatiblePackageGroupsFragment.model_rebuild()
2854
+ ProductFragment.model_rebuild()
2857
2855
  PlanFragment.model_rebuild()
2856
+ SubscriptionFutureUpdateData.model_rebuild()
2857
+ SubscriptionInvoiceFragment.model_rebuild()
2858
+ CustomerResourceFragment.model_rebuild()
2859
+ SubscriptionScheduledUpdateData.model_rebuild()
2858
2860
  SubscriptionFragment.model_rebuild()
2859
- FeatureFragment.model_rebuild()
2860
- EntitlementFragment.model_rebuild()
2861
2861
  ApplySubscriptionFragment.model_rebuild()
2862
2862
  FontVariantFragment.model_rebuild()
2863
2863
  TypographyConfigurationFragment.model_rebuild()
2864
2864
  CheckoutConfigurationFragment.model_rebuild()
2865
- CouponFragment.model_rebuild()
2866
2865
  PromotionalEntitlementFragment.model_rebuild()
2866
+ CouponFragment.model_rebuild()
2867
2867
  CustomerFragment.model_rebuild()
2868
2868
  CheckoutStateFragment.model_rebuild()
2869
2869
  CustomerPortalBillingInformationFragment.model_rebuild()
2870
2870
  CustomerPortalConfigurationFragment.model_rebuild()
2871
2871
  CustomerPortalEntitlementFragment.model_rebuild()
2872
2872
  CustomerPortalPromotionalEntitlementFragment.model_rebuild()
2873
- CustomerPortalSubscriptionAddonFragment.model_rebuild()
2874
2873
  CustomerPortalSubscriptionPriceFragment.model_rebuild()
2874
+ CustomerPortalSubscriptionAddonFragment.model_rebuild()
2875
2875
  CustomerPortalSubscriptionScheduledUpdateDataFragment.model_rebuild()
2876
2876
  CustomerPortalSubscriptionFragment.model_rebuild()
2877
2877
  CustomerPortalFragment.model_rebuild()
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: stigg-api-client-v2
3
- Version: 2.488.0
3
+ Version: 2.491.0
4
4
  Summary:
5
5
  License: STIGG SDK LICENSE
6
6
  Author: Stigg
@@ -119,11 +119,11 @@ stigg/generated/client.py,sha256=tGqbCewOFV2YP6igue7hQZghW3XraHyV0OXcoKfsssE,173
119
119
  stigg/generated/create_subscription.py,sha256=vbpBJ_daXHcQDtvU3vbwSr2E7s4VGRHxqPavyTV3Mtk,457
120
120
  stigg/generated/delegate_subscription_to_customer.py,sha256=0TgQDO0Hk-z7X7PGtqhvciqa8IjkToK9cpiX3Kqu_UY,561
121
121
  stigg/generated/detach_customer_payment_method.py,sha256=ACXlC2xsGaUP723OrayFZQ9SbXxe8TtVUYdG1gqcYFc,523
122
- stigg/generated/enums.py,sha256=UPo_2u9GdUtupXMrqY5cBtlP-lgUyKOU5GF1_jPr7g4,36682
122
+ stigg/generated/enums.py,sha256=LNYmJArnO1NejmLy-MhcZzdxPIRXDuKv2cYXTMxoDDk,36766
123
123
  stigg/generated/estimate_subscription.py,sha256=c0_vg0A_Hi8fdjeGudWZ0WziUF9jcjX5rlRitGMAMaQ,479
124
124
  stigg/generated/estimate_subscription_update.py,sha256=ZYIFqqHHDfzhrOn95QnMmPNTXZ7JrKWRlUFzk8fWwKA,528
125
125
  stigg/generated/exceptions.py,sha256=OQu-ZYCCV4VyMWTd1HR8gIjIK2CrA_JMlFxqOAJugWY,2411
126
- stigg/generated/fragments.py,sha256=rTvpDwJW0judE4Su8QWbze2Jo6sX_JlbRcwK48hl7SY,103850
126
+ stigg/generated/fragments.py,sha256=wffyWMiq-qYPwODG-RVpVV1AvSkzAFzmsMQCperBIR4,103850
127
127
  stigg/generated/get_active_subscriptions.py,sha256=ngZ9jr8vzGI59wT8FhUFl46a8j9waoNjeZ1_lrcu2ww,513
128
128
  stigg/generated/get_active_subscriptions_list.py,sha256=Awi9al2MXxdt_y7ZnWYZh8U3R9XiX50c7TyO4WZxyhw,541
129
129
  stigg/generated/get_checkout_state.py,sha256=SAOXGAND879dwb7R5mr5LPZuPVuMUDwNR5M4mgmHv6w,409
@@ -161,7 +161,7 @@ stigg/generated/transfer_subscription_to_resource.py,sha256=4-N7quYhHpVTGPi6EV-U
161
161
  stigg/generated/unarchive_customer.py,sha256=0OVttDrNNOHp6xIpLfDj--XfZL0ogkSpy9eW71jND2k,441
162
162
  stigg/generated/update_customer.py,sha256=DdbIKqG3AxIJie6Wk49m4dSVyXrQbY6UjhReZR6lkIM,403
163
163
  stigg/generated/update_subscription.py,sha256=R7RdFcFh1oEz-AHLiMBW5XvpQTi3ucB3Z4r-LvZjHJQ,457
164
- stigg_api_client_v2-2.488.0.dist-info/LICENSE,sha256=yhOTQTha61N-7pgHWeRZ0TGF5uq0ifi5U8qU8nHvzME,5127
165
- stigg_api_client_v2-2.488.0.dist-info/METADATA,sha256=gp9vJ-aL5o4S0SzexTcbS1IYsRgy5ImniWjfyLXWOqE,2258
166
- stigg_api_client_v2-2.488.0.dist-info/WHEEL,sha256=kLuE8m1WYU0Ig0_YEGrXyTtiJvKPpLpDEiChiNyei5Y,88
167
- stigg_api_client_v2-2.488.0.dist-info/RECORD,,
164
+ stigg_api_client_v2-2.491.0.dist-info/LICENSE,sha256=yhOTQTha61N-7pgHWeRZ0TGF5uq0ifi5U8qU8nHvzME,5127
165
+ stigg_api_client_v2-2.491.0.dist-info/METADATA,sha256=IcOIzIGgT85GZbQ9Ywq2_vd69ew_KIds6X7iU2JADqA,2258
166
+ stigg_api_client_v2-2.491.0.dist-info/WHEEL,sha256=kLuE8m1WYU0Ig0_YEGrXyTtiJvKPpLpDEiChiNyei5Y,88
167
+ stigg_api_client_v2-2.491.0.dist-info/RECORD,,