vayu-py 0.1.1__tar.gz

vayu_py-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 weft-finance
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

vayu_py-0.1.1/PKG-INFO

@@ -0,0 +1,17 @@
+Metadata-Version: 2.1
+Name: vayu-py
+Version: 0.1.1
+Summary: The Vayu API client library in Python
+Home-page: https://github.com/weft-finance/vayu-py
+Author: Vayu Team
+Author-email: team@withvayu.com
+License-File: LICENSE
+Requires-Dist: setuptools>=42
+Requires-Dist: wheel
+Requires-Dist: twine
+Requires-Dist: bump2version
+Requires-Dist: requests
+Requires-Dist: urllib3>=1.25.3
+Requires-Dist: python-dateutil
+Requires-Dist: pydantic
+Requires-Dist: pyjwt

vayu_py-0.1.1/README.md

@@ -0,0 +1,253 @@
+# Vayu API Client Library [![PyPI Latest Version](https://img.shields.io/pypi/v/vayu-py.svg)](https://pypi.org/project/vayu-py/)
+
+## Overview
+
+The Vayu API client library in Python allows you to submit events for processing and storage, manage billing-related entities, and perform various other operations seamlessly.
+
+## Installation
+
+Install the Vayu API client library using pip:
+
+```bash
+pip install vayu-py
+```
+
+## Usage
+
+### Initialization
+
+Initialize the Vayu API client. The `base_url` parameter is optional and defaults to Vayu's public API servers.
+
+```python
+from vayu_sdk import Vayu
+
+vayu = Vayu(
+    api_key='your-api-token',
+    host='https://connect.withvayu.com'  # Optional
+)
+```
+
+### Authentication
+
+#### Login and authenticate
+
+```python
+response = vayu.login()
+```
+
+### Events
+
+#### Sending Events
+
+To send a batch of events for processing and storage:
+
+```python
+events = [
+    Event(
+      name='api_call',
+      ref='4f6cf35x-2c4y-483z-a0a9-158621f77a21',
+      timestamp=datetime.strptime('2023-09-13T18:25:43.511Z', '%Y-%m-%dT%H:%M:%S.%fZ'),
+      customerAlias='customer_12345',
+      data={
+            'key1': 'processing_duration',
+            'key2': 'api_url'
+        }
+    )
+]
+
+response = vayu.events.send(events=events)
+
+print(response['valid_events'])
+print(response['invalid_events'])
+```
+
+#### Querying Events
+
+To fetch events occurring within a specified timestamp range:
+
+```python
+response = vayu.events.query(
+  start_time=datetime.strptime('2023-09-01T00:00:00.000Z', '%Y-%m-%dT%H:%M:%S.%fZ'),
+  end_time=datetime.strptime('2023-09-30T23:59:59.999Z', '%Y-%m-%dT%H:%M:%S.%fZ'),
+  event_name='api_call',
+  limit=10
+)
+
+print(response['events'])
+```
+
+#### Getting Event by Ref ID
+
+To get a specific event using its reference ID:
+
+```python
+response = vayu.events.get(ref='4f6cf35x-2c4y-483z-a0a9-158621f77a21')
+
+print(response['event'])
+```
+
+#### Deleting Event by Ref ID
+
+To delete a specific event using its reference ID:
+
+```python
+response = vayu.events.delete(ref='4f6cf35x-2c4y-483z-a0a9-158621f77a21')
+
+print(response['event'])
+```
+
+### Customers
+
+#### Creating a Customer
+
+To create a new customer:
+
+```python
+response = vayu.customers.create(
+  name='John Doe',
+  external_id='customer_12345'
+)
+
+print(response['customer'])
+```
+
+#### Updating a Customer
+
+To update an existing customer by ID:
+
+```python
+response = vayu.customers.update(
+  id='customer-id',
+  external_id='customer_67890'
+)
+
+print(response['customer'])
+```
+
+#### Deleting a Customer
+
+To delete a customer by ID:
+
+```python
+response = vayu.customers.delete(id='customer-id')
+
+print(response['customer'])
+```
+
+### Contracts
+
+#### Assigning a contract to a customer
+
+In order to assign a contract to a customer you would need to provide the customer Id and the relevant plan
+
+```python
+response = vayu.contracts.create(
+  start_date=time.time(), 
+  end_date=None, 
+  customer_id='1f4cf23x-2c4y-483z-1111-158621f77a21', 
+  plan_id='4f6cf35x-1234-483z-a0a9-158621f77a21'
+)
+
+print(response['contract'])
+```
+
+### Meters
+
+Meters are entities that track and aggregate usage data based on events. They are crucial for billing and monitoring purposes. Each meter is associated with a specific event name and has an aggregation method to sum up usage values.
+
+#### Getting a Meter by ID
+
+To get a meter by ID:
+
+```python
+response = vayu.meters.get(id='meter-id')
+
+print(response['meter'])
+```
+
+#### Updating a Meter
+
+To update a meter by ID:
+
+```python
+response = vayu.meters.update(
+  id='meter-id',
+  name='Updated Meter Name',
+  event_name='api_call',
+  aggregation_method= AggregationMethod(
+    field='usage',
+    operator=AggregationOperator.SUM
+  ),
+  filter=Filter(
+    conditions=[
+      Condition(criterions=[
+        Criterion(
+          field='event',
+          operator=CriterionOperator.EQUALS,
+          value='api_call'
+        )
+      ])
+    ]
+  )
+)
+
+print(response['meter'])
+```
+
+#### Deleting a Meter
+
+To delete a meter by ID:
+
+```python
+response = vayu.meters.delete(id='meter-id')
+
+print(response['meter'])
+```
+
+## Features
+
+The Vayu API client library provides access to the following features:
+
+- **Auth**
+  - `login()`
+- **Events**
+  - `events.get()`
+  - `events.delete()`
+  - `events.query()`
+  - `events.send()`
+  - `events.dry_run()`
+- **Customers**
+  - `customers.list()`
+  - `customers.get()`
+  - `customers.create()`
+  - `customers.update()`
+  - `customers.delete()`
+- **Meters**
+  - `meters.get()`
+  - `meters.update()`
+  - `meters.delete()`
+  - `meters.list()`
+- **Plans**
+  - `plans.list()`
+  - `plans.get()`
+  - `plans.delete()`
+- **Contracts**
+  - `contracts.list()`
+  - `contracts.get()`
+  - `contracts.create()`
+  - `contracts.delete()`
+- **Invoices**
+  - `invoices.list()`
+  - `invoices.get()`
+
+## Support
+
+If you have any questions or need further assistance, please contact Vayu at `team@withvayu.com`.
+
+## License
+
+This project is licensed under the MIT License.
+
+---
+
+This README provides an overview and usage examples for the Vayu API client library. For more detailed information on each method, please refer to the official Vayu API documentation.

vayu_py-0.1.1/openapi/__init__.py

@@ -0,0 +1,126 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Vayu API
+
+    The Vayu API is a RESTful API that allows you to submit events for processing and storage & manage billing related entities.           The API is secured using the Bearer Authentication scheme with JWT tokens.           To obtain a JWT token, please contact Vayu at team@withvayu.com
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: dev@withvayu.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# import apis into sdk package
+from openapi.api.auth_api import AuthApi
+from openapi.api.contracts_api import ContractsApi
+from openapi.api.credits_api import CreditsApi
+from openapi.api.customers_api import CustomersApi
+from openapi.api.events_api import EventsApi
+from openapi.api.integrations_api import IntegrationsApi
+from openapi.api.invoices_api import InvoicesApi
+from openapi.api.meters_api import MetersApi
+from openapi.api.plans_api import PlansApi
+from openapi.api.reports_api import ReportsApi
+from openapi.api.webhooks_api import WebhooksApi
+
+# import ApiClient
+from openapi.api_response import ApiResponse
+from openapi.api_client import ApiClient
+from openapi.configuration import Configuration
+from openapi.exceptions import OpenApiException
+from openapi.exceptions import ApiTypeError
+from openapi.exceptions import ApiValueError
+from openapi.exceptions import ApiKeyError
+from openapi.exceptions import ApiAttributeError
+from openapi.exceptions import ApiException
+
+# import models into sdk package
+from openapi.models.address import Address
+from openapi.models.aggregation_method import AggregationMethod
+from openapi.models.aggregation_operator import AggregationOperator
+from openapi.models.billing_cycle_status import BillingCycleStatus
+from openapi.models.billing_interval import BillingInterval
+from openapi.models.condition import Condition
+from openapi.models.contact import Contact
+from openapi.models.contract_status import ContractStatus
+from openapi.models.create_contract_request import CreateContractRequest
+from openapi.models.create_contract_response import CreateContractResponse
+from openapi.models.create_customer_request import CreateCustomerRequest
+from openapi.models.create_customer_response import CreateCustomerResponse
+from openapi.models.create_customer_response_customer import CreateCustomerResponseCustomer
+from openapi.models.credit_ledger_entry import CreditLedgerEntry
+from openapi.models.criterion import Criterion
+from openapi.models.criterion_operator import CriterionOperator
+from openapi.models.currency import Currency
+from openapi.models.deduct_credits_request import DeductCreditsRequest
+from openapi.models.delete_contract_response import DeleteContractResponse
+from openapi.models.delete_contract_response_contract import DeleteContractResponseContract
+from openapi.models.delete_customer_response import DeleteCustomerResponse
+from openapi.models.delete_customer_response_customer import DeleteCustomerResponseCustomer
+from openapi.models.delete_event_response import DeleteEventResponse
+from openapi.models.delete_event_response_event import DeleteEventResponseEvent
+from openapi.models.delete_meter_response import DeleteMeterResponse
+from openapi.models.delete_meter_response_meter import DeleteMeterResponseMeter
+from openapi.models.delete_plan_response import DeletePlanResponse
+from openapi.models.delete_plan_response_plan import DeletePlanResponsePlan
+from openapi.models.event import Event
+from openapi.models.events_dry_run_request import EventsDryRunRequest
+from openapi.models.events_dry_run_response import EventsDryRunResponse
+from openapi.models.events_dry_run_response_object import EventsDryRunResponseObject
+from openapi.models.events_dry_run_response_object_event import EventsDryRunResponseObjectEvent
+from openapi.models.events_dry_run_response_object_meter_with_values_inner import EventsDryRunResponseObjectMeterWithValuesInner
+from openapi.models.filter import Filter
+from openapi.models.full_day_period import FullDayPeriod
+from openapi.models.get_commitment_report_response import GetCommitmentReportResponse
+from openapi.models.get_contract_response import GetContractResponse
+from openapi.models.get_contract_response_contract import GetContractResponseContract
+from openapi.models.get_customer_response import GetCustomerResponse
+from openapi.models.get_event_response import GetEventResponse
+from openapi.models.get_event_response_event import GetEventResponseEvent
+from openapi.models.get_invoice_response import GetInvoiceResponse
+from openapi.models.get_invoice_response_invoice import GetInvoiceResponseInvoice
+from openapi.models.get_meter_response import GetMeterResponse
+from openapi.models.get_meter_response_meter import GetMeterResponseMeter
+from openapi.models.get_plan_response import GetPlanResponse
+from openapi.models.get_plan_response_plan import GetPlanResponsePlan
+from openapi.models.get_products_usage_report_response import GetProductsUsageReportResponse
+from openapi.models.grant_credits_request import GrantCreditsRequest
+from openapi.models.invalid_event import InvalidEvent
+from openapi.models.line_item import LineItem
+from openapi.models.line_item_revenue_breakdown import LineItemRevenueBreakdown
+from openapi.models.list_contracts_response import ListContractsResponse
+from openapi.models.list_credit_ledger_entries_response import ListCreditLedgerEntriesResponse
+from openapi.models.list_customers_response import ListCustomersResponse
+from openapi.models.list_invoices_response import ListInvoicesResponse
+from openapi.models.list_meters_response import ListMetersResponse
+from openapi.models.list_plans_response import ListPlansResponse
+from openapi.models.login_request import LoginRequest
+from openapi.models.login_response import LoginResponse
+from openapi.models.meter import Meter
+from openapi.models.net_suite_export_sales_order_request import NetSuiteExportSalesOrderRequest
+from openapi.models.net_suite_sync_invoices_request import NetSuiteSyncInvoicesRequest
+from openapi.models.net_suite_sync_invoices_request_data import NetSuiteSyncInvoicesRequestData
+from openapi.models.net_suite_sync_invoices_request_data_entity import NetSuiteSyncInvoicesRequestDataEntity
+from openapi.models.net_suite_sync_invoices_request_data_item import NetSuiteSyncInvoicesRequestDataItem
+from openapi.models.net_suite_sync_invoices_request_data_item_items_inner import NetSuiteSyncInvoicesRequestDataItemItemsInner
+from openapi.models.net_suite_sync_invoices_response import NetSuiteSyncInvoicesResponse
+from openapi.models.notification_event_type import NotificationEventType
+from openapi.models.payment_term import PaymentTerm
+from openapi.models.plan_billing_data import PlanBillingData
+from openapi.models.plan_status import PlanStatus
+from openapi.models.query_events_response import QueryEventsResponse
+from openapi.models.query_events_response_events_inner import QueryEventsResponseEventsInner
+from openapi.models.send_events_request import SendEventsRequest
+from openapi.models.send_events_response import SendEventsResponse
+from openapi.models.update_customer_request import UpdateCustomerRequest
+from openapi.models.update_customer_response import UpdateCustomerResponse
+from openapi.models.update_meter_request import UpdateMeterRequest
+from openapi.models.update_meter_response import UpdateMeterResponse
+from openapi.models.webhook_subscribe_request import WebhookSubscribeRequest

vayu_py-0.1.1/openapi/api/__init__.py

@@ -0,0 +1,15 @@
+# flake8: noqa
+
+# import apis into api package
+from openapi.api.auth_api import AuthApi
+from openapi.api.contracts_api import ContractsApi
+from openapi.api.credits_api import CreditsApi
+from openapi.api.customers_api import CustomersApi
+from openapi.api.events_api import EventsApi
+from openapi.api.integrations_api import IntegrationsApi
+from openapi.api.invoices_api import InvoicesApi
+from openapi.api.meters_api import MetersApi
+from openapi.api.plans_api import PlansApi
+from openapi.api.reports_api import ReportsApi
+from openapi.api.webhooks_api import WebhooksApi
+