@shippo/shippo-mcp 2.0.18 → 3.0.0

package/src/funcs/addressesValidate.ts

@@ -1,175 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { ShippoSDKCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { APIError } from "../models/errors/apierror.js";
-import {
-  ConnectionError,
-  InvalidRequestError,
-  RequestAbortedError,
-  RequestTimeoutError,
-  UnexpectedClientError,
-} from "../models/errors/httpclienterrors.js";
-import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
-import {
-  ValidateAddressRequest,
-  ValidateAddressRequest$zodSchema,
-  ValidateAddressResponse,
-  ValidateAddressResponse$zodSchema,
-} from "../models/validateaddressop.js";
-import { APICall, APIPromise } from "../types/async.js";
-import { Result } from "../types/fp.js";
-
-/**
- * Validate an address
- *
- * @remarks
- * Validates an existing address using an object ID
- */
-export function addressesValidate(
-  client$: ShippoSDKCore,
-  request: ValidateAddressRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    ValidateAddressResponse,
-    | APIError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | ConnectionError
-  >
-> {
-  return new APIPromise($do(
-    client$,
-    request,
-    options,
-  ));
-}
-
-async function $do(
-  client$: ShippoSDKCore,
-  request: ValidateAddressRequest,
-  options?: RequestOptions,
-): Promise<
-  [
-    Result<
-      ValidateAddressResponse,
-      | APIError
-      | SDKValidationError
-      | UnexpectedClientError
-      | InvalidRequestError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | ConnectionError
-    >,
-    APICall,
-  ]
-> {
-  const parsed$ = safeParse(
-    request,
-    (value$) => ValidateAddressRequest$zodSchema.parse(value$),
-    "Input validation failed",
-  );
-  if (!parsed$.ok) {
-    return [parsed$, { status: "invalid" }];
-  }
-  const payload$ = parsed$.value;
-  const body$ = null;
-
-  const pathParams$ = {
-    AddressId: encodeSimple("AddressId", payload$.AddressId, {
-      explode: false,
-      charEncoding: "percent",
-    }),
-  };
-  const path$ = pathToFunc("/addresses/{AddressId}/validate")(
-    pathParams$,
-  );
-
-  const headers$ = new Headers(compactMap({
-    Accept: "application/json",
-    "SHIPPO-API-VERSION": encodeSimple(
-      "SHIPPO-API-VERSION",
-      client$._options.shippoApiVersion,
-      { explode: false, charEncoding: "none" },
-    ),
-  }));
-  const securityInput = await extractSecurity(client$._options.security);
-  const requestSecurity = resolveGlobalSecurity(securityInput);
-
-  const context = {
-    options: client$._options,
-    baseURL: options?.serverURL ?? client$._baseURL ?? "",
-    operationID: "ValidateAddress",
-    oAuth2Scopes: null,
-    resolvedSecurity: requestSecurity,
-    securitySource: client$._options.security,
-    retryConfig: options?.retries
-      || client$._options.retryConfig
-      || { strategy: "none" },
-    retryCodes: options?.retryCodes || [
-      "429",
-      "500",
-      "502",
-      "503",
-      "504",
-    ],
-  };
-
-  const requestRes = client$._createRequest(context, {
-    security: requestSecurity,
-    method: "GET",
-    baseURL: options?.serverURL,
-    path: path$,
-    headers: headers$,
-    body: body$,
-    userAgent: client$._options.userAgent,
-    timeoutMs: options?.timeoutMs || client$._options.timeoutMs
-      || -1,
-  }, options);
-  if (!requestRes.ok) {
-    return [requestRes, { status: "invalid" }];
-  }
-  const req$ = requestRes.value;
-
-  const doResult = await client$._do(req$, {
-    context,
-    errorCodes: [],
-    retryConfig: context.retryConfig,
-    retryCodes: context.retryCodes,
-  });
-  if (!doResult.ok) {
-    return [doResult, { status: "request-error", request: req$ }];
-  }
-  const response = doResult.value;
-  const responseFields$ = {
-    HttpMeta: { Response: response, Request: req$ },
-  };
-
-  const [result$] = await M.match<
-    ValidateAddressResponse,
-    | APIError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | ConnectionError
-  >(
-    M.json(200, ValidateAddressResponse$zodSchema, { key: "Address" }),
-    M.json(400, ValidateAddressResponse$zodSchema, { key: "BadRequest" }),
-  )(response, req$, { extraFields: responseFields$ });
-
-  return [result$, { status: "complete", request: req$, response }];
-}

package/src/funcs/addressesValidateV2.ts

@@ -1,188 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { ShippoSDKCore } from "../core.js";
-import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { APIError } from "../models/errors/apierror.js";
-import {
-  ConnectionError,
-  InvalidRequestError,
-  RequestAbortedError,
-  RequestTimeoutError,
-  UnexpectedClientError,
-} from "../models/errors/httpclienterrors.js";
-import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
-import {
-  ValidateAddressV2Request,
-  ValidateAddressV2Request$zodSchema,
-  ValidateAddressV2Response,
-  ValidateAddressV2Response$zodSchema,
-} from "../models/validateaddressv2op.js";
-import { APICall, APIPromise } from "../types/async.js";
-import { Result } from "../types/fp.js";
-
-/**
- * Validate an address (v2)
- *
- * @remarks
- * Returns validation test results along with a recommended address.
- * Validates both US and international addresses.
- *
- * **US required combinations:**
- * - state_province + city_locality + address_line_1
- * - OR address_line_1 + postal_code
- *
- * **International required combinations:**
- * - city_locality + address_line_1
- */
-export function addressesValidateV2(
-  client$: ShippoSDKCore,
-  request: ValidateAddressV2Request,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    ValidateAddressV2Response,
-    | APIError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | ConnectionError
-  >
-> {
-  return new APIPromise($do(
-    client$,
-    request,
-    options,
-  ));
-}
-
-async function $do(
-  client$: ShippoSDKCore,
-  request: ValidateAddressV2Request,
-  options?: RequestOptions,
-): Promise<
-  [
-    Result<
-      ValidateAddressV2Response,
-      | APIError
-      | SDKValidationError
-      | UnexpectedClientError
-      | InvalidRequestError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | ConnectionError
-    >,
-    APICall,
-  ]
-> {
-  const parsed$ = safeParse(
-    request,
-    (value$) => ValidateAddressV2Request$zodSchema.parse(value$),
-    "Input validation failed",
-  );
-  if (!parsed$.ok) {
-    return [parsed$, { status: "invalid" }];
-  }
-  const payload$ = parsed$.value;
-  const body$ = null;
-  const path$ = pathToFunc("/v2/addresses/validate")();
-  const query$ = encodeFormQuery({
-    "address_line_1": payload$.address_line_1,
-    "address_line_2": payload$.address_line_2,
-    "city_locality": payload$.city_locality,
-    "country_code": payload$.country_code,
-    "name": payload$.name,
-    "organization": payload$.organization,
-    "postal_code": payload$.postal_code,
-    "state_province": payload$.state_province,
-  });
-
-  const headers$ = new Headers(compactMap({
-    Accept: "application/json",
-    "SHIPPO-API-VERSION": encodeSimple(
-      "SHIPPO-API-VERSION",
-      client$._options.shippoApiVersion,
-      { explode: false, charEncoding: "none" },
-    ),
-  }));
-  const securityInput = await extractSecurity(client$._options.security);
-  const requestSecurity = resolveGlobalSecurity(securityInput);
-
-  const context = {
-    options: client$._options,
-    baseURL: options?.serverURL ?? client$._baseURL ?? "",
-    operationID: "ValidateAddressV2",
-    oAuth2Scopes: null,
-    resolvedSecurity: requestSecurity,
-    securitySource: client$._options.security,
-    retryConfig: options?.retries
-      || client$._options.retryConfig
-      || { strategy: "none" },
-    retryCodes: options?.retryCodes || [
-      "429",
-      "500",
-      "502",
-      "503",
-      "504",
-    ],
-  };
-
-  const requestRes = client$._createRequest(context, {
-    security: requestSecurity,
-    method: "GET",
-    baseURL: options?.serverURL,
-    path: path$,
-    headers: headers$,
-    query: query$,
-    body: body$,
-    userAgent: client$._options.userAgent,
-    timeoutMs: options?.timeoutMs || client$._options.timeoutMs
-      || -1,
-  }, options);
-  if (!requestRes.ok) {
-    return [requestRes, { status: "invalid" }];
-  }
-  const req$ = requestRes.value;
-
-  const doResult = await client$._do(req$, {
-    context,
-    errorCodes: [],
-    retryConfig: context.retryConfig,
-    retryCodes: context.retryCodes,
-  });
-  if (!doResult.ok) {
-    return [doResult, { status: "request-error", request: req$ }];
-  }
-  const response = doResult.value;
-  const responseFields$ = {
-    HttpMeta: { Response: response, Request: req$ },
-  };
-
-  const [result$] = await M.match<
-    ValidateAddressV2Response,
-    | APIError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | ConnectionError
-  >(
-    M.json(200, ValidateAddressV2Response$zodSchema, {
-      key: "AddressValidationResultV2",
-    }),
-    M.json(422, ValidateAddressV2Response$zodSchema, { key: "object" }),
-    M.nil("5XX", ValidateAddressV2Response$zodSchema),
-  )(response, req$, { extraFields: responseFields$ });
-
-  return [result$, { status: "complete", request: req$, response }];
-}

package/src/funcs/batchesAddShipments.ts

@@ -1,176 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { ShippoSDKCore } from "../core.js";
-import { encodeJSON, encodeSimple } from "../lib/encodings.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import {
-  AddShipmentsToBatchRequest,
-  AddShipmentsToBatchRequest$zodSchema,
-  AddShipmentsToBatchResponse,
-  AddShipmentsToBatchResponse$zodSchema,
-} from "../models/addshipmentstobatchop.js";
-import { APIError } from "../models/errors/apierror.js";
-import {
-  ConnectionError,
-  InvalidRequestError,
-  RequestAbortedError,
-  RequestTimeoutError,
-  UnexpectedClientError,
-} from "../models/errors/httpclienterrors.js";
-import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
-import { APICall, APIPromise } from "../types/async.js";
-import { Result } from "../types/fp.js";
-
-/**
- * Add shipments to a batch
- *
- * @remarks
- * Adds batch shipments to an existing batch.
- */
-export function batchesAddShipments(
-  client$: ShippoSDKCore,
-  request: AddShipmentsToBatchRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    AddShipmentsToBatchResponse,
-    | APIError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | ConnectionError
-  >
-> {
-  return new APIPromise($do(
-    client$,
-    request,
-    options,
-  ));
-}
-
-async function $do(
-  client$: ShippoSDKCore,
-  request: AddShipmentsToBatchRequest,
-  options?: RequestOptions,
-): Promise<
-  [
-    Result<
-      AddShipmentsToBatchResponse,
-      | APIError
-      | SDKValidationError
-      | UnexpectedClientError
-      | InvalidRequestError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | ConnectionError
-    >,
-    APICall,
-  ]
-> {
-  const parsed$ = safeParse(
-    request,
-    (value$) => AddShipmentsToBatchRequest$zodSchema.parse(value$),
-    "Input validation failed",
-  );
-  if (!parsed$.ok) {
-    return [parsed$, { status: "invalid" }];
-  }
-  const payload$ = parsed$.value;
-  const body$ = encodeJSON("body", payload$.body, { explode: true });
-
-  const pathParams$ = {
-    BatchId: encodeSimple("BatchId", payload$.BatchId, {
-      explode: false,
-      charEncoding: "percent",
-    }),
-  };
-  const path$ = pathToFunc("/batches/{BatchId}/add_shipments")(
-    pathParams$,
-  );
-
-  const headers$ = new Headers(compactMap({
-    "Content-Type": "application/json",
-    Accept: "application/json",
-    "SHIPPO-API-VERSION": encodeSimple(
-      "SHIPPO-API-VERSION",
-      client$._options.shippoApiVersion,
-      { explode: false, charEncoding: "none" },
-    ),
-  }));
-  const securityInput = await extractSecurity(client$._options.security);
-  const requestSecurity = resolveGlobalSecurity(securityInput);
-
-  const context = {
-    options: client$._options,
-    baseURL: options?.serverURL ?? client$._baseURL ?? "",
-    operationID: "AddShipmentsToBatch",
-    oAuth2Scopes: null,
-    resolvedSecurity: requestSecurity,
-    securitySource: client$._options.security,
-    retryConfig: options?.retries
-      || client$._options.retryConfig
-      || { strategy: "none" },
-    retryCodes: options?.retryCodes || [
-      "429",
-      "500",
-      "502",
-      "503",
-      "504",
-    ],
-  };
-
-  const requestRes = client$._createRequest(context, {
-    security: requestSecurity,
-    method: "POST",
-    baseURL: options?.serverURL,
-    path: path$,
-    headers: headers$,
-    body: body$,
-    userAgent: client$._options.userAgent,
-    timeoutMs: options?.timeoutMs || client$._options.timeoutMs
-      || -1,
-  }, options);
-  if (!requestRes.ok) {
-    return [requestRes, { status: "invalid" }];
-  }
-  const req$ = requestRes.value;
-
-  const doResult = await client$._do(req$, {
-    context,
-    errorCodes: [],
-    retryConfig: context.retryConfig,
-    retryCodes: context.retryCodes,
-  });
-  if (!doResult.ok) {
-    return [doResult, { status: "request-error", request: req$ }];
-  }
-  const response = doResult.value;
-  const responseFields$ = {
-    HttpMeta: { Response: response, Request: req$ },
-  };
-
-  const [result$] = await M.match<
-    AddShipmentsToBatchResponse,
-    | APIError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | ConnectionError
-  >(
-    M.json(200, AddShipmentsToBatchResponse$zodSchema, { key: "Batch" }),
-    M.json(400, AddShipmentsToBatchResponse$zodSchema, { key: "BadRequest" }),
-  )(response, req$, { extraFields: responseFields$ });
-
-  return [result$, { status: "complete", request: req$, response }];
-}

package/src/funcs/batchesCreate.ts

@@ -1,178 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { ShippoSDKCore } from "../core.js";
-import { encodeJSON, encodeSimple } from "../lib/encodings.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import {
-  BatchCreateRequest,
-  BatchCreateRequest$zodSchema,
-} from "../models/batchcreaterequest.js";
-import {
-  CreateBatchResponse,
-  CreateBatchResponse$zodSchema,
-} from "../models/createbatchop.js";
-import { APIError } from "../models/errors/apierror.js";
-import {
-  ConnectionError,
-  InvalidRequestError,
-  RequestAbortedError,
-  RequestTimeoutError,
-  UnexpectedClientError,
-} from "../models/errors/httpclienterrors.js";
-import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
-import { APICall, APIPromise } from "../types/async.js";
-import { Result } from "../types/fp.js";
-
-/**
- * Create a batch
- *
- * @remarks
- * Creates a new batch object for purchasing shipping labels for many shipments at once. Batches are created asynchronously. This means that the API response won't include your batch shipments yet. You need to retrieve the batch later to verify that all batch shipments are valid.
- *
- * **IMPORTANT: There is NO batches-list endpoint in the Shippo API.**
- * You must store the batch `object_id` returned from this endpoint to retrieve batches later using `batches-get`.
- *
- * **Workflow:**
- * 1. Create batch → Save the returned `object_id`
- * 2. Retrieve batch status using `batches-get` with the saved ID
- * 3. Add/remove shipments as needed
- * 4. Purchase the batch when ready
- */
-export function batchesCreate(
-  client$: ShippoSDKCore,
-  request: BatchCreateRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    CreateBatchResponse,
-    | APIError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | ConnectionError
-  >
-> {
-  return new APIPromise($do(
-    client$,
-    request,
-    options,
-  ));
-}
-
-async function $do(
-  client$: ShippoSDKCore,
-  request: BatchCreateRequest,
-  options?: RequestOptions,
-): Promise<
-  [
-    Result<
-      CreateBatchResponse,
-      | APIError
-      | SDKValidationError
-      | UnexpectedClientError
-      | InvalidRequestError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | ConnectionError
-    >,
-    APICall,
-  ]
-> {
-  const parsed$ = safeParse(
-    request,
-    (value$) => BatchCreateRequest$zodSchema.parse(value$),
-    "Input validation failed",
-  );
-  if (!parsed$.ok) {
-    return [parsed$, { status: "invalid" }];
-  }
-  const payload$ = parsed$.value;
-  const body$ = encodeJSON("body", payload$, { explode: true });
-  const path$ = pathToFunc("/batches")();
-
-  const headers$ = new Headers(compactMap({
-    "Content-Type": "application/json",
-    Accept: "application/json",
-    "SHIPPO-API-VERSION": encodeSimple(
-      "SHIPPO-API-VERSION",
-      client$._options.shippoApiVersion,
-      { explode: false, charEncoding: "none" },
-    ),
-  }));
-  const securityInput = await extractSecurity(client$._options.security);
-  const requestSecurity = resolveGlobalSecurity(securityInput);
-
-  const context = {
-    options: client$._options,
-    baseURL: options?.serverURL ?? client$._baseURL ?? "",
-    operationID: "CreateBatch",
-    oAuth2Scopes: null,
-    resolvedSecurity: requestSecurity,
-    securitySource: client$._options.security,
-    retryConfig: options?.retries
-      || client$._options.retryConfig
-      || { strategy: "none" },
-    retryCodes: options?.retryCodes || [
-      "429",
-      "500",
-      "502",
-      "503",
-      "504",
-    ],
-  };
-
-  const requestRes = client$._createRequest(context, {
-    security: requestSecurity,
-    method: "POST",
-    baseURL: options?.serverURL,
-    path: path$,
-    headers: headers$,
-    body: body$,
-    userAgent: client$._options.userAgent,
-    timeoutMs: options?.timeoutMs || client$._options.timeoutMs
-      || -1,
-  }, options);
-  if (!requestRes.ok) {
-    return [requestRes, { status: "invalid" }];
-  }
-  const req$ = requestRes.value;
-
-  const doResult = await client$._do(req$, {
-    context,
-    errorCodes: [],
-    retryConfig: context.retryConfig,
-    retryCodes: context.retryCodes,
-  });
-  if (!doResult.ok) {
-    return [doResult, { status: "request-error", request: req$ }];
-  }
-  const response = doResult.value;
-  const responseFields$ = {
-    HttpMeta: { Response: response, Request: req$ },
-  };
-
-  const [result$] = await M.match<
-    CreateBatchResponse,
-    | APIError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | ConnectionError
-  >(
-    M.json(201, CreateBatchResponse$zodSchema, { key: "Batch" }),
-    M.json(400, CreateBatchResponse$zodSchema, { key: "BadRequest" }),
-  )(response, req$, { extraFields: responseFields$ });
-
-  return [result$, { status: "complete", request: req$, response }];
-}