stigg 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.3
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 +8 -0
- data/README.md +1 -1
- data/lib/stigg/internal/type/base_model.rb +2 -2
- data/lib/stigg/models/v1/{coupon_create_response.rb → coupon.rb} +24 -24
- data/lib/stigg/models/v1/customer_import_params.rb +75 -0
- data/lib/stigg/models/v1/customer_import_response.rb +35 -0
- data/lib/stigg/models/v1/{customer_create_params.rb → customer_provision_params.rb} +16 -16
- data/lib/stigg/models/v1/customer_response.rb +1 -1
- data/lib/stigg/models/v1/customers/promotional_entitlement_grant_params.rb +296 -0
- data/lib/stigg/models/v1/customers/promotional_entitlement_grant_response.rb +341 -0
- data/lib/stigg/models/v1/customers/promotional_entitlement_revoke_params.rb +24 -0
- data/lib/stigg/models/v1/customers/promotional_entitlement_revoke_response.rb +342 -0
- data/lib/stigg/models/v1/event_report_params.rb +91 -0
- data/lib/stigg/models/v1/event_report_response.rb +25 -0
- data/lib/stigg/models/v1/{subscription_retrieve_response.rb → subscription.rb} +30 -29
- data/lib/stigg/models/v1/subscription_cancel_params.rb +75 -0
- data/lib/stigg/models/v1/subscription_import_params.rb +92 -0
- data/lib/stigg/models/v1/subscription_import_response.rb +32 -0
- data/lib/stigg/models/v1/{subscription_create_params.rb → subscription_provision_params.rb} +118 -118
- data/lib/stigg/models/v1/{subscription_create_response.rb → subscription_provision_response.rb} +76 -75
- data/lib/stigg/models/v1/subscription_update_params.rb +1114 -0
- data/lib/stigg/models/v1/subscriptions/{future_update_cancel_pending_payment_response.rb → cancel_subscription.rb} +7 -5
- data/lib/stigg/models/v1/usage_history_params.rb +54 -0
- data/lib/stigg/models/v1/usage_history_response.rb +155 -0
- data/lib/stigg/models/v1/usage_report_params.rb +114 -0
- data/lib/stigg/models/v1/usage_report_response.rb +120 -0
- data/lib/stigg/models.rb +0 -4
- data/lib/stigg/resources/v1/coupons.rb +4 -4
- data/lib/stigg/resources/v1/customers/promotional_entitlements.rb +69 -0
- data/lib/stigg/resources/v1/customers.rb +59 -37
- data/lib/stigg/resources/v1/events.rb +38 -0
- data/lib/stigg/resources/v1/subscriptions/future_update.rb +4 -4
- data/lib/stigg/resources/v1/subscriptions.rb +166 -64
- data/lib/stigg/resources/v1/usage.rb +79 -0
- data/lib/stigg/resources/v1.rb +6 -42
- data/lib/stigg/version.rb +1 -1
- data/lib/stigg.rb +25 -16
- data/rbi/stigg/models/v1/{coupon_create_response.rbi → coupon.rbi} +156 -252
- data/rbi/stigg/models/v1/customer_import_params.rbi +130 -0
- data/rbi/stigg/models/v1/customer_import_response.rbi +76 -0
- data/rbi/stigg/models/v1/{customer_create_params.rbi → customer_provision_params.rbi} +35 -35
- data/rbi/stigg/models/v1/customers/promotional_entitlement_grant_params.rbi +640 -0
- data/rbi/stigg/models/v1/customers/promotional_entitlement_grant_response.rbi +690 -0
- data/rbi/stigg/models/v1/customers/promotional_entitlement_revoke_params.rbi +42 -0
- data/rbi/stigg/models/v1/customers/promotional_entitlement_revoke_response.rbi +696 -0
- data/rbi/stigg/models/v1/event_report_params.rbi +168 -0
- data/rbi/stigg/models/v1/event_report_response.rbi +35 -0
- data/rbi/stigg/models/v1/{subscription_migrate_response.rbi → subscription.rbi} +66 -117
- data/rbi/stigg/models/v1/subscription_cancel_params.rbi +182 -0
- data/rbi/stigg/models/v1/subscription_import_params.rbi +148 -0
- data/rbi/stigg/models/v1/subscription_import_response.rbi +69 -0
- data/rbi/stigg/models/v1/{subscription_create_params.rbi → subscription_provision_params.rbi} +794 -773
- data/rbi/stigg/models/v1/{subscription_create_response.rbi → subscription_provision_response.rbi} +481 -481
- data/rbi/stigg/models/v1/subscription_update_params.rbi +3578 -0
- data/rbi/stigg/models/v1/subscriptions/{future_update_cancel_schedule_response.rbi → cancel_subscription.rbi} +9 -16
- data/rbi/stigg/models/v1/usage_history_params.rbi +79 -0
- data/rbi/stigg/models/v1/usage_history_response.rbi +347 -0
- data/rbi/stigg/models/v1/usage_report_params.rbi +227 -0
- data/rbi/stigg/models/v1/usage_report_response.rbi +162 -0
- data/rbi/stigg/models.rbi +0 -4
- data/rbi/stigg/resources/v1/coupons.rbi +2 -2
- data/rbi/stigg/resources/v1/customers/promotional_entitlements.rbi +57 -0
- data/rbi/stigg/resources/v1/customers.rbi +53 -36
- data/rbi/stigg/resources/v1/events.rbi +28 -0
- data/rbi/stigg/resources/v1/subscriptions/future_update.rbi +2 -6
- data/rbi/stigg/resources/v1/subscriptions.rbi +179 -74
- data/rbi/stigg/resources/v1/usage.rbi +57 -0
- data/rbi/stigg/resources/v1.rbi +4 -26
- data/sig/stigg/models/v1/{coupon_create_response.rbs → coupon.rbs} +29 -32
- data/sig/stigg/models/v1/customer_import_params.rbs +74 -0
- data/sig/stigg/models/v1/customer_import_response.rbs +30 -0
- data/sig/stigg/models/v1/{customer_create_params.rbs → customer_provision_params.rbs} +22 -22
- data/sig/stigg/models/v1/customers/promotional_entitlement_grant_params.rbs +234 -0
- data/sig/stigg/models/v1/customers/promotional_entitlement_grant_response.rbs +281 -0
- data/sig/stigg/models/v1/customers/promotional_entitlement_revoke_params.rbs +27 -0
- data/sig/stigg/models/v1/customers/promotional_entitlement_revoke_response.rbs +281 -0
- data/sig/stigg/models/v1/event_report_params.rbs +82 -0
- data/sig/stigg/models/v1/event_report_response.rbs +15 -0
- data/sig/stigg/models/v1/{subscription_retrieve_response.rbs → subscription.rbs} +36 -41
- data/sig/stigg/models/v1/subscription_cancel_params.rbs +79 -0
- data/sig/stigg/models/v1/subscription_import_params.rbs +84 -0
- data/sig/stigg/models/v1/subscription_import_response.rbs +30 -0
- data/sig/stigg/models/v1/{subscription_create_params.rbs → subscription_provision_params.rbs} +200 -200
- data/sig/stigg/models/v1/{subscription_create_response.rbs → subscription_provision_response.rbs} +106 -106
- data/sig/stigg/models/v1/subscription_update_params.rbs +1544 -0
- data/sig/stigg/models/v1/subscriptions/cancel_subscription.rbs +34 -0
- data/sig/stigg/models/v1/usage_history_params.rbs +52 -0
- data/sig/stigg/models/v1/usage_history_response.rbs +129 -0
- data/sig/stigg/models/v1/usage_report_params.rbs +102 -0
- data/sig/stigg/models/v1/usage_report_response.rbs +87 -0
- data/sig/stigg/models.rbs +0 -4
- data/sig/stigg/resources/v1/coupons.rbs +2 -2
- data/sig/stigg/resources/v1/customers/promotional_entitlements.rbs +23 -0
- data/sig/stigg/resources/v1/customers.rbs +17 -12
- data/sig/stigg/resources/v1/events.rbs +14 -0
- data/sig/stigg/resources/v1/subscriptions/future_update.rbs +2 -2
- data/sig/stigg/resources/v1/subscriptions.rbs +65 -32
- data/sig/stigg/resources/v1/usage.rbs +24 -0
- data/sig/stigg/resources/v1.rbs +2 -8
- metadata +77 -50
- data/lib/stigg/models/v1/coupon_retrieve_response.rb +0 -322
- data/lib/stigg/models/v1/subscription_delegate_response.rb +0 -314
- data/lib/stigg/models/v1/subscription_migrate_response.rb +0 -314
- data/lib/stigg/models/v1/subscription_transfer_response.rb +0 -314
- data/lib/stigg/models/v1/subscriptions/future_update_cancel_schedule_response.rb +0 -34
- data/lib/stigg/models/v1_create_event_params.rb +0 -89
- data/lib/stigg/models/v1_create_event_response.rb +0 -23
- data/lib/stigg/models/v1_create_usage_params.rb +0 -112
- data/lib/stigg/models/v1_create_usage_response.rb +0 -118
- data/lib/stigg/resources/v1/customers/usage.rb +0 -18
- data/rbi/stigg/models/v1/coupon_retrieve_response.rbi +0 -987
- data/rbi/stigg/models/v1/subscription_delegate_response.rbi +0 -618
- data/rbi/stigg/models/v1/subscription_retrieve_response.rbi +0 -618
- data/rbi/stigg/models/v1/subscription_transfer_response.rbi +0 -618
- data/rbi/stigg/models/v1/subscriptions/future_update_cancel_pending_payment_response.rbi +0 -80
- data/rbi/stigg/models/v1_create_event_params.rbi +0 -161
- data/rbi/stigg/models/v1_create_event_response.rbi +0 -30
- data/rbi/stigg/models/v1_create_usage_params.rbi +0 -217
- data/rbi/stigg/models/v1_create_usage_response.rbi +0 -157
- data/rbi/stigg/resources/v1/customers/usage.rbi +0 -16
- data/sig/stigg/models/v1/coupon_retrieve_response.rbs +0 -394
- data/sig/stigg/models/v1/subscription_delegate_response.rbs +0 -255
- data/sig/stigg/models/v1/subscription_migrate_response.rbs +0 -255
- data/sig/stigg/models/v1/subscription_transfer_response.rbs +0 -255
- data/sig/stigg/models/v1/subscriptions/future_update_cancel_pending_payment_response.rbs +0 -34
- data/sig/stigg/models/v1/subscriptions/future_update_cancel_schedule_response.rbs +0 -34
- data/sig/stigg/models/v1_create_event_params.rbs +0 -80
- data/sig/stigg/models/v1_create_event_response.rbs +0 -13
- data/sig/stigg/models/v1_create_usage_params.rbs +0 -100
- data/sig/stigg/models/v1_create_usage_response.rbs +0 -85
- data/sig/stigg/resources/v1/customers/usage.rbs +0 -11
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Stigg
|
|
4
|
+
module Models
|
|
5
|
+
module V1
|
|
6
|
+
# @see Stigg::Resources::V1::Subscriptions#cancel
|
|
7
|
+
class SubscriptionCancelParams < Stigg::Internal::Type::BaseModel
|
|
8
|
+
extend Stigg::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Stigg::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute cancellation_action
|
|
12
|
+
# Action on cancellation (downgrade or revoke)
|
|
13
|
+
#
|
|
14
|
+
# @return [Symbol, Stigg::Models::V1::SubscriptionCancelParams::CancellationAction, nil]
|
|
15
|
+
optional :cancellation_action,
|
|
16
|
+
enum: -> { Stigg::V1::SubscriptionCancelParams::CancellationAction },
|
|
17
|
+
api_name: :cancellationAction
|
|
18
|
+
|
|
19
|
+
# @!attribute cancellation_time
|
|
20
|
+
# When to cancel (immediate, period end, or date)
|
|
21
|
+
#
|
|
22
|
+
# @return [Symbol, Stigg::Models::V1::SubscriptionCancelParams::CancellationTime, nil]
|
|
23
|
+
optional :cancellation_time,
|
|
24
|
+
enum: -> { Stigg::V1::SubscriptionCancelParams::CancellationTime },
|
|
25
|
+
api_name: :cancellationTime
|
|
26
|
+
|
|
27
|
+
# @!attribute end_date
|
|
28
|
+
# Subscription end date
|
|
29
|
+
#
|
|
30
|
+
# @return [Time, nil]
|
|
31
|
+
optional :end_date, Time, api_name: :endDate
|
|
32
|
+
|
|
33
|
+
# @!attribute prorate
|
|
34
|
+
# If set, enables or disables prorating of credits on subscription cancellation.
|
|
35
|
+
#
|
|
36
|
+
# @return [Boolean, nil]
|
|
37
|
+
optional :prorate, Stigg::Internal::Type::Boolean
|
|
38
|
+
|
|
39
|
+
# @!method initialize(cancellation_action: nil, cancellation_time: nil, end_date: nil, prorate: nil, request_options: {})
|
|
40
|
+
# @param cancellation_action [Symbol, Stigg::Models::V1::SubscriptionCancelParams::CancellationAction] Action on cancellation (downgrade or revoke)
|
|
41
|
+
#
|
|
42
|
+
# @param cancellation_time [Symbol, Stigg::Models::V1::SubscriptionCancelParams::CancellationTime] When to cancel (immediate, period end, or date)
|
|
43
|
+
#
|
|
44
|
+
# @param end_date [Time] Subscription end date
|
|
45
|
+
#
|
|
46
|
+
# @param prorate [Boolean] If set, enables or disables prorating of credits on subscription cancellation.
|
|
47
|
+
#
|
|
48
|
+
# @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
|
|
49
|
+
|
|
50
|
+
# Action on cancellation (downgrade or revoke)
|
|
51
|
+
module CancellationAction
|
|
52
|
+
extend Stigg::Internal::Type::Enum
|
|
53
|
+
|
|
54
|
+
DEFAULT = :DEFAULT
|
|
55
|
+
REVOKE_ENTITLEMENTS = :REVOKE_ENTITLEMENTS
|
|
56
|
+
|
|
57
|
+
# @!method self.values
|
|
58
|
+
# @return [Array<Symbol>]
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
# When to cancel (immediate, period end, or date)
|
|
62
|
+
module CancellationTime
|
|
63
|
+
extend Stigg::Internal::Type::Enum
|
|
64
|
+
|
|
65
|
+
END_OF_BILLING_PERIOD = :END_OF_BILLING_PERIOD
|
|
66
|
+
IMMEDIATE = :IMMEDIATE
|
|
67
|
+
SPECIFIC_DATE = :SPECIFIC_DATE
|
|
68
|
+
|
|
69
|
+
# @!method self.values
|
|
70
|
+
# @return [Array<Symbol>]
|
|
71
|
+
end
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
end
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Stigg
|
|
4
|
+
module Models
|
|
5
|
+
module V1
|
|
6
|
+
# @see Stigg::Resources::V1::Subscriptions#import
|
|
7
|
+
class SubscriptionImportParams < Stigg::Internal::Type::BaseModel
|
|
8
|
+
extend Stigg::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Stigg::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute subscriptions
|
|
12
|
+
# List of subscription objects to import
|
|
13
|
+
#
|
|
14
|
+
# @return [Array<Stigg::Models::V1::SubscriptionImportParams::Subscription>]
|
|
15
|
+
required :subscriptions,
|
|
16
|
+
-> { Stigg::Internal::Type::ArrayOf[Stigg::V1::SubscriptionImportParams::Subscription] }
|
|
17
|
+
|
|
18
|
+
# @!method initialize(subscriptions:, request_options: {})
|
|
19
|
+
# @param subscriptions [Array<Stigg::Models::V1::SubscriptionImportParams::Subscription>] List of subscription objects to import
|
|
20
|
+
#
|
|
21
|
+
# @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
|
|
22
|
+
|
|
23
|
+
class Subscription < Stigg::Internal::Type::BaseModel
|
|
24
|
+
# @!attribute id
|
|
25
|
+
# Subscription ID
|
|
26
|
+
#
|
|
27
|
+
# @return [String]
|
|
28
|
+
required :id, String
|
|
29
|
+
|
|
30
|
+
# @!attribute customer_id
|
|
31
|
+
# Customer ID
|
|
32
|
+
#
|
|
33
|
+
# @return [String]
|
|
34
|
+
required :customer_id, String, api_name: :customerId
|
|
35
|
+
|
|
36
|
+
# @!attribute plan_id
|
|
37
|
+
# Plan ID
|
|
38
|
+
#
|
|
39
|
+
# @return [String]
|
|
40
|
+
required :plan_id, String, api_name: :planId
|
|
41
|
+
|
|
42
|
+
# @!attribute billing_id
|
|
43
|
+
# Billing ID
|
|
44
|
+
#
|
|
45
|
+
# @return [String, nil]
|
|
46
|
+
optional :billing_id, String, api_name: :billingId, nil?: true
|
|
47
|
+
|
|
48
|
+
# @!attribute end_date
|
|
49
|
+
# Subscription end date
|
|
50
|
+
#
|
|
51
|
+
# @return [Time, nil]
|
|
52
|
+
optional :end_date, Time, api_name: :endDate, nil?: true
|
|
53
|
+
|
|
54
|
+
# @!attribute metadata
|
|
55
|
+
# Additional metadata for the subscription
|
|
56
|
+
#
|
|
57
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
58
|
+
optional :metadata, Stigg::Internal::Type::HashOf[String]
|
|
59
|
+
|
|
60
|
+
# @!attribute resource_id
|
|
61
|
+
# Resource ID
|
|
62
|
+
#
|
|
63
|
+
# @return [String, nil]
|
|
64
|
+
optional :resource_id, String, api_name: :resourceId, nil?: true
|
|
65
|
+
|
|
66
|
+
# @!attribute start_date
|
|
67
|
+
# Subscription start date
|
|
68
|
+
#
|
|
69
|
+
# @return [Time, nil]
|
|
70
|
+
optional :start_date, Time, api_name: :startDate
|
|
71
|
+
|
|
72
|
+
# @!method initialize(id:, customer_id:, plan_id:, billing_id: nil, end_date: nil, metadata: nil, resource_id: nil, start_date: nil)
|
|
73
|
+
# @param id [String] Subscription ID
|
|
74
|
+
#
|
|
75
|
+
# @param customer_id [String] Customer ID
|
|
76
|
+
#
|
|
77
|
+
# @param plan_id [String] Plan ID
|
|
78
|
+
#
|
|
79
|
+
# @param billing_id [String, nil] Billing ID
|
|
80
|
+
#
|
|
81
|
+
# @param end_date [Time, nil] Subscription end date
|
|
82
|
+
#
|
|
83
|
+
# @param metadata [Hash{Symbol=>String}] Additional metadata for the subscription
|
|
84
|
+
#
|
|
85
|
+
# @param resource_id [String, nil] Resource ID
|
|
86
|
+
#
|
|
87
|
+
# @param start_date [Time] Subscription start date
|
|
88
|
+
end
|
|
89
|
+
end
|
|
90
|
+
end
|
|
91
|
+
end
|
|
92
|
+
end
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Stigg
|
|
4
|
+
module Models
|
|
5
|
+
module V1
|
|
6
|
+
# @see Stigg::Resources::V1::Subscriptions#import
|
|
7
|
+
class SubscriptionImportResponse < Stigg::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute data
|
|
9
|
+
#
|
|
10
|
+
# @return [Stigg::Models::V1::SubscriptionImportResponse::Data]
|
|
11
|
+
required :data, -> { Stigg::Models::V1::SubscriptionImportResponse::Data }
|
|
12
|
+
|
|
13
|
+
# @!method initialize(data:)
|
|
14
|
+
# Response object
|
|
15
|
+
#
|
|
16
|
+
# @param data [Stigg::Models::V1::SubscriptionImportResponse::Data]
|
|
17
|
+
|
|
18
|
+
# @see Stigg::Models::V1::SubscriptionImportResponse#data
|
|
19
|
+
class Data < Stigg::Internal::Type::BaseModel
|
|
20
|
+
# @!attribute task_id
|
|
21
|
+
# Unique identifier for the import task
|
|
22
|
+
#
|
|
23
|
+
# @return [String]
|
|
24
|
+
required :task_id, String, api_name: :taskId
|
|
25
|
+
|
|
26
|
+
# @!method initialize(task_id:)
|
|
27
|
+
# @param task_id [String] Unique identifier for the import task
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
end
|