@chrt-inc/typescript-sdk 1.1035.0 → 1.1037.0

package/reference.md

@@ -4576,6 +4576,233 @@ await client.billingNew.taxConfigurations.updateV1("tax_configuration_id");
 </dl>
 </details>
 
+## CargoOnFlightIntegrations AirCanada
+
+<details><summary><code>client.cargoOnFlightIntegrations.airCanada.<a href="/src/api/resources/cargoOnFlightIntegrations/resources/airCanada/client/Client.ts">bookV1</a>(cargoOnFlightBookingId, { ...params }) -> Chrt.CargoOnFlightBooking1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Books a draft booking on Air Canada with one result and rate of one of its searches, with the user's Air Canada AWB or one Air Canada assigns. | authz_personas=[task_group_coordinator_operators] | (CargoOnFlightIntegrationsAirCanadaBookReq) -> (CargoOnFlightBooking1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.cargoOnFlightIntegrations.airCanada.bookV1("cargo_on_flight_booking_id", {
+    cargo_on_flight_booking_search_id: "cargo_on_flight_booking_search_id",
+    integration_rate_id: "integration_rate_id",
+    integration_result_id: "integration_result_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**cargoOnFlightBookingId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.cargoOnFlightIntegrations.CargoOnFlightIntegrationsAirCanadaBookReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AirCanada.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.cargoOnFlightIntegrations.airCanada.<a href="/src/api/resources/cargoOnFlightIntegrations/resources/airCanada/client/Client.ts">cancelV1</a>(cargoOnFlightBookingId, { ...params }) -> Chrt.CargoOnFlightBooking1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Deletes a booking on Air Canada and cancels it: a confirmed or requested one with an AWB, Air Canada's or else the requested one. | authz_personas=[task_group_coordinator_operators] | (CargoOnFlightIntegrationsAirCanadaCancelReq) -> (CargoOnFlightBooking1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.cargoOnFlightIntegrations.airCanada.cancelV1("cargo_on_flight_booking_id", {
+    cancellation_reason: "cancellation_reason",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**cargoOnFlightBookingId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.cargoOnFlightIntegrations.CargoOnFlightIntegrationsAirCanadaCancelReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AirCanada.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.cargoOnFlightIntegrations.airCanada.<a href="/src/api/resources/cargoOnFlightIntegrations/resources/airCanada/client/Client.ts">searchV1</a>(cargoOnFlightBookingId, { ...params }) -> Chrt.CargoOnFlightBookingSearch1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Quotes Air Canada flights with space and rates for a draft booking's cargos on a route and dates, and stores the search. | authz_personas=[task_group_coordinator_operators] | (CargoOnFlightBookingSearchClientCreate1) -> (CargoOnFlightBookingSearch1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.cargoOnFlightIntegrations.airCanada.searchV1("cargo_on_flight_booking_id", {
+    destination_iata: "destination_iata",
+    earliest_departure_date: "earliest_departure_date",
+    iata_cass_office_id: "iata_cass_office_id",
+    origin_iata: "origin_iata",
+    schema_version: 1,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**cargoOnFlightBookingId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.CargoOnFlightBookingSearchClientCreate1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AirCanada.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## CargoOnFlightIntegrations Cargoai
 
 <details><summary><code>client.cargoOnFlightIntegrations.cargoai.<a href="/src/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/Client.ts">listAirWaybillMessagesV1</a>({ ...params }) -> Chrt.CargoOnFlightIntegrationsCargoAiAirWaybillMessageListRes</code></summary>
@@ -5125,7 +5352,7 @@ await client.cargoOnFlightIntegrations.cargoai.searchV1("cargo_on_flight_booking
 <dl>
 <dd>
 
-**request:** `Chrt.cargoOnFlightIntegrations.CargoOnFlightBookingSearchClientCreate1`
+**request:** `Chrt.CargoOnFlightBookingSearchClientCreate1`
 
 </dd>
 </dl>
@@ -13803,6 +14030,456 @@ await client.orgs.accounts.getV1("account_id");
 </dl>
 </details>
 
+## Orgs AirWaybillStockNumbers
+
+<details><summary><code>client.orgs.airWaybillStockNumbers.<a href="/src/api/resources/orgs/resources/airWaybillStockNumbers/client/Client.ts">addV1</a>({ ...params }) -> Chrt.AirWaybillStockNumbersAddRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Adds AWB numbers an airline gave the caller's organization to its AWB stock, skipping numbers already in it. | authz: min_org_role=operator | (AirWaybillStockNumbersAddReq) -> (AirWaybillStockNumbersAddRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgs.airWaybillStockNumbers.addV1({
+    awb_numbers: ["awb_numbers"],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.orgs.AirWaybillStockNumbersAddReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AirWaybillStockNumbers.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.orgs.airWaybillStockNumbers.<a href="/src/api/resources/orgs/resources/airWaybillStockNumbers/client/Client.ts">deleteV1</a>(airWaybillStockNumberId) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Deletes an available AWB number from the caller's organization's AWB stock, e.g. one added by mistake. | authz: min_org_role=operator | () -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgs.airWaybillStockNumbers.deleteV1("air_waybill_stock_number_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**airWaybillStockNumberId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AirWaybillStockNumbers.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.orgs.airWaybillStockNumbers.<a href="/src/api/resources/orgs/resources/airWaybillStockNumbers/client/Client.ts">listV1</a>({ ...params }) -> Chrt.AirWaybillStockNumberListRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists the AWB numbers in the caller's organization's AWB stock, by airline prefix and status. | () -> (AirWaybillStockNumberListRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgs.airWaybillStockNumbers.listV1({
+    filter_awb_prefix: "filter_awb_prefix",
+    filter_status: ["available"],
+    sort_by: "awb_number",
+    sort_order: "asc",
+    page: 1,
+    page_size: 1,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.orgs.AirWaybillStockNumbersListV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AirWaybillStockNumbers.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.orgs.airWaybillStockNumbers.<a href="/src/api/resources/orgs/resources/airWaybillStockNumbers/client/Client.ts">markAvailableV1</a>({ ...params }) -> Chrt.AirWaybillStockNumber1[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Marks AWB numbers of the caller's organization's AWB stock as available, whatever their status, taking them off their booking. | authz: min_org_role=operator | (AirWaybillStockNumbersMarkAvailableReq) -> (list[AirWaybillStockNumber1])
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgs.airWaybillStockNumbers.markAvailableV1({
+    awb_numbers: ["awb_numbers"],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.orgs.AirWaybillStockNumbersMarkAvailableReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AirWaybillStockNumbers.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.orgs.airWaybillStockNumbers.<a href="/src/api/resources/orgs/resources/airWaybillStockNumbers/client/Client.ts">markUsedV1</a>({ ...params }) -> Chrt.AirWaybillStockNumber1[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Marks AWB numbers of the caller's organization's AWB stock as used, whatever their status, e.g. booked outside CHRT. | authz: min_org_role=operator | (AirWaybillStockNumbersMarkUsedReq) -> (list[AirWaybillStockNumber1])
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgs.airWaybillStockNumbers.markUsedV1({
+    awb_numbers: ["awb_numbers"],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.orgs.AirWaybillStockNumbersMarkUsedReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AirWaybillStockNumbers.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.orgs.airWaybillStockNumbers.<a href="/src/api/resources/orgs/resources/airWaybillStockNumbers/client/Client.ts">summaryV1</a>() -> Chrt.AirWaybillStockNumbersSummaryRes[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Counts the caller's organization's AWB stock per airline prefix and status. | () -> (list[AirWaybillStockNumbersSummaryRes])
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgs.airWaybillStockNumbers.summaryV1();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `AirWaybillStockNumbers.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.orgs.airWaybillStockNumbers.<a href="/src/api/resources/orgs/resources/airWaybillStockNumbers/client/Client.ts">voidV1</a>({ ...params }) -> Chrt.AirWaybillStockNumber1[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Voids available AWB numbers of the caller's organization's AWB stock, e.g. spoiled or returned to the airline. | authz: min_org_role=operator | (AirWaybillStockNumbersVoidReq) -> (list[AirWaybillStockNumber1])
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orgs.airWaybillStockNumbers.voidV1({
+    awb_numbers: ["awb_numbers"],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.orgs.AirWaybillStockNumbersVoidReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AirWaybillStockNumbers.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Orgs ComplianceDocuments
 
 <details><summary><code>client.orgs.complianceDocuments.<a href="/src/api/resources/orgs/resources/complianceDocuments/client/Client.ts">createV1</a>({ ...params }) -> Chrt.OrgComplianceDocument1</code></summary>
@@ -17827,7 +18504,7 @@ await client.shipping.cargoOnFlightBookings.createV1({
         },
     ],
     cargo_ids: ["cargo_ids"],
-    cargo_on_flight_integration: "cargoai",
+    cargo_on_flight_integration: "air_canada",
     schema_version: 1,
     task_group_id: "task_group_id",
 });