> ## Documentation Index > Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update an event definition > Atualize uma definição de evento comportamental personalizado específico pelo nome. > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/2026-03/events-manage-event-definitions-v2026-03.json PATCH /events/2026-03/event-definitions/{eventName} openapi: 3.0.1 info: title: Events Manage Event Definitions description: Basepom for all HubSpot Projects version: 2026-03 x-hubspot-product-tier-requirements: marketing: ENTERPRISE sales: ENTERPRISE service: ENTERPRISE cms: ENTERPRISE commerce: ENTERPRISE crmHub: ENTERPRISE dataHub: ENTERPRISE servers: - url: https://api.hubapi.com security: [] tags: - name: Advanced - name: Basic - name: Batch paths: /events/2026-03/event-definitions/{eventName}: patch: tags: - Basic summary: Atualizar uma definição de evento personalizado description: >- Atualize uma definição de evento comportamental personalizado específico pelo nome. operationId: patch-/events/2026-03/event-definitions/{eventName} parameters: - name: eventName in: path description: Nome exclusivo da definição de evento a ser atualizada. required: true style: simple explode: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ExternalBehavioralEventTypeDefinitionPatch' required: true responses: '201': description: successful operation headers: Location: description: URL of the newly created resource style: simple explode: false schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExternalBehavioralEventTypeDefinition' default: $ref: '#/components/responses/Error' description: '' security: - oauth2: - behavioral_events.event_definitions.read_write components: schemas: ExternalBehavioralEventTypeDefinitionPatch: type: object properties: description: type: string description: >- Uma descrição do evento que será exibida como texto de ajuda no HubSpot. label: type: string description: >- Rótulo legível por humanos para o evento. Usado na interface do HubSpot ExternalBehavioralEventTypeDefinition: required: - archived - associations - fullyQualifiedName - id - labels - name - objectTypeId - properties type: object properties: archived: type: boolean description: Um booleano que indica se o tipo de evento está arquivado. associations: type: array description: >- Uma matriz de definições de associação que definem as associações relacionadas ao tipo de evento. items: $ref: '#/components/schemas/AssociationDefinition' comboEventRules: $ref: '#/components/schemas/ComboEventRuleBranch' createdAt: type: string description: >- Uma string que representa a data e a hora em que o tipo de evento foi criado, no formato ISO 8601. format: date-time createdUserId: type: integer description: >- Um número inteiro que representa o ID do usuário que criou o tipo de evento. format: int32 customMatchingId: $ref: '#/components/schemas/ExternalObjectResolutionMappingResponse' description: type: string description: Uma string que fornece uma descrição do tipo de evento. detailTemplate: type: string description: Uma string usada como modelo para os detalhes do tipo de evento. fullyQualifiedName: type: string description: >- Uma string que representa o nome totalmente qualificado do tipo de evento. headerTemplate: type: string description: Uma string usada como modelo para o cabeçalho do tipo de evento. id: type: string description: >- Uma string que representa o identificador exclusivo do tipo de evento. labels: $ref: '#/components/schemas/BehavioralEventTypeDefinitionLabels' name: type: string description: Uma string que representa o nome do tipo de evento. objectTypeId: type: string description: Uma string que representa o ID do tipo de objeto do tipo de evento. primaryObject: type: string description: >- Uma string que representa o objeto principal associado ao tipo de evento. primaryObjectId: type: string description: >- Uma string que representa o ID do objeto principal associado ao tipo de evento. properties: type: array description: >- Uma matriz de objetos de propriedade que definem as propriedades do tipo de evento. items: $ref: '#/components/schemas/Property' trackingType: type: string description: >- Uma string que especifica o tipo de rastreamento do evento. Os valores válidos incluem "VISITED_URL", "CLICKED_ELEMENT", "CUSTOM_SCRIPT" e outros. enum: - APP_EVENT - AUTOCAPTURE_EVENT - CLICKED_ELEMENT - COMBO_EVENT - CUSTOM_SCRIPT - CUSTOM_SIGNAL - IMPORT - MANUAL - POLLING - PROPERTY_CHANGE - VISITED_URL - WEBHOOK updatedAt: type: string description: >- Uma string que representa a data e a hora em que o tipo de evento foi atualizado pela última vez, no formato ISO 8601. format: date-time updatedUserId: type: integer description: >- Um número inteiro que representa o ID do usuário que atualizou pela última vez o tipo de evento. format: int32 AssociationDefinition: required: - allowsCustomLabels - cardinality - category - fromObjectTypeId - hasAllAssociatedObjects - hasCascadingDeletes - hasUserEnforcedMaxFromObjectIds - hasUserEnforcedMaxToObjectIds - hidden - id - inverseAllowsCustomLabels - inverseCardinality - inverseHasAllAssociatedObjects - inverseId - inverseName - isDefault - isInversePrimary - isPrimary - maxFromObjectIds - maxToObjectIds - name - portalUniqueIdentifier - readOnly - toObjectTypeId type: object properties: allowsCustomLabels: type: boolean description: >- Indica se rótulos personalizados são permitidos para esta associação. cardinality: type: string description: >- Define a natureza da associação em termos de quantidade. Os valores válidos são "ONE_TO_ONE" e "ONE_TO_MANY". enum: - ONE_TO_MANY - ONE_TO_ONE category: type: string description: A categoria de erro enum: - HUBSPOT_DEFINED - INTEGRATOR_DEFINED - USER_DEFINED - WORK fromObjectType: type: string description: >- O tipo de objeto do qual a associação se origina. Os valores válidos incluem vários tipos de objetos do HubSpot, como "CONTACT", "COMPANY", "DEAL" etc. enum: - ABANDONED_CART - ACCEPTANCE_TEST - AD - AD_ACCOUNT - AD_CAMPAIGN - AD_GROUP - AI_FORECAST - ALL_PAGES - APPROVAL - APPROVAL_STEP - ATTRIBUTION - AUDIENCE - AUTOMATION_JOURNEY - AUTOMATION_PLATFORM_FLOW - AUTOMATION_PLATFORM_FLOW_ACTION - BET_ALERT - BET_DELIVERABLE_SERVICE - BLOG_LISTING_PAGE - BLOG_POST - CALL - CAMPAIGN - CAMPAIGN_BUDGET_ITEM - CAMPAIGN_SPEND_ITEM - CAMPAIGN_STEP - CAMPAIGN_TEMPLATE - CAMPAIGN_TEMPLATE_STEP - CART - CASE_STUDY - CHATFLOW - CLIP - CMS_URL - COMBO_EVENT_CONFIGURATION - COMMERCE_PAYMENT - COMMUNICATION - COMPANY - CONTACT - CONTACT_CREATE_ATTRIBUTION - CONTENT - CONTENT_AUDIT - CONTENT_AUDIT_PAGE - CONVERSATION - CONVERSATION_INBOX - CONVERSATION_SESSION - CRM_OBJECTS_DUMMY_TYPE - CRM_PIPELINES_DUMMY_TYPE - CTA - CTA_VARIANT - DATA_PRIVACY_CONSENT - DATA_SYNC_STATE - DEAL - DEAL_CREATE_ATTRIBUTION - DEAL_REGISTRATION - DEAL_SPLIT - DISCOUNT - DISCOUNT_CODE - DISCOUNT_TEMPLATE - EMAIL - ENGAGEMENT - EXPORT - EXTERNAL_WEB_URL - FEE - FEEDBACK_SUBMISSION - FEEDBACK_SURVEY - FILE_MANAGER_FILE - FILE_MANAGER_FOLDER - FOLDER - FORECAST - FORM - FORM_SUBMISSION_INBOUNDDB - GOAL_TARGET - GOAL_TARGET_GROUP - GOAL_TEMPLATE - GSC_PROPERTY - HUB - IMPORT - INVOICE - KEYWORD - KNOWLEDGE_ARTICLE - LANDING_PAGE - LEAD - LINE_ITEM - MARKETING_CALENDAR - MARKETING_CAMPAIGN_UTM - MARKETING_EMAIL - MARKETING_EVENT - MARKETING_EVENT_ATTENDANCE - MARKETING_SMS - MEDIA_BRIDGE - MEETING_EVENT - MIC - NOTE - OBJECT_LIST - ORDER - OWNER - PARTNER_ACCOUNT - PARTNER_CLIENT - PARTNER_CLIENT_REVENUE - PARTNER_SERVICE - PAYMENT_LINK - PAYMENT_SCHEDULE - PAYMENT_SCHEDULE_INSTALLMENT - PERMISSIONS_TESTING - PLAYBOOK - PLAYBOOK_QUESTION - PLAYBOOK_SUBMISSION - PLAYBOOK_SUBMISSION_ANSWER - PLAYLIST - PLAYLIST_FOLDER - PODCAST_EPISODE - PORTAL - PORTAL_OBJECT_SYNC_MESSAGE - POSTAL_MAIL - PRIVACY_SCANNER_COOKIE - PRODUCT - PRODUCT_OR_FOLDER - PROPERTY_INFO - PROSPECTING_AGENT_CONTACT_ASSIGNMENT - PUBLISHING_TASK - QUARANTINED_SUBMISSION - QUOTA - QUOTE - QUOTE_FIELD - QUOTE_MODULE - QUOTE_MODULE_FIELD - QUOTE_TEMPLATE - RESTORABLE_CRM_OBJECT - ROSTER - ROSTER_MEMBER - SALES_DOCUMENT - SALES_TASK - SALES_WORKLOAD - SALESFORCE_SYNC_ERROR - SCHEDULING_PAGE - SCHEMAS_BACKEND_TEST - SCORE_CONFIGURATION - SEQUENCE - SEQUENCE_ENROLLMENT - SEQUENCE_STEP - SEQUENCE_STEP_ENROLLMENT - SERVICE - SITE_PAGE - SNIPPET - SOCIAL_BROADCAST - SOCIAL_CHANNEL - SOCIAL_POST - SOCIAL_PROFILE - SOX_PROTECTED_DUMMY_TYPE - SOX_PROTECTED_TEST_TYPE - SUBMISSION_TAG - SUBSCRIPTION - TASK - TASK_TEMPLATE - TAX - TEMPLATE - TICKET - UNKNOWN - UNSUBSCRIBE - USER - VIEW - VIEW_BLOCK - WEB_INTERACTIVE fromObjectTypeId: type: string description: O ID do tipo de objeto do qual a associação se origina. hasAllAssociatedObjects: type: boolean description: Indica se todos os objetos associados estão incluídos na associação. hasCascadingDeletes: type: boolean description: Indica se a associação oferece suporte a exclusões em cascata. hasUserEnforcedMaxFromObjectIds: type: boolean description: >- Indica se há um número máximo de IDs de objeto imposto pelo usuário para o tipo de objeto de origem. hasUserEnforcedMaxToObjectIds: type: boolean description: >- Indica se há um número máximo de IDs de objeto imposto pelo usuário para o tipo de objeto de destino. hidden: type: boolean description: Indica se a associação está oculta. hiddenReason: type: string description: >- O motivo pelo qual a associação está oculta. Os valores válidos incluem 'DEFAULT', 'INTERNAL' e 'USER_CONFIGURED'. enum: - DEFAULT - INTERNAL - USER_CONFIGURED id: type: integer description: O identificador exclusivo da definição da associação. format: int32 inverseAllowsCustomLabels: type: boolean description: >- Indica se rótulos personalizados são permitidos para a associação inversa. inverseCardinality: type: string description: >- Define a natureza inversa da associação em termos de quantidade. Os valores válidos são "ONE_TO_ONE" e "ONE_TO_MANY". enum: - ONE_TO_MANY - ONE_TO_ONE inverseHasAllAssociatedObjects: type: boolean description: >- Indica se todos os objetos associados estão incluídos na associação inversa. inverseId: type: integer description: O identificador exclusivo da definição da associação inversa. format: int32 inverseLabel: type: string description: Um rótulo legível para a associação inversa. inverseName: type: string description: Nome da associação inversa. isDefault: type: boolean description: Indica se esta é a associação padrão. isInversePrimary: type: boolean description: Indica se a associação inversa é a associação principal. isPrimary: type: boolean description: Indica se esta é a associação principal. label: type: string description: Um rótulo legível por humanos para a associação. maxFromObjectIds: type: integer description: >- O número máximo de IDs de objeto que podem ser associados a partir do tipo de objeto de origem. format: int32 maxToObjectIds: type: integer description: >- O número máximo de IDs de objeto que podem ser associados ao tipo de objeto de destino. format: int32 name: type: string description: O nome da associação. portalUniqueIdentifier: type: string description: O identificador exclusivo da associação dentro do portal. readOnly: type: boolean description: Indica se a associação é somente leitura. toObjectType: type: string description: >- O tipo de objeto para o qual a associação aponta. Os valores válidos incluem vários tipos de objeto do HubSpot, como "CONTACT", "COMPANY", "DEAL" etc. enum: - ABANDONED_CART - ACCEPTANCE_TEST - AD - AD_ACCOUNT - AD_CAMPAIGN - AD_GROUP - AI_FORECAST - ALL_PAGES - APPROVAL - APPROVAL_STEP - ATTRIBUTION - AUDIENCE - AUTOMATION_JOURNEY - AUTOMATION_PLATFORM_FLOW - AUTOMATION_PLATFORM_FLOW_ACTION - BET_ALERT - BET_DELIVERABLE_SERVICE - BLOG_LISTING_PAGE - BLOG_POST - CALL - CAMPAIGN - CAMPAIGN_BUDGET_ITEM - CAMPAIGN_SPEND_ITEM - CAMPAIGN_STEP - CAMPAIGN_TEMPLATE - CAMPAIGN_TEMPLATE_STEP - CART - CASE_STUDY - CHATFLOW - CLIP - CMS_URL - COMBO_EVENT_CONFIGURATION - COMMERCE_PAYMENT - COMMUNICATION - COMPANY - CONTACT - CONTACT_CREATE_ATTRIBUTION - CONTENT - CONTENT_AUDIT - CONTENT_AUDIT_PAGE - CONVERSATION - CONVERSATION_INBOX - CONVERSATION_SESSION - CRM_OBJECTS_DUMMY_TYPE - CRM_PIPELINES_DUMMY_TYPE - CTA - CTA_VARIANT - DATA_PRIVACY_CONSENT - DATA_SYNC_STATE - DEAL - DEAL_CREATE_ATTRIBUTION - DEAL_REGISTRATION - DEAL_SPLIT - DISCOUNT - DISCOUNT_CODE - DISCOUNT_TEMPLATE - EMAIL - ENGAGEMENT - EXPORT - EXTERNAL_WEB_URL - FEE - FEEDBACK_SUBMISSION - FEEDBACK_SURVEY - FILE_MANAGER_FILE - FILE_MANAGER_FOLDER - FOLDER - FORECAST - FORM - FORM_SUBMISSION_INBOUNDDB - GOAL_TARGET - GOAL_TARGET_GROUP - GOAL_TEMPLATE - GSC_PROPERTY - HUB - IMPORT - INVOICE - KEYWORD - KNOWLEDGE_ARTICLE - LANDING_PAGE - LEAD - LINE_ITEM - MARKETING_CALENDAR - MARKETING_CAMPAIGN_UTM - MARKETING_EMAIL - MARKETING_EVENT - MARKETING_EVENT_ATTENDANCE - MARKETING_SMS - MEDIA_BRIDGE - MEETING_EVENT - MIC - NOTE - OBJECT_LIST - ORDER - OWNER - PARTNER_ACCOUNT - PARTNER_CLIENT - PARTNER_CLIENT_REVENUE - PARTNER_SERVICE - PAYMENT_LINK - PAYMENT_SCHEDULE - PAYMENT_SCHEDULE_INSTALLMENT - PERMISSIONS_TESTING - PLAYBOOK - PLAYBOOK_QUESTION - PLAYBOOK_SUBMISSION - PLAYBOOK_SUBMISSION_ANSWER - PLAYLIST - PLAYLIST_FOLDER - PODCAST_EPISODE - PORTAL - PORTAL_OBJECT_SYNC_MESSAGE - POSTAL_MAIL - PRIVACY_SCANNER_COOKIE - PRODUCT - PRODUCT_OR_FOLDER - PROPERTY_INFO - PROSPECTING_AGENT_CONTACT_ASSIGNMENT - PUBLISHING_TASK - QUARANTINED_SUBMISSION - QUOTA - QUOTE - QUOTE_FIELD - QUOTE_MODULE - QUOTE_MODULE_FIELD - QUOTE_TEMPLATE - RESTORABLE_CRM_OBJECT - ROSTER - ROSTER_MEMBER - SALES_DOCUMENT - SALES_TASK - SALES_WORKLOAD - SALESFORCE_SYNC_ERROR - SCHEDULING_PAGE - SCHEMAS_BACKEND_TEST - SCORE_CONFIGURATION - SEQUENCE - SEQUENCE_ENROLLMENT - SEQUENCE_STEP - SEQUENCE_STEP_ENROLLMENT - SERVICE - SITE_PAGE - SNIPPET - SOCIAL_BROADCAST - SOCIAL_CHANNEL - SOCIAL_POST - SOCIAL_PROFILE - SOX_PROTECTED_DUMMY_TYPE - SOX_PROTECTED_TEST_TYPE - SUBMISSION_TAG - SUBSCRIPTION - TASK - TASK_TEMPLATE - TAX - TEMPLATE - TICKET - UNKNOWN - UNSUBSCRIBE - USER - VIEW - VIEW_BLOCK - WEB_INTERACTIVE toObjectTypeId: type: string description: O ID do tipo de objeto para o qual a associação aponta. description: The definition of an association ComboEventRuleBranch: required: - composingRules - operationType - ruleBranches type: object properties: composingRules: type: array description: >- Uma matriz de objetos ComboEventRule que definem as regras individuais que compõem esta ramificação do evento combinado. items: $ref: '#/components/schemas/ComboEventRule' operationType: type: string description: >- Uma string que indica o tipo de operação lógica a ser aplicada entre as regras nesta ramificação. Os valores válidos são "AND" e "OR". enum: - AND - OR ruleBranches: type: array description: >- Uma matriz de objetos ComboEventRuleBranch, permitindo lógica de ramificação aninhada dentro das regras de evento combinado. items: $ref: '#/components/schemas/ComboEventRuleBranch' ExternalObjectResolutionMappingResponse: required: - primaryObjectRule type: object properties: primaryObjectRule: $ref: '#/components/schemas/ExternalPrimaryObjectResolutionRule' BehavioralEventTypeDefinitionLabels: required: - singular type: object properties: plural: type: string description: >- O rótulo no plural para o tipo de evento. Esta é uma string e é opcional. singular: type: string description: >- O rótulo no singular para o tipo de evento. Esta é uma string e é obrigatória. Property: required: - description - fieldType - groupName - label - name - options - type type: object properties: archived: type: boolean description: Indica se a propriedade está arquivada. archivedAt: type: string description: >- A data e hora em que esta propriedade foi arquivada, no formato ISO 8601. format: date-time calculated: type: boolean description: Indica se a propriedade é calculada. calculationFormula: type: string description: A fórmula usada para calcular a propriedade, se aplicável. createdAt: type: string description: >- A data e a hora em que esta propriedade foi criada, no formato ISO 8601. format: date-time createdUserId: type: string description: O ID do usuário que criou esta propriedade. currencyPropertyName: type: string description: O nome da propriedade de moeda associada a esta propriedade. dataSensitivity: type: string description: >- O nível de confidencialidade dos dados. Os valores válidos incluem "non_sensitive", "sensitive" e "highly_sensitive". enum: - highly_sensitive - non_sensitive - sensitive dateDisplayHint: type: string description: >- Uma dica de como os valores de data devem ser exibidos. Os valores válidos incluem 'absolute', 'absolute_with_relative', 'time_since' e 'time_until'. enum: - absolute - absolute_with_relative - time_since - time_until description: type: string description: Uma descrição da propriedade. displayOrder: type: integer description: A ordem em que esta propriedade é exibida. format: int32 externalOptions: type: boolean description: Indica se as opções da propriedade são externas. fieldType: type: string description: O tipo de campo da propriedade. formField: type: boolean description: Indica se a propriedade é um campo de formulário. groupName: type: string description: O nome do grupo ao qual esta propriedade pertence. hasUniqueValue: type: boolean description: Indica se a propriedade tem um valor exclusivo. hidden: type: boolean description: Indica se a propriedade está oculta. example: false hubspotDefined: type: boolean description: Indica se a propriedade é definida pelo HubSpot. label: type: string description: O rótulo de exibição da propriedade. modificationMetadata: $ref: '#/components/schemas/PropertyModificationMetadata' name: type: string description: O nome exclusivo da propriedade. numberDisplayHint: type: string description: >- Uma dica de como os valores numéricos devem ser exibidos. Os valores válidos incluem "unformatted", "formatted", "currency", "percentage", "duration" e "probability". enum: - currency - duration - formatted - percentage - probability - unformatted options: type: array description: >- Uma variedade de opções disponíveis para esta propriedade, cada uma definida por um rótulo, valor e outros atributos. items: $ref: '#/components/schemas/Option' referencedObjectType: type: string description: O tipo de objeto que esta propriedade referencia. sensitiveDataCategories: type: array description: >- Uma matriz de categorias que indicam a confidencialidade dos dados contidos na propriedade. items: type: string showCurrencySymbol: type: boolean description: Indica se um símbolo de moeda é exibido para a propriedade. textDisplayHint: type: string description: >- Uma dica de como os valores de texto devem ser exibidos. Os valores válidos incluem 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address' e 'postal_code'. enum: - domain_name - email - ip_address - multi_line - phone_number - physical_address - postal_code - unformatted_single_line type: type: string description: O tipo de dados da propriedade. updatedAt: type: string description: >- A data e hora em que esta propriedade foi atualizada pela última vez, no formato ISO 8601. format: date-time updatedUserId: type: string description: O ID do usuário que atualizou esta propriedade pela última vez. description: A HubSpot property Error: required: - category - correlationId - message type: object properties: category: type: string description: A categoria de erro context: type: object additionalProperties: type: array items: type: string description: Contexto sobre a condição do erro example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- Um identificador exclusivo para a solicitação. Inclua este valor em relatórios de erro ou tickets de suporte format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: mais informações sobre o erro items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: >- Um mapa de nomes de links para URIs associados que contêm documentação sobre o erro ou as etapas de correção recomendadas message: type: string description: >- Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado example: An error occurred subCategory: type: string description: >- Uma categoria específica que contém mais detalhes específicos sobre o erro description: >- Representa uma resposta de erro retornada pela API quando uma operação falha. Este componente é usado em vários endpoints para fornecer informações detalhadas sobre o erro encontrado. 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 ComboEventRule: required: - count - eventTypeId - propertyFilters type: object properties: count: type: integer description: >- Um número inteiro que especifica o número de ocorrências necessárias para que a regra do evento seja atendida. format: int32 eventTypeId: type: string description: O identificador exclusivo para o tipo de evento. É uma string. lookbackWindowDays: type: integer description: >- Um número inteiro que representa o número de dias a serem considerados ao avaliar a regra do evento. format: int32 propertyFilters: type: array description: >- Uma matriz de filtros de propriedade que definem critérios adicionais para o evento. Cada filtro especifica uma propriedade e a operação a ser aplicada. items: $ref: '#/components/schemas/PropertyFilter' ExternalPrimaryObjectResolutionRule: required: - eventPropertyName - targetObjectPropertyName type: object properties: eventPropertyName: type: string description: >- O nome da propriedade no evento. Esta é uma string que identifica qual propriedade do evento está sendo usada na regra de resolução. targetObjectPropertyName: type: string description: >- O nome da propriedade no objeto de destino. É uma string que identifica a qual propriedade do objeto de destino a referência está sendo feita. PropertyModificationMetadata: required: - archivable - readOnlyDefinition - readOnlyValue type: object properties: archivable: type: boolean description: Um booleano que indica se a propriedade pode ser arquivada. readOnlyDefinition: type: boolean description: >- Um valor booleano que indica se a definição da propriedade é somente leitura. readOnlyOptions: type: boolean description: >- Um valor booleano que indica se as opções da propriedade são somente leitura. readOnlyValue: type: boolean description: >- Um valor booleano que indica se o valor da propriedade é somente leitura. Option: required: - hidden - label - value type: object properties: description: type: string description: Uma string que fornece uma descrição da opção. displayOrder: type: integer description: >- Um número inteiro que indica a ordem em que a opção deve ser exibida em relação a outras opções. format: int32 hidden: type: boolean description: >- Um booleano que indica se a opção está oculta da interface do usuário. label: type: string description: Uma string que representa o rótulo de exibição da opção. value: type: string description: Uma string que representa o valor interno da opção. description: A HubSpot property option ErrorDetail: required: - message type: object properties: code: type: string description: O código de status associado ao detalhe do erro context: type: object additionalProperties: type: array items: type: string description: Contexto sobre a condição do erro example: '{missingScopes=[scope1, scope2]}' in: type: string description: O nome do campo ou parâmetro no qual o erro foi encontrado. message: type: string description: >- Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado subCategory: type: string description: >- Uma categoria específica que contém mais detalhes específicos sobre o erro description: >- Representa informações detalhadas sobre um erro ocorrido na API. Este componente é usado para fornecer contexto e detalhes adicionais sobre os erros, geralmente como parte de uma resposta de erro. PropertyFilter: title: PROPERTY required: - filterType - operation - property type: object properties: context: $ref: '#/components/schemas/PropertyFilterContext' filterInsightsId: type: integer description: >- Um número inteiro que serve como identificador para os insights do filtro. format: int32 filterType: type: string description: >- Uma string que indica o tipo de filtro que está sendo aplicado. O valor padrão é "PROPERTY". default: PROPERTY enum: - PROPERTY frameworkFilterId: type: integer description: >- Um número inteiro que representa o identificador exclusivo do filtro de estrutura. Ele é formatado como um int64. format: int64 operation: description: >- Um objeto que define a operação a ser realizada na propriedade. Pode ser um de vários tipos de operações, como 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: >- Uma string que representa o nome da propriedade na qual o filtro é aplicado. x-hubspot-sub-type-impl: true PropertyFilterContext: required: - objectTypeId type: object properties: objectTypeId: type: string description: >- Uma string que representa o identificador exclusivo do tipo de objeto associado ao contexto do filtro de propriedade. BoolPropertyOperation: title: bool required: - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType - value type: object properties: defaultValue: type: string description: Uma string que representa o valor padrão para a operação. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem valor definido devem ser definidos para a propriedade. operationType: type: string description: Uma string que indica o tipo de operação que está sendo realizada. operator: type: string description: >- Uma string que representa a operação a ser realizada. Os valores válidos incluem 'IS_EQUAL_TO', 'IS_NOT_EQUAL_TO', 'HAS_EVER_BEEN_EQUAL_TO' e '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: Uma string que representa o nome do operador usado na operação. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- Uma string que indica o tipo de propriedade, que é 'bool' para esta operação. default: bool enum: - bool renderSpec: type: string description: >- Uma string que define a especificação de renderização para a operação. value: type: boolean description: Um booleano que indica o valor a ser usado na operação. x-hubspot-sub-type-impl: true NumberPropertyOperation: title: number required: - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType - value type: object properties: defaultValue: type: string description: >- Uma string que representa o valor padrão da operação se nenhum valor específico for definido. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem um valor definido para a propriedade devem ser incluídos na operação. operationType: type: string description: Uma string que indica o tipo de operação que está sendo realizada. operator: type: string description: >- Uma string que representa o operador de comparação usado na operação. Os valores válidos incluem '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' e '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: Uma string que representa o nome do operador usado na operação. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- Uma string que indica o tipo de operação de propriedade, que é "number" neste caso. default: number enum: - number renderSpec: type: string description: >- Uma string que especifica como a operação deve ser renderizada ou exibida. value: type: number description: Um valor numérico usado na operação para comparação. x-hubspot-sub-type-impl: true StringPropertyOperation: title: string required: - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType - value type: object properties: defaultValue: type: string description: >- Valor padrão da string a ser usado se nenhum valor específico for definido. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem valor definido devem ser definidos para a propriedade. operationType: type: string description: >- O tipo de operação que está sendo realizada, representado como uma string. operator: type: string description: >- A operação a ser realizada na propriedade de string. Os valores válidos incluem "IS_EQUAL_TO", "IS_NOT_EQUAL_TO", "CONTAINS", "DOES_NOT_CONTAIN", "STARTS_WITH", "ENDS_WITH", "HAS_EVER_BEEN_EQUAL_TO", "HAS_NEVER_BEEN_EQUAL_TO", "HAS_EVER_CONTAINED" e "HAS_NEVER_CONTAINED". 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: O nome do operador usado na operação, representado como uma string. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: O tipo de propriedade, que é sempre "string" para esta operação. default: string enum: - string renderSpec: type: string description: >- Uma string que especifica como a operação deve ser renderizada, embora o formato exato não seja detalhado. value: type: string description: O valor da string a ser usado na operação. x-hubspot-sub-type-impl: true DateTimePropertyOperation: title: datetime required: - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType - requiresTimeZoneConversion - timestamp type: object properties: defaultValue: type: string description: >- Uma string que especifica o valor padrão a ser usado se nenhum outro valor for definido. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem um valor definido para esta propriedade devem ser incluídos na operação. operationType: type: string description: >- Uma string que especifica o tipo de operação que está sendo realizada. operator: type: string description: >- Uma string que representa a operação a ser realizada, com valores válidos incluindo 'IS_BEFORE', 'IS_AFTER', 'IS_EQUAL_TO', 'IS_BEFORE_DATE' e 'IS_AFTER_DATE'. enum: - IS_AFTER - IS_AFTER_DATE - IS_BEFORE - IS_BEFORE_DATE - IS_EQUAL_TO operatorName: type: string description: Uma string que representa o nome do operador usado na operação. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- Uma string que indica o tipo de propriedade, assumindo o padrão "datetime". default: datetime enum: - datetime renderSpec: type: string description: >- Uma string que define como a operação deve ser renderizada ou exibida. requiresTimeZoneConversion: type: boolean description: >- Um booleano que indica se a operação requer conversão com base em fusos horários. timestamp: type: integer description: >- Um número inteiro que representa uma data/hora Unix em milissegundos, usado para comparações de data/hora. 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: >- Uma string que representa o valor padrão a ser usado caso nenhum valor específico for definido. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se devem ser incluídos objetos que não têm um valor definido para a propriedade. lowerBoundTimestamp: type: integer description: >- Um número inteiro que representa o limite inferior do intervalo de datas, especificado como uma data/hora Unix em milissegundos. format: int64 operationType: type: string description: >- Uma string que representa o tipo de operação que está sendo realizada. operator: type: string description: >- Uma string que especifica a operação a ser realizada, com valores válidos 'IS_BETWEEN' e 'IS_NOT_BETWEEN'. enum: - IS_BETWEEN - IS_NOT_BETWEEN operatorName: type: string description: Uma string que representa o nome do operador usado na operação. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- Uma string que indica o tipo de operação de propriedade, que é 'datetime-ranged' para este componente. default: datetime-ranged enum: - datetime-ranged renderSpec: type: string description: Uma string que especifica como a operação deve ser renderizada. requiresTimeZoneConversion: type: boolean description: >- Um valor booleano que indica se a conversão de fuso horário é necessária para o intervalo de datas. upperBoundTimestamp: type: integer description: >- Um número inteiro que representa o limite superior do intervalo de datas, especificado como uma data/hora Unix em milissegundos. 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: Uma string que representa o nome da propriedade a ser comparada. defaultComparisonValue: type: string description: >- Uma string que especifica o valor padrão para comparação se a propriedade de comparação não estiver definida. defaultValue: type: string description: >- Uma string que fornece o valor padrão para a operação se nenhum valor específico for definido. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem um valor definido para a propriedade devem ser incluídos na operação. operationType: type: string description: >- Uma string que representa o tipo de operação que está sendo realizada. operator: type: string description: >- Uma string que especifica o operador de comparação a ser usado. Os valores válidos são "IS_BEFORE" e "IS_AFTER". enum: - IS_AFTER - IS_BEFORE operatorName: type: string description: >- Uma string que fornece um nome legível para o operador que está sendo usado. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- Uma string que indica o tipo de operação de propriedade, que é 'datetime-comparative' para este componente. default: datetime-comparative enum: - datetime-comparative renderSpec: type: string description: >- Uma string usada para definir como a operação deve ser renderizada, embora os detalhes não sejam especificados no esquema. x-hubspot-sub-type-impl: true ComparativeBoolPropertyOperation: title: bool-comparative required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType type: object properties: comparisonPropertyName: type: string description: Uma string que especifica o nome da propriedade a ser comparada. defaultValue: type: string description: >- Uma string que representa o valor padrão a ser usado se nenhum valor for definido. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem valor definido devem ser incluídos na operação. operationType: type: string description: >- Uma string que especifica o tipo de operação que está sendo realizada. operator: type: string description: >- Uma string que representa o operador de comparação. Os valores válidos são 'IS_EQUAL_TO' e 'IS_NOT_EQUAL_TO'. enum: - IS_EQUAL_TO - IS_NOT_EQUAL_TO operatorName: type: string description: Uma string que representa o nome do operador usado na operação. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- Uma string que indica o tipo de operação de propriedade, que é 'bool-comparative' para este componente. default: bool-comparative enum: - bool-comparative renderSpec: type: string description: >- Uma string que define a especificação de renderização para a operação. x-hubspot-sub-type-impl: true ComparativeNumberPropertyOperation: title: number-comparative required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType type: object properties: comparisonPropertyName: type: string description: >- Uma string que representa o nome da propriedade à qual a comparação é feita. defaultValue: type: string description: >- Uma string que especifica o valor padrão a ser usado se nenhum valor for definido para a propriedade que está sendo comparada. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se devem ser incluídos objetos que não têm valor definido para a propriedade que está sendo comparada. operationType: type: string description: >- Uma string que representa o tipo de operação que está sendo realizada. operator: type: string description: >- Uma string que indica o operador de comparação a ser usado. Os valores válidos incluem 'IS_EQUAL_TO', 'IS_NOT_EQUAL_TO', 'IS_GREATER_THAN', 'IS_GREATER_THAN_OR_EQUAL_TO', 'IS_LESS_THAN' e '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: Uma string que representa o nome do operador usado na operação. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- Uma string que representa o tipo de operação da propriedade, com um valor padrão de "number-comparative". default: number-comparative enum: - number-comparative renderSpec: type: string description: >- Uma string que fornece especificações de renderização para a operação. x-hubspot-sub-type-impl: true ComparativeStringPropertyOperation: title: string-comparative required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType type: object properties: comparisonPropertyName: type: string description: Uma string que especifica o nome da propriedade a ser comparada. defaultValue: type: string description: >- Uma string que representa o valor padrão a ser usado se o valor da propriedade não estiver definido. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem um valor definido para a propriedade devem ser incluídos na operação. operationType: type: string description: >- Uma string que representa o tipo de operação que está sendo realizada. operator: type: string description: >- Uma string que representa o operador de comparação usado na operação. Os valores válidos incluem 'IS_EQUAL_TO', 'IS_NOT_EQUAL_TO', 'CONTAINS', 'DOES_NOT_CONTAIN', 'STARTS_WITH' e 'ENDS_WITH'. enum: - CONTAINS - DOES_NOT_CONTAIN - ENDS_WITH - IS_EQUAL_TO - IS_NOT_EQUAL_TO - STARTS_WITH operatorName: type: string description: >- Uma string que fornece um nome legível para o operador usado na operação. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- Uma string que indica o tipo de operação da propriedade, que é "string-comparative" para este componente. default: string-comparative enum: - string-comparative renderSpec: type: string description: >- Uma string que fornece especificações de renderização para a operação, embora seu uso específico não seja detalhado na especificação. 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: Uma string que especifica o nome da propriedade a ser comparada. defaultComparisonValue: type: string description: >- Uma string que representa o valor padrão a ser usado para comparação se nenhum outro valor for definido. defaultValue: type: string description: >- Uma string que representa o valor padrão a ser usado se nenhum outro valor for definido. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem valor definido devem ser definidos para a propriedade. operationType: type: string description: Uma string que indica o tipo de operação que está sendo realizada. operator: type: string description: >- Uma string que indica o operador de comparação a ser usado, com valores válidos sendo 'IS_BEFORE' e 'IS_AFTER'. enum: - IS_AFTER - IS_BEFORE operatorName: type: string description: Uma string que representa o nome do operador usado na operação. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- Uma string que representa o tipo de operação da propriedade, assumindo o padrão "property-updated-comparative". default: property-updated-comparative enum: - property-updated-comparative renderSpec: type: string description: Uma string que fornece especificações para renderizar a operação. 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: >- Uma string que representa o valor padrão a ser usado se nenhum outro valor for definido. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem valor definido devem ser definidos para a propriedade. numberOfDays: type: integer description: >- Um número inteiro que representa o número de dias usados no cálculo do período de dias corridos. format: int32 operationType: type: string description: Uma string que indica o tipo de operação que está sendo realizada. operator: type: string description: >- Uma string que especifica a operação a ser realizada, como "IS_LESS_THAN_X_DAYS_AGO" ou "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: Uma string que representa o nome do operador usado na operação. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- Uma string que indica o tipo de operação da propriedade, com um valor padrão de "datetime-rolling". default: datetime-rolling enum: - datetime-rolling renderSpec: type: string description: >- Uma string usada para especificações de renderização, embora seu uso específico não seja detalhado. requiresTimeZoneConversion: type: boolean description: >- Um booleano que indica se a operação requer conversão com base em fusos horários. 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: >- Uma string que contém o valor predefinido para a propriedade, caso nenhum outro valor seja definido. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem um valor definido para a propriedade devem ser incluídos na operação. numberOfDays: type: integer description: >- Um número inteiro que representa o número de dias dentro dos quais a operação de atualização da propriedade é avaliada. format: int32 operationType: type: string description: >- Uma string que especifica o tipo de operação que está sendo realizada. operator: type: string description: >- Uma string que especifica a operação a ser realizada, com valores válidos sendo 'UPDATED_IN_LAST_X_DAYS' e 'NOT_UPDATED_IN_LAST_X_DAYS'. enum: - NOT_UPDATED_IN_LAST_X_DAYS - UPDATED_IN_LAST_X_DAYS operatorName: type: string description: Uma string que representa o nome do operador usado na operação. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- Uma string que indica o tipo de operação de propriedade, que é "rolling-property-updated". default: rolling-property-updated enum: - rolling-property-updated renderSpec: type: string description: >- Uma string que especifica como a operação deve ser renderizada ou exibida. x-hubspot-sub-type-impl: true EnumerationPropertyOperation: title: enumeration required: - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType - values type: object properties: defaultValue: type: string description: Uma string que representa o valor padrão para a operação. includeObjectsWithNoValueSet: type: boolean description: >- Booleano que indica se devem ser incluídos objetos sem valor definido para esta propriedade. operationType: type: string description: Uma string que indica o tipo de operação que está sendo realizada. operator: type: string description: >- Uma string que representa a operação a ser realizada, com valores válidos incluindo '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' e '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: Uma string que representa o nome do operador usado na operação. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- Uma string que indica o tipo de propriedade, que é "enumeration" por padrão. default: enumeration enum: - enumeration renderSpec: type: string description: Uma string que especifica como a operação deve ser renderizada. values: type: array description: >- Uma matriz de strings que representa os valores a serem usados na operação. items: type: string x-hubspot-sub-type-impl: true AllPropertyTypesOperation: title: alltypes required: - coalescingRefineBy - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType type: object properties: coalescingRefineBy: description: >- Um objeto que especifica critérios de refinamento adicionais para coalescência, que pode ser de vários tipos, como NumOccurrencesRefineBy ou SetOccurrencesRefineBy. oneOf: - $ref: '#/components/schemas/NumOccurrencesRefineBy' - $ref: '#/components/schemas/SetOccurrencesRefineBy' defaultValue: type: string description: Uma string que especifica o valor padrão a ser usado na operação. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem valor definido devem ser incluídos na operação. operationType: type: string description: Uma string que indica o tipo de operação que está sendo realizada. operator: type: string description: >- Uma string que representa a operação a ser realizada, com valores válidos incluindo "IS_KNOWN", "IS_UNKNOWN", "IS_BLANK" e "IS_NOT_BLANK". enum: - IS_BLANK - IS_KNOWN - IS_NOT_BLANK - IS_UNKNOWN operatorName: type: string description: Uma string que representa o nome do operador usado na operação. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- Uma string que indica o tipo de operação de propriedade, que é 'alltypes' para este componente. default: alltypes enum: - alltypes pruningRefineBy: description: >- Um objeto que especifica critérios de refinamento adicionais para remoção, que pode ser de vários tipos, como RelativeComparativeTimestampRefineBy ou 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: >- Uma string que fornece especificações de renderização para a operação. 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: >- Uma string que representa o valor padrão a ser usado se nenhum valor for definido para a propriedade. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem um valor definido para a propriedade devem ser incluídos na operação. lowerBound: type: number description: >- Um número que representa o limite inferior do intervalo para a operação. operationType: type: string description: >- Uma string que especifica o tipo de operação que está sendo realizada. operator: type: string description: >- Uma string que especifica a operação a ser realizada na propriedade. Os valores válidos incluem "IS_BETWEEN" e "IS_NOT_BETWEEN". enum: - IS_BETWEEN - IS_NOT_BETWEEN operatorName: type: string description: Uma string que representa o nome do operador usado na operação. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- Uma string que indica o tipo de operação de propriedade, que é "number-ranged" por padrão. default: number-ranged enum: - number-ranged renderSpec: type: string description: >- Uma string que especifica como a operação deve ser renderizada, embora seu uso exato não seja detalhado na especificação. upperBound: type: number description: >- Um número que representa o limite superior do intervalo para a operação. x-hubspot-sub-type-impl: true MultiStringPropertyOperation: title: multistring required: - coalescingRefineBy - includeObjectsWithNoValueSet - operationType - operator - operatorName - propertyType - values type: object properties: coalescingRefineBy: description: >- Um objeto que especifica critérios de refinamento adicionais para coalescência, que pode ser um de vários esquemas predefinidos, como NumOccurrencesRefineBy ou SetOccurrencesRefineBy. oneOf: - $ref: '#/components/schemas/NumOccurrencesRefineBy' - $ref: '#/components/schemas/SetOccurrencesRefineBy' defaultValue: type: string description: >- Uma string que representa o valor padrão a ser usado na operação se nenhum valor específico for fornecido. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem um valor definido para a propriedade devem ser incluídos na operação. operationType: type: string description: Uma string que indica o tipo de operação que está sendo realizada. operator: type: string description: >- Uma string que representa a operação a ser realizada, com valores possíveis incluindo "IS_EQUAL_TO", "IS_NOT_EQUAL_TO", "CONTAINS", "CONTAINS_EXACTLY", "DOES_NOT_CONTAIN", "DOES_NOT_CONTAIN_EXACTLY", "STARTS_WITH" e "ENDS_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: Uma string que representa o nome do operador usado na operação. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- Uma string que especifica o tipo de operação de propriedade, que é "multistring" por padrão. default: multistring enum: - multistring pruningRefineBy: description: >- Um objeto que especifica critérios de refinamento adicionais para remoção, que pode ser um de vários esquemas predefinidos, como RelativeComparativeTimestampRefineBy ou 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: >- Uma string que especifica como a operação deve ser renderizada ou exibida. values: type: array description: >- Uma matriz de strings que representa os valores a serem usados na operação. 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: Um número inteiro que especifica o componente de dia da data. format: int32 defaultValue: type: string description: >- Uma string que representa o valor padrão a ser usado se nenhum outro valor for definido. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem valor definido devem ser definidos para a propriedade. month: type: string description: Um número inteiro que especifica o componente de mês da data. enum: - APR - AUG - DEC - FEB - JAN - JUL - JUN - MAR - MAY - NOV - OCT - SEP operationType: type: string description: Uma string que indica o tipo de operação que está sendo realizada. operator: type: string description: >- Uma string que representa a operação a ser realizada na propriedade de data, como operações de comparação. enum: - AFTER - BEFORE - EQUAL operatorName: type: string description: Uma string que representa o nome do operador usado na operação. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- Uma string que indica o tipo de operação da propriedade, com um valor padrão de 'date'. default: date enum: - date renderSpec: type: string description: Uma string que fornece especificações para renderizar a operação. year: type: integer description: Número inteiro que especifica o componente de ano da data. 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: Uma string que representa o valor padrão para a operação. fiscalYearStart: type: string description: >- Uma string que indica o mês de início do ano fiscal, com opções como "JANUARY", "FEBRUARY", "MARCH" etc. enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que determina se objetos sem valor definido devem ser incluídos na operação. operationType: type: string description: Uma string que indica o tipo de operação que está sendo realizada. operator: type: string description: >- Uma string que especifica a operação a ser realizada, com valores válidos incluindo 'IN_THIS_TIME_UNIT', 'IN_THIS_TIME_UNIT_SO_FAR', 'IN_NEXT_TIME_UNIT', 'IN_LAST_TIME_UNIT' e '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: Uma string que representa o nome do operador usado na operação. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- Uma string que indica o tipo de propriedade, assumindo o padrão 'calendar-date'. default: calendar-date enum: - calendar-date renderSpec: type: string description: >- Uma string usada para definir as especificações de renderização para a operação. timeUnit: type: string description: >- Uma string que representa a unidade de tempo para a operação, como "DAY", "WEEK", "MONTH", "QUARTER" ou "YEAR". enum: - DAY - MONTH - QUARTER - WEEK - YEAR timeUnitCount: type: integer description: >- Um número inteiro que especifica o número de unidades de tempo a serem consideradas na operação. format: int32 useFiscalYear: type: boolean description: Um booleano que indica se o ano fiscal deve ser usado na operação. 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: Uma string que indica o valor padrão para a operação. endpointBehavior: type: string description: >- Uma string que indica o comportamento do endpoint. Os valores válidos são 'INCLUSIVE' e 'EXCLUSIVE'. enum: - EXCLUSIVE - INCLUSIVE includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se os objetos sem valor definido devem ser incluídos. operationType: type: string description: String que indica o tipo de operação. operator: type: string description: >- Uma string que representa o operador usado na operação. Os valores válidos são 'IS_BEFORE' e 'IS_AFTER'. enum: - IS_AFTER - IS_BEFORE operatorName: type: string description: Uma string que representa o nome do operador. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyParser: type: string description: >- Uma string que especifica o analisador de propriedade. Os valores válidos incluem 'VALUE', 'UPDATED_AT', 'ANNIVERSARY', 'VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION' e '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: Uma string que indica o tipo de propriedade. O padrão é "timepoint". default: timepoint enum: - timepoint renderSpec: type: string description: Uma string que define a especificação de renderização. timePoint: description: >- Um objeto que especifica o ponto no tempo. Pode ser um DatePoint, IndexedTimePoint ou PropertyReferencedTime. oneOf: - $ref: '#/components/schemas/DatePoint' - $ref: '#/components/schemas/IndexedTimePoint' - $ref: '#/components/schemas/PropertyReferencedTime' type: type: string description: Uma string que representa o tipo da operação. 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: >- Uma string que representa o valor padrão a ser usado se nenhum outro valor for definido. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se devem ser incluídos objetos que não têm valor definido para a propriedade especificada. lowerBoundEndpointBehavior: type: string description: >- Uma string que indica o comportamento do endpoint no limite inferior. Os valores válidos são "INCLUSIVE" e "EXCLUSIVE". enum: - EXCLUSIVE - INCLUSIVE lowerBoundTimePoint: description: >- Define o limite inferior do intervalo de tempo, podendo ser um DatePoint, IndexedTimePoint ou PropriedadeReferencedTime. oneOf: - $ref: '#/components/schemas/DatePoint' - $ref: '#/components/schemas/IndexedTimePoint' - $ref: '#/components/schemas/PropertyReferencedTime' operationType: type: string description: >- Uma string que representa o tipo de operação que está sendo realizada. operator: type: string description: >- Uma string que representa a operação a ser realizada, com valores válidos 'IS_BETWEEN' e 'IS_NOT_BETWEEN'. enum: - IS_BETWEEN - IS_NOT_BETWEEN operatorName: type: string description: Uma string que indica o nome do operador usado na operação. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyParser: type: string description: >- Uma string que especifica o analisador a ser usado para a propriedade. As opções incluem "VALUE", "UPDATED_AT", "ANNIVERSARY", "VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION" e "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: >- Uma string que indica o tipo de propriedade, assumindo o padrão "rangedtime". default: rangedtime enum: - rangedtime renderSpec: type: string description: Uma string que define a especificação de renderização, se aplicável. type: type: string description: Uma string que representa o tipo da operação. upperBoundEndpointBehavior: type: string description: >- Uma string que indica o comportamento do endpoint no limite superior. Os valores válidos são "INCLUSIVE" e "EXCLUSIVE". enum: - EXCLUSIVE - INCLUSIVE upperBoundTimePoint: description: >- Define o limite superior do intervalo de tempo, que pode ser um DatePoint, IndexedTimePoint ou 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: >- Boleano que indica se a correspondência de regex deve diferenciar maiúsculas de minúsculas. defaultValue: type: string description: >- Uma string que representa o valor padrão a ser usado se nenhuma correspondência for encontrada. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem valor definido devem ser definidos para a propriedade. operationType: type: string description: Uma string que indica o tipo de operação que está sendo realizada. operator: type: string description: >- Uma string que especifica a operação de regex a ser realizada, como "MATCHES_REGEX" ou "DOES_NOT_MATCH_REGEX". enum: - DOES_NOT_MATCH_REGEX - MATCHES_REGEX operatorName: type: string description: Uma string que representa o nome do operador usado na operação. pattern: type: string description: >- Uma string que representa o padrão de expressão regular usado para correspondência. propertyAspect: $ref: '#/components/schemas/PropertyAspect' propertyType: type: string description: >- Uma string que indica o tipo de operação de propriedade, com um valor padrão de "regex". default: regex enum: - regex renderSpec: type: string description: >- Uma string que especifica como a operação deve ser renderizada ou exibida. x-hubspot-sub-type-impl: true PropertyAspect: required: - aspect type: object properties: aspect: type: string enum: - TIMERANGE_END - TIMERANGE_START qualifier: type: string NumOccurrencesRefineBy: title: NumOccurrencesRefineBy required: - type type: object properties: maxOccurrences: type: integer description: >- Um número inteiro que representa o número máximo de ocorrências permitidas. format: int32 minOccurrences: type: integer description: >- Um número inteiro que representa o número mínimo de ocorrências necessárias. format: int32 type: type: string description: >- Uma string que especifica o tipo de refinamento, que é 'NumOccurrencesRefineBy' por padrão. default: NumOccurrencesRefineBy enum: - NumOccurrencesRefineBy x-hubspot-sub-type-impl: true SetOccurrencesRefineBy: title: SetOccurrencesRefineBy required: - setType - type type: object properties: setType: type: string description: >- Uma string que indica o tipo de conjunto usado para refinamento. Os valores válidos incluem 'ALL', 'ALL_INCLUDE_EMPTY', 'ANY', 'NONE', 'NONE_EXCLUDE_EMPTY' e 'ANY_INCLUDE_EMPTY'. enum: - ALL - ALL_INCLUDE_EMPTY - ANY - ANY_INCLUDE_EMPTY - NONE - NONE_EXCLUDE_EMPTY type: type: string description: >- Uma string que especifica o tipo de refinamento que está sendo aplicado. O valor padrão é "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: >- Uma string que indica a direção da comparação, seja "BEFORE" ou "AFTER". enum: - AFTER - BEFORE timeOffset: $ref: '#/components/schemas/TimeOffset' type: type: string description: >- Uma string que especifica o tipo de refinamento, que é '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: >- Uma string que indica o tipo de operação de intervalo. Os valores válidos são "BETWEEN" e "NOT_BETWEEN". enum: - BETWEEN - NOT_BETWEEN type: type: string description: >- Uma string que especifica o tipo de operação de refinamento. O valor padrão é '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: >- Uma string que indica o tipo de comparação a ser feita. Os valores válidos incluem "BEFORE" e "AFTER". enum: - AFTER - BEFORE timestamp: type: integer description: >- Um número inteiro que representa a data/hora específica a ser usada na comparação, formatado como um int64. format: int64 type: type: string description: >- Uma string que especifica o tipo de refinamento, com um valor padrão de "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: >- Um número inteiro que representa o limite inferior do intervalo de datas/horas, em milissegundos desde a época Unix. format: int64 rangeType: type: string description: >- Uma string que define o tipo de operação de intervalo. Os valores válidos incluem 'BETWEEN' e 'NOT_BETWEEN'. enum: - BETWEEN - NOT_BETWEEN type: type: string description: >- Uma string que especifica o tipo do componente. O valor padrão é 'AbsoluteRangedTimestampRefineBy'. default: AbsoluteRangedTimestampRefineBy enum: - AbsoluteRangedTimestampRefineBy upperTimestamp: type: integer description: >- Um número inteiro que representa o limite superior do intervalo de datas/horas, em milissegundos desde a época Unix. format: int64 x-hubspot-sub-type-impl: true AllHistoryRefineBy: title: AllHistoryRefineBy required: - type type: object properties: type: type: string description: >- Uma string que indica o tipo de refinamento. O valor padrão e único válido é '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: Um número inteiro que representa o componente de dia da data. format: int32 hour: type: integer description: Um número inteiro que representa o componente de hora. format: int32 millisecond: type: integer description: >- Um número inteiro que representa o componente de milissegundos do tempo. format: int32 minute: type: integer description: Um número inteiro que representa o componente de minuto do horário. format: int32 month: type: integer description: Um número inteiro que representa o componente de mês da data. format: int32 second: type: integer description: Um número inteiro que representa o componente de segundo do horário. format: int32 timeType: type: string description: >- Uma string que indica o tipo de representação de tempo, assumindo o padrão "DATE". default: DATE enum: - DATE timezoneSource: type: string description: >- Uma string que especifica a origem do fuso horário. Os valores válidos incluem "CUSTOM", "USER" e "PORTAL". enum: - CUSTOM - PORTAL - USER year: type: integer description: Um número inteiro que representa o componente do ano da data. format: int32 zoneId: type: string description: Uma string que representa o identificador do fuso horário. x-hubspot-sub-type-impl: true IndexedTimePoint: title: INDEXED required: - indexReference - timeType - timezoneSource - zoneId type: object properties: indexReference: description: >- Um objeto que referencia um ponto específico no tempo, que pode ser de vários tipos, como NowReference, TodayReference ou YearReference. 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: Um booleano que indica se o tempo de atualização deve ser gerado. timeType: type: string description: >- Uma string que indica o tipo de ponto no tempo, com um valor padrão de "INDEXED". default: INDEXED enum: - INDEXED timezoneSource: type: string description: >- Uma string que representa a origem do fuso horário. Os valores válidos incluem "CUSTOM", "USER" e "PORTAL". enum: - CUSTOM - PORTAL - USER zoneId: type: string description: Uma string que especifica o identificador do fuso horário. x-hubspot-sub-type-impl: true PropertyReferencedTime: title: PROPERTY_REFERENCED required: - property - referenceType - timeType - timezoneSource - zoneId type: object properties: property: type: string description: >- Uma string que indica a propriedade da qual a referência de tempo é derivada. referenceType: type: string description: >- Uma string que define o tipo de referência, com valores possíveis incluindo 'VALUE', 'UPDATED_AT', 'ANNIVERSARY', 'VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION' e 'ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION'. enum: - ANNIVERSARY - ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION - UPDATED_AT - VALUE - VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION timeType: type: string description: >- Uma string que indica o tipo de referência de tempo, com um valor padrão de "PROPERTY_REFERENCED". default: PROPERTY_REFERENCED enum: - PROPERTY_REFERENCED timezoneSource: type: string description: >- Uma string que especifica a origem do fuso horário, que pode ser "CUSTOM", "USER" ou "PORTAL". enum: - CUSTOM - PORTAL - USER zoneId: type: string description: Uma string que representa o identificador do fuso horário. x-hubspot-sub-type-impl: true TimeOffset: required: - amount - offsetDirection - timeUnit type: object properties: amount: type: integer description: >- Um número inteiro que representa o valor de unidades de tempo para o deslocamento. format: int64 offsetDirection: type: string description: >- Uma string que indica a direção do deslocamento de tempo. Os valores válidos são "PAST" e "FUTURE". enum: - FUTURE - PAST timeUnit: type: string description: >- Uma string que especifica a unidade de tempo para o deslocamento. Os valores válidos incluem "WEEKS", "DAYS", "HOURS" e "MINUTES". enum: - DAYS - HOURS - MINUTES - WEEKS NowReference: title: NOW required: - referenceType type: object properties: hour: type: integer description: Um número inteiro que representa a hora atual. format: int32 millisecond: type: integer description: Um número inteiro que representa os milissegundos da hora atual. format: int32 minute: type: integer description: Um número inteiro que representa os minutos da hora atual. format: int32 referenceType: type: string description: >- Uma string que indica o tipo de referência, que é sempre "NOW" para este componente. default: NOW enum: - NOW second: type: integer description: Um número inteiro que representa os segundos da hora atual. format: int32 x-hubspot-sub-type-impl: true TodayReference: title: TODAY required: - referenceType type: object properties: hour: type: integer description: Um número inteiro que representa a hora do dia. format: int32 millisecond: type: integer description: Um número inteiro que representa os milissegundos dentro do segundo. format: int32 minute: type: integer description: Um número inteiro que representa os minutos dentro da hora. format: int32 referenceType: type: string description: >- Uma string que indica o tipo de referência, com um valor padrão e único válido de "TODAY". default: TODAY enum: - TODAY second: type: integer description: Um número inteiro que representa os segundos dentro do minuto. format: int32 x-hubspot-sub-type-impl: true WeekReference: title: WEEK required: - dayOfWeek - referenceType type: object properties: dayOfWeek: type: string description: >- Uma string que representa o dia da semana. Os valores válidos incluem "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" e "SUNDAY". enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY hour: type: integer description: Um número inteiro que representa a hora do dia. format: int32 millisecond: type: integer description: Um número inteiro que representa os milissegundos dentro do segundo. format: int32 minute: type: integer description: Um número inteiro que representa os minutos dentro da hora. format: int32 referenceType: type: string description: Uma string que indica o tipo de referência, que é "WEEK" por padrão. default: WEEK enum: - WEEK second: type: integer description: Um número inteiro que representa os segundos dentro do minuto. format: int32 x-hubspot-sub-type-impl: true MonthReference: title: MONTH required: - day - referenceType type: object properties: day: type: integer description: Um número inteiro que representa o dia do mês. format: int32 hour: type: integer description: Um número inteiro que representa a hora do dia. format: int32 millisecond: type: integer description: Um número inteiro que representa o milissegundo do segundo. format: int32 minute: type: integer description: Um número inteiro que representa o minuto da hora. format: int32 referenceType: type: string description: >- Uma string que indica o tipo de referência, que é "MONTH" por padrão. default: MONTH enum: - MONTH second: type: integer description: Um número inteiro que representa o segundo do minuto. format: int32 x-hubspot-sub-type-impl: true QuarterReference: title: QUARTER required: - day - month - referenceType type: object properties: day: type: integer description: Um número inteiro que representa o dia do mês. format: int32 hour: type: integer description: Um número inteiro que representa a hora do dia. format: int32 millisecond: type: integer description: Um número inteiro que representa os milissegundos dentro do segundo. format: int32 minute: type: integer description: Um número inteiro que representa os minutos dentro da hora. format: int32 month: type: integer description: Um número inteiro que representa o mês dentro do trimestre. format: int32 referenceType: type: string description: >- Uma string que indica o tipo de referência, que é 'QUARTER' por padrão. default: QUARTER enum: - QUARTER second: type: integer description: Um número inteiro que representa os segundos dentro do minuto. format: int32 x-hubspot-sub-type-impl: true FiscalQuarter: title: FISCAL_QUARTER required: - day - month - referenceType type: object properties: day: type: integer description: Um número inteiro que representa o dia do mês. format: int32 hour: type: integer description: Um número inteiro que representa a hora do dia. format: int32 millisecond: type: integer description: Um número inteiro que representa os milissegundos dentro do segundo. format: int32 minute: type: integer description: Um número inteiro que representa os minutos dentro da hora. format: int32 month: type: integer description: Um número inteiro que representa o mês dentro do trimestre fiscal. format: int32 referenceType: type: string description: >- Uma string que indica o tipo de referência, que é "FISCAL_QUARTER" para este componente. default: FISCAL_QUARTER enum: - FISCAL_QUARTER second: type: integer description: Um número inteiro que representa os segundos dentro do minuto. format: int32 x-hubspot-sub-type-impl: true YearReference: title: YEAR required: - day - month - referenceType type: object properties: day: type: integer description: Um número inteiro que representa o dia do mês. format: int32 hour: type: integer description: Um número inteiro que representa a hora do dia. format: int32 millisecond: type: integer description: Um número inteiro que representa os milissegundos dentro do segundo. format: int32 minute: type: integer description: Um número inteiro que representa os minutos dentro da hora. format: int32 month: type: integer description: Um número inteiro que representa o mês do ano. format: int32 referenceType: type: string description: Uma string que indica o tipo de referência, que é 'YEAR' por padrão. default: YEAR enum: - YEAR second: type: integer description: Um número inteiro que representa os segundos dentro do minuto. format: int32 x-hubspot-sub-type-impl: true FiscalYear: title: FISCAL_YEAR required: - day - month - referenceType type: object properties: day: type: integer description: Um número inteiro que representa o componente de dia do ano fiscal. format: int32 hour: type: integer description: Um número inteiro que representa o componente de hora. format: int32 millisecond: type: integer description: >- Um número inteiro que representa o componente de milissegundos do tempo. format: int32 minute: type: integer description: Um número inteiro que representa o componente de minuto do horário. format: int32 month: type: integer description: Um número inteiro que representa o componente de mês do ano fiscal. format: int32 referenceType: type: string description: >- Uma string que representa o tipo de referência, que é "FISCAL_YEAR" por padrão. default: FISCAL_YEAR enum: - FISCAL_YEAR second: type: integer description: Um número inteiro que representa o componente de segundo do horário. format: int32 x-hubspot-sub-type-impl: true IndexOffset: type: object properties: days: type: integer description: >- Um número inteiro que representa o número de dias para o deslocamento. format: int32 hours: type: integer description: >- Um número inteiro que representa o número de horas para o deslocamento. format: int32 milliseconds: type: integer description: >- Um número inteiro que representa o número de milissegundos para o deslocamento. format: int32 minutes: type: integer description: >- Um número inteiro que representa o número de minutos para o deslocamento. format: int32 months: type: integer description: >- Um número inteiro que representa o número de meses para o deslocamento. format: int32 quarters: type: integer description: >- Um número inteiro que representa o número de trimestres para o deslocamento. format: int32 seconds: type: integer description: >- Um número inteiro que representa o número de segundos para o deslocamento. format: int32 weeks: type: integer description: Um número inteiro que representa o deslocamento em semanas. format: int32 years: type: integer description: >- Um número inteiro que representa o número de anos para o deslocamento. 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: analytics.behavioral_events.send: '' behavioral_events.event_definitions.read_write: '' ````