1
0
mirror of synced 2025-12-19 18:14:56 -05:00

docs: sync agent connector docs from airbyte-agent-connectors repo (#70976)

Co-authored-by: ian-at-airbyte <187576150+ian-at-airbyte@users.noreply.github.com>
This commit is contained in:
octavia-bot[bot]
2025-12-18 11:14:19 -08:00
committed by GitHub
parent 13676b83ce
commit 14d4ce4f4f
30 changed files with 742 additions and 566 deletions

View File

@@ -1,4 +1,19 @@
# Changelog
# Asana changelog
## [0.19.22] - 2025-12-18
- Updated connector definition (YAML version 0.1.4)
- Source commit: f7c55d3e
- SDK version: 0.1.0
## [0.19.21] - 2025-12-17
- Updated connector definition (YAML version 0.1.4)
- Source commit: af456521
- SDK version: 0.1.0
## [0.19.20] - 2025-12-17
- Updated connector definition (YAML version 0.1.4)
- Source commit: 6a6c981e
- SDK version: 0.1.0
## [0.19.19] - 2025-12-15
- Updated connector definition (YAML version 0.1.4)

View File

@@ -1,11 +1,11 @@
# Airbyte Asana AI Connector
# Asana agent connector
Asana is a work management platform that helps teams organize, track, and manage
projects and tasks. This connector provides access to tasks, projects, workspaces,
teams, and users for project tracking, workload analysis, and productivity insights.
## Example Questions
## Example questions
- What tasks are assigned to me this week?
- List all projects in my workspace
@@ -18,7 +18,7 @@ teams, and users for project tracking, workload analysis, and productivity insig
- Identify overdue tasks across all my projects
- Show me details of my current workspace and its users
## Unsupported Questions
## Unsupported questions
- Create a new task for [TeamMember]
- Update the priority of this task
@@ -46,10 +46,12 @@ connector = AsanaConnector(
client_secret="..."
)
)
result = connector.tasks.list()
result = await connector.tasks.list()
```
## Documentation
## Full documentation
This connector supports the following entities and actions.
| Entity | Actions |
|--------|---------|
@@ -77,14 +79,12 @@ result = connector.tasks.list()
| Task Dependents | [List](./REFERENCE.md#task-dependents-list) |
For detailed documentation on available actions and parameters, see [REFERENCE.md](./REFERENCE.md).
For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).
For the service's official API docs, see [Asana API Reference](https://developers.asana.com/reference/rest-api-reference).
For the service's official API docs, see the [Asana API reference](https://developers.asana.com/reference/rest-api-reference).
## Version Information
## Version information
**Package Version:** 0.19.19
**Connector Version:** 0.1.4
**Generated with connector-sdk:** c4c39c2797ecd929407c9417c728d425f77b37ed
- **Package version:** 0.19.22
- **Connector version:** 0.1.4
- **Generated with Connector SDK commit SHA:** f7c55d3e3cdc7568cab2da9d736285eec58f044b

View File

@@ -1,6 +1,10 @@
# Asana
# Asana full reference
## Supported Entities and Actions
This is the full reference documentation for the Asana agent connector.
## Supported entities and actions
The Asana connector supports the following entities and actions.
| Entity | Actions |
|--------|---------|
@@ -36,7 +40,7 @@ Returns a paginated list of tasks
**Python SDK**
```python
asana.tasks.list()
await asana.tasks.list()
```
**API**
@@ -52,7 +56,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -95,7 +99,7 @@ Get a single task by its ID
**Python SDK**
```python
asana.tasks.get(
await asana.tasks.get(
task_gid="<str>"
)
```
@@ -116,7 +120,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -144,7 +148,7 @@ Returns all tasks in a project
**Python SDK**
```python
asana.project_tasks.list(
await asana.project_tasks.list(
project_gid="<str>"
)
```
@@ -165,7 +169,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -206,7 +210,7 @@ Returns tasks that match the specified search criteria. Note - This endpoint req
**Python SDK**
```python
asana.workspace_task_search.list(
await asana.workspace_task_search.list(
workspace_gid="<str>"
)
```
@@ -227,7 +231,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -283,7 +287,7 @@ Returns a paginated list of projects
**Python SDK**
```python
asana.projects.list()
await asana.projects.list()
```
**API**
@@ -299,7 +303,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -337,7 +341,7 @@ Get a single project by its ID
**Python SDK**
```python
asana.projects.get(
await asana.projects.get(
project_gid="<str>"
)
```
@@ -358,7 +362,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -413,7 +417,7 @@ Returns all projects a task is in
**Python SDK**
```python
asana.task_projects.list(
await asana.task_projects.list(
task_gid="<str>"
)
```
@@ -434,7 +438,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -472,7 +476,7 @@ Returns all projects for a team
**Python SDK**
```python
asana.team_projects.list(
await asana.team_projects.list(
team_gid="<str>"
)
```
@@ -493,7 +497,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -532,7 +536,7 @@ Returns all projects in a workspace
**Python SDK**
```python
asana.workspace_projects.list(
await asana.workspace_projects.list(
workspace_gid="<str>"
)
```
@@ -553,7 +557,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -592,7 +596,7 @@ Returns a paginated list of workspaces
**Python SDK**
```python
asana.workspaces.list()
await asana.workspaces.list()
```
**API**
@@ -608,7 +612,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -643,7 +647,7 @@ Get a single workspace by its ID
**Python SDK**
```python
asana.workspaces.get(
await asana.workspaces.get(
workspace_gid="<str>"
)
```
@@ -664,7 +668,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -696,7 +700,7 @@ Returns a paginated list of users
**Python SDK**
```python
asana.users.list()
await asana.users.list()
```
**API**
@@ -712,7 +716,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -749,7 +753,7 @@ Get a single user by their ID
**Python SDK**
```python
asana.users.get(
await asana.users.get(
user_gid="<str>"
)
```
@@ -770,7 +774,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -803,7 +807,7 @@ Returns all users in a workspace
**Python SDK**
```python
asana.workspace_users.list(
await asana.workspace_users.list(
workspace_gid="<str>"
)
```
@@ -824,7 +828,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -862,7 +866,7 @@ Returns all users in a team
**Python SDK**
```python
asana.team_users.list(
await asana.team_users.list(
team_gid="<str>"
)
```
@@ -883,7 +887,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -921,7 +925,7 @@ Get a single team by its ID
**Python SDK**
```python
asana.teams.get(
await asana.teams.get(
team_gid="<str>"
)
```
@@ -942,7 +946,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -974,7 +978,7 @@ Returns all teams in a workspace
**Python SDK**
```python
asana.workspace_teams.list(
await asana.workspace_teams.list(
workspace_gid="<str>"
)
```
@@ -995,7 +999,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1033,7 +1037,7 @@ Returns all teams a user is a member of
**Python SDK**
```python
asana.user_teams.list(
await asana.user_teams.list(
user_gid="<str>",
organization="<str>"
)
@@ -1056,7 +1060,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1095,7 +1099,7 @@ Returns a list of attachments for an object (task, project, etc.)
**Python SDK**
```python
asana.attachments.list(
await asana.attachments.list(
parent="<str>"
)
```
@@ -1116,7 +1120,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1153,7 +1157,7 @@ Get details for a single attachment by its GID
**Python SDK**
```python
asana.attachments.get(
await asana.attachments.get(
attachment_gid="<str>"
)
```
@@ -1174,7 +1178,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1234,7 +1238,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1251,7 +1255,7 @@ Returns all tags in a workspace
**Python SDK**
```python
asana.workspace_tags.list(
await asana.workspace_tags.list(
workspace_gid="<str>"
)
```
@@ -1272,7 +1276,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1310,7 +1314,7 @@ Get a single tag by its ID
**Python SDK**
```python
asana.tags.get(
await asana.tags.get(
tag_gid="<str>"
)
```
@@ -1331,7 +1335,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1367,7 +1371,7 @@ Returns all sections in a project
**Python SDK**
```python
asana.project_sections.list(
await asana.project_sections.list(
project_gid="<str>"
)
```
@@ -1388,7 +1392,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1426,7 +1430,7 @@ Get a single section by its ID
**Python SDK**
```python
asana.sections.get(
await asana.sections.get(
section_gid="<str>"
)
```
@@ -1447,7 +1451,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1479,7 +1483,7 @@ Returns all subtasks of a task
**Python SDK**
```python
asana.task_subtasks.list(
await asana.task_subtasks.list(
task_gid="<str>"
)
```
@@ -1500,7 +1504,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1540,7 +1544,7 @@ Returns all tasks that this task depends on
**Python SDK**
```python
asana.task_dependencies.list(
await asana.task_dependencies.list(
task_gid="<str>"
)
```
@@ -1561,7 +1565,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1601,7 +1605,7 @@ Returns all tasks that depend on this task
**Python SDK**
```python
asana.task_dependents.list(
await asana.task_dependents.list(
task_gid="<str>"
)
```
@@ -1622,7 +1626,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1657,7 +1661,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
## Authentication
The Asana connector supports the following authentication methods:
The Asana connector supports the following authentication methods.
### Asana OAuth 2.0

View File

@@ -1,5 +1,20 @@
# Github changelog
## [0.18.24] - 2025-12-18
- Updated connector definition (YAML version 0.1.5)
- Source commit: f7c55d3e
- SDK version: 0.1.0
## [0.18.23] - 2025-12-17
- Updated connector definition (YAML version 0.1.5)
- Source commit: af456521
- SDK version: 0.1.0
## [0.18.22] - 2025-12-17
- Updated connector definition (YAML version 0.1.5)
- Source commit: 6a6c981e
- SDK version: 0.1.0
## [0.18.21] - 2025-12-16
- Updated connector definition (YAML version 0.1.5)
- Source commit: 57f08f60

View File

@@ -43,7 +43,7 @@ connector = GithubConnector(
access_token="..."
)
)
result = connector.repositories.get()
result = await connector.repositories.get()
```
## Full documentation
@@ -81,6 +81,6 @@ For the service's official API docs, see the [Github API reference](https://docs
## Version information
- **Package version:** 0.18.21
- **Package version:** 0.18.24
- **Connector version:** 0.1.5
- **Generated with Connector SDK commit SHA:** 57f08f6035b744556fa96334a7b764759896287c
- **Generated with Connector SDK commit SHA:** f7c55d3e3cdc7568cab2da9d736285eec58f044b

View File

@@ -39,7 +39,7 @@ Gets information about a specific GitHub repository using GraphQL
**Python SDK**
```python
github.repositories.get(
await github.repositories.get(
owner="<str>",
repo="<str>"
)
@@ -80,7 +80,7 @@ Returns a list of repositories for the specified user using GraphQL
**Python SDK**
```python
github.repositories.list(
await github.repositories.list(
username="<str>"
)
```
@@ -122,7 +122,7 @@ Examples: "language:python stars:>1000", "topic:machine-learning", "org:facebook
**Python SDK**
```python
github.repositories.search(
await github.repositories.search(
query="<str>"
)
```
@@ -164,7 +164,7 @@ Returns a list of repositories for the specified organization using GraphQL
**Python SDK**
```python
github.org_repositories.list(
await github.org_repositories.list(
org="<str>"
)
```
@@ -204,7 +204,7 @@ Returns a list of branches for the specified repository using GraphQL
**Python SDK**
```python
github.branches.list(
await github.branches.list(
owner="<str>",
repo="<str>"
)
@@ -245,7 +245,7 @@ Gets information about a specific branch using GraphQL
**Python SDK**
```python
github.branches.get(
await github.branches.get(
owner="<str>",
repo="<str>",
branch="<str>"
@@ -289,7 +289,7 @@ Returns a list of commits for the default branch using GraphQL
**Python SDK**
```python
github.commits.list(
await github.commits.list(
owner="<str>",
repo="<str>"
)
@@ -330,7 +330,7 @@ Gets information about a specific commit by SHA using GraphQL
**Python SDK**
```python
github.commits.get(
await github.commits.get(
owner="<str>",
repo="<str>",
sha="<str>"
@@ -374,7 +374,7 @@ Returns a list of releases for the specified repository using GraphQL
**Python SDK**
```python
github.releases.list(
await github.releases.list(
owner="<str>",
repo="<str>"
)
@@ -415,7 +415,7 @@ Gets information about a specific release by tag name using GraphQL
**Python SDK**
```python
github.releases.get(
await github.releases.get(
owner="<str>",
repo="<str>",
tag="<str>"
@@ -459,7 +459,7 @@ Returns a list of issues for the specified repository using GraphQL
**Python SDK**
```python
github.issues.list(
await github.issues.list(
owner="<str>",
repo="<str>"
)
@@ -501,7 +501,7 @@ Gets information about a specific issue using GraphQL
**Python SDK**
```python
github.issues.get(
await github.issues.get(
owner="<str>",
repo="<str>",
number=0
@@ -543,7 +543,7 @@ Search for issues using GitHub's search syntax
**Python SDK**
```python
github.issues.search(
await github.issues.search(
query="<str>"
)
```
@@ -583,7 +583,7 @@ Returns a list of pull requests for the specified repository using GraphQL
**Python SDK**
```python
github.pull_requests.list(
await github.pull_requests.list(
owner="<str>",
repo="<str>"
)
@@ -625,7 +625,7 @@ Gets information about a specific pull request using GraphQL
**Python SDK**
```python
github.pull_requests.get(
await github.pull_requests.get(
owner="<str>",
repo="<str>",
number=0
@@ -667,7 +667,7 @@ Search for pull requests using GitHub's search syntax
**Python SDK**
```python
github.pull_requests.search(
await github.pull_requests.search(
query="<str>"
)
```
@@ -707,7 +707,7 @@ Returns a list of reviews for the specified pull request using GraphQL
**Python SDK**
```python
github.reviews.list(
await github.reviews.list(
owner="<str>",
repo="<str>",
number=0
@@ -753,7 +753,7 @@ Returns a list of comments for the specified issue using GraphQL
**Python SDK**
```python
github.comments.list(
await github.comments.list(
owner="<str>",
repo="<str>",
number=0
@@ -802,7 +802,7 @@ where each comment includes both 'id' (node ID) and 'databaseId' (numeric ID).
**Python SDK**
```python
github.comments.get(
await github.comments.get(
id="<str>"
)
```
@@ -840,7 +840,7 @@ Returns a list of comments for the specified pull request using GraphQL
**Python SDK**
```python
github.pr_comments.list(
await github.pr_comments.list(
owner="<str>",
repo="<str>",
number=0
@@ -889,7 +889,7 @@ where each comment includes both 'id' (node ID) and 'databaseId' (numeric ID).
**Python SDK**
```python
github.pr_comments.get(
await github.pr_comments.get(
id="<str>"
)
```
@@ -927,7 +927,7 @@ Returns a list of labels for the specified repository using GraphQL
**Python SDK**
```python
github.labels.list(
await github.labels.list(
owner="<str>",
repo="<str>"
)
@@ -968,7 +968,7 @@ Gets information about a specific label by name using GraphQL
**Python SDK**
```python
github.labels.get(
await github.labels.get(
owner="<str>",
repo="<str>",
name="<str>"
@@ -1012,7 +1012,7 @@ Returns a list of milestones for the specified repository using GraphQL
**Python SDK**
```python
github.milestones.list(
await github.milestones.list(
owner="<str>",
repo="<str>"
)
@@ -1054,7 +1054,7 @@ Gets information about a specific milestone by number using GraphQL
**Python SDK**
```python
github.milestones.get(
await github.milestones.get(
owner="<str>",
repo="<str>",
number=0
@@ -1098,7 +1098,7 @@ Gets information about a specific organization using GraphQL
**Python SDK**
```python
github.organizations.get(
await github.organizations.get(
org="<str>"
)
```
@@ -1134,7 +1134,7 @@ Returns a list of organizations the user belongs to using GraphQL
**Python SDK**
```python
github.organizations.list(
await github.organizations.list(
username="<str>"
)
```
@@ -1174,7 +1174,7 @@ Gets information about a specific user using GraphQL
**Python SDK**
```python
github.users.get(
await github.users.get(
username="<str>"
)
```
@@ -1210,7 +1210,7 @@ Returns a list of members for the specified organization using GraphQL
**Python SDK**
```python
github.users.list(
await github.users.list(
org="<str>"
)
```
@@ -1248,7 +1248,7 @@ Search for GitHub users using search syntax
**Python SDK**
```python
github.users.search(
await github.users.search(
query="<str>"
)
```
@@ -1288,7 +1288,7 @@ Returns a list of teams for the specified organization using GraphQL
**Python SDK**
```python
github.teams.list(
await github.teams.list(
org="<str>"
)
```
@@ -1326,7 +1326,7 @@ Gets information about a specific team using GraphQL
**Python SDK**
```python
github.teams.get(
await github.teams.get(
org="<str>",
team_slug="<str>"
)
@@ -1367,7 +1367,7 @@ Returns a list of tags for the specified repository using GraphQL
**Python SDK**
```python
github.tags.list(
await github.tags.list(
owner="<str>",
repo="<str>"
)
@@ -1408,7 +1408,7 @@ Gets information about a specific tag by name using GraphQL
**Python SDK**
```python
github.tags.get(
await github.tags.get(
owner="<str>",
repo="<str>",
tag="<str>"
@@ -1452,7 +1452,7 @@ Returns a list of users who have starred the repository using GraphQL
**Python SDK**
```python
github.stargazers.list(
await github.stargazers.list(
owner="<str>",
repo="<str>"
)
@@ -1498,7 +1498,7 @@ the current user's profile, permissions, or associated resources.
**Python SDK**
```python
github.viewer.get()
await github.viewer.get()
```
**API**
@@ -1533,7 +1533,7 @@ automatically lists repositories for the current authenticated user.
**Python SDK**
```python
github.viewer_repositories.list()
await github.viewer_repositories.list()
```
**API**
@@ -1569,7 +1569,7 @@ Projects V2 are the new project boards that replaced classic projects.
**Python SDK**
```python
github.projects.list(
await github.projects.list(
org="<str>"
)
```
@@ -1607,7 +1607,7 @@ Gets information about a specific GitHub Project V2 by number
**Python SDK**
```python
github.projects.get(
await github.projects.get(
org="<str>",
project_number=0
)
@@ -1650,7 +1650,7 @@ Each item includes its field values like Status, Priority, etc.
**Python SDK**
```python
github.project_items.list(
await github.project_items.list(
org="<str>",
project_number=0
)

View File

@@ -1,5 +1,20 @@
# Gong changelog
## [0.19.23] - 2025-12-18
- Updated connector definition (YAML version 0.1.5)
- Source commit: f7c55d3e
- SDK version: 0.1.0
## [0.19.22] - 2025-12-17
- Updated connector definition (YAML version 0.1.5)
- Source commit: af456521
- SDK version: 0.1.0
## [0.19.21] - 2025-12-17
- Updated connector definition (YAML version 0.1.5)
- Source commit: 6a6c981e
- SDK version: 0.1.0
## [0.19.20] - 2025-12-17
- Updated connector definition (YAML version 0.1.5)
- Source commit: 4fe5029b

View File

@@ -42,7 +42,7 @@ connector = GongConnector(
access_token="..."
)
)
result = connector.users.list()
result = await connector.users.list()
```
## Full documentation
@@ -75,6 +75,6 @@ For the service's official API docs, see the [Gong API reference](https://gong.a
## Version information
- **Package version:** 0.19.20
- **Package version:** 0.19.23
- **Connector version:** 0.1.5
- **Generated with Connector SDK commit SHA:** 4fe5029b71369ddb9ad9b5912e7f957fb4f81747
- **Generated with Connector SDK commit SHA:** f7c55d3e3cdc7568cab2da9d736285eec58f044b

View File

@@ -34,7 +34,7 @@ Returns a list of all users in the Gong account
**Python SDK**
```python
gong.users.list()
await gong.users.list()
```
**API**
@@ -101,7 +101,7 @@ Get a single user by ID
**Python SDK**
```python
gong.users.get(
await gong.users.get(
id="<str>"
)
```
@@ -165,7 +165,7 @@ Retrieve calls data by date range
**Python SDK**
```python
gong.calls.list()
await gong.calls.list()
```
**API**
@@ -238,7 +238,7 @@ Get specific call data by ID
**Python SDK**
```python
gong.calls.get(
await gong.calls.get(
id="<str>"
)
```
@@ -306,7 +306,7 @@ Retrieve detailed call data including participants, interaction stats, and conte
**Python SDK**
```python
gong.calls_extensive.list(
await gong.calls_extensive.list(
filter={}
)
```
@@ -483,7 +483,7 @@ List all company workspaces
**Python SDK**
```python
gong.workspaces.list()
await gong.workspaces.list()
```
**API**
@@ -524,7 +524,7 @@ Returns transcripts for calls in a specified date range or specific call IDs
**Python SDK**
```python
gong.call_transcripts.list()
await gong.call_transcripts.list()
```
**API**
@@ -583,7 +583,7 @@ Provides aggregated user activity metrics across a specified period
**Python SDK**
```python
gong.stats_activity_aggregate.list()
await gong.stats_activity_aggregate.list()
```
**API**
@@ -657,7 +657,7 @@ Delivers daily user activity metrics across a specified date range
**Python SDK**
```python
gong.stats_activity_day_by_day.list()
await gong.stats_activity_day_by_day.list()
```
**API**
@@ -733,7 +733,7 @@ Returns interaction stats for users based on calls that have Whisper turned on
**Python SDK**
```python
gong.stats_interaction.list()
await gong.stats_interaction.list()
```
**API**
@@ -794,7 +794,7 @@ Retrieve all scorecard configurations in the company
**Python SDK**
```python
gong.settings_scorecards.list()
await gong.settings_scorecards.list()
```
**API**
@@ -859,7 +859,7 @@ Retrieve all keyword tracker configurations in the company
**Python SDK**
```python
gong.settings_trackers.list()
await gong.settings_trackers.list()
```
**API**
@@ -917,7 +917,7 @@ Retrieve the folder structure of the call library
**Python SDK**
```python
gong.library_folders.list(
await gong.library_folders.list(
workspace_id="<str>"
)
```
@@ -970,7 +970,7 @@ Retrieve calls in a specific library folder
**Python SDK**
```python
gong.library_folder_content.list(
await gong.library_folder_content.list(
folder_id="<str>"
)
```
@@ -1035,7 +1035,7 @@ Retrieve coaching metrics for a manager and their direct reports
**Python SDK**
```python
gong.coaching.list(
await gong.coaching.list(
workspace_id="<str>",
manager_id="<str>",
from_="2025-01-01T00:00:00Z",
@@ -1102,7 +1102,7 @@ Retrieve answered scorecards for applicable reviewed users or scorecards for a d
**Python SDK**
```python
gong.stats_activity_scorecards.list()
await gong.stats_activity_scorecards.list()
```
**API**

View File

@@ -1,4 +1,19 @@
# Changelog
# Greenhouse changelog
## [0.17.20] - 2025-12-18
- Updated connector definition (YAML version 0.1.1)
- Source commit: f7c55d3e
- SDK version: 0.1.0
## [0.17.19] - 2025-12-17
- Updated connector definition (YAML version 0.1.1)
- Source commit: af456521
- SDK version: 0.1.0
## [0.17.18] - 2025-12-17
- Updated connector definition (YAML version 0.1.1)
- Source commit: 6a6c981e
- SDK version: 0.1.0
## [0.17.17] - 2025-12-15
- Updated connector definition (YAML version 0.1.1)

View File

@@ -1,4 +1,4 @@
# Airbyte Greenhouse AI Connector
# Greenhouse agent connector
Greenhouse is an applicant tracking system (ATS) that helps companies manage their
hiring process. This connector provides access to candidates, applications, jobs,
@@ -6,7 +6,7 @@ offers, users, departments, offices, job posts, sources, and scheduled interview
for recruiting analytics and talent acquisition insights.
## Example Questions
## Example questions
- Show me candidates from [Company] who applied last month
- What are the top 5 sources for our job applications this quarter?
@@ -19,7 +19,7 @@ for recruiting analytics and talent acquisition insights.
- Summarize the candidate pipeline for our latest job posting
- Find the most active departments in recruiting this month
## Unsupported Questions
## Unsupported questions
- Create a new job posting for the marketing team
- Schedule an interview for [candidate]
@@ -44,10 +44,12 @@ connector = GreenhouseConnector(
api_key="..."
)
)
result = connector.candidates.list()
result = await connector.candidates.list()
```
## Documentation
## Full documentation
This connector supports the following entities and actions.
| Entity | Actions |
|--------|---------|
@@ -65,14 +67,12 @@ result = connector.candidates.list()
| Candidate Attachment | [Download](./REFERENCE.md#candidate-attachment-download) |
For detailed documentation on available actions and parameters, see [REFERENCE.md](./REFERENCE.md).
For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).
For the service's official API docs, see [Greenhouse API Reference](https://developers.greenhouse.io/harvest.html).
For the service's official API docs, see the [Greenhouse API reference](https://developers.greenhouse.io/harvest.html).
## Version Information
## Version information
**Package Version:** 0.17.17
**Connector Version:** 0.1.1
**Generated with connector-sdk:** c4c39c2797ecd929407c9417c728d425f77b37ed
- **Package version:** 0.17.20
- **Connector version:** 0.1.1
- **Generated with Connector SDK commit SHA:** f7c55d3e3cdc7568cab2da9d736285eec58f044b

View File

@@ -1,6 +1,10 @@
# Greenhouse
# Greenhouse full reference
## Supported Entities and Actions
This is the full reference documentation for the Greenhouse agent connector.
## Supported entities and actions
The Greenhouse connector supports the following entities and actions.
| Entity | Actions |
|--------|---------|
@@ -26,7 +30,7 @@ Returns a paginated list of all candidates in the organization
**Python SDK**
```python
greenhouse.candidates.list()
await greenhouse.candidates.list()
```
**API**
@@ -42,7 +46,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -57,7 +61,7 @@ Get a single candidate by ID
**Python SDK**
```python
greenhouse.candidates.get(
await greenhouse.candidates.get(
id=0
)
```
@@ -78,7 +82,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -131,7 +135,7 @@ Returns a paginated list of all applications
**Python SDK**
```python
greenhouse.applications.list()
await greenhouse.applications.list()
```
**API**
@@ -147,7 +151,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -167,7 +171,7 @@ Get a single application by ID
**Python SDK**
```python
greenhouse.applications.get(
await greenhouse.applications.get(
id=0
)
```
@@ -188,7 +192,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -240,7 +244,7 @@ Returns a paginated list of all jobs in the organization
**Python SDK**
```python
greenhouse.jobs.list()
await greenhouse.jobs.list()
```
**API**
@@ -256,7 +260,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -271,7 +275,7 @@ Get a single job by ID
**Python SDK**
```python
greenhouse.jobs.get(
await greenhouse.jobs.get(
id=0
)
```
@@ -292,7 +296,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -334,7 +338,7 @@ Returns a paginated list of all offers
**Python SDK**
```python
greenhouse.offers.list()
await greenhouse.offers.list()
```
**API**
@@ -350,7 +354,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -368,7 +372,7 @@ Get a single offer by ID
**Python SDK**
```python
greenhouse.offers.get(
await greenhouse.offers.get(
id=0
)
```
@@ -389,7 +393,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -429,7 +433,7 @@ Returns a paginated list of all users
**Python SDK**
```python
greenhouse.users.list()
await greenhouse.users.list()
```
**API**
@@ -445,7 +449,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -464,7 +468,7 @@ Get a single user by ID
**Python SDK**
```python
greenhouse.users.get(
await greenhouse.users.get(
id=0
)
```
@@ -485,7 +489,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -526,7 +530,7 @@ Returns a paginated list of all departments
**Python SDK**
```python
greenhouse.departments.list()
await greenhouse.departments.list()
```
**API**
@@ -542,7 +546,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -557,7 +561,7 @@ Get a single department by ID
**Python SDK**
```python
greenhouse.departments.get(
await greenhouse.departments.get(
id=0
)
```
@@ -578,7 +582,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -612,7 +616,7 @@ Returns a paginated list of all offices
**Python SDK**
```python
greenhouse.offices.list()
await greenhouse.offices.list()
```
**API**
@@ -628,7 +632,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -643,7 +647,7 @@ Get a single office by ID
**Python SDK**
```python
greenhouse.offices.get(
await greenhouse.offices.get(
id=0
)
```
@@ -664,7 +668,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -700,7 +704,7 @@ Returns a paginated list of all job posts
**Python SDK**
```python
greenhouse.job_posts.list()
await greenhouse.job_posts.list()
```
**API**
@@ -716,7 +720,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -733,7 +737,7 @@ Get a single job post by ID
**Python SDK**
```python
greenhouse.job_posts.get(
await greenhouse.job_posts.get(
id=0
)
```
@@ -754,7 +758,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -796,7 +800,7 @@ Returns a paginated list of all sources
**Python SDK**
```python
greenhouse.sources.list()
await greenhouse.sources.list()
```
**API**
@@ -812,7 +816,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -829,7 +833,7 @@ Returns a paginated list of all scheduled interviews
**Python SDK**
```python
greenhouse.scheduled_interviews.list()
await greenhouse.scheduled_interviews.list()
```
**API**
@@ -845,7 +849,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -866,7 +870,7 @@ Get a single scheduled interview by ID
**Python SDK**
```python
greenhouse.scheduled_interviews.get(
await greenhouse.scheduled_interviews.get(
id=0
)
```
@@ -887,7 +891,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -953,7 +957,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -997,7 +1001,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1010,7 +1014,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
## Authentication
The Greenhouse connector supports the following authentication methods:
The Greenhouse connector supports the following authentication methods.
### Harvest API Key Authentication

View File

@@ -1,4 +1,19 @@
# Changelog
# Hubspot changelog
## [0.15.21] - 2025-12-18
- Updated connector definition (YAML version 0.1.2)
- Source commit: f7c55d3e
- SDK version: 0.1.0
## [0.15.20] - 2025-12-17
- Updated connector definition (YAML version 0.1.2)
- Source commit: af456521
- SDK version: 0.1.0
## [0.15.19] - 2025-12-17
- Updated connector definition (YAML version 0.1.2)
- Source commit: 6a6c981e
- SDK version: 0.1.0
## [0.15.18] - 2025-12-15
- Updated connector definition (YAML version 0.1.2)

View File

@@ -1,11 +1,11 @@
# Airbyte Hubspot AI Connector
# Hubspot agent connector
HubSpot is a CRM platform that provides tools for marketing, sales, customer service,
and content management. This connector provides access to contacts, companies, deals,
tickets, and custom objects for customer relationship management and sales analytics.
## Example Questions
## Example questions
- Show me all deals from [Company] this quarter
- What are the top 5 most valuable deals in my pipeline right now?
@@ -16,7 +16,7 @@ tickets, and custom objects for customer relationship management and sales analy
- Compare the number of deals closed by different sales representatives
- Find all tickets related to a specific product issue and summarize their status
## Unsupported Questions
## Unsupported questions
- Create a new contact record for [personX]
- Update the contact information for [customerY]
@@ -43,10 +43,12 @@ connector = HubspotConnector(
access_token="..."
)
)
result = connector.contacts.list()
result = await connector.contacts.list()
```
## Documentation
## Full documentation
This connector supports the following entities and actions.
| Entity | Actions |
|--------|---------|
@@ -58,14 +60,12 @@ result = connector.contacts.list()
| Objects | [List](./REFERENCE.md#objects-list), [Get](./REFERENCE.md#objects-get) |
For detailed documentation on available actions and parameters, see [REFERENCE.md](./REFERENCE.md).
For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).
For the service's official API docs, see [Hubspot API Reference](https://developers.hubspot.com/docs/api/crm/understanding-the-crm).
For the service's official API docs, see the [Hubspot API reference](https://developers.hubspot.com/docs/api/crm/understanding-the-crm).
## Version Information
## Version information
**Package Version:** 0.15.18
**Connector Version:** 0.1.2
**Generated with connector-sdk:** c4c39c2797ecd929407c9417c728d425f77b37ed
- **Package version:** 0.15.21
- **Connector version:** 0.1.2
- **Generated with Connector SDK commit SHA:** f7c55d3e3cdc7568cab2da9d736285eec58f044b

View File

@@ -1,6 +1,10 @@
# Hubspot
# Hubspot full reference
## Supported Entities and Actions
This is the full reference documentation for the Hubspot agent connector.
## Supported entities and actions
The Hubspot connector supports the following entities and actions.
| Entity | Actions |
|--------|---------|
@@ -20,7 +24,7 @@ Returns a paginated list of contacts
**Python SDK**
```python
hubspot.contacts.list()
await hubspot.contacts.list()
```
**API**
@@ -36,7 +40,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -83,7 +87,7 @@ Get a single contact by ID
**Python SDK**
```python
hubspot.contacts.get(
await hubspot.contacts.get(
contact_id="<str>"
)
```
@@ -104,7 +108,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -144,7 +148,7 @@ Search for contacts by filtering on properties, searching through associations,
**Python SDK**
```python
hubspot.contacts.search()
await hubspot.contacts.search()
```
**API**
@@ -160,7 +164,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -217,7 +221,7 @@ Retrieve all companies, using query parameters to control the information that g
**Python SDK**
```python
hubspot.companies.list()
await hubspot.companies.list()
```
**API**
@@ -233,7 +237,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -280,7 +284,7 @@ Get a single company by ID
**Python SDK**
```python
hubspot.companies.get(
await hubspot.companies.get(
company_id="<str>"
)
```
@@ -301,7 +305,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -341,7 +345,7 @@ Search for companies by filtering on properties, searching through associations,
**Python SDK**
```python
hubspot.companies.search()
await hubspot.companies.search()
```
**API**
@@ -357,7 +361,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -414,7 +418,7 @@ Returns a paginated list of deals
**Python SDK**
```python
hubspot.deals.list()
await hubspot.deals.list()
```
**API**
@@ -430,7 +434,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -477,7 +481,7 @@ Get a single deal by ID
**Python SDK**
```python
hubspot.deals.get(
await hubspot.deals.get(
deal_id="<str>"
)
```
@@ -498,7 +502,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -538,7 +542,7 @@ Search deals with filters and sorting
**Python SDK**
```python
hubspot.deals.search()
await hubspot.deals.search()
```
**API**
@@ -554,7 +558,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -611,7 +615,7 @@ Returns a paginated list of tickets
**Python SDK**
```python
hubspot.tickets.list()
await hubspot.tickets.list()
```
**API**
@@ -627,7 +631,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -674,7 +678,7 @@ Get a single ticket by ID
**Python SDK**
```python
hubspot.tickets.get(
await hubspot.tickets.get(
ticket_id="<str>"
)
```
@@ -695,7 +699,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -735,7 +739,7 @@ Search for tickets by filtering on properties, searching through associations, a
**Python SDK**
```python
hubspot.tickets.search()
await hubspot.tickets.search()
```
**API**
@@ -751,7 +755,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -808,7 +812,7 @@ Returns all custom object schemas to discover available custom objects
**Python SDK**
```python
hubspot.schemas.list()
await hubspot.schemas.list()
```
**API**
@@ -824,7 +828,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -869,7 +873,7 @@ Get the schema for a specific custom object type
**Python SDK**
```python
hubspot.schemas.get(
await hubspot.schemas.get(
object_type="<str>"
)
```
@@ -890,7 +894,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -937,7 +941,7 @@ Read a page of objects. Control what is returned via the properties query param.
**Python SDK**
```python
hubspot.objects.list(
await hubspot.objects.list(
object_type="<str>"
)
```
@@ -958,7 +962,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1006,7 +1010,7 @@ Read an Object identified by \{objectId\}. \{objectId\} refers to the internal o
**Python SDK**
```python
hubspot.objects.get(
await hubspot.objects.get(
object_type="<str>",
object_id="<str>"
)
@@ -1029,7 +1033,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1067,7 +1071,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
## Authentication
The Hubspot connector supports the following authentication methods:
The Hubspot connector supports the following authentication methods.
### OAuth2 Authentication

View File

@@ -1,4 +1,19 @@
# Changelog
# Jira changelog
## [0.1.11] - 2025-12-18
- Updated connector definition (YAML version 1.0.2)
- Source commit: f7c55d3e
- SDK version: 0.1.0
## [0.1.10] - 2025-12-17
- Updated connector definition (YAML version 1.0.2)
- Source commit: af456521
- SDK version: 0.1.0
## [0.1.9] - 2025-12-17
- Updated connector definition (YAML version 1.0.2)
- Source commit: 6a6c981e
- SDK version: 0.1.0
## [0.1.8] - 2025-12-15
- Updated connector definition (YAML version 1.0.2)

View File

@@ -1,4 +1,4 @@
# Airbyte Jira AI Connector
# Jira agent connector
Connector for Jira API
@@ -19,10 +19,12 @@ connector = JiraConnector(
password="..."
)
)
result = connector.issues.search()
result = await connector.issues.search()
```
## Documentation
## Full documentation
This connector supports the following entities and actions.
| Entity | Actions |
|--------|---------|
@@ -34,14 +36,12 @@ result = connector.issues.search()
| Issue Worklogs | [List](./REFERENCE.md#issue-worklogs-list), [Get](./REFERENCE.md#issue-worklogs-get) |
For detailed documentation on available actions and parameters, see [REFERENCE.md](./REFERENCE.md).
For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).
For the service's official API docs, see [Jira API Reference](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/).
For the service's official API docs, see the [Jira API reference](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/).
## Version Information
## Version information
**Package Version:** 0.1.8
**Connector Version:** 1.0.2
**Generated with connector-sdk:** c4c39c2797ecd929407c9417c728d425f77b37ed
- **Package version:** 0.1.11
- **Connector version:** 1.0.2
- **Generated with Connector SDK commit SHA:** f7c55d3e3cdc7568cab2da9d736285eec58f044b

View File

@@ -1,6 +1,10 @@
# Jira
# Jira full reference
## Supported Entities and Actions
This is the full reference documentation for the Jira agent connector.
## Supported entities and actions
The Jira connector supports the following entities and actions.
| Entity | Actions |
|--------|---------|
@@ -20,7 +24,7 @@ Retrieve issues based on JQL query with pagination support
**Python SDK**
```python
jira.issues.search()
await jira.issues.search()
```
**API**
@@ -36,7 +40,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -81,7 +85,7 @@ Retrieve a single issue by its ID or key
**Python SDK**
```python
jira.issues.get(
await jira.issues.get(
issue_id_or_key="<str>"
)
```
@@ -102,7 +106,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -140,7 +144,7 @@ Search and filter projects with advanced query parameters
**Python SDK**
```python
jira.projects.search()
await jira.projects.search()
```
**API**
@@ -156,7 +160,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -220,7 +224,7 @@ Retrieve a single project by its ID or key
**Python SDK**
```python
jira.projects.get(
await jira.projects.get(
project_id_or_key="<str>"
)
```
@@ -241,7 +245,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -292,7 +296,7 @@ Retrieve a single user by their account ID
**Python SDK**
```python
jira.users.get(
await jira.users.get(
account_id="<str>"
)
```
@@ -313,7 +317,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -351,7 +355,7 @@ Returns a paginated list of users
**Python SDK**
```python
jira.users.list()
await jira.users.list()
```
**API**
@@ -367,7 +371,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -382,7 +386,7 @@ Search for users using a query string
**Python SDK**
```python
jira.users.search()
await jira.users.search()
```
**API**
@@ -398,7 +402,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -418,7 +422,7 @@ Returns a list of all custom and system fields
**Python SDK**
```python
jira.issue_fields.list()
await jira.issue_fields.list()
```
**API**
@@ -442,7 +446,7 @@ Search and filter issue fields with query parameters
**Python SDK**
```python
jira.issue_fields.search()
await jira.issue_fields.search()
```
**API**
@@ -458,7 +462,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -513,7 +517,7 @@ Retrieve all comments for a specific issue
**Python SDK**
```python
jira.issue_comments.list(
await jira.issue_comments.list(
issue_id_or_key="<str>"
)
```
@@ -534,7 +538,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -582,7 +586,7 @@ Retrieve a single comment by its ID
**Python SDK**
```python
jira.issue_comments.get(
await jira.issue_comments.get(
issue_id_or_key="<str>",
comment_id="<str>"
)
@@ -605,7 +609,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -645,7 +649,7 @@ Retrieve all worklogs for a specific issue
**Python SDK**
```python
jira.issue_worklogs.list(
await jira.issue_worklogs.list(
issue_id_or_key="<str>"
)
```
@@ -666,7 +670,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -715,7 +719,7 @@ Retrieve a single worklog by its ID
**Python SDK**
```python
jira.issue_worklogs.get(
await jira.issue_worklogs.get(
issue_id_or_key="<str>",
worklog_id="<str>"
)
@@ -738,7 +742,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -775,18 +779,16 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
## Configuration
The connector requires the following configuration variables:
The Jira connector requires the following configuration variables. These variables are used to construct the base API URL. Pass them via the `config` parameter when initializing the connector.
| Variable | Type | Required | Default | Description |
|----------|------|----------|---------|-------------|
| `subdomain` | `string` | Yes | \{subdomain\} | Your Jira Cloud subdomain |
These variables are used to construct the base API URL. Pass them via the `config` parameter when initializing the connector.
## Authentication
The Jira connector supports the following authentication methods:
The Jira connector supports the following authentication methods.
### Authentication

View File

@@ -1,4 +1,19 @@
# Changelog
# Linear changelog
## [0.19.20] - 2025-12-18
- Updated connector definition (YAML version 0.1.1)
- Source commit: f7c55d3e
- SDK version: 0.1.0
## [0.19.19] - 2025-12-17
- Updated connector definition (YAML version 0.1.1)
- Source commit: af456521
- SDK version: 0.1.0
## [0.19.18] - 2025-12-17
- Updated connector definition (YAML version 0.1.1)
- Source commit: 6a6c981e
- SDK version: 0.1.0
## [0.19.17] - 2025-12-15
- Updated connector definition (YAML version 0.1.1)

View File

@@ -1,11 +1,11 @@
# Airbyte Linear AI Connector
# Linear agent connector
Linear is a modern issue tracking and project management tool built for software
development teams. This connector provides access to issues, projects, and teams
for sprint planning, backlog management, and development workflow analysis.
## Example Questions
## Example questions
- Show me the open issues assigned to my team this week
- List out all projects I'm currently involved in
@@ -17,7 +17,7 @@ for sprint planning, backlog management, and development workflow analysis.
- Which projects have the most unresolved issues?
- Give me an overview of my team's current project backlog
## Unsupported Questions
## Unsupported questions
- Create a new issue for the backend team
- Update the priority of this specific issue
@@ -42,10 +42,12 @@ connector = LinearConnector(
api_key="..."
)
)
result = connector.issues.list()
result = await connector.issues.list()
```
## Documentation
## Full documentation
This connector supports the following entities and actions.
| Entity | Actions |
|--------|---------|
@@ -54,14 +56,12 @@ result = connector.issues.list()
| Teams | [List](./REFERENCE.md#teams-list), [Get](./REFERENCE.md#teams-get) |
For detailed documentation on available actions and parameters, see [REFERENCE.md](./REFERENCE.md).
For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).
For the service's official API docs, see [Linear API Reference](https://linear.app/developers/graphql).
For the service's official API docs, see the [Linear API reference](https://linear.app/developers/graphql).
## Version Information
## Version information
**Package Version:** 0.19.17
**Connector Version:** 0.1.1
**Generated with connector-sdk:** c4c39c2797ecd929407c9417c728d425f77b37ed
- **Package version:** 0.19.20
- **Connector version:** 0.1.1
- **Generated with Connector SDK commit SHA:** f7c55d3e3cdc7568cab2da9d736285eec58f044b

View File

@@ -1,6 +1,10 @@
# Linear
# Linear full reference
## Supported Entities and Actions
This is the full reference documentation for the Linear agent connector.
## Supported entities and actions
The Linear connector supports the following entities and actions.
| Entity | Actions |
|--------|---------|
@@ -17,7 +21,7 @@ Returns a paginated list of issues via GraphQL with pagination support
**Python SDK**
```python
linear.issues.list()
await linear.issues.list()
```
**API**
@@ -33,7 +37,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -60,7 +64,7 @@ Get a single issue by ID via GraphQL
**Python SDK**
```python
linear.issues.get(
await linear.issues.get(
id="<str>"
)
```
@@ -81,7 +85,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -109,7 +113,7 @@ Returns a paginated list of projects via GraphQL with pagination support
**Python SDK**
```python
linear.projects.list()
await linear.projects.list()
```
**API**
@@ -125,7 +129,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -152,7 +156,7 @@ Get a single project by ID via GraphQL
**Python SDK**
```python
linear.projects.get(
await linear.projects.get(
id="<str>"
)
```
@@ -173,7 +177,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -201,7 +205,7 @@ Returns a list of teams via GraphQL with pagination support
**Python SDK**
```python
linear.teams.list()
await linear.teams.list()
```
**API**
@@ -217,7 +221,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -244,7 +248,7 @@ Get a single team by ID via GraphQL
**Python SDK**
```python
linear.teams.get(
await linear.teams.get(
id="<str>"
)
```
@@ -265,7 +269,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -288,7 +292,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
## Authentication
The Linear connector supports the following authentication methods:
The Linear connector supports the following authentication methods.
### Authentication

View File

@@ -1,4 +1,19 @@
# Changelog
# Salesforce changelog
## [0.1.14] - 2025-12-18
- Updated connector definition (YAML version 1.0.3)
- Source commit: f7c55d3e
- SDK version: 0.1.0
## [0.1.13] - 2025-12-17
- Updated connector definition (YAML version 1.0.3)
- Source commit: af456521
- SDK version: 0.1.0
## [0.1.12] - 2025-12-17
- Updated connector definition (YAML version 1.0.3)
- Source commit: 6a6c981e
- SDK version: 0.1.0
## [0.1.11] - 2025-12-15
- Updated connector definition (YAML version 1.0.3)

View File

@@ -1,4 +1,4 @@
# Airbyte Salesforce AI Connector
# Salesforce agent connector
Salesforce is a cloud-based CRM platform that helps businesses manage customer
relationships, sales pipelines, and business operations. This connector provides
@@ -6,7 +6,7 @@ access to accounts, contacts, leads, opportunities, tasks, events, campaigns, ca
notes, and attachments for sales analytics and customer relationship management.
## Example Questions
## Example questions
- Show me my top 5 opportunities this month
- List all contacts from [Company] in the last quarter
@@ -18,7 +18,7 @@ notes, and attachments for sales analytics and customer relationship management.
- Identify the highest value opportunities I'm currently tracking
- Show me the notes and attachments for [customerX]'s account
## Unsupported Questions
## Unsupported questions
- Create a new lead for [personX]
- Update the status of my sales opportunity
@@ -44,10 +44,12 @@ connector = SalesforceConnector(
client_secret="..."
)
)
result = connector.accounts.list()
result = await connector.accounts.list()
```
## Documentation
## Full documentation
This connector supports the following entities and actions.
| Entity | Actions |
|--------|---------|
@@ -65,14 +67,12 @@ result = connector.accounts.list()
| Query | [List](./REFERENCE.md#query-list) |
For detailed documentation on available actions and parameters, see [REFERENCE.md](./REFERENCE.md).
For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).
For the service's official API docs, see [Salesforce API Reference](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_rest.htm).
For the service's official API docs, see the [Salesforce API reference](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_rest.htm).
## Version Information
## Version information
**Package Version:** 0.1.11
**Connector Version:** 1.0.3
**Generated with connector-sdk:** c4c39c2797ecd929407c9417c728d425f77b37ed
- **Package version:** 0.1.14
- **Connector version:** 1.0.3
- **Generated with Connector SDK commit SHA:** f7c55d3e3cdc7568cab2da9d736285eec58f044b

View File

@@ -1,6 +1,10 @@
# Salesforce
# Salesforce full reference
## Supported Entities and Actions
This is the full reference documentation for the Salesforce agent connector.
## Supported entities and actions
The Salesforce connector supports the following entities and actions.
| Entity | Actions |
|--------|---------|
@@ -28,7 +32,7 @@ For pagination, check the response: if `done` is false, use `nextRecordsUrl` to
**Python SDK**
```python
salesforce.accounts.list(
await salesforce.accounts.list(
q="<str>"
)
```
@@ -49,7 +53,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -86,7 +90,7 @@ Use the `fields` parameter to retrieve only specific fields for better performan
**Python SDK**
```python
salesforce.accounts.get(
await salesforce.accounts.get(
id="<str>"
)
```
@@ -107,7 +111,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -141,7 +145,7 @@ Use SOQL (list action) for structured queries with specific field conditions.
**Python SDK**
```python
salesforce.accounts.search(
await salesforce.accounts.search(
q="<str>"
)
```
@@ -162,7 +166,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -197,7 +201,7 @@ For pagination, check the response: if `done` is false, use `nextRecordsUrl` to
**Python SDK**
```python
salesforce.contacts.list(
await salesforce.contacts.list(
q="<str>"
)
```
@@ -218,7 +222,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -255,7 +259,7 @@ Use the `fields` parameter to retrieve only specific fields for better performan
**Python SDK**
```python
salesforce.contacts.get(
await salesforce.contacts.get(
id="<str>"
)
```
@@ -276,7 +280,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -309,7 +313,7 @@ SOSL is optimized for text-based searches across multiple fields.
**Python SDK**
```python
salesforce.contacts.search(
await salesforce.contacts.search(
q="<str>"
)
```
@@ -330,7 +334,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -364,7 +368,7 @@ For pagination, check the response: if `done` is false, use `nextRecordsUrl` to
**Python SDK**
```python
salesforce.leads.list(
await salesforce.leads.list(
q="<str>"
)
```
@@ -385,7 +389,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -422,7 +426,7 @@ Use the `fields` parameter to retrieve only specific fields for better performan
**Python SDK**
```python
salesforce.leads.get(
await salesforce.leads.get(
id="<str>"
)
```
@@ -443,7 +447,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -476,7 +480,7 @@ SOSL is optimized for text-based searches across multiple fields.
**Python SDK**
```python
salesforce.leads.search(
await salesforce.leads.search(
q="<str>"
)
```
@@ -497,7 +501,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -531,7 +535,7 @@ For pagination, check the response: if `done` is false, use `nextRecordsUrl` to
**Python SDK**
```python
salesforce.opportunities.list(
await salesforce.opportunities.list(
q="<str>"
)
```
@@ -552,7 +556,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -589,7 +593,7 @@ Use the `fields` parameter to retrieve only specific fields for better performan
**Python SDK**
```python
salesforce.opportunities.get(
await salesforce.opportunities.get(
id="<str>"
)
```
@@ -610,7 +614,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -643,7 +647,7 @@ SOSL is optimized for text-based searches across multiple fields.
**Python SDK**
```python
salesforce.opportunities.search(
await salesforce.opportunities.search(
q="<str>"
)
```
@@ -664,7 +668,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -698,7 +702,7 @@ For pagination, check the response: if `done` is false, use `nextRecordsUrl` to
**Python SDK**
```python
salesforce.tasks.list(
await salesforce.tasks.list(
q="<str>"
)
```
@@ -719,7 +723,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -756,7 +760,7 @@ Use the `fields` parameter to retrieve only specific fields for better performan
**Python SDK**
```python
salesforce.tasks.get(
await salesforce.tasks.get(
id="<str>"
)
```
@@ -777,7 +781,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -810,7 +814,7 @@ SOSL is optimized for text-based searches across multiple fields.
**Python SDK**
```python
salesforce.tasks.search(
await salesforce.tasks.search(
q="<str>"
)
```
@@ -831,7 +835,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -865,7 +869,7 @@ For pagination, check the response: if `done` is false, use `nextRecordsUrl` to
**Python SDK**
```python
salesforce.events.list(
await salesforce.events.list(
q="<str>"
)
```
@@ -886,7 +890,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -923,7 +927,7 @@ Use the `fields` parameter to retrieve only specific fields for better performan
**Python SDK**
```python
salesforce.events.get(
await salesforce.events.get(
id="<str>"
)
```
@@ -944,7 +948,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -977,7 +981,7 @@ SOSL is optimized for text-based searches across multiple fields.
**Python SDK**
```python
salesforce.events.search(
await salesforce.events.search(
q="<str>"
)
```
@@ -998,7 +1002,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1032,7 +1036,7 @@ For pagination, check the response: if `done` is false, use `nextRecordsUrl` to
**Python SDK**
```python
salesforce.campaigns.list(
await salesforce.campaigns.list(
q="<str>"
)
```
@@ -1053,7 +1057,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1090,7 +1094,7 @@ Use the `fields` parameter to retrieve only specific fields for better performan
**Python SDK**
```python
salesforce.campaigns.get(
await salesforce.campaigns.get(
id="<str>"
)
```
@@ -1111,7 +1115,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1144,7 +1148,7 @@ SOSL is optimized for text-based searches across multiple fields.
**Python SDK**
```python
salesforce.campaigns.search(
await salesforce.campaigns.search(
q="<str>"
)
```
@@ -1165,7 +1169,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1199,7 +1203,7 @@ For pagination, check the response: if `done` is false, use `nextRecordsUrl` to
**Python SDK**
```python
salesforce.cases.list(
await salesforce.cases.list(
q="<str>"
)
```
@@ -1220,7 +1224,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1258,7 +1262,7 @@ Use the `fields` parameter to retrieve only specific fields for better performan
**Python SDK**
```python
salesforce.cases.get(
await salesforce.cases.get(
id="<str>"
)
```
@@ -1279,7 +1283,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1313,7 +1317,7 @@ SOSL is optimized for text-based searches across multiple fields.
**Python SDK**
```python
salesforce.cases.search(
await salesforce.cases.search(
q="<str>"
)
```
@@ -1334,7 +1338,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1368,7 +1372,7 @@ For pagination, check the response: if `done` is false, use `nextRecordsUrl` to
**Python SDK**
```python
salesforce.notes.list(
await salesforce.notes.list(
q="<str>"
)
```
@@ -1389,7 +1393,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1426,7 +1430,7 @@ Use the `fields` parameter to retrieve only specific fields for better performan
**Python SDK**
```python
salesforce.notes.get(
await salesforce.notes.get(
id="<str>"
)
```
@@ -1447,7 +1451,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1480,7 +1484,7 @@ SOSL is optimized for text-based searches across multiple fields.
**Python SDK**
```python
salesforce.notes.search(
await salesforce.notes.search(
q="<str>"
)
```
@@ -1501,7 +1505,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1536,7 +1540,7 @@ Note: ContentVersion does not support FIELDS(STANDARD), so specific fields must
**Python SDK**
```python
salesforce.content_versions.list(
await salesforce.content_versions.list(
q="<str>"
)
```
@@ -1557,7 +1561,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1599,7 +1603,7 @@ Use the download action to retrieve the actual file binary.
**Python SDK**
```python
salesforce.content_versions.get(
await salesforce.content_versions.get(
id="<str>"
)
```
@@ -1620,7 +1624,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1682,7 +1686,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1704,7 +1708,7 @@ Note: Attachments are a legacy feature; consider using ContentVersion (Salesforc
**Python SDK**
```python
salesforce.attachments.list(
await salesforce.attachments.list(
q="<str>"
)
```
@@ -1725,7 +1729,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1766,7 +1770,7 @@ Note: Attachments are a legacy feature; consider using ContentVersion for new im
**Python SDK**
```python
salesforce.attachments.get(
await salesforce.attachments.get(
id="<str>"
)
```
@@ -1787,7 +1791,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1847,7 +1851,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1868,7 +1872,7 @@ For pagination, check the response: if `done` is false, use `nextRecordsUrl` to
**Python SDK**
```python
salesforce.query.list(
await salesforce.query.list(
q="<str>"
)
```
@@ -1889,7 +1893,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1920,18 +1924,16 @@ Examples:
## Configuration
The connector requires the following configuration variables:
The Salesforce connector requires the following configuration variables. These variables are used to construct the base API URL. Pass them via the `config` parameter when initializing the connector.
| Variable | Type | Required | Default | Description |
|----------|------|----------|---------|-------------|
| `instance_url` | `string` | Yes | https://login.salesforce.com | Your Salesforce instance URL (e.g., https://na1.salesforce.com) |
These variables are used to construct the base API URL. Pass them via the `config` parameter when initializing the connector.
## Authentication
The Salesforce connector supports the following authentication methods:
The Salesforce connector supports the following authentication methods.
### Salesforce OAuth 2.0

View File

@@ -1,4 +1,19 @@
# Changelog
# Stripe changelog
## [0.5.21] - 2025-12-18
- Updated connector definition (YAML version 0.1.2)
- Source commit: f7c55d3e
- SDK version: 0.1.0
## [0.5.20] - 2025-12-17
- Updated connector definition (YAML version 0.1.2)
- Source commit: af456521
- SDK version: 0.1.0
## [0.5.19] - 2025-12-17
- Updated connector definition (YAML version 0.1.2)
- Source commit: 6a6c981e
- SDK version: 0.1.0
## [0.5.18] - 2025-12-15
- Updated connector definition (YAML version 0.1.2)

View File

@@ -1,11 +1,11 @@
# Airbyte Stripe AI Connector
# Stripe agent connector
Stripe is a payment processing platform that enables businesses to accept payments,
manage subscriptions, and handle financial transactions. This connector provides
access to customers for payment analytics and customer management.
## Example Questions
## Example questions
- Show me my top 10 customers by total revenue this month
- List all customers who have spent over $5,000 in the last quarter
@@ -18,7 +18,7 @@ access to customers for payment analytics and customer management.
- What are the key financial insights from my customer base?
- Break down my customers by their average transaction value
## Unsupported Questions
## Unsupported questions
- Create a new customer profile in Stripe
- Update the billing information for [customerX]
@@ -42,10 +42,12 @@ connector = StripeConnector(
api_key="..."
)
)
result = connector.customers.list()
result = await connector.customers.list()
```
## Documentation
## Full documentation
This connector supports the following entities and actions.
| Entity | Actions |
|--------|---------|
@@ -62,14 +64,12 @@ result = connector.customers.list()
| Payouts | [List](./REFERENCE.md#payouts-list), [Get](./REFERENCE.md#payouts-get) |
For detailed documentation on available actions and parameters, see [REFERENCE.md](./REFERENCE.md).
For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).
For the service's official API docs, see [Stripe API Reference](https://docs.stripe.com/api).
For the service's official API docs, see the [Stripe API reference](https://docs.stripe.com/api).
## Version Information
## Version information
**Package Version:** 0.5.18
**Connector Version:** 0.1.2
**Generated with connector-sdk:** c4c39c2797ecd929407c9417c728d425f77b37ed
- **Package version:** 0.5.21
- **Connector version:** 0.1.2
- **Generated with Connector SDK commit SHA:** f7c55d3e3cdc7568cab2da9d736285eec58f044b

View File

@@ -1,6 +1,10 @@
# Stripe
# Stripe full reference
## Supported Entities and Actions
This is the full reference documentation for the Stripe agent connector.
## Supported entities and actions
The Stripe connector supports the following entities and actions.
| Entity | Actions |
|--------|---------|
@@ -25,7 +29,7 @@ Returns a list of your customers. The customers are returned sorted by creation
**Python SDK**
```python
stripe.customers.list()
await stripe.customers.list()
```
**API**
@@ -41,7 +45,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -110,7 +114,7 @@ Retrieves a Customer object.
**Python SDK**
```python
stripe.customers.get(
await stripe.customers.get(
id="<str>"
)
```
@@ -131,7 +135,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -186,7 +190,7 @@ Search for customers using Stripe's Search Query Language.
**Python SDK**
```python
stripe.customers.search(
await stripe.customers.search(
query="<str>"
)
```
@@ -207,7 +211,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -272,7 +276,7 @@ Returns a list of invoices
**Python SDK**
```python
stripe.invoices.list()
await stripe.invoices.list()
```
**API**
@@ -288,7 +292,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -421,7 +425,7 @@ Retrieves the invoice with the given ID
**Python SDK**
```python
stripe.invoices.get(
await stripe.invoices.get(
id="<str>"
)
```
@@ -442,7 +446,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -557,7 +561,7 @@ Search for invoices using Stripe's Search Query Language
**Python SDK**
```python
stripe.invoices.search(
await stripe.invoices.search(
query="<str>"
)
```
@@ -578,7 +582,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -702,7 +706,7 @@ Returns a list of charges you've previously created. The charges are returned in
**Python SDK**
```python
stripe.charges.list()
await stripe.charges.list()
```
**API**
@@ -718,7 +722,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -808,7 +812,7 @@ Retrieves the details of a charge that has previously been created
**Python SDK**
```python
stripe.charges.get(
await stripe.charges.get(
id="<str>"
)
```
@@ -829,7 +833,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -904,7 +908,7 @@ Search for charges using Stripe's Search Query Language
**Python SDK**
```python
stripe.charges.search(
await stripe.charges.search(
query="<str>"
)
```
@@ -925,7 +929,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1009,7 +1013,7 @@ By default, returns a list of subscriptions that have not been canceled
**Python SDK**
```python
stripe.subscriptions.list()
await stripe.subscriptions.list()
```
**API**
@@ -1025,7 +1029,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1130,7 +1134,7 @@ Retrieves the subscription with the given ID
**Python SDK**
```python
stripe.subscriptions.get(
await stripe.subscriptions.get(
id="<str>"
)
```
@@ -1151,7 +1155,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1226,7 +1230,7 @@ Search for subscriptions using Stripe's Search Query Language
**Python SDK**
```python
stripe.subscriptions.search(
await stripe.subscriptions.search(
query="<str>"
)
```
@@ -1247,7 +1251,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1331,7 +1335,7 @@ Returns a list of all refunds you've previously created. The refunds are returne
**Python SDK**
```python
stripe.refunds.list()
await stripe.refunds.list()
```
**API**
@@ -1347,7 +1351,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1408,7 +1412,7 @@ Retrieves the details of an existing refund
**Python SDK**
```python
stripe.refunds.get(
await stripe.refunds.get(
id="<str>"
)
```
@@ -1429,7 +1433,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1477,7 +1481,7 @@ Returns a list of your products. The products are returned sorted by creation da
**Python SDK**
```python
stripe.products.list()
await stripe.products.list()
```
**API**
@@ -1493,7 +1497,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1556,7 +1560,7 @@ Retrieves the details of an existing product. Supply the unique product ID and S
**Python SDK**
```python
stripe.products.get(
await stripe.products.get(
id="<str>"
)
```
@@ -1577,7 +1581,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1623,7 +1627,7 @@ Search for products using Stripe's Search Query Language.
**Python SDK**
```python
stripe.products.search(
await stripe.products.search(
query="<str>"
)
```
@@ -1644,7 +1648,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1700,7 +1704,7 @@ Retrieves the current account balance, based on the authentication that was used
**Python SDK**
```python
stripe.balance.get()
await stripe.balance.get()
```
**API**
@@ -1745,7 +1749,7 @@ Returns a list of transactions that have contributed to the Stripe account balan
**Python SDK**
```python
stripe.balance_transactions.list()
await stripe.balance_transactions.list()
```
**API**
@@ -1761,7 +1765,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1819,7 +1823,7 @@ Retrieves the balance transaction with the given ID.
**Python SDK**
```python
stripe.balance_transactions.get(
await stripe.balance_transactions.get(
id="<str>"
)
```
@@ -1840,7 +1844,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1883,7 +1887,7 @@ Returns a list of PaymentIntents. The payment intents are returned sorted by cre
**Python SDK**
```python
stripe.payment_intents.list()
await stripe.payment_intents.list()
```
**API**
@@ -1899,7 +1903,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1958,7 +1962,7 @@ Retrieves the details of a PaymentIntent that has previously been created.
**Python SDK**
```python
stripe.payment_intents.get(
await stripe.payment_intents.get(
id="<str>"
)
```
@@ -1979,7 +1983,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -2023,7 +2027,7 @@ Search for payment intents using Stripe's Search Query Language.
**Python SDK**
```python
stripe.payment_intents.search(
await stripe.payment_intents.search(
query="<str>"
)
```
@@ -2044,7 +2048,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -2098,7 +2102,7 @@ Returns a list of your disputes. The disputes are returned sorted by creation da
**Python SDK**
```python
stripe.disputes.list()
await stripe.disputes.list()
```
**API**
@@ -2114,7 +2118,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -2171,7 +2175,7 @@ Retrieves the dispute with the given ID.
**Python SDK**
```python
stripe.disputes.get(
await stripe.disputes.get(
id="<str>"
)
```
@@ -2192,7 +2196,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -2236,7 +2240,7 @@ Returns a list of existing payouts sent to third-party bank accounts or payouts
**Python SDK**
```python
stripe.payouts.list()
await stripe.payouts.list()
```
**API**
@@ -2252,7 +2256,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -2325,7 +2329,7 @@ Retrieves the details of an existing payout. Supply the unique payout ID from ei
**Python SDK**
```python
stripe.payouts.get(
await stripe.payouts.get(
id="<str>"
)
```
@@ -2346,7 +2350,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -2396,7 +2400,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
## Authentication
The Stripe connector supports the following authentication methods:
The Stripe connector supports the following authentication methods.
### API Key Authentication

View File

@@ -1,4 +1,19 @@
# Changelog
# Zendesk Support changelog
## [0.18.21] - 2025-12-18
- Updated connector definition (YAML version 0.1.3)
- Source commit: f7c55d3e
- SDK version: 0.1.0
## [0.18.20] - 2025-12-17
- Updated connector definition (YAML version 0.1.3)
- Source commit: af456521
- SDK version: 0.1.0
## [0.18.19] - 2025-12-17
- Updated connector definition (YAML version 0.1.3)
- Source commit: 6a6c981e
- SDK version: 0.1.0
## [0.18.18] - 2025-12-15
- Updated connector definition (YAML version 0.1.3)

View File

@@ -1,4 +1,4 @@
# Airbyte Zendesk-Support AI Connector
# Zendesk-Support agent connector
Zendesk Support is a customer service platform that helps businesses manage support
tickets, customer interactions, and help center content. This connector provides
@@ -7,7 +7,7 @@ triggers, macros, views, satisfaction ratings, SLA policies, and help center art
for customer support analytics and service performance insights.
## Example Questions
## Example questions
- Show me the tickets assigned to me last week
- What are the top 5 support issues our organization has faced this month?
@@ -18,7 +18,7 @@ for customer support analytics and service performance insights.
- Identify the most common ticket fields used in our support workflow
- Summarize the performance of our SLA policies this quarter
## Unsupported Questions
## Unsupported questions
- Create a new support ticket for [customerX]
- Update the priority of this ticket
@@ -43,10 +43,12 @@ connector = ZendeskSupportConnector(
refresh_token="..."
)
)
result = connector.tickets.list()
result = await connector.tickets.list()
```
## Documentation
## Full documentation
This connector supports the following entities and actions.
| Entity | Actions |
|--------|---------|
@@ -74,14 +76,12 @@ result = connector.tickets.list()
| Article Attachments | [List](./REFERENCE.md#article-attachments-list), [Get](./REFERENCE.md#article-attachments-get), [Download](./REFERENCE.md#article-attachments-download) |
For detailed documentation on available actions and parameters, see [REFERENCE.md](./REFERENCE.md).
For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).
For the service's official API docs, see [Zendesk-Support API Reference](https://developer.zendesk.com/api-reference/ticketing/introduction/).
For the service's official API docs, see the [Zendesk-Support API reference](https://developer.zendesk.com/api-reference/ticketing/introduction/).
## Version Information
## Version information
**Package Version:** 0.18.18
**Connector Version:** 0.1.3
**Generated with connector-sdk:** c4c39c2797ecd929407c9417c728d425f77b37ed
- **Package version:** 0.18.21
- **Connector version:** 0.1.3
- **Generated with Connector SDK commit SHA:** f7c55d3e3cdc7568cab2da9d736285eec58f044b

View File

@@ -1,6 +1,10 @@
# Zendesk-Support
# Zendesk-Support full reference
## Supported Entities and Actions
This is the full reference documentation for the Zendesk-Support agent connector.
## Supported entities and actions
The Zendesk-Support connector supports the following entities and actions.
| Entity | Actions |
|--------|---------|
@@ -36,7 +40,7 @@ Returns a list of all tickets in your account
**Python SDK**
```python
zendesk_support.tickets.list()
await zendesk_support.tickets.list()
```
**API**
@@ -52,7 +56,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -126,7 +130,7 @@ Returns a ticket by its ID
**Python SDK**
```python
zendesk_support.tickets.get(
await zendesk_support.tickets.get(
ticket_id=0
)
```
@@ -147,7 +151,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -213,7 +217,7 @@ Returns a list of all users in your account
**Python SDK**
```python
zendesk_support.users.list()
await zendesk_support.users.list()
```
**API**
@@ -229,7 +233,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -302,7 +306,7 @@ Returns a user by their ID
**Python SDK**
```python
zendesk_support.users.get(
await zendesk_support.users.get(
user_id=0
)
```
@@ -323,7 +327,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -388,7 +392,7 @@ Returns a list of all organizations in your account
**Python SDK**
```python
zendesk_support.organizations.list()
await zendesk_support.organizations.list()
```
**API**
@@ -404,7 +408,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -451,7 +455,7 @@ Returns an organization by its ID
**Python SDK**
```python
zendesk_support.organizations.get(
await zendesk_support.organizations.get(
organization_id=0
)
```
@@ -472,7 +476,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -513,7 +517,7 @@ Returns a list of all groups in your account
**Python SDK**
```python
zendesk_support.groups.list()
await zendesk_support.groups.list()
```
**API**
@@ -529,7 +533,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -572,7 +576,7 @@ Returns a group by its ID
**Python SDK**
```python
zendesk_support.groups.get(
await zendesk_support.groups.get(
group_id=0
)
```
@@ -593,7 +597,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -629,7 +633,7 @@ Returns a list of comments for a specific ticket
**Python SDK**
```python
zendesk_support.ticket_comments.list(
await zendesk_support.ticket_comments.list(
ticket_id=0
)
```
@@ -650,7 +654,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -700,7 +704,7 @@ Returns an attachment by its ID
**Python SDK**
```python
zendesk_support.attachments.get(
await zendesk_support.attachments.get(
attachment_id=0
)
```
@@ -721,7 +725,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -782,7 +786,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -799,7 +803,7 @@ Returns a list of all ticket audits
**Python SDK**
```python
zendesk_support.ticket_audits.list()
await zendesk_support.ticket_audits.list()
```
**API**
@@ -815,7 +819,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -855,7 +859,7 @@ Returns a list of audits for a specific ticket
**Python SDK**
```python
zendesk_support.ticket_audits.list(
await zendesk_support.ticket_audits.list(
ticket_id=0
)
```
@@ -876,7 +880,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -919,7 +923,7 @@ Returns a list of all ticket metrics
**Python SDK**
```python
zendesk_support.ticket_metrics.list()
await zendesk_support.ticket_metrics.list()
```
**API**
@@ -935,7 +939,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -992,7 +996,7 @@ Returns a list of all ticket fields
**Python SDK**
```python
zendesk_support.ticket_fields.list()
await zendesk_support.ticket_fields.list()
```
**API**
@@ -1008,7 +1012,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1067,7 +1071,7 @@ Returns a ticket field by its ID
**Python SDK**
```python
zendesk_support.ticket_fields.get(
await zendesk_support.ticket_fields.get(
ticket_field_id=0
)
```
@@ -1088,7 +1092,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1140,7 +1144,7 @@ Returns a list of all brands for the account
**Python SDK**
```python
zendesk_support.brands.list()
await zendesk_support.brands.list()
```
**API**
@@ -1156,7 +1160,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1205,7 +1209,7 @@ Returns a brand by its ID
**Python SDK**
```python
zendesk_support.brands.get(
await zendesk_support.brands.get(
brand_id=0
)
```
@@ -1226,7 +1230,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1269,7 +1273,7 @@ Returns a list of all views for the account
**Python SDK**
```python
zendesk_support.views.list()
await zendesk_support.views.list()
```
**API**
@@ -1285,7 +1289,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1335,7 +1339,7 @@ Returns a view by its ID
**Python SDK**
```python
zendesk_support.views.get(
await zendesk_support.views.get(
view_id=0
)
```
@@ -1356,7 +1360,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1395,7 +1399,7 @@ Returns a list of all macros for the account
**Python SDK**
```python
zendesk_support.macros.list()
await zendesk_support.macros.list()
```
**API**
@@ -1411,7 +1415,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1462,7 +1466,7 @@ Returns a macro by its ID
**Python SDK**
```python
zendesk_support.macros.get(
await zendesk_support.macros.get(
macro_id=0
)
```
@@ -1483,7 +1487,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1521,7 +1525,7 @@ Returns a list of all triggers for the account
**Python SDK**
```python
zendesk_support.triggers.list()
await zendesk_support.triggers.list()
```
**API**
@@ -1537,7 +1541,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1585,7 +1589,7 @@ Returns a trigger by its ID
**Python SDK**
```python
zendesk_support.triggers.get(
await zendesk_support.triggers.get(
trigger_id=0
)
```
@@ -1606,7 +1610,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1645,7 +1649,7 @@ Returns a list of all automations for the account
**Python SDK**
```python
zendesk_support.automations.list()
await zendesk_support.automations.list()
```
**API**
@@ -1661,7 +1665,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1706,7 +1710,7 @@ Returns an automation by its ID
**Python SDK**
```python
zendesk_support.automations.get(
await zendesk_support.automations.get(
automation_id=0
)
```
@@ -1727,7 +1731,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1764,7 +1768,7 @@ Returns a list of all tags used in the account
**Python SDK**
```python
zendesk_support.tags.list()
await zendesk_support.tags.list()
```
**API**
@@ -1780,7 +1784,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1817,7 +1821,7 @@ Returns a list of all satisfaction ratings
**Python SDK**
```python
zendesk_support.satisfaction_ratings.list()
await zendesk_support.satisfaction_ratings.list()
```
**API**
@@ -1833,7 +1837,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1882,7 +1886,7 @@ Returns a satisfaction rating by its ID
**Python SDK**
```python
zendesk_support.satisfaction_ratings.get(
await zendesk_support.satisfaction_ratings.get(
satisfaction_rating_id=0
)
```
@@ -1903,7 +1907,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -1943,7 +1947,7 @@ Returns a list of all group memberships
**Python SDK**
```python
zendesk_support.group_memberships.list()
await zendesk_support.group_memberships.list()
```
**API**
@@ -1959,7 +1963,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -2001,7 +2005,7 @@ Returns a list of all organization memberships
**Python SDK**
```python
zendesk_support.organization_memberships.list()
await zendesk_support.organization_memberships.list()
```
**API**
@@ -2017,7 +2021,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -2061,7 +2065,7 @@ Returns a list of all SLA policies
**Python SDK**
```python
zendesk_support.sla_policies.list()
await zendesk_support.sla_policies.list()
```
**API**
@@ -2077,7 +2081,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -2119,7 +2123,7 @@ Returns an SLA policy by its ID
**Python SDK**
```python
zendesk_support.sla_policies.get(
await zendesk_support.sla_policies.get(
sla_policy_id=0
)
```
@@ -2140,7 +2144,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -2176,7 +2180,7 @@ Returns a list of all ticket forms for the account
**Python SDK**
```python
zendesk_support.ticket_forms.list()
await zendesk_support.ticket_forms.list()
```
**API**
@@ -2192,7 +2196,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -2244,7 +2248,7 @@ Returns a ticket form by its ID
**Python SDK**
```python
zendesk_support.ticket_forms.get(
await zendesk_support.ticket_forms.get(
ticket_form_id=0
)
```
@@ -2265,7 +2269,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -2309,7 +2313,7 @@ Returns a list of all articles in the Help Center
**Python SDK**
```python
zendesk_support.articles.list()
await zendesk_support.articles.list()
```
**API**
@@ -2325,7 +2329,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -2376,7 +2380,7 @@ Retrieves the details of a specific article
**Python SDK**
```python
zendesk_support.articles.get(
await zendesk_support.articles.get(
id=0
)
```
@@ -2397,7 +2401,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -2440,7 +2444,7 @@ Returns a list of all attachments for a specific article
**Python SDK**
```python
zendesk_support.article_attachments.list(
await zendesk_support.article_attachments.list(
article_id=0
)
```
@@ -2461,7 +2465,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -2505,7 +2509,7 @@ Retrieves the metadata of a specific attachment for a specific article
**Python SDK**
```python
zendesk_support.article_attachments.get(
await zendesk_support.article_attachments.get(
article_id=0,
attachment_id=0
)
@@ -2528,7 +2532,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -2587,7 +2591,7 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
```
**Params**
**Parameters**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
@@ -2600,18 +2604,16 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connec
## Configuration
The connector requires the following configuration variables:
The Zendesk-Support connector requires the following configuration variables. These variables are used to construct the base API URL. Pass them via the `config` parameter when initializing the connector.
| Variable | Type | Required | Default | Description |
|----------|------|----------|---------|-------------|
| `subdomain` | `string` | Yes | your-subdomain | Your Zendesk subdomain |
These variables are used to construct the base API URL. Pass them via the `config` parameter when initializing the connector.
## Authentication
The Zendesk-Support connector supports the following authentication methods:
The Zendesk-Support connector supports the following authentication methods.
### OAuth 2.0