-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from beckf/ls-new-api
updated for api v3
- Loading branch information
Showing
8 changed files
with
92 additions
and
88 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,77 +1,12 @@ | ||
Metadata-Version: 2.1 | ||
Name: lightspeed-api | ||
Version: 0.1 | ||
Version: 0.3 | ||
Summary: Simple library for interacting with the Lightspeed HQ API | ||
Home-page: https://github.com/beckf/lightspeed_api | ||
Author: Forrest Beck | ||
Author-email: [email protected] | ||
License: MIT License | ||
Download-URL: https://github.com/beckf/lightspeed_api/archive/v.01.tar.gz | ||
Description: # Lightspeed HQ API Python Library | ||
Gives easy access to the Lightspeed retail point of sale api. | ||
|
||
To use create a new object with settings in a dictionary. Then just specify | ||
the endpoints and paramaters in your request. | ||
|
||
For API documentation see: https://developers.lightspeedhq.com/retail/introduction/introduction/ | ||
|
||
Some examples of uses: | ||
|
||
```python | ||
# Create a new dictionary with some settings that we will need. | ||
import lightspeed_api | ||
|
||
c = {'account_id': '12345678', | ||
'client_id': 'developer_client_id', | ||
'client_secret': 'developer_client_secret', | ||
'refresh_token': 'special_refresh_token' | ||
} | ||
|
||
ls = lightspeed_api.Lightspeed(c) | ||
|
||
# Get a customer record | ||
ls.get('Customer/1234') | ||
|
||
# Delete a customer by id number | ||
ls.delete('Customer/1234') | ||
|
||
# Create a new customer | ||
formatted = {'Customer': | ||
{'firstName': 'Joe', | ||
'lastName': 'Smith', | ||
'companyRegistrationNumber': '1234', | ||
'customerTypeID': 1, | ||
'Contact': { | ||
'custom': '', | ||
'noEmail': 'false', | ||
'noPhone': 'false', | ||
'noMail': 'false', | ||
'Emails': { | ||
'ContactEmail': { | ||
'address': '[email protected]', | ||
'useType': 'Primary' | ||
} | ||
}, | ||
'Addresses': { | ||
'ContactAddress': { | ||
'address1': '1212 Street Drive', | ||
'address2': '', | ||
'city': 'New York', | ||
'state': 'New York', | ||
'zip': '12345', | ||
'country': 'USA', | ||
'countryCode': '', | ||
'stateCode': '' | ||
} | ||
} | ||
}, | ||
} | ||
} | ||
ls.create("Customer", formatted["Customer"]) | ||
|
||
|
||
|
||
``` | ||
Download-URL: https://github.com/beckf/lightspeed_api/archive/v.03.tar.gz | ||
Keywords: Lightspeed,HQ,API,POS | ||
Platform: UNKNOWN | ||
Classifier: Development Status :: 5 - Production/Stable | ||
|
@@ -83,4 +18,74 @@ Classifier: Programming Language :: Python :: 3.4 | |
Classifier: Programming Language :: Python :: 3.5 | ||
Classifier: Programming Language :: Python :: 3.6 | ||
Classifier: Programming Language :: Python :: 3.7 | ||
Classifier: Programming Language :: Python :: 3.10 | ||
Description-Content-Type: text/markdown | ||
|
||
# Lightspeed HQ API Python Library | ||
**Updated for Lightspeed API V3** | ||
|
||
Gives easy access to the Lightspeed retail point of sale api. | ||
|
||
To use create a new object with settings in a dictionary. Then just specify | ||
the endpoints and parameters in your request. | ||
|
||
For API documentation see: https://developers.lightspeedhq.com/retail/introduction/introduction/ | ||
|
||
Some examples of uses: | ||
|
||
```python | ||
# Create a new dictionary with some settings that we will need. | ||
import lightspeed_api | ||
|
||
c = {'account_id': '12345678', | ||
'client_id': 'developer_client_id', | ||
'client_secret': 'developer_client_secret', | ||
'refresh_token': 'special_refresh_token' | ||
} | ||
|
||
ls = lightspeed_api.Lightspeed(c) | ||
|
||
# Get a customer record | ||
ls.get('Customer/1234') | ||
|
||
# Delete a customer by id number | ||
ls.delete('Customer/1234') | ||
|
||
# Create a new customer | ||
formatted = {'Customer': | ||
{'firstName': 'Joe', | ||
'lastName': 'Smith', | ||
'companyRegistrationNumber': '1234', | ||
'customerTypeID': 1, | ||
'Contact': { | ||
'custom': '', | ||
'noEmail': 'false', | ||
'noPhone': 'false', | ||
'noMail': 'false', | ||
'Emails': { | ||
'ContactEmail': { | ||
'address': '[email protected]', | ||
'useType': 'Primary' | ||
} | ||
}, | ||
'Addresses': { | ||
'ContactAddress': { | ||
'address1': '1212 Street Drive', | ||
'address2': '', | ||
'city': 'New York', | ||
'state': 'New York', | ||
'zip': '12345', | ||
'country': 'USA', | ||
'countryCode': '', | ||
'stateCode': '' | ||
} | ||
} | ||
}, | ||
} | ||
} | ||
ls.create("Customer", formatted["Customer"]) | ||
|
||
|
||
|
||
``` | ||
|
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,15 +9,15 @@ | |
setup( | ||
name='lightspeed_api', | ||
packages=['lightspeed_api'], | ||
version='0.1', | ||
version='0.3', | ||
description='Simple library for interacting with the Lightspeed HQ API', | ||
long_description=long_description, | ||
long_description_content_type='text/markdown', | ||
license='MIT License', | ||
author='Forrest Beck', | ||
author_email='[email protected]', | ||
url='https://github.com/beckf/lightspeed_api', | ||
download_url='https://github.com/beckf/lightspeed_api/archive/v.01.tar.gz', | ||
download_url='https://github.com/beckf/lightspeed_api/archive/v.03.tar.gz', | ||
keywords=['Lightspeed', 'HQ','API', 'POS'], | ||
install_requires=['requests'], | ||
classifiers=[ | ||
|
@@ -29,6 +29,7 @@ | |
'Programming Language :: Python :: 3.4', | ||
'Programming Language :: Python :: 3.5', | ||
'Programming Language :: Python :: 3.6', | ||
'Programming Language :: Python :: 3.7' | ||
'Programming Language :: Python :: 3.7', | ||
'Programming Language :: Python :: 3.10' | ||
], | ||
) |