-
Notifications
You must be signed in to change notification settings - Fork 73
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update v1 to v1.0.3 + Add important message in README.md
- Loading branch information
Showing
64 changed files
with
1,238 additions
and
377 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| var Allocations = require('./gen/allocations'); | ||
|
|
||
| module.exports = Allocations; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| /** | ||
| * This file is auto-generated by our openapi spec. | ||
| * We try to keep the generated code pretty clean but there will be lint | ||
| * errors that are just not worth fixing (like unused requires). | ||
| * TODO: maybe we can just disable those specifically and keep this code | ||
| * pretty lint-free too! | ||
| */ | ||
| /* jshint ignore:start */ | ||
| var Resource = require('../resource'); | ||
| var util = require('util'); | ||
| var _ = require('lodash'); | ||
|
|
||
| function Allocations(dispatcher) { | ||
| Resource.call(this, dispatcher); | ||
| } | ||
| util.inherits(Allocations, Resource); | ||
|
|
||
|
|
||
| /** | ||
| * Create an allocation | ||
| * @param {Object} data: Data for the request | ||
| * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request | ||
| * @return {Promise} The requested resource | ||
| */ | ||
| Allocations.prototype.createAllocation = function( | ||
| data, | ||
| dispatchOptions | ||
| ) { | ||
| var path = "/allocations"; | ||
|
|
||
| return this.dispatchPost(path, data, dispatchOptions) | ||
| }; | ||
|
|
||
|
|
||
| /** | ||
| * Delete an allocation | ||
| * @param {String} allocationGid: (required) Globally unique identifier for the allocation. | ||
| * @param {Object} data: Data for the request | ||
| * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request | ||
| * @return {Promise} The requested resource | ||
| */ | ||
| Allocations.prototype.deleteAllocation = function( | ||
| allocationGid, | ||
| data, | ||
| dispatchOptions | ||
| ) { | ||
| var path = "/allocations/{allocation_gid}".replace("{allocation_gid}", allocationGid); | ||
|
|
||
| return this.dispatchDelete(path, data, dispatchOptions) | ||
| }; | ||
|
|
||
|
|
||
| /** | ||
| * Get an allocation | ||
| * @param {String} allocationGid: (required) Globally unique identifier for the allocation. | ||
| * @param {Object} params: Parameters for the request | ||
| - optFields {[String]}: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ||
| - optPretty {Boolean}: Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ||
| * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request | ||
| * @return {Promise} The requested resource | ||
| */ | ||
| Allocations.prototype.getAllocation = function( | ||
| allocationGid, | ||
| params, | ||
| dispatchOptions | ||
| ) { | ||
| var path = "/allocations/{allocation_gid}".replace("{allocation_gid}", allocationGid); | ||
|
|
||
| return this.dispatchGet(path, params, dispatchOptions) | ||
| }; | ||
|
|
||
|
|
||
| /** | ||
| * Get multiple allocations | ||
| * @param {Object} params: Parameters for the request | ||
| - parent {String}: Globally unique identifier for the project to filter allocations by. | ||
| - assignee {String}: Globally unique identifier for the user the allocation is assigned to. | ||
| - workspace {String}: Globally unique identifier for the workspace. | ||
| - offset {String}: Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | ||
| - limit {Number}: Results per page. The number of objects to return per page. The value must be between 1 and 100. | ||
| - optFields {[String]}: This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ||
| - optPretty {Boolean}: Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ||
| * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request | ||
| * @return {Promise} The requested resource | ||
| */ | ||
| Allocations.prototype.getAllocations = function( | ||
| params, | ||
| dispatchOptions | ||
| ) { | ||
| var path = "/allocations"; | ||
|
|
||
| return this.dispatchGetCollection(path, params, dispatchOptions) | ||
| }; | ||
|
|
||
|
|
||
| /** | ||
| * Update an allocation | ||
| * @param {String} allocationGid: (required) Globally unique identifier for the allocation. | ||
| * @param {Object} data: Data for the request | ||
| * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request | ||
| * @return {Promise} The requested resource | ||
| */ | ||
| Allocations.prototype.updateAllocation = function( | ||
| allocationGid, | ||
| data, | ||
| dispatchOptions | ||
| ) { | ||
| var path = "/allocations/{allocation_gid}".replace("{allocation_gid}", allocationGid); | ||
|
|
||
| return this.dispatchPut(path, data, dispatchOptions) | ||
| }; | ||
|
|
||
| module.exports = Allocations; | ||
| /* jshint ignore:end */ |
Oops, something went wrong.