@shippo/shippo-mcp 0.8.34 → 0.8.43

package/src/models/defaultparceltemplate.ts

@@ -3,29 +3,85 @@
  */
 
 import * as z from "zod";
-import {
-  CarrierParcelTemplate,
-  CarrierParcelTemplate$zodSchema,
-} from "./carrierparceltemplate.js";
 import {
   DistanceUnitEnum,
   DistanceUnitEnum$zodSchema,
 } from "./distanceunitenum.js";
-import { WeightUnitEnum, WeightUnitEnum$zodSchema } from "./weightunitenum.js";
+
+/**
+ * The measure unit used for length, width and height.
+ */
+export const DefaultParcelTemplateDistanceUnitEnum$zodSchema = z.enum([
+  "cm",
+  "in",
+  "ft",
+  "m",
+  "mm",
+  "yd",
+]).describe("The measure unit used for length, width and height.");
+
+export type DefaultParcelTemplateDistanceUnitEnum = z.infer<
+  typeof DefaultParcelTemplateDistanceUnitEnum$zodSchema
+>;
+
+/**
+ * The unit used for weight.
+ */
+export const DefaultParcelTemplateWeightUnitEnum$zodSchema = z.enum([
+  "g",
+  "kg",
+  "lb",
+  "oz",
+]).describe("The unit used for weight.");
+
+export type DefaultParcelTemplateWeightUnitEnum = z.infer<
+  typeof DefaultParcelTemplateWeightUnitEnum$zodSchema
+>;
+
+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.ZodTypeDef,
+    unknown
+  > = 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?: DistanceUnitEnum | undefined;
-  height?: string | undefined;
-  length?: string | undefined;
-  name?: string | undefined;
-  weight?: string | undefined;
-  weight_unit?: WeightUnitEnum | undefined;
-  width?: string | undefined;
+  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?: CarrierParcelTemplate | undefined;
+  template?:
+    | DefaultParcelTemplateCarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb
+    | null
+    | undefined;
 };
 
 export const TheFieldsOfAParcelTemplateBeforeSavingItToTheDb$zodSchema:
@@ -34,18 +90,22 @@ export const TheFieldsOfAParcelTemplateBeforeSavingItToTheDb$zodSchema:
     z.ZodTypeDef,
     unknown
   > = z.object({
-    distance_unit: DistanceUnitEnum$zodSchema.optional(),
-    height: z.string().optional(),
-    length: z.string().optional(),
-    name: z.string().optional(),
+    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: CarrierParcelTemplate$zodSchema.optional(),
-    weight: z.string().optional(),
-    weight_unit: WeightUnitEnum$zodSchema.optional(),
-    width: 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(),
   });
 
 export type DefaultParcelTemplate = {

package/src/models/order.ts

@@ -4,6 +4,10 @@
 
 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,
@@ -15,6 +19,63 @@ 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.ZodTypeDef,
+  unknown
+> = 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.string().datetime({ offset: true }).optional(),
+  object_id: z.string().optional(),
+  object_owner: z.string().optional(),
+  object_updated: z.string().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<
@@ -24,20 +85,20 @@ export const OrderTransaction$zodSchema: z.ZodType<
 > = z.object({});
 
 export type Order = {
-  currency?: string | undefined;
-  notes?: string | undefined;
-  order_number?: string | undefined;
+  currency?: string | null | undefined;
+  notes?: string | null | undefined;
+  order_number?: string | null | undefined;
   order_status?: OrderStatusEnum | undefined;
   placed_at: string;
-  shipping_cost?: string | undefined;
-  shipping_cost_currency?: string | undefined;
-  shipping_method?: string | undefined;
-  subtotal_price?: string | undefined;
-  total_price?: string | undefined;
-  total_tax?: string | undefined;
-  weight?: string | undefined;
+  shipping_cost?: string | null | undefined;
+  shipping_cost_currency?: string | null | undefined;
+  shipping_method?: string | null | undefined;
+  subtotal_price?: string | null | undefined;
+  total_price?: string | null | undefined;
+  total_tax?: string | null | undefined;
+  weight?: string | null | undefined;
   weight_unit?: WeightUnitEnum | undefined;
-  from_address?: Address | undefined;
+  from_address?: OrderAddressFrom | null | undefined;
   to_address: Address;
   line_items?: Array<LineItem> | undefined;
   object_id?: string | undefined;
@@ -48,24 +109,25 @@ export type Order = {
 
 export const Order$zodSchema: z.ZodType<Order, z.ZodTypeDef, unknown> = z
   .object({
-    currency: z.string().optional(),
-    from_address: Address$zodSchema.optional(),
+    currency: z.string().nullable().optional(),
+    from_address: z.lazy(() => OrderAddressFrom$zodSchema).nullable()
+      .optional(),
     line_items: z.array(LineItem$zodSchema).optional(),
-    notes: z.string().optional(),
+    notes: z.string().nullable().optional(),
     object_id: z.string().optional(),
     object_owner: z.string().optional(),
-    order_number: z.string().optional(),
+    order_number: z.string().nullable().optional(),
     order_status: OrderStatusEnum$zodSchema.optional(),
     placed_at: z.string(),
-    shipping_cost: z.string().optional(),
-    shipping_cost_currency: z.string().optional(),
-    shipping_method: z.string().optional(),
+    shipping_cost: z.string().nullable().optional(),
+    shipping_cost_currency: z.string().nullable().optional(),
+    shipping_method: z.string().nullable().optional(),
     shop_app: OrderShopAppEnum$zodSchema.optional(),
-    subtotal_price: z.string().optional(),
+    subtotal_price: z.string().nullable().optional(),
     to_address: Address$zodSchema,
-    total_price: z.string().optional(),
-    total_tax: z.string().optional(),
+    total_price: z.string().nullable().optional(),
+    total_tax: z.string().nullable().optional(),
     transactions: z.array(z.lazy(() => OrderTransaction$zodSchema)).optional(),
-    weight: z.string().optional(),
+    weight: z.string().nullable().optional(),
     weight_unit: WeightUnitEnum$zodSchema.optional(),
   });

package/src/models/ordercreaterequest.ts

@@ -15,18 +15,18 @@ import {
 import { WeightUnitEnum, WeightUnitEnum$zodSchema } from "./weightunitenum.js";
 
 export type OrderCreateRequest = {
-  currency?: string | undefined;
-  notes?: string | undefined;
-  order_number?: string | undefined;
+  currency?: string | null | undefined;
+  notes?: string | null | undefined;
+  order_number?: string | null | undefined;
   order_status?: OrderStatusEnum | undefined;
   placed_at: string;
-  shipping_cost?: string | undefined;
-  shipping_cost_currency?: string | undefined;
-  shipping_method?: string | undefined;
-  subtotal_price?: string | undefined;
-  total_price?: string | undefined;
-  total_tax?: string | undefined;
-  weight?: string | undefined;
+  shipping_cost?: string | null | undefined;
+  shipping_cost_currency?: string | null | undefined;
+  shipping_method?: string | null | undefined;
+  subtotal_price?: string | null | undefined;
+  total_price?: string | null | undefined;
+  total_tax?: string | null | undefined;
+  weight?: string | null | undefined;
   weight_unit?: WeightUnitEnum | undefined;
   from_address?: AddressCreateRequest | undefined;
   to_address: AddressCreateRequest;
@@ -38,20 +38,20 @@ export const OrderCreateRequest$zodSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  currency: z.string().optional(),
+  currency: z.string().nullable().optional(),
   from_address: AddressCreateRequest$zodSchema.optional(),
   line_items: z.array(LineItemBase$zodSchema).optional(),
-  notes: z.string().optional(),
-  order_number: z.string().optional(),
+  notes: z.string().nullable().optional(),
+  order_number: z.string().nullable().optional(),
   order_status: OrderStatusEnum$zodSchema.optional(),
   placed_at: z.string(),
-  shipping_cost: z.string().optional(),
-  shipping_cost_currency: z.string().optional(),
-  shipping_method: z.string().optional(),
-  subtotal_price: z.string().optional(),
+  shipping_cost: z.string().nullable().optional(),
+  shipping_cost_currency: z.string().nullable().optional(),
+  shipping_method: z.string().nullable().optional(),
+  subtotal_price: z.string().nullable().optional(),
   to_address: AddressCreateRequest$zodSchema,
-  total_price: z.string().optional(),
-  total_tax: z.string().optional(),
-  weight: z.string().optional(),
+  total_price: z.string().nullable().optional(),
+  total_tax: z.string().nullable().optional(),
+  weight: z.string().nullable().optional(),
   weight_unit: WeightUnitEnum$zodSchema.optional(),
 });

package/src/models/servicegroup.ts

@@ -19,7 +19,7 @@ export type ServiceGroup = {
   free_shipping_threshold_currency?: string | null | undefined;
   free_shipping_threshold_min?: string | null | undefined;
   name: string;
-  rate_adjustment?: number | undefined;
+  rate_adjustment?: number | null | undefined;
   type: ServiceGroupTypeEnum;
   object_id: string;
   is_active?: boolean | undefined;
@@ -39,7 +39,7 @@ export const ServiceGroup$zodSchema: z.ZodType<
   is_active: z.boolean().optional(),
   name: z.string(),
   object_id: z.string(),
-  rate_adjustment: z.number().int().optional(),
+  rate_adjustment: z.number().int().nullable().optional(),
   service_levels: z.array(ServiceGroupAccountAndServiceLevel$zodSchema)
     .nullable(),
   type: ServiceGroupTypeEnum$zodSchema,

package/src/models/servicegroupcreaterequest.ts

@@ -19,7 +19,7 @@ export type ServiceGroupCreateRequest = {
   free_shipping_threshold_currency?: string | null | undefined;
   free_shipping_threshold_min?: string | null | undefined;
   name: string;
-  rate_adjustment?: number | undefined;
+  rate_adjustment?: number | null | undefined;
   type: ServiceGroupTypeEnum;
   service_levels: Array<ServiceGroupAccountAndServiceLevel>;
 };
@@ -35,7 +35,7 @@ export const ServiceGroupCreateRequest$zodSchema: z.ZodType<
   free_shipping_threshold_currency: z.string().nullable().optional(),
   free_shipping_threshold_min: z.string().nullable().optional(),
   name: z.string(),
-  rate_adjustment: z.number().int().optional(),
+  rate_adjustment: z.number().int().nullable().optional(),
   service_levels: z.array(ServiceGroupAccountAndServiceLevel$zodSchema),
   type: ServiceGroupTypeEnum$zodSchema,
 });

package/src/models/servicegroupupdaterequest.ts

@@ -19,7 +19,7 @@ export type ServiceGroupUpdateRequest = {
   free_shipping_threshold_currency?: string | null | undefined;
   free_shipping_threshold_min?: string | null | undefined;
   name: string;
-  rate_adjustment?: number | undefined;
+  rate_adjustment?: number | null | undefined;
   type: ServiceGroupTypeEnum;
   object_id: string;
   is_active: boolean;
@@ -39,7 +39,7 @@ export const ServiceGroupUpdateRequest$zodSchema: z.ZodType<
   is_active: z.boolean(),
   name: z.string(),
   object_id: z.string(),
-  rate_adjustment: z.number().int().optional(),
+  rate_adjustment: z.number().int().nullable().optional(),
   service_levels: z.array(ServiceGroupAccountAndServiceLevel$zodSchema),
   type: ServiceGroupTypeEnum$zodSchema,
 });

package/src/models/userparceltemplate.ts

@@ -3,29 +3,85 @@
  */
 
 import * as z from "zod";
-import {
-  CarrierParcelTemplate,
-  CarrierParcelTemplate$zodSchema,
-} from "./carrierparceltemplate.js";
 import {
   DistanceUnitEnum,
   DistanceUnitEnum$zodSchema,
 } from "./distanceunitenum.js";
-import { WeightUnitEnum, WeightUnitEnum$zodSchema } from "./weightunitenum.js";
+
+/**
+ * The measure unit used for length, width and height.
+ */
+export const UserParcelTemplateDistanceUnitEnum$zodSchema = z.enum([
+  "cm",
+  "in",
+  "ft",
+  "m",
+  "mm",
+  "yd",
+]).describe("The measure unit used for length, width and height.");
+
+export type UserParcelTemplateDistanceUnitEnum = z.infer<
+  typeof UserParcelTemplateDistanceUnitEnum$zodSchema
+>;
+
+/**
+ * The unit used for weight.
+ */
+export const UserParcelTemplateWeightUnitEnum$zodSchema = z.enum([
+  "g",
+  "kg",
+  "lb",
+  "oz",
+]).describe("The unit used for weight.");
+
+export type UserParcelTemplateWeightUnitEnum = z.infer<
+  typeof UserParcelTemplateWeightUnitEnum$zodSchema
+>;
+
+export type CarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb =
+  {
+    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 CarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb$zodSchema:
+  z.ZodType<
+    CarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb,
+    z.ZodTypeDef,
+    unknown
+  > = 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 UserParcelTemplate = {
-  distance_unit?: DistanceUnitEnum | undefined;
-  height?: string | undefined;
-  length?: string | undefined;
-  name?: string | undefined;
-  weight?: string | undefined;
-  weight_unit?: WeightUnitEnum | undefined;
-  width?: string | undefined;
+  distance_unit?: UserParcelTemplateDistanceUnitEnum | null | undefined;
+  height?: string | null | undefined;
+  length?: string | null | undefined;
+  name?: string | null | undefined;
+  weight?: string | null | undefined;
+  weight_unit?: UserParcelTemplateWeightUnitEnum | null | undefined;
+  width?: string | null | undefined;
   object_created?: string | undefined;
   object_id?: string | undefined;
   object_owner?: string | undefined;
   object_updated?: string | undefined;
-  template?: CarrierParcelTemplate | undefined;
+  template?:
+    | CarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb
+    | null
+    | undefined;
 };
 
 export const UserParcelTemplate$zodSchema: z.ZodType<
@@ -33,16 +89,19 @@ export const UserParcelTemplate$zodSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  distance_unit: DistanceUnitEnum$zodSchema.optional(),
-  height: z.string().optional(),
-  length: z.string().optional(),
-  name: z.string().optional(),
+  distance_unit: UserParcelTemplateDistanceUnitEnum$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: CarrierParcelTemplate$zodSchema.optional(),
-  weight: z.string().optional(),
-  weight_unit: WeightUnitEnum$zodSchema.optional(),
-  width: z.string().optional(),
+  template: z.lazy(() =>
+    CarrierParcelTemplateRepresentsTheFieldsOfATemplateBeforeSavingItToTheDb$zodSchema
+  ).nullable().optional(),
+  weight: z.string().nullable().optional(),
+  weight_unit: UserParcelTemplateWeightUnitEnum$zodSchema.nullable().optional(),
+  width: z.string().nullable().optional(),
 });

package/src/models/userparceltemplateupdaterequest.ts

@@ -3,20 +3,50 @@
  */
 
 import * as z from "zod";
-import {
-  DistanceUnitEnum,
-  DistanceUnitEnum$zodSchema,
-} from "./distanceunitenum.js";
-import { WeightUnitEnum, WeightUnitEnum$zodSchema } from "./weightunitenum.js";
+
+/**
+ * The measure unit used for length, width and height.
+ */
+export const UserParcelTemplateUpdateRequestDistanceUnitEnum$zodSchema = z.enum(
+  [
+    "cm",
+    "in",
+    "ft",
+    "m",
+    "mm",
+    "yd",
+  ],
+).describe("The measure unit used for length, width and height.");
+
+export type UserParcelTemplateUpdateRequestDistanceUnitEnum = z.infer<
+  typeof UserParcelTemplateUpdateRequestDistanceUnitEnum$zodSchema
+>;
+
+/**
+ * The unit used for weight.
+ */
+export const UserParcelTemplateUpdateRequestWeightUnitEnum$zodSchema = z.enum([
+  "g",
+  "kg",
+  "lb",
+  "oz",
+]).describe("The unit used for weight.");
+
+export type UserParcelTemplateUpdateRequestWeightUnitEnum = z.infer<
+  typeof UserParcelTemplateUpdateRequestWeightUnitEnum$zodSchema
+>;
 
 export type UserParcelTemplateUpdateRequest = {
-  distance_unit: DistanceUnitEnum;
-  height: string;
-  length: string;
-  name: string;
-  weight?: string | undefined;
-  weight_unit?: WeightUnitEnum | undefined;
-  width: string;
+  distance_unit: UserParcelTemplateUpdateRequestDistanceUnitEnum | null;
+  height: string | null;
+  length: string | null;
+  name: string | null;
+  weight?: string | null | undefined;
+  weight_unit?:
+    | UserParcelTemplateUpdateRequestWeightUnitEnum
+    | null
+    | undefined;
+  width: string | null;
 };
 
 export const UserParcelTemplateUpdateRequest$zodSchema: z.ZodType<
@@ -24,11 +54,13 @@ export const UserParcelTemplateUpdateRequest$zodSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  distance_unit: DistanceUnitEnum$zodSchema,
-  height: z.string(),
-  length: z.string(),
-  name: z.string(),
-  weight: z.string().optional(),
-  weight_unit: WeightUnitEnum$zodSchema.optional(),
-  width: z.string(),
+  distance_unit: UserParcelTemplateUpdateRequestDistanceUnitEnum$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(),
+  width: z.string().nullable(),
 });