data-dwh-dbt-project/models/intermediate/edeposit/schema.yml

version: 2

models:
  - name: int_edeposit__verifications
    description:
      "This table holds records on verifications for e-deposit bookings.
      It contains details on validations checked on the guests, guest information
      and some booking details like checkin-checkout date or the status of the verification.
      The id values found here are completely unrelated to the ones found in Core DWH.

      Note that id_verifications and booking_id should normally be 1 to 1.
      Though there are exception, the API will accept a duplicate booking and the users
      will be charged for it. A duplicate would return a unique id_verification."
    columns:
      - name: id_verification
        data_type: text
        description: "unique Superhog generated id for this verification"
        tests:
          - unique
          - not_null

      - name: id_booking
        data_type: text
        description: "unique Superhog generated id for a booking.
          note that this could be duplicated and both will be charged,
          it's up to the user to no generate duplicate verifications"

      - name: id_user_partner
        data_type: text
        description: "unique Superhog generated id for partner"
        tests:
          - not_null

      - name: id_accommodation
        data_type: text
        description: "unique Superhog generated id for a listing"

      - name: version
        data_type: text
        description: "value to identify if it is Guesty (V1) or E-deposit (V2)"
        tests:
          - accepted_values:
              values:
                - V1
                - V2

      - name: verification_source
        data_type: text
        description: "source of the verification for the booking"
        tests:
          - accepted_values:
              values:
                - Guesty
                - Edeposit

      - name: verification_status
        data_type: text
        description: "status of the verification"

      - name: nightly_fee_local
        data_type: double precision
        description: "fee charged per night"

      - name: number_nights
        data_type: integer
        description: "number of nights for the booking"

      - name: email_flag
        data_type: text
        description: "screening result for email"

      - name: phone_flag
        data_type: text
        description: "screening result for phone"

      - name: watch_list
        data_type: text
        description: "screening result of the guest"

      - name: channel
        data_type: text
        description: ""

      - name: checkin_at_utc
        data_type: timestamp without time zone
        description: "Timestamp of checkin for the booking"

      - name: checkin_date_utc
        data_type: date
        description: "Date of checkin for the booking"

      - name: checkout_at_utc
        data_type: timestamp without time zone
        description: "Timestamp of checkout for the booking"

      - name: checkout_date_utc
        data_type: date
        description: "Date of checkout for the booking"

      - name: is_cancelled
        data_type: boolean
        description: ""

      - name: cancelled_at_utc
        data_type: timestamp without time zone
        description: "Timestamp of cancellation of the booking"

      - name: cancelled_date_utc
        data_type: date
        description: "Date of cancellation for the booking"

      - name: user_email
        data_type: text
        description: ""

      - name: guest_email
        data_type: text
        description: ""

      - name: guest_last_name
        data_type: text
        description: ""

      - name: guest_first_name
        data_type: text
        description: ""

      - name: guest_telephone
        data_type: text
        description: ""

      - name: company_name
        data_type: text
        description: ""

      - name: property_manager_name
        data_type: text
        description: ""

      - name: property_manager_email
        data_type: text
        description: ""

      - name: listing_name
        data_type: text
        description: ""

      - name: listing_town
        data_type: text
        description: ""

      - name: listing_country
        data_type: text
        description: ""

      - name: listing_postcode
        data_type: text
        description: ""

      - name: pets_allowed
        data_type: boolean
        description: ""

      - name: level_of_protection_amount
        data_type: integer
        description: ""

      - name: level_of_protection_currency
        data_type: text
        description: ""

      - name: status_updated_at_utc
        data_type: timestamp without time zone
        description: "Timestamp when status was last updated"

      - name: status_updated_date_utc
        data_type: date
        description: "Date of last status update of the verification"

      - name: updated_at_utc
        data_type: timestamp without time zone
        description: "Timestamp of last updated of the verification"

      - name: updated_date_utc
        data_type: date
        description: "Date of last update of the verification"

      - name: athena_creation_at_utc
        data_type: timestamp without time zone
        description:
          "Athena timestamp referring to when the booking was created.
          It's provided by Guesty, but is not mandatory.
          In case of doubt use created_at_utc or created_date_utc fields"

      - name: athena_creation_date_utc
        data_type: date
        description: "Athena date referring to when the booking was created.
          It's provided by Guesty, but is not mandatory.
          In case of doubt use created_at_utc or created_date_utc fields"

      - name: created_at_utc
        data_type: timestamp without time zone
        description: "Timestamp of creation of the verification in the system"

      - name: created_date_utc
        data_type: date
        description: "Date of creation of the verification in the system"

  - name: int_edeposit__verification_fees
    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 0.05).
      Both cancellation and rejection fees are set to 0.25 though it might change.
      Fees are both in the currency used by the user and in GBP"
    columns:
      - name: id_verification
        data_type: text
        description: "Unique Superhog generated id for this verification.
          Note that there are some users that have a different id in Cosmos.
          For those users we created a mapping to relate this ids."
        tests:
          - unique
          - not_null

      - name: id_booking
        data_type: text
        description: "unique Superhog generated id for a booking.
          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

      - name: currency
        data_type: text
        description: "currency in which the transaction actually happened"
        tests:
          - not_null

      - name: ok_status_fee_in_txn_currency
        data_type: numeric
        description: "fee charged in used currency for approved or flagged verifications and not cancelled"
        tests:
          - not_null
          - dbt_expectations.expect_column_values_to_be_between:
              min_value: 0
              strictly: false

      - name: ok_status_fee_in_gbp
        data_type: numeric
        description: "fee charged in gbp for approved or flagged verifications and not cancelled"
        tests:
          - not_null
          - dbt_expectations.expect_column_values_to_be_between:
              min_value: 0
              strictly: false

      - name: rejected_fee_in_txn_currency
        data_type: numeric
        description: "fee charged in used currency for rejected verifications"
        tests:
          - not_null
          - dbt_expectations.expect_column_values_to_be_between:
              min_value: 0
              strictly: false

      - name: rejected_fee_in_gbp
        data_type: numeric
        description: "fee charged in gbp for rejected verifications"
        tests:
          - not_null
          - dbt_expectations.expect_column_values_to_be_between:
              min_value: 0
              strictly: false

      - name: cancelled_fee_in_txn_currency
        data_type: numeric
        description: "fee charged in used currency for cancelled verifications"
        tests:
          - not_null
          - dbt_expectations.expect_column_values_to_be_between:
              min_value: 0
              strictly: false

      - name: cancelled_fee_in_gbp
        data_type: numeric
        description: "fee charged in gbp for cancelled verifications"
        tests:
          - not_null
          - dbt_expectations.expect_column_values_to_be_between:
              min_value: 0
              strictly: false

      - name: checkout_date_utc
        data_type: date
        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"
        tests:
          - not_null

  - name: int_edeposit__guesty_verifications
    description: "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),
      to be charged on checkout."
    columns:
      - name: id_verification
        data_type: text
        description: "unique Superhog generated id for this verification"
        tests:
          - unique
          - not_null

      - name: id_booking
        data_type: text
        description: "unique Superhog generated id for a booking.
          note that there might be duplicate bookings on the original data
          but we remove them keeping only the verification with the most recent update."
        tests:
          - not_null
          - unique

      - name: verification_status
        data_type: text
        description: "status of the verification"

      - name: is_cancelled
        data_type: boolean
        description: "indicates if the booking has been cancelled or not."
        tests:
          - not_null

      - name: ok_status_fee_in_gbp
        data_type: integer
        description: "total fee charged on checkout, this is only charged for approved verifications"
        tests:
          - not_null
          - dbt_expectations.expect_column_values_to_be_between:
              min_value: 0
              strictly: true
              where: is_cancelled = false and verification_status = 'Approved'

      - name: created_date_utc
        data_type: date
        description: "Date of creation of the verification in the system"
        tests:
          - not_null

      - name: checkout_date_utc
        data_type: date
        description: "Date of checkout for the booking"
        tests:
          - not_null