diff --git a/airbyte-integrations/connectors/source-zendesk-talk/metadata.yaml b/airbyte-integrations/connectors/source-zendesk-talk/metadata.yaml index 032e8976e979..eae520a246eb 100644 --- a/airbyte-integrations/connectors/source-zendesk-talk/metadata.yaml +++ b/airbyte-integrations/connectors/source-zendesk-talk/metadata.yaml @@ -11,7 +11,7 @@ data: connectorSubtype: api connectorType: source definitionId: c8630570-086d-4a40-99ae-ea5b18673071 - dockerImageTag: 0.2.0 + dockerImageTag: 0.2.1 dockerRepository: airbyte/source-zendesk-talk documentationUrl: https://docs.airbyte.com/integrations/sources/zendesk-talk githubIssueLabel: source-zendesk-talk diff --git a/airbyte-integrations/connectors/source-zendesk-talk/poetry.lock b/airbyte-integrations/connectors/source-zendesk-talk/poetry.lock index 712f8a105902..778d4312bf60 100644 --- a/airbyte-integrations/connectors/source-zendesk-talk/poetry.lock +++ b/airbyte-integrations/connectors/source-zendesk-talk/poetry.lock @@ -2,13 +2,13 @@ [[package]] name = "airbyte-cdk" -version = "0.77.2" +version = "0.80.0" description = "A framework for writing Airbyte Connectors." optional = false python-versions = "<4.0,>=3.9" files = [ - {file = "airbyte_cdk-0.77.2-py3-none-any.whl", hash = "sha256:6dffbe0c4b3454a5cdd20525b4f1e9cfef2e80c005b6b30473fc5bf6f75af64e"}, - {file = "airbyte_cdk-0.77.2.tar.gz", hash = "sha256:84aeb27862a18e135c7bc3a5dfc363037665d428e7495e8824673f853adcca70"}, + {file = "airbyte_cdk-0.80.0-py3-none-any.whl", hash = "sha256:060e92323a73674fa4e9e2e4a1eb312b9b9d072c9bbe5fa28f54ef21cb4974f3"}, + {file = "airbyte_cdk-0.80.0.tar.gz", hash = "sha256:1383512a83917fecca5b24cea4c72aa5c561cf96dd464485fbcefda48fe574c5"}, ] [package.dependencies] @@ -32,7 +32,7 @@ requests_cache = "*" wcmatch = "8.4" [package.extras] -file-based = ["avro (>=1.11.2,<1.12.0)", "fastavro (>=1.8.0,<1.9.0)", "markdown", "pyarrow (>=15.0.0,<15.1.0)", "pytesseract (==0.3.10)", "unstructured.pytesseract (>=0.3.12)", "unstructured[docx,pptx] (==0.10.27)"] +file-based = ["avro (>=1.11.2,<1.12.0)", "fastavro (>=1.8.0,<1.9.0)", "markdown", "pdf2image (==1.16.3)", "pdfminer.six (==20221105)", "pyarrow (>=15.0.0,<15.1.0)", "pytesseract (==0.3.10)", "unstructured.pytesseract (>=0.3.12)", "unstructured[docx,pptx] (==0.10.27)"] sphinx-docs = ["Sphinx (>=4.2,<4.3)", "sphinx-rtd-theme (>=1.0,<1.1)"] vector-db-based = ["cohere (==4.21)", "langchain (==0.0.271)", "openai[embeddings] (==0.27.9)", "tiktoken (==0.4.0)"] @@ -1028,4 +1028,4 @@ files = [ [metadata] lock-version = "2.0" python-versions = "^3.9,<3.12" -content-hash = "dedee3fe65d06e7ceb8403980b7cb1fadb463183c7c25b2cda747e60bcd7be03" +content-hash = "93b64196fc01fe00f7c5d8479d66f4f0ea3ee8a96a646b8fae8d125c1f006ad4" diff --git a/airbyte-integrations/connectors/source-zendesk-talk/pyproject.toml b/airbyte-integrations/connectors/source-zendesk-talk/pyproject.toml index 2807c8d1581c..e9f23c40425f 100644 --- a/airbyte-integrations/connectors/source-zendesk-talk/pyproject.toml +++ b/airbyte-integrations/connectors/source-zendesk-talk/pyproject.toml @@ -3,7 +3,7 @@ requires = [ "poetry-core>=1.0.0",] build-backend = "poetry.core.masonry.api" [tool.poetry] -version = "0.2.0" +version = "0.2.1" name = "source-zendesk-talk" description = "Source implementation for Zendesk Talk." authors = [ "Airbyte ",] @@ -17,7 +17,7 @@ include = "source_zendesk_talk" [tool.poetry.dependencies] python = "^3.9,<3.12" -airbyte-cdk = "^0" +airbyte-cdk = "0.80.0" [tool.poetry.scripts] source-zendesk-talk = "source_zendesk_talk.run:run" diff --git a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/account_overview.json b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/account_overview.json index 935cdb2b9efd..a20d6b84435e 100644 --- a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/account_overview.json +++ b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/account_overview.json @@ -3,72 +3,95 @@ "type": "object", "properties": { "current_timestamp": { + "description": "Current timestamp at the time of the data retrieval", "type": "integer" }, "average_call_duration": { + "description": "Average duration of calls in seconds", "type": ["null", "integer"] }, "average_queue_wait_time": { + "description": "Average time callers spend waiting in the queue in seconds", "type": ["null", "integer"] }, "average_wrap_up_time": { + "description": "Average time taken by agents to complete call-related work after the call ends in seconds", "type": ["null", "integer"] }, "max_calls_waiting": { + "description": "Maximum number of calls waiting in the queue at a given time", "type": ["null", "integer"] }, "max_queue_wait_time": { + "description": "Longest wait time experienced by a caller in the queue in seconds", "type": ["null", "integer"] }, "total_call_duration": { + "description": "Total duration of all calls combined in seconds", "type": ["null", "integer"] }, "total_calls": { + "description": "Total number of calls handled", "type": ["null", "integer"] }, "total_voicemails": { + "description": "Total voicemails received", "type": ["null", "integer"] }, "total_wrap_up_time": { + "description": "Total time taken by agents for after-call tasks across all calls in seconds", "type": ["null", "integer"] }, "average_callback_wait_time": { + "description": "Average wait time before callback in seconds", "type": ["null", "integer"] }, "average_hold_time": { + "description": "Average time callers are put on hold in seconds", "type": ["null", "integer"] }, "average_time_to_answer": { + "description": "Average time taken to answer calls in seconds", "type": ["null", "integer"] }, "total_callback_calls": { + "description": "Total number of callbacks made", "type": ["null", "integer"] }, "total_calls_abandoned_in_queue": { + "description": "Total calls abandoned by callers while waiting in the queue", "type": ["null", "integer"] }, "total_calls_outside_business_hours": { + "description": "Total calls received outside normal business hours", "type": ["null", "integer"] }, "total_calls_with_exceeded_queue_wait_time": { + "description": "Total calls where wait time exceeded a defined threshold", "type": ["null", "integer"] }, "total_calls_with_requested_voicemail": { + "description": "Total calls where callers requested a voicemail", "type": ["null", "integer"] }, "total_hold_time": { + "description": "Total time callers were put on hold across all calls in seconds", "type": ["null", "integer"] }, "total_inbound_calls": { + "description": "Total incoming calls received", "type": ["null", "integer"] }, "total_outbound_calls": { + "description": "Total outgoing calls made", "type": ["null", "integer"] }, "total_textback_requests": { + "description": "Total requests for textback responses", "type": ["null", "integer"] }, "total_embeddable_callback_calls": { + "description": "Total number of calls that were callbacks from an embedded service", "type": ["null", "integer"] } } diff --git a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/addresses.json b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/addresses.json index 365aba088cd2..8cb553af3cb7 100644 --- a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/addresses.json +++ b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/addresses.json @@ -3,30 +3,39 @@ "type": "object", "properties": { "city": { + "description": "The city where the address is located.", "type": ["null", "string"] }, "country_code": { + "description": "The country code of the address.", "type": ["null", "string"] }, "id": { + "description": "The unique identifier of the address.", "type": ["null", "integer"] }, "name": { + "description": "The name associated with the address.", "type": ["null", "string"] }, "provider_reference": { + "description": "Reference identifier provided by the address provider.", "type": ["null", "string"] }, "province": { + "description": "The province or region of the address.", "type": ["null", "string"] }, "state": { + "description": "The state of the address.", "type": ["null", "string"] }, "street": { + "description": "The street name and number of the address.", "type": ["null", "string"] }, "zip": { + "description": "The postal or zip code of the address.", "type": ["null", "string"] } } diff --git a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/agents_activity.json b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/agents_activity.json index cd11a4071d79..27404ac9a7be 100644 --- a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/agents_activity.json +++ b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/agents_activity.json @@ -3,78 +3,103 @@ "type": "object", "properties": { "agent_id": { + "description": "Unique identifier for the agent.", "type": ["null", "integer"] }, "agent_state": { + "description": "Current state of the agent (e.g., available, away).", "type": ["null", "string"] }, "available_time": { + "description": "Total time the agent is available for calls.", "type": ["null", "integer"] }, "avatar_url": { + "description": "URL to the agent's avatar image.", "type": ["null", "string"] }, "away_time": { + "description": "Total time the agent is marked as away.", "type": ["null", "integer"] }, "call_status": { + "description": "Status of current call (e.g., ongoing, ended).", "type": ["null", "string"] }, "calls_accepted": { + "description": "Total number of calls accepted by the agent.", "type": ["null", "integer"] }, "calls_denied": { + "description": "Total number of calls denied by the agent.", "type": ["null", "integer"] }, "calls_missed": { + "description": "Total number of calls missed by the agent.", "type": ["null", "integer"] }, "forwarding_number": { + "description": "Phone number calls are forwarded to.", "type": ["null", "string"] }, "name": { + "description": "Name of the agent.", "type": ["null", "string"] }, "online_time": { + "description": "Total time the agent is online and active.", "type": ["null", "integer"] }, "total_call_duration": { + "description": "Total duration of all calls handled by the agent.", "type": ["null", "integer"] }, "total_talk_time": { + "description": "Total duration of talk time for all calls handled by the agent.", "type": ["null", "integer"] }, "total_wrap_up_time": { + "description": "Total time taken to wrap up calls after ending for the agent.", "type": ["null", "integer"] }, "via": { + "description": "Platform or channel via which calls are received (e.g., phone, chat).", "type": ["null", "string"] }, "accepted_third_party_conferences": { + "description": "Number of third-party conferences accepted by the agent.", "type": ["null", "integer"] }, "accepted_transfers": { + "description": "Number of transfers accepted by the agent.", "type": ["null", "integer"] }, "average_hold_time": { + "description": "Average time calls are put on hold before being resumed.", "type": ["null", "integer"] }, "average_talk_time": { + "description": "Average duration of talk time for calls.", "type": ["null", "integer"] }, "average_wrap_up_time": { + "description": "Average time taken to wrap up a call after ending.", "type": ["null", "integer"] }, "calls_put_on_hold": { + "description": "Total number of calls put on hold by the agent.", "type": ["null", "integer"] }, "started_third_party_conferences": { + "description": "Number of third-party conferences initiated by the agent.", "type": ["null", "integer"] }, "started_transfers": { + "description": "Number of transfers initiated by the agent.", "type": ["null", "integer"] }, "total_hold_time": { + "description": "Total time calls are put on hold by the agent.", "type": ["null", "integer"] } } diff --git a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/agents_overview.json b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/agents_overview.json index 14baa4555021..382026b7c66c 100644 --- a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/agents_overview.json +++ b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/agents_overview.json @@ -3,69 +3,91 @@ "type": "object", "properties": { "current_timestamp": { + "description": "The timestamp when the data was last updated.", "type": "integer" }, "average_wrap_up_time": { + "description": "The average time agents take to wrap up calls.", "type": ["null", "integer"] }, "total_calls_accepted": { + "description": "The total number of calls accepted by agents.", "type": ["null", "integer"] }, "total_calls_denied": { + "description": "The total number of calls denied by agents.", "type": ["null", "integer"] }, "total_calls_missed": { + "description": "The total number of calls missed by agents.", "type": ["null", "integer"] }, "total_talk_time": { + "description": "The total time agents have spent talking on calls.", "type": ["null", "integer"] }, "total_wrap_up_time": { + "description": "The total time agents have taken to wrap up all calls.", "type": ["null", "integer"] }, "average_accepted_transfers": { + "description": "The average number of transfers accepted by agents.", "type": ["null", "integer"] }, "average_available_time": { + "description": "The average amount of time agents are available to take calls.", "type": ["null", "integer"] }, "average_away_time": { + "description": "The average time agents are away from their desks.", "type": ["null", "integer"] }, "average_calls_accepted": { + "description": "The average number of calls accepted by agents.", "type": ["null", "integer"] }, "average_calls_denied": { + "description": "The average number of calls denied by agents.", "type": ["null", "integer"] }, "average_calls_missed": { + "description": "The average number of calls missed by agents.", "type": ["null", "integer"] }, "average_calls_put_on_hold": { + "description": "The average number of calls put on hold by agents.", "type": ["null", "integer"] }, "average_hold_time": { + "description": "The average time calls are put on hold by agents.", "type": ["null", "integer"] }, "average_online_time": { + "description": "The average amount of time agents spend online.", "type": ["null", "integer"] }, "average_started_transfers": { + "description": "The average number of transfers initiated by agents.", "type": ["null", "integer"] }, "average_talk_time": { + "description": "The average time agents spend talking on calls.", "type": ["null", "integer"] }, "total_accepted_transfers": { + "description": "The total number of transfers accepted by agents.", "type": ["null", "integer"] }, "total_calls_put_on_hold": { + "description": "The total number of calls put on hold by agents.", "type": ["null", "integer"] }, "total_hold_time": { + "description": "The total time calls are put on hold by agents.", "type": ["null", "integer"] }, "total_started_transfers": { + "description": "The total number of transfers initiated by agents.", "type": ["null", "integer"] } } diff --git a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/call_legs.json b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/call_legs.json index 5e3a0619dea8..e675c288cab3 100644 --- a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/call_legs.json +++ b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/call_legs.json @@ -3,79 +3,104 @@ "type": "object", "properties": { "agent_id": { + "description": "The unique identifier of the agent associated with the call leg.", "type": ["null", "integer"] }, "available_via": { + "description": "The communication channel through which the call leg is available.", "type": ["null", "string"] }, "call_charge": { + "description": "The charge incurred for the call leg.", "type": ["null", "string"] }, "call_id": { + "description": "The unique identifier of the call that the call leg belongs to.", "type": ["null", "integer"] }, "completion_status": { + "description": "The status indicating whether the call leg has been completed or not.", "type": ["null", "string"] }, "conference_from": { + "description": "The party initiating the conference call.", "type": ["null", "integer"] }, "conference_time": { + "description": "The time when the call enters a conference.", "type": ["null", "integer"] }, "conference_to": { + "description": "The party being added to the conference call.", "type": ["null", "integer"] }, "consultation_from": { + "description": "The party initiating the consultation call.", "type": ["null", "integer"] }, "consultation_time": { + "description": "The time when the call enters a consultation.", "type": ["null", "integer"] }, "consultation_to": { + "description": "The party being consulted during the call.", "type": ["null", "integer"] }, "created_at": { + "description": "The timestamp indicating when the call leg was created.", "type": ["null", "string"] }, "duration": { + "description": "The length of the call leg in seconds.", "type": ["null", "integer"] }, "forwarded_to": { + "description": "The party to whom the call was forwarded.", "type": ["null", "string"] }, "hold_time": { + "description": "The duration for which the call leg was on hold.", "type": ["null", "integer"] }, "id": { + "description": "The unique identifier of the call leg.", "type": ["null", "integer"] }, "minutes_billed": { + "description": "The minutes for which the call leg is billed.", "type": ["null", "integer"] }, "quality_issues": { + "description": "Any reported quality issues during the call leg.", "type": ["null", "array"] }, "talk_time": { + "description": "The actual time spent talking during the call leg.", "type": ["null", "integer"] }, "transferred_from": { + "description": "The party from which the call was originally transferred.", "type": ["null", "integer"] }, "transferred_to": { + "description": "The party to whom the call was transferred.", "type": ["null", "integer"] }, "type": { + "description": "The type of call leg (e.g., inbound, outbound, internal).", "type": ["null", "string"] }, "updated_at": { + "description": "The timestamp indicating when the call leg was last updated.", "type": ["null", "string"], "format": "date-time" }, "user_id": { + "description": "The unique identifier of the user associated with the call leg.", "type": ["null", "integer"] }, "wrap_up_time": { + "description": "The time taken for wrap-up activities after the call leg ends.", "type": ["null", "integer"] } } diff --git a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/calls.json b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/calls.json index 7bd28996e9a5..62e168e9ad67 100644 --- a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/calls.json +++ b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/calls.json @@ -3,124 +3,164 @@ "type": "object", "properties": { "agent_id": { + "description": "The unique identifier of the agent who handled the call.", "type": ["null", "integer"] }, "call_charge": { + "description": "The cost or charge associated with the call.", "type": ["null", "string"] }, "call_group_id": { + "description": "The ID of the group associated with the call.", "type": ["null", "integer"] }, "call_recording_consent": { + "description": "Indicates whether there is recording consent for the call.", "type": ["null", "string"] }, "call_recording_consent_action": { + "description": "The action taken based on recording consent.", "type": ["null", "string"] }, "call_recording_consent_keypress": { + "description": "Keypress used for call recording consent.", "type": ["null", "string"] }, "callback": { + "description": "Indicates if the call is a callback.", "type": ["null", "boolean"] }, "callback_source": { + "description": "Source of the callback.", "type": ["null", "string"] }, "completion_status": { + "description": "Status indicating if the call was successfully completed.", "type": ["null", "string"] }, "consultation_time": { + "description": "Time spent on consultation during the call.", "type": ["null", "integer"] }, "created_at": { + "description": "Timestamp indicating when the call was created.", "type": ["null", "string"] }, "customer_requested_voicemail": { + "description": "Indicates if the customer requested voicemail.", "type": ["null", "boolean"] }, "default_group": { + "description": "Default group associated with the call.", "type": ["null", "boolean"] }, "direction": { + "description": "Direction of the call (inbound/outbound).", "type": ["null", "string"] }, "duration": { + "description": "Total duration of the call.", "type": ["null", "integer"] }, "exceeded_queue_time": { + "description": "Indicates if the call exceeded queue waiting time.", "type": ["null", "boolean"] }, "hold_time": { + "description": "Time the caller spent on hold during the call.", "type": ["null", "integer"] }, "id": { + "description": "Unique identifier of the call.", "type": ["null", "integer"] }, "ivr_action": { + "description": "Action taken by IVR during the call.", "type": ["null", "string"] }, "ivr_destination_group_name": { + "description": "Name of the IVR destination group.", "type": ["null", "string"] }, "ivr_hops": { + "description": "Number of times call was routed through IVR.", "type": ["null", "integer"] }, "ivr_routed_to": { + "description": "Destination of the call after IVR routing.", "type": ["null", "string"] }, "ivr_time_spent": { + "description": "Time spent on IVR interactions during the call.", "type": ["null", "integer"] }, "minutes_billed": { + "description": "Minutes billed for the call.", "type": ["null", "integer"] }, "not_recording_time": { + "description": "Time when call was not being recorded.", "type": ["null", "integer"] }, "outside_business_hours": { + "description": "Indicates if the call occurred outside business hours.", "type": ["null", "boolean"] }, "overflowed": { + "description": "Indicates if the call overflowed from a queue.", "type": ["null", "boolean"] }, "overflowed_to": { + "description": "Destination where the call overflowed to.", "type": ["null", "string"] }, "phone_number": { + "description": "Phone number associated with the call.", "type": ["null", "string"] }, "phone_number_id": { + "description": "ID of the phone number associated with the call.", "type": ["null", "integer"] }, "quality_issues": { + "description": "Indicates any quality issues during the call.", "type": ["null", "array"] }, "recording_control_interactions": { + "description": "Interactions related to call recording control.", "type": ["null", "integer"] }, "recording_time": { + "description": "Total time the call was recorded.", "type": ["null", "integer"] }, "talk_time": { + "description": "Total talk time during the call.", "type": ["null", "integer"] }, "ticket_id": { + "description": "ID of the ticket associated with the call.", "type": ["null", "integer"] }, "time_to_answer": { + "description": "Time taken to answer the call.", "type": ["null", "integer"] }, "updated_at": { + "description": "Timestamp indicating when the call data was last updated.", "type": ["null", "string"], "format": "date-time" }, "voicemail": { + "description": "Indicates if voicemail was left during the call.", "type": ["null", "boolean"] }, "wait_time": { + "description": "Total time the caller waited before the call was answered.", "type": ["null", "integer"] }, "wrap_up_time": { + "description": "Time taken for wrap-up activities after the call.", "type": ["null", "integer"] } } diff --git a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/current_queue_activity.json b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/current_queue_activity.json index 2b1a7ab7b09b..9c47e2f28f9e 100644 --- a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/current_queue_activity.json +++ b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/current_queue_activity.json @@ -3,24 +3,31 @@ "type": "object", "properties": { "current_timestamp": { + "description": "The timestamp indicating the current time when the data was retrieved.", "type": "integer" }, "agents_online": { + "description": "The number of agents who are currently available and online in the queue.", "type": ["null", "integer"] }, "average_wait_time": { + "description": "The average amount of time callers are waiting in the queue before being connected to an agent.", "type": ["null", "integer"] }, "callbacks_waiting": { + "description": "The number of callback requests that are currently in the queue, waiting for agents to be available.", "type": ["null", "integer"] }, "calls_waiting": { + "description": "The number of incoming calls that are currently waiting to be answered by agents.", "type": ["null", "integer"] }, "embeddable_callbacks_waiting": { + "description": "The number of callback requests that are specifically designated for embedding in a webpage or application and are waiting in the queue.", "type": ["null", "integer"] }, "longest_wait_time": { + "description": "The longest amount of time a caller has been waiting in the queue before being connected to an agent.", "type": ["null", "integer"] } } diff --git a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/greeting_categories.json b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/greeting_categories.json index e414e1a762a4..75645587bbf0 100644 --- a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/greeting_categories.json +++ b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/greeting_categories.json @@ -3,9 +3,11 @@ "type": "object", "properties": { "id": { + "description": "Unique identifier for the greeting category.", "type": ["null", "integer"] }, "name": { + "description": "Name of the greeting category.", "type": ["null", "string"] } } diff --git a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/greetings.json b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/greetings.json index 9d2b0ab55289..c38cc9ba0fc5 100644 --- a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/greetings.json +++ b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/greetings.json @@ -3,48 +3,63 @@ "type": "object", "properties": { "active": { + "description": "Indicates if the greeting is currently active or not", "type": ["null", "boolean"] }, "audio_name": { + "description": "Name of the audio file for the greeting", "type": ["null", "string"] }, "audio_url": { + "description": "URL to access the audio file for the greeting", "type": ["null", "string"] }, "category_id": { + "description": "ID of the category to which the greeting belongs", "type": ["null", "integer"] }, "default": { + "description": "Indicates if the greeting is set as the default", "type": ["null", "boolean"] }, "default_lang": { + "description": "Default language for the greeting", "type": ["null", "boolean"] }, "has_sub_settings": { + "description": "Indicates if the greeting has sub settings or not", "type": ["null", "boolean"] }, "id": { + "description": "Unique identifier for the greeting", "type": ["null", "string"] }, "ivr_ids": { + "description": "List of IVR IDs associated with the greeting", "type": ["null", "array"], "items": { + "description": "IVR ID", "type": ["string", "integer"] } }, "name": { + "description": "Name of the greeting", "type": ["null", "string"] }, "pending": { + "description": "Indicates if the greeting is pending for approval", "type": ["null", "boolean"] }, "phone_number_ids": { + "description": "List of phone number IDs linked to the greeting", "type": ["null", "array"], "items": { + "description": "Phone number ID", "type": ["string", "integer"] } }, "upload_id": { + "description": "ID of the uploaded audio file for the greeting", "type": ["null", "integer"] } } diff --git a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/ivr_menus.json b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/ivr_menus.json index 125915b090b5..af592fd7eac6 100644 --- a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/ivr_menus.json +++ b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/ivr_menus.json @@ -3,18 +3,23 @@ "type": "object", "properties": { "default": { + "description": "The default action or response for this IVR menu.", "type": ["null", "boolean"] }, "greeting_id": { + "description": "The ID of the greeting message associated with this IVR menu.", "type": ["null", "integer"] }, "id": { + "description": "The unique identifier of the IVR menu.", "type": ["null", "integer"] }, "ivr_id": { + "description": "The ID of the IVR associated with this menu.", "type": ["null", "integer"] }, "name": { + "description": "The name of the IVR menu.", "type": ["null", "string"] } } diff --git a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/ivr_routes.json b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/ivr_routes.json index b6ccb5535ff4..c4c839dd2394 100644 --- a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/ivr_routes.json +++ b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/ivr_routes.json @@ -3,30 +3,39 @@ "type": "object", "properties": { "action": { + "description": "The action to be taken when this IVR route is triggered.", "type": ["null", "string"] }, "greeting": { + "description": "The message or greeting played to the caller when this IVR route is entered.", "type": ["null", "string"] }, "id": { + "description": "The unique identifier for the IVR route.", "type": ["null", "integer"] }, "ivr_id": { + "description": "The ID of the IVR associated with this route.", "type": ["null", "integer"] }, "ivr_menu_id": { + "description": "The ID of the IVR menu associated with this route.", "type": ["null", "integer"] }, "keypress": { + "description": "The keypress required to trigger this IVR route.", "type": ["null", "string"] }, "option_text": { + "description": "The text displayed for the option linked to this IVR route.", "type": ["null", "string"] }, "options": { + "description": "The list of options available for this IVR route.", "type": ["null", "object"] }, "overflow_options": { + "description": "The additional options presented when the IVR menu overflows.", "type": ["null", "array"] } } diff --git a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/ivrs.json b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/ivrs.json index 35e2f67d8f00..53fb4a5dccd9 100644 --- a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/ivrs.json +++ b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/ivrs.json @@ -3,52 +3,69 @@ "type": "object", "properties": { "id": { + "description": "Unique identifier of the IVR menu", "type": ["null", "integer"] }, "menus": { + "description": "Collection of IVR menus", "type": ["null", "array"], "items": { + "description": "Individual IVR menu item", "type": "object", "properties": { "default": { + "description": "Flag indicating if this menu is set as default", "type": ["null", "boolean"] }, "greeting_id": { + "description": "Identifier of the greeting associated with this IVR menu", "type": ["null", "integer"] }, "id": { + "description": "Unique identifier of the IVR menu item", "type": ["null", "integer"] }, "ivr_id": { + "description": "Identifier of the IVR this menu belongs to", "type": ["null", "integer"] }, "name": { + "description": "Name of the IVR menu item", "type": ["null", "string"] }, "routes": { + "description": "List of available routes within the IVR menu", "type": ["array", "null"], "items": { + "description": "Individual route within the IVR menu", "type": "object", "properties": { "action": { + "description": "Action to be taken when this route is selected", "type": ["null", "string"] }, "greeting": { + "description": "Text or audio greeting associated with this route", "type": ["null", "string"] }, "id": { + "description": "Unique identifier of the route", "type": ["null", "integer"] }, "keypress": { + "description": "Keypress for selecting this route", "type": ["null", "string"] }, "option_text": { + "description": "Text of the option presented to the user", "type": ["null", "string"] }, "options": { + "description": "Additional options available for this route", "type": ["null", "object"] }, "overflow_options": { + "description": "Options for handling overflow calls", "type": ["null", "array"] } } @@ -58,17 +75,22 @@ } }, "name": { + "description": "Name of the IVR menu", "type": ["null", "string"] }, "phone_number_ids": { + "description": "List of phone number IDs associated with the IVR data", "type": ["null", "array"], "items": { + "description": "Identifiers of phone numbers associated with this IVR menu", "type": ["string", "integer"] } }, "phone_number_names": { + "description": "List of phone number names associated with the IVR data", "type": ["null", "array"], "items": { + "description": "Names of phone numbers associated with this IVR menu", "type": ["integer", "string"] } } diff --git a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/phone_numbers.json b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/phone_numbers.json index 0310a9515e73..d188daa931c3 100644 --- a/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/phone_numbers.json +++ b/airbyte-integrations/connectors/source-zendesk-talk/source_zendesk_talk/schemas/phone_numbers.json @@ -3,107 +3,141 @@ "type": "object", "properties": { "call_recording_consent": { + "description": "Indicates whether consent for call recordings is given or not", "type": ["null", "string"] }, "capabilities": { + "description": "Capabilities of the phone number", "type": ["null", "object"], "properties": { "mms": { + "description": "Indicates if MMS capability is enabled", "type": ["null", "boolean"] }, "sms": { + "description": "Indicates if SMS capability is enabled", "type": ["null", "boolean"] }, "voice": { + "description": "Indicates if voice calling capability is enabled", "type": ["null", "boolean"] } } }, "categorised_greetings": { + "description": "Categorized greetings for the phone number", "type": ["null", "object"] }, "categorised_greetings_with_sub_settings": { + "description": "Categorized greetings with sub-settings for the phone number", "type": ["null", "object"] }, "country_code": { + "description": "Country code of the phone number", "type": ["null", "string"] }, "created_at": { + "description": "Date and time when the phone number was created", "type": ["null", "string"] }, "default_greeting_ids": { + "description": "IDs of default greetings for the phone number", "type": ["null", "array"], "items": { + "description": "ID of a default greeting", "type": "string" } }, "default_group_id": { + "description": "ID of the default group assigned to the phone number", "type": ["null", "integer"] }, "display_number": { + "description": "Phone number to be displayed", "type": ["null", "string"] }, "external": { + "description": "Indicates if the phone number is external", "type": ["null", "boolean"] }, "failover_number": { + "description": "Failover phone number", "type": ["null", "string"] }, "greeting_ids": { + "description": "IDs of greetings associated with the phone number", "type": ["null", "array"] }, "group_ids": { + "description": "IDs of groups associated with the phone number", "type": ["null", "array"] }, "id": { + "description": "Unique identifier of the phone number", "type": ["null", "integer"] }, "ivr_id": { + "description": "IVR (Interactive Voice Response) ID associated with the phone number", "type": ["null", "integer"] }, "line_type": { + "description": "Type of telephone line (e.g., landline, mobile)", "type": ["null", "string"] }, "location": { + "description": "Location of the phone number", "type": ["null", "string"] }, "name": { + "description": "Name of the phone number", "type": ["null", "string"] }, "nickname": { + "description": "Nickname of the phone number", "type": ["null", "string"] }, "number": { + "description": "Actual phone number", "type": ["null", "string"] }, "outbound_enabled": { + "description": "Indicates if outbound calling is enabled", "type": ["null", "boolean"] }, "priority": { + "description": "Priority level of the phone number", "type": ["null", "integer"] }, "recorded": { + "description": "Indicates if calls are recorded", "type": ["null", "boolean"] }, "schedule_id": { + "description": "ID of the schedule associated with the phone number", "type": ["null", "integer"] }, "sms_enabled": { + "description": "Indicates if SMS is enabled", "type": ["null", "boolean"] }, "sms_group_id": { + "description": "ID of the group for SMS", "type": ["null", "integer"] }, "token": { + "description": "Token associated with the phone number", "type": ["null", "string"] }, "toll_free": { + "description": "Indicates if the phone number is a toll-free number", "type": ["null", "boolean"] }, "transcription": { + "description": "Indicates if call transcription is enabled", "type": ["null", "boolean"] }, "voice_enabled": { + "description": "Indicates if voice calling is enabled", "type": ["null", "boolean"] } } diff --git a/docs/integrations/sources/zendesk-talk.md b/docs/integrations/sources/zendesk-talk.md index ee9781431226..0cecfd7e4346 100644 --- a/docs/integrations/sources/zendesk-talk.md +++ b/docs/integrations/sources/zendesk-talk.md @@ -10,9 +10,9 @@ ### Step 1: Set up Zendesk -Generate a API access token as described in [Zendesk docs](https://support.zendesk.com/hc/en-us/articles/226022787-Generating-a-new-API-token-) +Generate an API access token as described in [Zendesk docs](https://support.zendesk.com/hc/en-us/articles/226022787-Generating-a-new-API-token-) -We recommend creating a restricted, read-only key specifically for Airbyte access. This will allow you to control which resources Airbyte should be able to access. +We recommend creating a restricted, read-only key specifically for Airbyte access. This will allow you to control which resources Airbyte is able to access. Another option is to use OAuth2.0 for authentication. See [Zendesk docs](https://support.zendesk.com/hc/en-us/articles/4408845965210-Using-OAuth-authentication-with-your-application) for details. @@ -64,16 +64,17 @@ The Zendesk connector should not run into Zendesk API limitations under normal u ## Data type map | Integration Type | Airbyte Type | Notes | -| :------- | :------- | :--- | -| `string` | `string` | | -| `number` | `number` | | -| `array` | `array` | | -| `object` | `object` | | +|:-----------------|:-------------|:------| +| `string` | `string` | | +| `number` | `number` | | +| `array` | `array` | | +| `object` | `object` | | ## Changelog | Version | Date | Pull Request | Subject | |:--------|:-----------|:---------------------------------------------------------|:----------------------------------------------------------------------------| +| 0.2.1 | 2024-05-02 | [36625](https://github.com/airbytehq/airbyte/pull/36625) | Schema descriptions and CDK 0.80.0 | | 0.2.0 | 2024-03-25 | [36459](https://github.com/airbytehq/airbyte/pull/36459) | Unpin CDK version, add record counts in state messages | | 0.1.13 | 2024-03-04 | [35783](https://github.com/airbytehq/airbyte/pull/35783) | Change order of authentication methods in spec | | 0.1.12 | 2024-02-12 | [35156](https://github.com/airbytehq/airbyte/pull/35156) | Manage dependencies with Poetry. |