Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
- `ApiKey.disable`
- Adds a `Tracker.delete` function
- Fixes various Typescript definitions (adding missing items, correcting invalid items, consolidating duplicates, etc)
- Fixes TypeScript exports for model classes to be type-only exports. This prevents runtime errors when attempting to use these classes with `instanceof` or as constructors, since they are not actually exported as JavaScript values from the package. Users can still use these types for type annotations. (closes #456)

## v8.4.0 (2025-11-24)

Expand Down
4 changes: 3 additions & 1 deletion types/Address/Address.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ export declare interface IAddress extends IObjectWithId<'Address'> {
verifications: IVerifications;
}

export declare class Address implements IAddress {
declare class Address implements IAddress {
public constructor(input: DeepPartial<IAddressCreateParameters>);

id: string;
Expand Down Expand Up @@ -190,3 +190,5 @@ export declare class Address implements IAddress {
pageSize?: number,
): Promise<{ addresses: Address[]; has_more: boolean }>;
}

export type { Address };
4 changes: 3 additions & 1 deletion types/ApiKey/ApiKey.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export declare interface IApiKey extends IObjectWithId<'ApiKey'> {
active: boolean;
}

export declare class ApiKey implements IApiKey {
declare class ApiKey implements IApiKey {
id: string;
mode: 'test' | 'production';
object: 'ApiKey';
Expand Down Expand Up @@ -86,3 +86,5 @@ export declare class ApiKey implements IApiKey {
*/
static disable(id: string): Promise<ApiKey>;
}

export type { ApiKey };
4 changes: 3 additions & 1 deletion types/Batch/Batch.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ export declare interface IBatch extends IObjectWithId<'Batch'>, IDatedObject {
pickup: IPickup;
}

export declare class Batch implements IBatch {
declare class Batch implements IBatch {
public constructor(input: IBatchCreateParameters);

id: string;
Expand Down Expand Up @@ -177,3 +177,5 @@ export declare class Batch implements IBatch {
*/
static all(params?: IBatchListParameters): Promise<{ batches: Batch[]; has_more: boolean }>;
}

export type { Batch };
4 changes: 3 additions & 1 deletion types/Billing/Billing.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* @see https://docs.easypost.com/docs/users/billing
*/
export declare class Billing {
declare class Billing {
/**
* Fund your EasyPost wallet by charging your primary or secondary payment method on file.
*
Expand Down Expand Up @@ -33,3 +33,5 @@ export declare class Billing {
*/
static retrievePaymentMethods(): object;
}

export type { Billing };
4 changes: 3 additions & 1 deletion types/Brand/Brand.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export declare interface IBrand extends IObjectWithId<'Brand'> {
theme: 'theme1' | 'theme2';
}

export declare class Brand implements IBrand {
declare class Brand implements IBrand {
id: string;
mode: 'test' | 'production';
object: 'Brand';
Expand All @@ -71,3 +71,5 @@ export declare class Brand implements IBrand {
*/
static updateBrand(params: object): Promise<Brand>;
}

export type { Brand };
4 changes: 3 additions & 1 deletion types/Carrier/CarrierAccount/CarrierAccount.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ export declare interface ICarrierAccount extends IObjectWithId<'CarrierAccount'>
billing_type: string | null;
}

export declare class CarrierAccount implements ICarrierAccount {
declare class CarrierAccount implements ICarrierAccount {
public constructor(input: DeepPartial<ICarrierAccountCreateParameters>);

id: string;
Expand Down Expand Up @@ -137,3 +137,5 @@ export declare class CarrierAccount implements ICarrierAccount {
*/
static delete(carrierAccountId: string): void;
}

export type { CarrierAccount };
4 changes: 3 additions & 1 deletion types/Carrier/CarrierMetadata/CarrierMetadata.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export declare interface ICarrierMetadata {
shipment_options?: Array<Object> | null;
}

export declare class CarrierMetadata implements ICarrierMetadata {
declare class CarrierMetadata implements ICarrierMetadata {
carrier: string;
human_readable?: string | null;
service_levels?: Array<Object> | null;
Expand All @@ -59,3 +59,5 @@ export declare class CarrierMetadata implements ICarrierMetadata {
*/
static retrieve(carriers: Array<string>, types: Array<string>): Promise<CarrierMetadata>;
}

export type { CarrierMetadata };
4 changes: 3 additions & 1 deletion types/Carrier/CarrierType/CarrierType.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export declare interface ICarrierType extends IBaseObject<'CarrierType'> {
fields: ICarrierTypeFields;
}

export declare class CarrierType implements ICarrierType {
declare class CarrierType implements ICarrierType {
type: string;
fields: ICarrierTypeFields;
object: 'CarrierType';
Expand All @@ -43,3 +43,5 @@ export declare class CarrierType implements ICarrierType {
*/
static all(): Promise<CarrierType[]>;
}

export type { CarrierType };
4 changes: 3 additions & 1 deletion types/Claim/Claim.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ export declare interface IClaim extends IObjectWithId<'Claim'>, IDatedObject {
type: TClaimType;
}

export declare class Claim implements IClaim {
declare class Claim implements IClaim {
public constructor(input: IClaimCreateParameters);

id: string;
Expand Down Expand Up @@ -153,3 +153,5 @@ export declare class Claim implements IClaim {
*/
static cancel(claimId: string): Promise<Claim>;
}

export type { Claim };
4 changes: 3 additions & 1 deletion types/CustomerPortal/CustomerPortalAccountLink.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export declare interface ICustomerPortalAccountLink {
expires_at: string;
}

export declare class CustomerPortalAccountLink implements ICustomerPortalAccountLink {
declare class CustomerPortalAccountLink implements ICustomerPortalAccountLink {
public constructor(input: ICustomerPortalAccountLinkCreateParameters);

object: 'CustomerPortalAccountLink';
Expand All @@ -36,3 +36,5 @@ export declare class CustomerPortalAccountLink implements ICustomerPortalAccount
*/
static createAccountLink(params: Object): Promise<CustomerPortalAccountLink>;
}

export type { CustomerPortalAccountLink };
4 changes: 3 additions & 1 deletion types/Customs/CustomsInfo/CustomsInfo.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ export declare interface ICustomsInfo extends IObjectWithId<'CustomsInfo'>, IDat
declaration?: string | null;
}

export declare class CustomsInfo implements ICustomsInfo {
declare class CustomsInfo implements ICustomsInfo {
public constructor(input: DeepPartial<ICustomsInfoCreateParameters>);

id: string;
Expand Down Expand Up @@ -105,3 +105,5 @@ export declare class CustomsInfo implements ICustomsInfo {
*/
static retrieve(CustomsInfoId: string): Promise<CustomsInfo>;
}

export type { CustomsInfo };
4 changes: 3 additions & 1 deletion types/Customs/CustomsItem/CustomsItem.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export declare interface ICustomsItem extends IObjectWithId<'CustomsItem'>, IDat
currency?: string | null;
}

export declare class CustomsItem implements ICustomsItem {
declare class CustomsItem implements ICustomsItem {
public constructor(input: DeepPartial<ICustomsItemCreateParameters>);

id: string;
Expand Down Expand Up @@ -92,3 +92,5 @@ export declare class CustomsItem implements ICustomsItem {
*/
static retrieve(CustomsItemId: string): Promise<CustomsItem>;
}

export type { CustomsItem };
4 changes: 3 additions & 1 deletion types/Embeddable/EmbeddablesSession.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export declare interface IEmbeddablesSession {
expires_at: string;
}

export declare class EmbeddablesSession implements IEmbeddablesSession {
declare class EmbeddablesSession implements IEmbeddablesSession {
public constructor(input: IEmbeddablesSessionCreateParameters);

object: 'EmbeddablesSession';
Expand All @@ -36,3 +36,5 @@ export declare class EmbeddablesSession implements IEmbeddablesSession {
*/
static createSession(params: Object): Promise<EmbeddablesSession>;
}

export type { EmbeddablesSession };
4 changes: 3 additions & 1 deletion types/EndShipper/EndShipper.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export declare interface IEndshipper extends IObjectWithId<'EndShipper'> {
email?: string | null;
}

export declare class EndShipper implements IEndshipper {
declare class EndShipper implements IEndshipper {
public constructor(input: DeepPartial<IEndShipperCreateParameters>);
id: string;
mode: 'test' | 'production';
Expand Down Expand Up @@ -128,3 +128,5 @@ export declare class EndShipper implements IEndshipper {
params: IEndShipperListParameters,
): Promise<{ endshippers: EndShipper[]; has_more: boolean }>;
}

export type { EndShipper };
4 changes: 3 additions & 1 deletion types/Event/Event.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export declare interface IEvent extends IObjectWithId<'Event'>, IDatedObject {
completed_urls: string[];
}

export declare class Event implements IEvent {
declare class Event implements IEvent {
id: string;
mode: 'test' | 'production';
object: 'Event';
Expand Down Expand Up @@ -90,3 +90,5 @@ export declare class Event implements IEvent {
pageSize?: number,
): Promise<{ events: Event[]; has_more: boolean }>;
}

export type { Event };
4 changes: 3 additions & 1 deletion types/Event/Payload/Payload.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export declare interface IPayload extends IObjectWithId<'Payload'>, IDatedObject
response_body: string | null;
}

export declare class Payload implements IPayload {
declare class Payload implements IPayload {
id: string;
mode: 'test' | 'production';
object: 'Payload';
Expand Down Expand Up @@ -43,3 +43,5 @@ export declare class Payload implements IPayload {
*/
static all(params: IPayloadListParameters): Promise<{ payloads: Payload[] }>;
}

export type { Payload };
4 changes: 3 additions & 1 deletion types/Fee/Fee.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,12 @@ export declare interface IFee extends IBaseObject<'Fee'> {
refunded: boolean;
}

export declare class Fee implements IFee {
declare class Fee implements IFee {
object: 'Fee';
type: TFeeType;
amount: string;
charged: boolean;
refunded: boolean;
}

export type { Fee };
4 changes: 3 additions & 1 deletion types/Insurance/Insurance.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ export declare interface IInsurance extends IObjectWithId<'Insurance'>, IDatedOb
messages: string[];
}

export declare class Insurance implements IInsurance {
declare class Insurance implements IInsurance {
public constructor(input: IInsuranceCreateParameters);

id: string;
Expand Down Expand Up @@ -172,3 +172,5 @@ export declare class Insurance implements IInsurance {
*/
static refund(insuranceId: string): Promise<Insurance>;
}

export type { Insurance };
4 changes: 3 additions & 1 deletion types/Luma/Luma.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export declare interface ILumaPromise {
*
* @see https://docs.easypost.com/docs/luma
*/
export declare class Luma {
declare class Luma {
/**
* Get service recommendations from Luma that meet the criteria of your ruleset.
*
Expand All @@ -45,3 +45,5 @@ export declare class Luma {
*/
static getPromise(params: object): Promise<ILumaPromise>;
}

export type { Luma };
4 changes: 3 additions & 1 deletion types/Order/Order.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ export declare interface IOrder extends IObjectWithId<'Order'>, IDatedObject {
is_return?: boolean | null;
}

export declare class Order implements IOrder {
declare class Order implements IOrder {
public constructor(input: IOrderCreateParameters);

id: string;
Expand Down Expand Up @@ -133,3 +133,5 @@ export declare class Order implements IOrder {
*/
lowestRate(carriers?: string[], services?: string[]): IRate;
}

export type { Order };
4 changes: 3 additions & 1 deletion types/Parcel/Parcel.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export declare interface IParcel extends IObjectWithId<'Parcel'>, IDatedObject {
predefined_package?: string | null;
}

export declare class Parcel implements IParcel {
declare class Parcel implements IParcel {
public constructor(input: DeepPartial<IParcelCreateParameters>);

id: string;
Expand Down Expand Up @@ -80,3 +80,5 @@ export declare class Parcel implements IParcel {
*/
static retrieve(parcelId: string): Promise<Parcel>;
}

export type { Parcel };
4 changes: 3 additions & 1 deletion types/PaymentMethod/PaymentMethod.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export declare interface IPaymentMethod extends IObjectWithId<'PaymentMethod'> {
verified: boolean;
}

export declare class PaymentMethod implements IPaymentMethod {
declare class PaymentMethod implements IPaymentMethod {
id: string;
mode: 'test' | 'production';
object: 'PaymentMethod';
Expand All @@ -64,3 +64,5 @@ export declare class PaymentMethod implements IPaymentMethod {
name: string;
verified: boolean;
}

export type { PaymentMethod };
4 changes: 3 additions & 1 deletion types/Pickup/Pickup.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ export declare interface IPickup extends IObjectWithId<'Pickup'>, IDatedObject {
pickup_rates: IPickupRate[];
}

export declare class Pickup implements IPickup {
declare class Pickup implements IPickup {
public constructor(input: IPickupCreateParameters);

id: string;
Expand Down Expand Up @@ -197,3 +197,5 @@ export declare class Pickup implements IPickup {
*/
lowestRate(carriers?: string[], services?: string[]): IRate;
}

export type { Pickup };
4 changes: 3 additions & 1 deletion types/Rate/Rate.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ export declare interface IRate extends IObjectWithId<'Rate'>, IDatedObject {
billing_type: string;
}

export declare class Rate implements IRate {
declare class Rate implements IRate {
billing_type: string;
carrier: string;
carrier_account_id: string;
Expand All @@ -91,3 +91,5 @@ export declare class Rate implements IRate {
shipment_id: string;
updated_at: string;
}

export type { Rate };
4 changes: 3 additions & 1 deletion types/Referral/Referral.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export declare interface IReferral extends IUser {
api_keys?: IApiKey[];
}

export declare class Referral implements IReferral {
declare class Referral implements IReferral {
public constructor(input: IReferralCreateParameters);

id: string;
Expand Down Expand Up @@ -122,3 +122,5 @@ export declare class Referral implements IReferral {
pageSize?: number,
): Promise<{ referral_customers: Referral[]; has_more: boolean }>;
}

export type { Referral };
4 changes: 3 additions & 1 deletion types/Refund/Refund.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export declare interface IRefund extends IObjectWithId<'Refund'>, IDatedObject {
shipment_id: string;
}

export declare class Refund implements IRefund {
declare class Refund implements IRefund {
public constructor(input: IRefundCreateParameters);

id: string;
Expand Down Expand Up @@ -98,3 +98,5 @@ export declare class Refund implements IRefund {
pageSize?: number,
): Promise<{ refunds: Refund[]; has_more: boolean }>;
}

export type { Refund };
Loading