# stitchcredit-direct-api

> StitchCredit Direct API

Latest version **1.0.9** (published 2021-10-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install stitchcredit-direct-api
pnpm add stitchcredit-direct-api
yarn add stitchcredit-direct-api
bun add stitchcredit-direct-api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.9 |
| Published | 2021-10-19 |
| First published | 2021-10-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 428.8 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | tarikneradin |

## Links

- npm: https://www.npmjs.com/package/stitchcredit-direct-api
- npm.io page: https://npm.io/package/stitchcredit-direct-api

## Dependencies (4)

- [axios](https://npm.io/package/axios.md) ^0.23.0
- [@babel/cli](https://npm.io/package/@babel/cli.md) ^7.0.0
- [jwt-decode](https://npm.io/package/jwt-decode.md) ^3.1.2
- [superagent](https://npm.io/package/superagent.md) ^5.3.0

## Recent versions

- 1.0.9 (latest) — 2021-10-19
- 1.0.8 — 2021-10-19
- 1.0.7 — 2021-10-19
- 1.0.6 — 2021-10-19
- 1.0.5 — 2021-10-19
- 1.0.4 — 2021-10-19
- 1.0.1 — 2021-10-19
- 1.0.0 — 2021-10-18

## README

# stitchcredit-direct-api

StitchCreditApi - JavaScript client for stitchcredit-direct-api
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

```shell
npm install stitchcredit-direct-api --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:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
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:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
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:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var StitchCreditApi = require('stitchcredit-direct-api');


 const loginPayload = {
        apikey: {{API_KEY}},
        secret: {{SECRET},
        env: {{ENV}}
      };


// This will initialize SDK and configure Bearer (JWT) access token for authorization: accessToken
const directApi = new StitchCreditApi.DirectControllerApi();
const response = await directApi.login(loginPayload);

/* 
Call StitchCredit Direct API's methods
  1. Example - get user info
  2. Example - register user
*/

// get user info
const userId = {{USER_ID}};
const response = await directApi.getUser(userId);

//register user
const { DirectUserRegReqDTO } = require('stitchcredit-direct-api');

const registerUserReq = new DirectUserRegReqDTO({{EMAIL}}, {{F_NAME}}, {{L_NAME}}); 
const response = await directApi.register(registerUserReq);

//following syntax can be used too
  directApi.register(registerUserReq).then(function() {
    console.log('Do something with response: ', response);
  }, function(error) {
    console.error(error);
  });


```

## Documentation for API Endpoints

All URIs are relative to *{{BASE_URL}}/api*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*StitchCreditApi.DirectControllerApi* | [**changeEmail**](docs/DirectControllerApi.md#changeEmail) | **POST** /direct/change-email/{id} | 
*StitchCreditApi.DirectControllerApi* | [**changeHost**](docs/DirectControllerApi.md#changeHost) | **POST** /direct/change-host/{id} | 
*StitchCreditApi.DirectControllerApi* | [**changeMobile**](docs/DirectControllerApi.md#changeMobile) | **POST** /direct/change-mobile/{id} | 
*StitchCreditApi.DirectControllerApi* | [**closeAccount**](docs/DirectControllerApi.md#closeAccount) | **POST** /direct/close-account/{id} | 
*StitchCreditApi.DirectControllerApi* | [**efxAlert**](docs/DirectControllerApi.md#efxAlert) | **GET** /direct/efx-alert/{id} | 
*StitchCreditApi.DirectControllerApi* | [**efxConfig**](docs/DirectControllerApi.md#efxConfig) | **GET** /direct/efx-config/{id} | 
*StitchCreditApi.DirectControllerApi* | [**efxLatestEFXScore**](docs/DirectControllerApi.md#efxLatestEFXScore) | **GET** /direct/efx-latest-efx-score/{id} | 
*StitchCreditApi.DirectControllerApi* | [**efxLatestReport**](docs/DirectControllerApi.md#efxLatestReport) | **GET** /direct/efx-latest-report/{id} | 
*StitchCreditApi.DirectControllerApi* | [**efxLatestReportSummary**](docs/DirectControllerApi.md#efxLatestReportSummary) | **GET** /direct/efx-latest-report/{id}/summary | 
*StitchCreditApi.DirectControllerApi* | [**efxLatestScores**](docs/DirectControllerApi.md#efxLatestScores) | **GET** /direct/efx-latest-scores/{id} | 
*StitchCreditApi.DirectControllerApi* | [**efxScoreHistory**](docs/DirectControllerApi.md#efxScoreHistory) | **GET** /direct/efx-score-history/{id} | 
*StitchCreditApi.DirectControllerApi* | [**efxScores**](docs/DirectControllerApi.md#efxScores) | **GET** /direct/efx-scores/{id} | 
*StitchCreditApi.DirectControllerApi* | [**getEfxAlerts**](docs/DirectControllerApi.md#getEfxAlerts) | **GET** /direct/efx-alerts/{id} | 
*StitchCreditApi.DirectControllerApi* | [**getUser**](docs/DirectControllerApi.md#getUser) | **GET** /direct/user/{id} | 
*StitchCreditApi.DirectControllerApi* | [**login**](docs/DirectControllerApi.md#login) | **POST** /direct/login | 
*StitchCreditApi.DirectControllerApi* | [**preauthToken**](docs/DirectControllerApi.md#preauthToken) | **GET** /direct/preauth-token/{id} | 
*StitchCreditApi.DirectControllerApi* | [**refreshToken**](docs/DirectControllerApi.md#refreshToken) | **GET** /direct/refresh-token | 
*StitchCreditApi.DirectControllerApi* | [**register**](docs/DirectControllerApi.md#register) | **POST** /direct/user-reg | 
*StitchCreditApi.DirectControllerApi* | [**registerOld**](docs/DirectControllerApi.md#registerOld) | **POST** /direct/register | 
*StitchCreditApi.DirectControllerApi* | [**updateRefresh**](docs/DirectControllerApi.md#updateRefresh) | **POST** /direct/update-refresh/{id} | 
*StitchCreditApi.DirectControllerApi* | [**userTokenOld**](docs/DirectControllerApi.md#userTokenOld) | **GET** /direct/user-token/{id} | 


## Documentation for Models

 - [StitchCreditApi.AlertRespDTO](docs/AlertRespDTO.md)
 - [StitchCreditApi.BankruptcyReport](docs/BankruptcyReport.md)
 - [StitchCreditApi.CodeDescriptionReport](docs/CodeDescriptionReport.md)
 - [StitchCreditApi.CollectionItemReport](docs/CollectionItemReport.md)
 - [StitchCreditApi.ConsumerStatementReport](docs/ConsumerStatementReport.md)
 - [StitchCreditApi.ContactInformationReport](docs/ContactInformationReport.md)
 - [StitchCreditApi.CountryReport](docs/CountryReport.md)
 - [StitchCreditApi.CreditMonitoringAlertAbstract](docs/CreditMonitoringAlertAbstract.md)
 - [StitchCreditApi.CreditReportAccountReport](docs/CreditReportAccountReport.md)
 - [StitchCreditApi.CreditReportProviderDisputeInformationReport](docs/CreditReportProviderDisputeInformationReport.md)
 - [StitchCreditApi.CreditReportProviderViewReport](docs/CreditReportProviderViewReport.md)
 - [StitchCreditApi.CreditReportReport](docs/CreditReportReport.md)
 - [StitchCreditApi.CreditReportSummaryAccountsReport](docs/CreditReportSummaryAccountsReport.md)
 - [StitchCreditApi.CreditReportSummaryReport](docs/CreditReportSummaryReport.md)
 - [StitchCreditApi.CreditScoreAbstractScore](docs/CreditScoreAbstractScore.md)
 - [StitchCreditApi.CreditScoreHistoryProviderViewScore](docs/CreditScoreHistoryProviderViewScore.md)
 - [StitchCreditApi.CreditScoreHistoryScore](docs/CreditScoreHistoryScore.md)
 - [StitchCreditApi.CreditScoreLoanRiskRangeReport](docs/CreditScoreLoanRiskRangeReport.md)
 - [StitchCreditApi.CreditScoreLoanRiskRangeScore](docs/CreditScoreLoanRiskRangeScore.md)
 - [StitchCreditApi.CreditScoreProviderViewScore](docs/CreditScoreProviderViewScore.md)
 - [StitchCreditApi.CreditScoreRangeReport](docs/CreditScoreRangeReport.md)
 - [StitchCreditApi.CreditScoreRangeScore](docs/CreditScoreRangeScore.md)
 - [StitchCreditApi.CreditScoreReasonReport](docs/CreditScoreReasonReport.md)
 - [StitchCreditApi.CreditScoreReasonScore](docs/CreditScoreReasonScore.md)
 - [StitchCreditApi.CreditScoreReport](docs/CreditScoreReport.md)
 - [StitchCreditApi.CreditScoreScore](docs/CreditScoreScore.md)
 - [StitchCreditApi.DirectChangeEmailReqDTO](docs/DirectChangeEmailReqDTO.md)
 - [StitchCreditApi.DirectChangeMobileReqDTO](docs/DirectChangeMobileReqDTO.md)
 - [StitchCreditApi.DirectLoginReqDTO](docs/DirectLoginReqDTO.md)
 - [StitchCreditApi.DirectUserRegReqDTO](docs/DirectUserRegReqDTO.md)
 - [StitchCreditApi.EfxConfigRespDTO](docs/EfxConfigRespDTO.md)
 - [StitchCreditApi.EmployerReport](docs/EmployerReport.md)
 - [StitchCreditApi.InquiryReport](docs/InquiryReport.md)
 - [StitchCreditApi.InternationalAddressReport](docs/InternationalAddressReport.md)
 - [StitchCreditApi.InternationalPhoneReport](docs/InternationalPhoneReport.md)
 - [StitchCreditApi.JudgmentReport](docs/JudgmentReport.md)
 - [StitchCreditApi.LienReport](docs/LienReport.md)
 - [StitchCreditApi.LoginRespDTO](docs/LoginRespDTO.md)
 - [StitchCreditApi.MoneyReport](docs/MoneyReport.md)
 - [StitchCreditApi.PaymentHistoryMonthReport](docs/PaymentHistoryMonthReport.md)
 - [StitchCreditApi.PaymentHistoryYearReport](docs/PaymentHistoryYearReport.md)
 - [StitchCreditApi.PersonNameReport](docs/PersonNameReport.md)
 - [StitchCreditApi.PersonSubjectReport](docs/PersonSubjectReport.md)
 - [StitchCreditApi.PreauthTokenDTO](docs/PreauthTokenDTO.md)
 - [StitchCreditApi.PublicRecordsReport](docs/PublicRecordsReport.md)
 - [StitchCreditApi.TrendedDataHistoryReport](docs/TrendedDataHistoryReport.md)
 - [StitchCreditApi.TrendedDataReport](docs/TrendedDataReport.md)
 - [StitchCreditApi.TrendedDataYearReport](docs/TrendedDataYearReport.md)
 - [StitchCreditApi.UserLoginRespDTO](docs/UserLoginRespDTO.md)
 - [StitchCreditApi.UserRespDTO](docs/UserRespDTO.md)


## Documentation for Authorization


### accessToken

- **Type**: Bearer authentication (JWT)

---
_Source: https://npm.io/package/stitchcredit-direct-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._