npm package: @kulbir134/hubspot_api
Description: It_contains_APIs_for_Hubspot_actions_and_trigger
Latest version: 1.0.0

# hubspot_api

HubspotApi - JavaScript client for hubspot_api
It contains API's for Hubspot actions and trigger
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install hubspot_api --save
```

##### Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing 
into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
npm link
```

Finally, switch to the directory you want to use your hubspot_api from, and run:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

You should now be able to `require('hubspot_api')` in javascript files from the directory you ran the last 
command above from.

#### git
#
If the library is hosted at a git repository, e.g.
https://github.com/YOUR_USERNAME/hubspot_api
then install it via:

```shell
    npm install YOUR_USERNAME/hubspot_api --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually 
use this library):

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

### Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var HubspotApi = require('hubspot_api');

var defaultClient = HubspotApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['hapikey'] = "Token"

// Configure OAuth2 access token for authorization: auth
var auth = defaultClient.authentications['auth'];
auth.accessToken = "YOUR ACCESS TOKEN"

var api = new HubspotApi.DefaultApi()

var body = new HubspotApi.Company(); // {Company} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCompanyAction(body, callback);

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*HubspotApi.DefaultApi* | [**createCompanyAction**](docs/DefaultApi.md#createCompanyAction) | **POST** /companies/v2/companies | Create Company Action
*HubspotApi.DefaultApi* | [**createContactAction**](docs/DefaultApi.md#createContactAction) | **POST** /contacts/v1/contact/ | Create Contact Action
*HubspotApi.DefaultApi* | [**createSubscription**](docs/DefaultApi.md#createSubscription) | **POST** /webhooks/v1/{appId}/subscriptions | Triggers
*HubspotApi.DefaultApi* | [**createTicketsAction**](docs/DefaultApi.md#createTicketsAction) | **POST** /crm-objects/v1/objects/tickets | Create Tickets Action
*HubspotApi.DefaultApi* | [**getDealProperties**](docs/DefaultApi.md#getDealProperties) | **GET** /properties/v1/deals/properties | get Deal properties
*HubspotApi.DefaultApi* | [**getcompanyproperties**](docs/DefaultApi.md#getcompanyproperties) | **GET** /properties/v2/companies/properties | get company properties
*HubspotApi.DefaultApi* | [**getcontactproperties**](docs/DefaultApi.md#getcontactproperties) | **GET** /properties/v2/contact/properties | get contact properties
*HubspotApi.DefaultApi* | [**getticketsproperties**](docs/DefaultApi.md#getticketsproperties) | **GET** /properties/v2/tickets/properties | get tickets properties
*HubspotApi.DefaultApi* | [**updateContactAction**](docs/DefaultApi.md#updateContactAction) | **POST** /contacts/v1/contact/email/{emailId}/profile | Update Contact Action


## Documentation for Models

 - [HubspotApi.Company](docs/Company.md)
 - [HubspotApi.Contacts](docs/Contacts.md)
 - [HubspotApi.GetCompanyproperty](docs/GetCompanyproperty.md)
 - [HubspotApi.GetTicketproperty](docs/GetTicketproperty.md)
 - [HubspotApi.Getcontactpropertytoupdate](docs/Getcontactpropertytoupdate.md)
 - [HubspotApi.Getpropertyforcontacts](docs/Getpropertyforcontacts.md)
 - [HubspotApi.Tickets](docs/Tickets.md)
 - [HubspotApi.UpdateContact](docs/UpdateContact.md)
 - [HubspotApi.Webhook](docs/Webhook.md)
 - [HubspotApi.WebhookBody](docs/WebhookBody.md)


## Documentation for Authorization


### ApiKeyAuth

- **Type**: API key
- **API key parameter name**: hapikey
- **Location**: URL query string

### auth

- **Type**: OAuth
- **Flow**: accessCode
- **Authorization URL**: https://app.hubspot.com/oauth/authorize
- **Scopes**: 
  - contacts: grants write access to contacts
  - tickets: grant write access to tickets