@wix/auto_sdk_email-marketing_sender-details 1.0.21 → 1.0.23

package/build/{index.d.mts → internal/es/index.d.mts}

@@ -1,7 +1,8 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { G as GetSenderDetailsResponse, S as SenderDetails, U as UpdateSenderDetailsResponse, R as ResolveActualFromAddressResponse, a as SenderDetailsUpdatedEnvelope } from './email-marketing-v1-sender-details-sender-details.universal-CG1RXfqJ.mjs';
-export { A as ActionEvent, B as BaseEventMetadata, D as DomainEvent, f as DomainEventBodyOneOf, E as EntityCreatedEvent, i as EntityDeletedEvent, h as EntityUpdatedEvent, k as EventMetadata, b as GetSenderDetailsRequest, I as IdentificationData, j as IdentificationDataIdOneOf, M as MessageEnvelope, e as ResolveActualFromAddressRequest, g as RestoreInfo, c as UpdateSenderDetailsRequest, V as VerifySenderEmailRequest, d as VerifySenderEmailResponse, W as WebhookIdentityType } from './email-marketing-v1-sender-details-sender-details.universal-CG1RXfqJ.mjs';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { GetSenderDetailsResponse, SenderDetails, UpdateSenderDetailsResponse, VerifyEmailApplicationErrors, ResolveActualFromAddressResponse, SenderDetailsUpdatedEnvelope } from './index.typings.mjs';
+export { ActionEvent, BaseEventMetadata, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, GetSenderDetailsRequest, IdentificationData, IdentificationDataIdOneOf, MessageEnvelope, ResolveActualFromAddressRequest, RestoreInfo, UpdateSenderDetailsRequest, VerifySenderEmailRequest, VerifySenderEmailResponse, WebhookIdentityType } from './index.typings.mjs';
 
+type SenderDetailsNonNullablePaths = `fromName` | `fromEmail`;
 declare function getSenderDetails$1(httpClient: HttpClient): GetSenderDetailsSignature;
 interface GetSenderDetailsSignature {
     /**
@@ -12,7 +13,9 @@ interface GetSenderDetailsSignature {
      * + If you send an email campaign with a public email domain (e.g.
      * @deprecated
      */
-    (): Promise<GetSenderDetailsResponse>;
+    (): Promise<NonNullablePaths<GetSenderDetailsResponse, {
+        [P in SenderDetailsNonNullablePaths]: `senderDetails.${P}`;
+    }[SenderDetailsNonNullablePaths]>>;
 }
 declare function updateSenderDetails$1(httpClient: HttpClient): UpdateSenderDetailsSignature;
 interface UpdateSenderDetailsSignature {
@@ -24,7 +27,7 @@ interface UpdateSenderDetailsSignature {
      * @param - New sender details.
      * @deprecated
      */
-    (senderDetails: SenderDetails): Promise<UpdateSenderDetailsResponse>;
+    (senderDetails: SenderDetails): Promise<NonNullablePaths<UpdateSenderDetailsResponse, `verificationNeeded`>>;
 }
 declare function verifyEmail$1(httpClient: HttpClient): VerifyEmailSignature;
 interface VerifyEmailSignature {
@@ -33,7 +36,9 @@ interface VerifyEmailSignature {
      * @param - Verification code.
      * @deprecated
      */
-    (verificationCode: string): Promise<void>;
+    (verificationCode: string): Promise<void & {
+        __applicationErrorsType?: VerifyEmailApplicationErrors;
+    }>;
 }
 declare function resolveActualFromAddress$1(httpClient: HttpClient): ResolveActualFromAddressSignature;
 interface ResolveActualFromAddressSignature {
@@ -42,7 +47,7 @@ interface ResolveActualFromAddressSignature {
      * @param - User's provided address from which to send email marketing campaign.
      * @deprecated
      */
-    (fromAddress: string): Promise<ResolveActualFromAddressResponse>;
+    (fromAddress: string): Promise<NonNullablePaths<ResolveActualFromAddressResponse, `actualFromAddress`>>;
 }
 declare const onSenderDetailsUpdated$1: EventDefinition<SenderDetailsUpdatedEnvelope, "wix.email_marketing.v1.sender_details_updated">;
 

package/build/{index.mjs → internal/es/index.mjs}

@@ -307,6 +307,7 @@ async function verifyEmail2(verificationCode) {
   try {
     const result = await httpClient.request(reqOpts);
     sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(result.data);
   } catch (err) {
     const transformedError = sdkTransformError(
       err,

package/build/internal/es/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/email-marketing-v1-sender-details-sender-details.public.ts","../../../src/email-marketing-v1-sender-details-sender-details.universal.ts","../../../src/email-marketing-v1-sender-details-sender-details.http.ts","../../../src/email-marketing-v1-sender-details-sender-details.context.ts"],"sourcesContent":["import { renameKeysFromRESTResponseToSDKResponse } from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { EventDefinition, HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport {\n  GetSenderDetailsResponse,\n  ResolveActualFromAddressResponse,\n  SenderDetails,\n  SenderDetailsUpdatedEnvelope,\n  UpdateSenderDetailsResponse,\n  VerifyEmailApplicationErrors,\n  getSenderDetails as universalGetSenderDetails,\n  resolveActualFromAddress as universalResolveActualFromAddress,\n  updateSenderDetails as universalUpdateSenderDetails,\n  verifyEmail as universalVerifyEmail,\n} from './email-marketing-v1-sender-details-sender-details.universal.js';\n\nexport const __metadata = { PACKAGE_NAME: '@wix/email-marketing' };\n\ntype SenderDetailsNonNullablePaths = `fromName` | `fromEmail`;\n\nexport function getSenderDetails(\n  httpClient: HttpClient\n): GetSenderDetailsSignature {\n  return () =>\n    universalGetSenderDetails(\n      // @ts-ignore\n      { httpClient }\n    );\n}\n\ninterface GetSenderDetailsSignature {\n  /**\n   * Retrieves sender details.\n   *\n   * The sender details include the information displayed as the email sender's name and email address.\n   *\n   * + If you send an email campaign with a public email domain (e.g.\n   * @deprecated\n   */\n  (): Promise<\n    NonNullablePaths<\n      GetSenderDetailsResponse,\n      {\n        [P in SenderDetailsNonNullablePaths]: `senderDetails.${P}`;\n      }[SenderDetailsNonNullablePaths]\n    >\n  >;\n}\n\nexport function updateSenderDetails(\n  httpClient: HttpClient\n): UpdateSenderDetailsSignature {\n  return (senderDetails: SenderDetails) =>\n    universalUpdateSenderDetails(\n      senderDetails,\n      // @ts-ignore\n      { httpClient }\n    );\n}\n\ninterface UpdateSenderDetailsSignature {\n  /**\n   * Updates sender details (only provided fields will be updated).\n   *\n   * If `from_email` is changed - a verification code will be sent to new email address.\n   * If verification is needed, a verification email will be sent to the user, and `verification_needed` will return true.\n   * @param - New sender details.\n   * @deprecated\n   */\n  (senderDetails: SenderDetails): Promise<\n    NonNullablePaths<UpdateSenderDetailsResponse, `verificationNeeded`>\n  >;\n}\n\nexport function verifyEmail(httpClient: HttpClient): VerifyEmailSignature {\n  return (verificationCode: string) =>\n    universalVerifyEmail(\n      verificationCode,\n      // @ts-ignore\n      { httpClient }\n    );\n}\n\ninterface VerifyEmailSignature {\n  /**\n   * Verifies the sender's email using a verification code sent to the user's email address upon update.\n   * @param - Verification code.\n   * @deprecated\n   */\n  (verificationCode: string): Promise<\n    void & {\n      __applicationErrorsType?: VerifyEmailApplicationErrors;\n    }\n  >;\n}\n\nexport function resolveActualFromAddress(\n  httpClient: HttpClient\n): ResolveActualFromAddressSignature {\n  return (fromAddress: string) =>\n    universalResolveActualFromAddress(\n      fromAddress,\n      // @ts-ignore\n      { httpClient }\n    );\n}\n\ninterface ResolveActualFromAddressSignature {\n  /**\n   * Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).\n   * @param - User's provided address from which to send email marketing campaign.\n   * @deprecated\n   */\n  (fromAddress: string): Promise<\n    NonNullablePaths<ResolveActualFromAddressResponse, `actualFromAddress`>\n  >;\n}\n\nexport const onSenderDetailsUpdated = EventDefinition(\n  'wix.email_marketing.v1.sender_details_updated',\n  true,\n  (event: SenderDetailsUpdatedEnvelope) =>\n    renameKeysFromRESTResponseToSDKResponse(\n      transformPaths(event, [\n        {\n          transformFn: transformRESTTimestampToSDKTimestamp,\n          paths: [\n            { path: 'entity.dateVerified' },\n            { path: 'metadata.eventTime' },\n          ],\n        },\n      ])\n    )\n)<SenderDetailsUpdatedEnvelope>();\n\nexport {\n  ActionEvent,\n  BaseEventMetadata,\n  DomainEvent,\n  DomainEventBodyOneOf,\n  EntityCreatedEvent,\n  EntityDeletedEvent,\n  EntityUpdatedEvent,\n  EventMetadata,\n  GetSenderDetailsRequest,\n  GetSenderDetailsResponse,\n  IdentificationData,\n  IdentificationDataIdOneOf,\n  MessageEnvelope,\n  ResolveActualFromAddressRequest,\n  ResolveActualFromAddressResponse,\n  RestoreInfo,\n  SenderDetails,\n  SenderDetailsUpdatedEnvelope,\n  UpdateSenderDetailsRequest,\n  UpdateSenderDetailsResponse,\n  VerifySenderEmailRequest,\n  VerifySenderEmailResponse,\n  WebhookIdentityType,\n} from './email-marketing-v1-sender-details-sender-details.universal.js';\n","import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixEmailMarketingV1SenderDetails from './email-marketing-v1-sender-details-sender-details.http.js';\n\n/**\n * A sender details object contains the information that is displayed as the email sender's name and email address.\n * If sending email campaigns with a public email domain (e.g. @gmail.com or @yahoo.com), the email address will not\n * be displayed in the 'from' header. Instead, the email address is replaced with @wixemails.com (or @wixsitemail.com for free users),\n * and the sender's email is placed in the 'reply-to' header.\n *\n * If sending email campaigns with an email from a Wix managed domain, that email will be displayed in the 'from' header.\n * If sending with an email from a custom domain that is not managed by Wix, a line will be inserted that states that the\n * email was sent via wixemails.com.\n */\nexport interface SenderDetails {\n  /** Display name of sender. */\n  fromName?: string;\n  /**\n   * Email address of sender.\n   * @format EMAIL\n   */\n  fromEmail?: string;\n  /**\n   * Date and time the sender's email address was verified.\n   * @readonly\n   */\n  dateVerified?: Date | null;\n}\n\nexport interface GetSenderDetailsRequest {}\n\nexport interface GetSenderDetailsResponse {\n  /** Current sender details. */\n  senderDetails?: SenderDetails;\n}\n\nexport interface UpdateSenderDetailsRequest {\n  /** New sender details. */\n  senderDetails: SenderDetails;\n}\n\nexport interface UpdateSenderDetailsResponse {\n  /** Whether email address needs verification. */\n  verificationNeeded?: boolean;\n}\n\nexport interface VerifySenderEmailRequest {\n  /** Verification code. */\n  verificationCode: string;\n}\n\nexport interface VerifySenderEmailResponse {}\n\nexport interface ResolveActualFromAddressRequest {\n  /**\n   * User's provided address from which to send email marketing campaign.\n   * @format EMAIL\n   */\n  fromAddress: string;\n}\n\nexport interface ResolveActualFromAddressResponse {\n  /**\n   * Actual from-address that will be used for email distribution.\n   * @format EMAIL\n   */\n  actualFromAddress?: string;\n}\n\nexport interface DomainEvent extends DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */\n  _id?: string;\n  /**\n   * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.\n   * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.\n   */\n  entityFqdn?: string;\n  /**\n   * Event action name, placed at the top level to make it easier for users to dispatch messages.\n   * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.\n   */\n  slug?: string;\n  /** ID of the entity associated with the event. */\n  entityId?: string;\n  /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */\n  eventTime?: Date | null;\n  /**\n   * Whether the event was triggered as a result of a privacy regulation application\n   * (for example, GDPR).\n   */\n  triggeredByAnonymizeRequest?: boolean | null;\n  /** If present, indicates the action that triggered the event. */\n  originatedFrom?: string | null;\n  /**\n   * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.\n   * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.\n   */\n  entityEventSequence?: string | null;\n}\n\n/** @oneof */\nexport interface DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n}\n\nexport interface EntityCreatedEvent {\n  entity?: string;\n}\n\nexport interface RestoreInfo {\n  deletedDate?: Date | null;\n}\n\nexport interface EntityUpdatedEvent {\n  /**\n   * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n   * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n   * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n   */\n  currentEntity?: string;\n}\n\nexport interface EntityDeletedEvent {\n  /** Entity that was deleted. */\n  deletedEntity?: string | null;\n}\n\nexport interface ActionEvent {\n  body?: string;\n}\n\nexport interface MessageEnvelope {\n  /**\n   * App instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n  /**\n   * Event type.\n   * @maxLength 150\n   */\n  eventType?: string;\n  /** The identification type and identity data. */\n  identity?: IdentificationData;\n  /** Stringify payload. */\n  data?: string;\n}\n\nexport interface IdentificationData extends IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n  /** @readonly */\n  identityType?: WebhookIdentityTypeWithLiterals;\n}\n\n/** @oneof */\nexport interface IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n}\n\nexport enum WebhookIdentityType {\n  UNKNOWN = 'UNKNOWN',\n  ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n  MEMBER = 'MEMBER',\n  WIX_USER = 'WIX_USER',\n  APP = 'APP',\n}\n\n/** @enumType */\nexport type WebhookIdentityTypeWithLiterals =\n  | WebhookIdentityType\n  | 'UNKNOWN'\n  | 'ANONYMOUS_VISITOR'\n  | 'MEMBER'\n  | 'WIX_USER'\n  | 'APP';\nexport type VerifyEmailApplicationErrors = {\n  code?: 'INVALID_VERIFICATION_CODE';\n  description?: string;\n  data?: Record<string, any>;\n};\n\nexport interface BaseEventMetadata {\n  /**\n   * App instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n  /**\n   * Event type.\n   * @maxLength 150\n   */\n  eventType?: string;\n  /** The identification type and identity data. */\n  identity?: IdentificationData;\n}\n\nexport interface EventMetadata extends BaseEventMetadata {\n  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */\n  _id?: string;\n  /**\n   * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.\n   * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.\n   */\n  entityFqdn?: string;\n  /**\n   * Event action name, placed at the top level to make it easier for users to dispatch messages.\n   * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.\n   */\n  slug?: string;\n  /** ID of the entity associated with the event. */\n  entityId?: string;\n  /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */\n  eventTime?: Date | null;\n  /**\n   * Whether the event was triggered as a result of a privacy regulation application\n   * (for example, GDPR).\n   */\n  triggeredByAnonymizeRequest?: boolean | null;\n  /** If present, indicates the action that triggered the event. */\n  originatedFrom?: string | null;\n  /**\n   * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.\n   * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.\n   */\n  entityEventSequence?: string | null;\n}\n\nexport interface SenderDetailsUpdatedEnvelope {\n  entity: SenderDetails;\n  metadata: EventMetadata;\n}\n\n/**\n * An event that triggers when sender details are updated without the need for explicit verification.\n * @permissionScope Manage Stores\n * @permissionScopeId SCOPE.STORES.MANAGE-STORES\n * @permissionScope Access Verticals by Automations\n * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS\n * @permissionScope Set Up Automations\n * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS\n * @permissionScope Read Email Marketing\n * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING\n * @permissionScope Manage Email Marketing\n * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING\n * @permissionId Shoutout.Read\n * @webhook\n * @eventType wix.email_marketing.v1.sender_details_updated\n * @serviceIdentifier wix.emailmarketing.api.v1.SenderDetailsService\n * @slug updated\n */\nexport declare function onSenderDetailsUpdated(\n  handler: (event: SenderDetailsUpdatedEnvelope) => void | Promise<void>\n): void;\n\ntype SenderDetailsNonNullablePaths = `fromName` | `fromEmail`;\n\n/**\n * Retrieves sender details.\n *\n * The sender details include the information displayed as the email sender's name and email address.\n *\n * + If you send an email campaign with a public email domain (e.g. @gmail.com or @yahoo.com), the email address will not be displayed in the 'from' header. Instead, the email address is replaced with @wixemails.com (or @wixsitemail.com for free users), and the sender's email is placed in the 'reply-to' header.\n * + If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.\n * + If you send an email from a custom domain that is not managed by Wix, a line will be inserted that states that the email was sent via wixemails.com.\n * @public\n * @permissionId Shoutout.Manage\n * @applicableIdentity APP\n * @fqn wix.emailmarketing.api.v1.SenderDetailsService.Get\n * @deprecated\n * @replacedBy wix.promote.v1.SenderDetailsService.GetDefaultSenderDetails\n * @targetRemovalDate 2025-09-30\n */\nexport async function getSenderDetails(): Promise<\n  NonNullablePaths<\n    GetSenderDetailsResponse,\n    {\n      [P in SenderDetailsNonNullablePaths]: `senderDetails.${P}`;\n    }[SenderDetailsNonNullablePaths]\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[0] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({});\n\n  const reqOpts = ambassadorWixEmailMarketingV1SenderDetails.get(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: {},\n        singleArgumentUnchanged: false,\n      },\n      []\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\n/**\n * Updates sender details (only provided fields will be updated).\n *\n * If `from_email` is changed - a verification code will be sent to new email address.\n * If verification is needed, a verification email will be sent to the user, and `verification_needed` will return true.\n * @param senderDetails - New sender details.\n * @public\n * @requiredField senderDetails\n * @permissionId Shoutout.Manage\n * @applicableIdentity APP\n * @fqn wix.emailmarketing.api.v1.SenderDetailsService.Update\n * @deprecated\n * @replacedBy wix.promote.v1.SenderEmailService.GetOrCreateSenderEmail\n * @targetRemovalDate 2025-09-30\n */\nexport async function updateSenderDetails(\n  senderDetails: SenderDetails\n): Promise<\n  NonNullablePaths<UpdateSenderDetailsResponse, `verificationNeeded`>\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[1] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    senderDetails: senderDetails,\n  });\n\n  const reqOpts = ambassadorWixEmailMarketingV1SenderDetails.update(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { senderDetails: '$[0]' },\n        singleArgumentUnchanged: false,\n      },\n      ['senderDetails']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\n/**\n * Verifies the sender's email using a verification code sent to the user's email address upon update.\n * @param verificationCode - Verification code.\n * @public\n * @requiredField verificationCode\n * @permissionId Shoutout.Manage\n * @applicableIdentity APP\n * @fqn wix.emailmarketing.api.v1.SenderDetailsService.VerifyEmail\n * @deprecated\n * @replacedBy wix.promote.v1.SenderEmailService.VerifySenderEmail\n * @targetRemovalDate 2025-09-30\n */\nexport async function verifyEmail(verificationCode: string): Promise<\n  void & {\n    __applicationErrorsType?: VerifyEmailApplicationErrors;\n  }\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[1] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    verificationCode: verificationCode,\n  });\n\n  const reqOpts =\n    ambassadorWixEmailMarketingV1SenderDetails.verifyEmail(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { verificationCode: '$[0]' },\n        singleArgumentUnchanged: false,\n      },\n      ['verificationCode']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\n/**\n * Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).\n * @param fromAddress - User's provided address from which to send email marketing campaign.\n * @public\n * @requiredField fromAddress\n * @permissionId Shoutout.Manage\n * @applicableIdentity APP\n * @fqn wix.emailmarketing.api.v1.SenderDetailsService.ResolveActualFromAddress\n * @deprecated\n * @replacedBy wix.emailmarketing.api.v1.CampaignService.IdentifySenderAddress\n * @targetRemovalDate 2025-09-30\n */\nexport async function resolveActualFromAddress(\n  fromAddress: string\n): Promise<\n  NonNullablePaths<ResolveActualFromAddressResponse, `actualFromAddress`>\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[1] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    fromAddress: fromAddress,\n  });\n\n  const reqOpts =\n    ambassadorWixEmailMarketingV1SenderDetails.resolveActualFromAddress(\n      payload\n    );\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { fromAddress: '$[0]' },\n        singleArgumentUnchanged: false,\n      },\n      ['fromAddress']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformSDKTimestampToRESTTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixEmailmarketingApiV1SenderDetailsServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'editor._base_domain_': [\n      {\n        srcPath: '/shoutout',\n        destPath: '',\n      },\n      {\n        srcPath: '/_api/shoutout-editor',\n        destPath: '/api',\n      },\n      {\n        srcPath: '/_api/shoutout/v1',\n        destPath: '/v1',\n      },\n    ],\n    'blocks._base_domain_': [\n      {\n        srcPath: '/shoutout',\n        destPath: '',\n      },\n      {\n        srcPath: '/_api/shoutout-editor',\n        destPath: '/api',\n      },\n      {\n        srcPath: '/_api/shoutout/v1',\n        destPath: '/v1',\n      },\n    ],\n    'create.editorx': [\n      {\n        srcPath: '/shoutout',\n        destPath: '',\n      },\n      {\n        srcPath: '/_api/shoutout-editor',\n        destPath: '/api',\n      },\n      {\n        srcPath: '/_api/shoutout/v1',\n        destPath: '/v1',\n      },\n    ],\n    'shoutout._base_domain_': [\n      {\n        srcPath: '/_api/shoutout-editor',\n        destPath: '/api',\n      },\n      {\n        srcPath: '/_api/shoutout/v1',\n        destPath: '/v1',\n      },\n    ],\n    'www._base_domain_': [\n      {\n        srcPath: '/_api/shoutout-editor',\n        destPath: '/api',\n      },\n      {\n        srcPath: '/_api/shoutout/v1',\n        destPath: '/v1',\n      },\n    ],\n    'shoutouteditor._base_domain_': [\n      {\n        srcPath: '/_api/shoutout-editor',\n        destPath: '/api',\n      },\n    ],\n    'api._api_base_domain_': [\n      {\n        srcPath: '/shoutout-editor',\n        destPath: '',\n      },\n    ],\n    _: [\n      {\n        srcPath: '/_api/shoutout/v1',\n        destPath: '/v1',\n      },\n    ],\n    'api._base_domain_': [\n      {\n        srcPath: '/_api/shoutout/v1',\n        destPath: '/v1',\n      },\n    ],\n    'manage._base_domain_': [\n      {\n        srcPath: '/_api/shoutout-editor',\n        destPath: '/api',\n      },\n      {\n        srcPath: '/_api/shoutout/v1',\n        destPath: '/v1',\n      },\n    ],\n    'www.wixapis.com': [\n      {\n        srcPath: '/email-marketing/v1',\n        destPath: '/v1',\n      },\n    ],\n    'bo._base_domain_': [\n      {\n        srcPath: '/shoutout-editor/v1',\n        destPath: '/v1',\n      },\n      {\n        srcPath: '/_api/shoutout-editor',\n        destPath: '/api',\n      },\n    ],\n    'wixbo.ai': [\n      {\n        srcPath: '/shoutout-editor/v1',\n        destPath: '/v1',\n      },\n      {\n        srcPath: '/_api/shoutout-editor',\n        destPath: '/api',\n      },\n    ],\n    'wix-bo.com': [\n      {\n        srcPath: '/shoutout-editor/v1',\n        destPath: '/v1',\n      },\n      {\n        srcPath: '/_api/shoutout-editor',\n        destPath: '/api',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_email-marketing_sender-details';\n\n/**\n * Retrieves sender details.\n *\n * The sender details include the information displayed as the email sender's name and email address.\n *\n * + If you send an email campaign with a public email domain (e.g. @gmail.com or @yahoo.com), the email address will not be displayed in the 'from' header. Instead, the email address is replaced with @wixemails.com (or @wixsitemail.com for free users), and the sender's email is placed in the 'reply-to' header.\n * + If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.\n * + If you send an email from a custom domain that is not managed by Wix, a line will be inserted that states that the email was sent via wixemails.com.\n * @deprecated It has been replaced with wix.promote.v1.SenderDetailsService.GetDefaultSenderDetails(), and will be removed on 2025-09-30.\n */\nexport function get(payload: object): RequestOptionsFactory<any> {\n  function __get({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.email_marketing.v1.sender_details',\n      method: 'GET' as any,\n      methodFqn: 'wix.emailmarketing.api.v1.SenderDetailsService.Get',\n      packageName: PACKAGE_NAME,\n      url: resolveWixEmailmarketingApiV1SenderDetailsServiceUrl({\n        protoPath: '/v1/sender-details',\n        data: payload,\n        host,\n      }),\n      params: toURLSearchParams(payload),\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'senderDetails.dateVerified' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __get;\n}\n\n/**\n * Updates sender details (only provided fields will be updated).\n *\n * If `from_email` is changed - a verification code will be sent to new email address.\n * If verification is needed, a verification email will be sent to the user, and `verification_needed` will return true.\n * @deprecated It has been replaced with wix.promote.v1.SenderEmailService.GetOrCreateSenderEmail(), and will be removed on 2025-09-30.\n */\nexport function update(payload: object): RequestOptionsFactory<any> {\n  function __update({ host }: any) {\n    const serializedData = transformPaths(payload, [\n      {\n        transformFn: transformSDKTimestampToRESTTimestamp,\n        paths: [{ path: 'senderDetails.dateVerified' }],\n      },\n    ]);\n    const metadata = {\n      entityFqdn: 'wix.email_marketing.v1.sender_details',\n      method: 'PATCH' as any,\n      methodFqn: 'wix.emailmarketing.api.v1.SenderDetailsService.Update',\n      packageName: PACKAGE_NAME,\n      url: resolveWixEmailmarketingApiV1SenderDetailsServiceUrl({\n        protoPath: '/v1/sender-details',\n        data: serializedData,\n        host,\n      }),\n      data: serializedData,\n    };\n\n    return metadata;\n  }\n\n  return __update;\n}\n\n/**\n * Verifies the sender's email using a verification code sent to the user's email address upon update.\n * @deprecated It has been replaced with wix.promote.v1.SenderEmailService.VerifySenderEmail(), and will be removed on 2025-09-30.\n */\nexport function verifyEmail(payload: object): RequestOptionsFactory<any> {\n  function __verifyEmail({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.email_marketing.v1.sender_details',\n      method: 'POST' as any,\n      methodFqn: 'wix.emailmarketing.api.v1.SenderDetailsService.VerifyEmail',\n      packageName: PACKAGE_NAME,\n      url: resolveWixEmailmarketingApiV1SenderDetailsServiceUrl({\n        protoPath: '/v1/sender-details/verify-email',\n        data: payload,\n        host,\n      }),\n      data: payload,\n    };\n\n    return metadata;\n  }\n\n  return __verifyEmail;\n}\n\n/**\n * Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).\n * @deprecated It has been replaced with wix.emailmarketing.api.v1.CampaignService.IdentifySenderAddress(), and will be removed on 2025-09-30.\n */\nexport function resolveActualFromAddress(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __resolveActualFromAddress({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.email_marketing.v1.sender_details',\n      method: 'POST' as any,\n      methodFqn:\n        'wix.emailmarketing.api.v1.SenderDetailsService.ResolveActualFromAddress',\n      packageName: PACKAGE_NAME,\n      url: resolveWixEmailmarketingApiV1SenderDetailsServiceUrl({\n        protoPath: '/v1/sender-details/actual-from-address',\n        data: payload,\n        host,\n      }),\n      data: payload,\n    };\n\n    return metadata;\n  }\n\n  return __resolveActualFromAddress;\n}\n","import {\n  getSenderDetails as publicGetSenderDetails,\n  updateSenderDetails as publicUpdateSenderDetails,\n  verifyEmail as publicVerifyEmail,\n  resolveActualFromAddress as publicResolveActualFromAddress,\n} from './email-marketing-v1-sender-details-sender-details.public.js';\nimport { createRESTModule } from '@wix/sdk-runtime/rest-modules';\nimport { createEventModule } from '@wix/sdk-runtime/event-definition-modules';\nimport {\n  BuildRESTFunction,\n  MaybeContext,\n  BuildEventDefinition,\n} from '@wix/sdk-types';\nimport { onSenderDetailsUpdated as publicOnSenderDetailsUpdated } from './email-marketing-v1-sender-details-sender-details.public.js';\n\nexport const getSenderDetails: MaybeContext<\n  BuildRESTFunction<typeof publicGetSenderDetails> &\n    typeof publicGetSenderDetails\n> = /*#__PURE__*/ createRESTModule(publicGetSenderDetails);\nexport const updateSenderDetails: MaybeContext<\n  BuildRESTFunction<typeof publicUpdateSenderDetails> &\n    typeof publicUpdateSenderDetails\n> = /*#__PURE__*/ createRESTModule(publicUpdateSenderDetails);\nexport const verifyEmail: MaybeContext<\n  BuildRESTFunction<typeof publicVerifyEmail> & typeof publicVerifyEmail\n> = /*#__PURE__*/ createRESTModule(publicVerifyEmail);\nexport const resolveActualFromAddress: MaybeContext<\n  BuildRESTFunction<typeof publicResolveActualFromAddress> &\n    typeof publicResolveActualFromAddress\n> = /*#__PURE__*/ createRESTModule(publicResolveActualFromAddress);\n/**\n * An event that triggers when sender details are updated without the need for explicit verification.\n */\nexport const onSenderDetailsUpdated: BuildEventDefinition<\n  typeof publicOnSenderDetailsUpdated\n> = createEventModule(publicOnSenderDetailsUpdated);\n\nexport { WebhookIdentityType } from './email-marketing-v1-sender-details-sender-details.universal.js';\nexport {\n  SenderDetails,\n  GetSenderDetailsRequest,\n  GetSenderDetailsResponse,\n  UpdateSenderDetailsRequest,\n  UpdateSenderDetailsResponse,\n  VerifySenderEmailRequest,\n  VerifySenderEmailResponse,\n  ResolveActualFromAddressRequest,\n  ResolveActualFromAddressResponse,\n  DomainEvent,\n  DomainEventBodyOneOf,\n  EntityCreatedEvent,\n  RestoreInfo,\n  EntityUpdatedEvent,\n  EntityDeletedEvent,\n  ActionEvent,\n  MessageEnvelope,\n  IdentificationData,\n  IdentificationDataIdOneOf,\n  BaseEventMetadata,\n  EventMetadata,\n  SenderDetailsUpdatedEnvelope,\n} from './email-marketing-v1-sender-details-sender-details.universal.js';\n"],"mappings":";AAAA,SAAS,2CAAAA,gDAA+C;AACxD,SAAS,wCAAAC,6CAA4C;AACrD,SAAS,kBAAAC,uBAAsB;AAC/B,SAAS,uBAAqD;;;ACH9D,SAAS,kBAAkB,yBAAyB;AACpD;AAAA,EACE;AAAA,EACA;AAAA,OACK;;;ACJP,SAAS,yBAAyB;AAClC,SAAS,4CAA4C;AACrD,SAAS,4CAA4C;AACrD,SAAS,sBAAsB;AAC/B,SAAS,kBAAkB;AAI3B,SAAS,qDACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,kBAAkB;AAAA,MAChB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,0BAA0B;AAAA,MACxB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,qBAAqB;AAAA,MACnB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,gCAAgC;AAAA,MAC9B;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,yBAAyB;AAAA,MACvB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,GAAG;AAAA,MACD;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,qBAAqB;AAAA,MACnB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,oBAAoB;AAAA,MAClB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,YAAY;AAAA,MACV;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,cAAc;AAAA,MACZ;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,SAAO,WAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAYd,SAAS,IAAI,SAA6C;AAC/D,WAAS,MAAM,EAAE,KAAK,GAAQ;AAC5B,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,KAAK,qDAAqD;AAAA,QACxD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,QAAQ,kBAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACC,aAClB,eAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,6BAA6B,CAAC;AAAA,QAChD;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AASO,SAAS,OAAO,SAA6C;AAClE,WAAS,SAAS,EAAE,KAAK,GAAQ;AAC/B,UAAM,iBAAiB,eAAe,SAAS;AAAA,MAC7C;AAAA,QACE,aAAa;AAAA,QACb,OAAO,CAAC,EAAE,MAAM,6BAA6B,CAAC;AAAA,MAChD;AAAA,IACF,CAAC;AACD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,KAAK,qDAAqD;AAAA,QACxD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,IACR;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAMO,SAAS,YAAY,SAA6C;AACvE,WAAS,cAAc,EAAE,KAAK,GAAQ;AACpC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,KAAK,qDAAqD;AAAA,QACxD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,IACR;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAMO,SAAS,yBACd,SAC4B;AAC5B,WAAS,2BAA2B,EAAE,KAAK,GAAQ;AACjD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,KAAK,qDAAqD;AAAA,QACxD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,IACR;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADlEO,IAAK,sBAAL,kBAAKC,yBAAL;AACL,EAAAA,qBAAA,aAAU;AACV,EAAAA,qBAAA,uBAAoB;AACpB,EAAAA,qBAAA,YAAS;AACT,EAAAA,qBAAA,cAAW;AACX,EAAAA,qBAAA,SAAM;AALI,SAAAA;AAAA,GAAA;AAiHZ,eAAsB,mBAOpB;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC,CAAC,CAAC;AAExD,QAAM,UAAqD,IAAI,OAAO;AAEtE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,CAAC;AAAA,QAC3B,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC;AAAA,IACH;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAiBA,eAAsB,oBACpB,eAGA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC;AAAA,IACpD;AAAA,EACF,CAAC;AAED,QAAM,UAAqD,OAAO,OAAO;AAEzE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,eAAe,OAAO;AAAA,QAClD,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,eAAe;AAAA,IAClB;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAcA,eAAsBC,aAAY,kBAIhC;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC;AAAA,IACpD;AAAA,EACF,CAAC;AAED,QAAM,UACuC,YAAY,OAAO;AAEhE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,kBAAkB,OAAO;AAAA,QACrD,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,kBAAkB;AAAA,IACrB;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAcA,eAAsBC,0BACpB,aAGA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC;AAAA,IACpD;AAAA,EACF,CAAC;AAED,QAAM,UACuC;AAAA,IACzC;AAAA,EACF;AAEF,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,aAAa,OAAO;AAAA,QAChD,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,aAAa;AAAA,IAChB;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;;;ADlfO,SAASC,kBACd,YAC2B;AAC3B,SAAO,MACL;AAAA;AAAA,IAEE,EAAE,WAAW;AAAA,EACf;AACJ;AAqBO,SAASC,qBACd,YAC8B;AAC9B,SAAO,CAAC,kBACN;AAAA,IACE;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;AAgBO,SAASC,aAAY,YAA8C;AACxE,SAAO,CAAC,qBACNA;AAAA,IACE;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;AAeO,SAASC,0BACd,YACmC;AACnC,SAAO,CAAC,gBACNA;AAAA,IACE;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;AAaO,IAAM,yBAAyB;AAAA,EACpC;AAAA,EACA;AAAA,EACA,CAAC,UACCC;AAAA,IACEC,gBAAe,OAAO;AAAA,MACpB;AAAA,QACE,aAAaC;AAAA,QACb,OAAO;AAAA,UACL,EAAE,MAAM,sBAAsB;AAAA,UAC9B,EAAE,MAAM,qBAAqB;AAAA,QAC/B;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AACJ,EAAgC;;;AGhIhC,SAAS,wBAAwB;AACjC,SAAS,yBAAyB;AAQ3B,IAAMC,oBAGK,iCAAiBA,iBAAsB;AAClD,IAAMC,uBAGK,iCAAiBA,oBAAyB;AACrD,IAAMC,eAEK,iCAAiBA,YAAiB;AAC7C,IAAMC,4BAGK,iCAAiBA,yBAA8B;AAI1D,IAAMC,0BAET,kBAAkB,sBAA4B;","names":["renameKeysFromRESTResponseToSDKResponse","transformRESTTimestampToSDKTimestamp","transformPaths","payload","WebhookIdentityType","verifyEmail","resolveActualFromAddress","getSenderDetails","updateSenderDetails","verifyEmail","resolveActualFromAddress","renameKeysFromRESTResponseToSDKResponse","transformPaths","transformRESTTimestampToSDKTimestamp","getSenderDetails","updateSenderDetails","verifyEmail","resolveActualFromAddress","onSenderDetailsUpdated"]}

package/build/internal/{email-marketing-v1-sender-details-sender-details.universal-CG1RXfqJ.d.ts → es/index.typings.d.mts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 /**
  * A sender details object contains the information that is displayed as the email sender's name and email address.
  * If sending email campaigns with a public email domain (e.g. @gmail.com or @yahoo.com), the email address will not
@@ -190,6 +192,11 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type VerifyEmailApplicationErrors = {
+    code?: 'INVALID_VERIFICATION_CODE';
+    description?: string;
+    data?: Record<string, any>;
+};
 interface BaseEventMetadata {
     /**
      * App instance ID.
@@ -238,5 +245,88 @@ interface SenderDetailsUpdatedEnvelope {
     entity: SenderDetails;
     metadata: EventMetadata;
 }
+/**
+ * An event that triggers when sender details are updated without the need for explicit verification.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Access Verticals by Automations
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
+ * @permissionScope Read Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @permissionId Shoutout.Read
+ * @webhook
+ * @eventType wix.email_marketing.v1.sender_details_updated
+ * @serviceIdentifier wix.emailmarketing.api.v1.SenderDetailsService
+ * @slug updated
+ */
+declare function onSenderDetailsUpdated(handler: (event: SenderDetailsUpdatedEnvelope) => void | Promise<void>): void;
+type SenderDetailsNonNullablePaths = `fromName` | `fromEmail`;
+/**
+ * Retrieves sender details.
+ *
+ * The sender details include the information displayed as the email sender's name and email address.
+ *
+ * + If you send an email campaign with a public email domain (e.g. @gmail.com or @yahoo.com), the email address will not be displayed in the 'from' header. Instead, the email address is replaced with @wixemails.com (or @wixsitemail.com for free users), and the sender's email is placed in the 'reply-to' header.
+ * + If you send an email campaign with an email from a Wix managed domain, that email will be displayed in the 'from' header.
+ * + If you send an email from a custom domain that is not managed by Wix, a line will be inserted that states that the email was sent via wixemails.com.
+ * @public
+ * @permissionId Shoutout.Manage
+ * @applicableIdentity APP
+ * @fqn wix.emailmarketing.api.v1.SenderDetailsService.Get
+ * @deprecated
+ * @replacedBy wix.promote.v1.SenderDetailsService.GetDefaultSenderDetails
+ * @targetRemovalDate 2025-09-30
+ */
+declare function getSenderDetails(): Promise<NonNullablePaths<GetSenderDetailsResponse, {
+    [P in SenderDetailsNonNullablePaths]: `senderDetails.${P}`;
+}[SenderDetailsNonNullablePaths]>>;
+/**
+ * Updates sender details (only provided fields will be updated).
+ *
+ * If `from_email` is changed - a verification code will be sent to new email address.
+ * If verification is needed, a verification email will be sent to the user, and `verification_needed` will return true.
+ * @param senderDetails - New sender details.
+ * @public
+ * @requiredField senderDetails
+ * @permissionId Shoutout.Manage
+ * @applicableIdentity APP
+ * @fqn wix.emailmarketing.api.v1.SenderDetailsService.Update
+ * @deprecated
+ * @replacedBy wix.promote.v1.SenderEmailService.GetOrCreateSenderEmail
+ * @targetRemovalDate 2025-09-30
+ */
+declare function updateSenderDetails(senderDetails: SenderDetails): Promise<NonNullablePaths<UpdateSenderDetailsResponse, `verificationNeeded`>>;
+/**
+ * Verifies the sender's email using a verification code sent to the user's email address upon update.
+ * @param verificationCode - Verification code.
+ * @public
+ * @requiredField verificationCode
+ * @permissionId Shoutout.Manage
+ * @applicableIdentity APP
+ * @fqn wix.emailmarketing.api.v1.SenderDetailsService.VerifyEmail
+ * @deprecated
+ * @replacedBy wix.promote.v1.SenderEmailService.VerifySenderEmail
+ * @targetRemovalDate 2025-09-30
+ */
+declare function verifyEmail(verificationCode: string): Promise<void & {
+    __applicationErrorsType?: VerifyEmailApplicationErrors;
+}>;
+/**
+ * Checks if the sender's email address will be used as from-address or replaced (not related to current sender details).
+ * @param fromAddress - User's provided address from which to send email marketing campaign.
+ * @public
+ * @requiredField fromAddress
+ * @permissionId Shoutout.Manage
+ * @applicableIdentity APP
+ * @fqn wix.emailmarketing.api.v1.SenderDetailsService.ResolveActualFromAddress
+ * @deprecated
+ * @replacedBy wix.emailmarketing.api.v1.CampaignService.IdentifySenderAddress
+ * @targetRemovalDate 2025-09-30
+ */
+declare function resolveActualFromAddress(fromAddress: string): Promise<NonNullablePaths<ResolveActualFromAddressResponse, `actualFromAddress`>>;
 
-export { type ActionEvent as A, type BaseEventMetadata as B, type DomainEvent as D, type EntityCreatedEvent as E, type GetSenderDetailsResponse as G, type IdentificationData as I, type MessageEnvelope as M, type ResolveActualFromAddressResponse as R, type SenderDetails as S, type UpdateSenderDetailsResponse as U, type VerifySenderEmailRequest as V, WebhookIdentityType as W, type SenderDetailsUpdatedEnvelope as a, type GetSenderDetailsRequest as b, type UpdateSenderDetailsRequest as c, type VerifySenderEmailResponse as d, type ResolveActualFromAddressRequest as e, type DomainEventBodyOneOf as f, type RestoreInfo as g, type EntityUpdatedEvent as h, type EntityDeletedEvent as i, type IdentificationDataIdOneOf as j, type EventMetadata as k };
+export { type ActionEvent, type BaseEventMetadata, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type GetSenderDetailsRequest, type GetSenderDetailsResponse, type IdentificationData, type IdentificationDataIdOneOf, type MessageEnvelope, type ResolveActualFromAddressRequest, type ResolveActualFromAddressResponse, type RestoreInfo, type SenderDetails, type SenderDetailsUpdatedEnvelope, type UpdateSenderDetailsRequest, type UpdateSenderDetailsResponse, type VerifyEmailApplicationErrors, type VerifySenderEmailRequest, type VerifySenderEmailResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, getSenderDetails, onSenderDetailsUpdated, resolveActualFromAddress, updateSenderDetails, verifyEmail };

package/build/internal/es/index.typings.mjs

@@ -0,0 +1,353 @@
+// src/email-marketing-v1-sender-details-sender-details.universal.ts
+import { transformError as sdkTransformError } from "@wix/sdk-runtime/transform-error";
+import {
+  renameKeysFromSDKRequestToRESTRequest,
+  renameKeysFromRESTResponseToSDKResponse
+} from "@wix/sdk-runtime/rename-all-nested-keys";
+
+// src/email-marketing-v1-sender-details-sender-details.http.ts
+import { toURLSearchParams } from "@wix/sdk-runtime/rest-modules";
+import { transformSDKTimestampToRESTTimestamp } from "@wix/sdk-runtime/transformations/timestamp";
+import { transformRESTTimestampToSDKTimestamp } from "@wix/sdk-runtime/transformations/timestamp";
+import { transformPaths } from "@wix/sdk-runtime/transformations/transform-paths";
+import { resolveUrl } from "@wix/sdk-runtime/rest-modules";
+function resolveWixEmailmarketingApiV1SenderDetailsServiceUrl(opts) {
+  const domainToMappings = {
+    "editor._base_domain_": [
+      {
+        srcPath: "/shoutout",
+        destPath: ""
+      },
+      {
+        srcPath: "/_api/shoutout-editor",
+        destPath: "/api"
+      },
+      {
+        srcPath: "/_api/shoutout/v1",
+        destPath: "/v1"
+      }
+    ],
+    "blocks._base_domain_": [
+      {
+        srcPath: "/shoutout",
+        destPath: ""
+      },
+      {
+        srcPath: "/_api/shoutout-editor",
+        destPath: "/api"
+      },
+      {
+        srcPath: "/_api/shoutout/v1",
+        destPath: "/v1"
+      }
+    ],
+    "create.editorx": [
+      {
+        srcPath: "/shoutout",
+        destPath: ""
+      },
+      {
+        srcPath: "/_api/shoutout-editor",
+        destPath: "/api"
+      },
+      {
+        srcPath: "/_api/shoutout/v1",
+        destPath: "/v1"
+      }
+    ],
+    "shoutout._base_domain_": [
+      {
+        srcPath: "/_api/shoutout-editor",
+        destPath: "/api"
+      },
+      {
+        srcPath: "/_api/shoutout/v1",
+        destPath: "/v1"
+      }
+    ],
+    "www._base_domain_": [
+      {
+        srcPath: "/_api/shoutout-editor",
+        destPath: "/api"
+      },
+      {
+        srcPath: "/_api/shoutout/v1",
+        destPath: "/v1"
+      }
+    ],
+    "shoutouteditor._base_domain_": [
+      {
+        srcPath: "/_api/shoutout-editor",
+        destPath: "/api"
+      }
+    ],
+    "api._api_base_domain_": [
+      {
+        srcPath: "/shoutout-editor",
+        destPath: ""
+      }
+    ],
+    _: [
+      {
+        srcPath: "/_api/shoutout/v1",
+        destPath: "/v1"
+      }
+    ],
+    "api._base_domain_": [
+      {
+        srcPath: "/_api/shoutout/v1",
+        destPath: "/v1"
+      }
+    ],
+    "manage._base_domain_": [
+      {
+        srcPath: "/_api/shoutout-editor",
+        destPath: "/api"
+      },
+      {
+        srcPath: "/_api/shoutout/v1",
+        destPath: "/v1"
+      }
+    ],
+    "www.wixapis.com": [
+      {
+        srcPath: "/email-marketing/v1",
+        destPath: "/v1"
+      }
+    ],
+    "bo._base_domain_": [
+      {
+        srcPath: "/shoutout-editor/v1",
+        destPath: "/v1"
+      },
+      {
+        srcPath: "/_api/shoutout-editor",
+        destPath: "/api"
+      }
+    ],
+    "wixbo.ai": [
+      {
+        srcPath: "/shoutout-editor/v1",
+        destPath: "/v1"
+      },
+      {
+        srcPath: "/_api/shoutout-editor",
+        destPath: "/api"
+      }
+    ],
+    "wix-bo.com": [
+      {
+        srcPath: "/shoutout-editor/v1",
+        destPath: "/v1"
+      },
+      {
+        srcPath: "/_api/shoutout-editor",
+        destPath: "/api"
+      }
+    ]
+  };
+  return resolveUrl(Object.assign(opts, { domainToMappings }));
+}
+var PACKAGE_NAME = "@wix/auto_sdk_email-marketing_sender-details";
+function get(payload) {
+  function __get({ host }) {
+    const metadata = {
+      entityFqdn: "wix.email_marketing.v1.sender_details",
+      method: "GET",
+      methodFqn: "wix.emailmarketing.api.v1.SenderDetailsService.Get",
+      packageName: PACKAGE_NAME,
+      url: resolveWixEmailmarketingApiV1SenderDetailsServiceUrl({
+        protoPath: "/v1/sender-details",
+        data: payload,
+        host
+      }),
+      params: toURLSearchParams(payload),
+      transformResponse: (payload2) => transformPaths(payload2, [
+        {
+          transformFn: transformRESTTimestampToSDKTimestamp,
+          paths: [{ path: "senderDetails.dateVerified" }]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __get;
+}
+function update(payload) {
+  function __update({ host }) {
+    const serializedData = transformPaths(payload, [
+      {
+        transformFn: transformSDKTimestampToRESTTimestamp,
+        paths: [{ path: "senderDetails.dateVerified" }]
+      }
+    ]);
+    const metadata = {
+      entityFqdn: "wix.email_marketing.v1.sender_details",
+      method: "PATCH",
+      methodFqn: "wix.emailmarketing.api.v1.SenderDetailsService.Update",
+      packageName: PACKAGE_NAME,
+      url: resolveWixEmailmarketingApiV1SenderDetailsServiceUrl({
+        protoPath: "/v1/sender-details",
+        data: serializedData,
+        host
+      }),
+      data: serializedData
+    };
+    return metadata;
+  }
+  return __update;
+}
+function verifyEmail(payload) {
+  function __verifyEmail({ host }) {
+    const metadata = {
+      entityFqdn: "wix.email_marketing.v1.sender_details",
+      method: "POST",
+      methodFqn: "wix.emailmarketing.api.v1.SenderDetailsService.VerifyEmail",
+      packageName: PACKAGE_NAME,
+      url: resolveWixEmailmarketingApiV1SenderDetailsServiceUrl({
+        protoPath: "/v1/sender-details/verify-email",
+        data: payload,
+        host
+      }),
+      data: payload
+    };
+    return metadata;
+  }
+  return __verifyEmail;
+}
+function resolveActualFromAddress(payload) {
+  function __resolveActualFromAddress({ host }) {
+    const metadata = {
+      entityFqdn: "wix.email_marketing.v1.sender_details",
+      method: "POST",
+      methodFqn: "wix.emailmarketing.api.v1.SenderDetailsService.ResolveActualFromAddress",
+      packageName: PACKAGE_NAME,
+      url: resolveWixEmailmarketingApiV1SenderDetailsServiceUrl({
+        protoPath: "/v1/sender-details/actual-from-address",
+        data: payload,
+        host
+      }),
+      data: payload
+    };
+    return metadata;
+  }
+  return __resolveActualFromAddress;
+}
+
+// src/email-marketing-v1-sender-details-sender-details.universal.ts
+var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
+  WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
+  WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+  WebhookIdentityType2["MEMBER"] = "MEMBER";
+  WebhookIdentityType2["WIX_USER"] = "WIX_USER";
+  WebhookIdentityType2["APP"] = "APP";
+  return WebhookIdentityType2;
+})(WebhookIdentityType || {});
+async function getSenderDetails() {
+  const { httpClient, sideEffects } = arguments[0];
+  const payload = renameKeysFromSDKRequestToRESTRequest({});
+  const reqOpts = get(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(result.data);
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {},
+        singleArgumentUnchanged: false
+      },
+      []
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+async function updateSenderDetails(senderDetails) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = renameKeysFromSDKRequestToRESTRequest({
+    senderDetails
+  });
+  const reqOpts = update(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(result.data);
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { senderDetails: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["senderDetails"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+async function verifyEmail2(verificationCode) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = renameKeysFromSDKRequestToRESTRequest({
+    verificationCode
+  });
+  const reqOpts = verifyEmail(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(result.data);
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { verificationCode: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["verificationCode"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+async function resolveActualFromAddress2(fromAddress) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = renameKeysFromSDKRequestToRESTRequest({
+    fromAddress
+  });
+  const reqOpts = resolveActualFromAddress(
+    payload
+  );
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(result.data);
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { fromAddress: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["fromAddress"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+export {
+  WebhookIdentityType,
+  getSenderDetails,
+  resolveActualFromAddress2 as resolveActualFromAddress,
+  updateSenderDetails,
+  verifyEmail2 as verifyEmail
+};
+//# sourceMappingURL=index.typings.mjs.map