Metadata-Version: 2.1
Name: singapore_bullion_retailers
Version: 0.0.5
Summary: A package for accessing Singapore bullion retailers API
Author-email: Chad Lim Jin Jie <chadlimjinjie@gmail.com>
Project-URL: Homepage, https://github.com/chadlimjinjie/singapore_bullion_retailers
Project-URL: Issues, https://github.com/chadlimjinjie/singapore_bullion_retailers/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

  # Singapore Bullion Retailers API

Programmatic functions for accessing Singapore bullion retailers API


BullionStar Singapore https://www.bullionstar.com/developer/docs/api/


```python
# import the module
from bullion import BullionStar
```

BullionStar Object

```python
# Creates a http session
bullionstar_client = BullionStar(cuurency='SGD', locationId=1)
```

Authentication API
- Initialize Authentication
```python
authToken, salt = bullionstar_client.initialize('example@example.com')
```
- Perform Authentication
```python
data_authenticate = bullionstar_client.authenticate(authToken, BullionStar.encryptPassword(salt, BullionStar.hashPassword(password)))
```
- Perform Two-factor Authentication
- Resend Two-factor Authentication Code
- Invalidate Access Token
```python
data_invalidate = bullionstar_client.invalidate()
```

Shopping Cart API
- Refresh Shopping Cart
- Add to Shopping Cart
- Update Shopping Cart (Unstable)
- Remove from Shopping Cart (Unstable)
- Load All Shopping Carts

Buy Checkout API (in-development)
- Initialize Order
- Update Order
- Confirm Order
- Confirm Order and Create Account

Silver Bullion Singapore Stargrams (Development on hold)
- Login function

Silver Bullion Singapore (Development on hold)
- Login function (TODO)

Roadmap
- Retailers onboarding
- To release as a python package on PyPi
- Looking for passionate maintainers
