migma 1.6.0 → 1.8.0

package/dist/index.d.mts

@@ -492,6 +492,8 @@ interface ListProjectsParams {
     limit?: number;
     offset?: number;
     status?: string;
+    /** Scope the list to one workspace (see workspaces.list()). */
+    organizationId?: string;
 }
 interface ListProjectsResponse {
     projects: Project[];
@@ -553,6 +555,40 @@ interface FieldCatalogResponse {
     totalSubscribers: number;
     computedAt: string;
 }
+interface BrandImageStyle {
+    styleNotes?: string;
+    avoid?: string;
+    useBrandColors?: boolean;
+}
+/** Body for PUT /projects/:id/brand-guidelines. At least one field is required. */
+interface BrandGuidelinesParams {
+    /** Replaces the standing instructions every future email is written under. */
+    instructions?: string;
+    imageStyle?: BrandImageStyle;
+}
+interface BrandGuidelinesResponse {
+    instructions: string;
+    imageStyle: BrandImageStyle;
+    previous: {
+        instructions: string;
+    };
+    changed: boolean;
+}
+interface DesignReferenceItem {
+    id: string;
+    title: string;
+    content?: string;
+    date?: string;
+    previewHtml?: string;
+    thumbnailUrl?: string;
+    screenshotUrl?: string;
+    referenceOrigin?: string;
+    [key: string]: unknown;
+}
+interface ProjectReferencesResponse {
+    references: DesignReferenceItem[];
+    total: number;
+}
 
 interface PollingOptions {
     /** Polling interval in ms. Default: 2000 */
@@ -578,6 +614,10 @@ declare class Projects {
     get(projectId: string): Promise<MigmaResult<Project>>;
     import(params: ImportProjectParams): Promise<MigmaResult<ImportProjectResponse>>;
     getImportStatus(projectId: string): Promise<MigmaResult<ImportStatusResponse>>;
+    /** Replace the brand's standing design rules and/or image style notes. */
+    updateBrandGuidelines(projectId: string, params: BrandGuidelinesParams): Promise<MigmaResult<BrandGuidelinesResponse>>;
+    /** Design references generation reads: favorites, saved designs, saved sections. */
+    references(projectId: string): Promise<MigmaResult<ProjectReferencesResponse>>;
     retryImport(projectId: string): Promise<MigmaResult<RetryImportResponse>>;
     fieldCatalog(projectId: string, params?: FieldCatalogParams): Promise<MigmaResult<FieldCatalogResponse>>;
     /**
@@ -815,6 +855,12 @@ interface EmailLogsResponse {
     nextCursor: string | null;
     hasMore: boolean;
 }
+interface EmailFavorite {
+    emailId: string;
+    favorite: boolean;
+    conversationId: string;
+    slotUuid: string | null;
+}
 
 declare class Emails {
     private readonly client;
@@ -849,6 +895,8 @@ declare class Emails {
      * series. Events arrive asynchronously; opens are directional while clicks
      * and delivery events are stronger signals.
      */
+    /** Star or unstar one generated email as a design reference. Idempotent. */
+    setFavorite(emailId: string, favorite: boolean): Promise<MigmaResult<EmailFavorite>>;
     metrics(emailId: string): Promise<MigmaResult<EmailMetrics>>;
     /** Per-recipient send log for one generated email (cursor-paginated). */
     logs(emailId: string, params?: EmailLogsParams): Promise<MigmaResult<EmailLogsResponse>>;
@@ -1159,6 +1207,10 @@ interface DomainVerificationResult {
 }
 interface DomainAvailability {
     available: boolean;
+    prefix: string;
+    fullDomain: string;
+    /** Present only when unavailable: taken, reserved, or the format rule it breaks. */
+    reason?: string;
     [key: string]: unknown;
 }
 interface CreateManagedDomainParams {
@@ -1449,11 +1501,17 @@ declare class Webhooks {
     getStats(): Promise<MigmaResult<Record<string, unknown>>>;
 }
 
+/** What makes a knowledge-base entry a design reference rather than a plain brand fact. */
+type ReferenceOrigin = 'favorite' | 'upload' | 'manual';
 interface KnowledgeBaseEntry {
     id: string;
     title: string;
     content: string;
     date: string;
+    previewHtml?: string;
+    thumbnailUrl?: string;
+    screenshotUrl?: string;
+    referenceOrigin?: ReferenceOrigin;
 }
 interface KnowledgeBaseListResponse {
     entries: KnowledgeBaseEntry[];
@@ -1462,6 +1520,11 @@ interface KnowledgeBaseListResponse {
 interface AddKnowledgeBaseParams {
     title: string;
     content: string;
+    /** Set to mark the entry as a design reference generation should match. */
+    referenceOrigin?: ReferenceOrigin;
+    previewHtml?: string;
+    thumbnailUrl?: string;
+    screenshotUrl?: string;
 }
 interface UpdateKnowledgeBaseParams {
     title?: string;
@@ -1693,6 +1756,34 @@ declare class Metrics {
     sending(params?: SendingMetricsParams): Promise<MigmaResult<SendingMetrics>>;
 }
 
+interface Workspace {
+    id: string;
+    name: string;
+    type: string;
+    /** The caller's role in this workspace (owner, admin, member, …). */
+    role: string;
+    /** True for the caller's personal workspace. */
+    personal: boolean;
+    /** Brands in this workspace the caller can access — id + name only. */
+    projects: Array<{
+        id: string;
+        name: string;
+    }>;
+}
+interface ListWorkspacesResponse {
+    workspaces: Workspace[];
+}
+
+declare class Workspaces {
+    private readonly client;
+    constructor(client: MigmaClient);
+    /**
+     * Workspaces the API key owner belongs to. Pass a workspace id as
+     * `organizationId` to projects.list() to scope brands to it.
+     */
+    list(): Promise<MigmaResult<ListWorkspacesResponse>>;
+}
+
 interface MigmaConfig {
     /** API base URL. Default: 'https://api.migma.ai/v1' */
     baseUrl?: string;
@@ -1721,7 +1812,8 @@ declare class Migma {
     readonly images: Images;
     readonly campaigns: Campaigns;
     readonly metrics: Metrics;
+    readonly workspaces: Workspaces;
     constructor(apiKey: string, config?: MigmaConfig);
 }
 
-export { type AddCustomDnsRecordParams, type AddImageParams, type AddKnowledgeBaseParams, type AnalyzeDeliverabilityParams, type AnalyzeLinksParams, type ApiResponse, type BatchDeleteContactsParams, type BatchDeleteResponse, type BatchStatus, type BulkImportAsyncResponse, type BulkImportContactItem, type BulkImportJobStatus, type BulkImportParams, type BulkImportResponse, type BulkImportSyncResponse, type Campaign, type CampaignLog, type CampaignLogsParams, type CampaignLogsResponse, type CampaignStats, type CampaignStatus, type ChangeStatusParams, type CheckCompatibilityParams, type CheckSpellingParams, type CheckedLink, type ClientConfig, type CompatibilityResponse, type Contact, type ContactStatus, type CreateCampaignParams, type CreateContactParams, type CreateDomainParams, type CreateManagedDomainParams, type CreatePreviewParams, type CreatePreviewResponse, type CreateSegmentParams, type CreateTagParams, type CreateTopicParams, type CreateWebhookParams, type CreateWebhookResponse, type CreditStatus, type CustomDnsRecord, type CustomDnsRecordList, type CustomDnsRecordType, type DeleteResponse, type DeliverabilityResponse, type DeviceCategoriesResponse, type DnsRecord, type Domain, type DomainAvailability, type DomainDeleteResponse, type DomainPurchaseCheckout, type DomainPurchaseParams, type DomainPurchaseQuote, type DomainPurchaseSearchParams, type DomainRegistration, type DomainRegistrationStatus, type DomainStream, type DomainVerificationResult, type EditEmailParams, type Email, type EmailGenerationResult, type EmailGenerationStatus, type EmailImage, type EmailLogsParams, type EmailLogsResponse, type EmailMetrics, type EmailMetricsCountry, type EmailMetricsSummary, type EmailMetricsTimePoint, type EmailSendLog, type ExportFile, type ExportFormat, type ExportFormatsResponse, type ExportResult, type ExportStatusResponse, type FieldCatalogEntry, type FieldCatalogEntryType, type FieldCatalogParams, type FieldCatalogResponse, type GenerateEmailParams, type GenerateEmailResponse, type GeneratedEmail, type GetDevicePreviewResponse, type GetPreviewResponse, type GetPreviewStatusResponse, type GetSupportedDevicesResponse, type HubspotExportParams, type ImportHtmlEmailFile, type ImportHtmlEmailParams, type ImportProjectParams, type ImportProjectResponse, type ImportStatusResponse, type KnowledgeBaseEntry, type KnowledgeBaseListResponse, type LinkAnalysisResponse, type ListCampaignsParams, type ListCampaignsResponse, type ListContactsParams, type ListContactsResponse, type ListEmailsEmail, type ListEmailsParams, type ListEmailsResponse, type ListProjectsParams, type ListProjectsResponse, type ListSegmentsResponse, type ListTagsParams, type ListTagsResponse, type ListTopicsParams, type ListTopicsResponse, type ListWebhooksResponse, type LogosResponse, type MessageResponse, Migma, MigmaClient, type MigmaConfig, MigmaError, MigmaErrorCode, type MigmaResult, type PollingOptions, type PreviewDevice, type PreviewDeviceCategory, type PreviewDeviceStatus, type PreviewMetadata, type PreviewStatus, type Project, type ProjectImage, type ProviderType, type ProvisionStreamParams, type RecipientType, type RetryImportResponse, type ScheduleCampaignParams, type Segment, type SegmentActivityFilter, type SegmentFieldFilter, type SegmentFilters, type SendEmailParams, type SendEmailResponse, type SendTestEmailParams, type SendTestEmailResponse, type SendingMetrics, type SendingMetricsCounts, type SendingMetricsHistoryEntry, type SendingMetricsParams, type SendingMetricsToday, type SetupDomainParams, type SetupDomainResponse, type SpellingResponse, type SupportedDevice, type Tag, type Topic, type TopicSubscriptionParams, type TopicSubscriptionResponse, type UpdateContactParams, type UpdateDomainParams, type UpdateImageParams, type UpdateKnowledgeBaseParams, type UpdateLogosParams, type UpdateSegmentParams, type UpdateTagParams, type UpdateTopicParams, type UpdateWebhookParams, type UpgradeLink, type UpgradeLinkParams, type UpgradePlan, type ValidateAllParams, type ValidateAllResponse, type Webhook, type WebhookDeliveriesResponse, type WebhookDelivery, type WebhookDetail, type WebhookEvent, type WebhookEventType, type WebhookEventsResponse, type WebhookTestResult, poll };
+export { type AddCustomDnsRecordParams, type AddImageParams, type AddKnowledgeBaseParams, type AnalyzeDeliverabilityParams, type AnalyzeLinksParams, type ApiResponse, type BatchDeleteContactsParams, type BatchDeleteResponse, type BatchStatus, type BrandGuidelinesParams, type BrandGuidelinesResponse, type BrandImageStyle, type BulkImportAsyncResponse, type BulkImportContactItem, type BulkImportJobStatus, type BulkImportParams, type BulkImportResponse, type BulkImportSyncResponse, type Campaign, type CampaignLog, type CampaignLogsParams, type CampaignLogsResponse, type CampaignStats, type CampaignStatus, type ChangeStatusParams, type CheckCompatibilityParams, type CheckSpellingParams, type CheckedLink, type ClientConfig, type CompatibilityResponse, type Contact, type ContactStatus, type CreateCampaignParams, type CreateContactParams, type CreateDomainParams, type CreateManagedDomainParams, type CreatePreviewParams, type CreatePreviewResponse, type CreateSegmentParams, type CreateTagParams, type CreateTopicParams, type CreateWebhookParams, type CreateWebhookResponse, type CreditStatus, type CustomDnsRecord, type CustomDnsRecordList, type CustomDnsRecordType, type DeleteResponse, type DeliverabilityResponse, type DesignReferenceItem, type DeviceCategoriesResponse, type DnsRecord, type Domain, type DomainAvailability, type DomainDeleteResponse, type DomainPurchaseCheckout, type DomainPurchaseParams, type DomainPurchaseQuote, type DomainPurchaseSearchParams, type DomainRegistration, type DomainRegistrationStatus, type DomainStream, type DomainVerificationResult, type EditEmailParams, type Email, type EmailFavorite, type EmailGenerationResult, type EmailGenerationStatus, type EmailImage, type EmailLogsParams, type EmailLogsResponse, type EmailMetrics, type EmailMetricsCountry, type EmailMetricsSummary, type EmailMetricsTimePoint, type EmailSendLog, type ExportFile, type ExportFormat, type ExportFormatsResponse, type ExportResult, type ExportStatusResponse, type FieldCatalogEntry, type FieldCatalogEntryType, type FieldCatalogParams, type FieldCatalogResponse, type GenerateEmailParams, type GenerateEmailResponse, type GeneratedEmail, type GetDevicePreviewResponse, type GetPreviewResponse, type GetPreviewStatusResponse, type GetSupportedDevicesResponse, type HubspotExportParams, type ImportHtmlEmailFile, type ImportHtmlEmailParams, type ImportProjectParams, type ImportProjectResponse, type ImportStatusResponse, type KnowledgeBaseEntry, type KnowledgeBaseListResponse, type LinkAnalysisResponse, type ListCampaignsParams, type ListCampaignsResponse, type ListContactsParams, type ListContactsResponse, type ListEmailsEmail, type ListEmailsParams, type ListEmailsResponse, type ListProjectsParams, type ListProjectsResponse, type ListSegmentsResponse, type ListTagsParams, type ListTagsResponse, type ListTopicsParams, type ListTopicsResponse, type ListWebhooksResponse, type ListWorkspacesResponse, type LogosResponse, type MessageResponse, Migma, MigmaClient, type MigmaConfig, MigmaError, MigmaErrorCode, type MigmaResult, type PollingOptions, type PreviewDevice, type PreviewDeviceCategory, type PreviewDeviceStatus, type PreviewMetadata, type PreviewStatus, type Project, type ProjectImage, type ProjectReferencesResponse, type ProviderType, type ProvisionStreamParams, type RecipientType, type ReferenceOrigin, type RetryImportResponse, type ScheduleCampaignParams, type Segment, type SegmentActivityFilter, type SegmentFieldFilter, type SegmentFilters, type SendEmailParams, type SendEmailResponse, type SendTestEmailParams, type SendTestEmailResponse, type SendingMetrics, type SendingMetricsCounts, type SendingMetricsHistoryEntry, type SendingMetricsParams, type SendingMetricsToday, type SetupDomainParams, type SetupDomainResponse, type SpellingResponse, type SupportedDevice, type Tag, type Topic, type TopicSubscriptionParams, type TopicSubscriptionResponse, type UpdateContactParams, type UpdateDomainParams, type UpdateImageParams, type UpdateKnowledgeBaseParams, type UpdateLogosParams, type UpdateSegmentParams, type UpdateTagParams, type UpdateTopicParams, type UpdateWebhookParams, type UpgradeLink, type UpgradeLinkParams, type UpgradePlan, type ValidateAllParams, type ValidateAllResponse, type Webhook, type WebhookDeliveriesResponse, type WebhookDelivery, type WebhookDetail, type WebhookEvent, type WebhookEventType, type WebhookEventsResponse, type WebhookTestResult, type Workspace, poll };

package/dist/index.d.ts

@@ -492,6 +492,8 @@ interface ListProjectsParams {
     limit?: number;
     offset?: number;
     status?: string;
+    /** Scope the list to one workspace (see workspaces.list()). */
+    organizationId?: string;
 }
 interface ListProjectsResponse {
     projects: Project[];
@@ -553,6 +555,40 @@ interface FieldCatalogResponse {
     totalSubscribers: number;
     computedAt: string;
 }
+interface BrandImageStyle {
+    styleNotes?: string;
+    avoid?: string;
+    useBrandColors?: boolean;
+}
+/** Body for PUT /projects/:id/brand-guidelines. At least one field is required. */
+interface BrandGuidelinesParams {
+    /** Replaces the standing instructions every future email is written under. */
+    instructions?: string;
+    imageStyle?: BrandImageStyle;
+}
+interface BrandGuidelinesResponse {
+    instructions: string;
+    imageStyle: BrandImageStyle;
+    previous: {
+        instructions: string;
+    };
+    changed: boolean;
+}
+interface DesignReferenceItem {
+    id: string;
+    title: string;
+    content?: string;
+    date?: string;
+    previewHtml?: string;
+    thumbnailUrl?: string;
+    screenshotUrl?: string;
+    referenceOrigin?: string;
+    [key: string]: unknown;
+}
+interface ProjectReferencesResponse {
+    references: DesignReferenceItem[];
+    total: number;
+}
 
 interface PollingOptions {
     /** Polling interval in ms. Default: 2000 */
@@ -578,6 +614,10 @@ declare class Projects {
     get(projectId: string): Promise<MigmaResult<Project>>;
     import(params: ImportProjectParams): Promise<MigmaResult<ImportProjectResponse>>;
     getImportStatus(projectId: string): Promise<MigmaResult<ImportStatusResponse>>;
+    /** Replace the brand's standing design rules and/or image style notes. */
+    updateBrandGuidelines(projectId: string, params: BrandGuidelinesParams): Promise<MigmaResult<BrandGuidelinesResponse>>;
+    /** Design references generation reads: favorites, saved designs, saved sections. */
+    references(projectId: string): Promise<MigmaResult<ProjectReferencesResponse>>;
     retryImport(projectId: string): Promise<MigmaResult<RetryImportResponse>>;
     fieldCatalog(projectId: string, params?: FieldCatalogParams): Promise<MigmaResult<FieldCatalogResponse>>;
     /**
@@ -815,6 +855,12 @@ interface EmailLogsResponse {
     nextCursor: string | null;
     hasMore: boolean;
 }
+interface EmailFavorite {
+    emailId: string;
+    favorite: boolean;
+    conversationId: string;
+    slotUuid: string | null;
+}
 
 declare class Emails {
     private readonly client;
@@ -849,6 +895,8 @@ declare class Emails {
      * series. Events arrive asynchronously; opens are directional while clicks
      * and delivery events are stronger signals.
      */
+    /** Star or unstar one generated email as a design reference. Idempotent. */
+    setFavorite(emailId: string, favorite: boolean): Promise<MigmaResult<EmailFavorite>>;
     metrics(emailId: string): Promise<MigmaResult<EmailMetrics>>;
     /** Per-recipient send log for one generated email (cursor-paginated). */
     logs(emailId: string, params?: EmailLogsParams): Promise<MigmaResult<EmailLogsResponse>>;
@@ -1159,6 +1207,10 @@ interface DomainVerificationResult {
 }
 interface DomainAvailability {
     available: boolean;
+    prefix: string;
+    fullDomain: string;
+    /** Present only when unavailable: taken, reserved, or the format rule it breaks. */
+    reason?: string;
     [key: string]: unknown;
 }
 interface CreateManagedDomainParams {
@@ -1449,11 +1501,17 @@ declare class Webhooks {
     getStats(): Promise<MigmaResult<Record<string, unknown>>>;
 }
 
+/** What makes a knowledge-base entry a design reference rather than a plain brand fact. */
+type ReferenceOrigin = 'favorite' | 'upload' | 'manual';
 interface KnowledgeBaseEntry {
     id: string;
     title: string;
     content: string;
     date: string;
+    previewHtml?: string;
+    thumbnailUrl?: string;
+    screenshotUrl?: string;
+    referenceOrigin?: ReferenceOrigin;
 }
 interface KnowledgeBaseListResponse {
     entries: KnowledgeBaseEntry[];
@@ -1462,6 +1520,11 @@ interface KnowledgeBaseListResponse {
 interface AddKnowledgeBaseParams {
     title: string;
     content: string;
+    /** Set to mark the entry as a design reference generation should match. */
+    referenceOrigin?: ReferenceOrigin;
+    previewHtml?: string;
+    thumbnailUrl?: string;
+    screenshotUrl?: string;
 }
 interface UpdateKnowledgeBaseParams {
     title?: string;
@@ -1693,6 +1756,34 @@ declare class Metrics {
     sending(params?: SendingMetricsParams): Promise<MigmaResult<SendingMetrics>>;
 }
 
+interface Workspace {
+    id: string;
+    name: string;
+    type: string;
+    /** The caller's role in this workspace (owner, admin, member, …). */
+    role: string;
+    /** True for the caller's personal workspace. */
+    personal: boolean;
+    /** Brands in this workspace the caller can access — id + name only. */
+    projects: Array<{
+        id: string;
+        name: string;
+    }>;
+}
+interface ListWorkspacesResponse {
+    workspaces: Workspace[];
+}
+
+declare class Workspaces {
+    private readonly client;
+    constructor(client: MigmaClient);
+    /**
+     * Workspaces the API key owner belongs to. Pass a workspace id as
+     * `organizationId` to projects.list() to scope brands to it.
+     */
+    list(): Promise<MigmaResult<ListWorkspacesResponse>>;
+}
+
 interface MigmaConfig {
     /** API base URL. Default: 'https://api.migma.ai/v1' */
     baseUrl?: string;
@@ -1721,7 +1812,8 @@ declare class Migma {
     readonly images: Images;
     readonly campaigns: Campaigns;
     readonly metrics: Metrics;
+    readonly workspaces: Workspaces;
     constructor(apiKey: string, config?: MigmaConfig);
 }
 
-export { type AddCustomDnsRecordParams, type AddImageParams, type AddKnowledgeBaseParams, type AnalyzeDeliverabilityParams, type AnalyzeLinksParams, type ApiResponse, type BatchDeleteContactsParams, type BatchDeleteResponse, type BatchStatus, type BulkImportAsyncResponse, type BulkImportContactItem, type BulkImportJobStatus, type BulkImportParams, type BulkImportResponse, type BulkImportSyncResponse, type Campaign, type CampaignLog, type CampaignLogsParams, type CampaignLogsResponse, type CampaignStats, type CampaignStatus, type ChangeStatusParams, type CheckCompatibilityParams, type CheckSpellingParams, type CheckedLink, type ClientConfig, type CompatibilityResponse, type Contact, type ContactStatus, type CreateCampaignParams, type CreateContactParams, type CreateDomainParams, type CreateManagedDomainParams, type CreatePreviewParams, type CreatePreviewResponse, type CreateSegmentParams, type CreateTagParams, type CreateTopicParams, type CreateWebhookParams, type CreateWebhookResponse, type CreditStatus, type CustomDnsRecord, type CustomDnsRecordList, type CustomDnsRecordType, type DeleteResponse, type DeliverabilityResponse, type DeviceCategoriesResponse, type DnsRecord, type Domain, type DomainAvailability, type DomainDeleteResponse, type DomainPurchaseCheckout, type DomainPurchaseParams, type DomainPurchaseQuote, type DomainPurchaseSearchParams, type DomainRegistration, type DomainRegistrationStatus, type DomainStream, type DomainVerificationResult, type EditEmailParams, type Email, type EmailGenerationResult, type EmailGenerationStatus, type EmailImage, type EmailLogsParams, type EmailLogsResponse, type EmailMetrics, type EmailMetricsCountry, type EmailMetricsSummary, type EmailMetricsTimePoint, type EmailSendLog, type ExportFile, type ExportFormat, type ExportFormatsResponse, type ExportResult, type ExportStatusResponse, type FieldCatalogEntry, type FieldCatalogEntryType, type FieldCatalogParams, type FieldCatalogResponse, type GenerateEmailParams, type GenerateEmailResponse, type GeneratedEmail, type GetDevicePreviewResponse, type GetPreviewResponse, type GetPreviewStatusResponse, type GetSupportedDevicesResponse, type HubspotExportParams, type ImportHtmlEmailFile, type ImportHtmlEmailParams, type ImportProjectParams, type ImportProjectResponse, type ImportStatusResponse, type KnowledgeBaseEntry, type KnowledgeBaseListResponse, type LinkAnalysisResponse, type ListCampaignsParams, type ListCampaignsResponse, type ListContactsParams, type ListContactsResponse, type ListEmailsEmail, type ListEmailsParams, type ListEmailsResponse, type ListProjectsParams, type ListProjectsResponse, type ListSegmentsResponse, type ListTagsParams, type ListTagsResponse, type ListTopicsParams, type ListTopicsResponse, type ListWebhooksResponse, type LogosResponse, type MessageResponse, Migma, MigmaClient, type MigmaConfig, MigmaError, MigmaErrorCode, type MigmaResult, type PollingOptions, type PreviewDevice, type PreviewDeviceCategory, type PreviewDeviceStatus, type PreviewMetadata, type PreviewStatus, type Project, type ProjectImage, type ProviderType, type ProvisionStreamParams, type RecipientType, type RetryImportResponse, type ScheduleCampaignParams, type Segment, type SegmentActivityFilter, type SegmentFieldFilter, type SegmentFilters, type SendEmailParams, type SendEmailResponse, type SendTestEmailParams, type SendTestEmailResponse, type SendingMetrics, type SendingMetricsCounts, type SendingMetricsHistoryEntry, type SendingMetricsParams, type SendingMetricsToday, type SetupDomainParams, type SetupDomainResponse, type SpellingResponse, type SupportedDevice, type Tag, type Topic, type TopicSubscriptionParams, type TopicSubscriptionResponse, type UpdateContactParams, type UpdateDomainParams, type UpdateImageParams, type UpdateKnowledgeBaseParams, type UpdateLogosParams, type UpdateSegmentParams, type UpdateTagParams, type UpdateTopicParams, type UpdateWebhookParams, type UpgradeLink, type UpgradeLinkParams, type UpgradePlan, type ValidateAllParams, type ValidateAllResponse, type Webhook, type WebhookDeliveriesResponse, type WebhookDelivery, type WebhookDetail, type WebhookEvent, type WebhookEventType, type WebhookEventsResponse, type WebhookTestResult, poll };
+export { type AddCustomDnsRecordParams, type AddImageParams, type AddKnowledgeBaseParams, type AnalyzeDeliverabilityParams, type AnalyzeLinksParams, type ApiResponse, type BatchDeleteContactsParams, type BatchDeleteResponse, type BatchStatus, type BrandGuidelinesParams, type BrandGuidelinesResponse, type BrandImageStyle, type BulkImportAsyncResponse, type BulkImportContactItem, type BulkImportJobStatus, type BulkImportParams, type BulkImportResponse, type BulkImportSyncResponse, type Campaign, type CampaignLog, type CampaignLogsParams, type CampaignLogsResponse, type CampaignStats, type CampaignStatus, type ChangeStatusParams, type CheckCompatibilityParams, type CheckSpellingParams, type CheckedLink, type ClientConfig, type CompatibilityResponse, type Contact, type ContactStatus, type CreateCampaignParams, type CreateContactParams, type CreateDomainParams, type CreateManagedDomainParams, type CreatePreviewParams, type CreatePreviewResponse, type CreateSegmentParams, type CreateTagParams, type CreateTopicParams, type CreateWebhookParams, type CreateWebhookResponse, type CreditStatus, type CustomDnsRecord, type CustomDnsRecordList, type CustomDnsRecordType, type DeleteResponse, type DeliverabilityResponse, type DesignReferenceItem, type DeviceCategoriesResponse, type DnsRecord, type Domain, type DomainAvailability, type DomainDeleteResponse, type DomainPurchaseCheckout, type DomainPurchaseParams, type DomainPurchaseQuote, type DomainPurchaseSearchParams, type DomainRegistration, type DomainRegistrationStatus, type DomainStream, type DomainVerificationResult, type EditEmailParams, type Email, type EmailFavorite, type EmailGenerationResult, type EmailGenerationStatus, type EmailImage, type EmailLogsParams, type EmailLogsResponse, type EmailMetrics, type EmailMetricsCountry, type EmailMetricsSummary, type EmailMetricsTimePoint, type EmailSendLog, type ExportFile, type ExportFormat, type ExportFormatsResponse, type ExportResult, type ExportStatusResponse, type FieldCatalogEntry, type FieldCatalogEntryType, type FieldCatalogParams, type FieldCatalogResponse, type GenerateEmailParams, type GenerateEmailResponse, type GeneratedEmail, type GetDevicePreviewResponse, type GetPreviewResponse, type GetPreviewStatusResponse, type GetSupportedDevicesResponse, type HubspotExportParams, type ImportHtmlEmailFile, type ImportHtmlEmailParams, type ImportProjectParams, type ImportProjectResponse, type ImportStatusResponse, type KnowledgeBaseEntry, type KnowledgeBaseListResponse, type LinkAnalysisResponse, type ListCampaignsParams, type ListCampaignsResponse, type ListContactsParams, type ListContactsResponse, type ListEmailsEmail, type ListEmailsParams, type ListEmailsResponse, type ListProjectsParams, type ListProjectsResponse, type ListSegmentsResponse, type ListTagsParams, type ListTagsResponse, type ListTopicsParams, type ListTopicsResponse, type ListWebhooksResponse, type ListWorkspacesResponse, type LogosResponse, type MessageResponse, Migma, MigmaClient, type MigmaConfig, MigmaError, MigmaErrorCode, type MigmaResult, type PollingOptions, type PreviewDevice, type PreviewDeviceCategory, type PreviewDeviceStatus, type PreviewMetadata, type PreviewStatus, type Project, type ProjectImage, type ProjectReferencesResponse, type ProviderType, type ProvisionStreamParams, type RecipientType, type ReferenceOrigin, type RetryImportResponse, type ScheduleCampaignParams, type Segment, type SegmentActivityFilter, type SegmentFieldFilter, type SegmentFilters, type SendEmailParams, type SendEmailResponse, type SendTestEmailParams, type SendTestEmailResponse, type SendingMetrics, type SendingMetricsCounts, type SendingMetricsHistoryEntry, type SendingMetricsParams, type SendingMetricsToday, type SetupDomainParams, type SetupDomainResponse, type SpellingResponse, type SupportedDevice, type Tag, type Topic, type TopicSubscriptionParams, type TopicSubscriptionResponse, type UpdateContactParams, type UpdateDomainParams, type UpdateImageParams, type UpdateKnowledgeBaseParams, type UpdateLogosParams, type UpdateSegmentParams, type UpdateTagParams, type UpdateTopicParams, type UpdateWebhookParams, type UpgradeLink, type UpgradeLinkParams, type UpgradePlan, type ValidateAllParams, type ValidateAllResponse, type Webhook, type WebhookDeliveriesResponse, type WebhookDelivery, type WebhookDetail, type WebhookEvent, type WebhookEventType, type WebhookEventsResponse, type WebhookTestResult, type Workspace, poll };

package/dist/index.js

@@ -411,7 +411,8 @@ var Projects = class {
     return this.client.get("/projects", {
       limit: params?.limit,
       offset: params?.offset,
-      status: params?.status
+      status: params?.status,
+      organizationId: params?.organizationId
     });
   }
   async get(projectId) {
@@ -428,6 +429,17 @@ var Projects = class {
       `/projects/import/${projectId}/status`
     );
   }
+  /** Replace the brand's standing design rules and/or image style notes. */
+  async updateBrandGuidelines(projectId, params) {
+    return this.client.put(
+      `/projects/${projectId}/brand-guidelines`,
+      params
+    );
+  }
+  /** Design references generation reads: favorites, saved designs, saved sections. */
+  async references(projectId) {
+    return this.client.get(`/projects/${projectId}/references`);
+  }
   async retryImport(projectId) {
     return this.client.post(
       `/projects/import/${projectId}/retry`
@@ -554,6 +566,10 @@ var Emails = class {
    * series. Events arrive asynchronously; opens are directional while clicks
    * and delivery events are stronger signals.
    */
+  /** Star or unstar one generated email as a design reference. Idempotent. */
+  async setFavorite(emailId, favorite) {
+    return this.client.put(`/emails/${emailId}/favorite`, { favorite });
+  }
   async metrics(emailId) {
     return this.client.get(`/emails/${emailId}/metrics`);
   }
@@ -975,6 +991,20 @@ var Metrics = class {
   }
 };
 
+// src/resources/workspaces.ts
+var Workspaces = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Workspaces the API key owner belongs to. Pass a workspace id as
+   * `organizationId` to projects.list() to scope brands to it.
+   */
+  async list() {
+    return this.client.get("/workspaces");
+  }
+};
+
 // src/migma.ts
 var Migma = class {
   client;
@@ -996,6 +1026,7 @@ var Migma = class {
   images;
   campaigns;
   metrics;
+  workspaces;
   constructor(apiKey, config) {
     if (!apiKey) {
       throw new Error(
@@ -1025,6 +1056,7 @@ var Migma = class {
     this.images = new Images(this.client);
     this.campaigns = new Campaigns(this.client);
     this.metrics = new Metrics(this.client);
+    this.workspaces = new Workspaces(this.client);
   }
 };