@edropin/store-isvc v1.0.1
e_dropin_store_internal
EDropinStoreInternal - JavaScript client for e_dropin_store_internal Store service for eDropin This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.11
- Package version: 1.0.11
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install e_dropin_store_internal --save
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
Finally, switch to the directory you want to use your e_dropin_store_internal from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('e_dropin_store_internal')
in javascript files from the directory you ran the last
command above from.
git
If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually
use this library):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var EDropinStoreInternal = require('e_dropin_store_internal');
var defaultClient = EDropinStoreInternal.ApiClient.instance;
// Configure API key authorization: ServiceKey
var ServiceKey = defaultClient.authentications['ServiceKey'];
ServiceKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ServiceKey.apiKeyPrefix['X-Service-Key'] = "Token"
var api = new EDropinStoreInternal.EsOrderItemsApi()
var body = new EDropinStoreInternal.EsOrderItemStatusUpdate(); // {EsOrderItemStatusUpdate} Order Item Status Update
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.updateOrderItemStatus(body, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost:9004
Class | Method | HTTP request | Description |
---|---|---|---|
EDropinStoreInternal.EsOrderItemsApi | updateOrderItemStatus | POST /order-items/update-status | Update status of order items. Useful for marking items as deleted if another service removes them. |
Documentation for Models
- EDropinStoreInternal.EsBaseId
- EDropinStoreInternal.EsCheckoutSurveyInput
- EDropinStoreInternal.EsDSPagination
- EDropinStoreInternal.EsDeleteItem
- EDropinStoreInternal.EsExchangeRate
- EDropinStoreInternal.EsInstallmentPlanInput
- EDropinStoreInternal.EsOrderItemPromotion
- EDropinStoreInternal.EsOrderItemStatus
- EDropinStoreInternal.EsOrderItemStatusUpdate
- EDropinStoreInternal.EsOrderUser
- EDropinStoreInternal.EsRefundRequest
- EDropinStoreInternal.EsSuccess
- EDropinStoreInternal.EsCheckoutSurvey
- EDropinStoreInternal.EsInstallmentPlan
- EDropinStoreInternal.EsOrderItem
- EDropinStoreInternal.EsRefund
Documentation for Authorization
ServiceKey
- Type: API key
- API key parameter name: X-Service-Key
- Location: HTTP header