dovly_api

APIs_used_to_integrate_with_Dovly

Usage no npm install needed!

<script type="module">
  import dovlyApi from 'https://cdn.skypack.dev/dovly_api';
</script>

README

dovly_api

DovlyApi - JavaScript client for dovly_api APIs used to integrate with Dovly This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0
  • Package version: 1.0
  • Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen For more information, please visit https://www.dovly.com

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 dovly_api --save

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 DovlyApi = require('dovly_api');
var defaultClient = DovlyApi.ApiClient.instance;


var api = new DovlyApi.CreditsApi()
var opts = { 
  'userCognitoId': new DovlyApi.StringType() // {StringType} Cognito id to retrieves all credits alerts.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.creditalerts(opts, callback);

Documentation for API Endpoints

All URIs are relative to /

Class Method HTTP request Description
DovlyApi.CreditsApi creditalerts GET /credit/alerts
DovlyApi.CreditsApi creditreportreportId GET /credit/report/{report-id}
DovlyApi.CreditsApi creditreports GET /credit/reports
DovlyApi.DisputesApi deleteLetterCategories DELETE /disputes/letters/categories/{id}
DovlyApi.DisputesApi getAllDisputes GET /disputes
DovlyApi.DisputesApi getLetterCategories GET /disputes/letters/categories
DovlyApi.DisputesApi getReasons GET /disputes/reasons
DovlyApi.DisputesApi postLetterCategories POST /disputes/letters/categories
DovlyApi.DisputesApi putDispute PUT /disputes/{id}
DovlyApi.DisputesApi putLetterCategories PUT /disputes/letters/categories/{id}
DovlyApi.DisputesApi putSchedule PUT /disputes/schedule
DovlyApi.DocumentsApi deleteDocumentByUserId DELETE /users/documents/{id}
DovlyApi.DocumentsApi getDocuments GET /users/documents
DovlyApi.DocumentsApi getTypes GET /users/documents/types
DovlyApi.DocumentsApi saveDocuments POST /users/documents
DovlyApi.FunnelsApi deleteFunnel DELETE /funnels/{id}
DovlyApi.FunnelsApi deleteFunnelProducts DELETE /funnels/{id}/products/{product-id}
DovlyApi.FunnelsApi getFunnel GET /funnels/{id}
DovlyApi.FunnelsApi getFunnelProduct GET /funnels/{id}/products/{product-id}
DovlyApi.FunnelsApi getFunnelProducts GET /funnels/{id}/products
DovlyApi.FunnelsApi getFunnels GET /funnels
DovlyApi.FunnelsApi putFunnelProducts PUT /funnels/{id}/products/{product-id}
DovlyApi.FunnelsApi putFunnels PUT /funnels/{id}
DovlyApi.FunnelsApi saveFunnels POST /funnels
DovlyApi.FunnelsApi saveFunnelsProduct POST /funnels/{id}/products/{product-id}
DovlyApi.LettersApi deleteLetters DELETE /disputes/letters/{id}
DovlyApi.LettersApi disputesletters GET /disputes/letters
DovlyApi.LettersApi postLetters POST /disputes/letters
DovlyApi.LettersApi putLetters PUT /disputes/letters/{id}
DovlyApi.PermissionsApi deletePermission DELETE /permissions/{id}
DovlyApi.PermissionsApi getPermissions GET /permissions
DovlyApi.PermissionsApi postpermission POST /permissions
DovlyApi.PermissionsApi putPermission PUT /permissions/{id}
DovlyApi.ProductsApi deleteProduct DELETE /products/{id}
DovlyApi.ProductsApi products GET /products
DovlyApi.ProductsApi productsid GET /products/{id}
DovlyApi.ProductsApi putProduct PUT /products/{id}
DovlyApi.ProductsApi saveProduct POST /products
DovlyApi.RolesApi deleteRole DELETE /role/{id}
DovlyApi.RolesApi getRoles GET /roles
DovlyApi.RolesApi postRole POST /roles
DovlyApi.RolesApi putRole PUT /roles/{id}
DovlyApi.RolesPermissionsApi deleteRolesPermissions DELETE /roles/{id}/permissions/{permission-id}
DovlyApi.RolesPermissionsApi getRolesPermissions GET /roles/{id}/permissions
DovlyApi.RolesPermissionsApi postRolesPermissions POST /roles/{id}/permissions/{permission-id}
DovlyApi.StateApi states GET /states
DovlyApi.StateApi statesstate GET /states/{state}
DovlyApi.TransunionApi transunion GET /transunion
DovlyApi.UsersApi deleteUserByTypeId DELETE /users/{id}
DovlyApi.UsersApi getCustomers GET /users/customers/{status}
DovlyApi.UsersApi getLogins GET /users/logins/{cognito-id}
DovlyApi.UsersApi getOww GET /users/oow/{cognito-id}
DovlyApi.UsersApi getUserByTypeId GET /users/{id}
DovlyApi.UsersApi getUserLeads GET /users/leads/{status}
DovlyApi.UsersApi putOww PUT /users/oow/{cognito-id}
DovlyApi.UsersApi putUser PUT /users/{id}

Documentation for Models

Documentation for Authorization

BearerAuth