@segment/public-api-sdk-typescript 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2022 Twilio, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,51 @@
+# Public API Typescript Client
+
+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.
+
+All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace.
+
+See the next sections for more information on how to use the Segment Public API SDK.
+
+## Overview
+
+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.
+
+-   API version: 32.0.1
+
+-   Build package: org.openapitools.codegen.languages.TypeScriptNodeClientCodegen
+
+#### Building
+
+To build and compile the typescript sources to javascript use:
+
+```
+yarn install
+yarn build
+```
+
+## Code Example
+
+```typescript
+import * as publicApi from '@segment/public-api-sdk-typescript';
+
+const YOUR_TOKEN = 'YOUR_TOKEN';
+
+const myApis = publicApi.configureApis(YOUR_TOKEN);
+publicApi
+    .unwrap(myApis.workspaces.getWorkspaceCurrent())
+    .then((result) => {
+        console.log(`Result:\n ${JSON.stringify(result)}`);
+    })
+    .catch((error) => {
+        console.log('ERROR\n:', error);
+    });
+```
+
+#### Testing
+
+All test files are under `tests` folders.
+
+```
+yarn install
+yarn test
+```