@beach-depository/sdk 0.0.5 → 0.0.6
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/inboundShipments/client/Client.d.ts +18 -0
- package/dist/cjs/api/resources/inboundShipments/client/Client.js +57 -1
- package/dist/cjs/api/resources/inboundShipments/client/requests/ListInboundShipmentsRequest.d.ts +1 -0
- package/dist/cjs/api/resources/inboundShipments/client/requests/UpdateInboundShipmentsRequest.d.ts +23 -0
- package/dist/cjs/api/resources/inboundShipments/client/requests/UpdateInboundShipmentsRequest.js +3 -0
- package/dist/cjs/api/resources/inboundShipments/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboundShipments/types/UpdateInboundShipmentsResponse.d.ts +42 -0
- package/dist/cjs/api/resources/inboundShipments/types/UpdateInboundShipmentsResponse.js +18 -0
- package/dist/cjs/api/resources/inboundShipments/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboundShipments/types/index.js +1 -0
- package/dist/cjs/api/resources/outboundShipments/client/Client.d.ts +17 -0
- package/dist/cjs/api/resources/outboundShipments/client/Client.js +53 -0
- package/dist/cjs/api/resources/outboundShipments/client/requests/CreateOutboundShipmentsRequest.d.ts +2 -17
- package/dist/cjs/api/resources/outboundShipments/client/requests/CreateOutboundShipmentsRequest.js +0 -17
- package/dist/cjs/api/resources/outboundShipments/client/requests/GetRatesOutboundShipmentsRequest.d.ts +35 -0
- package/dist/cjs/api/resources/outboundShipments/client/requests/GetRatesOutboundShipmentsRequest.js +3 -0
- package/dist/cjs/api/resources/outboundShipments/client/requests/index.d.ts +2 -1
- package/dist/cjs/api/resources/outboundShipments/client/requests/index.js +0 -3
- package/dist/cjs/api/resources/outboundShipments/types/CancelOutboundShipmentsResponse.d.ts +1 -2
- package/dist/cjs/api/resources/outboundShipments/types/CreateOutboundShipmentsResponse.d.ts +1 -2
- package/dist/cjs/api/resources/outboundShipments/types/GetOutboundShipmentsResponse.d.ts +1 -2
- package/dist/cjs/api/resources/outboundShipments/types/GetRatesOutboundShipmentsResponse.d.ts +18 -0
- package/dist/cjs/api/resources/outboundShipments/types/GetRatesOutboundShipmentsResponse.js +3 -0
- package/dist/cjs/api/resources/outboundShipments/types/ListOutboundShipmentsResponse.d.ts +1 -2
- package/dist/cjs/api/resources/outboundShipments/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/outboundShipments/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/inboundShipments/client/Client.d.mts +18 -0
- package/dist/esm/api/resources/inboundShipments/client/Client.mjs +57 -1
- package/dist/esm/api/resources/inboundShipments/client/requests/ListInboundShipmentsRequest.d.mts +1 -0
- package/dist/esm/api/resources/inboundShipments/client/requests/UpdateInboundShipmentsRequest.d.mts +23 -0
- package/dist/esm/api/resources/inboundShipments/client/requests/UpdateInboundShipmentsRequest.mjs +2 -0
- package/dist/esm/api/resources/inboundShipments/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/inboundShipments/types/UpdateInboundShipmentsResponse.d.mts +42 -0
- package/dist/esm/api/resources/inboundShipments/types/UpdateInboundShipmentsResponse.mjs +15 -0
- package/dist/esm/api/resources/inboundShipments/types/index.d.mts +1 -0
- package/dist/esm/api/resources/inboundShipments/types/index.mjs +1 -0
- package/dist/esm/api/resources/outboundShipments/client/Client.d.mts +17 -0
- package/dist/esm/api/resources/outboundShipments/client/Client.mjs +53 -0
- package/dist/esm/api/resources/outboundShipments/client/requests/CreateOutboundShipmentsRequest.d.mts +2 -17
- package/dist/esm/api/resources/outboundShipments/client/requests/CreateOutboundShipmentsRequest.mjs +1 -16
- package/dist/esm/api/resources/outboundShipments/client/requests/GetRatesOutboundShipmentsRequest.d.mts +35 -0
- package/dist/esm/api/resources/outboundShipments/client/requests/GetRatesOutboundShipmentsRequest.mjs +2 -0
- package/dist/esm/api/resources/outboundShipments/client/requests/index.d.mts +2 -1
- package/dist/esm/api/resources/outboundShipments/client/requests/index.mjs +1 -1
- package/dist/esm/api/resources/outboundShipments/types/CancelOutboundShipmentsResponse.d.mts +1 -2
- package/dist/esm/api/resources/outboundShipments/types/CreateOutboundShipmentsResponse.d.mts +1 -2
- package/dist/esm/api/resources/outboundShipments/types/GetOutboundShipmentsResponse.d.mts +1 -2
- package/dist/esm/api/resources/outboundShipments/types/GetRatesOutboundShipmentsResponse.d.mts +18 -0
- package/dist/esm/api/resources/outboundShipments/types/GetRatesOutboundShipmentsResponse.mjs +2 -0
- package/dist/esm/api/resources/outboundShipments/types/ListOutboundShipmentsResponse.d.mts +1 -2
- package/dist/esm/api/resources/outboundShipments/types/index.d.mts +1 -0
- package/dist/esm/api/resources/outboundShipments/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
|
@@ -56,6 +56,24 @@ export declare class InboundShipmentsClient {
|
|
|
56
56
|
*/
|
|
57
57
|
get(request: BeachApi.GetInboundShipmentsRequest, requestOptions?: InboundShipmentsClient.RequestOptions): core.HttpResponsePromise<BeachApi.GetInboundShipmentsResponse>;
|
|
58
58
|
private __get;
|
|
59
|
+
/**
|
|
60
|
+
* @param {BeachApi.UpdateInboundShipmentsRequest} request
|
|
61
|
+
* @param {InboundShipmentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link errors.BeachApiError}
|
|
64
|
+
* @throws {@link errors.BeachApiTimeoutError}
|
|
65
|
+
*
|
|
66
|
+
* @example
|
|
67
|
+
* await client.inboundShipments.update({
|
|
68
|
+
* id: "id",
|
|
69
|
+
* lines: [{
|
|
70
|
+
* productId: "productId",
|
|
71
|
+
* quantityDeclared: 1
|
|
72
|
+
* }]
|
|
73
|
+
* })
|
|
74
|
+
*/
|
|
75
|
+
update(request: BeachApi.UpdateInboundShipmentsRequest, requestOptions?: InboundShipmentsClient.RequestOptions): core.HttpResponsePromise<BeachApi.UpdateInboundShipmentsResponse>;
|
|
76
|
+
private __update;
|
|
59
77
|
/**
|
|
60
78
|
* @param {BeachApi.CancelInboundShipmentsRequest} request
|
|
61
79
|
* @param {InboundShipmentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -83,12 +83,13 @@ class InboundShipmentsClient {
|
|
|
83
83
|
__list() {
|
|
84
84
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
85
85
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
86
|
-
const { page, limit, status, fboAccountId, includeLineItems } = request;
|
|
86
|
+
const { page, limit, status, fboAccountId, trackingNumber, includeLineItems } = request;
|
|
87
87
|
const _queryParams = {
|
|
88
88
|
page,
|
|
89
89
|
limit,
|
|
90
90
|
status: status != null ? status : undefined,
|
|
91
91
|
fboAccountId,
|
|
92
|
+
trackingNumber,
|
|
92
93
|
includeLineItems: Array.isArray(includeLineItems)
|
|
93
94
|
? includeLineItems.map((item) => (typeof item === "string" ? item : (0, json_js_1.toJson)(item)))
|
|
94
95
|
: includeLineItems != null
|
|
@@ -242,6 +243,61 @@ class InboundShipmentsClient {
|
|
|
242
243
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v1/inbound-shipments/{id}");
|
|
243
244
|
});
|
|
244
245
|
}
|
|
246
|
+
/**
|
|
247
|
+
* @param {BeachApi.UpdateInboundShipmentsRequest} request
|
|
248
|
+
* @param {InboundShipmentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
249
|
+
*
|
|
250
|
+
* @throws {@link errors.BeachApiError}
|
|
251
|
+
* @throws {@link errors.BeachApiTimeoutError}
|
|
252
|
+
*
|
|
253
|
+
* @example
|
|
254
|
+
* await client.inboundShipments.update({
|
|
255
|
+
* id: "id",
|
|
256
|
+
* lines: [{
|
|
257
|
+
* productId: "productId",
|
|
258
|
+
* quantityDeclared: 1
|
|
259
|
+
* }]
|
|
260
|
+
* })
|
|
261
|
+
*/
|
|
262
|
+
update(request, requestOptions) {
|
|
263
|
+
return core.HttpResponsePromise.fromPromise(this.__update(request, requestOptions));
|
|
264
|
+
}
|
|
265
|
+
__update(request, requestOptions) {
|
|
266
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
267
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
268
|
+
const { id } = request, _body = __rest(request, ["id"]);
|
|
269
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
270
|
+
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);
|
|
271
|
+
const _response = yield core.fetcher({
|
|
272
|
+
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/inbound-shipments/${core.url.encodePathParam(id)}`),
|
|
273
|
+
method: "PATCH",
|
|
274
|
+
headers: _headers,
|
|
275
|
+
contentType: "application/json",
|
|
276
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
277
|
+
requestType: "json",
|
|
278
|
+
body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(_body, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
|
|
279
|
+
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,
|
|
280
|
+
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,
|
|
281
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
282
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
283
|
+
logging: this._options.logging,
|
|
284
|
+
});
|
|
285
|
+
if (_response.ok) {
|
|
286
|
+
return {
|
|
287
|
+
data: _response.body,
|
|
288
|
+
rawResponse: _response.rawResponse,
|
|
289
|
+
};
|
|
290
|
+
}
|
|
291
|
+
if (_response.error.reason === "status-code") {
|
|
292
|
+
throw new errors.BeachApiError({
|
|
293
|
+
statusCode: _response.error.statusCode,
|
|
294
|
+
body: _response.error.body,
|
|
295
|
+
rawResponse: _response.rawResponse,
|
|
296
|
+
});
|
|
297
|
+
}
|
|
298
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PATCH", "/v1/inbound-shipments/{id}");
|
|
299
|
+
});
|
|
300
|
+
}
|
|
245
301
|
/**
|
|
246
302
|
* @param {BeachApi.CancelInboundShipmentsRequest} request
|
|
247
303
|
* @param {InboundShipmentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
package/dist/cjs/api/resources/inboundShipments/client/requests/UpdateInboundShipmentsRequest.d.ts
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* id: "id",
|
|
5
|
+
* lines: [{
|
|
6
|
+
* productId: "productId",
|
|
7
|
+
* quantityDeclared: 1
|
|
8
|
+
* }]
|
|
9
|
+
* }
|
|
10
|
+
*/
|
|
11
|
+
export interface UpdateInboundShipmentsRequest {
|
|
12
|
+
id: string;
|
|
13
|
+
lines: UpdateInboundShipmentsRequest.Lines.Item[];
|
|
14
|
+
}
|
|
15
|
+
export declare namespace UpdateInboundShipmentsRequest {
|
|
16
|
+
type Lines = Lines.Item[];
|
|
17
|
+
namespace Lines {
|
|
18
|
+
interface Item {
|
|
19
|
+
productId: string;
|
|
20
|
+
quantityDeclared: number;
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
}
|
|
@@ -2,3 +2,4 @@ export type { CancelInboundShipmentsRequest } from "./CancelInboundShipmentsRequ
|
|
|
2
2
|
export type { CreateInboundShipmentsRequest } from "./CreateInboundShipmentsRequest.js";
|
|
3
3
|
export type { GetInboundShipmentsRequest } from "./GetInboundShipmentsRequest.js";
|
|
4
4
|
export type { ListInboundShipmentsRequest } from "./ListInboundShipmentsRequest.js";
|
|
5
|
+
export type { UpdateInboundShipmentsRequest } from "./UpdateInboundShipmentsRequest.js";
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
export interface UpdateInboundShipmentsResponse {
|
|
2
|
+
data: UpdateInboundShipmentsResponse.Data;
|
|
3
|
+
}
|
|
4
|
+
export declare namespace UpdateInboundShipmentsResponse {
|
|
5
|
+
interface Data {
|
|
6
|
+
id: string;
|
|
7
|
+
fboAccountId: string;
|
|
8
|
+
organizationId: string;
|
|
9
|
+
status: Data.Status;
|
|
10
|
+
shipmentNotes?: string | undefined;
|
|
11
|
+
trackingNumber?: string | undefined;
|
|
12
|
+
carrier?: string | undefined;
|
|
13
|
+
receivedAt?: string | undefined;
|
|
14
|
+
lineItems?: Data.LineItems.Item[] | undefined;
|
|
15
|
+
createdAt: string;
|
|
16
|
+
}
|
|
17
|
+
namespace Data {
|
|
18
|
+
const Status: {
|
|
19
|
+
readonly Created: "created";
|
|
20
|
+
readonly InTransit: "in_transit";
|
|
21
|
+
readonly Processing: "processing";
|
|
22
|
+
readonly Accepted: "accepted";
|
|
23
|
+
readonly Rejected: "rejected";
|
|
24
|
+
readonly Cancelled: "cancelled";
|
|
25
|
+
};
|
|
26
|
+
type Status = (typeof Status)[keyof typeof Status];
|
|
27
|
+
type LineItems = LineItems.Item[];
|
|
28
|
+
namespace LineItems {
|
|
29
|
+
interface Item {
|
|
30
|
+
id: string;
|
|
31
|
+
productId: string;
|
|
32
|
+
quantityDeclared: number;
|
|
33
|
+
quantityReceived?: number | undefined;
|
|
34
|
+
quantityAccepted?: number | undefined;
|
|
35
|
+
quantityRejected?: number | undefined;
|
|
36
|
+
inventoryItemIds: string[];
|
|
37
|
+
checkedInAt?: string | undefined;
|
|
38
|
+
createdAt: string;
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.UpdateInboundShipmentsResponse = void 0;
|
|
5
|
+
var UpdateInboundShipmentsResponse;
|
|
6
|
+
(function (UpdateInboundShipmentsResponse) {
|
|
7
|
+
let Data;
|
|
8
|
+
(function (Data) {
|
|
9
|
+
Data.Status = {
|
|
10
|
+
Created: "created",
|
|
11
|
+
InTransit: "in_transit",
|
|
12
|
+
Processing: "processing",
|
|
13
|
+
Accepted: "accepted",
|
|
14
|
+
Rejected: "rejected",
|
|
15
|
+
Cancelled: "cancelled",
|
|
16
|
+
};
|
|
17
|
+
})(Data = UpdateInboundShipmentsResponse.Data || (UpdateInboundShipmentsResponse.Data = {}));
|
|
18
|
+
})(UpdateInboundShipmentsResponse || (exports.UpdateInboundShipmentsResponse = UpdateInboundShipmentsResponse = {}));
|
|
@@ -19,3 +19,4 @@ __exportStar(require("./CreateInboundShipmentsResponse.js"), exports);
|
|
|
19
19
|
__exportStar(require("./GetInboundShipmentsResponse.js"), exports);
|
|
20
20
|
__exportStar(require("./ListInboundShipmentsRequestStatus.js"), exports);
|
|
21
21
|
__exportStar(require("./ListInboundShipmentsResponse.js"), exports);
|
|
22
|
+
__exportStar(require("./UpdateInboundShipmentsResponse.js"), exports);
|
|
@@ -12,6 +12,23 @@ export declare namespace OutboundShipmentsClient {
|
|
|
12
12
|
export declare class OutboundShipmentsClient {
|
|
13
13
|
protected readonly _options: NormalizedClientOptionsWithAuth<OutboundShipmentsClient.Options>;
|
|
14
14
|
constructor(options: OutboundShipmentsClient.Options);
|
|
15
|
+
/**
|
|
16
|
+
* @param {BeachApi.GetRatesOutboundShipmentsRequest} request
|
|
17
|
+
* @param {OutboundShipmentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
18
|
+
*
|
|
19
|
+
* @throws {@link errors.BeachApiError}
|
|
20
|
+
* @throws {@link errors.BeachApiTimeoutError}
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* await client.outboundShipments.getRates({
|
|
24
|
+
* fboAccountId: "fboAccountId",
|
|
25
|
+
* items: [{
|
|
26
|
+
* inventoryItemId: "inventoryItemId"
|
|
27
|
+
* }]
|
|
28
|
+
* })
|
|
29
|
+
*/
|
|
30
|
+
getRates(request: BeachApi.GetRatesOutboundShipmentsRequest, requestOptions?: OutboundShipmentsClient.RequestOptions): core.HttpResponsePromise<BeachApi.GetRatesOutboundShipmentsResponse>;
|
|
31
|
+
private __getRates;
|
|
15
32
|
/**
|
|
16
33
|
* @param {BeachApi.ListOutboundShipmentsRequest} request
|
|
17
34
|
* @param {OutboundShipmentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -67,6 +67,59 @@ class OutboundShipmentsClient {
|
|
|
67
67
|
constructor(options) {
|
|
68
68
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
69
69
|
}
|
|
70
|
+
/**
|
|
71
|
+
* @param {BeachApi.GetRatesOutboundShipmentsRequest} request
|
|
72
|
+
* @param {OutboundShipmentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link errors.BeachApiError}
|
|
75
|
+
* @throws {@link errors.BeachApiTimeoutError}
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* await client.outboundShipments.getRates({
|
|
79
|
+
* fboAccountId: "fboAccountId",
|
|
80
|
+
* items: [{
|
|
81
|
+
* inventoryItemId: "inventoryItemId"
|
|
82
|
+
* }]
|
|
83
|
+
* })
|
|
84
|
+
*/
|
|
85
|
+
getRates(request, requestOptions) {
|
|
86
|
+
return core.HttpResponsePromise.fromPromise(this.__getRates(request, requestOptions));
|
|
87
|
+
}
|
|
88
|
+
__getRates(request, requestOptions) {
|
|
89
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
90
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
91
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
92
|
+
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);
|
|
93
|
+
const _response = yield core.fetcher({
|
|
94
|
+
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/rates"),
|
|
95
|
+
method: "POST",
|
|
96
|
+
headers: _headers,
|
|
97
|
+
contentType: "application/json",
|
|
98
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
99
|
+
requestType: "json",
|
|
100
|
+
body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(request, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
|
|
101
|
+
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,
|
|
102
|
+
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,
|
|
103
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
104
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
105
|
+
logging: this._options.logging,
|
|
106
|
+
});
|
|
107
|
+
if (_response.ok) {
|
|
108
|
+
return {
|
|
109
|
+
data: _response.body,
|
|
110
|
+
rawResponse: _response.rawResponse,
|
|
111
|
+
};
|
|
112
|
+
}
|
|
113
|
+
if (_response.error.reason === "status-code") {
|
|
114
|
+
throw new errors.BeachApiError({
|
|
115
|
+
statusCode: _response.error.statusCode,
|
|
116
|
+
body: _response.error.body,
|
|
117
|
+
rawResponse: _response.rawResponse,
|
|
118
|
+
});
|
|
119
|
+
}
|
|
120
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v1/outbound-shipments/rates");
|
|
121
|
+
});
|
|
122
|
+
}
|
|
70
123
|
/**
|
|
71
124
|
* @param {BeachApi.ListOutboundShipmentsRequest} request
|
|
72
125
|
* @param {OutboundShipmentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
package/dist/cjs/api/resources/outboundShipments/client/requests/CreateOutboundShipmentsRequest.d.ts
CHANGED
|
@@ -11,6 +11,7 @@ export interface CreateOutboundShipmentsRequest {
|
|
|
11
11
|
fboAccountId: string;
|
|
12
12
|
notes?: string;
|
|
13
13
|
destinationAddress?: CreateOutboundShipmentsRequest.DestinationAddress;
|
|
14
|
+
destinationAddressId?: string;
|
|
14
15
|
shipping?: CreateOutboundShipmentsRequest.Shipping;
|
|
15
16
|
items: CreateOutboundShipmentsRequest.Items.Item[];
|
|
16
17
|
}
|
|
@@ -28,23 +29,7 @@ export declare namespace CreateOutboundShipmentsRequest {
|
|
|
28
29
|
email?: string | undefined;
|
|
29
30
|
}
|
|
30
31
|
interface Shipping {
|
|
31
|
-
|
|
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];
|
|
32
|
+
service?: string | undefined;
|
|
48
33
|
}
|
|
49
34
|
type Items = Items.Item[];
|
|
50
35
|
namespace Items {
|
package/dist/cjs/api/resources/outboundShipments/client/requests/CreateOutboundShipmentsRequest.js
CHANGED
|
@@ -1,20 +1,3 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.CreateOutboundShipmentsRequest = void 0;
|
|
5
|
-
var CreateOutboundShipmentsRequest;
|
|
6
|
-
(function (CreateOutboundShipmentsRequest) {
|
|
7
|
-
let Shipping;
|
|
8
|
-
(function (Shipping) {
|
|
9
|
-
Shipping.Mode = {
|
|
10
|
-
Cheapest: "cheapest",
|
|
11
|
-
Selected: "selected",
|
|
12
|
-
};
|
|
13
|
-
Shipping.SignatureType = {
|
|
14
|
-
NoSignature: "NoSignature",
|
|
15
|
-
Signature: "Signature",
|
|
16
|
-
AdultSignature: "AdultSignature",
|
|
17
|
-
DirectSignature: "DirectSignature",
|
|
18
|
-
};
|
|
19
|
-
})(Shipping = CreateOutboundShipmentsRequest.Shipping || (CreateOutboundShipmentsRequest.Shipping = {}));
|
|
20
|
-
})(CreateOutboundShipmentsRequest || (exports.CreateOutboundShipmentsRequest = CreateOutboundShipmentsRequest = {}));
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* fboAccountId: "fboAccountId",
|
|
5
|
+
* items: [{
|
|
6
|
+
* inventoryItemId: "inventoryItemId"
|
|
7
|
+
* }]
|
|
8
|
+
* }
|
|
9
|
+
*/
|
|
10
|
+
export interface GetRatesOutboundShipmentsRequest {
|
|
11
|
+
fboAccountId: string;
|
|
12
|
+
destinationAddress?: GetRatesOutboundShipmentsRequest.DestinationAddress;
|
|
13
|
+
destinationAddressId?: string;
|
|
14
|
+
items: GetRatesOutboundShipmentsRequest.Items.Item[];
|
|
15
|
+
}
|
|
16
|
+
export declare namespace GetRatesOutboundShipmentsRequest {
|
|
17
|
+
interface DestinationAddress {
|
|
18
|
+
name?: string | undefined;
|
|
19
|
+
company?: string | undefined;
|
|
20
|
+
street1: string;
|
|
21
|
+
street2?: string | undefined;
|
|
22
|
+
city: string;
|
|
23
|
+
state: string;
|
|
24
|
+
zip: string;
|
|
25
|
+
country: string;
|
|
26
|
+
phone?: string | undefined;
|
|
27
|
+
email?: string | undefined;
|
|
28
|
+
}
|
|
29
|
+
type Items = Items.Item[];
|
|
30
|
+
namespace Items {
|
|
31
|
+
interface Item {
|
|
32
|
+
inventoryItemId: string;
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export type { CancelOutboundShipmentsRequest } from "./CancelOutboundShipmentsRequest.js";
|
|
2
|
-
export { CreateOutboundShipmentsRequest } from "./CreateOutboundShipmentsRequest.js";
|
|
2
|
+
export type { CreateOutboundShipmentsRequest } from "./CreateOutboundShipmentsRequest.js";
|
|
3
3
|
export type { GetOutboundShipmentsRequest } from "./GetOutboundShipmentsRequest.js";
|
|
4
|
+
export type { GetRatesOutboundShipmentsRequest } from "./GetRatesOutboundShipmentsRequest.js";
|
|
4
5
|
export type { ListOutboundShipmentsRequest } from "./ListOutboundShipmentsRequest.js";
|
|
@@ -1,5 +1,2 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.CreateOutboundShipmentsRequest = void 0;
|
|
4
|
-
var CreateOutboundShipmentsRequest_js_1 = require("./CreateOutboundShipmentsRequest.js");
|
|
5
|
-
Object.defineProperty(exports, "CreateOutboundShipmentsRequest", { enumerable: true, get: function () { return CreateOutboundShipmentsRequest_js_1.CreateOutboundShipmentsRequest; } });
|
|
@@ -37,8 +37,7 @@ export declare namespace CancelOutboundShipmentsResponse {
|
|
|
37
37
|
country?: string | undefined;
|
|
38
38
|
}
|
|
39
39
|
interface Shipping {
|
|
40
|
-
|
|
41
|
-
signatureType?: string | undefined;
|
|
40
|
+
service?: string | undefined;
|
|
42
41
|
quote?: Shipping.Quote | undefined;
|
|
43
42
|
}
|
|
44
43
|
namespace Shipping {
|
|
@@ -37,8 +37,7 @@ export declare namespace CreateOutboundShipmentsResponse {
|
|
|
37
37
|
country?: string | undefined;
|
|
38
38
|
}
|
|
39
39
|
interface Shipping {
|
|
40
|
-
|
|
41
|
-
signatureType?: string | undefined;
|
|
40
|
+
service?: string | undefined;
|
|
42
41
|
quote?: Shipping.Quote | undefined;
|
|
43
42
|
}
|
|
44
43
|
namespace Shipping {
|
|
@@ -37,8 +37,7 @@ export declare namespace GetOutboundShipmentsResponse {
|
|
|
37
37
|
country?: string | undefined;
|
|
38
38
|
}
|
|
39
39
|
interface Shipping {
|
|
40
|
-
|
|
41
|
-
signatureType?: string | undefined;
|
|
40
|
+
service?: string | undefined;
|
|
42
41
|
quote?: Shipping.Quote | undefined;
|
|
43
42
|
}
|
|
44
43
|
namespace Shipping {
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
export interface GetRatesOutboundShipmentsResponse {
|
|
2
|
+
data: GetRatesOutboundShipmentsResponse.Data;
|
|
3
|
+
}
|
|
4
|
+
export declare namespace GetRatesOutboundShipmentsResponse {
|
|
5
|
+
interface Data {
|
|
6
|
+
rates: Data.Rates.Item[];
|
|
7
|
+
}
|
|
8
|
+
namespace Data {
|
|
9
|
+
type Rates = Rates.Item[];
|
|
10
|
+
namespace Rates {
|
|
11
|
+
interface Item {
|
|
12
|
+
service: string;
|
|
13
|
+
rate: number;
|
|
14
|
+
deliveryDate: string;
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
}
|
|
@@ -40,8 +40,7 @@ export declare namespace ListOutboundShipmentsResponse {
|
|
|
40
40
|
country?: string | undefined;
|
|
41
41
|
}
|
|
42
42
|
interface Shipping {
|
|
43
|
-
|
|
44
|
-
signatureType?: string | undefined;
|
|
43
|
+
service?: string | undefined;
|
|
45
44
|
quote?: Shipping.Quote | undefined;
|
|
46
45
|
}
|
|
47
46
|
namespace Shipping {
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export * from "./CancelOutboundShipmentsResponse.js";
|
|
2
2
|
export * from "./CreateOutboundShipmentsResponse.js";
|
|
3
3
|
export * from "./GetOutboundShipmentsResponse.js";
|
|
4
|
+
export * from "./GetRatesOutboundShipmentsResponse.js";
|
|
4
5
|
export * from "./ListOutboundShipmentsRequestStatus.js";
|
|
5
6
|
export * from "./ListOutboundShipmentsResponse.js";
|
|
@@ -17,5 +17,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
17
17
|
__exportStar(require("./CancelOutboundShipmentsResponse.js"), exports);
|
|
18
18
|
__exportStar(require("./CreateOutboundShipmentsResponse.js"), exports);
|
|
19
19
|
__exportStar(require("./GetOutboundShipmentsResponse.js"), exports);
|
|
20
|
+
__exportStar(require("./GetRatesOutboundShipmentsResponse.js"), exports);
|
|
20
21
|
__exportStar(require("./ListOutboundShipmentsRequestStatus.js"), exports);
|
|
21
22
|
__exportStar(require("./ListOutboundShipmentsResponse.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.6";
|
package/dist/cjs/version.js
CHANGED
|
@@ -56,6 +56,24 @@ export declare class InboundShipmentsClient {
|
|
|
56
56
|
*/
|
|
57
57
|
get(request: BeachApi.GetInboundShipmentsRequest, requestOptions?: InboundShipmentsClient.RequestOptions): core.HttpResponsePromise<BeachApi.GetInboundShipmentsResponse>;
|
|
58
58
|
private __get;
|
|
59
|
+
/**
|
|
60
|
+
* @param {BeachApi.UpdateInboundShipmentsRequest} request
|
|
61
|
+
* @param {InboundShipmentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link errors.BeachApiError}
|
|
64
|
+
* @throws {@link errors.BeachApiTimeoutError}
|
|
65
|
+
*
|
|
66
|
+
* @example
|
|
67
|
+
* await client.inboundShipments.update({
|
|
68
|
+
* id: "id",
|
|
69
|
+
* lines: [{
|
|
70
|
+
* productId: "productId",
|
|
71
|
+
* quantityDeclared: 1
|
|
72
|
+
* }]
|
|
73
|
+
* })
|
|
74
|
+
*/
|
|
75
|
+
update(request: BeachApi.UpdateInboundShipmentsRequest, requestOptions?: InboundShipmentsClient.RequestOptions): core.HttpResponsePromise<BeachApi.UpdateInboundShipmentsResponse>;
|
|
76
|
+
private __update;
|
|
59
77
|
/**
|
|
60
78
|
* @param {BeachApi.CancelInboundShipmentsRequest} request
|
|
61
79
|
* @param {InboundShipmentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -47,12 +47,13 @@ export class InboundShipmentsClient {
|
|
|
47
47
|
__list() {
|
|
48
48
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
49
49
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
50
|
-
const { page, limit, status, fboAccountId, includeLineItems } = request;
|
|
50
|
+
const { page, limit, status, fboAccountId, trackingNumber, includeLineItems } = request;
|
|
51
51
|
const _queryParams = {
|
|
52
52
|
page,
|
|
53
53
|
limit,
|
|
54
54
|
status: status != null ? status : undefined,
|
|
55
55
|
fboAccountId,
|
|
56
|
+
trackingNumber,
|
|
56
57
|
includeLineItems: Array.isArray(includeLineItems)
|
|
57
58
|
? includeLineItems.map((item) => (typeof item === "string" ? item : toJson(item)))
|
|
58
59
|
: includeLineItems != null
|
|
@@ -206,6 +207,61 @@ export class InboundShipmentsClient {
|
|
|
206
207
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/inbound-shipments/{id}");
|
|
207
208
|
});
|
|
208
209
|
}
|
|
210
|
+
/**
|
|
211
|
+
* @param {BeachApi.UpdateInboundShipmentsRequest} request
|
|
212
|
+
* @param {InboundShipmentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
213
|
+
*
|
|
214
|
+
* @throws {@link errors.BeachApiError}
|
|
215
|
+
* @throws {@link errors.BeachApiTimeoutError}
|
|
216
|
+
*
|
|
217
|
+
* @example
|
|
218
|
+
* await client.inboundShipments.update({
|
|
219
|
+
* id: "id",
|
|
220
|
+
* lines: [{
|
|
221
|
+
* productId: "productId",
|
|
222
|
+
* quantityDeclared: 1
|
|
223
|
+
* }]
|
|
224
|
+
* })
|
|
225
|
+
*/
|
|
226
|
+
update(request, requestOptions) {
|
|
227
|
+
return core.HttpResponsePromise.fromPromise(this.__update(request, requestOptions));
|
|
228
|
+
}
|
|
229
|
+
__update(request, requestOptions) {
|
|
230
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
231
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
232
|
+
const { id } = request, _body = __rest(request, ["id"]);
|
|
233
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
234
|
+
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);
|
|
235
|
+
const _response = yield core.fetcher({
|
|
236
|
+
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/inbound-shipments/${core.url.encodePathParam(id)}`),
|
|
237
|
+
method: "PATCH",
|
|
238
|
+
headers: _headers,
|
|
239
|
+
contentType: "application/json",
|
|
240
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
241
|
+
requestType: "json",
|
|
242
|
+
body: mergeAdditionalBodyParameters(_body, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
|
|
243
|
+
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,
|
|
244
|
+
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,
|
|
245
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
246
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
247
|
+
logging: this._options.logging,
|
|
248
|
+
});
|
|
249
|
+
if (_response.ok) {
|
|
250
|
+
return {
|
|
251
|
+
data: _response.body,
|
|
252
|
+
rawResponse: _response.rawResponse,
|
|
253
|
+
};
|
|
254
|
+
}
|
|
255
|
+
if (_response.error.reason === "status-code") {
|
|
256
|
+
throw new errors.BeachApiError({
|
|
257
|
+
statusCode: _response.error.statusCode,
|
|
258
|
+
body: _response.error.body,
|
|
259
|
+
rawResponse: _response.rawResponse,
|
|
260
|
+
});
|
|
261
|
+
}
|
|
262
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/v1/inbound-shipments/{id}");
|
|
263
|
+
});
|
|
264
|
+
}
|
|
209
265
|
/**
|
|
210
266
|
* @param {BeachApi.CancelInboundShipmentsRequest} request
|
|
211
267
|
* @param {InboundShipmentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
package/dist/esm/api/resources/inboundShipments/client/requests/UpdateInboundShipmentsRequest.d.mts
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* id: "id",
|
|
5
|
+
* lines: [{
|
|
6
|
+
* productId: "productId",
|
|
7
|
+
* quantityDeclared: 1
|
|
8
|
+
* }]
|
|
9
|
+
* }
|
|
10
|
+
*/
|
|
11
|
+
export interface UpdateInboundShipmentsRequest {
|
|
12
|
+
id: string;
|
|
13
|
+
lines: UpdateInboundShipmentsRequest.Lines.Item[];
|
|
14
|
+
}
|
|
15
|
+
export declare namespace UpdateInboundShipmentsRequest {
|
|
16
|
+
type Lines = Lines.Item[];
|
|
17
|
+
namespace Lines {
|
|
18
|
+
interface Item {
|
|
19
|
+
productId: string;
|
|
20
|
+
quantityDeclared: number;
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
}
|
|
@@ -2,3 +2,4 @@ export type { CancelInboundShipmentsRequest } from "./CancelInboundShipmentsRequ
|
|
|
2
2
|
export type { CreateInboundShipmentsRequest } from "./CreateInboundShipmentsRequest.mjs";
|
|
3
3
|
export type { GetInboundShipmentsRequest } from "./GetInboundShipmentsRequest.mjs";
|
|
4
4
|
export type { ListInboundShipmentsRequest } from "./ListInboundShipmentsRequest.mjs";
|
|
5
|
+
export type { UpdateInboundShipmentsRequest } from "./UpdateInboundShipmentsRequest.mjs";
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
export interface UpdateInboundShipmentsResponse {
|
|
2
|
+
data: UpdateInboundShipmentsResponse.Data;
|
|
3
|
+
}
|
|
4
|
+
export declare namespace UpdateInboundShipmentsResponse {
|
|
5
|
+
interface Data {
|
|
6
|
+
id: string;
|
|
7
|
+
fboAccountId: string;
|
|
8
|
+
organizationId: string;
|
|
9
|
+
status: Data.Status;
|
|
10
|
+
shipmentNotes?: string | undefined;
|
|
11
|
+
trackingNumber?: string | undefined;
|
|
12
|
+
carrier?: string | undefined;
|
|
13
|
+
receivedAt?: string | undefined;
|
|
14
|
+
lineItems?: Data.LineItems.Item[] | undefined;
|
|
15
|
+
createdAt: string;
|
|
16
|
+
}
|
|
17
|
+
namespace Data {
|
|
18
|
+
const Status: {
|
|
19
|
+
readonly Created: "created";
|
|
20
|
+
readonly InTransit: "in_transit";
|
|
21
|
+
readonly Processing: "processing";
|
|
22
|
+
readonly Accepted: "accepted";
|
|
23
|
+
readonly Rejected: "rejected";
|
|
24
|
+
readonly Cancelled: "cancelled";
|
|
25
|
+
};
|
|
26
|
+
type Status = (typeof Status)[keyof typeof Status];
|
|
27
|
+
type LineItems = LineItems.Item[];
|
|
28
|
+
namespace LineItems {
|
|
29
|
+
interface Item {
|
|
30
|
+
id: string;
|
|
31
|
+
productId: string;
|
|
32
|
+
quantityDeclared: number;
|
|
33
|
+
quantityReceived?: number | undefined;
|
|
34
|
+
quantityAccepted?: number | undefined;
|
|
35
|
+
quantityRejected?: number | undefined;
|
|
36
|
+
inventoryItemIds: string[];
|
|
37
|
+
checkedInAt?: string | undefined;
|
|
38
|
+
createdAt: string;
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
export var UpdateInboundShipmentsResponse;
|
|
3
|
+
(function (UpdateInboundShipmentsResponse) {
|
|
4
|
+
let Data;
|
|
5
|
+
(function (Data) {
|
|
6
|
+
Data.Status = {
|
|
7
|
+
Created: "created",
|
|
8
|
+
InTransit: "in_transit",
|
|
9
|
+
Processing: "processing",
|
|
10
|
+
Accepted: "accepted",
|
|
11
|
+
Rejected: "rejected",
|
|
12
|
+
Cancelled: "cancelled",
|
|
13
|
+
};
|
|
14
|
+
})(Data = UpdateInboundShipmentsResponse.Data || (UpdateInboundShipmentsResponse.Data = {}));
|
|
15
|
+
})(UpdateInboundShipmentsResponse || (UpdateInboundShipmentsResponse = {}));
|
|
@@ -12,6 +12,23 @@ export declare namespace OutboundShipmentsClient {
|
|
|
12
12
|
export declare class OutboundShipmentsClient {
|
|
13
13
|
protected readonly _options: NormalizedClientOptionsWithAuth<OutboundShipmentsClient.Options>;
|
|
14
14
|
constructor(options: OutboundShipmentsClient.Options);
|
|
15
|
+
/**
|
|
16
|
+
* @param {BeachApi.GetRatesOutboundShipmentsRequest} request
|
|
17
|
+
* @param {OutboundShipmentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
18
|
+
*
|
|
19
|
+
* @throws {@link errors.BeachApiError}
|
|
20
|
+
* @throws {@link errors.BeachApiTimeoutError}
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* await client.outboundShipments.getRates({
|
|
24
|
+
* fboAccountId: "fboAccountId",
|
|
25
|
+
* items: [{
|
|
26
|
+
* inventoryItemId: "inventoryItemId"
|
|
27
|
+
* }]
|
|
28
|
+
* })
|
|
29
|
+
*/
|
|
30
|
+
getRates(request: BeachApi.GetRatesOutboundShipmentsRequest, requestOptions?: OutboundShipmentsClient.RequestOptions): core.HttpResponsePromise<BeachApi.GetRatesOutboundShipmentsResponse>;
|
|
31
|
+
private __getRates;
|
|
15
32
|
/**
|
|
16
33
|
* @param {BeachApi.ListOutboundShipmentsRequest} request
|
|
17
34
|
* @param {OutboundShipmentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -31,6 +31,59 @@ export class OutboundShipmentsClient {
|
|
|
31
31
|
constructor(options) {
|
|
32
32
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
33
33
|
}
|
|
34
|
+
/**
|
|
35
|
+
* @param {BeachApi.GetRatesOutboundShipmentsRequest} request
|
|
36
|
+
* @param {OutboundShipmentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link errors.BeachApiError}
|
|
39
|
+
* @throws {@link errors.BeachApiTimeoutError}
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
* await client.outboundShipments.getRates({
|
|
43
|
+
* fboAccountId: "fboAccountId",
|
|
44
|
+
* items: [{
|
|
45
|
+
* inventoryItemId: "inventoryItemId"
|
|
46
|
+
* }]
|
|
47
|
+
* })
|
|
48
|
+
*/
|
|
49
|
+
getRates(request, requestOptions) {
|
|
50
|
+
return core.HttpResponsePromise.fromPromise(this.__getRates(request, requestOptions));
|
|
51
|
+
}
|
|
52
|
+
__getRates(request, requestOptions) {
|
|
53
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
54
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
55
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
56
|
+
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);
|
|
57
|
+
const _response = yield core.fetcher({
|
|
58
|
+
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/rates"),
|
|
59
|
+
method: "POST",
|
|
60
|
+
headers: _headers,
|
|
61
|
+
contentType: "application/json",
|
|
62
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
63
|
+
requestType: "json",
|
|
64
|
+
body: mergeAdditionalBodyParameters(request, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
|
|
65
|
+
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,
|
|
66
|
+
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,
|
|
67
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
68
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
69
|
+
logging: this._options.logging,
|
|
70
|
+
});
|
|
71
|
+
if (_response.ok) {
|
|
72
|
+
return {
|
|
73
|
+
data: _response.body,
|
|
74
|
+
rawResponse: _response.rawResponse,
|
|
75
|
+
};
|
|
76
|
+
}
|
|
77
|
+
if (_response.error.reason === "status-code") {
|
|
78
|
+
throw new errors.BeachApiError({
|
|
79
|
+
statusCode: _response.error.statusCode,
|
|
80
|
+
body: _response.error.body,
|
|
81
|
+
rawResponse: _response.rawResponse,
|
|
82
|
+
});
|
|
83
|
+
}
|
|
84
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/outbound-shipments/rates");
|
|
85
|
+
});
|
|
86
|
+
}
|
|
34
87
|
/**
|
|
35
88
|
* @param {BeachApi.ListOutboundShipmentsRequest} request
|
|
36
89
|
* @param {OutboundShipmentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -11,6 +11,7 @@ export interface CreateOutboundShipmentsRequest {
|
|
|
11
11
|
fboAccountId: string;
|
|
12
12
|
notes?: string;
|
|
13
13
|
destinationAddress?: CreateOutboundShipmentsRequest.DestinationAddress;
|
|
14
|
+
destinationAddressId?: string;
|
|
14
15
|
shipping?: CreateOutboundShipmentsRequest.Shipping;
|
|
15
16
|
items: CreateOutboundShipmentsRequest.Items.Item[];
|
|
16
17
|
}
|
|
@@ -28,23 +29,7 @@ export declare namespace CreateOutboundShipmentsRequest {
|
|
|
28
29
|
email?: string | undefined;
|
|
29
30
|
}
|
|
30
31
|
interface Shipping {
|
|
31
|
-
|
|
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];
|
|
32
|
+
service?: string | undefined;
|
|
48
33
|
}
|
|
49
34
|
type Items = Items.Item[];
|
|
50
35
|
namespace Items {
|
package/dist/esm/api/resources/outboundShipments/client/requests/CreateOutboundShipmentsRequest.mjs
CHANGED
|
@@ -1,17 +1,2 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
-
export
|
|
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 = {}));
|
|
2
|
+
export {};
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* fboAccountId: "fboAccountId",
|
|
5
|
+
* items: [{
|
|
6
|
+
* inventoryItemId: "inventoryItemId"
|
|
7
|
+
* }]
|
|
8
|
+
* }
|
|
9
|
+
*/
|
|
10
|
+
export interface GetRatesOutboundShipmentsRequest {
|
|
11
|
+
fboAccountId: string;
|
|
12
|
+
destinationAddress?: GetRatesOutboundShipmentsRequest.DestinationAddress;
|
|
13
|
+
destinationAddressId?: string;
|
|
14
|
+
items: GetRatesOutboundShipmentsRequest.Items.Item[];
|
|
15
|
+
}
|
|
16
|
+
export declare namespace GetRatesOutboundShipmentsRequest {
|
|
17
|
+
interface DestinationAddress {
|
|
18
|
+
name?: string | undefined;
|
|
19
|
+
company?: string | undefined;
|
|
20
|
+
street1: string;
|
|
21
|
+
street2?: string | undefined;
|
|
22
|
+
city: string;
|
|
23
|
+
state: string;
|
|
24
|
+
zip: string;
|
|
25
|
+
country: string;
|
|
26
|
+
phone?: string | undefined;
|
|
27
|
+
email?: string | undefined;
|
|
28
|
+
}
|
|
29
|
+
type Items = Items.Item[];
|
|
30
|
+
namespace Items {
|
|
31
|
+
interface Item {
|
|
32
|
+
inventoryItemId: string;
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export type { CancelOutboundShipmentsRequest } from "./CancelOutboundShipmentsRequest.mjs";
|
|
2
|
-
export { CreateOutboundShipmentsRequest } from "./CreateOutboundShipmentsRequest.mjs";
|
|
2
|
+
export type { CreateOutboundShipmentsRequest } from "./CreateOutboundShipmentsRequest.mjs";
|
|
3
3
|
export type { GetOutboundShipmentsRequest } from "./GetOutboundShipmentsRequest.mjs";
|
|
4
|
+
export type { GetRatesOutboundShipmentsRequest } from "./GetRatesOutboundShipmentsRequest.mjs";
|
|
4
5
|
export type { ListOutboundShipmentsRequest } from "./ListOutboundShipmentsRequest.mjs";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export {
|
|
1
|
+
export {};
|
package/dist/esm/api/resources/outboundShipments/types/CancelOutboundShipmentsResponse.d.mts
CHANGED
|
@@ -37,8 +37,7 @@ export declare namespace CancelOutboundShipmentsResponse {
|
|
|
37
37
|
country?: string | undefined;
|
|
38
38
|
}
|
|
39
39
|
interface Shipping {
|
|
40
|
-
|
|
41
|
-
signatureType?: string | undefined;
|
|
40
|
+
service?: string | undefined;
|
|
42
41
|
quote?: Shipping.Quote | undefined;
|
|
43
42
|
}
|
|
44
43
|
namespace Shipping {
|
package/dist/esm/api/resources/outboundShipments/types/CreateOutboundShipmentsResponse.d.mts
CHANGED
|
@@ -37,8 +37,7 @@ export declare namespace CreateOutboundShipmentsResponse {
|
|
|
37
37
|
country?: string | undefined;
|
|
38
38
|
}
|
|
39
39
|
interface Shipping {
|
|
40
|
-
|
|
41
|
-
signatureType?: string | undefined;
|
|
40
|
+
service?: string | undefined;
|
|
42
41
|
quote?: Shipping.Quote | undefined;
|
|
43
42
|
}
|
|
44
43
|
namespace Shipping {
|
|
@@ -37,8 +37,7 @@ export declare namespace GetOutboundShipmentsResponse {
|
|
|
37
37
|
country?: string | undefined;
|
|
38
38
|
}
|
|
39
39
|
interface Shipping {
|
|
40
|
-
|
|
41
|
-
signatureType?: string | undefined;
|
|
40
|
+
service?: string | undefined;
|
|
42
41
|
quote?: Shipping.Quote | undefined;
|
|
43
42
|
}
|
|
44
43
|
namespace Shipping {
|
package/dist/esm/api/resources/outboundShipments/types/GetRatesOutboundShipmentsResponse.d.mts
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
export interface GetRatesOutboundShipmentsResponse {
|
|
2
|
+
data: GetRatesOutboundShipmentsResponse.Data;
|
|
3
|
+
}
|
|
4
|
+
export declare namespace GetRatesOutboundShipmentsResponse {
|
|
5
|
+
interface Data {
|
|
6
|
+
rates: Data.Rates.Item[];
|
|
7
|
+
}
|
|
8
|
+
namespace Data {
|
|
9
|
+
type Rates = Rates.Item[];
|
|
10
|
+
namespace Rates {
|
|
11
|
+
interface Item {
|
|
12
|
+
service: string;
|
|
13
|
+
rate: number;
|
|
14
|
+
deliveryDate: string;
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
}
|
|
@@ -40,8 +40,7 @@ export declare namespace ListOutboundShipmentsResponse {
|
|
|
40
40
|
country?: string | undefined;
|
|
41
41
|
}
|
|
42
42
|
interface Shipping {
|
|
43
|
-
|
|
44
|
-
signatureType?: string | undefined;
|
|
43
|
+
service?: string | undefined;
|
|
45
44
|
quote?: Shipping.Quote | undefined;
|
|
46
45
|
}
|
|
47
46
|
namespace Shipping {
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export * from "./CancelOutboundShipmentsResponse.mjs";
|
|
2
2
|
export * from "./CreateOutboundShipmentsResponse.mjs";
|
|
3
3
|
export * from "./GetOutboundShipmentsResponse.mjs";
|
|
4
|
+
export * from "./GetRatesOutboundShipmentsResponse.mjs";
|
|
4
5
|
export * from "./ListOutboundShipmentsRequestStatus.mjs";
|
|
5
6
|
export * from "./ListOutboundShipmentsResponse.mjs";
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export * from "./CancelOutboundShipmentsResponse.mjs";
|
|
2
2
|
export * from "./CreateOutboundShipmentsResponse.mjs";
|
|
3
3
|
export * from "./GetOutboundShipmentsResponse.mjs";
|
|
4
|
+
export * from "./GetRatesOutboundShipmentsResponse.mjs";
|
|
4
5
|
export * from "./ListOutboundShipmentsRequestStatus.mjs";
|
|
5
6
|
export * from "./ListOutboundShipmentsResponse.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "0.0.
|
|
1
|
+
export declare const SDK_VERSION = "0.0.6";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "0.0.
|
|
1
|
+
export const SDK_VERSION = "0.0.6";
|