Skip to content

Commit

Permalink
Merge pull request #325 from HubSpot/feature/codereview
Browse files Browse the repository at this point in the history 
review Pages + test
  • Loading branch information
@ksvirkou-hubspot
ksvirkou-hubspot authored Aug 28, 2020
2 parents dc9a83e + 89248fc commit 8794b4a
Show file tree
Hide file tree
Showing 4 changed files with 175 additions and 107 deletions.
9 changes: 7 additions & 2 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]
- *nothing of note yet here*
## [Unreleased](https://github.com/HubSpot/hubspot-php/compare/v2.0.5...HEAD)

## [2.0.5]

### Changed
- removing list contacts by email address
- minor changes

## [2.0.3]

Expand Down
193 changes: 111 additions & 82 deletions src/Resources/Pages.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,233 +9,262 @@ class Pages extends Resource
*
* @param array $params optional Parameters
*
* @see https://legacydocs.hubspot.com/docs/methods/pages/post_pages
*
* @return \SevenShores\Hubspot\Http\Response
*/
public function create($params)
public function create(array $params)
{
$endpoint = 'https://api.hubapi.com/content/api/v2/pages';

$options['json'] = $params;

return $this->client->request('post', $endpoint, $options);
return $this->client->request('post', $endpoint, ['json' => $params]);
}

/**
* Get all pages.
*
* @param array $params optional parameters
*
* @see https://legacydocs.hubspot.com/docs/methods/pages/get_pages
*
* @return \SevenShores\Hubspot\Http\Response
*/
public function all($params = [])
public function all(array $params = [])
{
$endpoint = 'https://api.hubapi.com/content/api/v2/pages';

$queryString = build_query_string($params);

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

/**
* Update a page.
*
* @param int $page_id the page id
* @param array $params the page fields to update
* @param int $pageId the page id
* @param array $params the page fields to update
*
* @see https://legacydocs.hubspot.com/docs/methods/pages/put_pages_page_id
*
* @return \SevenShores\Hubspot\Http\Response
*/
public function update($page_id, $params)
public function update($pageId, array $params)
{
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$page_id}";

$options['json'] = $params;
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$pageId}";

return $this->client->request('put', $endpoint, $options);
return $this->client->request('put', $endpoint, ['json' => $params]);
}

/**
* Delete a page.
*
* @param int $page_id
* @param int $pageId
*
* @see https://legacydocs.hubspot.com/docs/methods/pages/delete_pages_page_id
*
* @return \SevenShores\Hubspot\Http\Response
*/
public function delete($page_id)
public function delete($pageId)
{
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$page_id}";
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$pageId}";

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

/**
* Get a specific page.
* Get a Page by ID.
*
* @param int $page_id
* @param int $pageId
*
* @see https://legacydocs.hubspot.com/docs/methods/pages/get_pages_page_id
*
* @return \SevenShores\Hubspot\Http\Response
*/
public function getById($page_id)
public function getById($pageId)
{
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$page_id}";
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$pageId}";

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

/**
* Updates the auto-save buffer.
* Clone the page.
*
* @param int $page_id The page ID
* @param array $params the auto-save buffer fields to update
* @param int $pageId The page ID
* @param string $name The cloned page name
*
* @see https://legacydocs.hubspot.com/docs/methods/pages/post_pages_page_id_clone
*
* @return \SevenShores\Hubspot\Http\Response
*/
public function updateAutoSaveBuffer($page_id, $params)
public function clonePage($pageId, $name)
{
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$page_id}/buffer";

$options['json'] = $params;
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$pageId}/clone";

return $this->client->request('put', $endpoint, $options);
return $this->client->request('post', $endpoint, ['json' => ['name' => $name]]);
}

/**
* Gets the current contents of the auto-save buffer.
* Either publishes or cancels publishing based on the POSTed JSON.
*
* @param int $page_id The page ID
* Allowable actions are: "push-buffer-live", "schedule-publish", "cancel-publish".
* "push-buffer-live": copies the current contents of the auto-save buffer into the live object.
* "schedule-publish": which pushes the buffer live and then sets up the content for publishing at
* the existing publish_date time.
* "cancel-publish": cancels a previous schedule-publish action.
*
* @param int $pageId The page ID
* @param string $action The publish action
*
* @see https://legacydocs.hubspot.com/docs/methods/pages/post_pages_page_id_publish_action
*
* @return \SevenShores\Hubspot\Http\Response
*/
public function getAutoSaveBufferContents($page_id)
public function publishAction($pageId, string $action)
{
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$page_id}/buffer";
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$pageId}/publish-action";

return $this->client->request('get', $endpoint);
return $this->client->request(
'post',
$endpoint,
['json' => ['action' => $action]]
);
}

/**
* Clone the page.
* Gets the current contents of the auto-save buffer.
*
* @param int $pageId The page ID
*
* @param int $page_id The page ID
* @param string $name The cloned page name
* @see https://legacydocs.hubspot.com/docs/methods/pages/get_pages_page_id_buffer
*
* @return \SevenShores\Hubspot\Http\Response
*/
public function clonePage($page_id, $name)
public function getAutoSaveBufferContents($pageId)
{
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$page_id}/clone";

$options['json'] = ['name' => $name];
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$pageId}/buffer";

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

/**
* Determine if the auto-save buffer differs from the live page.
* Updates the auto-save buffer.
*
* @param int $page_id The page ID
* @param int $pageId The page ID
* @param array $params the auto-save buffer fields to update
*
* @see https://legacydocs.hubspot.com/docs/methods/pages/put_pages_page_id_buffer
*
* @return \SevenShores\Hubspot\Http\Response
*/
public function hasBufferedChanges($page_id)
public function updateAutoSaveBuffer($pageId, array $params = [])
{
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$page_id}/has-buffered-changes";
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$pageId}/buffer";

return $this->client->request('get', $endpoint);
return $this->client->request('put', $endpoint, ['json' => $params]);
}

/**
* Either publishes or cancels publishing based on the POSTed JSON.
* Determine if the auto-save buffer differs from the live page.
*
* Allowable actions are: "push-buffer-live", "schedule-publish", "cancel-publish".
* "push-buffer-live": copies the current contents of the auto-save buffer into the live object.
* "schedule-publish": which pushes the buffer live and then sets up the content for publishing at
* the existing publish_date time.
* "cancel-publish": cancels a previous schedule-publish action.
* @param int $pageId The page ID
*
* @param int $page_id The page ID
* @param string $action The publish action
* @see https://legacydocs.hubspot.com/docs/methods/pages/get_pages_page_id_has_buffered_changes
*
* @return \SevenShores\Hubspot\Http\Response
*/
public function publishAction($page_id, $action)
public function hasBufferedChanges($pageId)
{
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$page_id}/publish-action";
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$pageId}/has-buffered-changes";

$options['json'] = ['action' => $action];

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

/**
* Copies the contents of the auto-save buffer into the live page.
*
* @param int $page_id The page ID
* @param int $pageId The page ID
*
* @see https://legacydocs.hubspot.com/docs/methods/pages/post_pages_page_id_push_buffer_live
*
* @return \SevenShores\Hubspot\Http\Response
*/
public function pushBufferLive($page_id)
public function pushBufferLive($pageId)
{
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$page_id}/push-buffer-live";
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$pageId}/push-buffer-live";

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

/**
* Restores a previously deleted page.
* Validates the auto-save buffer version of the page.
*
* @param int $pageId The page ID
*
* @param int $page_id The page ID
* @see https://legacydocs.hubspot.com/docs/methods/pages/post_pages_page_id_validate_buffer
*
* @return \SevenShores\Hubspot\Http\Response
*/
public function restoreDeleted($page_id)
public function validateBuffer($pageId)
{
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$page_id}/restore-deleted";
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$pageId}/validate-buffer";

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

/**
* Validates the auto-save buffer version of the page.
* Restores a previously deleted page.
*
* @param int $pageId The page ID
*
* @param int $page_id The page ID
* @see https://legacydocs.hubspot.com/docs/methods/pages/post_pages_page_id_restore_deleted
*
* @return \SevenShores\Hubspot\Http\Response
*/
public function validateBuffer($page_id)
public function restoreDeleted($pageId)
{
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$page_id}/validate-buffer";
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$pageId}/restore-deleted";

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

/**
* List previous versions of the page.
*
* @param int $page_id The page ID
* @param int $pageId The page ID
*
* @see https://legacydocs.hubspot.com/docs/methods/pages/get_pages_page_id_versions
*
* @return \SevenShores\Hubspot\Http\Response
*/
public function versions($page_id)
public function versions($pageId)
{
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$page_id}/versions";
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$pageId}/versions";

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

/**
* Restore a previous version of the page.
*
* @param int $page_id The page ID
* @param int $version_id The version ID
* @param int $pageId The page ID
* @param int $versionId The version ID
*
* @see https://legacydocs.hubspot.com/docs/methods/pages/post_pages_page_id_versions_restore
*
* @return \SevenShores\Hubspot\Http\Response
*/
public function restoreVersion($page_id, $version_id)
public function restoreVersion($pageId, $versionId)
{
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$page_id}/versions/restore";

$options['json'] = compact('version_id');
$endpoint = "https://api.hubapi.com/content/api/v2/pages/{$pageId}/versions/restore";

return $this->client->request('post', $endpoint, $options);
return $this->client->request(
'post',
$endpoint,
['json' => ['version_id' => $versionId]]
);
}
}
Loading

0 comments on commit 8794b4a

Please sign in to comment.