# space_pirates_api

> APi_for_Space_Pirates_backend_to_handle_users_lobbies_friends_and_purchases_

Latest version **1.1.0** (published 2022-03-20) · Unlicense license · 0 weekly downloads

## Install

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

## 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.1.0 |
| Published | 2022-03-20 |
| First published | 2022-01-17 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 75.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | qualdevlabs |

## Links

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

## Dependencies (2)

- [@babel/cli](https://npm.io/package/@babel/cli.md) ^7.0.0
- [superagent](https://npm.io/package/superagent.md) ^5.3.0

## Recent versions

- 1.1.0 (latest) — 2022-03-20
- 1.0.7 — 2022-01-19
- 1.0.6 — 2022-01-18
- 1.0.5 — 2022-01-18
- 1.0.4 — 2022-01-18
- 1.0.3 — 2022-01-18
- 1.0.2 — 2022-01-18
- 1.0.1 — 2022-01-17
- 1.0.0 — 2022-01-17

## README

# space_pirates_api

SpacePiratesApi - JavaScript client for space_pirates_api
APi for Space Pirates backend to handle users, lobbies, friends, and purchases.
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.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 space_pirates_api --save
```

Finally, you need to build the module:

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

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

To use the link you just defined in your project, switch to the directory you want to use your space_pirates_api from, and run:

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

Finally, you need to build the module:

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

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --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):

```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 SpacePiratesApi = require('space_pirates_api');

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

var api = new SpacePiratesApi.DefaultSpacePiratesAPI()
var userId = "userId_example"; // {String} the user's UUID (unique)
var friendUserId = "friendUserId_example"; // {String} the user's UUID (unique)
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.acceptFriendReq(userId, friendUserId, callback);

```

## Documentation for API Endpoints

All URIs are relative to *https://spacepirates.uc.r.appspot.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*SpacePiratesApi.DefaultSpacePiratesAPI* | [**acceptFriendReq**](docs/DefaultSpacePiratesAPI.md#acceptFriendReq) | **PATCH** /users/{userId}/friendRequests/{friendUserId} | Accept a friend request
*SpacePiratesApi.DefaultSpacePiratesAPI* | [**createFriend**](docs/DefaultSpacePiratesAPI.md#createFriend) | **POST** /users/{userId}/friendRequests/{friendUserId} | create a friend relation
*SpacePiratesApi.DefaultSpacePiratesAPI* | [**createUser**](docs/DefaultSpacePiratesAPI.md#createUser) | **POST** /users/{userId} | Creates a new user.
*SpacePiratesApi.DefaultSpacePiratesAPI* | [**deleteFriend**](docs/DefaultSpacePiratesAPI.md#deleteFriend) | **DELETE** /users/{userId}/friends/{friendId} | delete a friend
*SpacePiratesApi.DefaultSpacePiratesAPI* | [**deleteUser**](docs/DefaultSpacePiratesAPI.md#deleteUser) | **DELETE** /users/{userId} | Delete a user
*SpacePiratesApi.DefaultSpacePiratesAPI* | [**getUser**](docs/DefaultSpacePiratesAPI.md#getUser) | **GET** /users/{userId} | 
*SpacePiratesApi.DefaultSpacePiratesAPI* | [**readUserFriendRequests**](docs/DefaultSpacePiratesAPI.md#readUserFriendRequests) | **GET** /users/{userId}/friendRequests | read a users friend requests
*SpacePiratesApi.DefaultSpacePiratesAPI* | [**readUserFriends**](docs/DefaultSpacePiratesAPI.md#readUserFriends) | **GET** /users/{userId}/friends | read a users friends
*SpacePiratesApi.DefaultSpacePiratesAPI* | [**updateUserExperience**](docs/DefaultSpacePiratesAPI.md#updateUserExperience) | **PATCH** /users/{userId}/experience | Updates user experience


## Documentation for Models

 - [SpacePiratesApi.FriendReqSchema](docs/FriendReqSchema.md)
 - [SpacePiratesApi.FriendSchema](docs/FriendSchema.md)
 - [SpacePiratesApi.NewUserSchema](docs/NewUserSchema.md)
 - [SpacePiratesApi.UpdateExperienceSchema](docs/UpdateExperienceSchema.md)
 - [SpacePiratesApi.UserResSchema](docs/UserResSchema.md)


## Documentation for Authorization



### sessionAuth


- **Type**: API key
- **API key parameter name**: token
- **Location**: HTTP header



### sigAuth


- **Type**: API key
- **API key parameter name**: signature
- **Location**: HTTP header

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