reporting schema

models/reporting/core/schema.yml

@@ -161,7 +161,7 @@ models:
           currency.
 
           This fee is calculated by finding what was the active price plan for the host user 
-          when the booking fee had to be charged. 
+          when the booking fee had to be charged.
 
       - name: booking_fee_charge_at_utc
         data_type: timestamp without time zone
@@ -191,7 +191,7 @@ models:
     columns:
       - name: id_verification_request
         data_type: bigint
-        description: | 
+        description: |
           Unique, incremental, internal ID for the related verification 
           request.
         tests:
@@ -220,25 +220,25 @@ models:
 
       - name: is_verification_request_complete
         data_type: boolean
-        description: | 
+        description: |
           True if the verification request is considered is considered 
           complete, AKA the guest has finished the full guest journey.
 
       - name: is_past_check_in
         data_type: boolean
-        description: | 
+        description: |
           True if the check-in date is in the past, false otherwise. This value
           only gets informed for users who have bought check-in cover.
 
       - name: is_awaiting_check_in
         data_type: boolean
-        description: | 
+        description: |
           True if the check-in date is in the future, false otherwise. This 
           value only gets informed for users who have bought check-in cover.
 
       - name: cover_was_purchased
         data_type: boolean
-        description: | 
+        description: |
           True if the guest purchased the check-in cover.
 
           This is identified by the fact that there is a payment of type 
@@ -246,8 +246,7 @@ models:
 
       - name: address_validation_passed
         data_type: boolean
-        description: 
+        description: "Boolean to indicate if the validation was approved or not.
-          "Boolean to indicate if the validation was approved or not.
           In case there was a problem with the validation it will be Null"
 
       - name: address_validation_notes
@@ -307,7 +306,7 @@ models:
 
       - name: verification_start_at_utc
         data_type: timestamp without time zone
-        description: | 
+        description: |
           The date and time at which the guest started the guest journey.
 
       - name: verification_start_date_utc
@@ -326,7 +325,7 @@ models:
 
       - name: amount_in_txn_currency
         data_type: numeric
-        description: | 
+        description: |
           The amount paid by the guest for the check-in cover, in the currency 
           in which the payment actually took place.
 
@@ -348,7 +347,7 @@ models:
 
       - name: checkin_cover_cover_amount_local_curr
         data_type: numeric
-        description: | 
+        description: |
           The total amount for which the guest check-in is covered, according
           to the Superhog backend, in the same currency as the guest payment.
 
@@ -385,18 +384,18 @@ models:
           For more details, contact pablo.martin or Lawrence.
 
   - name: core__verification_requests
-    description: 
+    description:
       This is a table that shows all guest journey from our guests users with
       each record matching each guest journey.
 
       It holds information about the guests like name, email, phone, etc.., as
-      well as dates regarding the process of the guest journey like when it 
+      well as dates regarding the process of the guest journey like when it
       was started or finished.
     columns:
       - name: id_verification_request
         data_type: bigint
-        description: 
+        description:
-          Unique, incremental, internal ID for the related verification 
+          Unique, incremental, internal ID for the related verification
           request.
 
       - name: uuid_verification_request
@@ -425,7 +424,7 @@ models:
 
       - name: is_verification_request_complete
         data_type: boolean
-        description: True if the verification request is considered 
+        description: True if the verification request is considered
           complete, AKA the guest has finished the full guest journey.
 
       - name: verification_url
@@ -470,43 +469,35 @@ models:
 
       - name: verification_start_at_utc
         data_type: timestamp without time zone
-        description: 
+        description: The date and time at which the guest started the guest journey.
-          The date and time at which the guest started the guest journey.
 
       - name: verification_start_date_utc
         data_type: date
-        description: 
+        description: The date on which the guest started the guest journey.
-          The date on which the guest started the guest journey.
 
       - name: verification_end_at_utc
         data_type: timestamp without time zone
-        description: 
+        description: The date and time at which the guest finished the guest journey.
-          The date and time at which the guest finished the guest journey.
 
       - name: verification_end_date_utc
         data_type: date
-        description: 
+        description: The date on which the guest finished the guest journey.
-          The date on which the guest finished the guest journey.
 
       - name: link_used_at_utc
         data_type: timestamp without time zone
-        description: 
+        description: The date and time at which the guest used the link for the verification.
-          The date and time at which the guest used the link for the verification.
 
       - name: link_used_date_utc
         data_type: date
-        description: 
+        description: The date on which the guest used the link for the verification.
-          The date on which the guest used the link for the verification.
 
       - name: expire_at_utc
         data_type: timestamp without time zone
-        description: 
+        description: The date and time at which the link for the verification expires.
-          The date and time at which the link for the verification expires.
 
       - name: expire_date_utc
         data_type: date
-        description: 
+        description: The date on which the link for the verification expires.
-          The date on which the link for the verification expires.
 
       - name: is_deleted
         data_type: boolean
@@ -532,8 +523,7 @@ models:
 
       - name: rejection_reason
         data_type: character varying
-        description: 
+        description: Reason as to why the guest was rejected.
-          Reason as to why the guest was rejected.
 
       - name: has_switched_to_mobile
         data_type: boolean
@@ -555,30 +545,26 @@ models:
 
       - name: created_at_utc
         data_type: timestamp without time zone
-        description: 
+        description: The date and time at which the verification process was created.
-          The date and time at which the verification process was created.
 
       - name: created_date_utc
         data_type: date
-        description: 
+        description: The date on which the verification process was created.
-          The date on which the verification process was created.
 
       - name: updated_at_utc
         data_type: timestamp without time zone
-        description: 
+        description: The date and time at which the last update on the entry happened.
-          The date and time at which the last update on the entry happened.
 
       - name: updated_date_utc
         data_type: date
-        description: 
+        description: The date on which the last update on the entry happened.
-          The date on which the last update on the entry happened.
 
       - name: dwh_extracted_at_utc
         data_type: timestamp with time zone
         description: ""
 
   - name: core__unified_user
-    description: 
+    description:
       This is a table to join data from all users of Superhog (hosts, PMs, guests, etc).
 
       It contains details of every user like name, last name, email address, etc.
@@ -589,7 +575,7 @@ models:
         tests:
           - unique
           - not_null
-          
+
       - name: id_account_type
         data_type: bigint
         description: Internal ID for type of user.
@@ -632,13 +618,11 @@ models:
 
       - name: joined_at_utc
         data_type: timestamp without time zone
-        description: 
+        description: The date time when the user created it's account in Superhog.
-          The date time when the user created it's account in Superhog.
 
       - name: joined_date_utc
         data_type: date
-        description: 
+        description: The date when the user created it's account in Superhog.
-          The date when the user created it's account in Superhog.
 
       - name: user_name
         data_type: character varying
@@ -694,13 +678,11 @@ models:
 
       - name: created_date_utc
         data_type: timestamp without time zone
-        description: 
+        description: The date time when the user data was created.
-          The date time when the user data was created.
 
       - name: updated_date_utc
         data_type: timestamp without time zone
-        description: 
+        description: The date when the user data was created.
-          The date when the user data was created.
 
       - name: verified_at_utc
         data_type: timestamp without time zone
@@ -735,7 +717,7 @@ models:
         description: ""
 
   - name: core__check_in_cover_users
-    description: 
+    description:
       This model contains information about hosts that offer check in cover.
       It has basic information on the users like name, phone, email or joined date.
 
@@ -783,8 +765,7 @@ models:
 
       - name: check_in_cover_added_date_utc
         data_type: date
-        description: 
+        description: Date the user first included check-in cover
-          Date the user first included check-in cover
 
       - name: billing_town
         data_type: character varying
@@ -795,7 +776,7 @@ models:
         description: ""
 
   - name: core__guest_satisfaction_responses
-    description: 
+    description:
       This model contains information on guests satisfaction survey responses,
       it contains some basic information on the guests, a rating of their experience
       and some comments on it.
@@ -818,28 +799,25 @@ models:
 
       - name: verification_request_booking_source
         data_type: text
-        description: 
+        description: Source type of host of the booking, this could be either;
-          Source type of host of the booking, this could be either;
           - PMS
           - OSL
           - API/MANUAL
         tests:
           - not_null
           - accepted_values:
-                values:
+              values:
-                  - 'PMS'
+                - "PMS"
-                  - 'OSL'
+                - "OSL"
-                  - 'API/MANUAL'
+                - "API/MANUAL"
 
       - name: experience_rating
         data_type: bigint
-        description: 
+        description: Guest rating of their experience with Superhog from 1 to 5
-          Guest rating of their experience with Superhog from 1 to 5
 
       - name: guest_comments
         data_type: character varying
-        description: 
+        description: Guest comments on their experience with Superhog
-          Guest comments on their experience with Superhog
 
       - name: is_contactable
         data_type: boolean
@@ -848,13 +826,11 @@ models:
 
       - name: created_at_utc
         data_type: timestamp without time zone
-        description: 
+        description: Date and time of response creation
-          Date and time of response creation
 
       - name: updated_at_utc
         data_type: timestamp without time zone
-        description: 
+        description: Date and time of last update of response
-          Date and time of last update of response
 
       - name: selected_payment_option
         data_type: character varying
@@ -889,13 +865,12 @@ models:
           True if guest payed the fee
 
   - name: core__check_in_cover_listings
-    description: 
+    description: This model contains information about hosts and their listings
-      This model contains information about hosts and their listings 
       that offer check in cover.
       It has basic information on the users and listings like country,
       town, address and if they are active or not.
 
-      This model is restricted to active user so it doesn't include historical 
+      This model is restricted to active user so it doesn't include historical
       data like users that had check-in cover but are currently inactive.
     columns:
       - name: id_user_host
@@ -938,8 +913,7 @@ models:
 
       - name: check_in_cover_added_date_utc
         data_type: date
-        description: 
+        description: Date the user first included check-in cover
-          Date the user first included check-in cover
 
       - name: billing_town
         data_type: character varying
@@ -982,15 +956,13 @@ models:
 
       - name: check_in_cover_purchased
         data_type: bigint
-        description: 
+        description: "Count of how many Check-in covers have been
-          "Count of how many Check-in covers have been
           purchased for this accommodation"
 
   - name: core__host_booking_fees
-    description: 
+    description: Bookings that have been processed by the Superhog backend.
-      Bookings that have been processed by the Superhog backend.
       Each record matches one booking and has information on host
-      booking fees, when they were charged and the currency used by 
+      booking fees, when they were charged and the currency used by
       the host.
 
     columns:
@@ -1017,7 +989,7 @@ models:
 
       - name: booking_state
         data_type: character varying
-        description: 
+        description:
           "State in which the booking is, could be either of the following:
           - Approved
           - NotApproved
@@ -1026,20 +998,20 @@ models:
           - NoFlags
           - Flagged
           - IncompleteInformation"
-        tests:          
+        tests:
           - accepted_values:
-                values:
+              values:
-                  - 'Approved'
+                - "Approved"
-                  - 'NotApproved'
+                - "NotApproved"
-                  - 'Cancelled'
+                - "Cancelled"
-                  - 'Rejected'
+                - "Rejected"
-                  - 'NoFlags'
+                - "NoFlags"
-                  - 'Flagged'
+                - "Flagged"
-                  - 'IncompleteInformation'
+                - "IncompleteInformation"
 
       - name: is_duplicate_booking
         data_type: boolean
-        description:  |
+        description: |
           A flag that identifies whether the booking is a duplicate.
           A booking is considered a duplicate if there's an older booking with the same user,
           accomodation and check-in date. If there are two or more bookings with the same user,
@@ -1151,7 +1123,7 @@ models:
           Count of listings that the user owns.
           It contains only those that can accept bookings (hard
           activation - not to be confused with activity-based
-          segmentation).    
+          segmentation).
 
       - name: total_listings_with_product_bundle_with_paid_service
         data_type: integer
@@ -1195,7 +1167,7 @@ models:
         data_type: integer
         description: |
           Integer-based flag version of total_bookings_with_product_bundle.
-          
+
       - name: has_bookings_with_product_bundle_with_paid_service
         data_type: integer
         description: |

models/reporting/edeposit/schema.yml

@@ -1,9 +1,8 @@
 version: 2
 
 models:
-
   - name: edeposit__verification_fees
-    description: 
+    description:
       "This table shows all fee charges per verification for E-deposit.
       Cancellation fee is charged when the monthly rate of cancelled bookings over
       total booking of the partner surpasses the threshold (currently set at 5%).
@@ -19,9 +18,8 @@ models:
 
       - name: id_booking
         data_type: text
-        description: 
+        description: "unique Superhog generated id for a booking.
-          "unique Superhog generated id for a booking.
+          note that this could be duplicated and both will be charged,
-          note that this could be duplicated and both will be charged, 
           it's up to the user to no generate duplicate verifications"
         tests:
           - not_null
@@ -70,7 +68,7 @@ models:
 
       - name: cancelled_fee_in_txn_currency
         data_type: numeric
-        description: "fee charged in used currency for cancelled verifications"  
+        description: "fee charged in used currency for cancelled verifications"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_between:
@@ -79,7 +77,7 @@ models:
 
       - name: cancelled_fee_in_gbp
         data_type: numeric
-        description: "fee charged in gbp for cancelled verifications"  
+        description: "fee charged in gbp for cancelled verifications"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_between:
@@ -88,21 +86,20 @@ models:
 
       - name: checkout_date_utc
         data_type: date
-        description: "Date of checkout for the booking"  
+        description: "Date of checkout for the booking"
         tests:
           - not_null
 
       - name: created_date_utc
         data_type: date
-        description: "Date of creation of the verification in the system"  
+        description: "Date of creation of the verification in the system"
         tests:
           - not_null
-          
+
   - name: edeposit__guesty_verifications
-    description: 
+    description: "This table shows all verification for Guesty.
-      "This table shows all verification for Guesty.
       The charged fee is 2GBP per booked night if booking is approved
-      (considered 1 night when the checkin and checkout are on the same day), 
+      (considered 1 night when the checkin and checkout are on the same day),
       to be charged on checkout."
     columns:
       - name: id_verification
@@ -114,9 +111,8 @@ models:
 
       - name: id_booking
         data_type: text
-        description: 
+        description: "unique Superhog generated id for a booking.
-          "unique Superhog generated id for a booking. 
+          note that this could be duplicated and both will be charged,
-          note that this could be duplicated and both will be charged, 
           it's up to the user to not generate or cancel duplicate verifications"
         tests:
           - not_null
@@ -133,8 +129,7 @@ models:
 
       - name: ok_status_fee_in_gbp
         data_type: integer
-        description: 
+        description: "total fee charged on checkout, this is only charged for approved verifications"
-          "total fee charged on checkout, this is only charged for approved verifications"
         tests:
           - not_null
           - dbt_expectations.expect_column_values_to_be_between:
@@ -144,14 +139,12 @@ models:
 
       - name: created_date_utc
         data_type: date
-        description: 
+        description: "Date of creation of the verification in the system"
-          "Date of creation of the verification in the system"
         tests:
           - not_null
 
       - name: checkout_date_utc
         data_type: date
-        description: 
+        description: "Date of checkout for the booking"
-          "Date of checkout for the booking"
         tests:
-          - not_null
+          - not_null

models/reporting/general/schema.yml

@@ -166,7 +166,7 @@ models:
         description: The full date for the last day of the year.
 
   - name: daily_currency_exchange_rates
-    description: 
+    description:
       This model holds a lot of data on currency exchange rates.  The time
       granularity is daily. Each record holds a currency pair for a specific
       day, source and version.
@@ -306,7 +306,7 @@ models:
       It's the main source of information for the Main KPIs reporting, specifically
       on the MTD (Month To Date) and the Monthly Overview.
 
-    tests: 
+    tests:
       - dbt_utils.unique_combination_of_columns:
           combination_of_columns:
             - date
@@ -322,7 +322,7 @@ models:
           - not_null
 
       - name: month
-        data_type: int 
+        data_type: int
         description: Month number of the given date.
         tests:
           - not_null
@@ -370,11 +370,11 @@ models:
           The dimension or granularity of the metrics. Keep in mind that
           in this reporting model this field corresponds to the 
           dimension_display; this is, the name of the dimension for 
-          displaying purposes. 
+          displaying purposes.
 
         tests:
           - not_null
-      
+
       - name: dimension_value
         data_type: string
         description: The value or segment available for the selected dimension.
@@ -404,31 +404,31 @@ models:
         data_type: text
         description: Allows for grouping and formatting for displaying purposes.
         tests:
-        - accepted_values:
+          - accepted_values:
-            values: ['integer', 'percentage', 'currency_gbp']
+              values: ["integer", "percentage", "currency_gbp"]
 
       - name: value
-        data_type: numeric 
+        data_type: numeric
-        description: | 
+        description: |
           Numeric value (integer or decimal) that corresponds to the MTD computation of the metric
           at a given date. Note that if the month is not in progress, then this value corresponds
           to the monthly figure.
 
       - name: previous_year_value
-        data_type: numeric 
+        data_type: numeric
-        description: | 
+        description: |
           Numeric value (integer or decimal) that corresponds to the MTD computation of the metric
           on the previous year at a given date.
 
       - name: relative_increment
-        data_type: numeric 
+        data_type: numeric
-        description: | 
+        description: |
           Numeric value that corresponds to the relative increment between value and previous year value,
           following the computation: value / previous_year_value - 1.
 
       - name: relative_increment_with_sign_format
-        data_type: numeric 
+        data_type: numeric
-        description: | 
+        description: |
           Relative_increment value multiplied by -1 in case this metric's growth doesn't have a
           positive impact for Superhog, otherwise is equal to relative_increment.
           This value is specially created for formatting in PBI
@@ -448,9 +448,9 @@ models:
       the int_mtd_aggregated metrics because 1) the mtd version contains more computing dates
       than the by deal version, the latest being a subset of the first, and 2) the deal based model
       enforces that a booking/guest journey/listing/etc has a host with a deal assigned, which is
-      not necessarily the case. 
+      not necessarily the case.
 
-    tests: 
+    tests:
       - dbt_utils.unique_combination_of_columns:
           combination_of_columns:
             - date
@@ -463,10 +463,10 @@ models:
         tests:
           - not_null
           - latest_date_is_yesterday
-          
+
       - name: id_deal
         data_type: character varying
-        description: Id of the deal associated to the host. 
+        description: Id of the deal associated to the host.
         tests:
           - not_null
 
@@ -490,7 +490,7 @@ models:
           - not_null
 
       - name: month
-        data_type: int 
+        data_type: int
         description: month number of the given date.
         tests:
           - not_null
@@ -499,4 +499,4 @@ models:
         data_type: int
         description: day monthly number of the given date.
         tests:
-          - not_null
+          - not_null

models/reporting/xero/schema.yml

@@ -798,7 +798,7 @@ models:
         tests:
           - not_null
           - unique
-      
+
       - name: id_prepayment
         data_type: character varying
         description: |
@@ -1072,7 +1072,7 @@ models:
 
       - name: line_amount_wo_taxes_in_gbp
         data_type: numeric
-        description:  |
+        description: |
           The total value transferred in this line, minus taxes, presented in 
           GBP.
 
@@ -1083,12 +1083,12 @@ models:
 
       - name: tax_amount_local_curr
         data_type: numeric
-        description: | 
+        description: |
           The total value of taxes for this line, in the transaction currency.
 
       - name: tax_amount_in_gbp
         data_type: numeric
-        description: | 
+        description: |
           The total value of taxes for this line, presented in GBP.
 
       - name: tax_type
@@ -1151,7 +1151,7 @@ models:
 
       Most fields are not documented here: you can find more details in upstream 
       models.
-      
+
     columns:
       - name: id_line_item
         data_type: text
@@ -1172,8 +1172,8 @@ models:
           - not_null
           - accepted_values:
               values:
-                - 'invoice'
+                - "invoice"
-                - 'credit note'
+                - "credit note"
 
       - name: item_code
         data_type: text