stigg 0.1.0.pre.alpha.1 → 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 +22 -0
- data/README.md +29 -1
- data/lib/stigg/internal/my_cursor_id_page.rb +32 -4
- data/lib/stigg/internal/type/base_model.rb +2 -2
- data/lib/stigg/models/v1/{coupon_create_response.rb → coupon.rb} +31 -26
- data/lib/stigg/models/v1/coupon_create_params.rb +2 -0
- data/lib/stigg/models/v1/coupon_list_params.rb +14 -14
- data/lib/stigg/models/v1/coupon_list_response.rb +262 -278
- 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_list_params.rb +14 -14
- data/lib/stigg/models/v1/customer_list_response.rb +160 -174
- data/lib/stigg/models/v1/{customer_create_params.rb → customer_provision_params.rb} +18 -16
- data/lib/stigg/models/v1/customer_response.rb +9 -2
- data/lib/stigg/models/v1/customer_update_params.rb +2 -0
- data/lib/stigg/models/v1/customers/payment_method_attach_params.rb +3 -1
- data/lib/stigg/models/v1/customers/{promotional_create_params.rb → promotional_entitlement_grant_params.rb} +46 -44
- data/lib/stigg/models/v1/customers/{promotional_create_response.rb → promotional_entitlement_grant_response.rb} +105 -32
- data/lib/stigg/models/v1/customers/{promotional_revoke_params.rb → promotional_entitlement_revoke_params.rb} +2 -2
- data/lib/stigg/models/v1/customers/{promotional_revoke_response.rb → promotional_entitlement_revoke_response.rb} +107 -33
- 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} +67 -26
- data/lib/stigg/models/v1/subscription_cancel_params.rb +75 -0
- data/lib/stigg/models/v1/subscription_delegate_params.rb +7 -2
- 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_list_params.rb +20 -24
- data/lib/stigg/models/v1/subscription_list_response.rb +255 -236
- data/lib/stigg/models/v1/subscription_migrate_params.rb +3 -3
- data/lib/stigg/models/v1/subscription_preview_params.rb +139 -46
- data/lib/stigg/models/v1/subscription_preview_response.rb +164 -49
- data/lib/stigg/models/v1/subscription_provision_params.rb +1693 -0
- data/lib/stigg/models/v1/subscription_provision_response.rb +1038 -0
- data/lib/stigg/models/v1/subscription_transfer_params.rb +2 -6
- 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} +9 -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 +16 -14
- data/lib/stigg/resources/v1/customers/payment_method.rb +6 -5
- data/lib/stigg/resources/v1/customers/{promotional.rb → promotional_entitlements.rb} +17 -17
- data/lib/stigg/resources/v1/customers.rb +78 -56
- data/lib/stigg/resources/v1/events.rb +38 -0
- data/lib/stigg/resources/v1/subscriptions/future_update.rb +10 -8
- data/lib/stigg/resources/v1/subscriptions.rb +206 -79
- 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 -23
- data/rbi/stigg/internal/my_cursor_id_page.rbi +27 -0
- data/rbi/stigg/models/v1/coupon.rbi +891 -0
- data/rbi/stigg/models/v1/coupon_create_params.rbi +1 -0
- data/rbi/stigg/models/v1/coupon_list_params.rbi +21 -21
- data/rbi/stigg/models/v1/coupon_list_response.rbi +812 -869
- 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_list_params.rbi +21 -21
- data/rbi/stigg/models/v1/customer_list_response.rbi +307 -347
- data/rbi/stigg/models/v1/{customer_create_params.rbi → customer_provision_params.rbi} +36 -35
- data/rbi/stigg/models/v1/customer_response.rbi +8 -1
- data/rbi/stigg/models/v1/customer_update_params.rbi +1 -0
- data/rbi/stigg/models/v1/customers/payment_method_attach_params.rbi +3 -0
- data/rbi/stigg/models/v1/customers/{promotional_create_params.rbi → promotional_entitlement_grant_params.rbi} +78 -77
- data/rbi/stigg/models/v1/customers/promotional_entitlement_grant_response.rbi +690 -0
- data/rbi/stigg/models/v1/customers/{promotional_revoke_params.rbi → promotional_entitlement_revoke_params.rbi} +2 -2
- 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} +130 -98
- data/rbi/stigg/models/v1/subscription_cancel_params.rbi +182 -0
- data/rbi/stigg/models/v1/subscription_delegate_params.rbi +6 -2
- 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_list_params.rbi +26 -28
- data/rbi/stigg/models/v1/subscription_list_response.rbi +460 -435
- data/rbi/stigg/models/v1/subscription_migrate_params.rbi +3 -3
- data/rbi/stigg/models/v1/subscription_preview_params.rbi +112 -14
- data/rbi/stigg/models/v1/subscription_preview_response.rbi +139 -6
- data/rbi/stigg/models/v1/subscription_provision_params.rbi +5306 -0
- data/rbi/stigg/models/v1/subscription_provision_response.rbi +3175 -0
- data/rbi/stigg/models/v1/subscription_transfer_params.rbi +2 -4
- 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} +10 -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 +22 -14
- data/rbi/stigg/resources/v1/customers/payment_method.rbi +9 -3
- data/rbi/stigg/resources/v1/customers/{promotional.rbi → promotional_entitlements.rbi} +13 -9
- data/rbi/stigg/resources/v1/customers.rbi +84 -53
- data/rbi/stigg/resources/v1/events.rbi +28 -0
- data/rbi/stigg/resources/v1/subscriptions/future_update.rbi +14 -10
- data/rbi/stigg/resources/v1/subscriptions.rbi +242 -58
- data/rbi/stigg/resources/v1/usage.rbi +57 -0
- data/rbi/stigg/resources/v1.rbi +4 -26
- data/sig/stigg/internal/my_cursor_id_page.rbs +17 -0
- data/sig/stigg/models/v1/{coupon_create_response.rbs → coupon.rbs} +29 -32
- data/sig/stigg/models/v1/coupon_list_params.rbs +11 -11
- data/sig/stigg/models/v1/coupon_list_response.rbs +331 -351
- 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_list_params.rbs +11 -11
- data/sig/stigg/models/v1/customer_list_response.rbs +133 -153
- data/sig/stigg/models/v1/{customer_create_params.rbs → customer_provision_params.rbs} +22 -22
- data/sig/stigg/models/v1/customers/{promotional_create_params.rbs → promotional_entitlement_grant_params.rbs} +43 -43
- data/sig/stigg/models/v1/customers/promotional_entitlement_grant_response.rbs +281 -0
- data/sig/stigg/models/v1/customers/{promotional_revoke_params.rbs → promotional_entitlement_revoke_params.rbs} +2 -2
- 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} +61 -35
- 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_list_params.rbs +14 -14
- data/sig/stigg/models/v1/subscription_list_response.rbs +196 -189
- data/sig/stigg/models/v1/subscription_preview_params.rbs +2 -6
- data/sig/stigg/models/v1/subscription_provision_params.rbs +2223 -0
- data/sig/stigg/models/v1/subscription_provision_response.rbs +1305 -0
- 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 +5 -5
- data/sig/stigg/resources/v1/customers/{promotional.rbs → promotional_entitlements.rbs} +5 -5
- data/sig/stigg/resources/v1/customers.rbs +20 -17
- 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 +68 -20
- data/sig/stigg/resources/v1/usage.rbs +24 -0
- data/sig/stigg/resources/v1.rbs +2 -8
- metadata +77 -71
- data/lib/stigg/models/v1/coupon_retrieve_response.rb +0 -317
- data/lib/stigg/models/v1/customers/usage_retrieve_params.rb +0 -56
- data/lib/stigg/models/v1/customers/usage_retrieve_response.rb +0 -145
- data/lib/stigg/models/v1/subscription_create_params.rb +0 -214
- data/lib/stigg/models/v1/subscription_create_response.rb +0 -338
- data/lib/stigg/models/v1/subscription_delegate_response.rb +0 -274
- data/lib/stigg/models/v1/subscription_migrate_response.rb +0 -274
- data/lib/stigg/models/v1/subscription_transfer_response.rb +0 -274
- data/lib/stigg/models/v1/subscriptions/future_update_cancel_schedule_response.rb +0 -32
- data/lib/stigg/models/v1_create_event_params.rb +0 -87
- data/lib/stigg/models/v1_create_event_response.rb +0 -16
- data/lib/stigg/models/v1_create_usage_params.rb +0 -96
- data/lib/stigg/models/v1_create_usage_response.rb +0 -112
- data/lib/stigg/resources/v1/customers/usage.rb +0 -59
- data/rbi/stigg/models/v1/coupon_create_response.rbi +0 -986
- data/rbi/stigg/models/v1/coupon_retrieve_response.rbi +0 -986
- data/rbi/stigg/models/v1/customers/promotional_create_response.rbi +0 -495
- data/rbi/stigg/models/v1/customers/promotional_revoke_response.rbi +0 -497
- data/rbi/stigg/models/v1/customers/usage_retrieve_params.rbi +0 -84
- data/rbi/stigg/models/v1/customers/usage_retrieve_response.rbi +0 -353
- data/rbi/stigg/models/v1/subscription_create_params.rbi +0 -394
- data/rbi/stigg/models/v1/subscription_create_response.rbi +0 -668
- data/rbi/stigg/models/v1/subscription_delegate_response.rbi +0 -535
- data/rbi/stigg/models/v1/subscription_retrieve_response.rbi +0 -535
- data/rbi/stigg/models/v1/subscription_transfer_response.rbi +0 -535
- data/rbi/stigg/models/v1/subscriptions/future_update_cancel_pending_payment_response.rbi +0 -79
- data/rbi/stigg/models/v1_create_event_params.rbi +0 -160
- data/rbi/stigg/models/v1_create_event_response.rbi +0 -23
- data/rbi/stigg/models/v1_create_usage_params.rbi +0 -177
- data/rbi/stigg/models/v1_create_usage_response.rbi +0 -150
- data/rbi/stigg/resources/v1/customers/usage.rbi +0 -45
- data/sig/stigg/models/v1/coupon_retrieve_response.rbs +0 -394
- data/sig/stigg/models/v1/customers/promotional_create_response.rbs +0 -209
- data/sig/stigg/models/v1/customers/promotional_revoke_response.rbs +0 -209
- data/sig/stigg/models/v1/customers/usage_retrieve_params.rbs +0 -54
- data/sig/stigg/models/v1/customers/usage_retrieve_response.rbs +0 -134
- data/sig/stigg/models/v1/subscription_create_params.rbs +0 -199
- data/sig/stigg/models/v1/subscription_create_response.rbs +0 -283
- data/sig/stigg/models/v1/subscription_delegate_response.rbs +0 -224
- data/sig/stigg/models/v1/subscription_migrate_response.rbs +0 -224
- data/sig/stigg/models/v1/subscription_transfer_response.rbs +0 -224
- 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 -90
- data/sig/stigg/models/v1_create_usage_response.rbs +0 -85
- data/sig/stigg/resources/v1/customers/usage.rbs +0 -21
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Stigg
|
|
4
|
+
module Models
|
|
5
|
+
module V1
|
|
6
|
+
# @see Stigg::Resources::V1::Customers#import
|
|
7
|
+
class CustomerImportResponse < Stigg::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute data
|
|
9
|
+
# List of newly created customer IDs from the import operation.
|
|
10
|
+
#
|
|
11
|
+
# @return [Stigg::Models::V1::CustomerImportResponse::Data]
|
|
12
|
+
required :data, -> { Stigg::Models::V1::CustomerImportResponse::Data }
|
|
13
|
+
|
|
14
|
+
# @!method initialize(data:)
|
|
15
|
+
# Response object
|
|
16
|
+
#
|
|
17
|
+
# @param data [Stigg::Models::V1::CustomerImportResponse::Data] List of newly created customer IDs from the import operation.
|
|
18
|
+
|
|
19
|
+
# @see Stigg::Models::V1::CustomerImportResponse#data
|
|
20
|
+
class Data < Stigg::Internal::Type::BaseModel
|
|
21
|
+
# @!attribute new_customers
|
|
22
|
+
# Customer IDs created during import
|
|
23
|
+
#
|
|
24
|
+
# @return [Array<String>]
|
|
25
|
+
required :new_customers, Stigg::Internal::Type::ArrayOf[String], api_name: :newCustomers
|
|
26
|
+
|
|
27
|
+
# @!method initialize(new_customers:)
|
|
28
|
+
# List of newly created customer IDs from the import operation.
|
|
29
|
+
#
|
|
30
|
+
# @param new_customers [Array<String>] Customer IDs created during import
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
end
|
|
@@ -8,30 +8,30 @@ module Stigg
|
|
|
8
8
|
extend Stigg::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Stigg::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
-
# @!attribute
|
|
12
|
-
#
|
|
11
|
+
# @!attribute after
|
|
12
|
+
# Return items that come after this cursor
|
|
13
13
|
#
|
|
14
14
|
# @return [String, nil]
|
|
15
|
-
optional :
|
|
15
|
+
optional :after, String
|
|
16
|
+
|
|
17
|
+
# @!attribute before
|
|
18
|
+
# Return items that come before this cursor
|
|
19
|
+
#
|
|
20
|
+
# @return [String, nil]
|
|
21
|
+
optional :before, String
|
|
16
22
|
|
|
17
23
|
# @!attribute limit
|
|
18
|
-
#
|
|
24
|
+
# Maximum number of items to return
|
|
19
25
|
#
|
|
20
26
|
# @return [Integer, nil]
|
|
21
27
|
optional :limit, Integer
|
|
22
28
|
|
|
23
|
-
# @!
|
|
24
|
-
#
|
|
25
|
-
#
|
|
26
|
-
# @return [String, nil]
|
|
27
|
-
optional :starting_after, String
|
|
28
|
-
|
|
29
|
-
# @!method initialize(ending_before: nil, limit: nil, starting_after: nil, request_options: {})
|
|
30
|
-
# @param ending_before [String] Ending before this UUID for pagination
|
|
29
|
+
# @!method initialize(after: nil, before: nil, limit: nil, request_options: {})
|
|
30
|
+
# @param after [String] Return items that come after this cursor
|
|
31
31
|
#
|
|
32
|
-
# @param
|
|
32
|
+
# @param before [String] Return items that come before this cursor
|
|
33
33
|
#
|
|
34
|
-
# @param
|
|
34
|
+
# @param limit [Integer] Maximum number of items to return
|
|
35
35
|
#
|
|
36
36
|
# @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
|
|
37
37
|
end
|
|
@@ -5,216 +5,202 @@ module Stigg
|
|
|
5
5
|
module V1
|
|
6
6
|
# @see Stigg::Resources::V1::Customers#list
|
|
7
7
|
class CustomerListResponse < Stigg::Internal::Type::BaseModel
|
|
8
|
-
# @!attribute
|
|
8
|
+
# @!attribute id
|
|
9
|
+
# Customer slug
|
|
9
10
|
#
|
|
10
|
-
# @return [
|
|
11
|
-
required :
|
|
11
|
+
# @return [String]
|
|
12
|
+
required :id, String
|
|
12
13
|
|
|
13
|
-
# @!
|
|
14
|
-
#
|
|
14
|
+
# @!attribute archived_at
|
|
15
|
+
# Timestamp of when the record was deleted
|
|
16
|
+
#
|
|
17
|
+
# @return [Time, nil]
|
|
18
|
+
required :archived_at, Time, api_name: :archivedAt, nil?: true
|
|
15
19
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
required :id, String
|
|
20
|
+
# @!attribute created_at
|
|
21
|
+
# Timestamp of when the record was created
|
|
22
|
+
#
|
|
23
|
+
# @return [Time]
|
|
24
|
+
required :created_at, Time, api_name: :createdAt
|
|
22
25
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
26
|
+
# @!attribute updated_at
|
|
27
|
+
# Timestamp of when the record was last updated
|
|
28
|
+
#
|
|
29
|
+
# @return [Time]
|
|
30
|
+
required :updated_at, Time, api_name: :updatedAt
|
|
28
31
|
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
32
|
+
# @!attribute coupon_id
|
|
33
|
+
# Customer level coupon
|
|
34
|
+
#
|
|
35
|
+
# @return [String, nil]
|
|
36
|
+
optional :coupon_id, String, api_name: :couponId, nil?: true
|
|
34
37
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
38
|
+
# @!attribute default_payment_method
|
|
39
|
+
# The default payment method details
|
|
40
|
+
#
|
|
41
|
+
# @return [Stigg::Models::V1::CustomerListResponse::DefaultPaymentMethod, nil]
|
|
42
|
+
optional :default_payment_method,
|
|
43
|
+
-> { Stigg::Models::V1::CustomerListResponse::DefaultPaymentMethod },
|
|
44
|
+
api_name: :defaultPaymentMethod,
|
|
45
|
+
nil?: true
|
|
46
|
+
|
|
47
|
+
# @!attribute email
|
|
48
|
+
# The email of the customer
|
|
49
|
+
#
|
|
50
|
+
# @return [String, nil]
|
|
51
|
+
optional :email, String, nil?: true
|
|
40
52
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
53
|
+
# @!attribute integrations
|
|
54
|
+
# List of integrations
|
|
55
|
+
#
|
|
56
|
+
# @return [Array<Stigg::Models::V1::CustomerListResponse::Integration>, nil]
|
|
57
|
+
optional :integrations,
|
|
58
|
+
-> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::CustomerListResponse::Integration] }
|
|
46
59
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
60
|
+
# @!attribute metadata
|
|
61
|
+
# Additional metadata
|
|
62
|
+
#
|
|
63
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
64
|
+
optional :metadata, Stigg::Internal::Type::HashOf[String]
|
|
52
65
|
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
66
|
+
# @!attribute name
|
|
67
|
+
# The name of the customer
|
|
68
|
+
#
|
|
69
|
+
# @return [String, nil]
|
|
70
|
+
optional :name, String, nil?: true
|
|
71
|
+
|
|
72
|
+
# @!method initialize(id:, archived_at:, created_at:, updated_at:, coupon_id: nil, default_payment_method: nil, email: nil, integrations: nil, metadata: nil, name: nil)
|
|
73
|
+
# A customer can be either an organization or an individual
|
|
74
|
+
#
|
|
75
|
+
# @param id [String] Customer slug
|
|
76
|
+
#
|
|
77
|
+
# @param archived_at [Time, nil] Timestamp of when the record was deleted
|
|
78
|
+
#
|
|
79
|
+
# @param created_at [Time] Timestamp of when the record was created
|
|
80
|
+
#
|
|
81
|
+
# @param updated_at [Time] Timestamp of when the record was last updated
|
|
82
|
+
#
|
|
83
|
+
# @param coupon_id [String, nil] Customer level coupon
|
|
84
|
+
#
|
|
85
|
+
# @param default_payment_method [Stigg::Models::V1::CustomerListResponse::DefaultPaymentMethod, nil] The default payment method details
|
|
86
|
+
#
|
|
87
|
+
# @param email [String, nil] The email of the customer
|
|
88
|
+
#
|
|
89
|
+
# @param integrations [Array<Stigg::Models::V1::CustomerListResponse::Integration>] List of integrations
|
|
90
|
+
#
|
|
91
|
+
# @param metadata [Hash{Symbol=>String}] Additional metadata
|
|
92
|
+
#
|
|
93
|
+
# @param name [String, nil] The name of the customer
|
|
61
94
|
|
|
62
|
-
|
|
63
|
-
|
|
95
|
+
# @see Stigg::Models::V1::CustomerListResponse#default_payment_method
|
|
96
|
+
class DefaultPaymentMethod < Stigg::Internal::Type::BaseModel
|
|
97
|
+
# @!attribute billing_id
|
|
98
|
+
# The default payment method id
|
|
64
99
|
#
|
|
65
100
|
# @return [String, nil]
|
|
66
|
-
|
|
101
|
+
required :billing_id, String, api_name: :billingId, nil?: true
|
|
67
102
|
|
|
68
|
-
# @!attribute
|
|
69
|
-
#
|
|
103
|
+
# @!attribute card_expiry_month
|
|
104
|
+
# The expiration month of the default payment method
|
|
70
105
|
#
|
|
71
|
-
# @return [
|
|
72
|
-
|
|
73
|
-
-> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::CustomerListResponse::Data::Integration] }
|
|
106
|
+
# @return [Float, nil]
|
|
107
|
+
required :card_expiry_month, Float, api_name: :cardExpiryMonth, nil?: true
|
|
74
108
|
|
|
75
|
-
# @!attribute
|
|
76
|
-
#
|
|
109
|
+
# @!attribute card_expiry_year
|
|
110
|
+
# The expiration year of the default payment method
|
|
77
111
|
#
|
|
78
|
-
# @return [
|
|
79
|
-
|
|
112
|
+
# @return [Float, nil]
|
|
113
|
+
required :card_expiry_year, Float, api_name: :cardExpiryYear, nil?: true
|
|
80
114
|
|
|
81
|
-
# @!attribute
|
|
82
|
-
# The
|
|
115
|
+
# @!attribute card_last4_digits
|
|
116
|
+
# The last 4 digits of the default payment method
|
|
83
117
|
#
|
|
84
118
|
# @return [String, nil]
|
|
85
|
-
|
|
119
|
+
required :card_last4_digits, String, api_name: :cardLast4Digits, nil?: true
|
|
86
120
|
|
|
87
|
-
# @!
|
|
88
|
-
#
|
|
89
|
-
#
|
|
90
|
-
# @param archived_at [Time, nil] Timestamp of when the record was deleted
|
|
121
|
+
# @!attribute type
|
|
122
|
+
# The default payment method type
|
|
91
123
|
#
|
|
92
|
-
# @
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
#
|
|
96
|
-
#
|
|
97
|
-
#
|
|
98
|
-
# @param coupon_id [String, nil] Customer level coupon
|
|
124
|
+
# @return [Symbol, Stigg::Models::V1::CustomerListResponse::DefaultPaymentMethod::Type]
|
|
125
|
+
required :type, enum: -> { Stigg::Models::V1::CustomerListResponse::DefaultPaymentMethod::Type }
|
|
126
|
+
|
|
127
|
+
# @!method initialize(billing_id:, card_expiry_month:, card_expiry_year:, card_last4_digits:, type:)
|
|
128
|
+
# The default payment method details
|
|
99
129
|
#
|
|
100
|
-
# @param
|
|
130
|
+
# @param billing_id [String, nil] The default payment method id
|
|
101
131
|
#
|
|
102
|
-
# @param
|
|
132
|
+
# @param card_expiry_month [Float, nil] The expiration month of the default payment method
|
|
103
133
|
#
|
|
104
|
-
# @param
|
|
134
|
+
# @param card_expiry_year [Float, nil] The expiration year of the default payment method
|
|
105
135
|
#
|
|
106
|
-
# @param
|
|
136
|
+
# @param card_last4_digits [String, nil] The last 4 digits of the default payment method
|
|
107
137
|
#
|
|
108
|
-
# @param
|
|
138
|
+
# @param type [Symbol, Stigg::Models::V1::CustomerListResponse::DefaultPaymentMethod::Type] The default payment method type
|
|
109
139
|
|
|
110
|
-
#
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
# @return [String, nil]
|
|
116
|
-
required :billing_id, String, api_name: :billingId, nil?: true
|
|
140
|
+
# The default payment method type
|
|
141
|
+
#
|
|
142
|
+
# @see Stigg::Models::V1::CustomerListResponse::DefaultPaymentMethod#type
|
|
143
|
+
module Type
|
|
144
|
+
extend Stigg::Internal::Type::Enum
|
|
117
145
|
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
# @return [Float, nil]
|
|
122
|
-
required :card_expiry_month, Float, api_name: :cardExpiryMonth, nil?: true
|
|
146
|
+
CARD = :CARD
|
|
147
|
+
BANK = :BANK
|
|
148
|
+
CASH_APP = :CASH_APP
|
|
123
149
|
|
|
124
|
-
# @!
|
|
125
|
-
#
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
required :card_expiry_year, Float, api_name: :cardExpiryYear, nil?: true
|
|
150
|
+
# @!method self.values
|
|
151
|
+
# @return [Array<Symbol>]
|
|
152
|
+
end
|
|
153
|
+
end
|
|
129
154
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
155
|
+
class Integration < Stigg::Internal::Type::BaseModel
|
|
156
|
+
# @!attribute id
|
|
157
|
+
# Integration details
|
|
158
|
+
#
|
|
159
|
+
# @return [String]
|
|
160
|
+
required :id, String
|
|
135
161
|
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
162
|
+
# @!attribute synced_entity_id
|
|
163
|
+
# Synced entity id
|
|
164
|
+
#
|
|
165
|
+
# @return [String, nil]
|
|
166
|
+
required :synced_entity_id, String, api_name: :syncedEntityId, nil?: true
|
|
141
167
|
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
# @param card_expiry_year [Float, nil] The expiration year of the default payment method
|
|
150
|
-
#
|
|
151
|
-
# @param card_last4_digits [String, nil] The last 4 digits of the default payment method
|
|
152
|
-
#
|
|
153
|
-
# @param type [Symbol, Stigg::Models::V1::CustomerListResponse::Data::DefaultPaymentMethod::Type] The default payment method type
|
|
168
|
+
# @!attribute vendor_identifier
|
|
169
|
+
# The vendor identifier of integration
|
|
170
|
+
#
|
|
171
|
+
# @return [Symbol, Stigg::Models::V1::CustomerListResponse::Integration::VendorIdentifier]
|
|
172
|
+
required :vendor_identifier,
|
|
173
|
+
enum: -> { Stigg::Models::V1::CustomerListResponse::Integration::VendorIdentifier },
|
|
174
|
+
api_name: :vendorIdentifier
|
|
154
175
|
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
176
|
+
# @!method initialize(id:, synced_entity_id:, vendor_identifier:)
|
|
177
|
+
# External billing or CRM integration link
|
|
178
|
+
#
|
|
179
|
+
# @param id [String] Integration details
|
|
180
|
+
#
|
|
181
|
+
# @param synced_entity_id [String, nil] Synced entity id
|
|
182
|
+
#
|
|
183
|
+
# @param vendor_identifier [Symbol, Stigg::Models::V1::CustomerListResponse::Integration::VendorIdentifier] The vendor identifier of integration
|
|
160
184
|
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
185
|
+
# The vendor identifier of integration
|
|
186
|
+
#
|
|
187
|
+
# @see Stigg::Models::V1::CustomerListResponse::Integration#vendor_identifier
|
|
188
|
+
module VendorIdentifier
|
|
189
|
+
extend Stigg::Internal::Type::Enum
|
|
164
190
|
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
191
|
+
AUTH0 = :AUTH0
|
|
192
|
+
ZUORA = :ZUORA
|
|
193
|
+
STRIPE = :STRIPE
|
|
194
|
+
HUBSPOT = :HUBSPOT
|
|
195
|
+
AWS_MARKETPLACE = :AWS_MARKETPLACE
|
|
196
|
+
SNOWFLAKE = :SNOWFLAKE
|
|
197
|
+
SALESFORCE = :SALESFORCE
|
|
198
|
+
BIG_QUERY = :BIG_QUERY
|
|
199
|
+
OPEN_FGA = :OPEN_FGA
|
|
200
|
+
APP_STORE = :APP_STORE
|
|
169
201
|
|
|
170
|
-
|
|
171
|
-
#
|
|
172
|
-
# Integration details
|
|
173
|
-
#
|
|
174
|
-
# @return [String]
|
|
175
|
-
required :id, String
|
|
176
|
-
|
|
177
|
-
# @!attribute synced_entity_id
|
|
178
|
-
# Synced entity id
|
|
179
|
-
#
|
|
180
|
-
# @return [String, nil]
|
|
181
|
-
required :synced_entity_id, String, api_name: :syncedEntityId, nil?: true
|
|
182
|
-
|
|
183
|
-
# @!attribute vendor_identifier
|
|
184
|
-
# The vendor identifier of integration
|
|
185
|
-
#
|
|
186
|
-
# @return [Symbol, Stigg::Models::V1::CustomerListResponse::Data::Integration::VendorIdentifier]
|
|
187
|
-
required :vendor_identifier,
|
|
188
|
-
enum: -> { Stigg::Models::V1::CustomerListResponse::Data::Integration::VendorIdentifier },
|
|
189
|
-
api_name: :vendorIdentifier
|
|
190
|
-
|
|
191
|
-
# @!method initialize(id:, synced_entity_id:, vendor_identifier:)
|
|
192
|
-
# @param id [String] Integration details
|
|
193
|
-
#
|
|
194
|
-
# @param synced_entity_id [String, nil] Synced entity id
|
|
195
|
-
#
|
|
196
|
-
# @param vendor_identifier [Symbol, Stigg::Models::V1::CustomerListResponse::Data::Integration::VendorIdentifier] The vendor identifier of integration
|
|
197
|
-
|
|
198
|
-
# The vendor identifier of integration
|
|
199
|
-
#
|
|
200
|
-
# @see Stigg::Models::V1::CustomerListResponse::Data::Integration#vendor_identifier
|
|
201
|
-
module VendorIdentifier
|
|
202
|
-
extend Stigg::Internal::Type::Enum
|
|
203
|
-
|
|
204
|
-
AUTH0 = :AUTH0
|
|
205
|
-
ZUORA = :ZUORA
|
|
206
|
-
STRIPE = :STRIPE
|
|
207
|
-
HUBSPOT = :HUBSPOT
|
|
208
|
-
AWS_MARKETPLACE = :AWS_MARKETPLACE
|
|
209
|
-
SNOWFLAKE = :SNOWFLAKE
|
|
210
|
-
SALESFORCE = :SALESFORCE
|
|
211
|
-
BIG_QUERY = :BIG_QUERY
|
|
212
|
-
OPEN_FGA = :OPEN_FGA
|
|
213
|
-
APP_STORE = :APP_STORE
|
|
214
|
-
|
|
215
|
-
# @!method self.values
|
|
216
|
-
# @return [Array<Symbol>]
|
|
217
|
-
end
|
|
202
|
+
# @!method self.values
|
|
203
|
+
# @return [Array<Symbol>]
|
|
218
204
|
end
|
|
219
205
|
end
|
|
220
206
|
end
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
module Stigg
|
|
4
4
|
module Models
|
|
5
5
|
module V1
|
|
6
|
-
# @see Stigg::Resources::V1::Customers#
|
|
7
|
-
class
|
|
6
|
+
# @see Stigg::Resources::V1::Customers#provision
|
|
7
|
+
class CustomerProvisionParams < Stigg::Internal::Type::BaseModel
|
|
8
8
|
extend Stigg::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Stigg::Internal::Type::RequestParameters
|
|
10
10
|
|
|
@@ -23,9 +23,9 @@ module Stigg
|
|
|
23
23
|
# @!attribute default_payment_method
|
|
24
24
|
# The default payment method details
|
|
25
25
|
#
|
|
26
|
-
# @return [Stigg::Models::V1::
|
|
26
|
+
# @return [Stigg::Models::V1::CustomerProvisionParams::DefaultPaymentMethod, nil]
|
|
27
27
|
optional :default_payment_method,
|
|
28
|
-
-> { Stigg::V1::
|
|
28
|
+
-> { Stigg::V1::CustomerProvisionParams::DefaultPaymentMethod },
|
|
29
29
|
api_name: :defaultPaymentMethod,
|
|
30
30
|
nil?: true
|
|
31
31
|
|
|
@@ -38,9 +38,9 @@ module Stigg
|
|
|
38
38
|
# @!attribute integrations
|
|
39
39
|
# List of integrations
|
|
40
40
|
#
|
|
41
|
-
# @return [Array<Stigg::Models::V1::
|
|
41
|
+
# @return [Array<Stigg::Models::V1::CustomerProvisionParams::Integration>, nil]
|
|
42
42
|
optional :integrations,
|
|
43
|
-
-> { Stigg::Internal::Type::ArrayOf[Stigg::V1::
|
|
43
|
+
-> { Stigg::Internal::Type::ArrayOf[Stigg::V1::CustomerProvisionParams::Integration] }
|
|
44
44
|
|
|
45
45
|
# @!attribute metadata
|
|
46
46
|
# Additional metadata
|
|
@@ -59,11 +59,11 @@ module Stigg
|
|
|
59
59
|
#
|
|
60
60
|
# @param coupon_id [String, nil] Customer level coupon
|
|
61
61
|
#
|
|
62
|
-
# @param default_payment_method [Stigg::Models::V1::
|
|
62
|
+
# @param default_payment_method [Stigg::Models::V1::CustomerProvisionParams::DefaultPaymentMethod, nil] The default payment method details
|
|
63
63
|
#
|
|
64
64
|
# @param email [String, nil] The email of the customer
|
|
65
65
|
#
|
|
66
|
-
# @param integrations [Array<Stigg::Models::V1::
|
|
66
|
+
# @param integrations [Array<Stigg::Models::V1::CustomerProvisionParams::Integration>] List of integrations
|
|
67
67
|
#
|
|
68
68
|
# @param metadata [Hash{Symbol=>String}] Additional metadata
|
|
69
69
|
#
|
|
@@ -99,8 +99,8 @@ module Stigg
|
|
|
99
99
|
# @!attribute type
|
|
100
100
|
# The default payment method type
|
|
101
101
|
#
|
|
102
|
-
# @return [Symbol, Stigg::Models::V1::
|
|
103
|
-
required :type, enum: -> { Stigg::V1::
|
|
102
|
+
# @return [Symbol, Stigg::Models::V1::CustomerProvisionParams::DefaultPaymentMethod::Type]
|
|
103
|
+
required :type, enum: -> { Stigg::V1::CustomerProvisionParams::DefaultPaymentMethod::Type }
|
|
104
104
|
|
|
105
105
|
# @!method initialize(billing_id:, card_expiry_month:, card_expiry_year:, card_last4_digits:, type:)
|
|
106
106
|
# The default payment method details
|
|
@@ -113,11 +113,11 @@ module Stigg
|
|
|
113
113
|
#
|
|
114
114
|
# @param card_last4_digits [String, nil] The last 4 digits of the default payment method
|
|
115
115
|
#
|
|
116
|
-
# @param type [Symbol, Stigg::Models::V1::
|
|
116
|
+
# @param type [Symbol, Stigg::Models::V1::CustomerProvisionParams::DefaultPaymentMethod::Type] The default payment method type
|
|
117
117
|
|
|
118
118
|
# The default payment method type
|
|
119
119
|
#
|
|
120
|
-
# @see Stigg::Models::V1::
|
|
120
|
+
# @see Stigg::Models::V1::CustomerProvisionParams::DefaultPaymentMethod#type
|
|
121
121
|
module Type
|
|
122
122
|
extend Stigg::Internal::Type::Enum
|
|
123
123
|
|
|
@@ -146,21 +146,23 @@ module Stigg
|
|
|
146
146
|
# @!attribute vendor_identifier
|
|
147
147
|
# The vendor identifier of integration
|
|
148
148
|
#
|
|
149
|
-
# @return [Symbol, Stigg::Models::V1::
|
|
149
|
+
# @return [Symbol, Stigg::Models::V1::CustomerProvisionParams::Integration::VendorIdentifier]
|
|
150
150
|
required :vendor_identifier,
|
|
151
|
-
enum: -> { Stigg::V1::
|
|
151
|
+
enum: -> { Stigg::V1::CustomerProvisionParams::Integration::VendorIdentifier },
|
|
152
152
|
api_name: :vendorIdentifier
|
|
153
153
|
|
|
154
154
|
# @!method initialize(id:, synced_entity_id:, vendor_identifier:)
|
|
155
|
+
# External billing or CRM integration link
|
|
156
|
+
#
|
|
155
157
|
# @param id [String] Integration details
|
|
156
158
|
#
|
|
157
159
|
# @param synced_entity_id [String, nil] Synced entity id
|
|
158
160
|
#
|
|
159
|
-
# @param vendor_identifier [Symbol, Stigg::Models::V1::
|
|
161
|
+
# @param vendor_identifier [Symbol, Stigg::Models::V1::CustomerProvisionParams::Integration::VendorIdentifier] The vendor identifier of integration
|
|
160
162
|
|
|
161
163
|
# The vendor identifier of integration
|
|
162
164
|
#
|
|
163
|
-
# @see Stigg::Models::V1::
|
|
165
|
+
# @see Stigg::Models::V1::CustomerProvisionParams::Integration#vendor_identifier
|
|
164
166
|
module VendorIdentifier
|
|
165
167
|
extend Stigg::Internal::Type::Enum
|
|
166
168
|
|
|
@@ -3,15 +3,18 @@
|
|
|
3
3
|
module Stigg
|
|
4
4
|
module Models
|
|
5
5
|
module V1
|
|
6
|
-
# @see Stigg::Resources::V1::Customers#
|
|
6
|
+
# @see Stigg::Resources::V1::Customers#retrieve
|
|
7
7
|
class CustomerResponse < Stigg::Internal::Type::BaseModel
|
|
8
8
|
# @!attribute data
|
|
9
|
+
# A customer can be either an organization or an individual
|
|
9
10
|
#
|
|
10
11
|
# @return [Stigg::Models::V1::CustomerResponse::Data]
|
|
11
12
|
required :data, -> { Stigg::V1::CustomerResponse::Data }
|
|
12
13
|
|
|
13
14
|
# @!method initialize(data:)
|
|
14
|
-
#
|
|
15
|
+
# Response object
|
|
16
|
+
#
|
|
17
|
+
# @param data [Stigg::Models::V1::CustomerResponse::Data] A customer can be either an organization or an individual
|
|
15
18
|
|
|
16
19
|
# @see Stigg::Models::V1::CustomerResponse#data
|
|
17
20
|
class Data < Stigg::Internal::Type::BaseModel
|
|
@@ -80,6 +83,8 @@ module Stigg
|
|
|
80
83
|
optional :name, String, nil?: true
|
|
81
84
|
|
|
82
85
|
# @!method initialize(id:, archived_at:, created_at:, updated_at:, coupon_id: nil, default_payment_method: nil, email: nil, integrations: nil, metadata: nil, name: nil)
|
|
86
|
+
# A customer can be either an organization or an individual
|
|
87
|
+
#
|
|
83
88
|
# @param id [String] Customer slug
|
|
84
89
|
#
|
|
85
90
|
# @param archived_at [Time, nil] Timestamp of when the record was deleted
|
|
@@ -182,6 +187,8 @@ module Stigg
|
|
|
182
187
|
api_name: :vendorIdentifier
|
|
183
188
|
|
|
184
189
|
# @!method initialize(id:, synced_entity_id:, vendor_identifier:)
|
|
190
|
+
# External billing or CRM integration link
|
|
191
|
+
#
|
|
185
192
|
# @param id [String] Integration details
|
|
186
193
|
#
|
|
187
194
|
# @param synced_entity_id [String, nil] Synced entity id
|
|
@@ -74,6 +74,8 @@ module Stigg
|
|
|
74
74
|
api_name: :vendorIdentifier
|
|
75
75
|
|
|
76
76
|
# @!method initialize(id:, synced_entity_id:, vendor_identifier:)
|
|
77
|
+
# External billing or CRM integration link
|
|
78
|
+
#
|
|
77
79
|
# @param id [String] Integration details
|
|
78
80
|
#
|
|
79
81
|
# @param synced_entity_id [String, nil] Synced entity id
|
|
@@ -30,6 +30,7 @@ module Stigg
|
|
|
30
30
|
api_name: :vendorIdentifier
|
|
31
31
|
|
|
32
32
|
# @!attribute billing_currency
|
|
33
|
+
# Customers selected currency
|
|
33
34
|
#
|
|
34
35
|
# @return [Symbol, Stigg::Models::V1::Customers::PaymentMethodAttachParams::BillingCurrency, nil]
|
|
35
36
|
optional :billing_currency,
|
|
@@ -44,7 +45,7 @@ module Stigg
|
|
|
44
45
|
#
|
|
45
46
|
# @param vendor_identifier [Symbol, Stigg::Models::V1::Customers::PaymentMethodAttachParams::VendorIdentifier] The vendor identifier of integration
|
|
46
47
|
#
|
|
47
|
-
# @param billing_currency [Symbol, Stigg::Models::V1::Customers::PaymentMethodAttachParams::BillingCurrency, nil]
|
|
48
|
+
# @param billing_currency [Symbol, Stigg::Models::V1::Customers::PaymentMethodAttachParams::BillingCurrency, nil] Customers selected currency
|
|
48
49
|
#
|
|
49
50
|
# @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
|
|
50
51
|
|
|
@@ -67,6 +68,7 @@ module Stigg
|
|
|
67
68
|
# @return [Array<Symbol>]
|
|
68
69
|
end
|
|
69
70
|
|
|
71
|
+
# Customers selected currency
|
|
70
72
|
module BillingCurrency
|
|
71
73
|
extend Stigg::Internal::Type::Enum
|
|
72
74
|
|