All API Classes should extend this base class. This base class will hold the common variables and setup any custom logging logic.

Need to populate API documentation for NewStoreConnector

Refund (V1.0.0

https://docs.newstore.net/api/integration/payments/refund_request_api_v1

Handler Property: NewStoreConnector.refund

Special Requirements

• None

Customer Profile API (1.0.0)

https://docs.newstore.net/api/integration/customer/consumer_profile_api_v1

Handler Property: NewStoreConnector.customer_profile

Special Requirements

• V1.0.0 Is Done for compatibility

Class should take in a tenant, stage (optional) and either a User Name and Password OR a valid API key.

NewStoreConnector class should also act as a constructor for specific API connector classes.

Item Return (v0.1)

https://docs.newstore.net/api/integration/order-management/item_return_api

Handler Property: NewStoreConnector.return

Special Requirements

• None

Order Information

https://docs.newstore.net/api/integration/order-management/sales_order_api

Handler Property: NewStoreConnector.order_information

Special Requirements

• None

Data Provisioning Graphql Query

https://docs.newstore.net/api/integration/eventstream-graphql/graphql_postgraphile_api_api

Handler parameter: NewStoreConnector.graphql

Special Requirements

• None

The logging Handler should collect all logging levels and store them in an instance variable. This way the logs can be accessed in the event of an error with additional debug information and the debug information won't clog up the logs.

Need to create a handler for the NewStore Order Notes API

This handler should be accessed the the NewStoreConnector.order_notes property

Customer Profile API (V2)

https://docs.p.newstore.partners/#/http/customers/customer-profiles/show-profile

Handler Property: NewStoreConnector.customer_profile

Special Requirements

• Should be set to the default Version
• Custom Profile Address should be set as a Sub class from the customer_profile class using a handler structured like the NewStoreConnector Handler.

Create the documentation for the order_injection module

Item Return API

https://docs.newstore.net/api/integration/order-management/item_return_api

Handler Property: NewStoreConnector.returns

Special Requirements

• Should be default
• Should include Endpoints for List returns for order and Get return. This should be done by also initializing an instance of the v0.1 connector in v2 and passing those functions to the list returns and get returns methods

Create the developer reference documentation for the order_notes module

Contributing guide should include instructions for creating API classes, how to populate the handlers in the NewStoreConnector class, Setting up tests and Calculating code coverage.

Need to fill out the README.md with the project information

Need to create documentation template for documenting the modules.

Need to come up with a way to automatically migrate requests from old API to new API versions if they are able to be migrated automatically.

If the FORMAT of the data hasn't changed, OR if a simple data formatting change has been made, IE, a field tool in a float, but now requires the field to be formatted as a string.

~~I think this can be done with the idea of using the NewStoreConnector class as the entry point for each groups specific version class. An intermediate check will need to be done to see if the payload versions can be automatically transformed, if they can, it will register the transformation method used to change the payload. Then the new version should be used and the transformation method called on the payload before it is sent. ~~
This can probably be done with a decorator at the method level. This would allow a modification function and the new endpoint to be passed. Doing it at the method level will allow more finite control.

In the event the transformation fails, the original API version should be used to attempt completion. The process should also allow for a keyword argument to be passed, like allow_upgrade = False to bypass that modification.

In any case, a warning should be raised that either the new API version was used and the code needs to be updated, or a new version is available and code should be updated when able.

The TTL time for the token is needed for caching access tokens in a centra manager. This is needed for another project.

Need to create an Issue Template for API Requests

Location API

https://docs.newstore.net/api/integration/order-management/location_api

Handler Property: NewStoreConnector.location

Special Requirements

• None