@shipengine/connect-carrier-api 2.6.1 → 2.6.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.
Files changed (58) hide show
  1. package/lib/app/carrier-app-definition.d.ts +2 -7
  2. package/lib/app/carrier-app.js +0 -5
  3. package/lib/app/carrier-app.js.map +1 -1
  4. package/lib/app/constants.d.ts +0 -1
  5. package/lib/app/constants.js +0 -1
  6. package/lib/app/constants.js.map +1 -1
  7. package/lib/app/internal/carrier-specification.d.ts +0 -1
  8. package/lib/app/internal/carrier-specification.js +0 -1
  9. package/lib/app/internal/carrier-specification.js.map +1 -1
  10. package/lib/app/internal/metadata.js +0 -3
  11. package/lib/app/internal/metadata.js.map +1 -1
  12. package/lib/app/metadata/carrier.d.ts +0 -2
  13. package/lib/app/metadata/carrier.js +0 -1
  14. package/lib/app/metadata/carrier.js.map +1 -1
  15. package/lib/models/labels/index.d.ts +0 -3
  16. package/lib/models/labels/index.js +0 -3
  17. package/lib/models/labels/index.js.map +1 -1
  18. package/lib/requests/create-label-request.d.ts +2 -3
  19. package/lib/requests/create-label-request.js.map +1 -1
  20. package/lib/requests/index.d.ts +0 -1
  21. package/lib/requests/index.js +0 -1
  22. package/lib/requests/index.js.map +1 -1
  23. package/lib/responses/index.d.ts +0 -1
  24. package/lib/responses/index.js +0 -1
  25. package/lib/responses/index.js.map +1 -1
  26. package/package.json +1 -1
  27. package/spec.json +3871 -4632
  28. package/src/app/carrier-app-definition.ts +0 -9
  29. package/src/app/carrier-app.ts +0 -7
  30. package/src/app/constants.ts +0 -1
  31. package/src/app/internal/carrier-specification.ts +0 -2
  32. package/src/app/internal/metadata.ts +0 -4
  33. package/src/app/metadata/carrier.ts +0 -3
  34. package/src/models/labels/index.ts +0 -3
  35. package/src/requests/create-label-request.ts +1 -4
  36. package/src/requests/index.ts +0 -1
  37. package/src/responses/index.ts +0 -1
  38. package/tsconfig.tsbuildinfo +1 -1
  39. package/lib/models/labels/label-details.d.ts +0 -36
  40. package/lib/models/labels/label-details.js +0 -8
  41. package/lib/models/labels/label-details.js.map +0 -1
  42. package/lib/models/labels/label-payment-result.d.ts +0 -10
  43. package/lib/models/labels/label-payment-result.js +0 -17
  44. package/lib/models/labels/label-payment-result.js.map +0 -1
  45. package/lib/models/labels/label-request.d.ts +0 -35
  46. package/lib/models/labels/label-request.js +0 -3
  47. package/lib/models/labels/label-request.js.map +0 -1
  48. package/lib/requests/create-label-payment-request.d.ts +0 -6
  49. package/lib/requests/create-label-payment-request.js +0 -9
  50. package/lib/requests/create-label-payment-request.js.map +0 -1
  51. package/lib/responses/create-label-payment-response.d.ts +0 -9
  52. package/lib/responses/create-label-payment-response.js +0 -16
  53. package/lib/responses/create-label-payment-response.js.map +0 -1
  54. package/src/models/labels/label-details.ts +0 -55
  55. package/src/models/labels/label-payment-result.ts +0 -17
  56. package/src/models/labels/label-request.ts +0 -53
  57. package/src/requests/create-label-payment-request.ts +0 -7
  58. package/src/responses/create-label-payment-response.ts +0 -14
@@ -1,8 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.LabelDetails = void 0;
4
- /** @description Basic structure for a label */
5
- class LabelDetails {
6
- }
7
- exports.LabelDetails = LabelDetails;
8
- //# sourceMappingURL=label-details.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"label-details.js","sourceRoot":"","sources":["../../../src/models/labels/label-details.ts"],"names":[],"mappings":";;;AAoBA,+CAA+C;AAC/C,MAAa,YAAY;CAiCxB;AAjCD,oCAiCC"}
@@ -1,10 +0,0 @@
1
- import Joi from 'joi';
2
- import { Identifier } from '../identifier';
3
- /** @description Basic structure for a label payment result */
4
- export declare class LabelPaymentResult {
5
- correlation_id: string;
6
- alternative_identifiers: Identifier[];
7
- error_messages?: string[];
8
- warning_messages?: string[];
9
- }
10
- export declare const LabelPaymentResultSchema: Joi.ObjectSchema<any>;
@@ -1,17 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.LabelPaymentResultSchema = exports.LabelPaymentResult = void 0;
4
- const tslib_1 = require("tslib");
5
- const joi_1 = tslib_1.__importDefault(require("joi"));
6
- const identifier_1 = require("../identifier");
7
- /** @description Basic structure for a label payment result */
8
- class LabelPaymentResult {
9
- }
10
- exports.LabelPaymentResult = LabelPaymentResult;
11
- exports.LabelPaymentResultSchema = joi_1.default.object({
12
- correlation_id: joi_1.default.string().required(),
13
- alternative_identifiers: joi_1.default.array().required().items(identifier_1.IdentifierSchema),
14
- error_messages: joi_1.default.array().optional().items(joi_1.default.string()),
15
- warning_messages: joi_1.default.array().optional().items(joi_1.default.string()),
16
- });
17
- //# sourceMappingURL=label-payment-result.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"label-payment-result.js","sourceRoot":"","sources":["../../../src/models/labels/label-payment-result.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,8CAA6D;AAE7D,8DAA8D;AAC9D,MAAa,kBAAkB;CAK9B;AALD,gDAKC;AAEY,QAAA,wBAAwB,GAAG,aAAG,CAAC,MAAM,CAAC;IACjD,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,uBAAuB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,6BAAgB,CAAC;IACvE,cAAc,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC;IAC1D,gBAAgB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC;CAC7D,CAAC,CAAC"}
@@ -1,35 +0,0 @@
1
- import { AdvancedOptions, ConfirmationTypes, FulfillmentPlanDetails, InsuranceProviders, DocumentFormat, LabelLayouts, Package, ReturnLabelDetails, ShipFrom, PudoLocation, ShipFromDisplay, ShipTo, Document, TimeWindow, RelayPointDetails, Identifier } from '..';
2
- /** @description Basic structure for a request to create a label */
3
- export interface LabelRequest {
4
- service_code?: string;
5
- ship_datetime: string;
6
- confirmation?: ConfirmationTypes;
7
- label_format?: DocumentFormat;
8
- label_layout?: LabelLayouts;
9
- /** @description Whether the request is for a test */
10
- is_test_label?: boolean;
11
- /** @description Any additional options a shipment may require, including custom options */
12
- advanced_options?: AdvancedOptions;
13
- insurance_provider?: InsuranceProviders;
14
- /** @description Whether the shipment is a return */
15
- is_return_label: boolean;
16
- packages: Package[];
17
- ship_to: ShipTo;
18
- ship_from: ShipFrom;
19
- pickup_location?: PudoLocation;
20
- relay_points?: RelayPointDetails;
21
- ship_from_display?: ShipFromDisplay;
22
- /** @description Whether the shipment requires next day shipping */
23
- next_day?: boolean;
24
- /** @description Whether the shipment is international */
25
- international?: boolean;
26
- reference?: string;
27
- return_details?: ReturnLabelDetails;
28
- fulfillment_plan_details?: FulfillmentPlanDetails;
29
- attachments?: Document[];
30
- /** @description The carrier pickup window is the time designated when the carrier will pickup your package from the initial location */
31
- carrier_pickup_window?: TimeWindow;
32
- /** @description Unique identifier for the carrier rate */
33
- carrier_rate_id?: string;
34
- alternative_identifiers?: Identifier[];
35
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=label-request.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"label-request.js","sourceRoot":"","sources":["../../../src/models/labels/label-request.ts"],"names":[],"mappings":""}
@@ -1,6 +0,0 @@
1
- import { BaseRequest } from './base-request';
2
- import { LabelDetails } from '../models';
3
- /** @description Basic structure for a request to create one or more label payments */
4
- export declare class CreateLabelPaymentRequest extends BaseRequest {
5
- labels: LabelDetails[];
6
- }
@@ -1,9 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.CreateLabelPaymentRequest = void 0;
4
- const base_request_1 = require("./base-request");
5
- /** @description Basic structure for a request to create one or more label payments */
6
- class CreateLabelPaymentRequest extends base_request_1.BaseRequest {
7
- }
8
- exports.CreateLabelPaymentRequest = CreateLabelPaymentRequest;
9
- //# sourceMappingURL=create-label-payment-request.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"create-label-payment-request.js","sourceRoot":"","sources":["../../src/requests/create-label-payment-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAG7C,sFAAsF;AACtF,MAAa,yBAA0B,SAAQ,0BAAW;CAEzD;AAFD,8DAEC"}
@@ -1,9 +0,0 @@
1
- import Joi from 'joi';
2
- import { BaseResponse } from './base-response';
3
- import { LabelPaymentResult } from '../models';
4
- /** @description Basic structure for a response to create a label */
5
- export declare class CreateLabelPaymentResponse extends BaseResponse {
6
- transaction_id: string;
7
- results: LabelPaymentResult[];
8
- }
9
- export declare const CreateLabelPaymentResponseSchema: Joi.ObjectSchema<any>;
@@ -1,16 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.CreateLabelPaymentResponseSchema = exports.CreateLabelPaymentResponse = void 0;
4
- const tslib_1 = require("tslib");
5
- const joi_1 = tslib_1.__importDefault(require("joi"));
6
- const base_response_1 = require("./base-response");
7
- const models_1 = require("../models");
8
- /** @description Basic structure for a response to create a label */
9
- class CreateLabelPaymentResponse extends base_response_1.BaseResponse {
10
- }
11
- exports.CreateLabelPaymentResponse = CreateLabelPaymentResponse;
12
- exports.CreateLabelPaymentResponseSchema = base_response_1.BaseResponseSchema.keys({
13
- transaction_id: joi_1.default.string().required(),
14
- results: joi_1.default.array().required().items(models_1.LabelPaymentResultSchema),
15
- });
16
- //# sourceMappingURL=create-label-payment-response.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"create-label-payment-response.js","sourceRoot":"","sources":["../../src/responses/create-label-payment-response.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,mDAAmE;AACnE,sCAAyE;AAEzE,oEAAoE;AACpE,MAAa,0BAA2B,SAAQ,4BAAY;CAG3D;AAHD,gEAGC;AAEY,QAAA,gCAAgC,GAAG,kCAAkB,CAAC,IAAI,CAAC;IACtE,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,OAAO,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,iCAAwB,CAAC;CAChE,CAAC,CAAC"}
@@ -1,55 +0,0 @@
1
- import {
2
- ConfirmationTypes,
3
- Document,
4
- DocumentFormat,
5
- LabelRequest,
6
- LabelLayouts,
7
- AdvancedOptions,
8
- InsuranceProviders,
9
- Package,
10
- ShipTo,
11
- ShipFrom,
12
- PudoLocation,
13
- RelayPointDetails,
14
- ShipFromDisplay,
15
- ReturnLabelDetails,
16
- FulfillmentPlanDetails,
17
- TimeWindow,
18
- Identifier,
19
- } from '..';
20
-
21
- /** @description Basic structure for a label */
22
- export class LabelDetails implements LabelRequest {
23
- correlation_id!: string;
24
- service_code?: string;
25
- ship_datetime!: string;
26
- confirmation?: ConfirmationTypes;
27
- label_format?: DocumentFormat;
28
- label_layout?: LabelLayouts;
29
- /** @description Whether the request is for a test */
30
- is_test_label?: boolean;
31
- /** @description Any additional options a shipment may require, including custom options */
32
- advanced_options?: AdvancedOptions;
33
- insurance_provider?: InsuranceProviders;
34
- /** @description Whether the shipment is a return */
35
- is_return_label!: boolean;
36
- packages!: Package[];
37
- ship_to!: ShipTo;
38
- ship_from!: ShipFrom;
39
- pickup_location?: PudoLocation;
40
- relay_points?: RelayPointDetails;
41
- ship_from_display?: ShipFromDisplay;
42
- /** @description Whether the shipment requires next day shipping */
43
- next_day?: boolean;
44
- /** @description Whether the shipment is international */
45
- international?: boolean;
46
- reference?: string;
47
- return_details?: ReturnLabelDetails;
48
- fulfillment_plan_details?: FulfillmentPlanDetails;
49
- attachments?: Document[];
50
- /** @description The carrier pickup window is the time designated when the carrier will pickup your package from the initial location */
51
- carrier_pickup_window?: TimeWindow;
52
- /** @description Unique identifier for the carrier rate */
53
- carrier_rate_id?: string;
54
- alternative_identifiers?: Identifier[];
55
- }
@@ -1,17 +0,0 @@
1
- import Joi from 'joi';
2
- import { Identifier, IdentifierSchema } from '../identifier';
3
-
4
- /** @description Basic structure for a label payment result */
5
- export class LabelPaymentResult {
6
- correlation_id!: string;
7
- alternative_identifiers!: Identifier[];
8
- error_messages?: string[];
9
- warning_messages?: string[];
10
- }
11
-
12
- export const LabelPaymentResultSchema = Joi.object({
13
- correlation_id: Joi.string().required(),
14
- alternative_identifiers: Joi.array().required().items(IdentifierSchema),
15
- error_messages: Joi.array().optional().items(Joi.string()),
16
- warning_messages: Joi.array().optional().items(Joi.string()),
17
- });
@@ -1,53 +0,0 @@
1
- import {
2
- AdvancedOptions,
3
- ConfirmationTypes,
4
- FulfillmentPlanDetails,
5
- InsuranceProviders,
6
- DocumentFormat,
7
- LabelLayouts,
8
- Package,
9
- ReturnLabelDetails,
10
- ShipFrom,
11
- PudoLocation,
12
- ShipFromDisplay,
13
- ShipTo,
14
- Document,
15
- TimeWindow,
16
- RelayPointDetails,
17
- Identifier,
18
- } from '..';
19
-
20
- /** @description Basic structure for a request to create a label */
21
- export interface LabelRequest {
22
- service_code?: string;
23
- ship_datetime: string;
24
- confirmation?: ConfirmationTypes;
25
- label_format?: DocumentFormat;
26
- label_layout?: LabelLayouts;
27
- /** @description Whether the request is for a test */
28
- is_test_label?: boolean;
29
- /** @description Any additional options a shipment may require, including custom options */
30
- advanced_options?: AdvancedOptions;
31
- insurance_provider?: InsuranceProviders;
32
- /** @description Whether the shipment is a return */
33
- is_return_label: boolean;
34
- packages: Package[];
35
- ship_to: ShipTo;
36
- ship_from: ShipFrom;
37
- pickup_location?: PudoLocation;
38
- relay_points?: RelayPointDetails;
39
- ship_from_display?: ShipFromDisplay;
40
- /** @description Whether the shipment requires next day shipping */
41
- next_day?: boolean;
42
- /** @description Whether the shipment is international */
43
- international?: boolean;
44
- reference?: string;
45
- return_details?: ReturnLabelDetails;
46
- fulfillment_plan_details?: FulfillmentPlanDetails;
47
- attachments?: Document[];
48
- /** @description The carrier pickup window is the time designated when the carrier will pickup your package from the initial location */
49
- carrier_pickup_window?: TimeWindow;
50
- /** @description Unique identifier for the carrier rate */
51
- carrier_rate_id?: string;
52
- alternative_identifiers?: Identifier[];
53
- }
@@ -1,7 +0,0 @@
1
- import { BaseRequest } from './base-request';
2
- import { LabelDetails } from '../models';
3
-
4
- /** @description Basic structure for a request to create one or more label payments */
5
- export class CreateLabelPaymentRequest extends BaseRequest {
6
- labels!: LabelDetails[];
7
- }
@@ -1,14 +0,0 @@
1
- import Joi from 'joi';
2
- import { BaseResponse, BaseResponseSchema } from './base-response';
3
- import { LabelPaymentResult, LabelPaymentResultSchema } from '../models';
4
-
5
- /** @description Basic structure for a response to create a label */
6
- export class CreateLabelPaymentResponse extends BaseResponse {
7
- transaction_id!: string;
8
- results!: LabelPaymentResult[];
9
- }
10
-
11
- export const CreateLabelPaymentResponseSchema = BaseResponseSchema.keys({
12
- transaction_id: Joi.string().required(),
13
- results: Joi.array().required().items(LabelPaymentResultSchema),
14
- });