@shippo/shippo-mcp 2.0.3 → 2.0.18

package/src/models/defaultparceltemplate.ts

@@ -3,133 +3,16 @@
  */
 
 import * as z from "zod";
-import { ClosedEnum } from "../types/enums.js";
 import {
-  DistanceUnitEnum,
-  DistanceUnitEnum$zodSchema,
-} from "./distanceunitenum.js";
-
-/**
- * The measure unit used for length, width and height.
- */
-export const DefaultParcelTemplateDistanceUnitEnum = {
-  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 DefaultParcelTemplateDistanceUnitEnum = ClosedEnum<
-  typeof DefaultParcelTemplateDistanceUnitEnum
->;
-
-export const DefaultParcelTemplateDistanceUnitEnum$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 DefaultParcelTemplateWeightUnitEnum = {
-  G: "g",
-  Kg: "kg",
-  Lb: "lb",
-  Oz: "oz",
-} as const;
-/**
- * The unit used for weight.
- */
-export type DefaultParcelTemplateWeightUnitEnum = ClosedEnum<
-  typeof DefaultParcelTemplateWeightUnitEnum
->;
-
-export const DefaultParcelTemplateWeightUnitEnum$zodSchema = z.enum([
-  "g",
-  "kg",
-  "lb",
-  "oz",
-]).describe("The unit used for weight.");
-
-export type DefaultParcelTemplateCarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb =
-  {
-    carrier?: string | undefined;
-    distance_unit?: DistanceUnitEnum | undefined;
-    height?: string | undefined;
-    is_variable_dimensions?: boolean | undefined;
-    length?: string | undefined;
-    name?: string | undefined;
-    token?: string | undefined;
-    width?: string | undefined;
-  };
-
-export const DefaultParcelTemplateCarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb$zodSchema:
-  z.ZodType<
-    DefaultParcelTemplateCarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb
-  > = z.object({
-    carrier: z.string().optional(),
-    distance_unit: DistanceUnitEnum$zodSchema.optional(),
-    height: z.string().optional(),
-    is_variable_dimensions: z.boolean().optional(),
-    length: z.string().optional(),
-    name: z.string().optional(),
-    token: z.string().optional(),
-    width: z.string().optional(),
-  });
-
-export type TheFieldsOfAParcelTemplateBeforeSavingItToTheDb = {
-  distance_unit?: DefaultParcelTemplateDistanceUnitEnum | null | undefined;
-  height?: string | null | undefined;
-  length?: string | null | undefined;
-  name?: string | null | undefined;
-  weight?: string | null | undefined;
-  weight_unit?: DefaultParcelTemplateWeightUnitEnum | null | undefined;
-  width?: string | null | undefined;
-  object_created?: string | undefined;
-  object_id?: string | undefined;
-  object_owner?: string | undefined;
-  object_updated?: string | undefined;
-  template?:
-    | DefaultParcelTemplateCarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb
-    | null
-    | undefined;
-};
-
-export const TheFieldsOfAParcelTemplateBeforeSavingItToTheDb$zodSchema:
-  z.ZodType<TheFieldsOfAParcelTemplateBeforeSavingItToTheDb> = z.object({
-    distance_unit: DefaultParcelTemplateDistanceUnitEnum$zodSchema.nullable()
-      .optional(),
-    height: z.string().nullable().optional(),
-    length: z.string().nullable().optional(),
-    name: z.string().nullable().optional(),
-    object_created: z.string().optional(),
-    object_id: z.string().optional(),
-    object_owner: z.string().optional(),
-    object_updated: z.string().optional(),
-    template: z.lazy(() =>
-      DefaultParcelTemplateCarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb$zodSchema
-    ).nullable().optional(),
-    weight: z.string().nullable().optional(),
-    weight_unit: DefaultParcelTemplateWeightUnitEnum$zodSchema.nullable()
-      .optional(),
-    width: z.string().nullable().optional(),
-  });
+  UserParcelTemplate,
+  UserParcelTemplate$zodSchema,
+} from "./userparceltemplate.js";
 
 export type DefaultParcelTemplate = {
-  result?: TheFieldsOfAParcelTemplateBeforeSavingItToTheDb | null | undefined;
+  result?: UserParcelTemplate | null | undefined;
 };
 
 export const DefaultParcelTemplate$zodSchema: z.ZodType<DefaultParcelTemplate> =
   z.object({
-    result: z.lazy(() =>
-      TheFieldsOfAParcelTemplateBeforeSavingItToTheDb$zodSchema
-    ).nullable().optional(),
+    result: UserParcelTemplate$zodSchema.nullable().optional(),
   });

package/src/models/fedexconnectexistingownaccountparameters.ts

@@ -38,12 +38,5 @@ export const FedExConnectExistingOwnAccountParameters$zodSchema: z.ZodType<
   last_name: z.string(),
   phone_number: z.string(),
 }).describe(
-  "In the case of masked fields, they should be handled carefully.\n"
-    + "\n"
-    + "Fields also must consider: \n"
-    + "- Not providing a *fields* in parameters will not result in a change to any configured value \n"
-    + "- Providing a value in a *masked field* with ****** (exactly 6 asterisks) will not change the configured value \n"
-    + "- Providing *field* with null will clear the configured value \n"
-    + "- Providing *field* with any other value will change the configured value and may affect the behavior of the account.\n"
-    + "",
+  "In the case of masked fields, they should be handled carefully.\n\nFields also must consider: \n- Not providing a *fields* in parameters will not result in a change to any configured value \n- Providing a value in a *masked field* with ****** (exactly 6 asterisks) will not change the configured value \n- Providing *field* with null will clear the configured value \n- Providing *field* with any other value will change the configured value and may affect the behavior of the account.\n",
 );

package/src/models/geocoordinates.ts

@@ -0,0 +1,18 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+/**
+ * Geographic coordinates
+ */
+export type GeoCoordinates = {
+  latitude?: number | null | undefined;
+  longitude?: number | null | undefined;
+};
+
+export const GeoCoordinates$zodSchema: z.ZodType<GeoCoordinates> = z.object({
+  latitude: z.number().nullable().optional(),
+  longitude: z.number().nullable().optional(),
+}).describe("Geographic coordinates");

package/src/models/getorderpackingslipop.ts

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { BadRequest, BadRequest$zodSchema } from "./badrequest.js";
+
+export type GetOrderPackingSlipGlobals = {
+  shippoApiVersion?: string | undefined;
+};
+
+export const GetOrderPackingSlipGlobals$zodSchema: z.ZodType<
+  GetOrderPackingSlipGlobals
+> = 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(),
+});
+
+export type GetOrderPackingSlipRequest = { OrderId: string };
+
+export const GetOrderPackingSlipRequest$zodSchema: z.ZodType<
+  GetOrderPackingSlipRequest
+> = z.object({
+  OrderId: z.string().describe("Object ID of the order"),
+});
+
+/**
+ * Packing slip generated successfully
+ */
+export type GetOrderPackingSlipResponseBody = {
+  slip_url: string;
+  created: string;
+  expires: string;
+};
+
+export const GetOrderPackingSlipResponseBody$zodSchema: z.ZodType<
+  GetOrderPackingSlipResponseBody
+> = z.object({
+  created: z.string(),
+  expires: z.string(),
+  slip_url: z.string(),
+}).describe("Packing slip generated successfully");
+
+export type GetOrderPackingSlipResponse = {
+  ContentType: string;
+  StatusCode: number;
+  RawResponse: Response;
+  object?: GetOrderPackingSlipResponseBody | undefined;
+  BadRequest?: BadRequest | undefined;
+};
+
+export const GetOrderPackingSlipResponse$zodSchema: z.ZodType<
+  GetOrderPackingSlipResponse
+> = z.object({
+  BadRequest: BadRequest$zodSchema.optional(),
+  ContentType: z.string(),
+  RawResponse: z.custom<Response>(x => x instanceof Response),
+  StatusCode: z.int(),
+  object: z.lazy(() => GetOrderPackingSlipResponseBody$zodSchema).optional(),
+});

package/src/models/insurance.ts

@@ -47,8 +47,5 @@ export const Insurance$zodSchema: z.ZodType<Insurance> = z.object({
   currency: z.string().optional(),
   provider: InsuranceProvider$zodSchema.optional(),
 }).describe(
-  "To add 3rd party insurance powered by <a href=\"https://docs.goshippo.com/docs/shipments/shippinginsurance/\">XCover</a>, \n"
-    + "specify <br> `amount`, `content`, and `currency`. <br> Alternatively, you can choose carrier provided insurance \n"
-    + "by additionally specifying `provider` (UPS, FedEx and OnTrac only). <br><br> If you do not want to add insurance \n"
-    + "to your shipment, do not set these parameters.",
+  "To add 3rd party insurance powered by <a href=\"https://docs.goshippo.com/docs/shipments/shippinginsurance/\">XCover</a>, \nspecify <br> `amount`, `content`, and `currency`. <br> Alternatively, you can choose carrier provided insurance \nby additionally specifying `provider` (UPS, FedEx and OnTrac only). <br><br> If you do not want to add insurance \nto your shipment, do not set these parameters.",
 );

package/src/models/labelfiletypeenum.ts

@@ -43,6 +43,5 @@ export const LabelFileTypeEnum$zodSchema = z.enum([
   "PDF_A6",
   "ZPLII",
 ]).describe(
-  "Print format of the <a href=\"https://docs.goshippo.com/docs/shipments/shippinglabelsizes/\">label</a>. If empty, will use the default format set from \n"
-    + "<a href=\"https://apps.goshippo.com/settings/labels\">the Shippo dashboard.</a>",
+  "Print format of the <a href=\"https://docs.goshippo.com/docs/shipments/shippinglabelsizes/\">label</a>. If empty, will use the default format set from \n<a href=\"https://apps.goshippo.com/settings/labels\">the Shippo dashboard.</a>",
 );

package/src/models/listordersop.ts

@@ -38,8 +38,7 @@ export type ListOrdersRequest = {
 export const ListOrdersRequest$zodSchema: z.ZodType<ListOrdersRequest> = z
   .object({
     end_date: z.string().describe(
-      "Filter orders created before the input date and time (ISO 8601 UTC format).  This is based on the \n"
-        + "`placed_at` field, meaning when the order has been placed, not when the order object was created.",
+      "Filter orders created before the input date and time (ISO 8601 UTC format).  This is based on the \n`placed_at` field, meaning when the order has been placed, not when the order object was created.",
     ).optional(),
     orderStatus: z.array(OrderStatusEnum$zodSchema).describe(
       "Filter orders by order status",
@@ -50,8 +49,7 @@ export const ListOrdersRequest$zodSchema: z.ZodType<ListOrdersRequest> = z
     ),
     shop_app: OrderShopAppEnum$zodSchema.optional(),
     start_date: z.string().describe(
-      "Filter orders created after the input date and time (ISO 8601 UTC format).  This is based on the \n"
-        + "`placed_at` field, meaning when the order has been placed, not when the order object was created.",
+      "Filter orders created after the input date and time (ISO 8601 UTC format).  This is based on the \n`placed_at` field, meaning when the order has been placed, not when the order object was created.",
     ).optional(),
   });
 

package/src/models/liveratecreaterequest.ts

@@ -27,9 +27,7 @@ export const LiveRateCreateRequestAddressFrom$zodSchema: z.ZodType<
   AddressCompleteCreateRequest$zodSchema,
   z.string(),
 ]).describe(
-  "The sender address, which includes your name, company name, street address, city, state, zip code, \n"
-    + "country, phone number, and email address (strings). Special characters should not be included in \n"
-    + "any address element, especially name, company, and email.",
+  "The sender address, which includes your name, company name, street address, city, state, zip code, \ncountry, phone number, and email address (strings). Special characters should not be included in \nany address element, especially name, company, and email.",
 );
 
 /**
@@ -49,9 +47,7 @@ export const LiveRateCreateRequestAddressTo$zodSchema: z.ZodType<
   AddressCompleteCreateRequest$zodSchema,
   z.string(),
 ]).describe(
-  "The recipient address, which includes the recipient's name, company name, street address, city, state, zip code, \n"
-    + "country, phone number, and email address (strings). Special characters should not be included in \n"
-    + "any address element, especially name, company, and email.",
+  "The recipient address, which includes the recipient's name, company name, street address, city, state, zip code, \ncountry, phone number, and email address (strings). Special characters should not be included in \nany address element, especially name, company, and email.",
 );
 
 /**

package/src/models/location.ts

@@ -51,8 +51,7 @@ export const BuildingLocationType$zodSchema = z.enum([
   "Reception",
   "Side Door",
 ]).describe(
-  "Where your parcels will be available for pickup. \"Security Deck\" and \"Shipping Dock\" are only \n"
-    + "supported for DHL Express.",
+  "Where your parcels will be available for pickup. \"Security Deck\" and \"Shipping Dock\" are only \nsupported for DHL Express.",
 );
 
 /**

package/src/models/order.ts

@@ -4,10 +4,6 @@
 
 import * as z from "zod";
 import { Address, Address$zodSchema } from "./address.js";
-import {
-  AddressValidationResults,
-  AddressValidationResults$zodSchema,
-} from "./addressvalidationresults.js";
 import { LineItem, LineItem$zodSchema } from "./lineitem.js";
 import {
   OrderShopAppEnum,
@@ -19,61 +15,6 @@ import {
 } from "./orderstatusenum.js";
 import { WeightUnitEnum, WeightUnitEnum$zodSchema } from "./weightunitenum.js";
 
-/**
- * <a href="#tag/Addresses">Address</a> object of the sender / seller. Will be returned expanded by default.
- */
-export type OrderAddressFrom = {
-  name?: string | undefined;
-  company?: string | undefined;
-  street1?: string | undefined;
-  street2?: string | undefined;
-  street3?: string | undefined;
-  street_no?: string | undefined;
-  city?: string | undefined;
-  state?: string | undefined;
-  zip?: string | undefined;
-  country: string;
-  phone?: string | undefined;
-  email?: string | undefined;
-  is_residential?: boolean | null | undefined;
-  metadata?: string | undefined;
-  is_complete?: boolean | undefined;
-  object_created?: string | undefined;
-  object_id?: string | undefined;
-  object_owner?: string | undefined;
-  object_updated?: string | undefined;
-  validation_results?: AddressValidationResults | undefined;
-  test?: boolean | null | undefined;
-};
-
-export const OrderAddressFrom$zodSchema: z.ZodType<OrderAddressFrom> = z.object(
-  {
-    city: z.string().optional(),
-    company: z.string().optional(),
-    country: z.string(),
-    email: z.string().optional(),
-    is_complete: z.boolean().optional(),
-    is_residential: z.boolean().nullable().optional(),
-    metadata: z.string().optional(),
-    name: z.string().optional(),
-    object_created: z.iso.datetime({ offset: true }).optional(),
-    object_id: z.string().optional(),
-    object_owner: z.string().optional(),
-    object_updated: z.iso.datetime({ offset: true }).optional(),
-    phone: z.string().optional(),
-    state: z.string().optional(),
-    street1: z.string().optional(),
-    street2: z.string().optional(),
-    street3: z.string().optional(),
-    street_no: z.string().optional(),
-    test: z.boolean().nullable().optional(),
-    validation_results: AddressValidationResults$zodSchema.optional(),
-    zip: z.string().optional(),
-  },
-).describe(
-  "<a href=\"#tag/Addresses\">Address</a> object of the sender / seller. Will be returned expanded by default.",
-);
-
 export type OrderTransaction = {};
 
 export const OrderTransaction$zodSchema: z.ZodType<OrderTransaction> = z.object(
@@ -94,7 +35,7 @@ export type Order = {
   total_tax?: string | null | undefined;
   weight?: string | null | undefined;
   weight_unit?: WeightUnitEnum | undefined;
-  from_address?: OrderAddressFrom | null | undefined;
+  from_address?: Address | null | undefined;
   to_address: Address;
   line_items?: Array<LineItem> | undefined;
   object_id?: string | undefined;
@@ -105,7 +46,7 @@ export type Order = {
 
 export const Order$zodSchema: z.ZodType<Order> = z.object({
   currency: z.string().nullable().optional(),
-  from_address: z.lazy(() => OrderAddressFrom$zodSchema).nullable().optional(),
+  from_address: Address$zodSchema.nullable().optional(),
   line_items: z.array(LineItem$zodSchema).optional(),
   notes: z.string().nullable().optional(),
   object_id: z.string().optional(),

package/src/models/ordershopappenum.ts

@@ -53,6 +53,5 @@ export const OrderShopAppEnum$zodSchema = z.enum([
   "Weebly",
   "WooCommerce",
 ]).describe(
-  "Platform the order was created on and, if applicable, imported from. \n"
-    + "Orders created via the Shippo API or dashboard will have the value \"Shippo\".",
+  "Platform the order was created on and, if applicable, imported from. \nOrders created via the Shippo API or dashboard will have the value \"Shippo\".",
 );

package/src/models/orderstatusenum.ts

@@ -37,6 +37,5 @@ export const OrderStatusEnum$zodSchema = z.enum([
   "PARTIALLY_FULFILLED",
   "SHIPPED",
 ]).describe(
-  "Current state of the order. See the <a href=\"https://docs.goshippo.com/docs/orders/orders/\">orders tutorial</a> \n"
-    + "for the logic of how the status is handled.",
+  "Current state of the order. See the <a href=\"https://docs.goshippo.com/docs/orders/orders/\">orders tutorial</a> \nfor the logic of how the status is handled.",
 );

package/src/models/parcel.ts

@@ -4,17 +4,44 @@
 
 import * as z from "zod";
 import { ClosedEnum } from "../types/enums.js";
+import { Cod, Cod$zodSchema } from "./cod.js";
 import {
   DistanceUnitEnum,
   DistanceUnitEnum$zodSchema,
 } from "./distanceunitenum.js";
-import { ParcelExtra, ParcelExtra$zodSchema } from "./parcelextra.js";
+import {
+  ParcelInsurance,
+  ParcelInsurance$zodSchema,
+} from "./parcelinsurance.js";
 import {
   ParcelTemplateEnumSet,
   ParcelTemplateEnumSet$zodSchema,
 } from "./parceltemplateenumset.js";
 import { WeightUnitEnum, WeightUnitEnum$zodSchema } from "./weightunitenum.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 ParcelParcelExtra = {
+  COD?: Cod | undefined;
+  insurance?: ParcelInsurance | undefined;
+  reference_1?: string | undefined;
+  reference_2?: string | undefined;
+};
+
+export const ParcelParcelExtra$zodSchema: z.ZodType<ParcelParcelExtra> = 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. \nSee the <a href=\"#section/Parcel-Extras\">Parcel Extra table below</a> for all available services.",
+  );
+
 /**
  * A Parcel will only be valid when all required values have been sent and validated successfully.
  */
@@ -33,7 +60,7 @@ export const ObjectState$zodSchema = z.enum([
 );
 
 export type Parcel = {
-  extra?: ParcelExtra | undefined;
+  extra?: ParcelParcelExtra | null | undefined;
   metadata?: string | undefined;
   mass_unit: WeightUnitEnum;
   weight: string;
@@ -52,7 +79,7 @@ export type Parcel = {
 
 export const Parcel$zodSchema: z.ZodType<Parcel> = z.object({
   distance_unit: DistanceUnitEnum$zodSchema,
-  extra: ParcelExtra$zodSchema.optional(),
+  extra: z.lazy(() => ParcelParcelExtra$zodSchema).nullable().optional(),
   height: z.string(),
   length: z.string(),
   mass_unit: WeightUnitEnum$zodSchema,

package/src/models/parcelcreatefromtemplaterequest.ts

@@ -3,15 +3,43 @@
  */
 
 import * as z from "zod";
-import { ParcelExtra, ParcelExtra$zodSchema } from "./parcelextra.js";
+import { Cod, Cod$zodSchema } from "./cod.js";
+import {
+  ParcelInsurance,
+  ParcelInsurance$zodSchema,
+} from "./parcelinsurance.js";
 import {
   ParcelTemplateEnumSet,
   ParcelTemplateEnumSet$zodSchema,
 } from "./parceltemplateenumset.js";
 import { WeightUnitEnum, WeightUnitEnum$zodSchema } from "./weightunitenum.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 ParcelCreateFromTemplateRequestParcelExtra = {
+  COD?: Cod | undefined;
+  insurance?: ParcelInsurance | undefined;
+  reference_1?: string | undefined;
+  reference_2?: string | undefined;
+};
+
+export const ParcelCreateFromTemplateRequestParcelExtra$zodSchema: z.ZodType<
+  ParcelCreateFromTemplateRequestParcelExtra
+> = 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. \nSee the <a href=\"#section/Parcel-Extras\">Parcel Extra table below</a> for all available services.",
+);
+
 export type ParcelCreateFromTemplateRequest = {
-  extra?: ParcelExtra | undefined;
+  extra?: ParcelCreateFromTemplateRequestParcelExtra | null | undefined;
   metadata?: string | undefined;
   mass_unit: WeightUnitEnum;
   weight: string;
@@ -21,7 +49,8 @@ export type ParcelCreateFromTemplateRequest = {
 export const ParcelCreateFromTemplateRequest$zodSchema: z.ZodType<
   ParcelCreateFromTemplateRequest
 > = z.object({
-  extra: ParcelExtra$zodSchema.optional(),
+  extra: z.lazy(() => ParcelCreateFromTemplateRequestParcelExtra$zodSchema)
+    .nullable().optional(),
   mass_unit: WeightUnitEnum$zodSchema,
   metadata: z.string().optional(),
   template: ParcelTemplateEnumSet$zodSchema.nullable(),