SevenShores\Hubspot\Resources\Engagements

Complexity

Total Complexity

10

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	13	1
A	recent()	0	8	1
A	update()	0	16	2
A	delete()	0	6	1
A	get()	0	6	1
A	all()	0	8	1
A	associate()	0	6	1
A	associated()	0	6	1
A	activityTypes()	0	6	1

<?php

namespace SevenShores\Hubspot\Resources;

use SevenShores\Hubspot\Exceptions\BadRequest;

class Engagements extends Resource
{
    /**
     * @param array $engagement Array of engagement engagement.
     * @param array $associations Array of engagement associations.
     * @param array $metadata Array of engagement metadata.
     * @param array $attachments Array of engagement attachments.
     * @return \SevenShores\Hubspot\Http\Response
     */
    function create($engagement, $associations, $metadata, $attachments = array())

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

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

        $options['json'] = [

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

            'engagement' => $engagement,
            'associations' => $associations,
            'metadata' => $metadata,
            'attachments' => $attachments
        ];

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

    /**
     * Returns all recently created or updated engagements.
     *
     * @param array $params Array of optional parameters ['count', 'offset', 'since]
     *
     * @see https://developers.hubspot.com/docs/methods/engagements/get-recent-engagements
     *
     * @return \SevenShores\Hubspot\Http\Response
     */
    function recent($params = [])

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

    {
        $endpoint = 'https://api.hubapi.com/engagements/v1/engagements/recent/modified';

        $queryString = build_query_string($params);

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

    /**
     * @param int $id The engagement id.
     * @param array $engagement The engagement engagement to update.
     * @param array $metadata The engagement metadata to update.
     * @param string $method
     * @return \SevenShores\Hubspot\Http\Response
     * @throws \SevenShores\Hubspot\Exceptions\BadRequest
     */
    function update($id, $engagement, $metadata, $method = 'patch')

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

    {
        $availableMethods = ['put', 'patch'];

        if (! \in_array($method, $availableMethods)) {
            throw new BadRequest('Method name '.$method.' is invalid', 400);
        }
        $endpoint = "https://api.hubapi.com/engagements/v1/engagements/{$id}";

        $options['json'] = [

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

            'engagement' => $engagement,
            'metadata' => $metadata,
        ];

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

    /**
     * @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/engagements/v1/engagements/{$id}";

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

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

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

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

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

    /**
     * Returns all engagements.
     *
     * @param array $params Array of optional parameters ['limit', 'offset']
     *
     * @see http://developers.hubspot.com/docs/methods/engagements/get-all-engagements
     *
     * @return \SevenShores\Hubspot\Http\Response
     */
    public function all($params = [])
    {
        $endpoint = 'https://api.hubapi.com/engagements/v1/engagements/paged';

        $queryString = build_query_string($params);

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

    /**
     * @param int $id
     * @param string $object_type
     * @param int $object_id
     * @return \SevenShores\Hubspot\Http\Response
     **/
    function associate($id, $object_type, $object_id)

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

    {
        $endpoint = "https://api.hubapi.com/engagements/v1/engagements/{$id}/associations/{$object_type}/{$object_id}";

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

    /**
     * @param string $object_type
     * @param int $object_id
     * @param array $params Array of optional parameters ['limit', 'offset']
     * @return \SevenShores\Hubspot\Http\Response
     **/
    function associated($object_type, $object_id, $params = [])

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

    {
        $endpoint = "https://api.hubapi.com/engagements/v1/engagements/associated/{$object_type}/{$object_id}/paged";
        $queryString = build_query_string($params);
        return $this->client->request('get', $endpoint, [], $queryString);
    }

    /**
     * @return \SevenShores\Hubspot\Http\Response
     */
    function activityTypes()

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

    {
        $endpoint = "https://api.hubapi.com/engagements/v1/activity-types";

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