SevenShores\Hubspot\Resources\ContactLists

Complexity

Total Complexity

13

Size/Duplication

Total Lines	194
Duplicated Lines	13.92 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	8	1
A	update()	8	8	1
A	delete()	0	6	1
A	all()	0	8	1
A	getById()	0	6	1
A	getBatchByIds()	0	8	1
A	getAllStatic()	0	8	1
A	getAllDynamic()	0	8	1
A	contacts()	0	8	1
A	recentContacts()	0	8	1
A	refresh()	0	6	1
A	addContact()	11	11	1
A	removeContact()	8	8	1

<?php

namespace SevenShores\Hubspot\Resources;

class ContactLists extends Resource
{
    /**
     * Create a new contact list.
     *
     * @param array $list Contact list properties.
     * @return \SevenShores\Hubspot\Http\Response
     */
    function create($list)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = 'https://api.hubapi.com/contacts/v1/lists';

        $options['json'] = $list;

        return $this->client->request('post', $endpoint, $options);
    }

    /**
     * Update a contact list.
     *
     * @param int   $id   The contact list id.
     * @param array $list The contact list properties to update.
     * @return \SevenShores\Hubspot\Http\Response
     */
    function update($id, $list)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/contacts/v1/lists/{$id}";

        $options['json'] = $list;

        return $this->client->request('post', $endpoint, $options);
    }

    /**
     * Delete a contact list.
     *
     * @param int $id
     * @return \SevenShores\Hubspot\Http\Response
     */
    function delete($id)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/contacts/v1/lists/{$id}";

        return $this->client->request('delete', $endpoint);
    }

    /**
     * Get a set of contact lists.
     *
     * @param array $params ['count', 'offset']
     * @return \SevenShores\Hubspot\Http\Response
     */
    function all($params = [])

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/contacts/v1/lists";

        $queryString = build_query_string($params);

        return $this->client->request('get', $endpoint, [], $queryString);
    }

    /**
     * @param int $id
     * @return \SevenShores\Hubspot\Http\Response
     */
    function getById($id)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/contacts/v1/lists/{$id}";

        return $this->client->request('get', $endpoint);
    }

    /**
     * @param array $ids
     * @return \SevenShores\Hubspot\Http\Response
     */
    function getBatchByIds($ids)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/contacts/v1/lists/batch";

        $queryString = build_query_string(['listId' => $ids]);

        return $this->client->request('get', $endpoint, [], $queryString);
    }

    /**
     * @param array $params Optional parameters ['count', 'offset']
     * @return \SevenShores\Hubspot\Http\Response
     */
    function getAllStatic($params = [])

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/contacts/v1/lists/static";

        $queryString = build_query_string($params);

        return $this->client->request('get', $endpoint, [], $queryString);
    }

    /**
     * @param array $params Optional parameters ['count', 'offset']
     * @return \SevenShores\Hubspot\Http\Response
     */
    function getAllDynamic($params = [])

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/contacts/v1/lists/dynamic";

        $queryString = build_query_string($params);

        return $this->client->request('get', $endpoint, [], $queryString);
    }

    /**
     * Get contacts in a list.
     *
     * @param int   $id     List id
     * @param array $params Optional parameters
     *                      { count, vidOffset, property, propertyMode, formSubmissionMode, showListMemberships }
     * @return \SevenShores\Hubspot\Http\Response
     */
    function contacts($id, $params = [])

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/contacts/v1/lists/{$id}/contacts/all";

        $queryString = build_query_string($params);

        return $this->client->request('get', $endpoint, [], $queryString);
    }

    /**
     * Get recently added contact from a list.
     *
     * @param int   $id List id
     * @param array $params
     * @return \SevenShores\Hubspot\Http\Response
     */
    function recentContacts($id, $params = [])

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/contacts/v1/lists/{$id}/contacts/recent";

        $queryString = build_query_string($params);

        return $this->client->request('get', $endpoint, [], $queryString);
    }

    /**
     * Refresh a list.
     *
     * @param int $id List id
     * @return \SevenShores\Hubspot\Http\Response
     */
    function refresh($id)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/contacts/v1/lists/{$id}/refresh";

        return $this->client->request('post', $endpoint);
    }

    /**
     * Add a contact to a list.
     *
     * @param int   $list_id
     * @param array $contact_ids
     * @param array $emails
     * @return \SevenShores\Hubspot\Http\Response
     */
    function addContact($list_id, $contact_ids, $emails = [])

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/contacts/v1/lists/{$list_id}/add";

        $options['json'] = [

$options was never initialized. Although not strictly required by PHP, it is generally a good practice to add $options = array(); before regardless.

          'vids' => $contact_ids,
          'emails' => $emails,
        ];

        return $this->client->request('post', $endpoint, $options);
    }

    /**
     * Remove a contact from a list.
     *
     * @param int   $list_id
     * @param array $contact_ids
     * @return \SevenShores\Hubspot\Http\Response
     */
    function removeContact($list_id, $contact_ids)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/contacts/v1/lists/{$list_id}/remove";

        $options['json'] = ['vids' => $contact_ids];

        return $this->client->request('post', $endpoint, $options);
    }

}