mydeposits_developer_api v1.0.15

mydeposits_developer_api

MydepositsDeveloperApi - JavaScript client for mydeposits_developer_api API services to automate Deposit Protection within your existing Property Management Software workflows and applications for both England & Wales, and also Scotland This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.2.2
• Package version: 1.2.2
• 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 mydeposits_developer_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 mydeposits_developer_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 MydepositsDeveloperApi = require('mydeposits_developer_api');

var api = new MydepositsDeveloperApi.AuthenticationServicesApi()
var scheme = "scheme_example"; // {String} ID of the selected deposit protection Scheme as returned by protectionschemes method.
var region = "region_example"; // {String} ID of the selected deposit protection Region as returned by protectionregions method.
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.authorisationCreate(scheme, region, callback);

Documentation for API Endpoints

All URIs are relative to https://api.sandbox.mydeposits.co.uk

Documentation for Models

• MydepositsDeveloperApi.APIModelsBatch
• MydepositsDeveloperApi.APIModelsBatchAddTenancy
• MydepositsDeveloperApi.APIModelsBranch
• MydepositsDeveloperApi.APIModelsCheckout
• MydepositsDeveloperApi.APIModelsDeductions
• MydepositsDeveloperApi.APIModelsInterestedParty
• MydepositsDeveloperApi.APIModelsJointTenant
• MydepositsDeveloperApi.APIModelsLandlord
• MydepositsDeveloperApi.APIModelsLandlordMember
• MydepositsDeveloperApi.APIModelsPaymentDetail
• MydepositsDeveloperApi.APIModelsProperty
• MydepositsDeveloperApi.APIModelsSubscribe
• MydepositsDeveloperApi.APIModelsTenancy
• MydepositsDeveloperApi.APIModelsTenant
• MydepositsDeveloperApi.APIModelsToken
• MydepositsDeveloperApi.APIModelsUnprotect
• MydepositsDeveloperApi.APIModelsUnprotectAccept
• MydepositsDeveloperApi.APIModelsUnprotectionDeductions
• MydepositsDeveloperApi.APIResponsesBatch
• MydepositsDeveloperApi.APIResponsesBatchAddTenancy
• MydepositsDeveloperApi.APIResponsesBatchCheckout
• MydepositsDeveloperApi.APIResponsesBatchDetails
• MydepositsDeveloperApi.APIResponsesBatchList
• MydepositsDeveloperApi.APIResponsesBatchTenancy
• MydepositsDeveloperApi.APIResponsesBranch
• MydepositsDeveloperApi.APIResponsesBranchDetails
• MydepositsDeveloperApi.APIResponsesBranchList
• MydepositsDeveloperApi.APIResponsesCheckout
• MydepositsDeveloperApi.APIResponsesConvertSPT
• MydepositsDeveloperApi.APIResponsesDefaultPayment
• MydepositsDeveloperApi.APIResponsesErrorList
• MydepositsDeveloperApi.APIResponsesErrors
• MydepositsDeveloperApi.APIResponsesInterestedPartyDetails
• MydepositsDeveloperApi.APIResponsesJointTenant
• MydepositsDeveloperApi.APIResponsesLandlord
• MydepositsDeveloperApi.APIResponsesLandlordDetails
• MydepositsDeveloperApi.APIResponsesLandlordMember
• MydepositsDeveloperApi.APIResponsesLeadTenant
• MydepositsDeveloperApi.APIResponsesOTP
• MydepositsDeveloperApi.APIResponsesPaymentDetail
• MydepositsDeveloperApi.APIResponsesPaymentDetails
• MydepositsDeveloperApi.APIResponsesPaymentDetailsList
• MydepositsDeveloperApi.APIResponsesProperty
• MydepositsDeveloperApi.APIResponsesPropertyDetails
• MydepositsDeveloperApi.APIResponsesProtection
• MydepositsDeveloperApi.APIResponsesProtectionList
• MydepositsDeveloperApi.APIResponsesSchemeRules
• MydepositsDeveloperApi.APIResponsesTenancy
• MydepositsDeveloperApi.APIResponsesTenancyDetails
• MydepositsDeveloperApi.APIResponsesToken
• MydepositsDeveloperApi.APIResponsesUnprotect
• MydepositsDeveloperApi.Country
• MydepositsDeveloperApi.DeductionReasons
• MydepositsDeveloperApi.InlineResponse200
• MydepositsDeveloperApi.LocalAuthorityRegion
• MydepositsDeveloperApi.PropertyType
• MydepositsDeveloperApi.TenancyStatus
• MydepositsDeveloperApi.TenancyType
• MydepositsDeveloperApi.Title

Documentation for Authorization

mydeposits_accessCode

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://api.sandbox.mydeposits.co.uk/{scheme}/eng/authorize
• Scopes:
  • write:mydeposits: modify mydeposits entities in your account
  • read:mydeposits: read your mydeposits entities

mydeposits_implicit

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A