lago_ruby 0.46.0.pre.beta
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CODE_OF_CONDUCT.md +128 -0
- data/CONTRIBUTING.md +213 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +72 -0
- data/LICENSE +21 -0
- data/README.md +343 -0
- data/Rakefile +10 -0
- data/docs/AddOn.md +18 -0
- data/docs/AddOnBaseInput.md +28 -0
- data/docs/AddOnCreateInput.md +18 -0
- data/docs/AddOnCreateInputAddOn.md +28 -0
- data/docs/AddOnObject.md +32 -0
- data/docs/AddOnUpdateInput.md +18 -0
- data/docs/AddOnsApi.md +433 -0
- data/docs/AddOnsPaginated.md +20 -0
- data/docs/ApiErrorBadRequest.md +20 -0
- data/docs/ApiErrorForbidden.md +22 -0
- data/docs/ApiErrorNotAllowed.md +22 -0
- data/docs/ApiErrorNotFound.md +22 -0
- data/docs/ApiErrorUnauthorized.md +20 -0
- data/docs/ApiErrorUnprocessableEntity.md +24 -0
- data/docs/AppliedAddOn.md +18 -0
- data/docs/AppliedAddOnInput.md +18 -0
- data/docs/AppliedAddOnInputAppliedAddOn.md +24 -0
- data/docs/AppliedAddOnObject.md +32 -0
- data/docs/AppliedCoupon.md +18 -0
- data/docs/AppliedCouponInput.md +18 -0
- data/docs/AppliedCouponInputAppliedCoupon.md +30 -0
- data/docs/AppliedCouponObject.md +50 -0
- data/docs/AppliedCouponObjectExtended.md +52 -0
- data/docs/AppliedCouponsPaginated.md +20 -0
- data/docs/BaseAppliedTax.md +34 -0
- data/docs/BillableMetric.md +18 -0
- data/docs/BillableMetricBaseInput.md +30 -0
- data/docs/BillableMetricCreateInput.md +18 -0
- data/docs/BillableMetricCreateInputBillableMetric.md +30 -0
- data/docs/BillableMetricGroup.md +20 -0
- data/docs/BillableMetricGroupValuesInner.md +49 -0
- data/docs/BillableMetricGroupValuesInnerOneOf.md +20 -0
- data/docs/BillableMetricObject.md +40 -0
- data/docs/BillableMetricUpdateInput.md +18 -0
- data/docs/BillableMetricsApi.md +439 -0
- data/docs/BillableMetricsPaginated.md +20 -0
- data/docs/ChargeObject.md +40 -0
- data/docs/ChargeObjectProperties.md +40 -0
- data/docs/ChargeProperties.md +40 -0
- data/docs/ChargePropertiesGraduatedPercentageRangesInner.md +24 -0
- data/docs/ChargePropertiesGraduatedRangesInner.md +24 -0
- data/docs/ChargePropertiesVolumeRangesInner.md +24 -0
- data/docs/Country.md +15 -0
- data/docs/Coupon.md +18 -0
- data/docs/CouponBaseInput.md +42 -0
- data/docs/CouponBaseInputAppliesTo.md +20 -0
- data/docs/CouponCreateInput.md +18 -0
- data/docs/CouponCreateInputCoupon.md +42 -0
- data/docs/CouponObject.md +52 -0
- data/docs/CouponUpdateInput.md +18 -0
- data/docs/CouponsApi.md +583 -0
- data/docs/CouponsPaginated.md +20 -0
- data/docs/CreateWebhookEndpoint200Response.md +18 -0
- data/docs/CreateWebhookEndpoint200ResponseWebhookEndpoint.md +26 -0
- data/docs/CreateWebhookEndpointRequest.md +18 -0
- data/docs/CreateWebhookEndpointRequestWebhookEndpoint.md +20 -0
- data/docs/CreditNote.md +18 -0
- data/docs/CreditNoteAppliedTaxObject.md +38 -0
- data/docs/CreditNoteCreateInput.md +18 -0
- data/docs/CreditNoteCreateInputCreditNote.md +28 -0
- data/docs/CreditNoteCreateInputCreditNoteItemsInner.md +20 -0
- data/docs/CreditNoteItemObject.md +24 -0
- data/docs/CreditNoteItemObjectFee.md +74 -0
- data/docs/CreditNoteObject.md +64 -0
- data/docs/CreditNoteUpdateInput.md +18 -0
- data/docs/CreditNoteUpdateInputCreditNote.md +18 -0
- data/docs/CreditNotes.md +18 -0
- data/docs/CreditNotesApi.md +435 -0
- data/docs/CreditObject.md +28 -0
- data/docs/CreditObjectInvoice.md +20 -0
- data/docs/CreditObjectItem.md +24 -0
- data/docs/Currency.md +15 -0
- data/docs/Customer.md +18 -0
- data/docs/CustomerBillingConfiguration.md +30 -0
- data/docs/CustomerChargeUsageObject.md +28 -0
- data/docs/CustomerChargeUsageObjectBillableMetric.md +24 -0
- data/docs/CustomerChargeUsageObjectCharge.md +20 -0
- data/docs/CustomerChargeUsageObjectGroupsInner.md +26 -0
- data/docs/CustomerCreateInput.md +18 -0
- data/docs/CustomerCreateInputCustomer.md +58 -0
- data/docs/CustomerCreateInputCustomerMetadataInner.md +24 -0
- data/docs/CustomerMetadata.md +26 -0
- data/docs/CustomerObject.md +68 -0
- data/docs/CustomerObjectExtended.md +70 -0
- data/docs/CustomerUsage.md +18 -0
- data/docs/CustomerUsageObject.md +32 -0
- data/docs/CustomersApi.md +505 -0
- data/docs/CustomersPaginated.md +20 -0
- data/docs/Event.md +18 -0
- data/docs/EventBatchInput.md +18 -0
- data/docs/EventBatchInputEvent.md +28 -0
- data/docs/EventBatchInputEventProperties.md +18 -0
- data/docs/EventEstimateFeesInput.md +18 -0
- data/docs/EventEstimateFeesInputEvent.md +24 -0
- data/docs/EventInput.md +18 -0
- data/docs/EventInputEvent.md +28 -0
- data/docs/EventObject.md +36 -0
- data/docs/EventsApi.md +285 -0
- data/docs/Fee.md +18 -0
- data/docs/FeeAppliedTaxObject.md +36 -0
- data/docs/FeeObject.md +74 -0
- data/docs/FeeObjectItem.md +26 -0
- data/docs/FeeUpdateInput.md +18 -0
- data/docs/FeeUpdateInputFee.md +18 -0
- data/docs/Fees.md +18 -0
- data/docs/FeesApi.md +253 -0
- data/docs/FeesPaginated.md +20 -0
- data/docs/FindAllWebhookEndpoints200Response.md +20 -0
- data/docs/GetCustomerPortalUrl200Response.md +18 -0
- data/docs/GetCustomerPortalUrl200ResponseCustomer.md +18 -0
- data/docs/GroupObject.md +22 -0
- data/docs/GroupPropertiesObject.md +20 -0
- data/docs/GroupPropertiesObjectValues.md +40 -0
- data/docs/GroupsPaginated.md +20 -0
- data/docs/Invoice.md +18 -0
- data/docs/InvoiceAppliedTaxObject.md +38 -0
- data/docs/InvoiceMetadataObject.md +24 -0
- data/docs/InvoiceObject.md +62 -0
- data/docs/InvoiceObjectCustomer.md +68 -0
- data/docs/InvoiceObjectExtended.md +68 -0
- data/docs/InvoiceOneOffCreateInput.md +18 -0
- data/docs/InvoiceOneOffCreateInputInvoice.md +22 -0
- data/docs/InvoiceOneOffCreateInputInvoiceFeesInner.md +26 -0
- data/docs/InvoiceUpdateInput.md +18 -0
- data/docs/InvoiceUpdateInputInvoice.md +20 -0
- data/docs/InvoiceUpdateInputInvoiceMetadataInner.md +22 -0
- data/docs/InvoicesApi.md +582 -0
- data/docs/InvoicesPaginated.md +20 -0
- data/docs/Organization.md +18 -0
- data/docs/OrganizationBillingConfiguration.md +22 -0
- data/docs/OrganizationObject.md +54 -0
- data/docs/OrganizationUpdateInput.md +18 -0
- data/docs/OrganizationUpdateInputOrganization.md +46 -0
- data/docs/OrganizationsApi.md +77 -0
- data/docs/PaginationMeta.md +26 -0
- data/docs/Plan.md +18 -0
- data/docs/PlanCreateInput.md +18 -0
- data/docs/PlanCreateInputPlan.md +38 -0
- data/docs/PlanCreateInputPlanChargesInner.md +34 -0
- data/docs/PlanCreateInputPlanChargesInnerGroupPropertiesInner.md +20 -0
- data/docs/PlanObject.md +46 -0
- data/docs/PlanUpdateInput.md +18 -0
- data/docs/PlanUpdateInputPlan.md +38 -0
- data/docs/PlanUpdateInputPlanChargesInner.md +36 -0
- data/docs/PlansApi.md +363 -0
- data/docs/PlansPaginated.md +20 -0
- data/docs/Subscription.md +18 -0
- data/docs/SubscriptionCreateInput.md +18 -0
- data/docs/SubscriptionCreateInputSubscription.md +28 -0
- data/docs/SubscriptionObject.md +48 -0
- data/docs/SubscriptionUpdateInput.md +18 -0
- data/docs/SubscriptionUpdateInputSubscription.md +20 -0
- data/docs/SubscriptionsApi.md +303 -0
- data/docs/SubscriptionsPaginated.md +20 -0
- data/docs/Tax.md +18 -0
- data/docs/TaxBaseInput.md +26 -0
- data/docs/TaxCreateInput.md +18 -0
- data/docs/TaxCreateInputTax.md +26 -0
- data/docs/TaxObject.md +38 -0
- data/docs/TaxUpdateInput.md +18 -0
- data/docs/TaxesApi.md +363 -0
- data/docs/TaxesPaginated.md +20 -0
- data/docs/Timezone.md +15 -0
- data/docs/Wallet.md +18 -0
- data/docs/WalletCreateInput.md +18 -0
- data/docs/WalletCreateInputWallet.md +30 -0
- data/docs/WalletObject.md +46 -0
- data/docs/WalletTransactionCreateInput.md +18 -0
- data/docs/WalletTransactionCreateInputWalletTransaction.md +22 -0
- data/docs/WalletTransactionObject.md +32 -0
- data/docs/WalletTransactions.md +18 -0
- data/docs/WalletTransactionsPaginated.md +20 -0
- data/docs/WalletUpdateInput.md +18 -0
- data/docs/WalletUpdateInputWallet.md +20 -0
- data/docs/WalletsApi.md +515 -0
- data/docs/WalletsPaginated.md +20 -0
- data/docs/WebhookEndpointsApi.md +363 -0
- data/docs/WebhooksApi.md +74 -0
- data/git_push.sh +57 -0
- data/lago_ruby.gemspec +42 -0
- data/lib/lago_ruby/api/add_ons_api.rb +421 -0
- data/lib/lago_ruby/api/billable_metrics_api.rb +422 -0
- data/lib/lago_ruby/api/coupons_api.rb +563 -0
- data/lib/lago_ruby/api/credit_notes_api.rb +419 -0
- data/lib/lago_ruby/api/customers_api.rb +481 -0
- data/lib/lago_ruby/api/events_api.rb +289 -0
- data/lib/lago_ruby/api/fees_api.rb +268 -0
- data/lib/lago_ruby/api/invoices_api.rb +565 -0
- data/lib/lago_ruby/api/organizations_api.rb +90 -0
- data/lib/lago_ruby/api/plans_api.rb +353 -0
- data/lib/lago_ruby/api/subscriptions_api.rb +306 -0
- data/lib/lago_ruby/api/taxes_api.rb +353 -0
- data/lib/lago_ruby/api/wallets_api.rb +503 -0
- data/lib/lago_ruby/api/webhook_endpoints_api.rb +353 -0
- data/lib/lago_ruby/api/webhooks_api.rb +79 -0
- data/lib/lago_ruby/api_client.rb +392 -0
- data/lib/lago_ruby/api_error.rb +58 -0
- data/lib/lago_ruby/configuration.rb +297 -0
- data/lib/lago_ruby/models/add_on.rb +221 -0
- data/lib/lago_ruby/models/add_on_base_input.rb +267 -0
- data/lib/lago_ruby/models/add_on_create_input.rb +221 -0
- data/lib/lago_ruby/models/add_on_create_input_add_on.rb +302 -0
- data/lib/lago_ruby/models/add_on_object.rb +329 -0
- data/lib/lago_ruby/models/add_on_update_input.rb +221 -0
- data/lib/lago_ruby/models/add_ons_paginated.rb +239 -0
- data/lib/lago_ruby/models/api_error_bad_request.rb +237 -0
- data/lib/lago_ruby/models/api_error_forbidden.rb +253 -0
- data/lib/lago_ruby/models/api_error_not_allowed.rb +253 -0
- data/lib/lago_ruby/models/api_error_not_found.rb +253 -0
- data/lib/lago_ruby/models/api_error_unauthorized.rb +237 -0
- data/lib/lago_ruby/models/api_error_unprocessable_entity.rb +269 -0
- data/lib/lago_ruby/models/applied_add_on.rb +221 -0
- data/lib/lago_ruby/models/applied_add_on_input.rb +221 -0
- data/lib/lago_ruby/models/applied_add_on_input_applied_add_on.rb +259 -0
- data/lib/lago_ruby/models/applied_add_on_object.rb +339 -0
- data/lib/lago_ruby/models/applied_coupon.rb +221 -0
- data/lib/lago_ruby/models/applied_coupon_input.rb +221 -0
- data/lib/lago_ruby/models/applied_coupon_input_applied_coupon.rb +343 -0
- data/lib/lago_ruby/models/applied_coupon_object.rb +507 -0
- data/lib/lago_ruby/models/applied_coupon_object_extended.rb +532 -0
- data/lib/lago_ruby/models/applied_coupons_paginated.rb +239 -0
- data/lib/lago_ruby/models/base_applied_tax.rb +294 -0
- data/lib/lago_ruby/models/billable_metric.rb +221 -0
- data/lib/lago_ruby/models/billable_metric_base_input.rb +310 -0
- data/lib/lago_ruby/models/billable_metric_create_input.rb +221 -0
- data/lib/lago_ruby/models/billable_metric_create_input_billable_metric.rb +338 -0
- data/lib/lago_ruby/models/billable_metric_group.rb +242 -0
- data/lib/lago_ruby/models/billable_metric_group_values_inner.rb +105 -0
- data/lib/lago_ruby/models/billable_metric_group_values_inner_one_of.rb +242 -0
- data/lib/lago_ruby/models/billable_metric_object.rb +423 -0
- data/lib/lago_ruby/models/billable_metric_update_input.rb +221 -0
- data/lib/lago_ruby/models/billable_metrics_paginated.rb +239 -0
- data/lib/lago_ruby/models/charge_object.rb +397 -0
- data/lib/lago_ruby/models/charge_object_properties.rb +422 -0
- data/lib/lago_ruby/models/charge_properties.rb +415 -0
- data/lib/lago_ruby/models/charge_properties_graduated_percentage_ranges_inner.rb +269 -0
- data/lib/lago_ruby/models/charge_properties_graduated_ranges_inner.rb +311 -0
- data/lib/lago_ruby/models/charge_properties_volume_ranges_inner.rb +311 -0
- data/lib/lago_ruby/models/country.rb +287 -0
- data/lib/lago_ruby/models/coupon.rb +221 -0
- data/lib/lago_ruby/models/coupon_base_input.rb +414 -0
- data/lib/lago_ruby/models/coupon_base_input_applies_to.rb +232 -0
- data/lib/lago_ruby/models/coupon_create_input.rb +221 -0
- data/lib/lago_ruby/models/coupon_create_input_coupon.rb +449 -0
- data/lib/lago_ruby/models/coupon_object.rb +538 -0
- data/lib/lago_ruby/models/coupon_update_input.rb +221 -0
- data/lib/lago_ruby/models/coupons_paginated.rb +239 -0
- data/lib/lago_ruby/models/create_webhook_endpoint200_response.rb +221 -0
- data/lib/lago_ruby/models/create_webhook_endpoint200_response_webhook_endpoint.rb +317 -0
- data/lib/lago_ruby/models/create_webhook_endpoint_request.rb +214 -0
- data/lib/lago_ruby/models/create_webhook_endpoint_request_webhook_endpoint.rb +267 -0
- data/lib/lago_ruby/models/credit_note.rb +221 -0
- data/lib/lago_ruby/models/credit_note_applied_tax_object.rb +320 -0
- data/lib/lago_ruby/models/credit_note_create_input.rb +221 -0
- data/lib/lago_ruby/models/credit_note_create_input_credit_note.rb +318 -0
- data/lib/lago_ruby/models/credit_note_create_input_credit_note_items_inner.rb +239 -0
- data/lib/lago_ruby/models/credit_note_item_object.rb +271 -0
- data/lib/lago_ruby/models/credit_note_item_object_fee.rb +628 -0
- data/lib/lago_ruby/models/credit_note_object.rb +635 -0
- data/lib/lago_ruby/models/credit_note_update_input.rb +221 -0
- data/lib/lago_ruby/models/credit_note_update_input_credit_note.rb +256 -0
- data/lib/lago_ruby/models/credit_notes.rb +223 -0
- data/lib/lago_ruby/models/credit_object.rb +304 -0
- data/lib/lago_ruby/models/credit_object_invoice.rb +271 -0
- data/lib/lago_ruby/models/credit_object_item.rb +308 -0
- data/lib/lago_ruby/models/currency.rb +175 -0
- data/lib/lago_ruby/models/customer.rb +221 -0
- data/lib/lago_ruby/models/customer_billing_configuration.rb +313 -0
- data/lib/lago_ruby/models/customer_charge_usage_object.rb +327 -0
- data/lib/lago_ruby/models/customer_charge_usage_object_billable_metric.rb +308 -0
- data/lib/lago_ruby/models/customer_charge_usage_object_charge.rb +274 -0
- data/lib/lago_ruby/models/customer_charge_usage_object_groups_inner.rb +277 -0
- data/lib/lago_ruby/models/customer_create_input.rb +221 -0
- data/lib/lago_ruby/models/customer_create_input_customer.rb +436 -0
- data/lib/lago_ruby/models/customer_create_input_customer_metadata_inner.rb +266 -0
- data/lib/lago_ruby/models/customer_metadata.rb +291 -0
- data/lib/lago_ruby/models/customer_object.rb +517 -0
- data/lib/lago_ruby/models/customer_object_extended.rb +536 -0
- data/lib/lago_ruby/models/customer_usage.rb +221 -0
- data/lib/lago_ruby/models/customer_usage_object.rb +335 -0
- data/lib/lago_ruby/models/customers_paginated.rb +239 -0
- data/lib/lago_ruby/models/event.rb +221 -0
- data/lib/lago_ruby/models/event_batch_input.rb +221 -0
- data/lib/lago_ruby/models/event_batch_input_event.rb +287 -0
- data/lib/lago_ruby/models/event_batch_input_event_properties.rb +250 -0
- data/lib/lago_ruby/models/event_estimate_fees_input.rb +221 -0
- data/lib/lago_ruby/models/event_estimate_fees_input_event.rb +252 -0
- data/lib/lago_ruby/models/event_input.rb +221 -0
- data/lib/lago_ruby/models/event_input_event.rb +278 -0
- data/lib/lago_ruby/models/event_object.rb +367 -0
- data/lib/lago_ruby/models/fee.rb +221 -0
- data/lib/lago_ruby/models/fee_applied_tax_object.rb +311 -0
- data/lib/lago_ruby/models/fee_object.rb +621 -0
- data/lib/lago_ruby/models/fee_object_item.rb +337 -0
- data/lib/lago_ruby/models/fee_update_input.rb +221 -0
- data/lib/lago_ruby/models/fee_update_input_fee.rb +256 -0
- data/lib/lago_ruby/models/fees.rb +223 -0
- data/lib/lago_ruby/models/fees_paginated.rb +246 -0
- data/lib/lago_ruby/models/find_all_webhook_endpoints200_response.rb +239 -0
- data/lib/lago_ruby/models/get_customer_portal_url200_response.rb +221 -0
- data/lib/lago_ruby/models/get_customer_portal_url200_response_customer.rb +222 -0
- data/lib/lago_ruby/models/group_object.rb +256 -0
- data/lib/lago_ruby/models/group_properties_object.rb +238 -0
- data/lib/lago_ruby/models/group_properties_object_values.rb +422 -0
- data/lib/lago_ruby/models/groups_paginated.rb +239 -0
- data/lib/lago_ruby/models/invoice.rb +221 -0
- data/lib/lago_ruby/models/invoice_applied_tax_object.rb +321 -0
- data/lib/lago_ruby/models/invoice_metadata_object.rb +245 -0
- data/lib/lago_ruby/models/invoice_object.rb +611 -0
- data/lib/lago_ruby/models/invoice_object_customer.rb +524 -0
- data/lib/lago_ruby/models/invoice_object_extended.rb +651 -0
- data/lib/lago_ruby/models/invoice_one_off_create_input.rb +221 -0
- data/lib/lago_ruby/models/invoice_one_off_create_input_invoice.rb +249 -0
- data/lib/lago_ruby/models/invoice_one_off_create_input_invoice_fees_inner.rb +284 -0
- data/lib/lago_ruby/models/invoice_update_input.rb +221 -0
- data/lib/lago_ruby/models/invoice_update_input_invoice.rb +260 -0
- data/lib/lago_ruby/models/invoice_update_input_invoice_metadata_inner.rb +235 -0
- data/lib/lago_ruby/models/invoices_paginated.rb +239 -0
- data/lib/lago_ruby/models/organization.rb +221 -0
- data/lib/lago_ruby/models/organization_billing_configuration.rb +237 -0
- data/lib/lago_ruby/models/organization_object.rb +431 -0
- data/lib/lago_ruby/models/organization_update_input.rb +221 -0
- data/lib/lago_ruby/models/organization_update_input_organization.rb +386 -0
- data/lib/lago_ruby/models/pagination_meta.rb +278 -0
- data/lib/lago_ruby/models/plan.rb +221 -0
- data/lib/lago_ruby/models/plan_create_input.rb +221 -0
- data/lib/lago_ruby/models/plan_create_input_plan.rb +353 -0
- data/lib/lago_ruby/models/plan_create_input_plan_charges_inner.rb +332 -0
- data/lib/lago_ruby/models/plan_create_input_plan_charges_inner_group_properties_inner.rb +238 -0
- data/lib/lago_ruby/models/plan_object.rb +456 -0
- data/lib/lago_ruby/models/plan_update_input.rb +221 -0
- data/lib/lago_ruby/models/plan_update_input_plan.rb +353 -0
- data/lib/lago_ruby/models/plan_update_input_plan_charges_inner.rb +342 -0
- data/lib/lago_ruby/models/plans_paginated.rb +239 -0
- data/lib/lago_ruby/models/subscription.rb +221 -0
- data/lib/lago_ruby/models/subscription_create_input.rb +221 -0
- data/lib/lago_ruby/models/subscription_create_input_subscription.rb +320 -0
- data/lib/lago_ruby/models/subscription_object.rb +481 -0
- data/lib/lago_ruby/models/subscription_update_input.rb +221 -0
- data/lib/lago_ruby/models/subscription_update_input_subscription.rb +226 -0
- data/lib/lago_ruby/models/subscriptions_paginated.rb +239 -0
- data/lib/lago_ruby/models/tax.rb +221 -0
- data/lib/lago_ruby/models/tax_base_input.rb +277 -0
- data/lib/lago_ruby/models/tax_create_input.rb +221 -0
- data/lib/lago_ruby/models/tax_create_input_tax.rb +305 -0
- data/lib/lago_ruby/models/tax_object.rb +364 -0
- data/lib/lago_ruby/models/tax_update_input.rb +221 -0
- data/lib/lago_ruby/models/taxes_paginated.rb +239 -0
- data/lib/lago_ruby/models/timezone.rb +173 -0
- data/lib/lago_ruby/models/wallet.rb +221 -0
- data/lib/lago_ruby/models/wallet_create_input.rb +214 -0
- data/lib/lago_ruby/models/wallet_create_input_wallet.rb +353 -0
- data/lib/lago_ruby/models/wallet_object.rb +525 -0
- data/lib/lago_ruby/models/wallet_transaction_create_input.rb +221 -0
- data/lib/lago_ruby/models/wallet_transaction_create_input_wallet_transaction.rb +284 -0
- data/lib/lago_ruby/models/wallet_transaction_object.rb +422 -0
- data/lib/lago_ruby/models/wallet_transactions.rb +223 -0
- data/lib/lago_ruby/models/wallet_transactions_paginated.rb +246 -0
- data/lib/lago_ruby/models/wallet_update_input.rb +221 -0
- data/lib/lago_ruby/models/wallet_update_input_wallet.rb +227 -0
- data/lib/lago_ruby/models/wallets_paginated.rb +239 -0
- data/lib/lago_ruby/version.rb +15 -0
- data/lib/lago_ruby.rb +217 -0
- data/spec/api/add_ons_api_spec.rb +109 -0
- data/spec/api/billable_metrics_api_spec.rb +111 -0
- data/spec/api/coupons_api_spec.rb +137 -0
- data/spec/api/credit_notes_api_spec.rb +110 -0
- data/spec/api/customers_api_spec.rb +122 -0
- data/spec/api/events_api_spec.rb +83 -0
- data/spec/api/fees_api_spec.rb +87 -0
- data/spec/api/invoices_api_spec.rb +138 -0
- data/spec/api/organizations_api_spec.rb +47 -0
- data/spec/api/plans_api_spec.rb +97 -0
- data/spec/api/subscriptions_api_spec.rb +89 -0
- data/spec/api/taxes_api_spec.rb +97 -0
- data/spec/api/wallets_api_spec.rb +126 -0
- data/spec/api/webhook_endpoints_api_spec.rb +97 -0
- data/spec/api/webhooks_api_spec.rb +46 -0
- data/spec/api_client_spec.rb +228 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/add_on_base_input_spec.rb +64 -0
- data/spec/models/add_on_create_input_add_on_spec.rb +64 -0
- data/spec/models/add_on_create_input_spec.rb +34 -0
- data/spec/models/add_on_object_spec.rb +76 -0
- data/spec/models/add_on_spec.rb +34 -0
- data/spec/models/add_on_update_input_spec.rb +34 -0
- data/spec/models/add_ons_paginated_spec.rb +40 -0
- data/spec/models/api_error_bad_request_spec.rb +40 -0
- data/spec/models/api_error_forbidden_spec.rb +46 -0
- data/spec/models/api_error_not_allowed_spec.rb +46 -0
- data/spec/models/api_error_not_found_spec.rb +46 -0
- data/spec/models/api_error_unauthorized_spec.rb +40 -0
- data/spec/models/api_error_unprocessable_entity_spec.rb +52 -0
- data/spec/models/applied_add_on_input_applied_add_on_spec.rb +52 -0
- data/spec/models/applied_add_on_input_spec.rb +34 -0
- data/spec/models/applied_add_on_object_spec.rb +76 -0
- data/spec/models/applied_add_on_spec.rb +34 -0
- data/spec/models/applied_coupon_input_applied_coupon_spec.rb +74 -0
- data/spec/models/applied_coupon_input_spec.rb +34 -0
- data/spec/models/applied_coupon_object_extended_spec.rb +144 -0
- data/spec/models/applied_coupon_object_spec.rb +138 -0
- data/spec/models/applied_coupon_spec.rb +34 -0
- data/spec/models/applied_coupons_paginated_spec.rb +40 -0
- data/spec/models/base_applied_tax_spec.rb +82 -0
- data/spec/models/billable_metric_base_input_spec.rb +74 -0
- data/spec/models/billable_metric_create_input_billable_metric_spec.rb +74 -0
- data/spec/models/billable_metric_create_input_spec.rb +34 -0
- data/spec/models/billable_metric_group_spec.rb +40 -0
- data/spec/models/billable_metric_group_values_inner_one_of_spec.rb +40 -0
- data/spec/models/billable_metric_group_values_inner_spec.rb +31 -0
- data/spec/models/billable_metric_object_spec.rb +104 -0
- data/spec/models/billable_metric_spec.rb +34 -0
- data/spec/models/billable_metric_update_input_spec.rb +34 -0
- data/spec/models/billable_metrics_paginated_spec.rb +40 -0
- data/spec/models/charge_object_properties_spec.rb +100 -0
- data/spec/models/charge_object_spec.rb +104 -0
- data/spec/models/charge_properties_graduated_percentage_ranges_inner_spec.rb +52 -0
- data/spec/models/charge_properties_graduated_ranges_inner_spec.rb +59 -0
- data/spec/models/charge_properties_spec.rb +100 -0
- data/spec/models/charge_properties_volume_ranges_inner_spec.rb +59 -0
- data/spec/models/country_spec.rb +28 -0
- data/spec/models/coupon_base_input_applies_to_spec.rb +40 -0
- data/spec/models/coupon_base_input_spec.rb +118 -0
- data/spec/models/coupon_create_input_coupon_spec.rb +118 -0
- data/spec/models/coupon_create_input_spec.rb +34 -0
- data/spec/models/coupon_object_spec.rb +148 -0
- data/spec/models/coupon_spec.rb +34 -0
- data/spec/models/coupon_update_input_spec.rb +34 -0
- data/spec/models/coupons_paginated_spec.rb +40 -0
- data/spec/models/create_webhook_endpoint200_response_spec.rb +34 -0
- data/spec/models/create_webhook_endpoint200_response_webhook_endpoint_spec.rb +62 -0
- data/spec/models/create_webhook_endpoint_request_spec.rb +34 -0
- data/spec/models/create_webhook_endpoint_request_webhook_endpoint_spec.rb +44 -0
- data/spec/models/credit_note_applied_tax_object_spec.rb +94 -0
- data/spec/models/credit_note_create_input_credit_note_items_inner_spec.rb +40 -0
- data/spec/models/credit_note_create_input_credit_note_spec.rb +68 -0
- data/spec/models/credit_note_create_input_spec.rb +34 -0
- data/spec/models/credit_note_item_object_fee_spec.rb +206 -0
- data/spec/models/credit_note_item_object_spec.rb +52 -0
- data/spec/models/credit_note_object_spec.rb +184 -0
- data/spec/models/credit_note_spec.rb +34 -0
- data/spec/models/credit_note_update_input_credit_note_spec.rb +38 -0
- data/spec/models/credit_note_update_input_spec.rb +34 -0
- data/spec/models/credit_notes_spec.rb +34 -0
- data/spec/models/credit_object_invoice_spec.rb +44 -0
- data/spec/models/credit_object_item_spec.rb +56 -0
- data/spec/models/credit_object_spec.rb +64 -0
- data/spec/models/currency_spec.rb +28 -0
- data/spec/models/customer_billing_configuration_spec.rb +74 -0
- data/spec/models/customer_charge_usage_object_billable_metric_spec.rb +56 -0
- data/spec/models/customer_charge_usage_object_charge_spec.rb +44 -0
- data/spec/models/customer_charge_usage_object_groups_inner_spec.rb +58 -0
- data/spec/models/customer_charge_usage_object_spec.rb +89 -0
- data/spec/models/customer_create_input_customer_metadata_inner_spec.rb +52 -0
- data/spec/models/customer_create_input_customer_spec.rb +154 -0
- data/spec/models/customer_create_input_spec.rb +34 -0
- data/spec/models/customer_metadata_spec.rb +58 -0
- data/spec/models/customer_object_extended_spec.rb +190 -0
- data/spec/models/customer_object_spec.rb +184 -0
- data/spec/models/customer_spec.rb +34 -0
- data/spec/models/customer_usage_object_spec.rb +76 -0
- data/spec/models/customer_usage_spec.rb +34 -0
- data/spec/models/customers_paginated_spec.rb +40 -0
- data/spec/models/event_batch_input_event_properties_spec.rb +38 -0
- data/spec/models/event_batch_input_event_spec.rb +64 -0
- data/spec/models/event_batch_input_spec.rb +34 -0
- data/spec/models/event_estimate_fees_input_event_spec.rb +52 -0
- data/spec/models/event_estimate_fees_input_spec.rb +34 -0
- data/spec/models/event_input_event_spec.rb +64 -0
- data/spec/models/event_input_spec.rb +34 -0
- data/spec/models/event_object_spec.rb +88 -0
- data/spec/models/event_spec.rb +34 -0
- data/spec/models/fee_applied_tax_object_spec.rb +88 -0
- data/spec/models/fee_object_item_spec.rb +66 -0
- data/spec/models/fee_object_spec.rb +206 -0
- data/spec/models/fee_spec.rb +34 -0
- data/spec/models/fee_update_input_fee_spec.rb +38 -0
- data/spec/models/fee_update_input_spec.rb +34 -0
- data/spec/models/fees_paginated_spec.rb +40 -0
- data/spec/models/fees_spec.rb +34 -0
- data/spec/models/find_all_webhook_endpoints200_response_spec.rb +40 -0
- data/spec/models/get_customer_portal_url200_response_customer_spec.rb +34 -0
- data/spec/models/get_customer_portal_url200_response_spec.rb +34 -0
- data/spec/models/group_object_spec.rb +46 -0
- data/spec/models/group_properties_object_spec.rb +40 -0
- data/spec/models/group_properties_object_values_spec.rb +100 -0
- data/spec/models/groups_paginated_spec.rb +40 -0
- data/spec/models/invoice_applied_tax_object_spec.rb +94 -0
- data/spec/models/invoice_metadata_object_spec.rb +52 -0
- data/spec/models/invoice_object_customer_spec.rb +184 -0
- data/spec/models/invoice_object_extended_spec.rb +196 -0
- data/spec/models/invoice_object_spec.rb +178 -0
- data/spec/models/invoice_one_off_create_input_invoice_fees_inner_spec.rb +58 -0
- data/spec/models/invoice_one_off_create_input_invoice_spec.rb +46 -0
- data/spec/models/invoice_one_off_create_input_spec.rb +34 -0
- data/spec/models/invoice_spec.rb +34 -0
- data/spec/models/invoice_update_input_invoice_metadata_inner_spec.rb +46 -0
- data/spec/models/invoice_update_input_invoice_spec.rb +44 -0
- data/spec/models/invoice_update_input_spec.rb +34 -0
- data/spec/models/invoices_paginated_spec.rb +40 -0
- data/spec/models/organization_billing_configuration_spec.rb +46 -0
- data/spec/models/organization_object_spec.rb +142 -0
- data/spec/models/organization_spec.rb +34 -0
- data/spec/models/organization_update_input_organization_spec.rb +122 -0
- data/spec/models/organization_update_input_spec.rb +34 -0
- data/spec/models/pagination_meta_spec.rb +58 -0
- data/spec/models/plan_create_input_plan_charges_inner_group_properties_inner_spec.rb +40 -0
- data/spec/models/plan_create_input_plan_charges_inner_spec.rb +86 -0
- data/spec/models/plan_create_input_plan_spec.rb +98 -0
- data/spec/models/plan_create_input_spec.rb +34 -0
- data/spec/models/plan_object_spec.rb +122 -0
- data/spec/models/plan_spec.rb +34 -0
- data/spec/models/plan_update_input_plan_charges_inner_spec.rb +92 -0
- data/spec/models/plan_update_input_plan_spec.rb +98 -0
- data/spec/models/plan_update_input_spec.rb +34 -0
- data/spec/models/plans_paginated_spec.rb +40 -0
- data/spec/models/subscription_create_input_spec.rb +34 -0
- data/spec/models/subscription_create_input_subscription_spec.rb +68 -0
- data/spec/models/subscription_object_spec.rb +132 -0
- data/spec/models/subscription_spec.rb +34 -0
- data/spec/models/subscription_update_input_spec.rb +34 -0
- data/spec/models/subscription_update_input_subscription_spec.rb +40 -0
- data/spec/models/subscriptions_paginated_spec.rb +40 -0
- data/spec/models/tax_base_input_spec.rb +58 -0
- data/spec/models/tax_create_input_spec.rb +34 -0
- data/spec/models/tax_create_input_tax_spec.rb +66 -0
- data/spec/models/tax_object_spec.rb +94 -0
- data/spec/models/tax_spec.rb +34 -0
- data/spec/models/tax_update_input_spec.rb +34 -0
- data/spec/models/taxes_paginated_spec.rb +40 -0
- data/spec/models/timezone_spec.rb +28 -0
- data/spec/models/wallet_create_input_spec.rb +34 -0
- data/spec/models/wallet_create_input_wallet_spec.rb +80 -0
- data/spec/models/wallet_object_spec.rb +140 -0
- data/spec/models/wallet_spec.rb +34 -0
- data/spec/models/wallet_transaction_create_input_spec.rb +34 -0
- data/spec/models/wallet_transaction_create_input_wallet_transaction_spec.rb +46 -0
- data/spec/models/wallet_transaction_object_spec.rb +95 -0
- data/spec/models/wallet_transactions_paginated_spec.rb +40 -0
- data/spec/models/wallet_transactions_spec.rb +34 -0
- data/spec/models/wallet_update_input_spec.rb +34 -0
- data/spec/models/wallet_update_input_wallet_spec.rb +40 -0
- data/spec/models/wallets_paginated_spec.rb +40 -0
- data/spec/spec_helper.rb +111 -0
- metadata +818 -0
|
@@ -0,0 +1,439 @@
|
|
|
1
|
+
# LagoAPI::BillableMetricsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.getlago.com/api/v1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_billable_metric**](BillableMetricsApi.md#create_billable_metric) | **POST** /billable_metrics | Create a billable metric |
|
|
8
|
+
| [**destroy_billable_metric**](BillableMetricsApi.md#destroy_billable_metric) | **DELETE** /billable_metrics/{code} | Delete a billable metric |
|
|
9
|
+
| [**find_all_billable_metric_groups**](BillableMetricsApi.md#find_all_billable_metric_groups) | **GET** /billable_metrics/{code}/groups | Find a billable metric's groups |
|
|
10
|
+
| [**find_all_billable_metrics**](BillableMetricsApi.md#find_all_billable_metrics) | **GET** /billable_metrics | List all billable metrics |
|
|
11
|
+
| [**find_billable_metric**](BillableMetricsApi.md#find_billable_metric) | **GET** /billable_metrics/{code} | Retrieve a billable metric |
|
|
12
|
+
| [**update_billable_metric**](BillableMetricsApi.md#update_billable_metric) | **PUT** /billable_metrics/{code} | Update a billable metric |
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## create_billable_metric
|
|
16
|
+
|
|
17
|
+
> <BillableMetric> create_billable_metric(billable_metric_create_input)
|
|
18
|
+
|
|
19
|
+
Create a billable metric
|
|
20
|
+
|
|
21
|
+
This endpoint creates a new billable metric representing a pricing component of your application.
|
|
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::BillableMetricsApi.new
|
|
35
|
+
billable_metric_create_input = LagoAPI::BillableMetricCreateInput.new({billable_metric: LagoAPI::BillableMetricCreateInputBillableMetric.new({name: 'Storage', code: 'storage', aggregation_type: 'count_agg'})}) # BillableMetricCreateInput | Billable metric payload
|
|
36
|
+
|
|
37
|
+
begin
|
|
38
|
+
# Create a billable metric
|
|
39
|
+
result = api_instance.create_billable_metric(billable_metric_create_input)
|
|
40
|
+
p result
|
|
41
|
+
rescue LagoAPI::ApiError => e
|
|
42
|
+
puts "Error when calling BillableMetricsApi->create_billable_metric: #{e}"
|
|
43
|
+
end
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
#### Using the create_billable_metric_with_http_info variant
|
|
47
|
+
|
|
48
|
+
This returns an Array which contains the response data, status code and headers.
|
|
49
|
+
|
|
50
|
+
> <Array(<BillableMetric>, Integer, Hash)> create_billable_metric_with_http_info(billable_metric_create_input)
|
|
51
|
+
|
|
52
|
+
```ruby
|
|
53
|
+
begin
|
|
54
|
+
# Create a billable metric
|
|
55
|
+
data, status_code, headers = api_instance.create_billable_metric_with_http_info(billable_metric_create_input)
|
|
56
|
+
p status_code # => 2xx
|
|
57
|
+
p headers # => { ... }
|
|
58
|
+
p data # => <BillableMetric>
|
|
59
|
+
rescue LagoAPI::ApiError => e
|
|
60
|
+
puts "Error when calling BillableMetricsApi->create_billable_metric_with_http_info: #{e}"
|
|
61
|
+
end
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Parameters
|
|
65
|
+
|
|
66
|
+
| Name | Type | Description | Notes |
|
|
67
|
+
| ---- | ---- | ----------- | ----- |
|
|
68
|
+
| **billable_metric_create_input** | [**BillableMetricCreateInput**](BillableMetricCreateInput.md) | Billable metric payload | |
|
|
69
|
+
|
|
70
|
+
### Return type
|
|
71
|
+
|
|
72
|
+
[**BillableMetric**](BillableMetric.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
|
+
## destroy_billable_metric
|
|
85
|
+
|
|
86
|
+
> <BillableMetric> destroy_billable_metric(code)
|
|
87
|
+
|
|
88
|
+
Delete a billable metric
|
|
89
|
+
|
|
90
|
+
This endpoint deletes an existing billable metric representing a pricing component of your application.
|
|
91
|
+
|
|
92
|
+
### Examples
|
|
93
|
+
|
|
94
|
+
```ruby
|
|
95
|
+
require 'time'
|
|
96
|
+
require 'lago_ruby'
|
|
97
|
+
# setup authorization
|
|
98
|
+
LagoAPI.configure do |config|
|
|
99
|
+
# Configure Bearer authorization: bearerAuth
|
|
100
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
api_instance = LagoAPI::BillableMetricsApi.new
|
|
104
|
+
code = 'storage' # String | Code of the existing billable metric.
|
|
105
|
+
|
|
106
|
+
begin
|
|
107
|
+
# Delete a billable metric
|
|
108
|
+
result = api_instance.destroy_billable_metric(code)
|
|
109
|
+
p result
|
|
110
|
+
rescue LagoAPI::ApiError => e
|
|
111
|
+
puts "Error when calling BillableMetricsApi->destroy_billable_metric: #{e}"
|
|
112
|
+
end
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
#### Using the destroy_billable_metric_with_http_info variant
|
|
116
|
+
|
|
117
|
+
This returns an Array which contains the response data, status code and headers.
|
|
118
|
+
|
|
119
|
+
> <Array(<BillableMetric>, Integer, Hash)> destroy_billable_metric_with_http_info(code)
|
|
120
|
+
|
|
121
|
+
```ruby
|
|
122
|
+
begin
|
|
123
|
+
# Delete a billable metric
|
|
124
|
+
data, status_code, headers = api_instance.destroy_billable_metric_with_http_info(code)
|
|
125
|
+
p status_code # => 2xx
|
|
126
|
+
p headers # => { ... }
|
|
127
|
+
p data # => <BillableMetric>
|
|
128
|
+
rescue LagoAPI::ApiError => e
|
|
129
|
+
puts "Error when calling BillableMetricsApi->destroy_billable_metric_with_http_info: #{e}"
|
|
130
|
+
end
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### Parameters
|
|
134
|
+
|
|
135
|
+
| Name | Type | Description | Notes |
|
|
136
|
+
| ---- | ---- | ----------- | ----- |
|
|
137
|
+
| **code** | **String** | Code of the existing billable metric. | |
|
|
138
|
+
|
|
139
|
+
### Return type
|
|
140
|
+
|
|
141
|
+
[**BillableMetric**](BillableMetric.md)
|
|
142
|
+
|
|
143
|
+
### Authorization
|
|
144
|
+
|
|
145
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
146
|
+
|
|
147
|
+
### HTTP request headers
|
|
148
|
+
|
|
149
|
+
- **Content-Type**: Not defined
|
|
150
|
+
- **Accept**: application/json
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
## find_all_billable_metric_groups
|
|
154
|
+
|
|
155
|
+
> <GroupsPaginated> find_all_billable_metric_groups(code, opts)
|
|
156
|
+
|
|
157
|
+
Find a billable metric's groups
|
|
158
|
+
|
|
159
|
+
This endpoint retrieves all groups for a billable metric.
|
|
160
|
+
|
|
161
|
+
### Examples
|
|
162
|
+
|
|
163
|
+
```ruby
|
|
164
|
+
require 'time'
|
|
165
|
+
require 'lago_ruby'
|
|
166
|
+
# setup authorization
|
|
167
|
+
LagoAPI.configure do |config|
|
|
168
|
+
# Configure Bearer authorization: bearerAuth
|
|
169
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
170
|
+
end
|
|
171
|
+
|
|
172
|
+
api_instance = LagoAPI::BillableMetricsApi.new
|
|
173
|
+
code = 'example_code' # String | Code of the existing billable metric.
|
|
174
|
+
opts = {
|
|
175
|
+
page: 1, # Integer | Page number.
|
|
176
|
+
per_page: 20 # Integer | Number of records per page.
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
begin
|
|
180
|
+
# Find a billable metric's groups
|
|
181
|
+
result = api_instance.find_all_billable_metric_groups(code, opts)
|
|
182
|
+
p result
|
|
183
|
+
rescue LagoAPI::ApiError => e
|
|
184
|
+
puts "Error when calling BillableMetricsApi->find_all_billable_metric_groups: #{e}"
|
|
185
|
+
end
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
#### Using the find_all_billable_metric_groups_with_http_info variant
|
|
189
|
+
|
|
190
|
+
This returns an Array which contains the response data, status code and headers.
|
|
191
|
+
|
|
192
|
+
> <Array(<GroupsPaginated>, Integer, Hash)> find_all_billable_metric_groups_with_http_info(code, opts)
|
|
193
|
+
|
|
194
|
+
```ruby
|
|
195
|
+
begin
|
|
196
|
+
# Find a billable metric's groups
|
|
197
|
+
data, status_code, headers = api_instance.find_all_billable_metric_groups_with_http_info(code, opts)
|
|
198
|
+
p status_code # => 2xx
|
|
199
|
+
p headers # => { ... }
|
|
200
|
+
p data # => <GroupsPaginated>
|
|
201
|
+
rescue LagoAPI::ApiError => e
|
|
202
|
+
puts "Error when calling BillableMetricsApi->find_all_billable_metric_groups_with_http_info: #{e}"
|
|
203
|
+
end
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
### Parameters
|
|
207
|
+
|
|
208
|
+
| Name | Type | Description | Notes |
|
|
209
|
+
| ---- | ---- | ----------- | ----- |
|
|
210
|
+
| **code** | **String** | Code of the existing billable metric. | |
|
|
211
|
+
| **page** | **Integer** | Page number. | [optional] |
|
|
212
|
+
| **per_page** | **Integer** | Number of records per page. | [optional] |
|
|
213
|
+
|
|
214
|
+
### Return type
|
|
215
|
+
|
|
216
|
+
[**GroupsPaginated**](GroupsPaginated.md)
|
|
217
|
+
|
|
218
|
+
### Authorization
|
|
219
|
+
|
|
220
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
221
|
+
|
|
222
|
+
### HTTP request headers
|
|
223
|
+
|
|
224
|
+
- **Content-Type**: Not defined
|
|
225
|
+
- **Accept**: application/json
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
## find_all_billable_metrics
|
|
229
|
+
|
|
230
|
+
> <BillableMetricsPaginated> find_all_billable_metrics(opts)
|
|
231
|
+
|
|
232
|
+
List all billable metrics
|
|
233
|
+
|
|
234
|
+
This endpoint retrieves all existing billable metrics that represent pricing components of your application.
|
|
235
|
+
|
|
236
|
+
### Examples
|
|
237
|
+
|
|
238
|
+
```ruby
|
|
239
|
+
require 'time'
|
|
240
|
+
require 'lago_ruby'
|
|
241
|
+
# setup authorization
|
|
242
|
+
LagoAPI.configure do |config|
|
|
243
|
+
# Configure Bearer authorization: bearerAuth
|
|
244
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
245
|
+
end
|
|
246
|
+
|
|
247
|
+
api_instance = LagoAPI::BillableMetricsApi.new
|
|
248
|
+
opts = {
|
|
249
|
+
page: 1, # Integer | Page number.
|
|
250
|
+
per_page: 20 # Integer | Number of records per page.
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
begin
|
|
254
|
+
# List all billable metrics
|
|
255
|
+
result = api_instance.find_all_billable_metrics(opts)
|
|
256
|
+
p result
|
|
257
|
+
rescue LagoAPI::ApiError => e
|
|
258
|
+
puts "Error when calling BillableMetricsApi->find_all_billable_metrics: #{e}"
|
|
259
|
+
end
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
#### Using the find_all_billable_metrics_with_http_info variant
|
|
263
|
+
|
|
264
|
+
This returns an Array which contains the response data, status code and headers.
|
|
265
|
+
|
|
266
|
+
> <Array(<BillableMetricsPaginated>, Integer, Hash)> find_all_billable_metrics_with_http_info(opts)
|
|
267
|
+
|
|
268
|
+
```ruby
|
|
269
|
+
begin
|
|
270
|
+
# List all billable metrics
|
|
271
|
+
data, status_code, headers = api_instance.find_all_billable_metrics_with_http_info(opts)
|
|
272
|
+
p status_code # => 2xx
|
|
273
|
+
p headers # => { ... }
|
|
274
|
+
p data # => <BillableMetricsPaginated>
|
|
275
|
+
rescue LagoAPI::ApiError => e
|
|
276
|
+
puts "Error when calling BillableMetricsApi->find_all_billable_metrics_with_http_info: #{e}"
|
|
277
|
+
end
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
### Parameters
|
|
281
|
+
|
|
282
|
+
| Name | Type | Description | Notes |
|
|
283
|
+
| ---- | ---- | ----------- | ----- |
|
|
284
|
+
| **page** | **Integer** | Page number. | [optional] |
|
|
285
|
+
| **per_page** | **Integer** | Number of records per page. | [optional] |
|
|
286
|
+
|
|
287
|
+
### Return type
|
|
288
|
+
|
|
289
|
+
[**BillableMetricsPaginated**](BillableMetricsPaginated.md)
|
|
290
|
+
|
|
291
|
+
### Authorization
|
|
292
|
+
|
|
293
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
294
|
+
|
|
295
|
+
### HTTP request headers
|
|
296
|
+
|
|
297
|
+
- **Content-Type**: Not defined
|
|
298
|
+
- **Accept**: application/json
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
## find_billable_metric
|
|
302
|
+
|
|
303
|
+
> <BillableMetric> find_billable_metric(code)
|
|
304
|
+
|
|
305
|
+
Retrieve a billable metric
|
|
306
|
+
|
|
307
|
+
This endpoint retrieves an existing billable metric that represents a pricing component of your application. The billable metric is identified by its unique code.
|
|
308
|
+
|
|
309
|
+
### Examples
|
|
310
|
+
|
|
311
|
+
```ruby
|
|
312
|
+
require 'time'
|
|
313
|
+
require 'lago_ruby'
|
|
314
|
+
# setup authorization
|
|
315
|
+
LagoAPI.configure do |config|
|
|
316
|
+
# Configure Bearer authorization: bearerAuth
|
|
317
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
318
|
+
end
|
|
319
|
+
|
|
320
|
+
api_instance = LagoAPI::BillableMetricsApi.new
|
|
321
|
+
code = 'storage' # String | Code of the existing billable metric.
|
|
322
|
+
|
|
323
|
+
begin
|
|
324
|
+
# Retrieve a billable metric
|
|
325
|
+
result = api_instance.find_billable_metric(code)
|
|
326
|
+
p result
|
|
327
|
+
rescue LagoAPI::ApiError => e
|
|
328
|
+
puts "Error when calling BillableMetricsApi->find_billable_metric: #{e}"
|
|
329
|
+
end
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
#### Using the find_billable_metric_with_http_info variant
|
|
333
|
+
|
|
334
|
+
This returns an Array which contains the response data, status code and headers.
|
|
335
|
+
|
|
336
|
+
> <Array(<BillableMetric>, Integer, Hash)> find_billable_metric_with_http_info(code)
|
|
337
|
+
|
|
338
|
+
```ruby
|
|
339
|
+
begin
|
|
340
|
+
# Retrieve a billable metric
|
|
341
|
+
data, status_code, headers = api_instance.find_billable_metric_with_http_info(code)
|
|
342
|
+
p status_code # => 2xx
|
|
343
|
+
p headers # => { ... }
|
|
344
|
+
p data # => <BillableMetric>
|
|
345
|
+
rescue LagoAPI::ApiError => e
|
|
346
|
+
puts "Error when calling BillableMetricsApi->find_billable_metric_with_http_info: #{e}"
|
|
347
|
+
end
|
|
348
|
+
```
|
|
349
|
+
|
|
350
|
+
### Parameters
|
|
351
|
+
|
|
352
|
+
| Name | Type | Description | Notes |
|
|
353
|
+
| ---- | ---- | ----------- | ----- |
|
|
354
|
+
| **code** | **String** | Code of the existing billable metric. | |
|
|
355
|
+
|
|
356
|
+
### Return type
|
|
357
|
+
|
|
358
|
+
[**BillableMetric**](BillableMetric.md)
|
|
359
|
+
|
|
360
|
+
### Authorization
|
|
361
|
+
|
|
362
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
363
|
+
|
|
364
|
+
### HTTP request headers
|
|
365
|
+
|
|
366
|
+
- **Content-Type**: Not defined
|
|
367
|
+
- **Accept**: application/json
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
## update_billable_metric
|
|
371
|
+
|
|
372
|
+
> <BillableMetric> update_billable_metric(code, billable_metric_update_input)
|
|
373
|
+
|
|
374
|
+
Update a billable metric
|
|
375
|
+
|
|
376
|
+
This endpoint updates an existing billable metric representing a pricing component of your application.
|
|
377
|
+
|
|
378
|
+
### Examples
|
|
379
|
+
|
|
380
|
+
```ruby
|
|
381
|
+
require 'time'
|
|
382
|
+
require 'lago_ruby'
|
|
383
|
+
# setup authorization
|
|
384
|
+
LagoAPI.configure do |config|
|
|
385
|
+
# Configure Bearer authorization: bearerAuth
|
|
386
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
387
|
+
end
|
|
388
|
+
|
|
389
|
+
api_instance = LagoAPI::BillableMetricsApi.new
|
|
390
|
+
code = 'storage' # String | Code of the existing billable metric.
|
|
391
|
+
billable_metric_update_input = LagoAPI::BillableMetricUpdateInput.new({billable_metric: LagoAPI::BillableMetricBaseInput.new}) # BillableMetricUpdateInput | Billable metric payload
|
|
392
|
+
|
|
393
|
+
begin
|
|
394
|
+
# Update a billable metric
|
|
395
|
+
result = api_instance.update_billable_metric(code, billable_metric_update_input)
|
|
396
|
+
p result
|
|
397
|
+
rescue LagoAPI::ApiError => e
|
|
398
|
+
puts "Error when calling BillableMetricsApi->update_billable_metric: #{e}"
|
|
399
|
+
end
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
#### Using the update_billable_metric_with_http_info variant
|
|
403
|
+
|
|
404
|
+
This returns an Array which contains the response data, status code and headers.
|
|
405
|
+
|
|
406
|
+
> <Array(<BillableMetric>, Integer, Hash)> update_billable_metric_with_http_info(code, billable_metric_update_input)
|
|
407
|
+
|
|
408
|
+
```ruby
|
|
409
|
+
begin
|
|
410
|
+
# Update a billable metric
|
|
411
|
+
data, status_code, headers = api_instance.update_billable_metric_with_http_info(code, billable_metric_update_input)
|
|
412
|
+
p status_code # => 2xx
|
|
413
|
+
p headers # => { ... }
|
|
414
|
+
p data # => <BillableMetric>
|
|
415
|
+
rescue LagoAPI::ApiError => e
|
|
416
|
+
puts "Error when calling BillableMetricsApi->update_billable_metric_with_http_info: #{e}"
|
|
417
|
+
end
|
|
418
|
+
```
|
|
419
|
+
|
|
420
|
+
### Parameters
|
|
421
|
+
|
|
422
|
+
| Name | Type | Description | Notes |
|
|
423
|
+
| ---- | ---- | ----------- | ----- |
|
|
424
|
+
| **code** | **String** | Code of the existing billable metric. | |
|
|
425
|
+
| **billable_metric_update_input** | [**BillableMetricUpdateInput**](BillableMetricUpdateInput.md) | Billable metric payload | |
|
|
426
|
+
|
|
427
|
+
### Return type
|
|
428
|
+
|
|
429
|
+
[**BillableMetric**](BillableMetric.md)
|
|
430
|
+
|
|
431
|
+
### Authorization
|
|
432
|
+
|
|
433
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
434
|
+
|
|
435
|
+
### HTTP request headers
|
|
436
|
+
|
|
437
|
+
- **Content-Type**: application/json
|
|
438
|
+
- **Accept**: application/json
|
|
439
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# LagoAPI::BillableMetricsPaginated
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **billable_metrics** | [**Array<BillableMetricObject>**](BillableMetricObject.md) | | |
|
|
8
|
+
| **meta** | [**PaginationMeta**](PaginationMeta.md) | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'lago_ruby'
|
|
14
|
+
|
|
15
|
+
instance = LagoAPI::BillableMetricsPaginated.new(
|
|
16
|
+
billable_metrics: null,
|
|
17
|
+
meta: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# LagoAPI::ChargeObject
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **lago_id** | **String** | Unique identifier of charge, created by Lago. | |
|
|
8
|
+
| **lago_billable_metric_id** | **String** | Unique identifier of the billable metric created by Lago. | |
|
|
9
|
+
| **billable_metric_code** | **String** | Unique code identifying a billable metric. | |
|
|
10
|
+
| **created_at** | **Time** | The date and time when the charge was created. It is expressed in UTC format according to the ISO 8601 datetime standard. | |
|
|
11
|
+
| **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`. | |
|
|
12
|
+
| **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] |
|
|
13
|
+
| **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] |
|
|
14
|
+
| **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] |
|
|
15
|
+
| **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] |
|
|
16
|
+
| **properties** | [**ChargeObjectProperties**](ChargeObjectProperties.md) | | [optional] |
|
|
17
|
+
| **group_properties** | [**Array<GroupPropertiesObject>**](GroupPropertiesObject.md) | All charge information, sorted by groups. | [optional] |
|
|
18
|
+
| **taxes** | [**Array<TaxObject>**](TaxObject.md) | All taxes applied to the charge. | [optional] |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'lago_ruby'
|
|
24
|
+
|
|
25
|
+
instance = LagoAPI::ChargeObject.new(
|
|
26
|
+
lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
|
|
27
|
+
lago_billable_metric_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
|
|
28
|
+
billable_metric_code: requests,
|
|
29
|
+
created_at: 2022-09-14T16:35:31Z,
|
|
30
|
+
charge_model: null,
|
|
31
|
+
pay_in_advance: true,
|
|
32
|
+
invoiceable: true,
|
|
33
|
+
prorated: false,
|
|
34
|
+
min_amount_cents: 1200,
|
|
35
|
+
properties: null,
|
|
36
|
+
group_properties: null,
|
|
37
|
+
taxes: null
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# LagoAPI::ChargeObjectProperties
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **graduated_ranges** | [**Array<ChargePropertiesGraduatedRangesInner>**](ChargePropertiesGraduatedRangesInner.md) | Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model. | [optional] |
|
|
8
|
+
| **graduated_percentage_ranges** | [**Array<ChargePropertiesGraduatedPercentageRangesInner>**](ChargePropertiesGraduatedPercentageRangesInner.md) | Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model. | [optional] |
|
|
9
|
+
| **amount** | **String** | - The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value. - The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value. | [optional] |
|
|
10
|
+
| **free_units** | **Integer** | The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle. | [optional] |
|
|
11
|
+
| **package_size** | **Integer** | The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure. | [optional] |
|
|
12
|
+
| **rate** | **String** | The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value. | [optional] |
|
|
13
|
+
| **fixed_amount** | **String** | The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value. | [optional] |
|
|
14
|
+
| **free_units_per_events** | **Integer** | The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee. | [optional] |
|
|
15
|
+
| **free_units_per_total_aggregation** | **String** | The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee. | [optional] |
|
|
16
|
+
| **per_transaction_max_amount** | **String** | Specifies the maximum allowable spending for a single transaction. Working as a transaction cap. | [optional] |
|
|
17
|
+
| **per_transaction_min_amount** | **String** | Specifies the minimum allowable spending for a single transaction. Working as a transaction floor. | [optional] |
|
|
18
|
+
| **volume_ranges** | [**Array<ChargePropertiesVolumeRangesInner>**](ChargePropertiesVolumeRangesInner.md) | Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model. | [optional] |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'lago_ruby'
|
|
24
|
+
|
|
25
|
+
instance = LagoAPI::ChargeObjectProperties.new(
|
|
26
|
+
graduated_ranges: null,
|
|
27
|
+
graduated_percentage_ranges: null,
|
|
28
|
+
amount: 30,
|
|
29
|
+
free_units: 100,
|
|
30
|
+
package_size: 1000,
|
|
31
|
+
rate: 1,
|
|
32
|
+
fixed_amount: 0.5,
|
|
33
|
+
free_units_per_events: 5,
|
|
34
|
+
free_units_per_total_aggregation: 500,
|
|
35
|
+
per_transaction_max_amount: 3.75,
|
|
36
|
+
per_transaction_min_amount: 1.75,
|
|
37
|
+
volume_ranges: null
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# LagoAPI::ChargeProperties
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **graduated_ranges** | [**Array<ChargePropertiesGraduatedRangesInner>**](ChargePropertiesGraduatedRangesInner.md) | Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model. | [optional] |
|
|
8
|
+
| **graduated_percentage_ranges** | [**Array<ChargePropertiesGraduatedPercentageRangesInner>**](ChargePropertiesGraduatedPercentageRangesInner.md) | Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model. | [optional] |
|
|
9
|
+
| **amount** | **String** | - The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value. - The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value. | [optional] |
|
|
10
|
+
| **free_units** | **Integer** | The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle. | [optional] |
|
|
11
|
+
| **package_size** | **Integer** | The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure. | [optional] |
|
|
12
|
+
| **rate** | **String** | The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value. | [optional] |
|
|
13
|
+
| **fixed_amount** | **String** | The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value. | [optional] |
|
|
14
|
+
| **free_units_per_events** | **Integer** | The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee. | [optional] |
|
|
15
|
+
| **free_units_per_total_aggregation** | **String** | The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee. | [optional] |
|
|
16
|
+
| **per_transaction_max_amount** | **String** | Specifies the maximum allowable spending for a single transaction. Working as a transaction cap. | [optional] |
|
|
17
|
+
| **per_transaction_min_amount** | **String** | Specifies the minimum allowable spending for a single transaction. Working as a transaction floor. | [optional] |
|
|
18
|
+
| **volume_ranges** | [**Array<ChargePropertiesVolumeRangesInner>**](ChargePropertiesVolumeRangesInner.md) | Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model. | [optional] |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'lago_ruby'
|
|
24
|
+
|
|
25
|
+
instance = LagoAPI::ChargeProperties.new(
|
|
26
|
+
graduated_ranges: null,
|
|
27
|
+
graduated_percentage_ranges: null,
|
|
28
|
+
amount: 30,
|
|
29
|
+
free_units: 100,
|
|
30
|
+
package_size: 1000,
|
|
31
|
+
rate: 1,
|
|
32
|
+
fixed_amount: 0.5,
|
|
33
|
+
free_units_per_events: 5,
|
|
34
|
+
free_units_per_total_aggregation: 500,
|
|
35
|
+
per_transaction_max_amount: 3.75,
|
|
36
|
+
per_transaction_min_amount: 1.75,
|
|
37
|
+
volume_ranges: null
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# LagoAPI::ChargePropertiesGraduatedPercentageRangesInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **from_value** | **Integer** | Specifies the lower value of a tier for a `graduated_percentage` charge model. It must be either 0 or the previous range's `to_value + 1` to maintain the proper sequence of values. | |
|
|
8
|
+
| **to_value** | **Integer** | Specifies the highest value of a tier for a `graduated_percentage` charge model. - This value must be higher than the from_value of the same tier. - This value must be null for the last tier. | |
|
|
9
|
+
| **rate** | **String** | The percentage rate that is applied to the amount of each transaction in the tier for a `graduated_percentage` charge model. It is expressed as a decimal value. | |
|
|
10
|
+
| **flat_amount** | **String** | The flat amount for a whole tier, excluding tax, for a `graduated_percentage` charge model. It is expressed as a decimal value. | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'lago_ruby'
|
|
16
|
+
|
|
17
|
+
instance = LagoAPI::ChargePropertiesGraduatedPercentageRangesInner.new(
|
|
18
|
+
from_value: 0,
|
|
19
|
+
to_value: 10,
|
|
20
|
+
rate: 1,
|
|
21
|
+
flat_amount: 10
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# LagoAPI::ChargePropertiesGraduatedRangesInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **from_value** | **Integer** | Specifies the lower value of a tier for a `graduated` charge model. It must be either 0 or the previous range's `to_value + 1` to maintain the proper sequence of values. | |
|
|
8
|
+
| **to_value** | **Integer** | Specifies the highest value of a tier for a `graduated` charge model. - This value must be higher than the from_value of the same tier. - This value must be null for the last tier. | |
|
|
9
|
+
| **flat_amount** | **String** | The flat amount for a whole tier, excluding tax, for a `graduated` charge model. It is expressed as a decimal value. | |
|
|
10
|
+
| **per_unit_amount** | **String** | The unit price, excluding tax, for a specific tier of a `graduated` charge model. It is expressed as a decimal value. | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'lago_ruby'
|
|
16
|
+
|
|
17
|
+
instance = LagoAPI::ChargePropertiesGraduatedRangesInner.new(
|
|
18
|
+
from_value: 0,
|
|
19
|
+
to_value: 10,
|
|
20
|
+
flat_amount: 10,
|
|
21
|
+
per_unit_amount: 0.5
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# LagoAPI::ChargePropertiesVolumeRangesInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **from_value** | **Integer** | Specifies the lower value of a tier for a `volume` charge model. It must be either 0 or the previous range's `to_value + 1` to maintain the proper sequence of values. | |
|
|
8
|
+
| **to_value** | **Integer** | Specifies the highest value of a tier for a `volume` charge model. - This value must be higher than the `from_value` of the same tier. - This value must be `null` for the last tier. | |
|
|
9
|
+
| **flat_amount** | **String** | The unit price, excluding tax, for a specific tier of a `volume` charge model. It is expressed as a decimal value. | |
|
|
10
|
+
| **per_unit_amount** | **String** | The flat amount for a whole tier, excluding tax, for a `volume` charge model. It is expressed as a decimal value. | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'lago_ruby'
|
|
16
|
+
|
|
17
|
+
instance = LagoAPI::ChargePropertiesVolumeRangesInner.new(
|
|
18
|
+
from_value: 0,
|
|
19
|
+
to_value: 10,
|
|
20
|
+
flat_amount: 10,
|
|
21
|
+
per_unit_amount: 0.5
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|