1.0.0 • Published 2 years ago

sangathan_app_api v1.0.0

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

sangathan_app

SangathanApp - JavaScript client for sangathan_app API for Sangathan App 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

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 sangathan_app --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 SangathanApp = require('sangathan_app');

var api = new SangathanApp.DesignationApi()
var body = new SangathanApp.CreateDesignationDto(); // {CreateDesignationDto} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.designationControllerCreate(body, callback);

Documentation for API Endpoints

All URIs are relative to /

ClassMethodHTTP requestDescription
SangathanApp.DesignationApidesignationControllerCreatePOST /designations
SangathanApp.DesignationApidesignationControllerFindAllGET /designations
SangathanApp.DesignationApidesignationControllerFindOneGET /designations/{designation}
SangathanApp.DesignationApidesignationControllerUpdatePATCH /designations/{designation}
SangathanApp.MemberAddressesApimemberAddressControllerAddAddressPOST /members/{memberId}/addresses
SangathanApp.MemberAddressesApimemberAddressControllerGetAllAddressesGET /members/{memberId}/addresses
SangathanApp.MemberAddressesApimemberAddressControllerUpdateAddressPATCH /members/{memberId}/addresses/{id}
SangathanApp.MemberAssocationsApimemberAssociationControllerAddAssociationPOST /members/{memberId}/associations
SangathanApp.MemberAssocationsApimemberAssociationControllerGetAllAssociationsGET /members/{memberId}/associations
SangathanApp.MemberAssocationsApimemberAssociationControllerUpdateAssociationPATCH /members/{memberId}/associations/{id}
SangathanApp.MemberDemographicsApimemberDemographicsControllerAddDemographicsPOST /members/{memberId}/demographics
SangathanApp.MemberDemographicsApimemberDemographicsControllerGetDemographicsGET /members/{memberId}/demographics
SangathanApp.MemberDemographicsApimemberDemographicsControllerUpdateDemographicsPATCH /members/{memberId}/demographics
SangathanApp.MemberSocialIdentitiesApimemberSocialControllerAddSocialIdentityPOST /members/{memberId}/socialIDs
SangathanApp.MemberSocialIdentitiesApimemberSocialControllerGetAllSocialIdentitiesGET /members/{memberId}/socialIDs
SangathanApp.MemberSocialIdentitiesApimemberSocialControllerUpdateSocialIdentityPATCH /members/{memberId}/socialIds/{id}
SangathanApp.MembersApimemberControllerCheckIfMemberExistsHEAD /members/{phone}
SangathanApp.MembersApimemberControllerCreateMemberWithBasicInfoPOST /members
SangathanApp.MembersApimemberControllerFindAllGET /members
SangathanApp.MembersApimemberControllerFindTeamsGET /members/{id}/teams
SangathanApp.MembersApimemberControllerGetMemberByPhoneGET /members/{phone}
SangathanApp.MembersApimemberControllerGetProfileGET /members/{id}/profile
SangathanApp.MembersApimemberControllerUpdateMemberPATCH /members/{id}
SangathanApp.TeamMembersApiteamMemberControllerCreatePOST /team-members
SangathanApp.TeamTypeApiteamTypeControllerCreatePOST /team-types
SangathanApp.TeamTypeApiteamTypeControllerFindAllGET /team-types
SangathanApp.TeamTypeApiteamTypeControllerFindOneGET /team-types/{type}
SangathanApp.TeamTypeApiteamTypeControllerUpdatePATCH /team-types/{type}
SangathanApp.TeamsApiteamControllerCreatePOST /teams
SangathanApp.TeamsApiteamControllerFindChildTeamsGET /teams/{id}/child-teams
SangathanApp.TeamsApiteamControllerFindMembersGET /teams/{id}/members
SangathanApp.TeamsApiteamControllerFindOneGET /teams/{id}

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.