# Augmenting Integrations Tools
[](https://www.gnu.org/licenses/agpl-3.0)[](https://github.com/astral-sh/ruff)
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
[](https://conventionalcommits.org)
[](https://github.com/pre-commit/pre-commit)
[](https://github.com/features/actions "Go to GitHub Actions homepage")
[](https://github.com/semantic-release/semantic-release)
# Secrets
Push secrets from .env to GH Actions.
Here is a draft for a `README.md` section that provides a general overview of the `LeadmoApiV1` class, its capabilities, and usage examples:
---
# LeadmoApiV1 Class
The `LeadmoApiV1` class is a Python client designed to facilitate interactions with the Lead Momentum API. This client provides an easy-to-use interface for managing contacts and appointments within the Lead Momentum platform. It abstracts away the complexities of making HTTP requests and handling authentication, allowing developers to focus on their application's core functionality.
## Capabilities
The `LeadmoApiV1` class offers the following capabilities:
### Contact Management
- **Create Contact**: Add a new contact to your Lead Momentum account.
- **Lookup Contact**: Retrieve contact details using contact identifiers.
- **Update Contact**: Modify existing contact information, such as address and phone number.
- **Delete Contact**: Remove a contact from your account.
- **Get Contact by ID**: Fetch detailed information about a contact using their unique identifier.
### Appointment Management
- **Get Available Appointment Slots**: Retrieve available time slots for scheduling appointments.
- **Create Appointment**: Schedule a new appointment using available slots.
- **Get Appointment by ID**: Retrieve detailed information about a specific appointment.
- **Update Appointment**: Change the details of an existing appointment.
- **Update Appointment Status**: Modify the status of an appointment (e.g., confirmed, canceled).
- **Delete Appointment**: Cancel and remove an appointment from the schedule.
## Usage
### Initialization
To use the `LeadmoApiV1` client, instantiate it with your API key:
```python
from augint_tools.leadmo_api.v1.client import LeadmoApiV1
# Initialize the client
api_key = "your_api_key_here"
leadmo = LeadmoApiV1(api_key=api_key)
```
Alternatively, you can set the API key as an environment variable and initialize the client without passing the key explicitly:
```python
from augint_tools.leadmo_api.v1.client import LeadmoApiV1
os.environ["LEADMO_BEARER_TOKEN"] = "your_api_key_here"
# Initialize the client
leadmo = LeadmoApiV1()
```
### Examples
#### Creating a Contact
```python
# Define contact details
contact_data = {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"phone": "+1234567890"
}
# Create the contact
response = leadmo.create_contact(**contact_data)
print(response)
```
#### Scheduling an Appointment
```python
# Get available appointment slots
slots_response = leadmo.get_available_appointment_slots(calendar_id="your_calendar_id", timezone="US/Pacific")
next_slot = list(slots_response.values())[0]["slots"][0]
# Create an appointment
appointment_response = leadmo.create_appointment(
phone=contact_data.get("phone"),
calendar_id="your_calendar_id",
selected_slot=next_slot,
selected_timezone="US/Pacific"
)
print(appointment_response)
```
#### Updating Contact Information
```python
# Update the contact's address
update_response = leadmo.update_contact(contact_id=contact_id, address1="1234 Main St.")
print(update_response)
```
#### Deleting an Appointment
```python
# Delete the appointment
leadmo.delete_appointment(appointment_id=appointment_id)
```
## Conclusion
The `LeadmoApiV1` class streamlines the process of integrating with the Lead Momentum API, providing a simple and efficient way to manage contacts and appointments programmatically. By utilizing this client, developers can focus on building robust applications while leveraging the powerful features offered by the Lead Momentum platform.
examples as needed for your project's documentation!
Raw data
{
"_id": null,
"home_page": "https://github.com/svange/openbrain",
"name": "augint-tools",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Samuel Vange",
"author_email": "7166607+svange@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/ee/a0/50b325da49b0d4ae93d7b8d1495540568ee5bba1e64dfdefedbe122e43d5/augint_tools-1.42.0.tar.gz",
"platform": null,
"description": "# Augmenting Integrations Tools\n\n\n\n[](https://www.gnu.org/licenses/agpl-3.0)[](https://github.com/astral-sh/ruff)\n<a href=\"https://github.com/psf/black\"><img alt=\"Code style: black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\"></a>\n[](https://conventionalcommits.org)\n[](https://github.com/pre-commit/pre-commit)\n[](https://github.com/features/actions \"Go to GitHub Actions homepage\")\n[](https://github.com/semantic-release/semantic-release)\n\n# Secrets\nPush secrets from .env to GH Actions.\n\n\nHere is a draft for a `README.md` section that provides a general overview of the `LeadmoApiV1` class, its capabilities, and usage examples:\n\n---\n\n# LeadmoApiV1 Class\n\nThe `LeadmoApiV1` class is a Python client designed to facilitate interactions with the Lead Momentum API. This client provides an easy-to-use interface for managing contacts and appointments within the Lead Momentum platform. It abstracts away the complexities of making HTTP requests and handling authentication, allowing developers to focus on their application's core functionality.\n\n## Capabilities\n\nThe `LeadmoApiV1` class offers the following capabilities:\n\n### Contact Management\n\n- **Create Contact**: Add a new contact to your Lead Momentum account.\n- **Lookup Contact**: Retrieve contact details using contact identifiers.\n- **Update Contact**: Modify existing contact information, such as address and phone number.\n- **Delete Contact**: Remove a contact from your account.\n- **Get Contact by ID**: Fetch detailed information about a contact using their unique identifier.\n\n### Appointment Management\n\n- **Get Available Appointment Slots**: Retrieve available time slots for scheduling appointments.\n- **Create Appointment**: Schedule a new appointment using available slots.\n- **Get Appointment by ID**: Retrieve detailed information about a specific appointment.\n- **Update Appointment**: Change the details of an existing appointment.\n- **Update Appointment Status**: Modify the status of an appointment (e.g., confirmed, canceled).\n- **Delete Appointment**: Cancel and remove an appointment from the schedule.\n\n## Usage\n\n### Initialization\n\nTo use the `LeadmoApiV1` client, instantiate it with your API key:\n\n```python\nfrom augint_tools.leadmo_api.v1.client import LeadmoApiV1\n\n# Initialize the client\napi_key = \"your_api_key_here\"\nleadmo = LeadmoApiV1(api_key=api_key)\n```\n\nAlternatively, you can set the API key as an environment variable and initialize the client without passing the key explicitly:\n\n```python\nfrom augint_tools.leadmo_api.v1.client import LeadmoApiV1\nos.environ[\"LEADMO_BEARER_TOKEN\"] = \"your_api_key_here\"\n# Initialize the client\nleadmo = LeadmoApiV1()\n```\n### Examples\n\n#### Creating a Contact\n\n```python\n# Define contact details\ncontact_data = {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone\": \"+1234567890\"\n}\n\n# Create the contact\nresponse = leadmo.create_contact(**contact_data)\nprint(response)\n```\n\n#### Scheduling an Appointment\n\n```python\n# Get available appointment slots\nslots_response = leadmo.get_available_appointment_slots(calendar_id=\"your_calendar_id\", timezone=\"US/Pacific\")\nnext_slot = list(slots_response.values())[0][\"slots\"][0]\n\n# Create an appointment\nappointment_response = leadmo.create_appointment(\n phone=contact_data.get(\"phone\"),\n calendar_id=\"your_calendar_id\",\n selected_slot=next_slot,\n selected_timezone=\"US/Pacific\"\n)\nprint(appointment_response)\n```\n\n#### Updating Contact Information\n\n```python\n# Update the contact's address\nupdate_response = leadmo.update_contact(contact_id=contact_id, address1=\"1234 Main St.\")\nprint(update_response)\n```\n\n#### Deleting an Appointment\n\n```python\n# Delete the appointment\nleadmo.delete_appointment(appointment_id=appointment_id)\n```\n\n## Conclusion\n\nThe `LeadmoApiV1` class streamlines the process of integrating with the Lead Momentum API, providing a simple and efficient way to manage contacts and appointments programmatically. By utilizing this client, developers can focus on building robust applications while leveraging the powerful features offered by the Lead Momentum platform.\n\nexamples as needed for your project's documentation!\n",
"bugtrack_url": null,
"license": "AGPL-3.0-only",
"summary": "Standard tools for Augmenting Integrations",
"version": "1.42.0",
"project_urls": {
"Homepage": "https://github.com/svange/openbrain"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8f36ea70863a02bf31bea238af68e8a9e3436d44a54ec6b1401be98d8dd49d87",
"md5": "41de53ff4b8a9f89966a6393c8ceb193",
"sha256": "5dfb7c3b10e1205e459d9d7b00f9e09817baa161366c7208a7f92f0ea7e4580e"
},
"downloads": -1,
"filename": "augint_tools-1.42.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "41de53ff4b8a9f89966a6393c8ceb193",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 23408,
"upload_time": "2024-09-11T18:42:08",
"upload_time_iso_8601": "2024-09-11T18:42:08.553955Z",
"url": "https://files.pythonhosted.org/packages/8f/36/ea70863a02bf31bea238af68e8a9e3436d44a54ec6b1401be98d8dd49d87/augint_tools-1.42.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eea050b325da49b0d4ae93d7b8d1495540568ee5bba1e64dfdefedbe122e43d5",
"md5": "da34f5a513bafeebbbbf2ac6f5103416",
"sha256": "268b0603e356b5cd56082959ff6a40c5dcc66f8195fa5e6d5618cfe3a94bdefa"
},
"downloads": -1,
"filename": "augint_tools-1.42.0.tar.gz",
"has_sig": false,
"md5_digest": "da34f5a513bafeebbbbf2ac6f5103416",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 21376,
"upload_time": "2024-09-11T18:42:09",
"upload_time_iso_8601": "2024-09-11T18:42:09.644917Z",
"url": "https://files.pythonhosted.org/packages/ee/a0/50b325da49b0d4ae93d7b8d1495540568ee5bba1e64dfdefedbe122e43d5/augint_tools-1.42.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-11 18:42:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "svange",
"github_project": "openbrain",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "augint-tools"
}
JSON
