lago_ruby 0.46.0.pre.beta → 0.48.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 +17 -19
- data/docs/AddOnsApi.md +0 -70
- data/docs/BillableMetricBaseInput.md +2 -0
- data/docs/BillableMetricCreateInputBillableMetric.md +2 -0
- data/docs/BillableMetricObject.md +2 -0
- data/docs/CouponObject.md +3 -1
- data/docs/CreditObjectItem.md +2 -2
- data/docs/EventInputEvent.md +4 -4
- data/docs/EventInputEventProperties.md +18 -0
- data/docs/EventInputEventTimestamp.md +15 -0
- data/docs/EventObject.md +2 -2
- data/docs/EventObjectProperties.md +18 -0
- data/docs/SubscriptionCreateInputSubscription.md +2 -0
- data/docs/SubscriptionObject.md +2 -0
- data/docs/SubscriptionUpdateInputSubscription.md +2 -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 -70
- 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 +2 -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 +2 -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 +2 -2
- data/lib/lago_ruby/api_error.rb +2 -2
- data/lib/lago_ruby/configuration.rb +2 -2
- data/lib/lago_ruby/models/add_on.rb +2 -2
- data/lib/lago_ruby/models/add_on_base_input.rb +2 -2
- data/lib/lago_ruby/models/add_on_create_input.rb +2 -2
- data/lib/lago_ruby/models/add_on_create_input_add_on.rb +2 -2
- data/lib/lago_ruby/models/add_on_object.rb +2 -2
- 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_add_on.rb +1 -1
- data/lib/lago_ruby/models/applied_add_on_input.rb +1 -1
- data/lib/lago_ruby/models/applied_add_on_input_applied_add_on.rb +1 -1
- data/lib/lago_ruby/models/applied_add_on_object.rb +1 -1
- 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 +28 -5
- data/lib/lago_ruby/models/billable_metric_create_input.rb +2 -2
- data/lib/lago_ruby/models/billable_metric_create_input_billable_metric.rb +28 -5
- 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 +28 -5
- 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 +2 -2
- 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/create_webhook_endpoint200_response.rb +1 -1
- data/lib/lago_ruby/models/create_webhook_endpoint200_response_webhook_endpoint.rb +1 -1
- data/lib/lago_ruby/models/create_webhook_endpoint_request.rb +1 -1
- data/lib/lago_ruby/models/create_webhook_endpoint_request_webhook_endpoint.rb +1 -1
- 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 +2 -2
- 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 +2 -2
- 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 +2 -2
- 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_usage.rb +2 -2
- data/lib/lago_ruby/models/customer_usage_object.rb +2 -2
- 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 +8 -6
- data/lib/lago_ruby/models/event_input_event_timestamp.rb +105 -0
- data/lib/lago_ruby/models/event_object.rb +3 -3
- data/lib/lago_ruby/models/event_object_properties.rb +250 -0
- 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 +2 -2
- data/lib/lago_ruby/models/fee_object_item.rb +2 -2
- 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/find_all_webhook_endpoints200_response.rb +1 -1
- 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 +2 -2
- 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 +2 -2
- 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 +2 -2
- data/lib/lago_ruby/models/plan_create_input_plan_charges_inner.rb +2 -2
- 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 +2 -2
- data/lib/lago_ruby/models/plan_update_input.rb +2 -2
- data/lib/lago_ruby/models/plan_update_input_plan.rb +2 -2
- data/lib/lago_ruby/models/plan_update_input_plan_charges_inner.rb +2 -2
- 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 -11
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/event_input_event_timestamp_spec.rb +21 -0
- data/spec/models/event_object_properties_spec.rb +38 -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/{applied_add_on_spec.rb → webhook_endpoint_spec.rb} +9 -9
- data/spec/models/{create_webhook_endpoint200_response_spec.rb → webhook_endpoint_update_input_spec.rb} +8 -8
- 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 +176 -161
- data/spec/models/applied_add_on_input_applied_add_on_spec.rb +0 -52
- data/spec/models/applied_add_on_input_spec.rb +0 -34
- data/spec/models/applied_add_on_object_spec.rb +0 -76
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e5738b2715145b3c82ebcd9bb48424256348c7758b1c2f814472bfa977e4aac1
|
4
|
+
data.tar.gz: 2a40ead695be008af06dbb38628ba5581995845b4ce9990924363e2ae4dc7d3e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: aca1397ab9360755c7caca7cf53d7f694944708efebfc67a1bff17a1a3efca70ef2a10b22f85e41a27d14b4e7379732961569e432b1e68da0e99fbfa998d765b
|
7
|
+
data.tar.gz: 735d0d793eb29856d91e763758dda5316a0d337aacb0df78f98b2563b57f096314f4790cf0045c569b762f517722b16d3df966c8abc08a63631c6b6d5c05d140
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -6,8 +6,8 @@ Lago API allows your application to push customer information and metrics (event
|
|
6
6
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
|
-
- API version: 0.
|
10
|
-
- Package version: 0.
|
9
|
+
- API version: 0.48.0-beta
|
10
|
+
- Package version: 0.48.0-beta
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
[![Gem Version](https://badge.fury.io/rb/lago-ruby.svg)](https://badge.fury.io/rb/lago-ruby)
|
@@ -26,16 +26,16 @@ gem build lago_ruby.gemspec
|
|
26
26
|
Then either install the gem locally:
|
27
27
|
|
28
28
|
```shell
|
29
|
-
gem install ./lago_ruby-0.
|
29
|
+
gem install ./lago_ruby-0.48.0-beta.gem
|
30
30
|
```
|
31
31
|
|
32
|
-
(for development, run `gem install --dev ./lago_ruby-0.
|
32
|
+
(for development, run `gem install --dev ./lago_ruby-0.48.0-beta.gem` to install the development dependencies)
|
33
33
|
|
34
34
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
35
35
|
|
36
36
|
Finally add this to the Gemfile:
|
37
37
|
|
38
|
-
gem 'lago_ruby', '~> 0.
|
38
|
+
gem 'lago_ruby', '~> 0.48.0-beta'
|
39
39
|
|
40
40
|
### Install from Git
|
41
41
|
|
@@ -68,14 +68,14 @@ LagoAPI.configure do |config|
|
|
68
68
|
end
|
69
69
|
|
70
70
|
api_instance = LagoAPI::AddOnsApi.new
|
71
|
-
|
71
|
+
add_on_create_input = LagoAPI::AddOnCreateInput.new({add_on: LagoAPI::AddOnCreateInputAddOn.new({name: 'Setup Fee', code: 'setup_fee', amount_cents: 50000, amount_currency: LagoAPI::Currency::AED})}) # AddOnCreateInput | Add-on payload
|
72
72
|
|
73
73
|
begin
|
74
|
-
#
|
75
|
-
result = api_instance.
|
74
|
+
#Create an add-on
|
75
|
+
result = api_instance.create_add_on(add_on_create_input)
|
76
76
|
p result
|
77
77
|
rescue LagoAPI::ApiError => e
|
78
|
-
puts "Exception when calling AddOnsApi->
|
78
|
+
puts "Exception when calling AddOnsApi->create_add_on: #{e}"
|
79
79
|
end
|
80
80
|
|
81
81
|
```
|
@@ -88,7 +88,6 @@ All URIs are relative to *https://api.getlago.com/api/v1*
|
|
88
88
|
|
89
89
|
Class | Method | HTTP request | Description
|
90
90
|
------------ | ------------- | ------------- | -------------
|
91
|
-
*LagoAPI::AddOnsApi* | [**apply_add_on**](docs/AddOnsApi.md#apply_add_on) | **POST** /applied_add_ons | Apply an add-on to a customer
|
92
91
|
*LagoAPI::AddOnsApi* | [**create_add_on**](docs/AddOnsApi.md#create_add_on) | **POST** /add_ons | Create an add-on
|
93
92
|
*LagoAPI::AddOnsApi* | [**destroy_add_on**](docs/AddOnsApi.md#destroy_add_on) | **DELETE** /add_ons/{code} | Delete an add-on
|
94
93
|
*LagoAPI::AddOnsApi* | [**find_add_on**](docs/AddOnsApi.md#find_add_on) | **GET** /add_ons/{code} | Retrieve an add-on
|
@@ -181,10 +180,6 @@ Class | Method | HTTP request | Description
|
|
181
180
|
- [LagoAPI::ApiErrorNotFound](docs/ApiErrorNotFound.md)
|
182
181
|
- [LagoAPI::ApiErrorUnauthorized](docs/ApiErrorUnauthorized.md)
|
183
182
|
- [LagoAPI::ApiErrorUnprocessableEntity](docs/ApiErrorUnprocessableEntity.md)
|
184
|
-
- [LagoAPI::AppliedAddOn](docs/AppliedAddOn.md)
|
185
|
-
- [LagoAPI::AppliedAddOnInput](docs/AppliedAddOnInput.md)
|
186
|
-
- [LagoAPI::AppliedAddOnInputAppliedAddOn](docs/AppliedAddOnInputAppliedAddOn.md)
|
187
|
-
- [LagoAPI::AppliedAddOnObject](docs/AppliedAddOnObject.md)
|
188
183
|
- [LagoAPI::AppliedCoupon](docs/AppliedCoupon.md)
|
189
184
|
- [LagoAPI::AppliedCouponInput](docs/AppliedCouponInput.md)
|
190
185
|
- [LagoAPI::AppliedCouponInputAppliedCoupon](docs/AppliedCouponInputAppliedCoupon.md)
|
@@ -217,10 +212,6 @@ Class | Method | HTTP request | Description
|
|
217
212
|
- [LagoAPI::CouponObject](docs/CouponObject.md)
|
218
213
|
- [LagoAPI::CouponUpdateInput](docs/CouponUpdateInput.md)
|
219
214
|
- [LagoAPI::CouponsPaginated](docs/CouponsPaginated.md)
|
220
|
-
- [LagoAPI::CreateWebhookEndpoint200Response](docs/CreateWebhookEndpoint200Response.md)
|
221
|
-
- [LagoAPI::CreateWebhookEndpoint200ResponseWebhookEndpoint](docs/CreateWebhookEndpoint200ResponseWebhookEndpoint.md)
|
222
|
-
- [LagoAPI::CreateWebhookEndpointRequest](docs/CreateWebhookEndpointRequest.md)
|
223
|
-
- [LagoAPI::CreateWebhookEndpointRequestWebhookEndpoint](docs/CreateWebhookEndpointRequestWebhookEndpoint.md)
|
224
215
|
- [LagoAPI::CreditNote](docs/CreditNote.md)
|
225
216
|
- [LagoAPI::CreditNoteAppliedTaxObject](docs/CreditNoteAppliedTaxObject.md)
|
226
217
|
- [LagoAPI::CreditNoteCreateInput](docs/CreditNoteCreateInput.md)
|
@@ -259,7 +250,9 @@ Class | Method | HTTP request | Description
|
|
259
250
|
- [LagoAPI::EventEstimateFeesInputEvent](docs/EventEstimateFeesInputEvent.md)
|
260
251
|
- [LagoAPI::EventInput](docs/EventInput.md)
|
261
252
|
- [LagoAPI::EventInputEvent](docs/EventInputEvent.md)
|
253
|
+
- [LagoAPI::EventInputEventTimestamp](docs/EventInputEventTimestamp.md)
|
262
254
|
- [LagoAPI::EventObject](docs/EventObject.md)
|
255
|
+
- [LagoAPI::EventObjectProperties](docs/EventObjectProperties.md)
|
263
256
|
- [LagoAPI::Fee](docs/Fee.md)
|
264
257
|
- [LagoAPI::FeeAppliedTaxObject](docs/FeeAppliedTaxObject.md)
|
265
258
|
- [LagoAPI::FeeObject](docs/FeeObject.md)
|
@@ -268,7 +261,6 @@ Class | Method | HTTP request | Description
|
|
268
261
|
- [LagoAPI::FeeUpdateInputFee](docs/FeeUpdateInputFee.md)
|
269
262
|
- [LagoAPI::Fees](docs/Fees.md)
|
270
263
|
- [LagoAPI::FeesPaginated](docs/FeesPaginated.md)
|
271
|
-
- [LagoAPI::FindAllWebhookEndpoints200Response](docs/FindAllWebhookEndpoints200Response.md)
|
272
264
|
- [LagoAPI::GetCustomerPortalUrl200Response](docs/GetCustomerPortalUrl200Response.md)
|
273
265
|
- [LagoAPI::GetCustomerPortalUrl200ResponseCustomer](docs/GetCustomerPortalUrl200ResponseCustomer.md)
|
274
266
|
- [LagoAPI::GroupObject](docs/GroupObject.md)
|
@@ -331,6 +323,12 @@ Class | Method | HTTP request | Description
|
|
331
323
|
- [LagoAPI::WalletUpdateInput](docs/WalletUpdateInput.md)
|
332
324
|
- [LagoAPI::WalletUpdateInputWallet](docs/WalletUpdateInputWallet.md)
|
333
325
|
- [LagoAPI::WalletsPaginated](docs/WalletsPaginated.md)
|
326
|
+
- [LagoAPI::WebhookEndpoint](docs/WebhookEndpoint.md)
|
327
|
+
- [LagoAPI::WebhookEndpointCreateInput](docs/WebhookEndpointCreateInput.md)
|
328
|
+
- [LagoAPI::WebhookEndpointCreateInputWebhookEndpoint](docs/WebhookEndpointCreateInputWebhookEndpoint.md)
|
329
|
+
- [LagoAPI::WebhookEndpointObject](docs/WebhookEndpointObject.md)
|
330
|
+
- [LagoAPI::WebhookEndpointUpdateInput](docs/WebhookEndpointUpdateInput.md)
|
331
|
+
- [LagoAPI::WebhookEndpointsPaginated](docs/WebhookEndpointsPaginated.md)
|
334
332
|
|
335
333
|
|
336
334
|
## Documentation for Authorization
|
data/docs/AddOnsApi.md
CHANGED
@@ -4,7 +4,6 @@ All URIs are relative to *https://api.getlago.com/api/v1*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**apply_add_on**](AddOnsApi.md#apply_add_on) | **POST** /applied_add_ons | Apply an add-on to a customer |
|
8
7
|
| [**create_add_on**](AddOnsApi.md#create_add_on) | **POST** /add_ons | Create an add-on |
|
9
8
|
| [**destroy_add_on**](AddOnsApi.md#destroy_add_on) | **DELETE** /add_ons/{code} | Delete an add-on |
|
10
9
|
| [**find_add_on**](AddOnsApi.md#find_add_on) | **GET** /add_ons/{code} | Retrieve an add-on |
|
@@ -12,75 +11,6 @@ All URIs are relative to *https://api.getlago.com/api/v1*
|
|
12
11
|
| [**update_add_on**](AddOnsApi.md#update_add_on) | **PUT** /add_ons/{code} | Update an add-on |
|
13
12
|
|
14
13
|
|
15
|
-
## apply_add_on
|
16
|
-
|
17
|
-
> <AppliedAddOn> apply_add_on(applied_add_on_input)
|
18
|
-
|
19
|
-
Apply an add-on to a customer
|
20
|
-
|
21
|
-
Apply an add-on to a customer
|
22
|
-
|
23
|
-
### Examples
|
24
|
-
|
25
|
-
```ruby
|
26
|
-
require 'time'
|
27
|
-
require 'lago_ruby'
|
28
|
-
# setup authorization
|
29
|
-
LagoAPI.configure do |config|
|
30
|
-
# Configure Bearer authorization: bearerAuth
|
31
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
32
|
-
end
|
33
|
-
|
34
|
-
api_instance = LagoAPI::AddOnsApi.new
|
35
|
-
applied_add_on_input = LagoAPI::AppliedAddOnInput.new({applied_add_on: LagoAPI::AppliedAddOnInputAppliedAddOn.new({external_customer_id: '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba', add_on_code: 'setup_fee'})}) # AppliedAddOnInput | Apply add-on payload
|
36
|
-
|
37
|
-
begin
|
38
|
-
# Apply an add-on to a customer
|
39
|
-
result = api_instance.apply_add_on(applied_add_on_input)
|
40
|
-
p result
|
41
|
-
rescue LagoAPI::ApiError => e
|
42
|
-
puts "Error when calling AddOnsApi->apply_add_on: #{e}"
|
43
|
-
end
|
44
|
-
```
|
45
|
-
|
46
|
-
#### Using the apply_add_on_with_http_info variant
|
47
|
-
|
48
|
-
This returns an Array which contains the response data, status code and headers.
|
49
|
-
|
50
|
-
> <Array(<AppliedAddOn>, Integer, Hash)> apply_add_on_with_http_info(applied_add_on_input)
|
51
|
-
|
52
|
-
```ruby
|
53
|
-
begin
|
54
|
-
# Apply an add-on to a customer
|
55
|
-
data, status_code, headers = api_instance.apply_add_on_with_http_info(applied_add_on_input)
|
56
|
-
p status_code # => 2xx
|
57
|
-
p headers # => { ... }
|
58
|
-
p data # => <AppliedAddOn>
|
59
|
-
rescue LagoAPI::ApiError => e
|
60
|
-
puts "Error when calling AddOnsApi->apply_add_on_with_http_info: #{e}"
|
61
|
-
end
|
62
|
-
```
|
63
|
-
|
64
|
-
### Parameters
|
65
|
-
|
66
|
-
| Name | Type | Description | Notes |
|
67
|
-
| ---- | ---- | ----------- | ----- |
|
68
|
-
| **applied_add_on_input** | [**AppliedAddOnInput**](AppliedAddOnInput.md) | Apply add-on payload | |
|
69
|
-
|
70
|
-
### Return type
|
71
|
-
|
72
|
-
[**AppliedAddOn**](AppliedAddOn.md)
|
73
|
-
|
74
|
-
### Authorization
|
75
|
-
|
76
|
-
[bearerAuth](../README.md#bearerAuth)
|
77
|
-
|
78
|
-
### HTTP request headers
|
79
|
-
|
80
|
-
- **Content-Type**: application/json
|
81
|
-
- **Accept**: application/json
|
82
|
-
|
83
|
-
|
84
14
|
## create_add_on
|
85
15
|
|
86
16
|
> <AddOn> create_add_on(add_on_create_input)
|
@@ -10,6 +10,7 @@
|
|
10
10
|
| **recurring** | **Boolean** | Defines if the billable metric is persisted billing period over billing period. - If set to `true`: the accumulated number of units calculated from the previous billing period is persisted to the next billing period. - If set to `false`: the accumulated number of units is reset to 0 at the end of the billing period. - If not defined in the request, default value is `false`. | [optional] |
|
11
11
|
| **field_name** | **String** | Property of the billable metric used for aggregating usage data. This field is not required for `count_agg`. | [optional] |
|
12
12
|
| **aggregation_type** | **String** | Aggregation method used to compute usage for this billable metric. Possible values are `count_agg`, `sum_agg`, `max_agg` or `unique_count_agg`. | [optional] |
|
13
|
+
| **weighted_interval** | **String** | Parameter exclusively utilized in conjunction with the `weighted_sum` aggregation type. It serves to adjust the aggregation result by assigning weights and proration to the result based on time intervals. When this field is not provided, the default time interval is assumed to be in `seconds`. | [optional] |
|
13
14
|
| **group** | [**BillableMetricGroup**](BillableMetricGroup.md) | | [optional] |
|
14
15
|
|
15
16
|
## Example
|
@@ -24,6 +25,7 @@ instance = LagoAPI::BillableMetricBaseInput.new(
|
|
24
25
|
recurring: false,
|
25
26
|
field_name: gb,
|
26
27
|
aggregation_type: sum_agg,
|
28
|
+
weighted_interval: seconds,
|
27
29
|
group: null
|
28
30
|
)
|
29
31
|
```
|
@@ -10,6 +10,7 @@
|
|
10
10
|
| **recurring** | **Boolean** | Defines if the billable metric is persisted billing period over billing period. - If set to `true`: the accumulated number of units calculated from the previous billing period is persisted to the next billing period. - If set to `false`: the accumulated number of units is reset to 0 at the end of the billing period. - If not defined in the request, default value is `false`. | [optional] |
|
11
11
|
| **field_name** | **String** | Property of the billable metric used for aggregating usage data. This field is not required for `count_agg`. | [optional] |
|
12
12
|
| **aggregation_type** | **String** | Aggregation method used to compute usage for this billable metric. Possible values are `count_agg`, `sum_agg`, `max_agg` or `unique_count_agg`. | |
|
13
|
+
| **weighted_interval** | **String** | Parameter exclusively utilized in conjunction with the `weighted_sum` aggregation type. It serves to adjust the aggregation result by assigning weights and proration to the result based on time intervals. When this field is not provided, the default time interval is assumed to be in `seconds`. | [optional] |
|
13
14
|
| **group** | [**BillableMetricGroup**](BillableMetricGroup.md) | | [optional] |
|
14
15
|
|
15
16
|
## Example
|
@@ -24,6 +25,7 @@ instance = LagoAPI::BillableMetricCreateInputBillableMetric.new(
|
|
24
25
|
recurring: false,
|
25
26
|
field_name: gb,
|
26
27
|
aggregation_type: sum_agg,
|
28
|
+
weighted_interval: seconds,
|
27
29
|
group: null
|
28
30
|
)
|
29
31
|
```
|
@@ -12,6 +12,7 @@
|
|
12
12
|
| **created_at** | **Time** | Creation date of the billable metric. | |
|
13
13
|
| **field_name** | **String** | Property of the billable metric used for aggregating usage data. This field is not required for `count_agg`. | [optional] |
|
14
14
|
| **aggregation_type** | **String** | Aggregation method used to compute usage for this billable metric. Possible values are `count_agg`, `sum_agg`, `max_agg` or `unique_count_agg`. | |
|
15
|
+
| **weighted_interval** | **String** | Parameter exclusively utilized in conjunction with the `weighted_sum` aggregation type. It serves to adjust the aggregation result by assigning weights and proration to the result based on time intervals. When this field is not provided, the default time interval is assumed to be in `seconds`. | [optional] |
|
15
16
|
| **group** | [**BillableMetricGroup**](BillableMetricGroup.md) | | [optional] |
|
16
17
|
| **active_subscriptions_count** | **Integer** | Number of active subscriptions using this billable metric. | |
|
17
18
|
| **draft_invoices_count** | **Integer** | Number of draft invoices for which this billable metric is listed as an invoice item. | |
|
@@ -31,6 +32,7 @@ instance = LagoAPI::BillableMetricObject.new(
|
|
31
32
|
created_at: 2022-09-14T16:35:31Z,
|
32
33
|
field_name: gb,
|
33
34
|
aggregation_type: sum_agg,
|
35
|
+
weighted_interval: seconds,
|
34
36
|
group: null,
|
35
37
|
active_subscriptions_count: 4,
|
36
38
|
draft_invoices_count: 10,
|
data/docs/CouponObject.md
CHANGED
@@ -22,6 +22,7 @@
|
|
22
22
|
| **expiration** | **String** | Specifies the type of expiration for the coupon. It can have two possible values: `time_limit` or `no_expiration`. - If set to `time_limit`, the coupon has an expiration based on a specified time limit. - If set to `no_expiration`, the coupon does not have an expiration date and remains valid indefinitely. | |
|
23
23
|
| **expiration_at** | **Time** | The expiration date and time of the coupon. This field is required only for coupons with `expiration` set to `time_limit`. The expiration date and time should be specified in UTC format according to the ISO 8601 datetime standard. It indicates the exact moment when the coupon will expire and is no longer valid. | [optional] |
|
24
24
|
| **created_at** | **Time** | The date and time when the coupon 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 coupon was initially created. | |
|
25
|
+
| **terminated_at** | **Time** | This field indicates if the coupon has been terminated and is no longer usable. If it's not null, it won't be removed for existing customers using it, but it prevents the coupon from being applied in the future. | [optional] |
|
25
26
|
|
26
27
|
## Example
|
27
28
|
|
@@ -46,7 +47,8 @@ instance = LagoAPI::CouponObject.new(
|
|
46
47
|
frequency_duration: 6,
|
47
48
|
expiration: time_limit,
|
48
49
|
expiration_at: 2022-08-08T23:59:59Z,
|
49
|
-
created_at: 2022-04-29T08:59:51Z
|
50
|
+
created_at: 2022-04-29T08:59:51Z,
|
51
|
+
terminated_at: 2022-08-08T23:59:59Z
|
50
52
|
)
|
51
53
|
```
|
52
54
|
|
data/docs/CreditObjectItem.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **
|
7
|
+
| **lago_item_id** | **String** | Unique identifier assigned to the credit item within the Lago application. | |
|
8
8
|
| **type** | **String** | The type of credit applied. Possible values are `coupon` or `credit_note`. | |
|
9
9
|
| **code** | **String** | The code of the credit applied. It can be the code of the coupon attached to the credit or the credit note's number. | |
|
10
10
|
| **name** | **String** | The name of the credit applied. It can be the name of the coupon attached to the credit or the initial invoice's number linked to the credit note. | |
|
@@ -15,7 +15,7 @@
|
|
15
15
|
require 'lago_ruby'
|
16
16
|
|
17
17
|
instance = LagoAPI::CreditObjectItem.new(
|
18
|
-
|
18
|
+
lago_item_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
|
19
19
|
type: coupon,
|
20
20
|
code: startup_deal,
|
21
21
|
name: Startup Deal
|
data/docs/EventInputEvent.md
CHANGED
@@ -8,8 +8,8 @@
|
|
8
8
|
| **external_customer_id** | **String** | The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription. | [optional] |
|
9
9
|
| **external_subscription_id** | **String** | The unique identifier of the subscription within your application. It is a mandatory field when the customer possesses multiple subscriptions or when the `external_customer_id` is not provided. | [optional] |
|
10
10
|
| **code** | **String** | The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process. | |
|
11
|
-
| **timestamp** | **
|
12
|
-
| **properties** |
|
11
|
+
| **timestamp** | [**EventInputEventTimestamp**](EventInputEventTimestamp.md) | | [optional] |
|
12
|
+
| **properties** | **Hash<String, String>** | This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required. | [optional] |
|
13
13
|
|
14
14
|
## Example
|
15
15
|
|
@@ -21,8 +21,8 @@ instance = LagoAPI::EventInputEvent.new(
|
|
21
21
|
external_customer_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
|
22
22
|
external_subscription_id: sub_1234567890,
|
23
23
|
code: storage,
|
24
|
-
timestamp:
|
25
|
-
properties:
|
24
|
+
timestamp: null,
|
25
|
+
properties: {"gb":10}
|
26
26
|
)
|
27
27
|
```
|
28
28
|
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# LagoAPI::EventInputEventProperties
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **operation_type** | **String** | The `operation_type` field is only necessary when adding or removing a specific unit when the targeted billable metric adopts a `unique_count_agg` aggregation method. In other cases, the `operation_type` field is not required. The valid values for the `operation_type` field are `add` or `remove`, which indicate whether the unit is being added or removed from the unique count aggregation, respectively. | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'lago_ruby'
|
13
|
+
|
14
|
+
instance = LagoAPI::EventInputEventProperties.new(
|
15
|
+
operation_type: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# LagoAPI::EventInputEventTimestamp
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'lago_ruby'
|
12
|
+
|
13
|
+
instance = LagoAPI::EventInputEventTimestamp.new()
|
14
|
+
```
|
15
|
+
|
data/docs/EventObject.md
CHANGED
@@ -10,7 +10,7 @@
|
|
10
10
|
| **external_customer_id** | **String** | The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription. | |
|
11
11
|
| **code** | **String** | The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process. | |
|
12
12
|
| **timestamp** | **Time** | This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC). If this timestamp is not provided, the API will automatically set it to the time of event reception. | |
|
13
|
-
| **properties** | [**
|
13
|
+
| **properties** | [**EventObjectProperties**](EventObjectProperties.md) | | [optional] |
|
14
14
|
| **lago_subscription_id** | **String** | Unique identifier assigned to the subscription within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription’s record within the Lago system | |
|
15
15
|
| **external_subscription_id** | **String** | The unique identifier of the subscription within your application. It is a mandatory field when the customer possesses multiple subscriptions or when the `external_customer_id` is not provided. | |
|
16
16
|
| **created_at** | **Time** | The creation date of the event's record in the Lago application, presented in the ISO 8601 datetime format, specifically in Coordinated Universal Time (UTC). It provides the precise timestamp of when the event's record was created within the Lago application | |
|
@@ -26,7 +26,7 @@ instance = LagoAPI::EventObject.new(
|
|
26
26
|
lago_customer_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
|
27
27
|
external_customer_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
|
28
28
|
code: storage,
|
29
|
-
timestamp: 2022-04-29T08:59:
|
29
|
+
timestamp: 2022-04-29T08:59:51.123Z,
|
30
30
|
properties: null,
|
31
31
|
lago_subscription_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
|
32
32
|
external_subscription_id: sub_1234567890,
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# LagoAPI::EventObjectProperties
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **operation_type** | **String** | The `operation_type` field is only necessary when adding or removing a specific unit when the targeted billable metric adopts a `unique_count_agg` aggregation method. In other cases, the `operation_type` field is not required. The valid values for the `operation_type` field are `add` or `remove`, which indicate whether the unit is being added or removed from the unique count aggregation, respectively. | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'lago_ruby'
|
13
|
+
|
14
|
+
instance = LagoAPI::EventObjectProperties.new(
|
15
|
+
operation_type: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -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
|
```
|
@@ -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
|
+
|