@shippo/shippo-mcp 2.0.2 → 2.0.8

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 (163) hide show
  1. package/bin/mcp-server.js +1504 -718
  2. package/bin/mcp-server.js.map +36 -16
  3. package/esm/funcs/addressesCreateV1.d.ts +17 -0
  4. package/esm/funcs/addressesCreateV1.d.ts.map +1 -0
  5. package/esm/funcs/addressesCreateV1.js +86 -0
  6. package/esm/funcs/addressesCreateV1.js.map +1 -0
  7. package/esm/funcs/addressesCreateV2.d.ts +18 -0
  8. package/esm/funcs/addressesCreateV2.d.ts.map +1 -0
  9. package/esm/funcs/addressesCreateV2.js +93 -0
  10. package/esm/funcs/addressesCreateV2.js.map +1 -0
  11. package/esm/funcs/addressesParse.d.ts +24 -0
  12. package/esm/funcs/addressesParse.d.ts.map +1 -0
  13. package/esm/funcs/addressesParse.js +96 -0
  14. package/esm/funcs/addressesParse.js.map +1 -0
  15. package/esm/funcs/addressesValidateV2.d.ts +24 -0
  16. package/esm/funcs/addressesValidateV2.d.ts.map +1 -0
  17. package/esm/funcs/addressesValidateV2.js +105 -0
  18. package/esm/funcs/addressesValidateV2.js.map +1 -0
  19. package/esm/lib/config.d.ts +2 -2
  20. package/esm/lib/config.js +2 -2
  21. package/esm/mcp-server/mcp-server.js +1 -1
  22. package/esm/mcp-server/server.d.ts.map +1 -1
  23. package/esm/mcp-server/server.js +9 -3
  24. package/esm/mcp-server/server.js.map +1 -1
  25. package/esm/mcp-server/tools/addressesCreateV1.d.ts +7 -0
  26. package/esm/mcp-server/tools/addressesCreateV1.d.ts.map +1 -0
  27. package/esm/mcp-server/tools/addressesCreateV1.js +48 -0
  28. package/esm/mcp-server/tools/addressesCreateV1.js.map +1 -0
  29. package/esm/mcp-server/tools/addressesCreateV2.d.ts +7 -0
  30. package/esm/mcp-server/tools/addressesCreateV2.d.ts.map +1 -0
  31. package/esm/mcp-server/tools/addressesCreateV2.js +82 -0
  32. package/esm/mcp-server/tools/addressesCreateV2.js.map +1 -0
  33. package/esm/mcp-server/tools/addressesParse.d.ts +7 -0
  34. package/esm/mcp-server/tools/addressesParse.d.ts.map +1 -0
  35. package/esm/mcp-server/tools/addressesParse.js +66 -0
  36. package/esm/mcp-server/tools/addressesParse.js.map +1 -0
  37. package/esm/mcp-server/tools/addressesValidate.d.ts.map +1 -1
  38. package/esm/mcp-server/tools/addressesValidate.js +12 -3
  39. package/esm/mcp-server/tools/addressesValidate.js.map +1 -1
  40. package/esm/mcp-server/tools/addressesValidateV2.d.ts +7 -0
  41. package/esm/mcp-server/tools/addressesValidateV2.d.ts.map +1 -0
  42. package/esm/mcp-server/tools/addressesValidateV2.js +95 -0
  43. package/esm/mcp-server/tools/addressesValidateV2.js.map +1 -0
  44. package/esm/mcp-server/tools/ordersList.d.ts.map +1 -1
  45. package/esm/mcp-server/tools/ordersList.js +20 -2
  46. package/esm/mcp-server/tools/ordersList.js.map +1 -1
  47. package/esm/models/addressanalysisv2.d.ts +24 -0
  48. package/esm/models/addressanalysisv2.d.ts.map +1 -0
  49. package/esm/models/addressanalysisv2.js +22 -0
  50. package/esm/models/addressanalysisv2.js.map +1 -0
  51. package/esm/models/addresscreaterequestv2.d.ts +41 -0
  52. package/esm/models/addresscreaterequestv2.d.ts.map +1 -0
  53. package/esm/models/addresscreaterequestv2.js +35 -0
  54. package/esm/models/addresscreaterequestv2.js.map +1 -0
  55. package/esm/models/addressdatav2.d.ts +35 -0
  56. package/esm/models/addressdatav2.d.ts.map +1 -0
  57. package/esm/models/addressdatav2.js +32 -0
  58. package/esm/models/addressdatav2.js.map +1 -0
  59. package/esm/models/addressv2.d.ts +18 -0
  60. package/esm/models/addressv2.d.ts.map +1 -0
  61. package/esm/models/addressv2.js +17 -0
  62. package/esm/models/addressv2.js.map +1 -0
  63. package/esm/models/addressvalidationresultv2.d.ts +16 -0
  64. package/esm/models/addressvalidationresultv2.d.ts.map +1 -0
  65. package/esm/models/addressvalidationresultv2.js +15 -0
  66. package/esm/models/addressvalidationresultv2.js.map +1 -0
  67. package/esm/models/addresswithmetadataresponse.d.ts +13 -0
  68. package/esm/models/addresswithmetadataresponse.d.ts.map +1 -0
  69. package/esm/models/addresswithmetadataresponse.js +12 -0
  70. package/esm/models/addresswithmetadataresponse.js.map +1 -0
  71. package/esm/models/confidenceresult.d.ts +23 -0
  72. package/esm/models/confidenceresult.d.ts.map +1 -0
  73. package/esm/models/confidenceresult.js +20 -0
  74. package/esm/models/confidenceresult.js.map +1 -0
  75. package/esm/models/createaddressv2op.d.ts +30 -0
  76. package/esm/models/createaddressv2op.d.ts.map +1 -0
  77. package/esm/models/createaddressv2op.js +22 -0
  78. package/esm/models/createaddressv2op.js.map +1 -0
  79. package/esm/models/customsdeclarationcreaterequest.d.ts +27 -27
  80. package/esm/models/customsdeclarationcreaterequest.d.ts.map +1 -1
  81. package/esm/models/customsdeclarationcreaterequest.js +27 -27
  82. package/esm/models/customsdeclarationcreaterequest.js.map +1 -1
  83. package/esm/models/defaultparceltemplate.d.ts +2 -71
  84. package/esm/models/defaultparceltemplate.d.ts.map +1 -1
  85. package/esm/models/defaultparceltemplate.js +2 -62
  86. package/esm/models/defaultparceltemplate.js.map +1 -1
  87. package/esm/models/geocoordinates.d.ts +10 -0
  88. package/esm/models/geocoordinates.d.ts.map +1 -0
  89. package/esm/models/geocoordinates.js +9 -0
  90. package/esm/models/geocoordinates.js.map +1 -0
  91. package/esm/models/order.d.ts +1 -29
  92. package/esm/models/order.d.ts.map +1 -1
  93. package/esm/models/order.js +1 -25
  94. package/esm/models/order.js.map +1 -1
  95. package/esm/models/parseaddressop.d.ts +20 -0
  96. package/esm/models/parseaddressop.d.ts.map +1 -0
  97. package/esm/models/parseaddressop.js +25 -0
  98. package/esm/models/parseaddressop.js.map +1 -0
  99. package/esm/models/parsedaddress.d.ts +16 -0
  100. package/esm/models/parsedaddress.d.ts.map +1 -0
  101. package/esm/models/parsedaddress.js +15 -0
  102. package/esm/models/parsedaddress.js.map +1 -0
  103. package/esm/models/recommendedaddressv2.d.ts +21 -0
  104. package/esm/models/recommendedaddressv2.d.ts.map +1 -0
  105. package/esm/models/recommendedaddressv2.js +21 -0
  106. package/esm/models/recommendedaddressv2.js.map +1 -0
  107. package/esm/models/shipment.d.ts +1 -1
  108. package/esm/models/userparceltemplate.d.ts +5 -57
  109. package/esm/models/userparceltemplate.d.ts.map +1 -1
  110. package/esm/models/userparceltemplate.js +5 -49
  111. package/esm/models/userparceltemplate.js.map +1 -1
  112. package/esm/models/userparceltemplateupdaterequest.d.ts +4 -45
  113. package/esm/models/userparceltemplateupdaterequest.d.ts.map +1 -1
  114. package/esm/models/userparceltemplateupdaterequest.js +4 -38
  115. package/esm/models/userparceltemplateupdaterequest.js.map +1 -1
  116. package/esm/models/userparceltemplatewithoutcarriertemplatecreaterequest.d.ts +4 -45
  117. package/esm/models/userparceltemplatewithoutcarriertemplatecreaterequest.d.ts.map +1 -1
  118. package/esm/models/userparceltemplatewithoutcarriertemplatecreaterequest.js +4 -38
  119. package/esm/models/userparceltemplatewithoutcarriertemplatecreaterequest.js.map +1 -1
  120. package/esm/models/validateaddressv2op.d.ts +265 -0
  121. package/esm/models/validateaddressv2op.d.ts.map +1 -0
  122. package/esm/models/validateaddressv2op.js +258 -0
  123. package/esm/models/validateaddressv2op.js.map +1 -0
  124. package/esm/models/validationresultv2.d.ts +15 -0
  125. package/esm/models/validationresultv2.d.ts.map +1 -0
  126. package/esm/models/validationresultv2.js +14 -0
  127. package/esm/models/validationresultv2.js.map +1 -0
  128. package/manifest.json +17 -5
  129. package/package.json +1 -1
  130. package/src/funcs/{addressesCreate.ts → addressesCreateV1.ts} +1 -1
  131. package/src/funcs/addressesCreateV2.ts +178 -0
  132. package/src/funcs/addressesParse.ts +178 -0
  133. package/src/funcs/addressesValidateV2.ts +188 -0
  134. package/src/lib/config.ts +2 -2
  135. package/src/mcp-server/mcp-server.ts +1 -1
  136. package/src/mcp-server/server.ts +9 -3
  137. package/src/mcp-server/tools/addressesCreateV1.ts +58 -0
  138. package/src/mcp-server/tools/addressesCreateV2.ts +92 -0
  139. package/src/mcp-server/tools/addressesParse.ts +76 -0
  140. package/src/mcp-server/tools/addressesValidate.ts +12 -3
  141. package/src/mcp-server/tools/addressesValidateV2.ts +105 -0
  142. package/src/mcp-server/tools/ordersList.ts +20 -2
  143. package/src/models/addressanalysisv2.ts +41 -0
  144. package/src/models/addresscreaterequestv2.ts +64 -0
  145. package/src/models/addressdatav2.ts +56 -0
  146. package/src/models/addressv2.ts +34 -0
  147. package/src/models/addressvalidationresultv2.ts +34 -0
  148. package/src/models/addresswithmetadataresponse.ts +25 -0
  149. package/src/models/confidenceresult.ts +36 -0
  150. package/src/models/createaddressv2op.ts +73 -0
  151. package/src/models/customsdeclarationcreaterequest.ts +54 -54
  152. package/src/models/defaultparceltemplate.ts +5 -122
  153. package/src/models/geocoordinates.ts +18 -0
  154. package/src/models/order.ts +2 -61
  155. package/src/models/parseaddressop.ts +44 -0
  156. package/src/models/parsedaddress.ts +32 -0
  157. package/src/models/recommendedaddressv2.ts +43 -0
  158. package/src/models/userparceltemplate.ts +11 -90
  159. package/src/models/userparceltemplateupdaterequest.ts +9 -62
  160. package/src/models/userparceltemplatewithoutcarriertemplatecreaterequest.ts +9 -70
  161. package/src/models/validateaddressv2op.ts +319 -0
  162. package/src/models/validationresultv2.ts +29 -0
  163. package/src/mcp-server/tools/addressesCreate.ts +0 -74
@@ -93,35 +93,35 @@ export const CustomsDeclarationCreateRequestDutiesPayor$zodSchema: z.ZodType<
93
93
 
94
94
  export type CustomsExporterIdentification = {
95
95
  eori_number?: string | null | undefined;
96
- tax_id?: CustomsTaxIdentification | undefined;
96
+ tax_id?: CustomsTaxIdentification | null | undefined;
97
97
  };
98
98
 
99
99
  export const CustomsExporterIdentification$zodSchema: z.ZodType<
100
100
  CustomsExporterIdentification
101
101
  > = z.object({
102
102
  eori_number: z.string().nullable().optional(),
103
- tax_id: CustomsTaxIdentification$zodSchema.optional(),
103
+ tax_id: CustomsTaxIdentification$zodSchema.nullable().optional(),
104
104
  });
105
105
 
106
106
  export type CustomsDeclarationCreateRequest = {
107
- aes_itn?: string | undefined;
107
+ aes_itn?: string | null | undefined;
108
108
  b13a_filing_option?: CustomsDeclarationB13AFilingOptionEnum | undefined;
109
- b13a_number?: string | undefined;
110
- certificate?: string | undefined;
109
+ b13a_number?: string | null | undefined;
110
+ certificate?: string | null | undefined;
111
111
  certify: boolean;
112
112
  certify_signer: string;
113
- commercial_invoice?: boolean | undefined;
114
- contents_explanation?: string | undefined;
115
- disclaimer?: string | undefined;
113
+ commercial_invoice?: boolean | null | undefined;
114
+ contents_explanation?: string | null | undefined;
115
+ disclaimer?: string | null | undefined;
116
116
  duties_payor?: CustomsDeclarationCreateRequestDutiesPayor | null | undefined;
117
117
  exporter_identification?: CustomsExporterIdentification | null | undefined;
118
- exporter_reference?: string | undefined;
119
- importer_reference?: string | undefined;
120
- is_vat_collected?: boolean | undefined;
121
- invoice?: string | undefined;
122
- license?: string | undefined;
123
- metadata?: string | undefined;
124
- notes?: string | undefined;
118
+ exporter_reference?: string | null | undefined;
119
+ importer_reference?: string | null | undefined;
120
+ is_vat_collected?: boolean | null | undefined;
121
+ invoice?: string | null | undefined;
122
+ license?: string | null | undefined;
123
+ metadata?: string | null | undefined;
124
+ notes?: string | null | undefined;
125
125
  address_importer?: AddressImporter | undefined;
126
126
  contents_type: CustomsDeclarationContentsTypeEnum;
127
127
  eel_pfc?: CustomsDeclarationEelPfcEnum | undefined;
@@ -135,33 +135,33 @@ export const CustomsDeclarationCreateRequest$zodSchema: z.ZodType<
135
135
  CustomsDeclarationCreateRequest
136
136
  > = z.object({
137
137
  address_importer: AddressImporter$zodSchema.optional(),
138
- aes_itn: z.string().optional(),
138
+ aes_itn: z.string().nullable().optional(),
139
139
  b13a_filing_option: CustomsDeclarationB13AFilingOptionEnum$zodSchema
140
140
  .optional(),
141
- b13a_number: z.string().optional(),
142
- certificate: z.string().optional(),
141
+ b13a_number: z.string().nullable().optional(),
142
+ certificate: z.string().nullable().optional(),
143
143
  certify: z.boolean(),
144
144
  certify_signer: z.string(),
145
- commercial_invoice: z.boolean().optional(),
146
- contents_explanation: z.string().optional(),
145
+ commercial_invoice: z.boolean().nullable().optional(),
146
+ contents_explanation: z.string().nullable().optional(),
147
147
  contents_type: CustomsDeclarationContentsTypeEnum$zodSchema,
148
- disclaimer: z.string().optional(),
148
+ disclaimer: z.string().nullable().optional(),
149
149
  duties_payor: z.lazy(() =>
150
150
  CustomsDeclarationCreateRequestDutiesPayor$zodSchema
151
151
  ).nullable().optional(),
152
152
  eel_pfc: CustomsDeclarationEelPfcEnum$zodSchema.optional(),
153
153
  exporter_identification: z.lazy(() => CustomsExporterIdentification$zodSchema)
154
154
  .nullable().optional(),
155
- exporter_reference: z.string().optional(),
156
- importer_reference: z.string().optional(),
155
+ exporter_reference: z.string().nullable().optional(),
156
+ importer_reference: z.string().nullable().optional(),
157
157
  incoterm: CustomsDeclarationIncotermEnum$zodSchema.optional(),
158
- invoice: z.string().optional(),
159
- is_vat_collected: z.boolean().optional(),
158
+ invoice: z.string().nullable().optional(),
159
+ is_vat_collected: z.boolean().nullable().optional(),
160
160
  items: z.array(CustomsItemCreateRequest$zodSchema),
161
- license: z.string().optional(),
162
- metadata: z.string().optional(),
161
+ license: z.string().nullable().optional(),
162
+ metadata: z.string().nullable().optional(),
163
163
  non_delivery_option: CustomsDeclarationNonDeliveryOptionEnum$zodSchema,
164
- notes: z.string().optional(),
164
+ notes: z.string().nullable().optional(),
165
165
  test: z.boolean().optional(),
166
166
  });
167
167
 
@@ -234,24 +234,24 @@ export const CustomsInvoicedCharges$zodSchema: z.ZodType<
234
234
  });
235
235
 
236
236
  export type CustomsDeclaration = {
237
- aes_itn?: string | undefined;
237
+ aes_itn?: string | null | undefined;
238
238
  b13a_filing_option?: string | undefined;
239
- b13a_number?: string | undefined;
240
- certificate?: string | undefined;
239
+ b13a_number?: string | null | undefined;
240
+ certificate?: string | null | undefined;
241
241
  certify: boolean;
242
242
  certify_signer: string;
243
- commercial_invoice?: boolean | undefined;
244
- contents_explanation?: string | undefined;
245
- disclaimer?: string | undefined;
243
+ commercial_invoice?: boolean | null | undefined;
244
+ contents_explanation?: string | null | undefined;
245
+ disclaimer?: string | null | undefined;
246
246
  duties_payor?: CustomsDeclarationDutiesPayor | null | undefined;
247
247
  exporter_identification?: CustomsExporterIdentification | null | undefined;
248
- exporter_reference?: string | undefined;
249
- importer_reference?: string | undefined;
250
- is_vat_collected?: boolean | undefined;
251
- invoice?: string | undefined;
252
- license?: string | undefined;
253
- metadata?: string | undefined;
254
- notes?: string | undefined;
248
+ exporter_reference?: string | null | undefined;
249
+ importer_reference?: string | null | undefined;
250
+ is_vat_collected?: boolean | null | undefined;
251
+ invoice?: string | null | undefined;
252
+ license?: string | null | undefined;
253
+ metadata?: string | null | undefined;
254
+ notes?: string | null | undefined;
255
255
  address_importer?: string | null | undefined;
256
256
  contents_type: string;
257
257
  eel_pfc?: string | undefined;
@@ -270,34 +270,34 @@ export type CustomsDeclaration = {
270
270
  export const CustomsDeclaration$zodSchema: z.ZodType<CustomsDeclaration> = z
271
271
  .object({
272
272
  address_importer: z.string().nullable().optional(),
273
- aes_itn: z.string().optional(),
273
+ aes_itn: z.string().nullable().optional(),
274
274
  b13a_filing_option: z.string().optional(),
275
- b13a_number: z.string().optional(),
276
- certificate: z.string().optional(),
275
+ b13a_number: z.string().nullable().optional(),
276
+ certificate: z.string().nullable().optional(),
277
277
  certify: z.boolean(),
278
278
  certify_signer: z.string(),
279
- commercial_invoice: z.boolean().optional(),
280
- contents_explanation: z.string().optional(),
279
+ commercial_invoice: z.boolean().nullable().optional(),
280
+ contents_explanation: z.string().nullable().optional(),
281
281
  contents_type: z.string(),
282
- disclaimer: z.string().optional(),
282
+ disclaimer: z.string().nullable().optional(),
283
283
  duties_payor: z.lazy(() => CustomsDeclarationDutiesPayor$zodSchema)
284
284
  .nullable().optional(),
285
285
  eel_pfc: z.string().optional(),
286
286
  exporter_identification: z.lazy(() =>
287
287
  CustomsExporterIdentification$zodSchema
288
288
  ).nullable().optional(),
289
- exporter_reference: z.string().optional(),
290
- importer_reference: z.string().optional(),
289
+ exporter_reference: z.string().nullable().optional(),
290
+ importer_reference: z.string().nullable().optional(),
291
291
  incoterm: z.string().optional(),
292
- invoice: z.string().optional(),
292
+ invoice: z.string().nullable().optional(),
293
293
  invoiced_charges: z.lazy(() => CustomsInvoicedCharges$zodSchema).nullable()
294
294
  .optional(),
295
- is_vat_collected: z.boolean().optional(),
295
+ is_vat_collected: z.boolean().nullable().optional(),
296
296
  items: z.array(z.string()).optional(),
297
- license: z.string().optional(),
298
- metadata: z.string().optional(),
297
+ license: z.string().nullable().optional(),
298
+ metadata: z.string().nullable().optional(),
299
299
  non_delivery_option: z.string(),
300
- notes: z.string().optional(),
300
+ notes: z.string().nullable().optional(),
301
301
  object_created: z.iso.datetime({ offset: true }).optional(),
302
302
  object_id: z.string().optional(),
303
303
  object_owner: z.string().optional(),
@@ -3,133 +3,16 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod";
6
- import { ClosedEnum } from "../types/enums.js";
7
6
  import {
8
- DistanceUnitEnum,
9
- DistanceUnitEnum$zodSchema,
10
- } from "./distanceunitenum.js";
11
-
12
- /**
13
- * The measure unit used for length, width and height.
14
- */
15
- export const DefaultParcelTemplateDistanceUnitEnum = {
16
- Cm: "cm",
17
- In: "in",
18
- Ft: "ft",
19
- M: "m",
20
- Mm: "mm",
21
- Yd: "yd",
22
- } as const;
23
- /**
24
- * The measure unit used for length, width and height.
25
- */
26
- export type DefaultParcelTemplateDistanceUnitEnum = ClosedEnum<
27
- typeof DefaultParcelTemplateDistanceUnitEnum
28
- >;
29
-
30
- export const DefaultParcelTemplateDistanceUnitEnum$zodSchema = z.enum([
31
- "cm",
32
- "in",
33
- "ft",
34
- "m",
35
- "mm",
36
- "yd",
37
- ]).describe("The measure unit used for length, width and height.");
38
-
39
- /**
40
- * The unit used for weight.
41
- */
42
- export const DefaultParcelTemplateWeightUnitEnum = {
43
- G: "g",
44
- Kg: "kg",
45
- Lb: "lb",
46
- Oz: "oz",
47
- } as const;
48
- /**
49
- * The unit used for weight.
50
- */
51
- export type DefaultParcelTemplateWeightUnitEnum = ClosedEnum<
52
- typeof DefaultParcelTemplateWeightUnitEnum
53
- >;
54
-
55
- export const DefaultParcelTemplateWeightUnitEnum$zodSchema = z.enum([
56
- "g",
57
- "kg",
58
- "lb",
59
- "oz",
60
- ]).describe("The unit used for weight.");
61
-
62
- export type DefaultParcelTemplateCarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb =
63
- {
64
- carrier?: string | undefined;
65
- distance_unit?: DistanceUnitEnum | undefined;
66
- height?: string | undefined;
67
- is_variable_dimensions?: boolean | undefined;
68
- length?: string | undefined;
69
- name?: string | undefined;
70
- token?: string | undefined;
71
- width?: string | undefined;
72
- };
73
-
74
- export const DefaultParcelTemplateCarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb$zodSchema:
75
- z.ZodType<
76
- DefaultParcelTemplateCarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb
77
- > = z.object({
78
- carrier: z.string().optional(),
79
- distance_unit: DistanceUnitEnum$zodSchema.optional(),
80
- height: z.string().optional(),
81
- is_variable_dimensions: z.boolean().optional(),
82
- length: z.string().optional(),
83
- name: z.string().optional(),
84
- token: z.string().optional(),
85
- width: z.string().optional(),
86
- });
87
-
88
- export type TheFieldsOfAParcelTemplateBeforeSavingItToTheDb = {
89
- distance_unit?: DefaultParcelTemplateDistanceUnitEnum | null | undefined;
90
- height?: string | null | undefined;
91
- length?: string | null | undefined;
92
- name?: string | null | undefined;
93
- weight?: string | null | undefined;
94
- weight_unit?: DefaultParcelTemplateWeightUnitEnum | null | undefined;
95
- width?: string | null | undefined;
96
- object_created?: string | undefined;
97
- object_id?: string | undefined;
98
- object_owner?: string | undefined;
99
- object_updated?: string | undefined;
100
- template?:
101
- | DefaultParcelTemplateCarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb
102
- | null
103
- | undefined;
104
- };
105
-
106
- export const TheFieldsOfAParcelTemplateBeforeSavingItToTheDb$zodSchema:
107
- z.ZodType<TheFieldsOfAParcelTemplateBeforeSavingItToTheDb> = z.object({
108
- distance_unit: DefaultParcelTemplateDistanceUnitEnum$zodSchema.nullable()
109
- .optional(),
110
- height: z.string().nullable().optional(),
111
- length: z.string().nullable().optional(),
112
- name: z.string().nullable().optional(),
113
- object_created: z.string().optional(),
114
- object_id: z.string().optional(),
115
- object_owner: z.string().optional(),
116
- object_updated: z.string().optional(),
117
- template: z.lazy(() =>
118
- DefaultParcelTemplateCarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb$zodSchema
119
- ).nullable().optional(),
120
- weight: z.string().nullable().optional(),
121
- weight_unit: DefaultParcelTemplateWeightUnitEnum$zodSchema.nullable()
122
- .optional(),
123
- width: z.string().nullable().optional(),
124
- });
7
+ UserParcelTemplate,
8
+ UserParcelTemplate$zodSchema,
9
+ } from "./userparceltemplate.js";
125
10
 
126
11
  export type DefaultParcelTemplate = {
127
- result?: TheFieldsOfAParcelTemplateBeforeSavingItToTheDb | null | undefined;
12
+ result?: UserParcelTemplate | null | undefined;
128
13
  };
129
14
 
130
15
  export const DefaultParcelTemplate$zodSchema: z.ZodType<DefaultParcelTemplate> =
131
16
  z.object({
132
- result: z.lazy(() =>
133
- TheFieldsOfAParcelTemplateBeforeSavingItToTheDb$zodSchema
134
- ).nullable().optional(),
17
+ result: UserParcelTemplate$zodSchema.nullable().optional(),
135
18
  });
@@ -0,0 +1,18 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+
7
+ /**
8
+ * Geographic coordinates
9
+ */
10
+ export type GeoCoordinates = {
11
+ latitude?: number | null | undefined;
12
+ longitude?: number | null | undefined;
13
+ };
14
+
15
+ export const GeoCoordinates$zodSchema: z.ZodType<GeoCoordinates> = z.object({
16
+ latitude: z.number().nullable().optional(),
17
+ longitude: z.number().nullable().optional(),
18
+ }).describe("Geographic coordinates");
@@ -4,10 +4,6 @@
4
4
 
5
5
  import * as z from "zod";
6
6
  import { Address, Address$zodSchema } from "./address.js";
7
- import {
8
- AddressValidationResults,
9
- AddressValidationResults$zodSchema,
10
- } from "./addressvalidationresults.js";
11
7
  import { LineItem, LineItem$zodSchema } from "./lineitem.js";
12
8
  import {
13
9
  OrderShopAppEnum,
@@ -19,61 +15,6 @@ import {
19
15
  } from "./orderstatusenum.js";
20
16
  import { WeightUnitEnum, WeightUnitEnum$zodSchema } from "./weightunitenum.js";
21
17
 
22
- /**
23
- * <a href="#tag/Addresses">Address</a> object of the sender / seller. Will be returned expanded by default.
24
- */
25
- export type OrderAddressFrom = {
26
- name?: string | undefined;
27
- company?: string | undefined;
28
- street1?: string | undefined;
29
- street2?: string | undefined;
30
- street3?: string | undefined;
31
- street_no?: string | undefined;
32
- city?: string | undefined;
33
- state?: string | undefined;
34
- zip?: string | undefined;
35
- country: string;
36
- phone?: string | undefined;
37
- email?: string | undefined;
38
- is_residential?: boolean | null | undefined;
39
- metadata?: string | undefined;
40
- is_complete?: boolean | undefined;
41
- object_created?: string | undefined;
42
- object_id?: string | undefined;
43
- object_owner?: string | undefined;
44
- object_updated?: string | undefined;
45
- validation_results?: AddressValidationResults | undefined;
46
- test?: boolean | null | undefined;
47
- };
48
-
49
- export const OrderAddressFrom$zodSchema: z.ZodType<OrderAddressFrom> = z.object(
50
- {
51
- city: z.string().optional(),
52
- company: z.string().optional(),
53
- country: z.string(),
54
- email: z.string().optional(),
55
- is_complete: z.boolean().optional(),
56
- is_residential: z.boolean().nullable().optional(),
57
- metadata: z.string().optional(),
58
- name: z.string().optional(),
59
- object_created: z.iso.datetime({ offset: true }).optional(),
60
- object_id: z.string().optional(),
61
- object_owner: z.string().optional(),
62
- object_updated: z.iso.datetime({ offset: true }).optional(),
63
- phone: z.string().optional(),
64
- state: z.string().optional(),
65
- street1: z.string().optional(),
66
- street2: z.string().optional(),
67
- street3: z.string().optional(),
68
- street_no: z.string().optional(),
69
- test: z.boolean().nullable().optional(),
70
- validation_results: AddressValidationResults$zodSchema.optional(),
71
- zip: z.string().optional(),
72
- },
73
- ).describe(
74
- "<a href=\"#tag/Addresses\">Address</a> object of the sender / seller. Will be returned expanded by default.",
75
- );
76
-
77
18
  export type OrderTransaction = {};
78
19
 
79
20
  export const OrderTransaction$zodSchema: z.ZodType<OrderTransaction> = z.object(
@@ -94,7 +35,7 @@ export type Order = {
94
35
  total_tax?: string | null | undefined;
95
36
  weight?: string | null | undefined;
96
37
  weight_unit?: WeightUnitEnum | undefined;
97
- from_address?: OrderAddressFrom | null | undefined;
38
+ from_address?: Address | null | undefined;
98
39
  to_address: Address;
99
40
  line_items?: Array<LineItem> | undefined;
100
41
  object_id?: string | undefined;
@@ -105,7 +46,7 @@ export type Order = {
105
46
 
106
47
  export const Order$zodSchema: z.ZodType<Order> = z.object({
107
48
  currency: z.string().nullable().optional(),
108
- from_address: z.lazy(() => OrderAddressFrom$zodSchema).nullable().optional(),
49
+ from_address: Address$zodSchema.nullable().optional(),
109
50
  line_items: z.array(LineItem$zodSchema).optional(),
110
51
  notes: z.string().nullable().optional(),
111
52
  object_id: z.string().optional(),
@@ -0,0 +1,44 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { BadRequest, BadRequest$zodSchema } from "./badrequest.js";
7
+ import { ParsedAddress, ParsedAddress$zodSchema } from "./parsedaddress.js";
8
+
9
+ export type ParseAddressGlobals = { shippoApiVersion?: string | undefined };
10
+
11
+ export const ParseAddressGlobals$zodSchema: z.ZodType<ParseAddressGlobals> = z
12
+ .object({
13
+ shippoApiVersion: z.string().describe(
14
+ "Optional string used to pick a non-default API version to use. See our <a href=\"https://docs.goshippo.com/docs/api_concepts/apiversioning/\">API version</a> guide.",
15
+ ).optional(),
16
+ });
17
+
18
+ export type ParseAddressRequest = { address: string };
19
+
20
+ export const ParseAddressRequest$zodSchema: z.ZodType<ParseAddressRequest> = z
21
+ .object({
22
+ address: z.string().describe(
23
+ "The address string to parse. Can include street address, city, state, postal code, \n"
24
+ + "country, phone number, and email address.\n"
25
+ + "",
26
+ ),
27
+ });
28
+
29
+ export type ParseAddressResponse = {
30
+ ContentType: string;
31
+ StatusCode: number;
32
+ RawResponse: Response;
33
+ ParsedAddress?: ParsedAddress | undefined;
34
+ BadRequest?: BadRequest | undefined;
35
+ };
36
+
37
+ export const ParseAddressResponse$zodSchema: z.ZodType<ParseAddressResponse> = z
38
+ .object({
39
+ BadRequest: BadRequest$zodSchema.optional(),
40
+ ContentType: z.string(),
41
+ ParsedAddress: ParsedAddress$zodSchema.optional(),
42
+ RawResponse: z.custom<Response>(x => x instanceof Response),
43
+ StatusCode: z.int(),
44
+ });
@@ -0,0 +1,32 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+
7
+ /**
8
+ * A structured address object parsed from an unstructured address string
9
+ */
10
+ export type ParsedAddress = {
11
+ address_line_1?: string | undefined;
12
+ address_line_2?: string | null | undefined;
13
+ city_locality?: string | undefined;
14
+ state_province?: string | undefined;
15
+ postal_code?: string | undefined;
16
+ country_code?: string | undefined;
17
+ email?: string | null | undefined;
18
+ phone?: string | null | undefined;
19
+ };
20
+
21
+ export const ParsedAddress$zodSchema: z.ZodType<ParsedAddress> = z.object({
22
+ address_line_1: z.string().optional(),
23
+ address_line_2: z.string().nullable().optional(),
24
+ city_locality: z.string().optional(),
25
+ country_code: z.string().optional(),
26
+ email: z.string().nullable().optional(),
27
+ phone: z.string().nullable().optional(),
28
+ postal_code: z.string().optional(),
29
+ state_province: z.string().optional(),
30
+ }).describe(
31
+ "A structured address object parsed from an unstructured address string",
32
+ );
@@ -0,0 +1,43 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import {
7
+ ConfidenceResult,
8
+ ConfidenceResult$zodSchema,
9
+ } from "./confidenceresult.js";
10
+
11
+ /**
12
+ * Recommended corrected address with confidence score
13
+ */
14
+ export type RecommendedAddressV2 = {
15
+ address_line_1?: string | null | undefined;
16
+ address_line_2?: string | null | undefined;
17
+ city_locality?: string | null | undefined;
18
+ state_province?: string | null | undefined;
19
+ postal_code?: string | null | undefined;
20
+ country_code?: string | null | undefined;
21
+ name?: string | null | undefined;
22
+ organization?: string | null | undefined;
23
+ phone?: string | null | undefined;
24
+ email?: string | null | undefined;
25
+ complete_address?: string | null | undefined;
26
+ confidence_result?: ConfidenceResult | undefined;
27
+ };
28
+
29
+ export const RecommendedAddressV2$zodSchema: z.ZodType<RecommendedAddressV2> = z
30
+ .object({
31
+ address_line_1: z.string().nullable().optional(),
32
+ address_line_2: z.string().nullable().optional(),
33
+ city_locality: z.string().nullable().optional(),
34
+ complete_address: z.string().nullable().optional(),
35
+ confidence_result: ConfidenceResult$zodSchema.optional(),
36
+ country_code: z.string().nullable().optional(),
37
+ email: z.string().nullable().optional(),
38
+ name: z.string().nullable().optional(),
39
+ organization: z.string().nullable().optional(),
40
+ phone: z.string().nullable().optional(),
41
+ postal_code: z.string().nullable().optional(),
42
+ state_province: z.string().nullable().optional(),
43
+ }).describe("Recommended corrected address with confidence score");
@@ -3,110 +3,34 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod";
6
- import { ClosedEnum } from "../types/enums.js";
6
+ import {
7
+ CarrierParcelTemplate,
8
+ CarrierParcelTemplate$zodSchema,
9
+ } from "./carrierparceltemplate.js";
7
10
  import {
8
11
  DistanceUnitEnum,
9
12
  DistanceUnitEnum$zodSchema,
10
13
  } from "./distanceunitenum.js";
11
-
12
- /**
13
- * The measure unit used for length, width and height.
14
- */
15
- export const UserParcelTemplateDistanceUnitEnum = {
16
- Cm: "cm",
17
- In: "in",
18
- Ft: "ft",
19
- M: "m",
20
- Mm: "mm",
21
- Yd: "yd",
22
- } as const;
23
- /**
24
- * The measure unit used for length, width and height.
25
- */
26
- export type UserParcelTemplateDistanceUnitEnum = ClosedEnum<
27
- typeof UserParcelTemplateDistanceUnitEnum
28
- >;
29
-
30
- export const UserParcelTemplateDistanceUnitEnum$zodSchema = z.enum([
31
- "cm",
32
- "in",
33
- "ft",
34
- "m",
35
- "mm",
36
- "yd",
37
- ]).describe("The measure unit used for length, width and height.");
38
-
39
- /**
40
- * The unit used for weight.
41
- */
42
- export const UserParcelTemplateWeightUnitEnum = {
43
- G: "g",
44
- Kg: "kg",
45
- Lb: "lb",
46
- Oz: "oz",
47
- } as const;
48
- /**
49
- * The unit used for weight.
50
- */
51
- export type UserParcelTemplateWeightUnitEnum = ClosedEnum<
52
- typeof UserParcelTemplateWeightUnitEnum
53
- >;
54
-
55
- export const UserParcelTemplateWeightUnitEnum$zodSchema = z.enum([
56
- "g",
57
- "kg",
58
- "lb",
59
- "oz",
60
- ]).describe("The unit used for weight.");
61
-
62
- export type CarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb =
63
- {
64
- carrier?: string | undefined;
65
- distance_unit?: DistanceUnitEnum | undefined;
66
- height?: string | undefined;
67
- is_variable_dimensions?: boolean | undefined;
68
- length?: string | undefined;
69
- name?: string | undefined;
70
- token?: string | undefined;
71
- width?: string | undefined;
72
- };
73
-
74
- export const CarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb$zodSchema:
75
- z.ZodType<
76
- CarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb
77
- > = z.object({
78
- carrier: z.string().optional(),
79
- distance_unit: DistanceUnitEnum$zodSchema.optional(),
80
- height: z.string().optional(),
81
- is_variable_dimensions: z.boolean().optional(),
82
- length: z.string().optional(),
83
- name: z.string().optional(),
84
- token: z.string().optional(),
85
- width: z.string().optional(),
86
- });
14
+ import { WeightUnitEnum, WeightUnitEnum$zodSchema } from "./weightunitenum.js";
87
15
 
88
16
  export type UserParcelTemplate = {
89
- distance_unit?: UserParcelTemplateDistanceUnitEnum | null | undefined;
17
+ distance_unit?: DistanceUnitEnum | null | undefined;
90
18
  height?: string | null | undefined;
91
19
  length?: string | null | undefined;
92
20
  name?: string | null | undefined;
93
21
  weight?: string | null | undefined;
94
- weight_unit?: UserParcelTemplateWeightUnitEnum | null | undefined;
22
+ weight_unit?: WeightUnitEnum | null | undefined;
95
23
  width?: string | null | undefined;
96
24
  object_created?: string | undefined;
97
25
  object_id?: string | undefined;
98
26
  object_owner?: string | undefined;
99
27
  object_updated?: string | undefined;
100
- template?:
101
- | CarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb
102
- | null
103
- | undefined;
28
+ template?: CarrierParcelTemplate | null | undefined;
104
29
  };
105
30
 
106
31
  export const UserParcelTemplate$zodSchema: z.ZodType<UserParcelTemplate> = z
107
32
  .object({
108
- distance_unit: UserParcelTemplateDistanceUnitEnum$zodSchema.nullable()
109
- .optional(),
33
+ distance_unit: DistanceUnitEnum$zodSchema.nullable().optional(),
110
34
  height: z.string().nullable().optional(),
111
35
  length: z.string().nullable().optional(),
112
36
  name: z.string().nullable().optional(),
@@ -114,11 +38,8 @@ export const UserParcelTemplate$zodSchema: z.ZodType<UserParcelTemplate> = z
114
38
  object_id: z.string().optional(),
115
39
  object_owner: z.string().optional(),
116
40
  object_updated: z.string().optional(),
117
- template: z.lazy(() =>
118
- CarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb$zodSchema
119
- ).nullable().optional(),
41
+ template: CarrierParcelTemplate$zodSchema.nullable().optional(),
120
42
  weight: z.string().nullable().optional(),
121
- weight_unit: UserParcelTemplateWeightUnitEnum$zodSchema.nullable()
122
- .optional(),
43
+ weight_unit: WeightUnitEnum$zodSchema.nullable().optional(),
123
44
  width: z.string().nullable().optional(),
124
45
  });