version: 2

models:
  - name: int_hubspot__deal
    description: |
      Our deals in Hubspot. A deal is a commercial relationship with a client
      company. It's possible for a single company to have multiple deals, but
      it's frequent for them to only have one.

      Deals are one of the spines of Superhog's data. You will find references
      to Deal Ids in both our in-house systems and Xero.

      Note that deals that follow the Guardhog pipeline are excluded from this 
      table.

    columns:
      - name: id_deal
        data_type: character varying
        description: Unique ID for this deal.
        data_tests:
          - unique
          - not_null

      - name: deal_name
        data_type: text
        description: Name of the deal.

      - name: contract_signed_date_utc
        data_type: date
        description: Date in which the contract was signed

      - name: onboarding_date_utc
        data_type: date
        description: Date in which the contract was onboarded

      - name: live_date_utc
        data_type: date
        description: Date in which the account went live

      - name: cancellation_date_utc
        data_type: date
        description: Date in which an account that was being used was cancelled

      - name: account_manager
        data_type: text
        description: |
          The name of the account manager that is currently taking care of this
          deal.

      - name: onboarding_owner
        data_type: text
        description: |
          The name of the person who is or has been in charge of onboarding this 
          deal.

      - name: deal_pipeline
        data_type: text
        description: |
          The name of the hubspot pipeline for this deal.

      - name: deal_hubspot_stage
        data_type: text
        description: |
          The name of the hubspot stage this deal is currently in. The different 
          stages a deal can be in depend on the hubspot pipeline.

      - name: cancellation_category
        data_type: text
        description: Categorization as to why they cancelled the account

      - name: cancellation_details
        data_type: text
        description: Free text with additional comments on why they cancelled the account

      - name: amount_of_properties
        data_type: integer
        description: |
          Amount of properties the owner told us they manage. This is not necessarily the
          amount of properties that will be finally booked in our business.

      - name: last_contacted_date_utc
        data_type: date
        description: Date in which the account was last contacted

      - name: amount_times_contacted
        data_type: integer
        description: Amount of times the account has been contacted

      - name: integration_type
        data_type: text
        description: |
          The type of integration that the customer has, such as OSL,
          PMS, etc. It can be null.

      - name: dashboard_type
        data_type: text
        description: |
          The type of dashboard that the customer has access to. This applies 
          for platform clients, and can be either Legacy or New. 
          It can be null.

      - name: pricing_structure
        data_type: text
        description: |
          The pricing structure that the customer has. It can be null.

      - name: partnership_services
        data_type: text
        description: |
          The partnership type, i.e., the services that the client has 
          according to hubspot. This field has been processed by applying a 
          standardized separation "|" and an upper case. Be aware that this 
          is not how data is presented in HubSpot.
          Be aware that this might not capture the full history of services 
          that the client has had in the past, nor necessarily be always 
          up-to-date. For New Dash clients, please refer to backend data 
          for complete accuracy.
          It can be null.

      - name: expressed_service_interest
        data_type: text
        description: |
          The services that captured the interest of the potential client 
          during onboarding calls, for New Dash.
          This field has been processed by applying a standardized separation 
          "|" and an upper case. Be aware that this is not how data is 
          presented in HubSpot.
          Not to be confused with the actual services that host has applied.
          For the later, check backend data.
          It can be null.

      - name: created_at_utc
        data_type: timestamp with time zone
        description: Timestamp of when the record was created in Hubspot

      - name: created_date_utc
        data_type: date
        description: Date of when the record was created in Hubspot

      - name: updated_at_utc
        data_type: timestamp with time zone
        description: Timestamp of when the record was last updated in Hubspot

      - name: updated_date_utc
        data_type: date
        description: Date of when the record was last updated in Hubspot