| Name | hightouch JSON |
| Version |
1.31.0
JSON |
| download |
| home_page | |
| Summary | Python SDK for Hightouch API |
| upload_time | 2023-08-08 16:40:13 |
| maintainer | |
| docs_url | None |
| author | Speakeasy |
| requires_python | >=3.9 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
<img src="https://user-images.githubusercontent.com/6267663/221538828-de1343f2-b249-4ba2-85e3-a2e43cc5f265.svg">
<h1>Python SDK</h1>
<p>Hightouch exposes a REST API that lets users interact with resources like syncs, models, sources and destinations.</p>
<a href="https://hightouch.com/docs/api-reference"><img src="https://img.shields.io/static/v1?label=Docs&message=API Ref&color=000000&style=for-the-badge" /></a>
<a href="https://github.com/speakeasy-sdks/hightouch-python-sdk/actions"><img src="https://img.shields.io/github/actions/workflow/status/speakeasy-sdks/hightouch-python-sdk/speakeasy_sdk_generation.yml?style=for-the-badge" /></a>
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge" /></a>
<a href="https://github.com/speakeasy-sdks/hightouch-python-sdk/releases"><img src="https://img.shields.io/github/v/release/speakeasy-sdks/hightouch-python-sdk?sort=semver&style=for-the-badge" /></a>
</div>
<!-- Start SDK Installation -->
## SDK Installation
```bash
pip install git+<UNSET>.git
```
<!-- End SDK Installation -->
## Authentication
- Create an [API key](https://app.hightouch.com/settings/api-keys)
- From the API keys tab on the Settings page, select Add API key.
- Enter a descriptive Name for your key.
- Copy your API key and store it in a safe location. The key will only be displayed once.
- Click Create API key.
## SDK Example Usage
<!-- Start SDK Example Usage -->
```python
import hightouch
from hightouch.models import operations, shared
s = hightouch.Hightouch()
req = shared.DestinationCreate(
configuration={
"provident": 'distinctio',
"quibusdam": 'unde',
"nulla": 'corrupti',
},
name='Ben Mueller',
slug='iure',
type='magnam',
)
res = s.create_destination(req, operations.CreateDestinationSecurity(
bearer_auth="YOUR_BEARER_TOKEN_HERE",
))
if res.create_destination_200_application_json_any_of is not None:
# handle response
```
<!-- End SDK Example Usage -->
<!-- Start SDK Available Operations -->
## Available Resources and Operations
### [Hightouch SDK](docs/hightouch/README.md)
* [create_destination](docs/hightouch/README.md#create_destination) - Create Destination
* [create_model](docs/hightouch/README.md#create_model) - Create Model
* [create_source](docs/hightouch/README.md#create_source) - Create Source
* [create_sync](docs/hightouch/README.md#create_sync) - Create Sync
* [get_destination](docs/hightouch/README.md#get_destination) - Get Destination
* [get_model](docs/hightouch/README.md#get_model) - Get Model
* [get_source](docs/hightouch/README.md#get_source) - Get Source
* [get_sync](docs/hightouch/README.md#get_sync) - Get Sync
* [list_destination](docs/hightouch/README.md#list_destination) - List Destinations
* [list_model](docs/hightouch/README.md#list_model) - List Models
* [list_source](docs/hightouch/README.md#list_source) - List Sources
* [list_sync](docs/hightouch/README.md#list_sync) - List Syncs
* [list_sync_runs](docs/hightouch/README.md#list_sync_runs) - List Sync Runs
* [trigger_run](docs/hightouch/README.md#trigger_run) - Trigger Sync
* [trigger_run_custom](docs/hightouch/README.md#trigger_run_custom) - Trigger Sync From ID or Slug
* [update_destination](docs/hightouch/README.md#update_destination) - Update Destination
* [update_model](docs/hightouch/README.md#update_model) - Update Model
* [update_source](docs/hightouch/README.md#update_source) - Update Source
* [update_sync](docs/hightouch/README.md#update_sync) - Update Sync
<!-- End SDK Available Operations -->
### SDK Generated by [Speakeasy](https://speakeasyapi.dev/)
Raw data
{
"_id": null,
"home_page": "",
"name": "hightouch",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "",
"author": "Speakeasy",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/3a/b0/eff977ec96d672f7e59b124e791afa3b24e929cff6965c0ee71afe91efa9/hightouch-1.31.0.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <img src=\"https://user-images.githubusercontent.com/6267663/221538828-de1343f2-b249-4ba2-85e3-a2e43cc5f265.svg\">\n <h1>Python SDK</h1>\n <p>Hightouch exposes a REST API that lets users interact with resources like syncs, models, sources and destinations.</p>\n <a href=\"https://hightouch.com/docs/api-reference\"><img src=\"https://img.shields.io/static/v1?label=Docs&message=API Ref&color=000000&style=for-the-badge\" /></a>\n <a href=\"https://github.com/speakeasy-sdks/hightouch-python-sdk/actions\"><img src=\"https://img.shields.io/github/actions/workflow/status/speakeasy-sdks/hightouch-python-sdk/speakeasy_sdk_generation.yml?style=for-the-badge\" /></a>\n <a href=\"https://opensource.org/licenses/MIT\"><img src=\"https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge\" /></a>\n <a href=\"https://github.com/speakeasy-sdks/hightouch-python-sdk/releases\"><img src=\"https://img.shields.io/github/v/release/speakeasy-sdks/hightouch-python-sdk?sort=semver&style=for-the-badge\" /></a>\n</div>\n\n<!-- Start SDK Installation -->\n## SDK Installation\n\n```bash\npip install git+<UNSET>.git\n```\n<!-- End SDK Installation -->\n\n## Authentication\n\n- Create an [API key](https://app.hightouch.com/settings/api-keys)\n- From the API keys tab on the Settings page, select Add API key.\n- Enter a descriptive Name for your key.\n- Copy your API key and store it in a safe location. The key will only be displayed once.\n- Click Create API key.\n\n## SDK Example Usage\n<!-- Start SDK Example Usage -->\n```python\nimport hightouch\nfrom hightouch.models import operations, shared\n\ns = hightouch.Hightouch()\n\nreq = shared.DestinationCreate(\n configuration={\n \"provident\": 'distinctio',\n \"quibusdam\": 'unde',\n \"nulla\": 'corrupti',\n },\n name='Ben Mueller',\n slug='iure',\n type='magnam',\n)\n\nres = s.create_destination(req, operations.CreateDestinationSecurity(\n bearer_auth=\"YOUR_BEARER_TOKEN_HERE\",\n))\n\nif res.create_destination_200_application_json_any_of is not None:\n # handle response\n```\n<!-- End SDK Example Usage -->\n\n<!-- Start SDK Available Operations -->\n## Available Resources and Operations\n\n### [Hightouch SDK](docs/hightouch/README.md)\n\n* [create_destination](docs/hightouch/README.md#create_destination) - Create Destination\n* [create_model](docs/hightouch/README.md#create_model) - Create Model\n* [create_source](docs/hightouch/README.md#create_source) - Create Source\n* [create_sync](docs/hightouch/README.md#create_sync) - Create Sync\n* [get_destination](docs/hightouch/README.md#get_destination) - Get Destination\n* [get_model](docs/hightouch/README.md#get_model) - Get Model\n* [get_source](docs/hightouch/README.md#get_source) - Get Source\n* [get_sync](docs/hightouch/README.md#get_sync) - Get Sync\n* [list_destination](docs/hightouch/README.md#list_destination) - List Destinations\n* [list_model](docs/hightouch/README.md#list_model) - List Models\n* [list_source](docs/hightouch/README.md#list_source) - List Sources\n* [list_sync](docs/hightouch/README.md#list_sync) - List Syncs\n* [list_sync_runs](docs/hightouch/README.md#list_sync_runs) - List Sync Runs\n* [trigger_run](docs/hightouch/README.md#trigger_run) - Trigger Sync\n* [trigger_run_custom](docs/hightouch/README.md#trigger_run_custom) - Trigger Sync From ID or Slug\n* [update_destination](docs/hightouch/README.md#update_destination) - Update Destination\n* [update_model](docs/hightouch/README.md#update_model) - Update Model\n* [update_source](docs/hightouch/README.md#update_source) - Update Source\n* [update_sync](docs/hightouch/README.md#update_sync) - Update Sync\n<!-- End SDK Available Operations -->\n\n### SDK Generated by [Speakeasy](https://speakeasyapi.dev/)\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Python SDK for Hightouch API",
"version": "1.31.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "33e054ea005253bd346f64f655fff44278c4728531f7145262e585f93ddaff61",
"md5": "478ed828c57410a2ad289711b61ce91b",
"sha256": "8c980b216a85e56ecd3f2a3da6d201f8c64edb65fa43966fbb48184e9d40e046"
},
"downloads": -1,
"filename": "hightouch-1.31.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "478ed828c57410a2ad289711b61ce91b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 49414,
"upload_time": "2023-08-08T16:40:12",
"upload_time_iso_8601": "2023-08-08T16:40:12.314815Z",
"url": "https://files.pythonhosted.org/packages/33/e0/54ea005253bd346f64f655fff44278c4728531f7145262e585f93ddaff61/hightouch-1.31.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3ab0eff977ec96d672f7e59b124e791afa3b24e929cff6965c0ee71afe91efa9",
"md5": "8bdf23091451d2c300544c4b59daf128",
"sha256": "712600167ed2cbdb1f6ff243f3268ea7f6bd77594556925d18efac2cc2a3664c"
},
"downloads": -1,
"filename": "hightouch-1.31.0.tar.gz",
"has_sig": false,
"md5_digest": "8bdf23091451d2c300544c4b59daf128",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 22487,
"upload_time": "2023-08-08T16:40:13",
"upload_time_iso_8601": "2023-08-08T16:40:13.966890Z",
"url": "https://files.pythonhosted.org/packages/3a/b0/eff977ec96d672f7e59b124e791afa3b24e929cff6965c0ee71afe91efa9/hightouch-1.31.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-08 16:40:13",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "hightouch"
}
