sangathan_app_api v1.0.0
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 /
Class | Method | HTTP request | Description |
---|---|---|---|
SangathanApp.DesignationApi | designationControllerCreate | POST /designations | |
SangathanApp.DesignationApi | designationControllerFindAll | GET /designations | |
SangathanApp.DesignationApi | designationControllerFindOne | GET /designations/{designation} | |
SangathanApp.DesignationApi | designationControllerUpdate | PATCH /designations/{designation} | |
SangathanApp.MemberAddressesApi | memberAddressControllerAddAddress | POST /members/{memberId}/addresses | |
SangathanApp.MemberAddressesApi | memberAddressControllerGetAllAddresses | GET /members/{memberId}/addresses | |
SangathanApp.MemberAddressesApi | memberAddressControllerUpdateAddress | PATCH /members/{memberId}/addresses/{id} | |
SangathanApp.MemberAssocationsApi | memberAssociationControllerAddAssociation | POST /members/{memberId}/associations | |
SangathanApp.MemberAssocationsApi | memberAssociationControllerGetAllAssociations | GET /members/{memberId}/associations | |
SangathanApp.MemberAssocationsApi | memberAssociationControllerUpdateAssociation | PATCH /members/{memberId}/associations/{id} | |
SangathanApp.MemberDemographicsApi | memberDemographicsControllerAddDemographics | POST /members/{memberId}/demographics | |
SangathanApp.MemberDemographicsApi | memberDemographicsControllerGetDemographics | GET /members/{memberId}/demographics | |
SangathanApp.MemberDemographicsApi | memberDemographicsControllerUpdateDemographics | PATCH /members/{memberId}/demographics | |
SangathanApp.MemberSocialIdentitiesApi | memberSocialControllerAddSocialIdentity | POST /members/{memberId}/socialIDs | |
SangathanApp.MemberSocialIdentitiesApi | memberSocialControllerGetAllSocialIdentities | GET /members/{memberId}/socialIDs | |
SangathanApp.MemberSocialIdentitiesApi | memberSocialControllerUpdateSocialIdentity | PATCH /members/{memberId}/socialIds/{id} | |
SangathanApp.MembersApi | memberControllerCheckIfMemberExists | HEAD /members/{phone} | |
SangathanApp.MembersApi | memberControllerCreateMemberWithBasicInfo | POST /members | |
SangathanApp.MembersApi | memberControllerFindAll | GET /members | |
SangathanApp.MembersApi | memberControllerFindTeams | GET /members/{id}/teams | |
SangathanApp.MembersApi | memberControllerGetMemberByPhone | GET /members/{phone} | |
SangathanApp.MembersApi | memberControllerGetProfile | GET /members/{id}/profile | |
SangathanApp.MembersApi | memberControllerUpdateMember | PATCH /members/{id} | |
SangathanApp.TeamMembersApi | teamMemberControllerCreate | POST /team-members | |
SangathanApp.TeamTypeApi | teamTypeControllerCreate | POST /team-types | |
SangathanApp.TeamTypeApi | teamTypeControllerFindAll | GET /team-types | |
SangathanApp.TeamTypeApi | teamTypeControllerFindOne | GET /team-types/{type} | |
SangathanApp.TeamTypeApi | teamTypeControllerUpdate | PATCH /team-types/{type} | |
SangathanApp.TeamsApi | teamControllerCreate | POST /teams | |
SangathanApp.TeamsApi | teamControllerFindChildTeams | GET /teams/{id}/child-teams | |
SangathanApp.TeamsApi | teamControllerFindMembers | GET /teams/{id}/members | |
SangathanApp.TeamsApi | teamControllerFindOne | GET /teams/{id} |
Documentation for Models
- SangathanApp.AllOfTeamParentTeam
- SangathanApp.Count
- SangathanApp.CreateDesignationDto
- SangathanApp.CreateMemberAddressDto
- SangathanApp.CreateMemberAssociationDto
- SangathanApp.CreateMemberDemographicsDto
- SangathanApp.CreateMemberDto
- SangathanApp.CreateMemberSocialDto
- SangathanApp.CreateTeamDto
- SangathanApp.CreateTeamMemberDto
- SangathanApp.CreateTeamTypeDto
- SangathanApp.Designation
- SangathanApp.Member
- SangathanApp.MemberAddress
- SangathanApp.MemberAssociation
- SangathanApp.MemberDemographics
- SangathanApp.MemberSocial
- SangathanApp.Team
- SangathanApp.TeamMember
- SangathanApp.TeamType
- SangathanApp.UpdateDesignationDto
- SangathanApp.UpdateMemberAddressDto
- SangathanApp.UpdateMemberAssociationDto
- SangathanApp.UpdateMemberDemographicsDto
- SangathanApp.UpdateMemberDto
- SangathanApp.UpdateMemberSocialDto
- SangathanApp.UpdateTeamTypeDto
Documentation for Authorization
All endpoints do not require authorization.
2 years ago