metronome-sdk 3.6.0 → 3.8.0
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 +54 -0
- data/README.md +1 -1
- data/lib/metronome_sdk/internal/transport/base_client.rb +4 -1
- data/lib/metronome_sdk/internal/type/enum.rb +0 -25
- data/lib/metronome_sdk/models/commit.rb +36 -1
- data/lib/metronome_sdk/models/contract.rb +140 -1
- data/lib/metronome_sdk/models/contract_v2.rb +457 -8
- data/lib/metronome_sdk/models/contract_without_amendments.rb +320 -5
- data/lib/metronome_sdk/models/credit.rb +10 -1
- data/lib/metronome_sdk/models/override.rb +7 -1
- data/lib/metronome_sdk/models/prepaid_balance_threshold_configuration.rb +113 -2
- data/lib/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rb +105 -2
- data/lib/metronome_sdk/models/spend_threshold_configuration.rb +33 -1
- data/lib/metronome_sdk/models/spend_threshold_configuration_v2.rb +33 -1
- data/lib/metronome_sdk/models/subscription.rb +90 -2
- data/lib/metronome_sdk/models/v1/alert_create_params.rb +127 -1
- data/lib/metronome_sdk/models/v1/contract_amend_params.rb +46 -5
- data/lib/metronome_sdk/models/v1/contract_create_params.rb +436 -12
- data/lib/metronome_sdk/models/v1/contract_create_response.rb +1308 -3
- data/lib/metronome_sdk/models/v1/contract_get_subscription_seats_history_params.rb +88 -0
- data/lib/metronome_sdk/models/v1/contract_get_subscription_seats_history_response.rb +62 -0
- data/lib/metronome_sdk/models/v1/contract_list_seat_balances_params.rb +10 -1
- data/lib/metronome_sdk/models/v1/customers/alert_retrieve_params.rb +127 -1
- data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +130 -3
- data/lib/metronome_sdk/models/v1/customers/invoice_list_params.rb +10 -1
- data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb +2 -0
- data/lib/metronome_sdk/models/v1/package_create_params.rb +394 -11
- data/lib/metronome_sdk/models/v1/package_list_response.rb +374 -8
- data/lib/metronome_sdk/models/v1/package_retrieve_response.rb +378 -8
- data/lib/metronome_sdk/models/v2/contract_edit_params.rb +817 -13
- data/lib/metronome_sdk/models/v2/contract_edit_response.rb +4310 -3
- data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +600 -10
- data/lib/metronome_sdk/resources/v1/alerts.rb +3 -1
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/rates.rb +4 -0
- data/lib/metronome_sdk/resources/v1/contracts.rb +71 -2
- data/lib/metronome_sdk/resources/v1/customers/alerts.rb +4 -2
- data/lib/metronome_sdk/resources/v1/customers/invoices.rb +3 -1
- data/lib/metronome_sdk/resources/v1/dashboards.rb +7 -2
- data/lib/metronome_sdk/resources/v1/packages.rb +6 -5
- data/lib/metronome_sdk/resources/v1.rb +0 -4
- data/lib/metronome_sdk/resources/v2/contracts.rb +5 -1
- data/lib/metronome_sdk/version.rb +1 -1
- data/lib/metronome_sdk.rb +2 -8
- data/rbi/metronome_sdk/models/commit.rbi +61 -0
- data/rbi/metronome_sdk/models/contract.rbi +354 -0
- data/rbi/metronome_sdk/models/contract_v2.rbi +1132 -11
- data/rbi/metronome_sdk/models/contract_without_amendments.rbi +831 -0
- data/rbi/metronome_sdk/models/credit.rbi +13 -0
- data/rbi/metronome_sdk/models/override.rbi +9 -0
- data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration.rbi +299 -6
- data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rbi +287 -6
- data/rbi/metronome_sdk/models/spend_threshold_configuration.rbi +78 -3
- data/rbi/metronome_sdk/models/spend_threshold_configuration_v2.rbi +78 -3
- data/rbi/metronome_sdk/models/subscription.rbi +212 -3
- data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +373 -0
- data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi +81 -6
- data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +1095 -17
- data/rbi/metronome_sdk/models/v1/contract_create_response.rbi +2911 -4
- data/rbi/metronome_sdk/models/v1/contract_get_subscription_seats_history_params.rbi +112 -0
- data/rbi/metronome_sdk/models/v1/contract_get_subscription_seats_history_response.rbi +119 -0
- data/rbi/metronome_sdk/models/v1/contract_list_seat_balances_params.rbi +13 -0
- data/rbi/metronome_sdk/models/v1/customers/alert_retrieve_params.rbi +360 -0
- data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi +379 -2
- data/rbi/metronome_sdk/models/v1/customers/invoice_list_params.rbi +13 -0
- data/rbi/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbi +10 -0
- data/rbi/metronome_sdk/models/v1/package_create_params.rbi +1049 -42
- data/rbi/metronome_sdk/models/v1/package_list_response.rbi +1051 -54
- data/rbi/metronome_sdk/models/v1/package_retrieve_response.rbi +1051 -54
- data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +2130 -114
- data/rbi/metronome_sdk/models/v2/contract_edit_response.rbi +9749 -4
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +1567 -82
- data/rbi/metronome_sdk/resources/v1/alerts.rbi +8 -0
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbi +4 -0
- data/rbi/metronome_sdk/resources/v1/contracts.rbi +77 -0
- data/rbi/metronome_sdk/resources/v1/customers/alerts.rbi +8 -1
- data/rbi/metronome_sdk/resources/v1/customers/invoices.rbi +4 -0
- data/rbi/metronome_sdk/resources/v1/dashboards.rbi +7 -2
- data/rbi/metronome_sdk/resources/v1/packages.rbi +8 -4
- data/rbi/metronome_sdk/resources/v1.rbi +0 -3
- data/rbi/metronome_sdk/resources/v2/contracts.rbi +10 -0
- data/sig/metronome_sdk/models/commit.rbs +26 -0
- data/sig/metronome_sdk/models/contract.rbs +151 -0
- data/sig/metronome_sdk/models/contract_v2.rbs +448 -5
- data/sig/metronome_sdk/models/contract_without_amendments.rbs +320 -2
- data/sig/metronome_sdk/models/credit.rbs +7 -0
- data/sig/metronome_sdk/models/override.rbs +7 -0
- data/sig/metronome_sdk/models/prepaid_balance_threshold_configuration.rbs +116 -6
- data/sig/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rbs +116 -6
- data/sig/metronome_sdk/models/spend_threshold_configuration.rbs +31 -3
- data/sig/metronome_sdk/models/spend_threshold_configuration_v2.rbs +31 -3
- data/sig/metronome_sdk/models/subscription.rbs +88 -3
- data/sig/metronome_sdk/models/v1/alert_create_params.rbs +144 -0
- data/sig/metronome_sdk/models/v1/contract_amend_params.rbs +26 -0
- data/sig/metronome_sdk/models/v1/contract_create_params.rbs +412 -5
- data/sig/metronome_sdk/models/v1/contract_create_response.rbs +1210 -4
- data/sig/metronome_sdk/models/v1/contract_get_subscription_seats_history_params.rbs +63 -0
- data/sig/metronome_sdk/models/v1/contract_get_subscription_seats_history_response.rbs +59 -0
- data/sig/metronome_sdk/models/v1/contract_list_seat_balances_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/alert_retrieve_params.rbs +141 -0
- data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +150 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_list_params.rbs +8 -1
- data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbs +4 -0
- data/sig/metronome_sdk/models/v1/package_create_params.rbs +386 -5
- data/sig/metronome_sdk/models/v1/package_list_response.rbs +380 -5
- data/sig/metronome_sdk/models/v1/package_retrieve_response.rbs +378 -5
- data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +751 -14
- data/sig/metronome_sdk/models/v2/contract_edit_response.rbs +4215 -4
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +569 -14
- data/sig/metronome_sdk/resources/v1/alerts.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/contracts.rbs +14 -0
- data/sig/metronome_sdk/resources/v1/customers/alerts.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/customers/invoices.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/packages.rbs +1 -0
- data/sig/metronome_sdk/resources/v1.rbs +0 -2
- data/sig/metronome_sdk/resources/v2/contracts.rbs +2 -0
- metadata +8 -26
- data/lib/metronome_sdk/models/v1/payment.rb +0 -196
- data/lib/metronome_sdk/models/v1/payment_attempt_params.rb +0 -28
- data/lib/metronome_sdk/models/v1/payment_attempt_response.rb +0 -18
- data/lib/metronome_sdk/models/v1/payment_cancel_params.rb +0 -28
- data/lib/metronome_sdk/models/v1/payment_cancel_response.rb +0 -18
- data/lib/metronome_sdk/models/v1/payment_list_params.rb +0 -53
- data/lib/metronome_sdk/models/v1/payment_status.rb +0 -19
- data/lib/metronome_sdk/resources/v1/payments.rb +0 -102
- data/rbi/metronome_sdk/models/v1/payment.rbi +0 -403
- data/rbi/metronome_sdk/models/v1/payment_attempt_params.rbi +0 -48
- data/rbi/metronome_sdk/models/v1/payment_attempt_response.rbi +0 -35
- data/rbi/metronome_sdk/models/v1/payment_cancel_params.rbi +0 -48
- data/rbi/metronome_sdk/models/v1/payment_cancel_response.rbi +0 -35
- data/rbi/metronome_sdk/models/v1/payment_list_params.rbi +0 -91
- data/rbi/metronome_sdk/models/v1/payment_status.rbi +0 -33
- data/rbi/metronome_sdk/resources/v1/payments.rbi +0 -72
- data/sig/metronome_sdk/models/v1/payment.rbs +0 -243
- data/sig/metronome_sdk/models/v1/payment_attempt_params.rbs +0 -30
- data/sig/metronome_sdk/models/v1/payment_attempt_response.rbs +0 -15
- data/sig/metronome_sdk/models/v1/payment_cancel_params.rbs +0 -30
- data/sig/metronome_sdk/models/v1/payment_cancel_response.rbs +0 -15
- data/sig/metronome_sdk/models/v1/payment_list_params.rbs +0 -56
- data/sig/metronome_sdk/models/v1/payment_status.rbs +0 -19
- data/sig/metronome_sdk/resources/v1/payments.rbs +0 -30
|
@@ -6,6 +6,7 @@ module MetronomeSDK
|
|
|
6
6
|
alert_type: MetronomeSDK::Models::V1::AlertCreateParams::alert_type,
|
|
7
7
|
name: String,
|
|
8
8
|
threshold: Float,
|
|
9
|
+
?alert_specifiers: ::Array[MetronomeSDK::V1::AlertCreateParams::AlertSpecifier],
|
|
9
10
|
?billable_metric_id: String,
|
|
10
11
|
?credit_grant_type_filters: ::Array[String],
|
|
11
12
|
?credit_type_id: String,
|
|
@@ -37,6 +37,7 @@ module MetronomeSDK
|
|
|
37
37
|
?scheduled_charges: ::Array[MetronomeSDK::V1::ContractCreateParams::ScheduledCharge],
|
|
38
38
|
?scheduled_charges_on_usage_invoices: MetronomeSDK::Models::V1::ContractCreateParams::scheduled_charges_on_usage_invoices,
|
|
39
39
|
?spend_threshold_configuration: MetronomeSDK::SpendThresholdConfiguration,
|
|
40
|
+
?spend_trackers: ::Array[MetronomeSDK::V1::ContractCreateParams::SpendTracker],
|
|
40
41
|
?subscriptions: ::Array[MetronomeSDK::V1::ContractCreateParams::Subscription],
|
|
41
42
|
?total_contract_value: Float,
|
|
42
43
|
?transition: MetronomeSDK::V1::ContractCreateParams::Transition,
|
|
@@ -115,6 +116,18 @@ module MetronomeSDK
|
|
|
115
116
|
?request_options: MetronomeSDK::request_opts
|
|
116
117
|
) -> MetronomeSDK::Models::V1::ContractGetNetBalanceResponse
|
|
117
118
|
|
|
119
|
+
def get_subscription_seats_history: (
|
|
120
|
+
contract_id: String,
|
|
121
|
+
customer_id: String,
|
|
122
|
+
subscription_id: String,
|
|
123
|
+
?covering_date: Time?,
|
|
124
|
+
?cursor: String?,
|
|
125
|
+
?ending_before: Time?,
|
|
126
|
+
?limit: Integer?,
|
|
127
|
+
?starting_at: Time?,
|
|
128
|
+
?request_options: MetronomeSDK::request_opts
|
|
129
|
+
) -> MetronomeSDK::Models::V1::ContractGetSubscriptionSeatsHistoryResponse
|
|
130
|
+
|
|
118
131
|
def list_balances: (
|
|
119
132
|
customer_id: String,
|
|
120
133
|
?id: String,
|
|
@@ -141,6 +154,7 @@ module MetronomeSDK
|
|
|
141
154
|
?include_ledgers: bool,
|
|
142
155
|
?limit: Integer,
|
|
143
156
|
?seat_ids: ::Array[String],
|
|
157
|
+
?skip_missing_seat_ids: bool,
|
|
144
158
|
?starting_at: Time,
|
|
145
159
|
?subscription_ids: ::Array[String],
|
|
146
160
|
?request_options: MetronomeSDK::request_opts
|
|
@@ -6,6 +6,7 @@ module MetronomeSDK
|
|
|
6
6
|
def retrieve: (
|
|
7
7
|
alert_id: String,
|
|
8
8
|
customer_id: String,
|
|
9
|
+
?alert_specifiers: ::Array[MetronomeSDK::V1::Customers::AlertRetrieveParams::AlertSpecifier],
|
|
9
10
|
?group_values: ::Array[MetronomeSDK::V1::Customers::AlertRetrieveParams::GroupValue],
|
|
10
11
|
?plans_or_contracts: MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::plans_or_contracts,
|
|
11
12
|
?seat_filter: MetronomeSDK::V1::Customers::AlertRetrieveParams::SeatFilter,
|
|
@@ -22,6 +22,7 @@ module MetronomeSDK
|
|
|
22
22
|
?starting_on: Time,
|
|
23
23
|
?status: String,
|
|
24
24
|
?type: MetronomeSDK::Models::V1::Customers::InvoiceListParams::type_,
|
|
25
|
+
?webhook_notification_id: String,
|
|
25
26
|
?request_options: MetronomeSDK::request_opts
|
|
26
27
|
) -> MetronomeSDK::Internal::CursorPage[MetronomeSDK::V1::Customers::Invoice]
|
|
27
28
|
|
|
@@ -22,6 +22,7 @@ module MetronomeSDK
|
|
|
22
22
|
?scheduled_charges: ::Array[MetronomeSDK::V1::PackageCreateParams::ScheduledCharge],
|
|
23
23
|
?scheduled_charges_on_usage_invoices: MetronomeSDK::Models::V1::PackageCreateParams::scheduled_charges_on_usage_invoices,
|
|
24
24
|
?spend_threshold_configuration: MetronomeSDK::SpendThresholdConfiguration,
|
|
25
|
+
?spend_trackers: ::Array[MetronomeSDK::V1::PackageCreateParams::SpendTracker],
|
|
25
26
|
?subscriptions: ::Array[MetronomeSDK::V1::PackageCreateParams::Subscription],
|
|
26
27
|
?uniqueness_key: String,
|
|
27
28
|
?usage_statement_schedule: MetronomeSDK::V1::PackageCreateParams::UsageStatementSchedule,
|
|
@@ -29,8 +29,6 @@ module MetronomeSDK
|
|
|
29
29
|
|
|
30
30
|
attr_reader packages: MetronomeSDK::Resources::V1::Packages
|
|
31
31
|
|
|
32
|
-
attr_reader payments: MetronomeSDK::Resources::V1::Payments
|
|
33
|
-
|
|
34
32
|
attr_reader settings: MetronomeSDK::Resources::V1::Settings
|
|
35
33
|
|
|
36
34
|
def initialize: (client: MetronomeSDK::Client) -> void
|
|
@@ -37,11 +37,13 @@ module MetronomeSDK
|
|
|
37
37
|
?add_revenue_system_configuration_update: MetronomeSDK::V2::ContractEditParams::AddRevenueSystemConfigurationUpdate,
|
|
38
38
|
?add_scheduled_charges: ::Array[MetronomeSDK::V2::ContractEditParams::AddScheduledCharge],
|
|
39
39
|
?add_spend_threshold_configuration: MetronomeSDK::SpendThresholdConfigurationV2,
|
|
40
|
+
?add_spend_trackers: ::Array[MetronomeSDK::V2::ContractEditParams::AddSpendTracker],
|
|
40
41
|
?add_subscriptions: ::Array[MetronomeSDK::V2::ContractEditParams::AddSubscription],
|
|
41
42
|
?allow_contract_ending_before_finalized_invoice: bool,
|
|
42
43
|
?archive_commits: ::Array[MetronomeSDK::V2::ContractEditParams::ArchiveCommit],
|
|
43
44
|
?archive_credits: ::Array[MetronomeSDK::V2::ContractEditParams::ArchiveCredit],
|
|
44
45
|
?archive_scheduled_charges: ::Array[MetronomeSDK::V2::ContractEditParams::ArchiveScheduledCharge],
|
|
46
|
+
?archive_spend_trackers: ::Array[String],
|
|
45
47
|
?remove_overrides: ::Array[MetronomeSDK::V2::ContractEditParams::RemoveOverride],
|
|
46
48
|
?uniqueness_key: String,
|
|
47
49
|
?update_commits: ::Array[MetronomeSDK::V2::ContractEditParams::UpdateCommit],
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: metronome-sdk
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 3.
|
|
4
|
+
version: 3.8.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Metronome
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-
|
|
11
|
+
date: 2026-07-01 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: cgi
|
|
@@ -133,6 +133,8 @@ files:
|
|
|
133
133
|
- lib/metronome_sdk/models/v1/contract_create_response.rb
|
|
134
134
|
- lib/metronome_sdk/models/v1/contract_get_net_balance_params.rb
|
|
135
135
|
- lib/metronome_sdk/models/v1/contract_get_net_balance_response.rb
|
|
136
|
+
- lib/metronome_sdk/models/v1/contract_get_subscription_seats_history_params.rb
|
|
137
|
+
- lib/metronome_sdk/models/v1/contract_get_subscription_seats_history_response.rb
|
|
136
138
|
- lib/metronome_sdk/models/v1/contract_list_balances_params.rb
|
|
137
139
|
- lib/metronome_sdk/models/v1/contract_list_balances_response.rb
|
|
138
140
|
- lib/metronome_sdk/models/v1/contract_list_params.rb
|
|
@@ -288,13 +290,6 @@ files:
|
|
|
288
290
|
- lib/metronome_sdk/models/v1/package_list_response.rb
|
|
289
291
|
- lib/metronome_sdk/models/v1/package_retrieve_params.rb
|
|
290
292
|
- lib/metronome_sdk/models/v1/package_retrieve_response.rb
|
|
291
|
-
- lib/metronome_sdk/models/v1/payment.rb
|
|
292
|
-
- lib/metronome_sdk/models/v1/payment_attempt_params.rb
|
|
293
|
-
- lib/metronome_sdk/models/v1/payment_attempt_response.rb
|
|
294
|
-
- lib/metronome_sdk/models/v1/payment_cancel_params.rb
|
|
295
|
-
- lib/metronome_sdk/models/v1/payment_cancel_response.rb
|
|
296
|
-
- lib/metronome_sdk/models/v1/payment_list_params.rb
|
|
297
|
-
- lib/metronome_sdk/models/v1/payment_status.rb
|
|
298
293
|
- lib/metronome_sdk/models/v1/plan_detail.rb
|
|
299
294
|
- lib/metronome_sdk/models/v1/plan_get_details_params.rb
|
|
300
295
|
- lib/metronome_sdk/models/v1/plan_get_details_response.rb
|
|
@@ -360,7 +355,6 @@ files:
|
|
|
360
355
|
- lib/metronome_sdk/resources/v1/dashboards.rb
|
|
361
356
|
- lib/metronome_sdk/resources/v1/invoices.rb
|
|
362
357
|
- lib/metronome_sdk/resources/v1/packages.rb
|
|
363
|
-
- lib/metronome_sdk/resources/v1/payments.rb
|
|
364
358
|
- lib/metronome_sdk/resources/v1/plans.rb
|
|
365
359
|
- lib/metronome_sdk/resources/v1/pricing_units.rb
|
|
366
360
|
- lib/metronome_sdk/resources/v1/services.rb
|
|
@@ -454,6 +448,8 @@ files:
|
|
|
454
448
|
- rbi/metronome_sdk/models/v1/contract_create_response.rbi
|
|
455
449
|
- rbi/metronome_sdk/models/v1/contract_get_net_balance_params.rbi
|
|
456
450
|
- rbi/metronome_sdk/models/v1/contract_get_net_balance_response.rbi
|
|
451
|
+
- rbi/metronome_sdk/models/v1/contract_get_subscription_seats_history_params.rbi
|
|
452
|
+
- rbi/metronome_sdk/models/v1/contract_get_subscription_seats_history_response.rbi
|
|
457
453
|
- rbi/metronome_sdk/models/v1/contract_list_balances_params.rbi
|
|
458
454
|
- rbi/metronome_sdk/models/v1/contract_list_balances_response.rbi
|
|
459
455
|
- rbi/metronome_sdk/models/v1/contract_list_params.rbi
|
|
@@ -609,13 +605,6 @@ files:
|
|
|
609
605
|
- rbi/metronome_sdk/models/v1/package_list_response.rbi
|
|
610
606
|
- rbi/metronome_sdk/models/v1/package_retrieve_params.rbi
|
|
611
607
|
- rbi/metronome_sdk/models/v1/package_retrieve_response.rbi
|
|
612
|
-
- rbi/metronome_sdk/models/v1/payment.rbi
|
|
613
|
-
- rbi/metronome_sdk/models/v1/payment_attempt_params.rbi
|
|
614
|
-
- rbi/metronome_sdk/models/v1/payment_attempt_response.rbi
|
|
615
|
-
- rbi/metronome_sdk/models/v1/payment_cancel_params.rbi
|
|
616
|
-
- rbi/metronome_sdk/models/v1/payment_cancel_response.rbi
|
|
617
|
-
- rbi/metronome_sdk/models/v1/payment_list_params.rbi
|
|
618
|
-
- rbi/metronome_sdk/models/v1/payment_status.rbi
|
|
619
608
|
- rbi/metronome_sdk/models/v1/plan_detail.rbi
|
|
620
609
|
- rbi/metronome_sdk/models/v1/plan_get_details_params.rbi
|
|
621
610
|
- rbi/metronome_sdk/models/v1/plan_get_details_response.rbi
|
|
@@ -681,7 +670,6 @@ files:
|
|
|
681
670
|
- rbi/metronome_sdk/resources/v1/dashboards.rbi
|
|
682
671
|
- rbi/metronome_sdk/resources/v1/invoices.rbi
|
|
683
672
|
- rbi/metronome_sdk/resources/v1/packages.rbi
|
|
684
|
-
- rbi/metronome_sdk/resources/v1/payments.rbi
|
|
685
673
|
- rbi/metronome_sdk/resources/v1/plans.rbi
|
|
686
674
|
- rbi/metronome_sdk/resources/v1/pricing_units.rbi
|
|
687
675
|
- rbi/metronome_sdk/resources/v1/services.rbi
|
|
@@ -774,6 +762,8 @@ files:
|
|
|
774
762
|
- sig/metronome_sdk/models/v1/contract_create_response.rbs
|
|
775
763
|
- sig/metronome_sdk/models/v1/contract_get_net_balance_params.rbs
|
|
776
764
|
- sig/metronome_sdk/models/v1/contract_get_net_balance_response.rbs
|
|
765
|
+
- sig/metronome_sdk/models/v1/contract_get_subscription_seats_history_params.rbs
|
|
766
|
+
- sig/metronome_sdk/models/v1/contract_get_subscription_seats_history_response.rbs
|
|
777
767
|
- sig/metronome_sdk/models/v1/contract_list_balances_params.rbs
|
|
778
768
|
- sig/metronome_sdk/models/v1/contract_list_balances_response.rbs
|
|
779
769
|
- sig/metronome_sdk/models/v1/contract_list_params.rbs
|
|
@@ -929,13 +919,6 @@ files:
|
|
|
929
919
|
- sig/metronome_sdk/models/v1/package_list_response.rbs
|
|
930
920
|
- sig/metronome_sdk/models/v1/package_retrieve_params.rbs
|
|
931
921
|
- sig/metronome_sdk/models/v1/package_retrieve_response.rbs
|
|
932
|
-
- sig/metronome_sdk/models/v1/payment.rbs
|
|
933
|
-
- sig/metronome_sdk/models/v1/payment_attempt_params.rbs
|
|
934
|
-
- sig/metronome_sdk/models/v1/payment_attempt_response.rbs
|
|
935
|
-
- sig/metronome_sdk/models/v1/payment_cancel_params.rbs
|
|
936
|
-
- sig/metronome_sdk/models/v1/payment_cancel_response.rbs
|
|
937
|
-
- sig/metronome_sdk/models/v1/payment_list_params.rbs
|
|
938
|
-
- sig/metronome_sdk/models/v1/payment_status.rbs
|
|
939
922
|
- sig/metronome_sdk/models/v1/plan_detail.rbs
|
|
940
923
|
- sig/metronome_sdk/models/v1/plan_get_details_params.rbs
|
|
941
924
|
- sig/metronome_sdk/models/v1/plan_get_details_response.rbs
|
|
@@ -1001,7 +984,6 @@ files:
|
|
|
1001
984
|
- sig/metronome_sdk/resources/v1/dashboards.rbs
|
|
1002
985
|
- sig/metronome_sdk/resources/v1/invoices.rbs
|
|
1003
986
|
- sig/metronome_sdk/resources/v1/packages.rbs
|
|
1004
|
-
- sig/metronome_sdk/resources/v1/payments.rbs
|
|
1005
987
|
- sig/metronome_sdk/resources/v1/plans.rbs
|
|
1006
988
|
- sig/metronome_sdk/resources/v1/pricing_units.rbs
|
|
1007
989
|
- sig/metronome_sdk/resources/v1/services.rbs
|
|
@@ -1,196 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module MetronomeSDK
|
|
4
|
-
module Models
|
|
5
|
-
module V1
|
|
6
|
-
# @see MetronomeSDK::Resources::V1::Payments#list
|
|
7
|
-
class Payment < MetronomeSDK::Internal::Type::BaseModel
|
|
8
|
-
# @!attribute id
|
|
9
|
-
#
|
|
10
|
-
# @return [String]
|
|
11
|
-
required :id, String
|
|
12
|
-
|
|
13
|
-
# @!attribute amount
|
|
14
|
-
#
|
|
15
|
-
# @return [Float, nil]
|
|
16
|
-
optional :amount, Float
|
|
17
|
-
|
|
18
|
-
# @!attribute amount_paid
|
|
19
|
-
#
|
|
20
|
-
# @return [Float, nil]
|
|
21
|
-
optional :amount_paid, Float
|
|
22
|
-
|
|
23
|
-
# @!attribute contract_id
|
|
24
|
-
#
|
|
25
|
-
# @return [String, nil]
|
|
26
|
-
optional :contract_id, String
|
|
27
|
-
|
|
28
|
-
# @!attribute created_at
|
|
29
|
-
#
|
|
30
|
-
# @return [Time, nil]
|
|
31
|
-
optional :created_at, Time
|
|
32
|
-
|
|
33
|
-
# @!attribute customer_id
|
|
34
|
-
#
|
|
35
|
-
# @return [String, nil]
|
|
36
|
-
optional :customer_id, String
|
|
37
|
-
|
|
38
|
-
# @!attribute error_message
|
|
39
|
-
#
|
|
40
|
-
# @return [String, nil]
|
|
41
|
-
optional :error_message, String
|
|
42
|
-
|
|
43
|
-
# @!attribute fiat_credit_type
|
|
44
|
-
#
|
|
45
|
-
# @return [MetronomeSDK::Models::CreditTypeData, nil]
|
|
46
|
-
optional :fiat_credit_type, -> { MetronomeSDK::CreditTypeData }
|
|
47
|
-
|
|
48
|
-
# @!attribute invoice_id
|
|
49
|
-
#
|
|
50
|
-
# @return [String, nil]
|
|
51
|
-
optional :invoice_id, String
|
|
52
|
-
|
|
53
|
-
# @!attribute payment_gateway
|
|
54
|
-
#
|
|
55
|
-
# @return [MetronomeSDK::Models::V1::Payment::PaymentGateway, nil]
|
|
56
|
-
optional :payment_gateway, -> { MetronomeSDK::V1::Payment::PaymentGateway }
|
|
57
|
-
|
|
58
|
-
# @!attribute revenue_system_payments
|
|
59
|
-
#
|
|
60
|
-
# @return [Array<MetronomeSDK::Models::V1::Payment::RevenueSystemPayment>, nil]
|
|
61
|
-
optional :revenue_system_payments,
|
|
62
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Payment::RevenueSystemPayment] }
|
|
63
|
-
|
|
64
|
-
# @!attribute status
|
|
65
|
-
#
|
|
66
|
-
# @return [Symbol, MetronomeSDK::Models::V1::PaymentStatus, nil]
|
|
67
|
-
optional :status, enum: -> { MetronomeSDK::V1::PaymentStatus }
|
|
68
|
-
|
|
69
|
-
# @!attribute updated_at
|
|
70
|
-
#
|
|
71
|
-
# @return [Time, nil]
|
|
72
|
-
optional :updated_at, Time
|
|
73
|
-
|
|
74
|
-
# @!method initialize(id:, amount: nil, amount_paid: nil, contract_id: nil, created_at: nil, customer_id: nil, error_message: nil, fiat_credit_type: nil, invoice_id: nil, payment_gateway: nil, revenue_system_payments: nil, status: nil, updated_at: nil)
|
|
75
|
-
# @param id [String]
|
|
76
|
-
# @param amount [Float]
|
|
77
|
-
# @param amount_paid [Float]
|
|
78
|
-
# @param contract_id [String]
|
|
79
|
-
# @param created_at [Time]
|
|
80
|
-
# @param customer_id [String]
|
|
81
|
-
# @param error_message [String]
|
|
82
|
-
# @param fiat_credit_type [MetronomeSDK::Models::CreditTypeData]
|
|
83
|
-
# @param invoice_id [String]
|
|
84
|
-
# @param payment_gateway [MetronomeSDK::Models::V1::Payment::PaymentGateway]
|
|
85
|
-
# @param revenue_system_payments [Array<MetronomeSDK::Models::V1::Payment::RevenueSystemPayment>]
|
|
86
|
-
# @param status [Symbol, MetronomeSDK::Models::V1::PaymentStatus]
|
|
87
|
-
# @param updated_at [Time]
|
|
88
|
-
|
|
89
|
-
# @see MetronomeSDK::Models::V1::Payment#payment_gateway
|
|
90
|
-
class PaymentGateway < MetronomeSDK::Internal::Type::BaseModel
|
|
91
|
-
# @!attribute stripe
|
|
92
|
-
#
|
|
93
|
-
# @return [MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe]
|
|
94
|
-
required :stripe, -> { MetronomeSDK::V1::Payment::PaymentGateway::Stripe }
|
|
95
|
-
|
|
96
|
-
# @!attribute type
|
|
97
|
-
#
|
|
98
|
-
# @return [Symbol, MetronomeSDK::Models::V1::Payment::PaymentGateway::Type]
|
|
99
|
-
required :type, enum: -> { MetronomeSDK::V1::Payment::PaymentGateway::Type }
|
|
100
|
-
|
|
101
|
-
# @!method initialize(stripe:, type:)
|
|
102
|
-
# @param stripe [MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe]
|
|
103
|
-
# @param type [Symbol, MetronomeSDK::Models::V1::Payment::PaymentGateway::Type]
|
|
104
|
-
|
|
105
|
-
# @see MetronomeSDK::Models::V1::Payment::PaymentGateway#stripe
|
|
106
|
-
class Stripe < MetronomeSDK::Internal::Type::BaseModel
|
|
107
|
-
# @!attribute payment_intent_id
|
|
108
|
-
#
|
|
109
|
-
# @return [String]
|
|
110
|
-
required :payment_intent_id, String
|
|
111
|
-
|
|
112
|
-
# @!attribute error
|
|
113
|
-
#
|
|
114
|
-
# @return [MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe::Error, nil]
|
|
115
|
-
optional :error, -> { MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error }
|
|
116
|
-
|
|
117
|
-
# @!attribute payment_method_id
|
|
118
|
-
#
|
|
119
|
-
# @return [String, nil]
|
|
120
|
-
optional :payment_method_id, String
|
|
121
|
-
|
|
122
|
-
# @!method initialize(payment_intent_id:, error: nil, payment_method_id: nil)
|
|
123
|
-
# @param payment_intent_id [String]
|
|
124
|
-
# @param error [MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe::Error]
|
|
125
|
-
# @param payment_method_id [String]
|
|
126
|
-
|
|
127
|
-
# @see MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe#error
|
|
128
|
-
class Error < MetronomeSDK::Internal::Type::BaseModel
|
|
129
|
-
# @!attribute code
|
|
130
|
-
#
|
|
131
|
-
# @return [String, nil]
|
|
132
|
-
optional :code, String
|
|
133
|
-
|
|
134
|
-
# @!attribute decline_code
|
|
135
|
-
#
|
|
136
|
-
# @return [String, nil]
|
|
137
|
-
optional :decline_code, String
|
|
138
|
-
|
|
139
|
-
# @!attribute type
|
|
140
|
-
#
|
|
141
|
-
# @return [String, nil]
|
|
142
|
-
optional :type, String
|
|
143
|
-
|
|
144
|
-
# @!method initialize(code: nil, decline_code: nil, type: nil)
|
|
145
|
-
# @param code [String]
|
|
146
|
-
# @param decline_code [String]
|
|
147
|
-
# @param type [String]
|
|
148
|
-
end
|
|
149
|
-
end
|
|
150
|
-
|
|
151
|
-
# @see MetronomeSDK::Models::V1::Payment::PaymentGateway#type
|
|
152
|
-
module Type
|
|
153
|
-
extend MetronomeSDK::Internal::Type::Enum
|
|
154
|
-
|
|
155
|
-
STRIPE = :stripe
|
|
156
|
-
|
|
157
|
-
# @!method self.values
|
|
158
|
-
# @return [Array<Symbol>]
|
|
159
|
-
end
|
|
160
|
-
end
|
|
161
|
-
|
|
162
|
-
class RevenueSystemPayment < MetronomeSDK::Internal::Type::BaseModel
|
|
163
|
-
# @!attribute revenue_system_provider
|
|
164
|
-
#
|
|
165
|
-
# @return [String]
|
|
166
|
-
required :revenue_system_provider, String
|
|
167
|
-
|
|
168
|
-
# @!attribute sync_status
|
|
169
|
-
#
|
|
170
|
-
# @return [String]
|
|
171
|
-
required :sync_status, String
|
|
172
|
-
|
|
173
|
-
# @!attribute error_message
|
|
174
|
-
# The error message from the revenue system, if available.
|
|
175
|
-
#
|
|
176
|
-
# @return [String, nil]
|
|
177
|
-
optional :error_message, String
|
|
178
|
-
|
|
179
|
-
# @!attribute revenue_system_external_payment_id
|
|
180
|
-
#
|
|
181
|
-
# @return [String, nil]
|
|
182
|
-
optional :revenue_system_external_payment_id, String
|
|
183
|
-
|
|
184
|
-
# @!method initialize(revenue_system_provider:, sync_status:, error_message: nil, revenue_system_external_payment_id: nil)
|
|
185
|
-
# @param revenue_system_provider [String]
|
|
186
|
-
#
|
|
187
|
-
# @param sync_status [String]
|
|
188
|
-
#
|
|
189
|
-
# @param error_message [String] The error message from the revenue system, if available.
|
|
190
|
-
#
|
|
191
|
-
# @param revenue_system_external_payment_id [String]
|
|
192
|
-
end
|
|
193
|
-
end
|
|
194
|
-
end
|
|
195
|
-
end
|
|
196
|
-
end
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module MetronomeSDK
|
|
4
|
-
module Models
|
|
5
|
-
module V1
|
|
6
|
-
# @see MetronomeSDK::Resources::V1::Payments#attempt
|
|
7
|
-
class PaymentAttemptParams < MetronomeSDK::Internal::Type::BaseModel
|
|
8
|
-
extend MetronomeSDK::Internal::Type::RequestParameters::Converter
|
|
9
|
-
include MetronomeSDK::Internal::Type::RequestParameters
|
|
10
|
-
|
|
11
|
-
# @!attribute customer_id
|
|
12
|
-
#
|
|
13
|
-
# @return [String]
|
|
14
|
-
required :customer_id, String
|
|
15
|
-
|
|
16
|
-
# @!attribute invoice_id
|
|
17
|
-
#
|
|
18
|
-
# @return [String]
|
|
19
|
-
required :invoice_id, String
|
|
20
|
-
|
|
21
|
-
# @!method initialize(customer_id:, invoice_id:, request_options: {})
|
|
22
|
-
# @param customer_id [String]
|
|
23
|
-
# @param invoice_id [String]
|
|
24
|
-
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
25
|
-
end
|
|
26
|
-
end
|
|
27
|
-
end
|
|
28
|
-
end
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module MetronomeSDK
|
|
4
|
-
module Models
|
|
5
|
-
module V1
|
|
6
|
-
# @see MetronomeSDK::Resources::V1::Payments#attempt
|
|
7
|
-
class PaymentAttemptResponse < MetronomeSDK::Internal::Type::BaseModel
|
|
8
|
-
# @!attribute data
|
|
9
|
-
#
|
|
10
|
-
# @return [MetronomeSDK::Models::V1::Payment]
|
|
11
|
-
required :data, -> { MetronomeSDK::V1::Payment }
|
|
12
|
-
|
|
13
|
-
# @!method initialize(data:)
|
|
14
|
-
# @param data [MetronomeSDK::Models::V1::Payment]
|
|
15
|
-
end
|
|
16
|
-
end
|
|
17
|
-
end
|
|
18
|
-
end
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module MetronomeSDK
|
|
4
|
-
module Models
|
|
5
|
-
module V1
|
|
6
|
-
# @see MetronomeSDK::Resources::V1::Payments#cancel
|
|
7
|
-
class PaymentCancelParams < MetronomeSDK::Internal::Type::BaseModel
|
|
8
|
-
extend MetronomeSDK::Internal::Type::RequestParameters::Converter
|
|
9
|
-
include MetronomeSDK::Internal::Type::RequestParameters
|
|
10
|
-
|
|
11
|
-
# @!attribute customer_id
|
|
12
|
-
#
|
|
13
|
-
# @return [String]
|
|
14
|
-
required :customer_id, String
|
|
15
|
-
|
|
16
|
-
# @!attribute invoice_id
|
|
17
|
-
#
|
|
18
|
-
# @return [String]
|
|
19
|
-
required :invoice_id, String
|
|
20
|
-
|
|
21
|
-
# @!method initialize(customer_id:, invoice_id:, request_options: {})
|
|
22
|
-
# @param customer_id [String]
|
|
23
|
-
# @param invoice_id [String]
|
|
24
|
-
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
25
|
-
end
|
|
26
|
-
end
|
|
27
|
-
end
|
|
28
|
-
end
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module MetronomeSDK
|
|
4
|
-
module Models
|
|
5
|
-
module V1
|
|
6
|
-
# @see MetronomeSDK::Resources::V1::Payments#cancel
|
|
7
|
-
class PaymentCancelResponse < MetronomeSDK::Internal::Type::BaseModel
|
|
8
|
-
# @!attribute data
|
|
9
|
-
#
|
|
10
|
-
# @return [MetronomeSDK::Models::V1::Payment]
|
|
11
|
-
required :data, -> { MetronomeSDK::V1::Payment }
|
|
12
|
-
|
|
13
|
-
# @!method initialize(data:)
|
|
14
|
-
# @param data [MetronomeSDK::Models::V1::Payment]
|
|
15
|
-
end
|
|
16
|
-
end
|
|
17
|
-
end
|
|
18
|
-
end
|
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module MetronomeSDK
|
|
4
|
-
module Models
|
|
5
|
-
module V1
|
|
6
|
-
# @see MetronomeSDK::Resources::V1::Payments#list
|
|
7
|
-
class PaymentListParams < MetronomeSDK::Internal::Type::BaseModel
|
|
8
|
-
extend MetronomeSDK::Internal::Type::RequestParameters::Converter
|
|
9
|
-
include MetronomeSDK::Internal::Type::RequestParameters
|
|
10
|
-
|
|
11
|
-
# @!attribute customer_id
|
|
12
|
-
#
|
|
13
|
-
# @return [String]
|
|
14
|
-
required :customer_id, String
|
|
15
|
-
|
|
16
|
-
# @!attribute invoice_id
|
|
17
|
-
#
|
|
18
|
-
# @return [String]
|
|
19
|
-
required :invoice_id, String
|
|
20
|
-
|
|
21
|
-
# @!attribute limit
|
|
22
|
-
# The maximum number of payments to return. Defaults to 25.
|
|
23
|
-
#
|
|
24
|
-
# @return [Integer, nil]
|
|
25
|
-
optional :limit, Integer
|
|
26
|
-
|
|
27
|
-
# @!attribute next_page
|
|
28
|
-
# The next page token from a previous response.
|
|
29
|
-
#
|
|
30
|
-
# @return [String, nil]
|
|
31
|
-
optional :next_page, String
|
|
32
|
-
|
|
33
|
-
# @!attribute statuses
|
|
34
|
-
#
|
|
35
|
-
# @return [Array<Symbol, MetronomeSDK::Models::V1::PaymentStatus>, nil]
|
|
36
|
-
optional :statuses, -> { MetronomeSDK::Internal::Type::ArrayOf[enum: MetronomeSDK::V1::PaymentStatus] }
|
|
37
|
-
|
|
38
|
-
# @!method initialize(customer_id:, invoice_id:, limit: nil, next_page: nil, statuses: nil, request_options: {})
|
|
39
|
-
# @param customer_id [String]
|
|
40
|
-
#
|
|
41
|
-
# @param invoice_id [String]
|
|
42
|
-
#
|
|
43
|
-
# @param limit [Integer] The maximum number of payments to return. Defaults to 25.
|
|
44
|
-
#
|
|
45
|
-
# @param next_page [String] The next page token from a previous response.
|
|
46
|
-
#
|
|
47
|
-
# @param statuses [Array<Symbol, MetronomeSDK::Models::V1::PaymentStatus>]
|
|
48
|
-
#
|
|
49
|
-
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
50
|
-
end
|
|
51
|
-
end
|
|
52
|
-
end
|
|
53
|
-
end
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module MetronomeSDK
|
|
4
|
-
module Models
|
|
5
|
-
module V1
|
|
6
|
-
module PaymentStatus
|
|
7
|
-
extend MetronomeSDK::Internal::Type::Enum
|
|
8
|
-
|
|
9
|
-
PENDING = :pending
|
|
10
|
-
REQUIRES_INTERVENTION = :requires_intervention
|
|
11
|
-
PAID = :paid
|
|
12
|
-
CANCELED = :canceled
|
|
13
|
-
|
|
14
|
-
# @!method self.values
|
|
15
|
-
# @return [Array<Symbol>]
|
|
16
|
-
end
|
|
17
|
-
end
|
|
18
|
-
end
|
|
19
|
-
end
|
|
@@ -1,102 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module MetronomeSDK
|
|
4
|
-
module Resources
|
|
5
|
-
class V1
|
|
6
|
-
class Payments
|
|
7
|
-
# Fetch all payment attempts for the given invoice.
|
|
8
|
-
#
|
|
9
|
-
# @overload list(customer_id:, invoice_id:, limit: nil, next_page: nil, statuses: nil, request_options: {})
|
|
10
|
-
#
|
|
11
|
-
# @param customer_id [String]
|
|
12
|
-
#
|
|
13
|
-
# @param invoice_id [String]
|
|
14
|
-
#
|
|
15
|
-
# @param limit [Integer] The maximum number of payments to return. Defaults to 25.
|
|
16
|
-
#
|
|
17
|
-
# @param next_page [String] The next page token from a previous response.
|
|
18
|
-
#
|
|
19
|
-
# @param statuses [Array<Symbol, MetronomeSDK::Models::V1::PaymentStatus>]
|
|
20
|
-
#
|
|
21
|
-
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
22
|
-
#
|
|
23
|
-
# @return [MetronomeSDK::Internal::BodyCursorPage<MetronomeSDK::Models::V1::Payment>]
|
|
24
|
-
#
|
|
25
|
-
# @see MetronomeSDK::Models::V1::PaymentListParams
|
|
26
|
-
def list(params)
|
|
27
|
-
parsed, options = MetronomeSDK::V1::PaymentListParams.dump_request(params)
|
|
28
|
-
@client.request(
|
|
29
|
-
method: :post,
|
|
30
|
-
path: "v1/payments/list",
|
|
31
|
-
body: parsed,
|
|
32
|
-
page: MetronomeSDK::Internal::BodyCursorPage,
|
|
33
|
-
model: MetronomeSDK::V1::Payment,
|
|
34
|
-
options: options
|
|
35
|
-
)
|
|
36
|
-
end
|
|
37
|
-
|
|
38
|
-
# Trigger a new attempt by canceling any existing attempts for this invoice and
|
|
39
|
-
# creating a new Payment. This will trigger another attempt to charge the
|
|
40
|
-
# Customer's configured Payment Gateway. Payment can only be attempted if all of
|
|
41
|
-
# the following are true:
|
|
42
|
-
#
|
|
43
|
-
# - The Metronome Invoice is finalized
|
|
44
|
-
# - PLG Invoicing is configured for the Customer
|
|
45
|
-
# - You cannot attempt payments for invoices that have already been `paid` or
|
|
46
|
-
# `voided`.
|
|
47
|
-
#
|
|
48
|
-
# Attempting to payment on an ineligible Invoice or Customer will result in a
|
|
49
|
-
# `400` response.
|
|
50
|
-
#
|
|
51
|
-
# @overload attempt(customer_id:, invoice_id:, request_options: {})
|
|
52
|
-
#
|
|
53
|
-
# @param customer_id [String]
|
|
54
|
-
# @param invoice_id [String]
|
|
55
|
-
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
56
|
-
#
|
|
57
|
-
# @return [MetronomeSDK::Models::V1::PaymentAttemptResponse]
|
|
58
|
-
#
|
|
59
|
-
# @see MetronomeSDK::Models::V1::PaymentAttemptParams
|
|
60
|
-
def attempt(params)
|
|
61
|
-
parsed, options = MetronomeSDK::V1::PaymentAttemptParams.dump_request(params)
|
|
62
|
-
@client.request(
|
|
63
|
-
method: :post,
|
|
64
|
-
path: "v1/payments/attempt",
|
|
65
|
-
body: parsed,
|
|
66
|
-
model: MetronomeSDK::Models::V1::PaymentAttemptResponse,
|
|
67
|
-
options: options
|
|
68
|
-
)
|
|
69
|
-
end
|
|
70
|
-
|
|
71
|
-
# Cancel an existing payment attempt for an invoice.
|
|
72
|
-
#
|
|
73
|
-
# @overload cancel(customer_id:, invoice_id:, request_options: {})
|
|
74
|
-
#
|
|
75
|
-
# @param customer_id [String]
|
|
76
|
-
# @param invoice_id [String]
|
|
77
|
-
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
78
|
-
#
|
|
79
|
-
# @return [MetronomeSDK::Models::V1::PaymentCancelResponse]
|
|
80
|
-
#
|
|
81
|
-
# @see MetronomeSDK::Models::V1::PaymentCancelParams
|
|
82
|
-
def cancel(params)
|
|
83
|
-
parsed, options = MetronomeSDK::V1::PaymentCancelParams.dump_request(params)
|
|
84
|
-
@client.request(
|
|
85
|
-
method: :post,
|
|
86
|
-
path: "v1/payments/cancel",
|
|
87
|
-
body: parsed,
|
|
88
|
-
model: MetronomeSDK::Models::V1::PaymentCancelResponse,
|
|
89
|
-
options: options
|
|
90
|
-
)
|
|
91
|
-
end
|
|
92
|
-
|
|
93
|
-
# @api private
|
|
94
|
-
#
|
|
95
|
-
# @param client [MetronomeSDK::Client]
|
|
96
|
-
def initialize(client:)
|
|
97
|
-
@client = client
|
|
98
|
-
end
|
|
99
|
-
end
|
|
100
|
-
end
|
|
101
|
-
end
|
|
102
|
-
end
|