@artaio/node-api 0.31.0 → 0.32.1

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.
Files changed (49) hide show
  1. package/README.md +8 -1
  2. package/dist/lib/ArtaClient.js +13 -6
  3. package/dist/lib/MetadataTypes.d.ts +1 -93
  4. package/dist/lib/MetadataTypes.js +15 -0
  5. package/dist/lib/arta.d.ts +1 -1
  6. package/dist/lib/arta.js +2 -2
  7. package/dist/lib/endpoint/attachment.d.ts +4 -10
  8. package/dist/lib/endpoint/emailRules.d.ts +6 -12
  9. package/dist/lib/endpoint/emailSubscriptions.d.ts +6 -12
  10. package/dist/lib/endpoint/endpoint.d.ts +5 -5
  11. package/dist/lib/endpoint/endpoint.js +3 -2
  12. package/dist/lib/endpoint/hostedSessions.d.ts +12 -29
  13. package/dist/lib/endpoint/invoicePayments.d.ts +4 -15
  14. package/dist/lib/endpoint/invoices.d.ts +4 -18
  15. package/dist/lib/endpoint/keys.d.ts +6 -16
  16. package/dist/lib/endpoint/logs.d.ts +4 -20
  17. package/dist/lib/endpoint/metadata.d.ts +3 -3
  18. package/dist/lib/endpoint/organization.d.ts +2 -14
  19. package/dist/lib/endpoint/payments.d.ts +4 -12
  20. package/dist/lib/endpoint/requests.d.ts +17 -41
  21. package/dist/lib/endpoint/requests.js +17 -5
  22. package/dist/lib/endpoint/shipments.d.ts +6 -73
  23. package/dist/lib/endpoint/shipments.js +19 -13
  24. package/dist/lib/endpoint/trackings.d.ts +3 -19
  25. package/dist/lib/endpoint/uploads.d.ts +7 -18
  26. package/dist/lib/endpoint/webhookDeliveries.d.ts +4 -18
  27. package/dist/lib/endpoint/webhooks.d.ts +10 -13
  28. package/dist/lib/index.d.ts +9 -16
  29. package/dist/lib/net/FetchHttpClient.d.ts +13 -0
  30. package/dist/lib/net/FetchHttpClient.js +128 -0
  31. package/dist/lib/net/HttpClient.d.ts +3 -6
  32. package/dist/lib/types.d.ts +750 -0
  33. package/dist/lib/types.js +2 -0
  34. package/dist/package.json +15 -10
  35. package/dist/schemas/generate.d.ts +1 -0
  36. package/dist/schemas/generate.js +51 -0
  37. package/dist/schemas/index.d.ts +3204 -0
  38. package/dist/schemas/index.js +733 -0
  39. package/dist/test-integration/index.d.ts +2 -0
  40. package/dist/test-integration/index.js +7 -0
  41. package/dist/test-integration/keys.test.d.ts +1 -0
  42. package/dist/test-integration/keys.test.js +71 -0
  43. package/dist/test-integration/requests.test.d.ts +1 -0
  44. package/dist/test-integration/requests.test.js +87 -0
  45. package/dist/test-integration/shipments.test.d.ts +1 -0
  46. package/dist/test-integration/shipments.test.js +114 -0
  47. package/package.json +15 -10
  48. package/dist/lib/net/NodeHttpClient.d.ts +0 -20
  49. package/dist/lib/net/NodeHttpClient.js +0 -203
@@ -0,0 +1,750 @@
1
+ export type Attachment = {
2
+ updated_at: Date;
3
+ created_at: Date;
4
+ id: number;
5
+ upload_id: number;
6
+ request_id?: (string | null) | undefined;
7
+ shipment_id?: (string | null) | undefined;
8
+ };
9
+ export type QuoteRequest = {
10
+ updated_at: Date;
11
+ created_at: Date;
12
+ id: string;
13
+ bookable: {
14
+ missing: string[];
15
+ ready: boolean;
16
+ };
17
+ destination: {
18
+ access_restrictions?: (("elevator_only" | "freight_elevator" | "loading_dock" | "loading_dock_low" | "low_clearance" | "non_paved" | "stairs_only" | "steep_gradient")[] | null) | undefined;
19
+ address_line_1?: (string | null) | undefined;
20
+ address_line_2?: (string | null) | undefined;
21
+ address_line_3?: (string | null) | undefined;
22
+ city?: (string | null) | undefined;
23
+ region?: (string | null) | undefined;
24
+ postal_code?: (string | null) | undefined;
25
+ country: string;
26
+ title?: (string | null) | undefined;
27
+ contacts?: ({
28
+ name: string;
29
+ email_address?: (string | null) | undefined;
30
+ phone_number?: (string | null) | undefined;
31
+ }[] | null) | undefined;
32
+ estimated_country?: string | undefined;
33
+ estimated_region?: string | undefined;
34
+ estimated_city?: string | undefined;
35
+ };
36
+ hosted_session_id: number | null;
37
+ insurance: ("arta_transit_insurance" | "no_arta_insurance") | null;
38
+ internal_reference: string | null;
39
+ log_request_id: string;
40
+ object_count: number | null;
41
+ origin: {
42
+ access_restrictions?: (("elevator_only" | "freight_elevator" | "loading_dock" | "loading_dock_low" | "low_clearance" | "non_paved" | "stairs_only" | "steep_gradient")[] | null) | undefined;
43
+ address_line_1?: (string | null) | undefined;
44
+ address_line_2?: (string | null) | undefined;
45
+ address_line_3?: (string | null) | undefined;
46
+ city?: (string | null) | undefined;
47
+ region?: (string | null) | undefined;
48
+ postal_code?: (string | null) | undefined;
49
+ country: string;
50
+ title?: (string | null) | undefined;
51
+ contacts?: ({
52
+ name: string;
53
+ email_address?: (string | null) | undefined;
54
+ phone_number?: (string | null) | undefined;
55
+ }[] | null) | undefined;
56
+ estimated_country?: string | undefined;
57
+ estimated_region?: string | undefined;
58
+ estimated_city?: string | undefined;
59
+ };
60
+ public_reference?: (string | null) | undefined;
61
+ quote_types: ("parcel" | "premium" | "select" | "self_ship")[];
62
+ shortcode: string;
63
+ status: "cancelled" | "closed" | "disqualified" | "expired" | "in_progress" | "pending" | "quoted";
64
+ tags?: any;
65
+ currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
66
+ additional_services: ("assembly" | "debris_disposal" | "deinstallation" | "destination_additional_labor" | "destination_building_coi" | "destination_condition_check" | "destination_full_condition_report" | "destination_unpacking" | "double_blind_bols" | "installation" | "origin_building_coi" | "origin_condition_check" | "origin_full_condition_report" | "placement" | "signature_delivery" | "tarmac_supervision")[];
67
+ disqualifications: {
68
+ quote_types: ("parcel" | "premium" | "select" | "self_ship")[];
69
+ reason?: (string | null) | undefined;
70
+ reason_code: "cannot_be_packed" | "client_timeout_reached" | "external_service_unavailable" | "object_not_supported" | "out_of_network" | "over_size" | "over_value" | "over_volume" | "over_weight" | "requested_service_unavailable" | "too_many_items" | "under_value" | "under_volume" | "under_weight";
71
+ }[];
72
+ objects: {
73
+ internal_reference?: (string | null) | undefined;
74
+ current_packing?: (("alcohol_case" | "lay_flat_wine_box" | "blanket" | "wardrobe_box" | "cardboard_box" | "chandelier_box" | "chair_box" | "cbin_closed" | "cbin_open" | "ply_box" | "fine_art_econo_crate" | "fine_art_international_crate" | "econo_crate" | "international_econo_crate" | "furniture_crate" | "international_furniture_crate" | "parcel_crate" | "museum_crate" | "international_museum_crate" | "foam_lined_box" | "cavity_box" | "strongbox" | "double_box" | "travel_frame" | "travel_frame_art" | "travel_frame_other" | "a_frame" | "slat_crate" | "tri_wall_crate" | "lockbox" | "no_packing" | "pallet" | "international_pallet" | "portfolio" | "rug_rolled" | "shadow_box" | "slipcase" | "slipcase_glass_tape" | "poly_cardboard" | "bubble_cardboard" | "garment_bag" | "poly_only" | "dartek_only" | "bubble_only" | "cling_wrap" | "cbin_communal" | "sonotube" | "stabilizing_box" | "shipping_tube_small" | "shipping_tube_large")[] | null) | undefined;
75
+ details?: ({
76
+ materials?: (("stone_marble" | "precious_stones" | "fiber_synthetic" | "fabric_natural" | "taxidermy" | "carbon_fiber" | "live_animal" | "paper" | "glass" | "presious_metals" | "particleboard" | "styrofoam" | "wood" | "photo_film" | "sand" | "metal" | "plexiglass" | "aquatic_life" | "canvas" | "drywall" | "hard_plastic" | "vinyl" | "soft_plastic" | "leather" | "rubber" | "concreate" | "paint" | "electronics" | "fiber_natural" | "gas" | "fabric_synthetic" | "CITES" | "liquids" | "salts")[] | null) | undefined;
77
+ creation_date?: (string | null) | undefined;
78
+ creator?: (string | null) | undefined;
79
+ notes?: (string | null) | undefined;
80
+ title?: (string | null) | undefined;
81
+ is_fragile?: (boolean | null) | undefined;
82
+ is_cites?: (boolean | null) | undefined;
83
+ } | null) | undefined;
84
+ height: number | string;
85
+ width: number | string;
86
+ weight?: ((number | string) | null) | undefined;
87
+ value: number | string;
88
+ depth?: ((number | string) | null) | undefined;
89
+ images?: (string[] | null) | undefined;
90
+ public_reference?: (string | null) | undefined;
91
+ subtype: "painting_unframed" | "painting_framed" | "painting_framed_plexi" | "painting_framed_glass" | "work_on_paper_unframed" | "work_on_paper_framed" | "work_on_paper_framed_plexi" | "work_on_paper_framed_glass" | "mixed_media_unframed" | "mixed_media_framed" | "mixed_media_framed_plexi" | "mixed_media_framed_glass" | "photograph_unframed" | "photograph_framed" | "photograph_framed_plexi" | "photograph_framed_glass" | "new_media" | "sculpture" | "pedestal" | "pedestal_case_glass" | "pedestal_case_plexi" | "ceramic" | "neon" | "tapestry" | "other_art" | "table" | "chair" | "sofa_loveseat_chaise" | "floor_lamp" | "floor_lamp_shade" | "table_lamp" | "table_lamp_shade" | "sconce" | "ottoman" | "bookcase_storage" | "nightstand" | "armoire_dresser" | "carpet_rug" | "mirror" | "chandelier" | "bedframe" | "headboard" | "desk_vanity" | "media_console" | "other_furniture" | "earrings" | "necklace" | "bracelet" | "ring" | "brooch" | "watch" | "cufflinks" | "eyeglasses" | "set" | "precious_stones" | "snuff_box_cigarette_case" | "other_jewelry" | "vase_vessel" | "bowl" | "plaque" | "object_of_vertu" | "candelabra_candlestick" | "dinnerware" | "flatware" | "glassware" | "serveware" | "porcelain_plate" | "porcelain_bowl" | "tabletop_accessory" | "clock" | "other_decorative_arts" | "stamp" | "book" | "coin" | "document_manuscript" | "toy" | "miniature_model" | "figurine_doll" | "neon_sign" | "memorabilia" | "camera_electrical" | "other_collectibles" | "wine_bottle" | "spirits_bottle" | "beer_bottle" | "wine_case" | "spirits_case" | "beer_case" | "wine_barrel" | "spirits_barrel" | "beer_barrel" | "other_alcohols" | "car" | "motorcycle" | "bus" | "van" | "limousine" | "carriage" | "trailer" | "sidecar" | "other_automotive" | "clothing" | "footwear" | "handbag" | "accessories" | "other_fashion" | "musical_instrument" | "firearm_weapon" | "hunting_fishing" | "medical_equipment" | "other";
92
+ unit_of_measurement?: (string | null) | undefined;
93
+ weight_unit?: (string | null) | undefined;
94
+ value_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
95
+ }[];
96
+ payment_process: "checkout" | "checkout_direct" | "invoicing";
97
+ preferred_quote_types?: (("parcel" | "premium" | "select" | "self_ship")[] | null) | undefined;
98
+ shipping_notes?: (string | null) | undefined;
99
+ quotes: {
100
+ id: number;
101
+ included_services: {
102
+ amount: number;
103
+ amount_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
104
+ is_requested?: boolean | undefined;
105
+ is_required?: boolean | undefined;
106
+ name: string;
107
+ sub_subtype: string;
108
+ subtype: "specialized" | "consolidated" | "freight" | "parcel" | "collection" | "delivery" | "location" | "unpacking" | "condition" | "installation" | "deinstallation" | "debris_disposal" | "site_visit" | "handling" | "packing" | "packing_materials" | "receive_release" | "warehouse" | "customs" | "coi" | "administration" | "taxes_duties" | "fees" | "security" | "equipment";
109
+ type: "transport" | "location" | "handling" | "packing" | "storage" | "administration" | "taxes_duties_fees" | "security" | "equipment";
110
+ included_services: any[];
111
+ }[];
112
+ included_insurance_policy?: ({
113
+ amount: number;
114
+ amount_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
115
+ id: string;
116
+ insured_value: number;
117
+ insured_value_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
118
+ } | null) | undefined;
119
+ optional_services: {
120
+ amount: number;
121
+ amount_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
122
+ is_requested?: boolean | undefined;
123
+ is_required?: boolean | undefined;
124
+ name: string;
125
+ sub_subtype: string;
126
+ subtype: "specialized" | "consolidated" | "freight" | "parcel" | "collection" | "delivery" | "location" | "unpacking" | "condition" | "installation" | "deinstallation" | "debris_disposal" | "site_visit" | "handling" | "packing" | "packing_materials" | "receive_release" | "warehouse" | "customs" | "coi" | "administration" | "taxes_duties" | "fees" | "security" | "equipment";
127
+ type: "transport" | "location" | "handling" | "packing" | "storage" | "administration" | "taxes_duties_fees" | "security" | "equipment";
128
+ included_services: any[];
129
+ }[];
130
+ quote_type: "parcel" | "premium" | "select" | "self_ship";
131
+ status: string;
132
+ total: number;
133
+ total_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
134
+ }[];
135
+ };
136
+ export type Key = {
137
+ updated_at: Date;
138
+ created_at: Date;
139
+ id: number;
140
+ name: string | null;
141
+ is_testing: boolean;
142
+ token: string;
143
+ };
144
+ export type Shipment = {
145
+ updated_at: Date;
146
+ created_at: Date;
147
+ id: string;
148
+ destination: {
149
+ access_restrictions?: (("elevator_only" | "freight_elevator" | "loading_dock" | "loading_dock_low" | "low_clearance" | "non_paved" | "stairs_only" | "steep_gradient")[] | null) | undefined;
150
+ address_line_1?: (string | null) | undefined;
151
+ address_line_2?: (string | null) | undefined;
152
+ address_line_3?: (string | null) | undefined;
153
+ city?: (string | null) | undefined;
154
+ region?: (string | null) | undefined;
155
+ postal_code?: (string | null) | undefined;
156
+ country: string;
157
+ title?: (string | null) | undefined;
158
+ contacts?: ({
159
+ name: string;
160
+ email_address?: (string | null) | undefined;
161
+ phone_number?: (string | null) | undefined;
162
+ }[] | null) | undefined;
163
+ estimated_country?: string | undefined;
164
+ estimated_region?: string | undefined;
165
+ estimated_city?: string | undefined;
166
+ };
167
+ eei_form_status?: (("pending" | "cleared" | "approved" | "rejected" | "submitted") | null) | undefined;
168
+ emissions?: (number | null) | undefined;
169
+ emissions_unit?: (string | null) | undefined;
170
+ exceptions?: ({
171
+ updated_at: Date;
172
+ created_at: Date;
173
+ exception_type_label?: (string | null) | undefined;
174
+ id: string;
175
+ package_id?: (number | null) | undefined;
176
+ resolution?: (string | null) | undefined;
177
+ status: "in_progress" | "new" | "resolved";
178
+ type: "change_of_address_request" | "customs_information_required" | "damaged_items" | "direct_payment_required" | "held_at_customs" | "inaccurate_object_details" | "incorrect_address" | "lost_in_transit" | "not_ready_for_delivery" | "not_ready_for_release" | "other" | "prepayment_required" | "requested_hold_to_collect" | "requested_hold_to_deliver" | "wrong_item";
179
+ }[] | null) | undefined;
180
+ hosted_session_id?: (number | null) | undefined;
181
+ insurance_policy?: ({
182
+ amount: number;
183
+ amount_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
184
+ id: string;
185
+ insured_value: number;
186
+ insured_value_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
187
+ } | null) | undefined;
188
+ internal_reference?: (string | null) | undefined;
189
+ log_request_id?: (string | null) | undefined;
190
+ object_count: number;
191
+ origin: {
192
+ access_restrictions?: (("elevator_only" | "freight_elevator" | "loading_dock" | "loading_dock_low" | "low_clearance" | "non_paved" | "stairs_only" | "steep_gradient")[] | null) | undefined;
193
+ address_line_1?: (string | null) | undefined;
194
+ address_line_2?: (string | null) | undefined;
195
+ address_line_3?: (string | null) | undefined;
196
+ city?: (string | null) | undefined;
197
+ region?: (string | null) | undefined;
198
+ postal_code?: (string | null) | undefined;
199
+ country: string;
200
+ title?: (string | null) | undefined;
201
+ contacts?: ({
202
+ name: string;
203
+ email_address?: (string | null) | undefined;
204
+ phone_number?: (string | null) | undefined;
205
+ }[] | null) | undefined;
206
+ estimated_country?: string | undefined;
207
+ estimated_region?: string | undefined;
208
+ estimated_city?: string | undefined;
209
+ };
210
+ package_count: number;
211
+ packages?: ({
212
+ depth: number;
213
+ eta?: (string | null) | undefined;
214
+ handle_with_care: boolean;
215
+ height: number;
216
+ id: number;
217
+ is_sufficiently_packed: boolean;
218
+ objects: {
219
+ internal_reference?: (string | null) | undefined;
220
+ current_packing?: (("alcohol_case" | "lay_flat_wine_box" | "blanket" | "wardrobe_box" | "cardboard_box" | "chandelier_box" | "chair_box" | "cbin_closed" | "cbin_open" | "ply_box" | "fine_art_econo_crate" | "fine_art_international_crate" | "econo_crate" | "international_econo_crate" | "furniture_crate" | "international_furniture_crate" | "parcel_crate" | "museum_crate" | "international_museum_crate" | "foam_lined_box" | "cavity_box" | "strongbox" | "double_box" | "travel_frame" | "travel_frame_art" | "travel_frame_other" | "a_frame" | "slat_crate" | "tri_wall_crate" | "lockbox" | "no_packing" | "pallet" | "international_pallet" | "portfolio" | "rug_rolled" | "shadow_box" | "slipcase" | "slipcase_glass_tape" | "poly_cardboard" | "bubble_cardboard" | "garment_bag" | "poly_only" | "dartek_only" | "bubble_only" | "cling_wrap" | "cbin_communal" | "sonotube" | "stabilizing_box" | "shipping_tube_small" | "shipping_tube_large")[] | null) | undefined;
221
+ details?: ({
222
+ materials?: (("stone_marble" | "precious_stones" | "fiber_synthetic" | "fabric_natural" | "taxidermy" | "carbon_fiber" | "live_animal" | "paper" | "glass" | "presious_metals" | "particleboard" | "styrofoam" | "wood" | "photo_film" | "sand" | "metal" | "plexiglass" | "aquatic_life" | "canvas" | "drywall" | "hard_plastic" | "vinyl" | "soft_plastic" | "leather" | "rubber" | "concreate" | "paint" | "electronics" | "fiber_natural" | "gas" | "fabric_synthetic" | "CITES" | "liquids" | "salts")[] | null) | undefined;
223
+ creation_date?: (string | null) | undefined;
224
+ creator?: (string | null) | undefined;
225
+ notes?: (string | null) | undefined;
226
+ title?: (string | null) | undefined;
227
+ is_fragile?: (boolean | null) | undefined;
228
+ is_cites?: (boolean | null) | undefined;
229
+ } | null) | undefined;
230
+ height: number | string;
231
+ width: number | string;
232
+ weight?: ((number | string) | null) | undefined;
233
+ value: number | string;
234
+ depth?: ((number | string) | null) | undefined;
235
+ images?: (string[] | null) | undefined;
236
+ public_reference?: (string | null) | undefined;
237
+ subtype: "painting_unframed" | "painting_framed" | "painting_framed_plexi" | "painting_framed_glass" | "work_on_paper_unframed" | "work_on_paper_framed" | "work_on_paper_framed_plexi" | "work_on_paper_framed_glass" | "mixed_media_unframed" | "mixed_media_framed" | "mixed_media_framed_plexi" | "mixed_media_framed_glass" | "photograph_unframed" | "photograph_framed" | "photograph_framed_plexi" | "photograph_framed_glass" | "new_media" | "sculpture" | "pedestal" | "pedestal_case_glass" | "pedestal_case_plexi" | "ceramic" | "neon" | "tapestry" | "other_art" | "table" | "chair" | "sofa_loveseat_chaise" | "floor_lamp" | "floor_lamp_shade" | "table_lamp" | "table_lamp_shade" | "sconce" | "ottoman" | "bookcase_storage" | "nightstand" | "armoire_dresser" | "carpet_rug" | "mirror" | "chandelier" | "bedframe" | "headboard" | "desk_vanity" | "media_console" | "other_furniture" | "earrings" | "necklace" | "bracelet" | "ring" | "brooch" | "watch" | "cufflinks" | "eyeglasses" | "set" | "precious_stones" | "snuff_box_cigarette_case" | "other_jewelry" | "vase_vessel" | "bowl" | "plaque" | "object_of_vertu" | "candelabra_candlestick" | "dinnerware" | "flatware" | "glassware" | "serveware" | "porcelain_plate" | "porcelain_bowl" | "tabletop_accessory" | "clock" | "other_decorative_arts" | "stamp" | "book" | "coin" | "document_manuscript" | "toy" | "miniature_model" | "figurine_doll" | "neon_sign" | "memorabilia" | "camera_electrical" | "other_collectibles" | "wine_bottle" | "spirits_bottle" | "beer_bottle" | "wine_case" | "spirits_case" | "beer_case" | "wine_barrel" | "spirits_barrel" | "beer_barrel" | "other_alcohols" | "car" | "motorcycle" | "bus" | "van" | "limousine" | "carriage" | "trailer" | "sidecar" | "other_automotive" | "clothing" | "footwear" | "handbag" | "accessories" | "other_fashion" | "musical_instrument" | "firearm_weapon" | "hunting_fishing" | "medical_equipment" | "other";
238
+ unit_of_measurement?: (string | null) | undefined;
239
+ weight_unit?: (string | null) | undefined;
240
+ value_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
241
+ }[];
242
+ packing_materials: ("alcohol_case" | "lay_flat_wine_box" | "blanket" | "wardrobe_box" | "cardboard_box" | "chandelier_box" | "chair_box" | "cbin_closed" | "cbin_open" | "ply_box" | "fine_art_econo_crate" | "fine_art_international_crate" | "econo_crate" | "international_econo_crate" | "furniture_crate" | "international_furniture_crate" | "parcel_crate" | "museum_crate" | "international_museum_crate" | "foam_lined_box" | "cavity_box" | "strongbox" | "double_box" | "travel_frame" | "travel_frame_art" | "travel_frame_other" | "a_frame" | "slat_crate" | "tri_wall_crate" | "lockbox" | "no_packing" | "pallet" | "international_pallet" | "portfolio" | "rug_rolled" | "shadow_box" | "slipcase" | "slipcase_glass_tape" | "poly_cardboard" | "bubble_cardboard" | "garment_bag" | "poly_only" | "dartek_only" | "bubble_only" | "cling_wrap" | "cbin_communal" | "sonotube" | "stabilizing_box" | "shipping_tube_small" | "shipping_tube_large")[];
243
+ status?: (("pending" | "transit" | "out_for_delivery" | "delivered" | "unknown" | "notfound" | "undelivered" | "exception" | "expired") | null) | undefined;
244
+ unit_of_measurement?: (string | null) | undefined;
245
+ weight: number;
246
+ weight_unit: string;
247
+ width: number;
248
+ }[] | null) | undefined;
249
+ payment_process?: (("checkout" | "checkout_direct" | "invoicing") | null) | undefined;
250
+ public_reference?: (string | null) | undefined;
251
+ quote_type: "parcel" | "premium" | "select" | "self_ship";
252
+ schedule?: ({
253
+ delivery_end?: (Date | null) | undefined;
254
+ delivery_start?: (Date | null) | undefined;
255
+ delivery_window_modifier: string;
256
+ pickup_end?: (Date | null) | undefined;
257
+ pickup_start?: (Date | null) | undefined;
258
+ pickup_window_modifier: string;
259
+ } | null) | undefined;
260
+ services?: ({
261
+ amount: number;
262
+ amount_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
263
+ is_requested?: boolean | undefined;
264
+ is_required?: boolean | undefined;
265
+ name: string;
266
+ sub_subtype: string;
267
+ subtype: "specialized" | "consolidated" | "freight" | "parcel" | "collection" | "delivery" | "location" | "unpacking" | "condition" | "installation" | "deinstallation" | "debris_disposal" | "site_visit" | "handling" | "packing" | "packing_materials" | "receive_release" | "warehouse" | "customs" | "coi" | "administration" | "taxes_duties" | "fees" | "security" | "equipment";
268
+ type: "transport" | "location" | "handling" | "packing" | "storage" | "administration" | "taxes_duties_fees" | "security" | "equipment";
269
+ included_services: any[];
270
+ }[] | null) | undefined;
271
+ shipping_notes?: (string | null) | undefined;
272
+ shortcode: string;
273
+ status: "pending" | "confirmed" | "collected" | "in_transit" | "completed";
274
+ total: number;
275
+ total_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
276
+ url?: (string | null) | undefined;
277
+ tracking?: ({
278
+ carrier_name: string;
279
+ label_url?: (string | null) | undefined;
280
+ package_id: number;
281
+ tracking_number: string;
282
+ url: string;
283
+ }[] | null) | undefined;
284
+ };
285
+ export type EmailRule = {
286
+ updated_at: Date;
287
+ created_at: Date;
288
+ id: number;
289
+ email_notification_id: "booking" | "cancelled" | "collected" | "collection" | "complete" | "custom_quoted_dashboard" | "in_transit" | "invoice" | "self_ship_label" | "payment" | "scheduling" | "eei";
290
+ recipients: ("payer" | "origin" | "destination")[];
291
+ };
292
+ export type EmailSubscription = {
293
+ updated_at: Date;
294
+ created_at: Date;
295
+ id: number;
296
+ email_notification_ids: ("booking" | "cancelled" | "collected" | "collection" | "complete" | "custom_quoted_dashboard" | "in_transit" | "invoice" | "self_ship_label" | "payment" | "scheduling" | "eei")[];
297
+ email_address: string;
298
+ name?: (string | null) | undefined;
299
+ };
300
+ export type HostedSession = {
301
+ updated_at: Date;
302
+ created_at: Date;
303
+ id: number;
304
+ additional_services?: (("assembly" | "debris_disposal" | "deinstallation" | "destination_additional_labor" | "destination_building_coi" | "destination_condition_check" | "destination_full_condition_report" | "destination_unpacking" | "double_blind_bols" | "installation" | "origin_building_coi" | "origin_condition_check" | "origin_full_condition_report" | "placement" | "signature_delivery" | "tarmac_supervision")[] | null) | undefined;
305
+ cancel_url?: (string | null) | undefined;
306
+ destination?: ({
307
+ access_restrictions?: (("elevator_only" | "freight_elevator" | "loading_dock" | "loading_dock_low" | "low_clearance" | "non_paved" | "stairs_only" | "steep_gradient")[] | null) | undefined;
308
+ address_line_1?: (string | null) | undefined;
309
+ address_line_2?: (string | null) | undefined;
310
+ address_line_3?: (string | null) | undefined;
311
+ city?: (string | null) | undefined;
312
+ region?: (string | null) | undefined;
313
+ postal_code?: (string | null) | undefined;
314
+ country: string;
315
+ title?: (string | null) | undefined;
316
+ contacts?: ({
317
+ name: string;
318
+ email_address?: (string | null) | undefined;
319
+ phone_number?: (string | null) | undefined;
320
+ }[] | null) | undefined;
321
+ estimated_country?: string | undefined;
322
+ estimated_region?: string | undefined;
323
+ estimated_city?: string | undefined;
324
+ } | null) | undefined;
325
+ insurance?: (("arta_transit_insurance" | "no_arta_insurance") | null) | undefined;
326
+ internal_reference?: (string | null) | undefined;
327
+ objects: {
328
+ internal_reference?: (string | null) | undefined;
329
+ current_packing?: (("alcohol_case" | "lay_flat_wine_box" | "blanket" | "wardrobe_box" | "cardboard_box" | "chandelier_box" | "chair_box" | "cbin_closed" | "cbin_open" | "ply_box" | "fine_art_econo_crate" | "fine_art_international_crate" | "econo_crate" | "international_econo_crate" | "furniture_crate" | "international_furniture_crate" | "parcel_crate" | "museum_crate" | "international_museum_crate" | "foam_lined_box" | "cavity_box" | "strongbox" | "double_box" | "travel_frame" | "travel_frame_art" | "travel_frame_other" | "a_frame" | "slat_crate" | "tri_wall_crate" | "lockbox" | "no_packing" | "pallet" | "international_pallet" | "portfolio" | "rug_rolled" | "shadow_box" | "slipcase" | "slipcase_glass_tape" | "poly_cardboard" | "bubble_cardboard" | "garment_bag" | "poly_only" | "dartek_only" | "bubble_only" | "cling_wrap" | "cbin_communal" | "sonotube" | "stabilizing_box" | "shipping_tube_small" | "shipping_tube_large")[] | null) | undefined;
330
+ details?: ({
331
+ materials?: (("stone_marble" | "precious_stones" | "fiber_synthetic" | "fabric_natural" | "taxidermy" | "carbon_fiber" | "live_animal" | "paper" | "glass" | "presious_metals" | "particleboard" | "styrofoam" | "wood" | "photo_film" | "sand" | "metal" | "plexiglass" | "aquatic_life" | "canvas" | "drywall" | "hard_plastic" | "vinyl" | "soft_plastic" | "leather" | "rubber" | "concreate" | "paint" | "electronics" | "fiber_natural" | "gas" | "fabric_synthetic" | "CITES" | "liquids" | "salts")[] | null) | undefined;
332
+ creation_date?: (string | null) | undefined;
333
+ creator?: (string | null) | undefined;
334
+ notes?: (string | null) | undefined;
335
+ title?: (string | null) | undefined;
336
+ is_fragile?: (boolean | null) | undefined;
337
+ is_cites?: (boolean | null) | undefined;
338
+ } | null) | undefined;
339
+ height: number | string;
340
+ width: number | string;
341
+ weight?: ((number | string) | null) | undefined;
342
+ value: number | string;
343
+ depth?: ((number | string) | null) | undefined;
344
+ images?: (string[] | null) | undefined;
345
+ public_reference?: (string | null) | undefined;
346
+ subtype: "painting_unframed" | "painting_framed" | "painting_framed_plexi" | "painting_framed_glass" | "work_on_paper_unframed" | "work_on_paper_framed" | "work_on_paper_framed_plexi" | "work_on_paper_framed_glass" | "mixed_media_unframed" | "mixed_media_framed" | "mixed_media_framed_plexi" | "mixed_media_framed_glass" | "photograph_unframed" | "photograph_framed" | "photograph_framed_plexi" | "photograph_framed_glass" | "new_media" | "sculpture" | "pedestal" | "pedestal_case_glass" | "pedestal_case_plexi" | "ceramic" | "neon" | "tapestry" | "other_art" | "table" | "chair" | "sofa_loveseat_chaise" | "floor_lamp" | "floor_lamp_shade" | "table_lamp" | "table_lamp_shade" | "sconce" | "ottoman" | "bookcase_storage" | "nightstand" | "armoire_dresser" | "carpet_rug" | "mirror" | "chandelier" | "bedframe" | "headboard" | "desk_vanity" | "media_console" | "other_furniture" | "earrings" | "necklace" | "bracelet" | "ring" | "brooch" | "watch" | "cufflinks" | "eyeglasses" | "set" | "precious_stones" | "snuff_box_cigarette_case" | "other_jewelry" | "vase_vessel" | "bowl" | "plaque" | "object_of_vertu" | "candelabra_candlestick" | "dinnerware" | "flatware" | "glassware" | "serveware" | "porcelain_plate" | "porcelain_bowl" | "tabletop_accessory" | "clock" | "other_decorative_arts" | "stamp" | "book" | "coin" | "document_manuscript" | "toy" | "miniature_model" | "figurine_doll" | "neon_sign" | "memorabilia" | "camera_electrical" | "other_collectibles" | "wine_bottle" | "spirits_bottle" | "beer_bottle" | "wine_case" | "spirits_case" | "beer_case" | "wine_barrel" | "spirits_barrel" | "beer_barrel" | "other_alcohols" | "car" | "motorcycle" | "bus" | "van" | "limousine" | "carriage" | "trailer" | "sidecar" | "other_automotive" | "clothing" | "footwear" | "handbag" | "accessories" | "other_fashion" | "musical_instrument" | "firearm_weapon" | "hunting_fishing" | "medical_equipment" | "other";
347
+ unit_of_measurement?: (string | null) | undefined;
348
+ weight_unit?: (string | null) | undefined;
349
+ value_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
350
+ }[];
351
+ origin: {
352
+ access_restrictions?: (("elevator_only" | "freight_elevator" | "loading_dock" | "loading_dock_low" | "low_clearance" | "non_paved" | "stairs_only" | "steep_gradient")[] | null) | undefined;
353
+ address_line_1?: (string | null) | undefined;
354
+ address_line_2?: (string | null) | undefined;
355
+ address_line_3?: (string | null) | undefined;
356
+ city?: (string | null) | undefined;
357
+ region?: (string | null) | undefined;
358
+ postal_code?: (string | null) | undefined;
359
+ country: string;
360
+ title?: (string | null) | undefined;
361
+ contacts?: ({
362
+ name: string;
363
+ email_address?: (string | null) | undefined;
364
+ phone_number?: (string | null) | undefined;
365
+ }[] | null) | undefined;
366
+ estimated_country?: string | undefined;
367
+ estimated_region?: string | undefined;
368
+ estimated_city?: string | undefined;
369
+ };
370
+ preferred_quote_types?: (("parcel" | "premium" | "select" | "self_ship")[] | null) | undefined;
371
+ public_reference?: (string | null) | undefined;
372
+ shipping_notes?: (string | null) | undefined;
373
+ success_url?: (string | null) | undefined;
374
+ payment_process: "checkout" | "checkout_direct" | "invoicing";
375
+ private_token: string;
376
+ shortcode: string;
377
+ status: "cancelled" | "closed" | "disqualified" | "expired" | "in_progress" | "pending" | "quoted";
378
+ url?: (string | null) | undefined;
379
+ };
380
+ export type InvoicePayment = {
381
+ updated_at: Date;
382
+ created_at: Date;
383
+ id: number;
384
+ amount: number;
385
+ amount_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
386
+ credit_id?: (string | null) | undefined;
387
+ invoice_id?: (string | null) | undefined;
388
+ paid_on: Date;
389
+ payment_id?: (string | null) | undefined;
390
+ shipment_id?: (string | null) | undefined;
391
+ };
392
+ export type Invoice = {
393
+ updated_at: Date;
394
+ created_at: Date;
395
+ id: number;
396
+ amount_owed: number;
397
+ amount_owed_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
398
+ amount_paid: number;
399
+ amount_paid_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
400
+ issued_on?: (Date | null) | undefined;
401
+ shipment_id?: (string | null) | undefined;
402
+ status: string;
403
+ invoice_url?: (string | null) | undefined;
404
+ };
405
+ export type Log = {
406
+ updated_at: Date;
407
+ created_at: Date;
408
+ id: number;
409
+ api_key_id: number;
410
+ arta_version: string;
411
+ end_at: Date;
412
+ method: string;
413
+ path: string;
414
+ query_params: string;
415
+ request_body?: (string | null) | undefined;
416
+ request_id: string;
417
+ response_body?: (string | null) | undefined;
418
+ start_at: Date;
419
+ status: number;
420
+ };
421
+ export type Organization = {
422
+ updated_at: Date;
423
+ created_at: Date;
424
+ api_version: string;
425
+ id: number;
426
+ name: string;
427
+ billing_terms?: (string | null) | undefined;
428
+ company_name?: (string | null) | undefined;
429
+ display_name?: (string | null) | undefined;
430
+ shortcode?: (string | null) | undefined;
431
+ status?: (string | null) | undefined;
432
+ stripe_customer_id?: (string | null) | undefined;
433
+ };
434
+ export type Payment = {
435
+ updated_at: Date;
436
+ created_at: Date;
437
+ id: number;
438
+ amount: number;
439
+ amount_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
440
+ context: "hosted_checkout" | "invoiced";
441
+ paid_on: Date;
442
+ };
443
+ export type Carrier = {
444
+ code: string;
445
+ name: string;
446
+ phone_number: string;
447
+ url: string;
448
+ };
449
+ export type TrackingEvent = {
450
+ date: Date;
451
+ location: string;
452
+ summary: string;
453
+ };
454
+ export type Tracking = {
455
+ carrier: {
456
+ code: string;
457
+ name: string;
458
+ phone_number: string;
459
+ url: string;
460
+ };
461
+ events: {
462
+ date: Date;
463
+ location: string;
464
+ summary: string;
465
+ }[];
466
+ status: string;
467
+ tracking_number: string;
468
+ };
469
+ export type Upload = {
470
+ updated_at: Date;
471
+ created_at: Date;
472
+ id: number;
473
+ document_type: "bill_of_lading" | "certificate_of_insurance" | "certificate_of_insurance_template" | "condition_report" | "condition_check" | "image" | "instructions" | "airway_bill" | "commercial_invoice" | "power_of_attorney" | "proof_of_export" | "proof_of_delivery" | "quote" | "shipping_label" | "other";
474
+ document_type_label?: (string | null) | undefined;
475
+ download_url?: (string | null) | undefined;
476
+ file_name: string;
477
+ mime_type: "application/pdf" | "application/vnd.ms-excel" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "application/vnd.openxmlformats-officedocument.wordprocessingml.document" | "image/jpeg" | "image/png" | "text/csv" | "video/mp4" | "video/quicktime" | "application/msword";
478
+ size: number;
479
+ status: string;
480
+ presigned_url: string;
481
+ };
482
+ export type WebhookDelivery = {
483
+ updated_at: Date;
484
+ created_at: Date;
485
+ id: string;
486
+ resource_id: number;
487
+ resource_type: "ping" | "request" | "shipment";
488
+ response_status_code: number;
489
+ status: "delivered" | "failed";
490
+ type: "request.created" | "request.status.updated" | "shipment.created" | "shipment.eei_form_status.updated" | "shipment.schedule.updated" | "shipment.status.updated" | "shipment.tracking.updated" | "ping";
491
+ webhook_id: number;
492
+ webhook_url: string;
493
+ next_retry?: (string | null) | undefined;
494
+ request_body?: (string | null) | undefined;
495
+ response_body?: (string | null) | undefined;
496
+ };
497
+ export type Webhook = {
498
+ updated_at: Date;
499
+ created_at: Date;
500
+ id: number;
501
+ name: string;
502
+ url: string;
503
+ };
504
+ export type ArtaService = {
505
+ amount: number;
506
+ amount_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
507
+ is_requested?: boolean | undefined;
508
+ is_required?: boolean | undefined;
509
+ name: string;
510
+ sub_subtype: string;
511
+ subtype: "specialized" | "consolidated" | "freight" | "parcel" | "collection" | "delivery" | "location" | "unpacking" | "condition" | "installation" | "deinstallation" | "debris_disposal" | "site_visit" | "handling" | "packing" | "packing_materials" | "receive_release" | "warehouse" | "customs" | "coi" | "administration" | "taxes_duties" | "fees" | "security" | "equipment";
512
+ type: "transport" | "location" | "handling" | "packing" | "storage" | "administration" | "taxes_duties_fees" | "security" | "equipment";
513
+ included_services: any[];
514
+ };
515
+ export type Disqualification = {
516
+ quote_types: ("parcel" | "premium" | "select" | "self_ship")[];
517
+ reason?: (string | null) | undefined;
518
+ reason_code: "cannot_be_packed" | "client_timeout_reached" | "external_service_unavailable" | "object_not_supported" | "out_of_network" | "over_size" | "over_value" | "over_volume" | "over_weight" | "requested_service_unavailable" | "too_many_items" | "under_value" | "under_volume" | "under_weight";
519
+ };
520
+ export type Detail = {
521
+ materials?: (("stone_marble" | "precious_stones" | "fiber_synthetic" | "fabric_natural" | "taxidermy" | "carbon_fiber" | "live_animal" | "paper" | "glass" | "presious_metals" | "particleboard" | "styrofoam" | "wood" | "photo_film" | "sand" | "metal" | "plexiglass" | "aquatic_life" | "canvas" | "drywall" | "hard_plastic" | "vinyl" | "soft_plastic" | "leather" | "rubber" | "concreate" | "paint" | "electronics" | "fiber_natural" | "gas" | "fabric_synthetic" | "CITES" | "liquids" | "salts")[] | null) | undefined;
522
+ creation_date?: (string | null) | undefined;
523
+ creator?: (string | null) | undefined;
524
+ notes?: (string | null) | undefined;
525
+ title?: (string | null) | undefined;
526
+ is_fragile?: (boolean | null) | undefined;
527
+ is_cites?: (boolean | null) | undefined;
528
+ };
529
+ export type AdditionalService = "assembly" | "debris_disposal" | "deinstallation" | "destination_additional_labor" | "destination_building_coi" | "destination_condition_check" | "destination_full_condition_report" | "destination_unpacking" | "double_blind_bols" | "installation" | "origin_building_coi" | "origin_condition_check" | "origin_full_condition_report" | "placement" | "signature_delivery" | "tarmac_supervision";
530
+ export type SupportedCurrency = "CAD" | "EUR" | "GBP" | "HKD" | "USD";
531
+ export type ArtaLocation = {
532
+ access_restrictions?: (("elevator_only" | "freight_elevator" | "loading_dock" | "loading_dock_low" | "low_clearance" | "non_paved" | "stairs_only" | "steep_gradient")[] | null) | undefined;
533
+ address_line_1?: (string | null) | undefined;
534
+ address_line_2?: (string | null) | undefined;
535
+ address_line_3?: (string | null) | undefined;
536
+ city?: (string | null) | undefined;
537
+ region?: (string | null) | undefined;
538
+ postal_code?: (string | null) | undefined;
539
+ country: string;
540
+ title?: (string | null) | undefined;
541
+ contacts?: ({
542
+ name: string;
543
+ email_address?: (string | null) | undefined;
544
+ phone_number?: (string | null) | undefined;
545
+ }[] | null) | undefined;
546
+ estimated_country?: string | undefined;
547
+ estimated_region?: string | undefined;
548
+ estimated_city?: string | undefined;
549
+ };
550
+ export type Insurance = "arta_transit_insurance" | "no_arta_insurance";
551
+ export type ArtaObject = {
552
+ internal_reference?: (string | null) | undefined;
553
+ current_packing?: (("alcohol_case" | "lay_flat_wine_box" | "blanket" | "wardrobe_box" | "cardboard_box" | "chandelier_box" | "chair_box" | "cbin_closed" | "cbin_open" | "ply_box" | "fine_art_econo_crate" | "fine_art_international_crate" | "econo_crate" | "international_econo_crate" | "furniture_crate" | "international_furniture_crate" | "parcel_crate" | "museum_crate" | "international_museum_crate" | "foam_lined_box" | "cavity_box" | "strongbox" | "double_box" | "travel_frame" | "travel_frame_art" | "travel_frame_other" | "a_frame" | "slat_crate" | "tri_wall_crate" | "lockbox" | "no_packing" | "pallet" | "international_pallet" | "portfolio" | "rug_rolled" | "shadow_box" | "slipcase" | "slipcase_glass_tape" | "poly_cardboard" | "bubble_cardboard" | "garment_bag" | "poly_only" | "dartek_only" | "bubble_only" | "cling_wrap" | "cbin_communal" | "sonotube" | "stabilizing_box" | "shipping_tube_small" | "shipping_tube_large")[] | null) | undefined;
554
+ details?: ({
555
+ materials?: (("stone_marble" | "precious_stones" | "fiber_synthetic" | "fabric_natural" | "taxidermy" | "carbon_fiber" | "live_animal" | "paper" | "glass" | "presious_metals" | "particleboard" | "styrofoam" | "wood" | "photo_film" | "sand" | "metal" | "plexiglass" | "aquatic_life" | "canvas" | "drywall" | "hard_plastic" | "vinyl" | "soft_plastic" | "leather" | "rubber" | "concreate" | "paint" | "electronics" | "fiber_natural" | "gas" | "fabric_synthetic" | "CITES" | "liquids" | "salts")[] | null) | undefined;
556
+ creation_date?: (string | null) | undefined;
557
+ creator?: (string | null) | undefined;
558
+ notes?: (string | null) | undefined;
559
+ title?: (string | null) | undefined;
560
+ is_fragile?: (boolean | null) | undefined;
561
+ is_cites?: (boolean | null) | undefined;
562
+ } | null) | undefined;
563
+ height: number | string;
564
+ width: number | string;
565
+ weight?: ((number | string) | null) | undefined;
566
+ value: number | string;
567
+ depth?: ((number | string) | null) | undefined;
568
+ images?: (string[] | null) | undefined;
569
+ public_reference?: (string | null) | undefined;
570
+ subtype: "painting_unframed" | "painting_framed" | "painting_framed_plexi" | "painting_framed_glass" | "work_on_paper_unframed" | "work_on_paper_framed" | "work_on_paper_framed_plexi" | "work_on_paper_framed_glass" | "mixed_media_unframed" | "mixed_media_framed" | "mixed_media_framed_plexi" | "mixed_media_framed_glass" | "photograph_unframed" | "photograph_framed" | "photograph_framed_plexi" | "photograph_framed_glass" | "new_media" | "sculpture" | "pedestal" | "pedestal_case_glass" | "pedestal_case_plexi" | "ceramic" | "neon" | "tapestry" | "other_art" | "table" | "chair" | "sofa_loveseat_chaise" | "floor_lamp" | "floor_lamp_shade" | "table_lamp" | "table_lamp_shade" | "sconce" | "ottoman" | "bookcase_storage" | "nightstand" | "armoire_dresser" | "carpet_rug" | "mirror" | "chandelier" | "bedframe" | "headboard" | "desk_vanity" | "media_console" | "other_furniture" | "earrings" | "necklace" | "bracelet" | "ring" | "brooch" | "watch" | "cufflinks" | "eyeglasses" | "set" | "precious_stones" | "snuff_box_cigarette_case" | "other_jewelry" | "vase_vessel" | "bowl" | "plaque" | "object_of_vertu" | "candelabra_candlestick" | "dinnerware" | "flatware" | "glassware" | "serveware" | "porcelain_plate" | "porcelain_bowl" | "tabletop_accessory" | "clock" | "other_decorative_arts" | "stamp" | "book" | "coin" | "document_manuscript" | "toy" | "miniature_model" | "figurine_doll" | "neon_sign" | "memorabilia" | "camera_electrical" | "other_collectibles" | "wine_bottle" | "spirits_bottle" | "beer_bottle" | "wine_case" | "spirits_case" | "beer_case" | "wine_barrel" | "spirits_barrel" | "beer_barrel" | "other_alcohols" | "car" | "motorcycle" | "bus" | "van" | "limousine" | "carriage" | "trailer" | "sidecar" | "other_automotive" | "clothing" | "footwear" | "handbag" | "accessories" | "other_fashion" | "musical_instrument" | "firearm_weapon" | "hunting_fishing" | "medical_equipment" | "other";
571
+ unit_of_measurement?: (string | null) | undefined;
572
+ weight_unit?: (string | null) | undefined;
573
+ value_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
574
+ };
575
+ export type QuoteType = "parcel" | "premium" | "select" | "self_ship";
576
+ export type Contact = {
577
+ name: string;
578
+ email_address?: (string | null) | undefined;
579
+ phone_number?: (string | null) | undefined;
580
+ };
581
+ export type ShipmentExceptionStatus = "in_progress" | "new" | "resolved";
582
+ export type PackageStatus = "pending" | "transit" | "out_for_delivery" | "delivered" | "unknown" | "notfound" | "undelivered" | "exception" | "expired";
583
+ export type Package = {
584
+ depth: number;
585
+ eta?: (string | null) | undefined;
586
+ handle_with_care: boolean;
587
+ height: number;
588
+ id: number;
589
+ is_sufficiently_packed: boolean;
590
+ objects: {
591
+ internal_reference?: (string | null) | undefined;
592
+ current_packing?: (("alcohol_case" | "lay_flat_wine_box" | "blanket" | "wardrobe_box" | "cardboard_box" | "chandelier_box" | "chair_box" | "cbin_closed" | "cbin_open" | "ply_box" | "fine_art_econo_crate" | "fine_art_international_crate" | "econo_crate" | "international_econo_crate" | "furniture_crate" | "international_furniture_crate" | "parcel_crate" | "museum_crate" | "international_museum_crate" | "foam_lined_box" | "cavity_box" | "strongbox" | "double_box" | "travel_frame" | "travel_frame_art" | "travel_frame_other" | "a_frame" | "slat_crate" | "tri_wall_crate" | "lockbox" | "no_packing" | "pallet" | "international_pallet" | "portfolio" | "rug_rolled" | "shadow_box" | "slipcase" | "slipcase_glass_tape" | "poly_cardboard" | "bubble_cardboard" | "garment_bag" | "poly_only" | "dartek_only" | "bubble_only" | "cling_wrap" | "cbin_communal" | "sonotube" | "stabilizing_box" | "shipping_tube_small" | "shipping_tube_large")[] | null) | undefined;
593
+ details?: ({
594
+ materials?: (("stone_marble" | "precious_stones" | "fiber_synthetic" | "fabric_natural" | "taxidermy" | "carbon_fiber" | "live_animal" | "paper" | "glass" | "presious_metals" | "particleboard" | "styrofoam" | "wood" | "photo_film" | "sand" | "metal" | "plexiglass" | "aquatic_life" | "canvas" | "drywall" | "hard_plastic" | "vinyl" | "soft_plastic" | "leather" | "rubber" | "concreate" | "paint" | "electronics" | "fiber_natural" | "gas" | "fabric_synthetic" | "CITES" | "liquids" | "salts")[] | null) | undefined;
595
+ creation_date?: (string | null) | undefined;
596
+ creator?: (string | null) | undefined;
597
+ notes?: (string | null) | undefined;
598
+ title?: (string | null) | undefined;
599
+ is_fragile?: (boolean | null) | undefined;
600
+ is_cites?: (boolean | null) | undefined;
601
+ } | null) | undefined;
602
+ height: number | string;
603
+ width: number | string;
604
+ weight?: ((number | string) | null) | undefined;
605
+ value: number | string;
606
+ depth?: ((number | string) | null) | undefined;
607
+ images?: (string[] | null) | undefined;
608
+ public_reference?: (string | null) | undefined;
609
+ subtype: "painting_unframed" | "painting_framed" | "painting_framed_plexi" | "painting_framed_glass" | "work_on_paper_unframed" | "work_on_paper_framed" | "work_on_paper_framed_plexi" | "work_on_paper_framed_glass" | "mixed_media_unframed" | "mixed_media_framed" | "mixed_media_framed_plexi" | "mixed_media_framed_glass" | "photograph_unframed" | "photograph_framed" | "photograph_framed_plexi" | "photograph_framed_glass" | "new_media" | "sculpture" | "pedestal" | "pedestal_case_glass" | "pedestal_case_plexi" | "ceramic" | "neon" | "tapestry" | "other_art" | "table" | "chair" | "sofa_loveseat_chaise" | "floor_lamp" | "floor_lamp_shade" | "table_lamp" | "table_lamp_shade" | "sconce" | "ottoman" | "bookcase_storage" | "nightstand" | "armoire_dresser" | "carpet_rug" | "mirror" | "chandelier" | "bedframe" | "headboard" | "desk_vanity" | "media_console" | "other_furniture" | "earrings" | "necklace" | "bracelet" | "ring" | "brooch" | "watch" | "cufflinks" | "eyeglasses" | "set" | "precious_stones" | "snuff_box_cigarette_case" | "other_jewelry" | "vase_vessel" | "bowl" | "plaque" | "object_of_vertu" | "candelabra_candlestick" | "dinnerware" | "flatware" | "glassware" | "serveware" | "porcelain_plate" | "porcelain_bowl" | "tabletop_accessory" | "clock" | "other_decorative_arts" | "stamp" | "book" | "coin" | "document_manuscript" | "toy" | "miniature_model" | "figurine_doll" | "neon_sign" | "memorabilia" | "camera_electrical" | "other_collectibles" | "wine_bottle" | "spirits_bottle" | "beer_bottle" | "wine_case" | "spirits_case" | "beer_case" | "wine_barrel" | "spirits_barrel" | "beer_barrel" | "other_alcohols" | "car" | "motorcycle" | "bus" | "van" | "limousine" | "carriage" | "trailer" | "sidecar" | "other_automotive" | "clothing" | "footwear" | "handbag" | "accessories" | "other_fashion" | "musical_instrument" | "firearm_weapon" | "hunting_fishing" | "medical_equipment" | "other";
610
+ unit_of_measurement?: (string | null) | undefined;
611
+ weight_unit?: (string | null) | undefined;
612
+ value_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
613
+ }[];
614
+ packing_materials: ("alcohol_case" | "lay_flat_wine_box" | "blanket" | "wardrobe_box" | "cardboard_box" | "chandelier_box" | "chair_box" | "cbin_closed" | "cbin_open" | "ply_box" | "fine_art_econo_crate" | "fine_art_international_crate" | "econo_crate" | "international_econo_crate" | "furniture_crate" | "international_furniture_crate" | "parcel_crate" | "museum_crate" | "international_museum_crate" | "foam_lined_box" | "cavity_box" | "strongbox" | "double_box" | "travel_frame" | "travel_frame_art" | "travel_frame_other" | "a_frame" | "slat_crate" | "tri_wall_crate" | "lockbox" | "no_packing" | "pallet" | "international_pallet" | "portfolio" | "rug_rolled" | "shadow_box" | "slipcase" | "slipcase_glass_tape" | "poly_cardboard" | "bubble_cardboard" | "garment_bag" | "poly_only" | "dartek_only" | "bubble_only" | "cling_wrap" | "cbin_communal" | "sonotube" | "stabilizing_box" | "shipping_tube_small" | "shipping_tube_large")[];
615
+ status?: (("pending" | "transit" | "out_for_delivery" | "delivered" | "unknown" | "notfound" | "undelivered" | "exception" | "expired") | null) | undefined;
616
+ unit_of_measurement?: (string | null) | undefined;
617
+ weight: number;
618
+ weight_unit: string;
619
+ width: number;
620
+ };
621
+ export type ShipmentExceptionTypeId = "change_of_address_request" | "customs_information_required" | "damaged_items" | "direct_payment_required" | "held_at_customs" | "inaccurate_object_details" | "incorrect_address" | "lost_in_transit" | "not_ready_for_delivery" | "not_ready_for_release" | "other" | "prepayment_required" | "requested_hold_to_collect" | "requested_hold_to_deliver" | "wrong_item";
622
+ export type ShipmentException = {
623
+ updated_at: Date;
624
+ created_at: Date;
625
+ exception_type_label?: (string | null) | undefined;
626
+ id: string;
627
+ package_id?: (number | null) | undefined;
628
+ resolution?: (string | null) | undefined;
629
+ status: "in_progress" | "new" | "resolved";
630
+ type: "change_of_address_request" | "customs_information_required" | "damaged_items" | "direct_payment_required" | "held_at_customs" | "inaccurate_object_details" | "incorrect_address" | "lost_in_transit" | "not_ready_for_delivery" | "not_ready_for_release" | "other" | "prepayment_required" | "requested_hold_to_collect" | "requested_hold_to_deliver" | "wrong_item";
631
+ };
632
+ export type ShipmentSchedule = {
633
+ delivery_end?: (Date | null) | undefined;
634
+ delivery_start?: (Date | null) | undefined;
635
+ delivery_window_modifier: string;
636
+ pickup_end?: (Date | null) | undefined;
637
+ pickup_start?: (Date | null) | undefined;
638
+ pickup_window_modifier: string;
639
+ };
640
+ export type ShipmentTracking = {
641
+ carrier_name: string;
642
+ label_url?: (string | null) | undefined;
643
+ package_id: number;
644
+ tracking_number: string;
645
+ url: string;
646
+ };
647
+ export type InsurancePolicy = {
648
+ amount: number;
649
+ amount_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
650
+ id: string;
651
+ insured_value: number;
652
+ insured_value_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
653
+ };
654
+ export type Quote = {
655
+ id: number;
656
+ included_services: {
657
+ amount: number;
658
+ amount_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
659
+ is_requested?: boolean | undefined;
660
+ is_required?: boolean | undefined;
661
+ name: string;
662
+ sub_subtype: string;
663
+ subtype: "specialized" | "consolidated" | "freight" | "parcel" | "collection" | "delivery" | "location" | "unpacking" | "condition" | "installation" | "deinstallation" | "debris_disposal" | "site_visit" | "handling" | "packing" | "packing_materials" | "receive_release" | "warehouse" | "customs" | "coi" | "administration" | "taxes_duties" | "fees" | "security" | "equipment";
664
+ type: "transport" | "location" | "handling" | "packing" | "storage" | "administration" | "taxes_duties_fees" | "security" | "equipment";
665
+ included_services: any[];
666
+ }[];
667
+ included_insurance_policy?: ({
668
+ amount: number;
669
+ amount_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
670
+ id: string;
671
+ insured_value: number;
672
+ insured_value_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
673
+ } | null) | undefined;
674
+ optional_services: {
675
+ amount: number;
676
+ amount_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
677
+ is_requested?: boolean | undefined;
678
+ is_required?: boolean | undefined;
679
+ name: string;
680
+ sub_subtype: string;
681
+ subtype: "specialized" | "consolidated" | "freight" | "parcel" | "collection" | "delivery" | "location" | "unpacking" | "condition" | "installation" | "deinstallation" | "debris_disposal" | "site_visit" | "handling" | "packing" | "packing_materials" | "receive_release" | "warehouse" | "customs" | "coi" | "administration" | "taxes_duties" | "fees" | "security" | "equipment";
682
+ type: "transport" | "location" | "handling" | "packing" | "storage" | "administration" | "taxes_duties_fees" | "security" | "equipment";
683
+ included_services: any[];
684
+ }[];
685
+ quote_type: "parcel" | "premium" | "select" | "self_ship";
686
+ status: string;
687
+ total: number;
688
+ total_currency: "CAD" | "EUR" | "GBP" | "HKD" | "USD";
689
+ };
690
+ export type QuoteRequestListItem = {
691
+ updated_at: Date;
692
+ created_at: Date;
693
+ id: string;
694
+ bookable: {
695
+ missing: string[];
696
+ ready: boolean;
697
+ };
698
+ destination: {
699
+ access_restrictions?: (("elevator_only" | "freight_elevator" | "loading_dock" | "loading_dock_low" | "low_clearance" | "non_paved" | "stairs_only" | "steep_gradient")[] | null) | undefined;
700
+ address_line_1?: (string | null) | undefined;
701
+ address_line_2?: (string | null) | undefined;
702
+ address_line_3?: (string | null) | undefined;
703
+ city?: (string | null) | undefined;
704
+ region?: (string | null) | undefined;
705
+ postal_code?: (string | null) | undefined;
706
+ country: string;
707
+ title?: (string | null) | undefined;
708
+ contacts?: ({
709
+ name: string;
710
+ email_address?: (string | null) | undefined;
711
+ phone_number?: (string | null) | undefined;
712
+ }[] | null) | undefined;
713
+ estimated_country?: string | undefined;
714
+ estimated_region?: string | undefined;
715
+ estimated_city?: string | undefined;
716
+ };
717
+ hosted_session_id: number | null;
718
+ insurance: ("arta_transit_insurance" | "no_arta_insurance") | null;
719
+ internal_reference: string | null;
720
+ log_request_id: string;
721
+ object_count: number | null;
722
+ origin: {
723
+ access_restrictions?: (("elevator_only" | "freight_elevator" | "loading_dock" | "loading_dock_low" | "low_clearance" | "non_paved" | "stairs_only" | "steep_gradient")[] | null) | undefined;
724
+ address_line_1?: (string | null) | undefined;
725
+ address_line_2?: (string | null) | undefined;
726
+ address_line_3?: (string | null) | undefined;
727
+ city?: (string | null) | undefined;
728
+ region?: (string | null) | undefined;
729
+ postal_code?: (string | null) | undefined;
730
+ country: string;
731
+ title?: (string | null) | undefined;
732
+ contacts?: ({
733
+ name: string;
734
+ email_address?: (string | null) | undefined;
735
+ phone_number?: (string | null) | undefined;
736
+ }[] | null) | undefined;
737
+ estimated_country?: string | undefined;
738
+ estimated_region?: string | undefined;
739
+ estimated_city?: string | undefined;
740
+ };
741
+ public_reference?: (string | null) | undefined;
742
+ quote_types: ("parcel" | "premium" | "select" | "self_ship")[];
743
+ shortcode: string;
744
+ status: "cancelled" | "closed" | "disqualified" | "expired" | "in_progress" | "pending" | "quoted";
745
+ tags?: any;
746
+ };
747
+ export type EmailNotificationId = "booking" | "cancelled" | "collected" | "collection" | "complete" | "custom_quoted_dashboard" | "in_transit" | "invoice" | "self_ship_label" | "payment" | "scheduling" | "eei";
748
+ export type Recipient = "payer" | "origin" | "destination";
749
+ export type ArtaMimeType = "application/pdf" | "application/vnd.ms-excel" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "application/vnd.openxmlformats-officedocument.wordprocessingml.document" | "image/jpeg" | "image/png" | "text/csv" | "video/mp4" | "video/quicktime" | "application/msword";
750
+ export type ArtaDocumentType = "bill_of_lading" | "certificate_of_insurance" | "certificate_of_insurance_template" | "condition_report" | "condition_check" | "image" | "instructions" | "airway_bill" | "commercial_invoice" | "power_of_attorney" | "proof_of_export" | "proof_of_delivery" | "quote" | "shipping_label" | "other";