<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Represents a marketing channel for the multichannel-marketing feature.

[2] Fix | Delete

*

[3] Fix | Delete

* This interface will be implemented by third-party extensions to register themselves as marketing channels.

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

namespace Automattic\WooCommerce\Admin\Marketing;

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* MarketingChannelInterface interface

[10] Fix | Delete

*

[11] Fix | Delete

* @since x.x.x

[12] Fix | Delete

*/

[13] Fix | Delete

interface MarketingChannelInterface {

[14] Fix | Delete

public const PRODUCT_LISTINGS_NOT_APPLICABLE = 'not-applicable';

[15] Fix | Delete

public const PRODUCT_LISTINGS_SYNC_IN_PROGRESS = 'sync-in-progress';

[16] Fix | Delete

public const PRODUCT_LISTINGS_SYNC_FAILED = 'sync-failed';

[17] Fix | Delete

public const PRODUCT_LISTINGS_SYNCED = 'synced';

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Returns the unique identifier string for the marketing channel extension, also known as the plugin slug.

[21] Fix | Delete

*

[22] Fix | Delete

* @return string

[23] Fix | Delete

*/

[24] Fix | Delete

public function get_slug(): string;

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Returns the name of the marketing channel.

[28] Fix | Delete

*

[29] Fix | Delete

* @return string

[30] Fix | Delete

*/

[31] Fix | Delete

public function get_name(): string;

[32] Fix | Delete

[33] Fix | Delete

/**

[34] Fix | Delete

* Returns the description of the marketing channel.

[35] Fix | Delete

*

[36] Fix | Delete

* @return string

[37] Fix | Delete

*/

[38] Fix | Delete

public function get_description(): string;

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* Returns the path to the channel icon.

[42] Fix | Delete

*

[43] Fix | Delete

* @return string

[44] Fix | Delete

*/

[45] Fix | Delete

public function get_icon_url(): string;

[46] Fix | Delete

[47] Fix | Delete

/**

[48] Fix | Delete

* Returns the setup status of the marketing channel.

[49] Fix | Delete

*

[50] Fix | Delete

* @return bool

[51] Fix | Delete

*/

[52] Fix | Delete

public function is_setup_completed(): bool;

[53] Fix | Delete

[54] Fix | Delete

/**

[55] Fix | Delete

* Returns the URL to the settings page, or the link to complete the setup/onboarding if the channel has not been set up yet.

[56] Fix | Delete

*

[57] Fix | Delete

* @return string

[58] Fix | Delete

*/

[59] Fix | Delete

public function get_setup_url(): string;

[60] Fix | Delete

[61] Fix | Delete

/**

[62] Fix | Delete

* Returns the status of the marketing channel's product listings.

[63] Fix | Delete

*

[64] Fix | Delete

* @return string

[65] Fix | Delete

*/

[66] Fix | Delete

public function get_product_listings_status(): string;

[67] Fix | Delete

[68] Fix | Delete

/**

[69] Fix | Delete

* Returns the number of channel issues/errors (e.g. account-related errors, product synchronization issues, etc.).

[70] Fix | Delete

*

[71] Fix | Delete

* @return int The number of issues to resolve, or 0 if there are no issues with the channel.

[72] Fix | Delete

*/

[73] Fix | Delete

public function get_errors_count(): int;

[74] Fix | Delete

[75] Fix | Delete

/**

[76] Fix | Delete

* Returns an array of marketing campaign types that the channel supports.

[77] Fix | Delete

*

[78] Fix | Delete

* @return MarketingCampaignType[] Array of marketing campaign type objects.

[79] Fix | Delete

*/

[80] Fix | Delete

public function get_supported_campaign_types(): array;

[81] Fix | Delete

[82] Fix | Delete

/**

[83] Fix | Delete

* Returns an array of the channel's marketing campaigns.

[84] Fix | Delete

*

[85] Fix | Delete

* @return MarketingCampaign[]

[86] Fix | Delete

*/

[87] Fix | Delete

public function get_campaigns(): array;

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete