Module airbyte_agent_sdk.connectors.freshdesk.connector

Freshdesk connector.

Classes

AgentsQuery(connector: FreshdeskConnector) : Query class for Agents entity operations.

Initialize query with connector reference.

Methods

context_store_search(self, query: AgentsSearchQuery, limit: int | None = None, cursor: str | None = None, fields: list[list[str]] | None = None) ‑> airbyte_agent_sdk.connectors.freshdesk.models.AirbyteSearchResult[AgentsSearchData] : Search agents records from Airbyte cache.

This operation searches cached data from Airbyte syncs. Only available in hosted execution mode.

Available filter fields (AgentsSearchFilter):

id: Unique agent ID
available: Whether the agent is available
available_since: Timestamp since the agent has been available
contact: Contact details of the agent including name, email, phone, and job title
occasional: Whether the agent is an occasional agent
signature: Signature of the agent (HTML)
ticket_scope: Ticket scope: 1=Global, 2=Group, 3=Restricted
type_: Agent type: support_agent, field_agent, collaborator
last_active_at: Timestamp of last agent activity
created_at: Agent creation timestamp
updated_at: Agent last update timestamp

Args: query: Filter and sort conditions. Supports operators like eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or. Example: {"filter": {"eq": {"status": "active"}}} limit: Maximum results to return (default 1000) cursor: Pagination cursor from previous response's meta.cursor fields: Field paths to include in results. Each path is a list of keys for nested access. Example: [["id"], ["user", "name"]] returns id and user.name fields.

Returns: AgentsSearchResult with typed records, pagination metadata, and optional search metadata

Raises: NotImplementedError: If called in local execution mode

get(self, id: str | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.freshdesk.models.Agent : Get a single agent by ID

Args: id: Agent ID **kwargs: Additional parameters

Returns: Agent

list(self, per_page: int | None = None, page: int | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.freshdesk.models.FreshdeskExecuteResultWithMeta[list[Agent], AgentsListResultMeta] : Returns a paginated list of agents

Args: per_page: Number of items per page (max 100) page: Page number (starts at 1) **kwargs: Additional parameters

Returns: AgentsListResult

CompaniesQuery(connector: FreshdeskConnector) : Query class for Companies entity operations.

Initialize query with connector reference.

Methods

context_store_search(self, query: CompaniesSearchQuery, limit: int | None = None, cursor: str | None = None, fields: list[list[str]] | None = None) ‑> airbyte_agent_sdk.connectors.freshdesk.models.AirbyteSearchResult[CompaniesSearchData] : Search companies records from Airbyte cache.

This operation searches cached data from Airbyte syncs. Only available in hosted execution mode.

Available filter fields (CompaniesSearchFilter):

id: Unique company ID
name: Name of the company
description: Description of the company
domains: Email domains associated with the company
note: Notes about the company
health_score: Health score of the company
account_tier: Account tier of the company
renewal_date: Renewal date
industry: Industry of the company
custom_fields: Custom fields associated with the company
created_at: Company creation timestamp
updated_at: Company last update timestamp

Returns: CompaniesSearchResult with typed records, pagination metadata, and optional search metadata

Raises: NotImplementedError: If called in local execution mode

get(self, id: str | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.freshdesk.models.Company : Get a single company by ID

Args: id: Company ID **kwargs: Additional parameters

Returns: Company

list(self, per_page: int | None = None, page: int | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.freshdesk.models.FreshdeskExecuteResultWithMeta[list[Company], CompaniesListResultMeta] : Returns a paginated list of companies

Args: per_page: Number of items per page (max 100) page: Page number (starts at 1) **kwargs: Additional parameters

Returns: CompaniesListResult

ContactsQuery(connector: FreshdeskConnector) : Query class for Contacts entity operations.

Initialize query with connector reference.

Methods

context_store_search(self, query: ContactsSearchQuery, limit: int | None = None, cursor: str | None = None, fields: list[list[str]] | None = None) ‑> airbyte_agent_sdk.connectors.freshdesk.models.AirbyteSearchResult[ContactsSearchData] : Search contacts records from Airbyte cache.

This operation searches cached data from Airbyte syncs. Only available in hosted execution mode.

Available filter fields (ContactsSearchFilter):

id: Unique contact ID
name: Name of the contact
email: Primary email address
phone: Phone number
mobile: Mobile number
active: Whether the contact has been verified
address: Address of the contact
company_id: ID of the primary company
custom_fields: Custom fields associated with the contact
description: Description of the contact
job_title: Job title of the contact
language: Language of the contact
twitter_id: Twitter ID
unique_external_id: External ID of the contact
time_zone: Time zone of the contact
facebook_id: Facebook ID of the contact
csat_rating: CSAT rating of the contact
preferred_source: Preferred contact source
created_at: Contact creation timestamp
updated_at: Contact last update timestamp

Returns: ContactsSearchResult with typed records, pagination metadata, and optional search metadata

Raises: NotImplementedError: If called in local execution mode

get(self, id: str | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.freshdesk.models.Contact : Get a single contact by ID

Args: id: Contact ID **kwargs: Additional parameters

Returns: Contact

list(self, per_page: int | None = None, page: int | None = None, updated_since: str | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.freshdesk.models.FreshdeskExecuteResultWithMeta[list[Contact], ContactsListResultMeta] : Returns a paginated list of contacts

Args: per_page: Number of items per page (max 100) page: Page number (starts at 1) updated_since: Return contacts updated since this timestamp (ISO 8601) **kwargs: Additional parameters

Returns: ContactsListResult

Auto-generated from OpenAPI specification with full type safety.

Initialize a new freshdesk connector instance.

Supports both local and hosted execution modes:

Local mode: Provide connector-specific auth config (e.g., FreshdeskAuthConfig)
Hosted mode: Provide AirbyteAuthConfig with client credentials and either connector_id or workspace_name

Args: auth_config: Either connector-specific auth config for local mode, or AirbyteAuthConfig for hosted mode on_token_refresh: Optional callback for OAuth2 token refresh persistence. Called with new_tokens dict when tokens are refreshed. Can be sync or async. Example: lambda tokens: save_to_database(tokens) subdomain: Your Freshdesk subdomain (e.g., "acme" for acme.freshdesk.com) Examples:

Local mode (direct API calls)

connector = FreshdeskConnector(auth_config=FreshdeskAuthConfig(api_key="..."))

Hosted mode with explicit connector_id (no lookup needed)

connector = FreshdeskConnector( auth_config=AirbyteAuthConfig( airbyte_client_id="client_abc123", airbyte_client_secret="secret_xyz789", connector_id="existing-source-uuid" ) )

Hosted mode with lookup by workspace_name

connector = FreshdeskConnector( auth_config=AirbyteAuthConfig( workspace_name="user-123", organization_id="00000000-0000-0000-0000-000000000123", airbyte_client_id="client_abc123", airbyte_client_secret="secret_xyz789" ) )

Class variables

connector_name : The type of the None singleton.

connector_version : The type of the None singleton.

sdk_version : The type of the None singleton.

Static methods

tool_utils(func: _F | None = None, *, update_docstring: bool = True, max_output_chars: int | None = 100000, framework: FrameworkName | None = None, internal_retries: int = 0, should_internal_retry: Callable[[Exception, tuple[Any, ...], dict[str, Any]], bool] | None = None, exhausted_runtime_failure_message: Callable[[Exception, tuple[Any, ...], dict[str, Any]], str | None] | None = None) ‑> ~_F | Callable[[~_F], ~_F] : Decorator that adds tool utilities like docstring augmentation and output limits.

Composes :func:airbyte_agent_sdk.translation.translate_exceptions for runtime wrapping (sync/async branch + output-size check + framework signal translation + optional internal retry loop), and adds connector-specific docstring augmentation on top of it.

Usage: @mcp.tool() @FreshdeskConnector.tool_utils async def execute(entity: str, action: str, params: dict): ...

@mcp.tool() @FreshdeskConnector.tool_utils(update_docstring=False, max_output_chars=None) async def execute(entity: str, action: str, params: dict): ...

@mcp.tool() @FreshdeskConnector.tool_utils(framework="pydantic_ai", internal_retries=2) async def execute(entity: str, action: str, params: dict): ...

Args: update_docstring: When True, append connector capabilities to doc. max_output_chars: Max serialized output size before raising. Use None to disable. framework: One of "pydantic_ai" | "langchain" | "openai_agents" | "mcp". Defaults to None → auto-detect by attempting each framework's canonical import in order. Explicit always wins. internal_retries: How many transient runtime failures (429/5xx, network, timeout) to retry silently before surfacing. Default 0. Forwarded to :func:airbyte_agent_sdk.translation.translate_exceptions. should_internal_retry: Optional predicate (error, args, kwargs) -> bool further restricting which retryable errors are safe for this specific tool. Forwarded to :func:airbyte_agent_sdk.translation.translate_exceptions. exhausted_runtime_failure_message: Optional callback (error, args, kwargs) -> str | None. Invoked after internal retries are exhausted OR were skipped via should_internal_retry returning False. Forwarded to :func:airbyte_agent_sdk.translation.translate_exceptions.

Instance variables

connector_id: str | None : Get the connector/source ID (only available in hosted mode).

Returns: The connector ID if in hosted mode, None if in local mode.

Methods

check(self) ‑> airbyte_agent_sdk.connectors.freshdesk.models.FreshdeskCheckResult : Perform a health check to verify connectivity and credentials.

Executes a lightweight list operation (limit=1) to validate that the connector can communicate with the API and credentials are valid.

Returns: FreshdeskCheckResult with status ("healthy" or "unhealthy") and optional error message

Example: result = await connector.check() if result.status == "healthy": print("Connection verified!") else: print(f"Check failed: {result.error}")

close(self) : Close the connector and release resources.

entity_schema(self, entity: str) ‑> dict[str, typing.Any] | None : Get the JSON schema for an entity.

Args: entity: Entity name (e.g., "contacts", "companies")

Returns: JSON schema dict describing the entity structure, or None if not found.

Example: schema = connector.entity_schema("contacts") if schema: print(f"Contact properties: {list(schema.get('properties', {}).keys())}")

execute(self, entity: str, action: "Literal['list', 'get', 'context_store_search']", params: Mapping[str, Any] | None = None) ‑> Any : Execute an entity operation with full type safety.

This is the recommended interface for blessed connectors as it:

Uses the same signature as non-blessed connectors
Provides full IDE autocomplete for entity/action/params
Makes migration from generic to blessed connectors seamless

Args: entity: Entity name (e.g., "customers") action: Operation action (e.g., "create", "get", "list") params: Operation parameters (typed based on entity+action)

Returns: Typed response based on the operation

Example: customer = await connector.execute( entity="customers", action="get", params={"id": "cus_123"} )

list_entities(self) ‑> list[dict[str, typing.Any]] : Get structured data about available entities, actions, and parameters.

Returns a list of entity descriptions with:

entity_name: Name of the entity (e.g., "contacts", "deals")
description: Entity description from the first endpoint
available_actions: List of actions (e.g., ["list", "get", "create"])
parameters: Dict mapping action -> list of parameter dicts

Example: entities = connector.list_entities() for entity in entities: print(f"{entity['entity_name']}: {entity['available_actions']}")

GroupsQuery(connector: FreshdeskConnector) : Query class for Groups entity operations.

Initialize query with connector reference.

Methods

context_store_search(self, query: GroupsSearchQuery, limit: int | None = None, cursor: str | None = None, fields: list[list[str]] | None = None) ‑> airbyte_agent_sdk.connectors.freshdesk.models.AirbyteSearchResult[GroupsSearchData] : Search groups records from Airbyte cache.

This operation searches cached data from Airbyte syncs. Only available in hosted execution mode.

Available filter fields (GroupsSearchFilter):

id: Unique group ID
name: Name of the group
description: Description of the group
auto_ticket_assign: Auto ticket assignment: 0=Disabled, 1=Round Robin, 2=Skill Based, 3=Load Based
business_hour_id: ID of the associated business hour
escalate_to: User ID for escalation
group_type: Type of the group (e.g., support_agent_group)
unassigned_for: Time after which escalation triggers
created_at: Group creation timestamp
updated_at: Group last update timestamp

Returns: GroupsSearchResult with typed records, pagination metadata, and optional search metadata

Raises: NotImplementedError: If called in local execution mode

get(self, id: str | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.freshdesk.models.Group : Get a single group by ID

Args: id: Group ID **kwargs: Additional parameters

Returns: Group

list(self, per_page: int | None = None, page: int | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.freshdesk.models.FreshdeskExecuteResultWithMeta[list[Group], GroupsListResultMeta] : Returns a paginated list of groups

Args: per_page: Number of items per page (max 100) page: Page number (starts at 1) **kwargs: Additional parameters

Returns: GroupsListResult

RolesQuery(connector: FreshdeskConnector) : Query class for Roles entity operations.

Initialize query with connector reference.

Methods

context_store_search(self, query: RolesSearchQuery, limit: int | None = None, cursor: str | None = None, fields: list[list[str]] | None = None) ‑> airbyte_agent_sdk.connectors.freshdesk.models.AirbyteSearchResult[RolesSearchData] : Search roles records from Airbyte cache.

This operation searches cached data from Airbyte syncs. Only available in hosted execution mode.

Available filter fields (RolesSearchFilter):

id: Unique role ID
name: Name of the role
description: Description of the role
default: Whether this is a default role
created_at: Role creation timestamp
updated_at: Role last update timestamp

Returns: RolesSearchResult with typed records, pagination metadata, and optional search metadata

Raises: NotImplementedError: If called in local execution mode

get(self, id: str | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.freshdesk.models.Role : Get a single role by ID

Args: id: Role ID **kwargs: Additional parameters

Returns: Role

list(self, per_page: int | None = None, page: int | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.freshdesk.models.FreshdeskExecuteResultWithMeta[list[Role], RolesListResultMeta] : Returns a paginated list of roles

Args: per_page: Number of items per page (max 100) page: Page number (starts at 1) **kwargs: Additional parameters

Returns: RolesListResult

SatisfactionRatingsQuery(connector: FreshdeskConnector) : Query class for SatisfactionRatings entity operations.

Initialize query with connector reference.

Methods

context_store_search(self, query: SatisfactionRatingsSearchQuery, limit: int | None = None, cursor: str | None = None, fields: list[list[str]] | None = None) ‑> airbyte_agent_sdk.connectors.freshdesk.models.AirbyteSearchResult[SatisfactionRatingsSearchData] : Search satisfaction_ratings records from Airbyte cache.

This operation searches cached data from Airbyte syncs. Only available in hosted execution mode.

Available filter fields (SatisfactionRatingsSearchFilter):

id: Unique satisfaction rating ID
survey_id: ID of the survey
user_id: ID of the user (requester)
agent_id: ID of the agent
group_id: ID of the group
ticket_id: ID of the ticket
feedback: Feedback text
ratings: Rating values (question_id to rating mapping)
created_at: Rating creation timestamp
updated_at: Rating last update timestamp

Returns: SatisfactionRatingsSearchResult with typed records, pagination metadata, and optional search metadata

Raises: NotImplementedError: If called in local execution mode

list(self, per_page: int | None = None, page: int | None = None, created_since: str | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.freshdesk.models.FreshdeskExecuteResultWithMeta[list[SatisfactionRating], SatisfactionRatingsListResultMeta] : Returns a paginated list of satisfaction ratings

Args: per_page: Number of items per page (max 100) page: Page number (starts at 1) created_since: Return ratings created since this timestamp (ISO 8601) **kwargs: Additional parameters

Returns: SatisfactionRatingsListResult

SurveysQuery(connector: FreshdeskConnector) : Query class for Surveys entity operations.

Initialize query with connector reference.

Methods

context_store_search(self, query: SurveysSearchQuery, limit: int | None = None, cursor: str | None = None, fields: list[list[str]] | None = None) ‑> airbyte_agent_sdk.connectors.freshdesk.models.AirbyteSearchResult[SurveysSearchData] : Search surveys records from Airbyte cache.

This operation searches cached data from Airbyte syncs. Only available in hosted execution mode.

Available filter fields (SurveysSearchFilter):

id: Unique survey ID
title: Title of the survey
active: Whether the survey is active
questions: Survey questions
created_at: Survey creation timestamp
updated_at: Survey last update timestamp

Returns: SurveysSearchResult with typed records, pagination metadata, and optional search metadata

Raises: NotImplementedError: If called in local execution mode

list(self, per_page: int | None = None, page: int | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.freshdesk.models.FreshdeskExecuteResultWithMeta[list[Survey], SurveysListResultMeta] : Returns a paginated list of surveys

Args: per_page: Number of items per page (max 100) page: Page number (starts at 1) **kwargs: Additional parameters

Returns: SurveysListResult

TicketFieldsQuery(connector: FreshdeskConnector) : Query class for TicketFields entity operations.

Initialize query with connector reference.

Methods

context_store_search(self, query: TicketFieldsSearchQuery, limit: int | None = None, cursor: str | None = None, fields: list[list[str]] | None = None) ‑> airbyte_agent_sdk.connectors.freshdesk.models.AirbyteSearchResult[TicketFieldsSearchData] : Search ticket_fields records from Airbyte cache.

This operation searches cached data from Airbyte syncs. Only available in hosted execution mode.

Available filter fields (TicketFieldsSearchFilter):

id: Unique ticket field ID
name: Name of the field
label: Display label for agents
label_for_customers: Display label in the customer portal
description: Description of the field
position: Position of the field in the form
type_: Field type (e.g., custom_dropdown, custom_text)
default: Whether this is a default (non-custom) field
required_for_closure: Whether the field is required for ticket closure
required_for_agents: Whether the field is required for agents
required_for_customers: Whether the field is required for customers
customers_can_edit: Whether customers can edit this field
displayed_to_customers: Whether the field is displayed to customers
portal_cc: Whether CC is enabled in the portal
portal_cc_to: CC recipients scope (all or company)
choices: Available choices for dropdown fields
created_at: Field creation timestamp
updated_at: Field last update timestamp

Returns: TicketFieldsSearchResult with typed records, pagination metadata, and optional search metadata

Raises: NotImplementedError: If called in local execution mode

list(self, per_page: int | None = None, page: int | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.freshdesk.models.FreshdeskExecuteResultWithMeta[list[TicketField], TicketFieldsListResultMeta] : Returns a list of all ticket fields

Args: per_page: Number of items per page (max 100) page: Page number (starts at 1) **kwargs: Additional parameters

Returns: TicketFieldsListResult

TicketsQuery(connector: FreshdeskConnector) : Query class for Tickets entity operations.

Initialize query with connector reference.

Methods

context_store_search(self, query: TicketsSearchQuery, limit: int | None = None, cursor: str | None = None, fields: list[list[str]] | None = None) ‑> airbyte_agent_sdk.connectors.freshdesk.models.AirbyteSearchResult[TicketsSearchData] : Search tickets records from Airbyte cache.

This operation searches cached data from Airbyte syncs. Only available in hosted execution mode.

Available filter fields (TicketsSearchFilter):

id: Unique ticket ID
subject: Subject of the ticket
description: HTML content of the ticket
description_text: Plain text content of the ticket
status: Status: 2=Open, 3=Pending, 4=Resolved, 5=Closed
priority: Priority: 1=Low, 2=Medium, 3=High, 4=Urgent
source: Source: 1=Email, 2=Portal, 3=Phone, 7=Chat, 9=Feedback Widget, 10=Outbound Email
type_: Ticket type
requester_id: ID of the requester
requester: Requester details including name, email, and contact info
responder_id: ID of the agent to whom the ticket is assigned
group_id: ID of the group to which the ticket is assigned
company_id: Company ID of the requester
product_id: ID of the product associated with the ticket
email_config_id: ID of the email config used for the ticket
cc_emails: CC email addresses
ticket_cc_emails: Ticket CC email addresses
to_emails: To email addresses
fwd_emails: Forwarded email addresses
reply_cc_emails: Reply CC email addresses
tags: Tags associated with the ticket
custom_fields: Custom fields associated with the ticket
due_by: Resolution due by timestamp
fr_due_by: First response due by timestamp
fr_escalated: Whether the first response time was breached
is_escalated: Whether the ticket is escalated
nr_due_by: Next response due by timestamp
nr_escalated: Whether the next response time was breached
spam: Whether the ticket is marked as spam
association_type: Association type for parent/child tickets
associated_tickets_count: Number of associated tickets
stats: Ticket statistics including response and resolution times
created_at: Ticket creation timestamp
updated_at: Ticket last update timestamp

Returns: TicketsSearchResult with typed records, pagination metadata, and optional search metadata

Raises: NotImplementedError: If called in local execution mode

get(self, id: str | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.freshdesk.models.Ticket : Get a single ticket by ID

Args: id: Ticket ID **kwargs: Additional parameters

Returns: Ticket

list(self, per_page: int | None = None, page: int | None = None, updated_since: str | None = None, order_by: str | None = None, order_type: str | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.freshdesk.models.FreshdeskExecuteResultWithMeta[list[Ticket], TicketsListResultMeta] : Returns a paginated list of tickets. By default returns tickets created in the past 30 days. Use updated_since to get older tickets.

Args: per_page: Number of items per page (max 100) page: Page number (starts at 1) updated_since: Return tickets updated since this timestamp (ISO 8601) order_by: Sort field order_type: Sort order **kwargs: Additional parameters

Returns: TicketsListResult

TimeEntriesQuery(connector: FreshdeskConnector) : Query class for TimeEntries entity operations.

Initialize query with connector reference.

Methods

context_store_search(self, query: TimeEntriesSearchQuery, limit: int | None = None, cursor: str | None = None, fields: list[list[str]] | None = None) ‑> airbyte_agent_sdk.connectors.freshdesk.models.AirbyteSearchResult[TimeEntriesSearchData] : Search time_entries records from Airbyte cache.

This operation searches cached data from Airbyte syncs. Only available in hosted execution mode.

Available filter fields (TimeEntriesSearchFilter):

id: Unique time entry ID
agent_id: ID of the agent
ticket_id: ID of the associated ticket
company_id: ID of the associated company
billable: Whether the time entry is billable
note: Description of the time entry
time_spent: Time spent in hh:mm format
timer_running: Whether the timer is running
executed_at: Execution timestamp
start_time: Start time of the timer
created_at: Time entry creation timestamp
updated_at: Time entry last update timestamp

Returns: TimeEntriesSearchResult with typed records, pagination metadata, and optional search metadata

Raises: NotImplementedError: If called in local execution mode

list(self, per_page: int | None = None, page: int | None = None, **kwargs) ‑> airbyte_agent_sdk.connectors.freshdesk.models.FreshdeskExecuteResultWithMeta[list[TimeEntry], TimeEntriesListResultMeta] : Returns a paginated list of time entries

Args: per_page: Number of items per page (max 100) page: Page number (starts at 1) **kwargs: Additional parameters

Returns: TimeEntriesListResult

Classes​

Methods​

Methods​

Methods​

Local mode (direct API calls)

Hosted mode with explicit connector_id (no lookup needed)

Hosted mode with lookup by workspace_name

Class variables​

Static methods​

Instance variables​

Methods​

Methods​

Methods​

Methods​

Methods​

Methods​

Methods​

Methods​

Classes

Methods

Methods

Methods

Class variables

Static methods

Instance variables

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods