@myparcel-dev/sdk 5.0.0

package/lib/endpoints/private/shipments/Shipment.types.d.ts

@@ -0,0 +1,175 @@
+import { CarrierId, CustomsDeclarationContents, DeliveryTypeId, PackageTypeId, ShipmentStatus } from '@myparcel-dev/constants';
+import { AddressWithContactDetails, RetailLocation, IntBoolean, Price, WithRequired } from '../../../types';
+
+export interface PostedShipmentReference {
+    id: number;
+    reference_identifier: string;
+}
+export interface PhysicalProperties {
+    height?: number;
+    length?: number;
+    volume?: number;
+    weight: number;
+    width?: number;
+}
+export interface ShipmentOptions {
+    delivery_type: DeliveryTypeId | null;
+    package_type: PackageTypeId;
+    age_check?: IntBoolean;
+    collect?: IntBoolean;
+    cooled_delivery?: IntBoolean;
+    delivery_date?: string | null;
+    drop_off_at_postal_point?: IntBoolean;
+    extra_assurance?: IntBoolean;
+    hide_sender?: IntBoolean;
+    insurance?: Price;
+    label_description?: string;
+    large_format?: IntBoolean;
+    only_recipient?: IntBoolean;
+    return?: IntBoolean;
+    same_day_delivery?: IntBoolean;
+    saturday_delivery?: IntBoolean;
+    signature?: IntBoolean;
+}
+export interface CustomsDeclarationItem {
+    amount: number;
+    classification: string;
+    country?: string;
+    description: string;
+    item_value?: Price;
+    weight: number;
+}
+export interface ShipmentCustomsDeclaration {
+    contents: CustomsDeclarationContents;
+    eori_number?: string | null;
+    invoice?: string | null;
+    items: CustomsDeclarationItem[];
+    vat_number?: string | null;
+    weight: number;
+}
+export interface ShipmentGeneralSettings {
+    delivery_notification?: IntBoolean;
+    delivery_notification_email?: string[];
+    disable_auto_detect_pickup?: IntBoolean;
+    printer_identifier?: string;
+    save_recipient_address?: IntBoolean;
+    tracktrace?: {
+        bcc: IntBoolean;
+        bcc_email: string;
+        carrier_email_basic_notification: IntBoolean;
+        delivery_notification: IntBoolean;
+        email_on_handed_to_courier: IntBoolean;
+        from_address_company: string;
+        from_address_email: string;
+        send_track_trace_emails: IntBoolean;
+    };
+}
+export interface ShipmentPickup {
+    box_number?: string;
+    cc?: string;
+    city?: string;
+    location_code?: string;
+    location_name?: string;
+    number?: string;
+    number_suffix?: string;
+    postal_code?: string;
+    region?: string;
+    retail_network_id?: string;
+    state?: string;
+    street?: string;
+}
+export interface ShipmentPostData {
+    account_id?: number;
+    carrier: CarrierId;
+    customs_declaration?: ShipmentCustomsDeclaration | null;
+    delivered?: 0;
+    general_settings?: ShipmentGeneralSettings;
+    hidden?: IntBoolean;
+    options?: ShipmentOptions;
+    physical_properties?: PhysicalProperties;
+    pickup?: ShipmentPickup | null;
+    recipient: WithRequired<AddressWithContactDetails, 'number'> | WithRequired<AddressWithContactDetails, 'street'>;
+    reference_identifier?: number | string;
+    shop_id?: number;
+    status?: ShipmentStatus;
+}
+interface ShippedItem {
+    order_identifier: string;
+    order_line: {
+        external_identifier: null;
+        instructions: null;
+        price: number;
+        price_after_vat: number;
+        product: {
+            external_identifier: string;
+            height: number;
+            length: number;
+            name: string;
+            sku: string;
+            weight: number;
+            width: number;
+        };
+        quantity: number;
+        shippable: boolean;
+        uuid: string;
+        vat: null;
+        vat_percentage: null;
+    };
+    order_line_identifier: string;
+    quantity: number;
+}
+export interface MyParcelShipment {
+    account_id: number;
+    api_key: string | null;
+    barcode: string | null;
+    carrier_id: CarrierId;
+    collection_contact: string | null;
+    contract_id: number;
+    created: Date;
+    created_by: number;
+    customs_declaration: ShipmentCustomsDeclaration | null;
+    delayed: boolean;
+    delivered: boolean;
+    drop_off_point: RetailLocation | null;
+    external_identifier: string | null;
+    external_provider: null;
+    external_provider_id: null;
+    general_settings: ShipmentGeneralSettings;
+    hidden: boolean;
+    id: number;
+    is_return: boolean;
+    link_consumer_portal: string | null;
+    modified: Date;
+    modified_by: number;
+    multi_collo: boolean;
+    multi_collo_main_shipment_id: string | null;
+    options: ShipmentOptions;
+    origin: string | null;
+    parent_id: number | null;
+    partner_track_traces: unknown[];
+    partner_tracktraces: unknown[];
+    payment_status: string;
+    physical_properties: PhysicalProperties | null;
+    pickup: RetailLocation | null;
+    pickup_request_number: null;
+    platform_id: number;
+    price: Price;
+    recipient: AddressWithContactDetails;
+    reference_identifier: string | null;
+    region: string;
+    secondary_shipments: unknown[];
+    sender: AddressWithContactDetails;
+    shipment_type: number | null;
+    shipped_items: ShippedItem[];
+    shop_id: number;
+    status: number | null;
+    transaction_status: string;
+    user_agent: string | null;
+}
+export interface ShipmentPatchData {
+    id: number;
+    hidden?: IntBoolean;
+    status?: ShipmentStatus;
+    delivered?: IntBoolean;
+}
+export {};

package/lib/endpoints/private/shipments/index.d.ts

@@ -0,0 +1,4 @@
+export * from './GetShipment';
+export * from './GetShipments';
+export * from './PostShipments';
+export * from './Shipment.types';

package/lib/endpoints/private/shops/GetShop.d.ts

@@ -0,0 +1,20 @@
+import { MyParcelShop } from './Shop.types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+
+type GetShopDefinition = CreateDefinition<{
+    name: typeof GetShop.name;
+    path: {
+        id: number;
+    };
+    response: MyParcelShop[];
+}>;
+/**
+ * Retrieve a single shop by ID.
+ */
+export declare class GetShop extends AbstractPrivateEndpoint<GetShopDefinition> {
+    readonly name = "getShop";
+    readonly path = "shops/:id";
+    readonly property = "shops";
+}
+export {};

package/lib/endpoints/private/shops/PostShop.d.ts

@@ -0,0 +1,23 @@
+import { MyParcelShop } from './Shop.types';
+import { HttpMethod } from '../../../types/request.types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+
+type PostShopDefinition = CreateDefinition<{
+    name: typeof PostShop.name;
+    body: MyParcelShop[];
+    response: {
+        id: number;
+    }[];
+}>;
+/**
+ * Create a shop.
+ */
+export declare class PostShop extends AbstractPrivateEndpoint<PostShopDefinition> {
+    readonly method: HttpMethod;
+    readonly name = "postShop";
+    readonly path = "shops/duplicate";
+    readonly property = "shops";
+    readonly responseProperty = "ids";
+}
+export {};

package/lib/endpoints/private/shops/PostShopDuplicate.d.ts

@@ -0,0 +1,24 @@
+import { DuplicateShop } from './Shop.types';
+import { HttpMethod } from '../../../types/request.types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+
+type PostShopDuplicateDefinition = CreateDefinition<{
+    name: typeof PostShopDuplicate.name;
+    body: DuplicateShop[];
+    response: {
+        ids: [{
+            id: number;
+        }];
+    };
+}>;
+/**
+ * The PostShopDuplicate endpoint is used to add a new shop.
+ */
+export declare class PostShopDuplicate extends AbstractPrivateEndpoint<PostShopDuplicateDefinition> {
+    readonly method: HttpMethod;
+    readonly name = "postShopDuplicate";
+    readonly path = "shops/duplicate";
+    readonly property = "ids";
+}
+export {};

package/lib/endpoints/private/shops/PutShop.d.ts

@@ -0,0 +1,17 @@
+import { MyParcelShop } from './Shop.types';
+import { HttpMethod } from '../../../types/request.types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+
+type PutShopDefinition = CreateDefinition<{
+    name: typeof PutShop.name;
+    body: MyParcelShop[];
+    response: MyParcelShop[];
+}>;
+export declare class PutShop extends AbstractPrivateEndpoint<PutShopDefinition> {
+    readonly method: HttpMethod;
+    readonly name = "putShop";
+    readonly path = "shops";
+    readonly property = "shops";
+}
+export {};

package/lib/endpoints/private/shops/Shop.types.d.ts

@@ -0,0 +1,81 @@
+import { Address, IntBoolean } from '../../../types';
+
+export interface ShopBranding {
+    accent_color: string;
+    enable_returns: boolean;
+    enable_track_trace: boolean;
+    subdomain: string;
+    use_consumer_portal: boolean;
+}
+export interface ShopBilling {
+    address: Address;
+    billing_method: 1 | 2 | 3 | 4;
+    coc?: string;
+    cycle: 'monthly' | 'weekly';
+    eori_number?: string;
+    iban?: string;
+    reference: string;
+    vat_number_uk?: string;
+    vat_number?: string;
+}
+export interface ReturnReason {
+    human: string;
+    name: string;
+}
+export interface ShopReturnReasons {
+    enabled: boolean;
+    mandatory: boolean;
+    return_reasons: ReturnReason[];
+}
+export interface ShopReturn {
+    address: Address;
+    bcc: IntBoolean;
+    email_address_for_tracktrace_return_shipments: string;
+    from_address_name?: string;
+    link_expires_after?: number;
+    send_tracktrace_email_for_return_shipments: IntBoolean;
+    settle_printerless_return_cost: IntBoolean;
+    use_custom_description: IntBoolean;
+    use_printerless_return: IntBoolean;
+    use_shop_shipment_options: IntBoolean;
+}
+export interface ShopSettings {
+    auto_save_addresses: IntBoolean;
+    default_collect_address_id?: number;
+    label_description: string;
+    label_format_locked: IntBoolean;
+    label_format: 'A4' | 'A6';
+    preferred_locale?: string;
+    reminder_email: IntBoolean;
+    use_logo_label: IntBoolean;
+    weight: number;
+}
+export interface ShopTrackTrace {
+    bcc_email: string;
+    bcc: IntBoolean;
+    carrier_email_basic_notification: IntBoolean;
+    delivery_notification: IntBoolean;
+    email_on_handed_to_courier: IntBoolean;
+    from_address_company: string;
+    from_address_email: string;
+    send_track_trace_emails: IntBoolean;
+}
+export interface MyParcelShop {
+    account_id: number;
+    billing: ShopBilling;
+    branding: ShopBranding;
+    created: string;
+    general_settings: ShopSettings;
+    hidden: boolean;
+    id: number;
+    modified: string;
+    name: string;
+    platform_id: number;
+    return_reason_settings: ShopReturnReasons;
+    return: ShopReturn;
+    tracktrace: ShopTrackTrace;
+}
+export interface DuplicateShop {
+    name: string;
+    account_id: number;
+}

package/lib/endpoints/private/shops/index.d.ts

@@ -0,0 +1,5 @@
+export * from './GetShop';
+export * from './PostShop';
+export * from './PostShopDuplicate';
+export * from './PutShop';
+export * from './Shop.types';

package/lib/endpoints/private/subscription-capabilities/GetSubscriptionCapabilities.d.ts

@@ -0,0 +1,18 @@
+import { SubscriptionCapability } from './SubscriptionCapability.types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+import { SubscriptionType } from '../subscriptions/Subscriptions.types';
+
+type GetSubscriptionsCapabilitiesDefinition = CreateDefinition<{
+    name: typeof GetSubscriptionsCapabilities.name;
+    parameters: {
+        id: number;
+    };
+    response: Record<SubscriptionType, SubscriptionCapability[]>;
+}>;
+export declare class GetSubscriptionsCapabilities extends AbstractPrivateEndpoint<GetSubscriptionsCapabilitiesDefinition> {
+    readonly name = "getSubscriptionsCapabilities";
+    readonly path = "subscriptions/capabilities";
+    readonly property = "capabilities";
+}
+export {};

package/lib/endpoints/private/subscription-capabilities/SubscriptionCapability.types.d.ts

@@ -0,0 +1,24 @@
+import { Price } from '../../../types';
+import { SubscriptionProductId, SubscriptionTier, SubscriptionTierName, SubscriptionType } from '../subscriptions/Subscriptions.types';
+
+export type DashboardSlug = 'shipments' | 'returns' | 'webshops' | 'shipments-weekly' | 'returns-weekly' | 'webshops-weekly' | 'transit-time' | 'surcharges' | 'cases' | 'shipments-t2' | 'returns-t2' | 'webshops-t2' | 'transit-time-t2' | 'surcharges-t2' | 'cases-t2' | 'finance-t2' | 'shortcoming-t2' | 'shipments-t3' | 'returns-t3' | 'webshops-t3' | 'transit-time-t3' | 'surcharges-t3' | 'cases-t3' | 'finance-t3' | 'shortcoming-t3';
+export interface SubscriptionConfiguration {
+    dashboard_slugs: string[];
+    free_shipments_per_month: number;
+    max_shipping_rules: number | null;
+    shipment_discount_price: Price;
+    shipment_discount_product: number;
+    shipment_fee_price: Price;
+    shipment_fee_product: number;
+}
+export interface SubscriptionCapability {
+    configuration: SubscriptionConfiguration;
+    features: string[];
+    price: Price;
+    tier: SubscriptionTier;
+    product_id: SubscriptionProductId;
+    product_name: string;
+    subscription_type_name: string;
+    tier_name: SubscriptionTierName;
+    type: SubscriptionType;
+}

package/lib/endpoints/private/subscription-capabilities/index.d.ts

@@ -0,0 +1,2 @@
+export * from './GetSubscriptionCapabilities';
+export * from './SubscriptionCapability.types';

package/lib/endpoints/private/subscriptions/DeleteSubscription.d.ts

@@ -0,0 +1,17 @@
+import { HttpMethod } from '../../../types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+
+type DeleteSubscriptionDefinition = CreateDefinition<{
+    name: typeof DeleteSubscription.name;
+    path: {
+        id: number;
+    };
+}>;
+export declare class DeleteSubscription extends AbstractPrivateEndpoint<DeleteSubscriptionDefinition> {
+    readonly method: HttpMethod;
+    readonly name = "deleteSubscription";
+    readonly path = "subscriptions/:id";
+    readonly property = "subscriptions";
+}
+export {};

package/lib/endpoints/private/subscriptions/GetSubscriptions.d.ts

@@ -0,0 +1,18 @@
+import { MyParcelSubscription, SubscriptionPostData } from './Subscriptions.types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+
+type GetSubscriptionsDefinition = CreateDefinition<{
+    name: typeof GetSubscriptions.name;
+    parameters: {
+        id: number;
+    };
+    body: SubscriptionPostData[];
+    response: MyParcelSubscription[];
+}>;
+export declare class GetSubscriptions extends AbstractPrivateEndpoint<GetSubscriptionsDefinition> {
+    readonly name = "getSubscriptions";
+    readonly path = "subscriptions";
+    readonly property = "subscriptions";
+}
+export {};

package/lib/endpoints/private/subscriptions/PatchSubscriptions.d.ts

@@ -0,0 +1,20 @@
+import { SubscriptionPatchData } from './Subscriptions.types';
+import { HttpMethod } from '../../../types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+
+type PatchSubscriptionsDefinition = CreateDefinition<{
+    name: typeof PatchSubscriptions.name;
+    body: SubscriptionPatchData[];
+    response: {
+        id: number;
+    }[];
+}>;
+export declare class PatchSubscriptions extends AbstractPrivateEndpoint<PatchSubscriptionsDefinition> {
+    readonly method: HttpMethod;
+    readonly name = "patchSubscriptions";
+    readonly path = "subscriptions";
+    readonly property = "subscriptions";
+    readonly responseProperty = "ids";
+}
+export {};

package/lib/endpoints/private/subscriptions/PostSubscriptions.d.ts

@@ -0,0 +1,20 @@
+import { SubscriptionPostData } from './Subscriptions.types';
+import { HttpMethod } from '../../../types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+
+type PostSubscriptionsDefinition = CreateDefinition<{
+    name: typeof PostSubscriptions.name;
+    body: SubscriptionPostData[];
+    response: {
+        id: number;
+    }[];
+}>;
+export declare class PostSubscriptions extends AbstractPrivateEndpoint<PostSubscriptionsDefinition> {
+    readonly method: HttpMethod;
+    readonly name = "postSubscriptions";
+    readonly path = "subscriptions";
+    readonly property = "subscriptions";
+    readonly responseProperty = "ids";
+}
+export {};

package/lib/endpoints/private/subscriptions/Subscriptions.types.d.ts

@@ -0,0 +1,30 @@
+export type SubscriptionProductId = 4610 | 4611 | 4612 | 4613 | 4614 | 4615 | 4616 | 4617 | 4618 | 4700 | 4701 | 4702 | 4703 | 4800 | 4801 | 4802 | 4803;
+export type SubscriptionTier = 0 | 1 | 2 | 3 | 4 | 5;
+export type SubscriptionTierName = 'light' | 'start' | 'plus' | 'premium' | 'max';
+export type SubscriptionType = 'my_contracts' | 'my_analytics' | 'my_orders' | 'bundle';
+export type SubscriptionStatus = 'active' | 'ended' | 'pending' | 'starting_soon' | 'ending_soon' | 'trial_active' | 'trial_ended';
+export type MyParcelSubscription = {
+    account_id: number;
+    billing_period_end: string;
+    billing_shop_id: number;
+    end: string | null;
+    id: number;
+    product_id: SubscriptionProductId;
+    start: string;
+    status: SubscriptionStatus;
+    tier: SubscriptionTier;
+    trial_end: string | null;
+    type: SubscriptionType;
+};
+export interface SubscriptionPostData {
+    account_id: number;
+    start: string;
+    billing_shop_id: number;
+    product_id: SubscriptionProductId;
+}
+export interface SubscriptionPatchData {
+    id: number;
+    billing_shop_id?: number;
+    trial_end?: string;
+    end?: string;
+}

package/lib/endpoints/private/subscriptions/index.d.ts

@@ -0,0 +1,5 @@
+export * from './DeleteSubscription';
+export * from './GetSubscriptions';
+export * from './PatchSubscriptions';
+export * from './PostSubscriptions';
+export * from './Subscriptions.types';

package/lib/endpoints/private/system-country-codes/GetSystemCountryCodes.d.ts

@@ -0,0 +1,15 @@
+import { SystemCountryCodesPerCountry, GetSystemCountryCodesParams } from './SystemCountryCodes.types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+
+type GetSystemCountryCodesDefinition = CreateDefinition<{
+    name: typeof GetSystemCountryCodes.name;
+    parameters: GetSystemCountryCodesParams;
+    response: SystemCountryCodesPerCountry;
+}>;
+export declare class GetSystemCountryCodes extends AbstractPrivateEndpoint<GetSystemCountryCodesDefinition> {
+    readonly name = "getSystemCountryCodes";
+    readonly path = "system_country_codes";
+    readonly property = "countries";
+}
+export {};

package/lib/endpoints/private/system-country-codes/SystemCountryCodes.types.d.ts

@@ -0,0 +1,11 @@
+import { CarrierId } from '@myparcel-dev/constants';
+
+export interface SystemCountryCode {
+    label: string;
+    region: string;
+}
+export type SystemCountryCodesPerCountry = Record<string, SystemCountryCode>[];
+export type GetSystemCountryCodesParams = {
+    carrier_id?: CarrierId;
+    unfiltered?: boolean;
+};

package/lib/endpoints/private/system-country-codes/index.d.ts

@@ -0,0 +1,2 @@
+export * from './GetSystemCountryCodes';
+export * from './SystemCountryCodes.types';

package/lib/endpoints/private/system-messages/GetSystemMessages.d.ts

@@ -0,0 +1,17 @@
+import { MyParcelSystemMessage } from './SystemMessage.types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+
+type GetSystemMessagesDefinition = CreateDefinition<{
+    name: typeof GetSystemMessages.name;
+    response: MyParcelSystemMessage[];
+}>;
+/**
+ * Retrieve system messages.
+ */
+export declare class GetSystemMessages extends AbstractPrivateEndpoint<GetSystemMessagesDefinition> {
+    readonly name = "getSystemMessages";
+    readonly path = "system_messages";
+    readonly property = "messages";
+}
+export {};

package/lib/endpoints/private/system-messages/SystemMessage.types.d.ts

@@ -0,0 +1,18 @@
+export interface MyParcelSystemMessage {
+    id: number;
+    content: string;
+    active: boolean;
+    additional_filter: string;
+    message_type: 1 | 2 | 3 | 4 | 5;
+    create: Date;
+    modified: Date;
+    start_date: Date;
+    end_date: Date;
+    notification_type: 'alert' | 'warning' | 'success' | 'info' | 'info';
+    content_nl: string;
+    content_en: string;
+    content_fr: string;
+    platform_ids: number[];
+    platform_id: number;
+    system_message_id: number;
+}

package/lib/endpoints/private/system-messages/index.d.ts

@@ -0,0 +1,2 @@
+export * from './GetSystemMessages';
+export * from './SystemMessage.types';

package/lib/endpoints/private/track-traces/GetTrackAndTraceByShipment.d.ts

@@ -0,0 +1,17 @@
+import { TrackAndTrace } from './TrackTraces.types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+
+type GetTrackAndTraceDefinition = CreateDefinition<{
+    name: typeof GetTrackAndTrace.name;
+    response: TrackAndTrace[];
+    path: {
+        shipment_id: string;
+    };
+}>;
+export declare class GetTrackAndTrace extends AbstractPrivateEndpoint<GetTrackAndTraceDefinition> {
+    readonly name = "getTrackAndTrace";
+    readonly path = "tracktraces/:shipment_id";
+    readonly property = "tracktraces";
+}
+export {};

package/lib/endpoints/private/track-traces/TrackTraces.types.d.ts

@@ -0,0 +1,51 @@
+import { CarrierId } from '@myparcel-dev/constants';
+import { ShipmentOptions } from '../shipments';
+import { Address, AddressWithContactDetails } from '../../../types';
+import { PickupLocation } from '../../public';
+
+export interface PartnerTrackTraceLink {
+    barcode: string;
+    uri: string;
+}
+export type ShipmentStatus = 'registered' | 'handed_to_carrier' | 'sorting' | 'distribution' | 'delivered';
+export interface TrackAndTraceStatus {
+    main: ShipmentStatus;
+    final: boolean;
+    current: number;
+}
+export interface TrackAndTraceLocation {
+    name: string;
+    countryCode: string;
+    city: string;
+    postalCode: string;
+    street: string;
+    number: string;
+    numberSuffix: string;
+    longitude: number;
+    latitude: number;
+}
+export interface TrackTraceHistory {
+    code: string;
+    description: string;
+    time: string;
+    delayed: boolean;
+    location: TrackAndTraceLocation;
+}
+export interface TrackAndTrace {
+    shipment_id: number;
+    carrier_id: CarrierId;
+    code: string;
+    description: string;
+    time: string;
+    link_consumer_portal: string;
+    link_tracktrace: string;
+    partner_tracktraces: PartnerTrackTraceLink[];
+    recipient: AddressWithContactDetails;
+    sender: Address;
+    options: ShipmentOptions;
+    pickup: PickupLocation | null;
+    delayed: boolean;
+    location: TrackAndTraceLocation | null;
+    status: TrackAndTraceStatus;
+    history: TrackTraceHistory[];
+}