govinfo-link-js
Version:
Access U.S. Government Publishing Office's FDsys (Federal Digital System) content and metadata collections using the govinfo-link-js client of Node.js and Web browsers.
169 lines (146 loc) • 6.57 kB
JavaScript
/**
* Govinfo-link-js
* <p>The <strong>govinfo</strong> Link Service provides services for developers and webmasters to access content and metadata on <strong>govinfo</strong>. Current and planned services include a link service, list service, and search service. Please contact <a href=\"https://www.gpo.gov/askgpo/\">askGPO</a> for additional information about current or planned services.</p> <p>The link service is used to create embedded links to content and metadata on <strong>govinfo</strong> and is currently enabled for the collections below. The collection code is listed in parenthesis after each collection name, and the available queries are listed below each collection. More information about each query is provided on the individual collection page.</p>
*
* OpenAPI spec version: 1.0.0
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
*
* Swagger Codegen version: 2.3.1
*
* Do not edit the class manually.
*
*/
(function (root, factory) {
if (typeof define === 'function' && define.amd) {
// AMD. Register as an anonymous module.
define(['ApiClient'], factory)
} else if (typeof module === 'object' && module.exports) {
// CommonJS-like environments that support module.exports, like Node.
module.exports = factory(require('../ApiClient'))
} else {
// Browser globals (root is window)
if (!root.govinfoLinkService) {
root.govinfoLinkService = {
}
}
root.govinfoLinkService.FederalRegister = factory(root.govinfoLinkService.ApiClient)
}
}(this, (ApiClient) => {
/**
* FederalRegisterFR service.
* @module api/FederalRegister
* @version 1.0.0
*/
/**
* Constructs a new FederalRegister.
*
* @alias module:api/FederalRegister
* @class
* @param {module:ApiClient} [apiClient] Optional API client implementation to use,
* default to {@link module:ApiClient#instance} if unspecified.
*/
const exports = function (apiClient) {
this.apiClient = apiClient || ApiClient.instance
/**
* Callback function to receive the result of the frDocFetchUsingGET operation.
* @callback module:api/FederalRegister~frDocFetchUsingGETCallback
* @param {String} error Error message, if any.
* @param {Object} data The data returned by the service call.
* @param {String} response The complete HTTP response.
*/
/**
* Query: Federal Register document number.
*
* @param {string} frdocnum - Required - The is the FR doc number that is listed at the end of each Federal Register document. Sample value is 2010-32535.
* @param {Object} opts - Optional parameters.
* @param {module:model/String} opts.linkType - This is the format of the returned document. Default is pdf. Other values are html, mods, premis, details, context, related.
* @param {module:api/FederalRegister~frDocFetchUsingGETCallback} callback The callback function, accepting three arguments: Error, data, response
* data is of type: {@link Object}.
*/
this.frDocFetchUsingGET = function (frdocnum, opts, callback) {
opts = opts || {
}
const postBody = null
// Verify the required parameter 'frdocnum' is set
if (frdocnum === undefined || frdocnum === null) {
throw new Error(`Missing the required parameter 'frdocnum' when calling frDocFetchUsingGET'`)
}
const pathParams = {
frdocnum
}
const queryParams = {
'link-type': opts.linkType
}
const collectionQueryParams = {
}
const headerParams = {
}
const formParams = {
}
const authNames = []
const contentTypes = ['application/json']
const accepts = ['*/*']
const returnType = Object
return this.apiClient.callApi(
'/fr/{frdocnum}', 'GET',
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType, callback
)
}
/**
* Callback function to receive the result of the frVolumeFetchUsingGET operation.
* @callback module:api/FederalRegister~frVolumeFetchUsingGETCallback
* @param {String} error Error message, if any.
* @param {Object} data The data returned by the service call.
* @param {String} response The complete HTTP response.
*/
/**
* Query: Volume, page number.
*
* @param {number} volume - This is the numerical volume number. Sample value is 76.
* @param {number} page - This is the numerical page number. Federal Register pages are numbered consecutively within a volume. Note: When multiple granules are contained on a page, content and metadata for the last granule on the page will be returned. Recommend selecting PDF link-type to return content for all granules on a page. Sample value is 575.
* @param {Object} opts - Optional parameters
* @param {module:model/String} opts.linkType - This is the format of the returned document. Default is pdf. Other values are html, mods, premis, details, context, related.
* @param {module:api/FederalRegister~frVolumeFetchUsingGETCallback} callback The callback function, accepting three arguments: error, data, response
* data is of type: {@link Object}
*/
this.frVolumeFetchUsingGET = function (volume, page, opts, callback) {
opts = opts || {
}
const postBody = null
// Verify the required parameter 'volume' is set
if (volume === undefined || volume === null) {
throw new Error(`Missing the required parameter 'volume' when calling frVolumeFetchUsingGET'`)
}
// Verify the required parameter 'page' is set
if (page === undefined || page === null) {
throw new Error(`Missing the required parameter 'page' when calling frVolumeFetchUsingGET'`)
}
const pathParams = {
volume,
page
}
const queryParams = {
'link-type': opts.linkType
}
const collectionQueryParams = {
}
const headerParams = {
}
const formParams = {
}
const authNames = []
const contentTypes = ['application/json']
const accepts = ['*/*']
const returnType = Object
return this.apiClient.callApi(
'/fr/{volume}/{page}', 'GET',
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType, callback
)
}
}
return exports
}))