Rename 'Deposit' to 'Payout' (feature branch) (#9606)

Co-authored-by: Nagesh Pai <4162931+nagpai@users.noreply.github.com> Co-authored-by: Nagesh Pai <nagesh.pai@automattic.com> Co-authored-by: bruce aldridge <bruce.aldridge@gmail.com> Co-authored-by: Rua Haszard <rua.haszard@automattic.com> Co-authored-by: Rua Haszard <rua@automattic.com> Co-authored-by: Jessy Pappachan <32092402+jessy-p@users.noreply.github.com> Co-authored-by: Jessy <jessy.pappachan@automattic.com> Co-authored-by: Eric Jinks <3147296+Jinksi@users.noreply.github.com>
Automattic · Nov 10, 2024 · daf79d5 · daf79d5
1 parent 75a11d0
commit daf79d5
Show file tree

Hide file tree

Showing 122 changed files with 1,060 additions and 660 deletions.
diff --git a/changelog/add-9673-payouts-rename-notice b/changelog/add-9673-payouts-rename-notice
@@ -0,0 +1,5 @@
+Significance: patch
+Type: add
+Comment: Added notice to indicate the rename of Deposits to Payouts. User facing changelog will be added as part of feature branch
+
+
diff --git a/changelog/dev-1-9601-rename-deposit-dev-docs b/changelog/dev-1-9601-rename-deposit-dev-docs
@@ -0,0 +1,5 @@
+Significance: patch
+Type: dev
+Comment: Rename 'deposit' to 'payout' within the developer doc description texts. The change is a part of a larger renaming project.
+
+
diff --git a/changelog/feature-deposits-payouts-rename b/changelog/feature-deposits-payouts-rename
@@ -0,0 +1,4 @@
+Significance: minor
+Type: update
+
+Rename 'deposit' to 'payout' across various places in the WooPayments admin UI, docs and doc URLs.
diff --git a/changelog/fix-9525-menu-url-payouts-rename b/changelog/fix-9525-menu-url-payouts-rename
@@ -0,0 +1,5 @@
+Significance: patch
+Type: dev
+Comment: Part of feature Renaming deposits to payouts
+
+
diff --git a/changelog/fix-9527-payouts-rename-settings b/changelog/fix-9527-payouts-rename-settings
@@ -0,0 +1,5 @@
+Significance: patch
+Type: dev
+Comment: Payouts rename: Settings page, part of a larger change
+
+
diff --git a/changelog/fix-9542-rename-payouts-instant-depost-modal-flow b/changelog/fix-9542-rename-payouts-instant-depost-modal-flow
@@ -0,0 +1,5 @@
+Significance: patch
+Type: dev
+Comment: Part of a larger change - renaming deposit to payout; this PR fixes instant payout modal + button
+
+
diff --git a/changelog/fix-9573-rename-payout-tos-modal b/changelog/fix-9573-rename-payout-tos-modal
@@ -0,0 +1,5 @@
+Significance: patch
+Type: dev
+Comment: Rename Deposit to Payout in TOS modal. Changelog to be included in featture branch
+
+
diff --git a/changelog/fix-9585-rename-instant-payouts b/changelog/fix-9585-rename-instant-payouts
@@ -0,0 +1,5 @@
+Significance: patch
+Type: update
+Comment: Renamed instant deposit to instant payout. Main changelog will be part of feature branch
+
+
diff --git a/changelog/fix-9588-rename-payouts-error-messages b/changelog/fix-9588-rename-payouts-error-messages
@@ -0,0 +1,5 @@
+Significance: patch
+Type: update
+Comment: Updated the payouts component error notices. User facing changelog will be on the feature branch.
+
+
diff --git a/changelog/fix-payout-rename-account-errors b/changelog/fix-payout-rename-account-errors
@@ -0,0 +1,5 @@
+Significance: patch
+Type: dev
+Comment: Renamed deposit to Payout in account error messages. Main changelog will be added on feature branch.
+
+
diff --git a/changelog/update-9524-deposit-payout-deposits-list b/changelog/update-9524-deposit-payout-deposits-list
@@ -0,0 +1,5 @@
+Significance: patch
+Type: dev
+Comment: Change deposit to payout in deposits list page.
+
+
diff --git a/changelog/update-9543-transactions-list-deposit-to-payout-rename b/changelog/update-9543-transactions-list-deposit-to-payout-rename
@@ -0,0 +1,5 @@
+Significance: patch
+Type: update
+Comment: Update 'deposit' to 'payout' in UI labels of the transaction list. This PR is a part of a project doing this rename across all parts of the UI.
+
+
diff --git a/changelog/update-9564-transaction-timeline-deposit-to-payout-rename b/changelog/update-9564-transaction-timeline-deposit-to-payout-rename
@@ -0,0 +1,5 @@
+Significance: patch
+Type: update
+Comment: Part of a larger change to change 'deposit' to 'payout'. This PR specificially changes it for the transaction details timeline.
+
+
diff --git a/changelog/update-9578-79-rename-deposit-overview-modal b/changelog/update-9578-79-rename-deposit-overview-modal
@@ -0,0 +1,5 @@
+Significance: patch
+Type: update
+Comment: Rename 'deposit' to 'payout' in modals within 'Overview' section. PR is a part of a larger renaming project.
+
+
diff --git a/changelog/update-9581-rename-deposit-onboarding-tasklist b/changelog/update-9581-rename-deposit-onboarding-tasklist
@@ -0,0 +1,5 @@
+Significance: patch
+Type: update
+Comment: Rename 'deposit' to 'payout' within the onboarding tasklist section. The change is a part of a larger project of doing this rename across the codebase.
+
+
diff --git a/changelog/update-9587-doc-url-payout-rename b/changelog/update-9587-doc-url-payout-rename
@@ -0,0 +1,5 @@
+Significance: patch
+Type: update
+Comment: Update 'deposit' to 'payout' in URLs of WooPayments docs occuring across the codebase. Part of a larger renaming project.
+
+
diff --git a/client/components/account-balances/balance-tooltip.tsx b/client/components/account-balances/balance-tooltip.tsx
@@ -36,7 +36,7 @@ export const TotalBalanceTooltip: React.FC< TotalBalanceTooltipProps > = ( {
 					<>
 						{ interpolateComponents( {
 							mixedString: __(
-								'{{bold}}Total balance{{/bold}} combines both pending funds (transactions under processing) and available funds (ready for deposit). {{learnMoreLink}}Learn more{{/learnMoreLink}}',
+								'{{bold}}Total balance{{/bold}} combines both pending funds (transactions under processing) and available funds (ready for payout). {{learnMoreLink}}Learn more{{/learnMoreLink}}',
 								'woocommerce-payments'
 							),
 							components: {
@@ -105,7 +105,7 @@ export const AvailableBalanceTooltip: React.FC< AvailableBalanceTooltipProps > =
 					<p>
 						{ interpolateComponents( {
 							mixedString: __(
-								'{{bold}}Available funds{{/bold}} have completed processing and are ready to be deposited into your bank account. {{learnMoreLink}}Learn more{{/learnMoreLink}}',
+								'{{bold}}Available funds{{/bold}} have completed processing and are ready to be dispatched to your bank account. {{learnMoreLink}}Learn more{{/learnMoreLink}}',
 								'woocommerce-payments'
 							),
 							components: {

diff --git a/client/components/account-balances/index.tsx b/client/components/account-balances/index.tsx
@@ -15,7 +15,7 @@ import type * as AccountOverview from 'wcpay/types/account-overview';
 import BalanceBlock from './balance-block';
 import HelpOutlineIcon from 'gridicons/dist/help-outline';
 import InlineNotice from '../inline-notice';
-import InstantDepositButton from 'deposits/instant-deposits';
+import InstantPayoutButton from 'wcpay/deposits/instant-payouts';
 import SendMoneyIcon from 'assets/images/icons/send-money.svg?asset';
 import {
 	TotalBalanceTooltip,
@@ -154,9 +154,8 @@ const AccountBalances: React.FC = () => {
 							>
 								{ sprintf(
 									__(
-										/* translators: %$1$s: Available instant deposit amount, %2$s: Instant deposit fee percentage */
-										/* 'Instantly deposit %1$s and get funds in your bank account in 30 mins for a %2$s%% fee.' */
-										'Get %1$s via instant deposit. Funds are typically in your bank account within 30 mins. Fee: %2$s%%.',
+										/* translators: %$1$s: Available instant payout amount, %2$s: Instant payout fee percentage */
+										'Get %1$s via instant payout. Funds are typically in your bank account within 30 mins. Fee: %2$s%%.',
 										'woocommerce-payments'
 									),
 									formatCurrency(
@@ -170,7 +169,7 @@ const AccountBalances: React.FC = () => {
 						) }
 
 						<Flex justify="flex-start">
-							<InstantDepositButton
+							<InstantPayoutButton
 								instantBalance={
 									selectedOverview.instantBalance
 								}
@@ -179,17 +178,17 @@ const AccountBalances: React.FC = () => {
 								<ClickTooltip
 									buttonIcon={ <HelpOutlineIcon /> }
 									buttonLabel={ __(
-										'Learn more about instant deposit',
+										'Learn more about instant payouts',
 										'woocommerce-payments'
 									) }
 									content={
-										/* 'With instant deposit you can receive requested funds in your bank account within 30 mins for a 1.5% fee. Learn more' */
+										/* 'With instant payout you can receive requested funds in your bank account within 30 mins for a 1.5% fee. Learn more' */
 
 										interpolateComponents( {
 											mixedString: sprintf(
 												__(
-													/* translators: %s: Instant deposit fee percentage */
-													'With {{strong}}instant deposit{{/strong}} you can receive requested funds in your bank account within 30 mins for a %s%% fee. {{learnMoreLink}}Learn more{{/learnMoreLink}}',
+													/* translators: %s: Instant payout fee percentage */
+													'With {{strong}}instant payout{{/strong}} you can receive requested funds in your bank account within 30 mins for a %s%% fee. {{learnMoreLink}}Learn more{{/learnMoreLink}}',
 													'woocommerce-payments'
 												),
 												selectedOverview.instantBalance
@@ -199,7 +198,7 @@ const AccountBalances: React.FC = () => {
 												strong: <strong />,
 												learnMoreLink: (
 													<Link
-														href="https://woocommerce.com/document/woopayments/deposits/instant-deposits/"
+														href="https://woocommerce.com/document/woopayments/payouts/instant-payouts/"
 														target="_blank"
 														rel="noreferrer"
 														type="external"

diff --git a/client/components/account-balances/strings.ts b/client/components/account-balances/strings.ts
@@ -26,7 +26,7 @@ export const fundLabelStrings = {
 
 export const documentationUrls = {
 	depositSchedule:
-		'https://woocommerce.com/document/woopayments/deposits/deposit-schedule/',
+		'https://woocommerce.com/document/woopayments/payouts/payout-schedule/',
 	negativeBalance:
 		'https://woocommerce.com/document/woopayments/fees-and-debits/account-showing-negative-balance/',
 };
diff --git a/client/components/account-balances/test/index.test.tsx b/client/components/account-balances/test/index.test.tsx
@@ -231,11 +231,11 @@ describe( 'AccountBalances', () => {
 		} );
 		fireEvent.click( tooltipButton );
 		const tooltip = screen.getByRole( 'tooltip', {
-			name: /Available funds have completed processing and are ready to be deposited into your bank account./,
+			name: /Available funds have completed processing and are ready to be dispatched to your bank account./,
 		} );
 		expect( within( tooltip ).getByRole( 'link' ) ).toHaveAttribute(
 			'href',
-			'https://woocommerce.com/document/woopayments/deposits/deposit-schedule/'
+			'https://woocommerce.com/document/woopayments/payouts/payout-schedule/'
 		);
 	} );
 
@@ -289,11 +289,11 @@ describe( 'AccountBalances', () => {
 		} );
 		fireEvent.click( tooltipButton );
 		const tooltip = screen.getByRole( 'tooltip', {
-			name: /Total balance combines both pending funds \(transactions under processing\) and available funds \(ready for deposit\)\./,
+			name: /Total balance combines both pending funds \(transactions under processing\) and available funds \(ready for payout\)\./,
 		} );
 		expect( within( tooltip ).getByRole( 'link' ) ).toHaveAttribute(
 			'href',
-			'https://woocommerce.com/document/woopayments/deposits/deposit-schedule/'
+			'https://woocommerce.com/document/woopayments/payouts/payout-schedule/'
 		);
 	} );
 

diff --git a/client/components/account-status/account-tools/strings.tsx b/client/components/account-status/account-tools/strings.tsx
@@ -17,7 +17,7 @@ export default {
 				'woocommerce-payments'
 		  )
 		: __(
-				'Payments and deposits are disabled until account setup is completed. If you are experiencing problems completing account setup, or need to change the email/country associated with your account, you can reset your account and start from the beginning.',
+				'Payments and payouts are disabled until account setup is completed. If you are experiencing problems completing account setup, or need to change the email/country associated with your account, you can reset your account and start from the beginning.',
 				'woocommerce-payments'
 		  ),
 	reset: __( 'Reset account', 'woocommerce-payments' ),

diff --git a/client/components/account-status/account-tools/test/__snapshots__/index.test.tsx.snap b/client/components/account-status/account-tools/test/__snapshots__/index.test.tsx.snap
@@ -18,7 +18,7 @@ exports[`AccountTools should render in test/sandbox mode onboarding 1`] = `
       Account Tools
     </h4>
     <p>
-      Payments and deposits are disabled until account setup is completed. If you are experiencing problems completing account setup, or need to change the email/country associated with your account, you can reset your account and start from the beginning.
+      Payments and payouts are disabled until account setup is completed. If you are experiencing problems completing account setup, or need to change the email/country associated with your account, you can reset your account and start from the beginning.
     </p>
     <div
       class="account-tools__actions"

diff --git a/client/components/account-status/index.js b/client/components/account-status/index.js
@@ -112,7 +112,7 @@ const AccountStatusDetails = ( props ) => {
 				/>
 			</AccountStatusItem>
 			<AccountStatusItem
-				label={ __( 'Deposits:', 'woocommerce-payments' ) }
+				label={ __( 'Payouts:', 'woocommerce-payments' ) }
 			>
 				<DepositsStatus
 					status={ accountStatus.deposits?.status }

diff --git a/client/components/account-status/status-chip.js b/client/components/account-status/status-chip.js
@@ -34,7 +34,7 @@ const StatusChip = ( props ) => {
 		description = __( 'Pending', 'woocommerce-payments' );
 		type = 'light';
 		tooltip = __(
-			'Deposits are pending while Stripe verifies details on your account.',
+			'Payouts are pending while Stripe verifies details on your account.',
 			'woocommerce-payments'
 		);
 	} else if ( accountStatus === 'restricted_partially' ) {

diff --git a/client/components/account-status/test/__snapshots__/index.js.snap b/client/components/account-status/test/__snapshots__/index.js.snap
@@ -86,7 +86,7 @@ exports[`AccountStatus does not render edit details when no account link 1`] = `
             data-wp-c16t="true"
             data-wp-component="FlexItem"
           >
-            Deposits:
+            Payouts:
           </div>
           <div
             class="components-flex-item components-flex-block item-value css-14wzr73-View-Item-sx-Base-block em57xhy0"
@@ -254,7 +254,7 @@ exports[`AccountStatus renders account tools 1`] = `
             data-wp-c16t="true"
             data-wp-component="FlexItem"
           >
-            Deposits:
+            Payouts:
           </div>
           <div
             class="components-flex-item components-flex-block item-value css-14wzr73-View-Item-sx-Base-block em57xhy0"
@@ -295,7 +295,7 @@ exports[`AccountStatus renders account tools 1`] = `
             Account Tools
           </h4>
           <p>
-            Payments and deposits are disabled until account setup is completed. If you are experiencing problems completing account setup, or need to change the email/country associated with your account, you can reset your account and start from the beginning.
+            Payments and payouts are disabled until account setup is completed. If you are experiencing problems completing account setup, or need to change the email/country associated with your account, you can reset your account and start from the beginning.
           </p>
           <div
             class="account-tools__actions"
@@ -490,7 +490,7 @@ exports[`AccountStatus renders normal status 1`] = `
             data-wp-c16t="true"
             data-wp-component="FlexItem"
           >
-            Deposits:
+            Payouts:
           </div>
           <div
             class="components-flex-item components-flex-block item-value css-14wzr73-View-Item-sx-Base-block em57xhy0"

diff --git a/client/components/deposits-overview/deposit-notices.tsx b/client/components/deposits-overview/deposit-notices.tsx
@@ -29,15 +29,15 @@ export const SuspendedDepositNotice: React.FC = () => {
 			{ interpolateComponents( {
 				/** translators: {{strong}}: placeholders are opening and closing strong tags. {{suspendLink}}: is a <a> link element */
 				mixedString: __(
-					'Your deposits are {{strong}}temporarily suspended{{/strong}}. {{suspendLink}}Learn more{{/suspendLink}}',
+					'Your payouts are {{strong}}temporarily suspended{{/strong}}. {{suspendLink}}Learn more{{/suspendLink}}',
 					'woocommerce-payments'
 				),
 				components: {
 					strong: <strong />,
 					suspendLink: (
 						<Link
 							href={
-								'https://woocommerce.com/document/woopayments/deposits/why-deposits-suspended/'
+								'https://woocommerce.com/document/woopayments/payouts/why-payouts-suspended/'
 							}
 						/>
 					),
@@ -54,7 +54,7 @@ export const DepositIncludesLoanPayoutNotice: React.FC = () => (
 	<InlineNotice icon status="warning" isDismissible={ false }>
 		{ interpolateComponents( {
 			mixedString: __(
-				'This deposit will include funds from your WooCommerce Capital loan. {{learnMoreLink}}Learn more{{/learnMoreLink}}',
+				'This payout will include funds from your WooCommerce Capital loan. {{learnMoreLink}}Learn more{{/learnMoreLink}}',
 				'woocommerce-payments'
 			),
 			components: {
@@ -86,7 +86,7 @@ export const NewAccountWaitingPeriodNotice: React.FC = () => (
 	>
 		{ interpolateComponents( {
 			mixedString: __(
-				'Your first deposit is held for 7-14 days. {{whyLink}}Why?{{/whyLink}}',
+				'Your first payout is held for 7-14 days. {{whyLink}}Why?{{/whyLink}}',
 				'woocommerce-payments'
 			),
 			components: {
@@ -96,7 +96,7 @@ export const NewAccountWaitingPeriodNotice: React.FC = () => (
 					<a
 						target="_blank"
 						rel="noopener noreferrer"
-						href="https://woocommerce.com/document/woopayments/deposits/deposit-schedule/#new-accounts"
+						href="https://woocommerce.com/document/woopayments/payouts/payout-schedule/#new-accounts"
 					/>
 				),
 			},
@@ -114,7 +114,7 @@ export const DepositTransitDaysNotice: React.FC = () => (
 		className="wcpay-deposit-transit-days-notice"
 	>
 		{ __(
-			'It may take 1-3 business days for deposits to reach your bank account.',
+			'It may take 1-3 business days for payouts to reach your bank account.',
 			'woocommerce-payments'
 		) }
 	</InlineNotice>
@@ -134,7 +134,7 @@ export const NegativeBalanceDepositsPausedNotice: React.FC = () => (
 			mixedString: sprintf(
 				/* translators: %s: WooPayments */
 				__(
-					'Deposits may be interrupted while your %s balance remains negative. {{whyLink}}Why?{{/whyLink}}',
+					'Payouts may be interrupted while your %s balance remains negative. {{whyLink}}Why?{{/whyLink}}',
 					'woocommerce-payments'
 				),
 				'WooPayments'
@@ -169,7 +169,7 @@ export const DepositMinimumBalanceNotice: React.FC< {
 				mixedString: sprintf(
 					/* translators: %s: a formatted currency amount, e.g. $5.00 USD */
 					__(
-						'Deposits are paused while your available funds balance remains below %s. {{learnMoreLink}}Learn more{{/learnMoreLink}}',
+						'Payouts are paused while your available funds balance remains below %s. {{learnMoreLink}}Learn more{{/learnMoreLink}}',
 						'woocommerce-payments'
 					),
 					minimumDepositAmountFormatted
@@ -181,7 +181,7 @@ export const DepositMinimumBalanceNotice: React.FC< {
 						<a
 							target="_blank"
 							rel="noopener noreferrer"
-							href="https://woocommerce.com/document/woopayments/deposits/deposit-schedule/#minimum-deposit-amounts"
+							href="https://woocommerce.com/document/woopayments/payouts/payout-schedule/#minimum-payout-amounts"
 						/>
 					),
 				},
@@ -197,7 +197,7 @@ export const NoFundsAvailableForDepositNotice: React.FC = () => (
 	<InlineNotice status="warning" icon isDismissible={ false }>
 		{ interpolateComponents( {
 			mixedString: __(
-				'You have no funds available to deposit. {{whyLink}}Why?{{/whyLink}}',
+				'You have no funds available. {{whyLink}}Why?{{/whyLink}}',
 				'woocommerce-payments'
 			),
 			components: {
@@ -207,7 +207,7 @@ export const NoFundsAvailableForDepositNotice: React.FC = () => (
 					<a
 						target="_blank"
 						rel="noopener noreferrer"
-						href="https://woocommerce.com/document/woopayments/deposits/deposit-schedule/#pending-funds"
+						href="https://woocommerce.com/document/woopayments/payouts/payout-schedule/#pending-funds"
 					/>
 				),
 			},
@@ -240,7 +240,7 @@ export const DepositFailureNotice: React.FC< {
 		>
 			{ interpolateComponents( {
 				mixedString: __(
-					'Deposits are currently paused because a recent deposit failed. Please {{updateLink}}update your bank account details{{/updateLink}}.',
+					'Payouts are currently paused because a recent payout failed. Please {{updateLink}}update your bank account details{{/updateLink}}.',
 					'woocommerce-payments'
 				),
 				components: {