@beach-depository/sdk 0.0.2 → 0.0.4
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/cjs/api/resources/outboundShipments/client/Client.d.ts +34 -1
- package/dist/cjs/api/resources/outboundShipments/client/Client.js +116 -0
- package/dist/cjs/api/resources/outboundShipments/client/requests/CancelOutboundShipmentsRequest.d.ts +10 -0
- package/dist/cjs/api/resources/outboundShipments/client/requests/CancelOutboundShipmentsRequest.js +3 -0
- package/dist/cjs/api/resources/outboundShipments/client/requests/CreateOutboundShipmentsRequest.d.ts +55 -0
- package/dist/cjs/api/resources/outboundShipments/client/requests/CreateOutboundShipmentsRequest.js +20 -0
- package/dist/cjs/api/resources/outboundShipments/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/outboundShipments/client/requests/index.js +3 -0
- package/dist/cjs/api/resources/outboundShipments/types/CancelOutboundShipmentsResponse.d.ts +78 -0
- package/dist/cjs/api/resources/outboundShipments/types/CancelOutboundShipmentsResponse.js +18 -0
- package/dist/cjs/api/resources/outboundShipments/types/CreateOutboundShipmentsResponse.d.ts +78 -0
- package/dist/cjs/api/resources/outboundShipments/types/CreateOutboundShipmentsResponse.js +18 -0
- package/dist/cjs/api/resources/outboundShipments/types/GetOutboundShipmentsResponse.d.ts +20 -10
- package/dist/cjs/api/resources/outboundShipments/types/GetOutboundShipmentsResponse.js +3 -0
- package/dist/cjs/api/resources/outboundShipments/types/ListOutboundShipmentsRequestStatus.d.ts +3 -0
- package/dist/cjs/api/resources/outboundShipments/types/ListOutboundShipmentsRequestStatus.js +3 -0
- package/dist/cjs/api/resources/outboundShipments/types/ListOutboundShipmentsResponse.d.ts +20 -10
- package/dist/cjs/api/resources/outboundShipments/types/ListOutboundShipmentsResponse.js +3 -0
- package/dist/cjs/api/resources/outboundShipments/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/outboundShipments/types/index.js +2 -0
- package/dist/cjs/api/resources/transfers/client/Client.d.ts +14 -0
- package/dist/cjs/api/resources/transfers/client/Client.js +45 -0
- package/dist/cjs/api/resources/transfers/client/requests/ConfirmTransfersRequest.d.ts +9 -0
- package/dist/cjs/api/resources/transfers/client/requests/ConfirmTransfersRequest.js +3 -0
- package/dist/cjs/api/resources/transfers/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/transfers/types/ConfirmTransfersResponse.d.ts +34 -0
- package/dist/cjs/api/resources/transfers/types/ConfirmTransfersResponse.js +21 -0
- package/dist/cjs/api/resources/transfers/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/transfers/types/index.js +1 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/api/resources/outboundShipments/client/Client.d.mts +34 -1
- package/dist/esm/api/resources/outboundShipments/client/Client.mjs +117 -1
- package/dist/esm/api/resources/outboundShipments/client/requests/CancelOutboundShipmentsRequest.d.mts +10 -0
- package/dist/esm/api/resources/outboundShipments/client/requests/CancelOutboundShipmentsRequest.mjs +2 -0
- package/dist/esm/api/resources/outboundShipments/client/requests/CreateOutboundShipmentsRequest.d.mts +55 -0
- package/dist/esm/api/resources/outboundShipments/client/requests/CreateOutboundShipmentsRequest.mjs +17 -0
- package/dist/esm/api/resources/outboundShipments/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/outboundShipments/client/requests/index.mjs +1 -1
- package/dist/esm/api/resources/outboundShipments/types/CancelOutboundShipmentsResponse.d.mts +78 -0
- package/dist/esm/api/resources/outboundShipments/types/CancelOutboundShipmentsResponse.mjs +15 -0
- package/dist/esm/api/resources/outboundShipments/types/CreateOutboundShipmentsResponse.d.mts +78 -0
- package/dist/esm/api/resources/outboundShipments/types/CreateOutboundShipmentsResponse.mjs +15 -0
- package/dist/esm/api/resources/outboundShipments/types/GetOutboundShipmentsResponse.d.mts +20 -10
- package/dist/esm/api/resources/outboundShipments/types/GetOutboundShipmentsResponse.mjs +3 -0
- package/dist/esm/api/resources/outboundShipments/types/ListOutboundShipmentsRequestStatus.d.mts +3 -0
- package/dist/esm/api/resources/outboundShipments/types/ListOutboundShipmentsRequestStatus.mjs +3 -0
- package/dist/esm/api/resources/outboundShipments/types/ListOutboundShipmentsResponse.d.mts +20 -10
- package/dist/esm/api/resources/outboundShipments/types/ListOutboundShipmentsResponse.mjs +3 -0
- package/dist/esm/api/resources/outboundShipments/types/index.d.mts +2 -0
- package/dist/esm/api/resources/outboundShipments/types/index.mjs +2 -0
- package/dist/esm/api/resources/transfers/client/Client.d.mts +14 -0
- package/dist/esm/api/resources/transfers/client/Client.mjs +45 -0
- package/dist/esm/api/resources/transfers/client/requests/ConfirmTransfersRequest.d.mts +9 -0
- package/dist/esm/api/resources/transfers/client/requests/ConfirmTransfersRequest.mjs +2 -0
- package/dist/esm/api/resources/transfers/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/transfers/types/ConfirmTransfersResponse.d.mts +34 -0
- package/dist/esm/api/resources/transfers/types/ConfirmTransfersResponse.mjs +18 -0
- package/dist/esm/api/resources/transfers/types/index.d.mts +1 -0
- package/dist/esm/api/resources/transfers/types/index.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
|
@@ -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);
|
|
@@ -57,6 +57,20 @@ export declare class TransfersClient {
|
|
|
57
57
|
*/
|
|
58
58
|
get(request: BeachApi.GetTransfersRequest, requestOptions?: TransfersClient.RequestOptions): core.HttpResponsePromise<BeachApi.GetTransfersResponse>;
|
|
59
59
|
private __get;
|
|
60
|
+
/**
|
|
61
|
+
* @param {BeachApi.ConfirmTransfersRequest} request
|
|
62
|
+
* @param {TransfersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link errors.BeachApiError}
|
|
65
|
+
* @throws {@link errors.BeachApiTimeoutError}
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* await client.transfers.confirm({
|
|
69
|
+
* id: "id"
|
|
70
|
+
* })
|
|
71
|
+
*/
|
|
72
|
+
confirm(request: BeachApi.ConfirmTransfersRequest, requestOptions?: TransfersClient.RequestOptions): core.HttpResponsePromise<BeachApi.ConfirmTransfersResponse>;
|
|
73
|
+
private __confirm;
|
|
60
74
|
/**
|
|
61
75
|
* @param {BeachApi.CancelTransfersRequest} request
|
|
62
76
|
* @param {TransfersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -215,6 +215,51 @@ class TransfersClient {
|
|
|
215
215
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v1/transfers/{id}");
|
|
216
216
|
});
|
|
217
217
|
}
|
|
218
|
+
/**
|
|
219
|
+
* @param {BeachApi.ConfirmTransfersRequest} request
|
|
220
|
+
* @param {TransfersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
221
|
+
*
|
|
222
|
+
* @throws {@link errors.BeachApiError}
|
|
223
|
+
* @throws {@link errors.BeachApiTimeoutError}
|
|
224
|
+
*
|
|
225
|
+
* @example
|
|
226
|
+
* await client.transfers.confirm({
|
|
227
|
+
* id: "id"
|
|
228
|
+
* })
|
|
229
|
+
*/
|
|
230
|
+
confirm(request, requestOptions) {
|
|
231
|
+
return core.HttpResponsePromise.fromPromise(this.__confirm(request, requestOptions));
|
|
232
|
+
}
|
|
233
|
+
__confirm(request, requestOptions) {
|
|
234
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
235
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
236
|
+
const { id } = request;
|
|
237
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
238
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
239
|
+
const _response = yield core.fetcher({
|
|
240
|
+
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/transfers/${core.url.encodePathParam(id)}/confirm`),
|
|
241
|
+
method: "POST",
|
|
242
|
+
headers: _headers,
|
|
243
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
244
|
+
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,
|
|
245
|
+
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,
|
|
246
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
247
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
248
|
+
logging: this._options.logging,
|
|
249
|
+
});
|
|
250
|
+
if (_response.ok) {
|
|
251
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
252
|
+
}
|
|
253
|
+
if (_response.error.reason === "status-code") {
|
|
254
|
+
throw new errors.BeachApiError({
|
|
255
|
+
statusCode: _response.error.statusCode,
|
|
256
|
+
body: _response.error.body,
|
|
257
|
+
rawResponse: _response.rawResponse,
|
|
258
|
+
});
|
|
259
|
+
}
|
|
260
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v1/transfers/{id}/confirm");
|
|
261
|
+
});
|
|
262
|
+
}
|
|
218
263
|
/**
|
|
219
264
|
* @param {BeachApi.CancelTransfersRequest} request
|
|
220
265
|
* @param {TransfersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export type { CancelTransfersRequest } from "./CancelTransfersRequest.js";
|
|
2
|
+
export type { ConfirmTransfersRequest } from "./ConfirmTransfersRequest.js";
|
|
2
3
|
export { CreateTransfersRequest } from "./CreateTransfersRequest.js";
|
|
3
4
|
export type { GetTransfersRequest } from "./GetTransfersRequest.js";
|
|
4
5
|
export type { ListTransfersRequest } from "./ListTransfersRequest.js";
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
export interface ConfirmTransfersResponse {
|
|
2
|
+
data: ConfirmTransfersResponse.Data;
|
|
3
|
+
}
|
|
4
|
+
export declare namespace ConfirmTransfersResponse {
|
|
5
|
+
interface Data {
|
|
6
|
+
id: string;
|
|
7
|
+
fromFboAccountId: string;
|
|
8
|
+
toFboAccountId: string;
|
|
9
|
+
organizationId: string;
|
|
10
|
+
status: Data.Status;
|
|
11
|
+
initiatedBy: Data.InitiatedBy;
|
|
12
|
+
totalItems: number;
|
|
13
|
+
approvedBySystem?: boolean | undefined;
|
|
14
|
+
notes?: string | undefined;
|
|
15
|
+
approvedAt?: string | undefined;
|
|
16
|
+
completedAt?: string | undefined;
|
|
17
|
+
createdAt: string;
|
|
18
|
+
}
|
|
19
|
+
namespace Data {
|
|
20
|
+
const Status: {
|
|
21
|
+
readonly PendingApproval: "pending_approval";
|
|
22
|
+
readonly Processing: "processing";
|
|
23
|
+
readonly Completed: "completed";
|
|
24
|
+
readonly Rejected: "rejected";
|
|
25
|
+
readonly Cancelled: "cancelled";
|
|
26
|
+
};
|
|
27
|
+
type Status = (typeof Status)[keyof typeof Status];
|
|
28
|
+
const InitiatedBy: {
|
|
29
|
+
readonly Customer: "customer";
|
|
30
|
+
readonly Vault: "vault";
|
|
31
|
+
};
|
|
32
|
+
type InitiatedBy = (typeof InitiatedBy)[keyof typeof InitiatedBy];
|
|
33
|
+
}
|
|
34
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ConfirmTransfersResponse = void 0;
|
|
5
|
+
var ConfirmTransfersResponse;
|
|
6
|
+
(function (ConfirmTransfersResponse) {
|
|
7
|
+
let Data;
|
|
8
|
+
(function (Data) {
|
|
9
|
+
Data.Status = {
|
|
10
|
+
PendingApproval: "pending_approval",
|
|
11
|
+
Processing: "processing",
|
|
12
|
+
Completed: "completed",
|
|
13
|
+
Rejected: "rejected",
|
|
14
|
+
Cancelled: "cancelled",
|
|
15
|
+
};
|
|
16
|
+
Data.InitiatedBy = {
|
|
17
|
+
Customer: "customer",
|
|
18
|
+
Vault: "vault",
|
|
19
|
+
};
|
|
20
|
+
})(Data = ConfirmTransfersResponse.Data || (ConfirmTransfersResponse.Data = {}));
|
|
21
|
+
})(ConfirmTransfersResponse || (exports.ConfirmTransfersResponse = ConfirmTransfersResponse = {}));
|
|
@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
__exportStar(require("./CancelTransfersResponse.js"), exports);
|
|
18
|
+
__exportStar(require("./ConfirmTransfersResponse.js"), exports);
|
|
18
19
|
__exportStar(require("./CreateTransfersResponse.js"), exports);
|
|
19
20
|
__exportStar(require("./GetTransfersResponse.js"), exports);
|
|
20
21
|
__exportStar(require("./ListTransfersRequestStatus.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "0.0.
|
|
1
|
+
export declare const SDK_VERSION = "0.0.4";
|
package/dist/cjs/version.js
CHANGED
|
@@ -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
|
}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* fboAccountId: "fboAccountId",
|
|
5
|
+
* items: [{
|
|
6
|
+
* inventoryItemId: "inventoryItemId"
|
|
7
|
+
* }]
|
|
8
|
+
* }
|
|
9
|
+
*/
|
|
10
|
+
export interface CreateOutboundShipmentsRequest {
|
|
11
|
+
fboAccountId: string;
|
|
12
|
+
notes?: string;
|
|
13
|
+
destinationAddress?: CreateOutboundShipmentsRequest.DestinationAddress;
|
|
14
|
+
shipping?: CreateOutboundShipmentsRequest.Shipping;
|
|
15
|
+
items: CreateOutboundShipmentsRequest.Items.Item[];
|
|
16
|
+
}
|
|
17
|
+
export declare namespace CreateOutboundShipmentsRequest {
|
|
18
|
+
interface DestinationAddress {
|
|
19
|
+
name?: string | undefined;
|
|
20
|
+
company?: string | undefined;
|
|
21
|
+
street1: string;
|
|
22
|
+
street2?: string | undefined;
|
|
23
|
+
city: string;
|
|
24
|
+
state: string;
|
|
25
|
+
zip: string;
|
|
26
|
+
country: string;
|
|
27
|
+
phone?: string | undefined;
|
|
28
|
+
email?: string | undefined;
|
|
29
|
+
}
|
|
30
|
+
interface Shipping {
|
|
31
|
+
mode?: Shipping.Mode | undefined;
|
|
32
|
+
signatureType?: Shipping.SignatureType | undefined;
|
|
33
|
+
serviceCode?: string | undefined;
|
|
34
|
+
}
|
|
35
|
+
namespace Shipping {
|
|
36
|
+
const Mode: {
|
|
37
|
+
readonly Cheapest: "cheapest";
|
|
38
|
+
readonly Selected: "selected";
|
|
39
|
+
};
|
|
40
|
+
type Mode = (typeof Mode)[keyof typeof Mode];
|
|
41
|
+
const SignatureType: {
|
|
42
|
+
readonly NoSignature: "NoSignature";
|
|
43
|
+
readonly Signature: "Signature";
|
|
44
|
+
readonly AdultSignature: "AdultSignature";
|
|
45
|
+
readonly DirectSignature: "DirectSignature";
|
|
46
|
+
};
|
|
47
|
+
type SignatureType = (typeof SignatureType)[keyof typeof SignatureType];
|
|
48
|
+
}
|
|
49
|
+
type Items = Items.Item[];
|
|
50
|
+
namespace Items {
|
|
51
|
+
interface Item {
|
|
52
|
+
inventoryItemId: string;
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
}
|
package/dist/esm/api/resources/outboundShipments/client/requests/CreateOutboundShipmentsRequest.mjs
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
export var CreateOutboundShipmentsRequest;
|
|
3
|
+
(function (CreateOutboundShipmentsRequest) {
|
|
4
|
+
let Shipping;
|
|
5
|
+
(function (Shipping) {
|
|
6
|
+
Shipping.Mode = {
|
|
7
|
+
Cheapest: "cheapest",
|
|
8
|
+
Selected: "selected",
|
|
9
|
+
};
|
|
10
|
+
Shipping.SignatureType = {
|
|
11
|
+
NoSignature: "NoSignature",
|
|
12
|
+
Signature: "Signature",
|
|
13
|
+
AdultSignature: "AdultSignature",
|
|
14
|
+
DirectSignature: "DirectSignature",
|
|
15
|
+
};
|
|
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";
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
export interface CancelOutboundShipmentsResponse {
|
|
2
|
+
data: CancelOutboundShipmentsResponse.Data;
|
|
3
|
+
}
|
|
4
|
+
export declare namespace CancelOutboundShipmentsResponse {
|
|
5
|
+
interface Data {
|
|
6
|
+
id: string;
|
|
7
|
+
fboAccountId: string;
|
|
8
|
+
organizationId: string;
|
|
9
|
+
status: Data.Status;
|
|
10
|
+
totalItems: number;
|
|
11
|
+
notes?: string | undefined;
|
|
12
|
+
destinationAddress?: Data.DestinationAddress | undefined;
|
|
13
|
+
shipping?: Data.Shipping | undefined;
|
|
14
|
+
packages: Data.Packages.Item[];
|
|
15
|
+
items?: Data.Items.Item[] | undefined;
|
|
16
|
+
shippedAt?: (string | null) | undefined;
|
|
17
|
+
deliveredAt?: (string | null) | undefined;
|
|
18
|
+
createdAt: string;
|
|
19
|
+
}
|
|
20
|
+
namespace Data {
|
|
21
|
+
const Status: {
|
|
22
|
+
readonly Created: "created";
|
|
23
|
+
readonly Processing: "processing";
|
|
24
|
+
readonly Shipped: "shipped";
|
|
25
|
+
readonly Delivered: "delivered";
|
|
26
|
+
readonly Rejected: "rejected";
|
|
27
|
+
readonly Cancelled: "cancelled";
|
|
28
|
+
};
|
|
29
|
+
type Status = (typeof Status)[keyof typeof Status];
|
|
30
|
+
interface DestinationAddress {
|
|
31
|
+
name?: string | undefined;
|
|
32
|
+
street1?: string | undefined;
|
|
33
|
+
street2?: string | undefined;
|
|
34
|
+
city?: string | undefined;
|
|
35
|
+
state?: string | undefined;
|
|
36
|
+
zip?: string | undefined;
|
|
37
|
+
country?: string | undefined;
|
|
38
|
+
}
|
|
39
|
+
interface Shipping {
|
|
40
|
+
mode?: string | undefined;
|
|
41
|
+
signatureType?: string | undefined;
|
|
42
|
+
quote?: Shipping.Quote | undefined;
|
|
43
|
+
}
|
|
44
|
+
namespace Shipping {
|
|
45
|
+
interface Quote {
|
|
46
|
+
carrier?: string | undefined;
|
|
47
|
+
service?: string | undefined;
|
|
48
|
+
serviceCode?: string | undefined;
|
|
49
|
+
quotedCents?: number | undefined;
|
|
50
|
+
currency?: string | undefined;
|
|
51
|
+
quotedAt?: number | undefined;
|
|
52
|
+
insuredValueCents?: number | undefined;
|
|
53
|
+
weightGrams?: number | undefined;
|
|
54
|
+
}
|
|
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
|
+
}
|
|
67
|
+
type Items = Items.Item[];
|
|
68
|
+
namespace Items {
|
|
69
|
+
interface Item {
|
|
70
|
+
id: string;
|
|
71
|
+
outboundShipmentId: string;
|
|
72
|
+
productId: string;
|
|
73
|
+
inventoryItemId: string;
|
|
74
|
+
createdAt: string;
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
@@ -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 = {}));
|