@chrt-inc/typescript-sdk 1.967.0 → 1.972.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/Client.d.ts +20 -4
- package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/Client.js +72 -7
- package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/requests/InvoiceLineItemClientUpdate1.d.ts +2 -2
- package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/requests/InvoiceLineItemsCurrencyConversionUpdateManyReq.d.ts +18 -0
- package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/requests/InvoiceLineItemsCurrencyConversionUpdateManyReq.js +5 -0
- package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/resources/export/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/billingNew/resources/invoices/resources/export/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderTemplatesNew/resources/tasks/client/requests/OrderTemplateNewTaskClientCreate1.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/Client.d.ts +13 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/Client.js +59 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/cargo/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/orders/resources/cargo/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.js +5 -1
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForProviderOperatorsV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/task/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/orders/resources/task/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.d.ts +5 -5
- package/dist/cjs/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.js +5 -5
- package/dist/cjs/api/types/DepartmentTypeEnum.d.ts +2 -1
- package/dist/cjs/api/types/DepartmentTypeEnum.js +1 -0
- package/dist/cjs/api/types/InvoiceExportListItem.d.ts +1 -1
- package/dist/cjs/api/types/InvoiceLineItem1.d.ts +1 -0
- package/dist/cjs/api/types/InvoiceLineItemCurrencyConversion1.d.ts +11 -0
- package/dist/cjs/api/types/InvoiceLineItemCurrencyConversion1.js +5 -0
- package/dist/cjs/api/types/InvoiceLineItemServerCreate1.d.ts +1 -0
- package/dist/cjs/api/types/OrderAndTaskGroupExpandedReq.d.ts +2 -0
- package/dist/cjs/api/types/OrderExpandedForProvider.d.ts +1 -0
- package/dist/cjs/api/types/OrderTemplateNewTask1.d.ts +1 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderExpanded1.d.ts +3 -1
- package/dist/cjs/api/types/ShippingIntegrationOrderStatusTimestampProvenanceEnum1.d.ts +8 -0
- package/dist/cjs/api/types/{ShippingIntegrationOrderCompletedAtProvenanceEnum1.js → ShippingIntegrationOrderStatusTimestampProvenanceEnum1.js} +2 -2
- package/dist/cjs/api/types/Task1.d.ts +1 -0
- package/dist/cjs/api/types/TaskClientCreate1.d.ts +1 -0
- package/dist/cjs/api/types/TaskGroupExpanded.d.ts +1 -0
- package/dist/cjs/api/types/index.d.ts +2 -1
- package/dist/cjs/api/types/index.js +2 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/billingNew/resources/invoiceLineItems/client/Client.d.mts +20 -4
- package/dist/esm/api/resources/billingNew/resources/invoiceLineItems/client/Client.mjs +72 -7
- package/dist/esm/api/resources/billingNew/resources/invoiceLineItems/client/requests/InvoiceLineItemClientUpdate1.d.mts +2 -2
- package/dist/esm/api/resources/billingNew/resources/invoiceLineItems/client/requests/InvoiceLineItemsCurrencyConversionUpdateManyReq.d.mts +18 -0
- package/dist/esm/api/resources/billingNew/resources/invoiceLineItems/client/requests/InvoiceLineItemsCurrencyConversionUpdateManyReq.mjs +4 -0
- package/dist/esm/api/resources/billingNew/resources/invoiceLineItems/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/resources/export/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/billingNew/resources/invoices/resources/export/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/orderTemplatesNew/resources/tasks/client/requests/OrderTemplateNewTaskClientCreate1.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/Client.d.mts +13 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/Client.mjs +59 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/cargo/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/cargo/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.mjs +5 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForProviderOperatorsV1Request.d.mts +3 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/task/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/task/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.d.mts +5 -5
- package/dist/esm/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.mjs +5 -5
- package/dist/esm/api/types/DepartmentTypeEnum.d.mts +2 -1
- package/dist/esm/api/types/DepartmentTypeEnum.mjs +1 -0
- package/dist/esm/api/types/InvoiceExportListItem.d.mts +1 -1
- package/dist/esm/api/types/InvoiceLineItem1.d.mts +1 -0
- package/dist/esm/api/types/InvoiceLineItemCurrencyConversion1.d.mts +11 -0
- package/dist/esm/api/types/InvoiceLineItemCurrencyConversion1.mjs +4 -0
- package/dist/esm/api/types/InvoiceLineItemServerCreate1.d.mts +1 -0
- package/dist/esm/api/types/OrderAndTaskGroupExpandedReq.d.mts +2 -0
- package/dist/esm/api/types/OrderExpandedForProvider.d.mts +1 -0
- package/dist/esm/api/types/OrderTemplateNewTask1.d.mts +1 -0
- package/dist/esm/api/types/ShippingIntegrationOrderExpanded1.d.mts +3 -1
- package/dist/esm/api/types/ShippingIntegrationOrderStatusTimestampProvenanceEnum1.d.mts +8 -0
- package/dist/esm/api/types/{ShippingIntegrationOrderCompletedAtProvenanceEnum1.mjs → ShippingIntegrationOrderStatusTimestampProvenanceEnum1.mjs} +1 -1
- package/dist/esm/api/types/Task1.d.mts +1 -0
- package/dist/esm/api/types/TaskClientCreate1.d.mts +1 -0
- package/dist/esm/api/types/TaskGroupExpanded.d.mts +1 -0
- package/dist/esm/api/types/index.d.mts +2 -1
- package/dist/esm/api/types/index.mjs +2 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +141 -11
- package/dist/cjs/api/types/ShippingIntegrationOrderCompletedAtProvenanceEnum1.d.ts +0 -8
- package/dist/esm/api/types/ShippingIntegrationOrderCompletedAtProvenanceEnum1.d.mts +0 -8
package/dist/esm/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.d.mts
CHANGED
|
@@ -31,7 +31,7 @@ export declare class TaskGroup {
|
|
|
31
31
|
protected readonly _options: TaskGroup.Options;
|
|
32
32
|
constructor(_options?: TaskGroup.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Adds a task group to
|
|
34
|
+
* Adds a task group to an order. Draft groups are DRAFT; all later lifecycle groups are STAGED and parent state is synchronized. | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | (OrdersAddTaskGroupReq) -> (PydanticObjectId)
|
|
35
35
|
*
|
|
36
36
|
* @param {Chrt.shipping.orders.OrdersAddTaskGroupReq} request
|
|
37
37
|
* @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -61,7 +61,7 @@ export declare class TaskGroup {
|
|
|
61
61
|
addExecutorV1(taskGroupId: string, request?: Chrt.shipping.orders.OrdersAddTaskGroupExecutorReq, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
62
62
|
private __addExecutorV1;
|
|
63
63
|
/**
|
|
64
|
-
* Deletes a task group
|
|
64
|
+
* Deletes a task group in any lifecycle state and synchronizes affected shipping state. | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | () -> (bool)
|
|
65
65
|
*
|
|
66
66
|
* @param {string} taskGroupId
|
|
67
67
|
* @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -100,7 +100,7 @@ export declare class TaskGroup {
|
|
|
100
100
|
removeExecutorV1(taskGroupId: string, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
101
101
|
private __removeExecutorV1;
|
|
102
102
|
/**
|
|
103
|
-
* Replaces the ordered flight legs on an order task group. | (OrdersSetTaskGroupFlightInfoReq) -> (bool)
|
|
103
|
+
* Replaces the ordered flight legs on an order task group. A submitted leg that is the same physical flight (carrier, flight number, origin, destination, UTC departure date) as an existing leg keeps its id, so tasks reporting on it stay attached. Changing any of those five details is a different flight: the old leg is deleted and any task referencing it has its flight_leg_id cleared. Because flight_leg_id is not editable, re-attaching such a task requires deleting and recreating it. | (OrdersSetTaskGroupFlightInfoReq) -> (bool)
|
|
104
104
|
*
|
|
105
105
|
* @param {string} taskGroupId
|
|
106
106
|
* @param {Chrt.shipping.orders.OrdersSetTaskGroupFlightInfoReq} request
|
|
@@ -124,7 +124,7 @@ export declare class TaskGroup {
|
|
|
124
124
|
setFlightInfoV1(taskGroupId: string, request: Chrt.shipping.orders.OrdersSetTaskGroupFlightInfoReq, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
125
125
|
private __setFlightInfoV1;
|
|
126
126
|
/**
|
|
127
|
-
* Sets
|
|
127
|
+
* Sets task ordering in any lifecycle state, recalculating mileage and affected cargo state. | authz_personas=[draft_creator_org_operator, task_group_operating_org_operators] | (OrdersSetTaskGroupTaskOrderingReq) -> (bool)
|
|
128
128
|
*
|
|
129
129
|
* @param {string} taskGroupId
|
|
130
130
|
* @param {Chrt.shipping.orders.OrdersSetTaskGroupTaskOrderingReq} request
|
|
@@ -140,7 +140,7 @@ export declare class TaskGroup {
|
|
|
140
140
|
setTaskOrderingV1(taskGroupId: string, request: Chrt.shipping.orders.OrdersSetTaskGroupTaskOrderingReq, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
141
141
|
private __setTaskOrderingV1;
|
|
142
142
|
/**
|
|
143
|
-
* Sets the vehicle type
|
|
143
|
+
* Sets the task-group vehicle type in any lifecycle state. | authz_personas=[draft_creator_org_operator, task_group_coordinator_operators] | (OrdersSetTaskGroupVehicleTypeReq) -> (bool)
|
|
144
144
|
*
|
|
145
145
|
* @param {string} taskGroupId
|
|
146
146
|
* @param {Chrt.shipping.orders.OrdersSetTaskGroupVehicleTypeReq} request
|
package/dist/esm/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.mjs
CHANGED
|
@@ -20,7 +20,7 @@ export class TaskGroup {
|
|
|
20
20
|
this._options = _options;
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
|
-
* Adds a task group to
|
|
23
|
+
* Adds a task group to an order. Draft groups are DRAFT; all later lifecycle groups are STAGED and parent state is synchronized. | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | (OrdersAddTaskGroupReq) -> (PydanticObjectId)
|
|
24
24
|
*
|
|
25
25
|
* @param {Chrt.shipping.orders.OrdersAddTaskGroupReq} request
|
|
26
26
|
* @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -148,7 +148,7 @@ export class TaskGroup {
|
|
|
148
148
|
});
|
|
149
149
|
}
|
|
150
150
|
/**
|
|
151
|
-
* Deletes a task group
|
|
151
|
+
* Deletes a task group in any lifecycle state and synchronizes affected shipping state. | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | () -> (bool)
|
|
152
152
|
*
|
|
153
153
|
* @param {string} taskGroupId
|
|
154
154
|
* @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -325,7 +325,7 @@ export class TaskGroup {
|
|
|
325
325
|
});
|
|
326
326
|
}
|
|
327
327
|
/**
|
|
328
|
-
* Replaces the ordered flight legs on an order task group. | (OrdersSetTaskGroupFlightInfoReq) -> (bool)
|
|
328
|
+
* Replaces the ordered flight legs on an order task group. A submitted leg that is the same physical flight (carrier, flight number, origin, destination, UTC departure date) as an existing leg keeps its id, so tasks reporting on it stay attached. Changing any of those five details is a different flight: the old leg is deleted and any task referencing it has its flight_leg_id cleared. Because flight_leg_id is not editable, re-attaching such a task requires deleting and recreating it. | (OrdersSetTaskGroupFlightInfoReq) -> (bool)
|
|
329
329
|
*
|
|
330
330
|
* @param {string} taskGroupId
|
|
331
331
|
* @param {Chrt.shipping.orders.OrdersSetTaskGroupFlightInfoReq} request
|
|
@@ -398,7 +398,7 @@ export class TaskGroup {
|
|
|
398
398
|
});
|
|
399
399
|
}
|
|
400
400
|
/**
|
|
401
|
-
* Sets
|
|
401
|
+
* Sets task ordering in any lifecycle state, recalculating mileage and affected cargo state. | authz_personas=[draft_creator_org_operator, task_group_operating_org_operators] | (OrdersSetTaskGroupTaskOrderingReq) -> (bool)
|
|
402
402
|
*
|
|
403
403
|
* @param {string} taskGroupId
|
|
404
404
|
* @param {Chrt.shipping.orders.OrdersSetTaskGroupTaskOrderingReq} request
|
|
@@ -463,7 +463,7 @@ export class TaskGroup {
|
|
|
463
463
|
});
|
|
464
464
|
}
|
|
465
465
|
/**
|
|
466
|
-
* Sets the vehicle type
|
|
466
|
+
* Sets the task-group vehicle type in any lifecycle state. | authz_personas=[draft_creator_org_operator, task_group_coordinator_operators] | (OrdersSetTaskGroupVehicleTypeReq) -> (bool)
|
|
467
467
|
*
|
|
468
468
|
* @param {string} taskGroupId
|
|
469
469
|
* @param {Chrt.shipping.orders.OrdersSetTaskGroupVehicleTypeReq} request
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
-
export type DepartmentTypeEnum = "aerospace" | "agriculture" | "automotive" | "chemicals" | "electronics" | "energy" | "food_and_beverage" | "general" | "healthcare" | "industrials" | "life_sciences" | "live_animals" | "manufacturing" | "pharmaceutical" | "radiopharma" | "retail" | "semiconductor";
|
|
4
|
+
export type DepartmentTypeEnum = "aerospace" | "agriculture" | "automotive" | "chemicals" | "electronics" | "energy" | "food_and_beverage" | "general" | "healthcare" | "industrials" | "life_sciences" | "live_animals" | "manufacturing" | "marine" | "pharmaceutical" | "radiopharma" | "retail" | "semiconductor";
|
|
5
5
|
export declare const DepartmentTypeEnum: {
|
|
6
6
|
readonly Aerospace: "aerospace";
|
|
7
7
|
readonly Agriculture: "agriculture";
|
|
@@ -16,6 +16,7 @@ export declare const DepartmentTypeEnum: {
|
|
|
16
16
|
readonly LifeSciences: "life_sciences";
|
|
17
17
|
readonly LiveAnimals: "live_animals";
|
|
18
18
|
readonly Manufacturing: "manufacturing";
|
|
19
|
+
readonly Marine: "marine";
|
|
19
20
|
readonly Pharmaceutical: "pharmaceutical";
|
|
20
21
|
readonly Radiopharma: "radiopharma";
|
|
21
22
|
readonly Retail: "retail";
|
|
@@ -21,7 +21,7 @@ export interface InvoiceExportListItem {
|
|
|
21
21
|
delivery_stops_on_order?: number | null;
|
|
22
22
|
destination_iata?: string | null;
|
|
23
23
|
flight_numbers?: string[];
|
|
24
|
-
invoice_approval_timestamp
|
|
24
|
+
invoice_approval_timestamp?: string | null;
|
|
25
25
|
invoice_number: string;
|
|
26
26
|
mileage_estimated?: number | null;
|
|
27
27
|
net_billing: number;
|
|
@@ -15,6 +15,7 @@ export interface InvoiceLineItem1 {
|
|
|
15
15
|
/** Must be a string starting with `user_` */
|
|
16
16
|
created_by_user_id: string;
|
|
17
17
|
currency_code: Chrt.BillingCurrencyCodeEnum1;
|
|
18
|
+
currency_conversion?: Chrt.InvoiceLineItemCurrencyConversion1 | null;
|
|
18
19
|
description: string;
|
|
19
20
|
export_ref__sage__item_id?: string | null;
|
|
20
21
|
invoice_id?: string | null;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Chrt from "../index.mjs";
|
|
5
|
+
export interface InvoiceLineItemCurrencyConversion1 {
|
|
6
|
+
/** Units of the target currency per one unit of source_currency_code. unit_price = source_unit_price * conversion_rate. */
|
|
7
|
+
conversion_rate: number;
|
|
8
|
+
description?: string | null;
|
|
9
|
+
source_currency_code: Chrt.BillingCurrencyCodeEnum1;
|
|
10
|
+
source_unit_price: number;
|
|
11
|
+
}
|
|
@@ -14,6 +14,7 @@ export interface InvoiceLineItemServerCreate1 {
|
|
|
14
14
|
/** Must be a string starting with `user_` */
|
|
15
15
|
created_by_user_id: string;
|
|
16
16
|
currency_code: Chrt.BillingCurrencyCodeEnum1;
|
|
17
|
+
currency_conversion?: Chrt.InvoiceLineItemCurrencyConversion1 | null;
|
|
17
18
|
description: string;
|
|
18
19
|
export_ref__sage__item_id?: string | null;
|
|
19
20
|
invoice_id?: string | null;
|
|
@@ -5,10 +5,12 @@ export interface OrderAndTaskGroupExpandedReq {
|
|
|
5
5
|
expand_accounts?: boolean;
|
|
6
6
|
expand_cargos?: boolean;
|
|
7
7
|
expand_contacts?: boolean;
|
|
8
|
+
expand_coordinator_department?: boolean;
|
|
8
9
|
expand_coordinator_org_company_name?: boolean;
|
|
9
10
|
expand_coordinator_org_handle?: boolean;
|
|
10
11
|
expand_coordinator_task_lists_to_apply_at_order_staging?: boolean;
|
|
11
12
|
expand_driver?: boolean;
|
|
13
|
+
expand_executor_department?: boolean;
|
|
12
14
|
expand_executor_org_company_name?: boolean;
|
|
13
15
|
expand_executor_org_handle?: boolean;
|
|
14
16
|
expand_notification_intents_ad_hoc?: boolean;
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import * as Chrt from "../index.mjs";
|
|
5
5
|
export interface OrderExpandedForProvider {
|
|
6
|
+
coordinator_department?: Chrt.Department1 | null;
|
|
6
7
|
coordinator_org_company_name?: string | null;
|
|
7
8
|
/** Must be a string starting with `@`. May only contain a-z, A-Z, 0-9, _, -. May not be longer than 30 characters. */
|
|
8
9
|
coordinator_org_handle?: string | null;
|
|
@@ -8,6 +8,7 @@ export interface OrderTemplateNewTask1 {
|
|
|
8
8
|
contact_ids?: string[];
|
|
9
9
|
coordinator_shipper_account_ids?: string[];
|
|
10
10
|
datetime_windows_dateparser_str?: Chrt.OrderTemplateNewDateTimeWindow1[];
|
|
11
|
+
flight_leg_id?: string | null;
|
|
11
12
|
geofence_distance_miles?: number;
|
|
12
13
|
location?: Chrt.LocationFeature | null;
|
|
13
14
|
order_placer_comments?: string | null;
|
|
@@ -4,10 +4,12 @@
|
|
|
4
4
|
import * as Chrt from "../index.mjs";
|
|
5
5
|
export interface ShippingIntegrationOrderExpanded1 {
|
|
6
6
|
_id: string;
|
|
7
|
-
completed_at_provenance?: Chrt.
|
|
7
|
+
completed_at_provenance?: Chrt.ShippingIntegrationOrderStatusTimestampProvenanceEnum1 | null;
|
|
8
8
|
completed_at_timestamp?: string | null;
|
|
9
9
|
destination?: Chrt.ShippingIntegrationOrderPlace1 | null;
|
|
10
10
|
first_mirrored_at_timestamp: string;
|
|
11
|
+
in_progress_at_provenance?: Chrt.ShippingIntegrationOrderStatusTimestampProvenanceEnum1 | null;
|
|
12
|
+
in_progress_at_timestamp?: string | null;
|
|
11
13
|
integration_order_id: string;
|
|
12
14
|
last_mirrored_at_timestamp: string;
|
|
13
15
|
ordered_at_timestamp?: string | null;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export type ShippingIntegrationOrderStatusTimestampProvenanceEnum1 = "reported" | "derived";
|
|
5
|
+
export declare const ShippingIntegrationOrderStatusTimestampProvenanceEnum1: {
|
|
6
|
+
readonly Reported: "reported";
|
|
7
|
+
readonly Derived: "derived";
|
|
8
|
+
};
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
-
export const
|
|
4
|
+
export const ShippingIntegrationOrderStatusTimestampProvenanceEnum1 = {
|
|
5
5
|
Reported: "reported",
|
|
6
6
|
Derived: "derived",
|
|
7
7
|
};
|
|
@@ -24,6 +24,7 @@ export interface Task1 {
|
|
|
24
24
|
draft_started_at_timestamp: string;
|
|
25
25
|
exception_at_timestamp?: string | null;
|
|
26
26
|
executor_org_notes?: Chrt.TaskExecutorOrgNote1[];
|
|
27
|
+
flight_leg_id?: string | null;
|
|
27
28
|
geofence_distance_miles?: number;
|
|
28
29
|
location?: Chrt.LocationFeature | null;
|
|
29
30
|
order_id: string;
|
|
@@ -7,6 +7,7 @@ export interface TaskClientCreate1 {
|
|
|
7
7
|
contact_ids?: string[];
|
|
8
8
|
coordinator_shipper_account_ids?: string[];
|
|
9
9
|
datetime_windows?: Chrt.DateTimeWindow1[];
|
|
10
|
+
flight_leg_id?: string | null;
|
|
10
11
|
geofence_distance_miles?: number;
|
|
11
12
|
location?: Chrt.LocationFeature | null;
|
|
12
13
|
order_placer_comments?: string | null;
|
|
@@ -10,6 +10,7 @@ export interface TaskGroupExpanded {
|
|
|
10
10
|
/** Must be a string starting with `org_` */
|
|
11
11
|
coordinator_org_id?: string | null;
|
|
12
12
|
driver?: Chrt.Driver1 | null;
|
|
13
|
+
executor_department?: Chrt.Department1 | null;
|
|
13
14
|
executor_org_company_name?: string | null;
|
|
14
15
|
/** Must be a string starting with `@`. May only contain a-z, A-Z, 0-9, _, -. May not be longer than 30 characters. */
|
|
15
16
|
executor_org_handle?: string | null;
|
|
@@ -262,6 +262,7 @@ export * from "./InvoiceLineItem1.mjs";
|
|
|
262
262
|
export * from "./InvoiceLineItemAmountTransformation1.mjs";
|
|
263
263
|
export * from "./InvoiceLineItemAmountTransformationTypeEnum1.mjs";
|
|
264
264
|
export * from "./InvoiceLineItemClientCreate1.mjs";
|
|
265
|
+
export * from "./InvoiceLineItemCurrencyConversion1.mjs";
|
|
265
266
|
export * from "./InvoiceLineItemExpandedListItem.mjs";
|
|
266
267
|
export * from "./InvoiceLineItemExpandedRes.mjs";
|
|
267
268
|
export * from "./InvoiceLineItemListRes.mjs";
|
|
@@ -476,7 +477,6 @@ export * from "./ShippingIntegrationConnection.mjs";
|
|
|
476
477
|
export * from "./ShippingIntegrationConnectionListRes.mjs";
|
|
477
478
|
export * from "./ShippingIntegrationIntegrationExecutor.mjs";
|
|
478
479
|
export * from "./ShippingIntegrationIntegrationExecutorListRes.mjs";
|
|
479
|
-
export * from "./ShippingIntegrationOrderCompletedAtProvenanceEnum1.mjs";
|
|
480
480
|
export * from "./ShippingIntegrationOrderExpanded1.mjs";
|
|
481
481
|
export * from "./ShippingIntegrationOrderListRes.mjs";
|
|
482
482
|
export * from "./ShippingIntegrationOrderPlace1.mjs";
|
|
@@ -487,6 +487,7 @@ export * from "./ShippingIntegrationOrderStatusChangedRes.mjs";
|
|
|
487
487
|
export * from "./ShippingIntegrationOrderStatusChangedWebhookPayload.mjs";
|
|
488
488
|
export * from "./ShippingIntegrationOrderStatusEnum1.mjs";
|
|
489
489
|
export * from "./ShippingIntegrationOrderStatusSummaryRes.mjs";
|
|
490
|
+
export * from "./ShippingIntegrationOrderStatusTimestampProvenanceEnum1.mjs";
|
|
490
491
|
export * from "./ShippingIntegrationOrderTypeaheadFieldEnum.mjs";
|
|
491
492
|
export * from "./ShippingIntegrationOrderTypeaheadResult.mjs";
|
|
492
493
|
export * from "./ShippingOrderCancelledWebhookPayload.mjs";
|
|
@@ -262,6 +262,7 @@ export * from "./InvoiceLineItem1.mjs";
|
|
|
262
262
|
export * from "./InvoiceLineItemAmountTransformation1.mjs";
|
|
263
263
|
export * from "./InvoiceLineItemAmountTransformationTypeEnum1.mjs";
|
|
264
264
|
export * from "./InvoiceLineItemClientCreate1.mjs";
|
|
265
|
+
export * from "./InvoiceLineItemCurrencyConversion1.mjs";
|
|
265
266
|
export * from "./InvoiceLineItemExpandedListItem.mjs";
|
|
266
267
|
export * from "./InvoiceLineItemExpandedRes.mjs";
|
|
267
268
|
export * from "./InvoiceLineItemListRes.mjs";
|
|
@@ -476,7 +477,6 @@ export * from "./ShippingIntegrationConnection.mjs";
|
|
|
476
477
|
export * from "./ShippingIntegrationConnectionListRes.mjs";
|
|
477
478
|
export * from "./ShippingIntegrationIntegrationExecutor.mjs";
|
|
478
479
|
export * from "./ShippingIntegrationIntegrationExecutorListRes.mjs";
|
|
479
|
-
export * from "./ShippingIntegrationOrderCompletedAtProvenanceEnum1.mjs";
|
|
480
480
|
export * from "./ShippingIntegrationOrderExpanded1.mjs";
|
|
481
481
|
export * from "./ShippingIntegrationOrderListRes.mjs";
|
|
482
482
|
export * from "./ShippingIntegrationOrderPlace1.mjs";
|
|
@@ -487,6 +487,7 @@ export * from "./ShippingIntegrationOrderStatusChangedRes.mjs";
|
|
|
487
487
|
export * from "./ShippingIntegrationOrderStatusChangedWebhookPayload.mjs";
|
|
488
488
|
export * from "./ShippingIntegrationOrderStatusEnum1.mjs";
|
|
489
489
|
export * from "./ShippingIntegrationOrderStatusSummaryRes.mjs";
|
|
490
|
+
export * from "./ShippingIntegrationOrderStatusTimestampProvenanceEnum1.mjs";
|
|
490
491
|
export * from "./ShippingIntegrationOrderTypeaheadFieldEnum.mjs";
|
|
491
492
|
export * from "./ShippingIntegrationOrderTypeaheadResult.mjs";
|
|
492
493
|
export * from "./ShippingOrderCancelledWebhookPayload.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.972.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "1.
|
|
1
|
+
export const SDK_VERSION = "1.972.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -2741,7 +2741,7 @@ await client.billingNew.invoiceLineItems.recalculateTaxesV1({
|
|
|
2741
2741
|
</dl>
|
|
2742
2742
|
</details>
|
|
2743
2743
|
|
|
2744
|
-
<details><summary><code>client.billingNew.invoiceLineItems.<a href="/src/api/resources/billingNew/resources/invoiceLineItems/client/Client.ts">
|
|
2744
|
+
<details><summary><code>client.billingNew.invoiceLineItems.<a href="/src/api/resources/billingNew/resources/invoiceLineItems/client/Client.ts">updateCurrencyConversionManyV1</a>({ ...params }) -> Chrt.InvoiceLineItem1[]</code></summary>
|
|
2745
2745
|
<dl>
|
|
2746
2746
|
<dd>
|
|
2747
2747
|
|
|
@@ -2753,7 +2753,7 @@ await client.billingNew.invoiceLineItems.recalculateTaxesV1({
|
|
|
2753
2753
|
<dl>
|
|
2754
2754
|
<dd>
|
|
2755
2755
|
|
|
2756
|
-
|
|
2756
|
+
Applies or reverts one currency conversion on line items from their original source values and moves attached items to the matching target-currency draft invoice. | authz: allowed_org_types=[provider], min_org_role=operator | (InvoiceLineItemsCurrencyConversionUpdateManyReq) -> (list[InvoiceLineItem1])
|
|
2757
2757
|
|
|
2758
2758
|
</dd>
|
|
2759
2759
|
</dl>
|
|
@@ -2769,7 +2769,73 @@ Updates an owner-scoped line item and rebuilds its draft invoice when attached.
|
|
|
2769
2769
|
<dd>
|
|
2770
2770
|
|
|
2771
2771
|
```typescript
|
|
2772
|
-
await client.billingNew.invoiceLineItems.
|
|
2772
|
+
await client.billingNew.invoiceLineItems.updateCurrencyConversionManyV1({
|
|
2773
|
+
invoice_line_item_ids: ["invoice_line_item_ids"],
|
|
2774
|
+
target_currency_code: "USD",
|
|
2775
|
+
});
|
|
2776
|
+
```
|
|
2777
|
+
|
|
2778
|
+
</dd>
|
|
2779
|
+
</dl>
|
|
2780
|
+
</dd>
|
|
2781
|
+
</dl>
|
|
2782
|
+
|
|
2783
|
+
#### ⚙️ Parameters
|
|
2784
|
+
|
|
2785
|
+
<dl>
|
|
2786
|
+
<dd>
|
|
2787
|
+
|
|
2788
|
+
<dl>
|
|
2789
|
+
<dd>
|
|
2790
|
+
|
|
2791
|
+
**request:** `Chrt.billingNew.InvoiceLineItemsCurrencyConversionUpdateManyReq`
|
|
2792
|
+
|
|
2793
|
+
</dd>
|
|
2794
|
+
</dl>
|
|
2795
|
+
|
|
2796
|
+
<dl>
|
|
2797
|
+
<dd>
|
|
2798
|
+
|
|
2799
|
+
**requestOptions:** `InvoiceLineItems.RequestOptions`
|
|
2800
|
+
|
|
2801
|
+
</dd>
|
|
2802
|
+
</dl>
|
|
2803
|
+
</dd>
|
|
2804
|
+
</dl>
|
|
2805
|
+
|
|
2806
|
+
</dd>
|
|
2807
|
+
</dl>
|
|
2808
|
+
</details>
|
|
2809
|
+
|
|
2810
|
+
<details><summary><code>client.billingNew.invoiceLineItems.<a href="/src/api/resources/billingNew/resources/invoiceLineItems/client/Client.ts">updateSourceV1</a>(invoiceLineItemId, { ...params }) -> Chrt.InvoiceLineItem1</code></summary>
|
|
2811
|
+
<dl>
|
|
2812
|
+
<dd>
|
|
2813
|
+
|
|
2814
|
+
#### 📝 Description
|
|
2815
|
+
|
|
2816
|
+
<dl>
|
|
2817
|
+
<dd>
|
|
2818
|
+
|
|
2819
|
+
<dl>
|
|
2820
|
+
<dd>
|
|
2821
|
+
|
|
2822
|
+
Updates an owner-scoped line item's source fields, reapplies any existing currency conversion, and rebuilds its draft invoice when attached. | authz: allowed_org_types=[provider], min_org_role=operator | (InvoiceLineItemClientUpdate1) -> (InvoiceLineItem1)
|
|
2823
|
+
|
|
2824
|
+
</dd>
|
|
2825
|
+
</dl>
|
|
2826
|
+
</dd>
|
|
2827
|
+
</dl>
|
|
2828
|
+
|
|
2829
|
+
#### 🔌 Usage
|
|
2830
|
+
|
|
2831
|
+
<dl>
|
|
2832
|
+
<dd>
|
|
2833
|
+
|
|
2834
|
+
<dl>
|
|
2835
|
+
<dd>
|
|
2836
|
+
|
|
2837
|
+
```typescript
|
|
2838
|
+
await client.billingNew.invoiceLineItems.updateSourceV1("invoice_line_item_id");
|
|
2773
2839
|
```
|
|
2774
2840
|
|
|
2775
2841
|
</dd>
|
|
@@ -3887,7 +3953,7 @@ await client.billingNew.orders.listExpandedForCoordinatorOperatorsV1({
|
|
|
3887
3953
|
<dl>
|
|
3888
3954
|
<dd>
|
|
3889
3955
|
|
|
3890
|
-
Lists up to 1,000 shipment-level export rows for one
|
|
3956
|
+
Lists up to 1,000 shipment-level export rows for one accounts-receivable invoice owned by the caller's organization, regardless of invoice status. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (InvoiceExportListRes)
|
|
3891
3957
|
|
|
3892
3958
|
</dd>
|
|
3893
3959
|
</dl>
|
|
@@ -17541,6 +17607,69 @@ await client.shipping.orders.unassignV1("order_id", {
|
|
|
17541
17607
|
</dl>
|
|
17542
17608
|
</details>
|
|
17543
17609
|
|
|
17610
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">undoCancelV1</a>(orderId) -> boolean</code></summary>
|
|
17611
|
+
<dl>
|
|
17612
|
+
<dd>
|
|
17613
|
+
|
|
17614
|
+
#### 📝 Description
|
|
17615
|
+
|
|
17616
|
+
<dl>
|
|
17617
|
+
<dd>
|
|
17618
|
+
|
|
17619
|
+
<dl>
|
|
17620
|
+
<dd>
|
|
17621
|
+
|
|
17622
|
+
Reopens a cancelled order, restaging every cancelled task group, task, task artifact, operations task, and cargo on it regardless of when each was cancelled, then re-deriving order, cargo, and driver status from the surviving work. | authz_personas=[task_group_operating_org_operators] | () -> (bool)
|
|
17623
|
+
|
|
17624
|
+
</dd>
|
|
17625
|
+
</dl>
|
|
17626
|
+
</dd>
|
|
17627
|
+
</dl>
|
|
17628
|
+
|
|
17629
|
+
#### 🔌 Usage
|
|
17630
|
+
|
|
17631
|
+
<dl>
|
|
17632
|
+
<dd>
|
|
17633
|
+
|
|
17634
|
+
<dl>
|
|
17635
|
+
<dd>
|
|
17636
|
+
|
|
17637
|
+
```typescript
|
|
17638
|
+
await client.shipping.orders.undoCancelV1("order_id");
|
|
17639
|
+
```
|
|
17640
|
+
|
|
17641
|
+
</dd>
|
|
17642
|
+
</dl>
|
|
17643
|
+
</dd>
|
|
17644
|
+
</dl>
|
|
17645
|
+
|
|
17646
|
+
#### ⚙️ Parameters
|
|
17647
|
+
|
|
17648
|
+
<dl>
|
|
17649
|
+
<dd>
|
|
17650
|
+
|
|
17651
|
+
<dl>
|
|
17652
|
+
<dd>
|
|
17653
|
+
|
|
17654
|
+
**orderId:** `string`
|
|
17655
|
+
|
|
17656
|
+
</dd>
|
|
17657
|
+
</dl>
|
|
17658
|
+
|
|
17659
|
+
<dl>
|
|
17660
|
+
<dd>
|
|
17661
|
+
|
|
17662
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
17663
|
+
|
|
17664
|
+
</dd>
|
|
17665
|
+
</dl>
|
|
17666
|
+
</dd>
|
|
17667
|
+
</dl>
|
|
17668
|
+
|
|
17669
|
+
</dd>
|
|
17670
|
+
</dl>
|
|
17671
|
+
</details>
|
|
17672
|
+
|
|
17544
17673
|
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">updateDepartmentV1</a>(orderId, { ...params }) -> boolean</code></summary>
|
|
17545
17674
|
<dl>
|
|
17546
17675
|
<dd>
|
|
@@ -21251,7 +21380,7 @@ await client.shipping.orders.cargo.associateWithTaskV1({
|
|
|
21251
21380
|
<dl>
|
|
21252
21381
|
<dd>
|
|
21253
21382
|
|
|
21254
|
-
Deletes
|
|
21383
|
+
Deletes cargo in any lifecycle state, removes task associations, and resynchronizes the order AWB cache. | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | () -> (bool)
|
|
21255
21384
|
|
|
21256
21385
|
</dd>
|
|
21257
21386
|
</dl>
|
|
@@ -21828,6 +21957,7 @@ await client.shipping.orders.expanded.listForProviderOperatorsV1({
|
|
|
21828
21957
|
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
21829
21958
|
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21830
21959
|
filter_executor_org_id: "filter_executor_org_id",
|
|
21960
|
+
filter_executor_department_id: "filter_executor_department_id",
|
|
21831
21961
|
filter_off_chrt_executor_org_data_id: "filter_off_chrt_executor_org_data_id",
|
|
21832
21962
|
filter_coordinator_org_id: "filter_coordinator_org_id",
|
|
21833
21963
|
filter_shipper_org_id: "filter_shipper_org_id",
|
|
@@ -22189,7 +22319,7 @@ await client.shipping.orders.task.addV1({
|
|
|
22189
22319
|
<dl>
|
|
22190
22320
|
<dd>
|
|
22191
22321
|
|
|
22192
|
-
Deletes a task
|
|
22322
|
+
Deletes a task in any lifecycle state and synchronizes affected shipping state. | () -> (bool)
|
|
22193
22323
|
|
|
22194
22324
|
</dd>
|
|
22195
22325
|
</dl>
|
|
@@ -22466,7 +22596,7 @@ await client.shipping.orders.taskArtifact.deleteV1("task_artifact_id");
|
|
|
22466
22596
|
<dl>
|
|
22467
22597
|
<dd>
|
|
22468
22598
|
|
|
22469
|
-
Adds a task group to
|
|
22599
|
+
Adds a task group to an order. Draft groups are DRAFT; all later lifecycle groups are STAGED and parent state is synchronized. | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | (OrdersAddTaskGroupReq) -> (PydanticObjectId)
|
|
22470
22600
|
|
|
22471
22601
|
</dd>
|
|
22472
22602
|
</dl>
|
|
@@ -22603,7 +22733,7 @@ await client.shipping.orders.taskGroup.addExecutorV1("task_group_id");
|
|
|
22603
22733
|
<dl>
|
|
22604
22734
|
<dd>
|
|
22605
22735
|
|
|
22606
|
-
Deletes a task group
|
|
22736
|
+
Deletes a task group in any lifecycle state and synchronizes affected shipping state. | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | () -> (bool)
|
|
22607
22737
|
|
|
22608
22738
|
</dd>
|
|
22609
22739
|
</dl>
|
|
@@ -22792,7 +22922,7 @@ await client.shipping.orders.taskGroup.removeExecutorV1("task_group_id");
|
|
|
22792
22922
|
<dl>
|
|
22793
22923
|
<dd>
|
|
22794
22924
|
|
|
22795
|
-
Replaces the ordered flight legs on an order task group. | (OrdersSetTaskGroupFlightInfoReq) -> (bool)
|
|
22925
|
+
Replaces the ordered flight legs on an order task group. A submitted leg that is the same physical flight (carrier, flight number, origin, destination, UTC departure date) as an existing leg keeps its id, so tasks reporting on it stay attached. Changing any of those five details is a different flight: the old leg is deleted and any task referencing it has its flight_leg_id cleared. Because flight_leg_id is not editable, re-attaching such a task requires deleting and recreating it. | (OrdersSetTaskGroupFlightInfoReq) -> (bool)
|
|
22796
22926
|
|
|
22797
22927
|
</dd>
|
|
22798
22928
|
</dl>
|
|
@@ -22875,7 +23005,7 @@ await client.shipping.orders.taskGroup.setFlightInfoV1("task_group_id", {
|
|
|
22875
23005
|
<dl>
|
|
22876
23006
|
<dd>
|
|
22877
23007
|
|
|
22878
|
-
Sets
|
|
23008
|
+
Sets task ordering in any lifecycle state, recalculating mileage and affected cargo state. | authz_personas=[draft_creator_org_operator, task_group_operating_org_operators] | (OrdersSetTaskGroupTaskOrderingReq) -> (bool)
|
|
22879
23009
|
|
|
22880
23010
|
</dd>
|
|
22881
23011
|
</dl>
|
|
@@ -22948,7 +23078,7 @@ await client.shipping.orders.taskGroup.setTaskOrderingV1("task_group_id", {
|
|
|
22948
23078
|
<dl>
|
|
22949
23079
|
<dd>
|
|
22950
23080
|
|
|
22951
|
-
Sets the vehicle type
|
|
23081
|
+
Sets the task-group vehicle type in any lifecycle state. | authz_personas=[draft_creator_org_operator, task_group_coordinator_operators] | (OrdersSetTaskGroupVehicleTypeReq) -> (bool)
|
|
22952
23082
|
|
|
22953
23083
|
</dd>
|
|
22954
23084
|
</dl>
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
export type ShippingIntegrationOrderCompletedAtProvenanceEnum1 = "reported" | "derived";
|
|
5
|
-
export declare const ShippingIntegrationOrderCompletedAtProvenanceEnum1: {
|
|
6
|
-
readonly Reported: "reported";
|
|
7
|
-
readonly Derived: "derived";
|
|
8
|
-
};
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
export type ShippingIntegrationOrderCompletedAtProvenanceEnum1 = "reported" | "derived";
|
|
5
|
-
export declare const ShippingIntegrationOrderCompletedAtProvenanceEnum1: {
|
|
6
|
-
readonly Reported: "reported";
|
|
7
|
-
readonly Derived: "derived";
|
|
8
|
-
};
|