@topcoder-platform/topcoder-api-challenges-v4-wrapper-dev
v1.0.5
Published
(DEV) Services_that_provide_access_and_interaction_with_all_sorts_of_challenges_including_design_dev_single_round_matches_and_marathon_matches_
Downloads
8
Keywords
Readme
ap_challenge_microservice
ApChallengeMicroservice - JavaScript client for ap_challenge_microservice Services that provide access and interaction with all sorts of challenges, including design, dev, single round matches, and marathon matches. This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.5
- Package version: 1.0.5
- Build package: io.swagger.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 ap_challenge_microservice --save
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
Finally, switch to the directory you want to use your ap_challenge_microservice from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('ap_challenge_microservice')
in javascript files from the directory you ran the last
command above from.
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, that's to say your javascript file where you actually
use this library):
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 ApChallengeMicroservice = require('ap_challenge_microservice');
var defaultClient = ApChallengeMicroservice.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 ApChallengeMicroservice.DefaultApi()
var id = "id_example"; // {String} the id of the draft challenge
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.activateChallenge(id, callback);
Documentation for API Endpoints
All URIs are relative to http://api.topcoder.com/v4
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ApChallengeMicroservice.DefaultApi | activateChallenge | POST /challenges/{id}/activate | ApChallengeMicroservice.DefaultApi | cancelPrivateContest | POST /challenges/{id}/cancel | ApChallengeMicroservice.DefaultApi | challengeResultsGet | GET /challengeResults | ApChallengeMicroservice.DefaultApi | challengesGet | GET /challenges | ApChallengeMicroservice.DefaultApi | challengesIdGet | GET /challenges/{id} | ApChallengeMicroservice.DefaultApi | challengesIdPut | PUT /challenges/{id} | ApChallengeMicroservice.DefaultApi | challengesIdResourcesDelete | DELETE /challenges/{id}/resources | ApChallengeMicroservice.DefaultApi | challengesIdResourcesGet | GET /challenges/{id}/resources | ApChallengeMicroservice.DefaultApi | challengesIdResourcesPost | POST /challenges/{id}/resources | ApChallengeMicroservice.DefaultApi | challengesIdResultsGet | GET /challenges/{id}/results | ApChallengeMicroservice.DefaultApi | challengesMemberGet | GET /challenges/member | ApChallengeMicroservice.DefaultApi | closePrivateContest | POST /challenges/{id}/close | ApChallengeMicroservice.DefaultApi | directChallengesGet | GET /direct/challenges | ApChallengeMicroservice.DefaultApi | getChallengeLegacyInfo | GET /challenges/legacyinfo/{challengeId} | ApChallengeMicroservice.DefaultApi | getChallengeMetadata | GET /challenges/metadata | ApChallengeMicroservice.DefaultApi | getChallengeTypes | GET /challenge-types | ApChallengeMicroservice.DefaultApi | marathonMatcheResultsGet | GET /marathonMatcheResults | ApChallengeMicroservice.DefaultApi | marathonMatchesGet | GET /marathonMatches | ApChallengeMicroservice.DefaultApi | membersHandleChallengesGet | GET /members/{handle}/challenges | ApChallengeMicroservice.DefaultApi | membersHandleMmsGet | GET /members/{handle}/mms | ApChallengeMicroservice.DefaultApi | membersHandleSrmsGet | GET /members/{handle}/srms | ApChallengeMicroservice.DefaultApi | phasesGet | GET /phases | ApChallengeMicroservice.DefaultApi | platformsGet | GET /platforms | ApChallengeMicroservice.DefaultApi | platformsIdDelete | DELETE /platforms/{id} | ApChallengeMicroservice.DefaultApi | platformsIdPatch | PATCH /platforms/{id} | ApChallengeMicroservice.DefaultApi | platformsPost | POST /platforms | ApChallengeMicroservice.DefaultApi | registerChallenge | POST /challenges/{id}/register | ApChallengeMicroservice.DefaultApi | saveDraftContest | POST /challenges | ApChallengeMicroservice.DefaultApi | srmResultsGet | GET /srmResults | ApChallengeMicroservice.DefaultApi | srmsGet | GET /srms | ApChallengeMicroservice.DefaultApi | technologiesGet | GET /technologies | ApChallengeMicroservice.DefaultApi | technologiesIdDelete | DELETE /technologies/{id} | ApChallengeMicroservice.DefaultApi | technologiesIdPatch | PATCH /technologies/{id} | ApChallengeMicroservice.DefaultApi | technologiesPost | POST /technologies | ApChallengeMicroservice.DefaultApi | unregisterChallenge | POST /challenges/{id}/unregister |
Documentation for Models
- ApChallengeMicroservice.AddResourceBody
- ApChallengeMicroservice.Challenge
- ApChallengeMicroservice.ChallengeFailedRegisterUsers
- ApChallengeMicroservice.ChallengeProperties
- ApChallengeMicroservice.ChallengeResponse
- ApChallengeMicroservice.ChallengeResponseMetadata
- ApChallengeMicroservice.ChallengeResponseResult
- ApChallengeMicroservice.ChallengeTechnologies
- ApChallengeMicroservice.ChallengeTypeResponse
- ApChallengeMicroservice.ChallengeTypeResponseResult
- ApChallengeMicroservice.ChallengeTypeResponseResultContent
- ApChallengeMicroservice.ChallengeUpdate
- ApChallengeMicroservice.DirectChallenge
- ApChallengeMicroservice.DirectPrize
- ApChallengeMicroservice.ErrorModel
- ApChallengeMicroservice.ErrorModelResult
- ApChallengeMicroservice.ErrorResponse
- ApChallengeMicroservice.ErrorResponseError
- ApChallengeMicroservice.GetResourceResponse
- ApChallengeMicroservice.GetResourceResult
- ApChallengeMicroservice.InlineResponse200
- ApChallengeMicroservice.InlineResponse2001
- ApChallengeMicroservice.InlineResponse20010
- ApChallengeMicroservice.InlineResponse20010Result
- ApChallengeMicroservice.InlineResponse20010ResultContent
- ApChallengeMicroservice.InlineResponse20010ResultRounds
- ApChallengeMicroservice.InlineResponse20010ResultUserMMDetails
- ApChallengeMicroservice.InlineResponse20011
- ApChallengeMicroservice.InlineResponse20011Result
- ApChallengeMicroservice.InlineResponse20011ResultContent
- ApChallengeMicroservice.InlineResponse20011ResultContentCheckpoints
- ApChallengeMicroservice.InlineResponse20011ResultContentDocuments
- ApChallengeMicroservice.InlineResponse20011ResultContentEvent
- ApChallengeMicroservice.InlineResponse20011ResultContentPhases
- ApChallengeMicroservice.InlineResponse20011ResultContentRegistrants
- ApChallengeMicroservice.InlineResponse20011ResultContentSubmissions
- ApChallengeMicroservice.InlineResponse20011ResultContentSubmissions1
- ApChallengeMicroservice.InlineResponse20011ResultContentTerms
- ApChallengeMicroservice.InlineResponse20011ResultContentWinners
- ApChallengeMicroservice.InlineResponse20012
- ApChallengeMicroservice.InlineResponse20012Results
- ApChallengeMicroservice.InlineResponse20013
- ApChallengeMicroservice.InlineResponse20013Result
- ApChallengeMicroservice.InlineResponse20013ResultContent
- ApChallengeMicroservice.InlineResponse20014
- ApChallengeMicroservice.InlineResponse20014Result
- ApChallengeMicroservice.InlineResponse20014ResultContent
- ApChallengeMicroservice.InlineResponse20015
- ApChallengeMicroservice.InlineResponse20015Result
- ApChallengeMicroservice.InlineResponse2001Result
- ApChallengeMicroservice.InlineResponse2001ResultMetadata
- ApChallengeMicroservice.InlineResponse2002
- ApChallengeMicroservice.InlineResponse2002Result
- ApChallengeMicroservice.InlineResponse2002ResultContent
- ApChallengeMicroservice.InlineResponse2003
- ApChallengeMicroservice.InlineResponse2003Result
- ApChallengeMicroservice.InlineResponse2003ResultContent
- ApChallengeMicroservice.InlineResponse2004
- ApChallengeMicroservice.InlineResponse2004Result
- ApChallengeMicroservice.InlineResponse2004ResultContent
- ApChallengeMicroservice.InlineResponse2005
- ApChallengeMicroservice.InlineResponse2005Result
- ApChallengeMicroservice.InlineResponse2005ResultContent
- ApChallengeMicroservice.InlineResponse2006
- ApChallengeMicroservice.InlineResponse2006Result
- ApChallengeMicroservice.InlineResponse2006ResultContent
- ApChallengeMicroservice.InlineResponse2007
- ApChallengeMicroservice.InlineResponse2007Result
- ApChallengeMicroservice.InlineResponse2007ResultContent
- ApChallengeMicroservice.InlineResponse2008
- ApChallengeMicroservice.InlineResponse2008Result
- ApChallengeMicroservice.InlineResponse2008ResultContent
- ApChallengeMicroservice.InlineResponse2008ResultUserDetails
- ApChallengeMicroservice.InlineResponse2009
- ApChallengeMicroservice.InlineResponse2009Result
- ApChallengeMicroservice.InlineResponse2009ResultContent
- ApChallengeMicroservice.InlineResponse2009ResultRounds
- ApChallengeMicroservice.InlineResponse200Result
- ApChallengeMicroservice.InlineResponse200ResultContent
- ApChallengeMicroservice.InlineResponse200ResultEvents
- ApChallengeMicroservice.InlineResponse200ResultSubmissions
- ApChallengeMicroservice.InlineResponse200ResultWinners
- ApChallengeMicroservice.ManageResourceResponse
- ApChallengeMicroservice.ManageResourceResult
- ApChallengeMicroservice.NewChallengeBodyParam
- ApChallengeMicroservice.NewPlatformBodyParam
- ApChallengeMicroservice.NewTechnologyBodyParam
- ApChallengeMicroservice.NormalResponse
- ApChallengeMicroservice.NormalResponseResult
- ApChallengeMicroservice.NullResponse
- ApChallengeMicroservice.NullResponseResult
- ApChallengeMicroservice.Phases
- ApChallengeMicroservice.Platform
- ApChallengeMicroservice.PlatformArrayResponse
- ApChallengeMicroservice.PlatformArrayResponseResult
- ApChallengeMicroservice.PlatformResponse
- ApChallengeMicroservice.PlatformResponseResult
- ApChallengeMicroservice.RemoveResourceBody
- ApChallengeMicroservice.ResponseMetadata
- ApChallengeMicroservice.ResponseMetadataFields
- ApChallengeMicroservice.Status
- ApChallengeMicroservice.Technology
- ApChallengeMicroservice.TechnologyArrayResponse
- ApChallengeMicroservice.TechnologyArrayResponseResult
- ApChallengeMicroservice.TechnologyResponse
- ApChallengeMicroservice.TechnologyResponseResult
- ApChallengeMicroservice.UpdateChallengeBodyParam
- ApChallengeMicroservice.ValidationErrorModel
Documentation for Authorization
bearer
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header