vayu-client 1.0.10

Simple and easy to use python package for utilizing vayu billing system

Vayu API Client Library

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:

pip install vayu-client

Usage

Initialization

Initialize the Vayu API client. The base_url parameter is optional and defaults to Vayu's public API servers.

from vayu_api_client import VayuClient

vayu = VayuClient(
    access_token='your-access-token',
    base_url='https://connect.withvayu.com'  # Optional
)

Authentication

Login and Obtain Access Token

To obtain a new access token, use the login method:

response = vayu.auth.login({
    'refresh_token': 'your-refresh-token'
})

print(response['access_token'])

Events

Sending Events

To send a batch of events for processing and storage:

events = [
    {
        'name': 'api_call',  # The distinctive label assigned to an event
        'timestamp': '2023-09-13T18:25:43.511Z',  # The exact moment of event occurrence in ISO 8601 format
        'customer_alias': 'customer_12345',  # A unique identifier assigned to each customer
        'ref': '4f6cf35x-2c4y-483z-a0a9-158621f77a21',  # A universally unique identifier for each event
        'data': {
            'key1': 'processing_duration',  # Example additional data
            'key2': 'api_url'  # Example additional data
        }
    }
]

response = vayu.events.send_events({'events': events})

print(response['valid_events'])
print(response['invalid_events'])

Querying Events

To fetch events occurring within a specified timestamp range:

response = vayu.events.query_events({
    'start_time': '2023-09-01T00:00:00.000Z',
    'end_time': '2023-09-30T23:59:59.999Z',
    'event_name': 'api_call',
    'limit': 10
})

print(response['events'])

Getting Event by Ref ID

To get a specific event using its reference ID:

response = vayu.events.get_event_by_ref_id('4f6cf35x-2c4y-483z-a0a9-158621f77a21')

print(response['event'])

Deleting Event by Ref ID

To delete a specific event using its reference ID:

response = vayu.events.delete_event_by_ref_id('4f6cf35x-2c4y-483z-a0a9-158621f77a21')

print(response['event'])

Customers

Creating a Customer

To create a new customer:

response = vayu.customers.create_customer({
    'name': 'John Doe',
    'alias': 'customer_12345'
})

print(response['customer'])

Updating a Customer

To update an existing customer by ID:

response = vayu.customers.update_customer('customer-id', {
    'name': 'Jane Doe',
    'alias': 'customer_67890'
})

print(response['customer'])

Deleting a Customer

To delete a customer by ID:

response = vayu.customers.delete_customer('customer-id')

print(response['customer'])

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:

response = vayu.meters.get_meter('meter-id')

print(response['meter'])

Updating a Meter

To update a meter by ID:

response = vayu.meters.update_meter('meter-id', {
    'name': 'Updated Meter Name',
    'event_name': 'api_call',
    'aggregation_method': {
        'operator': 'Sum',
        'field': 'usage',
    },
    'filter': {
        'conditions': [
            {
                'criterions': [
                    {
                        'field': 'event',
                        'operator': 'Equals',
                        'value': 'api_call'
                    }
                ]
            }
        ]
    }
})

print(response['meter'])

Deleting a Meter

To delete a meter by ID:

response = vayu.meters.delete_meter('meter-id')

print(response['meter'])

Features

The Vayu API client library provides access to the following features:

• Auth
  • auth.login()
• Events
  • events.send_events()
  • events.query_events()
  • events.get_event_by_ref_id()
  • events.delete_event_by_ref_id()
  • events.send_events_dry_run()
• Customers
  • customers.create_customer()
  • customers.update_customer()
  • customers.delete_customer()
  • customers.list_customers()
  • customers.get_customer()
• Meters
  • meters.get_meter()
  • meters.update_meter()
  • meters.delete_meter()
  • meters.list_meters()
• Plans
  • plans.get_plan()
  • plans.delete_plan()
  • plans.list_plans()
• Contracts
  • contracts.create_contract()
  • contracts.delete_contract()
  • contracts.list_contracts()
  • contracts.get_contract()
• Invoices
  • invoices.get_invoice()
  • invoices.list_invoices()

Support

If you have any questions or need further assistance, please contact Vayu at [e-mail].

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.