@beach-depository/sdk 0.0.3 → 0.0.5

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 (110) hide show
  1. package/dist/cjs/Client.d.ts +0 -3
  2. package/dist/cjs/Client.js +10 -15
  3. package/dist/cjs/api/resources/index.d.ts +0 -3
  4. package/dist/cjs/api/resources/index.js +1 -4
  5. package/dist/cjs/api/resources/outboundShipments/client/Client.d.ts +34 -1
  6. package/dist/cjs/api/resources/outboundShipments/client/Client.js +116 -0
  7. package/dist/cjs/api/resources/{outboundRequests/client/requests/CancelOutboundRequestsRequest.d.ts → outboundShipments/client/requests/CancelOutboundShipmentsRequest.d.ts} +1 -1
  8. package/dist/cjs/api/resources/{outboundRequests/client/requests/CreateOutboundRequestsRequest.d.ts → outboundShipments/client/requests/CreateOutboundShipmentsRequest.d.ts} +5 -5
  9. package/dist/cjs/api/resources/{outboundRequests/client/requests/CreateOutboundRequestsRequest.js → outboundShipments/client/requests/CreateOutboundShipmentsRequest.js} +5 -5
  10. package/dist/cjs/api/resources/outboundShipments/client/requests/index.d.ts +2 -0
  11. package/dist/cjs/api/resources/outboundShipments/client/requests/index.js +3 -0
  12. package/dist/cjs/api/resources/{outboundRequests/types/GetOutboundRequestsResponse.d.ts → outboundShipments/types/CancelOutboundShipmentsResponse.d.ts} +21 -8
  13. package/dist/cjs/api/resources/outboundShipments/types/CancelOutboundShipmentsResponse.js +18 -0
  14. package/dist/{esm/api/resources/outboundRequests/types/CancelOutboundRequestsResponse.d.mts → cjs/api/resources/outboundShipments/types/CreateOutboundShipmentsResponse.d.ts} +21 -8
  15. package/dist/cjs/api/resources/outboundShipments/types/CreateOutboundShipmentsResponse.js +18 -0
  16. package/dist/cjs/api/resources/outboundShipments/types/GetOutboundShipmentsResponse.d.ts +20 -10
  17. package/dist/cjs/api/resources/outboundShipments/types/GetOutboundShipmentsResponse.js +3 -0
  18. package/dist/cjs/api/resources/outboundShipments/types/ListOutboundShipmentsRequestStatus.d.ts +3 -0
  19. package/dist/cjs/api/resources/outboundShipments/types/ListOutboundShipmentsRequestStatus.js +3 -0
  20. package/dist/cjs/api/resources/outboundShipments/types/ListOutboundShipmentsResponse.d.ts +20 -10
  21. package/dist/cjs/api/resources/outboundShipments/types/ListOutboundShipmentsResponse.js +3 -0
  22. package/dist/cjs/api/resources/outboundShipments/types/index.d.ts +2 -0
  23. package/dist/cjs/api/resources/outboundShipments/types/index.js +2 -0
  24. package/dist/cjs/api/types/index.d.ts +0 -1
  25. package/dist/cjs/api/types/index.js +0 -1
  26. package/dist/cjs/version.d.ts +1 -1
  27. package/dist/cjs/version.js +1 -1
  28. package/dist/esm/Client.d.mts +0 -3
  29. package/dist/esm/Client.mjs +0 -5
  30. package/dist/esm/api/resources/index.d.mts +0 -3
  31. package/dist/esm/api/resources/index.mjs +0 -3
  32. package/dist/esm/api/resources/outboundShipments/client/Client.d.mts +34 -1
  33. package/dist/esm/api/resources/outboundShipments/client/Client.mjs +117 -1
  34. package/dist/esm/api/resources/{outboundRequests/client/requests/CancelOutboundRequestsRequest.d.mts → outboundShipments/client/requests/CancelOutboundShipmentsRequest.d.mts} +1 -1
  35. package/dist/esm/api/resources/{outboundRequests/client/requests/CreateOutboundRequestsRequest.d.mts → outboundShipments/client/requests/CreateOutboundShipmentsRequest.d.mts} +5 -5
  36. package/dist/esm/api/resources/{outboundRequests/client/requests/CreateOutboundRequestsRequest.mjs → outboundShipments/client/requests/CreateOutboundShipmentsRequest.mjs} +4 -4
  37. package/dist/esm/api/resources/outboundShipments/client/requests/index.d.mts +2 -0
  38. package/dist/esm/api/resources/outboundShipments/client/requests/index.mjs +1 -1
  39. package/dist/{cjs/api/resources/outboundRequests/types/CancelOutboundRequestsResponse.d.ts → esm/api/resources/outboundShipments/types/CancelOutboundShipmentsResponse.d.mts} +21 -8
  40. package/dist/esm/api/resources/outboundShipments/types/CancelOutboundShipmentsResponse.mjs +15 -0
  41. package/dist/{cjs/api/resources/outboundRequests/types/CreateOutboundRequestsResponse.d.ts → esm/api/resources/outboundShipments/types/CreateOutboundShipmentsResponse.d.mts} +21 -8
  42. package/dist/esm/api/resources/outboundShipments/types/CreateOutboundShipmentsResponse.mjs +15 -0
  43. package/dist/esm/api/resources/outboundShipments/types/GetOutboundShipmentsResponse.d.mts +20 -10
  44. package/dist/esm/api/resources/outboundShipments/types/GetOutboundShipmentsResponse.mjs +3 -0
  45. package/dist/esm/api/resources/outboundShipments/types/ListOutboundShipmentsRequestStatus.d.mts +3 -0
  46. package/dist/esm/api/resources/outboundShipments/types/ListOutboundShipmentsRequestStatus.mjs +3 -0
  47. package/dist/esm/api/resources/outboundShipments/types/ListOutboundShipmentsResponse.d.mts +20 -10
  48. package/dist/esm/api/resources/outboundShipments/types/ListOutboundShipmentsResponse.mjs +3 -0
  49. package/dist/esm/api/resources/outboundShipments/types/index.d.mts +2 -0
  50. package/dist/esm/api/resources/outboundShipments/types/index.mjs +2 -0
  51. package/dist/esm/api/types/index.d.mts +0 -1
  52. package/dist/esm/api/types/index.mjs +0 -1
  53. package/dist/esm/version.d.mts +1 -1
  54. package/dist/esm/version.mjs +1 -1
  55. package/package.json +1 -12
  56. package/reference.md +0 -206
  57. package/dist/cjs/api/resources/outboundRequests/client/Client.d.ts +0 -72
  58. package/dist/cjs/api/resources/outboundRequests/client/Client.js +0 -283
  59. package/dist/cjs/api/resources/outboundRequests/client/index.d.ts +0 -1
  60. package/dist/cjs/api/resources/outboundRequests/client/index.js +0 -17
  61. package/dist/cjs/api/resources/outboundRequests/client/requests/GetOutboundRequestsRequest.d.ts +0 -9
  62. package/dist/cjs/api/resources/outboundRequests/client/requests/GetOutboundRequestsRequest.js +0 -3
  63. package/dist/cjs/api/resources/outboundRequests/client/requests/ListOutboundRequestsRequest.d.ts +0 -12
  64. package/dist/cjs/api/resources/outboundRequests/client/requests/ListOutboundRequestsRequest.js +0 -3
  65. package/dist/cjs/api/resources/outboundRequests/client/requests/index.d.ts +0 -4
  66. package/dist/cjs/api/resources/outboundRequests/client/requests/index.js +0 -5
  67. package/dist/cjs/api/resources/outboundRequests/exports.d.ts +0 -2
  68. package/dist/cjs/api/resources/outboundRequests/exports.js +0 -21
  69. package/dist/cjs/api/resources/outboundRequests/index.d.ts +0 -2
  70. package/dist/cjs/api/resources/outboundRequests/index.js +0 -18
  71. package/dist/cjs/api/resources/outboundRequests/types/CancelOutboundRequestsResponse.js +0 -17
  72. package/dist/cjs/api/resources/outboundRequests/types/CreateOutboundRequestsResponse.js +0 -17
  73. package/dist/cjs/api/resources/outboundRequests/types/GetOutboundRequestsResponse.js +0 -17
  74. package/dist/cjs/api/resources/outboundRequests/types/ListOutboundRequestsRequestStatus.d.ts +0 -8
  75. package/dist/cjs/api/resources/outboundRequests/types/ListOutboundRequestsRequestStatus.js +0 -11
  76. package/dist/cjs/api/resources/outboundRequests/types/ListOutboundRequestsResponse.d.ts +0 -73
  77. package/dist/cjs/api/resources/outboundRequests/types/ListOutboundRequestsResponse.js +0 -20
  78. package/dist/cjs/api/resources/outboundRequests/types/index.d.ts +0 -5
  79. package/dist/cjs/api/resources/outboundRequests/types/index.js +0 -21
  80. package/dist/cjs/api/types/ListOutboundRequestsRequestIncludeLineItems.d.ts +0 -1
  81. package/dist/cjs/api/types/ListOutboundRequestsRequestIncludeLineItems.js +0 -3
  82. package/dist/esm/api/resources/outboundRequests/client/Client.d.mts +0 -72
  83. package/dist/esm/api/resources/outboundRequests/client/Client.mjs +0 -246
  84. package/dist/esm/api/resources/outboundRequests/client/index.d.mts +0 -1
  85. package/dist/esm/api/resources/outboundRequests/client/index.mjs +0 -1
  86. package/dist/esm/api/resources/outboundRequests/client/requests/GetOutboundRequestsRequest.d.mts +0 -9
  87. package/dist/esm/api/resources/outboundRequests/client/requests/GetOutboundRequestsRequest.mjs +0 -2
  88. package/dist/esm/api/resources/outboundRequests/client/requests/ListOutboundRequestsRequest.d.mts +0 -12
  89. package/dist/esm/api/resources/outboundRequests/client/requests/ListOutboundRequestsRequest.mjs +0 -2
  90. package/dist/esm/api/resources/outboundRequests/client/requests/index.d.mts +0 -4
  91. package/dist/esm/api/resources/outboundRequests/client/requests/index.mjs +0 -1
  92. package/dist/esm/api/resources/outboundRequests/exports.d.mts +0 -2
  93. package/dist/esm/api/resources/outboundRequests/exports.mjs +0 -3
  94. package/dist/esm/api/resources/outboundRequests/index.d.mts +0 -2
  95. package/dist/esm/api/resources/outboundRequests/index.mjs +0 -2
  96. package/dist/esm/api/resources/outboundRequests/types/CancelOutboundRequestsResponse.mjs +0 -14
  97. package/dist/esm/api/resources/outboundRequests/types/CreateOutboundRequestsResponse.d.mts +0 -65
  98. package/dist/esm/api/resources/outboundRequests/types/CreateOutboundRequestsResponse.mjs +0 -14
  99. package/dist/esm/api/resources/outboundRequests/types/GetOutboundRequestsResponse.d.mts +0 -65
  100. package/dist/esm/api/resources/outboundRequests/types/GetOutboundRequestsResponse.mjs +0 -14
  101. package/dist/esm/api/resources/outboundRequests/types/ListOutboundRequestsRequestStatus.d.mts +0 -8
  102. package/dist/esm/api/resources/outboundRequests/types/ListOutboundRequestsRequestStatus.mjs +0 -8
  103. package/dist/esm/api/resources/outboundRequests/types/ListOutboundRequestsResponse.d.mts +0 -73
  104. package/dist/esm/api/resources/outboundRequests/types/ListOutboundRequestsResponse.mjs +0 -17
  105. package/dist/esm/api/resources/outboundRequests/types/index.d.mts +0 -5
  106. package/dist/esm/api/resources/outboundRequests/types/index.mjs +0 -5
  107. package/dist/esm/api/types/ListOutboundRequestsRequestIncludeLineItems.d.mts +0 -1
  108. package/dist/esm/api/types/ListOutboundRequestsRequestIncludeLineItems.mjs +0 -2
  109. /package/dist/cjs/api/resources/{outboundRequests/client/requests/CancelOutboundRequestsRequest.js → outboundShipments/client/requests/CancelOutboundShipmentsRequest.js} +0 -0
  110. /package/dist/esm/api/resources/{outboundRequests/client/requests/CancelOutboundRequestsRequest.mjs → outboundShipments/client/requests/CancelOutboundShipmentsRequest.mjs} +0 -0
@@ -10,22 +10,24 @@ export declare namespace ListOutboundShipmentsResponse {
10
10
  fboAccountId: string;
11
11
  organizationId: string;
12
12
  status: Item.Status;
13
- carrier?: string | undefined;
14
- trackingNumber?: string | undefined;
15
- trackingUrl?: string | undefined;
13
+ totalItems: number;
14
+ notes?: string | undefined;
16
15
  destinationAddress?: Item.DestinationAddress | undefined;
17
16
  shipping?: Item.Shipping | undefined;
18
- approvedAt?: string | undefined;
19
- pickedUpAt?: string | undefined;
20
- shippedAt?: string | undefined;
17
+ packages: Item.Packages.Item[];
21
18
  items?: Item.Items.Item[] | undefined;
19
+ shippedAt?: (string | null) | undefined;
20
+ deliveredAt?: (string | null) | undefined;
22
21
  createdAt: string;
23
22
  }
24
23
  namespace Item {
25
24
  const Status: {
25
+ readonly Created: "created";
26
26
  readonly Processing: "processing";
27
27
  readonly Shipped: "shipped";
28
28
  readonly Delivered: "delivered";
29
+ readonly Rejected: "rejected";
30
+ readonly Cancelled: "cancelled";
29
31
  };
30
32
  type Status = (typeof Status)[keyof typeof Status];
31
33
  interface DestinationAddress {
@@ -54,16 +56,24 @@ export declare namespace ListOutboundShipmentsResponse {
54
56
  weightGrams?: number | undefined;
55
57
  }
56
58
  }
59
+ type Packages = Packages.Item[];
60
+ namespace Packages {
61
+ interface Item {
62
+ carrier: string | null;
63
+ trackingNumber: string | null;
64
+ trackingUrl: string | null;
65
+ shippedAt: string | null;
66
+ deliveredAt: string | null;
67
+ inventoryItemIds: string[];
68
+ }
69
+ }
57
70
  type Items = Items.Item[];
58
71
  namespace Items {
59
72
  interface Item {
60
73
  id: string;
61
74
  outboundShipmentId: string;
62
- inventoryItemId: string;
63
- outboundRequestItemId?: string | undefined;
64
75
  productId: string;
65
- inboundShipmentId?: string | undefined;
66
- inboundShipmentLineId?: string | undefined;
76
+ inventoryItemId: string;
67
77
  createdAt: string;
68
78
  }
69
79
  }
@@ -9,9 +9,12 @@ var ListOutboundShipmentsResponse;
9
9
  let Item;
10
10
  (function (Item) {
11
11
  Item.Status = {
12
+ Created: "created",
12
13
  Processing: "processing",
13
14
  Shipped: "shipped",
14
15
  Delivered: "delivered",
16
+ Rejected: "rejected",
17
+ Cancelled: "cancelled",
15
18
  };
16
19
  })(Item = Data.Item || (Data.Item = {}));
17
20
  })(Data = ListOutboundShipmentsResponse.Data || (ListOutboundShipmentsResponse.Data = {}));
@@ -1,3 +1,5 @@
1
+ export * from "./CancelOutboundShipmentsResponse.js";
2
+ export * from "./CreateOutboundShipmentsResponse.js";
1
3
  export * from "./GetOutboundShipmentsResponse.js";
2
4
  export * from "./ListOutboundShipmentsRequestStatus.js";
3
5
  export * from "./ListOutboundShipmentsResponse.js";
@@ -14,6 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./CancelOutboundShipmentsResponse.js"), exports);
18
+ __exportStar(require("./CreateOutboundShipmentsResponse.js"), exports);
17
19
  __exportStar(require("./GetOutboundShipmentsResponse.js"), exports);
18
20
  __exportStar(require("./ListOutboundShipmentsRequestStatus.js"), exports);
19
21
  __exportStar(require("./ListOutboundShipmentsResponse.js"), exports);
@@ -1,5 +1,4 @@
1
1
  export * from "./GetInboundShipmentsRequestIncludeLineItems.js";
2
2
  export * from "./GetOutboundShipmentsRequestIncludeLineItems.js";
3
3
  export * from "./ListInboundShipmentsRequestIncludeLineItems.js";
4
- export * from "./ListOutboundRequestsRequestIncludeLineItems.js";
5
4
  export * from "./ListOutboundShipmentsRequestIncludeLineItems.js";
@@ -17,5 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./GetInboundShipmentsRequestIncludeLineItems.js"), exports);
18
18
  __exportStar(require("./GetOutboundShipmentsRequestIncludeLineItems.js"), exports);
19
19
  __exportStar(require("./ListInboundShipmentsRequestIncludeLineItems.js"), exports);
20
- __exportStar(require("./ListOutboundRequestsRequestIncludeLineItems.js"), exports);
21
20
  __exportStar(require("./ListOutboundShipmentsRequestIncludeLineItems.js"), exports);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.0.3";
1
+ export declare const SDK_VERSION = "0.0.5";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "0.0.3";
4
+ exports.SDK_VERSION = "0.0.5";
@@ -3,7 +3,6 @@ import { InboundShipmentsClient } from "./api/resources/inboundShipments/client/
3
3
  import { InventoryClient } from "./api/resources/inventory/client/Client.mjs";
4
4
  import { LabelsClient } from "./api/resources/labels/client/Client.mjs";
5
5
  import { OrganizationClient } from "./api/resources/organization/client/Client.mjs";
6
- import { OutboundRequestsClient } from "./api/resources/outboundRequests/client/Client.mjs";
7
6
  import { OutboundShipmentsClient } from "./api/resources/outboundShipments/client/Client.mjs";
8
7
  import { ProductsClient } from "./api/resources/products/client/Client.mjs";
9
8
  import { StatementsClient } from "./api/resources/statements/client/Client.mjs";
@@ -24,7 +23,6 @@ export declare class BeachApiClient {
24
23
  protected _products: ProductsClient | undefined;
25
24
  protected _inventory: InventoryClient | undefined;
26
25
  protected _inboundShipments: InboundShipmentsClient | undefined;
27
- protected _outboundRequests: OutboundRequestsClient | undefined;
28
26
  protected _outboundShipments: OutboundShipmentsClient | undefined;
29
27
  protected _transfers: TransfersClient | undefined;
30
28
  protected _statements: StatementsClient | undefined;
@@ -36,7 +34,6 @@ export declare class BeachApiClient {
36
34
  get products(): ProductsClient;
37
35
  get inventory(): InventoryClient;
38
36
  get inboundShipments(): InboundShipmentsClient;
39
- get outboundRequests(): OutboundRequestsClient;
40
37
  get outboundShipments(): OutboundShipmentsClient;
41
38
  get transfers(): TransfersClient;
42
39
  get statements(): StatementsClient;
@@ -13,7 +13,6 @@ import { InboundShipmentsClient } from "./api/resources/inboundShipments/client/
13
13
  import { InventoryClient } from "./api/resources/inventory/client/Client.mjs";
14
14
  import { LabelsClient } from "./api/resources/labels/client/Client.mjs";
15
15
  import { OrganizationClient } from "./api/resources/organization/client/Client.mjs";
16
- import { OutboundRequestsClient } from "./api/resources/outboundRequests/client/Client.mjs";
17
16
  import { OutboundShipmentsClient } from "./api/resources/outboundShipments/client/Client.mjs";
18
17
  import { ProductsClient } from "./api/resources/products/client/Client.mjs";
19
18
  import { StatementsClient } from "./api/resources/statements/client/Client.mjs";
@@ -45,10 +44,6 @@ export class BeachApiClient {
45
44
  var _a;
46
45
  return ((_a = this._inboundShipments) !== null && _a !== void 0 ? _a : (this._inboundShipments = new InboundShipmentsClient(this._options)));
47
46
  }
48
- get outboundRequests() {
49
- var _a;
50
- return ((_a = this._outboundRequests) !== null && _a !== void 0 ? _a : (this._outboundRequests = new OutboundRequestsClient(this._options)));
51
- }
52
47
  get outboundShipments() {
53
48
  var _a;
54
49
  return ((_a = this._outboundShipments) !== null && _a !== void 0 ? _a : (this._outboundShipments = new OutboundShipmentsClient(this._options)));
@@ -12,9 +12,6 @@ export * as labels from "./labels/index.mjs";
12
12
  export * from "./labels/types/index.mjs";
13
13
  export * as organization from "./organization/index.mjs";
14
14
  export * from "./organization/types/index.mjs";
15
- export * from "./outboundRequests/client/requests/index.mjs";
16
- export * as outboundRequests from "./outboundRequests/index.mjs";
17
- export * from "./outboundRequests/types/index.mjs";
18
15
  export * from "./outboundShipments/client/requests/index.mjs";
19
16
  export * as outboundShipments from "./outboundShipments/index.mjs";
20
17
  export * from "./outboundShipments/types/index.mjs";
@@ -12,9 +12,6 @@ export * as labels from "./labels/index.mjs";
12
12
  export * from "./labels/types/index.mjs";
13
13
  export * as organization from "./organization/index.mjs";
14
14
  export * from "./organization/types/index.mjs";
15
- export * from "./outboundRequests/client/requests/index.mjs";
16
- export * as outboundRequests from "./outboundRequests/index.mjs";
17
- export * from "./outboundRequests/types/index.mjs";
18
15
  export * from "./outboundShipments/client/requests/index.mjs";
19
16
  export * as outboundShipments from "./outboundShipments/index.mjs";
20
17
  export * from "./outboundShipments/types/index.mjs";
@@ -1,4 +1,4 @@
1
- import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
1
+ import type { BaseClientOptions, BaseIdempotentRequestOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
2
2
  import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
3
3
  import * as core from "../../../../core/index.mjs";
4
4
  import type * as BeachApi from "../../../index.mjs";
@@ -6,6 +6,8 @@ export declare namespace OutboundShipmentsClient {
6
6
  type Options = BaseClientOptions;
7
7
  interface RequestOptions extends BaseRequestOptions {
8
8
  }
9
+ interface IdempotentRequestOptions extends RequestOptions, BaseIdempotentRequestOptions {
10
+ }
9
11
  }
10
12
  export declare class OutboundShipmentsClient {
11
13
  protected readonly _options: NormalizedClientOptionsWithAuth<OutboundShipmentsClient.Options>;
@@ -22,6 +24,23 @@ export declare class OutboundShipmentsClient {
22
24
  */
23
25
  list(request?: BeachApi.ListOutboundShipmentsRequest, requestOptions?: OutboundShipmentsClient.RequestOptions): core.HttpResponsePromise<BeachApi.ListOutboundShipmentsResponse>;
24
26
  private __list;
27
+ /**
28
+ * @param {BeachApi.CreateOutboundShipmentsRequest} request
29
+ * @param {OutboundShipmentsClient.IdempotentRequestOptions} requestOptions - Request-specific configuration.
30
+ *
31
+ * @throws {@link errors.BeachApiError}
32
+ * @throws {@link errors.BeachApiTimeoutError}
33
+ *
34
+ * @example
35
+ * await client.outboundShipments.create({
36
+ * fboAccountId: "fboAccountId",
37
+ * items: [{
38
+ * inventoryItemId: "inventoryItemId"
39
+ * }]
40
+ * })
41
+ */
42
+ create(request: BeachApi.CreateOutboundShipmentsRequest, requestOptions?: OutboundShipmentsClient.IdempotentRequestOptions): core.HttpResponsePromise<BeachApi.CreateOutboundShipmentsResponse>;
43
+ private __create;
25
44
  /**
26
45
  * @param {BeachApi.GetOutboundShipmentsRequest} request
27
46
  * @param {OutboundShipmentsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -36,4 +55,18 @@ export declare class OutboundShipmentsClient {
36
55
  */
37
56
  get(request: BeachApi.GetOutboundShipmentsRequest, requestOptions?: OutboundShipmentsClient.RequestOptions): core.HttpResponsePromise<BeachApi.GetOutboundShipmentsResponse>;
38
57
  private __get;
58
+ /**
59
+ * @param {BeachApi.CancelOutboundShipmentsRequest} request
60
+ * @param {OutboundShipmentsClient.RequestOptions} requestOptions - Request-specific configuration.
61
+ *
62
+ * @throws {@link errors.BeachApiError}
63
+ * @throws {@link errors.BeachApiTimeoutError}
64
+ *
65
+ * @example
66
+ * await client.outboundShipments.cancel({
67
+ * id: "id"
68
+ * })
69
+ */
70
+ cancel(request: BeachApi.CancelOutboundShipmentsRequest, requestOptions?: OutboundShipmentsClient.RequestOptions): core.HttpResponsePromise<BeachApi.CancelOutboundShipmentsResponse>;
71
+ private __cancel;
39
72
  }
@@ -8,10 +8,22 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
8
8
  step((generator = generator.apply(thisArg, _arguments || [])).next());
9
9
  });
10
10
  };
11
+ var __rest = (this && this.__rest) || function (s, e) {
12
+ var t = {};
13
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
14
+ t[p] = s[p];
15
+ if (s != null && typeof Object.getOwnPropertySymbols === "function")
16
+ for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
17
+ if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
18
+ t[p[i]] = s[p[i]];
19
+ }
20
+ return t;
21
+ };
11
22
  import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
12
- import { mergeHeaders } from "../../../../core/headers.mjs";
23
+ import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.mjs";
13
24
  import * as core from "../../../../core/index.mjs";
14
25
  import { toJson } from "../../../../core/json.mjs";
26
+ import { mergeAdditionalBodyParameters } from "../../../../core/requestBody.mjs";
15
27
  import * as environments from "../../../../environments.mjs";
16
28
  import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
17
29
  import * as errors from "../../../../errors/index.mjs";
@@ -82,6 +94,59 @@ export class OutboundShipmentsClient {
82
94
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/outbound-shipments");
83
95
  });
84
96
  }
97
+ /**
98
+ * @param {BeachApi.CreateOutboundShipmentsRequest} request
99
+ * @param {OutboundShipmentsClient.IdempotentRequestOptions} requestOptions - Request-specific configuration.
100
+ *
101
+ * @throws {@link errors.BeachApiError}
102
+ * @throws {@link errors.BeachApiTimeoutError}
103
+ *
104
+ * @example
105
+ * await client.outboundShipments.create({
106
+ * fboAccountId: "fboAccountId",
107
+ * items: [{
108
+ * inventoryItemId: "inventoryItemId"
109
+ * }]
110
+ * })
111
+ */
112
+ create(request, requestOptions) {
113
+ return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
114
+ }
115
+ __create(request, requestOptions) {
116
+ return __awaiter(this, void 0, void 0, function* () {
117
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
118
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
119
+ const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "Idempotency-Key": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
120
+ const _response = yield core.fetcher({
121
+ url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BeachApiEnvironment.Sandbox, "v1/outbound-shipments"),
122
+ method: "POST",
123
+ headers: _headers,
124
+ contentType: "application/json",
125
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
126
+ requestType: "json",
127
+ body: mergeAdditionalBodyParameters(request, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
128
+ timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
129
+ maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
130
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
131
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
132
+ logging: this._options.logging,
133
+ });
134
+ if (_response.ok) {
135
+ return {
136
+ data: _response.body,
137
+ rawResponse: _response.rawResponse,
138
+ };
139
+ }
140
+ if (_response.error.reason === "status-code") {
141
+ throw new errors.BeachApiError({
142
+ statusCode: _response.error.statusCode,
143
+ body: _response.error.body,
144
+ rawResponse: _response.rawResponse,
145
+ });
146
+ }
147
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/outbound-shipments");
148
+ });
149
+ }
85
150
  /**
86
151
  * @param {BeachApi.GetOutboundShipmentsRequest} request
87
152
  * @param {OutboundShipmentsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -143,4 +208,55 @@ export class OutboundShipmentsClient {
143
208
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/outbound-shipments/{id}");
144
209
  });
145
210
  }
211
+ /**
212
+ * @param {BeachApi.CancelOutboundShipmentsRequest} request
213
+ * @param {OutboundShipmentsClient.RequestOptions} requestOptions - Request-specific configuration.
214
+ *
215
+ * @throws {@link errors.BeachApiError}
216
+ * @throws {@link errors.BeachApiTimeoutError}
217
+ *
218
+ * @example
219
+ * await client.outboundShipments.cancel({
220
+ * id: "id"
221
+ * })
222
+ */
223
+ cancel(request, requestOptions) {
224
+ return core.HttpResponsePromise.fromPromise(this.__cancel(request, requestOptions));
225
+ }
226
+ __cancel(request, requestOptions) {
227
+ return __awaiter(this, void 0, void 0, function* () {
228
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
229
+ const { id } = request, _body = __rest(request, ["id"]);
230
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
231
+ const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
232
+ const _response = yield core.fetcher({
233
+ url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BeachApiEnvironment.Sandbox, `v1/outbound-shipments/${core.url.encodePathParam(id)}/cancel`),
234
+ method: "POST",
235
+ headers: _headers,
236
+ contentType: "application/json",
237
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
238
+ requestType: "json",
239
+ body: mergeAdditionalBodyParameters(_body, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
240
+ timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
241
+ maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
242
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
243
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
244
+ logging: this._options.logging,
245
+ });
246
+ if (_response.ok) {
247
+ return {
248
+ data: _response.body,
249
+ rawResponse: _response.rawResponse,
250
+ };
251
+ }
252
+ if (_response.error.reason === "status-code") {
253
+ throw new errors.BeachApiError({
254
+ statusCode: _response.error.statusCode,
255
+ body: _response.error.body,
256
+ rawResponse: _response.rawResponse,
257
+ });
258
+ }
259
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/outbound-shipments/{id}/cancel");
260
+ });
261
+ }
146
262
  }
@@ -4,7 +4,7 @@
4
4
  * id: "id"
5
5
  * }
6
6
  */
7
- export interface CancelOutboundRequestsRequest {
7
+ export interface CancelOutboundShipmentsRequest {
8
8
  id: string;
9
9
  reason?: string;
10
10
  }
@@ -7,14 +7,14 @@
7
7
  * }]
8
8
  * }
9
9
  */
10
- export interface CreateOutboundRequestsRequest {
10
+ export interface CreateOutboundShipmentsRequest {
11
11
  fboAccountId: string;
12
12
  notes?: string;
13
- destinationAddress?: CreateOutboundRequestsRequest.DestinationAddress;
14
- shipping?: CreateOutboundRequestsRequest.Shipping;
15
- items: CreateOutboundRequestsRequest.Items.Item[];
13
+ destinationAddress?: CreateOutboundShipmentsRequest.DestinationAddress;
14
+ shipping?: CreateOutboundShipmentsRequest.Shipping;
15
+ items: CreateOutboundShipmentsRequest.Items.Item[];
16
16
  }
17
- export declare namespace CreateOutboundRequestsRequest {
17
+ export declare namespace CreateOutboundShipmentsRequest {
18
18
  interface DestinationAddress {
19
19
  name?: string | undefined;
20
20
  company?: string | undefined;
@@ -1,6 +1,6 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
- export var CreateOutboundRequestsRequest;
3
- (function (CreateOutboundRequestsRequest) {
2
+ export var CreateOutboundShipmentsRequest;
3
+ (function (CreateOutboundShipmentsRequest) {
4
4
  let Shipping;
5
5
  (function (Shipping) {
6
6
  Shipping.Mode = {
@@ -13,5 +13,5 @@ export var CreateOutboundRequestsRequest;
13
13
  AdultSignature: "AdultSignature",
14
14
  DirectSignature: "DirectSignature",
15
15
  };
16
- })(Shipping = CreateOutboundRequestsRequest.Shipping || (CreateOutboundRequestsRequest.Shipping = {}));
17
- })(CreateOutboundRequestsRequest || (CreateOutboundRequestsRequest = {}));
16
+ })(Shipping = CreateOutboundShipmentsRequest.Shipping || (CreateOutboundShipmentsRequest.Shipping = {}));
17
+ })(CreateOutboundShipmentsRequest || (CreateOutboundShipmentsRequest = {}));
@@ -1,2 +1,4 @@
1
+ export type { CancelOutboundShipmentsRequest } from "./CancelOutboundShipmentsRequest.mjs";
2
+ export { CreateOutboundShipmentsRequest } from "./CreateOutboundShipmentsRequest.mjs";
1
3
  export type { GetOutboundShipmentsRequest } from "./GetOutboundShipmentsRequest.mjs";
2
4
  export type { ListOutboundShipmentsRequest } from "./ListOutboundShipmentsRequest.mjs";
@@ -1 +1 @@
1
- export {};
1
+ export { CreateOutboundShipmentsRequest } from "./CreateOutboundShipmentsRequest.mjs";
@@ -1,26 +1,28 @@
1
- export interface CancelOutboundRequestsResponse {
2
- data: CancelOutboundRequestsResponse.Data;
1
+ export interface CancelOutboundShipmentsResponse {
2
+ data: CancelOutboundShipmentsResponse.Data;
3
3
  }
4
- export declare namespace CancelOutboundRequestsResponse {
4
+ export declare namespace CancelOutboundShipmentsResponse {
5
5
  interface Data {
6
6
  id: string;
7
7
  fboAccountId: string;
8
8
  organizationId: string;
9
9
  status: Data.Status;
10
10
  totalItems: number;
11
- approvedBySystem?: boolean | undefined;
12
11
  notes?: string | undefined;
13
12
  destinationAddress?: Data.DestinationAddress | undefined;
14
13
  shipping?: Data.Shipping | undefined;
15
- outboundShipmentIds: string[];
14
+ packages: Data.Packages.Item[];
16
15
  items?: Data.Items.Item[] | undefined;
16
+ shippedAt?: (string | null) | undefined;
17
+ deliveredAt?: (string | null) | undefined;
17
18
  createdAt: string;
18
19
  }
19
20
  namespace Data {
20
21
  const Status: {
21
- readonly PendingReview: "pending_review";
22
+ readonly Created: "created";
22
23
  readonly Processing: "processing";
23
- readonly Fulfilled: "fulfilled";
24
+ readonly Shipped: "shipped";
25
+ readonly Delivered: "delivered";
24
26
  readonly Rejected: "rejected";
25
27
  readonly Cancelled: "cancelled";
26
28
  };
@@ -51,11 +53,22 @@ export declare namespace CancelOutboundRequestsResponse {
51
53
  weightGrams?: number | undefined;
52
54
  }
53
55
  }
56
+ type Packages = Packages.Item[];
57
+ namespace Packages {
58
+ interface Item {
59
+ carrier: string | null;
60
+ trackingNumber: string | null;
61
+ trackingUrl: string | null;
62
+ shippedAt: string | null;
63
+ deliveredAt: string | null;
64
+ inventoryItemIds: string[];
65
+ }
66
+ }
54
67
  type Items = Items.Item[];
55
68
  namespace Items {
56
69
  interface Item {
57
70
  id: string;
58
- outboundRequestId: string;
71
+ outboundShipmentId: string;
59
72
  productId: string;
60
73
  inventoryItemId: string;
61
74
  createdAt: string;
@@ -0,0 +1,15 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var CancelOutboundShipmentsResponse;
3
+ (function (CancelOutboundShipmentsResponse) {
4
+ let Data;
5
+ (function (Data) {
6
+ Data.Status = {
7
+ Created: "created",
8
+ Processing: "processing",
9
+ Shipped: "shipped",
10
+ Delivered: "delivered",
11
+ Rejected: "rejected",
12
+ Cancelled: "cancelled",
13
+ };
14
+ })(Data = CancelOutboundShipmentsResponse.Data || (CancelOutboundShipmentsResponse.Data = {}));
15
+ })(CancelOutboundShipmentsResponse || (CancelOutboundShipmentsResponse = {}));
@@ -1,26 +1,28 @@
1
- export interface CreateOutboundRequestsResponse {
2
- data: CreateOutboundRequestsResponse.Data;
1
+ export interface CreateOutboundShipmentsResponse {
2
+ data: CreateOutboundShipmentsResponse.Data;
3
3
  }
4
- export declare namespace CreateOutboundRequestsResponse {
4
+ export declare namespace CreateOutboundShipmentsResponse {
5
5
  interface Data {
6
6
  id: string;
7
7
  fboAccountId: string;
8
8
  organizationId: string;
9
9
  status: Data.Status;
10
10
  totalItems: number;
11
- approvedBySystem?: boolean | undefined;
12
11
  notes?: string | undefined;
13
12
  destinationAddress?: Data.DestinationAddress | undefined;
14
13
  shipping?: Data.Shipping | undefined;
15
- outboundShipmentIds: string[];
14
+ packages: Data.Packages.Item[];
16
15
  items?: Data.Items.Item[] | undefined;
16
+ shippedAt?: (string | null) | undefined;
17
+ deliveredAt?: (string | null) | undefined;
17
18
  createdAt: string;
18
19
  }
19
20
  namespace Data {
20
21
  const Status: {
21
- readonly PendingReview: "pending_review";
22
+ readonly Created: "created";
22
23
  readonly Processing: "processing";
23
- readonly Fulfilled: "fulfilled";
24
+ readonly Shipped: "shipped";
25
+ readonly Delivered: "delivered";
24
26
  readonly Rejected: "rejected";
25
27
  readonly Cancelled: "cancelled";
26
28
  };
@@ -51,11 +53,22 @@ export declare namespace CreateOutboundRequestsResponse {
51
53
  weightGrams?: number | undefined;
52
54
  }
53
55
  }
56
+ type Packages = Packages.Item[];
57
+ namespace Packages {
58
+ interface Item {
59
+ carrier: string | null;
60
+ trackingNumber: string | null;
61
+ trackingUrl: string | null;
62
+ shippedAt: string | null;
63
+ deliveredAt: string | null;
64
+ inventoryItemIds: string[];
65
+ }
66
+ }
54
67
  type Items = Items.Item[];
55
68
  namespace Items {
56
69
  interface Item {
57
70
  id: string;
58
- outboundRequestId: string;
71
+ outboundShipmentId: string;
59
72
  productId: string;
60
73
  inventoryItemId: string;
61
74
  createdAt: string;
@@ -0,0 +1,15 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var CreateOutboundShipmentsResponse;
3
+ (function (CreateOutboundShipmentsResponse) {
4
+ let Data;
5
+ (function (Data) {
6
+ Data.Status = {
7
+ Created: "created",
8
+ Processing: "processing",
9
+ Shipped: "shipped",
10
+ Delivered: "delivered",
11
+ Rejected: "rejected",
12
+ Cancelled: "cancelled",
13
+ };
14
+ })(Data = CreateOutboundShipmentsResponse.Data || (CreateOutboundShipmentsResponse.Data = {}));
15
+ })(CreateOutboundShipmentsResponse || (CreateOutboundShipmentsResponse = {}));