@artaio/node-api 1.5.4 → 1.7.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/lib/arta.d.ts +2 -0
- package/dist/lib/arta.js +2 -0
- package/dist/lib/endpoint/addressVerifications.d.ts +30 -0
- package/dist/lib/endpoint/addressVerifications.js +27 -0
- package/dist/lib/endpoint/hostedSessions.d.ts +35 -4
- package/dist/lib/index.d.ts +1 -0
- package/dist/lib/types.d.ts +192 -3
- package/dist/package.json +1 -1
- package/package.json +1 -1
package/dist/lib/arta.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { Logger, LoggerVerbosity } from './logging';
|
|
2
|
+
import { AddressVerificationsEndpoint } from './endpoint/addressVerifications';
|
|
2
3
|
import { AttachmentsEndpoint } from './endpoint/attachment';
|
|
3
4
|
import { EmailRulesEndpoint } from './endpoint/emailRules';
|
|
4
5
|
import { EmailSubscriptionsEndpoint } from './endpoint/emailSubscriptions';
|
|
@@ -25,6 +26,7 @@ export interface ArtaConfig {
|
|
|
25
26
|
export declare class Arta {
|
|
26
27
|
private readonly artaClient;
|
|
27
28
|
private readonly config;
|
|
29
|
+
address_verifications: AddressVerificationsEndpoint;
|
|
28
30
|
attachments: AttachmentsEndpoint;
|
|
29
31
|
email_rules: EmailRulesEndpoint;
|
|
30
32
|
email_subscriptions: EmailSubscriptionsEndpoint;
|
package/dist/lib/arta.js
CHANGED
|
@@ -4,6 +4,7 @@ exports.Arta = void 0;
|
|
|
4
4
|
var ArtaClient_1 = require("./ArtaClient");
|
|
5
5
|
var logging_1 = require("./logging");
|
|
6
6
|
var FetchHttpClient_1 = require("./net/FetchHttpClient");
|
|
7
|
+
var addressVerifications_1 = require("./endpoint/addressVerifications");
|
|
7
8
|
var attachment_1 = require("./endpoint/attachment");
|
|
8
9
|
var emailRules_1 = require("./endpoint/emailRules");
|
|
9
10
|
var emailSubscriptions_1 = require("./endpoint/emailSubscriptions");
|
|
@@ -35,6 +36,7 @@ var Arta = /** @class */ (function () {
|
|
|
35
36
|
apiKey: apiKey,
|
|
36
37
|
host: this.config.host,
|
|
37
38
|
});
|
|
39
|
+
this.address_verifications = new addressVerifications_1.AddressVerificationsEndpoint(this.artaClient);
|
|
38
40
|
this.attachments = new attachment_1.AttachmentsEndpoint(this.artaClient);
|
|
39
41
|
this.email_rules = new emailRules_1.EmailRulesEndpoint(this.artaClient);
|
|
40
42
|
this.email_subscriptions = new emailSubscriptions_1.EmailSubscriptionsEndpoint(this.artaClient);
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import type { ArtaID } from '../ArtaClient';
|
|
2
|
+
import type { RestClient } from '../net/RestClient';
|
|
3
|
+
import type { Page } from '../pagination';
|
|
4
|
+
import type { AddressVerification } from '../types';
|
|
5
|
+
export interface AddressVerificationCreateBodyInput {
|
|
6
|
+
address_line_1: string;
|
|
7
|
+
address_line_2?: string | null;
|
|
8
|
+
address_line_3?: string | null;
|
|
9
|
+
city?: string | null;
|
|
10
|
+
region?: string | null;
|
|
11
|
+
postal_code?: string | null;
|
|
12
|
+
country: string;
|
|
13
|
+
}
|
|
14
|
+
export interface AddressVerificationCreateBody {
|
|
15
|
+
input: AddressVerificationCreateBodyInput;
|
|
16
|
+
reference?: string | null;
|
|
17
|
+
}
|
|
18
|
+
export interface AddressVerificationCreate {
|
|
19
|
+
address_verification: AddressVerificationCreateBody;
|
|
20
|
+
}
|
|
21
|
+
export declare class AddressVerificationsEndpoint {
|
|
22
|
+
private readonly artaClient;
|
|
23
|
+
private readonly defaultEndpoint;
|
|
24
|
+
private readonly path;
|
|
25
|
+
constructor(artaClient: RestClient);
|
|
26
|
+
getById(id: ArtaID, auth?: string): Promise<AddressVerification>;
|
|
27
|
+
list(page?: number, pageSize?: number, auth?: string): Promise<Page<AddressVerification>>;
|
|
28
|
+
listAll(auth?: string): AsyncGenerator<AddressVerification>;
|
|
29
|
+
create(payload: AddressVerificationCreateBody, auth?: string): Promise<AddressVerification>;
|
|
30
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.AddressVerificationsEndpoint = void 0;
|
|
4
|
+
var endpoint_1 = require("./endpoint");
|
|
5
|
+
var AddressVerificationsEndpoint = /** @class */ (function () {
|
|
6
|
+
function AddressVerificationsEndpoint(artaClient) {
|
|
7
|
+
this.artaClient = artaClient;
|
|
8
|
+
this.path = '/address_verifications';
|
|
9
|
+
this.defaultEndpoint = new endpoint_1.DefaultEndpoint(this.path, this.artaClient);
|
|
10
|
+
}
|
|
11
|
+
AddressVerificationsEndpoint.prototype.getById = function (id, auth) {
|
|
12
|
+
return this.defaultEndpoint.getById(id, auth);
|
|
13
|
+
};
|
|
14
|
+
AddressVerificationsEndpoint.prototype.list = function (page, pageSize, auth) {
|
|
15
|
+
if (page === void 0) { page = 1; }
|
|
16
|
+
if (pageSize === void 0) { pageSize = 20; }
|
|
17
|
+
return this.defaultEndpoint.list({ page: page, page_size: pageSize }, auth);
|
|
18
|
+
};
|
|
19
|
+
AddressVerificationsEndpoint.prototype.listAll = function (auth) {
|
|
20
|
+
return this.defaultEndpoint.listAll(auth);
|
|
21
|
+
};
|
|
22
|
+
AddressVerificationsEndpoint.prototype.create = function (payload, auth) {
|
|
23
|
+
return this.defaultEndpoint.create({ address_verification: payload }, auth);
|
|
24
|
+
};
|
|
25
|
+
return AddressVerificationsEndpoint;
|
|
26
|
+
}());
|
|
27
|
+
exports.AddressVerificationsEndpoint = AddressVerificationsEndpoint;
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
import type { ArtaID } from '../ArtaClient';
|
|
2
2
|
import type { RestClient } from '../net/RestClient';
|
|
3
3
|
import type { Page } from '../pagination';
|
|
4
|
-
import type { AdditionalService, ArtaLocation, ArtaObject, HostedSession, Insurance, ParcelTransportServices, QuoteType } from '../MetadataTypes';
|
|
4
|
+
import type { AdditionalService, ArtaInboundObject, ArtaLocation, ArtaObject, HostedSession, Insurance, ParcelTransportServices, QuoteType, QuotingStrategy } from '../MetadataTypes';
|
|
5
5
|
import { type Nullable, type NullableString } from '../utils';
|
|
6
6
|
import type { HostedSessionsSearch } from '../search';
|
|
7
7
|
export type EnrichedHostedSession = HostedSession & {
|
|
8
8
|
cancel: (auth?: string) => Promise<HostedSession>;
|
|
9
9
|
};
|
|
10
|
-
export
|
|
10
|
+
export type HostedSessionCreateBody = {
|
|
11
11
|
additional_services?: Nullable<AdditionalService[]>;
|
|
12
12
|
cancel_url?: NullableString;
|
|
13
13
|
destination?: Nullable<ArtaLocation>;
|
|
@@ -20,7 +20,37 @@ export interface HostedSessionCreateBody {
|
|
|
20
20
|
public_reference?: NullableString;
|
|
21
21
|
shipping_notes?: NullableString;
|
|
22
22
|
success_url?: NullableString;
|
|
23
|
-
|
|
23
|
+
public_instructions_location_quotes?: HostedSession['public_instructions_location_quotes'];
|
|
24
|
+
public_instructions_payment?: HostedSession['public_instructions_payment'];
|
|
25
|
+
public_instructions_booking_review?: HostedSession['public_instructions_booking_review'];
|
|
26
|
+
public_instructions_confirmation?: HostedSession['public_instructions_confirmation'];
|
|
27
|
+
quoting_strategy?: QuotingStrategy;
|
|
28
|
+
type?: 'booking';
|
|
29
|
+
} | {
|
|
30
|
+
request_id: string;
|
|
31
|
+
} | {
|
|
32
|
+
additional_services?: Nullable<AdditionalService[]>;
|
|
33
|
+
cancel_url?: NullableString;
|
|
34
|
+
destination: ArtaLocation;
|
|
35
|
+
insurance?: Nullable<Insurance>;
|
|
36
|
+
internal_reference?: NullableString;
|
|
37
|
+
objects: ArtaInboundObject[];
|
|
38
|
+
origin?: Nullable<ArtaLocation>;
|
|
39
|
+
preferred_quote_types?: Nullable<QuoteType[]>;
|
|
40
|
+
preferred_parcel_transport_services?: Nullable<ParcelTransportServices[]>;
|
|
41
|
+
public_reference?: NullableString;
|
|
42
|
+
shipping_notes?: NullableString;
|
|
43
|
+
success_url?: NullableString;
|
|
44
|
+
can_user_confirm_object_dimensions?: HostedSession['can_user_confirm_object_dimensions'];
|
|
45
|
+
public_instructions_object_details?: HostedSession['public_instructions_object_details'];
|
|
46
|
+
public_instructions_location_quotes?: HostedSession['public_instructions_location_quotes'];
|
|
47
|
+
public_instructions_payment?: HostedSession['public_instructions_payment'];
|
|
48
|
+
public_instructions_booking_review?: HostedSession['public_instructions_booking_review'];
|
|
49
|
+
public_instructions_confirmation?: HostedSession['public_instructions_confirmation'];
|
|
50
|
+
quoting_strategy?: QuotingStrategy;
|
|
51
|
+
type: 'inbound_booking';
|
|
52
|
+
};
|
|
53
|
+
type HostedSessionListItem = Omit<HostedSession, 'public_instructions_object_details' | 'public_instructions_location_quotes' | 'public_instructions_payment' | 'public_instructions_booking_review' | 'public_instructions_confirmation'>;
|
|
24
54
|
export interface HostedSessionCreate {
|
|
25
55
|
hosted_session: HostedSessionCreateBody;
|
|
26
56
|
}
|
|
@@ -31,7 +61,8 @@ export declare class HostedSessionsEndpoint {
|
|
|
31
61
|
constructor(artaClient: RestClient);
|
|
32
62
|
private withFunctionCalls;
|
|
33
63
|
getById(id: ArtaID, auth?: string): Promise<EnrichedHostedSession>;
|
|
34
|
-
list(search?: HostedSessionsSearch, page?: number, pageSize?: number, auth?: string): Promise<Page<
|
|
64
|
+
list(search?: HostedSessionsSearch, page?: number, pageSize?: number, auth?: string): Promise<Page<HostedSessionListItem>>;
|
|
35
65
|
create(payload: HostedSessionCreateBody, auth?: string): Promise<EnrichedHostedSession>;
|
|
36
66
|
cancel(id: ArtaID, auth?: string): Promise<EnrichedHostedSession>;
|
|
37
67
|
}
|
|
68
|
+
export {};
|
package/dist/lib/index.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export { Arta } from './arta';
|
|
2
2
|
export { Logger, LoggerVerbosity } from './logging';
|
|
3
|
+
export { AddressVerificationCreateBody } from './endpoint/addressVerifications';
|
|
3
4
|
export { AttachmentCreateBodyRequest, AttachmentCreateBodyShipment, AttachmentCreateBody, } from './endpoint/attachment';
|
|
4
5
|
export { EmailRuleCreateBody } from './endpoint/emailRules';
|
|
5
6
|
export { EmailSubscriptionCreateBody } from './endpoint/emailSubscriptions';
|
package/dist/lib/types.d.ts
CHANGED
|
@@ -70,7 +70,7 @@ export type QuoteRequest = {
|
|
|
70
70
|
};
|
|
71
71
|
public_reference?: (string | null) | undefined;
|
|
72
72
|
quote_types: ("parcel" | "premium" | "select" | "self_ship")[];
|
|
73
|
-
quoting_strategy: "best_rate" | "compare_carriers";
|
|
73
|
+
quoting_strategy: "all_rates" | "best_rate" | "compare_carriers";
|
|
74
74
|
shortcode: string;
|
|
75
75
|
status: "cancelled" | "closed" | "disqualified" | "expired" | "in_progress" | "pending" | "quoted";
|
|
76
76
|
tags: {
|
|
@@ -485,6 +485,14 @@ export type HostedSession = {
|
|
|
485
485
|
shortcode: string;
|
|
486
486
|
status: "cancelled" | "closed" | "disqualified" | "expired" | "in_progress" | "pending" | "quoted";
|
|
487
487
|
url?: (string | null) | undefined;
|
|
488
|
+
type?: (("booking" | "inbound_booking") | null) | undefined;
|
|
489
|
+
can_user_confirm_object_dimensions?: (boolean | null) | undefined;
|
|
490
|
+
public_instructions_object_details?: (string | null) | undefined;
|
|
491
|
+
public_instructions_location_quotes?: (string | null) | undefined;
|
|
492
|
+
public_instructions_payment?: (string | null) | undefined;
|
|
493
|
+
public_instructions_booking_review?: (string | null) | undefined;
|
|
494
|
+
public_instructions_confirmation?: (string | null) | undefined;
|
|
495
|
+
quoting_strategy: "all_rates" | "best_rate" | "compare_carriers";
|
|
488
496
|
};
|
|
489
497
|
export type InvoicePayment = {
|
|
490
498
|
updated_at: Date;
|
|
@@ -847,7 +855,7 @@ export type Quote = {
|
|
|
847
855
|
total: number;
|
|
848
856
|
total_currency: "CAD" | "CHF" | "EUR" | "GBP" | "HKD" | "USD";
|
|
849
857
|
};
|
|
850
|
-
export type QuotingStrategy = "best_rate" | "compare_carriers";
|
|
858
|
+
export type QuotingStrategy = "all_rates" | "best_rate" | "compare_carriers";
|
|
851
859
|
export type QuoteRequestListItem = {
|
|
852
860
|
updated_at: Date;
|
|
853
861
|
created_at: Date;
|
|
@@ -901,7 +909,7 @@ export type QuoteRequestListItem = {
|
|
|
901
909
|
};
|
|
902
910
|
public_reference?: (string | null) | undefined;
|
|
903
911
|
quote_types: ("parcel" | "premium" | "select" | "self_ship")[];
|
|
904
|
-
quoting_strategy: "best_rate" | "compare_carriers";
|
|
912
|
+
quoting_strategy: "all_rates" | "best_rate" | "compare_carriers";
|
|
905
913
|
shortcode: string;
|
|
906
914
|
status: "cancelled" | "closed" | "disqualified" | "expired" | "in_progress" | "pending" | "quoted";
|
|
907
915
|
tags: {
|
|
@@ -941,3 +949,184 @@ export type ArtaComponent = {
|
|
|
941
949
|
value_currency?: (("CAD" | "CHF" | "EUR" | "GBP" | "HKD" | "USD") | null) | undefined;
|
|
942
950
|
};
|
|
943
951
|
export type ArtaComponentType = "accessories" | "armoire_dresser" | "bedframe" | "beer_barrel" | "beer_bottle" | "beer_case" | "book" | "bookcase_storage" | "bowl" | "bracelet" | "brooch" | "bus" | "camera_electrical" | "candelabra_candlestick" | "car" | "carpet_rug" | "carriage" | "ceramic" | "chair" | "chandelier" | "clock" | "clothing" | "coin" | "collectible_apparel" | "cufflinks" | "decoy" | "desk_vanity" | "dinnerware" | "document_manuscript" | "earrings" | "eyeglasses" | "figurine_doll" | "firearm_weapon" | "flatware" | "floor_lamp" | "floor_lamp_shade" | "folding_screen" | "footwear" | "fossil" | "glass_sculpture" | "glassware" | "handbag" | "headboard" | "hunting_fishing" | "lighting_fixture" | "limousine" | "media_console" | "medical_equipment" | "memorabilia" | "mineral" | "miniature_model" | "mirror" | "mixed_media_framed" | "mixed_media_framed_glass" | "mixed_media_framed_plexi" | "mixed_media_unframed" | "motorcycle" | "musical_instrument" | "necklace" | "neon" | "neon_sign" | "new_media" | "nightstand" | "object_of_vertu" | "other" | "other_alcohols" | "other_art" | "other_automotive" | "other_collectibles" | "other_decorative_arts" | "other_fashion" | "other_furniture" | "other_jewelry" | "ottoman" | "painting_framed" | "painting_framed_glass" | "painting_framed_plexi" | "painting_unframed" | "pedestal" | "pedestal_case_glass" | "pedestal_case_plexi" | "photograph_framed" | "photograph_framed_glass" | "photograph_framed_plexi" | "photograph_unframed" | "plaque" | "porcelain_bowl" | "porcelain_plate" | "precious_stones" | "ring" | "sconce" | "sculpture" | "serveware" | "set" | "sidecar" | "snuff_box_cigarette_case" | "sofa_loveseat_chaise" | "spirits_barrel" | "spirits_bottle" | "spirits_case" | "stamp" | "table" | "table_lamp" | "table_lamp_shade" | "tabletop_accessory" | "tapestry" | "toy" | "trading_card" | "trailer" | "van" | "vase_vessel" | "watch" | "wine_barrel" | "wine_bottle" | "wine_case" | "work_on_paper_framed" | "work_on_paper_framed_glass" | "work_on_paper_framed_plexi" | "work_on_paper_unframed";
|
|
952
|
+
export type InboundHostedSession = {
|
|
953
|
+
updated_at: Date;
|
|
954
|
+
created_at: Date;
|
|
955
|
+
id: number;
|
|
956
|
+
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;
|
|
957
|
+
cancel_url?: (string | null) | undefined;
|
|
958
|
+
destination: {
|
|
959
|
+
access_restrictions?: (("elevator_only" | "freight_elevator" | "loading_dock" | "loading_dock_low" | "low_clearance" | "non_paved" | "stairs_only" | "steep_gradient")[] | null) | undefined;
|
|
960
|
+
address_line_1?: (string | null) | undefined;
|
|
961
|
+
address_line_2?: (string | null) | undefined;
|
|
962
|
+
address_line_3?: (string | null) | undefined;
|
|
963
|
+
city?: (string | null) | undefined;
|
|
964
|
+
region?: (string | null) | undefined;
|
|
965
|
+
postal_code?: (string | null) | undefined;
|
|
966
|
+
country: string;
|
|
967
|
+
title?: (string | null) | undefined;
|
|
968
|
+
contacts?: ({
|
|
969
|
+
name: string;
|
|
970
|
+
email_address?: (string | null) | undefined;
|
|
971
|
+
phone_number?: (string | null) | undefined;
|
|
972
|
+
}[] | null) | undefined;
|
|
973
|
+
estimated_country?: string | undefined;
|
|
974
|
+
estimated_region?: string | undefined;
|
|
975
|
+
estimated_city?: string | undefined;
|
|
976
|
+
};
|
|
977
|
+
insurance?: (("arta_transit_insurance" | "no_arta_insurance") | null) | undefined;
|
|
978
|
+
internal_reference?: (string | null) | undefined;
|
|
979
|
+
objects: {
|
|
980
|
+
internal_reference?: (string | null) | undefined;
|
|
981
|
+
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;
|
|
982
|
+
details?: ({
|
|
983
|
+
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;
|
|
984
|
+
creation_date?: (string | null) | undefined;
|
|
985
|
+
creator?: (string | null) | undefined;
|
|
986
|
+
notes?: (string | null) | undefined;
|
|
987
|
+
title?: (string | null) | undefined;
|
|
988
|
+
is_fragile?: (boolean | null) | undefined;
|
|
989
|
+
is_cites?: (boolean | null) | undefined;
|
|
990
|
+
} | null) | undefined;
|
|
991
|
+
height?: ((number | string) | null) | undefined;
|
|
992
|
+
width?: ((number | string) | null) | undefined;
|
|
993
|
+
weight?: ((number | string) | null) | undefined;
|
|
994
|
+
value: number | string;
|
|
995
|
+
depth?: ((number | string) | null) | undefined;
|
|
996
|
+
images?: (string[] | null) | undefined;
|
|
997
|
+
public_reference?: (string | null) | undefined;
|
|
998
|
+
subtype: "accessories" | "armoire_dresser" | "bedframe" | "beer_barrel" | "beer_bottle" | "beer_case" | "book" | "bookcase_storage" | "bowl" | "bracelet" | "brooch" | "bus" | "camera_electrical" | "candelabra_candlestick" | "car" | "carpet_rug" | "carriage" | "ceramic" | "chair" | "chandelier" | "clock" | "clothing" | "coin" | "collectible_apparel" | "cufflinks" | "decoy" | "desk_vanity" | "dinnerware" | "document_manuscript" | "earrings" | "eyeglasses" | "figurine_doll" | "firearm_weapon" | "flatware" | "floor_lamp" | "floor_lamp_shade" | "folding_screen" | "footwear" | "fossil" | "glass_sculpture" | "glassware" | "handbag" | "headboard" | "hunting_fishing" | "lighting_fixture" | "limousine" | "media_console" | "medical_equipment" | "memorabilia" | "mineral" | "miniature_model" | "mirror" | "mixed_media_framed" | "mixed_media_framed_glass" | "mixed_media_framed_plexi" | "mixed_media_unframed" | "motorcycle" | "musical_instrument" | "necklace" | "neon" | "neon_sign" | "new_media" | "nightstand" | "object_of_vertu" | "other" | "other_alcohols" | "other_art" | "other_automotive" | "other_collectibles" | "other_decorative_arts" | "other_fashion" | "other_furniture" | "other_jewelry" | "ottoman" | "painting_framed" | "painting_framed_glass" | "painting_framed_plexi" | "painting_unframed" | "pedestal" | "pedestal_case_glass" | "pedestal_case_plexi" | "photograph_framed" | "photograph_framed_glass" | "photograph_framed_plexi" | "photograph_unframed" | "plaque" | "porcelain_bowl" | "porcelain_plate" | "precious_stones" | "prepacked_box" | "ring" | "sconce" | "sculpture" | "serveware" | "set" | "sidecar" | "snuff_box_cigarette_case" | "sofa_loveseat_chaise" | "spirits_barrel" | "spirits_bottle" | "spirits_case" | "stamp" | "table" | "table_lamp" | "table_lamp_shade" | "tabletop_accessory" | "tapestry" | "toy" | "trading_card" | "trailer" | "van" | "vase_vessel" | "watch" | "wine_barrel" | "wine_bottle" | "wine_case" | "work_on_paper_framed" | "work_on_paper_framed_glass" | "work_on_paper_framed_plexi" | "work_on_paper_unframed";
|
|
999
|
+
unit_of_measurement?: (string | null) | undefined;
|
|
1000
|
+
weight_unit?: (string | null) | undefined;
|
|
1001
|
+
value_currency: "CAD" | "CHF" | "EUR" | "GBP" | "HKD" | "USD";
|
|
1002
|
+
components?: ({
|
|
1003
|
+
customs?: ({
|
|
1004
|
+
country_of_origin?: (string | null) | undefined;
|
|
1005
|
+
hs_code?: (string | null) | undefined;
|
|
1006
|
+
medium?: (string | null) | undefined;
|
|
1007
|
+
temporary_admission?: (boolean | null) | undefined;
|
|
1008
|
+
} | null) | undefined;
|
|
1009
|
+
details?: ({
|
|
1010
|
+
creation_date?: (string | null) | undefined;
|
|
1011
|
+
creator?: (string | null) | undefined;
|
|
1012
|
+
notes?: (string | null) | undefined;
|
|
1013
|
+
title?: (string | null) | undefined;
|
|
1014
|
+
} | null) | undefined;
|
|
1015
|
+
internal_reference?: (string | null) | undefined;
|
|
1016
|
+
public_reference?: (string | null) | undefined;
|
|
1017
|
+
type: "accessories" | "armoire_dresser" | "bedframe" | "beer_barrel" | "beer_bottle" | "beer_case" | "book" | "bookcase_storage" | "bowl" | "bracelet" | "brooch" | "bus" | "camera_electrical" | "candelabra_candlestick" | "car" | "carpet_rug" | "carriage" | "ceramic" | "chair" | "chandelier" | "clock" | "clothing" | "coin" | "collectible_apparel" | "cufflinks" | "decoy" | "desk_vanity" | "dinnerware" | "document_manuscript" | "earrings" | "eyeglasses" | "figurine_doll" | "firearm_weapon" | "flatware" | "floor_lamp" | "floor_lamp_shade" | "folding_screen" | "footwear" | "fossil" | "glass_sculpture" | "glassware" | "handbag" | "headboard" | "hunting_fishing" | "lighting_fixture" | "limousine" | "media_console" | "medical_equipment" | "memorabilia" | "mineral" | "miniature_model" | "mirror" | "mixed_media_framed" | "mixed_media_framed_glass" | "mixed_media_framed_plexi" | "mixed_media_unframed" | "motorcycle" | "musical_instrument" | "necklace" | "neon" | "neon_sign" | "new_media" | "nightstand" | "object_of_vertu" | "other" | "other_alcohols" | "other_art" | "other_automotive" | "other_collectibles" | "other_decorative_arts" | "other_fashion" | "other_furniture" | "other_jewelry" | "ottoman" | "painting_framed" | "painting_framed_glass" | "painting_framed_plexi" | "painting_unframed" | "pedestal" | "pedestal_case_glass" | "pedestal_case_plexi" | "photograph_framed" | "photograph_framed_glass" | "photograph_framed_plexi" | "photograph_unframed" | "plaque" | "porcelain_bowl" | "porcelain_plate" | "precious_stones" | "ring" | "sconce" | "sculpture" | "serveware" | "set" | "sidecar" | "snuff_box_cigarette_case" | "sofa_loveseat_chaise" | "spirits_barrel" | "spirits_bottle" | "spirits_case" | "stamp" | "table" | "table_lamp" | "table_lamp_shade" | "tabletop_accessory" | "tapestry" | "toy" | "trading_card" | "trailer" | "van" | "vase_vessel" | "watch" | "wine_barrel" | "wine_bottle" | "wine_case" | "work_on_paper_framed" | "work_on_paper_framed_glass" | "work_on_paper_framed_plexi" | "work_on_paper_unframed";
|
|
1018
|
+
value: number | string;
|
|
1019
|
+
value_currency?: (("CAD" | "CHF" | "EUR" | "GBP" | "HKD" | "USD") | null) | undefined;
|
|
1020
|
+
}[] | null) | undefined;
|
|
1021
|
+
}[];
|
|
1022
|
+
origin?: ({
|
|
1023
|
+
access_restrictions?: (("elevator_only" | "freight_elevator" | "loading_dock" | "loading_dock_low" | "low_clearance" | "non_paved" | "stairs_only" | "steep_gradient")[] | null) | undefined;
|
|
1024
|
+
address_line_1?: (string | null) | undefined;
|
|
1025
|
+
address_line_2?: (string | null) | undefined;
|
|
1026
|
+
address_line_3?: (string | null) | undefined;
|
|
1027
|
+
city?: (string | null) | undefined;
|
|
1028
|
+
region?: (string | null) | undefined;
|
|
1029
|
+
postal_code?: (string | null) | undefined;
|
|
1030
|
+
country: string;
|
|
1031
|
+
title?: (string | null) | undefined;
|
|
1032
|
+
contacts?: ({
|
|
1033
|
+
name: string;
|
|
1034
|
+
email_address?: (string | null) | undefined;
|
|
1035
|
+
phone_number?: (string | null) | undefined;
|
|
1036
|
+
}[] | null) | undefined;
|
|
1037
|
+
estimated_country?: string | undefined;
|
|
1038
|
+
estimated_region?: string | undefined;
|
|
1039
|
+
estimated_city?: string | undefined;
|
|
1040
|
+
} | null) | undefined;
|
|
1041
|
+
preferred_parcel_transport_services?: (("economy" | "economy_freight" | "ground" | "next_day_air" | "priority" | "priority_freight" | "second_day_air" | "standard" | "three_day")[] | null) | undefined;
|
|
1042
|
+
preferred_quote_types?: (("parcel" | "premium" | "select" | "self_ship")[] | null) | undefined;
|
|
1043
|
+
public_reference?: (string | null) | undefined;
|
|
1044
|
+
shipping_notes?: (string | null) | undefined;
|
|
1045
|
+
success_url?: (string | null) | undefined;
|
|
1046
|
+
payment_process: "checkout" | "checkout_direct" | "invoicing";
|
|
1047
|
+
private_token: string;
|
|
1048
|
+
shortcode: string;
|
|
1049
|
+
status: "cancelled" | "closed" | "disqualified" | "expired" | "in_progress" | "pending" | "quoted";
|
|
1050
|
+
url?: (string | null) | undefined;
|
|
1051
|
+
type?: (("booking" | "inbound_booking") | null) | undefined;
|
|
1052
|
+
can_user_confirm_object_dimensions?: (boolean | null) | undefined;
|
|
1053
|
+
public_instructions_object_details?: (string | null) | undefined;
|
|
1054
|
+
public_instructions_location_quotes?: (string | null) | undefined;
|
|
1055
|
+
public_instructions_payment?: (string | null) | undefined;
|
|
1056
|
+
public_instructions_booking_review?: (string | null) | undefined;
|
|
1057
|
+
public_instructions_confirmation?: (string | null) | undefined;
|
|
1058
|
+
quoting_strategy: "all_rates" | "best_rate" | "compare_carriers";
|
|
1059
|
+
};
|
|
1060
|
+
export type ArtaInboundObject = {
|
|
1061
|
+
internal_reference?: (string | null) | undefined;
|
|
1062
|
+
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;
|
|
1063
|
+
details?: ({
|
|
1064
|
+
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;
|
|
1065
|
+
creation_date?: (string | null) | undefined;
|
|
1066
|
+
creator?: (string | null) | undefined;
|
|
1067
|
+
notes?: (string | null) | undefined;
|
|
1068
|
+
title?: (string | null) | undefined;
|
|
1069
|
+
is_fragile?: (boolean | null) | undefined;
|
|
1070
|
+
is_cites?: (boolean | null) | undefined;
|
|
1071
|
+
} | null) | undefined;
|
|
1072
|
+
height?: ((number | string) | null) | undefined;
|
|
1073
|
+
width?: ((number | string) | null) | undefined;
|
|
1074
|
+
weight?: ((number | string) | null) | undefined;
|
|
1075
|
+
value: number | string;
|
|
1076
|
+
depth?: ((number | string) | null) | undefined;
|
|
1077
|
+
images?: (string[] | null) | undefined;
|
|
1078
|
+
public_reference?: (string | null) | undefined;
|
|
1079
|
+
subtype: "accessories" | "armoire_dresser" | "bedframe" | "beer_barrel" | "beer_bottle" | "beer_case" | "book" | "bookcase_storage" | "bowl" | "bracelet" | "brooch" | "bus" | "camera_electrical" | "candelabra_candlestick" | "car" | "carpet_rug" | "carriage" | "ceramic" | "chair" | "chandelier" | "clock" | "clothing" | "coin" | "collectible_apparel" | "cufflinks" | "decoy" | "desk_vanity" | "dinnerware" | "document_manuscript" | "earrings" | "eyeglasses" | "figurine_doll" | "firearm_weapon" | "flatware" | "floor_lamp" | "floor_lamp_shade" | "folding_screen" | "footwear" | "fossil" | "glass_sculpture" | "glassware" | "handbag" | "headboard" | "hunting_fishing" | "lighting_fixture" | "limousine" | "media_console" | "medical_equipment" | "memorabilia" | "mineral" | "miniature_model" | "mirror" | "mixed_media_framed" | "mixed_media_framed_glass" | "mixed_media_framed_plexi" | "mixed_media_unframed" | "motorcycle" | "musical_instrument" | "necklace" | "neon" | "neon_sign" | "new_media" | "nightstand" | "object_of_vertu" | "other" | "other_alcohols" | "other_art" | "other_automotive" | "other_collectibles" | "other_decorative_arts" | "other_fashion" | "other_furniture" | "other_jewelry" | "ottoman" | "painting_framed" | "painting_framed_glass" | "painting_framed_plexi" | "painting_unframed" | "pedestal" | "pedestal_case_glass" | "pedestal_case_plexi" | "photograph_framed" | "photograph_framed_glass" | "photograph_framed_plexi" | "photograph_unframed" | "plaque" | "porcelain_bowl" | "porcelain_plate" | "precious_stones" | "prepacked_box" | "ring" | "sconce" | "sculpture" | "serveware" | "set" | "sidecar" | "snuff_box_cigarette_case" | "sofa_loveseat_chaise" | "spirits_barrel" | "spirits_bottle" | "spirits_case" | "stamp" | "table" | "table_lamp" | "table_lamp_shade" | "tabletop_accessory" | "tapestry" | "toy" | "trading_card" | "trailer" | "van" | "vase_vessel" | "watch" | "wine_barrel" | "wine_bottle" | "wine_case" | "work_on_paper_framed" | "work_on_paper_framed_glass" | "work_on_paper_framed_plexi" | "work_on_paper_unframed";
|
|
1080
|
+
unit_of_measurement?: (string | null) | undefined;
|
|
1081
|
+
weight_unit?: (string | null) | undefined;
|
|
1082
|
+
value_currency: "CAD" | "CHF" | "EUR" | "GBP" | "HKD" | "USD";
|
|
1083
|
+
components?: ({
|
|
1084
|
+
customs?: ({
|
|
1085
|
+
country_of_origin?: (string | null) | undefined;
|
|
1086
|
+
hs_code?: (string | null) | undefined;
|
|
1087
|
+
medium?: (string | null) | undefined;
|
|
1088
|
+
temporary_admission?: (boolean | null) | undefined;
|
|
1089
|
+
} | null) | undefined;
|
|
1090
|
+
details?: ({
|
|
1091
|
+
creation_date?: (string | null) | undefined;
|
|
1092
|
+
creator?: (string | null) | undefined;
|
|
1093
|
+
notes?: (string | null) | undefined;
|
|
1094
|
+
title?: (string | null) | undefined;
|
|
1095
|
+
} | null) | undefined;
|
|
1096
|
+
internal_reference?: (string | null) | undefined;
|
|
1097
|
+
public_reference?: (string | null) | undefined;
|
|
1098
|
+
type: "accessories" | "armoire_dresser" | "bedframe" | "beer_barrel" | "beer_bottle" | "beer_case" | "book" | "bookcase_storage" | "bowl" | "bracelet" | "brooch" | "bus" | "camera_electrical" | "candelabra_candlestick" | "car" | "carpet_rug" | "carriage" | "ceramic" | "chair" | "chandelier" | "clock" | "clothing" | "coin" | "collectible_apparel" | "cufflinks" | "decoy" | "desk_vanity" | "dinnerware" | "document_manuscript" | "earrings" | "eyeglasses" | "figurine_doll" | "firearm_weapon" | "flatware" | "floor_lamp" | "floor_lamp_shade" | "folding_screen" | "footwear" | "fossil" | "glass_sculpture" | "glassware" | "handbag" | "headboard" | "hunting_fishing" | "lighting_fixture" | "limousine" | "media_console" | "medical_equipment" | "memorabilia" | "mineral" | "miniature_model" | "mirror" | "mixed_media_framed" | "mixed_media_framed_glass" | "mixed_media_framed_plexi" | "mixed_media_unframed" | "motorcycle" | "musical_instrument" | "necklace" | "neon" | "neon_sign" | "new_media" | "nightstand" | "object_of_vertu" | "other" | "other_alcohols" | "other_art" | "other_automotive" | "other_collectibles" | "other_decorative_arts" | "other_fashion" | "other_furniture" | "other_jewelry" | "ottoman" | "painting_framed" | "painting_framed_glass" | "painting_framed_plexi" | "painting_unframed" | "pedestal" | "pedestal_case_glass" | "pedestal_case_plexi" | "photograph_framed" | "photograph_framed_glass" | "photograph_framed_plexi" | "photograph_unframed" | "plaque" | "porcelain_bowl" | "porcelain_plate" | "precious_stones" | "ring" | "sconce" | "sculpture" | "serveware" | "set" | "sidecar" | "snuff_box_cigarette_case" | "sofa_loveseat_chaise" | "spirits_barrel" | "spirits_bottle" | "spirits_case" | "stamp" | "table" | "table_lamp" | "table_lamp_shade" | "tabletop_accessory" | "tapestry" | "toy" | "trading_card" | "trailer" | "van" | "vase_vessel" | "watch" | "wine_barrel" | "wine_bottle" | "wine_case" | "work_on_paper_framed" | "work_on_paper_framed_glass" | "work_on_paper_framed_plexi" | "work_on_paper_unframed";
|
|
1099
|
+
value: number | string;
|
|
1100
|
+
value_currency?: (("CAD" | "CHF" | "EUR" | "GBP" | "HKD" | "USD") | null) | undefined;
|
|
1101
|
+
}[] | null) | undefined;
|
|
1102
|
+
};
|
|
1103
|
+
export type AddressVerification = {
|
|
1104
|
+
updated_at: Date;
|
|
1105
|
+
created_at: Date;
|
|
1106
|
+
id: string;
|
|
1107
|
+
shortcode: string;
|
|
1108
|
+
status: "success" | "partial" | "failed";
|
|
1109
|
+
match_level: "delivery_point" | "premise" | "thoroughfare" | "locality" | "administrative_area" | "none";
|
|
1110
|
+
reference: string | null;
|
|
1111
|
+
input: {
|
|
1112
|
+
address_line_1: string;
|
|
1113
|
+
address_line_2: string | null;
|
|
1114
|
+
address_line_3: string | null;
|
|
1115
|
+
city: string | null;
|
|
1116
|
+
region: string | null;
|
|
1117
|
+
postal_code: string | null;
|
|
1118
|
+
country: string;
|
|
1119
|
+
};
|
|
1120
|
+
recommendation: {
|
|
1121
|
+
address_line_1: string | null;
|
|
1122
|
+
address_line_2: string | null;
|
|
1123
|
+
address_line_3: string | null;
|
|
1124
|
+
city: string | null;
|
|
1125
|
+
region: string | null;
|
|
1126
|
+
postal_code: string | null;
|
|
1127
|
+
country: string | null;
|
|
1128
|
+
latitude: number | null;
|
|
1129
|
+
longitude: number | null;
|
|
1130
|
+
is_residential: boolean | null;
|
|
1131
|
+
};
|
|
1132
|
+
};
|
package/dist/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@artaio/node-api",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.7.0",
|
|
4
4
|
"description": "The Arta Node library provides a seamless integration to Arta API for backend applications using both Typescript or Javascript.",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "npm run build:types && tsc -p tsconfig-build.json",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@artaio/node-api",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.7.0",
|
|
4
4
|
"description": "The Arta Node library provides a seamless integration to Arta API for backend applications using both Typescript or Javascript.",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "npm run build:types && tsc -p tsconfig-build.json",
|