> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

---
id: 77983efb-4f9d-4767-a159-208c42eac0cd
---

# Retrieve score

> Retrieve the configuration details of a specific lead scoring model in your HubSpot account using its unique score ID. This endpoint is useful for accessing the setup and parameters of a particular scoring model to understand how leads are being evaluated.

export const ScopesList = ({scopes = [], description = "This API requires one of the following scopes:"}) => {
  if (!scopes || scopes.length === 0) {
    return null;
  }
  const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
  return <div>
      <div className="text-sm mb-2">{description}</div>
      <div>
        {sortedScopes.map((scope, index) => <div key={index}>
            <code>
              <span className="text-xs">{scope}</span>
            </code>
          </div>)}
      </div>
    </div>;
};

export const SupportedProducts = ({marketing, sales, service, cms, data, commerce, crm, marketingLevel, salesLevel, serviceLevel, cmsLevel, dataLevel, commerceLevel, crmLevel}) => {
  const translations = {
    description: "Requires one of the following products or higher.",
    productNames: {
      marketing: "Marketing Hub",
      sales: "Sales Hub",
      service: "Service Hub",
      cms: "Content Hub",
      data: "Data Hub",
      commerce: "Revenue Hub",
      crm: "Smart CRM"
    },
    tiers: {
      free: "Free",
      starter: "Starter",
      professional: "Professional",
      enterprise: "Enterprise"
    }
  };
  const translateTier = tier => {
    if (!tier) return '';
    const lowerTier = tier.toLowerCase();
    return translations.tiers[lowerTier] || tier;
  };
  const products = [{
    name: marketing ? translations.productNames.marketing : '',
    level: translateTier(marketingLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/marketing-bolt.svg",
    alt: "Marketing Hub"
  }, {
    name: sales ? translations.productNames.sales : '',
    level: translateTier(salesLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/sales-star.svg",
    alt: "Sales Hub"
  }, {
    name: service ? translations.productNames.service : '',
    level: translateTier(serviceLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/service-heart.svg",
    alt: "Service Hub"
  }, {
    name: cms ? translations.productNames.cms : '',
    level: translateTier(cmsLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/content-play.svg",
    alt: "Content Hub"
  }, {
    name: data ? translations.productNames.data : '',
    level: translateTier(dataLevel),
    icon: "https://developers.hubspot.com/hubfs/Knowledge_Base_2023-24-25/subscription_key_icons/operations_icon.svg",
    alt: "Data Hub"
  }, {
    name: commerce ? translations.productNames.commerce : '',
    level: translateTier(commerceLevel),
    icon: "https://developers.hubspot.com/hubfs/Knowledge_Base/subscription_key_icons/commerce_icon.svg",
    alt: "Revenue Hub"
  }, {
    name: crm ? translations.productNames.crm : '',
    level: translateTier(crmLevel),
    icon: "https://developer.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/SmartCRM.svg",
    alt: "Smart CRM"
  }].filter(product => product.name && product.level);
  if (products.length === 0) return null;
  return <div>
      <div className="text-sm mb-2">{translations.description}</div>
      <div className={`grid ${products.length === 1 ? 'grid-cols-1' : 'grid-cols-2'} gap-1.5`}>
        {products.map((product, index) => <div key={index} style={{
    display: 'flex',
    alignItems: 'center'
  }}>
            <img src={product.icon} alt={product.alt} className="w-3.5 h-3.5 mr-1.5 mt-2.5 mb-2.5 flex-shrink-0 align-middle" />
            <span className="font-medium mr-1 text-sm">{product.name} -</span>
            <span className="text-sm">{product.level}</span>
          </div>)}
      </div>
    </div>;
};

<AccordionGroup>
  <Accordion title="Supported products" defaultOpen="true" icon="cubes">
    <SupportedProducts marketing={true} sales={true} marketingLevel="professional" salesLevel="professional" />
  </Accordion>

  <Accordion title="Required Scopes" icon="key">
    <ScopesList
      scopes={[
  'marketing.lead_scoring.read'
]}
    />
  </Accordion>
</AccordionGroup>


## OpenAPI

````yaml specs/2026-09-beta/marketing-lead-scoring-v2026-09-beta.json GET /marketing/lead-scoring/2026-09-beta/scores/{scoreId}
openapi: 3.0.1
info:
  title: Marketing Lead Scoring
  description: Basepom for all HubSpot Projects
  version: 2026-09-beta
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Advanced
  - name: Basic
paths:
  /marketing/lead-scoring/2026-09-beta/scores/{scoreId}:
    get:
      tags:
        - Basic
      summary: Retrieve score
      description: >-
        Retrieve the configuration details of a specific lead scoring model in
        your HubSpot account using its unique score ID. This endpoint is useful
        for accessing the setup and parameters of a particular scoring model to
        understand how leads are being evaluated.
      operationId: get-/marketing/lead-scoring/2026-09-beta/scores/{scoreId}
      parameters:
        - name: scoreId
          in: path
          description: The unique identifier of the lead scoring model to retrieve.
          required: true
          style: simple
          explode: false
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicScoreConfig'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - mh-lead-scoring-view
components:
  schemas:
    PublicScoreConfig:
      required:
        - allowedGroupTypes
        - groupConfigs
        - id
        - name
        - objectTypeId
        - scoreStatus
        - scoreType
      type: object
      properties:
        allowedGroupTypes:
          type: array
          description: >-
            An array of strings representing the types of groups that are
            allowed in this score configuration.
          items:
            type: string
            enum:
              - FIT
              - INTENT
        createdAt:
          type: string
          description: >-
            The date and time when this score configuration was created, in ISO
            8601 format.
          format: date-time
        filterConfiguration:
          $ref: '#/components/schemas/FilterConfiguration'
        groupConfigs:
          type: array
          description: >-
            An array of group configurations that define the rules and settings
            for scoring groups.
          items:
            $ref: '#/components/schemas/PublicScoreGroupConfig'
        id:
          type: string
          description: The unique identifier for this score configuration.
        maxScore:
          type: integer
          description: The maximum score that can be assigned within this configuration.
          format: int32
        name:
          type: string
          description: The name of the score configuration.
        objectTypeId:
          type: string
          description: >-
            The identifier for the type of object that this score configuration
            applies to.
        outputConfiguration:
          $ref: '#/components/schemas/PublicOutputConfig'
        publishedAt:
          type: string
          description: >-
            The date and time when this score configuration was published, in
            ISO 8601 format.
          format: date-time
        scoreStatus:
          type: string
          description: The current status of the score, indicating its operational state.
        scoreType:
          type: string
          description: >-
            The type of scoring being applied, defining the scoring method or
            category.
        updatedAt:
          type: string
          description: >-
            The date and time when this score configuration was last updated, in
            ISO 8601 format.
          format: date-time
    FilterConfiguration:
      required:
        - listFilterType
        - listIds
      type: object
      properties:
        listFilterType:
          type: string
          description: >-
            A string indicating the type of filter to apply to the lists
            specified in listIds.
          enum:
            - EXCLUDES
            - INCLUDES
        listIds:
          type: array
          description: >-
            An array of integers representing the IDs of lists to which the
            filter configuration applies.
          items:
            type: integer
            format: int32
    PublicScoreGroupConfig:
      required:
        - groupCategory
        - groupName
        - id
        - ruleConfigurations
      type: object
      properties:
        groupCategory:
          type: string
        groupDecay:
          $ref: '#/components/schemas/PublicGroupDecayConfig'
        groupName:
          type: string
        id:
          type: string
        maxValue:
          type: number
        minValue:
          type: number
        ruleConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/PublicScoreRuleConfig'
    PublicOutputConfig:
      required:
        - limitsByCategory
        - propertyWriters
      type: object
      properties:
        limitsByCategory:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/CategoryLimits'
        propertyWriters:
          type: array
          items:
            $ref: '#/components/schemas/PublicOutputPropertyConfig'
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: The general category of the error.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: An object containing additional context about the error condition.
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: A unique identifier for tracking the error across different systems.
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: >-
            An array of ErrorDetail objects, each providing specific information
            about individual errors that occurred.
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            An object containing URLs or references to additional resources or
            documentation related to the error.
        message:
          type: string
          description: A human-readable message describing the error.
          example: An error occurred
        subCategory:
          type: string
          description: >-
            A more specific category providing additional detail about the
            error.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    PublicGroupDecayConfig:
      required:
        - decayIntervalDays
        - percentToDecayPerInterval
      type: object
      properties:
        decayIntervalDays:
          type: integer
          format: int32
        percentToDecayPerInterval:
          type: number
    PublicScoreRuleConfig:
      required:
        - configuration
        - enabled
        - id
      type: object
      properties:
        configuration:
          $ref: '#/components/schemas/RuleConfiguration'
        enabled:
          type: boolean
        id:
          type: string
        maximumValue:
          type: number
        minimumValue:
          type: number
    CategoryLimits:
      required:
        - maxLimit
        - minLimit
      type: object
      properties:
        maxLimit:
          type: number
          description: >-
            The maximum allowable value for the category. It is a number that
            sets the upper boundary.
        minLimit:
          type: number
          description: >-
            The minimum allowable value for the category. It is a number that
            sets the lower boundary.
    PublicOutputPropertyConfig:
      required:
        - groupsAndCalculators
        - id
        - outputIsEnabled
        - propertyToWriteTo
      type: object
      properties:
        groupsAndCalculators:
          $ref: '#/components/schemas/GroupsAndCalculator'
        id:
          type: string
        outputIsEnabled:
          type: boolean
        propertyDescription:
          type: string
        propertyGroup:
          type: string
        propertyLabel:
          type: string
        propertyToWriteTo:
          type: string
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: The status code associated with the error detail.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Context about the error condition, represented as an object with
            additional properties that provide further details.
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: The name of the field or parameter in which the error was found.
        message:
          type: string
          description: >-
            A human readable message describing the error along with remediation
            steps where appropriate.
        subCategory:
          type: string
          description: >-
            A specific category that contains more specific detail about the
            error.
    RuleConfiguration:
      required:
        - calculation
      type: object
      properties:
        calculation:
          description: >-
            The calculation logic for the rule, which can be one of several
            types such as ConstantValueCalculator, MatchCalculator, or
            PropertyValueCalculator, among others.
          oneOf:
            - $ref: '#/components/schemas/ConstantValueCalculator'
            - $ref: '#/components/schemas/MatchCalculator'
            - $ref: '#/components/schemas/PropertyValueCalculator'
            - $ref: '#/components/schemas/MultiValueCalculator'
            - $ref: '#/components/schemas/UnifiedEventRollupCalculator'
            - $ref: '#/components/schemas/AssociationObjectRollupCalculator'
            - $ref: '#/components/schemas/MultiUnifiedEventRollupCalculator'
            - $ref: '#/components/schemas/AssociationUnifiedEventRollupCalculator'
            - $ref: '#/components/schemas/ListMembershipCalculator'
            - $ref: '#/components/schemas/ConditionalCalculator'
            - $ref: '#/components/schemas/ListMembershipEventCalculator'
        id:
          type: string
          description: >-
            A unique identifier for the rule configuration, represented as a
            UUID.
          format: uuid
    GroupsAndCalculator:
      required:
        - calculator
        - groupCategories
      type: object
      properties:
        calculator:
          description: >-
            An object that specifies the calculation logic. It can be one of
            several types, including ThresholdBasedCalculator,
            PassthroughCalculator, or CombinedThresholdCalculator.
          oneOf:
            - $ref: '#/components/schemas/ThresholdBasedCalculator'
            - $ref: '#/components/schemas/PassthroughCalculator'
            - $ref: '#/components/schemas/CombinedThresholdCalculator'
        groupCategories:
          type: array
          description: >-
            An array of strings representing the categories of groups involved
            in the calculation.
          items:
            type: string
        id:
          type: string
          description: >-
            A unique identifier for the GroupsAndCalculator object, formatted as
            a UUID.
          format: uuid
    ConstantValueCalculator:
      title: CONSTANT
      required:
        - type
        - value
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for the calculator, formatted as a UUID.
          format: uuid
        type:
          type: string
          description: A string indicating the type of calculator, which is 'CONSTANT'.
          default: CONSTANT
          enum:
            - CONSTANT
        value:
          type: number
          description: >-
            A number representing the constant value assigned by this
            calculator.
      x-hubspot-sub-type-impl: true
    MatchCalculator:
      title: MATCH
      required:
        - matchRules
        - property
        - type
      type: object
      properties:
        defaultValue:
          type: number
          description: >-
            A string representing the default value to be used if no match is
            found.
        id:
          type: string
          description: A unique identifier for the MatchCalculator, formatted as a UUID.
          format: uuid
        matchRules:
          type: array
          description: >-
            An array of match rules that define the conditions for the
            calculation. Each rule specifies an operation and a value.
          items:
            $ref: '#/components/schemas/MatchRule'
        property:
          type: string
          description: A string indicating the property that the match rules will evaluate.
        type:
          type: string
          description: >-
            A string representing the type of calculator, with the default value
            'MATCH'.
          default: MATCH
          enum:
            - MATCH
      x-hubspot-sub-type-impl: true
    PropertyValueCalculator:
      title: PROPERTY
      required:
        - property
        - type
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for the calculator, formatted as a UUID.
          format: uuid
        property:
          type: string
          description: The name of the property whose value is being calculated.
        type:
          type: string
          description: >-
            A string indicating the type of calculator, which is 'PROPERTY' for
            this component.
          default: PROPERTY
          enum:
            - PROPERTY
      x-hubspot-sub-type-impl: true
    MultiValueCalculator:
      title: MULTI
      required:
        - calculators
        - type
      type: object
      properties:
        calculators:
          type: array
          description: >-
            An array of calculators that are part of this multi-value
            calculator. Each item can be one of several types, such as
            ListMembershipCalculator, ConditionalCalculator, MatchCalculator, or
            others.
          items:
            oneOf:
              - $ref: '#/components/schemas/ListMembershipCalculator'
              - $ref: '#/components/schemas/ConditionalCalculator'
              - $ref: '#/components/schemas/MatchCalculator'
              - $ref: '#/components/schemas/MultiValueCalculator'
              - $ref: '#/components/schemas/ListMembershipEventCalculator'
              - $ref: '#/components/schemas/PropertyValueCalculator'
              - $ref: '#/components/schemas/ConstantValueCalculator'
        id:
          type: string
          description: A unique identifier for this calculator, formatted as a UUID.
          format: uuid
        type:
          type: string
          description: >-
            A string indicating the type of calculator, which is 'MULTI' for
            this component.
          default: MULTI
          enum:
            - MULTI
      x-hubspot-sub-type-impl: true
    UnifiedEventRollupCalculator:
      title: UE
      required:
        - eventTypeId
        - recordCalculation
        - rollupType
        - type
      type: object
      properties:
        decay:
          $ref: '#/components/schemas/UnifiedEventDecay'
        eventTimeframe:
          $ref: '#/components/schemas/EventTimeframe'
        eventTypeId:
          type: string
          description: >-
            A string identifier for the event type that this calculator will
            process.
        id:
          type: string
          description: A unique identifier for the calculator, formatted as a UUID.
          format: uuid
        recordCalculation:
          description: >-
            An object defining the calculation to be performed on the records.
            It can be one of several types, such as ListMembershipCalculator,
            ConditionalCalculator, MatchCalculator, MultiValueCalculator,
            ListMembershipEventCalculator, PropertyValueCalculator, or
            ConstantValueCalculator.
          oneOf:
            - $ref: '#/components/schemas/ListMembershipCalculator'
            - $ref: '#/components/schemas/ConditionalCalculator'
            - $ref: '#/components/schemas/MatchCalculator'
            - $ref: '#/components/schemas/MultiValueCalculator'
            - $ref: '#/components/schemas/ListMembershipEventCalculator'
            - $ref: '#/components/schemas/PropertyValueCalculator'
            - $ref: '#/components/schemas/ConstantValueCalculator'
        rollupType:
          type: string
          description: >-
            A string representing the type of rollup operation to perform. Valid
            values include 'COUNT', 'SUM', 'MAX', 'MIN', 'AVG', and 'MEDIAN'.
          enum:
            - AVG
            - COUNT
            - MAX
            - MEDIAN
            - MIN
            - SUM
        type:
          type: string
          description: >-
            A string indicating the type of calculator, with a default value of
            'UE'.
          default: UE
          enum:
            - UE
      x-hubspot-sub-type-impl: true
    AssociationObjectRollupCalculator:
      title: ASSOCIATIONS
      required:
        - associatedObjectTypeId
        - associationSpec
        - inverseAssociationSpec
        - recordCalculation
        - rollupType
        - type
      type: object
      properties:
        associatedObjectTypeId:
          type: string
          description: A string representing the type ID of the associated object.
        associationFilters:
          $ref: '#/components/schemas/AssociationFilter'
        associationSpec:
          $ref: '#/components/schemas/AssociationSpec'
        id:
          type: string
          description: A unique identifier for the calculator, formatted as a UUID.
          format: uuid
        inverseAssociationSpec:
          $ref: '#/components/schemas/AssociationSpec'
        maxRecords:
          type: integer
          description: >-
            An integer specifying the maximum number of records to consider in
            the rollup calculation.
          format: int32
        recordCalculation:
          description: >-
            An object or one of several possible schemas that defines the
            calculation to perform on the records, such as
            ListMembershipCalculator, ConditionalCalculator, MatchCalculator,
            MultiValueCalculator, ListMembershipEventCalculator,
            PropertyValueCalculator, or ConstantValueCalculator.
          oneOf:
            - $ref: '#/components/schemas/ListMembershipCalculator'
            - $ref: '#/components/schemas/ConditionalCalculator'
            - $ref: '#/components/schemas/MatchCalculator'
            - $ref: '#/components/schemas/MultiValueCalculator'
            - $ref: '#/components/schemas/ListMembershipEventCalculator'
            - $ref: '#/components/schemas/PropertyValueCalculator'
            - $ref: '#/components/schemas/ConstantValueCalculator'
        rollupType:
          type: string
          description: >-
            A string specifying the type of rollup operation to perform. Valid
            values include 'COUNT', 'SUM', 'MAX', 'MIN', 'AVG', and 'MEDIAN'.
          enum:
            - AVG
            - COUNT
            - MAX
            - MEDIAN
            - MIN
            - SUM
        type:
          type: string
          description: >-
            A string indicating the type of calculator, with a default value of
            'ASSOCIATIONS'.
          default: ASSOCIATIONS
          enum:
            - ASSOCIATIONS
      x-hubspot-sub-type-impl: true
    MultiUnifiedEventRollupCalculator:
      title: MULTI_UE
      required:
        - eventCalculators
        - rollupType
        - type
      type: object
      properties:
        decay:
          $ref: '#/components/schemas/UnifiedEventDecay'
        eventCalculators:
          type: array
          description: >-
            An array of event calculator entries that define how individual
            events should be processed and aggregated.
          items:
            $ref: '#/components/schemas/MultiUnifiedEventCalculatorEntry'
        id:
          type: string
          description: A unique identifier for the calculator, formatted as a UUID.
          format: uuid
        rollupType:
          type: string
          description: >-
            The type of rollup operation to perform. Valid values include
            'COUNT', 'SUM', 'MAX', 'MIN', 'AVG', and 'MEDIAN'.
          enum:
            - AVG
            - COUNT
            - MAX
            - MEDIAN
            - MIN
            - SUM
        type:
          type: string
          description: >-
            A string indicating the type of calculator, which is 'MULTI_UE' for
            this component.
          default: MULTI_UE
          enum:
            - MULTI_UE
      x-hubspot-sub-type-impl: true
    AssociationUnifiedEventRollupCalculator:
      title: ASSOCIATION_UE
      required:
        - associatedObjectTypeId
        - associationSpec
        - inverseAssociationSpec
        - recordCalculation
        - rollupType
        - type
      type: object
      properties:
        associatedObjectTypeId:
          type: string
          description: >-
            A string representing the type ID of the object that is associated
            with the events.
        associationFilters:
          $ref: '#/components/schemas/AssociationFilter'
        associationSpec:
          $ref: '#/components/schemas/AssociationSpec'
        id:
          type: string
          description: A unique identifier for the calculator, formatted as a UUID.
          format: uuid
        inverseAssociationSpec:
          $ref: '#/components/schemas/AssociationSpec'
        maxRecords:
          type: integer
          description: >-
            An integer specifying the maximum number of records to consider in
            the rollup calculation.
          format: int32
        recordCalculation:
          $ref: '#/components/schemas/MultiUnifiedEventRollupCalculator'
        rollupType:
          type: string
          description: >-
            A string representing the type of rollup operation to perform, with
            valid values including 'COUNT', 'SUM', 'MAX', 'MIN', 'AVG', and
            'MEDIAN'.
          enum:
            - AVG
            - COUNT
            - MAX
            - MEDIAN
            - MIN
            - SUM
        type:
          type: string
          description: >-
            A string indicating the type of calculator, which is
            'ASSOCIATION_UE' for this component.
          default: ASSOCIATION_UE
          enum:
            - ASSOCIATION_UE
      x-hubspot-sub-type-impl: true
    ListMembershipCalculator:
      title: LIST_MEMBERSHIP
      required:
        - listMembershipRules
        - type
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for the calculator, represented as a UUID.
          format: uuid
        listMembershipRules:
          type: array
          description: >-
            An array of rules that define the criteria for list membership. Each
            rule is represented by a ListMembershipRule object.
          items:
            $ref: '#/components/schemas/ListMembershipRule'
        type:
          type: string
          description: >-
            A string that specifies the type of calculator, which is
            'LIST_MEMBERSHIP_EVENT'.
          default: LIST_MEMBERSHIP
          enum:
            - LIST_MEMBERSHIP
      x-hubspot-sub-type-impl: true
    ConditionalCalculator:
      title: CONDITIONAL
      required:
        - type
        - value
        - whereCondition
      type: object
      properties:
        id:
          type: string
          description: >-
            A unique identifier for the ConditionalCalculator, formatted as a
            UUID.
          format: uuid
        type:
          type: string
          description: >-
            A string indicating the type of calculator, which is 'CONDITIONAL'
            for this component.
          default: CONDITIONAL
          enum:
            - CONDITIONAL
        value:
          type: number
          description: >-
            A numeric value representing the result of the calculation when the
            conditions are met.
        whereCondition:
          $ref: '#/components/schemas/CompositeCondition'
      x-hubspot-sub-type-impl: true
    ListMembershipEventCalculator:
      title: LIST_MEMBERSHIP_EVENT
      required:
        - listMembershipRules
        - type
      type: object
      properties:
        decay:
          $ref: '#/components/schemas/UnifiedEventDecay'
        eventTimeframe:
          $ref: '#/components/schemas/EventTimeframe'
        id:
          type: string
          description: A unique identifier for the calculator, formatted as a UUID.
          format: uuid
        listMembershipRules:
          type: array
          description: An array of rules that define the conditions for list membership.
          items:
            $ref: '#/components/schemas/ListMembershipRule'
        type:
          type: string
          description: >-
            A string indicating the type of calculator, which is
            'LIST_MEMBERSHIP_EVENT'.
          default: LIST_MEMBERSHIP_EVENT
          enum:
            - LIST_MEMBERSHIP_EVENT
      x-hubspot-sub-type-impl: true
    ThresholdBasedCalculator:
      title: THRESHOLD
      required:
        - outputIfNoThresholdMet
        - thresholds
        - type
      type: object
      properties:
        defaultTagColor:
          type: string
          description: >-
            A string representing the default color tag associated with the
            calculator.
        id:
          type: string
          description: A unique identifier for the calculator, formatted as a UUID.
          format: uuid
        offset:
          type: number
          description: >-
            A numerical value representing an offset applied during the
            calculation.
        outputIfNoThresholdMet:
          type: string
          description: >-
            The output value to be used if no thresholds are met during the
            calculation.
        thresholds:
          type: array
          description: >-
            An array of threshold descriptors that define the conditions for
            scoring.
          items:
            $ref: '#/components/schemas/ThresholdEntry'
        type:
          type: string
          description: >-
            A string that indicates the type of calculator, specifically
            'THRESHOLD'.
          default: THRESHOLD
          enum:
            - THRESHOLD
      x-hubspot-sub-type-impl: true
    PassthroughCalculator:
      title: PASS
      required:
        - type
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for the calculator, represented as a UUID.
          format: uuid
        maxValue:
          type: number
          description: >-
            A number indicating the maximum value that can be passed through by
            the calculator.
        minValue:
          type: number
          description: >-
            A number indicating the minimum value that can be passed through by
            the calculator.
        offset:
          type: number
          description: A number representing the offset to be applied to the input value.
        type:
          type: string
          description: >-
            A string that specifies the type of calculator, which is 'PASS' for
            the PassthroughCalculator.
          default: PASS
          enum:
            - PASS
      x-hubspot-sub-type-impl: true
    CombinedThresholdCalculator:
      title: COMBINED
      required:
        - offsetByCategory
        - thresholds
        - type
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for this calculator, formatted as a UUID.
          format: uuid
        offsetByCategory:
          type: object
          additionalProperties:
            type: number
          description: >-
            An object mapping category names to their respective offset values,
            allowing for category-specific adjustments.
        thresholds:
          type: array
          description: >-
            An array of CombinedThresholdEntry objects, each defining specific
            thresholds and outputs for different categories.
          items:
            $ref: '#/components/schemas/CombinedThresholdEntry'
        type:
          type: string
          description: >-
            A string indicating the type of calculator, expected to be
            'CombinedThresholdCalculator'.
          default: COMBINED
          enum:
            - COMBINED
      x-hubspot-sub-type-impl: true
    MatchRule:
      required:
        - operation
        - value
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for the match rule, formatted as a UUID.
          format: uuid
        operation:
          description: >-
            The operation to be performed, which can be one of several types
            such as BoolPropertyOperation, NumberPropertyOperation,
            StringPropertyOperation, and others.
          oneOf:
            - $ref: '#/components/schemas/BoolPropertyOperation'
            - $ref: '#/components/schemas/NumberPropertyOperation'
            - $ref: '#/components/schemas/StringPropertyOperation'
            - $ref: '#/components/schemas/DateTimePropertyOperation'
            - $ref: '#/components/schemas/RangedDatePropertyOperation'
            - $ref: '#/components/schemas/ComparativeDatePropertyOperation'
            - $ref: '#/components/schemas/ComparativeBoolPropertyOperation'
            - $ref: '#/components/schemas/ComparativeNumberPropertyOperation'
            - $ref: '#/components/schemas/ComparativeStringPropertyOperation'
            - $ref: '#/components/schemas/ComparativePropertyUpdatedOperation'
            - $ref: '#/components/schemas/RollingDateRangePropertyOperation'
            - $ref: '#/components/schemas/RollingPropertyUpdatedOperation'
            - $ref: '#/components/schemas/EnumerationPropertyOperation'
            - $ref: '#/components/schemas/AllPropertyTypesOperation'
            - $ref: '#/components/schemas/RangedNumberPropertyOperation'
            - $ref: '#/components/schemas/MultiStringPropertyOperation'
            - $ref: '#/components/schemas/DatePropertyOperation'
            - $ref: '#/components/schemas/CalendarDatePropertyOperation'
            - $ref: '#/components/schemas/TimePointOperation'
            - $ref: '#/components/schemas/RangedTimeOperation'
            - $ref: '#/components/schemas/RegexPropertyOperation'
        value:
          type: number
          description: >-
            A numerical value associated with the match rule, used in
            conjunction with the operation to determine if the rule is
            satisfied.
    UnifiedEventDecay:
      required:
        - decayIntervalDays
        - percentToDecayPerInterval
      type: object
      properties:
        decayIntervalDays:
          type: integer
          description: >-
            An integer representing the number of days between each decay
            interval.
          format: int32
        percentToDecayPerInterval:
          type: number
          description: >-
            A number indicating the percentage by which the score should decay
            at each interval.
    EventTimeframe:
      required:
        - eventFilterOperation
      type: object
      properties:
        eventFilterOperation:
          description: >-
            Defines the operation used to filter events within the timeframe.
            This can be one of several types of property operations, such as
            BoolPropertyOperation, NumberPropertyOperation,
            StringPropertyOperation, and others, each specifying different
            criteria for event filtering.
          oneOf:
            - $ref: '#/components/schemas/BoolPropertyOperation'
            - $ref: '#/components/schemas/NumberPropertyOperation'
            - $ref: '#/components/schemas/StringPropertyOperation'
            - $ref: '#/components/schemas/DateTimePropertyOperation'
            - $ref: '#/components/schemas/RangedDatePropertyOperation'
            - $ref: '#/components/schemas/ComparativeDatePropertyOperation'
            - $ref: '#/components/schemas/ComparativeBoolPropertyOperation'
            - $ref: '#/components/schemas/ComparativeNumberPropertyOperation'
            - $ref: '#/components/schemas/ComparativeStringPropertyOperation'
            - $ref: '#/components/schemas/ComparativePropertyUpdatedOperation'
            - $ref: '#/components/schemas/RollingDateRangePropertyOperation'
            - $ref: '#/components/schemas/RollingPropertyUpdatedOperation'
            - $ref: '#/components/schemas/EnumerationPropertyOperation'
            - $ref: '#/components/schemas/AllPropertyTypesOperation'
            - $ref: '#/components/schemas/RangedNumberPropertyOperation'
            - $ref: '#/components/schemas/MultiStringPropertyOperation'
            - $ref: '#/components/schemas/DatePropertyOperation'
            - $ref: '#/components/schemas/CalendarDatePropertyOperation'
            - $ref: '#/components/schemas/TimePointOperation'
            - $ref: '#/components/schemas/RangedTimeOperation'
            - $ref: '#/components/schemas/RegexPropertyOperation'
    AssociationFilter:
      required:
        - propertyFilters
        - type
      type: object
      properties:
        propertyFilters:
          type: array
          description: >-
            An array of PropertyFilter objects that define the specific
            conditions or operations to apply to properties when filtering
            associations.
          items:
            $ref: '#/components/schemas/PropertyFilter'
        type:
          type: string
          description: >-
            A string indicating the type of the filter, used to categorize or
            identify the filter within the system.
    AssociationSpec:
      required:
        - associationCategory
        - associationTypeId
      type: object
      properties:
        associationCategory:
          type: string
          description: >-
            A string representing the category of the association. This defines
            the general type or grouping of the association.
          enum:
            - HUBSPOT_DEFINED
            - INTEGRATOR_DEFINED
            - USER_DEFINED
            - WORK
        associationTypeId:
          type: integer
          description: >-
            An integer representing the unique identifier for the specific type
            of association. This ID is used to distinguish between different
            association types within the same category.
          format: int32
      description: >-
        Defines the type, direction, and details of the relationship between two
        CRM objects.
    MultiUnifiedEventCalculatorEntry:
      required:
        - eventTypeId
        - recordCalculation
      type: object
      properties:
        eventFrequencyCriteria:
          description: >-
            Specifies the criteria for the frequency of the event, which can be
            either an EventFrequencyBetween or an EmptyFrequencyCriteria.
          oneOf:
            - $ref: '#/components/schemas/EventFrequencyBetween'
            - $ref: '#/components/schemas/EmptyFrequencyCriteria'
        eventTimeframe:
          $ref: '#/components/schemas/EventTimeframe'
        eventTypeId:
          type: string
          description: The identifier for the type of event this entry is associated with.
        id:
          type: string
          description: A unique identifier for the entry, formatted as a UUID.
          format: uuid
        recordCalculation:
          description: >-
            Specifies the calculation method for the event record. This can be
            one of several types of calculators, such as
            ListMembershipCalculator, ConditionalCalculator, MatchCalculator,
            MultiValueCalculator, ListMembershipEventCalculator,
            PropertyValueCalculator, or ConstantValueCalculator.
          oneOf:
            - $ref: '#/components/schemas/ListMembershipCalculator'
            - $ref: '#/components/schemas/ConditionalCalculator'
            - $ref: '#/components/schemas/MatchCalculator'
            - $ref: '#/components/schemas/MultiValueCalculator'
            - $ref: '#/components/schemas/ListMembershipEventCalculator'
            - $ref: '#/components/schemas/PropertyValueCalculator'
            - $ref: '#/components/schemas/ConstantValueCalculator'
    ListMembershipRule:
      required:
        - listIds
        - operation
        - value
      type: object
      properties:
        id:
          type: string
          description: >-
            The unique identifier for the list membership rule, represented as a
            UUID.
          format: uuid
        listIds:
          type: array
          description: >-
            An array of integers representing the IDs of lists that are
            evaluated by this rule.
          items:
            type: integer
            format: int32
        operation:
          type: string
          description: >-
            Specifies the operation or condition that must be met for the rule
            to apply. This is defined by a specific operation type.
          enum:
            - HAS_ALL_LIST_MEMBERSHIP
            - HAS_AT_LEAST_ONE_LIST_MEMBERSHIP
            - HAS_NO_LIST_MEMBERSHIP
        value:
          type: number
          description: >-
            A numerical value that is used in conjunction with the operation to
            determine if the rule is satisfied.
    CompositeCondition:
      title: COMPOSITE
      required:
        - conditions
        - operator
        - type
      type: object
      properties:
        conditions:
          type: array
          description: >-
            An array of conditions that are part of this composite condition.
            Each condition is evaluated as part of the composite logic.
          items:
            oneOf:
              - $ref: '#/components/schemas/SingleCondition'
              - $ref: '#/components/schemas/CompositeCondition'
        id:
          type: string
          description: >-
            A unique identifier for the composite condition, formatted as a
            UUID.
          format: uuid
        operator:
          type: string
          description: >-
            A string representing the logical operator used to combine the
            conditions, such as 'AND' or 'OR'.
          enum:
            - AND
            - OR
        type:
          type: string
          description: >-
            A string indicating the type of condition, expected to be
            'COMPOSITE'.
          default: COMPOSITE
          enum:
            - COMPOSITE
      x-hubspot-sub-type-impl: true
    ThresholdEntry:
      required:
        - output
        - threshold
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for this threshold entry, formatted as a UUID.
          format: uuid
        output:
          type: string
          description: The output category associated with this threshold entry.
        tagColor:
          type: string
          description: >-
            A string representing the color tag associated with this threshold
            entry.
        threshold:
          type: number
          description: The numeric value that represents the threshold for this entry.
    CombinedThresholdEntry:
      required:
        - output
        - thresholdByCategory
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for this entry, formatted as a UUID.
          format: uuid
        output:
          type: string
          description: >-
            A string representing the output associated with this threshold
            entry.
        tagColor:
          type: string
          description: >-
            A string specifying the color tag associated with this entry,
            typically used for visual representation.
        thresholdByCategory:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/CombinedThresholdDescriptor'
          description: >-
            An object mapping category names to their respective threshold
            descriptors, which define the threshold values for each category.
    BoolPropertyOperation:
      title: bool
      required:
        - includeObjectsWithNoValueSet
        - operationType
        - operator
        - operatorName
        - propertyType
        - value
      type: object
      properties:
        defaultValue:
          type: string
          description: A string representing the default value for the operation.
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean indicating whether objects with no value set should be
            included in the operation.
        operationType:
          type: string
          description: A string representing the type of operation being performed.
        operator:
          type: string
          description: >-
            A string indicating the operation to be performed, with valid values
            including 'IS_EQUAL_TO', 'IS_NOT_EQUAL_TO',
            'HAS_EVER_BEEN_EQUAL_TO', and 'HAS_NEVER_BEEN_EQUAL_TO'.
          enum:
            - HAS_EVER_BEEN_EQUAL_TO
            - HAS_NEVER_BEEN_EQUAL_TO
            - IS_EQUAL_TO
            - IS_NOT_EQUAL_TO
        operatorName:
          type: string
          description: >-
            A string representing the name of the operator used in the
            operation.
        propertyType:
          type: string
          description: A string representing the type of property, defaulting to 'bool'.
          default: bool
          enum:
            - bool
        renderSpec:
          type: string
          description: A string specifying how the operation should be rendered.
        value:
          type: boolean
          description: A boolean value that the property is compared against.
      x-hubspot-sub-type-impl: true
    NumberPropertyOperation:
      title: number
      required:
        - includeObjectsWithNoValueSet
        - operationType
        - operator
        - operatorName
        - propertyType
        - value
      type: object
      properties:
        defaultValue:
          type: string
          description: >-
            A string representing the default value used in the operation if no
            specific value is set.
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean indicating whether objects without a set value should be
            included in the operation.
        operationType:
          type: string
          description: A string representing the type of operation being performed.
        operator:
          type: string
          description: >-
            A string indicating the comparison operation to perform. Valid
            values include 'IS_EQUAL_TO', 'IS_NOT_EQUAL_TO', 'IS_GREATER_THAN',
            'IS_GREATER_THAN_OR_EQUAL_TO', 'IS_LESS_THAN',
            'IS_LESS_THAN_OR_EQUAL_TO', 'HAS_EVER_BEEN_EQUAL_TO', and
            'HAS_NEVER_BEEN_EQUAL_TO'.
          enum:
            - HAS_EVER_BEEN_EQUAL_TO
            - HAS_NEVER_BEEN_EQUAL_TO
            - IS_EQUAL_TO
            - IS_GREATER_THAN
            - IS_GREATER_THAN_OR_EQUAL_TO
            - IS_LESS_THAN
            - IS_LESS_THAN_OR_EQUAL_TO
            - IS_NOT_EQUAL_TO
        operatorName:
          type: string
          description: A string providing a human-readable name for the operator.
        propertyType:
          type: string
          description: A string representing the type of property, defaulting to 'number'.
          default: number
          enum:
            - number
        renderSpec:
          type: string
          description: A string specifying the rendering specification for the operation.
        value:
          type: number
          description: >-
            A number representing the value to be compared against in the
            operation.
      x-hubspot-sub-type-impl: true
    StringPropertyOperation:
      title: string
      required:
        - includeObjectsWithNoValueSet
        - operationType
        - operator
        - operatorName
        - propertyType
        - value
      type: object
      properties:
        defaultValue:
          type: string
          description: >-
            A string representing the default value to be used if no specific
            value is set.
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean indicating whether objects without a set value should be
            included in the operation.
        operationType:
          type: string
          description: A string representing the type of operation being performed.
        operator:
          type: string
          description: >-
            A string representing the operation to be performed, such as
            'IS_EQUAL_TO', 'CONTAINS', or 'STARTS_WITH'.
          enum:
            - CONTAINS
            - DOES_NOT_CONTAIN
            - ENDS_WITH
            - HAS_EVER_BEEN_EQUAL_TO
            - HAS_EVER_CONTAINED
            - HAS_NEVER_BEEN_EQUAL_TO
            - HAS_NEVER_CONTAINED
            - IS_EQUAL_TO
            - IS_NOT_EQUAL_TO
            - STARTS_WITH
        operatorName:
          type: string
          description: >-
            A string representing the name of the operator used in the
            operation.
        propertyType:
          type: string
          description: A string indicating the type of property, defaulting to 'string'.
          default: string
          enum:
            - string
        renderSpec:
          type: string
          description: >-
            A string providing specifications for rendering the operation, if
            applicable.
        value:
          type: string
          description: >-
            A string value that the operation will use for comparison or
            evaluation.
      x-hubspot-sub-type-impl: true
    DateTimePropertyOperation:
      title: datetime
      required:
        - includeObjectsWithNoValueSet
        - operationType
        - operator
        - operatorName
        - propertyType
        - requiresTimeZoneConversion
        - timestamp
      type: object
      properties:
        defaultValue:
          type: string
          description: >-
            A string that specifies the default value to use if no other value
            is set.
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean indicating whether to include objects that have no value
            set for the property.
        operationType:
          type: string
          description: A string that specifies the type of operation being performed.
        operator:
          type: string
          description: >-
            A string representing the operation to be performed, with valid
            values including 'IS_BEFORE', 'IS_AFTER', 'IS_EQUAL_TO',
            'IS_BEFORE_DATE', and 'IS_AFTER_DATE'.
          enum:
            - IS_AFTER
            - IS_AFTER_DATE
            - IS_BEFORE
            - IS_BEFORE_DATE
            - IS_EQUAL_TO
        operatorName:
          type: string
          description: >-
            A string representing the name of the operator used in the
            operation.
        propertyType:
          type: string
          description: A string indicating the type of property, defaulting to 'datetime'.
          default: datetime
          enum:
            - datetime
        renderSpec:
          type: string
          description: A string that provides rendering specifications for the operation.
        requiresTimeZoneConversion:
          type: boolean
          description: >-
            A boolean indicating whether the operation requires conversion based
            on time zone.
        timestamp:
          type: integer
          description: >-
            An integer representing a Unix timestamp in milliseconds used for
            comparison.
          format: int64
      x-hubspot-sub-type-impl: true
    RangedDatePropertyOperation:
      title: datetime-ranged
      required:
        - includeObjectsWithNoValueSet
        - lowerBoundTimestamp
        - operationType
        - operator
        - operatorName
        - propertyType
        - requiresTimeZoneConversion
        - upperBoundTimestamp
      type: object
      properties:
        defaultValue:
          type: string
          description: A string representing the default value to use if no value is set.
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean indicating whether objects without a set value should be
            included in the operation.
        lowerBoundTimestamp:
          type: integer
          description: >-
            An integer representing the lower bound of the timestamp range, in
            milliseconds since the Unix epoch.
          format: int64
        operationType:
          type: string
          description: A string representing the type of operation being performed.
        operator:
          type: string
          description: >-
            A string indicating the operation to perform, with valid values
            being 'IS_BETWEEN' and 'IS_NOT_BETWEEN'.
          enum:
            - IS_BETWEEN
            - IS_NOT_BETWEEN
        operatorName:
          type: string
          description: A string providing a human-readable name for the operator.
        propertyType:
          type: string
          description: >-
            A string representing the type of property, defaulting to
            'datetime-ranged'.
          default: datetime-ranged
          enum:
            - datetime-ranged
        renderSpec:
          type: string
          description: >-
            A string specifying how the operation should be rendered or
            displayed.
        requiresTimeZoneConversion:
          type: boolean
          description: >-
            A boolean indicating whether the timestamps require conversion based
            on time zones.
        upperBoundTimestamp:
          type: integer
          description: >-
            An integer representing the upper bound of the timestamp range, in
            milliseconds since the Unix epoch.
          format: int64
      x-hubspot-sub-type-impl: true
    ComparativeDatePropertyOperation:
      title: datetime-comparative
      required:
        - comparisonPropertyName
        - includeObjectsWithNoValueSet
        - operationType
        - operator
        - operatorName
        - propertyType
      type: object
      properties:
        comparisonPropertyName:
          type: string
          description: A string specifying the name of the property to be compared against.
        defaultComparisonValue:
          type: string
          description: >-
            A string representing the default value to compare against if the
            comparison property is not set.
        defaultValue:
          type: string
          description: >-
            A string representing the default value used in the operation if no
            other value is set.
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean indicating whether objects with no value set should be
            included in the operation.
        operationType:
          type: string
          description: A string indicating the type of operation being performed.
        operator:
          type: string
          description: >-
            A string representing the comparison operator used in the operation.
            Valid values include 'IS_BEFORE' and 'IS_AFTER'.
          enum:
            - IS_AFTER
            - IS_BEFORE
        operatorName:
          type: string
          description: >-
            A string representing the name of the operator used in the
            operation.
        propertyType:
          type: string
          description: >-
            A string indicating the type of property operation, with a default
            value of 'datetime-comparative'.
          default: datetime-comparative
          enum:
            - datetime-comparative
        renderSpec:
          type: string
          description: >-
            A string that specifies how the operation should be rendered or
            displayed.
      x-hubspot-sub-type-impl: true
    ComparativeBoolPropertyOperation:
      title: bool-comparative
      required:
        - comparisonPropertyName
        - includeObjectsWithNoValueSet
        - operationType
        - operator
        - operatorName
        - propertyType
      type: object
      properties:
        comparisonPropertyName:
          type: string
          description: A string specifying the name of the property to be compared.
        defaultValue:
          type: string
          description: >-
            A string representing the default value to be used if no other value
            is set.
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean indicating whether objects with no value set for the
            property should be included in the operation.
        operationType:
          type: string
          description: A string representing the type of operation being performed.
        operator:
          type: string
          description: >-
            A string representing the comparison operator used in the operation.
            Valid values include 'IS_EQUAL_TO', 'IS_NOT_EQUAL_TO',
            'HAS_EVER_BEEN_EQUAL_TO', and 'HAS_NEVER_BEEN_EQUAL_TO'.
          enum:
            - IS_EQUAL_TO
            - IS_NOT_EQUAL_TO
        operatorName:
          type: string
          description: >-
            A string representing the name of the operator used in the
            operation.
        propertyType:
          type: string
          description: >-
            A string indicating the type of property operation, which is 'bool'
            for boolean operations.
          default: bool-comparative
          enum:
            - bool-comparative
        renderSpec:
          type: string
          description: >-
            A string that specifies the rendering specification for the
            operation.
      x-hubspot-sub-type-impl: true
    ComparativeNumberPropertyOperation:
      title: number-comparative
      required:
        - comparisonPropertyName
        - includeObjectsWithNoValueSet
        - operationType
        - operator
        - operatorName
        - propertyType
      type: object
      properties:
        comparisonPropertyName:
          type: string
          description: A string specifying the name of the property to compare against.
        defaultValue:
          type: string
          description: A string representing the default value to use if no value is set.
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean indicating whether to include objects that have no value
            set for the property.
        operationType:
          type: string
          description: A string representing the type of operation being performed.
        operator:
          type: string
          description: >-
            A string representing the comparison operator, with valid values
            including 'IS_EQUAL_TO', 'IS_NOT_EQUAL_TO', 'IS_GREATER_THAN',
            'IS_GREATER_THAN_OR_EQUAL_TO', 'IS_LESS_THAN', and
            'IS_LESS_THAN_OR_EQUAL_TO'.
          enum:
            - IS_EQUAL_TO
            - IS_GREATER_THAN
            - IS_GREATER_THAN_OR_EQUAL_TO
            - IS_LESS_THAN
            - IS_LESS_THAN_OR_EQUAL_TO
            - IS_NOT_EQUAL_TO
        operatorName:
          type: string
          description: A string providing a human-readable name for the operator.
        propertyType:
          type: string
          description: >-
            A string indicating the type of property, defaulting to
            'number-comparative'.
          default: number-comparative
          enum:
            - number-comparative
        renderSpec:
          type: string
          description: A string that provides rendering specifications.
      x-hubspot-sub-type-impl: true
    ComparativeStringPropertyOperation:
      title: string-comparative
      required:
        - comparisonPropertyName
        - includeObjectsWithNoValueSet
        - operationType
        - operator
        - operatorName
        - propertyType
      type: object
      properties:
        comparisonPropertyName:
          type: string
          description: >-
            The name of the property to compare against, represented as a
            string.
        defaultValue:
          type: string
          description: A string representing the default value to use if no value is set.
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean indicating whether to include objects that have no value
            set for the property.
        operationType:
          type: string
          description: A string representing the type of operation being performed.
        operator:
          type: string
          description: >-
            A string specifying the comparison operator to use. Valid values
            include 'IS_EQUAL_TO', 'IS_NOT_EQUAL_TO', 'CONTAINS',
            'DOES_NOT_CONTAIN', 'STARTS_WITH', and 'ENDS_WITH'.
          enum:
            - CONTAINS
            - DOES_NOT_CONTAIN
            - ENDS_WITH
            - IS_EQUAL_TO
            - IS_NOT_EQUAL_TO
            - STARTS_WITH
        operatorName:
          type: string
          description: >-
            A string representing the name of the operator used in the
            comparison.
        propertyType:
          type: string
          description: >-
            A string indicating the type of property operation, defaulting to
            'string-comparative'.
          default: string-comparative
          enum:
            - string-comparative
        renderSpec:
          type: string
          description: A string providing rendering specifications for the operation.
      x-hubspot-sub-type-impl: true
    ComparativePropertyUpdatedOperation:
      title: property-updated-comparative
      required:
        - comparisonPropertyName
        - includeObjectsWithNoValueSet
        - operationType
        - operator
        - operatorName
        - propertyType
      type: object
      properties:
        comparisonPropertyName:
          type: string
          description: A string specifying the name of the property to compare against.
        defaultComparisonValue:
          type: string
          description: A string representing the default value for comparison.
        defaultValue:
          type: string
          description: A string representing the default value to use if no value is set.
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean indicating whether objects with no value set should be
            included in the operation.
        operationType:
          type: string
          description: A string indicating the type of operation being performed.
        operator:
          type: string
          description: >-
            A string representing the comparison operation to be performed.
            Valid values include 'IS_BEFORE' and 'IS_AFTER'.
          enum:
            - IS_AFTER
            - IS_BEFORE
        operatorName:
          type: string
          description: >-
            A string representing the name of the operator used in the
            operation.
        propertyType:
          type: string
          description: >-
            A string indicating the type of property, with a default value of
            'datetime-comparative'.
          default: property-updated-comparative
          enum:
            - property-updated-comparative
        renderSpec:
          type: string
          description: A string used for rendering specifications.
      x-hubspot-sub-type-impl: true
    RollingDateRangePropertyOperation:
      title: datetime-rolling
      required:
        - includeObjectsWithNoValueSet
        - numberOfDays
        - operationType
        - operator
        - operatorName
        - propertyType
        - requiresTimeZoneConversion
      type: object
      properties:
        defaultValue:
          type: string
          description: A string representing the default value for the operation.
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean indicating whether objects without a set value should be
            included in the operation.
        numberOfDays:
          type: integer
          description: >-
            An integer representing the number of days used in the operation to
            determine the rolling date range.
          format: int32
        operationType:
          type: string
          description: A string that specifies the type of operation being performed.
        operator:
          type: string
          description: >-
            A string specifying the operation to perform, with valid values
            including 'IS_LESS_THAN_X_DAYS_AGO', 'IS_MORE_THAN_X_DAYS_AGO',
            'IS_LESS_THAN_X_DAYS_FROM_NOW', and 'IS_MORE_THAN_X_DAYS_FROM_NOW'.
          enum:
            - IS_LESS_THAN_X_DAYS_AGO
            - IS_LESS_THAN_X_DAYS_FROM_NOW
            - IS_MORE_THAN_X_DAYS_AGO
            - IS_MORE_THAN_X_DAYS_FROM_NOW
        operatorName:
          type: string
          description: >-
            A string representing the name of the operator used in the
            operation.
        propertyType:
          type: string
          description: >-
            A string indicating the type of property operation, defaulting to
            'datetime-rolling'.
          default: datetime-rolling
          enum:
            - datetime-rolling
        renderSpec:
          type: string
          description: A string that specifies how the operation should be rendered.
        requiresTimeZoneConversion:
          type: boolean
          description: >-
            A boolean indicating if the operation requires conversion based on
            time zones.
      x-hubspot-sub-type-impl: true
    RollingPropertyUpdatedOperation:
      title: rolling-property-updated
      required:
        - includeObjectsWithNoValueSet
        - numberOfDays
        - operationType
        - operator
        - operatorName
        - propertyType
      type: object
      properties:
        defaultValue:
          type: string
          description: >-
            A string that may hold a default value for the operation, if
            applicable.
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean indicating whether objects with no value set should be
            included in the operation.
        numberOfDays:
          type: integer
          description: >-
            An integer specifying the number of days within which the property
            should have been updated.
          format: int32
        operationType:
          type: string
          description: A string representing the type of operation being performed.
        operator:
          type: string
          description: >-
            A string representing the operation to be performed, with valid
            values being 'UPDATED_IN_LAST_X_DAYS' and
            'NOT_UPDATED_IN_LAST_X_DAYS'.
          enum:
            - NOT_UPDATED_IN_LAST_X_DAYS
            - UPDATED_IN_LAST_X_DAYS
        operatorName:
          type: string
          description: A string that holds the name of the operator used in the operation.
        propertyType:
          type: string
          description: >-
            A string indicating the type of property operation, which is
            'rolling-property-updated'.
          default: rolling-property-updated
          enum:
            - rolling-property-updated
        renderSpec:
          type: string
          description: >-
            A string that may contain rendering specifications for the
            operation.
      x-hubspot-sub-type-impl: true
    EnumerationPropertyOperation:
      title: enumeration
      required:
        - includeObjectsWithNoValueSet
        - operationType
        - operator
        - operatorName
        - propertyType
        - values
      type: object
      properties:
        defaultValue:
          type: string
          description: >-
            A string representing the default value to use if no other value is
            set.
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean indicating whether to include objects that have no value
            set for the property.
        operationType:
          type: string
          description: A string that specifies the type of operation being performed.
        operator:
          type: string
          description: >-
            A string representing the operation to perform on the enumeration
            property. Valid values include 'IS_ANY_OF', 'IS_NONE_OF',
            'IS_EXACTLY', 'IS_NOT_EXACTLY', 'CONTAINS_ALL',
            'DOES_NOT_CONTAIN_ALL', 'HAS_EVER_BEEN_ANY_OF',
            'HAS_NEVER_BEEN_ANY_OF', 'HAS_EVER_BEEN_EXACTLY',
            'HAS_NEVER_BEEN_EXACTLY', 'HAS_EVER_CONTAINED_ALL', and
            'HAS_NEVER_CONTAINED_ALL'.
          enum:
            - CONTAINS_ALL
            - DOES_NOT_CONTAIN_ALL
            - HAS_EVER_BEEN_ANY_OF
            - HAS_EVER_BEEN_EXACTLY
            - HAS_EVER_CONTAINED_ALL
            - HAS_NEVER_BEEN_ANY_OF
            - HAS_NEVER_BEEN_EXACTLY
            - HAS_NEVER_CONTAINED_ALL
            - IS_ANY_OF
            - IS_EXACTLY
            - IS_NONE_OF
            - IS_NOT_EXACTLY
        operatorName:
          type: string
          description: >-
            A string representing the name of the operator used in the
            operation.
        propertyType:
          type: string
          description: >-
            A string indicating the type of property, which is 'enumeration' for
            this operation.
          default: enumeration
          enum:
            - enumeration
        renderSpec:
          type: string
          description: A string that provides rendering specifications for the operation.
        values:
          type: array
          description: >-
            An array of strings specifying the enumeration values to be used in
            the operation.
          items:
            type: string
      x-hubspot-sub-type-impl: true
    AllPropertyTypesOperation:
      title: alltypes
      required:
        - coalescingRefineBy
        - includeObjectsWithNoValueSet
        - operationType
        - operator
        - operatorName
        - propertyType
      type: object
      properties:
        coalescingRefineBy:
          description: >-
            An object that specifies the refinement criteria for coalescing,
            which can be one of several types such as NumOccurrencesRefineBy or
            SetOccurrencesRefineBy.
          oneOf:
            - $ref: '#/components/schemas/NumOccurrencesRefineBy'
            - $ref: '#/components/schemas/SetOccurrencesRefineBy'
        defaultValue:
          type: string
          description: A string representing the default value to be used in the operation.
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean indicating whether objects with no value set should be
            included in the operation.
        operationType:
          type: string
          description: A string indicating the type of operation being performed.
        operator:
          type: string
          description: >-
            A string representing the operation to be performed, with valid
            values including 'IS_KNOWN', 'IS_UNKNOWN', 'IS_BLANK', and
            'IS_NOT_BLANK'.
          enum:
            - IS_BLANK
            - IS_KNOWN
            - IS_NOT_BLANK
            - IS_UNKNOWN
        operatorName:
          type: string
          description: >-
            A string representing the name of the operator used in the
            operation.
        propertyType:
          type: string
          description: >-
            A string indicating the type of property operation, defaulting to
            'alltypes'.
          default: alltypes
          enum:
            - alltypes
        pruningRefineBy:
          description: >-
            An object that specifies the refinement criteria for pruning, which
            can be one of several types such as
            RelativeComparativeTimestampRefineBy or
            AbsoluteRangedTimestampRefineBy.
          oneOf:
            - $ref: '#/components/schemas/RelativeComparativeTimestampRefineBy'
            - $ref: '#/components/schemas/RelativeRangedTimestampRefineBy'
            - $ref: '#/components/schemas/AbsoluteComparativeTimestampRefineBy'
            - $ref: '#/components/schemas/AbsoluteRangedTimestampRefineBy'
            - $ref: '#/components/schemas/AllHistoryRefineBy'
            - $ref: '#/components/schemas/TimePointOperation'
            - $ref: '#/components/schemas/RangedTimeOperation'
        renderSpec:
          type: string
          description: >-
            A string that specifies the rendering specification for the
            operation.
      x-hubspot-sub-type-impl: true
    RangedNumberPropertyOperation:
      title: number-ranged
      required:
        - includeObjectsWithNoValueSet
        - lowerBound
        - operationType
        - operator
        - operatorName
        - propertyType
        - upperBound
      type: object
      properties:
        defaultValue:
          type: string
          description: >-
            A string representing the default value to use if no specific value
            is set.
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean indicating whether to include objects that have no value
            set for this property.
        lowerBound:
          type: number
          description: A number representing the lower bound of the range.
        operationType:
          type: string
          description: A string specifying the type of operation.
        operator:
          type: string
          description: >-
            A string specifying the operation to perform, with valid values
            including 'IS_BETWEEN' and 'IS_NOT_BETWEEN'.
          enum:
            - IS_BETWEEN
            - IS_NOT_BETWEEN
        operatorName:
          type: string
          description: A string representing the name of the operator.
        propertyType:
          type: string
          description: >-
            A string indicating the type of property, with a default value of
            'number-ranged'.
          default: number-ranged
          enum:
            - number-ranged
        renderSpec:
          type: string
          description: A string that provides rendering specifications.
        upperBound:
          type: number
          description: A number representing the upper bound of the range.
      x-hubspot-sub-type-impl: true
    MultiStringPropertyOperation:
      title: multistring
      required:
        - coalescingRefineBy
        - includeObjectsWithNoValueSet
        - operationType
        - operator
        - operatorName
        - propertyType
        - values
      type: object
      properties:
        coalescingRefineBy:
          description: >-
            An object that defines additional refinement criteria for
            coalescing, using one of several possible schemas.
          oneOf:
            - $ref: '#/components/schemas/NumOccurrencesRefineBy'
            - $ref: '#/components/schemas/SetOccurrencesRefineBy'
        defaultValue:
          type: string
          description: >-
            A string that specifies the default value to be used if no other
            value is set.
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean indicating whether objects with no value set should be
            included in the operation.
        operationType:
          type: string
          description: A string that specifies the type of operation being performed.
        operator:
          type: string
          description: >-
            A string representing the operation to be performed, such as
            'IS_EQUAL_TO', 'CONTAINS', or 'STARTS_WITH'.
          enum:
            - CONTAINS
            - CONTAINS_EXACTLY
            - DOES_NOT_CONTAIN
            - DOES_NOT_CONTAIN_EXACTLY
            - ENDS_WITH
            - IS_EQUAL_TO
            - IS_NOT_EQUAL_TO
            - STARTS_WITH
        operatorName:
          type: string
          description: A string that provides a human-readable name for the operator.
        propertyType:
          type: string
          description: >-
            A string indicating the type of property operation, defaulting to
            'multistring'.
          default: multistring
          enum:
            - multistring
        pruningRefineBy:
          description: >-
            An object that defines additional refinement criteria for pruning,
            using one of several possible schemas.
          oneOf:
            - $ref: '#/components/schemas/RelativeComparativeTimestampRefineBy'
            - $ref: '#/components/schemas/RelativeRangedTimestampRefineBy'
            - $ref: '#/components/schemas/AbsoluteComparativeTimestampRefineBy'
            - $ref: '#/components/schemas/AbsoluteRangedTimestampRefineBy'
            - $ref: '#/components/schemas/AllHistoryRefineBy'
            - $ref: '#/components/schemas/TimePointOperation'
            - $ref: '#/components/schemas/RangedTimeOperation'
        renderSpec:
          type: string
          description: A string that provides specifications for rendering the operation.
        values:
          type: array
          description: >-
            An array of strings representing the values involved in the
            operation.
          items:
            type: string
      x-hubspot-sub-type-impl: true
    DatePropertyOperation:
      title: date
      required:
        - day
        - includeObjectsWithNoValueSet
        - month
        - operationType
        - operator
        - operatorName
        - propertyType
        - year
      type: object
      properties:
        day:
          type: integer
          description: An integer representing the day component of the date.
          format: int32
        defaultValue:
          type: string
          description: >-
            A string representing the default value to be used if no other value
            is set.
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean indicating whether objects with no value set should be
            included in the operation.
        month:
          type: string
          description: An integer representing the month component of the date.
          enum:
            - APR
            - AUG
            - DEC
            - FEB
            - JAN
            - JUL
            - JUN
            - MAR
            - MAY
            - NOV
            - OCT
            - SEP
        operationType:
          type: string
          description: A string representing the type of operation being performed.
        operator:
          type: string
          description: >-
            A string indicating the operation to be performed, such as
            'IS_BEFORE' or 'IS_AFTER'.
          enum:
            - AFTER
            - BEFORE
            - EQUAL
        operatorName:
          type: string
          description: >-
            A string representing the name of the operator used in the
            operation.
        propertyType:
          type: string
          description: >-
            A string representing the type of the property, with a default value
            of 'date'.
          default: date
          enum:
            - date
        renderSpec:
          type: string
          description: A string that specifies how the operation should be rendered.
        year:
          type: integer
          description: An integer representing the year component of the date.
          format: int32
      x-hubspot-sub-type-impl: true
    CalendarDatePropertyOperation:
      title: calendar-date
      required:
        - includeObjectsWithNoValueSet
        - operationType
        - operator
        - operatorName
        - propertyType
        - timeUnit
        - timeUnitCount
        - useFiscalYear
      type: object
      properties:
        defaultValue:
          type: string
          description: >-
            A string representing the default value to be used if no other value
            is set.
        fiscalYearStart:
          type: string
          description: >-
            A string representing the starting month of the fiscal year. Valid
            values include 'JANUARY', 'FEBRUARY', 'MARCH', 'APRIL', 'MAY',
            'JUNE', 'JULY', 'AUGUST', 'SEPTEMBER', 'OCTOBER', 'NOVEMBER', and
            'DECEMBER'.
          enum:
            - APRIL
            - AUGUST
            - DECEMBER
            - FEBRUARY
            - JANUARY
            - JULY
            - JUNE
            - MARCH
            - MAY
            - NOVEMBER
            - OCTOBER
            - SEPTEMBER
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean that determines whether objects with no value set should
            be included in the operation.
        operationType:
          type: string
          description: A string indicating the type of operation being performed.
        operator:
          type: string
          description: >-
            A string representing the operation to be performed. Valid values
            include 'IN_THIS_TIME_UNIT', 'IN_THIS_TIME_UNIT_SO_FAR',
            'IN_NEXT_TIME_UNIT', 'IN_LAST_TIME_UNIT', and
            'IN_LAST_TIME_UNIT_SO_FAR'.
          enum:
            - IN_LAST_TIME_UNIT
            - IN_LAST_TIME_UNIT_SO_FAR
            - IN_NEXT_TIME_UNIT
            - IN_THIS_TIME_UNIT
            - IN_THIS_TIME_UNIT_SO_FAR
        operatorName:
          type: string
          description: >-
            A string representing the name of the operator used in the
            operation.
        propertyType:
          type: string
          description: >-
            A string indicating the type of property operation, which is
            'calendar-date' for this component.
          default: calendar-date
          enum:
            - calendar-date
        renderSpec:
          type: string
          description: A string that specifies how the operation should be rendered.
        timeUnit:
          type: string
          description: >-
            A string specifying the unit of time to be used in the operation.
            Valid values are 'DAY', 'WEEK', 'MONTH', 'QUARTER', and 'YEAR'.
          enum:
            - DAY
            - MONTH
            - QUARTER
            - WEEK
            - YEAR
        timeUnitCount:
          type: integer
          description: >-
            An integer indicating the number of time units to be considered in
            the operation.
          format: int32
        useFiscalYear:
          type: boolean
          description: >-
            A boolean indicating whether the fiscal year should be used in the
            operation.
      x-hubspot-sub-type-impl: true
    TimePointOperation:
      title: timepoint
      required:
        - endpointBehavior
        - includeObjectsWithNoValueSet
        - operationType
        - operator
        - operatorName
        - propertyParser
        - propertyType
        - timePoint
        - type
      type: object
      properties:
        defaultValue:
          type: string
          description: A string representing the default value for the operation.
        endpointBehavior:
          type: string
          description: >-
            A string that defines the behavior of the endpoint, with valid
            values being 'INCLUSIVE' or 'EXCLUSIVE'.
          enum:
            - EXCLUSIVE
            - INCLUSIVE
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean indicating whether objects without a set value should be
            included in the operation.
        operationType:
          type: string
          description: A string that specifies the type of operation being performed.
        operator:
          type: string
          description: >-
            A string representing the operator used in the operation. Valid
            values include 'IS_BEFORE' and 'IS_AFTER'.
          enum:
            - IS_AFTER
            - IS_BEFORE
        operatorName:
          type: string
          description: >-
            A string representing the name of the operator used in the
            operation.
        propertyParser:
          type: string
          description: >-
            A string specifying the parser to use for the property. Valid
            options include 'VALUE', 'UPDATED_AT', 'ANNIVERSARY',
            'VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION', and
            'ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION'.
          enum:
            - ANNIVERSARY
            - ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION
            - UPDATED_AT
            - VALUE
            - VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION
        propertyType:
          type: string
          description: >-
            A string indicating the type of property, with a default value of
            'timepoint'.
          default: timepoint
          enum:
            - timepoint
        renderSpec:
          type: string
          description: A string that specifies how the operation should be rendered.
        timePoint:
          description: >-
            A reference to a specific time point, which can be a DatePoint,
            IndexedTimePoint, or PropertyReferencedTime.
          oneOf:
            - $ref: '#/components/schemas/DatePoint'
            - $ref: '#/components/schemas/IndexedTimePoint'
            - $ref: '#/components/schemas/PropertyReferencedTime'
        type:
          type: string
          description: A string indicating the type of operation.
      x-hubspot-sub-type-impl: true
    RangedTimeOperation:
      title: rangedtime
      required:
        - includeObjectsWithNoValueSet
        - lowerBoundEndpointBehavior
        - lowerBoundTimePoint
        - operationType
        - operator
        - operatorName
        - propertyParser
        - propertyType
        - type
        - upperBoundEndpointBehavior
        - upperBoundTimePoint
      type: object
      properties:
        defaultValue:
          type: string
          description: A string representing the default value for the operation.
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean indicating whether objects without a set value should be
            included in the operation.
        lowerBoundEndpointBehavior:
          type: string
          description: >-
            A string indicating whether the lower bound is inclusive or
            exclusive, with possible values 'INCLUSIVE' and 'EXCLUSIVE'.
          enum:
            - EXCLUSIVE
            - INCLUSIVE
        lowerBoundTimePoint:
          description: >-
            Defines the lower bound of the time range, which can be a DatePoint,
            IndexedTimePoint, or PropertyReferencedTime.
          oneOf:
            - $ref: '#/components/schemas/DatePoint'
            - $ref: '#/components/schemas/IndexedTimePoint'
            - $ref: '#/components/schemas/PropertyReferencedTime'
        operationType:
          type: string
          description: A string that specifies the type of operation being performed.
        operator:
          type: string
          description: >-
            A string representing the operator used in the operation, with
            possible values 'IS_BETWEEN' and 'IS_NOT_BETWEEN'.
          enum:
            - IS_BETWEEN
            - IS_NOT_BETWEEN
        operatorName:
          type: string
          description: >-
            A string representing the name of the operator used in the
            operation.
        propertyParser:
          type: string
          description: >-
            A string specifying the property parser to be used, with possible
            values including 'VALUE', 'UPDATED_AT', 'ANNIVERSARY',
            'VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION', and
            'ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION'.
          enum:
            - ANNIVERSARY
            - ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION
            - UPDATED_AT
            - VALUE
            - VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION
        propertyType:
          type: string
          description: >-
            A string that specifies the type of property, with a default value
            of 'rangedtime'.
          default: rangedtime
          enum:
            - rangedtime
        renderSpec:
          type: string
          description: A string that provides rendering specifications for the operation.
        type:
          type: string
          description: A string that specifies the type of operation.
        upperBoundEndpointBehavior:
          type: string
          description: >-
            A string indicating whether the upper bound is inclusive or
            exclusive, with possible values 'INCLUSIVE' and 'EXCLUSIVE'.
          enum:
            - EXCLUSIVE
            - INCLUSIVE
        upperBoundTimePoint:
          description: >-
            Defines the upper bound of the time range, which can be a DatePoint,
            IndexedTimePoint, or PropertyReferencedTime.
          oneOf:
            - $ref: '#/components/schemas/DatePoint'
            - $ref: '#/components/schemas/IndexedTimePoint'
            - $ref: '#/components/schemas/PropertyReferencedTime'
      x-hubspot-sub-type-impl: true
    RegexPropertyOperation:
      title: regex
      required:
        - caseSensitive
        - includeObjectsWithNoValueSet
        - operationType
        - operator
        - operatorName
        - pattern
        - propertyType
      type: object
      properties:
        caseSensitive:
          type: boolean
          description: >-
            A boolean indicating whether the regex matching should be
            case-sensitive.
        defaultValue:
          type: string
          description: >-
            A string representing the default value to be used if no match is
            found.
        includeObjectsWithNoValueSet:
          type: boolean
          description: >-
            A boolean indicating whether objects without a set value should be
            included in the operation.
        operationType:
          type: string
          description: A string representing the type of operation being performed.
        operator:
          type: string
          description: >-
            A string representing the operation to be performed, such as
            matching or not matching a pattern.
          enum:
            - DOES_NOT_MATCH_REGEX
            - MATCHES_REGEX
        operatorName:
          type: string
          description: A string providing a human-readable name for the operator.
        pattern:
          type: string
          description: >-
            A string containing the regular expression pattern to be used for
            matching.
        propertyType:
          type: string
          description: >-
            A string indicating the type of property operation, defaulting to
            'regex'.
          default: regex
          enum:
            - regex
        renderSpec:
          type: string
          description: >-
            A string specifying how the operation should be rendered or
            displayed.
      x-hubspot-sub-type-impl: true
    PropertyFilter:
      title: PROPERTY
      required:
        - filterType
        - operation
        - property
      type: object
      properties:
        context:
          $ref: '#/components/schemas/PropertyFilterContext'
        filterInsightsId:
          type: integer
          description: >-
            An integer representing the identifier for insights related to the
            filter.
          format: int32
        filterType:
          type: string
          description: A string indicating the type of filter. Defaults to 'PROPERTY'.
          default: PROPERTY
          enum:
            - PROPERTY
        frameworkFilterId:
          type: integer
          description: >-
            An integer (int64 format) serving as the unique identifier for the
            framework filter.
          format: int64
        operation:
          description: >-
            Defines the operation to be performed on the property. It can be one
            of several types, such as BoolPropertyOperation,
            NumberPropertyOperation, StringPropertyOperation, etc.
          oneOf:
            - $ref: '#/components/schemas/BoolPropertyOperation'
            - $ref: '#/components/schemas/NumberPropertyOperation'
            - $ref: '#/components/schemas/StringPropertyOperation'
            - $ref: '#/components/schemas/DateTimePropertyOperation'
            - $ref: '#/components/schemas/RangedDatePropertyOperation'
            - $ref: '#/components/schemas/ComparativeDatePropertyOperation'
            - $ref: '#/components/schemas/ComparativeBoolPropertyOperation'
            - $ref: '#/components/schemas/ComparativeNumberPropertyOperation'
            - $ref: '#/components/schemas/ComparativeStringPropertyOperation'
            - $ref: '#/components/schemas/ComparativePropertyUpdatedOperation'
            - $ref: '#/components/schemas/RollingDateRangePropertyOperation'
            - $ref: '#/components/schemas/RollingPropertyUpdatedOperation'
            - $ref: '#/components/schemas/EnumerationPropertyOperation'
            - $ref: '#/components/schemas/AllPropertyTypesOperation'
            - $ref: '#/components/schemas/RangedNumberPropertyOperation'
            - $ref: '#/components/schemas/MultiStringPropertyOperation'
            - $ref: '#/components/schemas/DatePropertyOperation'
            - $ref: '#/components/schemas/CalendarDatePropertyOperation'
            - $ref: '#/components/schemas/TimePointOperation'
            - $ref: '#/components/schemas/RangedTimeOperation'
            - $ref: '#/components/schemas/RegexPropertyOperation'
        property:
          type: string
          description: >-
            A string representing the name of the property to which the filter
            is applied.
      x-hubspot-sub-type-impl: true
    EventFrequencyBetween:
      title: BETWEEN
      required:
        - ranges
        - type
      type: object
      properties:
        ranges:
          type: array
          description: >-
            An array of objects defining the specific frequency ranges. Each
            range specifies the minimum and maximum occurrences of an event
            within the timeframe.
          items:
            $ref: '#/components/schemas/FrequencyRange'
        type:
          type: string
          description: >-
            A string representing the type of frequency criteria. It is required
            and must be specified.
          default: BETWEEN
          enum:
            - BETWEEN
      x-hubspot-sub-type-impl: true
    EmptyFrequencyCriteria:
      title: EMPTY
      required:
        - type
      type: object
      properties:
        type:
          type: string
          description: >-
            A string that indicates the type of frequency criteria. The default
            value is 'EMPTY', and it is the only valid value for this property.
          default: EMPTY
          enum:
            - EMPTY
      x-hubspot-sub-type-impl: true
    SingleCondition:
      title: SINGLE
      required:
        - operation
        - property
        - type
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for the condition, formatted as a UUID.
          format: uuid
        operation:
          description: >-
            Defines the operation to be performed on the property, determining
            how the condition is evaluated.
          oneOf:
            - $ref: '#/components/schemas/BoolPropertyOperation'
            - $ref: '#/components/schemas/NumberPropertyOperation'
            - $ref: '#/components/schemas/StringPropertyOperation'
            - $ref: '#/components/schemas/DateTimePropertyOperation'
            - $ref: '#/components/schemas/RangedDatePropertyOperation'
            - $ref: '#/components/schemas/ComparativeDatePropertyOperation'
            - $ref: '#/components/schemas/ComparativeBoolPropertyOperation'
            - $ref: '#/components/schemas/ComparativeNumberPropertyOperation'
            - $ref: '#/components/schemas/ComparativeStringPropertyOperation'
            - $ref: '#/components/schemas/ComparativePropertyUpdatedOperation'
            - $ref: '#/components/schemas/RollingDateRangePropertyOperation'
            - $ref: '#/components/schemas/RollingPropertyUpdatedOperation'
            - $ref: '#/components/schemas/EnumerationPropertyOperation'
            - $ref: '#/components/schemas/AllPropertyTypesOperation'
            - $ref: '#/components/schemas/RangedNumberPropertyOperation'
            - $ref: '#/components/schemas/MultiStringPropertyOperation'
            - $ref: '#/components/schemas/DatePropertyOperation'
            - $ref: '#/components/schemas/CalendarDatePropertyOperation'
            - $ref: '#/components/schemas/TimePointOperation'
            - $ref: '#/components/schemas/RangedTimeOperation'
            - $ref: '#/components/schemas/RegexPropertyOperation'
        property:
          type: string
          description: The name of the property that this condition applies to.
        type:
          type: string
          description: >-
            A string indicating the type of condition, with a default value of
            'SINGLE'.
          default: SINGLE
          enum:
            - SINGLE
      x-hubspot-sub-type-impl: true
    CombinedThresholdDescriptor:
      required:
        - label
        - threshold
      type: object
      properties:
        label:
          type: string
          description: A string used to label or describe the threshold.
        threshold:
          type: number
          description: A numerical value representing the threshold. It is of type number.
    NumOccurrencesRefineBy:
      title: NumOccurrencesRefineBy
      required:
        - type
      type: object
      properties:
        maxOccurrences:
          type: integer
          description: An integer specifying the maximum number of occurrences allowed.
          format: int32
        minOccurrences:
          type: integer
          description: An integer specifying the minimum number of occurrences required.
          format: int32
        type:
          type: string
          description: >-
            A string indicating the type of refinement, with a default value of
            'NumOccurrencesRefineBy'.
          default: NumOccurrencesRefineBy
          enum:
            - NumOccurrencesRefineBy
      x-hubspot-sub-type-impl: true
    SetOccurrencesRefineBy:
      title: SetOccurrencesRefineBy
      required:
        - setType
        - type
      type: object
      properties:
        setType:
          type: string
          description: >-
            A string representing the specific set type to refine by. This
            property is used to define the nature of the set occurrence
            criteria.
          enum:
            - ALL
            - ALL_INCLUDE_EMPTY
            - ANY
            - ANY_INCLUDE_EMPTY
            - NONE
            - NONE_EXCLUDE_EMPTY
        type:
          type: string
          description: >-
            A string indicating the type of refine-by operation. The default
            value is 'SetOccurrencesRefineBy'.
          default: SetOccurrencesRefineBy
          enum:
            - SetOccurrencesRefineBy
      x-hubspot-sub-type-impl: true
    RelativeComparativeTimestampRefineBy:
      title: RelativeComparativeTimestampRefineBy
      required:
        - comparison
        - timeOffset
        - type
      type: object
      properties:
        comparison:
          type: string
          description: >-
            A string indicating the type of comparison to be made, with valid
            values being 'BEFORE' or 'AFTER'.
          enum:
            - AFTER
            - BEFORE
        timeOffset:
          $ref: '#/components/schemas/TimeOffset'
        type:
          type: string
          description: >-
            A string that identifies the type of this component, which is always
            'RelativeComparativeTimestampRefineBy'.
          default: RelativeComparativeTimestampRefineBy
          enum:
            - RelativeComparativeTimestampRefineBy
      x-hubspot-sub-type-impl: true
    RelativeRangedTimestampRefineBy:
      title: RelativeRangedTimestampRefineBy
      required:
        - lowerBoundOffset
        - rangeType
        - type
        - upperBoundOffset
      type: object
      properties:
        lowerBoundOffset:
          $ref: '#/components/schemas/TimeOffset'
        rangeType:
          type: string
          description: >-
            A string indicating the type of range comparison, with valid values
            being 'BETWEEN' and 'NOT_BETWEEN'.
          enum:
            - BETWEEN
            - NOT_BETWEEN
        type:
          type: string
          description: >-
            A string indicating the type of refinement, defaulting to
            'RelativeRangedTimestampRefineBy'.
          default: RelativeRangedTimestampRefineBy
          enum:
            - RelativeRangedTimestampRefineBy
        upperBoundOffset:
          $ref: '#/components/schemas/TimeOffset'
      x-hubspot-sub-type-impl: true
    AbsoluteComparativeTimestampRefineBy:
      title: AbsoluteComparativeTimestampRefineBy
      required:
        - comparison
        - timestamp
        - type
      type: object
      properties:
        comparison:
          type: string
          description: >-
            A string specifying the type of comparison to be performed. Valid
            values are 'BEFORE' and 'AFTER'.
          enum:
            - AFTER
            - BEFORE
        timestamp:
          type: integer
          description: >-
            An integer representing the specific timestamp to be used for
            comparison, formatted as an int64.
          format: int64
        type:
          type: string
          description: >-
            A string indicating the type of refinement, which is
            'AbsoluteComparativeTimestampRefineBy'.
          default: AbsoluteComparativeTimestampRefineBy
          enum:
            - AbsoluteComparativeTimestampRefineBy
      x-hubspot-sub-type-impl: true
    AbsoluteRangedTimestampRefineBy:
      title: AbsoluteRangedTimestampRefineBy
      required:
        - lowerTimestamp
        - rangeType
        - type
        - upperTimestamp
      type: object
      properties:
        lowerTimestamp:
          type: integer
          description: >-
            An integer representing the lower bound of the timestamp range, in
            Unix time format (milliseconds).
          format: int64
        rangeType:
          type: string
          description: >-
            A string that specifies the type of range operation, with valid
            values including 'BETWEEN' and 'NOT_BETWEEN'.
          enum:
            - BETWEEN
            - NOT_BETWEEN
        type:
          type: string
          description: >-
            A string that indicates the type of refinement, with a default value
            of 'AbsoluteRangedTimestampRefineBy'.
          default: AbsoluteRangedTimestampRefineBy
          enum:
            - AbsoluteRangedTimestampRefineBy
        upperTimestamp:
          type: integer
          description: >-
            An integer representing the upper bound of the timestamp range, in
            Unix time format (milliseconds).
          format: int64
      x-hubspot-sub-type-impl: true
    AllHistoryRefineBy:
      title: AllHistoryRefineBy
      required:
        - type
      type: object
      properties:
        type:
          type: string
          description: >-
            A string indicating the type of refinement, which is set to
            'AllHistoryRefineBy'.
          default: AllHistoryRefineBy
          enum:
            - AllHistoryRefineBy
      x-hubspot-sub-type-impl: true
    DatePoint:
      title: DATE
      required:
        - day
        - month
        - timeType
        - timezoneSource
        - year
        - zoneId
      type: object
      properties:
        day:
          type: integer
          description: An integer representing the day component of the date.
          format: int32
        hour:
          type: integer
          description: An integer representing the hour component of the time.
          format: int32
        millisecond:
          type: integer
          description: An integer representing the millisecond component of the time.
          format: int32
        minute:
          type: integer
          description: An integer representing the minute component of the time.
          format: int32
        month:
          type: integer
          description: An integer representing the month component of the date.
          format: int32
        second:
          type: integer
          description: An integer representing the second component of the time.
          format: int32
        timeType:
          type: string
          description: >-
            A string indicating the type of time point, with the default value
            being 'DATE'.
          default: DATE
          enum:
            - DATE
        timezoneSource:
          type: string
          description: >-
            A string specifying the source of the timezone, which can be
            'CUSTOM', 'USER', or 'PORTAL'.
          enum:
            - CUSTOM
            - PORTAL
            - USER
        year:
          type: integer
          description: An integer representing the year component of the date.
          format: int32
        zoneId:
          type: string
          description: A string representing the identifier for the timezone.
      x-hubspot-sub-type-impl: true
    IndexedTimePoint:
      title: INDEXED
      required:
        - indexReference
        - timeType
        - timezoneSource
        - zoneId
      type: object
      properties:
        indexReference:
          description: >-
            Defines the reference point for the indexed time, which can be one
            of several predefined references such as 'NOW', 'TODAY', 'WEEK',
            etc.
          oneOf:
            - $ref: '#/components/schemas/NowReference'
            - $ref: '#/components/schemas/TodayReference'
            - $ref: '#/components/schemas/WeekReference'
            - $ref: '#/components/schemas/MonthReference'
            - $ref: '#/components/schemas/QuarterReference'
            - $ref: '#/components/schemas/FiscalQuarter'
            - $ref: '#/components/schemas/YearReference'
            - $ref: '#/components/schemas/FiscalYear'
        offset:
          $ref: '#/components/schemas/IndexOffset'
        shouldGenerateRefreshTime:
          type: boolean
          description: A boolean indicating whether a refresh time should be generated.
        timeType:
          type: string
          description: >-
            A string indicating the type of time point, with a default value of
            'INDEXED'.
          default: INDEXED
          enum:
            - INDEXED
        timezoneSource:
          type: string
          description: >-
            A string specifying the source of the timezone, which can be
            'CUSTOM', 'USER', or 'PORTAL'.
          enum:
            - CUSTOM
            - PORTAL
            - USER
        zoneId:
          type: string
          description: A string representing the ID of the timezone.
      x-hubspot-sub-type-impl: true
    PropertyReferencedTime:
      title: PROPERTY_REFERENCED
      required:
        - property
        - referenceType
        - timeType
        - timezoneSource
        - zoneId
      type: object
      properties:
        property:
          type: string
          description: >-
            A string indicating the property that the time reference is
            associated with.
        referenceType:
          type: string
          description: >-
            A string denoting the reference type, which must be
            'PropertyReferencedTime'.
          enum:
            - ANNIVERSARY
            - ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION
            - UPDATED_AT
            - VALUE
            - VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION
        timeType:
          type: string
          description: >-
            A string indicating the type of time reference. It must be
            'PropertyReferencedTime'.
          default: PROPERTY_REFERENCED
          enum:
            - PROPERTY_REFERENCED
        timezoneSource:
          type: string
          description: >-
            A string specifying the source of the timezone. Valid values include
            'CUSTOM', 'USER', and 'PORTAL'.
          enum:
            - CUSTOM
            - PORTAL
            - USER
        zoneId:
          type: string
          description: A string representing the ID of the timezone.
      x-hubspot-sub-type-impl: true
    PropertyFilterContext:
      required:
        - objectTypeId
      type: object
      properties:
        objectTypeId:
          type: string
          description: >-
            A string representing the unique identifier for the type of object
            to which the property filter is applied.
    FrequencyRange:
      required:
        - from
        - type
        - value
      type: object
      properties:
        from:
          type: integer
          description: The starting point of the frequency range, represented as a number.
          format: int32
        to:
          type: integer
          description: The ending point of the frequency range, represented as a number.
          format: int32
        type:
          type: string
          description: The type of frequency range, represented as a string.
          enum:
            - AT_LEAST
            - BETWEEN
            - EXACTLY
        value:
          type: number
          description: >-
            The specific value associated with the frequency range, represented
            as a number.
    TimeOffset:
      required:
        - amount
        - offsetDirection
        - timeUnit
      type: object
      properties:
        amount:
          type: integer
          description: The amount of time for the offset, represented as an integer.
          format: int64
        offsetDirection:
          type: string
          description: >-
            The direction of the time offset. Valid values include 'PAST' and
            'FUTURE'.
          enum:
            - FUTURE
            - PAST
        timeUnit:
          type: string
          description: >-
            The unit of time for the offset. Valid values include 'WEEKS',
            'DAYS', 'HOURS', and 'MINUTES'.
          enum:
            - DAYS
            - HOURS
            - MINUTES
            - WEEKS
    NowReference:
      title: NOW
      required:
        - referenceType
      type: object
      properties:
        hour:
          type: integer
          description: An integer representing the hour of the current time.
          format: int32
        millisecond:
          type: integer
          description: An integer representing the millisecond of the current time.
          format: int32
        minute:
          type: integer
          description: An integer representing the minute of the current time.
          format: int32
        referenceType:
          type: string
          description: >-
            A string indicating the type of reference, which is 'NOW' by
            default.
          default: NOW
          enum:
            - NOW
        second:
          type: integer
          description: An integer representing the second of the current time.
          format: int32
      x-hubspot-sub-type-impl: true
    TodayReference:
      title: TODAY
      required:
        - referenceType
      type: object
      properties:
        hour:
          type: integer
          description: An integer representing the hour of the day.
          format: int32
        millisecond:
          type: integer
          description: An integer representing the millisecond within the second.
          format: int32
        minute:
          type: integer
          description: An integer representing the minute within the hour.
          format: int32
        referenceType:
          type: string
          description: >-
            A string that specifies the type of reference, which is 'TODAY' by
            default.
          default: TODAY
          enum:
            - TODAY
        second:
          type: integer
          description: An integer representing the second within the minute.
          format: int32
      x-hubspot-sub-type-impl: true
    WeekReference:
      title: WEEK
      required:
        - dayOfWeek
        - referenceType
      type: object
      properties:
        dayOfWeek:
          type: string
          description: >-
            A string representing the day of the week, with valid values
            including 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY',
            'SATURDAY', and 'SUNDAY'.
          enum:
            - FRIDAY
            - MONDAY
            - SATURDAY
            - SUNDAY
            - THURSDAY
            - TUESDAY
            - WEDNESDAY
        hour:
          type: integer
          description: An integer representing the hour of the day.
          format: int32
        millisecond:
          type: integer
          description: An integer representing the millisecond within the second.
          format: int32
        minute:
          type: integer
          description: An integer representing the minute within the hour.
          format: int32
        referenceType:
          type: string
          description: A string indicating the type of reference, defaulting to 'WEEK'.
          default: WEEK
          enum:
            - WEEK
        second:
          type: integer
          description: An integer representing the second within the minute.
          format: int32
      x-hubspot-sub-type-impl: true
    MonthReference:
      title: MONTH
      required:
        - day
        - referenceType
      type: object
      properties:
        day:
          type: integer
          description: An integer representing the day of the month.
          format: int32
        hour:
          type: integer
          description: An integer representing the hour of the day.
          format: int32
        millisecond:
          type: integer
          description: An integer representing the millisecond within the second.
          format: int32
        minute:
          type: integer
          description: An integer representing the minute within the hour.
          format: int32
        referenceType:
          type: string
          description: >-
            A string indicating the type of reference, with a default value of
            'MONTH'.
          default: MONTH
          enum:
            - MONTH
        second:
          type: integer
          description: An integer representing the second within the minute.
          format: int32
      x-hubspot-sub-type-impl: true
    QuarterReference:
      title: QUARTER
      required:
        - day
        - month
        - referenceType
      type: object
      properties:
        day:
          type: integer
          description: An integer representing the day of the month.
          format: int32
        hour:
          type: integer
          description: An integer representing the hour of the day.
          format: int32
        millisecond:
          type: integer
          description: An integer representing the millisecond within the second.
          format: int32
        minute:
          type: integer
          description: An integer representing the minute within the hour.
          format: int32
        month:
          type: integer
          description: An integer representing the month of the quarter.
          format: int32
        referenceType:
          type: string
          description: >-
            A string indicating the type of reference, which is 'QUARTER' by
            default.
          default: QUARTER
          enum:
            - QUARTER
        second:
          type: integer
          description: An integer representing the second within the minute.
          format: int32
      x-hubspot-sub-type-impl: true
    FiscalQuarter:
      title: FISCAL_QUARTER
      required:
        - day
        - month
        - referenceType
      type: object
      properties:
        day:
          type: integer
          description: An integer representing the day within the month.
          format: int32
        hour:
          type: integer
          description: An integer representing the hour of the day.
          format: int32
        millisecond:
          type: integer
          description: An integer representing the millisecond within the second.
          format: int32
        minute:
          type: integer
          description: An integer representing the minute within the hour.
          format: int32
        month:
          type: integer
          description: An integer representing the month within the fiscal quarter.
          format: int32
        referenceType:
          type: string
          description: >-
            A string indicating the type of reference, which is 'FISCAL_QUARTER'
            for this component.
          default: FISCAL_QUARTER
          enum:
            - FISCAL_QUARTER
        second:
          type: integer
          description: An integer representing the second within the minute.
          format: int32
      x-hubspot-sub-type-impl: true
    YearReference:
      title: YEAR
      required:
        - day
        - month
        - referenceType
      type: object
      properties:
        day:
          type: integer
          description: An integer representing the day of the month.
          format: int32
        hour:
          type: integer
          description: An integer representing the hour of the day.
          format: int32
        millisecond:
          type: integer
          description: An integer representing the millisecond within the second.
          format: int32
        minute:
          type: integer
          description: An integer representing the minute within the hour.
          format: int32
        month:
          type: integer
          description: An integer representing the month of the year.
          format: int32
        referenceType:
          type: string
          description: >-
            A string indicating the type of reference, which is 'YEAR' by
            default.
          default: YEAR
          enum:
            - YEAR
        second:
          type: integer
          description: An integer representing the second within the minute.
          format: int32
      x-hubspot-sub-type-impl: true
    FiscalYear:
      title: FISCAL_YEAR
      required:
        - day
        - month
        - referenceType
      type: object
      properties:
        day:
          type: integer
          description: >-
            An integer representing the day of the month that marks the start of
            the fiscal year, with no specific constraints or default value
            provided.
          format: int32
        hour:
          type: integer
          description: >-
            An integer representing the hour of the day, with no specific
            constraints or default value provided.
          format: int32
        millisecond:
          type: integer
          description: >-
            An integer representing the millisecond within the second, with no
            specific constraints or default value provided.
          format: int32
        minute:
          type: integer
          description: >-
            An integer representing the minute within the hour, with no specific
            constraints or default value provided.
          format: int32
        month:
          type: integer
          description: >-
            An integer representing the month of the fiscal year, with no
            specific constraints or default value provided.
          format: int32
        referenceType:
          type: string
          description: >-
            A string indicating the type of reference, which is 'FISCAL_YEAR'
            for this component.
          default: FISCAL_YEAR
          enum:
            - FISCAL_YEAR
        second:
          type: integer
          description: >-
            An integer representing the second within the minute, with no
            specific constraints or default value provided.
          format: int32
      x-hubspot-sub-type-impl: true
    IndexOffset:
      type: object
      properties:
        days:
          type: integer
          description: An integer representing the number of days to offset.
          format: int32
        hours:
          type: integer
          description: An integer representing the number of hours to offset.
          format: int32
        milliseconds:
          type: integer
          description: An integer representing the number of milliseconds to offset.
          format: int32
        minutes:
          type: integer
          description: An integer representing the number of minutes to offset.
          format: int32
        months:
          type: integer
          description: An integer representing the number of months to offset.
          format: int32
        quarters:
          type: integer
          description: An integer representing the number of quarters to offset.
          format: int32
        seconds:
          type: integer
          description: An integer representing the number of seconds to offset.
          format: int32
        weeks:
          type: integer
          description: An integer representing the number of weeks to offset.
          format: int32
        years:
          type: integer
          description: An integer representing the number of years to offset.
          format: int32
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            mh-lead-scoring-edit: ''
            mh-lead-scoring-view: ''
            oauth: ''

````