github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/openapi-generator/templates/typescript-fetch/README.mustache

## {{npmName}}@{{npmVersion}}

Phrase Strings is a translation management platform for software projects. You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase Strings for your account.

## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: {{appVersion}}
- Package version: {{npmVersion}}
{{^hideGenerationTimestamp}}
- Build date: {{generatedDate}}
{{/hideGenerationTimestamp}}
- Build package: {{npmName}}
{{#infoUrl}}
For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
{{/infoUrl}}


This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:

Environment
* Node.js
* Webpack
* Browserify

Language level
* ES5 - you must have a Promises/A+ library installed
* ES6

Module system
* CommonJS
* ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html))

### Building

To build and compile the typescript sources to javascript use:
```
npm install
npm run build
```

### Publishing

First build the package then run ```npm publish```

### Installation

navigate to the folder of your consuming project and run one of the following commands.

_published:_


```
npm install {{npmName}}@{{npmVersion}} --save
```

if you are using yarn


```
yarn install {{npmName}}@{{npmVersion}}
```

_unPublished (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE --save
```


## Getting Started

Please follow the [installation](#installation) procedure and then run the following code:

```javascript
import {Configuration, SpacesApi} from "{{npmName}}"

const configuration = new Configuration({apiKey: 'token API_TOKEN'})

const spaceApi = new SpacesApi(configuration)

let requestParameters = {
  accountId: 'ACCOUNT_ID'
}

spaceApi.spacesList(requestParameters).then(function (data) { console.log(data) })
```

## Getting Started in Node.js

This package is using `fetch` and `FormData` so make sure to have polyfills for it

here is the example package.json

```json
{
  "name": "openapi_typescript_test",
  "version": "1.0.0",
  "description": "",
  "main": "dist/index.js",
  "scripts": {
    "start": "tsc && node dist/index.js",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC",
  "dependencies": {
    "@types/node": "^14.0.1",
    "form-data": "^3.0.0",
    "node-fetch": "^2.6.0",
    "phrase-js": "^{{npmVersion}}"
  },
  "devDependencies": {
    "tslint": "^5.20.1",
    "typescript": "^3.9.2"
  }
}
```

and you can use it as follows

```javascript
import {Configuration, SpacesApi} from "phrase-js"
var FormData = require("form-data")
var fetch = require("node-fetch")

const globalAny: any = global;
globalAny.FormData = FormData

const configuration = new Configuration({
  apiKey: 'token API_TOKEN',
  fetchApi: fetch
})

const spaceApi = new SpacesApi(configuration)

let requestParameters = {
  accountId: 'YOUR_ACCOUNT_ID'
}

spaceApi.spacesList(requestParameters).then(function (data) {console.log(data)})
```

### Upload

```javascript
const uploadsApi = new UploadsApi(configuration)
const file = fs.createReadStream('example.json')

const requestParameters = {
  projectId: 'YOUR_PROJECT_ID',
  localeId: 'YOUR_LOCALE_ID',
  file: file,
  fileFormat: 'json'
}

uploadsApi.uploadCreate(requestParameters).then(function (data) { console.log(data) })
```

In Node.js >= 18 there is `fetch` built-in, but you need to prepare the arguments slightly differently:

```javascript
const fs = require("fs");
const { File } = require('buffer');

const buf = await fs.readFileSync(filePath);
const file = new File([buf], filePath);

const requestParams = {
  projectId: 'YOUR_PROJECT_ID',
  localeId: 'YOUR_LOCALE_ID',
  file: file,
  fileFormat: 'json'
};
```

## Datacenters

The API is only accessible via HTTPS and the current version is <code>v2</code>, which results in a base URL like: <code>{{{basePath}}}</code> depending on the datacenter.

### EU Datacenter
```
{{{basePath}}}
```

This is the default datacenter.

### US Datacenter
```
https://api.us.app.phrase.com/v2/
```

### Specifying US Datacenter
You can use the US datacenter by setting the following:
```
const configuration = new Configuration({basePath: 'https://api.us.app.phrase.com/v2/'})
```

## API Endpoints

All URIs are relative to *{{basePath}}*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | **{{operationId}}** | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}}
{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}

## Author

{{#apiInfo}}{{#apis}}{{#-last}}{{infoEmail}}
{{/-last}}{{/apis}}{{/apiInfo}}

## Get help / support

Please contact [support@phrase.com](mailto:support@phrase.com?subject=[GitHub]%20phrase-js) and we can take more direct action toward finding a solution.