Metadata-Version: 2.4
Name: airbyte-ai-zendesk-support
Version: 0.18.2
Summary: Airbyte Zendesk-Support Connector for AI platforms
Project-URL: Homepage, https://github.com/airbytehq/airbyte-embedded
Project-URL: Documentation, https://github.com/airbytehq/airbyte-embedded/tree/main/integrations
Project-URL: Repository, https://github.com/airbytehq/airbyte-embedded
Project-URL: Issues, https://github.com/airbytehq/airbyte-embedded/issues
Author-email: Airbyte <contact@airbyte.io>
License: Elastic-2.0
Keywords: airbyte,api,connector,zendesk-support
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Requires-Dist: httpx>=0.24.0
Requires-Dist: jinja2>=3.0.0
Requires-Dist: jsonpath-ng>=1.6.1
Requires-Dist: jsonref>=1.1.0
Requires-Dist: opentelemetry-api>=1.37.0
Requires-Dist: opentelemetry-sdk>=1.37.0
Requires-Dist: pydantic>=2.0.0
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: segment-analytics-python>=2.2.0
Description-Content-Type: text/markdown

# Airbyte Zendesk-Support AI Connector

Type-safe Zendesk-Support API connector with full IDE autocomplete support for AI applications.

## Installation

```bash
uv pip install airbyte-ai-zendesk-support
```

## Usage

```python
from airbyte_ai_zendesk_support import ZendeskSupportConnector
from airbyte_ai_zendesk_support.models import ZendeskSupportAuthConfig

# Create connector
connector = ZendeskSupportConnector(auth_config=ZendeskSupportAuthConfig(access_token="...", refresh_token="...", client_id="...", client_secret="..."))

# Use typed methods with full IDE autocomplete
# (See Available Actions below for all methods)
```

## Available Actions

### Tickets Actions
- `list_tickets()` - Returns a list of all tickets in your account
- `get_ticket()` - Returns a ticket by its ID

### Users Actions
- `list_users()` - Returns a list of all users in your account
- `get_user()` - Returns a user by their ID

### Organizations Actions
- `list_organizations()` - Returns a list of all organizations in your account
- `get_organization()` - Returns an organization by its ID

### Groups Actions
- `list_groups()` - Returns a list of all groups in your account
- `get_group()` - Returns a group by its ID

### Ticket_Comments Actions
- `list_ticket_comments()` - Returns a list of comments for a specific ticket

### Attachments Actions
- `get_attachment()` - Returns an attachment by its ID
- `download_attachment()` - Downloads the file content of a ticket attachment

### Ticket_Audits Actions
- `list_ticket_audits()` - Returns a list of all ticket audits
- `list_audits_for_ticket()` - Returns a list of audits for a specific ticket

### Ticket_Metrics Actions
- `list_ticket_metrics()` - Returns a list of all ticket metrics

### Ticket_Fields Actions
- `list_ticket_fields()` - Returns a list of all ticket fields
- `get_ticket_field()` - Returns a ticket field by its ID

### Brands Actions
- `list_brands()` - Returns a list of all brands for the account
- `get_brand()` - Returns a brand by its ID

### Views Actions
- `list_views()` - Returns a list of all views for the account
- `get_view()` - Returns a view by its ID

### Macros Actions
- `list_macros()` - Returns a list of all macros for the account
- `get_macro()` - Returns a macro by its ID

### Triggers Actions
- `list_triggers()` - Returns a list of all triggers for the account
- `get_trigger()` - Returns a trigger by its ID

### Automations Actions
- `list_automations()` - Returns a list of all automations for the account
- `get_automation()` - Returns an automation by its ID

### Tags Actions
- `list_tags()` - Returns a list of all tags used in the account

### Satisfaction_Ratings Actions
- `list_satisfaction_ratings()` - Returns a list of all satisfaction ratings
- `get_satisfaction_rating()` - Returns a satisfaction rating by its ID

### Group_Memberships Actions
- `list_group_memberships()` - Returns a list of all group memberships

### Organization_Memberships Actions
- `list_organization_memberships()` - Returns a list of all organization memberships

### Sla_Policies Actions
- `list_sla_policies()` - Returns a list of all SLA policies
- `get_sla_policy()` - Returns an SLA policy by its ID

### Ticket_Forms Actions
- `list_ticket_forms()` - Returns a list of all ticket forms for the account
- `get_ticket_form()` - Returns a ticket form by its ID

### Articles Actions
- `list_articles()` - Returns a list of all articles in the Help Center
- `get_article()` - Retrieves the details of a specific article

### Article_Attachments Actions
- `list_article_attachments()` - Returns a list of all attachments for a specific article
- `get_article_attachment_metadata()` - Retrieves the metadata of a specific attachment for a specific article
- `download_article_attachment()` - Downloads the file content of a specific attachment

## Type Definitions

All response types are fully typed using Pydantic models for IDE autocomplete support.
Import types from `airbyte_ai_zendesk_support.types`.

## Documentation

Generated from OpenAPI 3.0 specification.

For API documentation, see the service's official API docs.

## Version Information

**Package Version:** 0.18.2

**Connector Version:** 0.1.1

**SDK Version:** 0.1.0