SevenShores\Hubspot\Resources\EcommerceBridge

Complexity

Total Complexity

11

Size/Duplication

Total Lines	169
Duplicated Lines	15.38 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	install()	0	6	1
A	checkInstall()	0	6	1
A	uninstall()	0	6	1
A	upsertSettings()	0	8	1
A	deleteSettings()	0	6	1
A	sendSyncMessages()	8	8	1
A	getSyncErrors()	0	6	1
A	setImportUri()	10	10	1
A	getImportSettings()	0	6	1
A	importObjects()	8	8	1
A	signalImportEnd()	0	11	1

<?php

namespace SevenShores\Hubspot\Resources;

class EcommerceBridge extends Resource
{
    /**
     * Installs the ecommerce bridge into a portal.
     *
     * @return \SevenShores\Hubspot\Http\Response
     * @throws \SevenShores\Hubspot\Exceptions\BadRequest
     */
    function install()

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

    {
        $endpoint = 'https://api.hubapi.com/extensions/ecomm/v1/installs';

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

    /**
     * Check the status of the ecommerce bridge.
     *
     * @return \SevenShores\Hubspot\Http\Response
     * @throws \SevenShores\Hubspot\Exceptions\BadRequest
     */
    function checkInstall()

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

    {
        $endpoint = 'https://api.hubapi.com/extensions/ecomm/v1/installs/status';

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

    /**
     * Uninstall the ecommerce settings from a portal.
     *
     * @return \SevenShores\Hubspot\Http\Response
     * @throws \SevenShores\Hubspot\Exceptions\BadRequest
     */
    function uninstall()

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

    {
        $endpoint = 'https://api.hubapi.com/extensions/ecomm/v1/installs/uninstall';

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

    /**
     * Create or update the ecommerce settings.
     *
     * @param  array $settings
     * @return \SevenShores\Hubspot\Http\Response
     * @throws \SevenShores\Hubspot\Exceptions\BadRequest
     */
    function upsertSettings($settings = [])

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

    {
        $endpoint = 'https://api.hubapi.com/extensions/ecomm/v1/settings';

        $options['json'] = $settings;

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

    /**
     * Delete the ecommerce settings for your app or portal.
     * Note: This action cannot be undone. If you want to disable sync messages from being applied, it is recommended that you disable the settings rather than deleting them.
     *
     * @return \SevenShores\Hubspot\Http\Response
     * @throws \SevenShores\Hubspot\Exceptions\BadRequest
     */
    function deleteSettings()

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

    {
        $endpoint = 'https://api.hubapi.com/extensions/ecomm/v1/settings';

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

    /**
     * Send a group of sync messages for a specific object type. Sync messages would be notifications of creates, updates, or deletes of ecommerce objects.
     *
     * @param  string $objectType - The object type that the updates are for. One of CONTACT, DEAL, PRODUCT, or LINE_ITEM.
     * @param  array  $messages
     * @return \SevenShores\Hubspot\Http\Response
     * @throws \SevenShores\Hubspot\Exceptions\BadRequest
     */
    function sendSyncMessages($objectType, $messages = [])

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

    {
        $endpoint = "https://api.hubapi.com/extensions/ecomm/v1/sync-messages/{$objectType}";

        $options['json'] = $messages;

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

    /**
     * Get errors from previously processed sync messages.
     *
     * @return \SevenShores\Hubspot\Http\Response
     * @throws \SevenShores\Hubspot\Exceptions\BadRequest
     */
    function getSyncErrors()

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

    {
        $endpoint = 'https://api.hubapi.com/extensions/ecomm/v1/sync-errors';

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

    /**
     * Set the URI for the import initialization webhook.
     *
     * @param  string $importTriggerUri - The URI that will be hit with the import webhook.
     * @return \SevenShores\Hubspot\Http\Response
     * @throws \SevenShores\Hubspot\Exceptions\BadRequest
     */
    function setImportUri($importTriggerUri)

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

    {
        $endpoint = 'https://api.hubapi.com/extensions/ecomm/v1/import-settings';

        $options['json'] = [

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

            'importTriggerUri' => $importTriggerUri
        ];

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

    /**
     * Retrieve the ecommerce import settings for an app.
     *
     * @return \SevenShores\Hubspot\Http\Response
     * @throws \SevenShores\Hubspot\Exceptions\BadRequest
     */
    function getImportSettings()

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

    {
        $endpoint = 'https://api.hubapi.com/extensions/ecomm/v1/import-settings';

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

    /**
     * @param  int    $importStartedAt - Timestamp from the import initialization request
     * @param  string $objectType      - The object type this data corresponds to. Must be one of CONTACT, DEAL, LINE_ITEM, or PRODUCT.
     * @param  int    $pageNumber      - A numeric page number that identifies this page of data
     * @param  array  $messages        - The import messages
     * @return \SevenShores\Hubspot\Http\Response
     * @throws \SevenShores\Hubspot\Exceptions\BadRequest
     */
    function importObjects($importStartedAt, $objectType, $pageNumber, $messages)

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

    {
        $endpoint = "https://api.hubapi.com/import-pages/{$importStartedAt}/{$objectType}/{$pageNumber}";

        $options['json'] = $messages;

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

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

    /**
     * @param  int    $importStartedAt - Timestamp from the import initialization request
     * @param  string $objectType      - The object type this data corresponds to. Must be one of CONTACT, DEAL, LINE_ITEM, or PRODUCT.
     * @param  int    $pageCount       - The total number of pages sent via the import pages endpoint.
     * @param  int    $itemCount       - The total number of items sent via the import pages endpoint.
     * @return \SevenShores\Hubspot\Http\Response
     * @throws \SevenShores\Hubspot\Exceptions\BadRequest
     */
    function signalImportEnd($importStartedAt, $objectType, $pageCount, $itemCount)

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

    {
        $endpoint = "https://api.hubapi.com/import-pages/{$importStartedAt}/{$objectType}/end";

        $options['json'] = [

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

            'pageCount' => $pageCount,
            'itemCount' => $itemCount
        ];

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