@stackshift-cloud/sdk 1.4.0 → 1.4.1

package/README.md

@@ -34,6 +34,24 @@ Set your API key:
 STACKSHIFT_API_KEY=sk_live_xxx
 ```
 
+## Partner platforms
+
+Staff-enabled partner accounts buy domains for merchants from their StackShift wallet; StackShift registers the domain, sets up Mail and creates a warmed-up brand tagged with your merchant reference. Use an API token with the `partner:manage` scope (and `mail:manage` to run campaigns) on your server:
+
+```ts
+const domain = await stackshift.partner.purchaseDomain({
+  domain: 'merchantshop.com',
+  years: 1,
+  merchantRef: 'm_123',
+  registrant: { first_name: 'Ada', last_name: 'Obi', email: 'ada@merchantshop.com', phone: '+2348012345678', address: '1 Marina', city: 'Lagos', state: 'Lagos', postal_code: '101001', country: 'NG' },
+  brand: { name: 'Merchant Shop', postalAddress: '1 Marina, Lagos, Nigeria' },
+  replies: { mode: 'forward', forwardTo: 'ada@gmail.com' },
+}, { idempotencyKey: 'order-m_123-1' })
+const status = await stackshift.partner.getDomain(domain.id)
+```
+
+`partner` also exposes `overview`, `updateSettings`, `listDomains` (with `q` and `attention` to find the merchants that need you), `retryDomain`, `getDiagnosis`, `restoreDns`, `transferOut`, `resumeBrand`, `getComplaints`, `listComplaintSources`, `suppressNeverOpened`, `undoSuppression`, `usage`, `listRequests` and `createRequest`. `transferOut` needs the `partner:transfer` scope (or `*`); `partner:manage` alone is refused. Purchases are capped at 30 per minute and, per partner, at 25 domains in a rolling 24 hours (429 `daily_purchase_limit`; staff can raise it). Validation errors are 400, state conflicts are 409. Subscribe to the `partner.*` event types with `mail.webhooks.create` and send campaigns through the brand in `domain.brandId`.
+
 ## AI credits
 
 AI credits are account-scoped. Inspect the balance and usage, create a top-up checkout, or choose managed billing versus your own provider key:

package/dist/asset-media-v2.d.ts

@@ -2,7 +2,8 @@ export type AssetMediaKind = 'image' | 'video';
 export type AssetTransformOutputKind = 'image' | 'video' | 'audio' | 'thumbnail';
 export type AssetAnimationPolicy = 'first' | 'preserve' | 'reject';
 export interface AssetTransformOperation {
-    type: 'crop' | 'resize' | 'rotate' | 'blur' | 'radius' | 'dpr' | 'background' | 'overlay' | 'trim' | 'fps' | 'timestamp';
+    type: 'crop' | 'resize' | 'rotate' | 'blur' | 'radius' | 'dpr' | 'background' | 'overlay' | 'trim' | 'fps' | 'timestamp' | 'remove_background' | 'smart_crop';
+    focus?: 'attention' | 'entropy';
     mode?: 'explicit' | 'fit' | 'fill' | 'pad';
     gravity?: 'northwest' | 'north' | 'northeast' | 'west' | 'centre' | 'east' | 'southwest' | 'south' | 'southeast';
     width?: number;
@@ -39,6 +40,19 @@ export type AssetTransformMaterializeInput = {
     preset: string;
     definition?: never;
 };
+export interface AssetTransformEstimateInput {
+    version_id: string;
+    definition: AssetTransformDefinition;
+}
+export interface AssetTransformEstimate {
+    cost_micros: number;
+    currency: string;
+    steps: Array<{
+        index: number;
+        type: AssetTransformOperation['type'];
+        cost_micros: number;
+    }>;
+}
 export interface AssetDerivedAsset {
     id: string;
     asset_id: string;

package/dist/assets-dam-types.d.ts

@@ -257,3 +257,38 @@ export interface AssetRenderingInfo {
     sets: AssetRenderSet[];
     deliveries: Record<string, AssetPublicationDelivery>;
 }
+export interface AssetReferrerUsage {
+    window_days: number;
+    referrers: Array<{
+        host: string;
+        requests: number;
+    }>;
+}
+export interface AssetHoldDetail {
+    kind: 'scan' | 'content' | 'policy';
+    finding: string;
+    explanation: string;
+    explained_by: 'stackie' | 'scan_result' | 'content_check';
+    version_id: string;
+    upload: {
+        window_minutes: number;
+        files: number;
+        held: Array<{
+            id: string;
+            name: string;
+        }>;
+    };
+    same_content: number;
+}
+export interface AssetReuploadRequestInput {
+    email?: string;
+    message?: string;
+}
+export interface AssetReuploadRequest {
+    id: string;
+    email: string;
+    status: 'sent' | 'completed' | 'expired' | 'revoked';
+    expires_at: string;
+    created_at: string;
+    completed_at?: string;
+}

package/dist/assets.d.ts

@@ -2,8 +2,9 @@ import { AssetDAMClient } from './assets-dam.js';
 import { AssetVideoClient } from './assets-video.js';
 import type { StackShift } from './client.js';
 import { AssetConnectionsClient, AssetMigrationsClient, AssetStorageClient, AssetTextClient, AssetUploadCapabilitiesClient } from './assets-platform.js';
+import type { AssetHoldDetail, AssetReferrerUsage, AssetReuploadRequest, AssetReuploadRequestInput } from './assets-dam-types.js';
 import { AssetWorkflowsClient } from './asset-workflows.js';
-import type { AssetDerivedAsset, AssetImageGenerationInput, AssetTransformDefinition, AssetTransformMaterializeInput } from './asset-media-v2.js';
+import type { AssetDerivedAsset, AssetImageGenerationInput, AssetTransformDefinition, AssetTransformEstimate, AssetTransformEstimateInput, AssetTransformMaterializeInput } from './asset-media-v2.js';
 import type { Asset, AssetBucket, AssetBucketInput, AssetAIAccountConfig, AssetPatchInput, AssetAIAnnotation, AssetManualDescriptionInput, AssetCustomDomain, AssetEvent, AssetJob, AssetJobSubmission, AssetLifecycleRule, AssetUsageSummary, AssetWebhook, AssetWebhookDelivery, AssetAIInfo, AssetCollection, AssetContentPolicy, AssetNamedTransformInput, AssetListOptions, AssetListResult, AssetSavedSearch, AssetTranscript, AssetUploadProgressCallbacks, AssetVersion, AssetSignedUploadUrl, AssetSignedUploadUrlOptions, AssetSignedTransformOptions, AssetSignedUrl, AssetSignedUrlOptions, AssetTransformOptions, AssetTransformPreset, AssetUploadOptions } from './types.js';
 export declare const assetTransformPresets: AssetTransformPreset[];
 export declare function getAssetTransformPreset(name: string): AssetTransformPreset | undefined;
@@ -66,6 +67,12 @@ export declare class AssetsClient {
     requestTranscript(assetId: string, idempotencyKey?: string): Promise<AssetJobSubmission>;
     requestSmartCrop(assetId: string, idempotencyKey?: string): Promise<AssetJobSubmission>;
     requestBackgroundRemoval(assetId: string, idempotencyKey?: string): Promise<AssetJobSubmission>;
+    usage(assetId: string): Promise<AssetReferrerUsage>;
+    hold(assetId: string): Promise<AssetHoldDetail>;
+    createReuploadRequest(assetId: string, input?: AssetReuploadRequestInput): Promise<AssetReuploadRequest>;
+    reuploadRequests(assetId: string): Promise<{
+        requests: AssetReuploadRequest[];
+    }>;
     versions(assetId: string): Promise<{
         versions: AssetVersion[];
     }>;
@@ -110,6 +117,7 @@ export declare class AssetsClient {
     updatePolicy(policy: AssetContentPolicy): Promise<AssetContentPolicy>;
     createTransformation(input: AssetNamedTransformInput): Promise<unknown>;
     createTransformationV2(name: string, definition: AssetTransformDefinition, eager?: boolean): Promise<unknown>;
+    estimateTransform(assetId: string, input: AssetTransformEstimateInput): Promise<AssetTransformEstimate>;
     materializeTransform(assetId: string, input: AssetTransformMaterializeInput, idempotencyKey?: string): Promise<AssetJobSubmission>;
     derivatives(assetId: string): Promise<{
         derivatives: AssetDerivedAsset[];

package/dist/assets.js

@@ -291,6 +291,20 @@ export class AssetsClient {
     requestBackgroundRemoval(assetId, idempotencyKey) {
         return this.requestAssetJob(`/assets/${encodeURIComponent(assetId)}/background-remove`, idempotencyKey);
     }
+    usage(assetId) {
+        return this.client.request(`/assets/${encodeURIComponent(assetId)}/usage`);
+    }
+    hold(assetId) {
+        return this.client.request(`/assets/${encodeURIComponent(assetId)}/hold`);
+    }
+    createReuploadRequest(assetId, input = {}) {
+        return this.client.request(`/assets/${encodeURIComponent(assetId)}/reupload-requests`, {
+            method: 'POST', body: input,
+        });
+    }
+    reuploadRequests(assetId) {
+        return this.client.request(`/assets/${encodeURIComponent(assetId)}/reupload-requests`);
+    }
     versions(assetId) {
         return this.client.request(`/assets/${encodeURIComponent(assetId)}/versions`);
     }
@@ -350,6 +364,11 @@ export class AssetsClient {
             method: 'POST', body: { name, definition, eager },
         });
     }
+    estimateTransform(assetId, input) {
+        return this.client.request(`/assets/${encodeURIComponent(assetId)}/transforms/estimate`, {
+            method: 'POST', body: input,
+        });
+    }
     materializeTransform(assetId, input, idempotencyKey) {
         return this.client.request(`/assets/${encodeURIComponent(assetId)}/transforms`, {
             method: 'POST', body: input,

package/dist/client.d.ts

@@ -1,6 +1,7 @@
 import { AICreditsClient } from './ai-credits.js';
 import { AssetsClient } from './assets.js';
 import { MailClient } from './mail.js';
+import { PartnerClient } from './partner.js';
 import { ProjectsClient } from './projects.js';
 import { WorkloadSecurityClient } from './workload-security.js';
 import type { StackShiftOptions } from './types.js';
@@ -14,6 +15,7 @@ export declare class StackShift {
     readonly projects: ProjectsClient;
     readonly assets: AssetsClient;
     readonly mail: MailClient;
+    readonly partner: PartnerClient;
     readonly workloadSecurity: WorkloadSecurityClient;
     private readonly fetcher;
     constructor(options?: StackShiftOptions);

package/dist/client.js

@@ -1,6 +1,7 @@
 import { AICreditsClient } from './ai-credits.js';
 import { AssetsClient } from './assets.js';
 import { MailClient } from './mail.js';
+import { PartnerClient } from './partner.js';
 import { ProjectsClient } from './projects.js';
 import { WorkloadSecurityClient } from './workload-security.js';
 const defaultBaseUrl = 'https://api.stackshift.cloud/api/v1';
@@ -16,6 +17,7 @@ export class StackShift {
     projects;
     assets;
     mail;
+    partner;
     workloadSecurity;
     fetcher;
     constructor(options = {}) {
@@ -33,6 +35,7 @@ export class StackShift {
         this.projects = new ProjectsClient(this);
         this.assets = new AssetsClient(this);
         this.mail = new MailClient(this);
+        this.partner = new PartnerClient(this);
         this.workloadSecurity = new WorkloadSecurityClient(this);
     }
     async request(path, init = {}) {

package/dist/index.d.ts

@@ -16,7 +16,7 @@ export type { ArtDirectionSource, ResponsiveImageDescriptor, ResponsiveImageOpti
 export { assetContractOperations } from './generated/assets-contract.js';
 export type { AssetAPIScope, AssetContractOperation, AssetOperationId } from './generated/assets-contract.js';
 export { MailBouncesClient, MailClient, MailDomainsClient, MailEventsClient, MailLimitsClient, MailMessagesClient, MailScheduledClient, MailBatchClient, MailInboundClient, MailAnalyticsClient, MailOtpChallengesClient, MailOtpClient, MailReputationClient, MailReputationEventsClient, MailSuppressionsClient, MailTemplatesClient, MailWebhooksClient, MailStreamsClient, MailAudiencesClient, MailCampaignsClient, } from './mail.js';
-export type { MailAudience, MailAudienceMember, MailAudienceMemberImport, MailCampaign } from './mail-campaigns.js';
+export type { MailAudience, MailAudienceMember, MailAudienceMemberImport, MailBrandFilterOptions, MailCampaign } from './mail-campaigns.js';
 export { MailExportsClient } from './mail-exports.js';
 export type { MailExport, MailExportCreateInput } from './mail-exports.js';
 export { MailboxAliasesClient, MailboxDomainsClient, MailboxGroupsClient, MailboxImportsClient, MailboxRoutesClient, MailboxesClient } from './mail-mailboxes.js';
@@ -29,7 +29,7 @@ export type { Asset, AssetAIAnnotation, AssetAIInfo, AssetManualDescriptionInput
 export type { MailBounce, MailBounceListOptions, MailBounceListResult, MailBounceType, MailSuppression, MailSuppressionCreateInput, MailSuppressionListOptions, MailSuppressionListResult, MailSuppressionReason, MailSuppressionSource, } from './mail-delivery-types.js';
 export type { MailOtpChallenge, MailOtpChallengeListOptions, MailOtpChallengeListResult, MailOtpSendInput, MailOtpSendResponse, MailOtpStatus, MailOtpVerifyInput, MailOtpVerifyResponse, } from './mail-otp-types.js';
 export type { MailSendTemplateInput, MailSendTemplateResponse, MailTemplate, MailTemplateCreateInput, MailTemplateDetail, MailTemplateListOptions, MailTemplateListResult, MailTemplatePreview, MailTemplatePreviewInput, MailTemplateStatus, MailTemplateTestSendInput, MailTemplateTestSendResponse, MailTemplateUpdateInput, MailTemplateVersion, } from './mail-template-types.js';
-export type { MailEvent, MailEventListOptions, MailEventListResult, MailEventType, MailTimelineItem, MailWebhook, MailWebhookCreateInput, MailWebhookCreateResponse, MailWebhookDelivery, MailWebhookDeliveryAttempt, MailWebhookDeliveryDetail, MailWebhookDeliveryListOptions, MailWebhookListOptions, MailWebhookListResult, MailWebhookUpdateInput, MailWebhookReplay, MailWebhookReplayInput, } from './mail-webhook-types.js';
+export type { MailEvent, MailEventListOptions, MailEventListResult, MailEventType, MailTimelineItem, MailWebhook, MailWebhookCreateInput, MailWebhookCreateResponse, MailWebhookDelivery, MailWebhookDeliveryAttempt, MailWebhookDeliveryDetail, MailWebhookDeliveryListItem, MailWebhookDeliveryListOptions, MailWebhookDeliveryMerchant, MailWebhookDetail, MailWebhookDiagnosis, MailWebhookDiagnosisResult, MailWebhookListOptions, MailWebhookListResult, MailWebhookUpdateInput, MailWebhookReplay, MailWebhookReplayInput, MailWebhookWaitingHighlight, MailWebhookWaitingSummary, } from './mail-webhook-types.js';
 export type { MailMessageStream, MailMessageStreamCreateInput, MailMessageStreamListResult } from './mail-streams.js';
 export type { MailDomainReputation, MailLimits, MailManualReviewStatus, MailReputation, MailReputationEvent, MailReputationEventListOptions, MailReputationEventListResult, MailReputationEventSeverity, MailReputationStatus, MailReputationTier, MailReputationWorkspace, } from './mail-reputation-types.js';
 export type { MailAnalytics, MailAnalyticsRateCohort, MailAnalyticsInput, MailAttachmentInput, MailBatch, MailBatchItem, MailBatchSendInput, MailBatchTemplateInput, MailInboundDomain, MailInboundMessage, MailScheduledCreateInput, MailScheduledMessage, } from './mail-advanced-types.js';
@@ -45,6 +45,8 @@ export * from './mail-brands.js';
 export * from './mail-billing.js';
 export * from './mail-migration.js';
 export * from './mail-marketing.js';
+export { PartnerClient } from './partner.js';
+export type * from './partner.js';
 export { AICreditsClient } from './ai-credits.js';
 export type * from './ai-credits.js';
 export * from './support-action-types.js';

package/dist/index.js

@@ -19,6 +19,7 @@ export * from './mail-brands.js';
 export * from './mail-billing.js';
 export * from './mail-migration.js';
 export * from './mail-marketing.js';
+export { PartnerClient } from './partner.js';
 export { AICreditsClient } from './ai-credits.js';
 export * from './support-action-types.js';
 export * from './support-actions.js';

package/dist/mail-billing.d.ts

@@ -26,6 +26,17 @@ export interface MailBillingSummary {
         revision: number;
     };
 }
+export interface MailBillingPeriodUsage {
+    period: string;
+    planSlug?: string;
+    currency: 'NGN';
+    periodStart: string;
+    periodEnd: string;
+    monthlyPriceKobo: number;
+    included: number;
+    used: number;
+    spentKobo: number;
+}
 export interface MailCampaignEstimate extends MailBillingSummary {
     recipientCount: number;
     requiredCreditKobo: number;
@@ -35,4 +46,5 @@ export declare class MailBillingClient {
     private readonly client;
     constructor(client: StackShift);
     summary(): Promise<MailBillingSummary>;
+    periodUsage(period: string): Promise<MailBillingPeriodUsage>;
 }

package/dist/mail-billing.js

@@ -4,4 +4,7 @@ export class MailBillingClient {
         this.client = client;
     }
     summary() { return this.client.mailRequest('/mail/billing'); }
+    periodUsage(period) {
+        return this.client.mailRequest(`/mail/billing?period=${encodeURIComponent(period)}`);
+    }
 }

package/dist/mail-brands.d.ts

@@ -10,22 +10,35 @@ export interface MailBrandFields {
     website?: string;
     supportEmail?: string;
     editableFields?: string[];
+    merchantRef?: string;
 }
 export interface MailBrand extends MailBrandFields {
     id: string;
     workspaceId: string;
     mode: MailMode;
     status: 'active' | 'archived';
+    sendingPausedAt: string | null;
+    sendingPauseReason: string;
+    suspendedAt: string | null;
     revision: number;
     createdAt: string;
     updatedAt: string;
 }
+export interface MailBrandWarmup {
+    day: number;
+    totalDays: number;
+    marketingUnlocked: boolean;
+    status: 'new' | 'warming' | 'trusted';
+}
+export interface MailBrandListItem extends MailBrand {
+    warmup: MailBrandWarmup | null;
+}
 export declare class MailBrandsClient {
     private readonly client;
     constructor(client: StackShift);
     create(input: MailBrandFields): Promise<MailBrand>;
     list(): Promise<{
-        data: MailBrand[];
+        data: MailBrandListItem[];
     }>;
     get(id: string): Promise<MailBrand>;
     update(id: string, input: MailBrandFields & {

package/dist/mail-campaigns.d.ts

@@ -40,6 +40,9 @@ export interface MailAudienceMemberImport {
     consentIp?: string;
     attributes?: Record<string, string>;
 }
+export interface MailBrandFilterOptions {
+    brandId?: string;
+}
 export interface MailCampaignContent {
     subject: string;
     previewText?: string;
@@ -95,7 +98,7 @@ export declare class MailAudiencesClient {
         name: string;
         description?: string;
     }): Promise<MailAudience>;
-    list(): Promise<{
+    list(options?: MailBrandFilterOptions): Promise<{
         data: MailAudience[];
     }>;
     get(id: string): Promise<MailAudience>;
@@ -116,7 +119,7 @@ export declare class MailCampaignsClient {
     private readonly client;
     constructor(client: StackShift);
     create(input: MailCampaignInput): Promise<MailCampaign>;
-    list(): Promise<{
+    list(options?: MailBrandFilterOptions): Promise<{
         data: MailCampaign[];
     }>;
     get(id: string): Promise<MailCampaign>;

package/dist/mail-campaigns.js

@@ -6,8 +6,9 @@ export class MailAudiencesClient {
     create(input) {
         return this.client.mailRequest('/mail/audiences', { method: 'POST', body: input });
     }
-    list() {
-        return this.client.mailRequest('/mail/audiences');
+    list(options = {}) {
+        const query = options.brandId ? `?brandId=${encodeURIComponent(options.brandId)}` : '';
+        return this.client.mailRequest(`/mail/audiences${query}`);
     }
     get(id) {
         return this.client.mailRequest(`/mail/audiences/${encodeURIComponent(id)}`);
@@ -39,8 +40,9 @@ export class MailCampaignsClient {
     create(input) {
         return this.client.mailRequest('/mail/campaigns', { method: 'POST', body: input });
     }
-    list() {
-        return this.client.mailRequest('/mail/campaigns');
+    list(options = {}) {
+        const query = options.brandId ? `?brandId=${encodeURIComponent(options.brandId)}` : '';
+        return this.client.mailRequest(`/mail/campaigns${query}`);
     }
     get(id) {
         return this.client.mailRequest(`/mail/campaigns/${encodeURIComponent(id)}`);

package/dist/mail-delivery-types.d.ts

@@ -14,6 +14,7 @@ export interface MailSuppression {
 export interface MailSuppressionListOptions {
     email?: string;
     reason?: MailSuppressionReason;
+    brandId?: string;
     limit?: number;
     cursor?: string;
 }

package/dist/mail-events-webhooks.d.ts

@@ -1,5 +1,5 @@
 import type { StackShift } from './client.js';
-import type { MailEvent, MailEventListOptions, MailEventListResult, MailTimelineItem, MailWebhook, MailWebhookCreateInput, MailWebhookCreateResponse, MailWebhookDelivery, MailWebhookDeliveryDetail, MailWebhookDeliveryListOptions, MailWebhookListOptions, MailWebhookListResult, MailWebhookReplay, MailWebhookReplayInput, MailWebhookUpdateInput } from './mail-webhook-types.js';
+import type { MailEvent, MailEventListOptions, MailEventListResult, MailTimelineItem, MailWebhook, MailWebhookCreateInput, MailWebhookCreateResponse, MailWebhookDelivery, MailWebhookDeliveryDetail, MailWebhookDeliveryListItem, MailWebhookDeliveryListOptions, MailWebhookDetail, MailWebhookDiagnosisResult, MailWebhookListOptions, MailWebhookListResult, MailWebhookReplay, MailWebhookReplayInput, MailWebhookUpdateInput } from './mail-webhook-types.js';
 export declare class MailEventsClient {
     private readonly client;
     constructor(client: StackShift);
@@ -11,14 +11,19 @@ export declare class MailWebhooksClient {
     constructor(client: StackShift);
     create(input: MailWebhookCreateInput): Promise<MailWebhookCreateResponse>;
     list(options?: MailWebhookListOptions): Promise<MailWebhookListResult>;
-    get(webhookId: string): Promise<MailWebhook>;
+    get(webhookId: string): Promise<MailWebhookDetail>;
     update(webhookId: string, input: MailWebhookUpdateInput): Promise<MailWebhook>;
     rotateSecret(webhookId: string): Promise<{
         secret: string;
     }>;
+    revealSecret(webhookId: string): Promise<{
+        secret: string;
+    }>;
+    diagnosis(webhookId: string): Promise<MailWebhookDiagnosisResult>;
+    diagnose(webhookId: string): Promise<MailWebhookDiagnosisResult>;
     delete(webhookId: string): Promise<void>;
     deliveries(webhookId: string, options?: MailWebhookDeliveryListOptions): Promise<{
-        data: MailWebhookDelivery[];
+        data: MailWebhookDeliveryListItem[];
         nextCursor?: string | null;
     }>;
     getDelivery(deliveryId: string): Promise<MailWebhookDeliveryDetail>;

package/dist/mail-events-webhooks.js

@@ -39,6 +39,19 @@ export class MailWebhooksClient {
             method: 'POST',
         });
     }
+    revealSecret(webhookId) {
+        return this.client.mailRequest(`/mail/webhooks/${encodeURIComponent(webhookId)}/reveal-secret`, {
+            method: 'POST',
+        });
+    }
+    diagnosis(webhookId) {
+        return this.client.mailRequest(`/mail/webhooks/${encodeURIComponent(webhookId)}/diagnosis`);
+    }
+    diagnose(webhookId) {
+        return this.client.mailRequest(`/mail/webhooks/${encodeURIComponent(webhookId)}/diagnosis`, {
+            method: 'POST',
+        });
+    }
     delete(webhookId) {
         return this.client.mailRequest(`/mail/webhooks/${encodeURIComponent(webhookId)}`, {
             method: 'DELETE',

package/dist/mail-webhook-types.d.ts

@@ -1,6 +1,14 @@
 import type { MailMode } from './mail-simulation.js';
 import type { JsonValue } from './types.js';
-export type MailEventType = 'mail.message.opened' | 'mail.message.clicked' | 'mail.message.accepted' | 'mail.message.queued' | 'mail.message.sending' | 'mail.message.mta_accepted' | 'mail.delivery.delayed' | 'mail.delivery.delivered' | 'mail.message.failed' | 'mail.message.bounced' | 'mail.message.suppressed' | 'mail.message.complained' | 'mail.suppression.created' | 'mail.suppression.deleted' | 'mail.otp.created' | 'mail.otp.sent' | 'mail.otp.verified' | 'mail.otp.failed_attempt' | 'mail.otp.failed' | 'mail.otp.expired' | 'mail.otp.canceled' | 'mail.template.created' | 'mail.template.updated' | 'mail.template.deleted' | 'mail.template.version.created' | 'mail.template.test_queued' | 'mail.domain.created' | 'mail.domain.verified' | 'mail.domain.failed' | 'mail.domain.deleted' | 'mail.webhook.created' | 'mail.webhook.updated' | 'mail.webhook.disabled' | 'mail.webhook.delivery.succeeded' | 'mail.webhook.delivery.failed' | 'mail.audience.created' | 'mail.audience.members.imported' | 'mail.campaign.created' | 'mail.campaign.queued';
+export type MailEventType = 'mail.message.opened' | 'mail.message.clicked' | 'mail.message.accepted' | 'mail.message.queued' | 'mail.message.sending' | 'mail.message.mta_accepted' | 'mail.delivery.delayed' | 'mail.delivery.delivered' | 'mail.message.failed' | 'mail.message.bounced' | 'mail.message.suppressed' | 'mail.message.complained' | 'mail.suppression.created' | 'mail.suppression.deleted' | 'mail.otp.created' | 'mail.otp.sent' | 'mail.otp.verified' | 'mail.otp.failed_attempt' | 'mail.otp.failed' | 'mail.otp.expired' | 'mail.otp.canceled' | 'mail.template.created' | 'mail.template.updated' | 'mail.template.deleted' | 'mail.template.version.created' | 'mail.template.test_queued' | 'mail.domain.created' | 'mail.domain.verified' | 'mail.domain.failed' | 'mail.domain.deleted' | 'mail.webhook.created' | 'mail.webhook.updated' | 'mail.webhook.disabled' | 'mail.webhook.delivery.succeeded' | 'mail.webhook.delivery.failed' | 'mail.audience.created' | 'mail.audience.members.imported' | 'mail.campaign.created' | 'mail.campaign.queued' | 'mail.campaign.stopped' | 'partner.domain.registered' | 'partner.domain.failed' | 'partner.domain.dns_verified' | 'partner.brand.ready' | 'partner.warmup.progress' | 'partner.brand.warning' | 'partner.brand.paused' | 'partner.brand.resumed' | 'partner.brand.bounced' | 'partner.brand.complained' | 'partner.domain.renewal_due' | 'partner.domain.renewed' | 'partner.domain.renewal_failed';
+export interface MailCampaignStoppedEvent {
+    campaignId: string;
+    brandId: string;
+    reason: 'sender_paused';
+    pauseReason: 'complaint_rate' | 'bounce_rate' | 'partner_suspended' | string;
+    pausedSince: string;
+    message: string;
+}
 export interface MailEvent {
     mode?: MailMode;
     id: string;
@@ -43,6 +51,20 @@ export interface MailWebhook {
     lastFailureAt?: string | null;
     createdAt: string;
 }
+export interface MailWebhookWaitingHighlight {
+    type: string;
+    shop: string;
+}
+export interface MailWebhookWaitingSummary {
+    count: number;
+    capped: boolean;
+    oldestAt: string;
+    merchantUpdates: number;
+    highlights: MailWebhookWaitingHighlight[];
+}
+export interface MailWebhookDetail extends MailWebhook {
+    waitingSummary: MailWebhookWaitingSummary | null;
+}
 export interface MailWebhookCreateInput {
     url: string;
     description?: string;
@@ -80,6 +102,23 @@ export interface MailWebhookDelivery {
     createdAt: string;
     completedAt?: string | null;
 }
+export interface MailWebhookDeliveryMerchant {
+    partnerDomainId: string;
+    merchantRef: string;
+    shop: string;
+}
+export interface MailWebhookDeliveryListItem extends MailWebhookDelivery {
+    durationMs: number | null;
+    merchant: MailWebhookDeliveryMerchant | null;
+}
+export interface MailWebhookDiagnosis {
+    checkedAt: string;
+    repliesRead: number;
+    summary: string;
+}
+export interface MailWebhookDiagnosisResult {
+    diagnosis: MailWebhookDiagnosis | null;
+}
 export interface MailWebhookDeliveryAttempt {
     id: string;
     attemptNumber: number;

package/dist/mail.js

@@ -262,6 +262,7 @@ export class MailSuppressionsClient {
         const query = new URLSearchParams();
         append(query, 'email', options.email);
         append(query, 'reason', options.reason);
+        append(query, 'brandId', options.brandId);
         append(query, 'limit', options.limit);
         append(query, 'cursor', options.cursor);
         const suffix = query.toString();

package/dist/partner.d.ts

@@ -0,0 +1,369 @@
+import type { StackShift } from './client.js';
+import type { MailBrand } from './mail-brands.js';
+import type { JsonValue } from './types.js';
+export type PartnerDomainState = 'registering' | 'mail_setup' | 'verifying' | 'replies' | 'brand_setup' | 'ready' | 'failed';
+export type PartnerRepliesMode = 'forward' | 'mailbox';
+export interface PartnerAccount {
+    userId: string;
+    name: string;
+    status: 'active' | 'suspended' | string;
+    complaintPauseRate: number;
+    bouncePauseRate: number;
+    dedicatedPoolName: string | null;
+    dailyPurchaseLimit: number;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface PartnerWalletBalance {
+    currency: string;
+    balance_minor: number;
+    held_minor: number;
+    disputed_minor: number;
+    available_minor: number;
+}
+export interface PartnerLimits {
+    maxComplaintPauseRate: number;
+    maxBouncePauseRate: number;
+    minimumRecipients: number;
+    windowDays: number;
+    shortWindowHours: number;
+    dailyPurchaseLimit: number;
+    warningFraction: number;
+    merchantSharePercent: number;
+    merchantCount: number;
+    dailySendingLimit: number;
+    hourlySendingLimit: number;
+}
+export interface PartnerOverview {
+    account: PartnerAccount;
+    wallet: PartnerWalletBalance[];
+    webhookEvents: string[];
+    limits: PartnerLimits;
+}
+export interface PartnerSettingsInput {
+    complaintPauseRate: number;
+    bouncePauseRate: number;
+}
+export interface PartnerRegistrant {
+    first_name: string;
+    last_name: string;
+    organization?: string;
+    email: string;
+    phone: string;
+    address: string;
+    city: string;
+    state: string;
+    postal_code: string;
+    country: string;
+}
+export interface PartnerBrandInput {
+    name: string;
+    fromLocalPart?: string;
+    postalAddress: string;
+    website?: string;
+    supportEmail?: string;
+}
+export interface PartnerRepliesInput {
+    mode: PartnerRepliesMode;
+    forwardTo?: string;
+    mailboxOwnerEmail?: string;
+    mailboxPlan?: string;
+}
+export interface PartnerDomainPurchaseInput {
+    domain: string;
+    years: number;
+    currency?: 'NGN' | 'USD';
+    merchantRef: string;
+    registrant: PartnerRegistrant;
+    brand: PartnerBrandInput;
+    replies: PartnerRepliesInput;
+}
+export interface PartnerPurchaseOptions {
+    idempotencyKey: string;
+}
+export type PartnerFailureCode = 'nameservers_changed' | 'dns_not_visible' | 'wallet_short' | 'registry_taken' | 'registration_rejected' | 'registration_timed_out' | 'purchase_interrupted' | 'mailbox_unavailable' | 'mail_setup_rejected' | 'dns_provider_error' | 'registration_mismatch' | 'sending_domains_missing' | 'internal_retrying';
+export interface PartnerFailureFact {
+    label: string;
+    value: string;
+    tone: 'bad' | 'ok' | 'neutral';
+    at: string | null;
+}
+export type PartnerFailureFix = {
+    label: string;
+    action: 'restore_nameservers';
+} | {
+    label: string;
+    href: string;
+};
+export interface PartnerFailure {
+    code: PartnerFailureCode;
+    title: string;
+    headline: string;
+    explanation: string;
+    since: string | null;
+    facts: PartnerFailureFact[];
+    data: Record<string, JsonValue>;
+    fix: PartnerFailureFix | null;
+    canRetry: boolean;
+}
+export interface PartnerDiagnosis {
+    checkedAt: string;
+    summary: string;
+}
+export interface PartnerPause {
+    reason: 'complaint_rate' | 'bounce_rate';
+    rate: number;
+    limit: number;
+    window: 'last_7_days' | 'last_24_hours';
+    campaignId: string | null;
+    campaignName: string | null;
+    listId: string | null;
+    listName: string | null;
+    listImportedAt: string | null;
+    listShare: number | null;
+    recoversAt: string | null;
+}
+export interface PartnerWaitingFor {
+    kind: 'wallet';
+    currency: string;
+    requiredMinor: number;
+    availableMinor: number;
+}
+export interface PartnerRefund {
+    amountMinor: number;
+    currency: string;
+    at: string;
+}
+export interface PartnerMerchantDomain {
+    id: string;
+    partnerUserId: string;
+    merchantRef: string;
+    domain: string;
+    years: number;
+    domainOrderId: string | null;
+    registeredDomainId: string | null;
+    mailDomainId: string | null;
+    brandId: string | null;
+    mailboxDomainId: string | null;
+    mailboxId: string | null;
+    brand: PartnerBrandInput;
+    registrant: PartnerRegistrant;
+    replies: PartnerRepliesInput;
+    state: PartnerDomainState;
+    failedState: PartnerDomainState | null;
+    lastError: string;
+    attempts: number;
+    nextAttemptAt: string;
+    lastAttemptAt: string | null;
+    waitingFor: PartnerWaitingFor | null;
+    warmupDay: number;
+    healthWarnedAt: string | null;
+    transferredOutAt: string | null;
+    amountMinor: number;
+    currency: string;
+    walletReference: string;
+    createdAt: string;
+    updatedAt: string;
+    expiryDate: string | null;
+    brandPausedAt: string | null;
+    brandPauseReason: 'complaint_rate' | 'bounce_rate' | '';
+    pause: PartnerPause | null;
+    failure: PartnerFailure | null;
+    diagnosis: PartnerDiagnosis | null;
+}
+export interface PartnerDomainListOptions {
+    merchantRef?: string;
+    q?: string;
+    attention?: boolean;
+    limit?: number;
+    offset?: number;
+}
+export interface PartnerWarmupSummary {
+    status: string;
+    day: number;
+    totalDays: number;
+    marketingUnlocked: boolean;
+    marketingOpensInDays: number;
+}
+export interface PartnerDomainListItem extends PartnerMerchantDomain {
+    health: PartnerBrandHealth | null;
+    transactionalHealth: PartnerBrandHealth | null;
+    refunded: boolean;
+    sentByDay: number[];
+    warmup: PartnerWarmupSummary | null;
+}
+export interface PartnerDomainList {
+    domains: PartnerDomainListItem[];
+    total: number;
+    attentionTotal: number;
+}
+export interface PartnerSenders {
+    marketing: string;
+    transactional: string;
+    replyTo: string;
+}
+export interface PartnerHealthWindow {
+    attempted: number;
+    accepted: number;
+    bounced: number;
+    complained: number;
+    bounceRate: number;
+    complaintRate: number;
+}
+export interface PartnerBrandHealth extends PartnerHealthWindow {
+    last24h: PartnerHealthWindow;
+}
+export interface PartnerWarmup {
+    status: string;
+    day: number;
+    totalDays: number;
+    dailyLimit: number;
+    marketingDailyLimit: number;
+    marketingUnlocked: boolean;
+    cleanTransactionalDays: number;
+    requiredCleanDays: number;
+    firstCampaignCap: number;
+    paused: boolean;
+    marketingSentToday: number;
+    marketingOpensInDays: number;
+}
+export type PartnerRecordPurpose = 'dkim' | 'spf' | 'return_path' | 'dmarc' | 'reply_mx' | 'reply_ownership' | 'mta_sts' | 'mta_sts_policy' | 'tls_reporting';
+export interface PartnerRecord {
+    domain: string;
+    type: string;
+    name: string;
+    value: string;
+    priority: number | null;
+    verified: boolean;
+    purpose: PartnerRecordPurpose;
+}
+export interface PartnerDomainView extends PartnerMerchantDomain {
+    senders: PartnerSenders;
+    brandStatus: MailBrand | null;
+    health: PartnerBrandHealth | null;
+    transactionalHealth: PartnerBrandHealth | null;
+    warmup: PartnerWarmup | null;
+    replies: PartnerRepliesInput & {
+        mailboxOwnerName: string | null;
+    };
+    records: PartnerRecord[];
+    refunded: boolean;
+    refund: PartnerRefund | null;
+    webhookDeliveredAt: string | null;
+}
+export interface PartnerTransferOut {
+    domain: string;
+    authCode: string;
+}
+export interface PartnerUsageOptions {
+    from?: string;
+    to?: string;
+}
+export interface PartnerBrandUsage {
+    partnerDomainId: string;
+    merchantRef: string;
+    domain: string;
+    brandId: string | null;
+    brandName: string;
+    marketingRecipients: number;
+    transactionalRecipients: number;
+    domainChargesMinor: number;
+    refundedMinor: number;
+    currency: string;
+}
+export interface PartnerUsage {
+    from: string;
+    to: string;
+    brands: PartnerBrandUsage[];
+}
+export interface PartnerComplaintSummary {
+    complained: number;
+    suppressed: number;
+}
+export interface PartnerComplaintSource {
+    audienceId: string;
+    audienceName: string;
+    importedAt: string | null;
+    contacts: number;
+    neverOpened: number;
+    complained: number;
+}
+export interface PartnerBulkSuppressionInput {
+    audienceId: string;
+    reason: 'never_opened';
+}
+export interface PartnerBulkSuppression {
+    id: string;
+    audienceId: string;
+    reason: 'never_opened';
+    suppressed: number;
+}
+export type PartnerRequestKind = 'purchase_limit' | 'dedicated_addresses';
+export interface PartnerRequestInput {
+    kind: PartnerRequestKind;
+    message?: string;
+}
+export interface PartnerRequest {
+    id: string;
+    kind: PartnerRequestKind;
+    message: string;
+    status: 'open' | 'done' | 'declined';
+    resolvedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface PartnerEventBase {
+    partnerDomainId: string;
+    merchantRef: string;
+    domain: string;
+    state: PartnerDomainState;
+    brandId?: string;
+}
+export interface PartnerBrandHealthEvent extends PartnerEventBase {
+    bounceRate: number;
+    complaintRate: number;
+    recipients: number;
+    last24h: PartnerHealthWindow;
+    bounceLimit: number;
+    complaintLimit: number;
+    reason?: 'complaint_rate' | 'bounce_rate';
+}
+export interface PartnerDomainRenewedEvent extends PartnerEventBase {
+    expiryDate: string;
+    previousExpiryDate: string;
+}
+export interface PartnerDomainRenewalDueEvent extends PartnerEventBase {
+    expiryDate: string;
+    autoRenew: boolean;
+}
+export interface PartnerDomainRenewalFailedEvent extends PartnerEventBase {
+    expiryDate: string;
+    reason: string;
+    amountMinor: number;
+    currency: string;
+}
+export declare class PartnerClient {
+    private readonly client;
+    constructor(client: StackShift);
+    overview(): Promise<PartnerOverview>;
+    updateSettings(input: PartnerSettingsInput): Promise<PartnerAccount>;
+    purchaseDomain(input: PartnerDomainPurchaseInput, { idempotencyKey }: PartnerPurchaseOptions): Promise<PartnerMerchantDomain>;
+    listDomains(options?: PartnerDomainListOptions): Promise<PartnerDomainList>;
+    getDomain(id: string): Promise<PartnerDomainView>;
+    retryDomain(id: string): Promise<PartnerMerchantDomain>;
+    transferOut(id: string): Promise<PartnerTransferOut>;
+    getDiagnosis(id: string): Promise<PartnerDiagnosis>;
+    restoreDns(id: string): Promise<PartnerMerchantDomain>;
+    resumeBrand(brandId: string): Promise<MailBrand>;
+    getComplaints(brandId: string): Promise<PartnerComplaintSummary>;
+    listComplaintSources(brandId: string): Promise<PartnerComplaintSource[]>;
+    suppressNeverOpened(brandId: string, input: PartnerBulkSuppressionInput): Promise<PartnerBulkSuppression>;
+    undoSuppression(brandId: string, bulkId: string): Promise<{
+        restored: number;
+    }>;
+    usage(options?: PartnerUsageOptions): Promise<PartnerUsage>;
+    listRequests(): Promise<{
+        requests: PartnerRequest[];
+    }>;
+    createRequest(input: PartnerRequestInput): Promise<PartnerRequest>;
+}

package/dist/partner.js

@@ -0,0 +1,70 @@
+export class PartnerClient {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    overview() {
+        return this.client.request('/partner');
+    }
+    updateSettings(input) {
+        return this.client.request('/partner/settings', { method: 'PUT', body: input });
+    }
+    purchaseDomain(input, { idempotencyKey }) {
+        return this.client.request('/partner/domains', {
+            method: 'POST',
+            headers: { 'Idempotency-Key': idempotencyKey },
+            body: input,
+        });
+    }
+    listDomains(options = {}) {
+        return this.client.request(`/partner/domains${queryString(options)}`);
+    }
+    getDomain(id) {
+        return this.client.request(`/partner/domains/${encodeURIComponent(id)}`);
+    }
+    retryDomain(id) {
+        return this.client.request(`/partner/domains/${encodeURIComponent(id)}/retry`, { method: 'POST' });
+    }
+    transferOut(id) {
+        return this.client.request(`/partner/domains/${encodeURIComponent(id)}/transfer-out`, { method: 'POST' });
+    }
+    getDiagnosis(id) {
+        return this.client.request(`/partner/domains/${encodeURIComponent(id)}/diagnosis`);
+    }
+    restoreDns(id) {
+        return this.client.request(`/partner/domains/${encodeURIComponent(id)}/restore-dns`, { method: 'POST' });
+    }
+    resumeBrand(brandId) {
+        return this.client.request(`/partner/brands/${encodeURIComponent(brandId)}/resume`, { method: 'POST' });
+    }
+    getComplaints(brandId) {
+        return this.client.request(`/partner/brands/${encodeURIComponent(brandId)}/complaints`);
+    }
+    listComplaintSources(brandId) {
+        return this.client.request(`/partner/brands/${encodeURIComponent(brandId)}/complaints/sources`);
+    }
+    suppressNeverOpened(brandId, input) {
+        return this.client.request(`/partner/brands/${encodeURIComponent(brandId)}/suppressions/bulk`, { method: 'POST', body: input });
+    }
+    undoSuppression(brandId, bulkId) {
+        return this.client.request(`/partner/brands/${encodeURIComponent(brandId)}/suppressions/bulk/${encodeURIComponent(bulkId)}/undo`, { method: 'POST' });
+    }
+    usage(options = {}) {
+        return this.client.request(`/partner/usage${queryString(options)}`);
+    }
+    listRequests() {
+        return this.client.request('/partner/requests');
+    }
+    createRequest(input) {
+        return this.client.request('/partner/requests', { method: 'POST', body: input });
+    }
+}
+function queryString(options) {
+    const query = new URLSearchParams();
+    for (const [key, value] of Object.entries(options)) {
+        if (value !== undefined)
+            query.set(key, String(value));
+    }
+    const suffix = query.toString();
+    return suffix ? `?${suffix}` : '';
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackshift-cloud/sdk",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "Official JavaScript and TypeScript SDK for StackShift.",
   "type": "module",
   "main": "./dist/index.js",
@@ -17,7 +17,7 @@
   ],
   "scripts": {
     "build": "tsc -p tsconfig.json",
-    "test": "npm run build && node test/mail.test.mjs && node test/mail-simulation.test.mjs && node test/mail-platform.test.mjs && node test/mail-webhooks.test.mjs && node test/mail-advanced.test.mjs && node test/mail-tracking.test.mjs && node test/mail-subscribers.test.mjs && node test/mail-exports.test.mjs && node test/mail-mailboxes.test.mjs && node test/mail-diagnostics.test.mjs && node test/assets.test.mjs && node test/assets-platform.test.mjs && node test/assets-video.test.mjs && node test/assets-dam.test.mjs && node test/ai-credits.test.mjs && node --test test/s2-upload.test.mjs",
+    "test": "npm run build && node test/mail.test.mjs && node test/mail-simulation.test.mjs && node test/mail-platform.test.mjs && node test/mail-webhooks.test.mjs && node test/mail-advanced.test.mjs && node test/mail-tracking.test.mjs && node test/mail-subscribers.test.mjs && node test/mail-exports.test.mjs && node test/mail-mailboxes.test.mjs && node test/mail-diagnostics.test.mjs && node test/partner.test.mjs && node test/assets.test.mjs && node test/assets-platform.test.mjs && node test/assets-video.test.mjs && node test/assets-dam.test.mjs && node test/ai-credits.test.mjs && node --test test/s2-upload.test.mjs",
     "test:support-actions": "npm run build && node --test tests/support-actions.test.mjs"
   },
   "devDependencies": {