# mammoth_publish_app

> PublishApp - JavaScript client for publish_app No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codege

Latest version **1.0.0** (published 2021-03-03) · Unlicense license · 0 weekly downloads

## Install

```sh
npm install mammoth_publish_app
pnpm add mammoth_publish_app
yarn add mammoth_publish_app
bun add mammoth_publish_app
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-03-03 |
| First published | 2021-03-03 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 89.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | imran001 |

## Links

- npm: https://www.npmjs.com/package/mammoth_publish_app
- npm.io page: https://npm.io/package/mammoth_publish_app

## Dependencies (2)

- [superagent](https://npm.io/package/superagent.md) 3.7.0
- [querystring](https://npm.io/package/querystring.md) 0.2.0

## Recent versions

- 1.0.0 (latest) — 2021-03-03

## README

# publish_app

PublishApp - JavaScript client for publish_app
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install publish_app --save
```

##### 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:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
npm link
```

Finally, switch to the directory you want to use your publish_app from, and run:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

You should now be able to `require('publish_app')` in javascript files from the directory you ran the last 
command above from.

#### git
#
If the library is hosted at a git repository, e.g.
https://github.com/YOUR_USERNAME/publish_app
then install it via:

```shell
    npm install YOUR_USERNAME/publish_app --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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, that's to say your javascript file where you actually 
use this library):

```shell
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:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var PublishApp = require('publish_app');

var defaultClient = PublishApp.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-API-Key'] = "Token"

var api = new PublishApp.CreateApi()

var body = new PublishApp.CreateReport(); // {CreateReport} Info about workspace and report name.

var X_ACCOUNT_ID = 8.14; // {Number} account id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createReport(body, X_ACCOUNT_ID, callback);

```

## Documentation for API Endpoints

All URIs are relative to *https://doraemon.mammoth.io/api/v1/*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*PublishApp.CreateApi* | [**createReport**](docs/CreateApi.md#createReport) | **POST** /reports | Create a new report
*PublishApp.ReadApi* | [**readReports**](docs/ReadApi.md#readReports) | **GET** /reports | Read all reports in workspace
*PublishApp.ReadApi* | [**reportReportIdGet**](docs/ReadApi.md#reportReportIdGet) | **GET** /report/{report_id} | Read one report


## Documentation for Models

 - [PublishApp.CreateReport](docs/CreateReport.md)
 - [PublishApp.ReadAllReports](docs/ReadAllReports.md)
 - [PublishApp.ReadAllReportsInner](docs/ReadAllReportsInner.md)
 - [PublishApp.ReadOneReport](docs/ReadOneReport.md)
 - [PublishApp.ReadOneReportComponents](docs/ReadOneReportComponents.md)
 - [PublishApp.ReportCreated](docs/ReportCreated.md)


## Documentation for Authorization


### api_key

- **Type**: API key
- **API key parameter name**: X-API-Key
- **Location**: HTTP header

---
_Source: https://npm.io/package/mammoth_publish_app · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._