Skip to content

deployAddressSettingsXml

deployAddressSettingsXml(options): Promise<AddressSettingsDeployResult>

Defined in: packages/simply-settings-core/src/address/addressSettingsTransfer.ts:102

Deploys Address.settings-meta.xml content to the org and polls to completion.

Does not throw on a failed deploy — the failure is reported in the result (success: false, populated failures). An error here means the deploy request or polling itself broke.

AddressSettingsTransferOptions & object

The org connection, the settings XML, and how long to wait.

Promise<AddressSettingsDeployResult>

The deploy’s id, terminal status, and component failures.