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

@@ -44,6 +44,7 @@ from .enums import (
44
44
  CouponSource,
45
45
  CouponStatus,
46
46
  CouponType,
47
+ CreditGrantType,
47
48
  Currency,
48
49
  CustomerResourceSortFields,
49
50
  CustomerSortFields,
@@ -630,7 +631,9 @@ from .input_types import (
630
631
  CreateOrUpdateAwsMarketplaceProductInput,
631
632
  CreatePackageGroup,
632
633
  CreateWorkflowTriggerInput,
634
+ CreditGrantInput,
633
635
  CursorPaging,
636
+ CustomCurrencyInput,
634
637
  CustomerBillingInfo,
635
638
  CustomerFilter,
636
639
  CustomerFilterCustomerSubscriptionFilter,
@@ -712,6 +715,7 @@ from .input_types import (
712
715
  FontVariantInput,
713
716
  GetActiveSubscriptionsInput,
714
717
  GetAuth0ApplicationsInput,
718
+ GetCreditGrantsInput,
715
719
  GetCustomerByRefIdInput,
716
720
  GetPackageByRefIdInput,
717
721
  GetPackageGroup,
@@ -896,6 +900,8 @@ from .input_types import (
896
900
  UnlinkFeatureGroupFromPackageInput,
897
901
  UpdateAccountInput,
898
902
  UpdateCouponInput,
903
+ UpdateCreditGrantInput,
904
+ UpdateCustomCurrencyInput,
899
905
  UpdateCustomerInput,
900
906
  UpdateExperimentInput,
901
907
  UpdateFeatureInput,
@@ -1092,8 +1098,11 @@ __all__ = [
1092
1098
  "CreateSubscription",
1093
1099
  "CreateSubscriptionCreateSubscription",
1094
1100
  "CreateWorkflowTriggerInput",
1101
+ "CreditGrantInput",
1102
+ "CreditGrantType",
1095
1103
  "Currency",
1096
1104
  "CursorPaging",
1105
+ "CustomCurrencyInput",
1097
1106
  "CustomerBillingInfo",
1098
1107
  "CustomerFilter",
1099
1108
  "CustomerFilterCustomerSubscriptionFilter",
@@ -1293,6 +1302,7 @@ __all__ = [
1293
1302
  "GetCouponsCoupons",
1294
1303
  "GetCouponsCouponsEdges",
1295
1304
  "GetCouponsCouponsEdgesNode",
1305
+ "GetCreditGrantsInput",
1296
1306
  "GetCustomerById",
1297
1307
  "GetCustomerByIdGetCustomerByRefId",
1298
1308
  "GetCustomerByRefIdInput",
@@ -1845,6 +1855,8 @@ __all__ = [
1845
1855
  "UnlinkFeatureGroupFromPackageInput",
1846
1856
  "UpdateAccountInput",
1847
1857
  "UpdateCouponInput",
1858
+ "UpdateCreditGrantInput",
1859
+ "UpdateCustomCurrencyInput",
1848
1860
  "UpdateCustomer",
1849
1861
  "UpdateCustomerInput",
1850
1862
  "UpdateCustomerUpdateCustomer",
stigg/generated/enums.py CHANGED
@@ -157,6 +157,11 @@ class CouponType(str, Enum):
157
157
  PERCENTAGE = "PERCENTAGE"
158
158
 
159
159
 
160
+ class CreditGrantType(str, Enum):
161
+ PAID = "PAID"
162
+ PROMOTIONAL = "PROMOTIONAL"
163
+
164
+
160
165
  class Currency(str, Enum):
161
166
  AED = "AED"
162
167
  ALL = "ALL"
@@ -434,6 +439,9 @@ class ErrorCode(str, Enum):
434
439
  CannotReportUsageForEntitlementWithMeterError = (
435
440
  "CannotReportUsageForEntitlementWithMeterError"
436
441
  )
442
+ CannotUpdateExpireAtForExpiredCreditGrantError = (
443
+ "CannotUpdateExpireAtForExpiredCreditGrantError"
444
+ )
437
445
  CannotUpdateUnitTransformationError = "CannotUpdateUnitTransformationError"
438
446
  CannotUpsertToPackageThatHasDraft = "CannotUpsertToPackageThatHasDraft"
439
447
  ChangingPayingCustomerIsNotSupportedError = (
@@ -441,6 +449,8 @@ class ErrorCode(str, Enum):
441
449
  )
442
450
  CheckoutIsNotSupported = "CheckoutIsNotSupported"
443
451
  CouponNotFound = "CouponNotFound"
452
+ CreditGrantNotFound = "CreditGrantNotFound"
453
+ CustomCurrencyNotFound = "CustomCurrencyNotFound"
444
454
  CustomerAlreadyHaveCustomerCoupon = "CustomerAlreadyHaveCustomerCoupon"
445
455
  CustomerAlreadyUsesCoupon = "CustomerAlreadyUsesCoupon"
446
456
  CustomerHasNoEmailAddress = "CustomerHasNoEmailAddress"
@@ -466,6 +476,7 @@ class ErrorCode(str, Enum):
466
476
  ExperimentAlreadyRunning = "ExperimentAlreadyRunning"
467
477
  ExperimentNotFoundError = "ExperimentNotFoundError"
468
478
  ExperimentStatusError = "ExperimentStatusError"
479
+ ExpireAtMustBeLaterThanEffectiveAtError = "ExpireAtMustBeLaterThanEffectiveAtError"
469
480
  FailedToCreateCheckoutSessionError = "FailedToCreateCheckoutSessionError"
470
481
  FailedToImportCustomer = "FailedToImportCustomer"
471
482
  FailedToImportSubscriptions = "FailedToImportSubscriptions"
@@ -561,6 +572,7 @@ class ErrorCode(str, Enum):
561
572
  SubscriptionMustHaveSinglePlanError = "SubscriptionMustHaveSinglePlanError"
562
573
  SubscriptionNoBillingId = "SubscriptionNoBillingId"
563
574
  SubscriptionNotFound = "SubscriptionNotFound"
575
+ TooManyCustomCurrencies = "TooManyCustomCurrencies"
564
576
  TooManySubscriptionsPerCustomer = "TooManySubscriptionsPerCustomer"
565
577
  TrialMustBeCancelledImmediately = "TrialMustBeCancelledImmediately"
566
578
  UnPublishedPackage = "UnPublishedPackage"
@@ -625,6 +637,8 @@ class EventLogType(str, Enum):
625
637
  COUPON_CREATED = "COUPON_CREATED"
626
638
  COUPON_UPDATED = "COUPON_UPDATED"
627
639
  CREATE_SUBSCRIPTION_FAILED = "CREATE_SUBSCRIPTION_FAILED"
640
+ CREDITS_EXPIRED = "CREDITS_EXPIRED"
641
+ CREDITS_GRANTED = "CREDITS_GRANTED"
628
642
  CUSTOMER_CREATED = "CUSTOMER_CREATED"
629
643
  CUSTOMER_DELETED = "CUSTOMER_DELETED"
630
644
  CUSTOMER_ENTITLEMENT_CALCULATION_TRIGGERED = (
@@ -60,6 +60,40 @@ class AddonDependencyFragment(BaseModel):
60
60
  description: Optional[str] = Field(default=None)
61
61
 
62
62
 
63
+ class PackageEntitlementFragment(BaseModel):
64
+ usage_limit: Optional[float] = Field(alias="usageLimit", default=None)
65
+ has_unlimited_usage: Optional[bool] = Field(alias="hasUnlimitedUsage", default=None)
66
+ has_soft_limit: Optional[bool] = Field(alias="hasSoftLimit", default=None)
67
+ feature_id: str = Field(alias="featureId")
68
+ reset_period: Optional[EntitlementResetPeriod] = Field(
69
+ alias="resetPeriod", default=None
70
+ )
71
+ hidden_from_widgets: Optional[List[WidgetType]] = Field(
72
+ alias="hiddenFromWidgets", default=None
73
+ )
74
+ is_custom: Optional[bool] = Field(alias="isCustom", default=None)
75
+ display_name_override: Optional[str] = Field(
76
+ alias="displayNameOverride", default=None
77
+ )
78
+ enum_values: Optional[List[str]] = Field(alias="enumValues", default=None)
79
+ feature: "PackageEntitlementFragmentFeature"
80
+
81
+
82
+ class PackageEntitlementFragmentFeature(BaseModel):
83
+ feature_type: FeatureType = Field(alias="featureType")
84
+ meter_type: Optional[MeterType] = Field(alias="meterType", default=None)
85
+ feature_units: Optional[str] = Field(alias="featureUnits", default=None)
86
+ feature_units_plural: Optional[str] = Field(
87
+ alias="featureUnitsPlural", default=None
88
+ )
89
+ display_name: str = Field(alias="displayName")
90
+ description: Optional[str] = Field(default=None)
91
+ ref_id: str = Field(alias="refId")
92
+ additional_meta_data: Optional[Any] = Field(
93
+ alias="additionalMetaData", default=None
94
+ )
95
+
96
+
63
97
  class PriceTierFragment(BaseModel):
64
98
  up_to: Optional[float] = Field(alias="upTo", default=None)
65
99
  unit_price: Optional["PriceTierFragmentUnitPrice"] = Field(
@@ -148,40 +182,6 @@ class OveragePriceFragmentFeature(BaseModel):
148
182
  description: Optional[str] = Field(default=None)
149
183
 
150
184
 
151
- class PackageEntitlementFragment(BaseModel):
152
- usage_limit: Optional[float] = Field(alias="usageLimit", default=None)
153
- has_unlimited_usage: Optional[bool] = Field(alias="hasUnlimitedUsage", default=None)
154
- has_soft_limit: Optional[bool] = Field(alias="hasSoftLimit", default=None)
155
- feature_id: str = Field(alias="featureId")
156
- reset_period: Optional[EntitlementResetPeriod] = Field(
157
- alias="resetPeriod", default=None
158
- )
159
- hidden_from_widgets: Optional[List[WidgetType]] = Field(
160
- alias="hiddenFromWidgets", default=None
161
- )
162
- is_custom: Optional[bool] = Field(alias="isCustom", default=None)
163
- display_name_override: Optional[str] = Field(
164
- alias="displayNameOverride", default=None
165
- )
166
- enum_values: Optional[List[str]] = Field(alias="enumValues", default=None)
167
- feature: "PackageEntitlementFragmentFeature"
168
-
169
-
170
- class PackageEntitlementFragmentFeature(BaseModel):
171
- feature_type: FeatureType = Field(alias="featureType")
172
- meter_type: Optional[MeterType] = Field(alias="meterType", default=None)
173
- feature_units: Optional[str] = Field(alias="featureUnits", default=None)
174
- feature_units_plural: Optional[str] = Field(
175
- alias="featureUnitsPlural", default=None
176
- )
177
- display_name: str = Field(alias="displayName")
178
- description: Optional[str] = Field(default=None)
179
- ref_id: str = Field(alias="refId")
180
- additional_meta_data: Optional[Any] = Field(
181
- alias="additionalMetaData", default=None
182
- )
183
-
184
-
185
185
  class AddonFragment(BaseModel):
186
186
  id: Any
187
187
  ref_id: str = Field(alias="refId")
@@ -220,276 +220,162 @@ class AddonFragmentDependencies(AddonDependencyFragment):
220
220
  pass
221
221
 
222
222
 
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
230
- )
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
236
- )
237
-
238
-
239
- class FeatureFragmentUnitTransformation(BaseModel):
240
- divide: float
241
- round: UnitTransformationRound
223
+ class CustomerResourceFragment(BaseModel):
224
+ resource_id: str = Field(alias="resourceId")
242
225
 
243
226
 
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
249
- )
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
227
+ class SubscriptionFutureUpdateData(BaseModel):
228
+ subscription_schedule_type: SubscriptionScheduleType = Field(
229
+ alias="subscriptionScheduleType"
261
230
  )
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
231
+ schedule_status: SubscriptionScheduleStatus = Field(alias="scheduleStatus")
232
+ scheduled_execution_time: Any = Field(alias="scheduledExecutionTime")
233
+ target_package: Optional["SubscriptionFutureUpdateDataTargetPackage"] = Field(
234
+ alias="targetPackage", default=None
269
235
  )
270
- reset_period_configuration: Optional[
236
+ schedule_variables: Optional[
271
237
  Annotated[
272
238
  Union[
273
- "EntitlementFragmentResetPeriodConfigurationMonthlyResetPeriodConfig",
274
- "EntitlementFragmentResetPeriodConfigurationWeeklyResetPeriodConfig",
275
- "EntitlementFragmentResetPeriodConfigurationYearlyResetPeriodConfig",
239
+ "SubscriptionFutureUpdateDataScheduleVariablesAddonChangeVariables",
240
+ "SubscriptionFutureUpdateDataScheduleVariablesAddonPriceOverrideChangeVariables",
241
+ "SubscriptionFutureUpdateDataScheduleVariablesBillingPeriodChangeVariables",
242
+ "SubscriptionFutureUpdateDataScheduleVariablesCouponChangeVariables",
243
+ "SubscriptionFutureUpdateDataScheduleVariablesDowngradeChangeVariables",
244
+ "SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariables",
245
+ "SubscriptionFutureUpdateDataScheduleVariablesPlanPriceOverrideChangeVariables",
246
+ "SubscriptionFutureUpdateDataScheduleVariablesUnitAmountChangeVariables",
276
247
  ],
277
248
  Field(discriminator="typename__"),
278
249
  ]
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
306
-
307
-
308
- class TotalPriceFragment(BaseModel):
309
- sub_total: "TotalPriceFragmentSubTotal" = Field(alias="subTotal")
310
- total: "TotalPriceFragmentTotal"
311
-
312
-
313
- class TotalPriceFragmentSubTotal(BaseModel):
314
- amount: float
315
- currency: Currency
316
-
317
-
318
- class TotalPriceFragmentTotal(BaseModel):
319
- amount: float
320
- currency: Currency
321
-
322
-
323
- class CustomerResourceFragment(BaseModel):
324
- resource_id: str = Field(alias="resourceId")
325
-
326
-
327
- class SubscriptionTrialConfigurationFragment(BaseModel):
328
- trial_end_behavior: TrialEndBehavior = Field(alias="trialEndBehavior")
329
-
330
-
331
- class SubscriptionInvoiceFragment(BaseModel):
332
- billing_id: str = Field(alias="billingId")
333
- status: SubscriptionInvoiceStatus
334
- created_at: Any = Field(alias="createdAt")
335
- updated_at: Any = Field(alias="updatedAt")
336
- error_message: Optional[str] = Field(alias="errorMessage", default=None)
337
- requires_action: bool = Field(alias="requiresAction")
338
- payment_secret: Optional[str] = Field(alias="paymentSecret", default=None)
339
- payment_url: Optional[str] = Field(alias="paymentUrl", default=None)
340
- pdf_url: Optional[str] = Field(alias="pdfUrl", default=None)
341
- billing_reason: Optional[SubscriptionInvoiceBillingReason] = Field(
342
- alias="billingReason", default=None
343
- )
344
- currency: Optional[str] = Field(default=None)
345
- sub_total: Optional[float] = Field(alias="subTotal", default=None)
346
- sub_total_excluding_tax: Optional[float] = Field(
347
- alias="subTotalExcludingTax", default=None
348
- )
349
- total: Optional[float] = Field(default=None)
350
- total_excluding_tax: Optional[float] = Field(
351
- alias="totalExcludingTax", default=None
352
- )
353
- tax: Optional[float] = Field(default=None)
354
- amount_due: Optional[float] = Field(alias="amountDue", default=None)
355
- attempt_count: Optional[float] = Field(alias="attemptCount", default=None)
250
+ ] = Field(alias="scheduleVariables", default=None)
356
251
 
357
252
 
358
- class SlimCustomerFragment(BaseModel):
253
+ class SubscriptionFutureUpdateDataTargetPackage(BaseModel):
359
254
  id: Any
360
- name: Optional[str] = Field(default=None)
361
- email: Optional[str] = Field(default=None)
362
- created_at: Optional[Any] = Field(alias="createdAt", default=None)
363
- updated_at: Any = Field(alias="updatedAt")
364
- ref_id: str = Field(alias="refId")
365
- customer_id: str = Field(alias="customerId")
366
- billing_id: Optional[str] = Field(alias="billingId", default=None)
367
- additional_meta_data: Optional[Any] = Field(
368
- alias="additionalMetaData", default=None
369
- )
370
- aws_marketplace_customer_id: Optional[str] = Field(
371
- alias="awsMarketplaceCustomerId", default=None
372
- )
373
-
374
-
375
- class ProductFragment(BaseModel):
376
- ref_id: str = Field(alias="refId")
377
- display_name: Optional[str] = Field(alias="displayName", default=None)
378
- description: Optional[str] = Field(default=None)
379
- additional_meta_data: Optional[Any] = Field(
380
- alias="additionalMetaData", default=None
381
- )
382
- product_settings: "ProductFragmentProductSettings" = Field(alias="productSettings")
383
-
384
-
385
- class ProductFragmentProductSettings(BaseModel):
386
- downgrade_plan: Optional["ProductFragmentProductSettingsDowngradePlan"] = Field(
387
- alias="downgradePlan", default=None
388
- )
389
-
390
-
391
- class ProductFragmentProductSettingsDowngradePlan(BaseModel):
392
255
  ref_id: str = Field(alias="refId")
393
256
  display_name: str = Field(alias="displayName")
394
257
 
395
258
 
396
- class PlanCompatiblePackageGroupsFragment(BaseModel):
397
- package_group_id: str = Field(alias="packageGroupId")
398
- display_name: str = Field(alias="displayName")
399
- addons: Optional[List["PlanCompatiblePackageGroupsFragmentAddons"]] = Field(
400
- default=None
401
- )
402
- options: "PlanCompatiblePackageGroupsFragmentOptions"
259
+ class SubscriptionFutureUpdateDataScheduleVariablesAddonChangeVariables(BaseModel):
260
+ typename__: Literal["AddonChangeVariables"] = Field(alias="__typename")
261
+ addon_ref_id: str = Field(alias="addonRefId")
262
+ new_quantity: float = Field(alias="newQuantity")
403
263
 
404
264
 
405
- class PlanCompatiblePackageGroupsFragmentAddons(AddonFragment):
406
- pass
265
+ class SubscriptionFutureUpdateDataScheduleVariablesAddonPriceOverrideChangeVariables(
266
+ BaseModel
267
+ ):
268
+ typename__: Literal["AddonPriceOverrideChangeVariables"] = Field(alias="__typename")
269
+ addon_ref_id: str = Field(alias="addonRefId")
270
+ feature_id: Optional[str] = Field(alias="featureId", default=None)
407
271
 
408
272
 
409
- class PlanCompatiblePackageGroupsFragmentOptions(BaseModel):
410
- min_items: Optional[float] = Field(alias="minItems", default=None)
411
- free_items: Optional[float] = Field(alias="freeItems", default=None)
273
+ class SubscriptionFutureUpdateDataScheduleVariablesBillingPeriodChangeVariables(
274
+ BaseModel
275
+ ):
276
+ typename__: Literal["BillingPeriodChangeVariables"] = Field(alias="__typename")
277
+ billing_period: Optional[BillingPeriod] = Field(alias="billingPeriod", default=None)
412
278
 
413
279
 
414
- class PlanFragment(BaseModel):
415
- id: Any
416
- ref_id: str = Field(alias="refId")
417
- display_name: str = Field(alias="displayName")
418
- description: Optional[str] = Field(default=None)
419
- billing_id: Optional[str] = Field(alias="billingId", default=None)
420
- version_number: int = Field(alias="versionNumber")
421
- additional_meta_data: Optional[Any] = Field(
422
- alias="additionalMetaData", default=None
423
- )
424
- hidden_from_widgets: Optional[List[WidgetType]] = Field(
425
- alias="hiddenFromWidgets", default=None
426
- )
427
- product: "PlanFragmentProduct"
428
- base_plan: Optional["PlanFragmentBasePlan"] = Field(alias="basePlan", default=None)
429
- entitlements: Optional[List["PlanFragmentEntitlements"]] = Field(default=None)
430
- inherited_entitlements: Optional[List["PlanFragmentInheritedEntitlements"]] = Field(
431
- alias="inheritedEntitlements", default=None
432
- )
433
- compatible_addons: Optional[List["PlanFragmentCompatibleAddons"]] = Field(
434
- alias="compatibleAddons", default=None
435
- )
436
- compatible_package_groups: Optional[
437
- List["PlanFragmentCompatiblePackageGroups"]
438
- ] = Field(alias="compatiblePackageGroups", default=None)
439
- prices: Optional[List["PlanFragmentPrices"]] = Field(default=None)
440
- overage_prices: Optional[List["PlanFragmentOveragePrices"]] = Field(
441
- alias="overagePrices", default=None
442
- )
443
- pricing_type: Optional[PricingType] = Field(alias="pricingType", default=None)
444
- default_trial_config: Optional["PlanFragmentDefaultTrialConfig"] = Field(
445
- alias="defaultTrialConfig", default=None
446
- )
280
+ class SubscriptionFutureUpdateDataScheduleVariablesCouponChangeVariables(BaseModel):
281
+ typename__: Literal["CouponChangeVariables"] = Field(alias="__typename")
447
282
 
448
283
 
449
- class PlanFragmentProduct(ProductFragment):
450
- pass
284
+ class SubscriptionFutureUpdateDataScheduleVariablesDowngradeChangeVariables(BaseModel):
285
+ typename__: Literal["DowngradeChangeVariables"] = Field(alias="__typename")
286
+ downgrade_plan_ref_id: str = Field(alias="downgradePlanRefId")
287
+ billing_period: Optional[BillingPeriod] = Field(alias="billingPeriod", default=None)
288
+ billable_features: Optional[
289
+ List[
290
+ "SubscriptionFutureUpdateDataScheduleVariablesDowngradeChangeVariablesBillableFeatures"
291
+ ]
292
+ ] = Field(alias="billableFeatures", default=None)
293
+ addons: Optional[
294
+ List[
295
+ "SubscriptionFutureUpdateDataScheduleVariablesDowngradeChangeVariablesAddons"
296
+ ]
297
+ ] = Field(default=None)
298
+ price_overrides: Optional[
299
+ List[
300
+ "SubscriptionFutureUpdateDataScheduleVariablesDowngradeChangeVariablesPriceOverrides"
301
+ ]
302
+ ] = Field(alias="priceOverrides", default=None)
451
303
 
452
304
 
453
- class PlanFragmentBasePlan(BaseModel):
454
- ref_id: str = Field(alias="refId")
455
- display_name: str = Field(alias="displayName")
305
+ class SubscriptionFutureUpdateDataScheduleVariablesDowngradeChangeVariablesBillableFeatures(
306
+ BaseModel
307
+ ):
308
+ feature_id: str = Field(alias="featureId")
309
+ quantity: float
456
310
 
457
311
 
458
- class PlanFragmentEntitlements(PackageEntitlementFragment):
459
- pass
312
+ class SubscriptionFutureUpdateDataScheduleVariablesDowngradeChangeVariablesAddons(
313
+ BaseModel
314
+ ):
315
+ addon_ref_id: str = Field(alias="addonRefId")
316
+ quantity: float
460
317
 
461
318
 
462
- class PlanFragmentInheritedEntitlements(PackageEntitlementFragment):
463
- pass
319
+ class SubscriptionFutureUpdateDataScheduleVariablesDowngradeChangeVariablesPriceOverrides(
320
+ BaseModel
321
+ ):
322
+ plan_ref_id: Optional[str] = Field(alias="planRefId", default=None)
323
+ addon_ref_id: Optional[str] = Field(alias="addonRefId", default=None)
324
+ feature_id: Optional[str] = Field(alias="featureId", default=None)
464
325
 
465
326
 
466
- class PlanFragmentCompatibleAddons(AddonFragment):
467
- pass
327
+ class SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariables(BaseModel):
328
+ typename__: Literal["PlanChangeVariables"] = Field(alias="__typename")
329
+ plan_ref_id: str = Field(alias="planRefId")
330
+ change_type: PlanChangeType = Field(alias="changeType")
331
+ billing_period: Optional[BillingPeriod] = Field(alias="billingPeriod", default=None)
332
+ billable_features: Optional[
333
+ List[
334
+ "SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariablesBillableFeatures"
335
+ ]
336
+ ] = Field(alias="billableFeatures", default=None)
337
+ addons: Optional[
338
+ List["SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariablesAddons"]
339
+ ] = Field(default=None)
340
+ price_overrides: Optional[
341
+ List[
342
+ "SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariablesPriceOverrides"
343
+ ]
344
+ ] = Field(alias="priceOverrides", default=None)
468
345
 
469
346
 
470
- class PlanFragmentCompatiblePackageGroups(PlanCompatiblePackageGroupsFragment):
471
- pass
347
+ class SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariablesBillableFeatures(
348
+ BaseModel
349
+ ):
350
+ feature_id: str = Field(alias="featureId")
351
+ quantity: float
472
352
 
473
353
 
474
- class PlanFragmentPrices(PriceFragment):
475
- pass
354
+ class SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariablesAddons(BaseModel):
355
+ addon_ref_id: str = Field(alias="addonRefId")
356
+ quantity: float
476
357
 
477
358
 
478
- class PlanFragmentOveragePrices(OveragePriceFragment):
479
- pass
359
+ class SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariablesPriceOverrides(
360
+ BaseModel
361
+ ):
362
+ plan_ref_id: Optional[str] = Field(alias="planRefId", default=None)
363
+ addon_ref_id: Optional[str] = Field(alias="addonRefId", default=None)
364
+ feature_id: Optional[str] = Field(alias="featureId", default=None)
480
365
 
481
366
 
482
- class PlanFragmentDefaultTrialConfig(BaseModel):
483
- duration: float
484
- units: TrialPeriodUnits
485
- budget: Optional["PlanFragmentDefaultTrialConfigBudget"] = Field(default=None)
486
- trial_end_behavior: Optional[TrialEndBehavior] = Field(
487
- alias="trialEndBehavior", default=None
488
- )
367
+ class SubscriptionFutureUpdateDataScheduleVariablesPlanPriceOverrideChangeVariables(
368
+ BaseModel
369
+ ):
370
+ typename__: Literal["PlanPriceOverrideChangeVariables"] = Field(alias="__typename")
371
+ plan_ref_id: str = Field(alias="planRefId")
372
+ feature_id: Optional[str] = Field(alias="featureId", default=None)
489
373
 
490
374
 
491
- class PlanFragmentDefaultTrialConfigBudget(BaseModel):
492
- limit: float
375
+ class SubscriptionFutureUpdateDataScheduleVariablesUnitAmountChangeVariables(BaseModel):
376
+ typename__: Literal["UnitAmountChangeVariables"] = Field(alias="__typename")
377
+ new_unit_amount: Optional[float] = Field(alias="newUnitAmount", default=None)
378
+ feature_id: Optional[str] = Field(alias="featureId", default=None)
493
379
 
494
380
 
495
381
  class SubscriptionScheduledUpdateData(BaseModel):
@@ -654,158 +540,187 @@ class SubscriptionScheduledUpdateDataScheduleVariablesUnitAmountChangeVariables(
654
540
  feature_id: Optional[str] = Field(alias="featureId", default=None)
655
541
 
656
542
 
657
- class SubscriptionFutureUpdateData(BaseModel):
658
- subscription_schedule_type: SubscriptionScheduleType = Field(
659
- alias="subscriptionScheduleType"
543
+ class ProductFragment(BaseModel):
544
+ ref_id: str = Field(alias="refId")
545
+ display_name: Optional[str] = Field(alias="displayName", default=None)
546
+ description: Optional[str] = Field(default=None)
547
+ additional_meta_data: Optional[Any] = Field(
548
+ alias="additionalMetaData", default=None
660
549
  )
661
- schedule_status: SubscriptionScheduleStatus = Field(alias="scheduleStatus")
662
- scheduled_execution_time: Any = Field(alias="scheduledExecutionTime")
663
- target_package: Optional["SubscriptionFutureUpdateDataTargetPackage"] = Field(
664
- alias="targetPackage", default=None
550
+ product_settings: "ProductFragmentProductSettings" = Field(alias="productSettings")
551
+
552
+
553
+ class ProductFragmentProductSettings(BaseModel):
554
+ downgrade_plan: Optional["ProductFragmentProductSettingsDowngradePlan"] = Field(
555
+ alias="downgradePlan", default=None
665
556
  )
666
- schedule_variables: Optional[
667
- Annotated[
668
- Union[
669
- "SubscriptionFutureUpdateDataScheduleVariablesAddonChangeVariables",
670
- "SubscriptionFutureUpdateDataScheduleVariablesAddonPriceOverrideChangeVariables",
671
- "SubscriptionFutureUpdateDataScheduleVariablesBillingPeriodChangeVariables",
672
- "SubscriptionFutureUpdateDataScheduleVariablesCouponChangeVariables",
673
- "SubscriptionFutureUpdateDataScheduleVariablesDowngradeChangeVariables",
674
- "SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariables",
675
- "SubscriptionFutureUpdateDataScheduleVariablesPlanPriceOverrideChangeVariables",
676
- "SubscriptionFutureUpdateDataScheduleVariablesUnitAmountChangeVariables",
677
- ],
678
- Field(discriminator="typename__"),
679
- ]
680
- ] = Field(alias="scheduleVariables", default=None)
681
557
 
682
558
 
683
- class SubscriptionFutureUpdateDataTargetPackage(BaseModel):
559
+ class ProductFragmentProductSettingsDowngradePlan(BaseModel):
560
+ ref_id: str = Field(alias="refId")
561
+ display_name: str = Field(alias="displayName")
562
+
563
+
564
+ class PlanCompatiblePackageGroupsFragment(BaseModel):
565
+ package_group_id: str = Field(alias="packageGroupId")
566
+ display_name: str = Field(alias="displayName")
567
+ addons: Optional[List["PlanCompatiblePackageGroupsFragmentAddons"]] = Field(
568
+ default=None
569
+ )
570
+ options: "PlanCompatiblePackageGroupsFragmentOptions"
571
+
572
+
573
+ class PlanCompatiblePackageGroupsFragmentAddons(AddonFragment):
574
+ pass
575
+
576
+
577
+ class PlanCompatiblePackageGroupsFragmentOptions(BaseModel):
578
+ min_items: Optional[float] = Field(alias="minItems", default=None)
579
+ free_items: Optional[float] = Field(alias="freeItems", default=None)
580
+
581
+
582
+ class PlanFragment(BaseModel):
684
583
  id: Any
685
584
  ref_id: str = Field(alias="refId")
686
585
  display_name: str = Field(alias="displayName")
586
+ description: Optional[str] = Field(default=None)
587
+ billing_id: Optional[str] = Field(alias="billingId", default=None)
588
+ version_number: int = Field(alias="versionNumber")
589
+ additional_meta_data: Optional[Any] = Field(
590
+ alias="additionalMetaData", default=None
591
+ )
592
+ hidden_from_widgets: Optional[List[WidgetType]] = Field(
593
+ alias="hiddenFromWidgets", default=None
594
+ )
595
+ product: "PlanFragmentProduct"
596
+ base_plan: Optional["PlanFragmentBasePlan"] = Field(alias="basePlan", default=None)
597
+ entitlements: Optional[List["PlanFragmentEntitlements"]] = Field(default=None)
598
+ inherited_entitlements: Optional[List["PlanFragmentInheritedEntitlements"]] = Field(
599
+ alias="inheritedEntitlements", default=None
600
+ )
601
+ compatible_addons: Optional[List["PlanFragmentCompatibleAddons"]] = Field(
602
+ alias="compatibleAddons", default=None
603
+ )
604
+ compatible_package_groups: Optional[
605
+ List["PlanFragmentCompatiblePackageGroups"]
606
+ ] = Field(alias="compatiblePackageGroups", default=None)
607
+ prices: Optional[List["PlanFragmentPrices"]] = Field(default=None)
608
+ overage_prices: Optional[List["PlanFragmentOveragePrices"]] = Field(
609
+ alias="overagePrices", default=None
610
+ )
611
+ pricing_type: Optional[PricingType] = Field(alias="pricingType", default=None)
612
+ default_trial_config: Optional["PlanFragmentDefaultTrialConfig"] = Field(
613
+ alias="defaultTrialConfig", default=None
614
+ )
687
615
 
688
616
 
689
- class SubscriptionFutureUpdateDataScheduleVariablesAddonChangeVariables(BaseModel):
690
- typename__: Literal["AddonChangeVariables"] = Field(alias="__typename")
691
- addon_ref_id: str = Field(alias="addonRefId")
692
- new_quantity: float = Field(alias="newQuantity")
617
+ class PlanFragmentProduct(ProductFragment):
618
+ pass
693
619
 
694
620
 
695
- class SubscriptionFutureUpdateDataScheduleVariablesAddonPriceOverrideChangeVariables(
696
- BaseModel
697
- ):
698
- typename__: Literal["AddonPriceOverrideChangeVariables"] = Field(alias="__typename")
699
- addon_ref_id: str = Field(alias="addonRefId")
700
- feature_id: Optional[str] = Field(alias="featureId", default=None)
621
+ class PlanFragmentBasePlan(BaseModel):
622
+ ref_id: str = Field(alias="refId")
623
+ display_name: str = Field(alias="displayName")
701
624
 
702
625
 
703
- class SubscriptionFutureUpdateDataScheduleVariablesBillingPeriodChangeVariables(
704
- BaseModel
705
- ):
706
- typename__: Literal["BillingPeriodChangeVariables"] = Field(alias="__typename")
707
- billing_period: Optional[BillingPeriod] = Field(alias="billingPeriod", default=None)
626
+ class PlanFragmentEntitlements(PackageEntitlementFragment):
627
+ pass
708
628
 
709
629
 
710
- class SubscriptionFutureUpdateDataScheduleVariablesCouponChangeVariables(BaseModel):
711
- typename__: Literal["CouponChangeVariables"] = Field(alias="__typename")
630
+ class PlanFragmentInheritedEntitlements(PackageEntitlementFragment):
631
+ pass
712
632
 
713
633
 
714
- class SubscriptionFutureUpdateDataScheduleVariablesDowngradeChangeVariables(BaseModel):
715
- typename__: Literal["DowngradeChangeVariables"] = Field(alias="__typename")
716
- downgrade_plan_ref_id: str = Field(alias="downgradePlanRefId")
717
- billing_period: Optional[BillingPeriod] = Field(alias="billingPeriod", default=None)
718
- billable_features: Optional[
719
- List[
720
- "SubscriptionFutureUpdateDataScheduleVariablesDowngradeChangeVariablesBillableFeatures"
721
- ]
722
- ] = Field(alias="billableFeatures", default=None)
723
- addons: Optional[
724
- List[
725
- "SubscriptionFutureUpdateDataScheduleVariablesDowngradeChangeVariablesAddons"
726
- ]
727
- ] = Field(default=None)
728
- price_overrides: Optional[
729
- List[
730
- "SubscriptionFutureUpdateDataScheduleVariablesDowngradeChangeVariablesPriceOverrides"
731
- ]
732
- ] = Field(alias="priceOverrides", default=None)
634
+ class PlanFragmentCompatibleAddons(AddonFragment):
635
+ pass
733
636
 
734
637
 
735
- class SubscriptionFutureUpdateDataScheduleVariablesDowngradeChangeVariablesBillableFeatures(
736
- BaseModel
737
- ):
738
- feature_id: str = Field(alias="featureId")
739
- quantity: float
638
+ class PlanFragmentCompatiblePackageGroups(PlanCompatiblePackageGroupsFragment):
639
+ pass
740
640
 
741
641
 
742
- class SubscriptionFutureUpdateDataScheduleVariablesDowngradeChangeVariablesAddons(
743
- BaseModel
744
- ):
745
- addon_ref_id: str = Field(alias="addonRefId")
746
- quantity: float
642
+ class PlanFragmentPrices(PriceFragment):
643
+ pass
747
644
 
748
645
 
749
- class SubscriptionFutureUpdateDataScheduleVariablesDowngradeChangeVariablesPriceOverrides(
750
- BaseModel
751
- ):
752
- plan_ref_id: Optional[str] = Field(alias="planRefId", default=None)
753
- addon_ref_id: Optional[str] = Field(alias="addonRefId", default=None)
754
- feature_id: Optional[str] = Field(alias="featureId", default=None)
646
+ class PlanFragmentOveragePrices(OveragePriceFragment):
647
+ pass
755
648
 
756
649
 
757
- class SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariables(BaseModel):
758
- typename__: Literal["PlanChangeVariables"] = Field(alias="__typename")
759
- plan_ref_id: str = Field(alias="planRefId")
760
- change_type: PlanChangeType = Field(alias="changeType")
761
- billing_period: Optional[BillingPeriod] = Field(alias="billingPeriod", default=None)
762
- billable_features: Optional[
763
- List[
764
- "SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariablesBillableFeatures"
765
- ]
766
- ] = Field(alias="billableFeatures", default=None)
767
- addons: Optional[
768
- List["SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariablesAddons"]
769
- ] = Field(default=None)
770
- price_overrides: Optional[
771
- List[
772
- "SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariablesPriceOverrides"
773
- ]
774
- ] = Field(alias="priceOverrides", default=None)
650
+ class PlanFragmentDefaultTrialConfig(BaseModel):
651
+ duration: float
652
+ units: TrialPeriodUnits
653
+ budget: Optional["PlanFragmentDefaultTrialConfigBudget"] = Field(default=None)
654
+ trial_end_behavior: Optional[TrialEndBehavior] = Field(
655
+ alias="trialEndBehavior", default=None
656
+ )
775
657
 
776
658
 
777
- class SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariablesBillableFeatures(
778
- BaseModel
779
- ):
780
- feature_id: str = Field(alias="featureId")
781
- quantity: float
659
+ class PlanFragmentDefaultTrialConfigBudget(BaseModel):
660
+ limit: float
661
+
662
+
663
+ class SubscriptionTrialConfigurationFragment(BaseModel):
664
+ trial_end_behavior: TrialEndBehavior = Field(alias="trialEndBehavior")
782
665
 
783
666
 
784
- class SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariablesAddons(BaseModel):
785
- addon_ref_id: str = Field(alias="addonRefId")
786
- quantity: float
667
+ class SubscriptionInvoiceFragment(BaseModel):
668
+ billing_id: str = Field(alias="billingId")
669
+ status: SubscriptionInvoiceStatus
670
+ created_at: Any = Field(alias="createdAt")
671
+ updated_at: Any = Field(alias="updatedAt")
672
+ error_message: Optional[str] = Field(alias="errorMessage", default=None)
673
+ requires_action: bool = Field(alias="requiresAction")
674
+ payment_secret: Optional[str] = Field(alias="paymentSecret", default=None)
675
+ payment_url: Optional[str] = Field(alias="paymentUrl", default=None)
676
+ pdf_url: Optional[str] = Field(alias="pdfUrl", default=None)
677
+ billing_reason: Optional[SubscriptionInvoiceBillingReason] = Field(
678
+ alias="billingReason", default=None
679
+ )
680
+ currency: Optional[str] = Field(default=None)
681
+ sub_total: Optional[float] = Field(alias="subTotal", default=None)
682
+ sub_total_excluding_tax: Optional[float] = Field(
683
+ alias="subTotalExcludingTax", default=None
684
+ )
685
+ total: Optional[float] = Field(default=None)
686
+ total_excluding_tax: Optional[float] = Field(
687
+ alias="totalExcludingTax", default=None
688
+ )
689
+ tax: Optional[float] = Field(default=None)
690
+ amount_due: Optional[float] = Field(alias="amountDue", default=None)
691
+ attempt_count: Optional[float] = Field(alias="attemptCount", default=None)
787
692
 
788
693
 
789
- class SubscriptionFutureUpdateDataScheduleVariablesPlanChangeVariablesPriceOverrides(
790
- BaseModel
791
- ):
792
- plan_ref_id: Optional[str] = Field(alias="planRefId", default=None)
793
- addon_ref_id: Optional[str] = Field(alias="addonRefId", default=None)
794
- feature_id: Optional[str] = Field(alias="featureId", default=None)
694
+ class TotalPriceFragment(BaseModel):
695
+ sub_total: "TotalPriceFragmentSubTotal" = Field(alias="subTotal")
696
+ total: "TotalPriceFragmentTotal"
795
697
 
796
698
 
797
- class SubscriptionFutureUpdateDataScheduleVariablesPlanPriceOverrideChangeVariables(
798
- BaseModel
799
- ):
800
- typename__: Literal["PlanPriceOverrideChangeVariables"] = Field(alias="__typename")
801
- plan_ref_id: str = Field(alias="planRefId")
802
- feature_id: Optional[str] = Field(alias="featureId", default=None)
699
+ class TotalPriceFragmentSubTotal(BaseModel):
700
+ amount: float
701
+ currency: Currency
803
702
 
804
703
 
805
- class SubscriptionFutureUpdateDataScheduleVariablesUnitAmountChangeVariables(BaseModel):
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)
704
+ class TotalPriceFragmentTotal(BaseModel):
705
+ amount: float
706
+ currency: Currency
707
+
708
+
709
+ class SlimCustomerFragment(BaseModel):
710
+ id: Any
711
+ name: Optional[str] = Field(default=None)
712
+ email: Optional[str] = Field(default=None)
713
+ created_at: Optional[Any] = Field(alias="createdAt", default=None)
714
+ updated_at: Any = Field(alias="updatedAt")
715
+ ref_id: str = Field(alias="refId")
716
+ customer_id: str = Field(alias="customerId")
717
+ billing_id: Optional[str] = Field(alias="billingId", default=None)
718
+ additional_meta_data: Optional[Any] = Field(
719
+ alias="additionalMetaData", default=None
720
+ )
721
+ aws_marketplace_customer_id: Optional[str] = Field(
722
+ alias="awsMarketplaceCustomerId", default=None
723
+ )
809
724
 
810
725
 
811
726
  class SubscriptionFragment(BaseModel):
@@ -917,6 +832,91 @@ class SubscriptionFragmentTrialConfiguration(SubscriptionTrialConfigurationFragm
917
832
  pass
918
833
 
919
834
 
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,35 +994,6 @@ 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
-
1026
997
  class CouponFragment(BaseModel):
1027
998
  id: Any
1028
999
  discount_value: float = Field(alias="discountValue")
@@ -1057,6 +1028,35 @@ class CouponFragmentSyncStates(BaseModel):
1057
1028
  status: SyncStatus
1058
1029
 
1059
1030
 
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")
@@ -1263,16 +1263,6 @@ class CustomerPortalEntitlementFragmentFeature(FeatureFragment):
1263
1263
  pass
1264
1264
 
1265
1265
 
1266
- class CustomerPortalPromotionalEntitlementFragment(BaseModel):
1267
- display_name: str = Field(alias="displayName")
1268
- has_unlimited_usage: Optional[bool] = Field(alias="hasUnlimitedUsage", default=None)
1269
- has_soft_limit: Optional[bool] = Field(alias="hasSoftLimit", default=None)
1270
- usage_limit: Optional[float] = Field(alias="usageLimit", default=None)
1271
- period: PromotionalEntitlementPeriod
1272
- start_date: Any = Field(alias="startDate")
1273
- end_date: Optional[Any] = Field(alias="endDate", default=None)
1274
-
1275
-
1276
1266
  class CustomerPortalSubscriptionAddonFragment(BaseModel):
1277
1267
  addon_id: str = Field(alias="addonId")
1278
1268
  description: Optional[str] = Field(default=None)
@@ -1572,6 +1562,16 @@ class CustomerPortalSubscriptionFragmentScheduledUpdates(
1572
1562
  pass
1573
1563
 
1574
1564
 
1565
+ class CustomerPortalPromotionalEntitlementFragment(BaseModel):
1566
+ display_name: str = Field(alias="displayName")
1567
+ has_unlimited_usage: Optional[bool] = Field(alias="hasUnlimitedUsage", default=None)
1568
+ has_soft_limit: Optional[bool] = Field(alias="hasSoftLimit", default=None)
1569
+ usage_limit: Optional[float] = Field(alias="usageLimit", default=None)
1570
+ period: PromotionalEntitlementPeriod
1571
+ start_date: Any = Field(alias="startDate")
1572
+ end_date: Optional[Any] = Field(alias="endDate", default=None)
1573
+
1574
+
1575
1575
  class CustomerPortalFragment(BaseModel):
1576
1576
  subscriptions: List["CustomerPortalFragmentSubscriptions"]
1577
1577
  entitlements: List["CustomerPortalFragmentEntitlements"]
@@ -2840,40 +2840,40 @@ class UsageHistoryV2FragmentSeriesPoints(BaseModel):
2840
2840
 
2841
2841
 
2842
2842
  AddonDependencyFragment.model_rebuild()
2843
+ PackageEntitlementFragment.model_rebuild()
2843
2844
  PriceTierFragment.model_rebuild()
2844
2845
  PriceFragment.model_rebuild()
2845
2846
  OveragePriceFragment.model_rebuild()
2846
- PackageEntitlementFragment.model_rebuild()
2847
2847
  AddonFragment.model_rebuild()
2848
- FeatureFragment.model_rebuild()
2849
- EntitlementFragment.model_rebuild()
2850
- TotalPriceFragment.model_rebuild()
2851
2848
  CustomerResourceFragment.model_rebuild()
2852
- SubscriptionTrialConfigurationFragment.model_rebuild()
2853
- SubscriptionInvoiceFragment.model_rebuild()
2854
- SlimCustomerFragment.model_rebuild()
2849
+ SubscriptionFutureUpdateData.model_rebuild()
2850
+ SubscriptionScheduledUpdateData.model_rebuild()
2855
2851
  ProductFragment.model_rebuild()
2856
2852
  PlanCompatiblePackageGroupsFragment.model_rebuild()
2857
2853
  PlanFragment.model_rebuild()
2858
- SubscriptionScheduledUpdateData.model_rebuild()
2859
- SubscriptionFutureUpdateData.model_rebuild()
2854
+ SubscriptionTrialConfigurationFragment.model_rebuild()
2855
+ SubscriptionInvoiceFragment.model_rebuild()
2856
+ TotalPriceFragment.model_rebuild()
2857
+ SlimCustomerFragment.model_rebuild()
2860
2858
  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
- PromotionalEntitlementFragment.model_rebuild()
2866
2865
  CouponFragment.model_rebuild()
2866
+ PromotionalEntitlementFragment.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
- CustomerPortalPromotionalEntitlementFragment.model_rebuild()
2873
2872
  CustomerPortalSubscriptionAddonFragment.model_rebuild()
2874
2873
  CustomerPortalSubscriptionPriceFragment.model_rebuild()
2875
2874
  CustomerPortalSubscriptionScheduledUpdateDataFragment.model_rebuild()
2876
2875
  CustomerPortalSubscriptionFragment.model_rebuild()
2876
+ CustomerPortalPromotionalEntitlementFragment.model_rebuild()
2877
2877
  CustomerPortalFragment.model_rebuild()
2878
2878
  CustomerStatisticsFragment.model_rebuild()
2879
2879
  CustomerWithSubscriptionsFragment.model_rebuild()
@@ -24,6 +24,7 @@ from .enums import (
24
24
  CouponSource,
25
25
  CouponStatus,
26
26
  CouponType,
27
+ CreditGrantType,
27
28
  Currency,
28
29
  CustomerResourceSortFields,
29
30
  CustomerSortFields,
@@ -790,6 +791,24 @@ class CreateWorkflowTriggerInput(BaseModel):
790
791
  trigger_id: Optional[str] = Field(alias="triggerId", default=None)
791
792
 
792
793
 
794
+ class CreditGrantInput(BaseModel):
795
+ additional_meta_data: Optional[Any] = Field(
796
+ alias="additionalMetaData", default=None
797
+ )
798
+ amount: float
799
+ comment: Optional[str] = None
800
+ cost: Optional["MoneyInputDTO"] = None
801
+ currency_id: str = Field(alias="currencyId")
802
+ customer_id: str = Field(alias="customerId")
803
+ display_name: str = Field(alias="displayName")
804
+ effective_at: Optional[Any] = Field(alias="effectiveAt", default=None)
805
+ environment_id: Optional[Any] = Field(alias="environmentId", default=None)
806
+ expire_at: Optional[Any] = Field(alias="expireAt", default=None)
807
+ grant_type: CreditGrantType = Field(alias="grantType")
808
+ priority: Optional[float] = None
809
+ resource_id: Optional[str] = Field(alias="resourceId", default=None)
810
+
811
+
793
812
  class CursorPaging(BaseModel):
794
813
  after: Optional[Any] = None
795
814
  before: Optional[Any] = None
@@ -797,6 +816,16 @@ class CursorPaging(BaseModel):
797
816
  last: Optional[int] = None
798
817
 
799
818
 
819
+ class CustomCurrencyInput(BaseModel):
820
+ additional_meta_data: Optional[Any] = Field(
821
+ alias="additionalMetaData", default=None
822
+ )
823
+ currency_id: str = Field(alias="currencyId")
824
+ display_name: str = Field(alias="displayName")
825
+ environment_id: Optional[Any] = Field(alias="environmentId", default=None)
826
+ symbol: str
827
+
828
+
800
829
  class CustomerBillingInfo(BaseModel):
801
830
  billing_address: Optional["Address"] = Field(alias="billingAddress", default=None)
802
831
  currency: Optional[Currency] = None
@@ -1939,6 +1968,13 @@ class GetAuth0ApplicationsInput(BaseModel):
1939
1968
  environment_id: Optional[Any] = Field(alias="environmentId", default=None)
1940
1969
 
1941
1970
 
1971
+ class GetCreditGrantsInput(BaseModel):
1972
+ currency_id: Optional[str] = Field(alias="currencyId", default=None)
1973
+ customer_id: str = Field(alias="customerId")
1974
+ environment_id: Optional[Any] = Field(alias="environmentId", default=None)
1975
+ resource_id: Optional[str] = Field(alias="resourceId", default=None)
1976
+
1977
+
1942
1978
  class GetCustomerByRefIdInput(BaseModel):
1943
1979
  customer_id: str = Field(alias="customerId")
1944
1980
  environment_id: Optional[Any] = Field(alias="environmentId", default=None)
@@ -4498,6 +4534,29 @@ class UpdateCouponInput(BaseModel):
4498
4534
  ref_id: str = Field(alias="refId")
4499
4535
 
4500
4536
 
4537
+ class UpdateCreditGrantInput(BaseModel):
4538
+ additional_meta_data: Optional[Any] = Field(
4539
+ alias="additionalMetaData", default=None
4540
+ )
4541
+ comment: Optional[str] = None
4542
+ display_name: Optional[str] = Field(alias="displayName", default=None)
4543
+ effective_at: Optional[Any] = Field(alias="effectiveAt", default=None)
4544
+ environment_id: Optional[Any] = Field(alias="environmentId", default=None)
4545
+ expire_at: Optional[Any] = Field(alias="expireAt", default=None)
4546
+ id: Any
4547
+ priority: Optional[float] = None
4548
+
4549
+
4550
+ class UpdateCustomCurrencyInput(BaseModel):
4551
+ additional_meta_data: Optional[Any] = Field(
4552
+ alias="additionalMetaData", default=None
4553
+ )
4554
+ currency_id: str = Field(alias="currencyId")
4555
+ display_name: Optional[str] = Field(alias="displayName", default=None)
4556
+ environment_id: Optional[Any] = Field(alias="environmentId", default=None)
4557
+ symbol: Optional[str] = None
4558
+
4559
+
4501
4560
  class UpdateCustomerInput(BaseModel):
4502
4561
  additional_meta_data: Optional[Any] = Field(
4503
4562
  alias="additionalMetaData", default=None
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: stigg-api-client-v2
3
- Version: 2.492.0
3
+ Version: 2.503.0
4
4
  Summary:
5
5
  License: STIGG SDK LICENSE
6
6
  Author: Stigg
@@ -106,7 +106,7 @@ stigg/_vendors/pydantic-2.6.4.dist-info/REQUESTED,sha256=47DEQpj8HBSa-_TImW-5JCe
106
106
  stigg/_vendors/pydantic-2.6.4.dist-info/WHEEL,sha256=TJPnKdtrSue7xZ_AVGkp9YXcvDrobsjBds1du3Nx6dc,87
107
107
  stigg/_vendors/pydantic-2.6.4.dist-info/licenses/LICENSE,sha256=qeGG88oWte74QxjnpwFyE1GgDLe4rjpDlLZ7SeNSnvM,1129
108
108
  stigg/client.py,sha256=RWrVnxo9zHFXka8KJVE4sMgyek70ispQk0vqOINCvM0,8335
109
- stigg/generated/__init__.py,sha256=vlLeLOVc7thTyseqkEd6Gf_NjFRWvHwzUItaDU9zroQ,71687
109
+ stigg/generated/__init__.py,sha256=fDQ9VzudH8JL72sOeBvEmbG4blpGBVeAFQlduCCSW8I,72005
110
110
  stigg/generated/apply_subscription.py,sha256=Vbs-QZZxN16pUpt3Hp7Jvvcc5o_8xwJK9oTLQQjH0ZA,451
111
111
  stigg/generated/archive_customer.py,sha256=3N3iBiT2Vvzfb0ckV3o57A6lmJ_ef7JNPaMX_Jtcg6c,396
112
112
  stigg/generated/async_base_client.py,sha256=zqd6IhYxpalyA6KQkeGhXgSurC0vXSwSWmSlM2zZ0VM,12593
@@ -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=LNYmJArnO1NejmLy-MhcZzdxPIRXDuKv2cYXTMxoDDk,36766
122
+ stigg/generated/enums.py,sha256=Q8Po8_Wmdxjpc5xevWh2mBx2SoemvHwq5jGyLn8QwUg,37296
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=PPtpYpir9AA-HNYqONlHssRUSZcYBB_vf1eGHvcZ6Kw,103850
126
+ stigg/generated/fragments.py,sha256=wRGpQ_1WQWofoFqm4G_MvEcXncosLRuzVVGoMAMZB-g,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
@@ -145,7 +145,7 @@ stigg/generated/grant_promotional_entitlements.py,sha256=72PRYuqecL-0SkWb7deygkh
145
145
  stigg/generated/import_customer.py,sha256=yEtrEB7T-Aykv3AUl-rAQz2XL6hKL0j-7JL3h-xi87o,403
146
146
  stigg/generated/import_customer_bulk.py,sha256=miLn2ScWlPOH1IipltY5Vgd-ZQ_BkBk9t3-EsLvU5ZQ,284
147
147
  stigg/generated/import_subscriptions_bulk.py,sha256=QgitpZkjE7eBhP1o5W0PTVAbKOvz61dNoeBAWupIcgU,297
148
- stigg/generated/input_types.py,sha256=ABA8suyocvdVov0LKq4LP3fQ028f_60RnM1g8PQNTY0,201534
148
+ stigg/generated/input_types.py,sha256=c37o276EMmfPjlg9brzcJa7M_syE9KMUQzldBa__QgE,203900
149
149
  stigg/generated/migrate_subscription_to_latest.py,sha256=qQDwH7EodYAeJFb62IIl-MAEB5MbthgCJ0v1RMxpdYk,516
150
150
  stigg/generated/preview_next_invoice.py,sha256=MiQ4Gv7Ve1Hv60xhaQi7uj82aq0xLP2UB-gjvcQdOL8,478
151
151
  stigg/generated/preview_subscription.py,sha256=Qo2vlFs7sFzqaE8J_e-EHTRfLvG46lko-dcJMxDSCR0,475
@@ -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.492.0.dist-info/LICENSE,sha256=yhOTQTha61N-7pgHWeRZ0TGF5uq0ifi5U8qU8nHvzME,5127
165
- stigg_api_client_v2-2.492.0.dist-info/METADATA,sha256=Unms1Y4zggB573emmTooA_pDrnVLIWt42HusjBn--j8,2258
166
- stigg_api_client_v2-2.492.0.dist-info/WHEEL,sha256=kLuE8m1WYU0Ig0_YEGrXyTtiJvKPpLpDEiChiNyei5Y,88
167
- stigg_api_client_v2-2.492.0.dist-info/RECORD,,
164
+ stigg_api_client_v2-2.503.0.dist-info/LICENSE,sha256=yhOTQTha61N-7pgHWeRZ0TGF5uq0ifi5U8qU8nHvzME,5127
165
+ stigg_api_client_v2-2.503.0.dist-info/METADATA,sha256=w5xNBVVtYDtqCQi0wvnSsP2deweJQhPr4cdt_WsrB3s,2258
166
+ stigg_api_client_v2-2.503.0.dist-info/WHEEL,sha256=kLuE8m1WYU0Ig0_YEGrXyTtiJvKPpLpDEiChiNyei5Y,88
167
+ stigg_api_client_v2-2.503.0.dist-info/RECORD,,