@shipengine/connect-carrier-api 4.14.1 → 4.14.3

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.
@@ -2,6 +2,8 @@ import { CollectOnDelivery } from './collect-on-delivery';
2
2
  import { Currency } from './currency';
3
3
  import { DangerousGoodsContact } from './dangerous-good/dangerous-goods-contact';
4
4
  import { WindsorFrameworkDetails } from './windsor-framework/windsor_framework_details';
5
+ import { AccessibilityTypes } from './accessibility-types';
6
+ import { Signatory } from './signatory';
5
7
  /** @description Basic structure for shipping options */
6
8
  export declare class AdvancedOptions {
7
9
  /** @description Whether the shipment contains alcohol */
@@ -32,6 +34,10 @@ export declare class AdvancedOptions {
32
34
  event_notification?: boolean;
33
35
  /** @description Any other custom shipping options */
34
36
  windsor_framework_details?: WindsorFrameworkDetails;
37
+ /** @description Identifies whatever the product being shipped is accessible or inaccessible during delivery.*/
38
+ accessibility?: AccessibilityTypes;
39
+ /** @description Specify the name, title and place of the signatory responsible for the dangerous goods shipment. */
40
+ signatory?: Signatory;
35
41
  /** @description Indicates whether the recipient should be notified of events related to the shipment. */
36
42
  [key: string]: any;
37
43
  }
@@ -31,6 +31,10 @@ class AdvancedOptions {
31
31
  event_notification;
32
32
  /** @description Any other custom shipping options */
33
33
  windsor_framework_details;
34
+ /** @description Identifies whatever the product being shipped is accessible or inaccessible during delivery.*/
35
+ accessibility;
36
+ /** @description Specify the name, title and place of the signatory responsible for the dangerous goods shipment. */
37
+ signatory;
34
38
  }
35
39
  exports.AdvancedOptions = AdvancedOptions;
36
40
  //# sourceMappingURL=advanced-options.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"advanced-options.js","sourceRoot":"","sources":["../../src/models/advanced-options.ts"],"names":[],"mappings":";;;AAKA,wDAAwD;AACxD,MAAa,eAAe;IAC1B,yDAAyD;IACzD,gBAAgB,CAAW;IAC3B,iEAAiE;IACjE,UAAU,CAAW;IACrB,oEAAoE;IACpE,cAAc,CAAW;IACzB,8EAA8E;IAC9E,qBAAqB,CAAW;IAChC,6DAA6D;IAC7D,iBAAiB,CAAW;IAC5B,iGAAiG;IACjG,GAAG,CAAY;IACf,wFAAwF;IACxF,mBAAmB,CAAW;IAC9B,iGAAiG;IACjG,mBAAmB,CAAqB;IACxC,8IAA8I;IAC9I,mBAAmB,CAAW;IAC9B,iFAAiF;IACjF,eAAe,CAAW;IAC1B,2DAA2D;IAC3D,uBAAuB,CAAyB;IAChD,+HAA+H;IAC/H,gBAAgB,CAAW;IAC3B,qDAAqD;IACrD,kBAAkB,CAAW;IAC7B,qDAAqD;IACrD,yBAAyB,CAA2B;CAGrD;AA/BD,0CA+BC"}
1
+ {"version":3,"file":"advanced-options.js","sourceRoot":"","sources":["../../src/models/advanced-options.ts"],"names":[],"mappings":";;;AAOA,wDAAwD;AACxD,MAAa,eAAe;IAC1B,yDAAyD;IACzD,gBAAgB,CAAW;IAC3B,iEAAiE;IACjE,UAAU,CAAW;IACrB,oEAAoE;IACpE,cAAc,CAAW;IACzB,8EAA8E;IAC9E,qBAAqB,CAAW;IAChC,6DAA6D;IAC7D,iBAAiB,CAAW;IAC5B,iGAAiG;IACjG,GAAG,CAAY;IACf,wFAAwF;IACxF,mBAAmB,CAAW;IAC9B,iGAAiG;IACjG,mBAAmB,CAAqB;IACxC,8IAA8I;IAC9I,mBAAmB,CAAW;IAC9B,iFAAiF;IACjF,eAAe,CAAW;IAC1B,2DAA2D;IAC3D,uBAAuB,CAAyB;IAChD,+HAA+H;IAC/H,gBAAgB,CAAW;IAC3B,qDAAqD;IACrD,kBAAkB,CAAW;IAC7B,qDAAqD;IACrD,yBAAyB,CAA2B;IACpD,+GAA+G;IAC/G,aAAa,CAAsB;IACnC,oHAAoH;IACpH,SAAS,CAAa;CAGvB;AAnCD,0CAmCC"}
@@ -0,0 +1,7 @@
1
+ /** @description This model specifies whether the payment is required before the delivery of goods or services or if credit is extended to the customer.*/
2
+ export declare enum PaymentTerms {
3
+ /** @description Payment must be made in full before the goods or services are delivered.*/
4
+ Prepaid = "prepaid",
5
+ /** @description Payment is deferred, allowing the customer to settle the invoice at a later agreed-upon date.*/
6
+ Credit = "credit"
7
+ }
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.PaymentTerms = void 0;
4
+ /** @description This model specifies whether the payment is required before the delivery of goods or services or if credit is extended to the customer.*/
5
+ var PaymentTerms;
6
+ (function (PaymentTerms) {
7
+ /** @description Payment must be made in full before the goods or services are delivered.*/
8
+ PaymentTerms["Prepaid"] = "prepaid";
9
+ /** @description Payment is deferred, allowing the customer to settle the invoice at a later agreed-upon date.*/
10
+ PaymentTerms["Credit"] = "credit";
11
+ })(PaymentTerms || (exports.PaymentTerms = PaymentTerms = {}));
12
+ //# sourceMappingURL=payment-terms.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"payment-terms.js","sourceRoot":"","sources":["../../src/models/payment-terms.ts"],"names":[],"mappings":";;;AAAA,0JAA0J;AAC1J,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,2FAA2F;IAC3F,mCAAmB,CAAA;IACnB,gHAAgH;IAChH,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB"}
@@ -0,0 +1,9 @@
1
+ /** @description Specify the name, title and place of the signatory responsible for the dangerous goods shipment. */
2
+ export declare class Signatory {
3
+ /** @description Name of the signatory. */
4
+ contact_name?: string;
5
+ /** @description Title of the signatory. */
6
+ title?: string;
7
+ /** @description Place of the signatory. */
8
+ place?: string;
9
+ }
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Signatory = void 0;
4
+ /** @description Specify the name, title and place of the signatory responsible for the dangerous goods shipment. */
5
+ class Signatory {
6
+ /** @description Name of the signatory. */
7
+ contact_name;
8
+ /** @description Title of the signatory. */
9
+ title;
10
+ /** @description Place of the signatory. */
11
+ place;
12
+ }
13
+ exports.Signatory = Signatory;
14
+ //# sourceMappingURL=signatory.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"signatory.js","sourceRoot":"","sources":["../../src/models/signatory.ts"],"names":[],"mappings":";;;AAAA,oHAAoH;AACpH,MAAa,SAAS;IACpB,0CAA0C;IAC1C,YAAY,CAAU;IACtB,2CAA2C;IAC3C,KAAK,CAAU;IACf,2CAA2C;IAC3C,KAAK,CAAU;CAChB;AAPD,8BAOC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shipengine/connect-carrier-api",
3
- "version": "4.14.1",
3
+ "version": "4.14.3",
4
4
  "description": "This is the typescript/javascript definitions for carrier api",
5
5
  "homepage": "https://connect.shipengine.com",
6
6
  "main": "./lib/index.js",
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.27.0"
6
+ "version": "1.27.2"
7
7
  },
8
8
  "paths": {
9
9
  "/Register": {
@@ -855,6 +855,12 @@
855
855
  },
856
856
  "windsor_framework_details": {
857
857
  "$ref": "#/components/schemas/WindsorFrameworkDetails"
858
+ },
859
+ "accessibility": {
860
+ "$ref": "#/components/schemas/AccessibilityTypes"
861
+ },
862
+ "signatory": {
863
+ "$ref": "#/components/schemas/Signatory"
858
864
  }
859
865
  },
860
866
  "additionalProperties": { },
@@ -3379,6 +3385,33 @@
3379
3385
  "additionalProperties": { },
3380
3386
  "description": "This model represents the product information for a single item."
3381
3387
  },
3388
+ "ProofOfDelivery": {
3389
+ "required": [
3390
+ "data",
3391
+ "format"
3392
+ ],
3393
+ "type": "object",
3394
+ "properties": {
3395
+ "data": {
3396
+ "type": "string",
3397
+ "description": "Base64 encoded data for the proof of delivery.",
3398
+ "nullable": true
3399
+ },
3400
+ "format": {
3401
+ "$ref": "#/components/schemas/ProofOfDeliveryFormat"
3402
+ }
3403
+ },
3404
+ "additionalProperties": false,
3405
+ "description": "An image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc."
3406
+ },
3407
+ "ProofOfDeliveryFormat": {
3408
+ "enum": [
3409
+ "PDF",
3410
+ "PNG"
3411
+ ],
3412
+ "type": "string",
3413
+ "description": "The format the document is in.\r\nPdf - PDF\r\nPng - PNG"
3414
+ },
3382
3415
  "PudoLocation": {
3383
3416
  "required": [
3384
3417
  "postal_code",
@@ -4238,6 +4271,28 @@
4238
4271
  "additionalProperties": false,
4239
4272
  "description": "This model represents a shipment that has already been shipped, and contains\r\nsummary information about the shipment."
4240
4273
  },
4274
+ "Signatory": {
4275
+ "type": "object",
4276
+ "properties": {
4277
+ "contact_name": {
4278
+ "type": "string",
4279
+ "description": "Name of the signatory.",
4280
+ "nullable": true
4281
+ },
4282
+ "title": {
4283
+ "type": "string",
4284
+ "description": "Title of the signatory.",
4285
+ "nullable": true
4286
+ },
4287
+ "place": {
4288
+ "type": "string",
4289
+ "description": "Place of the signatory.",
4290
+ "nullable": true
4291
+ }
4292
+ },
4293
+ "additionalProperties": false,
4294
+ "description": "Specify the name, title and place of the signatory\r\nresponsible for the dangerous goods shipment."
4295
+ },
4241
4296
  "SpecialOpeningTime": {
4242
4297
  "type": "object",
4243
4298
  "properties": {
@@ -4359,33 +4414,6 @@
4359
4414
  "type": "string",
4360
4415
  "description": "This represents the ShipEngine supported detail codes for a shipment."
4361
4416
  },
4362
- "ProofOfDelivery": {
4363
- "required": [
4364
- "data",
4365
- "format"
4366
- ],
4367
- "type": "object",
4368
- "properties": {
4369
- "data": {
4370
- "type": "string",
4371
- "description": "Base64 encoded data for the proof of delivery.",
4372
- "nullable": true
4373
- },
4374
- "format": {
4375
- "$ref": "#/components/schemas/ProofOfDeliveryFormat"
4376
- }
4377
- },
4378
- "additionalProperties": false,
4379
- "description": "An image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc."
4380
- },
4381
- "ProofOfDeliveryFormat": {
4382
- "enum": [
4383
- "PDF",
4384
- "PNG"
4385
- ],
4386
- "type": "string",
4387
- "description": "The format the document is in.\r\nPdf - PDF\r\nPng - PNG"
4388
- },
4389
4417
  "TaxDetails": {
4390
4418
  "type": "object",
4391
4419
  "properties": {
@@ -4530,6 +4558,9 @@
4530
4558
  "description": "Optional field for the carrier's specific event code when CarrierApi.Common.Models.Tracking.TrackEvent.EventCode is populated with a generic event code.",
4531
4559
  "nullable": true
4532
4560
  },
4561
+ "proof_of_delivery": {
4562
+ "$ref": "#/components/schemas/ProofOfDelivery"
4563
+ },
4533
4564
  "description": {
4534
4565
  "type": "string",
4535
4566
  "description": "Description of the package status at this event",
@@ -4572,9 +4603,6 @@
4572
4603
  },
4573
4604
  "status_detail_code": {
4574
4605
  "$ref": "#/components/schemas/StandardizedStatusDetailCodes"
4575
- },
4576
- "proof_of_delivery": {
4577
- "$ref": "#/components/schemas/ProofOfDelivery"
4578
4606
  }
4579
4607
  },
4580
4608
  "additionalProperties": false,
@@ -5261,4 +5289,4 @@
5261
5289
  "description": "Given inbound data, such as a webhook with tracking updates, return normalized information."
5262
5290
  }
5263
5291
  ]
5264
- }
5292
+ }
@@ -2,6 +2,8 @@ import { CollectOnDelivery } from './collect-on-delivery';
2
2
  import { Currency } from './currency';
3
3
  import { DangerousGoodsContact } from './dangerous-good/dangerous-goods-contact';
4
4
  import { WindsorFrameworkDetails } from './windsor-framework/windsor_framework_details';
5
+ import { AccessibilityTypes } from './accessibility-types';
6
+ import { Signatory } from './signatory';
5
7
 
6
8
  /** @description Basic structure for shipping options */
7
9
  export class AdvancedOptions {
@@ -33,6 +35,10 @@ export class AdvancedOptions {
33
35
  event_notification?: boolean;
34
36
  /** @description Any other custom shipping options */
35
37
  windsor_framework_details?: WindsorFrameworkDetails;
38
+ /** @description Identifies whatever the product being shipped is accessible or inaccessible during delivery.*/
39
+ accessibility?: AccessibilityTypes;
40
+ /** @description Specify the name, title and place of the signatory responsible for the dangerous goods shipment. */
41
+ signatory?: Signatory;
36
42
  /** @description Indicates whether the recipient should be notified of events related to the shipment. */
37
43
  [key: string]: any;
38
44
  }
@@ -0,0 +1,7 @@
1
+ /** @description This model specifies whether the payment is required before the delivery of goods or services or if credit is extended to the customer.*/
2
+ export enum PaymentTerms {
3
+ /** @description Payment must be made in full before the goods or services are delivered.*/
4
+ Prepaid = 'prepaid',
5
+ /** @description Payment is deferred, allowing the customer to settle the invoice at a later agreed-upon date.*/
6
+ Credit = 'credit',
7
+ }
@@ -0,0 +1,9 @@
1
+ /** @description Specify the name, title and place of the signatory responsible for the dangerous goods shipment. */
2
+ export class Signatory {
3
+ /** @description Name of the signatory. */
4
+ contact_name?: string;
5
+ /** @description Title of the signatory. */
6
+ title?: string;
7
+ /** @description Place of the signatory. */
8
+ place?: string;
9
+ }