Client

Lomadee class, SdkParams, and shared configuration types

The root export of @thelomadee/sdk. Instantiate Lomadee once per server process (or scoped factory) and access resource clients through its properties.

import { Lomadee } from '@thelomadee/sdk';
import type { SdkParams, Environment, SdkResponse } from '@thelomadee/sdk';

const sdk = new Lomadee({
  authKey: process.env.LOMADEE_AUTH_KEY!,
  environment: 'production',
});

Domain data types (CreateOrderBody, CommissionData, TermData, enums, etc.) are imported from @thelomadee/sdk/domains, not from the root package.

Constructor

new Lomadee(config: SdkParams): Lomadee

Creates a client that shares one authenticated HTTP session (10 second timeout) across all resource properties. Authentication uses the partner authKey as the x-auth-key header on every request.

SdkParams

authKey · string · required

Partner credential provided during onboarding. Required.

environment · Environment

Target deployment. Union: 'staging' | 'production'. Optional; defaults to 'production' when omitted.

Properties

Property	Type	Reference
transactions	Transaction	Transactions
commissions	Commission	Commissions
affiliates	Affiliate	Affiliates
contents	Content	Contents
terms	Term	Terms

terms.acceptances

Nested on terms, type TermAcceptance. Exposes create and list for term acceptance records. See Terms — acceptances.

Resource return types are defined per client. For example, transactions methods return Promise<unknown>; commissions.list returns CommissionListResponse; affiliates.list returns AffiliateListResponse; other methods may use SdkResponse<T> or concrete domain types. See each resource reference page.

Root exports

Export	Kind	Description
Lomadee	class	Root client
SdkParams	type	Constructor configuration
Environment	type	'staging' | 'production'
SdkResponse<T>	type	Response envelope { data: T } used by some clients

Advanced resource implementation classes are available through dedicated subpaths. Prefer the root client; use these imports only when you intentionally construct a resource class outside Lomadee:

Root property	Advanced import	Class
transactions	@thelomadee/sdk/domains/orders	Transaction
commissions	@thelomadee/sdk/domains/commissions	Commission
affiliates	@thelomadee/sdk/domains/affiliates	Affiliate
contents	@thelomadee/sdk/domains/contents	Content
terms	@thelomadee/sdk/domains/terms	Term, TermAcceptance

The recommended entry point remains new Lomadee(...) on @thelomadee/sdk.

Example

import { Lomadee } from '@thelomadee/sdk';

const sdk = new Lomadee({
  authKey: process.env.LOMADEE_AUTH_KEY!,
});

const term = await sdk.terms.latest();
console.log(term.version);

Related

• Quickstart
• Environments and secrets
• How the SDK works