lago_ruby 0.46.1.pre.beta → 0.49.0.pre.beta
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +15 -10
- data/docs/AddOnBaseInput.md +2 -0
- data/docs/AddOnCreateInputAddOn.md +2 -0
- data/docs/AddOnObject.md +2 -0
- data/docs/BillableMetricBaseInput.md +3 -1
- data/docs/BillableMetricCreateInputBillableMetric.md +3 -1
- data/docs/BillableMetricObject.md +3 -1
- data/docs/ChargeObject.md +2 -0
- data/docs/CouponObject.md +3 -1
- data/docs/CreditNoteItemObjectFee.md +2 -0
- data/docs/CreditObjectItem.md +2 -2
- data/docs/CustomerChargeUsageObject.md +2 -0
- data/docs/CustomerChargeUsageObjectGroupsInner.md +2 -0
- data/docs/CustomerPastUsage.md +20 -0
- data/docs/CustomerUsageObject.md +2 -0
- data/docs/CustomersApi.md +82 -0
- data/docs/EventInputEvent.md +2 -2
- data/docs/EventInputEventTimestamp.md +15 -0
- data/docs/EventObject.md +1 -1
- data/docs/FeeObject.md +2 -0
- data/docs/FeeObjectItem.md +2 -0
- data/docs/GroupPropertiesObject.md +2 -0
- data/docs/InvoiceOneOffCreateInputInvoiceFeesInner.md +2 -0
- data/docs/PlanCreateInputPlan.md +3 -1
- data/docs/PlanCreateInputPlanChargesInner.md +2 -0
- data/docs/PlanObject.md +3 -1
- data/docs/PlanUpdateInputPlan.md +3 -1
- data/docs/PlanUpdateInputPlanChargesInner.md +2 -0
- data/docs/SubscriptionCreateInputSubscription.md +2 -0
- data/docs/SubscriptionObject.md +2 -0
- data/docs/SubscriptionUpdateInputSubscription.md +2 -0
- data/docs/SubscriptionsApi.md +70 -0
- data/docs/WebhookEndpoint.md +18 -0
- data/docs/WebhookEndpointCreateInput.md +18 -0
- data/docs/WebhookEndpointCreateInputWebhookEndpoint.md +20 -0
- data/docs/WebhookEndpointObject.md +26 -0
- data/docs/WebhookEndpointUpdateInput.md +18 -0
- data/docs/WebhookEndpointsApi.md +28 -28
- data/docs/WebhookEndpointsPaginated.md +20 -0
- data/lago_ruby.gemspec +2 -2
- data/lib/lago_ruby/api/add_ons_api.rb +2 -2
- data/lib/lago_ruby/api/billable_metrics_api.rb +2 -2
- data/lib/lago_ruby/api/coupons_api.rb +2 -2
- data/lib/lago_ruby/api/credit_notes_api.rb +2 -2
- data/lib/lago_ruby/api/customers_api.rb +84 -2
- data/lib/lago_ruby/api/events_api.rb +2 -2
- data/lib/lago_ruby/api/fees_api.rb +2 -2
- data/lib/lago_ruby/api/invoices_api.rb +2 -2
- data/lib/lago_ruby/api/organizations_api.rb +2 -2
- data/lib/lago_ruby/api/plans_api.rb +2 -2
- data/lib/lago_ruby/api/subscriptions_api.rb +65 -2
- data/lib/lago_ruby/api/taxes_api.rb +2 -2
- data/lib/lago_ruby/api/wallets_api.rb +2 -2
- data/lib/lago_ruby/api/webhook_endpoints_api.rb +35 -35
- data/lib/lago_ruby/api/webhooks_api.rb +2 -2
- data/lib/lago_ruby/api_client.rb +4 -3
- data/lib/lago_ruby/api_error.rb +2 -2
- data/lib/lago_ruby/configuration.rb +3 -2
- data/lib/lago_ruby/models/add_on.rb +2 -2
- data/lib/lago_ruby/models/add_on_base_input.rb +13 -3
- data/lib/lago_ruby/models/add_on_create_input.rb +2 -2
- data/lib/lago_ruby/models/add_on_create_input_add_on.rb +13 -3
- data/lib/lago_ruby/models/add_on_object.rb +13 -3
- data/lib/lago_ruby/models/add_on_update_input.rb +2 -2
- data/lib/lago_ruby/models/add_ons_paginated.rb +2 -2
- data/lib/lago_ruby/models/api_error_bad_request.rb +2 -2
- data/lib/lago_ruby/models/api_error_forbidden.rb +2 -2
- data/lib/lago_ruby/models/api_error_not_allowed.rb +2 -2
- data/lib/lago_ruby/models/api_error_not_found.rb +2 -2
- data/lib/lago_ruby/models/api_error_unauthorized.rb +2 -2
- data/lib/lago_ruby/models/api_error_unprocessable_entity.rb +2 -2
- data/lib/lago_ruby/models/applied_coupon.rb +2 -2
- data/lib/lago_ruby/models/applied_coupon_input.rb +2 -2
- data/lib/lago_ruby/models/applied_coupon_input_applied_coupon.rb +2 -2
- data/lib/lago_ruby/models/applied_coupon_object.rb +2 -2
- data/lib/lago_ruby/models/applied_coupon_object_extended.rb +2 -2
- data/lib/lago_ruby/models/applied_coupons_paginated.rb +2 -2
- data/lib/lago_ruby/models/base_applied_tax.rb +2 -2
- data/lib/lago_ruby/models/billable_metric.rb +2 -2
- data/lib/lago_ruby/models/billable_metric_base_input.rb +29 -6
- data/lib/lago_ruby/models/billable_metric_create_input.rb +2 -2
- data/lib/lago_ruby/models/billable_metric_create_input_billable_metric.rb +29 -6
- data/lib/lago_ruby/models/billable_metric_group.rb +2 -2
- data/lib/lago_ruby/models/billable_metric_group_values_inner.rb +2 -2
- data/lib/lago_ruby/models/billable_metric_group_values_inner_one_of.rb +2 -2
- data/lib/lago_ruby/models/billable_metric_object.rb +29 -6
- data/lib/lago_ruby/models/billable_metric_update_input.rb +2 -2
- data/lib/lago_ruby/models/billable_metrics_paginated.rb +2 -2
- data/lib/lago_ruby/models/charge_object.rb +13 -3
- data/lib/lago_ruby/models/charge_object_properties.rb +2 -2
- data/lib/lago_ruby/models/charge_properties.rb +2 -2
- data/lib/lago_ruby/models/charge_properties_graduated_percentage_ranges_inner.rb +2 -2
- data/lib/lago_ruby/models/charge_properties_graduated_ranges_inner.rb +2 -2
- data/lib/lago_ruby/models/charge_properties_volume_ranges_inner.rb +2 -2
- data/lib/lago_ruby/models/country.rb +2 -2
- data/lib/lago_ruby/models/coupon.rb +2 -2
- data/lib/lago_ruby/models/coupon_base_input.rb +2 -2
- data/lib/lago_ruby/models/coupon_base_input_applies_to.rb +2 -2
- data/lib/lago_ruby/models/coupon_create_input.rb +2 -2
- data/lib/lago_ruby/models/coupon_create_input_coupon.rb +2 -2
- data/lib/lago_ruby/models/coupon_object.rb +16 -6
- data/lib/lago_ruby/models/coupon_update_input.rb +2 -2
- data/lib/lago_ruby/models/coupons_paginated.rb +2 -2
- data/lib/lago_ruby/models/credit_note.rb +2 -2
- data/lib/lago_ruby/models/credit_note_applied_tax_object.rb +2 -2
- data/lib/lago_ruby/models/credit_note_create_input.rb +2 -2
- data/lib/lago_ruby/models/credit_note_create_input_credit_note.rb +2 -2
- data/lib/lago_ruby/models/credit_note_create_input_credit_note_items_inner.rb +2 -2
- data/lib/lago_ruby/models/credit_note_item_object.rb +2 -2
- data/lib/lago_ruby/models/credit_note_item_object_fee.rb +13 -3
- data/lib/lago_ruby/models/credit_note_object.rb +2 -2
- data/lib/lago_ruby/models/credit_note_update_input.rb +2 -2
- data/lib/lago_ruby/models/credit_note_update_input_credit_note.rb +2 -2
- data/lib/lago_ruby/models/credit_notes.rb +2 -2
- data/lib/lago_ruby/models/credit_object.rb +2 -2
- data/lib/lago_ruby/models/credit_object_invoice.rb +2 -2
- data/lib/lago_ruby/models/credit_object_item.rb +13 -13
- data/lib/lago_ruby/models/currency.rb +2 -2
- data/lib/lago_ruby/models/customer.rb +2 -2
- data/lib/lago_ruby/models/customer_billing_configuration.rb +2 -2
- data/lib/lago_ruby/models/customer_charge_usage_object.rb +20 -3
- data/lib/lago_ruby/models/customer_charge_usage_object_billable_metric.rb +2 -2
- data/lib/lago_ruby/models/customer_charge_usage_object_charge.rb +2 -2
- data/lib/lago_ruby/models/customer_charge_usage_object_groups_inner.rb +13 -3
- data/lib/lago_ruby/models/customer_create_input.rb +2 -2
- data/lib/lago_ruby/models/customer_create_input_customer.rb +2 -2
- data/lib/lago_ruby/models/customer_create_input_customer_metadata_inner.rb +2 -2
- data/lib/lago_ruby/models/customer_metadata.rb +2 -2
- data/lib/lago_ruby/models/customer_object.rb +2 -2
- data/lib/lago_ruby/models/customer_object_extended.rb +2 -2
- data/lib/lago_ruby/models/customer_past_usage.rb +239 -0
- data/lib/lago_ruby/models/customer_usage.rb +2 -2
- data/lib/lago_ruby/models/customer_usage_object.rb +14 -3
- data/lib/lago_ruby/models/customers_paginated.rb +2 -2
- data/lib/lago_ruby/models/event.rb +2 -2
- data/lib/lago_ruby/models/event_batch_input.rb +2 -2
- data/lib/lago_ruby/models/event_batch_input_event.rb +2 -2
- data/lib/lago_ruby/models/event_batch_input_event_properties.rb +2 -2
- data/lib/lago_ruby/models/event_estimate_fees_input.rb +2 -2
- data/lib/lago_ruby/models/event_estimate_fees_input_event.rb +2 -2
- data/lib/lago_ruby/models/event_input.rb +2 -2
- data/lib/lago_ruby/models/event_input_event.rb +3 -4
- data/lib/lago_ruby/models/event_input_event_timestamp.rb +105 -0
- data/lib/lago_ruby/models/event_object.rb +2 -2
- data/lib/lago_ruby/models/event_object_properties.rb +2 -2
- data/lib/lago_ruby/models/fee.rb +2 -2
- data/lib/lago_ruby/models/fee_applied_tax_object.rb +2 -2
- data/lib/lago_ruby/models/fee_object.rb +13 -3
- data/lib/lago_ruby/models/fee_object_item.rb +13 -3
- data/lib/lago_ruby/models/fee_update_input.rb +2 -2
- data/lib/lago_ruby/models/fee_update_input_fee.rb +2 -2
- data/lib/lago_ruby/models/fees.rb +2 -2
- data/lib/lago_ruby/models/fees_paginated.rb +2 -2
- data/lib/lago_ruby/models/get_customer_portal_url200_response.rb +2 -2
- data/lib/lago_ruby/models/get_customer_portal_url200_response_customer.rb +2 -2
- data/lib/lago_ruby/models/group_object.rb +2 -2
- data/lib/lago_ruby/models/group_properties_object.rb +13 -3
- data/lib/lago_ruby/models/group_properties_object_values.rb +2 -2
- data/lib/lago_ruby/models/groups_paginated.rb +2 -2
- data/lib/lago_ruby/models/invoice.rb +2 -2
- data/lib/lago_ruby/models/invoice_applied_tax_object.rb +2 -2
- data/lib/lago_ruby/models/invoice_metadata_object.rb +2 -2
- data/lib/lago_ruby/models/invoice_object.rb +2 -2
- data/lib/lago_ruby/models/invoice_object_customer.rb +2 -2
- data/lib/lago_ruby/models/invoice_object_extended.rb +2 -2
- data/lib/lago_ruby/models/invoice_one_off_create_input.rb +2 -2
- data/lib/lago_ruby/models/invoice_one_off_create_input_invoice.rb +2 -2
- data/lib/lago_ruby/models/invoice_one_off_create_input_invoice_fees_inner.rb +13 -3
- data/lib/lago_ruby/models/invoice_update_input.rb +2 -2
- data/lib/lago_ruby/models/invoice_update_input_invoice.rb +2 -2
- data/lib/lago_ruby/models/invoice_update_input_invoice_metadata_inner.rb +2 -2
- data/lib/lago_ruby/models/invoices_paginated.rb +2 -2
- data/lib/lago_ruby/models/organization.rb +2 -2
- data/lib/lago_ruby/models/organization_billing_configuration.rb +2 -2
- data/lib/lago_ruby/models/organization_object.rb +2 -2
- data/lib/lago_ruby/models/organization_update_input.rb +2 -2
- data/lib/lago_ruby/models/organization_update_input_organization.rb +2 -2
- data/lib/lago_ruby/models/pagination_meta.rb +2 -2
- data/lib/lago_ruby/models/plan.rb +2 -2
- data/lib/lago_ruby/models/plan_create_input.rb +2 -2
- data/lib/lago_ruby/models/plan_create_input_plan.rb +13 -3
- data/lib/lago_ruby/models/plan_create_input_plan_charges_inner.rb +13 -3
- data/lib/lago_ruby/models/plan_create_input_plan_charges_inner_group_properties_inner.rb +2 -2
- data/lib/lago_ruby/models/plan_object.rb +13 -3
- data/lib/lago_ruby/models/plan_update_input.rb +2 -2
- data/lib/lago_ruby/models/plan_update_input_plan.rb +13 -3
- data/lib/lago_ruby/models/plan_update_input_plan_charges_inner.rb +13 -3
- data/lib/lago_ruby/models/plans_paginated.rb +2 -2
- data/lib/lago_ruby/models/subscription.rb +2 -2
- data/lib/lago_ruby/models/subscription_create_input.rb +2 -2
- data/lib/lago_ruby/models/subscription_create_input_subscription.rb +13 -3
- data/lib/lago_ruby/models/subscription_object.rb +13 -3
- data/lib/lago_ruby/models/subscription_update_input.rb +2 -2
- data/lib/lago_ruby/models/subscription_update_input_subscription.rb +13 -3
- data/lib/lago_ruby/models/subscriptions_paginated.rb +2 -2
- data/lib/lago_ruby/models/tax.rb +2 -2
- data/lib/lago_ruby/models/tax_base_input.rb +2 -2
- data/lib/lago_ruby/models/tax_create_input.rb +2 -2
- data/lib/lago_ruby/models/tax_create_input_tax.rb +2 -2
- data/lib/lago_ruby/models/tax_object.rb +2 -2
- data/lib/lago_ruby/models/tax_update_input.rb +2 -2
- data/lib/lago_ruby/models/taxes_paginated.rb +2 -2
- data/lib/lago_ruby/models/timezone.rb +2 -2
- data/lib/lago_ruby/models/wallet.rb +2 -2
- data/lib/lago_ruby/models/wallet_create_input.rb +2 -2
- data/lib/lago_ruby/models/wallet_create_input_wallet.rb +2 -2
- data/lib/lago_ruby/models/wallet_object.rb +2 -2
- data/lib/lago_ruby/models/wallet_transaction_create_input.rb +2 -2
- data/lib/lago_ruby/models/wallet_transaction_create_input_wallet_transaction.rb +2 -2
- data/lib/lago_ruby/models/wallet_transaction_object.rb +2 -2
- data/lib/lago_ruby/models/wallet_transactions.rb +2 -2
- data/lib/lago_ruby/models/wallet_transactions_paginated.rb +2 -2
- data/lib/lago_ruby/models/wallet_update_input.rb +2 -2
- data/lib/lago_ruby/models/wallet_update_input_wallet.rb +2 -2
- data/lib/lago_ruby/models/wallets_paginated.rb +2 -2
- data/lib/lago_ruby/models/webhook_endpoint.rb +221 -0
- data/lib/lago_ruby/models/webhook_endpoint_create_input.rb +214 -0
- data/lib/lago_ruby/models/webhook_endpoint_create_input_webhook_endpoint.rb +267 -0
- data/lib/lago_ruby/models/webhook_endpoint_object.rb +317 -0
- data/lib/lago_ruby/models/webhook_endpoint_update_input.rb +214 -0
- data/lib/lago_ruby/models/webhook_endpoints_paginated.rb +239 -0
- data/lib/lago_ruby/version.rb +3 -3
- data/lib/lago_ruby.rb +10 -7
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/customer_past_usage_spec.rb +42 -0
- data/spec/models/event_input_event_timestamp_spec.rb +21 -0
- data/spec/models/{create_webhook_endpoint_request_spec.rb → webhook_endpoint_create_input_spec.rb} +8 -8
- data/spec/models/{create_webhook_endpoint_request_webhook_endpoint_spec.rb → webhook_endpoint_create_input_webhook_endpoint_spec.rb} +8 -8
- data/spec/models/{create_webhook_endpoint200_response_webhook_endpoint_spec.rb → webhook_endpoint_object_spec.rb} +8 -8
- data/spec/models/{create_webhook_endpoint200_response_spec.rb → webhook_endpoint_spec.rb} +8 -8
- data/spec/models/webhook_endpoint_update_input_spec.rb +34 -0
- data/spec/models/{find_all_webhook_endpoints200_response_spec.rb → webhook_endpoints_paginated_spec.rb} +8 -8
- data/spec/spec_helper.rb +2 -2
- metadata +179 -157
@@ -8,6 +8,7 @@
|
|
8
8
|
| **charge_model** | **String** | Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage` `package`, `percentage` or `volume`. | [optional] |
|
9
9
|
| **pay_in_advance** | **Boolean** | This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period. | [optional] |
|
10
10
|
| **invoiceable** | **Boolean** | This field specifies whether the charge should be included in a proper invoice. If set to false, no invoice will be issued for this charge. You can only set it to `false` when `pay_in_advance` is `true`. | [optional] |
|
11
|
+
| **invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name. | [optional] |
|
11
12
|
| **prorated** | **Boolean** | Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully. - If set to `true`, the charge is prorated based on the remaining days in the current billing period. - If set to `false`, the charge is billed in full. - If not defined in the request, default value is `false`. | [optional] |
|
12
13
|
| **min_amount_cents** | **Integer** | The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period. | [optional] |
|
13
14
|
| **properties** | [**ChargeObjectProperties**](ChargeObjectProperties.md) | | [optional] |
|
@@ -24,6 +25,7 @@ instance = LagoAPI::PlanCreateInputPlanChargesInner.new(
|
|
24
25
|
charge_model: standard,
|
25
26
|
pay_in_advance: false,
|
26
27
|
invoiceable: true,
|
28
|
+
invoice_display_name: Setup,
|
27
29
|
prorated: false,
|
28
30
|
min_amount_cents: 0,
|
29
31
|
properties: null,
|
data/docs/PlanObject.md
CHANGED
@@ -6,6 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **lago_id** | **String** | Unique identifier of the plan created by Lago. | |
|
8
8
|
| **name** | **String** | The name of the plan. | |
|
9
|
+
| **invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name. | [optional] |
|
9
10
|
| **created_at** | **Time** | The date and time when the plan was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the plan was initially created. | |
|
10
11
|
| **code** | **String** | The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance. | |
|
11
12
|
| **interval** | **String** | The interval used for recurring billing. It represents the frequency at which subscription billing occurs. The interval can be one of the following values: `yearly`, `quarterly`, `monthly` or `weekly`. | |
|
@@ -28,6 +29,7 @@ require 'lago_ruby'
|
|
28
29
|
instance = LagoAPI::PlanObject.new(
|
29
30
|
lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
|
30
31
|
name: Startup,
|
32
|
+
invoice_display_name: Startup plan,
|
31
33
|
created_at: 2023-06-27T19:43:42Z,
|
32
34
|
code: startup,
|
33
35
|
interval: monthly,
|
@@ -39,7 +41,7 @@ instance = LagoAPI::PlanObject.new(
|
|
39
41
|
bill_charges_monthly: null,
|
40
42
|
active_subscriptions_count: 0,
|
41
43
|
draft_invoices_count: 0,
|
42
|
-
charges: [{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","billable_metric_code":"requests","created_at":"2023-06-27T19:43:42Z","charge_model":"package","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","billable_metric_code":"cpu","created_at":"2023-06-27T19:43:42Z","charge_model":"graduated","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"from_value":0,"to_value":10,"flat_amount":"10","per_unit_amount":"0.5"},{"from_value":11,"to_value":null,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","billable_metric_code":"seats","created_at":"2023-06-27T19:43:42Z","charge_model":"standard","invoiceable":true,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","values":{"amount":"8"}}]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","billable_metric_code":"storage","created_at":"2023-06-27T19:43:42Z","charge_model":"volume","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","billable_metric_code":"payments","created_at":"2023-06-27T19:43:42Z","charge_model":"percentage","invoiceable":false,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}],
|
44
|
+
charges: [{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","billable_metric_code":"requests","created_at":"2023-06-27T19:43:42Z","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","billable_metric_code":"cpu","created_at":"2023-06-27T19:43:42Z","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"from_value":0,"to_value":10,"flat_amount":"10","per_unit_amount":"0.5"},{"from_value":11,"to_value":null,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","billable_metric_code":"seats","created_at":"2023-06-27T19:43:42Z","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","billable_metric_code":"storage","created_at":"2023-06-27T19:43:42Z","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","billable_metric_code":"payments","created_at":"2023-06-27T19:43:42Z","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}],
|
43
45
|
taxes: null
|
44
46
|
)
|
45
47
|
```
|
data/docs/PlanUpdateInputPlan.md
CHANGED
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **name** | **String** | The name of the plan. | [optional] |
|
8
|
+
| **invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name. | [optional] |
|
8
9
|
| **code** | **String** | The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance. | [optional] |
|
9
10
|
| **interval** | **String** | The interval used for recurring billing. It represents the frequency at which subscription billing occurs. The interval can be one of the following values: `yearly`, `quarterly`, `monthly`, or `weekly`. | [optional] |
|
10
11
|
| **description** | **String** | The description on the plan. | [optional] |
|
@@ -23,6 +24,7 @@ require 'lago_ruby'
|
|
23
24
|
|
24
25
|
instance = LagoAPI::PlanUpdateInputPlan.new(
|
25
26
|
name: Startup,
|
27
|
+
invoice_display_name: Startup plan,
|
26
28
|
code: startup,
|
27
29
|
interval: monthly,
|
28
30
|
description: Plan for early stage startups.,
|
@@ -32,7 +34,7 @@ instance = LagoAPI::PlanUpdateInputPlan.new(
|
|
32
34
|
pay_in_advance: true,
|
33
35
|
bill_charges_monthly: null,
|
34
36
|
tax_codes: ["french_standard_vat"],
|
35
|
-
charges: [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[],"tax_codes":["french_standard_vat"]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
|
37
|
+
charges: [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[],"tax_codes":["french_standard_vat"]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
|
36
38
|
)
|
37
39
|
```
|
38
40
|
|
@@ -9,6 +9,7 @@
|
|
9
9
|
| **charge_model** | **String** | Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage` or `volume`. | [optional] |
|
10
10
|
| **pay_in_advance** | **Boolean** | This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period. | [optional] |
|
11
11
|
| **invoiceable** | **Boolean** | This field specifies whether the charge should be included in a proper invoice. If set to false, no invoice will be issued for this charge. You can only set it to `false` when `pay_in_advance` is `true`. | [optional] |
|
12
|
+
| **invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name. | [optional] |
|
12
13
|
| **prorated** | **Boolean** | Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully. - If set to `true`, the charge is prorated based on the remaining days in the current billing period. - If set to `false`, the charge is billed in full. - If not defined in the request, default value is `false`. | [optional] |
|
13
14
|
| **min_amount_cents** | **Integer** | The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period. | [optional] |
|
14
15
|
| **properties** | [**ChargeObjectProperties**](ChargeObjectProperties.md) | | [optional] |
|
@@ -26,6 +27,7 @@ instance = LagoAPI::PlanUpdateInputPlanChargesInner.new(
|
|
26
27
|
charge_model: standard,
|
27
28
|
pay_in_advance: false,
|
28
29
|
invoiceable: true,
|
30
|
+
invoice_display_name: Setup,
|
29
31
|
prorated: false,
|
30
32
|
min_amount_cents: 0,
|
31
33
|
properties: null,
|
@@ -9,6 +9,7 @@
|
|
9
9
|
| **name** | **String** | The display name of the subscription on an invoice. This field allows for customization of the subscription's name for billing purposes, especially useful when a single customer has multiple subscriptions using the same plan. | [optional] |
|
10
10
|
| **external_id** | **String** | The unique external identifier for the subscription. This identifier serves as an idempotency key, ensuring that each subscription is unique. | |
|
11
11
|
| **billing_time** | **String** | The billing time for the subscription, which can be set as either `anniversary` or `calendar`. If not explicitly provided, it will default to `calendar`. The billing time determines the timing of recurring billing cycles for the subscription. By specifying `anniversary`, the billing cycle will be based on the specific date the subscription started (billed fully), while `calendar` sets the billing cycle at the first day of the week/month/year (billed with proration). | [optional] |
|
12
|
+
| **ending_at** | **Time** | The effective end date of the subscription. If this field is set to null, the subscription will automatically renew. This date should be provided in ISO 8601 datetime format, and use Coordinated Universal Time (UTC). | [optional] |
|
12
13
|
| **subscription_at** | **Time** | The start date for the subscription, allowing for the creation of subscriptions that can begin in the past or future. Please note that it cannot be used to update the start date of a pending subscription or schedule an upgrade/downgrade. The start_date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). | [optional] |
|
13
14
|
|
14
15
|
## Example
|
@@ -22,6 +23,7 @@ instance = LagoAPI::SubscriptionCreateInputSubscription.new(
|
|
22
23
|
name: Repository A,
|
23
24
|
external_id: my_sub_1234567890,
|
24
25
|
billing_time: anniversary,
|
26
|
+
ending_at: 2022-10-08T00:00Z,
|
25
27
|
subscription_at: 2022-08-08T00:00Z
|
26
28
|
)
|
27
29
|
```
|
data/docs/SubscriptionObject.md
CHANGED
@@ -15,6 +15,7 @@
|
|
15
15
|
| **created_at** | **Time** | The creation date of the subscription, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). This date provides a timestamp indicating when the subscription was initially created. | |
|
16
16
|
| **canceled_at** | **Time** | The cancellation date of the subscription. This field is not null when the subscription is `canceled`. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). | [optional] |
|
17
17
|
| **started_at** | **Time** | The effective start date of the subscription. This field can be null if the subscription is `pending` or `canceled`. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). | [optional] |
|
18
|
+
| **ending_at** | **Time** | The effective end date of the subscription. If this field is set to null, the subscription will automatically renew. This date should be provided in ISO 8601 datetime format, and use Coordinated Universal Time (UTC). | [optional] |
|
18
19
|
| **subscription_at** | **Time** | The anniversary date and time of the initial subscription. This date serves as the basis for billing subscriptions with `anniversary` billing time. The `anniversary_date` should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). | |
|
19
20
|
| **terminated_at** | **Time** | The termination date of the subscription. This field is not null when the subscription is `terminated`. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC) | [optional] |
|
20
21
|
| **previous_plan_code** | **String** | The code identifying the previous plan associated with this subscription. | [optional] |
|
@@ -38,6 +39,7 @@ instance = LagoAPI::SubscriptionObject.new(
|
|
38
39
|
created_at: 2022-08-08T00:00Z,
|
39
40
|
canceled_at: 2022-09-14T16:35:31Z,
|
40
41
|
started_at: 2022-08-08T00:00Z,
|
42
|
+
ending_at: 2022-10-08T00:00Z,
|
41
43
|
subscription_at: 2022-08-08T00:00Z,
|
42
44
|
terminated_at: 2022-09-14T16:35:31Z,
|
43
45
|
previous_plan_code: null,
|
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **name** | **String** | The display name of the subscription on an invoice. This field allows for customization of the subscription's name for billing purposes, especially useful when a single customer has multiple subscriptions using the same plan. | [optional] |
|
8
|
+
| **ending_at** | **Time** | The effective end date of the subscription. If this field is set to null, the subscription will automatically renew. This date should be provided in ISO 8601 datetime format, and use Coordinated Universal Time (UTC). | [optional] |
|
8
9
|
| **subscription_at** | **Time** | The start date and time of the subscription. This field can only be modified for pending subscriptions that have not yet started. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). | [optional] |
|
9
10
|
|
10
11
|
## Example
|
@@ -14,6 +15,7 @@ require 'lago_ruby'
|
|
14
15
|
|
15
16
|
instance = LagoAPI::SubscriptionUpdateInputSubscription.new(
|
16
17
|
name: Repository B,
|
18
|
+
ending_at: 2022-10-08T00:00Z,
|
17
19
|
subscription_at: 2022-08-08T00:00Z
|
18
20
|
)
|
19
21
|
```
|
data/docs/SubscriptionsApi.md
CHANGED
@@ -7,6 +7,7 @@ All URIs are relative to *https://api.getlago.com/api/v1*
|
|
7
7
|
| [**create_subscription**](SubscriptionsApi.md#create_subscription) | **POST** /subscriptions | Assign a plan to a customer |
|
8
8
|
| [**destroy_subscription**](SubscriptionsApi.md#destroy_subscription) | **DELETE** /subscriptions/{external_id} | Terminate a subscription |
|
9
9
|
| [**find_all_subscriptions**](SubscriptionsApi.md#find_all_subscriptions) | **GET** /subscriptions | List all subscriptions |
|
10
|
+
| [**find_subscription**](SubscriptionsApi.md#find_subscription) | **GET** /subscriptions/{external_id} | Retrieve a subscription |
|
10
11
|
| [**update_subscription**](SubscriptionsApi.md#update_subscription) | **PUT** /subscriptions/{external_id} | Update a subscription |
|
11
12
|
|
12
13
|
|
@@ -231,6 +232,75 @@ end
|
|
231
232
|
- **Accept**: application/json
|
232
233
|
|
233
234
|
|
235
|
+
## find_subscription
|
236
|
+
|
237
|
+
> <Subscription> find_subscription(external_id)
|
238
|
+
|
239
|
+
Retrieve a subscription
|
240
|
+
|
241
|
+
This endpoint retrieves a specific subscription.
|
242
|
+
|
243
|
+
### Examples
|
244
|
+
|
245
|
+
```ruby
|
246
|
+
require 'time'
|
247
|
+
require 'lago_ruby'
|
248
|
+
# setup authorization
|
249
|
+
LagoAPI.configure do |config|
|
250
|
+
# Configure Bearer authorization: bearerAuth
|
251
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
252
|
+
end
|
253
|
+
|
254
|
+
api_instance = LagoAPI::SubscriptionsApi.new
|
255
|
+
external_id = '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba' # String | External ID of the existing subscription
|
256
|
+
|
257
|
+
begin
|
258
|
+
# Retrieve a subscription
|
259
|
+
result = api_instance.find_subscription(external_id)
|
260
|
+
p result
|
261
|
+
rescue LagoAPI::ApiError => e
|
262
|
+
puts "Error when calling SubscriptionsApi->find_subscription: #{e}"
|
263
|
+
end
|
264
|
+
```
|
265
|
+
|
266
|
+
#### Using the find_subscription_with_http_info variant
|
267
|
+
|
268
|
+
This returns an Array which contains the response data, status code and headers.
|
269
|
+
|
270
|
+
> <Array(<Subscription>, Integer, Hash)> find_subscription_with_http_info(external_id)
|
271
|
+
|
272
|
+
```ruby
|
273
|
+
begin
|
274
|
+
# Retrieve a subscription
|
275
|
+
data, status_code, headers = api_instance.find_subscription_with_http_info(external_id)
|
276
|
+
p status_code # => 2xx
|
277
|
+
p headers # => { ... }
|
278
|
+
p data # => <Subscription>
|
279
|
+
rescue LagoAPI::ApiError => e
|
280
|
+
puts "Error when calling SubscriptionsApi->find_subscription_with_http_info: #{e}"
|
281
|
+
end
|
282
|
+
```
|
283
|
+
|
284
|
+
### Parameters
|
285
|
+
|
286
|
+
| Name | Type | Description | Notes |
|
287
|
+
| ---- | ---- | ----------- | ----- |
|
288
|
+
| **external_id** | **String** | External ID of the existing subscription | |
|
289
|
+
|
290
|
+
### Return type
|
291
|
+
|
292
|
+
[**Subscription**](Subscription.md)
|
293
|
+
|
294
|
+
### Authorization
|
295
|
+
|
296
|
+
[bearerAuth](../README.md#bearerAuth)
|
297
|
+
|
298
|
+
### HTTP request headers
|
299
|
+
|
300
|
+
- **Content-Type**: Not defined
|
301
|
+
- **Accept**: application/json
|
302
|
+
|
303
|
+
|
234
304
|
## update_subscription
|
235
305
|
|
236
306
|
> <Subscription> update_subscription(external_id, subscription_update_input)
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# LagoAPI::WebhookEndpoint
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **webhook_endpoint** | [**WebhookEndpointObject**](WebhookEndpointObject.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'lago_ruby'
|
13
|
+
|
14
|
+
instance = LagoAPI::WebhookEndpoint.new(
|
15
|
+
webhook_endpoint: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# LagoAPI::WebhookEndpointCreateInput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **webhook_endpoint** | [**WebhookEndpointCreateInputWebhookEndpoint**](WebhookEndpointCreateInputWebhookEndpoint.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'lago_ruby'
|
13
|
+
|
14
|
+
instance = LagoAPI::WebhookEndpointCreateInput.new(
|
15
|
+
webhook_endpoint: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# LagoAPI::WebhookEndpointCreateInputWebhookEndpoint
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **webhook_url** | **String** | The URL of the webhook endpoint. | |
|
8
|
+
| **signature_algo** | **String** | The signature used for the webhook. If no value is passed, | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'lago_ruby'
|
14
|
+
|
15
|
+
instance = LagoAPI::WebhookEndpointCreateInputWebhookEndpoint.new(
|
16
|
+
webhook_url: https://foo.bar,
|
17
|
+
signature_algo: hmac
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# LagoAPI::WebhookEndpointObject
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **lago_id** | **String** | Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the webhook endpoint's record within the Lago system. | |
|
8
|
+
| **lago_organization_id** | **String** | Unique identifier assigned to the organization attached to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the organization’s record within the Lago system. | |
|
9
|
+
| **webhook_url** | **String** | The name of the wallet. | |
|
10
|
+
| **signature_algo** | **String** | The signature algo for the webhook. | [optional] |
|
11
|
+
| **created_at** | **Time** | The date of the webhook endpoint creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'lago_ruby'
|
17
|
+
|
18
|
+
instance = LagoAPI::WebhookEndpointObject.new(
|
19
|
+
lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
|
20
|
+
lago_organization_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
|
21
|
+
webhook_url: Prepaid,
|
22
|
+
signature_algo: hmac,
|
23
|
+
created_at: 2022-04-29T08:59:51Z
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# LagoAPI::WebhookEndpointUpdateInput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **webhook_endpoint** | [**WebhookEndpointCreateInputWebhookEndpoint**](WebhookEndpointCreateInputWebhookEndpoint.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'lago_ruby'
|
13
|
+
|
14
|
+
instance = LagoAPI::WebhookEndpointUpdateInput.new(
|
15
|
+
webhook_endpoint: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/WebhookEndpointsApi.md
CHANGED
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.getlago.com/api/v1*
|
|
13
13
|
|
14
14
|
## create_webhook_endpoint
|
15
15
|
|
16
|
-
> <
|
16
|
+
> <WebhookEndpoint> create_webhook_endpoint(webhook_endpoint_create_input)
|
17
17
|
|
18
18
|
Create a webhook_endpoint
|
19
19
|
|
@@ -31,11 +31,11 @@ LagoAPI.configure do |config|
|
|
31
31
|
end
|
32
32
|
|
33
33
|
api_instance = LagoAPI::WebhookEndpointsApi.new
|
34
|
-
|
34
|
+
webhook_endpoint_create_input = LagoAPI::WebhookEndpointCreateInput.new # WebhookEndpointCreateInput | Webhook Endpoint payload
|
35
35
|
|
36
36
|
begin
|
37
37
|
# Create a webhook_endpoint
|
38
|
-
result = api_instance.create_webhook_endpoint(
|
38
|
+
result = api_instance.create_webhook_endpoint(webhook_endpoint_create_input)
|
39
39
|
p result
|
40
40
|
rescue LagoAPI::ApiError => e
|
41
41
|
puts "Error when calling WebhookEndpointsApi->create_webhook_endpoint: #{e}"
|
@@ -46,15 +46,15 @@ end
|
|
46
46
|
|
47
47
|
This returns an Array which contains the response data, status code and headers.
|
48
48
|
|
49
|
-
> <Array(<
|
49
|
+
> <Array(<WebhookEndpoint>, Integer, Hash)> create_webhook_endpoint_with_http_info(webhook_endpoint_create_input)
|
50
50
|
|
51
51
|
```ruby
|
52
52
|
begin
|
53
53
|
# Create a webhook_endpoint
|
54
|
-
data, status_code, headers = api_instance.create_webhook_endpoint_with_http_info(
|
54
|
+
data, status_code, headers = api_instance.create_webhook_endpoint_with_http_info(webhook_endpoint_create_input)
|
55
55
|
p status_code # => 2xx
|
56
56
|
p headers # => { ... }
|
57
|
-
p data # => <
|
57
|
+
p data # => <WebhookEndpoint>
|
58
58
|
rescue LagoAPI::ApiError => e
|
59
59
|
puts "Error when calling WebhookEndpointsApi->create_webhook_endpoint_with_http_info: #{e}"
|
60
60
|
end
|
@@ -64,11 +64,11 @@ end
|
|
64
64
|
|
65
65
|
| Name | Type | Description | Notes |
|
66
66
|
| ---- | ---- | ----------- | ----- |
|
67
|
-
| **
|
67
|
+
| **webhook_endpoint_create_input** | [**WebhookEndpointCreateInput**](WebhookEndpointCreateInput.md) | Webhook Endpoint payload | |
|
68
68
|
|
69
69
|
### Return type
|
70
70
|
|
71
|
-
[**
|
71
|
+
[**WebhookEndpoint**](WebhookEndpoint.md)
|
72
72
|
|
73
73
|
### Authorization
|
74
74
|
|
@@ -82,7 +82,7 @@ end
|
|
82
82
|
|
83
83
|
## destroy_webhook_endpoint
|
84
84
|
|
85
|
-
>
|
85
|
+
> <WebhookEndpoint> destroy_webhook_endpoint(lago_id)
|
86
86
|
|
87
87
|
Delete a webhook endpoint
|
88
88
|
|
@@ -115,7 +115,7 @@ end
|
|
115
115
|
|
116
116
|
This returns an Array which contains the response data, status code and headers.
|
117
117
|
|
118
|
-
> <Array(
|
118
|
+
> <Array(<WebhookEndpoint>, Integer, Hash)> destroy_webhook_endpoint_with_http_info(lago_id)
|
119
119
|
|
120
120
|
```ruby
|
121
121
|
begin
|
@@ -123,7 +123,7 @@ begin
|
|
123
123
|
data, status_code, headers = api_instance.destroy_webhook_endpoint_with_http_info(lago_id)
|
124
124
|
p status_code # => 2xx
|
125
125
|
p headers # => { ... }
|
126
|
-
p data # =>
|
126
|
+
p data # => <WebhookEndpoint>
|
127
127
|
rescue LagoAPI::ApiError => e
|
128
128
|
puts "Error when calling WebhookEndpointsApi->destroy_webhook_endpoint_with_http_info: #{e}"
|
129
129
|
end
|
@@ -137,7 +137,7 @@ end
|
|
137
137
|
|
138
138
|
### Return type
|
139
139
|
|
140
|
-
**
|
140
|
+
[**WebhookEndpoint**](WebhookEndpoint.md)
|
141
141
|
|
142
142
|
### Authorization
|
143
143
|
|
@@ -151,7 +151,7 @@ end
|
|
151
151
|
|
152
152
|
## find_all_webhook_endpoints
|
153
153
|
|
154
|
-
> <
|
154
|
+
> <WebhookEndpointsPaginated> find_all_webhook_endpoints(opts)
|
155
155
|
|
156
156
|
List all webhook endpoints
|
157
157
|
|
@@ -187,7 +187,7 @@ end
|
|
187
187
|
|
188
188
|
This returns an Array which contains the response data, status code and headers.
|
189
189
|
|
190
|
-
> <Array(<
|
190
|
+
> <Array(<WebhookEndpointsPaginated>, Integer, Hash)> find_all_webhook_endpoints_with_http_info(opts)
|
191
191
|
|
192
192
|
```ruby
|
193
193
|
begin
|
@@ -195,7 +195,7 @@ begin
|
|
195
195
|
data, status_code, headers = api_instance.find_all_webhook_endpoints_with_http_info(opts)
|
196
196
|
p status_code # => 2xx
|
197
197
|
p headers # => { ... }
|
198
|
-
p data # => <
|
198
|
+
p data # => <WebhookEndpointsPaginated>
|
199
199
|
rescue LagoAPI::ApiError => e
|
200
200
|
puts "Error when calling WebhookEndpointsApi->find_all_webhook_endpoints_with_http_info: #{e}"
|
201
201
|
end
|
@@ -210,7 +210,7 @@ end
|
|
210
210
|
|
211
211
|
### Return type
|
212
212
|
|
213
|
-
[**
|
213
|
+
[**WebhookEndpointsPaginated**](WebhookEndpointsPaginated.md)
|
214
214
|
|
215
215
|
### Authorization
|
216
216
|
|
@@ -224,7 +224,7 @@ end
|
|
224
224
|
|
225
225
|
## find_webhook_endpoint
|
226
226
|
|
227
|
-
>
|
227
|
+
> <WebhookEndpoint> find_webhook_endpoint(lago_id)
|
228
228
|
|
229
229
|
Retrieve a webhook endpoint
|
230
230
|
|
@@ -257,7 +257,7 @@ end
|
|
257
257
|
|
258
258
|
This returns an Array which contains the response data, status code and headers.
|
259
259
|
|
260
|
-
> <Array(
|
260
|
+
> <Array(<WebhookEndpoint>, Integer, Hash)> find_webhook_endpoint_with_http_info(lago_id)
|
261
261
|
|
262
262
|
```ruby
|
263
263
|
begin
|
@@ -265,7 +265,7 @@ begin
|
|
265
265
|
data, status_code, headers = api_instance.find_webhook_endpoint_with_http_info(lago_id)
|
266
266
|
p status_code # => 2xx
|
267
267
|
p headers # => { ... }
|
268
|
-
p data # =>
|
268
|
+
p data # => <WebhookEndpoint>
|
269
269
|
rescue LagoAPI::ApiError => e
|
270
270
|
puts "Error when calling WebhookEndpointsApi->find_webhook_endpoint_with_http_info: #{e}"
|
271
271
|
end
|
@@ -279,7 +279,7 @@ end
|
|
279
279
|
|
280
280
|
### Return type
|
281
281
|
|
282
|
-
**
|
282
|
+
[**WebhookEndpoint**](WebhookEndpoint.md)
|
283
283
|
|
284
284
|
### Authorization
|
285
285
|
|
@@ -293,7 +293,7 @@ end
|
|
293
293
|
|
294
294
|
## update_webhook_endpoint
|
295
295
|
|
296
|
-
>
|
296
|
+
> <WebhookEndpoint> update_webhook_endpoint(lago_id, webhook_endpoint_update_input)
|
297
297
|
|
298
298
|
Update a webhook endpoint
|
299
299
|
|
@@ -312,11 +312,11 @@ end
|
|
312
312
|
|
313
313
|
api_instance = LagoAPI::WebhookEndpointsApi.new
|
314
314
|
lago_id = '1a901a90-1a90-1a90-1a90-1a901a901a90' # String | Unique identifier assigned to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the webhook endpoint's record within the Lago system.
|
315
|
-
|
315
|
+
webhook_endpoint_update_input = LagoAPI::WebhookEndpointUpdateInput.new # WebhookEndpointUpdateInput | Webhook Endpoint update payload
|
316
316
|
|
317
317
|
begin
|
318
318
|
# Update a webhook endpoint
|
319
|
-
result = api_instance.update_webhook_endpoint(lago_id,
|
319
|
+
result = api_instance.update_webhook_endpoint(lago_id, webhook_endpoint_update_input)
|
320
320
|
p result
|
321
321
|
rescue LagoAPI::ApiError => e
|
322
322
|
puts "Error when calling WebhookEndpointsApi->update_webhook_endpoint: #{e}"
|
@@ -327,15 +327,15 @@ end
|
|
327
327
|
|
328
328
|
This returns an Array which contains the response data, status code and headers.
|
329
329
|
|
330
|
-
> <Array(
|
330
|
+
> <Array(<WebhookEndpoint>, Integer, Hash)> update_webhook_endpoint_with_http_info(lago_id, webhook_endpoint_update_input)
|
331
331
|
|
332
332
|
```ruby
|
333
333
|
begin
|
334
334
|
# Update a webhook endpoint
|
335
|
-
data, status_code, headers = api_instance.update_webhook_endpoint_with_http_info(lago_id,
|
335
|
+
data, status_code, headers = api_instance.update_webhook_endpoint_with_http_info(lago_id, webhook_endpoint_update_input)
|
336
336
|
p status_code # => 2xx
|
337
337
|
p headers # => { ... }
|
338
|
-
p data # =>
|
338
|
+
p data # => <WebhookEndpoint>
|
339
339
|
rescue LagoAPI::ApiError => e
|
340
340
|
puts "Error when calling WebhookEndpointsApi->update_webhook_endpoint_with_http_info: #{e}"
|
341
341
|
end
|
@@ -346,11 +346,11 @@ end
|
|
346
346
|
| Name | Type | Description | Notes |
|
347
347
|
| ---- | ---- | ----------- | ----- |
|
348
348
|
| **lago_id** | **String** | Unique identifier assigned to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the webhook endpoint's record within the Lago system. | |
|
349
|
-
| **
|
349
|
+
| **webhook_endpoint_update_input** | [**WebhookEndpointUpdateInput**](WebhookEndpointUpdateInput.md) | Webhook Endpoint update payload | |
|
350
350
|
|
351
351
|
### Return type
|
352
352
|
|
353
|
-
**
|
353
|
+
[**WebhookEndpoint**](WebhookEndpoint.md)
|
354
354
|
|
355
355
|
### Authorization
|
356
356
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# LagoAPI::WebhookEndpointsPaginated
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **webhook_endpoints** | [**Array<WebhookEndpointObject>**](WebhookEndpointObject.md) | | |
|
8
|
+
| **meta** | [**PaginationMeta**](PaginationMeta.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'lago_ruby'
|
14
|
+
|
15
|
+
instance = LagoAPI::WebhookEndpointsPaginated.new(
|
16
|
+
webhook_endpoints: null,
|
17
|
+
meta: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/lago_ruby.gemspec
CHANGED
@@ -5,10 +5,10 @@
|
|
5
5
|
|
6
6
|
#Lago API allows your application to push customer information and metrics (events) from your application to the billing application.
|
7
7
|
|
8
|
-
The version of the OpenAPI document: 0.
|
8
|
+
The version of the OpenAPI document: 0.49.0-beta
|
9
9
|
Contact: tech@getlago.com
|
10
10
|
Generated by: https://openapi-generator.tech
|
11
|
-
OpenAPI Generator version: 7.0
|
11
|
+
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
12
12
|
|
13
13
|
=end
|
14
14
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#Lago API allows your application to push customer information and metrics (events) from your application to the billing application.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 0.
|
6
|
+
The version of the OpenAPI document: 0.49.0-beta
|
7
7
|
Contact: tech@getlago.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 7.0
|
9
|
+
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#Lago API allows your application to push customer information and metrics (events) from your application to the billing application.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 0.
|
6
|
+
The version of the OpenAPI document: 0.49.0-beta
|
7
7
|
Contact: tech@getlago.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 7.0
|
9
|
+
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|