README

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure OAuth2 access token for authorization: oauth2
$config = Rollout\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure API key authorization: private_apps
$config = Rollout\Client\Configuration::getDefaultConfiguration()->setApiKey('private-app', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Rollout\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('private-app', 'Bearer');


$apiInstance = new Rollout\Client\Api\BasicApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$contact_id = 'contact_id_example'; // string

try {
    $apiInstance->deleteCrmV3ObjectsContactsContactIdArchive($contact_id);
} catch (Exception $e) {
    echo 'Exception when calling BasicApi->deleteCrmV3ObjectsContactsContactIdArchive: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.hubapi.com

Class	Method	HTTP request	Description
BasicApi	deleteCrmV3ObjectsContactsContactIdArchive	DELETE /crm/v3/objects/contacts/{contactId}	Archive
BasicApi	getCrmV3ObjectsContactsContactIdGetById	GET /crm/v3/objects/contacts/{contactId}	Read
BasicApi	getCrmV3ObjectsContactsGetPage	GET /crm/v3/objects/contacts	List
BasicApi	patchCrmV3ObjectsContactsContactIdUpdate	PATCH /crm/v3/objects/contacts/{contactId}	Update
BasicApi	postCrmV3ObjectsContactsCreate	POST /crm/v3/objects/contacts	Create
BatchApi	postCrmV3ObjectsContactsBatchArchiveArchive	POST /crm/v3/objects/contacts/batch/archive	Archive a batch of contacts by ID
BatchApi	postCrmV3ObjectsContactsBatchCreateCreate	POST /crm/v3/objects/contacts/batch/create	Create a batch of contacts
BatchApi	postCrmV3ObjectsContactsBatchReadRead	POST /crm/v3/objects/contacts/batch/read	Read a batch of contacts by internal ID, or unique property values
BatchApi	postCrmV3ObjectsContactsBatchUpdateUpdate	POST /crm/v3/objects/contacts/batch/update	Update a batch of contacts
GDPRApi	postCrmV3ObjectsContactsGdprDeletePurge	POST /crm/v3/objects/contacts/gdpr-delete	GDPR DELETE
PublicObjectApi	postCrmV3ObjectsContactsMergeMerge	POST /crm/v3/objects/contacts/merge	Merge two contacts with same type
SearchApi	postCrmV3ObjectsContactsSearchDoSearch	POST /crm/v3/objects/contacts/search

Models

Authorization

Authentication schemes defined for the API:

oauth2_legacy

Type: OAuth
Flow: accessCode
Authorization URL: https://app.hubspot.com/oauth/authorize
Scopes:
- media_bridge.read: Read media and media events
- crm.objects.goals.read: Read goals
- tickets: Read and write tickets
- crm.objects.custom.read: View custom object records
- e-commerce: e-commerce
- crm.objects.custom.write: Change custom object records

oauth2

Type: OAuth
Flow: accessCode
Authorization URL: https://app.hubspot.com/oauth/authorize
Scopes:
- crm.objects.quotes.write: Quotes
- crm.objects.deals.read:
- crm.objects.line_items.read: Line Items
- crm.objects.deals.write:
- crm.objects.quotes.read: Quotes
- crm.objects.line_items.write: Line Items
- crm.objects.companies.read:
- crm.objects.companies.write:
- crm.objects.contacts.write:
- crm.objects.contacts.read:

private_apps_legacy

Type: API key
API key parameter name: private-app-legacy
Location: HTTP header

private_apps

Type: API key
API key parameter name: private-app
Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: v3
- Generator version: 7.7.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

mike-rollout / hubspot-php-client

Maintainers

Details