Stitchcredit-users-api NPM

stitchcredit-users-api

StitchCreditApi - JavaScript client for stitchcredit-users-api This SDK is automatically generated by the OpenAPI Generator project:

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 stitchcredit-users-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 stitch_credit_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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:

import { UserControllerApi } from 'stitchcredit-users-api';
const usersApi = new UserControllerApi();

// This will initialize SDK and configure Bearer (JWT) access token for authorization: accessToken
await usersApi.exchangePreauthToken({{token}});


/* 
Call StitchCredit Users API's methods
  1. Example - get efx latest report
  2. Example - get efx latest reporty summary
*/

const res = await usersApi.efxLatestReport();
const res = await usersApi.efxLatestReportSummary();

Documentation for API Endpoints

All URIs are relative to https://efx-dev.stitchcredit.com/api

Class	Method	HTTP request
StitchCreditApi.UserControllerApi	changeNotifications	POST /users/change-notifications
StitchCreditApi.UserControllerApi	changePassword	POST /users/change-password
StitchCreditApi.UserControllerApi	changeRecovery	POST /users/change-recovery
StitchCreditApi.UserControllerApi	changeUserEmail	POST /users/change-email
StitchCreditApi.UserControllerApi	closeUserAccount	POST /users/close-account
StitchCreditApi.UserControllerApi	efxLatestReport	GET /users/efx-latest-report
StitchCreditApi.UserControllerApi	efxLatestReportSummary	GET /users/efx-latest-report/summary
StitchCreditApi.UserControllerApi	exchangePreauthToken	GET /users/preauth-token/{token}
StitchCreditApi.UserControllerApi	getActionToken	POST /users/action-token
StitchCreditApi.UserControllerApi	getEfxAlerts	GET /users/efx-alerts
StitchCreditApi.UserControllerApi	getEfxConfig	GET /users/efx-config
StitchCreditApi.UserControllerApi	getEfxLatestEFXScore	GET /users/efx-latest-efx-score
StitchCreditApi.UserControllerApi	getEfxLatestScores	GET /users/efx-latest-scores
StitchCreditApi.UserControllerApi	getEfxScoreHistory	GET /users/efx-score-history
StitchCreditApi.UserControllerApi	getEfxScores	GET /users/efx-scores
StitchCreditApi.UserControllerApi	getIdentityQuiz	GET /users/get-quiz
StitchCreditApi.UserControllerApi	getMobileAuthorization	GET /users/get-mobile
StitchCreditApi.UserControllerApi	getUser	GET /users
StitchCreditApi.UserControllerApi	initialize	GET /users/initialize
StitchCreditApi.UserControllerApi	initializeWithKey	GET /users/initialize/{key}
StitchCreditApi.UserControllerApi	loginUser	POST /users/login
StitchCreditApi.UserControllerApi	recoverPassword	POST /users/password-recovery
StitchCreditApi.UserControllerApi	recoveryQuestion	POST /users/recovery-token
StitchCreditApi.UserControllerApi	refreshUserToken	GET /users/refresh-token
StitchCreditApi.UserControllerApi	registerUser	POST /users/register
StitchCreditApi.UserControllerApi	renewMobileCode	POST /users/renew-code
StitchCreditApi.UserControllerApi	resetPassword	POST /users/password-reset
StitchCreditApi.UserControllerApi	sendMobileCode	POST /users/send-code/{token}
StitchCreditApi.UserControllerApi	setIdentity	POST /users/identity
StitchCreditApi.UserControllerApi	startUserSession	GET /users/start
StitchCreditApi.UserControllerApi	verifyIdentityQuiz	POST /users/verify-quiz
StitchCreditApi.UserControllerApi	verifyMobileCode	POST /users/verify-code

Documentation for Models

Documentation for Authorization

accessToken

Type: Bearer authentication (JWT)

@babel/cli superagent axios js-cookie jwt-decode

@everything-registry/sub-chunk-2827 @infinitebrahmanuniverse/nolb-sti

1.0.0

3 years ago