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
data/docs/InvoicesApi.md
ADDED
@@ -0,0 +1,582 @@
|
|
1
|
+
# LagoAPI::InvoicesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.getlago.com/api/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_invoice**](InvoicesApi.md#create_invoice) | **POST** /invoices | Create a one-off invoice |
|
8
|
+
| [**download_invoice**](InvoicesApi.md#download_invoice) | **POST** /invoices/{lago_id}/download | Download an invoice PDF |
|
9
|
+
| [**finalize_invoice**](InvoicesApi.md#finalize_invoice) | **PUT** /invoices/{lago_id}/finalize | Finalize a draft invoice |
|
10
|
+
| [**find_all_invoices**](InvoicesApi.md#find_all_invoices) | **GET** /invoices | List all invoices |
|
11
|
+
| [**find_invoice**](InvoicesApi.md#find_invoice) | **GET** /invoices/{lago_id} | Retrieve an invoice |
|
12
|
+
| [**refresh_invoice**](InvoicesApi.md#refresh_invoice) | **PUT** /invoices/{lago_id}/refresh | Refresh a draft invoice |
|
13
|
+
| [**retry_payment**](InvoicesApi.md#retry_payment) | **POST** /invoices/{lago_id}/retry_payment | Retry an invoice payment |
|
14
|
+
| [**update_invoice**](InvoicesApi.md#update_invoice) | **PUT** /invoices/{lago_id} | Update an invoice |
|
15
|
+
|
16
|
+
|
17
|
+
## create_invoice
|
18
|
+
|
19
|
+
> <Invoice> create_invoice(invoice_one_off_create_input)
|
20
|
+
|
21
|
+
Create a one-off invoice
|
22
|
+
|
23
|
+
This endpoint is used for issuing a one-off invoice.
|
24
|
+
|
25
|
+
### Examples
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'time'
|
29
|
+
require 'lago_ruby'
|
30
|
+
# setup authorization
|
31
|
+
LagoAPI.configure do |config|
|
32
|
+
# Configure Bearer authorization: bearerAuth
|
33
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
34
|
+
end
|
35
|
+
|
36
|
+
api_instance = LagoAPI::InvoicesApi.new
|
37
|
+
invoice_one_off_create_input = LagoAPI::InvoiceOneOffCreateInput.new({invoice: LagoAPI::InvoiceOneOffCreateInputInvoice.new({external_customer_id: 'hooli_1234', fees: [LagoAPI::InvoiceOneOffCreateInputInvoiceFeesInner.new({add_on_code: 'setup_fee'})]})}) # InvoiceOneOffCreateInput | Invoice payload
|
38
|
+
|
39
|
+
begin
|
40
|
+
# Create a one-off invoice
|
41
|
+
result = api_instance.create_invoice(invoice_one_off_create_input)
|
42
|
+
p result
|
43
|
+
rescue LagoAPI::ApiError => e
|
44
|
+
puts "Error when calling InvoicesApi->create_invoice: #{e}"
|
45
|
+
end
|
46
|
+
```
|
47
|
+
|
48
|
+
#### Using the create_invoice_with_http_info variant
|
49
|
+
|
50
|
+
This returns an Array which contains the response data, status code and headers.
|
51
|
+
|
52
|
+
> <Array(<Invoice>, Integer, Hash)> create_invoice_with_http_info(invoice_one_off_create_input)
|
53
|
+
|
54
|
+
```ruby
|
55
|
+
begin
|
56
|
+
# Create a one-off invoice
|
57
|
+
data, status_code, headers = api_instance.create_invoice_with_http_info(invoice_one_off_create_input)
|
58
|
+
p status_code # => 2xx
|
59
|
+
p headers # => { ... }
|
60
|
+
p data # => <Invoice>
|
61
|
+
rescue LagoAPI::ApiError => e
|
62
|
+
puts "Error when calling InvoicesApi->create_invoice_with_http_info: #{e}"
|
63
|
+
end
|
64
|
+
```
|
65
|
+
|
66
|
+
### Parameters
|
67
|
+
|
68
|
+
| Name | Type | Description | Notes |
|
69
|
+
| ---- | ---- | ----------- | ----- |
|
70
|
+
| **invoice_one_off_create_input** | [**InvoiceOneOffCreateInput**](InvoiceOneOffCreateInput.md) | Invoice payload | |
|
71
|
+
|
72
|
+
### Return type
|
73
|
+
|
74
|
+
[**Invoice**](Invoice.md)
|
75
|
+
|
76
|
+
### Authorization
|
77
|
+
|
78
|
+
[bearerAuth](../README.md#bearerAuth)
|
79
|
+
|
80
|
+
### HTTP request headers
|
81
|
+
|
82
|
+
- **Content-Type**: application/json
|
83
|
+
- **Accept**: application/json
|
84
|
+
|
85
|
+
|
86
|
+
## download_invoice
|
87
|
+
|
88
|
+
> <Invoice> download_invoice(lago_id)
|
89
|
+
|
90
|
+
Download an invoice PDF
|
91
|
+
|
92
|
+
This endpoint is used for downloading a specific invoice PDF document.
|
93
|
+
|
94
|
+
### Examples
|
95
|
+
|
96
|
+
```ruby
|
97
|
+
require 'time'
|
98
|
+
require 'lago_ruby'
|
99
|
+
# setup authorization
|
100
|
+
LagoAPI.configure do |config|
|
101
|
+
# Configure Bearer authorization: bearerAuth
|
102
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
103
|
+
end
|
104
|
+
|
105
|
+
api_instance = LagoAPI::InvoicesApi.new
|
106
|
+
lago_id = '1a901a90-1a90-1a90-1a90-1a901a901a90' # String | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice’s record within the Lago system.
|
107
|
+
|
108
|
+
begin
|
109
|
+
# Download an invoice PDF
|
110
|
+
result = api_instance.download_invoice(lago_id)
|
111
|
+
p result
|
112
|
+
rescue LagoAPI::ApiError => e
|
113
|
+
puts "Error when calling InvoicesApi->download_invoice: #{e}"
|
114
|
+
end
|
115
|
+
```
|
116
|
+
|
117
|
+
#### Using the download_invoice_with_http_info variant
|
118
|
+
|
119
|
+
This returns an Array which contains the response data, status code and headers.
|
120
|
+
|
121
|
+
> <Array(<Invoice>, Integer, Hash)> download_invoice_with_http_info(lago_id)
|
122
|
+
|
123
|
+
```ruby
|
124
|
+
begin
|
125
|
+
# Download an invoice PDF
|
126
|
+
data, status_code, headers = api_instance.download_invoice_with_http_info(lago_id)
|
127
|
+
p status_code # => 2xx
|
128
|
+
p headers # => { ... }
|
129
|
+
p data # => <Invoice>
|
130
|
+
rescue LagoAPI::ApiError => e
|
131
|
+
puts "Error when calling InvoicesApi->download_invoice_with_http_info: #{e}"
|
132
|
+
end
|
133
|
+
```
|
134
|
+
|
135
|
+
### Parameters
|
136
|
+
|
137
|
+
| Name | Type | Description | Notes |
|
138
|
+
| ---- | ---- | ----------- | ----- |
|
139
|
+
| **lago_id** | **String** | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice’s record within the Lago system. | |
|
140
|
+
|
141
|
+
### Return type
|
142
|
+
|
143
|
+
[**Invoice**](Invoice.md)
|
144
|
+
|
145
|
+
### Authorization
|
146
|
+
|
147
|
+
[bearerAuth](../README.md#bearerAuth)
|
148
|
+
|
149
|
+
### HTTP request headers
|
150
|
+
|
151
|
+
- **Content-Type**: Not defined
|
152
|
+
- **Accept**: application/json
|
153
|
+
|
154
|
+
|
155
|
+
## finalize_invoice
|
156
|
+
|
157
|
+
> <Invoice> finalize_invoice(lago_id)
|
158
|
+
|
159
|
+
Finalize a draft invoice
|
160
|
+
|
161
|
+
This endpoint is used for finalizing a draft invoice.
|
162
|
+
|
163
|
+
### Examples
|
164
|
+
|
165
|
+
```ruby
|
166
|
+
require 'time'
|
167
|
+
require 'lago_ruby'
|
168
|
+
# setup authorization
|
169
|
+
LagoAPI.configure do |config|
|
170
|
+
# Configure Bearer authorization: bearerAuth
|
171
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
172
|
+
end
|
173
|
+
|
174
|
+
api_instance = LagoAPI::InvoicesApi.new
|
175
|
+
lago_id = '1a901a90-1a90-1a90-1a90-1a901a901a90' # String | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice’s record within the Lago system.
|
176
|
+
|
177
|
+
begin
|
178
|
+
# Finalize a draft invoice
|
179
|
+
result = api_instance.finalize_invoice(lago_id)
|
180
|
+
p result
|
181
|
+
rescue LagoAPI::ApiError => e
|
182
|
+
puts "Error when calling InvoicesApi->finalize_invoice: #{e}"
|
183
|
+
end
|
184
|
+
```
|
185
|
+
|
186
|
+
#### Using the finalize_invoice_with_http_info variant
|
187
|
+
|
188
|
+
This returns an Array which contains the response data, status code and headers.
|
189
|
+
|
190
|
+
> <Array(<Invoice>, Integer, Hash)> finalize_invoice_with_http_info(lago_id)
|
191
|
+
|
192
|
+
```ruby
|
193
|
+
begin
|
194
|
+
# Finalize a draft invoice
|
195
|
+
data, status_code, headers = api_instance.finalize_invoice_with_http_info(lago_id)
|
196
|
+
p status_code # => 2xx
|
197
|
+
p headers # => { ... }
|
198
|
+
p data # => <Invoice>
|
199
|
+
rescue LagoAPI::ApiError => e
|
200
|
+
puts "Error when calling InvoicesApi->finalize_invoice_with_http_info: #{e}"
|
201
|
+
end
|
202
|
+
```
|
203
|
+
|
204
|
+
### Parameters
|
205
|
+
|
206
|
+
| Name | Type | Description | Notes |
|
207
|
+
| ---- | ---- | ----------- | ----- |
|
208
|
+
| **lago_id** | **String** | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice’s record within the Lago system. | |
|
209
|
+
|
210
|
+
### Return type
|
211
|
+
|
212
|
+
[**Invoice**](Invoice.md)
|
213
|
+
|
214
|
+
### Authorization
|
215
|
+
|
216
|
+
[bearerAuth](../README.md#bearerAuth)
|
217
|
+
|
218
|
+
### HTTP request headers
|
219
|
+
|
220
|
+
- **Content-Type**: Not defined
|
221
|
+
- **Accept**: application/json
|
222
|
+
|
223
|
+
|
224
|
+
## find_all_invoices
|
225
|
+
|
226
|
+
> <InvoicesPaginated> find_all_invoices(opts)
|
227
|
+
|
228
|
+
List all invoices
|
229
|
+
|
230
|
+
This endpoint is used for retrievign all invoices.
|
231
|
+
|
232
|
+
### Examples
|
233
|
+
|
234
|
+
```ruby
|
235
|
+
require 'time'
|
236
|
+
require 'lago_ruby'
|
237
|
+
# setup authorization
|
238
|
+
LagoAPI.configure do |config|
|
239
|
+
# Configure Bearer authorization: bearerAuth
|
240
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
241
|
+
end
|
242
|
+
|
243
|
+
api_instance = LagoAPI::InvoicesApi.new
|
244
|
+
opts = {
|
245
|
+
page: 1, # Integer | Page number.
|
246
|
+
per_page: 20, # Integer | Number of records per page.
|
247
|
+
external_customer_id: '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba', # String | Unique identifier assigned to the customer in your application.
|
248
|
+
issuing_date_from: Date.parse('Fri Jul 08 00:00:00 UTC 2022'), # Date | Filter invoices starting from a specific date.
|
249
|
+
issuing_date_to: Date.parse('Tue Aug 09 00:00:00 UTC 2022'), # Date | Filter invoices up to a specific date.
|
250
|
+
status: 'draft', # String | Filter invoices by status. Possible values are `draft` or `finalized`.
|
251
|
+
payment_status: 'pending' # String | Filter invoices by payment status. Possible values are `pending`, `failed` or `succeeded`.
|
252
|
+
}
|
253
|
+
|
254
|
+
begin
|
255
|
+
# List all invoices
|
256
|
+
result = api_instance.find_all_invoices(opts)
|
257
|
+
p result
|
258
|
+
rescue LagoAPI::ApiError => e
|
259
|
+
puts "Error when calling InvoicesApi->find_all_invoices: #{e}"
|
260
|
+
end
|
261
|
+
```
|
262
|
+
|
263
|
+
#### Using the find_all_invoices_with_http_info variant
|
264
|
+
|
265
|
+
This returns an Array which contains the response data, status code and headers.
|
266
|
+
|
267
|
+
> <Array(<InvoicesPaginated>, Integer, Hash)> find_all_invoices_with_http_info(opts)
|
268
|
+
|
269
|
+
```ruby
|
270
|
+
begin
|
271
|
+
# List all invoices
|
272
|
+
data, status_code, headers = api_instance.find_all_invoices_with_http_info(opts)
|
273
|
+
p status_code # => 2xx
|
274
|
+
p headers # => { ... }
|
275
|
+
p data # => <InvoicesPaginated>
|
276
|
+
rescue LagoAPI::ApiError => e
|
277
|
+
puts "Error when calling InvoicesApi->find_all_invoices_with_http_info: #{e}"
|
278
|
+
end
|
279
|
+
```
|
280
|
+
|
281
|
+
### Parameters
|
282
|
+
|
283
|
+
| Name | Type | Description | Notes |
|
284
|
+
| ---- | ---- | ----------- | ----- |
|
285
|
+
| **page** | **Integer** | Page number. | [optional] |
|
286
|
+
| **per_page** | **Integer** | Number of records per page. | [optional] |
|
287
|
+
| **external_customer_id** | **String** | Unique identifier assigned to the customer in your application. | [optional] |
|
288
|
+
| **issuing_date_from** | **Date** | Filter invoices starting from a specific date. | [optional] |
|
289
|
+
| **issuing_date_to** | **Date** | Filter invoices up to a specific date. | [optional] |
|
290
|
+
| **status** | **String** | Filter invoices by status. Possible values are `draft` or `finalized`. | [optional] |
|
291
|
+
| **payment_status** | **String** | Filter invoices by payment status. Possible values are `pending`, `failed` or `succeeded`. | [optional] |
|
292
|
+
|
293
|
+
### Return type
|
294
|
+
|
295
|
+
[**InvoicesPaginated**](InvoicesPaginated.md)
|
296
|
+
|
297
|
+
### Authorization
|
298
|
+
|
299
|
+
[bearerAuth](../README.md#bearerAuth)
|
300
|
+
|
301
|
+
### HTTP request headers
|
302
|
+
|
303
|
+
- **Content-Type**: Not defined
|
304
|
+
- **Accept**: application/json
|
305
|
+
|
306
|
+
|
307
|
+
## find_invoice
|
308
|
+
|
309
|
+
> <Invoice> find_invoice(lago_id)
|
310
|
+
|
311
|
+
Retrieve an invoice
|
312
|
+
|
313
|
+
This endpoint is used for retrieving a specific invoice that has been issued.
|
314
|
+
|
315
|
+
### Examples
|
316
|
+
|
317
|
+
```ruby
|
318
|
+
require 'time'
|
319
|
+
require 'lago_ruby'
|
320
|
+
# setup authorization
|
321
|
+
LagoAPI.configure do |config|
|
322
|
+
# Configure Bearer authorization: bearerAuth
|
323
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
324
|
+
end
|
325
|
+
|
326
|
+
api_instance = LagoAPI::InvoicesApi.new
|
327
|
+
lago_id = '1a901a90-1a90-1a90-1a90-1a901a901a90' # String | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice’s record within the Lago system.
|
328
|
+
|
329
|
+
begin
|
330
|
+
# Retrieve an invoice
|
331
|
+
result = api_instance.find_invoice(lago_id)
|
332
|
+
p result
|
333
|
+
rescue LagoAPI::ApiError => e
|
334
|
+
puts "Error when calling InvoicesApi->find_invoice: #{e}"
|
335
|
+
end
|
336
|
+
```
|
337
|
+
|
338
|
+
#### Using the find_invoice_with_http_info variant
|
339
|
+
|
340
|
+
This returns an Array which contains the response data, status code and headers.
|
341
|
+
|
342
|
+
> <Array(<Invoice>, Integer, Hash)> find_invoice_with_http_info(lago_id)
|
343
|
+
|
344
|
+
```ruby
|
345
|
+
begin
|
346
|
+
# Retrieve an invoice
|
347
|
+
data, status_code, headers = api_instance.find_invoice_with_http_info(lago_id)
|
348
|
+
p status_code # => 2xx
|
349
|
+
p headers # => { ... }
|
350
|
+
p data # => <Invoice>
|
351
|
+
rescue LagoAPI::ApiError => e
|
352
|
+
puts "Error when calling InvoicesApi->find_invoice_with_http_info: #{e}"
|
353
|
+
end
|
354
|
+
```
|
355
|
+
|
356
|
+
### Parameters
|
357
|
+
|
358
|
+
| Name | Type | Description | Notes |
|
359
|
+
| ---- | ---- | ----------- | ----- |
|
360
|
+
| **lago_id** | **String** | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice’s record within the Lago system. | |
|
361
|
+
|
362
|
+
### Return type
|
363
|
+
|
364
|
+
[**Invoice**](Invoice.md)
|
365
|
+
|
366
|
+
### Authorization
|
367
|
+
|
368
|
+
[bearerAuth](../README.md#bearerAuth)
|
369
|
+
|
370
|
+
### HTTP request headers
|
371
|
+
|
372
|
+
- **Content-Type**: Not defined
|
373
|
+
- **Accept**: application/json
|
374
|
+
|
375
|
+
|
376
|
+
## refresh_invoice
|
377
|
+
|
378
|
+
> <Invoice> refresh_invoice(lago_id)
|
379
|
+
|
380
|
+
Refresh a draft invoice
|
381
|
+
|
382
|
+
This endpoint is used for refreshing a draft invoice.
|
383
|
+
|
384
|
+
### Examples
|
385
|
+
|
386
|
+
```ruby
|
387
|
+
require 'time'
|
388
|
+
require 'lago_ruby'
|
389
|
+
# setup authorization
|
390
|
+
LagoAPI.configure do |config|
|
391
|
+
# Configure Bearer authorization: bearerAuth
|
392
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
393
|
+
end
|
394
|
+
|
395
|
+
api_instance = LagoAPI::InvoicesApi.new
|
396
|
+
lago_id = '1a901a90-1a90-1a90-1a90-1a901a901a90' # String | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice’s record within the Lago system.
|
397
|
+
|
398
|
+
begin
|
399
|
+
# Refresh a draft invoice
|
400
|
+
result = api_instance.refresh_invoice(lago_id)
|
401
|
+
p result
|
402
|
+
rescue LagoAPI::ApiError => e
|
403
|
+
puts "Error when calling InvoicesApi->refresh_invoice: #{e}"
|
404
|
+
end
|
405
|
+
```
|
406
|
+
|
407
|
+
#### Using the refresh_invoice_with_http_info variant
|
408
|
+
|
409
|
+
This returns an Array which contains the response data, status code and headers.
|
410
|
+
|
411
|
+
> <Array(<Invoice>, Integer, Hash)> refresh_invoice_with_http_info(lago_id)
|
412
|
+
|
413
|
+
```ruby
|
414
|
+
begin
|
415
|
+
# Refresh a draft invoice
|
416
|
+
data, status_code, headers = api_instance.refresh_invoice_with_http_info(lago_id)
|
417
|
+
p status_code # => 2xx
|
418
|
+
p headers # => { ... }
|
419
|
+
p data # => <Invoice>
|
420
|
+
rescue LagoAPI::ApiError => e
|
421
|
+
puts "Error when calling InvoicesApi->refresh_invoice_with_http_info: #{e}"
|
422
|
+
end
|
423
|
+
```
|
424
|
+
|
425
|
+
### Parameters
|
426
|
+
|
427
|
+
| Name | Type | Description | Notes |
|
428
|
+
| ---- | ---- | ----------- | ----- |
|
429
|
+
| **lago_id** | **String** | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice’s record within the Lago system. | |
|
430
|
+
|
431
|
+
### Return type
|
432
|
+
|
433
|
+
[**Invoice**](Invoice.md)
|
434
|
+
|
435
|
+
### Authorization
|
436
|
+
|
437
|
+
[bearerAuth](../README.md#bearerAuth)
|
438
|
+
|
439
|
+
### HTTP request headers
|
440
|
+
|
441
|
+
- **Content-Type**: Not defined
|
442
|
+
- **Accept**: application/json
|
443
|
+
|
444
|
+
|
445
|
+
## retry_payment
|
446
|
+
|
447
|
+
> retry_payment(lago_id)
|
448
|
+
|
449
|
+
Retry an invoice payment
|
450
|
+
|
451
|
+
This endpoint resends an invoice for collection and retry a payment.
|
452
|
+
|
453
|
+
### Examples
|
454
|
+
|
455
|
+
```ruby
|
456
|
+
require 'time'
|
457
|
+
require 'lago_ruby'
|
458
|
+
# setup authorization
|
459
|
+
LagoAPI.configure do |config|
|
460
|
+
# Configure Bearer authorization: bearerAuth
|
461
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
462
|
+
end
|
463
|
+
|
464
|
+
api_instance = LagoAPI::InvoicesApi.new
|
465
|
+
lago_id = '1a901a90-1a90-1a90-1a90-1a901a901a90' # String | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice’s record within the Lago system.
|
466
|
+
|
467
|
+
begin
|
468
|
+
# Retry an invoice payment
|
469
|
+
api_instance.retry_payment(lago_id)
|
470
|
+
rescue LagoAPI::ApiError => e
|
471
|
+
puts "Error when calling InvoicesApi->retry_payment: #{e}"
|
472
|
+
end
|
473
|
+
```
|
474
|
+
|
475
|
+
#### Using the retry_payment_with_http_info variant
|
476
|
+
|
477
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
478
|
+
|
479
|
+
> <Array(nil, Integer, Hash)> retry_payment_with_http_info(lago_id)
|
480
|
+
|
481
|
+
```ruby
|
482
|
+
begin
|
483
|
+
# Retry an invoice payment
|
484
|
+
data, status_code, headers = api_instance.retry_payment_with_http_info(lago_id)
|
485
|
+
p status_code # => 2xx
|
486
|
+
p headers # => { ... }
|
487
|
+
p data # => nil
|
488
|
+
rescue LagoAPI::ApiError => e
|
489
|
+
puts "Error when calling InvoicesApi->retry_payment_with_http_info: #{e}"
|
490
|
+
end
|
491
|
+
```
|
492
|
+
|
493
|
+
### Parameters
|
494
|
+
|
495
|
+
| Name | Type | Description | Notes |
|
496
|
+
| ---- | ---- | ----------- | ----- |
|
497
|
+
| **lago_id** | **String** | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice’s record within the Lago system. | |
|
498
|
+
|
499
|
+
### Return type
|
500
|
+
|
501
|
+
nil (empty response body)
|
502
|
+
|
503
|
+
### Authorization
|
504
|
+
|
505
|
+
[bearerAuth](../README.md#bearerAuth)
|
506
|
+
|
507
|
+
### HTTP request headers
|
508
|
+
|
509
|
+
- **Content-Type**: Not defined
|
510
|
+
- **Accept**: application/json
|
511
|
+
|
512
|
+
|
513
|
+
## update_invoice
|
514
|
+
|
515
|
+
> <Invoice> update_invoice(lago_id, invoice_update_input)
|
516
|
+
|
517
|
+
Update an invoice
|
518
|
+
|
519
|
+
This endpoint is used for updating an existing invoice.
|
520
|
+
|
521
|
+
### Examples
|
522
|
+
|
523
|
+
```ruby
|
524
|
+
require 'time'
|
525
|
+
require 'lago_ruby'
|
526
|
+
# setup authorization
|
527
|
+
LagoAPI.configure do |config|
|
528
|
+
# Configure Bearer authorization: bearerAuth
|
529
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
530
|
+
end
|
531
|
+
|
532
|
+
api_instance = LagoAPI::InvoicesApi.new
|
533
|
+
lago_id = '1a901a90-1a90-1a90-1a90-1a901a901a90' # String | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice’s record within the Lago system.
|
534
|
+
invoice_update_input = LagoAPI::InvoiceUpdateInput.new({invoice: LagoAPI::InvoiceUpdateInputInvoice.new}) # InvoiceUpdateInput | Update an existing invoice
|
535
|
+
|
536
|
+
begin
|
537
|
+
# Update an invoice
|
538
|
+
result = api_instance.update_invoice(lago_id, invoice_update_input)
|
539
|
+
p result
|
540
|
+
rescue LagoAPI::ApiError => e
|
541
|
+
puts "Error when calling InvoicesApi->update_invoice: #{e}"
|
542
|
+
end
|
543
|
+
```
|
544
|
+
|
545
|
+
#### Using the update_invoice_with_http_info variant
|
546
|
+
|
547
|
+
This returns an Array which contains the response data, status code and headers.
|
548
|
+
|
549
|
+
> <Array(<Invoice>, Integer, Hash)> update_invoice_with_http_info(lago_id, invoice_update_input)
|
550
|
+
|
551
|
+
```ruby
|
552
|
+
begin
|
553
|
+
# Update an invoice
|
554
|
+
data, status_code, headers = api_instance.update_invoice_with_http_info(lago_id, invoice_update_input)
|
555
|
+
p status_code # => 2xx
|
556
|
+
p headers # => { ... }
|
557
|
+
p data # => <Invoice>
|
558
|
+
rescue LagoAPI::ApiError => e
|
559
|
+
puts "Error when calling InvoicesApi->update_invoice_with_http_info: #{e}"
|
560
|
+
end
|
561
|
+
```
|
562
|
+
|
563
|
+
### Parameters
|
564
|
+
|
565
|
+
| Name | Type | Description | Notes |
|
566
|
+
| ---- | ---- | ----------- | ----- |
|
567
|
+
| **lago_id** | **String** | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the invoice’s record within the Lago system. | |
|
568
|
+
| **invoice_update_input** | [**InvoiceUpdateInput**](InvoiceUpdateInput.md) | Update an existing invoice | |
|
569
|
+
|
570
|
+
### Return type
|
571
|
+
|
572
|
+
[**Invoice**](Invoice.md)
|
573
|
+
|
574
|
+
### Authorization
|
575
|
+
|
576
|
+
[bearerAuth](../README.md#bearerAuth)
|
577
|
+
|
578
|
+
### HTTP request headers
|
579
|
+
|
580
|
+
- **Content-Type**: application/json
|
581
|
+
- **Accept**: application/json
|
582
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# LagoAPI::InvoicesPaginated
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **invoices** | [**Array<InvoiceObject>**](InvoiceObject.md) | | |
|
8
|
+
| **meta** | [**PaginationMeta**](PaginationMeta.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'lago_ruby'
|
14
|
+
|
15
|
+
instance = LagoAPI::InvoicesPaginated.new(
|
16
|
+
invoices: null,
|
17
|
+
meta: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# LagoAPI::Organization
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **organization** | [**OrganizationObject**](OrganizationObject.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'lago_ruby'
|
13
|
+
|
14
|
+
instance = LagoAPI::Organization.new(
|
15
|
+
organization: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# LagoAPI::OrganizationBillingConfiguration
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **invoice_footer** | **String** | The customer invoice message that appears at the bottom of each billing documents. | [optional] |
|
8
|
+
| **invoice_grace_period** | **Integer** | The grace period, expressed in days, for finalizing the invoice. This period refers to the additional time granted to your customers beyond the invoice due date to adjust usage and line items. Can be overwritten by the customer’s grace period. | [optional] |
|
9
|
+
| **document_locale** | **String** | The locale of the billing documents, expressed in the ISO 639-1 format. This field indicates the language or regional variant used for the documents content issued or the embeddable customer portal. | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'lago_ruby'
|
15
|
+
|
16
|
+
instance = LagoAPI::OrganizationBillingConfiguration.new(
|
17
|
+
invoice_footer: This is my customer footer,
|
18
|
+
invoice_grace_period: 3,
|
19
|
+
document_locale: en
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,54 @@
|
|
1
|
+
# LagoAPI::OrganizationObject
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **lago_id** | **String** | Unique identifier assigned to the organization 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 | |
|
8
|
+
| **name** | **String** | The name of your organization. | |
|
9
|
+
| **created_at** | **Time** | The date of creation of your organization, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). | |
|
10
|
+
| **webhook_url** | **String** | The URL of your newest updated webhook endpoint. This URL allows your organization to receive important messages, notifications, or data from the Lago system. By configuring your webhook endpoint to this URL, you can ensure that your organization stays informed and receives relevant information in a timely manner. | [optional] |
|
11
|
+
| **webhook_urls** | **Array<String>** | The array containing your webhooks URLs. | [optional] |
|
12
|
+
| **country** | [**Country**](Country.md) | | [optional] |
|
13
|
+
| **address_line1** | **String** | The first line of your organization’s billing address. | [optional] |
|
14
|
+
| **address_line2** | **String** | The second line of your organization’s billing address. | [optional] |
|
15
|
+
| **state** | **String** | The state of your organization’s billing address. | [optional] |
|
16
|
+
| **zipcode** | **String** | The zipcode of your organization’s billing address. | [optional] |
|
17
|
+
| **email** | **String** | The email address of your organization used to bill your customers. | [optional] |
|
18
|
+
| **city** | **String** | The city of your organization’s billing address. | [optional] |
|
19
|
+
| **legal_name** | **String** | The legal name of your organization. | [optional] |
|
20
|
+
| **legal_number** | **String** | The legal number of your organization. | [optional] |
|
21
|
+
| **net_payment_term** | **Integer** | The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized. | [optional] |
|
22
|
+
| **tax_identification_number** | **String** | The tax identification number of your organization. | [optional] |
|
23
|
+
| **timezone** | [**Timezone**](Timezone.md) | | [optional] |
|
24
|
+
| **billing_configuration** | [**OrganizationBillingConfiguration**](OrganizationBillingConfiguration.md) | | |
|
25
|
+
| **taxes** | [**Array<TaxObject>**](TaxObject.md) | List of default organization taxes | [optional] |
|
26
|
+
|
27
|
+
## Example
|
28
|
+
|
29
|
+
```ruby
|
30
|
+
require 'lago_ruby'
|
31
|
+
|
32
|
+
instance = LagoAPI::OrganizationObject.new(
|
33
|
+
lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
|
34
|
+
name: Name1,
|
35
|
+
created_at: 2022-05-02T13:04:09Z,
|
36
|
+
webhook_url: https://webhook.brex.com,
|
37
|
+
webhook_urls: ["https://webhook.brex.com","https://webhook2.brex.com"],
|
38
|
+
country: null,
|
39
|
+
address_line1: 100 Brex Street,
|
40
|
+
address_line2: null,
|
41
|
+
state: NYC,
|
42
|
+
zipcode: 10000,
|
43
|
+
email: brex@brex.com,
|
44
|
+
city: New York,
|
45
|
+
legal_name: null,
|
46
|
+
legal_number: null,
|
47
|
+
net_payment_term: 30,
|
48
|
+
tax_identification_number: US123456789,
|
49
|
+
timezone: null,
|
50
|
+
billing_configuration: null,
|
51
|
+
taxes: null
|
52
|
+
)
|
53
|
+
```
|
54
|
+
|