viu_accounts_api v1.0.0

viu_accounts_api

ViuAccountsApi - JavaScript client for viu_accounts_api No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• 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 viu_accounts_api --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 viu_accounts_api 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 ViuAccountsApi = require('viu_accounts_api');

var defaultClient = ViuAccountsApi.ApiClient.instance;
// Configure API key authorization: okta
var okta = defaultClient.authentications['okta'];
okta.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//okta.apiKeyPrefix['Authorization'] = "Token"

var api = new ViuAccountsApi.ContactsApi()
var opts = {
  'sessionId': "sessionId_example", // {String} session id for user
  'xViuUser': "xViuUser_example" // {String} User id
};
api.authstatuses(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://viuh-account-api-dev-eastus2-apps.viu-account-dev-eastus2-ase.appserviceenvironment.net/api/v1

Documentation for Models

• ViuAccountsApi.AddExternalPolicy
• ViuAccountsApi.Address
• ViuAccountsApi.ApiError
• ViuAccountsApi.BoundPolicy
• ViuAccountsApi.Carrier
• ViuAccountsApi.CarrierIdAuthStatus
• ViuAccountsApi.Consent
• ViuAccountsApi.DeprecatedConsentToken
• ViuAccountsApi.Document
• ViuAccountsApi.Location
• ViuAccountsApi.MfaResponse
• ViuAccountsApi.OktaAccountCreation
• ViuAccountsApi.OktaAccountReactivation
• ViuAccountsApi.OktaLastSession
• ViuAccountsApi.OktaNewSession
• ViuAccountsApi.OktaPasswordChange
• ViuAccountsApi.OktaPasswordReset
• ViuAccountsApi.OktaSessionLocation
• ViuAccountsApi.Policies
• ViuAccountsApi.Quote
• ViuAccountsApi.QuoteHydration
• ViuAccountsApi.UserCreationError
• ViuAccountsApi.UserInfo
• ViuAccountsApi.ViuContactAuthStatuses
• ViuAccountsApi.ViuContactExtended
• ViuAccountsApi.ViuContactID
• ViuAccountsApi.ViuLead
• ViuAccountsApi.ViuLeadId
• ViuAccountsApi.ViuPartnerSeralizer
• ViuAccountsApi.ViuSPLead

Documentation for Authorization

okta

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header