@chrt-inc/typescript-sdk 1.1000.0 → 1.1002.0

package/reference.md

@@ -26434,6 +26434,678 @@ await client.shippingIntegrations.atlas.orders.syncOneV1({
 </dl>
 </details>
 
+## ShippingIntegrations Courie Creds
+
+<details><summary><code>client.shippingIntegrations.courie.creds.<a href="/src/api/resources/shippingIntegrations/resources/courie/resources/creds/client/Client.ts">detailV1</a>(providerOrgId) -> Chrt.CourieCredsLimited1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns the caller's Courie credential for one provider, without API key. | () -> (CourieCredsLimited1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shippingIntegrations.courie.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.courie.creds.<a href="/src/api/resources/shippingIntegrations/resources/courie/resources/creds/client/Client.ts">listV1</a>() -> Chrt.CourieCredsListRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists the caller's Courie credentials, one per connected provider, without API key. | () -> (CourieCredsListRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shippingIntegrations.courie.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.courie.creds.<a href="/src/api/resources/shippingIntegrations/resources/courie/resources/creds/client/Client.ts">testV1</a>(providerOrgId) -> Chrt.CourieCredsTestRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Tests whether stored Courie credentials can authenticate against the provider. | authz: min_org_role=operator | () -> (CourieCredsTestRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shippingIntegrations.courie.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.courie.creds.<a href="/src/api/resources/shippingIntegrations/resources/courie/resources/creds/client/Client.ts">createV1</a>(providerOrgId, { ...params }) -> string</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Stores Courie credentials for one provider on behalf of the caller's organization. | authz: min_org_role=administrator | (CourieCredsClientCreate1) -> (PydanticObjectId)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shippingIntegrations.courie.creds.createV1("provider_org_id", {
+    api_key: "api_key",
+    courier_id: "courier_id",
+    schema_version: 1,
+});
+```
+
+</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.courie.CourieCredsClientCreate1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Creds.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shippingIntegrations.courie.creds.<a href="/src/api/resources/shippingIntegrations/resources/courie/resources/creds/client/Client.ts">deleteV1</a>(providerOrgId) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Deletes stored Courie credentials for one provider. | authz: min_org_role=administrator | () -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shippingIntegrations.courie.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.courie.creds.<a href="/src/api/resources/shippingIntegrations/resources/courie/resources/creds/client/Client.ts">updateV1</a>(providerOrgId, { ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Updates stored Courie credentials for one provider. | authz: min_org_role=administrator | (CourieCredsClientUpdate1) -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shippingIntegrations.courie.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.courie.CourieCredsClientUpdate1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Creds.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## ShippingIntegrations Courie Orders
+
+<details><summary><code>client.shippingIntegrations.courie.orders.<a href="/src/api/resources/shippingIntegrations/resources/courie/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(orgId, integrationOrderId) -> Chrt.CourieOrder1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns one mirrored Courie order by the provider's own order ID. | () -> (CourieOrder1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shippingIntegrations.courie.orders.detailByIntegrationOrderIdV1("org_id", "integration_order_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**orgId:** `string` — CHRT org ID of the other party (executor if caller is coordinator, coordinator if caller is executor)
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**integrationOrderId:** `string` — Courie's own ID 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.courie.orders.<a href="/src/api/resources/shippingIntegrations/resources/courie/resources/orders/client/Client.ts">detailV1</a>(id) -> Chrt.CourieOrder1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns one mirrored Courie order by its Mongo ObjectId. | () -> (CourieOrder1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shippingIntegrations.courie.orders.detailV1("id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` — Mongo ObjectId of the mirror document. Courie's own order ID 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.courie.orders.<a href="/src/api/resources/shippingIntegrations/resources/courie/resources/orders/client/Client.ts">listV1</a>({ ...params }) -> Chrt.CourieOrderListRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists mirrored Courie orders for the caller's organization with filtering, sorting, and pagination. | () -> (CourieOrderListRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shippingIntegrations.courie.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_customer_id: "filter_customer_id",
+    filter_provider_status: "CREATED",
+    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.courie.OrdersListV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Orders.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shippingIntegrations.courie.orders.<a href="/src/api/resources/shippingIntegrations/resources/courie/resources/orders/client/Client.ts">syncOneV1</a>({ ...params }) -> Chrt.CourieOrder1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Fetches and mirrors one Courie order by the provider's own order ID, updating the unified order list alongside it. | authz: min_org_role=operator | (CourieOrderSyncOneReq) -> (CourieOrder1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shippingIntegrations.courie.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.courie.CourieOrderSyncOneReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Orders.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## ShippingIntegrations Cxt Creds
 
 <details><summary><code>client.shippingIntegrations.cxt.creds.<a href="/src/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/Client.ts">detailV1</a>(providerOrgId) -> Chrt.CxtCredsLimited1</code></summary>