From e63e74a320202593eab0f3fae2e0c7d271258d40 Mon Sep 17 00:00:00 2001 From: fivetran-kristin Date: Tue, 28 Jul 2020 12:21:56 -0700 Subject: [PATCH] working changes --- .gitignore | 5 + LICENSE | 201 ++++++++++++++++++ dbt_project.yml | 29 +++ models/src_zendesk.yml | 192 +++++++++++++++++ models/stg_zendesk_group.sql | 20 ++ models/stg_zendesk_organization.sql | 19 ++ models/stg_zendesk_schedule.sql | 23 ++ models/stg_zendesk_sla_policy_history.sql | 25 +++ .../stg_zendesk_sla_policy_metric_history.sql | 26 +++ models/stg_zendesk_ticket.sql | 42 ++++ models/stg_zendesk_ticket_comment.sql | 26 +++ models/stg_zendesk_ticket_field_history.sql | 23 ++ models/stg_zendesk_ticket_schedule.sql | 21 ++ models/stg_zendesk_ticket_sla_policy.sql | 20 ++ models/stg_zendesk_user.sql | 26 +++ packages.yml | 3 + 16 files changed, 701 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 dbt_project.yml create mode 100644 models/src_zendesk.yml create mode 100644 models/stg_zendesk_group.sql create mode 100644 models/stg_zendesk_organization.sql create mode 100644 models/stg_zendesk_schedule.sql create mode 100644 models/stg_zendesk_sla_policy_history.sql create mode 100644 models/stg_zendesk_sla_policy_metric_history.sql create mode 100644 models/stg_zendesk_ticket.sql create mode 100644 models/stg_zendesk_ticket_comment.sql create mode 100644 models/stg_zendesk_ticket_field_history.sql create mode 100644 models/stg_zendesk_ticket_schedule.sql create mode 100644 models/stg_zendesk_ticket_sla_policy.sql create mode 100644 models/stg_zendesk_user.sql create mode 100644 packages.yml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..64454d7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ + +target/ +dbt_modules/ +logs/ +.DS_Store \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/dbt_project.yml b/dbt_project.yml new file mode 100644 index 0000000..85f3407 --- /dev/null +++ b/dbt_project.yml @@ -0,0 +1,29 @@ +config-version: 2 + +name: 'zendesk_source' +version: '0.0.1' + +profile: 'fivetran' + +require-dbt-version: '>=0.17.0' + +models: + zendesk_source: + materialized: ephemeral + +vars: + zendesk_source: + group: "{{ source('zendesk', 'group') }}" + organization: "{{ source('zendesk', 'organization') }}" + ticket: "{{ source('zendesk', 'ticket') }}" + ticket_comment: "{{ source('zendesk', 'ticket_comment') }}" + ticket_field_history: "{{ source('zendesk', 'ticket_field_history') }}" + ticket_sla_policy: "{{ source('zendesk', 'ticket_sla_policy') }}" + ticket_schedule: "{{ source('zendesk', 'ticket_schedule') }}" + schedule: "{{ source('zendesk', 'schedule') }}" + sla_policy_metric_history: "{{ source('zendesk', 'sla_policy_metric_history') }}" + sla_policy_history: "{{ source('zendesk', 'sla_policy_history') }}" + user: "{{ source('zendesk', 'user') }}" + using_sla_policy: True + zendesk_schema: 'zendesk_new' + zendesk_database: 'target.database' diff --git a/models/src_zendesk.yml b/models/src_zendesk.yml new file mode 100644 index 0000000..46f88bb --- /dev/null +++ b/models/src_zendesk.yml @@ -0,0 +1,192 @@ +version: 2 + +sources: + - name: zendesk + database: "{{var ('zendesk_database', target.database)}}" + schema: "{{var ('zendesk_schema', 'zendesk')}}" + + loader: fivetran + loaded_at_field: _fivetran_synced + + freshness: + warn_after: {count: 72, period: hour} + error_after: {count: 168, period: hour} + + + tables: + - name: ticket + description: Tickets are the means through which your end users (customers) communicate with agents in Zendesk Support. Tickets can originate from a number of channels, including email, Help Center, chat, phone call, Twitter, Facebook, or the API. + loaded_at_field: _fivetran_synced + columns: + - name: id + description: Automatically assigned when the ticket is created + tests: + - unique + - not_null + - name: url + description: The API url of this ticket + - name: assignee_id + description: The agent currently assigned to the ticket + - name: brand_id + description: Enterprise only. The id of the brand this ticket is associated with + - name: created_at + description: When this record was created + - name: type + description: The type of this ticket, possible values are problem, incident, question or task + - name: subject + description: The value of the subject field for this ticket + - name: description + description: Read-only first comment on the ticket + - name: priority + description: The urgency with which the ticket should be addressed, possible values are urgent, high, normal and low + - name: status + description: The state of the ticket, possible values are new, open, pending, hold, solved and closed + - name: recipient + description: The original recipient e-mail address of the ticket + - name: requester_id + description: The user who requested this ticket + - name: submitter_id + description: The user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket + - name: organization_id + description: The organization of the requester + - name: group_id + description: The group this ticket is assigned to + - name: due_at + description: If this is a ticket of type "task" it has a due date. Due date format uses ISO 8601 format. + - name: ticket_form_id + description: Enterprise only. The id of the ticket form to render for the ticket + - name: is_public + description: Is true if any comments are public, false otherwise + - name: updated_at + description: When this record last got updated + - name: via_channel + description: The channel the ticket was created from + - name: via_source_from_id + description: The channel the ticket was created from + - name: via_source_from_title + description: The channel the ticket was created from + - name: via_source_rel + description: The rel the ticket was created from + - name: via_source_to_address + description: The address of the source the ticket was created from + - name: via_source_to_name + description: The name of the source the ticket was created from + + - name: group + description: > + When support requests arrive in Zendesk Support, they can be assigned to a Group. Groups serve as the core + element of ticket workflow; support agents are organized into Groups and tickets can be assigned to a Group + only, or to an assigned agent within a Group. A ticket can never be assigned to an agent without also being + assigned to a Group. + freshness: null + columns: + - name: id + description: Automatically assigned when creating groups + tests: + - unique + - not_null + - name: name + description: The name of the group + + - name: organization + description: > + Just as agents can be segmented into groups in Zendesk Support, your customers (end-users) can be segmented into + organizations. You can manually assign customers to an organization or automatically assign them to an organization + by their email address domain. Organizations can be used in business rules to route tickets to groups of agents or + to send email notifications. + freshness: null + columns: + - name: id + description: Automatically assigned when the organization is created + tests: + - unique + - not_null + - name: name + description: A unique name for the organization + - name: details + description: Any details obout the organization, such as the address + - name: url + description: The API url of this organization + - name: external_id + description: A unique external id to associate organizations to an external record + - name: created_at + description: The time the organization was created + - name: updated_at + description: The time of the last update of the organization + - name: domain_names + description: An array of domain names associated with this organization + - name: details + description: Any details obout the organization, such as the address + - name: notes + description: Any notes you have about the organization + - name: group_id + description: New tickets from users in this organization are automatically put in this group + - name: shared_tickets + description: End users in this organization are able to see each other's tickets + - name: shared_comments + description: End users in this organization are able to see each other's comments on tickets + - name: tags + description: The tags of the organization + - name: organization_fields + description: Custom fields for this organization + + - name: ticket_comment + description: Ticket comments represent the conversation between requesters, collaborators, and agents. Comments can be public or private. + loaded_at_field: _fivetran_synced + columns: + - name: id + description: Automatically assigned when the comment is created + tests: + - unique + - not_null + - name: body + description: The comment string + - name: created + description: The time the comment was created + - name: public + description: Boolean field indicating if the comment is public (true), or if it is an internal note (false) + - name: ticket_id + description: The ticket id associated with this comment + - name: user_id + description: The id of the comment author + - name: facebook_comment + description: Boolean field indicating if the comment is a facebook comment + - name: tweet + description: Boolean field indicating if the comment is a twitter tweet + - name: voice_comment + description: Boolean field indicating if the comment is a voice comment + + + - name: user + description: Zendesk has three types of users, end-users (your customers), agents, and administrators. + freshness: null + columns: + - name: id + description: Automatically assigned when the user is created + tests: + - unique + - not_null + - name: email + description: The user's primary email address. *Writeable on create only. On update, a secondary email is added. See Email Address + - name: name + description: The user's name + - name: active + description: false if the user has been deleted + - name: created_at + description: The time the user was created + - name: organization_id + description: The id of the user's organization. If the user has more than one organization memberships, the id of the user's default organization + - name: role + description: The user's role. Possible values are "end-user", "agent", or "admin" + - name: time_zone + description: The user's time zone. See Time Zone + - name: ticket_restriction + description: Specifies which tickets the user has access to. Possible values are organization, groups, assigned, requested and null + + - name: sla_policy_metric_history + - name: sla_policy_history + - name: ticket_field_history + - name: ticket_sla_policy + - name: ticket_schedule + - name: schedule + \ No newline at end of file diff --git a/models/stg_zendesk_group.sql b/models/stg_zendesk_group.sql new file mode 100644 index 0000000..4141719 --- /dev/null +++ b/models/stg_zendesk_group.sql @@ -0,0 +1,20 @@ +with base as ( + + select * + from {{ var('group')}} + +), fields as ( + + select + + id as group_id, + name + + from base + where not _fivetran_deleted + + +) + +select * +from fields \ No newline at end of file diff --git a/models/stg_zendesk_organization.sql b/models/stg_zendesk_organization.sql new file mode 100644 index 0000000..aa9481d --- /dev/null +++ b/models/stg_zendesk_organization.sql @@ -0,0 +1,19 @@ +with base as ( + + select * + from {{ var('organization')}} + +), fields as ( + + select + + id as organization_id, + details, + name + + from base + +) + +select * +from fields \ No newline at end of file diff --git a/models/stg_zendesk_schedule.sql b/models/stg_zendesk_schedule.sql new file mode 100644 index 0000000..aeab2ec --- /dev/null +++ b/models/stg_zendesk_schedule.sql @@ -0,0 +1,23 @@ +{{ config(enabled=var('using_sla_policy', True)) }} + +with base as ( + + select * + from {{ var('schedule')}} + +), fields as ( + + select + + id as schedule_id, + end_time_utc, + start_time_utc, + name as schedule_name + + from base + where not _fivetran_deleted + +) + +select * +from fields \ No newline at end of file diff --git a/models/stg_zendesk_sla_policy_history.sql b/models/stg_zendesk_sla_policy_history.sql new file mode 100644 index 0000000..9eb9c57 --- /dev/null +++ b/models/stg_zendesk_sla_policy_history.sql @@ -0,0 +1,25 @@ +{{ config(enabled=var('using_sla_policy', True)) }} + +with base as ( + + select * + from {{ var('sla_policy_history')}} + +), fields as ( + + select + + id as sla_policy_id, + _fivetran_deleted, + created_at, + updated_at, + description, + title + + + from base + +) + +select * +from fields \ No newline at end of file diff --git a/models/stg_zendesk_sla_policy_metric_history.sql b/models/stg_zendesk_sla_policy_metric_history.sql new file mode 100644 index 0000000..ef99517 --- /dev/null +++ b/models/stg_zendesk_sla_policy_metric_history.sql @@ -0,0 +1,26 @@ +{{ config(enabled=var('using_sla_policy', True)) }} + +with base as ( + + select * + from {{ var('sla_policy_metric_history')}} + +), fields as ( + + select + sla_policy_id, + sla_policy_updated_at, + coalesce( + lead(sla_policy_updated_at) over (partition by sla_policy_id, business_hours, metric, priority order by sla_policy_updated_at), + '2999-12-31 23:59:59 UTC') + as valid_ending_at, + business_hours, + metric, + priority, + target + + from base +) + +select * +from fields \ No newline at end of file diff --git a/models/stg_zendesk_ticket.sql b/models/stg_zendesk_ticket.sql new file mode 100644 index 0000000..b40c79f --- /dev/null +++ b/models/stg_zendesk_ticket.sql @@ -0,0 +1,42 @@ +with base as ( + + select * + from {{ var('ticket')}} + +), fields as ( + + select + + id as ticket_id, + _fivetran_synced, + assignee_id, + brand_id, + created_at, + description, + due_at, + group_id, + is_public, + organization_id, + priority, + recipient, + requester_id, + status, + subject, + submitter_id, + ticket_form_id, + type, + updated_at, + url, + via_channel as created_channel, + via_source_from_id as source_from_id, + via_source_from_title as source_from_title, + via_source_rel as source_rel, + via_source_to_address as source_to_address, + via_source_to_name as source_to_name + + from base + +) + +select * +from fields \ No newline at end of file diff --git a/models/stg_zendesk_ticket_comment.sql b/models/stg_zendesk_ticket_comment.sql new file mode 100644 index 0000000..7477e3c --- /dev/null +++ b/models/stg_zendesk_ticket_comment.sql @@ -0,0 +1,26 @@ +with base as ( + + select * + from {{ var('ticket_comment')}} + +), fields as ( + + select + + id as ticket_comment_id, + _fivetran_synced, + body, + created as created_at, + public as is_public, + ticket_id, + user_id as user_id, + facebook_comment as is_facebook_comment, + tweet as is_tweet, + voice_comment as is_voice_comment + + from base + +) + +select * +from fields \ No newline at end of file diff --git a/models/stg_zendesk_ticket_field_history.sql b/models/stg_zendesk_ticket_field_history.sql new file mode 100644 index 0000000..56c0709 --- /dev/null +++ b/models/stg_zendesk_ticket_field_history.sql @@ -0,0 +1,23 @@ +with base as ( + + select * + from {{ var('ticket_field_history')}} + +), fields as ( + + select + + ticket_id, + field_name, + updated as valid_starting_at, + lead(updated) over (partition by ticket_id, field_name order by updated) as valid_ending_at, + value, + user_id + + from base + order by 1,2,3 + +) + +select * +from fields \ No newline at end of file diff --git a/models/stg_zendesk_ticket_schedule.sql b/models/stg_zendesk_ticket_schedule.sql new file mode 100644 index 0000000..5006810 --- /dev/null +++ b/models/stg_zendesk_ticket_schedule.sql @@ -0,0 +1,21 @@ +{{ config(enabled=var('using_sla_policy', True)) }} + +with base as ( + + select * + from {{ var('ticket_schedule')}} + +), fields as ( + + select + + ticket_id, + created_at, + schedule_id, + + from base + +) + +select * +from fields \ No newline at end of file diff --git a/models/stg_zendesk_ticket_sla_policy.sql b/models/stg_zendesk_ticket_sla_policy.sql new file mode 100644 index 0000000..b7de3d5 --- /dev/null +++ b/models/stg_zendesk_ticket_sla_policy.sql @@ -0,0 +1,20 @@ +{{ config(enabled=var('using_sla_policy', True)) }} + +with base as ( + + select * + from {{ var('ticket_sla_policy')}} + +), fields as ( + + select + + sla_policy_id, + ticket_id, + policy_applied_at + + from base +) + +select * +from fields \ No newline at end of file diff --git a/models/stg_zendesk_user.sql b/models/stg_zendesk_user.sql new file mode 100644 index 0000000..859906d --- /dev/null +++ b/models/stg_zendesk_user.sql @@ -0,0 +1,26 @@ +with base as ( + + select * + from {{ var('user')}} + +), fields as ( + + select + + id as user_id, + _fivetran_synced, + created_at, + email, + name, + organization_id, + role, + ticket_restriction, + time_zone, + active as is_active + + from base + +) + +select * +from fields \ No newline at end of file diff --git a/packages.yml b/packages.yml new file mode 100644 index 0000000..c705fcc --- /dev/null +++ b/packages.yml @@ -0,0 +1,3 @@ +packages: + - package: fishtown-analytics/dbt_utils + version: 0.4.0 \ No newline at end of file