ownerrez-wrapper 0.1.0__tar.gz

ownerrez_wrapper-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Geody Moore
+
+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.

ownerrez_wrapper-0.1.0/MANIFEST.in

@@ -0,0 +1,5 @@
+include LICENSE
+include README.md
+include requirements.txt
+include requirements-dev.txt
+recursive-include tests *.py

ownerrez_wrapper-0.1.0/PKG-INFO

@@ -0,0 +1,187 @@
+Metadata-Version: 2.2
+Name: ownerrez-wrapper
+Version: 0.1.0
+Summary: A Python wrapper for the OwnerRez API
+Home-page: https://github.com/gmoorevt/ownerrez-wrapper
+Author: Geody Moore
+Author-email: geody.moore@gmail.com
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.0
+Requires-Dist: python-dateutil>=2.8.0
+Requires-Dist: python-dotenv>=1.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=2.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: isort>=5.0.0; extra == "dev"
+Requires-Dist: flake8>=3.9.0; extra == "dev"
+Requires-Dist: mypy>=0.900; extra == "dev"
+Requires-Dist: freezegun>=1.2.0; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# OwnerRez API Wrapper
+
+A Python wrapper for the OwnerRez API. This package provides a simple and intuitive interface to interact with the OwnerRez API v2.
+
+## Requirements
+
+- Python 3.10 or higher
+
+## Installation
+
+```bash
+pip install ownerrez-wrapper
+```
+
+## Python Usage
+
+```python
+from ownerrez_wrapper import API
+from datetime import datetime
+
+# Initialize the API client
+api = API(username="your_username", token="your_token")
+
+# Get all properties
+properties = api.getproperties()
+for prop in properties:
+    print(f"Property: {prop.name} (ID: {prop.id})")
+
+# Get bookings for a property
+bookings = api.getbookings(
+    property_id=123,
+    since_utc=datetime(2024, 1, 1)
+)
+for booking in bookings:
+    print(f"Booking: {booking.arrival} to {booking.departure}")
+
+# Get a specific booking
+booking = api.getbooking(booking_id=456)
+print(f"Guest ID: {booking.guest_id}")
+
+# Get guest details
+guest = api.getguest(guest_id=789)
+print(f"Guest: {guest.first_name} {guest.last_name}")
+
+# Check if a property is currently booked
+is_booked = api.isunitbooked(property_id=123)
+print(f"Property is booked: {is_booked}")
+```
+
+## API Documentation
+
+### API Class Methods
+
+- `getproperties()` -> List[Property]
+  - Returns a list of all properties
+
+- `getproperty(property_id: int)` -> Property
+  - Get details for a specific property
+  - Parameters:
+    - property_id: The property ID
+
+- `getbookings(property_id: int, since_utc: datetime)` -> List[Booking]
+  - Get bookings for a specific property since a given date
+  - Parameters:
+    - property_id: The property ID
+    - since_utc: DateTime object for the start date
+
+- `getbooking(booking_id: int)` -> Booking
+  - Get details for a specific booking
+  - Parameters:
+    - booking_id: The booking ID
+
+- `getguest(guest_id: int)` -> Guest
+  - Get details for a specific guest
+  - Parameters:
+    - guest_id: The guest ID
+
+- `isunitbooked(property_id: int)` -> bool
+  - Check if a property is currently booked
+  - Parameters:
+    - property_id: The property ID
+
+### Data Models
+
+The API returns strongly-typed objects that provide a rich interface to the OwnerRez data. For detailed documentation of all data models, including all available fields and usage examples, see [Data Models Documentation](docs/models.md).
+
+Main models:
+- `Property`: Contains property details (id, name, bedrooms, etc.)
+- `Booking`: Contains booking information (arrival, departure, guest, etc.)
+- `Guest`: Contains guest information (name, contact details, etc.)
+
+Supporting models:
+- `Address`: Physical address information
+- `EmailAddress`: Email contact information
+- `Phone`: Phone contact information
+- `Charge`: Booking charge information
+- `DoorCode`: Property access codes
+
+## CLI Tool (for testing)
+
+A command-line interface is included for testing and debugging. You can provide credentials via environment variables or a `.env` file:
+
+```bash
+# Using .env file
+echo "OWNERREZ_USERNAME=your_username" > .env
+echo "OWNERREZ_TOKEN=your_token" >> .env
+
+# List properties
+ownerrez properties
+
+# Get property details
+ownerrez property 123
+
+# Check bookings
+ownerrez bookings 123 --since 2024-01-01
+
+# Get booking details
+ownerrez booking 456
+```
+
+## Development
+
+To set up the development environment:
+
+```bash
+git clone https://github.com/gmoorevt/ownerrez-wrapper.git
+cd ownerrez-wrapper
+pip install -e ".[dev]"
+```
+
+To run tests:
+
+```bash
+pytest
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Author
+
+- Geody Moore (geody.moore@gmail.com)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

ownerrez_wrapper-0.1.0/README.md

@@ -0,0 +1,147 @@
+# OwnerRez API Wrapper
+
+A Python wrapper for the OwnerRez API. This package provides a simple and intuitive interface to interact with the OwnerRez API v2.
+
+## Requirements
+
+- Python 3.10 or higher
+
+## Installation
+
+```bash
+pip install ownerrez-wrapper
+```
+
+## Python Usage
+
+```python
+from ownerrez_wrapper import API
+from datetime import datetime
+
+# Initialize the API client
+api = API(username="your_username", token="your_token")
+
+# Get all properties
+properties = api.getproperties()
+for prop in properties:
+    print(f"Property: {prop.name} (ID: {prop.id})")
+
+# Get bookings for a property
+bookings = api.getbookings(
+    property_id=123,
+    since_utc=datetime(2024, 1, 1)
+)
+for booking in bookings:
+    print(f"Booking: {booking.arrival} to {booking.departure}")
+
+# Get a specific booking
+booking = api.getbooking(booking_id=456)
+print(f"Guest ID: {booking.guest_id}")
+
+# Get guest details
+guest = api.getguest(guest_id=789)
+print(f"Guest: {guest.first_name} {guest.last_name}")
+
+# Check if a property is currently booked
+is_booked = api.isunitbooked(property_id=123)
+print(f"Property is booked: {is_booked}")
+```
+
+## API Documentation
+
+### API Class Methods
+
+- `getproperties()` -> List[Property]
+  - Returns a list of all properties
+
+- `getproperty(property_id: int)` -> Property
+  - Get details for a specific property
+  - Parameters:
+    - property_id: The property ID
+
+- `getbookings(property_id: int, since_utc: datetime)` -> List[Booking]
+  - Get bookings for a specific property since a given date
+  - Parameters:
+    - property_id: The property ID
+    - since_utc: DateTime object for the start date
+
+- `getbooking(booking_id: int)` -> Booking
+  - Get details for a specific booking
+  - Parameters:
+    - booking_id: The booking ID
+
+- `getguest(guest_id: int)` -> Guest
+  - Get details for a specific guest
+  - Parameters:
+    - guest_id: The guest ID
+
+- `isunitbooked(property_id: int)` -> bool
+  - Check if a property is currently booked
+  - Parameters:
+    - property_id: The property ID
+
+### Data Models
+
+The API returns strongly-typed objects that provide a rich interface to the OwnerRez data. For detailed documentation of all data models, including all available fields and usage examples, see [Data Models Documentation](docs/models.md).
+
+Main models:
+- `Property`: Contains property details (id, name, bedrooms, etc.)
+- `Booking`: Contains booking information (arrival, departure, guest, etc.)
+- `Guest`: Contains guest information (name, contact details, etc.)
+
+Supporting models:
+- `Address`: Physical address information
+- `EmailAddress`: Email contact information
+- `Phone`: Phone contact information
+- `Charge`: Booking charge information
+- `DoorCode`: Property access codes
+
+## CLI Tool (for testing)
+
+A command-line interface is included for testing and debugging. You can provide credentials via environment variables or a `.env` file:
+
+```bash
+# Using .env file
+echo "OWNERREZ_USERNAME=your_username" > .env
+echo "OWNERREZ_TOKEN=your_token" >> .env
+
+# List properties
+ownerrez properties
+
+# Get property details
+ownerrez property 123
+
+# Check bookings
+ownerrez bookings 123 --since 2024-01-01
+
+# Get booking details
+ownerrez booking 456
+```
+
+## Development
+
+To set up the development environment:
+
+```bash
+git clone https://github.com/gmoorevt/ownerrez-wrapper.git
+cd ownerrez-wrapper
+pip install -e ".[dev]"
+```
+
+To run tests:
+
+```bash
+pytest
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Author
+
+- Geody Moore (geody.moore@gmail.com)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

ownerrez_wrapper-0.1.0/ownerrez_wrapper/__init__.py

@@ -0,0 +1,15 @@
+"""
+OwnerRez API Wrapper
+~~~~~~~~~~~~~~~~~~~
+
+A Python wrapper for the OwnerRez API.
+"""
+
+from .api import API
+from .cli import main as cli
+
+__version__ = "0.1.0"
+__author__ = "Geody Moore"
+__email__ = "geody.moore@gmail.com"
+
+__all__ = ["API", "cli"]

ownerrez_wrapper-0.1.0/ownerrez_wrapper/api.py

@@ -0,0 +1,84 @@
+from typing import List
+from datetime import datetime
+from .restAdapter import RestAdapter
+from .model import Property, Booking, Guest
+
+
+class API(object):
+    """
+    OwnerRez API wrapper class
+    """
+
+    def __init__(self,username, token):
+        """
+        Initialize the OwnerRez API wrapper with the OwnerRez username and token
+        :param username: OwnerRez username
+        :param token: OwnerRez token
+        """
+        self.username = username
+        self.token = token
+    
+    
+    def getproperties(self) -> list:
+        """
+        Get a list of properties.
+        """
+        restAdapt = RestAdapter(self.username,self.token)
+        results = []
+        property_list = restAdapt.get(endpoint='properties')
+        for prop in property_list.data['items']:
+            prop = Property(**prop)
+            results.append(prop)
+        return results
+
+    def getproperty(self, property_id: int) -> Property:
+        """
+        Get a single property by ID.
+        """
+        restAdapt = RestAdapter(self.username,self.token)
+        property_data = restAdapt.get(endpoint=f'properties/{property_id}')
+        return Property(**property_data.data)
+
+    def getbookings(self, property_id: int, since_utc: datetime) -> List[Booking]:
+        """
+        Get a list of bookings for a property since a given date.
+        """
+        restAdapt = RestAdapter(self.username,self.token)
+        results = []
+        params = {'since_utc': since_utc, 'property_id': property_id}
+        booking_list = restAdapt.get(endpoint='bookings', ep_params=params)
+        
+        for booking in booking_list.data['items']:
+            booking = Booking(**booking)
+            results.append(booking)
+        return results
+    
+    def getbooking(self, booking_id: int) -> Booking:
+        """
+        Get a single booking by ID.
+        """
+        restAdapt = RestAdapter(self.username,self.token)
+        booking = restAdapt.get(endpoint=f'bookings/{booking_id}')
+        return Booking(**booking.data)
+    
+    def getguest(self, guest_id: int) -> Guest:
+        """
+        Get a single guest by ID.
+        """
+        restAdapt = RestAdapter(self.username,self.token)
+        guest = restAdapt.get(endpoint=f'guests/{guest_id}')
+        return Guest(**guest.data)
+    
+    def isunitbooked(self, property_id: int) -> bool:
+        """
+        Check if a unit is booked today.
+        """
+        today = datetime.today()
+        bookings = self.getbookings(property_id=property_id, since_utc=today)
+        for booking in bookings:
+            # Convert string dates to datetime if they aren't already
+            arrival = booking.arrival if isinstance(booking.arrival, datetime) else datetime.strptime(booking.arrival, "%Y-%m-%d")
+            departure = booking.departure if isinstance(booking.departure, datetime) else datetime.strptime(booking.departure, "%Y-%m-%d")
+            if arrival <= today and departure >= today:
+                return True
+        return False

ownerrez_wrapper-0.1.0/ownerrez_wrapper/cli.py

@@ -0,0 +1,114 @@
+#!/usr/bin/env python3
+import argparse
+from datetime import datetime
+import json
+from typing import Any
+import os
+from pathlib import Path
+from dotenv import load_dotenv
+from .api import API
+from uuid import UUID
+
+def json_serial(obj: Any) -> str:
+    """JSON serializer for objects not serializable by default json code"""
+    if isinstance(obj, datetime):
+        return obj.isoformat()
+    if isinstance(obj, UUID):
+        return str(obj)
+    if hasattr(obj, '__dict__'):
+        return {k: v for k, v in obj.__dict__.items() if v is not None}
+    raise TypeError(f"Type {type(obj)} not serializable")
+
+def print_json(data: Any) -> None:
+    """Print data as formatted JSON"""
+    print(json.dumps(data, indent=2, default=json_serial))
+
+def load_env():
+    """Load environment variables from .env file"""
+    env_path = Path('.env')
+    if env_path.exists():
+        load_dotenv(env_path)
+
+def main():
+    # Load environment variables from .env file
+    load_env()
+    
+    parser = argparse.ArgumentParser(description='OwnerRez API CLI')
+    
+    # Authentication arguments
+    parser.add_argument('--username', help='OwnerRez API username')
+    parser.add_argument('--token', help='OwnerRez API token')
+    
+    # Commands
+    subparsers = parser.add_subparsers(dest='command', help='Commands')
+    
+    # Properties command
+    properties_parser = subparsers.add_parser('properties', help='List all properties')
+    
+    # Property command
+    property_parser = subparsers.add_parser('property', help='Get a specific property')
+    property_parser.add_argument('property_id', type=int, help='Property ID')
+    
+    # Bookings command
+    bookings_parser = subparsers.add_parser('bookings', help='Get bookings for a property')
+    bookings_parser.add_argument('property_id', type=int, help='Property ID')
+    bookings_parser.add_argument('--since', type=str, help='Get bookings since date (YYYY-MM-DD)')
+    
+    # Booking command
+    booking_parser = subparsers.add_parser('booking', help='Get a specific booking')
+    booking_parser.add_argument('booking_id', type=int, help='Booking ID')
+    
+    # Guest command
+    guest_parser = subparsers.add_parser('guest', help='Get a specific guest')
+    guest_parser.add_argument('guest_id', type=int, help='Guest ID')
+    
+    # Check if unit is booked command
+    booked_parser = subparsers.add_parser('is-booked', help='Check if a unit is currently booked')
+    booked_parser.add_argument('property_id', type=int, help='Property ID')
+    
+    args = parser.parse_args()
+    
+    # Get credentials from arguments or environment
+    username = args.username or os.environ.get('OWNERREZ_USERNAME')
+    token = args.token or os.environ.get('OWNERREZ_TOKEN')
+    
+    if not username or not token:
+        parser.error('Username and token must be provided via arguments, environment variables, or .env file')
+    
+    api = API(username=username, token=token)
+    
+    try:
+        if args.command == 'properties':
+            properties = api.getproperties()
+            print_json(properties)
+            
+        elif args.command == 'property':
+            property = api.getproperty(property_id=args.property_id)
+            print_json(property)
+            
+        elif args.command == 'bookings':
+            since_date = datetime.strptime(args.since, "%Y-%m-%d") if args.since else datetime.today()
+            bookings = api.getbookings(property_id=args.property_id, since_utc=since_date)
+            print_json(bookings)
+            
+        elif args.command == 'booking':
+            booking = api.getbooking(booking_id=args.booking_id)
+            print_json(booking)
+            
+        elif args.command == 'guest':
+            guest = api.getguest(guest_id=args.guest_id)
+            print_json(guest)
+            
+        elif args.command == 'is-booked':
+            is_booked = api.isunitbooked(property_id=args.property_id)
+            print_json({"is_booked": is_booked})
+            
+        else:
+            parser.print_help()
+            
+    except Exception as e:
+        print(f"Error: {str(e)}")
+        exit(1)
+
+if __name__ == '__main__':
+    main() 

ownerrez_wrapper-0.1.0/ownerrez_wrapper/constants.py

@@ -0,0 +1 @@
+BASEURL = "https://api.ownerreservations.com/v2" 

ownerrez_wrapper-0.1.0/ownerrez_wrapper/exceptions.py

@@ -0,0 +1,3 @@
+class OwnerrezApiException(Exception):
+    """Base exception for OwnerRez API errors"""
+    pass 

ownerrez_wrapper-0.1.0/ownerrez_wrapper/model.py

@@ -0,0 +1,218 @@
+from dataclasses import dataclass
+from uuid import UUID
+from datetime import datetime
+from typing import List, Dict, Optional, Any
+
+
+@dataclass
+class Result:
+    message: str
+    status: str
+    data: Optional[List[Dict]] = None
+
+    def __init__(self, **kwargs):
+        for key, value in kwargs.items():
+            if hasattr(self, key):
+                setattr(self, key, value)
+
+@dataclass
+class Address:
+    city: Optional[str] = None
+    country: Optional[str] = None
+    id: Optional[int] = None
+    is_default: Optional[bool] = None
+    postal_code: Optional[str] = None
+    province: Optional[str] = None
+    state: Optional[str] = None
+    street1: Optional[str] = None
+    street2: Optional[str] = None
+    type: Optional[str] = None
+
+    def __init__(self, **kwargs):
+        for key, value in kwargs.items():
+            if hasattr(self, key):
+                setattr(self, key, value)
+
+@dataclass
+class EmailAddress:
+    address: Optional[str] = None
+    id: Optional[int] = None
+    is_default: Optional[bool] = None
+    type: Optional[str] = None
+
+    def __init__(self, **kwargs):
+        for key, value in kwargs.items():
+            if hasattr(self, key):
+                setattr(self, key, value)
+
+@dataclass
+class Phone:
+    extension: Optional[str] = None
+    id: Optional[int] = None
+    is_default: Optional[bool] = None
+    number: Optional[str] = None
+    type: Optional[str] = None
+
+    def __init__(self, **kwargs):
+        for key, value in kwargs.items():
+            if hasattr(self, key):
+                setattr(self, key, value)
+
+@dataclass
+class Guest:
+    addresses: Optional[List[Address]] = None
+    email_addresses: Optional[List[EmailAddress]] = None
+    first_name: Optional[str] = None
+    id: Optional[int] = None
+    last_name: Optional[str] = None
+    notes: Optional[str] = None
+    phones: Optional[List[Phone]] = None
+
+    def __init__(self, **kwargs):
+        for key, value in kwargs.items():
+            if hasattr(self, key):
+                if key == 'addresses' and value:
+                    self.addresses = [Address(**addr) for addr in value]
+                elif key == 'email_addresses' and value:
+                    self.email_addresses = [EmailAddress(**email) for email in value]
+                elif key == 'phones' and value:
+                    self.phones = [Phone(**phone) for phone in value]
+                else:
+                    setattr(self, key, value)
+
+@dataclass
+class Property:
+    active: Optional[bool] = None
+    address: Optional[Address] = None
+    bathrooms: Optional[int] = None
+    bathrooms_full: Optional[int] = None
+    bathrooms_half: Optional[int] = None
+    bedrooms: Optional[int] = None
+    check_in: Optional[str] = None
+    check_in_end: Optional[str] = None
+    check_out: Optional[str] = None
+    currency_code: Optional[str] = None
+    display_order: Optional[int] = None
+    external_display_order: Optional[int] = None
+    external_name: Optional[str] = None
+    id: Optional[int] = None
+    internal_code: Optional[str] = None
+    key: Optional[UUID] = None
+    latitude: Optional[int] = None
+    longitude: Optional[int] = None
+    max_adults: Optional[int] = None
+    max_children: Optional[int] = None
+    max_guests: Optional[int] = None
+    max_pets: Optional[int] = None
+    name: Optional[str] = None
+    owner_id: Optional[int] = None
+    property_type: Optional[str] = None
+    public_url: Optional[str] = None
+    thumbnail_url: Optional[str] = None
+    thumbnail_url_large: Optional[str] = None
+    thumbnail_url_medium: Optional[str] = None
+    living_area: Optional[int] = None
+    
+    def __init__(self, **kwargs):
+        for key, value in kwargs.items():
+            if hasattr(self, key):
+                if key == 'address' and value:
+                    self.address = Address(**value)
+                else:
+                    setattr(self, key, value)
+
+
+
+@dataclass
+class Charge:
+    amount: Optional[int] = None
+    commission_amount: Optional[int] = None
+    description: Optional[str] = None
+    expense_id: Optional[int] = None
+    is_channel_managed: Optional[bool] = None
+    is_commission_all: Optional[bool] = None
+    is_expense_all: Optional[bool] = None
+    is_taxable: Optional[bool] = None
+    owner_amount: Optional[int] = None
+    owner_commission_percent: Optional[int] = None
+    position: Optional[int] = None
+    rate: Optional[int] = None
+    rate_is_percent: Optional[bool] = None
+    surcharge_id: Optional[int] = None
+    tax_id: Optional[int] = None
+    type: Optional[str] = None
+
+    def __init__(self, **kwargs):
+        for key, value in kwargs.items():
+            if hasattr(self, key):
+                setattr(self, key, value)
+
+
+@dataclass
+class DoorCode:
+    code: Optional[str] = None
+    lock_names: Optional[str] = None
+
+    def __init__(self, **kwargs):
+        for key, value in kwargs.items():
+            if hasattr(self, key):
+                setattr(self, key, value)
+
+
+
+@dataclass
+class Booking:
+    adults: Optional[int] = None
+    arrival: Optional[datetime] = None
+    booked_utc: Optional[datetime] = None
+    canceled_utc: Optional[datetime] = None
+    charges: Optional[List[Charge]] = None
+    check_in: Optional[str] = None
+    check_in_end: Optional[str] = None
+    check_out: Optional[str] = None
+    children: Optional[int] = None
+    cleaning_date: Optional[datetime] = None
+    currency_code: Optional[str] = None
+    departure: Optional[datetime] = None
+    door_codes: Optional[List[DoorCode]] = None
+    form_key: Optional[str] = None
+    guest: Optional[Guest] = None
+    guest_id: Optional[int] = None
+    id: Optional[int] = None
+    infants: Optional[int] = None
+    is_block: Optional[bool] = None
+    listing_site: Optional[str] = None
+    notes: Optional[str] = None
+    owner_id: Optional[int] = None
+    pending_until_utc: Optional[datetime] = None
+    pets: Optional[int] = None
+    platform_email_address: Optional[str] = None
+    platform_reservation_number: Optional[str] = None
+    property_id: Optional[int] = None
+    quote_id: Optional[int] = None
+    status: Optional[str] = None
+    title: Optional[str] = None
+    total_amount: Optional[int] = None
+    total_host_fees: Optional[int] = None
+    total_owed: Optional[int] = None
+    total_paid: Optional[int] = None
+    total_refunded: Optional[int] = None
+    type: Optional[str] = None
+
+    def __init__(self, **kwargs):
+        for key, value in kwargs.items():
+            if hasattr(self, key):
+                if key in ['arrival', 'departure', 'booked_utc', 'canceled_utc', 'cleaning_date', 'pending_until_utc'] and value:
+                    # Convert string dates to datetime objects
+                    try:
+                        setattr(self, key, datetime.fromisoformat(value.replace('Z', '+00:00')))
+                    except (ValueError, AttributeError):
+                        setattr(self, key, value)
+                elif key == 'charges' and value:
+                    self.charges = [Charge(**charge) for charge in value]
+                elif key == 'door_codes' and value:
+                    self.door_codes = [DoorCode(**code) for code in value]
+                elif key == 'guest' and value:
+                    self.guest = Guest(**value)
+                else:
+                    setattr(self, key, value)

ownerrez_wrapper-0.1.0/ownerrez_wrapper/restAdapter.py

@@ -0,0 +1,76 @@
+import requests
+from json import JSONDecodeError
+from ownerrez_wrapper.model import Result
+import base64
+from typing import List, Dict
+import logging
+import datetime
+from ownerrez_wrapper.constants import BASEURL as hosturl
+from ownerrez_wrapper.exceptions import OwnerrezApiException
+
+class RestAdapter(object):
+    def __init__(self,username, token):
+        """
+        Initialize the RestAdapter object with the OwnerRez username and token
+        :param username: OwnerRez username
+        :param token: OwnerRez token
+        """
+        auth_string = f"{username}:{token}"
+        auth_bytes = auth_string.encode('ascii')
+        auth_b64 = base64.b64encode(auth_bytes).decode('ascii')
+        self.headers = {
+            'User-Agent': 'OwnerRezAPI',
+            'Content-Type': 'application/json',
+            'Authorization': f'Basic {auth_b64}'
+        }
+        self._logger = logging.getLogger(__name__)
+        self._logger.setLevel(logging.DEBUG)
+
+    def _do_request(self, http_method, endpoint, ep_params, data: Dict = None):
+        """
+        Make a request to the OwnerRez API
+        :param http_method: HTTP method to use
+        :param endpoint: API endpoint to call
+        :param ep_params: Dictionary of parameters to pass to the endpoint
+        :param data: Dictionary of data to pass in the request body
+        :return: Result object
+        """
+        
+        full_url = f"{hosturl}/{endpoint.lstrip('/')}"
+        log_line_pre = f"method={http_method}, url={full_url}, params={ep_params}"
+        log_line_post = ', '.join((log_line_pre, "success={}, status_code={}, message={}"))
+        
+        # Make the request
+        try:
+            self._logger.debug(msg = log_line_pre)
+            response = requests.request(method=http_method, url=full_url, headers=self.headers, params=ep_params, json=data)
+        
+        # If the request fails, log the error and raise an exception
+        except requests.exceptions.RequestException as e:
+            self._logger.error(msg=(str(e)))
+            raise OwnerrezApiException("Request failed") from e
+        
+        # Check status code first
+        is_success = 299 >= response.status_code >= 200     # 200 to 299 is OK
+        if not is_success:
+            self._logger.error(msg=log_line_post.format(False, response.status_code, response.reason))
+            raise OwnerrezApiException(f"{response.status_code}: {response.reason}")
+
+        # Try to parse the response as JSON only for successful responses
+        try:
+            data_out = response.json()
+        except (ValueError, TypeError, JSONDecodeError) as e:
+            self._logger.error(msg=log_line_post.format(False, response.status_code, e))
+            raise OwnerrezApiException("Bad JSON in response") from e
+
+        
+        return Result(status=response.status_code, message=response.reason, data=data_out)
+
+    def get(self, endpoint: str, ep_params: Dict = None) -> Result:
+        """
+        Make a GET request to the OwnerRez API
+        :param endpoint: API endpoint to call
+        :param ep_params: Dictionary of parameters to pass to the endpoint
+        :return: Result object
+        """
+        return self._do_request(http_method='GET', endpoint=endpoint, ep_params=ep_params)

ownerrez_wrapper-0.1.0/ownerrez_wrapper.egg-info/PKG-INFO

@@ -0,0 +1,187 @@
+Metadata-Version: 2.2
+Name: ownerrez-wrapper
+Version: 0.1.0
+Summary: A Python wrapper for the OwnerRez API
+Home-page: https://github.com/gmoorevt/ownerrez-wrapper
+Author: Geody Moore
+Author-email: geody.moore@gmail.com
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.0
+Requires-Dist: python-dateutil>=2.8.0
+Requires-Dist: python-dotenv>=1.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=2.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: isort>=5.0.0; extra == "dev"
+Requires-Dist: flake8>=3.9.0; extra == "dev"
+Requires-Dist: mypy>=0.900; extra == "dev"
+Requires-Dist: freezegun>=1.2.0; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# OwnerRez API Wrapper
+
+A Python wrapper for the OwnerRez API. This package provides a simple and intuitive interface to interact with the OwnerRez API v2.
+
+## Requirements
+
+- Python 3.10 or higher
+
+## Installation
+
+```bash
+pip install ownerrez-wrapper
+```
+
+## Python Usage
+
+```python
+from ownerrez_wrapper import API
+from datetime import datetime
+
+# Initialize the API client
+api = API(username="your_username", token="your_token")
+
+# Get all properties
+properties = api.getproperties()
+for prop in properties:
+    print(f"Property: {prop.name} (ID: {prop.id})")
+
+# Get bookings for a property
+bookings = api.getbookings(
+    property_id=123,
+    since_utc=datetime(2024, 1, 1)
+)
+for booking in bookings:
+    print(f"Booking: {booking.arrival} to {booking.departure}")
+
+# Get a specific booking
+booking = api.getbooking(booking_id=456)
+print(f"Guest ID: {booking.guest_id}")
+
+# Get guest details
+guest = api.getguest(guest_id=789)
+print(f"Guest: {guest.first_name} {guest.last_name}")
+
+# Check if a property is currently booked
+is_booked = api.isunitbooked(property_id=123)
+print(f"Property is booked: {is_booked}")
+```
+
+## API Documentation
+
+### API Class Methods
+
+- `getproperties()` -> List[Property]
+  - Returns a list of all properties
+
+- `getproperty(property_id: int)` -> Property
+  - Get details for a specific property
+  - Parameters:
+    - property_id: The property ID
+
+- `getbookings(property_id: int, since_utc: datetime)` -> List[Booking]
+  - Get bookings for a specific property since a given date
+  - Parameters:
+    - property_id: The property ID
+    - since_utc: DateTime object for the start date
+
+- `getbooking(booking_id: int)` -> Booking
+  - Get details for a specific booking
+  - Parameters:
+    - booking_id: The booking ID
+
+- `getguest(guest_id: int)` -> Guest
+  - Get details for a specific guest
+  - Parameters:
+    - guest_id: The guest ID
+
+- `isunitbooked(property_id: int)` -> bool
+  - Check if a property is currently booked
+  - Parameters:
+    - property_id: The property ID
+
+### Data Models
+
+The API returns strongly-typed objects that provide a rich interface to the OwnerRez data. For detailed documentation of all data models, including all available fields and usage examples, see [Data Models Documentation](docs/models.md).
+
+Main models:
+- `Property`: Contains property details (id, name, bedrooms, etc.)
+- `Booking`: Contains booking information (arrival, departure, guest, etc.)
+- `Guest`: Contains guest information (name, contact details, etc.)
+
+Supporting models:
+- `Address`: Physical address information
+- `EmailAddress`: Email contact information
+- `Phone`: Phone contact information
+- `Charge`: Booking charge information
+- `DoorCode`: Property access codes
+
+## CLI Tool (for testing)
+
+A command-line interface is included for testing and debugging. You can provide credentials via environment variables or a `.env` file:
+
+```bash
+# Using .env file
+echo "OWNERREZ_USERNAME=your_username" > .env
+echo "OWNERREZ_TOKEN=your_token" >> .env
+
+# List properties
+ownerrez properties
+
+# Get property details
+ownerrez property 123
+
+# Check bookings
+ownerrez bookings 123 --since 2024-01-01
+
+# Get booking details
+ownerrez booking 456
+```
+
+## Development
+
+To set up the development environment:
+
+```bash
+git clone https://github.com/gmoorevt/ownerrez-wrapper.git
+cd ownerrez-wrapper
+pip install -e ".[dev]"
+```
+
+To run tests:
+
+```bash
+pytest
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Author
+
+- Geody Moore (geody.moore@gmail.com)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

ownerrez_wrapper-0.1.0/ownerrez_wrapper.egg-info/SOURCES.txt

@@ -0,0 +1,21 @@
+LICENSE
+MANIFEST.in
+README.md
+requirements-dev.txt
+requirements.txt
+setup.py
+ownerrez_wrapper/__init__.py
+ownerrez_wrapper/api.py
+ownerrez_wrapper/cli.py
+ownerrez_wrapper/constants.py
+ownerrez_wrapper/exceptions.py
+ownerrez_wrapper/model.py
+ownerrez_wrapper/restAdapter.py
+ownerrez_wrapper.egg-info/PKG-INFO
+ownerrez_wrapper.egg-info/SOURCES.txt
+ownerrez_wrapper.egg-info/dependency_links.txt
+ownerrez_wrapper.egg-info/entry_points.txt
+ownerrez_wrapper.egg-info/requires.txt
+ownerrez_wrapper.egg-info/top_level.txt
+tests/__init__.py
+tests/test_api.py

ownerrez_wrapper-0.1.0/ownerrez_wrapper.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ownerrez_wrapper-0.1.0/ownerrez_wrapper.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ownerrez = ownerrez_wrapper.cli:main

ownerrez_wrapper-0.1.0/ownerrez_wrapper.egg-info/requires.txt

@@ -0,0 +1,12 @@
+requests>=2.25.0
+python-dateutil>=2.8.0
+python-dotenv>=1.0.0
+
+[dev]
+pytest>=6.0.0
+pytest-cov>=2.0.0
+black>=22.0.0
+isort>=5.0.0
+flake8>=3.9.0
+mypy>=0.900
+freezegun>=1.2.0

ownerrez_wrapper-0.1.0/ownerrez_wrapper.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+ownerrez_wrapper
+tests

ownerrez_wrapper-0.1.0/requirements-dev.txt

@@ -0,0 +1,9 @@
+-r requirements.txt
+pytest>=6.0.0
+pytest-cov>=2.0.0
+black>=22.0.0
+isort>=5.0.0
+flake8>=3.9.0
+mypy>=0.900
+build>=0.7.0
+twine>=3.4.2

ownerrez_wrapper-0.1.0/requirements.txt

@@ -0,0 +1,2 @@
+requests>=2.25.0
+python-dateutil>=2.8.0

ownerrez_wrapper-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ownerrez_wrapper-0.1.0/setup.py

@@ -0,0 +1,48 @@
+from setuptools import setup, find_packages
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setup(
+    name="ownerrez-wrapper",
+    version="0.1.0",
+    author="Geody Moore",
+    author_email="geody.moore@gmail.com",
+    description="A Python wrapper for the OwnerRez API",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/gmoorevt/ownerrez-wrapper",
+    packages=find_packages(),
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+    ],
+    python_requires=">=3.10",
+    install_requires=[
+        "requests>=2.25.0",
+        "python-dateutil>=2.8.0",
+        "python-dotenv>=1.0.0"
+    ],
+    extras_require={
+        "dev": [
+            "pytest>=6.0.0",
+            "pytest-cov>=2.0.0",
+            "black>=22.0.0",
+            "isort>=5.0.0",
+            "flake8>=3.9.0",
+            "mypy>=0.900",
+            "freezegun>=1.2.0"
+        ]
+    },
+    entry_points={
+        'console_scripts': [
+            'ownerrez=ownerrez_wrapper.cli:main',
+        ],
+    },
+)

ownerrez_wrapper-0.1.0/tests/test_api.py

@@ -0,0 +1,124 @@
+"""
+Tests for the OwnerRez API wrapper
+"""
+import pytest
+from datetime import datetime
+from freezegun import freeze_time
+from ownerrez_wrapper.api import API
+from ownerrez_wrapper.model import Result, Property, Booking, Guest
+
+@pytest.fixture
+def api():
+    """Create an API instance for testing"""
+    return API(username="test_user", token="test_token")
+
+@pytest.fixture
+def mock_property_response():
+    return {
+        "items": [{
+            "id": 1,
+            "name": "Test Property",
+            "bedrooms": 3,
+            "bathrooms": 2,
+            "active": True
+        }]
+    }
+
+@pytest.fixture
+def mock_booking_response():
+    return {
+        "items": [{
+            "id": 1,
+            "property_id": 1,
+            "arrival": "2024-03-01",
+            "departure": "2024-03-05",
+            "status": "confirmed",
+            "guest_id": 1
+        }]
+    }
+
+@pytest.fixture
+def mock_guest_response():
+    return {
+        "id": 1,
+        "first_name": "John",
+        "last_name": "Doe",
+        "email_addresses": [{"address": "john@example.com", "is_default": True}]
+    }
+
+def test_api_initialization(api):
+    """Test API initialization"""
+    assert api.username == "test_user"
+    assert api.token == "test_token"
+
+def test_getproperties(api, mock_property_response, monkeypatch):
+    def mock_get(*args, **kwargs):
+        return Result(status=200, message="OK", data=mock_property_response)
+    
+    monkeypatch.setattr("ownerrez_wrapper.restAdapter.RestAdapter.get", mock_get)
+    
+    properties = api.getproperties()
+    assert len(properties) == 1
+    assert isinstance(properties[0], Property)
+    assert properties[0].id == 1
+    assert properties[0].name == "Test Property"
+
+def test_getbookings(api, mock_booking_response, monkeypatch):
+    def mock_get(*args, **kwargs):
+        return Result(status=200, message="OK", data=mock_booking_response)
+    
+    monkeypatch.setattr("ownerrez_wrapper.restAdapter.RestAdapter.get", mock_get)
+    
+    bookings = api.getbookings(property_id=1, since_utc=datetime(2024, 1, 1))
+    assert len(bookings) == 1
+    assert isinstance(bookings[0], Booking)
+    assert bookings[0].id == 1
+    assert bookings[0].property_id == 1
+
+def test_getbooking(api, monkeypatch):
+    booking_data = {
+        "id": 1,
+        "property_id": 1,
+        "arrival": "2024-03-01",
+        "departure": "2024-03-05"
+    }
+    
+    def mock_get(*args, **kwargs):
+        return Result(status=200, message="OK", data=booking_data)
+    
+    monkeypatch.setattr("ownerrez_wrapper.restAdapter.RestAdapter.get", mock_get)
+    
+    booking = api.getbooking(booking_id=1)
+    assert isinstance(booking, Booking)
+    assert booking.id == 1
+    assert booking.property_id == 1
+
+def test_getguest(api, mock_guest_response, monkeypatch):
+    def mock_get(*args, **kwargs):
+        return Result(status=200, message="OK", data=mock_guest_response)
+    
+    monkeypatch.setattr("ownerrez_wrapper.restAdapter.RestAdapter.get", mock_get)
+    
+    guest = api.getguest(guest_id=1)
+    assert isinstance(guest, Guest)
+    assert guest.id == 1
+    assert guest.first_name == "John"
+    assert guest.last_name == "Doe"
+
+@freeze_time("2024-03-03")  # A date between arrival and departure
+def test_isunitbooked(api, mock_booking_response, monkeypatch):
+    def mock_get(*args, **kwargs):
+        return Result(status=200, message="OK", data=mock_booking_response)
+    
+    monkeypatch.setattr("ownerrez_wrapper.restAdapter.RestAdapter.get", mock_get)
+    is_booked = api.isunitbooked(property_id=1)
+    assert is_booked is True
+
+@freeze_time("2024-03-06")  # A date after departure
+def test_isunitbooked_not_booked(api, mock_booking_response, monkeypatch):
+    def mock_get(*args, **kwargs):
+        return Result(status=200, message="OK", data=mock_booking_response)
+    
+    monkeypatch.setattr("ownerrez_wrapper.restAdapter.RestAdapter.get", mock_get)
+    is_booked = api.isunitbooked(property_id=1)
+    assert is_booked is False