Metadata-Version: 2.1
Name: autobuy
Version: 3.0
Summary: An unofficial Python wrapper for the autobuy.io API
Home-page: https://github.com/jakestrouse00/AutoBuy.io-Python-Wrapper
Author: Jake Strouse
Author-email: jakestrouse00@gmail.com
License: UNKNOWN
Description: # Unofficial autobuy.io Python Wrapper
        An unofficial Python wrapper for the autobuy.io API
        
        ![Build Status](https://img.shields.io/badge/build-passing-brightgreen)
        
        ## Background Information
        AutoBuy.io is an e-commerce platform for merchants who sell digital items. AutoBuy.io is currently in open beta. You can visit AutoBuy.io [HERE](https://autobuy.io/ "AutoBuy.io Homepage")
        ## prerequisites
        requests==2.22.0
        
        ## Installation
        ```cmd
        python -m pip install autobuy
        ```
        ## Methods
        
        ### Get Methods
        
        #### Get order details
        Get the details of a specific order.
        ```python
        from autobuyWrapper.autobuy import Get
        
        GetMethod = Get(APIKey='2cdbdc48-b297-41ad-a234-329db0d2dbea')
        orderDetails = GetMethod.order(order='c1497823-370c-4c7a-82cd-dacddb36fc30')
        ```
         
         #### Get all orders
        Lists orders in descending order by creation date in pages of 10.
         ```python
        from autobuyWrapper.autobuy import Get
        
        GetMethod = Get(APIKey='2cdbdc48-b297-41ad-a234-329db0d2dbea')
        oders = GetMethod.orders(page='1')
        ```
        
        #### Get all products
        This will list all your products out along with the stocked product.
        ```python
        from autobuyWrapper.autobuy import Get
        
        GetMethod = Get(APIKey='2cdbdc48-b297-41ad-a234-329db0d2dbea')
        allProducts = GetMethod.products()
        ```
        
        
        #### Get product details
        Get a single product by ID.
        ```python
        from autobuyWrapper.autobuy import Get
        
        GetMethod = Get(APIKey='2cdbdc48-b297-41ad-a234-329db0d2dbea')
        allProducts = GetMethod.products(id='2cdbdc48-b297-41ad-a234-329db0d2dbea')
        ```
        
        ### Products
        
        #### Create product
        Creates a new product.
        
        Only four arguments are required. APIKey, name, description, productType. The rest of the arguments are optional. Optional arguments with default values are: unlisted=False, blockProxy=False, purchaseMax='100000', purchaseMin='1', webhookUrl=None, serials='', stockDelimiter=','. 
        ```python
        from autobuyWrapper.autobuy import Product
        ProductMethod = Product(APIKey='2cdbdc48-b297-41ad-a234-329db0d2dbea')
        # Use of Product.create() with only required arguments
        newProduct = ProductMethod.create(name='test12', description='just a test', price='9.99', productType='SerialNumber')
        ```
        
        
        #### Update product
        Updates a product by ID. This call requires all arguments to be present.
        
        ```python
        from autobuyWrapper.autobuy import Product
        
        ProductMethod = Product(APIKey='2cdbdc48-b297-41ad-a234-329db0d2dbea')
        updatedProduct = ProductMethod.update(id='2cdbdc48-b297-41ad-a234-329db0d2dbea', name='test13', description='updated description', price='8.99', productType='SerialNumber', unlisted=False, blockProxy=False, purchaseMax='100000', purchaseMin='1', webhookUrl='https://ptb.discordapp.com/api/webhooks/618938749723869205/wMjAX1okpWGuMvIScJXk2cU_r8D1qAiPty5W78vs9znoX254i1l7-8gYM4Ew_A3io0r8', serials='newAccount, newAccount2', stockDelimiter=',')
        ```
        
        
        #### Delete product
        Delete a product by ID.
        
        ```python
        from autobuyWrapper.autobuy import Product
        
        ProductMethod = Product(APIKey='2cdbdc48-b297-41ad-a234-329db0d2dbea')
        ProductMethod.delete(id='2cdbdc48-b297-41ad-a234-329db0d2dbea')
        ```
        
        #### Add stock to product
        Adds stock to a product. Only one item can be added per call. 
        ```python
        from autobuyWrapper.autobuy import Product
        
        ProductMethod = Product(APIKey='2cdbdc48-b297-41ad-a234-329db0d2dbea')
        updatedProduct = ProductMethod.addStock(id='2cdbdc48-b297-41ad-a234-329db0d2dbea', serial='email@email.com:randomPassword')
        ```
        
        To add multiple items to the product's stock, loop over a list of the items.
        
        ```python
        from autobuyWrapper.autobuy import Product
        
        ProductMethod = Product(APIKey='2cdbdc48-b297-41ad-a234-329db0d2dbea')
        items = ['serial1', 'serial2', 'serial3', 'serial4', 'serial5']
        for item in items:
            updatedProduct = ProductMethod.addStock(id='2cdbdc48-b297-41ad-a234-329db0d2dbea', serial=item)
        
        ```
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
