@caspiandevbr/yes4track-web-api-client

Caspian Yes4Track ServiceAPI

Usage no npm install needed!

<script type="module">
  import caspiandevbrYes4trackWebApiClient from 'https://cdn.skypack.dev/@caspiandevbr/yes4track-web-api-client';
</script>

README

caspian_yes4_track_service_api

CaspianYes4TrackServiceApi - JavaScript client for caspian_yes4_track_service_api Caspian.Yes4Track.Service API This SDK is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • Package version: v1
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://github.com/jefersonmlopes

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 caspian_yes4_track_service_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 caspian_yes4_track_service_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 CaspianYes4TrackServiceApi = require('caspian_yes4_track_service_api');

var defaultClient = CaspianYes4TrackServiceApi.ApiClient.instance;
// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new CaspianYes4TrackServiceApi.AdventureApi()
var id = null; // {String} Adventure id
var opts = {
  'xApiKey': "xApiKey_example", // {String} Your Api Key
  'xCsrfToken': "'b49e04c2-530f-4685-a9de-a9fd801aee0b'" // {String} CSRF Protection
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getByIdAdventure(id, opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
CaspianYes4TrackServiceApi.AdventureApi getByIdAdventure GET /yes4track/v1/adventures/{id} Get Adventure by id
CaspianYes4TrackServiceApi.AdventureApi getByIdAdventureCode GET /yes4track/v1/adventures/{id}/code Get Adventure Code by id
CaspianYes4TrackServiceApi.AdventureApi getByIdAdventureLikes GET /yes4track/v1/adventures/{id}/likes/{likeId} Get Adventure Like by id
CaspianYes4TrackServiceApi.AdventureApi yes4trackV1AdventuresGet GET /yes4track/v1/adventures Get All Adventure by filter with pagination
CaspianYes4TrackServiceApi.AdventureApi yes4trackV1AdventuresIdActivatePost POST /yes4track/v1/adventures/{id}/activate Activate Adventure
CaspianYes4TrackServiceApi.AdventureApi yes4trackV1AdventuresIdCodeCodeCheckPost POST /yes4track/v1/adventures/{id}/code/{code}/check Check Adventure Code
CaspianYes4TrackServiceApi.AdventureApi yes4trackV1AdventuresIdDelete DELETE /yes4track/v1/adventures/{id} Delete Adventure by Id
CaspianYes4TrackServiceApi.AdventureApi yes4trackV1AdventuresIdExperiencesExperienceIdDelete DELETE /yes4track/v1/adventures/{id}/experiences/{experienceId} Delete Adventure Experience
CaspianYes4TrackServiceApi.AdventureApi yes4trackV1AdventuresIdExperiencesExperienceIdPost POST /yes4track/v1/adventures/{id}/experiences/{experienceId} Add Adventure Experience
CaspianYes4TrackServiceApi.AdventureApi yes4trackV1AdventuresIdImagesImageIdDelete DELETE /yes4track/v1/adventures/{id}/images/{imageId} Delete Adventure by Id
CaspianYes4TrackServiceApi.AdventureApi yes4trackV1AdventuresIdImagesPost POST /yes4track/v1/adventures/{id}/images Add images in adventure
CaspianYes4TrackServiceApi.AdventureApi yes4trackV1AdventuresIdLikesDelete DELETE /yes4track/v1/adventures/{id}/likes Delete Adventure Likes by Id
CaspianYes4TrackServiceApi.AdventureApi yes4trackV1AdventuresIdLikesGet GET /yes4track/v1/adventures/{id}/likes Get All Adventure Likes by filter with pagination
CaspianYes4TrackServiceApi.AdventureApi yes4trackV1AdventuresIdLikesPost POST /yes4track/v1/adventures/{id}/likes Create Adventure Likes
CaspianYes4TrackServiceApi.AdventureApi yes4trackV1AdventuresIdPatch PATCH /yes4track/v1/adventures/{id} Update part of Adventure
CaspianYes4TrackServiceApi.AdventureApi yes4trackV1AdventuresIdPut PUT /yes4track/v1/adventures/{id} Update Adventure
CaspianYes4TrackServiceApi.AdventureApi yes4trackV1AdventuresIdVideosPost POST /yes4track/v1/adventures/{id}/videos Add videos in adventure
CaspianYes4TrackServiceApi.AdventureApi yes4trackV1AdventuresIdVideosVideoIdDelete DELETE /yes4track/v1/adventures/{id}/videos/{videoId} Delete Adventure by Id
CaspianYes4TrackServiceApi.AdventureApi yes4trackV1AdventuresPost POST /yes4track/v1/adventures Create Adventure
CaspianYes4TrackServiceApi.AuditApi yes4trackV1AuditsGet GET /yes4track/v1/audits Get All Audit by filter with pagination
CaspianYes4TrackServiceApi.CardApi getByIdCard GET /yes4track/v1/cards/{id} Get Card by id
CaspianYes4TrackServiceApi.CardApi yes4trackV1CardsGet GET /yes4track/v1/cards Get All Card by filter with pagination
CaspianYes4TrackServiceApi.CardApi yes4trackV1CardsIdDelete DELETE /yes4track/v1/cards/{id} Delete Card by Id
CaspianYes4TrackServiceApi.CardApi yes4trackV1CardsIdPatch PATCH /yes4track/v1/cards/{id} Update part of Card
CaspianYes4TrackServiceApi.CardApi yes4trackV1CardsIdPut PUT /yes4track/v1/cards/{id} Update Card
CaspianYes4TrackServiceApi.CardApi yes4trackV1CardsPost POST /yes4track/v1/cards Create Card
CaspianYes4TrackServiceApi.CompanyApi getByIdCompany GET /yes4track/v1/companies/{id} Get Company by id
CaspianYes4TrackServiceApi.CompanyApi yes4trackV1CompaniesGet GET /yes4track/v1/companies Get All Company by filter with pagination
CaspianYes4TrackServiceApi.CompanyApi yes4trackV1CompaniesIdDelete DELETE /yes4track/v1/companies/{id} Delete Company by Id
CaspianYes4TrackServiceApi.CompanyApi yes4trackV1CompaniesIdPatch PATCH /yes4track/v1/companies/{id} Update part of Company
CaspianYes4TrackServiceApi.CompanyApi yes4trackV1CompaniesIdPut PUT /yes4track/v1/companies/{id} Update Company
CaspianYes4TrackServiceApi.CompanyApi yes4trackV1CompaniesPost POST /yes4track/v1/companies Create Company
CaspianYes4TrackServiceApi.ExperienceApi getByIdExperience GET /yes4track/v1/experiences/{id} Get Experience by id
CaspianYes4TrackServiceApi.ExperienceApi getByIdExperienceCode GET /yes4track/v1/experiences/{id}/code Get Experience Code by id
CaspianYes4TrackServiceApi.ExperienceApi yes4trackV1ExperiencesGet GET /yes4track/v1/experiences Get All Experience by filter with pagination
CaspianYes4TrackServiceApi.ExperienceApi yes4trackV1ExperiencesIdActivatePost POST /yes4track/v1/experiences/{id}/activate Activate Experience
CaspianYes4TrackServiceApi.ExperienceApi yes4trackV1ExperiencesIdCodeCodeCheckPost POST /yes4track/v1/experiences/{id}/code/{code}/check Check Experience Code
CaspianYes4TrackServiceApi.ExperienceApi yes4trackV1ExperiencesIdDelete DELETE /yes4track/v1/experiences/{id} Delete Experience by Id
CaspianYes4TrackServiceApi.ExperienceApi yes4trackV1ExperiencesIdImagesImageIdDelete DELETE /yes4track/v1/experiences/{id}/images/{imageId} Delete Experience by Id
CaspianYes4TrackServiceApi.ExperienceApi yes4trackV1ExperiencesIdImagesPost POST /yes4track/v1/experiences/{id}/images Add images in Experience
CaspianYes4TrackServiceApi.ExperienceApi yes4trackV1ExperiencesIdPatch PATCH /yes4track/v1/experiences/{id} Update part of Experience
CaspianYes4TrackServiceApi.ExperienceApi yes4trackV1ExperiencesIdPut PUT /yes4track/v1/experiences/{id} Update Experience
CaspianYes4TrackServiceApi.ExperienceApi yes4trackV1ExperiencesIdVideosPost POST /yes4track/v1/experiences/{id}/videos Add videos in an Experience
CaspianYes4TrackServiceApi.ExperienceApi yes4trackV1ExperiencesIdVideosVideoIdDelete DELETE /yes4track/v1/experiences/{id}/videos/{videoId} Delete Experience by Id
CaspianYes4TrackServiceApi.ExperienceApi yes4trackV1ExperiencesPost POST /yes4track/v1/experiences Create Experience
CaspianYes4TrackServiceApi.SponsorApi getByIdSponsor GET /yes4track/v1/sponsors/{id} Get Sponsor by id
CaspianYes4TrackServiceApi.SponsorApi yes4trackV1SponsorsGet GET /yes4track/v1/sponsors Get All Sponsor by filter with pagination
CaspianYes4TrackServiceApi.SponsorApi yes4trackV1SponsorsIdDelete DELETE /yes4track/v1/sponsors/{id} Delete Sponsor by Id
CaspianYes4TrackServiceApi.SponsorApi yes4trackV1SponsorsIdPatch PATCH /yes4track/v1/sponsors/{id} Update part of Sponsor
CaspianYes4TrackServiceApi.SponsorApi yes4trackV1SponsorsIdPut PUT /yes4track/v1/sponsors/{id} Update Sponsor
CaspianYes4TrackServiceApi.SponsorApi yes4trackV1SponsorsPost POST /yes4track/v1/sponsors Create Sponsor
CaspianYes4TrackServiceApi.TemplateApi getByIdTemplate GET /yes4track/v1/templates/{id} Get Template by id
CaspianYes4TrackServiceApi.TemplateApi yes4trackV1TemplatesGet GET /yes4track/v1/templates Get All Template by filter with pagination
CaspianYes4TrackServiceApi.TemplateApi yes4trackV1TemplatesIdDelete DELETE /yes4track/v1/templates/{id} Delete Template by Id
CaspianYes4TrackServiceApi.TemplateApi yes4trackV1TemplatesIdPatch PATCH /yes4track/v1/templates/{id} Update part of Template
CaspianYes4TrackServiceApi.TemplateApi yes4trackV1TemplatesIdPhotosUploadPost POST /yes4track/v1/templates/{id}/photos/upload Create Template
CaspianYes4TrackServiceApi.TemplateApi yes4trackV1TemplatesIdPut PUT /yes4track/v1/templates/{id} Update Template
CaspianYes4TrackServiceApi.TemplateApi yes4trackV1TemplatesPost POST /yes4track/v1/templates Create Template
CaspianYes4TrackServiceApi.TrackApi getByIdTrack GET /yes4track/v1/tracks/{id} Get Track by id
CaspianYes4TrackServiceApi.TrackApi getByIdTrackGeoData GET /yes4track/v1/tracks/{id}/geodata Get Track Geo Data by id
CaspianYes4TrackServiceApi.TrackApi getByIdTrackGeoLocation GET /yes4track/v1/tracks/geolocation Get Track Geo Location by id
CaspianYes4TrackServiceApi.TrackApi yes4trackV1TracksGet GET /yes4track/v1/tracks Get All Track by filter with pagination
CaspianYes4TrackServiceApi.TrackApi yes4trackV1TracksIdDelete DELETE /yes4track/v1/tracks/{id} Delete Track by Id
CaspianYes4TrackServiceApi.TrackApi yes4trackV1TracksIdGeodataPost POST /yes4track/v1/tracks/{id}/geodata Create Track GeoData
CaspianYes4TrackServiceApi.TrackApi yes4trackV1TracksIdPatch PATCH /yes4track/v1/tracks/{id} Update part of Track
CaspianYes4TrackServiceApi.TrackApi yes4trackV1TracksIdPut PUT /yes4track/v1/tracks/{id} Update Track
CaspianYes4TrackServiceApi.TrackApi yes4trackV1TracksIdStatisticPut PUT /yes4track/v1/tracks/{id}/statistic Update Track Statistic
CaspianYes4TrackServiceApi.TrackApi yes4trackV1TracksPost POST /yes4track/v1/tracks Create Track
CaspianYes4TrackServiceApi.TrailApi getByIdTrail GET /yes4track/v1/trails/{id} Get Trail by id
CaspianYes4TrackServiceApi.TrailApi getByIdTrailGeoData GET /yes4track/v1/trails/{id}/geodata Get Trail Geo Data by id
CaspianYes4TrackServiceApi.TrailApi yes4trackV1TrailsActiveByAngelGet GET /yes4track/v1/trails/activeByAngel Get All Active Trail by Angel
CaspianYes4TrackServiceApi.TrailApi yes4trackV1TrailsGet GET /yes4track/v1/trails Get All Trail by filter with pagination
CaspianYes4TrackServiceApi.TrailApi yes4trackV1TrailsIdAngelAngelIdDelete DELETE /yes4track/v1/trails/{id}/angel/{angelId} Delete Trail Angel by Id
CaspianYes4TrackServiceApi.TrailApi yes4trackV1TrailsIdAngelAngelIdPost POST /yes4track/v1/trails/{id}/angel/{angelId} Add Trail Angel by Id
CaspianYes4TrackServiceApi.TrailApi yes4trackV1TrailsIdDelete DELETE /yes4track/v1/trails/{id} Delete Trail by Id
CaspianYes4TrackServiceApi.TrailApi yes4trackV1TrailsIdGeodataChunckPost POST /yes4track/v1/trails/{id}/geodata/chunck Add Chunck Trail GeoData
CaspianYes4TrackServiceApi.TrailApi yes4trackV1TrailsIdGeodataPost POST /yes4track/v1/trails/{id}/geodata Create Trail GeoData
CaspianYes4TrackServiceApi.TrailApi yes4trackV1TrailsIdPatch PATCH /yes4track/v1/trails/{id} Update part of Trail
CaspianYes4TrackServiceApi.TrailApi yes4trackV1TrailsIdPut PUT /yes4track/v1/trails/{id} Update Trail
CaspianYes4TrackServiceApi.TrailApi yes4trackV1TrailsIdSponsorSponsorIdDelete DELETE /yes4track/v1/trails/{id}/sponsor/{sponsorId} Delete Trail Sponsor by Id
CaspianYes4TrackServiceApi.TrailApi yes4trackV1TrailsIdSponsorSponsorIdPost POST /yes4track/v1/trails/{id}/sponsor/{sponsorId} Add Trail Sponsor by Id
CaspianYes4TrackServiceApi.TrailApi yes4trackV1TrailsPost POST /yes4track/v1/trails Create Trail
CaspianYes4TrackServiceApi.UserApi getByIdUser GET /yes4track/v1/users/{id} Get User by id
CaspianYes4TrackServiceApi.UserApi yes4trackV1UsersAccesstokenPost POST /yes4track/v1/users/accesstoken User SignIn
CaspianYes4TrackServiceApi.UserApi yes4trackV1UsersGet GET /yes4track/v1/users Get All User by filter with pagination
CaspianYes4TrackServiceApi.UserApi yes4trackV1UsersIdCompaniesCompanyIdDelete DELETE /yes4track/v1/users/{id}/companies/{companyId} Delete User Company
CaspianYes4TrackServiceApi.UserApi yes4trackV1UsersIdCompaniesCompanyIdPost POST /yes4track/v1/users/{id}/companies/{companyId} Add User Company
CaspianYes4TrackServiceApi.UserApi yes4trackV1UsersIdDelete DELETE /yes4track/v1/users/{id} Delete User by Id
CaspianYes4TrackServiceApi.UserApi yes4trackV1UsersIdLocationPut PUT /yes4track/v1/users/{id}/location Update User Location
CaspianYes4TrackServiceApi.UserApi yes4trackV1UsersIdPatch PATCH /yes4track/v1/users/{id} Update part of User
CaspianYes4TrackServiceApi.UserApi yes4trackV1UsersIdPhotoPut PUT /yes4track/v1/users/{id}/photo Update User Photo
CaspianYes4TrackServiceApi.UserApi yes4trackV1UsersIdPut PUT /yes4track/v1/users/{id} Update User
CaspianYes4TrackServiceApi.UserApi yes4trackV1UsersPost POST /yes4track/v1/users Add User
CaspianYes4TrackServiceApi.UserApi yes4trackV1UsersResendcodePost POST /yes4track/v1/users/resendcode Resend Code
CaspianYes4TrackServiceApi.UserApi yes4trackV1UsersSetupangelPost POST /yes4track/v1/users/setupangel Setup User default Angel
CaspianYes4TrackServiceApi.UserApi yes4trackV1UsersSetupsponsorIdPost POST /yes4track/v1/users/setupsponsor/{id} Setup User default Sponsor
CaspianYes4TrackServiceApi.UserApi yes4trackV1UsersSigninPost POST /yes4track/v1/users/signin User SignIn
CaspianYes4TrackServiceApi.UserApi yes4trackV1UsersSignupPost POST /yes4track/v1/users/signup User SignUp

Documentation for Models

Documentation for Authorization

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header