@shipengine/js-api 0.0.3

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 (54) hide show
  1. package/account-settings/api.d.ts +8 -0
  2. package/account-settings/index.d.ts +2 -0
  3. package/account-settings/types.d.ts +8 -0
  4. package/addresses/api.d.ts +8 -0
  5. package/addresses/index.d.ts +2 -0
  6. package/addresses/types.d.ts +94 -0
  7. package/carriers/api.d.ts +17 -0
  8. package/carriers/index.d.ts +2 -0
  9. package/carriers/types.d.ts +109 -0
  10. package/client.d.ts +34 -0
  11. package/custom-packages/api.d.ts +9 -0
  12. package/custom-packages/index.d.ts +2 -0
  13. package/custom-packages/types.d.ts +11 -0
  14. package/dimensions/index.d.ts +1 -0
  15. package/dimensions/types.d.ts +18 -0
  16. package/errors/index.d.ts +2 -0
  17. package/errors/types.d.ts +27 -0
  18. package/errors/utils.d.ts +3 -0
  19. package/index.d.ts +2 -0
  20. package/index.js +16 -0
  21. package/index.mjs +2913 -0
  22. package/insurance/api.d.ts +7 -0
  23. package/insurance/index.d.ts +2 -0
  24. package/insurance/types.d.ts +9 -0
  25. package/labels/api.d.ts +22 -0
  26. package/labels/index.d.ts +2 -0
  27. package/labels/types.d.ts +65 -0
  28. package/order-sources/api.d.ts +11 -0
  29. package/order-sources/index.d.ts +2 -0
  30. package/order-sources/types.d.ts +23 -0
  31. package/package.json +18 -0
  32. package/payments/index.d.ts +1 -0
  33. package/payments/types.d.ts +37 -0
  34. package/rates/api.d.ts +20 -0
  35. package/rates/index.d.ts +2 -0
  36. package/rates/types.d.ts +52 -0
  37. package/relay-points/index.d.ts +1 -0
  38. package/relay-points/types.d.ts +12 -0
  39. package/resources/index.d.ts +1 -0
  40. package/resources/types.d.ts +16 -0
  41. package/sales-order-shipments/api.d.ts +15 -0
  42. package/sales-order-shipments/index.d.ts +2 -0
  43. package/sales-order-shipments/types.d.ts +16 -0
  44. package/sales-orders/api.d.ts +15 -0
  45. package/sales-orders/index.d.ts +2 -0
  46. package/sales-orders/types.d.ts +78 -0
  47. package/shipments/index.d.ts +1 -0
  48. package/shipments/types.d.ts +195 -0
  49. package/types.d.ts +18 -0
  50. package/warehouses/api.d.ts +12 -0
  51. package/warehouses/index.d.ts +2 -0
  52. package/warehouses/types.d.ts +12 -0
  53. package/weight/index.d.ts +1 -0
  54. package/weight/types.d.ts +23 -0
package/types.d.ts ADDED
@@ -0,0 +1,18 @@
1
+ export * from "./account-settings/types";
2
+ export * from "./addresses/types";
3
+ export * from "./carriers/types";
4
+ export * from "./custom-packages/types";
5
+ export * from "./dimensions/types";
6
+ export * from "./errors/types";
7
+ export * from "./insurance/types";
8
+ export * from "./labels/types";
9
+ export * from "./order-sources/types";
10
+ export * from "./payments/types";
11
+ export * from "./rates/types";
12
+ export * from "./relay-points/types";
13
+ export * from "./resources/types";
14
+ export * from "./sales-order-shipments/types";
15
+ export * from "./sales-orders/types";
16
+ export * from "./shipments/types";
17
+ export * from "./warehouses/types";
18
+ export * from "./weight/types";
@@ -0,0 +1,12 @@
1
+ import { AxiosInstance } from "axios";
2
+ import { Warehouse } from "./types";
3
+ export declare class WarehousesAPI {
4
+ private client;
5
+ constructor(client: AxiosInstance);
6
+ list: () => Promise<import("axios").AxiosResponse<{
7
+ warehouses: Warehouse[];
8
+ }, any>>;
9
+ create: (warehouse: Partial<Warehouse>) => Promise<import("axios").AxiosResponse<Warehouse, any>>;
10
+ update: (warehouseId: string, warehouse: Partial<Warehouse>) => Promise<import("axios").AxiosResponse<void, any>>;
11
+ delete: (warehouseId: string) => Promise<import("axios").AxiosResponse<void, any>>;
12
+ }
@@ -0,0 +1,2 @@
1
+ export * from "./api";
2
+ export * from "./types";
@@ -0,0 +1,12 @@
1
+ import { Address } from "../addresses";
2
+ /**
3
+ * @category Entities
4
+ */
5
+ export interface Warehouse {
6
+ createdAt: string;
7
+ isDefault: boolean;
8
+ name: string;
9
+ originAddress: Address;
10
+ returnAddress: Address;
11
+ warehouseId: string;
12
+ }
@@ -0,0 +1 @@
1
+ export * from "./types";
@@ -0,0 +1,23 @@
1
+ /**
2
+ * @category Entities
3
+ */
4
+ export type WeightUnit = "pound" | "ounce" | "gram" | "kilogram";
5
+ /**
6
+ * @category Entities
7
+ */
8
+ export interface FractionalWeight {
9
+ fractional: number;
10
+ whole: number;
11
+ }
12
+ /**
13
+ * @category Entities
14
+ */
15
+ export interface Weight {
16
+ value: number;
17
+ }
18
+ /**
19
+ * @category Entities
20
+ */
21
+ export type WeightWithUnit = Weight & {
22
+ unit: WeightUnit;
23
+ };