{"id":18383943,"url":"https://github.com/speakeasy-sdks/hightouch-python-sdk","last_synced_at":"2025-06-17T10:11:19.895Z","repository":{"id":135630629,"uuid":"593487777","full_name":"speakeasy-sdks/hightouch-python-sdk","owner":"speakeasy-sdks","description":"Python SDK for Hightouch API","archived":false,"fork":false,"pushed_at":"2024-04-02T20:48:55.000Z","size":570,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-13T19:24:50.959Z","etag":null,"topics":["activation","cdi","cdp","datawarehouse","destination","hightouch","models","python","python3","sdk"],"latest_commit_sha":null,"homepage":"https://hightouch.com/docs/developer-tools/api-guide","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/speakeasy-sdks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-26T05:36:15.000Z","updated_at":"2025-04-27T17:53:23.000Z","dependencies_parsed_at":null,"dependency_job_id":"2f20319f-784c-4d3f-a6f4-4f5ffb3edb5e","html_url":"https://github.com/speakeasy-sdks/hightouch-python-sdk","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/speakeasy-sdks/hightouch-python-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-sdks%2Fhightouch-python-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-sdks%2Fhightouch-python-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-sdks%2Fhightouch-python-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-sdks%2Fhightouch-python-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/speakeasy-sdks","download_url":"https://codeload.github.com/speakeasy-sdks/hightouch-python-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-sdks%2Fhightouch-python-sdk/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259718932,"owners_count":22901189,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["activation","cdi","cdp","datawarehouse","destination","hightouch","models","python","python3","sdk"],"created_at":"2024-11-06T01:13:04.485Z","updated_at":"2025-06-17T10:11:14.886Z","avatar_url":"https://github.com/speakeasy-sdks.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/6267663/221538828-de1343f2-b249-4ba2-85e3-a2e43cc5f265.svg\"\u003e\n  \u003ch1\u003ePython SDK\u003c/h1\u003e\n  \u003cp\u003eHightouch exposes a REST API that lets users interact with resources like syncs, models, sources and destinations.\u003c/p\u003e\n  \u003ca href=\"https://hightouch.com/docs/api-reference\"\u003e\u003cimg src=\"https://img.shields.io/static/v1?label=Docs\u0026message=API Ref\u0026color=000000\u0026style=for-the-badge\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/speakeasy-sdks/hightouch-python-sdk/actions\"\u003e\u003cimg src=\"https://img.shields.io/github/actions/workflow/status/speakeasy-sdks/hightouch-python-sdk/speakeasy_sdk_generation.yml?style=for-the-badge\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://opensource.org/licenses/MIT\"\u003e\u003cimg src=\"https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/speakeasy-sdks/hightouch-python-sdk/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/v/release/speakeasy-sdks/hightouch-python-sdk?sort=semver\u0026style=for-the-badge\" /\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n\u003c!-- Start SDK Installation [installation] --\u003e\n## SDK Installation\n\n```bash\npip install git+https://github.com/speakeasy-sdks/hightouch-python-sdk.git\n```\n\u003c!-- End SDK Installation [installation] --\u003e\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\u003c!-- Start SDK Example Usage [usage] --\u003e\n## SDK Example Usage\n\n### Example\n\n```python\nimport hightouch\nfrom hightouch.models import shared\n\ns = hightouch.Hightouch(\n    security=shared.Security(\n        bearer_auth=\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n    ),\n)\n\nreq = shared.DestinationCreate(\n    configuration={\n        'key': '\u003cvalue\u003e',\n    },\n    name='\u003cvalue\u003e',\n    slug='\u003cvalue\u003e',\n    type='\u003cvalue\u003e',\n)\n\nres = s.create_destination(req)\n\nif res.one_of is not None:\n    # handle response\n    pass\n\n```\n\u003c!-- End SDK Example Usage [usage] --\u003e\n\n\u003c!-- Start Available Resources and Operations [operations] --\u003e\n## Available Resources and Operations\n\n### [Hightouch SDK](docs/sdks/hightouch/README.md)\n\n* [create_destination](docs/sdks/hightouch/README.md#create_destination) - Create Destination\n* [create_model](docs/sdks/hightouch/README.md#create_model) - Create Model\n* [create_source](docs/sdks/hightouch/README.md#create_source) - Create Source\n* [create_sync](docs/sdks/hightouch/README.md#create_sync) - Create Sync\n* [get_destination](docs/sdks/hightouch/README.md#get_destination) - Get Destination\n* [get_model](docs/sdks/hightouch/README.md#get_model) - Get Model\n* [get_source](docs/sdks/hightouch/README.md#get_source) - Get Source\n* [get_sync](docs/sdks/hightouch/README.md#get_sync) - Get Sync\n* [get_sync_sequence_run](docs/sdks/hightouch/README.md#get_sync_sequence_run) - Sync sequence status\n* [list_destination](docs/sdks/hightouch/README.md#list_destination) - List Destinations\n* [list_model](docs/sdks/hightouch/README.md#list_model) - List Models\n* [list_source](docs/sdks/hightouch/README.md#list_source) - List Sources\n* [list_sync](docs/sdks/hightouch/README.md#list_sync) - List Syncs\n* [list_sync_runs](docs/sdks/hightouch/README.md#list_sync_runs) - List Sync Runs\n* [trigger_run](docs/sdks/hightouch/README.md#trigger_run) - Trigger Sync\n* [trigger_run_custom](docs/sdks/hightouch/README.md#trigger_run_custom) - Trigger Sync From ID or Slug\n* [trigger_run_id_graph](docs/sdks/hightouch/README.md#trigger_run_id_graph)\n* [trigger_sequence_run](docs/sdks/hightouch/README.md#trigger_sequence_run) - Trigger Sync sequence\n* [update_destination](docs/sdks/hightouch/README.md#update_destination) - Update Destination\n* [update_model](docs/sdks/hightouch/README.md#update_model) - Update Model\n* [update_source](docs/sdks/hightouch/README.md#update_source) - Update Source\n* [update_sync](docs/sdks/hightouch/README.md#update_sync) - Update Sync\n\u003c!-- End Available Resources and Operations [operations] --\u003e\n\n\n\n\n\n\n\n\u003c!-- Start Error Handling [errors] --\u003e\n## Error Handling\n\nHandling errors in this SDK should largely match your expectations.  All operations return a response object or raise an error.  If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.\n\n| Error Object             | Status Code              | Content Type             |\n| ------------------------ | ------------------------ | ------------------------ |\n| errors.ValidateErrorJSON | 409,422                  | application/json         |\n| errors.SDKError          | 4xx-5xx                  | */*                      |\n\n### Example\n\n```python\nimport hightouch\nfrom hightouch.models import errors, shared\n\ns = hightouch.Hightouch(\n    security=shared.Security(\n        bearer_auth=\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n    ),\n)\n\nreq = shared.DestinationCreate(\n    configuration={\n        'key': '\u003cvalue\u003e',\n    },\n    name='\u003cvalue\u003e',\n    slug='\u003cvalue\u003e',\n    type='\u003cvalue\u003e',\n)\n\nres = None\ntry:\n    res = s.create_destination(req)\nexcept errors.ValidateErrorJSON as e:\n    # handle exception\n    raise(e)\nexcept errors.SDKError as e:\n    # handle exception\n    raise(e)\n\nif res.one_of is not None:\n    # handle response\n    pass\n\n```\n\u003c!-- End Error Handling [errors] --\u003e\n\n\n\n\u003c!-- Start Server Selection [server] --\u003e\n## Server Selection\n\n### Select Server by Index\n\nYou can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:\n\n| # | Server | Variables |\n| - | ------ | --------- |\n| 0 | `https://api.hightouch.com/api/v1` | None |\n\n#### Example\n\n```python\nimport hightouch\nfrom hightouch.models import shared\n\ns = hightouch.Hightouch(\n    server_idx=0,\n    security=shared.Security(\n        bearer_auth=\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n    ),\n)\n\nreq = shared.DestinationCreate(\n    configuration={\n        'key': '\u003cvalue\u003e',\n    },\n    name='\u003cvalue\u003e',\n    slug='\u003cvalue\u003e',\n    type='\u003cvalue\u003e',\n)\n\nres = s.create_destination(req)\n\nif res.one_of is not None:\n    # handle response\n    pass\n\n```\n\n\n### Override Server URL Per-Client\n\nThe default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:\n```python\nimport hightouch\nfrom hightouch.models import shared\n\ns = hightouch.Hightouch(\n    server_url=\"https://api.hightouch.com/api/v1\",\n    security=shared.Security(\n        bearer_auth=\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n    ),\n)\n\nreq = shared.DestinationCreate(\n    configuration={\n        'key': '\u003cvalue\u003e',\n    },\n    name='\u003cvalue\u003e',\n    slug='\u003cvalue\u003e',\n    type='\u003cvalue\u003e',\n)\n\nres = s.create_destination(req)\n\nif res.one_of is not None:\n    # handle response\n    pass\n\n```\n\u003c!-- End Server Selection [server] --\u003e\n\n\n\n\u003c!-- Start Custom HTTP Client [http-client] --\u003e\n## Custom HTTP Client\n\nThe Python SDK makes API calls using the [requests](https://pypi.org/project/requests/) HTTP library.  In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object.\n\nFor example, you could specify a header for every request that this sdk makes as follows:\n```python\nimport hightouch\nimport requests\n\nhttp_client = requests.Session()\nhttp_client.headers.update({'x-custom-header': 'someValue'})\ns = hightouch.Hightouch(client=http_client)\n```\n\u003c!-- End Custom HTTP Client [http-client] --\u003e\n\n\n\n\u003c!-- Start Authentication [security] --\u003e\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security scheme globally:\n\n| Name          | Type          | Scheme        |\n| ------------- | ------------- | ------------- |\n| `bearer_auth` | http          | HTTP Bearer   |\n\nYou can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:\n```python\nimport hightouch\nfrom hightouch.models import shared\n\ns = hightouch.Hightouch(\n    security=shared.Security(\n        bearer_auth=\"\u003cYOUR_BEARER_TOKEN_HERE\u003e\",\n    ),\n)\n\nreq = shared.DestinationCreate(\n    configuration={\n        'key': '\u003cvalue\u003e',\n    },\n    name='\u003cvalue\u003e',\n    slug='\u003cvalue\u003e',\n    type='\u003cvalue\u003e',\n)\n\nres = s.create_destination(req)\n\nif res.one_of is not None:\n    # handle response\n    pass\n\n```\n\u003c!-- End Authentication [security] --\u003e\n\n\u003c!-- Placeholder for Future Speakeasy SDK Sections --\u003e\n\n\n\n### SDK Generated by [Speakeasy](https://speakeasyapi.dev/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeakeasy-sdks%2Fhightouch-python-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspeakeasy-sdks%2Fhightouch-python-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeakeasy-sdks%2Fhightouch-python-sdk/lists"}