|
| 1 | +# ap_challenge_microservice |
| 2 | + |
| 3 | +ApChallengeMicroservice - JavaScript client for ap_challenge_microservice |
| 4 | +Services that provide access and interaction with all sorts of challenges, including design, dev, single round matches, and marathon matches. |
| 5 | +This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: |
| 6 | + |
| 7 | +- API version: 1.0.5 |
| 8 | +- Package version: 1.0.5 |
| 9 | +- Build package: io.swagger.codegen.languages.JavascriptClientCodegen |
| 10 | + |
| 11 | +## Installation |
| 12 | + |
| 13 | +### For [Node.js](https://nodejs.org/) |
| 14 | + |
| 15 | +#### npm |
| 16 | + |
| 17 | +To publish the library as a [npm](https://www.npmjs.com/), |
| 18 | +please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). |
| 19 | + |
| 20 | +Then install it via: |
| 21 | + |
| 22 | +```shell |
| 23 | +npm install ap_challenge_microservice --save |
| 24 | +``` |
| 25 | + |
| 26 | +#### git |
| 27 | +# |
| 28 | +If the library is hosted at a git repository, e.g. |
| 29 | +https://github.com/YOUR_USERNAME/ap_challenge_microservice |
| 30 | +then install it via: |
| 31 | + |
| 32 | +```shell |
| 33 | + npm install YOUR_USERNAME/ap_challenge_microservice --save |
| 34 | +``` |
| 35 | + |
| 36 | +### For browser |
| 37 | + |
| 38 | +The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following |
| 39 | +the above steps with Node.js and installing browserify with `npm install -g browserify`, |
| 40 | +perform the following (assuming *main.js* is your entry file): |
| 41 | + |
| 42 | +```shell |
| 43 | +browserify main.js > bundle.js |
| 44 | +``` |
| 45 | + |
| 46 | +Then include *bundle.js* in the HTML pages. |
| 47 | + |
| 48 | +## Getting Started |
| 49 | + |
| 50 | +Please follow the [installation](#installation) instruction and execute the following JS code: |
| 51 | + |
| 52 | +```javascript |
| 53 | +var ApChallengeMicroservice = require('ap_challenge_microservice'); |
| 54 | + |
| 55 | +var defaultClient = ApChallengeMicroservice.ApiClient.instance; |
| 56 | + |
| 57 | +// Configure API key authorization: bearer |
| 58 | +var bearer = defaultClient.authentications['bearer']; |
| 59 | +bearer.apiKey = "YOUR API KEY" |
| 60 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 61 | +//bearer.apiKeyPrefix['Authorization'] = "Token" |
| 62 | + |
| 63 | +var api = new ApChallengeMicroservice.DefaultApi() |
| 64 | + |
| 65 | +var id = "id_example"; // {String} the id of the draft challenge |
| 66 | + |
| 67 | + |
| 68 | +var callback = function(error, data, response) { |
| 69 | + if (error) { |
| 70 | + console.error(error); |
| 71 | + } else { |
| 72 | + console.log('API called successfully. Returned data: ' + data); |
| 73 | + } |
| 74 | +}; |
| 75 | +api.activateChallenge(id, callback); |
| 76 | + |
| 77 | +``` |
| 78 | + |
| 79 | +## Documentation for API Endpoints |
| 80 | + |
| 81 | +All URIs are relative to *http://api.topcoder.com/v3* |
| 82 | + |
| 83 | +Class | Method | HTTP request | Description |
| 84 | +------------ | ------------- | ------------- | ------------- |
| 85 | +*ApChallengeMicroservice.DefaultApi* | [**activateChallenge**](docs/DefaultApi.md#activateChallenge) | **POST** /challenges/{id}/activate | |
| 86 | +*ApChallengeMicroservice.DefaultApi* | [**cancelPrivateContest**](docs/DefaultApi.md#cancelPrivateContest) | **POST** /challenges/{id}/cancel | |
| 87 | +*ApChallengeMicroservice.DefaultApi* | [**challengeResultsGet**](docs/DefaultApi.md#challengeResultsGet) | **GET** /challengeResults | |
| 88 | +*ApChallengeMicroservice.DefaultApi* | [**challengesGet**](docs/DefaultApi.md#challengesGet) | **GET** /challenges | |
| 89 | +*ApChallengeMicroservice.DefaultApi* | [**challengesIdResourcesDelete**](docs/DefaultApi.md#challengesIdResourcesDelete) | **DELETE** /challenges/{id}/resources | |
| 90 | +*ApChallengeMicroservice.DefaultApi* | [**challengesIdResourcesGet**](docs/DefaultApi.md#challengesIdResourcesGet) | **GET** /challenges/{id}/resources | |
| 91 | +*ApChallengeMicroservice.DefaultApi* | [**challengesIdResourcesPost**](docs/DefaultApi.md#challengesIdResourcesPost) | **POST** /challenges/{id}/resources | |
| 92 | +*ApChallengeMicroservice.DefaultApi* | [**closePrivateContest**](docs/DefaultApi.md#closePrivateContest) | **POST** /challenges/{id}/close | |
| 93 | +*ApChallengeMicroservice.DefaultApi* | [**marathonMatcheResultsGet**](docs/DefaultApi.md#marathonMatcheResultsGet) | **GET** /marathonMatcheResults | |
| 94 | +*ApChallengeMicroservice.DefaultApi* | [**marathonMatchesGet**](docs/DefaultApi.md#marathonMatchesGet) | **GET** /marathonMatches | |
| 95 | +*ApChallengeMicroservice.DefaultApi* | [**membersHandleChallengesGet**](docs/DefaultApi.md#membersHandleChallengesGet) | **GET** /members/{handle}/challenges | |
| 96 | +*ApChallengeMicroservice.DefaultApi* | [**membersHandleMmsGet**](docs/DefaultApi.md#membersHandleMmsGet) | **GET** /members/{handle}/mms | |
| 97 | +*ApChallengeMicroservice.DefaultApi* | [**membersHandleSrmsGet**](docs/DefaultApi.md#membersHandleSrmsGet) | **GET** /members/{handle}/srms | |
| 98 | +*ApChallengeMicroservice.DefaultApi* | [**phasesGet**](docs/DefaultApi.md#phasesGet) | **GET** /phases | |
| 99 | +*ApChallengeMicroservice.DefaultApi* | [**platformsGet**](docs/DefaultApi.md#platformsGet) | **GET** /platforms | |
| 100 | +*ApChallengeMicroservice.DefaultApi* | [**platformsIdDelete**](docs/DefaultApi.md#platformsIdDelete) | **DELETE** /platforms/{id} | |
| 101 | +*ApChallengeMicroservice.DefaultApi* | [**platformsIdPatch**](docs/DefaultApi.md#platformsIdPatch) | **PATCH** /platforms/{id} | |
| 102 | +*ApChallengeMicroservice.DefaultApi* | [**platformsPost**](docs/DefaultApi.md#platformsPost) | **POST** /platforms | |
| 103 | +*ApChallengeMicroservice.DefaultApi* | [**saveDraftContest**](docs/DefaultApi.md#saveDraftContest) | **POST** /challenges | |
| 104 | +*ApChallengeMicroservice.DefaultApi* | [**srmResultsGet**](docs/DefaultApi.md#srmResultsGet) | **GET** /srmResults | |
| 105 | +*ApChallengeMicroservice.DefaultApi* | [**srmsGet**](docs/DefaultApi.md#srmsGet) | **GET** /srms | |
| 106 | +*ApChallengeMicroservice.DefaultApi* | [**technologiesGet**](docs/DefaultApi.md#technologiesGet) | **GET** /technologies | |
| 107 | +*ApChallengeMicroservice.DefaultApi* | [**technologiesIdDelete**](docs/DefaultApi.md#technologiesIdDelete) | **DELETE** /technologies/{id} | |
| 108 | +*ApChallengeMicroservice.DefaultApi* | [**technologiesIdPatch**](docs/DefaultApi.md#technologiesIdPatch) | **PATCH** /technologies/{id} | |
| 109 | +*ApChallengeMicroservice.DefaultApi* | [**technologiesPost**](docs/DefaultApi.md#technologiesPost) | **POST** /technologies | |
| 110 | + |
| 111 | + |
| 112 | +## Documentation for Models |
| 113 | + |
| 114 | + - [ApChallengeMicroservice.AddResourceBody](docs/AddResourceBody.md) |
| 115 | + - [ApChallengeMicroservice.Challenge](docs/Challenge.md) |
| 116 | + - [ApChallengeMicroservice.ChallengeFailedRegisterUsers](docs/ChallengeFailedRegisterUsers.md) |
| 117 | + - [ApChallengeMicroservice.ChallengeProperties](docs/ChallengeProperties.md) |
| 118 | + - [ApChallengeMicroservice.ChallengeResponse](docs/ChallengeResponse.md) |
| 119 | + - [ApChallengeMicroservice.ChallengeResponseResult](docs/ChallengeResponseResult.md) |
| 120 | + - [ApChallengeMicroservice.ChallengeTechnologies](docs/ChallengeTechnologies.md) |
| 121 | + - [ApChallengeMicroservice.ErrorModel](docs/ErrorModel.md) |
| 122 | + - [ApChallengeMicroservice.ErrorModelResult](docs/ErrorModelResult.md) |
| 123 | + - [ApChallengeMicroservice.GetResourceResponse](docs/GetResourceResponse.md) |
| 124 | + - [ApChallengeMicroservice.GetResourceResult](docs/GetResourceResult.md) |
| 125 | + - [ApChallengeMicroservice.InlineResponse200](docs/InlineResponse200.md) |
| 126 | + - [ApChallengeMicroservice.InlineResponse2001](docs/InlineResponse2001.md) |
| 127 | + - [ApChallengeMicroservice.InlineResponse2001Result](docs/InlineResponse2001Result.md) |
| 128 | + - [ApChallengeMicroservice.InlineResponse2001ResultContent](docs/InlineResponse2001ResultContent.md) |
| 129 | + - [ApChallengeMicroservice.InlineResponse2002](docs/InlineResponse2002.md) |
| 130 | + - [ApChallengeMicroservice.InlineResponse2002Result](docs/InlineResponse2002Result.md) |
| 131 | + - [ApChallengeMicroservice.InlineResponse2002ResultContent](docs/InlineResponse2002ResultContent.md) |
| 132 | + - [ApChallengeMicroservice.InlineResponse2003](docs/InlineResponse2003.md) |
| 133 | + - [ApChallengeMicroservice.InlineResponse2003Result](docs/InlineResponse2003Result.md) |
| 134 | + - [ApChallengeMicroservice.InlineResponse2003ResultContent](docs/InlineResponse2003ResultContent.md) |
| 135 | + - [ApChallengeMicroservice.InlineResponse2004](docs/InlineResponse2004.md) |
| 136 | + - [ApChallengeMicroservice.InlineResponse2004Result](docs/InlineResponse2004Result.md) |
| 137 | + - [ApChallengeMicroservice.InlineResponse2004ResultContent](docs/InlineResponse2004ResultContent.md) |
| 138 | + - [ApChallengeMicroservice.InlineResponse2005](docs/InlineResponse2005.md) |
| 139 | + - [ApChallengeMicroservice.InlineResponse2005Result](docs/InlineResponse2005Result.md) |
| 140 | + - [ApChallengeMicroservice.InlineResponse2005ResultContent](docs/InlineResponse2005ResultContent.md) |
| 141 | + - [ApChallengeMicroservice.InlineResponse2006](docs/InlineResponse2006.md) |
| 142 | + - [ApChallengeMicroservice.InlineResponse2006Result](docs/InlineResponse2006Result.md) |
| 143 | + - [ApChallengeMicroservice.InlineResponse2006ResultContent](docs/InlineResponse2006ResultContent.md) |
| 144 | + - [ApChallengeMicroservice.InlineResponse2007](docs/InlineResponse2007.md) |
| 145 | + - [ApChallengeMicroservice.InlineResponse2007Result](docs/InlineResponse2007Result.md) |
| 146 | + - [ApChallengeMicroservice.InlineResponse2007ResultContent](docs/InlineResponse2007ResultContent.md) |
| 147 | + - [ApChallengeMicroservice.InlineResponse2007ResultUserDetails](docs/InlineResponse2007ResultUserDetails.md) |
| 148 | + - [ApChallengeMicroservice.InlineResponse2008](docs/InlineResponse2008.md) |
| 149 | + - [ApChallengeMicroservice.InlineResponse2008Result](docs/InlineResponse2008Result.md) |
| 150 | + - [ApChallengeMicroservice.InlineResponse2008ResultContent](docs/InlineResponse2008ResultContent.md) |
| 151 | + - [ApChallengeMicroservice.InlineResponse2008ResultRounds](docs/InlineResponse2008ResultRounds.md) |
| 152 | + - [ApChallengeMicroservice.InlineResponse2009](docs/InlineResponse2009.md) |
| 153 | + - [ApChallengeMicroservice.InlineResponse2009Result](docs/InlineResponse2009Result.md) |
| 154 | + - [ApChallengeMicroservice.InlineResponse2009ResultContent](docs/InlineResponse2009ResultContent.md) |
| 155 | + - [ApChallengeMicroservice.InlineResponse2009ResultRounds](docs/InlineResponse2009ResultRounds.md) |
| 156 | + - [ApChallengeMicroservice.InlineResponse2009ResultUserMMDetails](docs/InlineResponse2009ResultUserMMDetails.md) |
| 157 | + - [ApChallengeMicroservice.InlineResponse200Result](docs/InlineResponse200Result.md) |
| 158 | + - [ApChallengeMicroservice.InlineResponse200ResultContent](docs/InlineResponse200ResultContent.md) |
| 159 | + - [ApChallengeMicroservice.InlineResponse200ResultSubmissions](docs/InlineResponse200ResultSubmissions.md) |
| 160 | + - [ApChallengeMicroservice.ManageResourceResponse](docs/ManageResourceResponse.md) |
| 161 | + - [ApChallengeMicroservice.ManageResourceResult](docs/ManageResourceResult.md) |
| 162 | + - [ApChallengeMicroservice.NewChallengeBodyParam](docs/NewChallengeBodyParam.md) |
| 163 | + - [ApChallengeMicroservice.NewPlatformBodyParam](docs/NewPlatformBodyParam.md) |
| 164 | + - [ApChallengeMicroservice.NewTechnologyBodyParam](docs/NewTechnologyBodyParam.md) |
| 165 | + - [ApChallengeMicroservice.NormalResponse](docs/NormalResponse.md) |
| 166 | + - [ApChallengeMicroservice.NormalResponseResult](docs/NormalResponseResult.md) |
| 167 | + - [ApChallengeMicroservice.NullResponse](docs/NullResponse.md) |
| 168 | + - [ApChallengeMicroservice.NullResponseResult](docs/NullResponseResult.md) |
| 169 | + - [ApChallengeMicroservice.Platform](docs/Platform.md) |
| 170 | + - [ApChallengeMicroservice.PlatformArrayResponse](docs/PlatformArrayResponse.md) |
| 171 | + - [ApChallengeMicroservice.PlatformArrayResponseResult](docs/PlatformArrayResponseResult.md) |
| 172 | + - [ApChallengeMicroservice.PlatformResponse](docs/PlatformResponse.md) |
| 173 | + - [ApChallengeMicroservice.PlatformResponseResult](docs/PlatformResponseResult.md) |
| 174 | + - [ApChallengeMicroservice.RemoveResourceBody](docs/RemoveResourceBody.md) |
| 175 | + - [ApChallengeMicroservice.ResponseMetadata](docs/ResponseMetadata.md) |
| 176 | + - [ApChallengeMicroservice.Status](docs/Status.md) |
| 177 | + - [ApChallengeMicroservice.Technology](docs/Technology.md) |
| 178 | + - [ApChallengeMicroservice.TechnologyArrayResponse](docs/TechnologyArrayResponse.md) |
| 179 | + - [ApChallengeMicroservice.TechnologyArrayResponseResult](docs/TechnologyArrayResponseResult.md) |
| 180 | + - [ApChallengeMicroservice.TechnologyResponse](docs/TechnologyResponse.md) |
| 181 | + - [ApChallengeMicroservice.TechnologyResponseResult](docs/TechnologyResponseResult.md) |
| 182 | + - [ApChallengeMicroservice.ValidationErrorModel](docs/ValidationErrorModel.md) |
| 183 | + |
| 184 | + |
| 185 | +## Documentation for Authorization |
| 186 | + |
| 187 | + |
| 188 | +### bearer |
| 189 | + |
| 190 | +- **Type**: API key |
| 191 | +- **API key parameter name**: Authorization |
| 192 | +- **Location**: HTTP header |
| 193 | + |
0 commit comments