@chrt-inc/typescript-sdk 1.935.0 → 1.944.0

package/reference.md

@@ -26579,6 +26579,684 @@ await client.shippingIntegrations.dispatchScience.orders.syncOneV1({
 </dl>
 </details>
 
+## ShippingIntegrations Ecourier Creds
+
+<details><summary><code>client.shippingIntegrations.ecourier.creds.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/Client.ts">detailV1</a>(providerOrgId) -> Chrt.EcourierCredsLimited1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns the caller's e-Courier credential for one provider, without the password or session token. | () -> (EcourierCredsLimited1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shippingIntegrations.ecourier.creds.detailV1("provider_org_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**providerOrgId:** `string` — Must be a string starting with `org_`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Creds.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shippingIntegrations.ecourier.creds.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/Client.ts">listV1</a>() -> Chrt.EcourierCredsListRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists the caller's e-Courier credentials, one per connected provider, without the password or session token. | () -> (EcourierCredsListRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shippingIntegrations.ecourier.creds.listV1();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Creds.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shippingIntegrations.ecourier.creds.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/Client.ts">testV1</a>(providerOrgId) -> Chrt.EcourierCredsTestRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Confirms the caller's stored e-Courier credentials for one provider can still log in, and reports which customer the credential is scoped to. | authz: min_org_role=operator | () -> (EcourierCredsTestRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shippingIntegrations.ecourier.creds.testV1("provider_org_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**providerOrgId:** `string` — Must be a string starting with `org_`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Creds.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shippingIntegrations.ecourier.creds.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/Client.ts">createV1</a>(providerOrgId, { ...params }) -> string</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Stores e-Courier credentials for one provider on behalf of the caller's organization. | authz: min_org_role=administrator | (EcourierCredsClientCreate1) -> (PydanticObjectId)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shippingIntegrations.ecourier.creds.createV1("provider_org_id", {
+    base_url: "https://bigtex.e-courier.com",
+    ecourier_customer_code: "ecourier_customer_code",
+    ecourier_customer_id: "ecourier_customer_id",
+    ecourier_database: "ecourier_database",
+    password: "password",
+    schema_version: 1,
+    username: "username",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**providerOrgId:** `string` — Must be a string starting with `org_`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.shippingIntegrations.ecourier.EcourierCredsClientCreate1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Creds.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shippingIntegrations.ecourier.creds.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/Client.ts">deleteV1</a>(providerOrgId) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Deletes the caller's e-Courier credentials for one provider, stopping future syncs. | authz: min_org_role=administrator | () -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shippingIntegrations.ecourier.creds.deleteV1("provider_org_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**providerOrgId:** `string` — Must be a string starting with `org_`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Creds.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shippingIntegrations.ecourier.creds.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/Client.ts">updateV1</a>(providerOrgId, { ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Updates the caller's e-Courier credentials for one provider. | authz: min_org_role=administrator | (EcourierCredsClientUpdate1) -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shippingIntegrations.ecourier.creds.updateV1("provider_org_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**providerOrgId:** `string` — Must be a string starting with `org_`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.shippingIntegrations.ecourier.EcourierCredsClientUpdate1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Creds.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## ShippingIntegrations Ecourier Orders
+
+<details><summary><code>client.shippingIntegrations.ecourier.orders.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(providerOrgId, integrationOrderId) -> Chrt.EcourierOrder1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns one mirrored e-Courier order by the provider's own order number. | () -> (EcourierOrder1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shippingIntegrations.ecourier.orders.detailByIntegrationOrderIdV1(
+    "provider_org_id",
+    "integration_order_id",
+);
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**providerOrgId:** `string` — CHRT org ID of the courier whose e-Courier database holds the order
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**integrationOrderId:** `string` — e-Courier's own order number for the order, as carried on a unified order row
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Orders.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shippingIntegrations.ecourier.orders.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/Client.ts">detailV1</a>(id) -> Chrt.EcourierOrder1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns one mirrored e-Courier order by its Mongo ObjectId. | () -> (EcourierOrder1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shippingIntegrations.ecourier.orders.detailV1("id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` — Mongo ObjectId of the mirror document. e-Courier's own order number is the integration_order_id, accepted by the by_integration_order_id route.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Orders.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shippingIntegrations.ecourier.orders.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/Client.ts">listV1</a>({ ...params }) -> Chrt.EcourierOrderListRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists mirrored e-Courier orders for the caller's organization with filtering, sorting, and pagination. | () -> (EcourierOrderListRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shippingIntegrations.ecourier.orders.listV1({
+    sort_by: "mirrored_at_timestamp",
+    sort_order: "asc",
+    page: 1,
+    page_size: 1,
+    filter_provider_org_id: ["filter_provider_org_id"],
+    filter_integration_order_id: "filter_integration_order_id",
+    filter_provider_status_raw: "filter_provider_status_raw",
+    filter_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_updated_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_updated_at_timestamp_lte: "2024-01-15T09:30:00Z",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.shippingIntegrations.ecourier.OrdersListV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Orders.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shippingIntegrations.ecourier.orders.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/Client.ts">syncOneV1</a>({ ...params }) -> Chrt.EcourierOrder1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Fetches and mirrors one e-Courier order by the provider's own order number, updating the unified order list alongside it. | authz: min_org_role=operator | (EcourierOrderSyncOneReq) -> (EcourierOrder1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shippingIntegrations.ecourier.orders.syncOneV1({
+    integration_order_id: "integration_order_id",
+    provider_org_id: "provider_org_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.shippingIntegrations.ecourier.EcourierOrderSyncOneReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Orders.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## ShippingIntegrations Ontime360 Creds
 
 <details><summary><code>client.shippingIntegrations.ontime360.creds.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/Client.ts">detailV1</a>(providerOrgId) -> Chrt.OnTime360CredsLimited1</code></summary>