@shipengine/connect-carrier-api 4.8.6 → 4.8.7
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/lib/models/service-points/day-of-operation-schema.d.ts +2 -0
- package/lib/models/service-points/day-of-operation-schema.js +10 -0
- package/lib/models/service-points/day-of-operation-schema.js.map +1 -0
- package/lib/models/service-points/day-of-operation.d.ts +7 -0
- package/lib/models/service-points/day-of-operation.js +12 -0
- package/lib/models/service-points/day-of-operation.js.map +1 -0
- package/lib/models/service-points/service-point.d.ts +6 -0
- package/lib/models/service-points/service-point.js +4 -0
- package/lib/models/service-points/service-point.js.map +1 -1
- package/lib/models/service-points/special-opening-time-schema.d.ts +2 -0
- package/lib/models/service-points/special-opening-time-schema.js +12 -0
- package/lib/models/service-points/special-opening-time-schema.js.map +1 -0
- package/lib/models/service-points/special-opening-time.d.ts +10 -0
- package/lib/models/service-points/special-opening-time.js +14 -0
- package/lib/models/service-points/special-opening-time.js.map +1 -0
- package/package.json +1 -1
- package/spec.json +59 -1
- package/src/models/service-points/day-of-operation-schema.ts +6 -0
- package/src/models/service-points/day-of-operation.ts +7 -0
- package/src/models/service-points/service-point.ts +6 -0
- package/src/models/service-points/special-opening-time-schema.ts +8 -0
- package/src/models/service-points/special-opening-time.ts +11 -0
- package/tsconfig.tsbuildinfo +1 -1
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.DayOfOperationSchema = void 0;
|
|
4
|
+
const tslib_1 = require("tslib");
|
|
5
|
+
const joi_1 = tslib_1.__importDefault(require("joi"));
|
|
6
|
+
exports.DayOfOperationSchema = joi_1.default.object({
|
|
7
|
+
start: joi_1.default.string().optional().empty(),
|
|
8
|
+
end: joi_1.default.string().optional().empty(),
|
|
9
|
+
});
|
|
10
|
+
//# sourceMappingURL=day-of-operation-schema.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"day-of-operation-schema.js","sourceRoot":"","sources":["../../../src/models/service-points/day-of-operation-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAET,QAAA,oBAAoB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC7C,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACtC,GAAG,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CACrC,CAAC,CAAC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/** @description Indicates a specific date window that a service point is open */
|
|
2
|
+
export declare class DayOfOperation {
|
|
3
|
+
/** @description The starting day expressed in ISO 8601 date(yyyy-mm-dd) only format */
|
|
4
|
+
start?: string;
|
|
5
|
+
/** @description The close time expressed in ISO 8601 date(yyyy-mm-dd) only format */
|
|
6
|
+
end?: string;
|
|
7
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.DayOfOperation = void 0;
|
|
4
|
+
/** @description Indicates a specific date window that a service point is open */
|
|
5
|
+
class DayOfOperation {
|
|
6
|
+
/** @description The starting day expressed in ISO 8601 date(yyyy-mm-dd) only format */
|
|
7
|
+
start;
|
|
8
|
+
/** @description The close time expressed in ISO 8601 date(yyyy-mm-dd) only format */
|
|
9
|
+
end;
|
|
10
|
+
}
|
|
11
|
+
exports.DayOfOperation = DayOfOperation;
|
|
12
|
+
//# sourceMappingURL=day-of-operation.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"day-of-operation.js","sourceRoot":"","sources":["../../../src/models/service-points/day-of-operation.ts"],"names":[],"mappings":";;;AAAA,iFAAiF;AACjF,MAAa,cAAc;IACzB,uFAAuF;IACvF,KAAK,CAAU;IACf,qFAAqF;IACrF,GAAG,CAAU;CACd;AALD,wCAKC"}
|
|
@@ -2,6 +2,8 @@ import { ServicePointFeaturesEnum } from '../../app/metadata/service-point-featu
|
|
|
2
2
|
import { ServicePointLocationTypeEnum } from '../../app/metadata/service-point-location-type';
|
|
3
3
|
import { ServicePointResponseAddress } from './service-point-response-address';
|
|
4
4
|
import { WeeklyHoursOfOperation } from './weekly-hours-of-operation';
|
|
5
|
+
import { DayOfOperation } from './day-of-operation';
|
|
6
|
+
import { SpecialOpeningTime } from './special-opening-time';
|
|
5
7
|
/** @description Basic structure for a service point */
|
|
6
8
|
export declare class ServicePoint {
|
|
7
9
|
/** @description The identifier for the carrier's service point */
|
|
@@ -12,6 +14,10 @@ export declare class ServicePoint {
|
|
|
12
14
|
hours_of_operation: WeeklyHoursOfOperation;
|
|
13
15
|
/** @description Features supported by the service point */
|
|
14
16
|
features?: ServicePointFeaturesEnum[];
|
|
17
|
+
/** @description Temporary closures days */
|
|
18
|
+
temporary_closures?: DayOfOperation[];
|
|
19
|
+
/** @description Special opening times */
|
|
20
|
+
special_opening_times?: SpecialOpeningTime[];
|
|
15
21
|
/** @description Location type like PUDOs, parcelshops, postoffices, lockers, retailers own stores etc. */
|
|
16
22
|
type?: ServicePointLocationTypeEnum;
|
|
17
23
|
}
|
|
@@ -11,6 +11,10 @@ class ServicePoint {
|
|
|
11
11
|
hours_of_operation;
|
|
12
12
|
/** @description Features supported by the service point */
|
|
13
13
|
features;
|
|
14
|
+
/** @description Temporary closures days */
|
|
15
|
+
temporary_closures;
|
|
16
|
+
/** @description Special opening times */
|
|
17
|
+
special_opening_times;
|
|
14
18
|
/** @description Location type like PUDOs, parcelshops, postoffices, lockers, retailers own stores etc. */
|
|
15
19
|
type;
|
|
16
20
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"service-point.js","sourceRoot":"","sources":["../../../src/models/service-points/service-point.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"service-point.js","sourceRoot":"","sources":["../../../src/models/service-points/service-point.ts"],"names":[],"mappings":";;;AAOA,uDAAuD;AACvD,MAAa,YAAY;IACvB,kEAAkE;IAClE,gBAAgB,CAAU;IAC1B,kEAAkE;IAClE,OAAO,CAA+B;IACtC,mEAAmE;IACnE,kBAAkB,CAA0B;IAC5C,2DAA2D;IAC3D,QAAQ,CAA8B;IACtC,2CAA2C;IAC3C,kBAAkB,CAAoB;IACtC,yCAAyC;IACzC,qBAAqB,CAAwB;IAC7C,0GAA0G;IAC1G,IAAI,CAAgC;CACrC;AAfD,oCAeC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.SpecialOpeningTimeSchema = void 0;
|
|
4
|
+
const tslib_1 = require("tslib");
|
|
5
|
+
const joi_1 = tslib_1.__importDefault(require("joi"));
|
|
6
|
+
const hours_of_operation_schema_1 = require("./hours-of-operation-schema");
|
|
7
|
+
exports.SpecialOpeningTimeSchema = joi_1.default.object({
|
|
8
|
+
start: joi_1.default.string().optional().empty(),
|
|
9
|
+
end: joi_1.default.string().optional().empty(),
|
|
10
|
+
hours_of_operation: hours_of_operation_schema_1.HoursOfOperationSchema.optional(),
|
|
11
|
+
});
|
|
12
|
+
//# sourceMappingURL=special-opening-time-schema.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"special-opening-time-schema.js","sourceRoot":"","sources":["../../../src/models/service-points/special-opening-time-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,2EAAqE;AAExD,QAAA,wBAAwB,GAAG,aAAG,CAAC,MAAM,CAAC;IACjD,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACtC,GAAG,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACpC,kBAAkB,EAAE,kDAAsB,CAAC,QAAQ,EAAE;CACtD,CAAC,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { HoursOfOperation } from './hours-of-operation';
|
|
2
|
+
/** @description Indicates a specific date window that a service point is open with opening hours */
|
|
3
|
+
export declare class SpecialOpeningTime {
|
|
4
|
+
/** @description The starting day expressed in ISO 8601 date(yyyy-mm-dd) only format */
|
|
5
|
+
start?: string;
|
|
6
|
+
/** @description The close time expressed in ISO 8601 date(yyyy-mm-dd) only format */
|
|
7
|
+
end?: string;
|
|
8
|
+
/** @description The opening hours */
|
|
9
|
+
hours_of_operation?: HoursOfOperation[];
|
|
10
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.SpecialOpeningTime = void 0;
|
|
4
|
+
/** @description Indicates a specific date window that a service point is open with opening hours */
|
|
5
|
+
class SpecialOpeningTime {
|
|
6
|
+
/** @description The starting day expressed in ISO 8601 date(yyyy-mm-dd) only format */
|
|
7
|
+
start;
|
|
8
|
+
/** @description The close time expressed in ISO 8601 date(yyyy-mm-dd) only format */
|
|
9
|
+
end;
|
|
10
|
+
/** @description The opening hours */
|
|
11
|
+
hours_of_operation;
|
|
12
|
+
}
|
|
13
|
+
exports.SpecialOpeningTime = SpecialOpeningTime;
|
|
14
|
+
//# sourceMappingURL=special-opening-time.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"special-opening-time.js","sourceRoot":"","sources":["../../../src/models/service-points/special-opening-time.ts"],"names":[],"mappings":";;;AAEA,oGAAoG;AACpG,MAAa,kBAAkB;IAC7B,uFAAuF;IACvF,KAAK,CAAU;IACf,qFAAqF;IACrF,GAAG,CAAU;IACb,qCAAqC;IACrC,kBAAkB,CAAsB;CACzC;AAPD,gDAOC"}
|
package/package.json
CHANGED
package/spec.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Shipping API",
|
|
5
5
|
"description": "This API specification describes the canonical ShipEngine Shipping API connector module.",
|
|
6
|
-
"version": "1.22.
|
|
6
|
+
"version": "1.22.2"
|
|
7
7
|
},
|
|
8
8
|
"paths": {
|
|
9
9
|
"/Register": {
|
|
@@ -2041,6 +2041,24 @@
|
|
|
2041
2041
|
"additionalProperties": false,
|
|
2042
2042
|
"description": "This model represents contact information regarding dangerous goods"
|
|
2043
2043
|
},
|
|
2044
|
+
"DayOfOperation": {
|
|
2045
|
+
"type": "object",
|
|
2046
|
+
"properties": {
|
|
2047
|
+
"start": {
|
|
2048
|
+
"type": "string",
|
|
2049
|
+
"description": "The start date expressed in ISO 8601 date only format",
|
|
2050
|
+
"nullable": true,
|
|
2051
|
+
"example": "2024-01-25"
|
|
2052
|
+
},
|
|
2053
|
+
"end": {
|
|
2054
|
+
"type": "string",
|
|
2055
|
+
"description": "The end date expressed in ISO 8601 date only format",
|
|
2056
|
+
"nullable": true,
|
|
2057
|
+
"example": "2024-01-27"
|
|
2058
|
+
}
|
|
2059
|
+
},
|
|
2060
|
+
"additionalProperties": false
|
|
2061
|
+
},
|
|
2044
2062
|
"DimensionDetails": {
|
|
2045
2063
|
"type": "object",
|
|
2046
2064
|
"properties": {
|
|
@@ -3832,6 +3850,20 @@
|
|
|
3832
3850
|
},
|
|
3833
3851
|
"nullable": true
|
|
3834
3852
|
},
|
|
3853
|
+
"temporary_closures": {
|
|
3854
|
+
"type": "array",
|
|
3855
|
+
"items": {
|
|
3856
|
+
"$ref": "#/components/schemas/DayOfOperation"
|
|
3857
|
+
},
|
|
3858
|
+
"nullable": true
|
|
3859
|
+
},
|
|
3860
|
+
"special_opening_times": {
|
|
3861
|
+
"type": "array",
|
|
3862
|
+
"items": {
|
|
3863
|
+
"$ref": "#/components/schemas/SpecialOpeningTime"
|
|
3864
|
+
},
|
|
3865
|
+
"nullable": true
|
|
3866
|
+
},
|
|
3835
3867
|
"type": {
|
|
3836
3868
|
"$ref": "#/components/schemas/ServicePointLocationType"
|
|
3837
3869
|
}
|
|
@@ -4198,6 +4230,32 @@
|
|
|
4198
4230
|
"additionalProperties": false,
|
|
4199
4231
|
"description": "This model represents a shipment that has already been shipped, and contains\r\nsummary information about the shipment."
|
|
4200
4232
|
},
|
|
4233
|
+
"SpecialOpeningTime": {
|
|
4234
|
+
"type": "object",
|
|
4235
|
+
"properties": {
|
|
4236
|
+
"start": {
|
|
4237
|
+
"type": "string",
|
|
4238
|
+
"description": "The start date expressed in ISO 8601 date only format",
|
|
4239
|
+
"nullable": true,
|
|
4240
|
+
"example": "2024-01-25"
|
|
4241
|
+
},
|
|
4242
|
+
"end": {
|
|
4243
|
+
"type": "string",
|
|
4244
|
+
"description": "The end date expressed in ISO 8601 date only format",
|
|
4245
|
+
"nullable": true,
|
|
4246
|
+
"example": "2024-01-27"
|
|
4247
|
+
},
|
|
4248
|
+
"hours_of_operation": {
|
|
4249
|
+
"type": "array",
|
|
4250
|
+
"items": {
|
|
4251
|
+
"$ref": "#/components/schemas/HoursOfOperation"
|
|
4252
|
+
},
|
|
4253
|
+
"description": "The opening hours",
|
|
4254
|
+
"nullable": true
|
|
4255
|
+
}
|
|
4256
|
+
},
|
|
4257
|
+
"additionalProperties": false
|
|
4258
|
+
},
|
|
4201
4259
|
"StandardizedStatusCodes": {
|
|
4202
4260
|
"enum": [
|
|
4203
4261
|
"UN",
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/** @description Indicates a specific date window that a service point is open */
|
|
2
|
+
export class DayOfOperation {
|
|
3
|
+
/** @description The starting day expressed in ISO 8601 date(yyyy-mm-dd) only format */
|
|
4
|
+
start?: string;
|
|
5
|
+
/** @description The close time expressed in ISO 8601 date(yyyy-mm-dd) only format */
|
|
6
|
+
end?: string;
|
|
7
|
+
}
|
|
@@ -2,6 +2,8 @@ import { ServicePointFeaturesEnum } from '../../app/metadata/service-point-featu
|
|
|
2
2
|
import { ServicePointLocationTypeEnum } from '../../app/metadata/service-point-location-type';
|
|
3
3
|
import { ServicePointResponseAddress } from './service-point-response-address';
|
|
4
4
|
import { WeeklyHoursOfOperation } from './weekly-hours-of-operation';
|
|
5
|
+
import { DayOfOperation } from './day-of-operation';
|
|
6
|
+
import { SpecialOpeningTime } from './special-opening-time';
|
|
5
7
|
|
|
6
8
|
/** @description Basic structure for a service point */
|
|
7
9
|
export class ServicePoint {
|
|
@@ -13,6 +15,10 @@ export class ServicePoint {
|
|
|
13
15
|
hours_of_operation!: WeeklyHoursOfOperation;
|
|
14
16
|
/** @description Features supported by the service point */
|
|
15
17
|
features?: ServicePointFeaturesEnum[];
|
|
18
|
+
/** @description Temporary closures days */
|
|
19
|
+
temporary_closures?: DayOfOperation[];
|
|
20
|
+
/** @description Special opening times */
|
|
21
|
+
special_opening_times?: SpecialOpeningTime[];
|
|
16
22
|
/** @description Location type like PUDOs, parcelshops, postoffices, lockers, retailers own stores etc. */
|
|
17
23
|
type?: ServicePointLocationTypeEnum;
|
|
18
24
|
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import Joi from 'joi';
|
|
2
|
+
import { HoursOfOperationSchema } from './hours-of-operation-schema';
|
|
3
|
+
|
|
4
|
+
export const SpecialOpeningTimeSchema = Joi.object({
|
|
5
|
+
start: Joi.string().optional().empty(),
|
|
6
|
+
end: Joi.string().optional().empty(),
|
|
7
|
+
hours_of_operation: HoursOfOperationSchema.optional(),
|
|
8
|
+
});
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { HoursOfOperation } from './hours-of-operation';
|
|
2
|
+
|
|
3
|
+
/** @description Indicates a specific date window that a service point is open with opening hours */
|
|
4
|
+
export class SpecialOpeningTime {
|
|
5
|
+
/** @description The starting day expressed in ISO 8601 date(yyyy-mm-dd) only format */
|
|
6
|
+
start?: string;
|
|
7
|
+
/** @description The close time expressed in ISO 8601 date(yyyy-mm-dd) only format */
|
|
8
|
+
end?: string;
|
|
9
|
+
/** @description The opening hours */
|
|
10
|
+
hours_of_operation?: HoursOfOperation[];
|
|
11
|
+
}
|