0a2691ea69 | ||
---|---|---|
.. | ||
.openapi-generator | ||
docs | ||
src | ||
test | ||
.babelrc | ||
.gitignore | ||
.openapi-generator-ignore | ||
.travis.yml | ||
README.md | ||
git_push.sh | ||
mocha.opts | ||
package.json |
README.md
sf_gate
SfGate - JavaScript client for sf_gate Customer Information Microservice This SDK is automatically generated by the OpenAPI Generator project:
- API version: 0.0.2
- Package version: 0.0.2
- Build package: org.openapitools.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 sf_gate --save
Finally, you need to build the module:
npm run build
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
To use the link you just defined in your project, switch to the directory you want to use your sf_gate from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
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):
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 SfGate = require('sf_gate');
var defaultClient = SfGate.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token"
var api = new SfGate.AccountsApi()
var opts = {
'accountId': "accountId_example" // {String} Taxnexus Record Id of an Account
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.deleteAccount(opts, callback);
Documentation for API Endpoints
All URIs are relative to http://sf-gate.vernonkeenan.com:8080/v1
Class | Method | HTTP request | Description |
---|---|---|---|
SfGate.AccountsApi | deleteAccount | DELETE /accounts | Delete An Account |
SfGate.AccountsApi | getAccounts | GET /accounts | Get a list of accounts |
SfGate.AccountsApi | postAccounts | POST /accounts | Add a new account to Taxnexus |
SfGate.AccountsApi | putAccount | PUT /accounts | Update a single account |
SfGate.ClustersApi | getClusters | GET /clusters | Get a list Clusters |
SfGate.ClustersApi | postClusters | POST /clusters | Create new Clusters |
SfGate.ClustersApi | putClusters | PUT /clusters | Update Clusters |
SfGate.ContactsApi | getContacts | GET /contacts | Get a Contact record |
SfGate.ContactsApi | postContacts | POST /contacts | Add a new Contacts to Taxnexus |
SfGate.ContractsApi | getContracts | GET /contracts | Get a list of contracts |
SfGate.ContractsApi | postContracts | POST /contracts | Add a new contract to Taxnexus |
SfGate.DatabasesApi | getDatabases | GET /databases | Get a list Databases |
SfGate.DatabasesApi | postDatabases | POST /databases | Create new Databases |
SfGate.DatabasesApi | putDatabases | PUT /databases | Update Databases |
SfGate.RolesApi | getRoles | GET /roles | Get a list of Roles |
SfGate.TemplatesApi | getTemplates | GET /templates | Get PDF Rendering Templates |
SfGate.TenantsApi | getTenants | GET /tenants | Get a list Tenants |
SfGate.TenantsApi | putTenants | PUT /tenants | Update Tenants |
SfGate.TenantsApi | tenants | POST /tenants | Create new Tenants |
SfGate.UsersApi | getUsers | GET /users | Get a list Users |
Documentation for Models
- SfGate.Account
- SfGate.AccountRequest
- SfGate.AccountResponse
- SfGate.Address
- SfGate.Cluster
- SfGate.ClusterRequest
- SfGate.ClusterResponse
- SfGate.Contact
- SfGate.ContactRequest
- SfGate.ContactResponse
- SfGate.Contract
- SfGate.ContractRequest
- SfGate.ContractResponse
- SfGate.Database
- SfGate.DatabaseRequest
- SfGate.DatabaseResponse
- SfGate.DeleteResponse
- SfGate.Error
- SfGate.InvalidError
- SfGate.InvalidErrorAllOf
- SfGate.Message
- SfGate.Pagination
- SfGate.RequestMeta
- SfGate.ResponseMeta
- SfGate.Role
- SfGate.RoleRequest
- SfGate.RoleResponse
- SfGate.Template
- SfGate.TemplateResponse
- SfGate.Tenant
- SfGate.TenantRequest
- SfGate.TenantResponse
- SfGate.TenantUser
- SfGate.User
- SfGate.UserResponse
- SfGate.UserRole
Documentation for Authorization
ApiKeyAuth
- Type: API key
- API key parameter name: X-API-Key
- Location: HTTP header