green_link_api

GreenLinkApi - JavaScript client for green_link_api ⚡GreenLink API documentation with interactive tools for testing API endpoints.⚡ This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.1.0
• Package version: 1.1.0
• Build package: org.openapitools.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 green_link_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 green_link_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 GreenLinkApi = require('green_link_api');

var defaultClient = GreenLinkApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'
// Configure Bearer (JWT) access token for authorization: jwtAuth
var jwtAuth = defaultClient.authentications['jwtAuth'];
jwtAuth.accessToken = "YOUR ACCESS TOKEN"
// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new GreenLinkApi.BlockchainApi()
var smartContract = new GreenLinkApi.SmartContract(); // {SmartContract} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.blockchainSmartContractsCreate(smartContract, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
GreenLinkApi.BlockchainApi	blockchainSmartContractsCreate	POST /blockchain/smart-contracts/
GreenLinkApi.BlockchainApi	blockchainSmartContractsDestroy	DELETE /blockchain/smart-contracts/{id}/
GreenLinkApi.BlockchainApi	blockchainSmartContractsList	GET /blockchain/smart-contracts/
GreenLinkApi.BlockchainApi	blockchainSmartContractsPartialUpdate	PATCH /blockchain/smart-contracts/{id}/
GreenLinkApi.BlockchainApi	blockchainSmartContractsRetrieve	GET /blockchain/smart-contracts/{id}/
GreenLinkApi.BlockchainApi	blockchainSmartContractsUpdate	PUT /blockchain/smart-contracts/{id}/
GreenLinkApi.EnergyAssetsApi	energyAssetsConsumptionSitesCreate	POST /energy-assets/consumption-sites/
GreenLinkApi.EnergyAssetsApi	energyAssetsConsumptionSitesDestroy	DELETE /energy-assets/consumption-sites/{id}/
GreenLinkApi.EnergyAssetsApi	energyAssetsConsumptionSitesImportDataCreate	POST /energy-assets/consumption-sites/import-data/
GreenLinkApi.EnergyAssetsApi	energyAssetsConsumptionSitesList	GET /energy-assets/consumption-sites/
GreenLinkApi.EnergyAssetsApi	energyAssetsConsumptionSitesManyCreate	POST /energy-assets/consumption-sites/many/
GreenLinkApi.EnergyAssetsApi	energyAssetsConsumptionSitesPartialUpdate	PATCH /energy-assets/consumption-sites/{id}/
GreenLinkApi.EnergyAssetsApi	energyAssetsConsumptionSitesRetrieve	GET /energy-assets/consumption-sites/{id}/
GreenLinkApi.EnergyAssetsApi	energyAssetsConsumptionSitesUpdate	PUT /energy-assets/consumption-sites/{id}/
GreenLinkApi.EnergyAssetsApi	energyAssetsConsumptionSitesUploadFileCreate	POST /energy-assets/consumption-sites/upload-file/
GreenLinkApi.EnergyAssetsApi	energyAssetsProductionSitesCreate	POST /energy-assets/production-sites/
GreenLinkApi.EnergyAssetsApi	energyAssetsProductionSitesDestroy	DELETE /energy-assets/production-sites/{id}/
GreenLinkApi.EnergyAssetsApi	energyAssetsProductionSitesList	GET /energy-assets/production-sites/
GreenLinkApi.EnergyAssetsApi	energyAssetsProductionSitesPartialUpdate	PATCH /energy-assets/production-sites/{id}/
GreenLinkApi.EnergyAssetsApi	energyAssetsProductionSitesRetrieve	GET /energy-assets/production-sites/{id}/
GreenLinkApi.EnergyAssetsApi	energyAssetsProductionSitesUpdate	PUT /energy-assets/production-sites/{id}/
GreenLinkApi.EnergyAssetsApi	energyAssetsProductionSitesUploadFileCreate	POST /energy-assets/production-sites/upload-file/
GreenLinkApi.EnergyDataApi	energyDataConsumptionDataCreate	POST /energy-data/consumption-data/
GreenLinkApi.EnergyDataApi	energyDataConsumptionDataDestroy	DELETE /energy-data/consumption-data/{id}/
GreenLinkApi.EnergyDataApi	energyDataConsumptionDataImportDataCreate	POST /energy-data/consumption-data/import-data/
GreenLinkApi.EnergyDataApi	energyDataConsumptionDataList	GET /energy-data/consumption-data/
GreenLinkApi.EnergyDataApi	energyDataConsumptionDataPartialUpdate	PATCH /energy-data/consumption-data/{id}/
GreenLinkApi.EnergyDataApi	energyDataConsumptionDataRetrieve	GET /energy-data/consumption-data/{id}/
GreenLinkApi.EnergyDataApi	energyDataConsumptionDataUpdate	PUT /energy-data/consumption-data/{id}/
GreenLinkApi.EnergyDataApi	energyDataConsumptionDataUploadFileCreate	POST /energy-data/consumption-data/upload-file/
GreenLinkApi.EnergyDataApi	energyDataEmissionFactorCreate	POST /energy-data/emission-factor/
GreenLinkApi.EnergyDataApi	energyDataEmissionFactorDestroy	DELETE /energy-data/emission-factor/{id}/
GreenLinkApi.EnergyDataApi	energyDataEmissionFactorList	GET /energy-data/emission-factor/
GreenLinkApi.EnergyDataApi	energyDataEmissionFactorPartialUpdate	PATCH /energy-data/emission-factor/{id}/
GreenLinkApi.EnergyDataApi	energyDataEmissionFactorRetrieve	GET /energy-data/emission-factor/{id}/
GreenLinkApi.EnergyDataApi	energyDataEmissionFactorUpdate	PUT /energy-data/emission-factor/{id}/
GreenLinkApi.EnergyDataApi	energyDataMatchRequestList	GET /energy-data/match-request/
GreenLinkApi.EnergyDataApi	energyDataMatchRequestRetrieve	GET /energy-data/match-request/{id}/
GreenLinkApi.EnergyDataApi	energyDataMatchedEnergyDataCreate	POST /energy-data/matched-energy-data/
GreenLinkApi.EnergyDataApi	energyDataMatchedEnergyDataList	GET /energy-data/matched-energy-data/
GreenLinkApi.EnergyDataApi	energyDataMatchedEnergyDataMatchConsumerCreate	POST /energy-data/matched-energy-data/match-consumer/
GreenLinkApi.EnergyDataApi	energyDataMatchedEnergyDataMatchSiteCreate	POST /energy-data/matched-energy-data/match-site/
GreenLinkApi.EnergyDataApi	energyDataMatchedEnergyDataRetrieve	GET /energy-data/matched-energy-data/{id}/
GreenLinkApi.EnergyDataApi	energyDataProductionDataCreate	POST /energy-data/production-data/
GreenLinkApi.EnergyDataApi	energyDataProductionDataDestroy	DELETE /energy-data/production-data/{id}/
GreenLinkApi.EnergyDataApi	energyDataProductionDataGetFromEpiasAndInsertCreate	POST /energy-data/production-data/get_from_epias_and_insert/
GreenLinkApi.EnergyDataApi	energyDataProductionDataList	GET /energy-data/production-data/
GreenLinkApi.EnergyDataApi	energyDataProductionDataPartialUpdate	PATCH /energy-data/production-data/{id}/
GreenLinkApi.EnergyDataApi	energyDataProductionDataRetrieve	GET /energy-data/production-data/{id}/
GreenLinkApi.EnergyDataApi	energyDataProductionDataUpdate	PUT /energy-data/production-data/{id}/
GreenLinkApi.EnergyDataApi	energyDataProductionDataUploadFileCreate	POST /energy-data/production-data/upload-file/
GreenLinkApi.HealthCheckApi	healthCheckRetrieve	GET /health-check/
GreenLinkApi.LicensedProductionSitesOnEpiasApi	licensedProductionSitesOnEpiasRetrieve	GET /licensed-production-sites-on-epias/
GreenLinkApi.LocationsApi	locationsConsumptionSitesRetrieve	GET /locations/consumption-sites/
GreenLinkApi.LocationsApi	locationsCreate	POST /locations/
GreenLinkApi.LocationsApi	locationsDestroy	DELETE /locations/{id}/
GreenLinkApi.LocationsApi	locationsList	GET /locations/
GreenLinkApi.LocationsApi	locationsPartialUpdate	PATCH /locations/{id}/
GreenLinkApi.LocationsApi	locationsProductionSitesRetrieve	GET /locations/production-sites/
GreenLinkApi.LocationsApi	locationsRetrieve	GET /locations/{id}/
GreenLinkApi.LocationsApi	locationsUpdate	PUT /locations/{id}/
GreenLinkApi.LogsApi	logsProductionEpiasDestroy	DELETE /logs/production-epias/{id}/
GreenLinkApi.LogsApi	logsProductionEpiasList	GET /logs/production-epias/
GreenLinkApi.LogsApi	logsProductionEpiasRetrieve	GET /logs/production-epias/{id}/
GreenLinkApi.LogsApi	logsUnprocessedRowDestroy	DELETE /logs/unprocessed-row/{id}/
GreenLinkApi.LogsApi	logsUnprocessedRowList	GET /logs/unprocessed-row/
GreenLinkApi.LogsApi	logsUnprocessedRowRetrieve	GET /logs/unprocessed-row/{id}/
GreenLinkApi.LogsApi	logsUploadFileDestroy	DELETE /logs/upload-file/{id}/
GreenLinkApi.LogsApi	logsUploadFileList	GET /logs/upload-file/
GreenLinkApi.LogsApi	logsUploadFileRetrieve	GET /logs/upload-file/{id}/
GreenLinkApi.MaintenanceCheckApi	maintenanceCheckRetrieve	GET /maintenance-check/
GreenLinkApi.OrganizationprofilesApi	organizationprofilesEnergySourcePreferenceCreate	POST /organizationprofiles/energy-source-preference/
GreenLinkApi.OrganizationprofilesApi	organizationprofilesEnergySourcePreferenceDestroy	DELETE /organizationprofiles/energy-source-preference/{id}/
GreenLinkApi.OrganizationprofilesApi	organizationprofilesEnergySourcePreferenceList	GET /organizationprofiles/energy-source-preference/
GreenLinkApi.OrganizationprofilesApi	organizationprofilesEnergySourcePreferencePartialUpdate	PATCH /organizationprofiles/energy-source-preference/{id}/
GreenLinkApi.OrganizationprofilesApi	organizationprofilesEnergySourcePreferenceRetrieve	GET /organizationprofiles/energy-source-preference/{id}/
GreenLinkApi.OrganizationprofilesApi	organizationprofilesEnergySourcePreferenceUpdate	PUT /organizationprofiles/energy-source-preference/{id}/
GreenLinkApi.OrganizationsApi	organizationsConsumersCreate	POST /organizations/consumers/
GreenLinkApi.OrganizationsApi	organizationsConsumersDestroy	DELETE /organizations/consumers/{id}/
GreenLinkApi.OrganizationsApi	organizationsConsumersList	GET /organizations/consumers/
GreenLinkApi.OrganizationsApi	organizationsConsumersPartialUpdate	PATCH /organizations/consumers/{id}/
GreenLinkApi.OrganizationsApi	organizationsConsumersRetrieve	GET /organizations/consumers/{id}/
GreenLinkApi.OrganizationsApi	organizationsConsumersUpdate	PUT /organizations/consumers/{id}/
GreenLinkApi.OrganizationsApi	organizationsGridoperatorsCreate	POST /organizations/gridoperators/
GreenLinkApi.OrganizationsApi	organizationsGridoperatorsDestroy	DELETE /organizations/gridoperators/{id}/
GreenLinkApi.OrganizationsApi	organizationsGridoperatorsList	GET /organizations/gridoperators/
GreenLinkApi.OrganizationsApi	organizationsGridoperatorsPartialUpdate	PATCH /organizations/gridoperators/{id}/
GreenLinkApi.OrganizationsApi	organizationsGridoperatorsRetrieve	GET /organizations/gridoperators/{id}/
GreenLinkApi.OrganizationsApi	organizationsGridoperatorsUpdate	PUT /organizations/gridoperators/{id}/
GreenLinkApi.OrganizationsApi	organizationsIssuersCreate	POST /organizations/issuers/
GreenLinkApi.OrganizationsApi	organizationsIssuersDestroy	DELETE /organizations/issuers/{id}/
GreenLinkApi.OrganizationsApi	organizationsIssuersList	GET /organizations/issuers/
GreenLinkApi.OrganizationsApi	organizationsIssuersPartialUpdate	PATCH /organizations/issuers/{id}/
GreenLinkApi.OrganizationsApi	organizationsIssuersRetrieve	GET /organizations/issuers/{id}/
GreenLinkApi.OrganizationsApi	organizationsIssuersUpdate	PUT /organizations/issuers/{id}/
GreenLinkApi.OrganizationsApi	organizationsProducersCreate	POST /organizations/producers/
GreenLinkApi.OrganizationsApi	organizationsProducersDestroy	DELETE /organizations/producers/{id}/
GreenLinkApi.OrganizationsApi	organizationsProducersList	GET /organizations/producers/
GreenLinkApi.OrganizationsApi	organizationsProducersPartialUpdate	PATCH /organizations/producers/{id}/
GreenLinkApi.OrganizationsApi	organizationsProducersRetrieve	GET /organizations/producers/{id}/
GreenLinkApi.OrganizationsApi	organizationsProducersUpdate	PUT /organizations/producers/{id}/
GreenLinkApi.OrganizationsApi	organizationsRetailersCreate	POST /organizations/retailers/
GreenLinkApi.OrganizationsApi	organizationsRetailersDestroy	DELETE /organizations/retailers/{id}/
GreenLinkApi.OrganizationsApi	organizationsRetailersList	GET /organizations/retailers/
GreenLinkApi.OrganizationsApi	organizationsRetailersPartialUpdate	PATCH /organizations/retailers/{id}/
GreenLinkApi.OrganizationsApi	organizationsRetailersRetrieve	GET /organizations/retailers/{id}/
GreenLinkApi.OrganizationsApi	organizationsRetailersUpdate	PUT /organizations/retailers/{id}/
GreenLinkApi.SchemaApi	schemaRetrieve	GET /schema/
GreenLinkApi.SentryDebugApi	sentryDebugRetrieve	GET /sentry-debug/
GreenLinkApi.UsersApi	usersDestroy	DELETE /users/{id}/
GreenLinkApi.UsersApi	usersList	GET /users/
GreenLinkApi.UsersApi	usersLoginCreate	POST /users/login/
GreenLinkApi.UsersApi	usersLogoutCreate	POST /users/logout/
GreenLinkApi.UsersApi	usersPartialUpdate	PATCH /users/{id}/
GreenLinkApi.UsersApi	usersRegistrationCreate	POST /users/registration/
GreenLinkApi.UsersApi	usersRetrieve	GET /users/{id}/
GreenLinkApi.UsersApi	usersUserDetailsPartialUpdate	PATCH /users/user-details/
GreenLinkApi.UsersApi	usersUserDetailsRetrieve	GET /users/user-details/
GreenLinkApi.UsersApi	usersUserDetailsUpdate	PUT /users/user-details/

Documentation for Models

• GreenLinkApi.BlockchainTransaction
• GreenLinkApi.Consumer
• GreenLinkApi.ConsumptionDataFileList
• GreenLinkApi.ConsumptionDataFromRetailerRequest
• GreenLinkApi.ConsumptionDataFromRetailerResponse
• GreenLinkApi.ConsumptionDataPointCreate
• GreenLinkApi.ConsumptionDataPointListOrDetail
• GreenLinkApi.ConsumptionDataPointUpdate
• GreenLinkApi.ConsumptionSite
• GreenLinkApi.ConsumptionSiteCreate
• GreenLinkApi.ConsumptionSiteFileUpload
• GreenLinkApi.ConsumptionSiteFromRetailer
• GreenLinkApi.ConsumptionSiteListOrDetail
• GreenLinkApi.ConsumptionSiteMany
• GreenLinkApi.ContentTypeEnum
• GreenLinkApi.EmissionFactor
• GreenLinkApi.EnergySourceEnum
• GreenLinkApi.EnergySourcePreference
• GreenLinkApi.GetFromEpias
• GreenLinkApi.GridOperator
• GreenLinkApi.Issuer
• GreenLinkApi.Location
• GreenLinkApi.Login
• GreenLinkApi.MatchRequest
• GreenLinkApi.MatchTypeEnum
• GreenLinkApi.MatchedEnergyDataPoint
• GreenLinkApi.MatchingConsumerRequest
• GreenLinkApi.MatchingSiteRequest
• GreenLinkApi.OrganizationTypeEnum
• GreenLinkApi.PaginatedConsumerList
• GreenLinkApi.PaginatedConsumptionDataPointListOrDetailList
• GreenLinkApi.PaginatedConsumptionSiteListOrDetailList
• GreenLinkApi.PaginatedEmissionFactorList
• GreenLinkApi.PaginatedEnergySourcePreferenceList
• GreenLinkApi.PaginatedGridOperatorList
• GreenLinkApi.PaginatedIssuerList
• GreenLinkApi.PaginatedLocationList
• GreenLinkApi.PaginatedMatchRequestList
• GreenLinkApi.PaginatedMatchedEnergyDataPointList
• GreenLinkApi.PaginatedProducerList
• GreenLinkApi.PaginatedProductionDataFromEpiasRequestList
• GreenLinkApi.PaginatedProductionDataPointListOrDetailList
• GreenLinkApi.PaginatedProductionSiteListOrDetailList
• GreenLinkApi.PaginatedRetailerList
• GreenLinkApi.PaginatedSmartContractList
• GreenLinkApi.PaginatedUnprocessedRowList
• GreenLinkApi.PaginatedUploadedFileList
• GreenLinkApi.PaginatedUserList
• GreenLinkApi.PatchedConsumer
• GreenLinkApi.PatchedConsumptionDataPointUpdate
• GreenLinkApi.PatchedConsumptionSite
• GreenLinkApi.PatchedEmissionFactor
• GreenLinkApi.PatchedEnergySourcePreference
• GreenLinkApi.PatchedGridOperator
• GreenLinkApi.PatchedIssuer
• GreenLinkApi.PatchedLocation
• GreenLinkApi.PatchedProducer
• GreenLinkApi.PatchedProductionDataPointUpdate
• GreenLinkApi.PatchedProductionSiteUpdate
• GreenLinkApi.PatchedRetailer
• GreenLinkApi.PatchedSmartContract
• GreenLinkApi.PatchedUser
• GreenLinkApi.PatchedUserDetail
• GreenLinkApi.PriorityEnum
• GreenLinkApi.Producer
• GreenLinkApi.ProductionDataFileList
• GreenLinkApi.ProductionDataFromEpiasRequest
• GreenLinkApi.ProductionDataPointCreate
• GreenLinkApi.ProductionDataPointListOrDetail
• GreenLinkApi.ProductionDataPointUpdate
• GreenLinkApi.ProductionSite
• GreenLinkApi.ProductionSiteFileUpload
• GreenLinkApi.ProductionSiteListOrDetail
• GreenLinkApi.ProductionSiteUpdate
• GreenLinkApi.Register
• GreenLinkApi.Retailer
• GreenLinkApi.SmartContract
• GreenLinkApi.StatusEnum
• GreenLinkApi.Token
• GreenLinkApi.TypeEnum
• GreenLinkApi.UnprocessedRow
• GreenLinkApi.UploadedFile
• GreenLinkApi.User
• GreenLinkApi.UserDetail

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication

cookieAuth

• Type: API key
• API key parameter name: sessionid
• Location:

jwtAuth

• Type: Bearer authentication (JWT)

tokenAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header