1.0.2 • Published 4 years ago

dovly_api v1.0.2

Weekly downloads
2
License
Unlicense
Repository
-
Last release
4 years ago

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 /

ClassMethodHTTP requestDescription
DovlyApi.CreditsApicreditalertsGET /credit/alerts
DovlyApi.CreditsApicreditreportreportIdGET /credit/report/{report-id}
DovlyApi.CreditsApicreditreportsGET /credit/reports
DovlyApi.DisputesApideleteLetterCategoriesDELETE /disputes/letters/categories/{id}
DovlyApi.DisputesApigetAllDisputesGET /disputes
DovlyApi.DisputesApigetLetterCategoriesGET /disputes/letters/categories
DovlyApi.DisputesApigetReasonsGET /disputes/reasons
DovlyApi.DisputesApipostLetterCategoriesPOST /disputes/letters/categories
DovlyApi.DisputesApiputDisputePUT /disputes/{id}
DovlyApi.DisputesApiputLetterCategoriesPUT /disputes/letters/categories/{id}
DovlyApi.DisputesApiputSchedulePUT /disputes/schedule
DovlyApi.DocumentsApideleteDocumentByUserIdDELETE /users/documents/{id}
DovlyApi.DocumentsApigetDocumentsGET /users/documents
DovlyApi.DocumentsApigetTypesGET /users/documents/types
DovlyApi.DocumentsApisaveDocumentsPOST /users/documents
DovlyApi.FunnelsApideleteFunnelDELETE /funnels/{id}
DovlyApi.FunnelsApideleteFunnelProductsDELETE /funnels/{id}/products/{product-id}
DovlyApi.FunnelsApigetFunnelGET /funnels/{id}
DovlyApi.FunnelsApigetFunnelProductGET /funnels/{id}/products/{product-id}
DovlyApi.FunnelsApigetFunnelProductsGET /funnels/{id}/products
DovlyApi.FunnelsApigetFunnelsGET /funnels
DovlyApi.FunnelsApiputFunnelProductsPUT /funnels/{id}/products/{product-id}
DovlyApi.FunnelsApiputFunnelsPUT /funnels/{id}
DovlyApi.FunnelsApisaveFunnelsPOST /funnels
DovlyApi.FunnelsApisaveFunnelsProductPOST /funnels/{id}/products/{product-id}
DovlyApi.LettersApideleteLettersDELETE /disputes/letters/{id}
DovlyApi.LettersApidisputeslettersGET /disputes/letters
DovlyApi.LettersApipostLettersPOST /disputes/letters
DovlyApi.LettersApiputLettersPUT /disputes/letters/{id}
DovlyApi.PermissionsApideletePermissionDELETE /permissions/{id}
DovlyApi.PermissionsApigetPermissionsGET /permissions
DovlyApi.PermissionsApipostpermissionPOST /permissions
DovlyApi.PermissionsApiputPermissionPUT /permissions/{id}
DovlyApi.ProductsApideleteProductDELETE /products/{id}
DovlyApi.ProductsApiproductsGET /products
DovlyApi.ProductsApiproductsidGET /products/{id}
DovlyApi.ProductsApiputProductPUT /products/{id}
DovlyApi.ProductsApisaveProductPOST /products
DovlyApi.RolesApideleteRoleDELETE /role/{id}
DovlyApi.RolesApigetRolesGET /roles
DovlyApi.RolesApipostRolePOST /roles
DovlyApi.RolesApiputRolePUT /roles/{id}
DovlyApi.RolesPermissionsApideleteRolesPermissionsDELETE /roles/{id}/permissions/{permission-id}
DovlyApi.RolesPermissionsApigetRolesPermissionsGET /roles/{id}/permissions
DovlyApi.RolesPermissionsApipostRolesPermissionsPOST /roles/{id}/permissions/{permission-id}
DovlyApi.StateApistatesGET /states
DovlyApi.StateApistatesstateGET /states/{state}
DovlyApi.TransunionApitransunionGET /transunion
DovlyApi.UsersApideleteUserByTypeIdDELETE /users/{id}
DovlyApi.UsersApigetCustomersGET /users/customers/{status}
DovlyApi.UsersApigetLoginsGET /users/logins/{cognito-id}
DovlyApi.UsersApigetOwwGET /users/oow/{cognito-id}
DovlyApi.UsersApigetUserByTypeIdGET /users/{id}
DovlyApi.UsersApigetUserLeadsGET /users/leads/{status}
DovlyApi.UsersApiputOwwPUT /users/oow/{cognito-id}
DovlyApi.UsersApiputUserPUT /users/{id}

Documentation for Models

Documentation for Authorization

BearerAuth

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago