Release 1.0.2

Author: fern-api[bot]

README.md

@@ -1,14 +1,14 @@
 # Openledger TypeScript Library
 
 [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fopenledger%2Fopenledger-typescript-sdk)
-[![npm shield](https://img.shields.io/npm/v/@openledger/typescript-sdk)](https://www.npmjs.com/package/@openledger/typescript-sdk)
+[![npm shield](https://img.shields.io/npm/v/openledger)](https://www.npmjs.com/package/openledger)
 
 The Openledger TypeScript library provides convenient access to the Openledger API from TypeScript.
 
 ## Installation
 
 ```sh
-npm i -s @openledger/typescript-sdk
+npm i -s openledger
 ```
 
 ## Reference
@@ -20,12 +20,13 @@ A full reference for this library is available [here](./reference.md).
 Instantiate and use the client with the following:
 
 ```typescript
-import { OpenLedgerClientClient } from "@openledger/typescript-sdk";
+import { OpenLedgerClientClient } from "openledger";
 
 const client = new OpenLedgerClientClient({ token: "YOUR_TOKEN" });
-await client.authentication.generateToken({
-    clientId: "client_id",
-    clientSecret: "client_secret",
+await client.categories.createANewCategory({
+    entityId: "entityId",
+    name: "name",
+    type: "ASSET",
 });
 ```
 
@@ -35,9 +36,9 @@ The SDK exports all request and response types as TypeScript interfaces. Simply
 following namespace:
 
 ```typescript
-import { OpenLedgerClient } from "@openledger/typescript-sdk";
+import { OpenLedgerClient } from "openledger";
 
-const request: OpenLedgerClient.TokenRequest = {
+const request: OpenLedgerClient.GetV1BanksCreateLinkRequest = {
     ...
 };
 ```
@@ -48,10 +49,10 @@ When the API returns a non-success status code (4xx or 5xx response), a subclass
 will be thrown.
 
 ```typescript
-import { OpenLedgerClientError } from "@openledger/typescript-sdk";
+import { OpenLedgerClientError } from "openledger";
 
 try {
-    await client.authentication.generateToken(...);
+    await client.categories.createANewCategory(...);
 } catch (err) {
     if (err instanceof OpenLedgerClientError) {
         console.log(err.statusCode);
@@ -69,7 +70,7 @@ try {
 If you would like to send additional headers as part of the request, use the `headers` request option.
 
 ```typescript
-const response = await client.authentication.generateToken(..., {
+const response = await client.categories.createANewCategory(..., {
     headers: {
         'X-Custom-Header': 'custom value'
     }
@@ -91,7 +92,7 @@ A request is deemed retryable when any of the following HTTP status codes is ret
 Use the `maxRetries` request option to configure this behavior.
 
 ```typescript
-const response = await client.authentication.generateToken(..., {
+const response = await client.categories.createANewCategory(..., {
     maxRetries: 0 // override maxRetries at the request level
 });
 ```
@@ -101,7 +102,7 @@ const response = await client.authentication.generateToken(..., {
 The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
 ```typescript
-const response = await client.authentication.generateToken(..., {
+const response = await client.categories.createANewCategory(..., {
     timeoutInSeconds: 30 // override timeout to 30s
 });
 ```
@@ -112,7 +113,7 @@ The SDK allows users to abort requests at any point by passing in an abort signa
 
 ```typescript
 const controller = new AbortController();
-const response = await client.authentication.generateToken(..., {
+const response = await client.categories.createANewCategory(..., {
     abortSignal: controller.signal
 });
 controller.abort(); // aborts the request
@@ -124,7 +125,7 @@ The SDK provides access to raw response data, including headers, through the `.w
 The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
 
 ```typescript
-const { data, rawResponse } = await client.authentication.generateToken(...).withRawResponse();
+const { data, rawResponse } = await client.categories.createANewCategory(...).withRawResponse();
 
 console.log(data);
 console.log(rawResponse.headers['X-My-Header']);
@@ -148,7 +149,7 @@ The SDK provides a way for you to customize the underlying HTTP client / Fetch f
 unsupported environment, this provides a way for you to break glass and ensure the SDK works.
 
 ```typescript
-import { OpenLedgerClientClient } from "@openledger/typescript-sdk";
+import { OpenLedgerClientClient } from "openledger";
 
 const client = new OpenLedgerClientClient({
     ...

package.json

@@ -1,6 +1,6 @@
 {
-    "name": "@openledger/typescript-sdk",
-    "version": "0.0.35",
+    "name": "openledger",
+    "version": "1.0.2",
     "private": false,
     "repository": "https://github.com/openledger/openledger-typescript-sdk",
     "main": "./index.js",