stigg 0.1.0.pre.beta.52 → 0.1.0.pre.beta.54
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +23 -0
- data/README.md +1 -1
- data/lib/stigg/models/v1/addon.rb +6 -2
- data/lib/stigg/models/v1/addon_create_params.rb +6 -2
- data/lib/stigg/models/v1/addon_list_charges_response.rb +3 -2
- data/lib/stigg/models/v1/addon_list_response.rb +6 -2
- data/lib/stigg/models/v1/addon_publish_params.rb +10 -3
- data/lib/stigg/models/v1/addon_update_params.rb +36 -13
- data/lib/stigg/models/v1/contract_create_params.rb +61 -21
- data/lib/stigg/models/v1/contract_create_response.rb +9 -1
- data/lib/stigg/models/v1/contract_delete_response.rb +9 -1
- data/lib/stigg/models/v1/contract_list_response.rb +9 -1
- data/lib/stigg/models/v1/contract_retrieve_response.rb +9 -1
- data/lib/stigg/models/v1/contract_update_response.rb +9 -1
- data/lib/stigg/models/v1/coupon.rb +13 -6
- data/lib/stigg/models/v1/coupon_create_params.rb +13 -6
- data/lib/stigg/models/v1/coupon_list_response.rb +13 -6
- data/lib/stigg/models/v1/credits/credit_grant_response.rb +37 -11
- data/lib/stigg/models/v1/credits/grant_create_params.rb +34 -10
- data/lib/stigg/models/v1/credits/grant_list_response.rb +28 -9
- data/lib/stigg/models/v1/customer_import_params.rb +16 -6
- data/lib/stigg/models/v1/customer_integration_response.rb +20 -21
- data/lib/stigg/models/v1/customer_list_contracts_response.rb +9 -1
- data/lib/stigg/models/v1/customer_list_resources_response.rb +6 -1
- data/lib/stigg/models/v1/customer_list_response.rb +44 -17
- data/lib/stigg/models/v1/customer_provision_params.rb +48 -17
- data/lib/stigg/models/v1/customer_response.rb +48 -17
- data/lib/stigg/models/v1/customer_update_params.rb +38 -14
- data/lib/stigg/models/v1/customers/integration_link_params.rb +13 -18
- data/lib/stigg/models/v1/customers/integration_list_params.rb +1 -11
- data/lib/stigg/models/v1/customers/integration_list_response.rb +13 -19
- data/lib/stigg/models/v1/customers/integration_update_params.rb +7 -2
- data/lib/stigg/models/v1/customers/payment_method_attach_params.rb +13 -7
- data/lib/stigg/models/v1/customers/promotional_entitlement_create_params.rb +3 -1
- data/lib/stigg/models/v1/customers/promotional_entitlement_create_response.rb +5 -1
- data/lib/stigg/models/v1/customers/promotional_entitlement_list_response.rb +5 -1
- data/lib/stigg/models/v1/customers/promotional_entitlement_revoke_response.rb +15 -3
- data/lib/stigg/models/v1/event_estimate_params.rb +8 -2
- data/lib/stigg/models/v1/event_report_params.rb +12 -4
- data/lib/stigg/models/v1/feature.rb +162 -7
- data/lib/stigg/models/v1/feature_create_feature_params.rb +159 -7
- data/lib/stigg/models/v1/feature_list_features_response.rb +165 -7
- data/lib/stigg/models/v1/feature_update_feature_params.rb +21 -6
- data/lib/stigg/models/v1/plan.rb +14 -5
- data/lib/stigg/models/v1/plan_create_params.rb +14 -5
- data/lib/stigg/models/v1/plan_list_charges_response.rb +3 -2
- data/lib/stigg/models/v1/plan_list_overage_charges_response.rb +3 -2
- data/lib/stigg/models/v1/plan_list_response.rb +14 -5
- data/lib/stigg/models/v1/plan_publish_params.rb +10 -3
- data/lib/stigg/models/v1/plan_update_params.rb +44 -16
- data/lib/stigg/models/v1/product.rb +6 -4
- data/lib/stigg/models/v1/product_list_products_response.rb +6 -4
- data/lib/stigg/models/v1/product_update_product_params.rb +13 -6
- data/lib/stigg/models/v1/subscription.rb +14 -4
- data/lib/stigg/models/v1/subscription_delegate_params.rb +4 -4
- data/lib/stigg/models/v1/subscription_import_params.rb +6 -2
- data/lib/stigg/models/v1/subscription_list_response.rb +14 -4
- data/lib/stigg/models/v1/subscription_preview_params.rb +6 -2
- data/lib/stigg/models/v1/subscription_preview_response.rb +10 -2
- data/lib/stigg/models/v1/subscription_provision_params.rb +35 -9
- data/lib/stigg/models/v1/subscription_provision_response.rb +16 -4
- data/lib/stigg/models/v1/subscription_update_params.rb +22 -5
- data/lib/stigg/models/v1/usage_estimate_params.rb +19 -7
- data/lib/stigg/models/v1/usage_history_params.rb +8 -2
- data/lib/stigg/models/v1/usage_report_params.rb +23 -9
- data/lib/stigg/models/v1/usage_report_response.rb +5 -2
- data/lib/stigg/resources/v1/addons.rb +7 -3
- data/lib/stigg/resources/v1/contracts.rb +8 -7
- data/lib/stigg/resources/v1/coupons.rb +3 -3
- data/lib/stigg/resources/v1/credits/grants.rb +3 -3
- data/lib/stigg/resources/v1/customers/integrations.rb +7 -7
- data/lib/stigg/resources/v1/customers/payment_method.rb +3 -3
- data/lib/stigg/resources/v1/customers.rb +18 -19
- data/lib/stigg/resources/v1/events/data_export.rb +0 -36
- data/lib/stigg/resources/v1/events.rb +3 -3
- data/lib/stigg/resources/v1/features.rb +6 -4
- data/lib/stigg/resources/v1/plans.rb +11 -7
- data/lib/stigg/resources/v1/products.rb +1 -1
- data/lib/stigg/resources/v1/subscriptions.rb +16 -8
- data/lib/stigg/resources/v1/usage.rb +4 -4
- data/lib/stigg/version.rb +1 -1
- data/lib/stigg.rb +0 -2
- data/rbi/stigg/models/v1/addon.rbi +4 -2
- data/rbi/stigg/models/v1/addon_create_params.rbi +4 -2
- data/rbi/stigg/models/v1/addon_list_charges_response.rbi +4 -2
- data/rbi/stigg/models/v1/addon_list_response.rbi +4 -2
- data/rbi/stigg/models/v1/addon_publish_params.rbi +9 -3
- data/rbi/stigg/models/v1/addon_update_params.rbi +29 -13
- data/rbi/stigg/models/v1/contract_create_params.rbi +81 -23
- data/rbi/stigg/models/v1/contract_create_response.rbi +8 -0
- data/rbi/stigg/models/v1/contract_delete_response.rbi +8 -0
- data/rbi/stigg/models/v1/contract_list_response.rbi +8 -0
- data/rbi/stigg/models/v1/contract_retrieve_response.rbi +8 -0
- data/rbi/stigg/models/v1/contract_update_response.rbi +8 -0
- data/rbi/stigg/models/v1/coupon.rbi +14 -6
- data/rbi/stigg/models/v1/coupon_create_params.rbi +14 -6
- data/rbi/stigg/models/v1/coupon_list_response.rbi +14 -6
- data/rbi/stigg/models/v1/credits/credit_grant_response.rbi +36 -11
- data/rbi/stigg/models/v1/credits/grant_create_params.rbi +46 -10
- data/rbi/stigg/models/v1/credits/grant_list_response.rbi +28 -9
- data/rbi/stigg/models/v1/customer_import_params.rbi +20 -6
- data/rbi/stigg/models/v1/customer_integration_response.rbi +22 -62
- data/rbi/stigg/models/v1/customer_list_contracts_response.rbi +8 -0
- data/rbi/stigg/models/v1/customer_list_resources_response.rbi +6 -1
- data/rbi/stigg/models/v1/customer_list_response.rbi +50 -17
- data/rbi/stigg/models/v1/customer_provision_params.rbi +50 -17
- data/rbi/stigg/models/v1/customer_response.rbi +50 -17
- data/rbi/stigg/models/v1/customer_update_params.rbi +36 -14
- data/rbi/stigg/models/v1/customers/integration_link_params.rbi +13 -59
- data/rbi/stigg/models/v1/customers/integration_list_params.rbi +2 -52
- data/rbi/stigg/models/v1/customers/integration_list_response.rbi +16 -60
- data/rbi/stigg/models/v1/customers/integration_update_params.rbi +6 -2
- data/rbi/stigg/models/v1/customers/payment_method_attach_params.rbi +13 -7
- data/rbi/stigg/models/v1/customers/promotional_entitlement_create_params.rbi +3 -1
- data/rbi/stigg/models/v1/customers/promotional_entitlement_create_response.rbi +5 -1
- data/rbi/stigg/models/v1/customers/promotional_entitlement_list_response.rbi +5 -1
- data/rbi/stigg/models/v1/customers/promotional_entitlement_revoke_response.rbi +15 -3
- data/rbi/stigg/models/v1/event_estimate_params.rbi +8 -2
- data/rbi/stigg/models/v1/event_report_params.rbi +14 -4
- data/rbi/stigg/models/v1/feature.rbi +387 -6
- data/rbi/stigg/models/v1/feature_create_feature_params.rbi +409 -6
- data/rbi/stigg/models/v1/feature_list_features_response.rbi +421 -6
- data/rbi/stigg/models/v1/feature_update_feature_params.rbi +23 -2
- data/rbi/stigg/models/v1/plan.rbi +15 -5
- data/rbi/stigg/models/v1/plan_create_params.rbi +15 -5
- data/rbi/stigg/models/v1/plan_list_charges_response.rbi +4 -2
- data/rbi/stigg/models/v1/plan_list_overage_charges_response.rbi +4 -2
- data/rbi/stigg/models/v1/plan_list_response.rbi +15 -5
- data/rbi/stigg/models/v1/plan_publish_params.rbi +9 -3
- data/rbi/stigg/models/v1/plan_update_params.rbi +40 -16
- data/rbi/stigg/models/v1/product.rbi +8 -4
- data/rbi/stigg/models/v1/product_list_products_response.rbi +8 -4
- data/rbi/stigg/models/v1/product_update_product_params.rbi +14 -6
- data/rbi/stigg/models/v1/subscription.rbi +12 -4
- data/rbi/stigg/models/v1/subscription_delegate_params.rbi +6 -6
- data/rbi/stigg/models/v1/subscription_import_params.rbi +4 -2
- data/rbi/stigg/models/v1/subscription_list_response.rbi +12 -4
- data/rbi/stigg/models/v1/subscription_preview_params.rbi +4 -2
- data/rbi/stigg/models/v1/subscription_preview_response.rbi +12 -2
- data/rbi/stigg/models/v1/subscription_provision_params.rbi +34 -9
- data/rbi/stigg/models/v1/subscription_provision_response.rbi +12 -4
- data/rbi/stigg/models/v1/subscription_update_params.rbi +20 -5
- data/rbi/stigg/models/v1/usage_estimate_params.rbi +23 -7
- data/rbi/stigg/models/v1/usage_history_params.rbi +8 -2
- data/rbi/stigg/models/v1/usage_report_params.rbi +29 -9
- data/rbi/stigg/models/v1/usage_report_response.rbi +8 -2
- data/rbi/stigg/resources/v1/addons.rbi +13 -5
- data/rbi/stigg/resources/v1/contracts.rbi +17 -10
- data/rbi/stigg/resources/v1/coupons.rbi +8 -3
- data/rbi/stigg/resources/v1/credits/grants.rbi +18 -4
- data/rbi/stigg/resources/v1/customers/integrations.rbi +11 -7
- data/rbi/stigg/resources/v1/customers/payment_method.rbi +7 -3
- data/rbi/stigg/resources/v1/customers.rbi +26 -19
- data/rbi/stigg/resources/v1/events/data_export.rbi +0 -32
- data/rbi/stigg/resources/v1/events.rbi +6 -3
- data/rbi/stigg/resources/v1/features.rbi +13 -3
- data/rbi/stigg/resources/v1/plans.rbi +23 -7
- data/rbi/stigg/resources/v1/products.rbi +3 -1
- data/rbi/stigg/resources/v1/subscriptions.rbi +24 -11
- data/rbi/stigg/resources/v1/usage.rbi +15 -4
- data/sig/stigg/models/v1/contract_create_params.rbs +25 -7
- data/sig/stigg/models/v1/contract_create_response.rbs +5 -0
- data/sig/stigg/models/v1/contract_delete_response.rbs +5 -0
- data/sig/stigg/models/v1/contract_list_response.rbs +5 -0
- data/sig/stigg/models/v1/contract_retrieve_response.rbs +5 -0
- data/sig/stigg/models/v1/contract_update_response.rbs +5 -0
- data/sig/stigg/models/v1/customer_integration_response.rbs +2 -25
- data/sig/stigg/models/v1/customer_list_contracts_response.rbs +5 -0
- data/sig/stigg/models/v1/customer_list_response.rbs +6 -5
- data/sig/stigg/models/v1/customer_provision_params.rbs +6 -5
- data/sig/stigg/models/v1/customer_response.rbs +6 -5
- data/sig/stigg/models/v1/customers/integration_link_params.rbs +2 -25
- data/sig/stigg/models/v1/customers/integration_list_params.rbs +2 -25
- data/sig/stigg/models/v1/customers/integration_list_response.rbs +2 -25
- data/sig/stigg/models/v1/feature.rbs +146 -0
- data/sig/stigg/models/v1/feature_create_feature_params.rbs +156 -0
- data/sig/stigg/models/v1/feature_list_features_response.rbs +146 -0
- data/sig/stigg/models/v1/subscription_provision_params.rbs +9 -2
- data/sig/stigg/models/v1/subscription_update_params.rbs +9 -2
- data/sig/stigg/resources/v1/contracts.rbs +2 -1
- data/sig/stigg/resources/v1/events/data_export.rbs +0 -9
- data/sig/stigg/resources/v1/features.rbs +1 -0
- metadata +2 -8
- data/lib/stigg/models/v1/events/data_export_mint_scoped_token_params.rb +0 -55
- data/lib/stigg/models/v1/events/data_export_mint_scoped_token_response.rb +0 -55
- data/rbi/stigg/models/v1/events/data_export_mint_scoped_token_params.rbi +0 -88
- data/rbi/stigg/models/v1/events/data_export_mint_scoped_token_response.rbi +0 -111
- data/sig/stigg/models/v1/events/data_export_mint_scoped_token_params.rbs +0 -58
- data/sig/stigg/models/v1/events/data_export_mint_scoped_token_response.rbs +0 -51
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b656b4ba3fc90ca4486804b4c37637e9468716350c477bc6f5316c2ad696125c
|
|
4
|
+
data.tar.gz: 904bb67fde8fc93166f60586984d8fa1fc341a4744fb20f27681e1de2bd17b4f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b2c4c488e943c64427f91576620d000470f7b635b17c607ae79270791c8ad7c0da49802513601e255c21fe7d69b340f1174086db4ac6ba4b1ab784afcd2f851a
|
|
7
|
+
data.tar.gz: df2b4bbf81244e2c668f270859b864f1eab1c77d9c7cfe86c429323e4ab5109eda04248cd3bcd61ac0e8b12e539e04748c4d4347ad2422f99c4c2a20a0e5cfac
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,28 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.1.0-beta.54](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.53...v0.1.0-beta.54) (2026-09-29)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Bug Fixes
|
|
7
|
+
|
|
8
|
+
* **STIGG-9660:** back-sync production into staging to un-fork the trunks ([d953be5](https://github.com/stiggio/stigg-ruby/commit/d953be57fbb741cac3a622baf55a12d6ef8d04e6))
|
|
9
|
+
* **STIGG-9768:** stop exporting skipped workflow runs as failures ([b21fe43](https://github.com/stiggio/stigg-ruby/commit/b21fe43f39ec328ce04140c72c24016fa229be00))
|
|
10
|
+
* **STIGG-9768:** stop exporting skipped workflow runs as failures ([4c92e1b](https://github.com/stiggio/stigg-ruby/commit/4c92e1b93ec774836838b4f946cd1e060390c87c))
|
|
11
|
+
* sync OpenAPI spec from stigg-api ([451be2e](https://github.com/stiggio/stigg-ruby/commit/451be2ec055df4958a7390aacf48ebfd765ba813))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Chores
|
|
15
|
+
|
|
16
|
+
* normalize version.rb to gem prerelease format for stlc codegen ([bfd7daa](https://github.com/stiggio/stigg-ruby/commit/bfd7daa1f34940208e9a71a459f7420c1be8ef64))
|
|
17
|
+
* normalize version.rb to gem prerelease format for stlc codegen ([ea186c7](https://github.com/stiggio/stigg-ruby/commit/ea186c7f0174bb68baadaf28d365317a24f07f74))
|
|
18
|
+
|
|
19
|
+
## [0.1.0-beta.53](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.52...v0.1.0-beta.53) (2026-08-13)
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
### Bug Fixes
|
|
23
|
+
|
|
24
|
+
* gem prerelease version format in version.rb (align with stlc codegen) ([0bbaa6c](https://github.com/stiggio/stigg-ruby/commit/0bbaa6c7302564c1e4041a9785750e5418737548))
|
|
25
|
+
|
|
3
26
|
## [0.1.0-beta.52](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.51...v0.1.0-beta.52) (2026-08-12)
|
|
4
27
|
|
|
5
28
|
|
data/README.md
CHANGED
|
@@ -67,7 +67,8 @@ module Stigg
|
|
|
67
67
|
required :is_latest, Stigg::Internal::Type::Boolean, api_name: :isLatest, nil?: true
|
|
68
68
|
|
|
69
69
|
# @!attribute max_quantity
|
|
70
|
-
# The maximum quantity of this addon that can be added to a subscription
|
|
70
|
+
# The maximum quantity of this addon that can be added to a subscription. Leave
|
|
71
|
+
# unset for no upper bound.
|
|
71
72
|
#
|
|
72
73
|
# @return [Integer, nil]
|
|
73
74
|
required :max_quantity, Integer, api_name: :maxQuantity, nil?: true
|
|
@@ -112,6 +113,9 @@ module Stigg
|
|
|
112
113
|
required :version_number, Integer, api_name: :versionNumber
|
|
113
114
|
|
|
114
115
|
# @!method initialize(id:, billing_id:, created_at:, dependencies:, description:, display_name:, entitlements:, is_latest:, max_quantity:, metadata:, pricing_type:, product_id:, status:, updated_at:, version_number:)
|
|
116
|
+
# Some parameter documentations has been truncated, see
|
|
117
|
+
# {Stigg::Models::V1::Addon::Data} for more details.
|
|
118
|
+
#
|
|
115
119
|
# Addon configuration object
|
|
116
120
|
#
|
|
117
121
|
# @param id [String] The unique identifier for the entity
|
|
@@ -130,7 +134,7 @@ module Stigg
|
|
|
130
134
|
#
|
|
131
135
|
# @param is_latest [Boolean, nil] Indicates if the package is the latest version
|
|
132
136
|
#
|
|
133
|
-
# @param max_quantity [Integer, nil] The maximum quantity of this addon that can be added to a subscription
|
|
137
|
+
# @param max_quantity [Integer, nil] The maximum quantity of this addon that can be added to a subscription. Leave un
|
|
134
138
|
#
|
|
135
139
|
# @param metadata [Hash{Symbol=>String}] Metadata associated with the entity
|
|
136
140
|
#
|
|
@@ -39,7 +39,8 @@ module Stigg
|
|
|
39
39
|
optional :description, String, nil?: true
|
|
40
40
|
|
|
41
41
|
# @!attribute max_quantity
|
|
42
|
-
# The maximum quantity of this addon that can be added to a subscription
|
|
42
|
+
# The maximum quantity of this addon that can be added to a subscription. Leave
|
|
43
|
+
# unset for no upper bound.
|
|
43
44
|
#
|
|
44
45
|
# @return [Integer, nil]
|
|
45
46
|
optional :max_quantity, Integer, api_name: :maxQuantity, nil?: true
|
|
@@ -76,6 +77,9 @@ module Stigg
|
|
|
76
77
|
optional :x_environment_id, String
|
|
77
78
|
|
|
78
79
|
# @!method initialize(id:, display_name:, product_id:, billing_id: nil, description: nil, max_quantity: nil, metadata: nil, pricing_type: nil, status: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
|
|
80
|
+
# Some parameter documentations has been truncated, see
|
|
81
|
+
# {Stigg::Models::V1::AddonCreateParams} for more details.
|
|
82
|
+
#
|
|
79
83
|
# @param id [String] The unique identifier for the entity
|
|
80
84
|
#
|
|
81
85
|
# @param display_name [String] The display name of the package
|
|
@@ -86,7 +90,7 @@ module Stigg
|
|
|
86
90
|
#
|
|
87
91
|
# @param description [String, nil] The description of the package
|
|
88
92
|
#
|
|
89
|
-
# @param max_quantity [Integer, nil] The maximum quantity of this addon that can be added to a subscription
|
|
93
|
+
# @param max_quantity [Integer, nil] The maximum quantity of this addon that can be added to a subscription. Leave un
|
|
90
94
|
#
|
|
91
95
|
# @param metadata [Hash{Symbol=>String}] Metadata associated with the entity
|
|
92
96
|
#
|
|
@@ -42,7 +42,8 @@ module Stigg
|
|
|
42
42
|
required :created_at, Time, api_name: :createdAt
|
|
43
43
|
|
|
44
44
|
# @!attribute billing_country_code
|
|
45
|
-
# ISO country code for localized pricing,
|
|
45
|
+
# ISO country code for localized pricing, or "eu" for the European Union group you
|
|
46
|
+
# map countries into, if any
|
|
46
47
|
#
|
|
47
48
|
# @return [String, nil]
|
|
48
49
|
optional :billing_country_code, String, api_name: :billingCountryCode, nil?: true
|
|
@@ -163,7 +164,7 @@ module Stigg
|
|
|
163
164
|
#
|
|
164
165
|
# @param created_at [Time] Timestamp when the charge was created
|
|
165
166
|
#
|
|
166
|
-
# @param billing_country_code [String, nil] ISO country code for localized pricing,
|
|
167
|
+
# @param billing_country_code [String, nil] ISO country code for localized pricing, or "eu" for the European Union group you
|
|
167
168
|
#
|
|
168
169
|
# @param billing_id [String, nil] Identifier in the external billing integration (e.g. Stripe price id), if any
|
|
169
170
|
#
|
|
@@ -55,7 +55,8 @@ module Stigg
|
|
|
55
55
|
required :is_latest, Stigg::Internal::Type::Boolean, api_name: :isLatest, nil?: true
|
|
56
56
|
|
|
57
57
|
# @!attribute max_quantity
|
|
58
|
-
# The maximum quantity of this addon that can be added to a subscription
|
|
58
|
+
# The maximum quantity of this addon that can be added to a subscription. Leave
|
|
59
|
+
# unset for no upper bound.
|
|
59
60
|
#
|
|
60
61
|
# @return [Integer, nil]
|
|
61
62
|
required :max_quantity, Integer, api_name: :maxQuantity, nil?: true
|
|
@@ -100,6 +101,9 @@ module Stigg
|
|
|
100
101
|
required :version_number, Integer, api_name: :versionNumber
|
|
101
102
|
|
|
102
103
|
# @!method initialize(id:, billing_id:, created_at:, dependencies:, description:, display_name:, entitlements:, is_latest:, max_quantity:, metadata:, pricing_type:, product_id:, status:, updated_at:, version_number:)
|
|
104
|
+
# Some parameter documentations has been truncated, see
|
|
105
|
+
# {Stigg::Models::V1::AddonListResponse} for more details.
|
|
106
|
+
#
|
|
103
107
|
# Addon configuration object
|
|
104
108
|
#
|
|
105
109
|
# @param id [String] The unique identifier for the entity
|
|
@@ -118,7 +122,7 @@ module Stigg
|
|
|
118
122
|
#
|
|
119
123
|
# @param is_latest [Boolean, nil] Indicates if the package is the latest version
|
|
120
124
|
#
|
|
121
|
-
# @param max_quantity [Integer, nil] The maximum quantity of this addon that can be added to a subscription
|
|
125
|
+
# @param max_quantity [Integer, nil] The maximum quantity of this addon that can be added to a subscription. Leave un
|
|
122
126
|
#
|
|
123
127
|
# @param metadata [Hash{Symbol=>String}] Metadata associated with the entity
|
|
124
128
|
#
|
|
@@ -14,7 +14,9 @@ module Stigg
|
|
|
14
14
|
required :id, String
|
|
15
15
|
|
|
16
16
|
# @!attribute migration_type
|
|
17
|
-
#
|
|
17
|
+
# Who the published version applies to: NEW_CUSTOMERS (default) leaves existing
|
|
18
|
+
# subscribers on their current version, ALL_CUSTOMERS moves them onto the new
|
|
19
|
+
# version immediately.
|
|
18
20
|
#
|
|
19
21
|
# @return [Symbol, Stigg::Models::V1::AddonPublishParams::MigrationType]
|
|
20
22
|
required :migration_type,
|
|
@@ -32,9 +34,12 @@ module Stigg
|
|
|
32
34
|
optional :x_environment_id, String
|
|
33
35
|
|
|
34
36
|
# @!method initialize(id:, migration_type:, x_account_id: nil, x_environment_id: nil, request_options: {})
|
|
37
|
+
# Some parameter documentations has been truncated, see
|
|
38
|
+
# {Stigg::Models::V1::AddonPublishParams} for more details.
|
|
39
|
+
#
|
|
35
40
|
# @param id [String]
|
|
36
41
|
#
|
|
37
|
-
# @param migration_type [Symbol, Stigg::Models::V1::AddonPublishParams::MigrationType]
|
|
42
|
+
# @param migration_type [Symbol, Stigg::Models::V1::AddonPublishParams::MigrationType] Who the published version applies to: NEW_CUSTOMERS (default) leaves existing su
|
|
38
43
|
#
|
|
39
44
|
# @param x_account_id [String]
|
|
40
45
|
#
|
|
@@ -42,7 +47,9 @@ module Stigg
|
|
|
42
47
|
#
|
|
43
48
|
# @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
|
|
44
49
|
|
|
45
|
-
#
|
|
50
|
+
# Who the published version applies to: NEW_CUSTOMERS (default) leaves existing
|
|
51
|
+
# subscribers on their current version, ALL_CUSTOMERS moves them onto the new
|
|
52
|
+
# version immediately.
|
|
46
53
|
module MigrationType
|
|
47
54
|
extend Stigg::Internal::Type::Enum
|
|
48
55
|
|
|
@@ -20,7 +20,9 @@ module Stigg
|
|
|
20
20
|
optional :billing_id, String, api_name: :billingId, nil?: true
|
|
21
21
|
|
|
22
22
|
# @!attribute charges
|
|
23
|
-
# Pricing configuration to set on the addon draft
|
|
23
|
+
# Pricing configuration to set on the addon draft. Unlike the rest of this
|
|
24
|
+
# request, this is a full replace of the pricing configuration, not a merge — see
|
|
25
|
+
# SetPackagePricingRequest.
|
|
24
26
|
#
|
|
25
27
|
# @return [Stigg::Models::V1::AddonUpdateParams::Charges, nil]
|
|
26
28
|
optional :charges, -> { Stigg::V1::AddonUpdateParams::Charges }
|
|
@@ -44,7 +46,8 @@ module Stigg
|
|
|
44
46
|
optional :display_name, String, api_name: :displayName
|
|
45
47
|
|
|
46
48
|
# @!attribute max_quantity
|
|
47
|
-
# The maximum quantity of this addon that can be added to a subscription
|
|
49
|
+
# The maximum quantity of this addon that can be added to a subscription. Leave
|
|
50
|
+
# unset for no upper bound.
|
|
48
51
|
#
|
|
49
52
|
# @return [Integer, nil]
|
|
50
53
|
optional :max_quantity, Integer, api_name: :maxQuantity, nil?: true
|
|
@@ -72,11 +75,14 @@ module Stigg
|
|
|
72
75
|
optional :x_environment_id, String
|
|
73
76
|
|
|
74
77
|
# @!method initialize(id:, billing_id: nil, charges: nil, dependencies: nil, description: nil, display_name: nil, max_quantity: nil, metadata: nil, status: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
|
|
78
|
+
# Some parameter documentations has been truncated, see
|
|
79
|
+
# {Stigg::Models::V1::AddonUpdateParams} for more details.
|
|
80
|
+
#
|
|
75
81
|
# @param id [String]
|
|
76
82
|
#
|
|
77
83
|
# @param billing_id [String, nil] The unique identifier for the entity in the billing provider
|
|
78
84
|
#
|
|
79
|
-
# @param charges [Stigg::Models::V1::AddonUpdateParams::Charges] Pricing configuration to set on the addon draft
|
|
85
|
+
# @param charges [Stigg::Models::V1::AddonUpdateParams::Charges] Pricing configuration to set on the addon draft. Unlike the rest of this request
|
|
80
86
|
#
|
|
81
87
|
# @param dependencies [Array<String>, nil] List of addons the addon is dependant on
|
|
82
88
|
#
|
|
@@ -84,7 +90,7 @@ module Stigg
|
|
|
84
90
|
#
|
|
85
91
|
# @param display_name [String] The display name of the package
|
|
86
92
|
#
|
|
87
|
-
# @param max_quantity [Integer, nil] The maximum quantity of this addon that can be added to a subscription
|
|
93
|
+
# @param max_quantity [Integer, nil] The maximum quantity of this addon that can be added to a subscription. Leave un
|
|
88
94
|
#
|
|
89
95
|
# @param metadata [Hash{Symbol=>String}] Metadata associated with the entity
|
|
90
96
|
#
|
|
@@ -129,7 +135,8 @@ module Stigg
|
|
|
129
135
|
api_name: :overageBillingPeriod
|
|
130
136
|
|
|
131
137
|
# @!attribute overage_pricing_models
|
|
132
|
-
# Array of overage pricing model configurations
|
|
138
|
+
# Array of overage pricing model configurations. Replaces all existing overage
|
|
139
|
+
# pricing models on the draft — omit this to end up with no overage pricing.
|
|
133
140
|
#
|
|
134
141
|
# @return [Array<Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel>, nil]
|
|
135
142
|
optional :overage_pricing_models,
|
|
@@ -139,7 +146,8 @@ module Stigg
|
|
|
139
146
|
api_name: :overagePricingModels
|
|
140
147
|
|
|
141
148
|
# @!attribute pricing_models
|
|
142
|
-
# Array of pricing model configurations
|
|
149
|
+
# Array of pricing model configurations. Replaces all existing base pricing models
|
|
150
|
+
# on the draft — omit this to end up with no base pricing.
|
|
143
151
|
#
|
|
144
152
|
# @return [Array<Stigg::Models::V1::AddonUpdateParams::Charges::PricingModel>, nil]
|
|
145
153
|
optional :pricing_models,
|
|
@@ -147,7 +155,12 @@ module Stigg
|
|
|
147
155
|
api_name: :pricingModels
|
|
148
156
|
|
|
149
157
|
# @!method initialize(pricing_type:, billing_id: nil, minimum_spend: nil, overage_billing_period: nil, overage_pricing_models: nil, pricing_models: nil)
|
|
150
|
-
#
|
|
158
|
+
# Some parameter documentations has been truncated, see
|
|
159
|
+
# {Stigg::Models::V1::AddonUpdateParams::Charges} for more details.
|
|
160
|
+
#
|
|
161
|
+
# Pricing configuration to set on the addon draft. Unlike the rest of this
|
|
162
|
+
# request, this is a full replace of the pricing configuration, not a merge — see
|
|
163
|
+
# SetPackagePricingRequest.
|
|
151
164
|
#
|
|
152
165
|
# @param pricing_type [Symbol, Stigg::Models::V1::AddonUpdateParams::Charges::PricingType] The pricing type (FREE, PAID, or CUSTOM)
|
|
153
166
|
#
|
|
@@ -157,9 +170,9 @@ module Stigg
|
|
|
157
170
|
#
|
|
158
171
|
# @param overage_billing_period [Symbol, Stigg::Models::V1::AddonUpdateParams::Charges::OverageBillingPeriod] When overage charges are billed
|
|
159
172
|
#
|
|
160
|
-
# @param overage_pricing_models [Array<Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel>] Array of overage pricing model configurations
|
|
173
|
+
# @param overage_pricing_models [Array<Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel>] Array of overage pricing model configurations. Replaces all existing overage pri
|
|
161
174
|
#
|
|
162
|
-
# @param pricing_models [Array<Stigg::Models::V1::AddonUpdateParams::Charges::PricingModel>] Array of pricing model configurations
|
|
175
|
+
# @param pricing_models [Array<Stigg::Models::V1::AddonUpdateParams::Charges::PricingModel>] Array of pricing model configurations. Replaces all existing base pricing models
|
|
163
176
|
|
|
164
177
|
# The pricing type (FREE, PAID, or CUSTOM)
|
|
165
178
|
#
|
|
@@ -440,7 +453,8 @@ module Stigg
|
|
|
440
453
|
api_name: :billingPeriod
|
|
441
454
|
|
|
442
455
|
# @!attribute billing_country_code
|
|
443
|
-
# ISO country code for localized pricing
|
|
456
|
+
# ISO country code for localized pricing, or "eu" for the European Union group you
|
|
457
|
+
# map countries into
|
|
444
458
|
#
|
|
445
459
|
# @return [String, nil]
|
|
446
460
|
optional :billing_country_code, String, api_name: :billingCountryCode
|
|
@@ -485,11 +499,15 @@ module Stigg
|
|
|
485
499
|
-> { Stigg::Internal::Type::ArrayOf[Stigg::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier] }
|
|
486
500
|
|
|
487
501
|
# @!method initialize(billing_period:, billing_country_code: nil, block_size: nil, credit_grant_cadence: nil, credit_rate: nil, price: nil, tiers: nil)
|
|
502
|
+
# Some parameter documentations has been truncated, see
|
|
503
|
+
# {Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod}
|
|
504
|
+
# for more details.
|
|
505
|
+
#
|
|
488
506
|
# Price configuration for a specific billing period.
|
|
489
507
|
#
|
|
490
508
|
# @param billing_period [Symbol, Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::BillingPeriod] The billing period (MONTHLY or ANNUALLY)
|
|
491
509
|
#
|
|
492
|
-
# @param billing_country_code [String] ISO country code for localized pricing
|
|
510
|
+
# @param billing_country_code [String] ISO country code for localized pricing, or "eu" for the European Union group you
|
|
493
511
|
#
|
|
494
512
|
# @param block_size [Float] Block size for usage-based pricing
|
|
495
513
|
#
|
|
@@ -1443,7 +1461,8 @@ module Stigg
|
|
|
1443
1461
|
api_name: :billingPeriod
|
|
1444
1462
|
|
|
1445
1463
|
# @!attribute billing_country_code
|
|
1446
|
-
# ISO country code for localized pricing
|
|
1464
|
+
# ISO country code for localized pricing, or "eu" for the European Union group you
|
|
1465
|
+
# map countries into
|
|
1447
1466
|
#
|
|
1448
1467
|
# @return [String, nil]
|
|
1449
1468
|
optional :billing_country_code, String, api_name: :billingCountryCode
|
|
@@ -1486,11 +1505,15 @@ module Stigg
|
|
|
1486
1505
|
-> { Stigg::Internal::Type::ArrayOf[Stigg::V1::AddonUpdateParams::Charges::PricingModel::PricePeriod::Tier] }
|
|
1487
1506
|
|
|
1488
1507
|
# @!method initialize(billing_period:, billing_country_code: nil, block_size: nil, credit_grant_cadence: nil, credit_rate: nil, price: nil, tiers: nil)
|
|
1508
|
+
# Some parameter documentations has been truncated, see
|
|
1509
|
+
# {Stigg::Models::V1::AddonUpdateParams::Charges::PricingModel::PricePeriod} for
|
|
1510
|
+
# more details.
|
|
1511
|
+
#
|
|
1489
1512
|
# Price configuration for a specific billing period.
|
|
1490
1513
|
#
|
|
1491
1514
|
# @param billing_period [Symbol, Stigg::Models::V1::AddonUpdateParams::Charges::PricingModel::PricePeriod::BillingPeriod] The billing period (MONTHLY or ANNUALLY)
|
|
1492
1515
|
#
|
|
1493
|
-
# @param billing_country_code [String] ISO country code for localized pricing
|
|
1516
|
+
# @param billing_country_code [String] ISO country code for localized pricing, or "eu" for the European Union group you
|
|
1494
1517
|
#
|
|
1495
1518
|
# @param block_size [Float] Block size for usage-based pricing
|
|
1496
1519
|
#
|
|
@@ -14,15 +14,6 @@ module Stigg
|
|
|
14
14
|
# @return [String]
|
|
15
15
|
required :customer_id, String, api_name: :customerId
|
|
16
16
|
|
|
17
|
-
# @!attribute subscriptions
|
|
18
|
-
# The subscriptions to attach to the contract (must be non-empty). Each entry is
|
|
19
|
-
# either a new subscription to create or a reference to an existing custom
|
|
20
|
-
# subscription.
|
|
21
|
-
#
|
|
22
|
-
# @return [Array<Stigg::Models::V1::ContractCreateParams::Subscription>]
|
|
23
|
-
required :subscriptions,
|
|
24
|
-
-> { Stigg::Internal::Type::ArrayOf[Stigg::V1::ContractCreateParams::Subscription] }
|
|
25
|
-
|
|
26
17
|
# @!attribute activation_end_date
|
|
27
18
|
# Optional contract activation end date
|
|
28
19
|
#
|
|
@@ -35,6 +26,16 @@ module Stigg
|
|
|
35
26
|
# @return [Time, nil]
|
|
36
27
|
optional :activation_start_date, Time, api_name: :activationStartDate
|
|
37
28
|
|
|
29
|
+
# @!attribute contract_id
|
|
30
|
+
# Your own ID for the contract, which makes this call idempotent: sending the same
|
|
31
|
+
# one again returns the existing contract instead of creating a second. Omit it
|
|
32
|
+
# and one is generated for you, but then a retry cannot be told apart from a new
|
|
33
|
+
# contract — and contracts cannot be deleted. Recommended whenever a retry is
|
|
34
|
+
# possible, e.g. building a contract from an order form.
|
|
35
|
+
#
|
|
36
|
+
# @return [String, nil]
|
|
37
|
+
optional :contract_id, String, api_name: :contractId
|
|
38
|
+
|
|
38
39
|
# @!attribute name
|
|
39
40
|
# Optional contract name
|
|
40
41
|
#
|
|
@@ -55,6 +56,16 @@ module Stigg
|
|
|
55
56
|
# @return [Boolean, nil]
|
|
56
57
|
optional :setup_billing, Stigg::Internal::Type::Boolean, api_name: :setupBilling
|
|
57
58
|
|
|
59
|
+
# @!attribute subscriptions
|
|
60
|
+
# The subscriptions to attach to the contract. Each entry is either a new
|
|
61
|
+
# subscription to create or a reference to an existing custom subscription.
|
|
62
|
+
# Optional — omit it (or pass an empty list) to create a contract with no
|
|
63
|
+
# subscriptions and attach them later.
|
|
64
|
+
#
|
|
65
|
+
# @return [Array<Stigg::Models::V1::ContractCreateParams::Subscription>, nil]
|
|
66
|
+
optional :subscriptions,
|
|
67
|
+
-> { Stigg::Internal::Type::ArrayOf[Stigg::V1::ContractCreateParams::Subscription] }
|
|
68
|
+
|
|
58
69
|
# @!attribute x_account_id
|
|
59
70
|
#
|
|
60
71
|
# @return [String, nil]
|
|
@@ -65,24 +76,26 @@ module Stigg
|
|
|
65
76
|
# @return [String, nil]
|
|
66
77
|
optional :x_environment_id, String
|
|
67
78
|
|
|
68
|
-
# @!method initialize(customer_id:,
|
|
79
|
+
# @!method initialize(customer_id:, activation_end_date: nil, activation_start_date: nil, contract_id: nil, name: nil, po_number: nil, setup_billing: nil, subscriptions: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
|
|
69
80
|
# Some parameter documentations has been truncated, see
|
|
70
81
|
# {Stigg::Models::V1::ContractCreateParams} for more details.
|
|
71
82
|
#
|
|
72
83
|
# @param customer_id [String] The customer ref ID the contract belongs to
|
|
73
84
|
#
|
|
74
|
-
# @param subscriptions [Array<Stigg::Models::V1::ContractCreateParams::Subscription>] The subscriptions to attach to the contract (must be non-empty). Each entry is e
|
|
75
|
-
#
|
|
76
85
|
# @param activation_end_date [Time] Optional contract activation end date
|
|
77
86
|
#
|
|
78
87
|
# @param activation_start_date [Time] Optional contract activation start date
|
|
79
88
|
#
|
|
89
|
+
# @param contract_id [String] Your own ID for the contract, which makes this call idempotent: sending the same
|
|
90
|
+
#
|
|
80
91
|
# @param name [String, nil] Optional contract name
|
|
81
92
|
#
|
|
82
93
|
# @param po_number [String, nil] Optional purchase-order number
|
|
83
94
|
#
|
|
84
95
|
# @param setup_billing [Boolean] Whether to set up billing for the contract by creating a billing contract in the
|
|
85
96
|
#
|
|
97
|
+
# @param subscriptions [Array<Stigg::Models::V1::ContractCreateParams::Subscription>] The subscriptions to attach to the contract. Each entry is either a new subscrip
|
|
98
|
+
#
|
|
86
99
|
# @param x_account_id [String]
|
|
87
100
|
#
|
|
88
101
|
# @param x_environment_id [String]
|
|
@@ -159,7 +172,9 @@ module Stigg
|
|
|
159
172
|
api_name: :awaitPaymentConfirmation
|
|
160
173
|
|
|
161
174
|
# @!attribute billing_country_code
|
|
162
|
-
# The
|
|
175
|
+
# The country code used to select a localized price, or "eu" for the European
|
|
176
|
+
# Union group you map countries into, falling back to the default price when none
|
|
177
|
+
# matches
|
|
163
178
|
#
|
|
164
179
|
# @return [String, nil]
|
|
165
180
|
optional :billing_country_code, String, api_name: :billingCountryCode, nil?: true
|
|
@@ -233,7 +248,8 @@ module Stigg
|
|
|
233
248
|
-> { Stigg::Internal::Type::ArrayOf[union: Stigg::V1::ContractCreateParams::Subscription::NewSubscription::Entitlement] }
|
|
234
249
|
|
|
235
250
|
# @!attribute metadata
|
|
236
|
-
# Additional metadata for the subscription
|
|
251
|
+
# Additional metadata for the subscription, stored as an arbitrary flat key-value
|
|
252
|
+
# object.
|
|
237
253
|
#
|
|
238
254
|
# @return [Hash{Symbol=>String}, nil]
|
|
239
255
|
optional :metadata, Stigg::Internal::Type::HashOf[String]
|
|
@@ -317,6 +333,10 @@ module Stigg
|
|
|
317
333
|
optional :unit_quantity, Integer, api_name: :unitQuantity
|
|
318
334
|
|
|
319
335
|
# @!method initialize(customer_id:, plan_id:, id: nil, addons: nil, applied_coupon: nil, await_payment_confirmation: nil, billing_country_code: nil, billing_cycle_anchor: nil, billing_id: nil, billing_information: nil, billing_period: nil, budget: nil, cancellation_date: nil, charges: nil, checkout_options: nil, entitlements: nil, metadata: nil, minimum_spend: nil, paying_customer_id: nil, payment_collection_method: nil, price_overrides: nil, resource_id: nil, salesforce_id: nil, schedule_strategy: nil, start_date: nil, trial_override_configuration: nil, unit_quantity: nil)
|
|
336
|
+
# Some parameter documentations has been truncated, see
|
|
337
|
+
# {Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription} for
|
|
338
|
+
# more details.
|
|
339
|
+
#
|
|
320
340
|
# A new subscription to create, using the same body the provision-subscription
|
|
321
341
|
# endpoint accepts
|
|
322
342
|
#
|
|
@@ -332,7 +352,7 @@ module Stigg
|
|
|
332
352
|
#
|
|
333
353
|
# @param await_payment_confirmation [Boolean] Whether to wait for payment confirmation before returning the subscription
|
|
334
354
|
#
|
|
335
|
-
# @param billing_country_code [String, nil] The
|
|
355
|
+
# @param billing_country_code [String, nil] The country code used to select a localized price, or "eu" for the European Unio
|
|
336
356
|
#
|
|
337
357
|
# @param billing_cycle_anchor [Symbol, Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::BillingCycleAnchor] Billing cycle anchor behavior for the subscription
|
|
338
358
|
#
|
|
@@ -352,7 +372,7 @@ module Stigg
|
|
|
352
372
|
#
|
|
353
373
|
# @param entitlements [Array<Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::Entitlement::Feature, Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::Entitlement::Credit>]
|
|
354
374
|
#
|
|
355
|
-
# @param metadata [Hash{Symbol=>String}] Additional metadata for the subscription
|
|
375
|
+
# @param metadata [Hash{Symbol=>String}] Additional metadata for the subscription, stored as an arbitrary flat key-value
|
|
356
376
|
#
|
|
357
377
|
# @param minimum_spend [Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::MinimumSpend, nil] Minimum spend amount
|
|
358
378
|
#
|
|
@@ -711,7 +731,8 @@ module Stigg
|
|
|
711
731
|
optional :is_invoice_paid, Stigg::Internal::Type::Boolean, api_name: :isInvoicePaid
|
|
712
732
|
|
|
713
733
|
# @!attribute metadata
|
|
714
|
-
# Additional metadata for the subscription
|
|
734
|
+
# Additional metadata for the subscription, stored as an arbitrary flat key-value
|
|
735
|
+
# object.
|
|
715
736
|
#
|
|
716
737
|
# @return [Hash{Symbol=>String}, nil]
|
|
717
738
|
optional :metadata, Stigg::Internal::Type::HashOf[String]
|
|
@@ -749,6 +770,10 @@ module Stigg
|
|
|
749
770
|
optional :tax_rate_ids, Stigg::Internal::Type::ArrayOf[String], api_name: :taxRateIds
|
|
750
771
|
|
|
751
772
|
# @!method initialize(billing_address: nil, charge_on_behalf_of_account: nil, integration_id: nil, invoice_days_until_due: nil, is_backdated: nil, is_invoice_paid: nil, metadata: nil, proration_behavior: nil, tax_ids: nil, tax_percentage: nil, tax_rate_ids: nil)
|
|
773
|
+
# Some parameter documentations has been truncated, see
|
|
774
|
+
# {Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::BillingInformation}
|
|
775
|
+
# for more details.
|
|
776
|
+
#
|
|
752
777
|
# @param billing_address [Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::BillingInformation::BillingAddress] Billing address for the subscription
|
|
753
778
|
#
|
|
754
779
|
# @param charge_on_behalf_of_account [String, nil] Stripe Connect account to charge on behalf of
|
|
@@ -761,7 +786,7 @@ module Stigg
|
|
|
761
786
|
#
|
|
762
787
|
# @param is_invoice_paid [Boolean] Whether the invoice is marked as paid
|
|
763
788
|
#
|
|
764
|
-
# @param metadata [Hash{Symbol=>String}] Additional metadata for the subscription
|
|
789
|
+
# @param metadata [Hash{Symbol=>String}] Additional metadata for the subscription, stored as an arbitrary flat key-value
|
|
765
790
|
#
|
|
766
791
|
# @param proration_behavior [Symbol, Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::BillingInformation::ProrationBehavior] How to handle proration for billing changes
|
|
767
792
|
#
|
|
@@ -1242,7 +1267,13 @@ module Stigg
|
|
|
1242
1267
|
# @return [Symbol, :CREDIT]
|
|
1243
1268
|
required :type, const: :CREDIT
|
|
1244
1269
|
|
|
1245
|
-
# @!
|
|
1270
|
+
# @!attribute has_soft_limit
|
|
1271
|
+
# Whether the credit balance is a soft limit
|
|
1272
|
+
#
|
|
1273
|
+
# @return [Boolean, nil]
|
|
1274
|
+
optional :has_soft_limit, Stigg::Internal::Type::Boolean, api_name: :hasSoftLimit
|
|
1275
|
+
|
|
1276
|
+
# @!method initialize(id:, amount:, cadence:, has_soft_limit: nil, type: :CREDIT)
|
|
1246
1277
|
# Credit entitlement configuration for a subscription
|
|
1247
1278
|
#
|
|
1248
1279
|
# @param id [String] The custom currency ID for the credit entitlement
|
|
@@ -1251,6 +1282,8 @@ module Stigg
|
|
|
1251
1282
|
#
|
|
1252
1283
|
# @param cadence [Symbol, Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::Entitlement::Credit::Cadence] Credit grant cadence (MONTH or YEAR)
|
|
1253
1284
|
#
|
|
1285
|
+
# @param has_soft_limit [Boolean] Whether the credit balance is a soft limit
|
|
1286
|
+
#
|
|
1254
1287
|
# @param type [Symbol, :CREDIT] SubscriptionCreditEntitlementRequest
|
|
1255
1288
|
|
|
1256
1289
|
# Credit grant cadence (MONTH or YEAR)
|
|
@@ -1455,7 +1488,10 @@ module Stigg
|
|
|
1455
1488
|
optional :base_charge, Stigg::Internal::Type::Boolean, api_name: :baseCharge
|
|
1456
1489
|
|
|
1457
1490
|
# @!attribute billing_country_code
|
|
1458
|
-
#
|
|
1491
|
+
# ISO 3166-1 alpha-2 country code this price applies to, or "eu" for the European
|
|
1492
|
+
# Union group you map countries into. Omit for the default price shown to all
|
|
1493
|
+
# countries; set one or more country-specific price periods on the same currency
|
|
1494
|
+
# to localize the amount by billing country.
|
|
1459
1495
|
#
|
|
1460
1496
|
# @return [String, nil]
|
|
1461
1497
|
optional :billing_country_code, String, api_name: :billingCountryCode
|
|
@@ -1505,13 +1541,17 @@ module Stigg
|
|
|
1505
1541
|
-> { Stigg::Internal::Type::ArrayOf[Stigg::V1::ContractCreateParams::Subscription::NewSubscription::PriceOverride::Tier] }
|
|
1506
1542
|
|
|
1507
1543
|
# @!method initialize(addon_id: nil, amount: nil, base_charge: nil, billing_country_code: nil, block_size: nil, credit_grant_cadence: nil, credit_rate: nil, currency: nil, feature_id: nil, tiers: nil)
|
|
1544
|
+
# Some parameter documentations has been truncated, see
|
|
1545
|
+
# {Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::PriceOverride}
|
|
1546
|
+
# for more details.
|
|
1547
|
+
#
|
|
1508
1548
|
# @param addon_id [String, nil] Addon identifier for the price override
|
|
1509
1549
|
#
|
|
1510
1550
|
# @param amount [Float] The price amount
|
|
1511
1551
|
#
|
|
1512
1552
|
# @param base_charge [Boolean] Whether this is a base charge override
|
|
1513
1553
|
#
|
|
1514
|
-
# @param billing_country_code [String]
|
|
1554
|
+
# @param billing_country_code [String] ISO 3166-1 alpha-2 country code this price applies to, or "eu" for the European
|
|
1515
1555
|
#
|
|
1516
1556
|
# @param block_size [Float] Block size for pricing
|
|
1517
1557
|
#
|
|
@@ -309,6 +309,12 @@ module Stigg
|
|
|
309
309
|
# @return [Time, nil]
|
|
310
310
|
required :due_date, Time, api_name: :dueDate, nil?: true
|
|
311
311
|
|
|
312
|
+
# @!attribute invoice_id
|
|
313
|
+
# The billing provider ID of the draft invoice this preview describes
|
|
314
|
+
#
|
|
315
|
+
# @return [String, nil]
|
|
316
|
+
required :invoice_id, String, api_name: :invoiceId, nil?: true
|
|
317
|
+
|
|
312
318
|
# @!attribute period_end
|
|
313
319
|
# The end of the billing period the upcoming invoice covers
|
|
314
320
|
#
|
|
@@ -321,13 +327,15 @@ module Stigg
|
|
|
321
327
|
# @return [Time, nil]
|
|
322
328
|
required :period_start, Time, api_name: :periodStart, nil?: true
|
|
323
329
|
|
|
324
|
-
# @!method initialize(amount:, due_date:, period_end:, period_start:)
|
|
330
|
+
# @!method initialize(amount:, due_date:, invoice_id:, period_end:, period_start:)
|
|
325
331
|
# A preview of the contract's upcoming invoice, or null when none is available
|
|
326
332
|
#
|
|
327
333
|
# @param amount [Stigg::Models::V1::ContractCreateResponse::Data::NextInvoice::Amount] The total amount of the upcoming invoice
|
|
328
334
|
#
|
|
329
335
|
# @param due_date [Time, nil] The date the upcoming invoice is due
|
|
330
336
|
#
|
|
337
|
+
# @param invoice_id [String, nil] The billing provider ID of the draft invoice this preview describes
|
|
338
|
+
#
|
|
331
339
|
# @param period_end [Time, nil] The end of the billing period the upcoming invoice covers
|
|
332
340
|
#
|
|
333
341
|
# @param period_start [Time, nil] The start of the billing period the upcoming invoice covers
|
|
@@ -309,6 +309,12 @@ module Stigg
|
|
|
309
309
|
# @return [Time, nil]
|
|
310
310
|
required :due_date, Time, api_name: :dueDate, nil?: true
|
|
311
311
|
|
|
312
|
+
# @!attribute invoice_id
|
|
313
|
+
# The billing provider ID of the draft invoice this preview describes
|
|
314
|
+
#
|
|
315
|
+
# @return [String, nil]
|
|
316
|
+
required :invoice_id, String, api_name: :invoiceId, nil?: true
|
|
317
|
+
|
|
312
318
|
# @!attribute period_end
|
|
313
319
|
# The end of the billing period the upcoming invoice covers
|
|
314
320
|
#
|
|
@@ -321,13 +327,15 @@ module Stigg
|
|
|
321
327
|
# @return [Time, nil]
|
|
322
328
|
required :period_start, Time, api_name: :periodStart, nil?: true
|
|
323
329
|
|
|
324
|
-
# @!method initialize(amount:, due_date:, period_end:, period_start:)
|
|
330
|
+
# @!method initialize(amount:, due_date:, invoice_id:, period_end:, period_start:)
|
|
325
331
|
# A preview of the contract's upcoming invoice, or null when none is available
|
|
326
332
|
#
|
|
327
333
|
# @param amount [Stigg::Models::V1::ContractDeleteResponse::Data::NextInvoice::Amount] The total amount of the upcoming invoice
|
|
328
334
|
#
|
|
329
335
|
# @param due_date [Time, nil] The date the upcoming invoice is due
|
|
330
336
|
#
|
|
337
|
+
# @param invoice_id [String, nil] The billing provider ID of the draft invoice this preview describes
|
|
338
|
+
#
|
|
331
339
|
# @param period_end [Time, nil] The end of the billing period the upcoming invoice covers
|
|
332
340
|
#
|
|
333
341
|
# @param period_start [Time, nil] The start of the billing period the upcoming invoice covers
|
|
@@ -296,6 +296,12 @@ module Stigg
|
|
|
296
296
|
# @return [Time, nil]
|
|
297
297
|
required :due_date, Time, api_name: :dueDate, nil?: true
|
|
298
298
|
|
|
299
|
+
# @!attribute invoice_id
|
|
300
|
+
# The billing provider ID of the draft invoice this preview describes
|
|
301
|
+
#
|
|
302
|
+
# @return [String, nil]
|
|
303
|
+
required :invoice_id, String, api_name: :invoiceId, nil?: true
|
|
304
|
+
|
|
299
305
|
# @!attribute period_end
|
|
300
306
|
# The end of the billing period the upcoming invoice covers
|
|
301
307
|
#
|
|
@@ -308,13 +314,15 @@ module Stigg
|
|
|
308
314
|
# @return [Time, nil]
|
|
309
315
|
required :period_start, Time, api_name: :periodStart, nil?: true
|
|
310
316
|
|
|
311
|
-
# @!method initialize(amount:, due_date:, period_end:, period_start:)
|
|
317
|
+
# @!method initialize(amount:, due_date:, invoice_id:, period_end:, period_start:)
|
|
312
318
|
# A preview of the contract's upcoming invoice, or null when none is available
|
|
313
319
|
#
|
|
314
320
|
# @param amount [Stigg::Models::V1::ContractListResponse::NextInvoice::Amount] The total amount of the upcoming invoice
|
|
315
321
|
#
|
|
316
322
|
# @param due_date [Time, nil] The date the upcoming invoice is due
|
|
317
323
|
#
|
|
324
|
+
# @param invoice_id [String, nil] The billing provider ID of the draft invoice this preview describes
|
|
325
|
+
#
|
|
318
326
|
# @param period_end [Time, nil] The end of the billing period the upcoming invoice covers
|
|
319
327
|
#
|
|
320
328
|
# @param period_start [Time, nil] The start of the billing period the upcoming invoice covers
|