resend 4.7.0-preview-topics.2 → 4.8.0

package/dist/index.d.mts

@@ -51,10 +51,13 @@ interface CreateApiKeyResponseSuccess {
     token: string;
     id: string;
 }
-interface CreateApiKeyResponse {
-    data: CreateApiKeyResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type CreateApiKeyResponse = {
+    data: CreateApiKeyResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 interface ApiKey {
     created_at: string;
@@ -63,16 +66,22 @@ interface ApiKey {
 }
 
 type ListApiKeysResponseSuccess = Pick<ApiKey, 'name' | 'id' | 'created_at'>[];
-interface ListApiKeysResponse {
-    data: ListApiKeysResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type ListApiKeysResponse = {
+    data: ListApiKeysResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 type RemoveApiKeyResponseSuccess = {};
-interface RemoveApiKeyResponse {
-    data: RemoveApiKeyResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type RemoveApiKeyResponse = {
+    data: RemoveApiKeyResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 declare class ApiKeys {
     private readonly resend;
@@ -96,36 +105,48 @@ interface CreateAudienceRequestOptions extends PostOptions {
 interface CreateAudienceResponseSuccess extends Pick<Audience, 'name' | 'id'> {
     object: 'audience';
 }
-interface CreateAudienceResponse {
-    data: CreateAudienceResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type CreateAudienceResponse = {
+    data: CreateAudienceResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 interface GetAudienceResponseSuccess extends Pick<Audience, 'id' | 'name' | 'created_at'> {
     object: 'audience';
 }
-interface GetAudienceResponse {
-    data: GetAudienceResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type GetAudienceResponse = {
+    data: GetAudienceResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 type ListAudiencesResponseSuccess = {
     object: 'list';
     data: Audience[];
 };
-interface ListAudiencesResponse {
-    data: ListAudiencesResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type ListAudiencesResponse = {
+    data: ListAudiencesResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 interface RemoveAudiencesResponseSuccess extends Pick<Audience, 'id'> {
     object: 'audience';
     deleted: boolean;
 }
-interface RemoveAudiencesResponse {
-    data: RemoveAudiencesResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type RemoveAudiencesResponse = {
+    data: RemoveAudiencesResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 declare class Audiences {
     private readonly resend;
@@ -224,12 +245,6 @@ interface CreateEmailBaseOptions {
      * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters
      */
     to: string | string[];
-    /**
-     * The id of the topic you want to send to
-     *
-     * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters
-     */
-    topicId?: string | null;
     /**
      * Schedule email to be sent later.
      * The date should be in ISO 8601 format (e.g: 2024-08-05T11:52:01.858Z).
@@ -245,10 +260,13 @@ interface CreateEmailResponseSuccess {
     /** The ID of the newly created email. */
     id: string;
 }
-interface CreateEmailResponse {
-    data: CreateEmailResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type CreateEmailResponse = {
+    data: CreateEmailResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 interface Attachment {
     /** Content of an attached file. */
     content?: string | Buffer;
@@ -258,6 +276,11 @@ interface Attachment {
     path?: string;
     /** Optional content type for the attachment, if not set will be derived from the filename property */
     contentType?: string;
+    /**
+     * Optional content ID for the attachment, to be used as a reference in the HTML content.
+     * If set, this attachment will be sent as an inline attachment and you can reference it in the HTML content using the `cid:` prefix.
+     */
+    inlineContentId?: string;
 }
 type Tag = {
     /**
@@ -279,10 +302,13 @@ interface CreateBatchSuccessResponse {
         id: string;
     }[];
 }
-interface CreateBatchResponse {
-    data: CreateBatchSuccessResponse | null;
-    error: ErrorResponse | null;
-}
+type CreateBatchResponse = {
+    data: CreateBatchSuccessResponse;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 declare class Batch {
     private readonly resend;
@@ -349,12 +375,6 @@ interface CreateBroadcastBaseOptions {
      * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
      */
     subject: string;
-    /**
-     * The id of the topic you want to send to
-     *
-     * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
-     */
-    topicId?: string | null;
 }
 type CreateBroadcastOptions = RequireAtLeastOne<EmailRenderOptions> & CreateBroadcastBaseOptions;
 interface CreateBroadcastRequestOptions extends PostOptions {
@@ -363,10 +383,13 @@ interface CreateBroadcastResponseSuccess {
     /** The ID of the newly sent broadcasts. */
     id: string;
 }
-interface CreateBroadcastResponse {
-    data: CreateBroadcastResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type CreateBroadcastResponse = {
+    data: CreateBroadcastResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 interface Broadcast {
     id: string;
@@ -380,34 +403,42 @@ interface Broadcast {
     created_at: string;
     scheduled_at: string | null;
     sent_at: string | null;
-    topic_id?: string | null;
 }
 
 interface GetBroadcastResponseSuccess extends Broadcast {
     object: 'broadcast';
 }
-interface GetBroadcastResponse {
-    data: GetBroadcastResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type GetBroadcastResponse = {
+    data: GetBroadcastResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 type ListBroadcastsResponseSuccess = {
     object: 'list';
     data: Pick<Broadcast, 'id' | 'name' | 'audience_id' | 'status' | 'created_at' | 'scheduled_at' | 'sent_at'>[];
 };
-interface ListBroadcastsResponse {
-    data: ListBroadcastsResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type ListBroadcastsResponse = {
+    data: ListBroadcastsResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 interface RemoveBroadcastResponseSuccess extends Pick<Broadcast, 'id'> {
     object: 'broadcast';
     deleted: boolean;
 }
-interface RemoveBroadcastResponse {
-    data: RemoveBroadcastResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type RemoveBroadcastResponse = {
+    data: RemoveBroadcastResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 interface SendBroadcastBaseOptions {
     /**
@@ -426,10 +457,13 @@ interface SendBroadcastResponseSuccess {
     /** The ID of the sent broadcast. */
     id: string;
 }
-interface SendBroadcastResponse {
-    data: SendBroadcastResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type SendBroadcastResponse = {
+    data: SendBroadcastResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 interface UpdateBroadcastResponseSuccess {
     id: string;
@@ -443,12 +477,14 @@ interface UpdateBroadcastOptions {
     subject?: string;
     replyTo?: string[];
     previewText?: string;
-    topicId?: string | null;
-}
-interface UpdateBroadcastResponse {
-    data: UpdateBroadcastResponseSuccess | null;
-    error: ErrorResponse | null;
 }
+type UpdateBroadcastResponse = {
+    data: UpdateBroadcastResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 declare class Broadcasts {
     private readonly resend;
@@ -489,10 +525,13 @@ interface CreateContactRequestOptions extends PostOptions {
 interface CreateContactResponseSuccess extends Pick<Contact, 'id'> {
     object: 'contact';
 }
-interface CreateContactResponse {
-    data: CreateContactResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type CreateContactResponse = {
+    data: CreateContactResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 interface GetContactOptions {
     audienceId: string;
@@ -502,10 +541,13 @@ interface GetContactOptions {
 interface GetContactResponseSuccess extends Pick<Contact, 'id' | 'email' | 'created_at' | 'first_name' | 'last_name' | 'unsubscribed'> {
     object: 'contact';
 }
-interface GetContactResponse {
-    data: GetContactResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type GetContactResponse = {
+    data: GetContactResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 interface ListContactsOptions {
     audienceId: string;
@@ -514,10 +556,13 @@ interface ListContactsResponseSuccess {
     object: 'list';
     data: Contact[];
 }
-interface ListContactsResponse {
-    data: ListContactsResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type ListContactsResponse = {
+    data: ListContactsResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 type RemoveContactsResponseSuccess = {
     object: 'contact';
@@ -541,10 +586,13 @@ interface RemoveByOptions {
 interface RemoveContactOptions extends RemoveByOptions {
     audienceId: string;
 }
-interface RemoveContactsResponse {
-    data: RemoveContactsResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type RemoveContactsResponse = {
+    data: RemoveContactsResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 interface UpdateContactBaseOptions {
     id?: string;
@@ -559,60 +607,16 @@ interface UpdateContactOptions extends UpdateContactBaseOptions {
 type UpdateContactResponseSuccess = Pick<Contact, 'id'> & {
     object: 'contact';
 };
-interface UpdateContactResponse {
-    data: UpdateContactResponseSuccess | null;
-    error: ErrorResponse | null;
-}
-
-interface GetContactTopicsBaseOptions {
-    id?: string;
-    email?: string;
-}
-interface GetContactTopicsOptions extends GetContactTopicsBaseOptions {
-}
-interface ContactTopic {
-    id: string;
-    name: string;
-    description: string | null;
-    subscription: 'opt_in' | 'opt_out';
-}
-interface GetContactTopicsResponseSuccess {
-    email: string;
-    topics: ContactTopic[];
-}
-interface GetContactTopicsResponse {
-    data: GetContactTopicsResponseSuccess | null;
-    error: ErrorResponse | null;
-}
-
-interface UpdateContactTopicsBaseOptions {
-    id?: string;
-    email?: string;
-}
-interface UpdateContactTopicsOptions extends UpdateContactTopicsBaseOptions {
-    topics: {
-        id: string;
-        subscription: 'opt_in' | 'opt_out';
-    }[];
-}
-interface UpdateContactTopicsResponseSuccess {
-    id: string;
-}
-interface UpdateContactTopicsResponse {
-    data: UpdateContactTopicsResponseSuccess | null;
-    error: ErrorResponse | null;
-}
-
-declare class ContactTopics {
-    private readonly resend;
-    constructor(resend: Resend);
-    update(payload: UpdateContactTopicsOptions): Promise<UpdateContactTopicsResponse>;
-    get(options: GetContactTopicsOptions): Promise<GetContactTopicsResponse>;
-}
+type UpdateContactResponse = {
+    data: UpdateContactResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 declare class Contacts {
     private readonly resend;
-    readonly topics: ContactTopics;
     constructor(resend: Resend);
     create(payload: CreateContactOptions, options?: CreateContactRequestOptions): Promise<CreateContactResponse>;
     list(options: ListContactsOptions): Promise<ListContactsResponse>;
@@ -664,36 +668,48 @@ interface CreateDomainRequestOptions extends PostOptions {
 interface CreateDomainResponseSuccess extends Pick<Domain, 'name' | 'id' | 'status' | 'created_at' | 'region'> {
     records: DomainRecords[];
 }
-interface CreateDomainResponse {
-    data: CreateDomainResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type CreateDomainResponse = {
+    data: CreateDomainResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 interface GetDomainResponseSuccess extends Pick<Domain, 'id' | 'name' | 'created_at' | 'region' | 'status'> {
     object: 'domain';
     records: DomainRecords[];
 }
-interface GetDomainResponse {
-    data: GetDomainResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type GetDomainResponse = {
+    data: GetDomainResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 type ListDomainsResponseSuccess = {
     data: Domain[];
 };
-interface ListDomainsResponse {
-    data: ListDomainsResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type ListDomainsResponse = {
+    data: ListDomainsResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 type RemoveDomainsResponseSuccess = Pick<Domain, 'id'> & {
     object: 'domain';
     deleted: boolean;
 };
-interface RemoveDomainsResponse {
-    data: RemoveDomainsResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type RemoveDomainsResponse = {
+    data: RemoveDomainsResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 interface UpdateDomainsOptions {
     id: string;
@@ -704,18 +720,24 @@ interface UpdateDomainsOptions {
 type UpdateDomainsResponseSuccess = Pick<Domain, 'id'> & {
     object: 'domain';
 };
-interface UpdateDomainsResponse {
-    data: UpdateDomainsResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type UpdateDomainsResponse = {
+    data: UpdateDomainsResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 type VerifyDomainsResponseSuccess = Pick<Domain, 'id'> & {
     object: 'domain';
 };
-interface VerifyDomainsResponse {
-    data: VerifyDomainsResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type VerifyDomainsResponse = {
+    data: VerifyDomainsResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 declare class Domains {
     private readonly resend;
@@ -728,14 +750,17 @@ declare class Domains {
     verify(id: string): Promise<VerifyDomainsResponse>;
 }
 
-interface CancelEmailResponse {
-    data: CancelEmailResponseSuccess | null;
-    error: ErrorResponse | null;
-}
 interface CancelEmailResponseSuccess {
     object: 'email';
     id: string;
 }
+type CancelEmailResponse = {
+    data: CancelEmailResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 interface GetEmailResponseSuccess {
     bcc: string[] | null;
@@ -749,14 +774,16 @@ interface GetEmailResponseSuccess {
     subject: string;
     text: string | null;
     to: string[];
-    topic_id?: string | null;
     scheduled_at: string | null;
     object: 'email';
 }
-interface GetEmailResponse {
-    data: GetEmailResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type GetEmailResponse = {
+    data: GetEmailResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 interface UpdateEmailOptions {
     id: string;
@@ -766,10 +793,13 @@ interface UpdateEmailResponseSuccess {
     id: string;
     object: 'email';
 }
-interface UpdateEmailResponse {
-    data: UpdateEmailResponseSuccess | null;
-    error: ErrorResponse | null;
-}
+type UpdateEmailResponse = {
+    data: UpdateEmailResponseSuccess;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+};
 
 declare class Emails {
     private readonly resend;
@@ -782,69 +812,6 @@ declare class Emails {
     cancel(id: string): Promise<CancelEmailResponse>;
 }
 
-interface Topic {
-    id: string;
-    name: string;
-    description?: string;
-    default_subscription: 'opt_in' | 'opt_out';
-    created_at: string;
-}
-
-interface CreateTopicOptions {
-    name: string;
-    description?: string;
-    default_subscription: 'opt_in' | 'opt_out';
-}
-type CreateTopicResponseSuccess = Pick<Topic, 'id'>;
-interface CreateTopicResponse {
-    data: CreateTopicResponseSuccess | null;
-    error: ErrorResponse | null;
-}
-
-type GetTopicResponseSuccess = Topic;
-interface GetTopicResponse {
-    data: GetTopicResponseSuccess | null;
-    error: ErrorResponse | null;
-}
-
-interface ListTopicsResponseSuccess {
-    data: Topic[];
-}
-interface ListTopicsResponse {
-    data: ListTopicsResponseSuccess | null;
-    error: ErrorResponse | null;
-}
-
-type RemoveTopicResponseSuccess = Pick<Topic, 'id'> & {
-    object: 'topic';
-    deleted: boolean;
-};
-interface RemoveTopicResponse {
-    data: RemoveTopicResponseSuccess | null;
-    error: ErrorResponse | null;
-}
-
-interface UpdateTopicOptions {
-    id: string;
-    name?: string;
-    description?: string;
-}
-type UpdateTopicResponseSuccess = Pick<Topic, 'id'>;
-interface UpdateTopicResponse {
-    data: UpdateTopicResponseSuccess | null;
-    error: ErrorResponse | null;
-}
-
-declare class Topics {
-    private readonly resend;
-    constructor(resend: Resend);
-    create(payload: CreateTopicOptions): Promise<CreateTopicResponse>;
-    list(): Promise<ListTopicsResponse>;
-    get(id: string): Promise<GetTopicResponse>;
-    update(payload: UpdateTopicOptions): Promise<UpdateTopicResponse>;
-    remove(id: string): Promise<RemoveTopicResponse>;
-}
-
 declare class Resend {
     readonly key?: string | undefined;
     private readonly headers;
@@ -855,31 +822,48 @@ declare class Resend {
     readonly contacts: Contacts;
     readonly domains: Domains;
     readonly emails: Emails;
-    readonly topics: Topics;
     constructor(key?: string | undefined);
     fetchRequest<T>(path: string, options?: {}): Promise<{
-        data: T | null;
-        error: ErrorResponse | null;
+        data: T;
+        error: null;
+    } | {
+        data: null;
+        error: ErrorResponse;
     }>;
     post<T>(path: string, entity?: unknown, options?: PostOptions & IdempotentRequest): Promise<{
-        data: T | null;
-        error: ErrorResponse | null;
+        data: null;
+        error: ErrorResponse;
+    } | {
+        data: T;
+        error: null;
     }>;
     get<T>(path: string, options?: GetOptions): Promise<{
-        data: T | null;
-        error: ErrorResponse | null;
+        data: null;
+        error: ErrorResponse;
+    } | {
+        data: T;
+        error: null;
     }>;
     put<T>(path: string, entity: unknown, options?: PutOptions): Promise<{
-        data: T | null;
-        error: ErrorResponse | null;
+        data: null;
+        error: ErrorResponse;
+    } | {
+        data: T;
+        error: null;
     }>;
     patch<T>(path: string, entity: unknown, options?: PatchOptions): Promise<{
-        data: T | null;
-        error: ErrorResponse | null;
+        data: null;
+        error: ErrorResponse;
+    } | {
+        data: T;
+        error: null;
     }>;
     delete<T>(path: string, query?: unknown): Promise<{
-        data: T | null;
-        error: ErrorResponse | null;
+        data: null;
+        error: ErrorResponse;
+    } | {
+        data: T;
+        error: null;
     }>;
 }