1.0.0 • Published 3 years ago

@caspiandevbr/yes4track-web-api-client v1.0.0

Weekly downloads
-
License
Use under MIT Lic...
Repository
github
Last release
3 years ago

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

ClassMethodHTTP requestDescription
CaspianYes4TrackServiceApi.AdventureApigetByIdAdventureGET /yes4track/v1/adventures/{id}Get Adventure by id
CaspianYes4TrackServiceApi.AdventureApigetByIdAdventureCodeGET /yes4track/v1/adventures/{id}/codeGet Adventure Code by id
CaspianYes4TrackServiceApi.AdventureApigetByIdAdventureLikesGET /yes4track/v1/adventures/{id}/likes/{likeId}Get Adventure Like by id
CaspianYes4TrackServiceApi.AdventureApiyes4trackV1AdventuresGetGET /yes4track/v1/adventuresGet All Adventure by filter with pagination
CaspianYes4TrackServiceApi.AdventureApiyes4trackV1AdventuresIdActivatePostPOST /yes4track/v1/adventures/{id}/activateActivate Adventure
CaspianYes4TrackServiceApi.AdventureApiyes4trackV1AdventuresIdCodeCodeCheckPostPOST /yes4track/v1/adventures/{id}/code/{code}/checkCheck Adventure Code
CaspianYes4TrackServiceApi.AdventureApiyes4trackV1AdventuresIdDeleteDELETE /yes4track/v1/adventures/{id}Delete Adventure by Id
CaspianYes4TrackServiceApi.AdventureApiyes4trackV1AdventuresIdExperiencesExperienceIdDeleteDELETE /yes4track/v1/adventures/{id}/experiences/{experienceId}Delete Adventure Experience
CaspianYes4TrackServiceApi.AdventureApiyes4trackV1AdventuresIdExperiencesExperienceIdPostPOST /yes4track/v1/adventures/{id}/experiences/{experienceId}Add Adventure Experience
CaspianYes4TrackServiceApi.AdventureApiyes4trackV1AdventuresIdImagesImageIdDeleteDELETE /yes4track/v1/adventures/{id}/images/{imageId}Delete Adventure by Id
CaspianYes4TrackServiceApi.AdventureApiyes4trackV1AdventuresIdImagesPostPOST /yes4track/v1/adventures/{id}/imagesAdd images in adventure
CaspianYes4TrackServiceApi.AdventureApiyes4trackV1AdventuresIdLikesDeleteDELETE /yes4track/v1/adventures/{id}/likesDelete Adventure Likes by Id
CaspianYes4TrackServiceApi.AdventureApiyes4trackV1AdventuresIdLikesGetGET /yes4track/v1/adventures/{id}/likesGet All Adventure Likes by filter with pagination
CaspianYes4TrackServiceApi.AdventureApiyes4trackV1AdventuresIdLikesPostPOST /yes4track/v1/adventures/{id}/likesCreate Adventure Likes
CaspianYes4TrackServiceApi.AdventureApiyes4trackV1AdventuresIdPatchPATCH /yes4track/v1/adventures/{id}Update part of Adventure
CaspianYes4TrackServiceApi.AdventureApiyes4trackV1AdventuresIdPutPUT /yes4track/v1/adventures/{id}Update Adventure
CaspianYes4TrackServiceApi.AdventureApiyes4trackV1AdventuresIdVideosPostPOST /yes4track/v1/adventures/{id}/videosAdd videos in adventure
CaspianYes4TrackServiceApi.AdventureApiyes4trackV1AdventuresIdVideosVideoIdDeleteDELETE /yes4track/v1/adventures/{id}/videos/{videoId}Delete Adventure by Id
CaspianYes4TrackServiceApi.AdventureApiyes4trackV1AdventuresPostPOST /yes4track/v1/adventuresCreate Adventure
CaspianYes4TrackServiceApi.AuditApiyes4trackV1AuditsGetGET /yes4track/v1/auditsGet All Audit by filter with pagination
CaspianYes4TrackServiceApi.CardApigetByIdCardGET /yes4track/v1/cards/{id}Get Card by id
CaspianYes4TrackServiceApi.CardApiyes4trackV1CardsGetGET /yes4track/v1/cardsGet All Card by filter with pagination
CaspianYes4TrackServiceApi.CardApiyes4trackV1CardsIdDeleteDELETE /yes4track/v1/cards/{id}Delete Card by Id
CaspianYes4TrackServiceApi.CardApiyes4trackV1CardsIdPatchPATCH /yes4track/v1/cards/{id}Update part of Card
CaspianYes4TrackServiceApi.CardApiyes4trackV1CardsIdPutPUT /yes4track/v1/cards/{id}Update Card
CaspianYes4TrackServiceApi.CardApiyes4trackV1CardsPostPOST /yes4track/v1/cardsCreate Card
CaspianYes4TrackServiceApi.CompanyApigetByIdCompanyGET /yes4track/v1/companies/{id}Get Company by id
CaspianYes4TrackServiceApi.CompanyApiyes4trackV1CompaniesGetGET /yes4track/v1/companiesGet All Company by filter with pagination
CaspianYes4TrackServiceApi.CompanyApiyes4trackV1CompaniesIdDeleteDELETE /yes4track/v1/companies/{id}Delete Company by Id
CaspianYes4TrackServiceApi.CompanyApiyes4trackV1CompaniesIdPatchPATCH /yes4track/v1/companies/{id}Update part of Company
CaspianYes4TrackServiceApi.CompanyApiyes4trackV1CompaniesIdPutPUT /yes4track/v1/companies/{id}Update Company
CaspianYes4TrackServiceApi.CompanyApiyes4trackV1CompaniesPostPOST /yes4track/v1/companiesCreate Company
CaspianYes4TrackServiceApi.ExperienceApigetByIdExperienceGET /yes4track/v1/experiences/{id}Get Experience by id
CaspianYes4TrackServiceApi.ExperienceApigetByIdExperienceCodeGET /yes4track/v1/experiences/{id}/codeGet Experience Code by id
CaspianYes4TrackServiceApi.ExperienceApiyes4trackV1ExperiencesGetGET /yes4track/v1/experiencesGet All Experience by filter with pagination
CaspianYes4TrackServiceApi.ExperienceApiyes4trackV1ExperiencesIdActivatePostPOST /yes4track/v1/experiences/{id}/activateActivate Experience
CaspianYes4TrackServiceApi.ExperienceApiyes4trackV1ExperiencesIdCodeCodeCheckPostPOST /yes4track/v1/experiences/{id}/code/{code}/checkCheck Experience Code
CaspianYes4TrackServiceApi.ExperienceApiyes4trackV1ExperiencesIdDeleteDELETE /yes4track/v1/experiences/{id}Delete Experience by Id
CaspianYes4TrackServiceApi.ExperienceApiyes4trackV1ExperiencesIdImagesImageIdDeleteDELETE /yes4track/v1/experiences/{id}/images/{imageId}Delete Experience by Id
CaspianYes4TrackServiceApi.ExperienceApiyes4trackV1ExperiencesIdImagesPostPOST /yes4track/v1/experiences/{id}/imagesAdd images in Experience
CaspianYes4TrackServiceApi.ExperienceApiyes4trackV1ExperiencesIdPatchPATCH /yes4track/v1/experiences/{id}Update part of Experience
CaspianYes4TrackServiceApi.ExperienceApiyes4trackV1ExperiencesIdPutPUT /yes4track/v1/experiences/{id}Update Experience
CaspianYes4TrackServiceApi.ExperienceApiyes4trackV1ExperiencesIdVideosPostPOST /yes4track/v1/experiences/{id}/videosAdd videos in an Experience
CaspianYes4TrackServiceApi.ExperienceApiyes4trackV1ExperiencesIdVideosVideoIdDeleteDELETE /yes4track/v1/experiences/{id}/videos/{videoId}Delete Experience by Id
CaspianYes4TrackServiceApi.ExperienceApiyes4trackV1ExperiencesPostPOST /yes4track/v1/experiencesCreate Experience
CaspianYes4TrackServiceApi.SponsorApigetByIdSponsorGET /yes4track/v1/sponsors/{id}Get Sponsor by id
CaspianYes4TrackServiceApi.SponsorApiyes4trackV1SponsorsGetGET /yes4track/v1/sponsorsGet All Sponsor by filter with pagination
CaspianYes4TrackServiceApi.SponsorApiyes4trackV1SponsorsIdDeleteDELETE /yes4track/v1/sponsors/{id}Delete Sponsor by Id
CaspianYes4TrackServiceApi.SponsorApiyes4trackV1SponsorsIdPatchPATCH /yes4track/v1/sponsors/{id}Update part of Sponsor
CaspianYes4TrackServiceApi.SponsorApiyes4trackV1SponsorsIdPutPUT /yes4track/v1/sponsors/{id}Update Sponsor
CaspianYes4TrackServiceApi.SponsorApiyes4trackV1SponsorsPostPOST /yes4track/v1/sponsorsCreate Sponsor
CaspianYes4TrackServiceApi.TemplateApigetByIdTemplateGET /yes4track/v1/templates/{id}Get Template by id
CaspianYes4TrackServiceApi.TemplateApiyes4trackV1TemplatesGetGET /yes4track/v1/templatesGet All Template by filter with pagination
CaspianYes4TrackServiceApi.TemplateApiyes4trackV1TemplatesIdDeleteDELETE /yes4track/v1/templates/{id}Delete Template by Id
CaspianYes4TrackServiceApi.TemplateApiyes4trackV1TemplatesIdPatchPATCH /yes4track/v1/templates/{id}Update part of Template
CaspianYes4TrackServiceApi.TemplateApiyes4trackV1TemplatesIdPhotosUploadPostPOST /yes4track/v1/templates/{id}/photos/uploadCreate Template
CaspianYes4TrackServiceApi.TemplateApiyes4trackV1TemplatesIdPutPUT /yes4track/v1/templates/{id}Update Template
CaspianYes4TrackServiceApi.TemplateApiyes4trackV1TemplatesPostPOST /yes4track/v1/templatesCreate Template
CaspianYes4TrackServiceApi.TrackApigetByIdTrackGET /yes4track/v1/tracks/{id}Get Track by id
CaspianYes4TrackServiceApi.TrackApigetByIdTrackGeoDataGET /yes4track/v1/tracks/{id}/geodataGet Track Geo Data by id
CaspianYes4TrackServiceApi.TrackApigetByIdTrackGeoLocationGET /yes4track/v1/tracks/geolocationGet Track Geo Location by id
CaspianYes4TrackServiceApi.TrackApiyes4trackV1TracksGetGET /yes4track/v1/tracksGet All Track by filter with pagination
CaspianYes4TrackServiceApi.TrackApiyes4trackV1TracksIdDeleteDELETE /yes4track/v1/tracks/{id}Delete Track by Id
CaspianYes4TrackServiceApi.TrackApiyes4trackV1TracksIdGeodataPostPOST /yes4track/v1/tracks/{id}/geodataCreate Track GeoData
CaspianYes4TrackServiceApi.TrackApiyes4trackV1TracksIdPatchPATCH /yes4track/v1/tracks/{id}Update part of Track
CaspianYes4TrackServiceApi.TrackApiyes4trackV1TracksIdPutPUT /yes4track/v1/tracks/{id}Update Track
CaspianYes4TrackServiceApi.TrackApiyes4trackV1TracksIdStatisticPutPUT /yes4track/v1/tracks/{id}/statisticUpdate Track Statistic
CaspianYes4TrackServiceApi.TrackApiyes4trackV1TracksPostPOST /yes4track/v1/tracksCreate Track
CaspianYes4TrackServiceApi.TrailApigetByIdTrailGET /yes4track/v1/trails/{id}Get Trail by id
CaspianYes4TrackServiceApi.TrailApigetByIdTrailGeoDataGET /yes4track/v1/trails/{id}/geodataGet Trail Geo Data by id
CaspianYes4TrackServiceApi.TrailApiyes4trackV1TrailsActiveByAngelGetGET /yes4track/v1/trails/activeByAngelGet All Active Trail by Angel
CaspianYes4TrackServiceApi.TrailApiyes4trackV1TrailsGetGET /yes4track/v1/trailsGet All Trail by filter with pagination
CaspianYes4TrackServiceApi.TrailApiyes4trackV1TrailsIdAngelAngelIdDeleteDELETE /yes4track/v1/trails/{id}/angel/{angelId}Delete Trail Angel by Id
CaspianYes4TrackServiceApi.TrailApiyes4trackV1TrailsIdAngelAngelIdPostPOST /yes4track/v1/trails/{id}/angel/{angelId}Add Trail Angel by Id
CaspianYes4TrackServiceApi.TrailApiyes4trackV1TrailsIdDeleteDELETE /yes4track/v1/trails/{id}Delete Trail by Id
CaspianYes4TrackServiceApi.TrailApiyes4trackV1TrailsIdGeodataChunckPostPOST /yes4track/v1/trails/{id}/geodata/chunckAdd Chunck Trail GeoData
CaspianYes4TrackServiceApi.TrailApiyes4trackV1TrailsIdGeodataPostPOST /yes4track/v1/trails/{id}/geodataCreate Trail GeoData
CaspianYes4TrackServiceApi.TrailApiyes4trackV1TrailsIdPatchPATCH /yes4track/v1/trails/{id}Update part of Trail
CaspianYes4TrackServiceApi.TrailApiyes4trackV1TrailsIdPutPUT /yes4track/v1/trails/{id}Update Trail
CaspianYes4TrackServiceApi.TrailApiyes4trackV1TrailsIdSponsorSponsorIdDeleteDELETE /yes4track/v1/trails/{id}/sponsor/{sponsorId}Delete Trail Sponsor by Id
CaspianYes4TrackServiceApi.TrailApiyes4trackV1TrailsIdSponsorSponsorIdPostPOST /yes4track/v1/trails/{id}/sponsor/{sponsorId}Add Trail Sponsor by Id
CaspianYes4TrackServiceApi.TrailApiyes4trackV1TrailsPostPOST /yes4track/v1/trailsCreate Trail
CaspianYes4TrackServiceApi.UserApigetByIdUserGET /yes4track/v1/users/{id}Get User by id
CaspianYes4TrackServiceApi.UserApiyes4trackV1UsersAccesstokenPostPOST /yes4track/v1/users/accesstokenUser SignIn
CaspianYes4TrackServiceApi.UserApiyes4trackV1UsersGetGET /yes4track/v1/usersGet All User by filter with pagination
CaspianYes4TrackServiceApi.UserApiyes4trackV1UsersIdCompaniesCompanyIdDeleteDELETE /yes4track/v1/users/{id}/companies/{companyId}Delete User Company
CaspianYes4TrackServiceApi.UserApiyes4trackV1UsersIdCompaniesCompanyIdPostPOST /yes4track/v1/users/{id}/companies/{companyId}Add User Company
CaspianYes4TrackServiceApi.UserApiyes4trackV1UsersIdDeleteDELETE /yes4track/v1/users/{id}Delete User by Id
CaspianYes4TrackServiceApi.UserApiyes4trackV1UsersIdLocationPutPUT /yes4track/v1/users/{id}/locationUpdate User Location
CaspianYes4TrackServiceApi.UserApiyes4trackV1UsersIdPatchPATCH /yes4track/v1/users/{id}Update part of User
CaspianYes4TrackServiceApi.UserApiyes4trackV1UsersIdPhotoPutPUT /yes4track/v1/users/{id}/photoUpdate User Photo
CaspianYes4TrackServiceApi.UserApiyes4trackV1UsersIdPutPUT /yes4track/v1/users/{id}Update User
CaspianYes4TrackServiceApi.UserApiyes4trackV1UsersPostPOST /yes4track/v1/usersAdd User
CaspianYes4TrackServiceApi.UserApiyes4trackV1UsersResendcodePostPOST /yes4track/v1/users/resendcodeResend Code
CaspianYes4TrackServiceApi.UserApiyes4trackV1UsersSetupangelPostPOST /yes4track/v1/users/setupangelSetup User default Angel
CaspianYes4TrackServiceApi.UserApiyes4trackV1UsersSetupsponsorIdPostPOST /yes4track/v1/users/setupsponsor/{id}Setup User default Sponsor
CaspianYes4TrackServiceApi.UserApiyes4trackV1UsersSigninPostPOST /yes4track/v1/users/signinUser SignIn
CaspianYes4TrackServiceApi.UserApiyes4trackV1UsersSignupPostPOST /yes4track/v1/users/signupUser SignUp

Documentation for Models

Documentation for Authorization

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header
@babel/clisuperagent
@infinitebrahmanuniverse/nolb-_cas@everything-registry/sub-chunk-158
1.0.0

3 years ago