https://github.com/getlago/lago-rust-client
Rust Client for Lago
https://github.com/getlago/lago-rust-client
Last synced: 5 months ago
JSON representation
Rust Client for Lago
- Host: GitHub
- URL: https://github.com/getlago/lago-rust-client
- Owner: getlago
- License: mit
- Created: 2023-01-17T14:20:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T09:04:46.000Z (8 months ago)
- Last Synced: 2024-11-17T02:12:21.395Z (7 months ago)
- Language: Rust
- Size: 125 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rust API client for openapi
Lago API allows your application to push customer information and metrics (events) from your application to the billing application.
## Current Releases
| Project | Release Badge |
|--------------------|-----------------------------------------------------------------------------------------------------|
| **Lago** | [](https://github.com/getlago/lago/releases) |
| **Rust API client for openapi** | [](https://github.com/getlago/lago-rust-client/releases) |
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
- API version: 0.32.0-beta
- Package version: 0.32.0-beta
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`
## Installation
Put the package under your project folder in a directory named `openapi` and add the following to `Cargo.toml` under `[dependencies]`:
```
openapi = { path = "./openapi" }
```
## Documentation for API Endpoints
All URIs are relative to *https://api.getlago.com/api/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AddOnsApi* | [**apply_add_on**](docs/AddOnsApi.md#apply_add_on) | **POST** /applied_add_ons | Apply an add-on to a customer
*AddOnsApi* | [**create_add_on**](docs/AddOnsApi.md#create_add_on) | **POST** /add_ons | Create a new add-on
*AddOnsApi* | [**destroy_add_on**](docs/AddOnsApi.md#destroy_add_on) | **DELETE** /add_ons/{code} | Delete an add-on
*AddOnsApi* | [**find_add_on**](docs/AddOnsApi.md#find_add_on) | **GET** /add_ons/{code} | Find add-on by code
*AddOnsApi* | [**find_all_add_ons**](docs/AddOnsApi.md#find_all_add_ons) | **GET** /add_ons | Find add-ons
*AddOnsApi* | [**update_add_on**](docs/AddOnsApi.md#update_add_on) | **PUT** /add_ons/{code} | Update an existing add-on
*BillableMetricsApi* | [**create_billable_metric**](docs/BillableMetricsApi.md#create_billable_metric) | **POST** /billable_metrics | Create a new billable metric
*BillableMetricsApi* | [**destroy_billable_metric**](docs/BillableMetricsApi.md#destroy_billable_metric) | **DELETE** /billable_metrics/{code} | Delete a billable metric
*BillableMetricsApi* | [**find_all_billable_metric_groups**](docs/BillableMetricsApi.md#find_all_billable_metric_groups) | **GET** /billable_metrics/{code}/groups | Find Billable metric groups
*BillableMetricsApi* | [**find_all_billable_metrics**](docs/BillableMetricsApi.md#find_all_billable_metrics) | **GET** /billable_metrics | Find Billable metrics
*BillableMetricsApi* | [**find_billable_metric**](docs/BillableMetricsApi.md#find_billable_metric) | **GET** /billable_metrics/{code} | Find billable metric by code
*BillableMetricsApi* | [**update_billable_metric**](docs/BillableMetricsApi.md#update_billable_metric) | **PUT** /billable_metrics/{code} | Update an existing billable metric
*CouponsApi* | [**apply_coupon**](docs/CouponsApi.md#apply_coupon) | **POST** /applied_coupons | Apply a coupon to a customer
*CouponsApi* | [**create_coupon**](docs/CouponsApi.md#create_coupon) | **POST** /coupons | Create a new coupon
*CouponsApi* | [**destroy_coupon**](docs/CouponsApi.md#destroy_coupon) | **DELETE** /coupons/{code} | Delete a coupon
*CouponsApi* | [**find_all_applied_coupons**](docs/CouponsApi.md#find_all_applied_coupons) | **GET** /applied_coupons | Find Applied Coupons
*CouponsApi* | [**find_all_coupons**](docs/CouponsApi.md#find_all_coupons) | **GET** /coupons | Find Coupons
*CouponsApi* | [**find_coupon**](docs/CouponsApi.md#find_coupon) | **GET** /coupons/{code} | Find coupon by code
*CouponsApi* | [**update_coupon**](docs/CouponsApi.md#update_coupon) | **PUT** /coupons/{code} | Update an existing coupon
*CreditNotesApi* | [**create_credit_note**](docs/CreditNotesApi.md#create_credit_note) | **POST** /credit_notes | Create a new Credit note
*CreditNotesApi* | [**download_credit_note**](docs/CreditNotesApi.md#download_credit_note) | **POST** /credit_notes/{id}/download | Download an existing credit note
*CreditNotesApi* | [**find_all_credit_notes**](docs/CreditNotesApi.md#find_all_credit_notes) | **GET** /credit_notes | Find Credit notes
*CreditNotesApi* | [**find_credit_note**](docs/CreditNotesApi.md#find_credit_note) | **GET** /credit_notes/{id} | Find credit note
*CreditNotesApi* | [**update_credit_note**](docs/CreditNotesApi.md#update_credit_note) | **PUT** /credit_notes/{id} | Update an existing credit note
*CreditNotesApi* | [**void_credit_note**](docs/CreditNotesApi.md#void_credit_note) | **PUT** /credit_notes/{id}/void | Void existing credit note
*CustomersApi* | [**create_customer**](docs/CustomersApi.md#create_customer) | **POST** /customers | Create a customer
*CustomersApi* | [**delete_applied_coupon**](docs/CustomersApi.md#delete_applied_coupon) | **DELETE** /customers/{customer_external_id}/applied_coupons/{applied_coupon_id} | Delete customer's appplied coupon
*CustomersApi* | [**destroy_customer**](docs/CustomersApi.md#destroy_customer) | **DELETE** /customers/{external_id} | Delete a customer
*CustomersApi* | [**find_all_customers**](docs/CustomersApi.md#find_all_customers) | **GET** /customers | Find customers
*CustomersApi* | [**find_customer**](docs/CustomersApi.md#find_customer) | **GET** /customers/{external_id} | Find customer by external ID
*CustomersApi* | [**find_customer_current_usage**](docs/CustomersApi.md#find_customer_current_usage) | **GET** /customers/{customer_external_id}/current_usage | Find customer current usage
*CustomersApi* | [**get_customer_portal_url**](docs/CustomersApi.md#get_customer_portal_url) | **GET** /customers/{customer_external_id}/portal_url | Get customer portal URL
*EventsApi* | [**create_batch_events**](docs/EventsApi.md#create_batch_events) | **POST** /events/batch | Create batch events
*EventsApi* | [**create_event**](docs/EventsApi.md#create_event) | **POST** /events | Create a new event
*EventsApi* | [**event_estimate_fees**](docs/EventsApi.md#event_estimate_fees) | **POST** /events/estimate_fees | Estimate fees for an instant charge
*EventsApi* | [**find_event**](docs/EventsApi.md#find_event) | **GET** /events/{id} | Find event by transaction ID
*FeesApi* | [**find_all_fees**](docs/FeesApi.md#find_all_fees) | **GET** /fees | Find all fees
*FeesApi* | [**find_fee**](docs/FeesApi.md#find_fee) | **GET** /fees/{id} | Find fee by ID
*FeesApi* | [**update_fee**](docs/FeesApi.md#update_fee) | **PUT** /fees/{id} | Update an existing fee
*InvoicesApi* | [**create_invoice**](docs/InvoicesApi.md#create_invoice) | **POST** /invoices | Create a new invoice
*InvoicesApi* | [**download_invoice**](docs/InvoicesApi.md#download_invoice) | **POST** /invoices/{id}/download | Download an existing invoice
*InvoicesApi* | [**finalize_invoice**](docs/InvoicesApi.md#finalize_invoice) | **PUT** /invoices/{id}/finalize | Finalize a draft invoice
*InvoicesApi* | [**find_all_invoices**](docs/InvoicesApi.md#find_all_invoices) | **GET** /invoices | Find all invoices
*InvoicesApi* | [**find_invoice**](docs/InvoicesApi.md#find_invoice) | **GET** /invoices/{id} | Find invoice by ID
*InvoicesApi* | [**refresh_invoice**](docs/InvoicesApi.md#refresh_invoice) | **PUT** /invoices/{id}/refresh | Refresh a draft invoice
*InvoicesApi* | [**retry_payment**](docs/InvoicesApi.md#retry_payment) | **POST** /invoices/{id}/retry_payment | Retry invoice payment
*InvoicesApi* | [**update_invoice**](docs/InvoicesApi.md#update_invoice) | **PUT** /invoices/{id} | Update an existing invoice status
*OrganizationsApi* | [**update_organization**](docs/OrganizationsApi.md#update_organization) | **PUT** /organizations | Update an existing Organization
*PlansApi* | [**create_plan**](docs/PlansApi.md#create_plan) | **POST** /plans | Create a new plan
*PlansApi* | [**destroy_plan**](docs/PlansApi.md#destroy_plan) | **DELETE** /plans/{code} | Delete a plan
*PlansApi* | [**find_all_plans**](docs/PlansApi.md#find_all_plans) | **GET** /plans | Find plans
*PlansApi* | [**find_plan**](docs/PlansApi.md#find_plan) | **GET** /plans/{code} | Find plan by code
*PlansApi* | [**update_plan**](docs/PlansApi.md#update_plan) | **PUT** /plans/{code} | Update an existing plan
*SubscriptionsApi* | [**create_subscription**](docs/SubscriptionsApi.md#create_subscription) | **POST** /subscriptions | Assign a plan to a customer
*SubscriptionsApi* | [**destroy_subscription**](docs/SubscriptionsApi.md#destroy_subscription) | **DELETE** /subscriptions/{external_id} | Terminate a subscription
*SubscriptionsApi* | [**find_all_subscriptions**](docs/SubscriptionsApi.md#find_all_subscriptions) | **GET** /subscriptions | Find subscriptions
*SubscriptionsApi* | [**update_subscription**](docs/SubscriptionsApi.md#update_subscription) | **PUT** /subscriptions/{external_id} | Update an existing subscription
*WalletsApi* | [**create_wallet**](docs/WalletsApi.md#create_wallet) | **POST** /wallets | Create a new wallet
*WalletsApi* | [**create_wallet_transaction**](docs/WalletsApi.md#create_wallet_transaction) | **POST** /wallet_transactions | Create a new wallet transaction
*WalletsApi* | [**destroy_wallet**](docs/WalletsApi.md#destroy_wallet) | **DELETE** /wallets/{id} | Delete a wallet
*WalletsApi* | [**find_all_wallet_transactions**](docs/WalletsApi.md#find_all_wallet_transactions) | **GET** /wallets/{id}/wallet_transactions | Find wallet transactions
*WalletsApi* | [**find_all_wallets**](docs/WalletsApi.md#find_all_wallets) | **GET** /wallets | Find wallets
*WalletsApi* | [**find_wallet**](docs/WalletsApi.md#find_wallet) | **GET** /wallets/{id} | Find wallet
*WalletsApi* | [**update_wallet**](docs/WalletsApi.md#update_wallet) | **PUT** /wallets/{id} | Update an existing wallet
*WebhooksApi* | [**fetch_public_key**](docs/WebhooksApi.md#fetch_public_key) | **GET** /webhooks/public_key | Fetch webhook public key
## Documentation For Models
- [AddOn](docs/AddOn.md)
- [AddOnInput](docs/AddOnInput.md)
- [AddOnInputAddOn](docs/AddOnInputAddOn.md)
- [AddOnObject](docs/AddOnObject.md)
- [AddOnsPaginated](docs/AddOnsPaginated.md)
- [ApiResponseBadRequest](docs/ApiResponseBadRequest.md)
- [ApiResponseForbidden](docs/ApiResponseForbidden.md)
- [ApiResponseNotAllowed](docs/ApiResponseNotAllowed.md)
- [ApiResponseNotFound](docs/ApiResponseNotFound.md)
- [ApiResponseUnauthorized](docs/ApiResponseUnauthorized.md)
- [ApiResponseUnprocessableEntity](docs/ApiResponseUnprocessableEntity.md)
- [AppliedAddOn](docs/AppliedAddOn.md)
- [AppliedAddOnInput](docs/AppliedAddOnInput.md)
- [AppliedAddOnInputAppliedAddOn](docs/AppliedAddOnInputAppliedAddOn.md)
- [AppliedAddOnObject](docs/AppliedAddOnObject.md)
- [AppliedCoupon](docs/AppliedCoupon.md)
- [AppliedCouponInput](docs/AppliedCouponInput.md)
- [AppliedCouponInputAppliedCoupon](docs/AppliedCouponInputAppliedCoupon.md)
- [AppliedCouponObject](docs/AppliedCouponObject.md)
- [AppliedCouponObjectExtended](docs/AppliedCouponObjectExtended.md)
- [AppliedCouponObjectExtendedAllOf](docs/AppliedCouponObjectExtendedAllOf.md)
- [AppliedCouponsPaginated](docs/AppliedCouponsPaginated.md)
- [BatchEventInput](docs/BatchEventInput.md)
- [BatchEventInputEvent](docs/BatchEventInputEvent.md)
- [BillableMetric](docs/BillableMetric.md)
- [BillableMetricGroup](docs/BillableMetricGroup.md)
- [BillableMetricGroupValuesInner](docs/BillableMetricGroupValuesInner.md)
- [BillableMetricInput](docs/BillableMetricInput.md)
- [BillableMetricInputBillableMetric](docs/BillableMetricInputBillableMetric.md)
- [BillableMetricObject](docs/BillableMetricObject.md)
- [BillableMetricsPaginated](docs/BillableMetricsPaginated.md)
- [BillingConfigurationCustomer](docs/BillingConfigurationCustomer.md)
- [BillingConfigurationOrganization](docs/BillingConfigurationOrganization.md)
- [ChargeObject](docs/ChargeObject.md)
- [ChargeUsageObject](docs/ChargeUsageObject.md)
- [ChargeUsageObjectBillableMetric](docs/ChargeUsageObjectBillableMetric.md)
- [ChargeUsageObjectCharge](docs/ChargeUsageObjectCharge.md)
- [ChargeUsageObjectGroupsInner](docs/ChargeUsageObjectGroupsInner.md)
- [Coupon](docs/Coupon.md)
- [CouponInput](docs/CouponInput.md)
- [CouponInputCoupon](docs/CouponInputCoupon.md)
- [CouponInputCouponAppliesTo](docs/CouponInputCouponAppliesTo.md)
- [CouponObject](docs/CouponObject.md)
- [CouponsPaginated](docs/CouponsPaginated.md)
- [CreditNote](docs/CreditNote.md)
- [CreditNoteInput](docs/CreditNoteInput.md)
- [CreditNoteInputCreditNote](docs/CreditNoteInputCreditNote.md)
- [CreditNoteInputCreditNoteItemsInner](docs/CreditNoteInputCreditNoteItemsInner.md)
- [CreditNoteItemObject](docs/CreditNoteItemObject.md)
- [CreditNoteObject](docs/CreditNoteObject.md)
- [CreditNoteUpdateInput](docs/CreditNoteUpdateInput.md)
- [CreditNoteUpdateInputCreditNote](docs/CreditNoteUpdateInputCreditNote.md)
- [CreditNotes](docs/CreditNotes.md)
- [CreditObject](docs/CreditObject.md)
- [CreditObjectInvoice](docs/CreditObjectInvoice.md)
- [CreditObjectItem](docs/CreditObjectItem.md)
- [Customer](docs/Customer.md)
- [CustomerInput](docs/CustomerInput.md)
- [CustomerInputCustomer](docs/CustomerInputCustomer.md)
- [CustomerInputCustomerMetadataInner](docs/CustomerInputCustomerMetadataInner.md)
- [CustomerMetadataObject](docs/CustomerMetadataObject.md)
- [CustomerObject](docs/CustomerObject.md)
- [CustomerUsage](docs/CustomerUsage.md)
- [CustomerUsageObject](docs/CustomerUsageObject.md)
- [CustomersPaginated](docs/CustomersPaginated.md)
- [Event](docs/Event.md)
- [EventEstimateFeesInput](docs/EventEstimateFeesInput.md)
- [EventEstimateFeesInputEvent](docs/EventEstimateFeesInputEvent.md)
- [EventInput](docs/EventInput.md)
- [EventInputEvent](docs/EventInputEvent.md)
- [EventObject](docs/EventObject.md)
- [FeeObject](docs/FeeObject.md)
- [FeeObjectItem](docs/FeeObjectItem.md)
- [FeeUpdateInput](docs/FeeUpdateInput.md)
- [FeeUpdateInputInvoice](docs/FeeUpdateInputInvoice.md)
- [Fees](docs/Fees.md)
- [FeesPaginated](docs/FeesPaginated.md)
- [FeesPaginatedAllOf](docs/FeesPaginatedAllOf.md)
- [GetCustomerPortalUrl200Response](docs/GetCustomerPortalUrl200Response.md)
- [GetCustomerPortalUrl200ResponseCustomer](docs/GetCustomerPortalUrl200ResponseCustomer.md)
- [GroupObject](docs/GroupObject.md)
- [GroupPropertiesObject](docs/GroupPropertiesObject.md)
- [GroupsPaginated](docs/GroupsPaginated.md)
- [Invoice](docs/Invoice.md)
- [InvoiceInput](docs/InvoiceInput.md)
- [InvoiceInputInvoice](docs/InvoiceInputInvoice.md)
- [InvoiceInputInvoiceMetadataInner](docs/InvoiceInputInvoiceMetadataInner.md)
- [InvoiceMetadataObject](docs/InvoiceMetadataObject.md)
- [InvoiceObject](docs/InvoiceObject.md)
- [InvoiceObjectExtended](docs/InvoiceObjectExtended.md)
- [InvoiceObjectExtendedAllOf](docs/InvoiceObjectExtendedAllOf.md)
- [InvoiceOneOffInput](docs/InvoiceOneOffInput.md)
- [InvoiceOneOffInputInvoice](docs/InvoiceOneOffInputInvoice.md)
- [InvoiceOneOffInputInvoiceFeesInner](docs/InvoiceOneOffInputInvoiceFeesInner.md)
- [InvoicesPaginated](docs/InvoicesPaginated.md)
- [Organization](docs/Organization.md)
- [OrganizationInput](docs/OrganizationInput.md)
- [OrganizationInputOrganization](docs/OrganizationInputOrganization.md)
- [OrganizationObject](docs/OrganizationObject.md)
- [PaginationMeta](docs/PaginationMeta.md)
- [Plan](docs/Plan.md)
- [PlanInput](docs/PlanInput.md)
- [PlanInputPlan](docs/PlanInputPlan.md)
- [PlanInputPlanChargesInner](docs/PlanInputPlanChargesInner.md)
- [PlanInputPlanChargesInnerGroupPropertiesInner](docs/PlanInputPlanChargesInnerGroupPropertiesInner.md)
- [PlanObject](docs/PlanObject.md)
- [PlansPaginated](docs/PlansPaginated.md)
- [Subscription](docs/Subscription.md)
- [SubscriptionCreateInput](docs/SubscriptionCreateInput.md)
- [SubscriptionCreateInputSubscription](docs/SubscriptionCreateInputSubscription.md)
- [SubscriptionObject](docs/SubscriptionObject.md)
- [SubscriptionUpdateInput](docs/SubscriptionUpdateInput.md)
- [SubscriptionUpdateInputSubscription](docs/SubscriptionUpdateInputSubscription.md)
- [SubscriptionsPaginated](docs/SubscriptionsPaginated.md)
- [Wallet](docs/Wallet.md)
- [WalletInput](docs/WalletInput.md)
- [WalletInputWallet](docs/WalletInputWallet.md)
- [WalletObject](docs/WalletObject.md)
- [WalletTransactionInput](docs/WalletTransactionInput.md)
- [WalletTransactionInputWalletTransaction](docs/WalletTransactionInputWalletTransaction.md)
- [WalletTransactionObject](docs/WalletTransactionObject.md)
- [WalletTransactions](docs/WalletTransactions.md)
- [WalletTransactionsPaginated](docs/WalletTransactionsPaginated.md)
- [WalletUpdateInput](docs/WalletUpdateInput.md)
- [WalletUpdateInputWallet](docs/WalletUpdateInputWallet.md)
- [WalletsPaginated](docs/WalletsPaginated.md)
To get access to the crate's generated documentation, use:
```
cargo doc --open
```
## Author