class MailchimpConnectedSites in Mailchimp 8

Mailchimp Connected Sites library.

@package Mailchimp

Hierarchy

• class \Mailchimp\Mailchimp
  • class \Mailchimp\MailchimpConnectedSites

See also

https://kb.mailchimp.com/integrations/connected-sites/about-connected-sites

2 string references to 'MailchimpConnectedSites'

MailchimpAdminSettingsForm::buildForm in src/Form/MailchimpAdminSettingsForm.php

Form constructor.

mailchimp_page_bottom in ./mailchimp.module

Implements hook_page_bottom().

File

lib/mailchimp-api-php/src/MailchimpConnectedSites.php, line 12

Namespace

Mailchimp

class MailchimpConnectedSites extends Mailchimp {

  /**
   * Gets information about all connected sites for the authenticated account.
   *
   * @param array $parameters
   *   Associative array of optional request parameters.
   *
   * @return object
   */
  public function getConnectedSites($parameters = []) {
    return $this
      ->request('GET', '/connected-sites', NULL, $parameters);
  }

  /**
   * Gets a connected site.
   *
   * @param string $connected_site_id
   *   The ID of the connected site.
   * @param array $parameters
   *   Associative array of optional request parameters.
   *
   * @return object
   */
  public function getConnectedSite($connected_site_id, $parameters = []) {
    $tokens = [
      'connected_site_id' => $connected_site_id,
    ];
    return $this
      ->request('GET', '/connected-sites/{connected_site_id}', $tokens, $parameters);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Mailchimp::$api_key	private	property	The Mailchimp API key to authenticate with.
Mailchimp::$api_user	private	property	The Mailchimp API username to authenticate with.
Mailchimp::$batch_operations	private	property	Array of pending batch operations.
Mailchimp::$client	protected	property	The HTTP client.
Mailchimp::$debug_error_code	private	property	A Mailchimp API error code to return with every API response.
Mailchimp::$endpoint	protected	property	The REST API endpoint.
Mailchimp::$version	public	property	API version.
Mailchimp::addBatchOperation	protected	function	Adds a pending batch operation.
Mailchimp::DEFAULT_DATA_CENTER		constant
Mailchimp::ERROR_CODE_API_KEY_INVALID		constant
Mailchimp::ERROR_CODE_API_KEY_MISSING		constant
Mailchimp::ERROR_CODE_BAD_REQUEST		constant
Mailchimp::ERROR_CODE_COMPLIANCE_RELATED		constant
Mailchimp::ERROR_CODE_FORBIDDEN		constant
Mailchimp::ERROR_CODE_INTERNAL_SERVER_ERROR		constant
Mailchimp::ERROR_CODE_INVALID_ACTION		constant
Mailchimp::ERROR_CODE_INVALID_METHOD_OVERRIDE		constant
Mailchimp::ERROR_CODE_INVALID_RESOURCE		constant
Mailchimp::ERROR_CODE_JSON_PARSE_ERROR		constant
Mailchimp::ERROR_CODE_METHOD_NOT_ALLOWED		constant
Mailchimp::ERROR_CODE_REQUESTED_FIELDS_INVALID		constant
Mailchimp::ERROR_CODE_RESOURCE_NESTING_TOO_DEEP		constant
Mailchimp::ERROR_CODE_RESOURCE_NOT_FOUND		constant
Mailchimp::ERROR_CODE_TOO_MANY_REQUESTS		constant
Mailchimp::ERROR_CODE_USER_DISABLED		constant
Mailchimp::ERROR_CODE_WRONG_DATACENTER		constant
Mailchimp::getAccount	public	function	Gets Mailchimp account information for the authenticated account.
Mailchimp::getBatchOperation	public	function	Gets the status of a batch request.
Mailchimp::getDataCenter	private	function	Gets the ID of the data center associated with an API key.
Mailchimp::getDefaultHttpClient	private	function	Instantiates a default HTTP client based on the local environment.
Mailchimp::processBatchOperations	public	function	Processes all pending batch operations.
Mailchimp::request	public	function	Makes a request to the Mailchimp API.
Mailchimp::setClient	public	function	Sets a custom HTTP client to be used for all API requests.
Mailchimp::setDebugErrorCode	public	function	Sets a Mailchimp error code to be returned by all requests.
Mailchimp::VERSION		constant
Mailchimp::__construct	public	function	Mailchimp constructor.	7
MailchimpConnectedSites::getConnectedSite	public	function	Gets a connected site.
MailchimpConnectedSites::getConnectedSites	public	function	Gets information about all connected sites for the authenticated account.