@segment/public-api-sdk-typescript 32.0.2-b5004 → 33.0.2-b5327

package/README.md

@@ -1,55 +1,59 @@
-# Public API Typescript Client
+# Segment Public API TypeScript SDK
 
-The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. The full documentation is available at https://docs.segmentapis.com.
+## Overview
 
-All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace.
+The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. The full documentation is available at [https://docs.segmentapis.com](https://docs.segmentapis.com).
 
-See the next sections for more information on how to use the Segment Public API SDK.
+All endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace.
 
-## Overview
+See the next sections for more information on how to use the Segment Public API TypeScript SDK.
+
+Latest API and SDK version: 33.0.2
+
+## Installation
 
-This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
+This SDK is published as an [NPM package](https://npmjs.org). To install it, use:
 
--   API version: 32.0.2
+```
+npm i @segment/public-api-sdk-typescript
+```
 
--   Build package: org.openapitools.codegen.languages.TypeScriptNodeClientCodegen
+Or, if you're using yarn:
 
-#### Building
+```
+yarn add @segment/public-api-sdk-typescript
+```
 
-To build and compile the typescript sources to javascript use:
+To build and compile the SDK from source, clone this repository and use:
 
 ```
 yarn install
 yarn build
 ```
 
-## Code Example
+This will output the compiled JavaScript files in the `dist/` directory.
+
+You are now ready to start making calls to Public API!
+
+## Example
 
 ```typescript
-import * as publicApi from '@segment/public-api-sdk-typescript';
+import * as publicApi from '@segment/public-api-sdk-typescript'
 
-const YOUR_TOKEN = 'YOUR_TOKEN';
+const TOKEN = // ...
 
-const myApis = publicApi.configureApis(YOUR_TOKEN);
-publicApi
-    .unwrap(myApis.workspaces.getWorkspaceCurrent())
+const api = publicApi.configureApis(TOKEN)
+publicApi.unwrap(api.workspaces.getWorkspaceCurrent())
     .then((result) => {
         console.log(`Result:\n ${JSON.stringify(result)}`);
     })
     .catch((error) => {
-        console.log('ERROR\n:', error);
-    });
-```
-
-#### Testing
+        console.log("ERROR\n:", error)
+    }
+)
 
-All test files are under `tests` folders.
-
-```
-yarn install
-yarn test
 ```
 
 ## Contributing
 
-This repository is auto-generated and not open for contributions from external contributors. If you have problems with the repo, please raise an issue instead of a pull request. Pull requests will not be reviewed.
+The contents of this repository are automatically generated, so we can't take contributions from external developers. If you have any issues with this SDK, please raise an issue or reach out to friends@segment.com instead of opening a pull request. Pull requests will not be reviewed.