@apoxy-dev/apoxy

apoxy_api

ApoxyApi - JavaScript client for apoxy_api No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1
• Package version: 1
• Generator version: 7.7.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 apoxy_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 apoxy_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 ApoxyApi = require('apoxy_api');

var defaultClient = ApoxyApi.ApiClient.instance;
// Configure API key authorization: ProjectId
var ProjectId = defaultClient.authentications['ProjectId'];
ProjectId.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ProjectId.apiKeyPrefix['x-apoxy-project-id'] = "Token"
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['x-apoxy-api-key'] = "Token"

var api = new ApoxyApi.DefaultApi()
var opts = {
  'query': "query_example", // {String} Search query to filter logs by.
  'startTime': "startTime_example", // {String} Start of the range to return in ISO 8601 format. eg. 2024-01-02T22:22:22.222Z 
  'endTime': "endTime_example", // {String} End of the range to return in ISO 8601 format. eg. 2024-01-02T22:22:22.222Z 
  'order': "order_example", // {String} Order of logs to return:   * `desc` - newest first.   * `asc` -  oldest first. 
  'pageToken': "pageToken_example" // {String} Next page token to return.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLogs(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.apoxy.dev

Class	Method	HTTP request	Description
ApoxyApi.DefaultApi	getLogs	GET /v1/logs

Documentation for Models

• ApoxyApi.ApoxyLogsV1GetLogsResponse
• ApoxyApi.ApoxyLogsV1Log
• ApoxyApi.ApoxyLogsV1LogsSource

Documentation for Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: x-apoxy-api-key
• Location: HTTP header

ProjectId

• Type: API key
• API key parameter name: x-apoxy-project-id
• Location: HTTP header