@chrt-inc/typescript-sdk 0.0.2

package/reference.md

@@ -0,0 +1,4621 @@
+# Reference
+
+## Root
+
+<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">getRoot</a>() -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns a greeting message
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.root.getRoot();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Root.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">getAuthd</a>() -> Record<string, string></code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.root.getAuthd();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Root.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">postAuthd</a>() -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.root.postAuthd();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Root.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">getFailure</a>() -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.root.getFailure();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Root.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">getHealth</a>() -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Used for monitoring system health
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.root.getHealth();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Root.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">getOptionallyAuthd</a>() -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.root.getOptionallyAuthd();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Root.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pydantic</a>() -> Chrt.PydanticResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+This route exposes pydantic models - which are not returned by any other route - to the OpenAPI spec to ensure they get included during sdk codegen
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.root.pydantic();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Root.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## Mirror
+
+<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">getAuthdMirror</a>() -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.mirror.getAuthdMirror();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Mirror.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">postAuthdMirror</a>() -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.mirror.postAuthdMirror();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Mirror.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">putAuthdMirror</a>() -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.mirror.putAuthdMirror();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Mirror.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">deleteAuthdMirror</a>() -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.mirror.deleteAuthdMirror();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Mirror.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">patchAuthdMirror</a>() -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.mirror.patchAuthdMirror();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Mirror.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">getMirror</a>() -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.mirror.getMirror();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Mirror.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">postMirror</a>() -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.mirror.postMirror();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Mirror.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">putMirror</a>() -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.mirror.putMirror();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Mirror.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">deleteMirror</a>() -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.mirror.deleteMirror();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Mirror.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">patchMirror</a>() -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.mirror.patchMirror();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Mirror.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">postOrderCompletedEmail</a>({ ...params }) -> Chrt.EmailRes</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.mirror.postOrderCompletedEmail({
+    to: ["to"],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.EmailReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Mirror.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">postOrderInProgressEmail</a>({ ...params }) -> Chrt.EmailRes</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.mirror.postOrderInProgressEmail({
+    to: ["to"],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.EmailReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Mirror.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## Dev
+
+<details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getDecodedJwt</a>() -> Chrt.DecodedJwtWithOrgAndUserId</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.dev.getDecodedJwt();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Dev.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getEmail</a>() -> string</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.dev.getEmail();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Dev.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getTemplate</a>() -> string</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.dev.getTemplate();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Dev.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">postTemplate</a>({ ...params }) -> Chrt.TemplateRes</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.dev.postTemplate({
+    message: "message",
+    number: 1,
+    timestamp: "2024-01-15T09:30:00Z",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.TemplateReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Dev.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getUserId</a>() -> string</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.dev.getUserId();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Dev.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## Directory
+
+<details><summary><code>client.directory.<a href="/src/api/resources/directory/client/Client.ts">postShippers</a>({ ...params }) -> Chrt.Shipper2[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve the full list of shippers with optional pagination and sorting
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.directory.postShippers();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.DbQueryParams`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Directory.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## OortConnections
+
+<details><summary><code>client.oortConnections.<a href="/src/api/resources/oortConnections/client/Client.ts">getConnectionsInfoForCouriers</a>() -> Chrt.ShipperOrgConnectionInfo1[]</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortConnections.getConnectionsInfoForCouriers();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortConnections.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortConnections.<a href="/src/api/resources/oortConnections/client/Client.ts">getConnectionsInfoForShippers</a>() -> Chrt.CourierOrgConnectionInfo1[]</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortConnections.getConnectionsInfoForShippers();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortConnections.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortConnections.<a href="/src/api/resources/oortConnections/client/Client.ts">createConnectionToCourier</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Body: Courier Handle, Shipper Org Id from JWT
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortConnections.createConnectionToCourier({
+    handle: "handle",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.CreateConnectionReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortConnections.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## OortCourierPayDriverRateSheets
+
+<details><summary><code>client.oortCourierPayDriverRateSheets.<a href="/src/api/resources/oortCourierPayDriverRateSheets/client/Client.ts">getRateSheetsByCourierOrgId</a>() -> Chrt.CourierPayDriverRateSheet1[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+This is for getting a list of all rate sheets by courier org id from the JWT
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortCourierPayDriverRateSheets.getRateSheetsByCourierOrgId();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortCourierPayDriverRateSheets.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortCourierPayDriverRateSheets.<a href="/src/api/resources/oortCourierPayDriverRateSheets/client/Client.ts">getRateSheetByDriverId</a>(driverId) -> Chrt.CourierPayDriverRateSheet1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get a rate sheet by driver ID, courier org id from JWT
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortCourierPayDriverRateSheets.getRateSheetByDriverId("driver_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**driverId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortCourierPayDriverRateSheets.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortCourierPayDriverRateSheets.<a href="/src/api/resources/oortCourierPayDriverRateSheets/client/Client.ts">getRateSheetsByShipperOrgId</a>() -> Chrt.CourierPayDriverRateSheet1[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+This is for getting a list of all rate sheets by shipper org id from the JWT
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortCourierPayDriverRateSheets.getRateSheetsByShipperOrgId();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortCourierPayDriverRateSheets.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortCourierPayDriverRateSheets.<a href="/src/api/resources/oortCourierPayDriverRateSheets/client/Client.ts">postCreateRateSheet</a>({ ...params }) -> string</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+This is for creating a rate sheet
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortCourierPayDriverRateSheets.postCreateRateSheet({
+    additional_mileage_rate_usd_per_mile: 1.1,
+    after_hours: 1.1,
+    base_mileage_distance_miles: 1.1,
+    base_mileage_rate_usd_per_instance: 1.1,
+    courier_org_id: "courier_org_id",
+    dangerous_goods_rate_usd_per_instance: 1.1,
+    extra_stop_rate_usd: 1.1,
+    fuel_surchage_rate_usd_per_mile: 1.1,
+    holiday: 1.1,
+    long_distance_surcharge_miles_before_surcharge: 1.1,
+    long_distance_surcharge_rate_usd_per_mile: 1.1,
+    schema_version: 1,
+    wait_time_before_charge_minutes: 1.1,
+    wait_time_rate_usd_per_minute: 1.1,
+    weekend: 1.1,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.CourierPayDriverRateSheetClientCreate1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortCourierPayDriverRateSheets.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## OortDrivers
+
+<details><summary><code>client.oortDrivers.<a href="/src/api/resources/oortDrivers/client/Client.ts">getOortDriversByDriverId</a>(driverId) -> Chrt.Driver1</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortDrivers.getOortDriversByDriverId("driver_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**driverId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortDrivers.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortDrivers.<a href="/src/api/resources/oortDrivers/client/Client.ts">getOortDriversByUserId</a>() -> Chrt.Driver1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Uses user_id from the JWT. (originally included for use by Pytest)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortDrivers.getOortDriversByUserId();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortDrivers.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortDrivers.<a href="/src/api/resources/oortDrivers/client/Client.ts">postOortDriversCreate</a>({ ...params }) -> string</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortDrivers.postOortDriversCreate({
+    org_member: {
+        role: "role",
+        user_id: "user_id",
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.DriverCreateReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortDrivers.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortDrivers.<a href="/src/api/resources/oortDrivers/client/Client.ts">postOortDriversLastSeen</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortDrivers.postOortDriversLastSeen({
+    location: {
+        type: "Feature",
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.DriverLastSeenReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortDrivers.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortDrivers.<a href="/src/api/resources/oortDrivers/client/Client.ts">getOortDriversByOrgId</a>() -> Chrt.Driver1[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Used org_id from the JWT
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortDrivers.getOortDriversByOrgId();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortDrivers.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortDrivers.<a href="/src/api/resources/oortDrivers/client/Client.ts">getOortDriversListOrgMembersAndDrivers</a>() -> Chrt.OrgMembersAndDrivers[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Uses the org_id from the JWT
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortDrivers.getOortDriversListOrgMembersAndDrivers();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortDrivers.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortDrivers.<a href="/src/api/resources/oortDrivers/client/Client.ts">postOortDriversSetActivation</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Set a driver's activation status (active=true/false).
+This route is idempotent - setting a driver to their current status is allowed.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortDrivers.postOortDriversSetActivation({
+    active: true,
+    driver_object_id: "driver_object_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.SetDriverActivationReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortDrivers.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortDrivers.<a href="/src/api/resources/oortDrivers/client/Client.ts">putOortDriversUpdateDriverDetails</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortDrivers.putOortDriversUpdateDriverDetails({
+    driver_object_id: "driver_object_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.UpdateDriverDetailsReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortDrivers.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortDrivers.<a href="/src/api/resources/oortDrivers/client/Client.ts">deleteOortDrivers</a>(driverId) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Can be used e.g. if a driver is removed from an org
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortDrivers.deleteOortDrivers("driver_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**driverId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortDrivers.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## OortMilestones
+
+<details><summary><code>client.oortMilestones.<a href="/src/api/resources/oortMilestones/client/Client.ts">postOortMilestonesAddToTask</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortMilestones.postOortMilestonesAddToTask({
+    task_id: "task_id",
+    type: "image",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.MilestoneAddToTaskReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortMilestones.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortMilestones.<a href="/src/api/resources/oortMilestones/client/Client.ts">getOortMilestonesImages</a>(milestoneS3ObjectMetadataId) -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortMilestones.getOortMilestonesImages("milestone_s3_object_metadata_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**milestoneS3ObjectMetadataId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortMilestones.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortMilestones.<a href="/src/api/resources/oortMilestones/client/Client.ts">deleteOortMilestonesImage</a>(milestoneS3ObjectMetadataId) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+The `id` is the MilestoneS3ObjectMetadata1 id
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortMilestones.deleteOortMilestonesImage("milestone_s3_object_metadata_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**milestoneS3ObjectMetadataId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortMilestones.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortMilestones.<a href="/src/api/resources/oortMilestones/client/Client.ts">postOortMilestonesUpdate</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortMilestones.postOortMilestonesUpdate({
+    milestone_id: "milestone_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.MilestoneUpdateReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortMilestones.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortMilestones.<a href="/src/api/resources/oortMilestones/client/Client.ts">postOortMilestonesUploadImage</a>(image, milestoneId, { ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortMilestones.postOortMilestonesUploadImage(
+    fs.createReadStream("/path/to/your/file"),
+    "milestone_id",
+    {},
+);
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**image:** `File | fs.ReadStream | Blob`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**milestoneId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.BodyPostOortMilestonesUploadImageOortMilestonesUploadImageMilestoneIdPost`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortMilestones.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## OortNotificationPreferences
+
+<details><summary><code>client.oortNotificationPreferences.<a href="/src/api/resources/oortNotificationPreferences/client/Client.ts">getNotificationPreferencesByOrgId</a>() -> Chrt.NotificationPreferences1</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortNotificationPreferences.getNotificationPreferencesByOrgId();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortNotificationPreferences.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortNotificationPreferences.<a href="/src/api/resources/oortNotificationPreferences/client/Client.ts">postNotificationPreferencesCreate</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortNotificationPreferences.postNotificationPreferencesCreate({
+    schema_version: 1,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.NotificationPreferencesClientCreate1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortNotificationPreferences.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## OortOrders
+
+<details><summary><code>client.oortOrders.<a href="/src/api/resources/oortOrders/client/Client.ts">postOortOrdersCreate</a>({ ...params }) -> Chrt.CreateOrderRes</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortOrders.postOortOrdersCreate({
+    cargo_client_creates_map: {
+        key: {
+            cargo_type: "spare_parts",
+            schema_version: 1,
+        },
+    },
+    order_client_create: {
+        schema_version: 1,
+    },
+    order_created_by_type: "chrt",
+    order_dispatch_type: "dtc",
+    task_client_creates_bundle_groupings: [
+        [
+            {
+                task_client_create: {
+                    schema_version: 1,
+                },
+            },
+        ],
+    ],
+    transport_type: "ground_only",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.CreateOrderReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortOrders.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortOrders.<a href="/src/api/resources/oortOrders/client/Client.ts">getOortOrdersListByCourierOrgId</a>() -> Chrt.Order1[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Uses the org_id from the JWT
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortOrders.getOortOrdersListByCourierOrgId();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortOrders.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortOrders.<a href="/src/api/resources/oortOrders/client/Client.ts">getOortOrdersListByShipperOrgId</a>() -> Chrt.Order1[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Uses the org_id from the JWT
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortOrders.getOortOrdersListByShipperOrgId();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortOrders.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortOrders.<a href="/src/api/resources/oortOrders/client/Client.ts">getOortOrdersListByShipperOrgIdFull</a>() -> Chrt.GetOrderFullRes[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Uses the org_id from the JWT
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortOrders.getOortOrdersListByShipperOrgIdFull();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortOrders.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortOrders.<a href="/src/api/resources/oortOrders/client/Client.ts">getOortOrdersOrderIdOrShortId</a>(orderIdOrShortId) -> Chrt.GetOrderRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Accepts both order_id and order_short_id values and returns just the Order
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortOrders.getOortOrdersOrderIdOrShortId("order_id_or_short_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**orderIdOrShortId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortOrders.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortOrders.<a href="/src/api/resources/oortOrders/client/Client.ts">putOortOrdersOrderIdOrShortIdCancel</a>(orderIdOrShortId) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortOrders.putOortOrdersOrderIdOrShortIdCancel("order_id_or_short_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**orderIdOrShortId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortOrders.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortOrders.<a href="/src/api/resources/oortOrders/client/Client.ts">getOortOrdersOrderIdOrShortIdFull</a>(orderIdOrShortId) -> Chrt.GetOrderFullRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Accepts both order_id and order_short_id values and returns the Order with all its Task Groups, Tasks, Milestones, and Cargos
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortOrders.getOortOrdersOrderIdOrShortIdFull("order_id_or_short_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**orderIdOrShortId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortOrders.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## OortOrgConnectionInfos
+
+<details><summary><code>client.oortOrgConnectionInfos.<a href="/src/api/resources/oortOrgConnectionInfos/client/Client.ts">createCourierOrgInfo</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a new courier org info. Fails if one already exists.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortOrgConnectionInfos.createCourierOrgInfo({
+    email_address_primary: "email_address_primary",
+    schema_version: 1,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.CourierOrgConnectionInfoClientCreate1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortOrgConnectionInfos.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortOrgConnectionInfos.<a href="/src/api/resources/oortOrgConnectionInfos/client/Client.ts">createShipperOrgInfo</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a new shipper org info. Fails if one already exists.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortOrgConnectionInfos.createShipperOrgInfo({
+    email_address_primary: "email_address_primary",
+    schema_version: 1,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.ShipperOrgConnectionInfoClientCreate1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortOrgConnectionInfos.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortOrgConnectionInfos.<a href="/src/api/resources/oortOrgConnectionInfos/client/Client.ts">getCourierOrgInfo</a>() -> Chrt.CourierOrgConnectionInfo1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Gets the courier org info for the authenticated user
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortOrgConnectionInfos.getCourierOrgInfo();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortOrgConnectionInfos.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortOrgConnectionInfos.<a href="/src/api/resources/oortOrgConnectionInfos/client/Client.ts">getShipperOrgInfo</a>() -> Chrt.ShipperOrgConnectionInfo1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Gets the shipper org info for the authenticated user
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortOrgConnectionInfos.getShipperOrgInfo();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortOrgConnectionInfos.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortOrgConnectionInfos.<a href="/src/api/resources/oortOrgConnectionInfos/client/Client.ts">updateCourierOrgInfo</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Update existing courier org info. Can update one or more fields.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortOrgConnectionInfos.updateCourierOrgInfo();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.CourierOrgConnectionInfoUpdate`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortOrgConnectionInfos.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortOrgConnectionInfos.<a href="/src/api/resources/oortOrgConnectionInfos/client/Client.ts">updateShipperOrgInfo</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Update existing shipper org info. Can update one or more fields.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortOrgConnectionInfos.updateShipperOrgInfo();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.ShipperOrgConnectionInfoClientUpdate1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortOrgConnectionInfos.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## OortOrgProfiles
+
+<details><summary><code>client.oortOrgProfiles.<a href="/src/api/resources/oortOrgProfiles/client/Client.ts">getAvatar</a>({ ...params }) -> string</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortOrgProfiles.getAvatar({
+    handle: "handle",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.GetAvatarRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortOrgProfiles.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortOrgProfiles.<a href="/src/api/resources/oortOrgProfiles/client/Client.ts">getProfileByHandle</a>(handle) -> Chrt.CourierOrgProfile3</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortOrgProfiles.getProfileByHandle("handle");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**handle:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortOrgProfiles.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortOrgProfiles.<a href="/src/api/resources/oortOrgProfiles/client/Client.ts">getProfileByOrgId</a>() -> Chrt.CourierOrgProfile3</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortOrgProfiles.getProfileByOrgId();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortOrgProfiles.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortOrgProfiles.<a href="/src/api/resources/oortOrgProfiles/client/Client.ts">postOrgProfile</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortOrgProfiles.postOrgProfile({
+    description: "description",
+    email_address_primary: "email_address_primary",
+    phone_number_primary: "phone_number_primary",
+    schema_version: 1,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.CourierOrgProfileClientCreate3`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortOrgProfiles.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## OortShipperUserInfo
+
+<details><summary><code>client.oortShipperUserInfo.<a href="/src/api/resources/oortShipperUserInfo/client/Client.ts">getShipperUserInfoByUserId</a>() -> Chrt.ShipperUserInfo1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get the shipper user info for the authenticated user jwt
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortShipperUserInfo.getShipperUserInfoByUserId();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortShipperUserInfo.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortShipperUserInfo.<a href="/src/api/resources/oortShipperUserInfo/client/Client.ts">createShipperUserInfo</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortShipperUserInfo.createShipperUserInfo({
+    schema_version: 1,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.ShipperUserInfoClientCreate1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortShipperUserInfo.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortShipperUserInfo.<a href="/src/api/resources/oortShipperUserInfo/client/Client.ts">getShipperUserInfoListByOrgId</a>(orgId) -> Chrt.ShipperUserInfo1[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get the list of shipper user info for the authenticated user jwt
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortShipperUserInfo.getShipperUserInfoListByOrgId("org_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**orgId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortShipperUserInfo.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortShipperUserInfo.<a href="/src/api/resources/oortShipperUserInfo/client/Client.ts">updateShipperUserInfo</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortShipperUserInfo.updateShipperUserInfo();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.ShipperUserInfoClientUpdate1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortShipperUserInfo.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## OortTaskGroups
+
+<details><summary><code>client.oortTaskGroups.<a href="/src/api/resources/oortTaskGroups/client/Client.ts">getOortTaskGroupsListByCourierOrgId</a>() -> Chrt.MultipleTaskGroupsWithTasks</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Uses the org_id from the JWT - returns task groups and with their list of tasks for the courier org
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortTaskGroups.getOortTaskGroupsListByCourierOrgId();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortTaskGroups.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortTaskGroups.<a href="/src/api/resources/oortTaskGroups/client/Client.ts">getOortTaskGroupsListByCourierOrgIdFull</a>() -> Chrt.MultipleTaskGroupsDetailsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Uses the org_id from the JWT - returns multiple task groups with their tasks, milestones, and cargos
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortTaskGroups.getOortTaskGroupsListByCourierOrgIdFull();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortTaskGroups.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortTaskGroups.<a href="/src/api/resources/oortTaskGroups/client/Client.ts">getTaskGroupsListByDriverId</a>(driverId) -> Chrt.TaskGroup1[]</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortTaskGroups.getTaskGroupsListByDriverId("driver_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**driverId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortTaskGroups.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortTaskGroups.<a href="/src/api/resources/oortTaskGroups/client/Client.ts">postOortTaskGroupsUpdate</a>({ ...params }) -> Chrt.UpdateTaskGroupRes</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortTaskGroups.postOortTaskGroupsUpdate({
+    task_group_id: "task_group_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.UpdateTaskGroupReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortTaskGroups.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortTaskGroups.<a href="/src/api/resources/oortTaskGroups/client/Client.ts">getOortTaskGroupsTaskInfoList</a>(taskGroupId) -> Chrt.TaskGroupWithTasks</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns a single task group and its tasks
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortTaskGroups.getOortTaskGroupsTaskInfoList("task_group_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskGroupId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortTaskGroups.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortTaskGroups.<a href="/src/api/resources/oortTaskGroups/client/Client.ts">getOortTaskGroupsTaskInfoListFull</a>(taskGroupId) -> Chrt.TaskGroupWithDetails</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns a single task group and its tasks, milestones, and cargos
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortTaskGroups.getOortTaskGroupsTaskInfoListFull("task_group_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskGroupId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortTaskGroups.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortTaskGroups.<a href="/src/api/resources/oortTaskGroups/client/Client.ts">putOortTaskGroupsStart</a>(taskGroupId) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortTaskGroups.putOortTaskGroupsStart("task_group_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskGroupId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortTaskGroups.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.oortTaskGroups.<a href="/src/api/resources/oortTaskGroups/client/Client.ts">putOortTaskGroupsSetPause</a>(taskGroupId, { ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.oortTaskGroups.putOortTaskGroupsSetPause("task_group_id", {
+    paused: true,
+    task_group_id: "task_group_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskGroupId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.SetTaskGroupPauseReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OortTaskGroups.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## Orgs
+
+<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgsHandle</a>() -> string</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get the handle for the org from JWT
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgs.getOrgsHandle();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Orgs.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getHandleAvailability</a>(handle) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Check if a handle is available, returns true if it is, false if it is not
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgs.getHandleAvailability("handle");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**handle:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Orgs.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgMembers</a>() -> Chrt.OrgMemberDetails[]</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgs.getOrgMembers();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Orgs.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgsPublicData</a>() -> Chrt.OrgPublicData2</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get the org public data for the org from JWT
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgs.getOrgsPublicData();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Orgs.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">postOrgsPublicData</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create org public data with handle and company name
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgs.postOrgsPublicData({
+    company_name: "company_name",
+    handle: "handle",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.CreateOrgPublicDataReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Orgs.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">patchOrgsPublicData</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Update handle or company_name for an org
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgs.patchOrgsPublicData();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.UpdateOrgPublicDataReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Orgs.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgsPublicDataByOrgId</a>(orgId) -> Chrt.OrgPublicData2</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get the org public data for the org from org_id
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgs.getOrgsPublicDataByOrgId("org_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**orgId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Orgs.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## Payments
+
+<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">createCheckoutSession</a>({ ...params }) -> Chrt.CreateCheckoutSessionRes2</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Steps:
+(1) (a) Validate and decode the jwt, (b) check for an org_id
+(2) Resolve the subscription_plan
+(3) Check for an already-active same subscription within the org
+(4) Check if the current org membership count <= subscription_plan's limit
+(5) Get the customer_id
+(6) Create the checkout session url
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.payments.createCheckoutSession({
+    price_name: "courier_ops_solo_100_month",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.CreateCheckoutSessionReq2`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Payments.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">syncStripeToClerk</a>() -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.payments.syncStripeToClerk();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Payments.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">webhook</a>() -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.payments.webhook();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Payments.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## Users
+
+<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">getUserPublicData</a>() -> Chrt.UserPublicData5</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.users.getUserPublicData();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Users.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>