@shipengine/js-api 0.22.1 → 0.24.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/errors/types.d.ts CHANGED
@@ -1,11 +1,11 @@
1
1
  /**
2
2
  * @category Entities
3
3
  */
4
- export type CodedErrorCode = "auto_fund_not_supported" | "batch_cannot_be_modified" | "carrier_conflict" | "carrier_disconnected" | "carrier_not_connected" | "carrier_not_supported" | "confirmation_not_supported" | "default_warehouse_cannot_be_deleted" | "field_conflict" | "field_value_required" | "forbidden" | "identifier_conflict" | "identifiers_must_match" | "insufficient_funds" | "invalid_address" | "invalid_billing_plan" | "invalid_field_value" | "invalid_identifier" | "invalid_status" | "invalid_string_length" | "label_images_not_supported" | "meter_failure" | "order_source_not_active" | "rate_limit_exceeded" | "refresh_not_supported" | "request_body_required" | "return_label_not_supported" | "settings_not_supported" | "subscription_inactive" | "terms_not_accepted" | "tracking_not_supported" | "trial_expired" | "unauthorized" | "unknown" | "unspecified" | "verification_failure" | "warehouse_conflict" | "webhook_event_type_conflict";
4
+ export type CodedErrorCode = "auto_fund_not_supported" | "batch_cannot_be_modified" | "carrier_conflict" | "carrier_disconnected" | "carrier_not_connected" | "carrier_not_supported" | "confirmation_not_supported" | "default_warehouse_cannot_be_deleted" | "duplicated_rate_card" | "empty_file" | "field_conflict" | "field_value_required" | "forbidden" | "identifier_conflict" | "identifiers_must_match" | "insufficient_funds" | "insufficient_rate_card_data" | "invalid_address" | "invalid_billing_plan" | "invalid_field_value" | "invalid_file_type" | "invalid_identifier" | "invalid_status" | "invalid_string_length" | "invalid_zones" | "invalid_packages" | "invalid_weight_bands" | "invalid_rates" | "label_images_not_supported" | "meter_failure" | "not_found" | "order_source_not_active" | "rate_limit_exceeded" | "refresh_not_supported" | "request_body_required" | "return_label_not_supported" | "settings_not_supported" | "subscription_inactive" | "terms_not_accepted" | "tracking_not_supported" | "trial_expired" | "unauthorized" | "unknown" | "unspecified" | "verification_failure" | "warehouse_conflict" | "webhook_event_type_conflict";
5
5
  /**
6
6
  * @category Entities
7
7
  */
8
- export type CodedErrorSource = "carrier" | "order_source" | "shipengine" | "elements" | "client";
8
+ export type CodedErrorSource = "carrier" | "order_source" | "shipengine" | "elements" | "client" | "rate_card_manager";
9
9
  /**
10
10
  * @category Entities
11
11
  */
@@ -1,5 +1,6 @@
1
1
  import { AxiosInstance } from "axios";
2
- import { CarrierRegistration, CarrierRegistrationResponse, CreateFundingSource, CreditCardInfo, FundingSource, FundingSourceAddress } from "./types";
2
+ import { Money } from "../payments";
3
+ import { AddFundsResponse, CarrierRegistration, CarrierRegistrationResponse, CreateFundingSource, CreditCardInfo, FundingSource, FundingSourceAddress } from "./types";
3
4
  export declare class FundingSourcesAPI {
4
5
  private client;
5
6
  constructor(client: AxiosInstance);
@@ -14,4 +15,5 @@ export declare class FundingSourcesAPI {
14
15
  fundingSource: FundingSource;
15
16
  }, any>>;
16
17
  registerCarrier: (carrier: CarrierRegistration) => Promise<import("axios").AxiosResponse<CarrierRegistrationResponse, any>>;
18
+ addFunds: (amount: Money, fundingSourceId: string) => Promise<import("axios").AxiosResponse<AddFundsResponse, any>>;
17
19
  }
@@ -1,7 +1,19 @@
1
+ export type AddFundsResponse = {
2
+ balance: {
3
+ amount: number;
4
+ currency: string;
5
+ };
6
+ };
7
+ /**
8
+ * An encoded device fingerprint string containing information about the end-user's computing device such as OS, browser, etc.
9
+ * Required for carrier registration and US Wallet creation.
10
+ */
11
+ type IovationBlackBox = string;
1
12
  export type CreateFundingSource = {
2
13
  acceptedTerms: Term[];
3
14
  agreeToTerms: boolean;
4
15
  billingInfo: FundingSourceAddress;
16
+ iovationBlackBox: IovationBlackBox;
5
17
  paymentMethod: {
6
18
  creditCardInfo: CreditCardInfo;
7
19
  };
@@ -25,6 +37,7 @@ export interface CarrierRegistration {
25
37
  agreeToTerms: boolean;
26
38
  carrierCode: "stamps_com" | "ups_walleted" | "dhl_express_worldwide";
27
39
  fundingSourceId: string;
40
+ iovationBlackBox: IovationBlackBox;
28
41
  pickupAddress?: FundingSourceAddress;
29
42
  }
30
43
  ];
@@ -64,3 +77,4 @@ export interface CarrierRegistrationResponse {
64
77
  }
65
78
  ];
66
79
  }
80
+ export {};
package/index.js CHANGED
@@ -3231,6 +3231,12 @@ class FundingSourcesAPI {
3231
3231
  endUserIpAddress
3232
3232
  }, carrier));
3233
3233
  });
3234
+ this.addFunds = (amount, fundingSourceId) => __async$2(this, null, function* () {
3235
+ return yield this.client.put(
3236
+ `/v1/funding_sources/${fundingSourceId}/add_funds`,
3237
+ amount
3238
+ );
3239
+ });
3234
3240
  this.client = client;
3235
3241
  }
3236
3242
  }
@@ -3305,6 +3311,15 @@ class RateCardsAPI {
3305
3311
  responseType: "blob"
3306
3312
  });
3307
3313
  };
3314
+ this.upload = (rateCardId, file) => {
3315
+ const formData = new FormData();
3316
+ formData.append("file", file);
3317
+ return this.client.put(`/v1/rate_cards/${rateCardId}/rates/upload`, formData, {
3318
+ headers: {
3319
+ ContentType: "multipart/form-data"
3320
+ }
3321
+ });
3322
+ };
3308
3323
  this.client = client;
3309
3324
  }
3310
3325
  }
package/index.mjs CHANGED
@@ -3227,6 +3227,12 @@ class FundingSourcesAPI {
3227
3227
  endUserIpAddress
3228
3228
  }, carrier));
3229
3229
  });
3230
+ this.addFunds = (amount, fundingSourceId) => __async$2(this, null, function* () {
3231
+ return yield this.client.put(
3232
+ `/v1/funding_sources/${fundingSourceId}/add_funds`,
3233
+ amount
3234
+ );
3235
+ });
3230
3236
  this.client = client;
3231
3237
  }
3232
3238
  }
@@ -3301,6 +3307,15 @@ class RateCardsAPI {
3301
3307
  responseType: "blob"
3302
3308
  });
3303
3309
  };
3310
+ this.upload = (rateCardId, file) => {
3311
+ const formData = new FormData();
3312
+ formData.append("file", file);
3313
+ return this.client.put(`/v1/rate_cards/${rateCardId}/rates/upload`, formData, {
3314
+ headers: {
3315
+ ContentType: "multipart/form-data"
3316
+ }
3317
+ });
3318
+ };
3304
3319
  this.client = client;
3305
3320
  }
3306
3321
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shipengine/js-api",
3
- "version": "0.22.1",
3
+ "version": "0.24.0",
4
4
  "main": "./index.js",
5
5
  "types": "./index.d.ts",
6
6
  "exports": {
@@ -10,4 +10,5 @@ export declare class RateCardsAPI {
10
10
  create: (rateCardInput: RateCardInput) => Promise<import("axios").AxiosResponse<RateCard, any>>;
11
11
  update: (rateCard: RateCard) => Promise<import("axios").AxiosResponse<RateCard, any>>;
12
12
  download: (rateCardId: string) => Promise<import("axios").AxiosResponse<Blob, any>>;
13
+ upload: (rateCardId: string, file: File) => Promise<import("axios").AxiosResponse<any, any>>;
13
14
  }