@sp-api-sdk/shipping-api-v2 2.1.4 → 2.1.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.
Files changed (182) hide show
  1. package/dist/cjs/api-model/api/shipping-api.js +0 -89
  2. package/dist/cjs/api-model/base.js +0 -19
  3. package/dist/cjs/api-model/common.js +0 -37
  4. package/dist/cjs/api-model/configuration.js +0 -17
  5. package/dist/cjs/api-model/models/access-point-type.js +0 -2
  6. package/dist/cjs/api-model/models/account-status.js +0 -2
  7. package/dist/cjs/api-model/models/account-type.js +0 -2
  8. package/dist/cjs/api-model/models/channel-type.js +0 -2
  9. package/dist/cjs/api-model/models/claim-reason.js +0 -2
  10. package/dist/cjs/api-model/models/detail-codes.js +0 -2
  11. package/dist/cjs/api-model/models/document-format.js +0 -2
  12. package/dist/cjs/api-model/models/document-type.js +0 -2
  13. package/dist/cjs/api-model/models/event-code.js +0 -2
  14. package/dist/cjs/api-model/models/generation-status.js +0 -2
  15. package/dist/cjs/api-model/models/ineligibility-reason-code.js +0 -2
  16. package/dist/cjs/api-model/models/input-type.js +0 -2
  17. package/dist/cjs/api-model/models/label-attribute.js +0 -2
  18. package/dist/cjs/api-model/models/ndr-action.js +0 -2
  19. package/dist/cjs/api-model/models/payment-type.js +0 -2
  20. package/dist/cjs/api-model/models/rate-item-id.js +0 -2
  21. package/dist/cjs/api-model/models/rate-item-type.js +0 -2
  22. package/dist/cjs/api-model/models/settlement-type.js +0 -2
  23. package/dist/cjs/api-model/models/shipment-type.js +0 -2
  24. package/dist/cjs/api-model/models/status.js +0 -2
  25. package/dist/cjs/api-model/models/tax-type.js +0 -2
  26. package/dist/es/api-model/api/shipping-api.js +0 -89
  27. package/dist/es/api-model/base.js +0 -19
  28. package/dist/es/api-model/common.js +0 -37
  29. package/dist/es/api-model/configuration.js +0 -17
  30. package/dist/es/api-model/models/access-point-type.js +0 -2
  31. package/dist/es/api-model/models/account-status.js +0 -2
  32. package/dist/es/api-model/models/account-type.js +0 -2
  33. package/dist/es/api-model/models/channel-type.js +0 -2
  34. package/dist/es/api-model/models/claim-reason.js +0 -2
  35. package/dist/es/api-model/models/detail-codes.js +0 -2
  36. package/dist/es/api-model/models/document-format.js +0 -2
  37. package/dist/es/api-model/models/document-type.js +0 -2
  38. package/dist/es/api-model/models/event-code.js +0 -2
  39. package/dist/es/api-model/models/generation-status.js +0 -2
  40. package/dist/es/api-model/models/ineligibility-reason-code.js +0 -2
  41. package/dist/es/api-model/models/input-type.js +0 -2
  42. package/dist/es/api-model/models/label-attribute.js +0 -2
  43. package/dist/es/api-model/models/ndr-action.js +0 -2
  44. package/dist/es/api-model/models/payment-type.js +0 -2
  45. package/dist/es/api-model/models/rate-item-id.js +0 -2
  46. package/dist/es/api-model/models/rate-item-type.js +0 -2
  47. package/dist/es/api-model/models/settlement-type.js +0 -2
  48. package/dist/es/api-model/models/shipment-type.js +0 -2
  49. package/dist/es/api-model/models/status.js +0 -2
  50. package/dist/es/api-model/models/tax-type.js +0 -2
  51. package/dist/types/api-model/api/shipping-api.d.ts +0 -235
  52. package/dist/types/api-model/base.d.ts +0 -24
  53. package/dist/types/api-model/common.d.ts +0 -37
  54. package/dist/types/api-model/configuration.d.ts +0 -17
  55. package/dist/types/api-model/models/access-point-details.d.ts +0 -4
  56. package/dist/types/api-model/models/access-point-type.d.ts +0 -2
  57. package/dist/types/api-model/models/access-point.d.ts +0 -31
  58. package/dist/types/api-model/models/accessibility-attributes.d.ts +0 -6
  59. package/dist/types/api-model/models/account-status.d.ts +0 -2
  60. package/dist/types/api-model/models/account-type.d.ts +0 -2
  61. package/dist/types/api-model/models/active-account.d.ts +0 -6
  62. package/dist/types/api-model/models/address.d.ts +0 -29
  63. package/dist/types/api-model/models/amazon-order-details.d.ts +0 -4
  64. package/dist/types/api-model/models/amazon-shipment-details.d.ts +0 -4
  65. package/dist/types/api-model/models/available-value-added-service-group.d.ts +0 -10
  66. package/dist/types/api-model/models/benefits.d.ts +0 -6
  67. package/dist/types/api-model/models/cancel-shipment-response.d.ts +0 -4
  68. package/dist/types/api-model/models/carrier-account-attribute.d.ts +0 -8
  69. package/dist/types/api-model/models/carrier-account-input.d.ts +0 -21
  70. package/dist/types/api-model/models/carrier-account.d.ts +0 -6
  71. package/dist/types/api-model/models/carrier.d.ts +0 -6
  72. package/dist/types/api-model/models/channel-details.d.ts +0 -17
  73. package/dist/types/api-model/models/channel-type.d.ts +0 -2
  74. package/dist/types/api-model/models/charge-component.d.ts +0 -9
  75. package/dist/types/api-model/models/claim-reason.d.ts +0 -2
  76. package/dist/types/api-model/models/client-reference-detail.d.ts +0 -6
  77. package/dist/types/api-model/models/collect-on-delivery.d.ts +0 -7
  78. package/dist/types/api-model/models/collection-forms-history-record.d.ts +0 -18
  79. package/dist/types/api-model/models/collections-form-document.d.ts +0 -6
  80. package/dist/types/api-model/models/create-claim-request.d.ts +0 -23
  81. package/dist/types/api-model/models/create-claim-response.d.ts +0 -4
  82. package/dist/types/api-model/models/currency.d.ts +0 -6
  83. package/dist/types/api-model/models/dangerous-goods-details.d.ts +0 -10
  84. package/dist/types/api-model/models/date-range.d.ts +0 -6
  85. package/dist/types/api-model/models/detail-codes.d.ts +0 -2
  86. package/dist/types/api-model/models/dimensions.d.ts +0 -10
  87. package/dist/types/api-model/models/direct-fulfillment-item-identifiers.d.ts +0 -6
  88. package/dist/types/api-model/models/direct-purchase-request.d.ts +0 -29
  89. package/dist/types/api-model/models/direct-purchase-response.d.ts +0 -7
  90. package/dist/types/api-model/models/direct-purchase-result.d.ts +0 -6
  91. package/dist/types/api-model/models/document-format.d.ts +0 -2
  92. package/dist/types/api-model/models/document-size.d.ts +0 -8
  93. package/dist/types/api-model/models/document-type.d.ts +0 -2
  94. package/dist/types/api-model/models/error-list.d.ts +0 -4
  95. package/dist/types/api-model/models/event-code.d.ts +0 -2
  96. package/dist/types/api-model/models/event.d.ts +0 -19
  97. package/dist/types/api-model/models/exception-operating-hours.d.ts +0 -12
  98. package/dist/types/api-model/models/excluded-benefit.d.ts +0 -6
  99. package/dist/types/api-model/models/generate-collection-form-request.d.ts +0 -11
  100. package/dist/types/api-model/models/generate-collection-form-response.d.ts +0 -7
  101. package/dist/types/api-model/models/generation-status.d.ts +0 -2
  102. package/dist/types/api-model/models/geocode.d.ts +0 -6
  103. package/dist/types/api-model/models/get-access-points-response.d.ts +0 -7
  104. package/dist/types/api-model/models/get-access-points-result.d.ts +0 -4
  105. package/dist/types/api-model/models/get-additional-inputs-response.d.ts +0 -4
  106. package/dist/types/api-model/models/get-carrier-account-form-inputs-response.d.ts +0 -4
  107. package/dist/types/api-model/models/get-carrier-accounts-request.d.ts +0 -4
  108. package/dist/types/api-model/models/get-carrier-accounts-response.d.ts +0 -4
  109. package/dist/types/api-model/models/get-collection-form-history-request.d.ts +0 -18
  110. package/dist/types/api-model/models/get-collection-form-history-response.d.ts +0 -6
  111. package/dist/types/api-model/models/get-collection-form-response.d.ts +0 -7
  112. package/dist/types/api-model/models/get-rates-request.d.ts +0 -52
  113. package/dist/types/api-model/models/get-rates-response.d.ts +0 -7
  114. package/dist/types/api-model/models/get-rates-result.d.ts +0 -8
  115. package/dist/types/api-model/models/get-shipment-documents-response.d.ts +0 -7
  116. package/dist/types/api-model/models/get-shipment-documents-result.d.ts +0 -14
  117. package/dist/types/api-model/models/get-tracking-response.d.ts +0 -7
  118. package/dist/types/api-model/models/get-tracking-result.d.ts +0 -15
  119. package/dist/types/api-model/models/get-unmanifested-shipments-request.d.ts +0 -4
  120. package/dist/types/api-model/models/get-unmanifested-shipments-response.d.ts +0 -4
  121. package/dist/types/api-model/models/goods-owner.d.ts +0 -4
  122. package/dist/types/api-model/models/ineligibility-reason-code.d.ts +0 -2
  123. package/dist/types/api-model/models/ineligibility-reason.d.ts +0 -9
  124. package/dist/types/api-model/models/ineligible-rate.d.ts +0 -12
  125. package/dist/types/api-model/models/input-type.d.ts +0 -2
  126. package/dist/types/api-model/models/invoice-details.d.ts +0 -6
  127. package/dist/types/api-model/models/item.d.ts +0 -44
  128. package/dist/types/api-model/models/label-attribute.d.ts +0 -2
  129. package/dist/types/api-model/models/link-carrier-account-request.d.ts +0 -10
  130. package/dist/types/api-model/models/link-carrier-account-response.d.ts +0 -9
  131. package/dist/types/api-model/models/linkable-account-type.d.ts +0 -9
  132. package/dist/types/api-model/models/linkable-carrier.d.ts +0 -6
  133. package/dist/types/api-model/models/liquid-volume.d.ts +0 -6
  134. package/dist/types/api-model/models/location.d.ts +0 -10
  135. package/dist/types/api-model/models/model-error.d.ts +0 -8
  136. package/dist/types/api-model/models/ndr-action.d.ts +0 -2
  137. package/dist/types/api-model/models/ndr-request-data.d.ts +0 -6
  138. package/dist/types/api-model/models/one-click-shipment-request.d.ts +0 -55
  139. package/dist/types/api-model/models/one-click-shipment-response.d.ts +0 -7
  140. package/dist/types/api-model/models/one-click-shipment-result.d.ts +0 -26
  141. package/dist/types/api-model/models/one-click-shipment-value-added-service.d.ts +0 -9
  142. package/dist/types/api-model/models/operating-hours.d.ts +0 -14
  143. package/dist/types/api-model/models/package-document-detail.d.ts +0 -8
  144. package/dist/types/api-model/models/package-document.d.ts +0 -14
  145. package/dist/types/api-model/models/package.d.ts +0 -27
  146. package/dist/types/api-model/models/payment-type.d.ts +0 -2
  147. package/dist/types/api-model/models/print-option.d.ts +0 -10
  148. package/dist/types/api-model/models/promise.d.ts +0 -12
  149. package/dist/types/api-model/models/purchase-shipment-request.d.ts +0 -15
  150. package/dist/types/api-model/models/purchase-shipment-response.d.ts +0 -7
  151. package/dist/types/api-model/models/purchase-shipment-result.d.ts +0 -16
  152. package/dist/types/api-model/models/rate-item-id.d.ts +0 -2
  153. package/dist/types/api-model/models/rate-item-type.d.ts +0 -2
  154. package/dist/types/api-model/models/rate-item.d.ts +0 -19
  155. package/dist/types/api-model/models/rate.d.ts +0 -45
  156. package/dist/types/api-model/models/requested-document-specification.d.ts +0 -25
  157. package/dist/types/api-model/models/requested-label-customization.d.ts +0 -4
  158. package/dist/types/api-model/models/requested-value-added-service.d.ts +0 -4
  159. package/dist/types/api-model/models/service-selection.d.ts +0 -4
  160. package/dist/types/api-model/models/service.d.ts +0 -6
  161. package/dist/types/api-model/models/settlement-type.d.ts +0 -2
  162. package/dist/types/api-model/models/shipment-type.d.ts +0 -2
  163. package/dist/types/api-model/models/shipper-instruction.d.ts +0 -4
  164. package/dist/types/api-model/models/status.d.ts +0 -2
  165. package/dist/types/api-model/models/submit-ndr-feedback-request.d.ts +0 -14
  166. package/dist/types/api-model/models/supported-document-detail.d.ts +0 -9
  167. package/dist/types/api-model/models/supported-document-specification.d.ts +0 -14
  168. package/dist/types/api-model/models/tax-detail.d.ts +0 -9
  169. package/dist/types/api-model/models/tax-type.d.ts +0 -2
  170. package/dist/types/api-model/models/time-of-day.d.ts +0 -8
  171. package/dist/types/api-model/models/time-window.d.ts +0 -6
  172. package/dist/types/api-model/models/tracking-detail-codes.d.ts +0 -6
  173. package/dist/types/api-model/models/tracking-summary.d.ts +0 -12
  174. package/dist/types/api-model/models/unlink-carrier-account-request.d.ts +0 -6
  175. package/dist/types/api-model/models/unlink-carrier-account-response.d.ts +0 -4
  176. package/dist/types/api-model/models/unmanifested-carrier-information.d.ts +0 -8
  177. package/dist/types/api-model/models/unmanifested-shipment-location.d.ts +0 -9
  178. package/dist/types/api-model/models/validation-metadata.d.ts +0 -8
  179. package/dist/types/api-model/models/value-added-service-details.d.ts +0 -7
  180. package/dist/types/api-model/models/value-added-service.d.ts +0 -11
  181. package/dist/types/api-model/models/weight.d.ts +0 -6
  182. package/package.json +25 -4
@@ -15,49 +15,32 @@ export class Configuration {
15
15
  /**
16
16
  * parameter for apiKey security
17
17
  * @param name security name
18
- * @memberof Configuration
19
18
  */
20
19
  apiKey;
21
20
  /**
22
21
  * parameter for basic security
23
- *
24
- * @type {string}
25
- * @memberof Configuration
26
22
  */
27
23
  username;
28
24
  /**
29
25
  * parameter for basic security
30
- *
31
- * @type {string}
32
- * @memberof Configuration
33
26
  */
34
27
  password;
35
28
  /**
36
29
  * parameter for oauth2 security
37
30
  * @param name security name
38
31
  * @param scopes oauth2 scope
39
- * @memberof Configuration
40
32
  */
41
33
  accessToken;
42
34
  /**
43
35
  * override base path
44
- *
45
- * @type {string}
46
- * @memberof Configuration
47
36
  */
48
37
  basePath;
49
38
  /**
50
39
  * override server index
51
- *
52
- * @type {number}
53
- * @memberof Configuration
54
40
  */
55
41
  serverIndex;
56
42
  /**
57
43
  * base options for axios calls
58
- *
59
- * @type {any}
60
- * @memberof Configuration
61
44
  */
62
45
  baseOptions;
63
46
  /**
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * The type of access point, like counter (HELIX), lockers, etc.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const AccessPointType = {
20
18
  Helix: 'HELIX',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * Account Status.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const AccountStatus = {
20
18
  Active: 'ACTIVE',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * Shipper Account Type.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const AccountType = {
20
18
  ShipperAccount: 'SHIPPER_ACCOUNT',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * The shipment source channel type.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const ChannelType = {
20
18
  Amazon: 'AMAZON',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * The reason for which shipper is filing the claim for a particular shipment.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const ClaimReason = {
20
18
  LostInTransit: 'LOST_IN_TRANSIT',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * A list of codes used to provide additional shipment information.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const DetailCodes = {
20
18
  BusinessClosed: 'BusinessClosed',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * The file format of the document.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const DocumentFormat = {
20
18
  Pdf: 'PDF',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * The type of shipping document.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const DocumentType = {
20
18
  Packslip: 'PACKSLIP',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * The tracking event type.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const EventCode = {
20
18
  ReadyForReceive: 'ReadyForReceive',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * Generation Status.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const GenerationStatus = {
20
18
  Completed: 'Completed',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * Reasons that make a shipment service offering ineligible.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const IneligibilityReasonCode = {
20
18
  NoCoverage: 'NO_COVERAGE',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * Type of Input.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const InputType = {
20
18
  Textbox: 'TEXTBOX',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * Enumerates the attributes supported to be printed on a shipping label. The values for these attributes are retrieved from GetRates/OneClickShipment request
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const LabelAttribute = {
20
18
  PackageClientReferenceId: 'PACKAGE_CLIENT_REFERENCE_ID',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * The type of NDR action shipper wants to take for a particular shipment.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const NdrAction = {
20
18
  Reschedule: 'RESCHEDULE',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * Payment type of the purchase.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const PaymentType = {
20
18
  PayThroughAmazon: 'PAY_THROUGH_AMAZON',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * Unique ID for the rateItem.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const RateItemID = {
20
18
  BaseRate: 'BASE_RATE',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * Type of the rateItem.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const RateItemType = {
20
18
  Mandatory: 'MANDATORY',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * Type of settlement the shipper wants to receive for a particular shipment.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const SettlementType = {
20
18
  Refund: 'REFUND',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * Shipment type.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const ShipmentType = {
20
18
  Forward: 'FORWARD',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * The status of the package being shipped.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const Status = {
20
18
  PreTransit: 'PreTransit',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * Indicates the type of tax.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const TaxType = {
20
18
  Gst: 'GST'