@shippo/shippo-mcp 2.0.3 → 2.0.18

package/src/models/userparceltemplateupdaterequest.ts

@@ -3,83 +3,30 @@
  */
 
 import * as z from "zod";
-import { ClosedEnum } from "../types/enums.js";
-
-/**
- * The measure unit used for length, width and height.
- */
-export const UserParcelTemplateUpdateRequestDistanceUnitEnum = {
-  Cm: "cm",
-  In: "in",
-  Ft: "ft",
-  M: "m",
-  Mm: "mm",
-  Yd: "yd",
-} as const;
-/**
- * The measure unit used for length, width and height.
- */
-export type UserParcelTemplateUpdateRequestDistanceUnitEnum = ClosedEnum<
-  typeof UserParcelTemplateUpdateRequestDistanceUnitEnum
->;
-
-export const UserParcelTemplateUpdateRequestDistanceUnitEnum$zodSchema = z.enum(
-  [
-    "cm",
-    "in",
-    "ft",
-    "m",
-    "mm",
-    "yd",
-  ],
-).describe("The measure unit used for length, width and height.");
-
-/**
- * The unit used for weight.
- */
-export const UserParcelTemplateUpdateRequestWeightUnitEnum = {
-  G: "g",
-  Kg: "kg",
-  Lb: "lb",
-  Oz: "oz",
-} as const;
-/**
- * The unit used for weight.
- */
-export type UserParcelTemplateUpdateRequestWeightUnitEnum = ClosedEnum<
-  typeof UserParcelTemplateUpdateRequestWeightUnitEnum
->;
-
-export const UserParcelTemplateUpdateRequestWeightUnitEnum$zodSchema = z.enum([
-  "g",
-  "kg",
-  "lb",
-  "oz",
-]).describe("The unit used for weight.");
+import {
+  DistanceUnitEnum,
+  DistanceUnitEnum$zodSchema,
+} from "./distanceunitenum.js";
+import { WeightUnitEnum, WeightUnitEnum$zodSchema } from "./weightunitenum.js";
 
 export type UserParcelTemplateUpdateRequest = {
-  distance_unit: UserParcelTemplateUpdateRequestDistanceUnitEnum | null;
+  distance_unit: DistanceUnitEnum | null;
   height: string | null;
   length: string | null;
   name: string | null;
   weight?: string | null | undefined;
-  weight_unit?:
-    | UserParcelTemplateUpdateRequestWeightUnitEnum
-    | null
-    | undefined;
+  weight_unit?: WeightUnitEnum | null | undefined;
   width: string | null;
 };
 
 export const UserParcelTemplateUpdateRequest$zodSchema: z.ZodType<
   UserParcelTemplateUpdateRequest
 > = z.object({
-  distance_unit: UserParcelTemplateUpdateRequestDistanceUnitEnum$zodSchema
-    .nullable(),
+  distance_unit: DistanceUnitEnum$zodSchema.nullable(),
   height: z.string().nullable(),
   length: z.string().nullable(),
   name: z.string().nullable(),
   weight: z.string().nullable().optional(),
-  weight_unit: UserParcelTemplateUpdateRequestWeightUnitEnum$zodSchema
-    .nullable().optional(),
+  weight_unit: WeightUnitEnum$zodSchema.nullable().optional(),
   width: z.string().nullable(),
 });

package/src/models/userparceltemplatewithoutcarriertemplatecreaterequest.ts

@@ -3,90 +3,29 @@
  */
 
 import * as z from "zod";
-import { ClosedEnum } from "../types/enums.js";
-
-/**
- * The measure unit used for length, width and height.
- */
-export const UserParcelTemplateWithoutCarrierTemplateCreateRequestDistanceUnitEnum =
-  {
-    Cm: "cm",
-    In: "in",
-    Ft: "ft",
-    M: "m",
-    Mm: "mm",
-    Yd: "yd",
-  } as const;
-/**
- * The measure unit used for length, width and height.
- */
-export type UserParcelTemplateWithoutCarrierTemplateCreateRequestDistanceUnitEnum =
-  ClosedEnum<
-    typeof UserParcelTemplateWithoutCarrierTemplateCreateRequestDistanceUnitEnum
-  >;
-
-export const UserParcelTemplateWithoutCarrierTemplateCreateRequestDistanceUnitEnum$zodSchema =
-  z.enum([
-    "cm",
-    "in",
-    "ft",
-    "m",
-    "mm",
-    "yd",
-  ]).describe("The measure unit used for length, width and height.");
-
-/**
- * The unit used for weight.
- */
-export const UserParcelTemplateWithoutCarrierTemplateCreateRequestWeightUnitEnum =
-  {
-    G: "g",
-    Kg: "kg",
-    Lb: "lb",
-    Oz: "oz",
-  } as const;
-/**
- * The unit used for weight.
- */
-export type UserParcelTemplateWithoutCarrierTemplateCreateRequestWeightUnitEnum =
-  ClosedEnum<
-    typeof UserParcelTemplateWithoutCarrierTemplateCreateRequestWeightUnitEnum
-  >;
-
-export const UserParcelTemplateWithoutCarrierTemplateCreateRequestWeightUnitEnum$zodSchema =
-  z.enum([
-    "g",
-    "kg",
-    "lb",
-    "oz",
-  ]).describe("The unit used for weight.");
+import {
+  DistanceUnitEnum,
+  DistanceUnitEnum$zodSchema,
+} from "./distanceunitenum.js";
+import { WeightUnitEnum, WeightUnitEnum$zodSchema } from "./weightunitenum.js";
 
 export type UserParcelTemplateWithoutCarrierTemplateCreateRequest = {
-  distance_unit:
-    | UserParcelTemplateWithoutCarrierTemplateCreateRequestDistanceUnitEnum
-    | null;
+  distance_unit: DistanceUnitEnum | null;
   height: string | null;
   length: string | null;
   name: string | null;
   weight?: string | null | undefined;
-  weight_unit?:
-    | UserParcelTemplateWithoutCarrierTemplateCreateRequestWeightUnitEnum
-    | null
-    | undefined;
+  weight_unit?: WeightUnitEnum | null | undefined;
   width: string | null;
 };
 
 export const UserParcelTemplateWithoutCarrierTemplateCreateRequest$zodSchema:
   z.ZodType<UserParcelTemplateWithoutCarrierTemplateCreateRequest> = z.object({
-    distance_unit:
-      UserParcelTemplateWithoutCarrierTemplateCreateRequestDistanceUnitEnum$zodSchema
-        .nullable(),
+    distance_unit: DistanceUnitEnum$zodSchema.nullable(),
     height: z.string().nullable(),
     length: z.string().nullable(),
     name: z.string().nullable(),
     weight: z.string().nullable().optional(),
-    weight_unit:
-      UserParcelTemplateWithoutCarrierTemplateCreateRequestWeightUnitEnum$zodSchema
-        .nullable().optional(),
+    weight_unit: WeightUnitEnum$zodSchema.nullable().optional(),
     width: z.string().nullable(),
   });

package/src/models/validateaddressv2op.ts

@@ -0,0 +1,319 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
+import {
+  AddressValidationResultV2,
+  AddressValidationResultV2$zodSchema,
+} from "./addressvalidationresultv2.js";
+
+export type ValidateAddressV2Globals = {
+  shippoApiVersion?: string | undefined;
+};
+
+export const ValidateAddressV2Globals$zodSchema: z.ZodType<
+  ValidateAddressV2Globals
+> = z.object({
+  shippoApiVersion: z.string().describe(
+    "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.",
+  ).optional(),
+});
+
+/**
+ * The ISO 3166 country code
+ */
+export const CountryCode = {
+  Ae: "AE",
+  Ar: "AR",
+  At: "AT",
+  Au: "AU",
+  Ax: "AX",
+  Az: "AZ",
+  Ba: "BA",
+  Bd: "BD",
+  Be: "BE",
+  Bg: "BG",
+  Bh: "BH",
+  Bm: "BM",
+  Bn: "BN",
+  Br: "BR",
+  Bs: "BS",
+  Bw: "BW",
+  By: "BY",
+  Ca: "CA",
+  Ch: "CH",
+  Cl: "CL",
+  Co: "CO",
+  Cn: "CN",
+  Cy: "CY",
+  Cz: "CZ",
+  De: "DE",
+  Dk: "DK",
+  Ec: "EC",
+  Ee: "EE",
+  Eg: "EG",
+  Es: "ES",
+  Fi: "FI",
+  Fo: "FO",
+  Fr: "FR",
+  Gb: "GB",
+  Ge: "GE",
+  Gf: "GF",
+  Gg: "GG",
+  Gi: "GI",
+  Gp: "GP",
+  Gr: "GR",
+  Gu: "GU",
+  Hk: "HK",
+  Hr: "HR",
+  Hu: "HU",
+  Id: "ID",
+  Ie: "IE",
+  Il: "IL",
+  Im: "IM",
+  In: "IN",
+  Is: "IS",
+  It: "IT",
+  Je: "JE",
+  Jo: "JO",
+  Jp: "JP",
+  Kr: "KR",
+  Ky: "KY",
+  Kw: "KW",
+  Kz: "KZ",
+  Lb: "LB",
+  Li: "LI",
+  Lt: "LT",
+  Lu: "LU",
+  Lv: "LV",
+  Ma: "MA",
+  Mc: "MC",
+  Md: "MD",
+  Me: "ME",
+  Mk: "MK",
+  Mo: "MO",
+  Mp: "MP",
+  Mq: "MQ",
+  Mt: "MT",
+  Mx: "MX",
+  My: "MY",
+  Na: "NA",
+  Nl: "NL",
+  No: "NO",
+  Nz: "NZ",
+  Om: "OM",
+  Pe: "PE",
+  Ph: "PH",
+  Pl: "PL",
+  Pm: "PM",
+  Pr: "PR",
+  Pt: "PT",
+  Py: "PY",
+  Qa: "QA",
+  Re: "RE",
+  Ro: "RO",
+  Ru: "RU",
+  Sa: "SA",
+  Sc: "SC",
+  Se: "SE",
+  Sg: "SG",
+  Si: "SI",
+  Sk: "SK",
+  Sm: "SM",
+  Sr: "SR",
+  Th: "TH",
+  Tn: "TN",
+  Tr: "TR",
+  Tw: "TW",
+  Ua: "UA",
+  Us: "US",
+  Uy: "UY",
+  Vn: "VN",
+  We: "WE",
+  Yt: "YT",
+  Za: "ZA",
+} as const;
+/**
+ * The ISO 3166 country code
+ */
+export type CountryCode = ClosedEnum<typeof CountryCode>;
+
+export const CountryCode$zodSchema = z.enum([
+  "AE",
+  "AR",
+  "AT",
+  "AU",
+  "AX",
+  "AZ",
+  "BA",
+  "BD",
+  "BE",
+  "BG",
+  "BH",
+  "BM",
+  "BN",
+  "BR",
+  "BS",
+  "BW",
+  "BY",
+  "CA",
+  "CH",
+  "CL",
+  "CO",
+  "CN",
+  "CY",
+  "CZ",
+  "DE",
+  "DK",
+  "EC",
+  "EE",
+  "EG",
+  "ES",
+  "FI",
+  "FO",
+  "FR",
+  "GB",
+  "GE",
+  "GF",
+  "GG",
+  "GI",
+  "GP",
+  "GR",
+  "GU",
+  "HK",
+  "HR",
+  "HU",
+  "ID",
+  "IE",
+  "IL",
+  "IM",
+  "IN",
+  "IS",
+  "IT",
+  "JE",
+  "JO",
+  "JP",
+  "KR",
+  "KY",
+  "KW",
+  "KZ",
+  "LB",
+  "LI",
+  "LT",
+  "LU",
+  "LV",
+  "MA",
+  "MC",
+  "MD",
+  "ME",
+  "MK",
+  "MO",
+  "MP",
+  "MQ",
+  "MT",
+  "MX",
+  "MY",
+  "NA",
+  "NL",
+  "NO",
+  "NZ",
+  "OM",
+  "PE",
+  "PH",
+  "PL",
+  "PM",
+  "PR",
+  "PT",
+  "PY",
+  "QA",
+  "RE",
+  "RO",
+  "RU",
+  "SA",
+  "SC",
+  "SE",
+  "SG",
+  "SI",
+  "SK",
+  "SM",
+  "SR",
+  "TH",
+  "TN",
+  "TR",
+  "TW",
+  "UA",
+  "US",
+  "UY",
+  "VN",
+  "WE",
+  "YT",
+  "ZA",
+]).describe("The ISO 3166 country code");
+
+export type ValidateAddressV2Request = {
+  name?: string | undefined;
+  organization?: string | undefined;
+  address_line_1: string;
+  address_line_2?: string | undefined;
+  city_locality?: string | undefined;
+  state_province?: string | undefined;
+  postal_code?: string | undefined;
+  country_code: CountryCode;
+};
+
+export const ValidateAddressV2Request$zodSchema: z.ZodType<
+  ValidateAddressV2Request
+> = z.object({
+  address_line_1: z.string().describe("The first line of the address"),
+  address_line_2: z.string().describe("The second line of the address")
+    .optional(),
+  city_locality: z.string().describe("The city or locality of the address")
+    .optional(),
+  country_code: CountryCode$zodSchema,
+  name: z.string().describe("The name of the addressee").optional(),
+  organization: z.string().describe("The organization of the addressee")
+    .optional(),
+  postal_code: z.string().describe("The postal code or zip code").optional(),
+  state_province: z.string().describe(
+    "The state, province, county, or municipal division",
+  ).optional(),
+});
+
+export type ValidateAddressV2Detail = {};
+
+export const ValidateAddressV2Detail$zodSchema: z.ZodType<
+  ValidateAddressV2Detail
+> = z.object({});
+
+/**
+ * Unprocessable Entity
+ */
+export type ValidateAddressV2ResponseBody = {
+  detail?: Array<ValidateAddressV2Detail> | undefined;
+};
+
+export const ValidateAddressV2ResponseBody$zodSchema: z.ZodType<
+  ValidateAddressV2ResponseBody
+> = z.object({
+  detail: z.array(z.lazy(() => ValidateAddressV2Detail$zodSchema)).optional(),
+}).describe("Unprocessable Entity");
+
+export type ValidateAddressV2Response = {
+  ContentType: string;
+  StatusCode: number;
+  RawResponse: Response;
+  AddressValidationResultV2?: AddressValidationResultV2 | undefined;
+  object?: ValidateAddressV2ResponseBody | undefined;
+};
+
+export const ValidateAddressV2Response$zodSchema: z.ZodType<
+  ValidateAddressV2Response
+> = z.object({
+  AddressValidationResultV2: AddressValidationResultV2$zodSchema.optional(),
+  ContentType: z.string(),
+  RawResponse: z.custom<Response>(x => x instanceof Response),
+  StatusCode: z.int(),
+  object: z.lazy(() => ValidateAddressV2ResponseBody$zodSchema).optional(),
+});

package/src/models/validationresultv2.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type Reasons = {
+  code?: string | undefined;
+  description?: string | undefined;
+};
+
+export const Reasons$zodSchema: z.ZodType<Reasons> = z.object({
+  code: z.string().optional(),
+  description: z.string().optional(),
+});
+
+/**
+ * Validation result details
+ */
+export type ValidationResultV2 = {
+  value?: string | null | undefined;
+  reasons?: Array<Reasons> | null | undefined;
+};
+
+export const ValidationResultV2$zodSchema: z.ZodType<ValidationResultV2> = z
+  .object({
+    reasons: z.array(z.lazy(() => Reasons$zodSchema)).nullable().optional(),
+    value: z.string().nullable().optional(),
+  }).describe("Validation result details");

package/src/mcp-server/tools/addressesCreate.ts

@@ -1,74 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { addressesCreate } from "../../funcs/addressesCreate.js";
-import { AddressCreateRequest$zodSchema } from "../../models/addresscreaterequest.js";
-import { formatResult, ToolDefinition } from "../tools.js";
-
-const args = {
-  request: AddressCreateRequest$zodSchema,
-};
-
-export const tool$addressesCreate: ToolDefinition<typeof args> = {
-  name: "addresses-create-or-validate",
-  description:
-    `**PREFERRED TOOL FOR ADDRESS VALIDATION AND CREATION** - Use this tool when asked to validate or create addresses.
-
-This is the standard Shippo address validation and creation flow. When users request address validation,
-use this tool with validate=true parameter.
-
-Example usage for validation:
-\`\`\`
-POST /addresses
-{
-  "name": "Shawn Ippotle",
-  "company": "Shippo", 
-  "street1": "215 Clayton St.",
-  "city": "San Francisco",
-  "state": "CA",
-  "zip": "94117",
-  "country": "US",
-  "email": "shippotle@shippo.com",
-  "validate": true
-}
-\`\`\`
-
-When validate=true is set, this endpoint:
-- Validates address accuracy and deliverability
-- Returns standardized formatting (street abbreviations, proper casing)
-- Provides extended ZIP+4 codes when available
-- Determines residential vs commercial classification
-- Returns validation results and any corrections
-- Creates the address record for future use
-
-Use this tool for both address validation AND creating address records for shipments.
-`,
-  scopes: ["write", "validation"],
-  annotations: {
-    "title": "",
-    "destructiveHint": false,
-    "idempotentHint": false,
-    "openWorldHint": false,
-    "readOnlyHint": false,
-  },
-  args,
-  tool: async (client, args, ctx) => {
-    const [result, apiCall] = await addressesCreate(
-      client,
-      args.request,
-      { fetchOptions: { signal: ctx.signal } },
-    ).$inspect();
-
-    if (!result.ok) {
-      return {
-        content: [{ type: "text", text: result.error.message }],
-        isError: true,
-      };
-    }
-
-    const value = result.value;
-
-    return formatResult(value, apiCall);
-  },
-};

package/src/models/parcelextra.ts

@@ -1,33 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod";
-import { Cod, Cod$zodSchema } from "./cod.js";
-import {
-  ParcelInsurance,
-  ParcelInsurance$zodSchema,
-} from "./parcelinsurance.js";
-
-/**
- * An object holding optional extra services to be requested for each parcel in a multi-piece shipment.
- *
- * @remarks
- * See the <a href="#section/Parcel-Extras">Parcel Extra table below</a> for all available services.
- */
-export type ParcelExtra = {
-  COD?: Cod | undefined;
-  insurance?: ParcelInsurance | undefined;
-  reference_1?: string | undefined;
-  reference_2?: string | undefined;
-};
-
-export const ParcelExtra$zodSchema: z.ZodType<ParcelExtra> = z.object({
-  COD: Cod$zodSchema.optional(),
-  insurance: ParcelInsurance$zodSchema.optional(),
-  reference_1: z.string().optional(),
-  reference_2: z.string().optional(),
-}).describe(
-  "An object holding optional extra services to be requested for each parcel in a multi-piece shipment. \n"
-    + "See the <a href=\"#section/Parcel-Extras\">Parcel Extra table below</a> for all available services.",
-);