@chrt-inc/typescript-sdk 1.309.0 → 1.312.0

package/reference.md

@@ -3215,6 +3215,69 @@ await client.connections.listForwardersV1();
 </dl>
 </details>
 
+<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getByHandleV1</a>(handle) -> (Chrt.ConnectionsGetByHandleV1Response | null) | undefined</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Gets connection between authenticated org and org with specified handle. | () -> (ShipperCourierConnection1 | ShipperForwarderConnection1 | ForwarderCourierConnection1 | None)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.connections.getByHandleV1("handle");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**handle:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Connections.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## OrgProfiles
 
 <details><summary><code>client.orgProfiles.<a href="/src/api/resources/orgProfiles/client/Client.ts">getV1</a>() -> Chrt.OrgProfileRes1</code></summary>
@@ -9437,9 +9500,9 @@ await client.orders.expandedList.postOrderCreatorExpandedListV1({
 </dl>
 </details>
 
-## OrgConnectionInfos Shipper
+## OrgInfoForConnections Shipper
 
-<details><summary><code>client.orgConnectionInfos.shipper.<a href="/src/api/resources/orgConnectionInfos/resources/shipper/client/Client.ts">getV1</a>() -> Chrt.ShipperOrgInfoForConnections1</code></summary>
+<details><summary><code>client.orgInfoForConnections.shipper.<a href="/src/api/resources/orgInfoForConnections/resources/shipper/client/Client.ts">getV1</a>() -> Chrt.ShipperOrgInfoForConnections1</code></summary>
 <dl>
 <dd>
 
@@ -9467,7 +9530,7 @@ Retrieves shipper organization connection information for the authenticated orga
 <dd>
 
 ```typescript
-await client.orgConnectionInfos.shipper.getV1();
+await client.orgInfoForConnections.shipper.getV1();
 ```
 
 </dd>
@@ -9494,7 +9557,7 @@ await client.orgConnectionInfos.shipper.getV1();
 </dl>
 </details>
 
-<details><summary><code>client.orgConnectionInfos.shipper.<a href="/src/api/resources/orgConnectionInfos/resources/shipper/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
+<details><summary><code>client.orgInfoForConnections.shipper.<a href="/src/api/resources/orgInfoForConnections/resources/shipper/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
 <dl>
 <dd>
 
@@ -9522,7 +9585,7 @@ Creates shipper organization connection information. Fails if already exists. |
 <dd>
 
 ```typescript
-await client.orgConnectionInfos.shipper.createV1({
+await client.orgInfoForConnections.shipper.createV1({
     schema_version: 1,
     email_address_primary: "email_address_primary",
 });
@@ -9541,7 +9604,7 @@ await client.orgConnectionInfos.shipper.createV1({
 <dl>
 <dd>
 
-**request:** `Chrt.orgConnectionInfos.ShipperOrgInfoForConnectionsClientCreate1`
+**request:** `Chrt.orgInfoForConnections.ShipperOrgInfoForConnectionsClientCreate1`
 
 </dd>
 </dl>
@@ -9560,7 +9623,7 @@ await client.orgConnectionInfos.shipper.createV1({
 </dl>
 </details>
 
-<details><summary><code>client.orgConnectionInfos.shipper.<a href="/src/api/resources/orgConnectionInfos/resources/shipper/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
+<details><summary><code>client.orgInfoForConnections.shipper.<a href="/src/api/resources/orgInfoForConnections/resources/shipper/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
 <dl>
 <dd>
 
@@ -9588,7 +9651,7 @@ Updates existing shipper organization connection information. | (ShipperOrgInfoF
 <dd>
 
 ```typescript
-await client.orgConnectionInfos.shipper.updateV1();
+await client.orgInfoForConnections.shipper.updateV1();
 ```
 
 </dd>
@@ -9604,7 +9667,7 @@ await client.orgConnectionInfos.shipper.updateV1();
 <dl>
 <dd>
 
-**request:** `Chrt.orgConnectionInfos.ShipperOrgInfoForConnectionsClientUpdate1`
+**request:** `Chrt.orgInfoForConnections.ShipperOrgInfoForConnectionsClientUpdate1`
 
 </dd>
 </dl>
@@ -9623,9 +9686,9 @@ await client.orgConnectionInfos.shipper.updateV1();
 </dl>
 </details>
 
-## OrgConnectionInfos Courier
+## OrgInfoForConnections Courier
 
-<details><summary><code>client.orgConnectionInfos.courier.<a href="/src/api/resources/orgConnectionInfos/resources/courier/client/Client.ts">getV1</a>() -> Chrt.CourierOrgInfoForConnections1</code></summary>
+<details><summary><code>client.orgInfoForConnections.courier.<a href="/src/api/resources/orgInfoForConnections/resources/courier/client/Client.ts">getV1</a>() -> Chrt.CourierOrgInfoForConnections1</code></summary>
 <dl>
 <dd>
 
@@ -9653,7 +9716,62 @@ Retrieves courier organization connection information for the authenticated orga
 <dd>
 
 ```typescript
-await client.orgConnectionInfos.courier.getV1();
+await client.orgInfoForConnections.courier.getV1();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Courier.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.orgInfoForConnections.courier.<a href="/src/api/resources/orgInfoForConnections/resources/courier/client/Client.ts">listV1</a>() -> Chrt.CourierOrgInfoForConnections1[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves list of connected courier organizations for forwarder or shipper organizations. Not accessible by courier organizations. | () -> (list[CourierOrgInfoForConnections1])
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgInfoForConnections.courier.listV1();
 ```
 
 </dd>
@@ -9680,7 +9798,7 @@ await client.orgConnectionInfos.courier.getV1();
 </dl>
 </details>
 
-<details><summary><code>client.orgConnectionInfos.courier.<a href="/src/api/resources/orgConnectionInfos/resources/courier/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
+<details><summary><code>client.orgInfoForConnections.courier.<a href="/src/api/resources/orgInfoForConnections/resources/courier/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
 <dl>
 <dd>
 
@@ -9708,7 +9826,7 @@ Creates courier organization connection information. Fails if already exists. |
 <dd>
 
 ```typescript
-await client.orgConnectionInfos.courier.createV1({
+await client.orgInfoForConnections.courier.createV1({
     schema_version: 1,
     email_address_primary: "email_address_primary",
 });
@@ -9727,7 +9845,7 @@ await client.orgConnectionInfos.courier.createV1({
 <dl>
 <dd>
 
-**request:** `Chrt.orgConnectionInfos.CourierOrgInfoForConnectionsClientCreate1`
+**request:** `Chrt.orgInfoForConnections.CourierOrgInfoForConnectionsClientCreate1`
 
 </dd>
 </dl>
@@ -9746,7 +9864,7 @@ await client.orgConnectionInfos.courier.createV1({
 </dl>
 </details>
 
-<details><summary><code>client.orgConnectionInfos.courier.<a href="/src/api/resources/orgConnectionInfos/resources/courier/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
+<details><summary><code>client.orgInfoForConnections.courier.<a href="/src/api/resources/orgInfoForConnections/resources/courier/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
 <dl>
 <dd>
 
@@ -9774,7 +9892,7 @@ Updates existing courier organization connection information. | (CourierOrgInfoF
 <dd>
 
 ```typescript
-await client.orgConnectionInfos.courier.updateV1();
+await client.orgInfoForConnections.courier.updateV1();
 ```
 
 </dd>
@@ -9790,7 +9908,7 @@ await client.orgConnectionInfos.courier.updateV1();
 <dl>
 <dd>
 
-**request:** `Chrt.orgConnectionInfos.CourierOrgInfoForConnectionsClientUpdate1`
+**request:** `Chrt.orgInfoForConnections.CourierOrgInfoForConnectionsClientUpdate1`
 
 </dd>
 </dl>
@@ -9809,6 +9927,192 @@ await client.orgConnectionInfos.courier.updateV1();
 </dl>
 </details>
 
+## OrgInfoForConnections Forwarder
+
+<details><summary><code>client.orgInfoForConnections.forwarder.<a href="/src/api/resources/orgInfoForConnections/resources/forwarder/client/Client.ts">getV1</a>() -> Chrt.ForwarderOrgInfoForConnections1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves forwarder organization connection information for the authenticated organization. | () -> (ForwarderOrgInfoForConnections1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgInfoForConnections.forwarder.getV1();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Forwarder.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.orgInfoForConnections.forwarder.<a href="/src/api/resources/orgInfoForConnections/resources/forwarder/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates forwarder organization connection information. Fails if already exists. | (ForwarderOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgInfoForConnections.forwarder.createV1({
+    schema_version: 1,
+    email_address_primary: "email_address_primary",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.orgInfoForConnections.ForwarderOrgInfoForConnectionsClientCreate1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Forwarder.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.orgInfoForConnections.forwarder.<a href="/src/api/resources/orgInfoForConnections/resources/forwarder/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Updates existing forwarder organization connection information. | (ForwarderOrgInfoForConnectionsClientUpdate1) -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgInfoForConnections.forwarder.updateV1();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.orgInfoForConnections.ForwarderOrgInfoForConnectionsClientUpdate1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Forwarder.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## ShipperPayCourierLineItemGroups Shipper
 
 <details><summary><code>client.shipperPayCourierLineItemGroups.shipper.<a href="/src/api/resources/shipperPayCourierLineItemGroups/resources/shipper/client/Client.ts">listV1</a>() -> Chrt.ShipperPayCourierLineItemGroup1[]</code></summary>