> ## 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. # Retrieve rules > Recupere as regras associadas a um pipeline específico na sua conta HubSpot. Este endpoint permite acessar as regras de validação de governança e as fases de aprovação para o pipeline especificado. É útil para entender as restrições e os processos de aprovação aplicados ao pipeline. > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/2026-09/crm-pipeline-governance-v2026-09.json GET /crm/pipelines-rules/2026-09/{objectTypeId}/{pipelineId} openapi: 3.0.1 info: title: CRM Pipeline Governance description: Basepom for all HubSpot Projects version: 2026-09 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: /crm/pipelines-rules/2026-09/{objectTypeId}/{pipelineId}: get: tags: - Basic summary: Recuperar regras description: >- Recupere as regras associadas a um pipeline específico na sua conta HubSpot. Este endpoint permite acessar as regras de validação de governança e as fases de aprovação para o pipeline especificado. É útil para entender as restrições e os processos de aprovação aplicados ao pipeline. operationId: get-/crm/pipelines-rules/2026-09/{objectTypeId}/{pipelineId} parameters: - name: objectTypeId in: path description: >- O identificador exclusivo do tipo de objeto para o qual as regras de pipeline estão sendo recuperadas. required: true style: simple explode: false schema: type: string - name: pipelineId in: path description: >- O identificador exclusivo do pipeline cujas regras estão sendo recuperadas. required: true style: simple explode: false schema: type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/PublicPipelineRules' default: $ref: '#/components/responses/Error' description: '' security: - oauth2: - crm.pipelines.governance.read components: schemas: PublicPipelineRules: required: - createdAt - governanceValidationRules - id - objectTypeId - pipelineId - updatedAt type: object properties: approvalStage: $ref: '#/components/schemas/PublicApprovalStageRule' createdAt: type: string description: A data e a hora em que a regra de pipeline foi criada. format: date-time governanceValidationRules: $ref: '#/components/schemas/PublicGovernanceValidationRules' id: type: string description: O identificador exclusivo da regra de pipeline. objectTypeId: type: string description: >- O identificador para o tipo de objeto ao qual a regra de pipeline está associada. pipelineId: type: string description: O identificador exclusivo do pipeline ao qual a regra se aplica. updatedAt: type: string description: >- A data e a hora em que a regra de pipeline foi atualizada pela última vez. format: date-time PublicApprovalStageRule: required: - approvalMode - approverUserIds - pipelineStageId type: object properties: approvalComment: type: string description: >- Uma string que permite um comentário ou observação opcional sobre o processo de aprovação. approvalMode: type: string description: >- Especifica o modo de aprovação necessário. Pode ser "ALL", que significa que todos os aprovadores devem aprovar, ou "ANY", que significa que qualquer um dos aprovadores pode aprovar. É uma string. enum: - ALL - ANY approverUserIds: type: array description: >- Uma matriz de IDs de usuário que representam os usuários designados como aprovadores para esta fase. Cada ID de usuário é uma string. items: type: string conditionalApprovalFilterBranch: description: >- Define as condições sob as quais a aprovação é necessária. Pode ser um dos vários tipos de ramificação de filtro, como PublicOrFilterBranch ou PublicAndFilterBranch, que determinam as condições lógicas para a aprovação. oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' pipelineStageId: type: string description: >- O identificador exclusivo para a fase do pipeline ao qual esta regra de aprovação se aplica. É uma string. PublicGovernanceValidationRules: required: - noBackwardsMovementRule - noSkippingStagesRule - objectCreationRule type: object properties: noBackwardsMovementRule: $ref: '#/components/schemas/PublicSequenceValidationRule' noSkippingStagesRule: $ref: '#/components/schemas/PublicSequenceValidationRule' objectCreationRule: $ref: '#/components/schemas/PublicObjectCreationRule' Error: required: - category - correlationId - message type: object properties: category: type: string description: Uma string que representa a categoria geral do erro. context: type: object additionalProperties: type: array items: type: string description: >- Um objeto que inclui contexto adicional sobre a condição de erro, com propriedades como matrizes de strings. example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- Uma string que identifica de forma exclusiva a solicitação para fins de rastreamento e depuração. format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: >- Uma matriz de objetos ErrorDetail que fornecem informações detalhadas sobre cada erro encontrado. items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: >- Um objeto que contém links relacionados, em que cada chave é uma string e o valor é uma string que representa um URL. message: type: string description: >- Uma string contendo uma mensagem legível por humanos que descreve o erro. example: An error occurred subCategory: type: string description: >- Uma string que fornece detalhes mais específicos sobre a categoria do 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 PublicOrFilterBranch: title: OR required: - filterBranchOperator - filterBranchType - filterBranches - filters type: object properties: filterBranchOperator: type: string description: Uma string que representa o operador usado no ramo do filtro. filterBranchType: type: string description: >- Uma string que especifica o tipo de ramificação de filtro, que é "OR' por padrão. default: OR enum: - OR filterBranches: type: array description: >- Uma matriz de ramificações de filtro que pode incluir vários tipos de ramificações de filtro, como "OR", "AND", "NOT_ALL", "NOT_ANY", "RESTRICTED", "UNIFIED_EVENTS" ou "ASSOCIATION". items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array description: >- Uma matriz de filtros que pode incluir diferentes tipos de filtros, como "PublicPropertyFilter", "PublicAssociationInListFilter", "PublicPageViewAnalyticsFilter" e outros. items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' x-hubspot-sub-type-impl: true PublicAndFilterBranch: title: AND required: - filterBranchOperator - filterBranchType - filterBranches - filters type: object properties: filterBranchOperator: type: string description: Uma string que representa o operador lógico usado no ramo do filtro. filterBranchType: type: string description: >- Uma string que indica o tipo de ramificação do filtro. O padrão é 'AND'. default: AND enum: - AND filterBranches: type: array description: >- Uma matriz de ramificações de filtro aninhadas, que podem incluir ramificações de filtro "OR", "AND", "NOT_ALL", "NOT_ANY", "RESTRICTED", "UNIFIED_EVENTS" e "ASSOCIATION". items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array description: >- Uma série de filtros que são aplicados dentro desta ramificação. Estes podem incluir vários tipos de filtros, como filtros de propriedade, filtros de evento e filtros de assinatura. items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' x-hubspot-sub-type-impl: true PublicNotAllFilterBranch: title: NOT_ALL required: - filterBranchOperator - filterBranchType - filterBranches - filters type: object properties: filterBranchOperator: type: string description: >- Uma string que representa o operador usado para combinar os ramos do filtro. filterBranchType: type: string description: >- Uma string que indica o tipo de ramificação de filtro, que é "NOT_ALL" para este componente. default: NOT_ALL enum: - NOT_ALL filterBranches: type: array description: >- Uma matriz de ramificações de filtro que pode incluir vários tipos de ramificações de filtro, como "OR", "AND", "NOT_ALL" etc. items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array description: >- Uma matriz de filtros que pode incluir vários tipos de filtros, como filtros de propriedade, filtros de associação e muito mais. items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' x-hubspot-sub-type-impl: true PublicNotAnyFilterBranch: title: NOT_ANY required: - filterBranchOperator - filterBranchType - filterBranches - filters type: object properties: filterBranchOperator: type: string description: >- Uma string que representa o operador lógico usado na ramificação de filtro. filterBranchType: type: string description: >- Uma string que indica o tipo de ramificação de filtro, que é "NOT_ANY" para este componente. default: NOT_ANY enum: - NOT_ANY filterBranches: type: array description: >- Uma matriz de ramificações de filtro aninhadas, cada uma das quais pode ser de vários tipos, incluindo "OR", "AND", "NOT_ALL", "NOT_ANY", "RESTRICTED", "UNIFIED_EVENTS" e "ASSOCIATION". items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array description: >- Uma matriz de filtros que pode incluir diferentes tipos, como filtros de propriedade, filtros de associação e vários filtros de análise. items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' x-hubspot-sub-type-impl: true PublicRestrictedFilterBranch: title: RESTRICTED required: - filterBranchOperator - filterBranchType - filterBranches - filters type: object properties: filterBranchOperator: type: string description: Uma string que representa o operador usado no ramo do filtro. filterBranchType: type: string description: >- Uma string que indica o tipo do ramo do filtro. O padrão é "RESTRICTED". default: RESTRICTED enum: - RESTRICTED filterBranches: type: array description: >- Um array de ramificações de filtro aninhadas. Cada item pode ser de vários tipos, incluindo "PublicOrFilterBranch", "PublicAndFilterBranch", "PublicNotAllFilterBranch", "PublicNotAnyFilterBranch", "PublicRestrictedFilterBranch", "PublicUnifiedEventsFilterBranch" ou "PublicAssociationFilterBranch". items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array description: >- Uma série de filtros aplicados nesta ramificação. Cada filtro pode ser de vários tipos, como "PublicPropertyFilter", "PublicAssociationInListFilter", "PublicPageViewAnalyticsFilter", "PublicCtaAnalyticsFilter", 'PublicEventAnalyticsFilter", "PublicFormSubmissionFilter", "PublicFormSubmissionOnPageFilter", "PublicIntegrationEventFilter", "PublicEmailSubscriptionFilter", "PublicCommunicationSubscriptionFilter", "PublicSurveyMonkeyFilter", "PublicSurveyMonkeyValueFilter", "PublicWebinarFilter", "PublicEmailEventFilter", "PublicPrivacyAnalyticsFilter", "PublicAdsSearchFilter", "PublicAdsTimeFilter", "PublicInListFilter", "PublicUnifiedEventsFilter" ou "PublicConstantFilter". items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' x-hubspot-sub-type-impl: true PublicUnifiedEventsFilterBranch: title: UNIFIED_EVENTS required: - eventTypeId - filterBranchOperator - filterBranchType - filterBranches - filters - operator type: object properties: coalescingRefineBy: description: >- Um critério de refinamento opcional que permite filtragem adicional com base na lógica de coalescência. Pode ser um dos vários esquemas de refinamento predefinidos. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' eventTypeId: type: string description: >- Uma string que representa o identificador exclusivo para o tipo de evento que estaramificação de filtro está segmentando. filterBranchOperator: type: string description: >- Uma string que especifica o operador usado para combinar várias ramificações de filtro dentro deste componente. filterBranchType: type: string description: >- Uma string que indica o tipo de ramificação de filtro, que é "UNIFIED_EVENTS" para este componente. default: UNIFIED_EVENTS enum: - UNIFIED_EVENTS filterBranches: type: array description: >- Uma matriz de ramificações de filtro aninhadas, cada uma das quais pode ser uma estrutura de filtro complexa envolvendo vários operadores lógicos. items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array description: >- Uma matriz de filtros que aplicam condições específicas aos eventos unificados. Cada filtro pode ser de vários tipos, como filtros de propriedade ou filtros de análise de eventos. items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' operator: type: string description: >- Uma string que especifica o operador lógico para a ramificação de filtro, com valores válidos incluindo "HAS_COMPLETED" e "HAS_NOT_COMPLETED". enum: - HAS_COMPLETED - HAS_NOT_COMPLETED pruningRefineBy: description: >- Um critério de refinamento opcional que permite filtragem adicional com base na lógica de remoção. Pode ser um dos vários esquemas de refinamento predefinidos. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicAssociationFilterBranch: title: ASSOCIATION required: - associationCategory - associationTypeId - filterBranchOperator - filterBranchType - filterBranches - filters - objectTypeId - operator type: object properties: associationCategory: type: string description: Uma string que indica a categoria da associação. associationTypeId: type: integer description: Um número inteiro que representa o ID do tipo de associação. format: int32 filterBranchOperator: type: string description: >- Uma string que representa o operador usado para combinar os ramos do filtro. filterBranchType: type: string description: >- Uma string que indica o tipo de ramificação de filtro, que é "ASSOCIATION" por padrão. default: ASSOCIATION enum: - ASSOCIATION filterBranches: type: array description: >- Uma matriz de ramificações de filtro que pode incluir vários tipos de ramificações, como OR, AND, NOT_ALL, NOT_ANY, RESTRICTED, UNIFIED_EVENTS e ASSOCIATION. items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array description: >- Uma matriz de filtros que pode incluir diferentes tipos de filtros, como filtros de propriedade, filtros de associação e diversos filtros de análise. items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' objectTypeId: type: string description: >- Uma string que representa o ID do tipo de objeto envolvido na associação. operator: type: string description: Uma string que representa o operador usado no ramo do filtro. x-hubspot-sub-type-impl: true PublicSequenceValidationRule: required: - enabledForAllStages - pipelineStageIds type: object properties: enabledForAllStages: type: boolean description: >- Um booleano que indica se a regra de validação está habilitada para todas as fases no pipeline. pipelineStageIds: type: array description: >- Uma matriz de strings que representa os IDs específicos das fases do pipeline para os quais a regra de validação se aplica. items: type: string PublicObjectCreationRule: required: - pipelineStageIds type: object properties: pipelineStageIds: type: array description: >- Uma matriz de strings que representa os IDs das fases do pipeline em que os objetos podem ser criados. items: type: string ErrorDetail: required: - message type: object properties: code: type: string description: >- O código de status associado ao detalhe do erro. Esta é uma propriedade de string. context: type: object additionalProperties: type: array items: type: string description: >- Contexto sobre a condição de erro, representado como um objeto com propriedades adicionais. Cada propriedade é uma matriz de strings que fornece mais detalhes. example: '{missingScopes=[scope1, scope2]}' in: type: string description: >- O nome do campo ou parâmetro no qual o erro foi encontrado. Esta é uma propriedade de string. message: type: string description: >- Uma mensagem legível descrevendo o erro, juntamente com as etapas de correção, quando apropriado. É uma propriedade de string obrigatória. subCategory: type: string description: >- Uma categoria específica que contém detalhes mais específicos sobre o erro. Esta é uma propriedade de string. 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. PublicPropertyFilter: title: PROPERTY required: - filterType - operation - property type: object properties: filterType: type: string description: >- Uma string que indica o tipo de filtro. O valor padrão é 'PROPRIEDADE'. default: PROPERTY enum: - PROPERTY operation: description: >- Define a operação a ser realizada na propriedade. Pode ser um dos vários tipos de operação, como booleano, número, string, data e muito mais, cada um com seu próprio comportamento específico. oneOf: - $ref: '#/components/schemas/PublicBoolPropertyOperation' - $ref: '#/components/schemas/PublicNumberPropertyOperation' - $ref: '#/components/schemas/PublicStringPropertyOperation' - $ref: '#/components/schemas/PublicDateTimePropertyOperation' - $ref: '#/components/schemas/PublicRangedDatePropertyOperation' - $ref: '#/components/schemas/PublicComparativePropertyUpdatedOperation' - $ref: '#/components/schemas/PublicComparativeDatePropertyOperation' - $ref: '#/components/schemas/PublicRollingDateRangePropertyOperation' - $ref: '#/components/schemas/PublicRollingPropertyUpdatedOperation' - $ref: '#/components/schemas/PublicEnumerationPropertyOperation' - $ref: '#/components/schemas/PublicAllPropertyTypesOperation' - $ref: '#/components/schemas/PublicRangedNumberPropertyOperation' - $ref: '#/components/schemas/PublicMultiStringPropertyOperation' - $ref: '#/components/schemas/PublicDatePropertyOperation' - $ref: '#/components/schemas/PublicCalendarDatePropertyOperation' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' - $ref: '#/components/schemas/PublicComparativeStringPropertyOperation' - $ref: '#/components/schemas/PublicComparativeNumberPropertyOperation' property: type: string description: Uma string que representa o nome da propriedade a ser filtrada. x-hubspot-sub-type-impl: true PublicAssociationInListFilter: title: ASSOCIATION required: - associationCategory - associationTypeId - coalescingRefineBy - filterType - listId - operator type: object properties: associationCategory: type: string description: Uma string que especifica a categoria da associação. associationTypeId: type: integer description: Um número inteiro que identifica o tipo de associação. format: int32 coalescingRefineBy: description: >- Um objeto que define os critérios para refinar o filtro. Pode ser de vários tipos, como PublicNumOccurrencesRefineBy ou PublicTimePointOperation. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' filterType: type: string description: >- Uma string que especifica o tipo de filtro. O valor padrão é "ASSOCIATION". default: ASSOCIATION enum: - ASSOCIATION listId: type: string description: Uma string que identifica a lista à qual o filtro é aplicado. operator: type: string description: Uma string que representa o operador usado no filtro. toObjectType: type: string description: >- Uma string que especifica o tipo de objeto ao qual a associação é feita. toObjectTypeId: type: string description: >- Uma string que especifica o ID do tipo de objeto ao qual a associação é feita. x-hubspot-sub-type-impl: true PublicPageViewAnalyticsFilter: title: PAGE_VIEW required: - filterType - operator - pageUrl type: object properties: coalescingRefineBy: description: >- Um critério de refinamento opcional que pode ser um de vários esquemas predefinidos, usado para refinar ainda mais os resultados do filtro. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' enableTracking: type: boolean description: >- Um booleano que indica se o rastreamento está ativado para este filtro. filterType: type: string description: >- Uma string que representa o tipo de filtro. O valor padrão é 'PAGE_VIEW'. default: PAGE_VIEW enum: - PAGE_VIEW operator: type: string description: Uma string que representa o operador usado no filtro. pageUrl: type: string description: Uma string que representa a URL da página a ser filtrada. pruningRefineBy: description: >- Um critério de refinamento opcional que pode ser um de vários esquemas predefinidos, usado para remover os resultados do filtro. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicCtaAnalyticsFilter: title: CTA required: - ctaName - filterType - operator type: object properties: coalescingRefineBy: description: >- Um critério de refinamento opcional que pode ser de vários tipos, incluindo ocorrências e comparações de data/hora. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' ctaName: type: string description: >- Uma string que representa o nome da call to action que está sendo filtrada. filterType: type: string description: Uma string que especifica o tipo de filtro, com valor padrão "CTA". default: CTA enum: - CTA operator: type: string description: Uma string que define a operação a ser aplicada no filtro. pruningRefineBy: description: >- Um critério de refinamento opcional usado para restringir dados, semelhante a coalescingRefineBy, com opções como ocorrências e comparações de data/hora. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicEventAnalyticsFilter: title: EVENT required: - eventId - filterType - operator type: object properties: coalescingRefineBy: description: >- Um critério de refinamento opcional que pode ser de vários tipos, como ocorrências ou comparações de data/hora, para refinar ainda mais os resultados do filtro. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' eventId: type: string description: >- Uma string que identifica de forma exclusiva o evento a ser filtrado. filterType: type: string description: >- Uma string que indica o tipo de filtro, que é sempre "EVENT" para este componente. default: EVENT enum: - EVENT operator: type: string description: Uma string que representa a operação ou condição aplicada no filtro. pruningRefineBy: description: >- Um critério de refinamento opcional, semelhante a coalescingRefineBy, usado para podar os resultados do filtro com base em condições específicas. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicFormSubmissionFilter: title: FORM_SUBMISSION required: - filterType - operator type: object properties: coalescingRefineBy: description: >- Um objeto usado para refinar o filtro ao agrupar critérios. Pode ser de vários tipos, como ocorrências ou refinamentos baseados em data/hora. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' filterType: type: string description: >- Uma string que especifica o tipo de filtro. O valor padrão é 'FORM_SUBMISSION'. default: FORM_SUBMISSION enum: - FORM_SUBMISSION formId: type: string description: Uma string que representa o identificador exclusivo do formulário. operator: type: string description: >- Uma string que especifica a operação a ser aplicada, com valores válidos sendo "FILLED_OUT" ou "NOT_FILLED_OUT". enum: - FILLED_OUT - NOT_FILLED_OUT pruningRefineBy: description: >- Um objeto usado para refinar o filtro ao remover critérios. Pode ser de vários tipos, como ocorrências ou refinamentos baseados em data/hora. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicFormSubmissionOnPageFilter: title: FORM_SUBMISSION_ON_PAGE required: - filterType - operator - pageId type: object properties: coalescingRefineBy: description: >- Critérios usados para refinar o filtro por coalescência, que podem incluir várias operações de data/hora. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' filterType: type: string description: >- O tipo de filtro que está sendo aplicado. O padrão é "FORM_SUBMISSION_ON_PAGE". default: FORM_SUBMISSION_ON_PAGE enum: - FORM_SUBMISSION_ON_PAGE formId: type: string description: O identificador exclusivo do formulário que está sendo filtrado. operator: type: string description: >- A operação a ser aplicada, que pode ser "FILLED_OUT" ou "NOT_FILLED_OUT". enum: - FILLED_OUT - NOT_FILLED_OUT pageId: type: string description: >- O identificador exclusivo da página em que o envio de formulário está sendo filtrado. pruningRefineBy: description: >- Critérios usados para refinar o filtro por remoção, que podem incluir várias operações de data/hora. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicIntegrationEventFilter: title: INTEGRATION_EVENT required: - eventTypeId - filterLines - filterType type: object properties: eventTypeId: type: integer description: >- Uma string que identifica de forma exclusiva o tipo de evento a ser filtrado. Esta propriedade é usada para especificar a qual tipo de evento o filtro se aplica. format: int32 filterLines: type: array description: >- Uma matriz de linhas de filtro que contêm os metadados para o filtro de evento. Cada item na matriz é uma especificação detalhada dos critérios usados para filtrar eventos. items: $ref: '#/components/schemas/PublicEventFilterMetadata' filterType: type: string description: >- Uma string que representa o tipo de filtro. É um campo obrigatório e geralmente tem um valor padrão específico para o tipo de filtro. default: INTEGRATION_EVENT enum: - INTEGRATION_EVENT x-hubspot-sub-type-impl: true PublicEmailSubscriptionFilter: title: EMAIL_SUBSCRIPTION required: - acceptedStatuses - filterType - subscriptionIds type: object properties: acceptedStatuses: type: array description: Uma matriz de strings que indicam os status aceitos para o filtro. items: type: string filterType: type: string description: >- Uma string que indica o tipo de filtro, que é 'EMAIL_SUBSCRIPTION' para este componente. default: EMAIL_SUBSCRIPTION enum: - EMAIL_SUBSCRIPTION subscriptionIds: type: array description: >- Uma matriz de strings que representam os IDs das assinaturas a serem filtradas. items: type: string subscriptionType: type: string description: Uma string que representa o tipo de assinatura. x-hubspot-sub-type-impl: true PublicCommunicationSubscriptionFilter: title: COMMUNICATION_SUBSCRIPTION required: - acceptedOptStates - channel - filterType - subscriptionIds - subscriptionType type: object properties: acceptedOptStates: type: array description: >- Uma matriz de strings que representam os estados de aceitação de opt-in para a assinatura. items: type: string businessUnitId: type: string description: >- Uma string que representa o ID da unidade de negócio associada à assinatura. channel: type: string description: Uma string que indica o canal de comunicação associado à assinatura. filterType: type: string description: >- Uma string que indica o tipo de filtro. O valor padrão é 'COMMUNICATION_SUBSCRIPTION'. default: COMMUNICATION_SUBSCRIPTION enum: - COMMUNICATION_SUBSCRIPTION subscriptionIds: type: array description: >- Uma matriz de strings que representam os IDs das assinaturas a serem filtradas. items: type: string subscriptionType: type: string description: Uma string que indica o tipo de assinatura. x-hubspot-sub-type-impl: true PublicSurveyMonkeyFilter: title: SURVEY_MONKEY required: - filterType - operator - surveyId type: object properties: filterType: type: string description: >- Uma string que especifica o tipo de filtro usado. O valor padrão é "SURVEY_MONKEY", que indica que este filtro é para dados do SurveyMonkey. default: SURVEY_MONKEY enum: - SURVEY_MONKEY operator: type: string description: >- Uma string que define a operação ou condição a ser aplicada ao filtrar os dados da pesquisa. surveyId: type: string description: >- Uma string que representa o identificador exclusivo da pesquisa do SurveyMonkey a ser filtrada. x-hubspot-sub-type-impl: true PublicSurveyMonkeyValueFilter: title: SURVEY_MONKEY_VALUE required: - filterType - operator - surveyId - surveyQuestion - valueComparison type: object properties: filterType: type: string description: >- Uma string que indica o tipo de filtro. O padrão é "SURVEY_MONKEY_VALUE". default: SURVEY_MONKEY_VALUE enum: - SURVEY_MONKEY_VALUE operator: type: string description: >- Uma string que especifica o operador usado no filtro, determinando como os dados da pesquisa são avaliados em relação aos critérios do filtro. surveyAnswerColId: type: string description: >- Uma string que representa o identificador da coluna da resposta da pesquisa, usado para filtrar respostas específicas. surveyAnswerRowId: type: string description: >- Uma string que representa o identificador da linha da resposta da pesquisa, usado para filtrar respostas específicas. surveyId: type: string description: >- Uma string que representa o identificador exclusivo da pesquisa do SurveyMonkey. surveyQuestion: type: string description: >- Uma string que especifica a pergunta na pesquisa para filtrar as respostas. valueComparison: description: >- Um objeto que define a operação para comparar valores de respostas de pesquisa. Pode ser de vários tipos, como operações de número, string ou data. oneOf: - $ref: '#/components/schemas/PublicBoolPropertyOperation' - $ref: '#/components/schemas/PublicNumberPropertyOperation' - $ref: '#/components/schemas/PublicStringPropertyOperation' - $ref: '#/components/schemas/PublicDateTimePropertyOperation' - $ref: '#/components/schemas/PublicRangedDatePropertyOperation' - $ref: '#/components/schemas/PublicComparativePropertyUpdatedOperation' - $ref: '#/components/schemas/PublicComparativeDatePropertyOperation' - $ref: '#/components/schemas/PublicRollingDateRangePropertyOperation' - $ref: '#/components/schemas/PublicRollingPropertyUpdatedOperation' - $ref: '#/components/schemas/PublicEnumerationPropertyOperation' - $ref: '#/components/schemas/PublicAllPropertyTypesOperation' - $ref: '#/components/schemas/PublicRangedNumberPropertyOperation' - $ref: '#/components/schemas/PublicMultiStringPropertyOperation' - $ref: '#/components/schemas/PublicDatePropertyOperation' - $ref: '#/components/schemas/PublicCalendarDatePropertyOperation' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' - $ref: '#/components/schemas/PublicComparativeStringPropertyOperation' - $ref: '#/components/schemas/PublicComparativeNumberPropertyOperation' x-hubspot-sub-type-impl: true PublicWebinarFilter: title: WEBINAR required: - filterType - operator type: object properties: filterType: type: string description: >- Uma string que especifica o tipo de filtro. O valor padrão é 'WEBINAR'. default: WEBINAR enum: - WEBINAR operator: type: string description: Uma string que representa o operador usado no filtro. webinarId: type: string description: >- Uma string que identifica de forma exclusiva o webinar a ser filtrado. x-hubspot-sub-type-impl: true PublicEmailEventFilter: title: EMAIL_EVENT required: - appId - emailId - filterType - level - operator type: object properties: appId: type: string description: >- Uma string que identifica o aplicativo associado ao evento de e-mail. clickUrl: type: string description: Uma string que representa o URL clicado no evento de e-mail. emailId: type: string description: >- Uma string que identifica de forma exclusiva o e-mail associado ao evento. filterType: type: string description: >- Uma string que especifica o tipo de filtro. O valor padrão é 'EMAIL_EVENT'. default: EMAIL_EVENT enum: - EMAIL_EVENT level: type: string description: Uma string que representa o nível do evento de e-mail. operator: type: string description: >- Uma string que define o tipo de operação ou evento para filtragem. Os valores válidos incluem "LINK_CLICKED", "MARKED_SPAM", "OPENED", "OPENED_BUT_LINK_NOT_CLICKED", "OPENED_BUT_NOT_REPLIED", "REPLIED", "UNSUBSCRIBED", "BOUNCED", "RECEIVED", "RECEIVED_BUT_NOT_OPENED", "SENT", "SENT_BUT_LINK_NOT_CLICKED" e "SENT_BUT_NOT_RECEIVED". enum: - BOUNCED - LINK_CLICKED - MARKED_SPAM - OPENED - OPENED_BUT_LINK_NOT_CLICKED - OPENED_BUT_NOT_REPLIED - RECEIVED - RECEIVED_BUT_NOT_OPENED - REPLIED - SENT - SENT_BUT_LINK_NOT_CLICKED - SENT_BUT_NOT_RECEIVED - UNSUBSCRIBED pruningRefineBy: description: >- Um objeto que especifica critérios adicionais para refinar o filtro, que pode ser de vários tipos, como 'PublicNumOccurrencesRefineBy', 'PublicSetOccurrencesRefineBy', 'PublicRelativeComparativeTimestampRefineBy', 'PublicRelativeRangedTimestampRefineBy', 'PublicAbsoluteComparativeTimestampRefineBy', 'PublicAbsoluteRangedTimestampRefineBy', 'PublicAllHistoryRefineBy', 'PublicTimePointOperation' ou 'PublicRangedTimeOperation'. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicPrivacyAnalyticsFilter: title: PRIVACY required: - filterType - operator - privacyName type: object properties: filterType: type: string description: >- Uma string que indica o tipo de filtro, que é "PRIVACY" para este componente. default: PRIVACY enum: - PRIVACY operator: type: string description: >- Uma string que especifica o operador a ser usado em conjunto com o privacyName para filtragem. privacyName: type: string description: >- Uma string que representa o nome da configuração de privacidade a ser usada no filtro. x-hubspot-sub-type-impl: true PublicAdsSearchFilter: title: ADS_SEARCH required: - adNetwork - entityType - filterType - operator - searchTermType - searchTerms type: object properties: adNetwork: type: string description: >- Uma string que identifica a rede de anúncios onde a pesquisa é realizada. entityType: type: string description: >- Uma string que representa o tipo de entidade que está sendo filtrada. filterType: type: string description: >- Uma string que indica o tipo de filtro que está sendo aplicado. O valor padrão é "ADS_SEARCH". default: ADS_SEARCH enum: - ADS_SEARCH operator: type: string description: Uma string que especifica a operação ou condição aplicada ao filtro. searchTermType: type: string description: >- Uma string que especifica o tipo de termo de pesquisa usado no filtro. searchTerms: type: array description: >- Uma matriz de strings contendo os termos usados para pesquisar na rede de anúncios. items: type: string x-hubspot-sub-type-impl: true PublicAdsTimeFilter: title: ADS_TIME required: - filterType - pruningRefineBy type: object properties: filterType: type: string description: >- Uma string que indica o tipo de filtro que está sendo aplicado. O valor padrão é "ADS_TIME". default: ADS_TIME enum: - ADS_TIME pruningRefineBy: description: >- Um objeto que define os critérios para refinar o filtro com base em atributos de tempo. Pode ser de vários tipos, como PublicNumOccurrencesRefineBy, PublicSetOccurrencesRefineBy ou vários tipos de refinamento de data/hora. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicInListFilter: title: IN_LIST required: - filterType - listId - operator type: object properties: filterType: type: string description: >- Uma string que especifica o tipo de filtro que está sendo aplicado. O valor padrão é "IN_LIST". default: IN_LIST enum: - IN_LIST listId: type: string description: >- Uma string que representa o identificador exclusivo da lista a ser usada no filtro. metadata: $ref: '#/components/schemas/PublicInListFilterMetadata' operator: type: string description: Uma string que define o operador usado no filtro. x-hubspot-sub-type-impl: true PublicUnifiedEventsFilter: title: UNIFIED_EVENTS required: - filterLines - filterType type: object properties: coalescingRefineBy: description: >- Um objeto que especifica critérios de refinamento para agrupar eventos. Pode ser um dos vários esquemas predefinidos, como PublicNumOccurrencesRefineBy ou PublicTimePointOperation. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' eventTypeId: type: string description: >- Uma string que representa o identificador exclusivo para o tipo de evento. filterLines: type: array description: >- Uma matriz de objetos, cada um em conformidade com o esquema PublicEventFilterMetadata, representando as linhas de filtro individuais que compõem o filtro de eventos unificado. items: $ref: '#/components/schemas/PublicEventFilterMetadata' filterType: type: string description: >- Uma string que indica o tipo de filtro. O valor padrão é 'UNIFIED_EVENTS'. default: UNIFIED_EVENTS enum: - UNIFIED_EVENTS pruningRefineBy: description: >- Um objeto que especifica critérios de refinamento para a remoção de eventos. Pode ser um dos vários esquemas predefinidos, como PublicNumOccurrencesRefineBy ou PublicTimePointOperation. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicConstantFilter: title: CONSTANT required: - filterType - shouldAccept type: object properties: filterType: type: string description: >- Uma string que indica o tipo de filtro. O padrão é "CONSTANT" e deve ser um dos tipos de filtro predefinidos. default: CONSTANT enum: - CONSTANT shouldAccept: type: boolean description: >- Um booleano que indica se o filtro deve aceitar os critérios que avalia. source: type: string description: >- Uma string que representa a origem ou o contexto de onde o filtro é aplicado. x-hubspot-sub-type-impl: true PublicNumOccurrencesRefineBy: title: NUM_OCCURRENCES required: - type type: object properties: maxOccurrences: type: integer description: >- Um número inteiro que especifica o número máximo de ocorrências permitidas. format: int32 minOccurrences: type: integer description: >- Um número inteiro que especifica o número mínimo de ocorrências necessárias. format: int32 type: type: string description: >- Uma string que indica o tipo de refinamento, que é "NUM_OCCURRENCES". default: NUM_OCCURRENCES enum: - NUM_OCCURRENCES x-hubspot-sub-type-impl: true PublicSetOccurrencesRefineBy: title: SET_OCCURRENCES required: - setType - type type: object properties: setType: type: string description: >- Uma string que especifica o tipo de conjunto para o refinamento de ocorrências. type: type: string description: >- Uma string que representa o tipo de refinamento. O valor padrão é 'SET_OCCURRENCES'. default: SET_OCCURRENCES enum: - SET_OCCURRENCES x-hubspot-sub-type-impl: true PublicRelativeComparativeTimestampRefineBy: title: RELATIVE_COMPARATIVE required: - comparison - timeOffset - type type: object properties: comparison: type: string description: Uma string que representa a operação de comparação a ser realizada. timeOffset: $ref: '#/components/schemas/PublicTimeOffset' type: type: string description: >- Uma string que indica o tipo de refinamento, que é 'RELATIVE_COMPARATIVE'. default: RELATIVE_COMPARATIVE enum: - RELATIVE_COMPARATIVE x-hubspot-sub-type-impl: true PublicRelativeRangedTimestampRefineBy: title: RELATIVE_RANGED required: - lowerBoundOffset - rangeType - type - upperBoundOffset type: object properties: lowerBoundOffset: $ref: '#/components/schemas/PublicTimeOffset' rangeType: type: string description: >- Uma string que indica o tipo de intervalo usado para o refinamento do data/hora. type: type: string description: >- Uma string que especifica o tipo de operação de refinamento, que é "RELATIVE_RANGED". default: RELATIVE_RANGED enum: - RELATIVE_RANGED upperBoundOffset: $ref: '#/components/schemas/PublicTimeOffset' x-hubspot-sub-type-impl: true PublicAbsoluteComparativeTimestampRefineBy: title: ABSOLUTE_COMPARATIVE required: - comparison - timestamp - type type: object properties: comparison: type: string description: >- Uma string que representa o tipo de comparação a ser feita com a data/hora. timestamp: type: integer description: >- Um número inteiro que representa o ponto específico no tempo a ser usado para a comparação, formatado como uma data/hora Unix em milissegundos. format: int64 type: type: string description: >- Uma string que indica o tipo de refinamento, que é 'ABSOLUTE_COMPARATIVE'. default: ABSOLUTE_COMPARATIVE enum: - ABSOLUTE_COMPARATIVE x-hubspot-sub-type-impl: true PublicAbsoluteRangedTimestampRefineBy: title: ABSOLUTE_RANGED required: - lowerTimestamp - rangeType - type - upperTimestamp type: object properties: lowerTimestamp: type: integer description: >- Um número inteiro que representa o limite inferior do intervalo de data/hora, especificado como uma data/hora Unix em milissegundos. format: int64 rangeType: type: string description: >- Uma string que representa o tipo de intervalo que está sendo definido. type: type: string description: >- Uma string que especifica o tipo de operação de refinamento. O valor padrão é "ABSOLUTE_RANGED". default: ABSOLUTE_RANGED enum: - ABSOLUTE_RANGED upperTimestamp: type: integer description: >- Um número inteiro que representa o limite superior do intervalo de data/hora, especificado como uma data/hora Unix em milissegundos. format: int64 x-hubspot-sub-type-impl: true PublicAllHistoryRefineBy: title: ALL_HISTORY required: - type type: object properties: type: type: string description: >- Uma string que representa o tipo de refinamento. O valor padrão e único válido é "ALL_HISTORY". default: ALL_HISTORY enum: - ALL_HISTORY x-hubspot-sub-type-impl: true PublicTimePointOperation: title: TIME_POINT required: - includeObjectsWithNoValueSet - operationType - operator - timePoint - type type: object properties: endpointBehavior: type: string description: >- Uma string que descreve o comportamento do endpoint no contexto da operação de ponto no tempo. 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, com padrão "TIME_POINT". default: TIME_POINT enum: - TIME_POINT operator: type: string description: >- Uma string que representa o operador usado na operação de ponto no tempo. propertyParser: type: string description: >- Uma string que especifica o analisador usado para a propriedade na operação. timePoint: description: >- Define o ponto específico no tempo para a operação. Pode ser de vários tipos, incluindo PublicDatePoint, PublicIndexedTimePoint ou PublicPropertyReferencedTime. oneOf: - $ref: '#/components/schemas/PublicDatePoint' - $ref: '#/components/schemas/PublicIndexedTimePoint' - $ref: '#/components/schemas/PublicPropertyReferencedTime' type: type: string description: Uma string que representa o tipo da operação de ponto no tempo. x-hubspot-sub-type-impl: true PublicRangedTimeOperation: title: TIME_RANGED required: - includeObjectsWithNoValueSet - lowerBoundTimePoint - operationType - operator - type - upperBoundTimePoint type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se os objetos sem valor definido devem ser incluídos. lowerBoundEndpointBehavior: type: string description: >- Uma string que especifica o comportamento do ponto final do limite inferior no intervalo de tempo. lowerBoundTimePoint: description: >- Um objeto que define o ponto de tempo do limite inferior do intervalo. Pode ser um ponto de data, um ponto de tempo indexado ou um tempo referenciado por propriedade. oneOf: - $ref: '#/components/schemas/PublicDatePoint' - $ref: '#/components/schemas/PublicIndexedTimePoint' - $ref: '#/components/schemas/PublicPropertyReferencedTime' operationType: type: string description: >- Uma string que especifica o tipo de operação que está sendo realizada. operator: type: string description: Uma string que define o operador usado na operação de tempo. propertyParser: type: string description: Uma string que indica o analisador de propriedade usado na operação. type: type: string description: >- Uma string que especifica o tipo de operação, com um valor padrão de "TIME_RANGED". default: TIME_RANGED enum: - TIME_RANGED upperBoundEndpointBehavior: type: string description: >- Uma string que especifica o comportamento do ponto final do limite superior no intervalo de tempo. upperBoundTimePoint: description: >- Um objeto que define o ponto de tempo limite superior do intervalo. Pode ser um ponto de data, um ponto de tempo indexado ou um tempo referenciado por propriedade. oneOf: - $ref: '#/components/schemas/PublicDatePoint' - $ref: '#/components/schemas/PublicIndexedTimePoint' - $ref: '#/components/schemas/PublicPropertyReferencedTime' x-hubspot-sub-type-impl: true PublicBoolPropertyOperation: title: BOOL required: - includeObjectsWithNoValueSet - operationType - operator - value type: object properties: 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 representa o tipo de operação. O valor padrão é 'BOOLEAN'. default: BOOL enum: - BOOL operator: type: string description: Uma string que indica o operador usado na operação booleana. value: type: boolean description: Um booleano que representa o valor a ser usado na operação. x-hubspot-sub-type-impl: true PublicNumberPropertyOperation: title: NUMBER required: - includeObjectsWithNoValueSet - operationType - operator - value type: object properties: 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. O valor padrão é 'NUMBER'. default: NUMBER enum: - NUMBER operator: type: string description: Uma string que representa o operador usado na operação. value: type: number description: Um número que representa o valor usado na operação. x-hubspot-sub-type-impl: true PublicStringPropertyOperation: title: STRING required: - includeObjectsWithNoValueSet - operationType - operator - value type: object properties: 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 é sempre 'STRING' para este componente. default: STRING enum: - STRING operator: type: string description: >- Uma string que representa o operador a ser usado na operação. Os operadores específicos não são detalhados na especificação. value: type: string description: Uma string que representa o valor a ser usado na operação. x-hubspot-sub-type-impl: true PublicDateTimePropertyOperation: title: DATETIME required: - includeObjectsWithNoValueSet - operationType - operator - requiresTimeZoneConversion - timestamp type: object properties: 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 é sempre 'DATETIME' para este componente. default: DATETIME enum: - DATETIME operator: type: string description: >- Uma string que representa o operador usado na operação de data e hora. requiresTimeZoneConversion: type: boolean description: >- Um booleano que especifica se a operação de data e hora requer conversão com base em fusos horários. timestamp: type: integer description: >- Um número inteiro que representa a data/hora envolvida na operação, formatado como um int64. format: int64 x-hubspot-sub-type-impl: true PublicRangedDatePropertyOperation: title: RANGED_DATE required: - includeObjectsWithNoValueSet - lowerBound - operationType - operator - requiresTimeZoneConversion - upperBound type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem valor definido devem ser incluídos. lowerBound: type: integer description: >- Um número inteiro que representa o limite inferior do intervalo de datas, no formato int64. format: int64 operationType: type: string description: >- Uma string que especifica o tipo de operação, com um valor padrão de "RANGED_DATE". default: RANGED_DATE enum: - RANGED_DATE operator: type: string description: Uma string que representa o operador usado na operação. requiresTimeZoneConversion: type: boolean description: >- Um booleano que indica se a operação exige conversão de fuso horário. upperBound: type: integer description: >- Um número inteiro que representa o limite superior do intervalo de datas, no formato int64. format: int64 x-hubspot-sub-type-impl: true PublicComparativePropertyUpdatedOperation: title: COMPARATIVE_PROPERTY_UPDATED required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator type: object properties: comparisonPropertyName: type: string description: Uma string que representa o nome da propriedade a ser comparada. defaultComparisonValue: type: string description: >- Um valor opcional usado como padrão para comparação se a propriedade de comparação não estiver definida. 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 especifica o tipo de operação. O valor padrão é 'COMPARATIVE_PROPERTY_UPDATED'. default: COMPARATIVE_PROPERTY_UPDATED enum: - COMPARATIVE_PROPERTY_UPDATED operator: type: string description: Uma string que define o operador usado na comparação. x-hubspot-sub-type-impl: true PublicComparativeDatePropertyOperation: title: COMPARATIVE_DATE required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator type: object properties: comparisonPropertyName: type: string description: >- Uma string que especifica o nome da propriedade a ser usada para comparação. defaultComparisonValue: type: string description: >- Uma string que representa o valor padrão a ser usado para comparação se nenhum outro 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 indica o tipo de operação. O valor padrão é 'COMPARATIVE_DATE'. default: COMPARATIVE_DATE enum: - COMPARATIVE_DATE operator: type: string description: Uma string que representa o operador usado para comparação. x-hubspot-sub-type-impl: true PublicRollingDateRangePropertyOperation: title: ROLLING_DATE_RANGE required: - includeObjectsWithNoValueSet - numberOfDays - operationType - operator - requiresTimeZoneConversion type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se devem ser incluídos objetos que sem valor definido para a propriedade em questão. numberOfDays: type: integer description: >- Um número inteiro que especifica o número de dias que definem o período de dias corridos. format: int32 operationType: type: string description: >- Uma string que indica o tipo de operação, que é 'ROLLING_DATE_RANGE' por padrão. default: ROLLING_DATE_RANGE enum: - ROLLING_DATE_RANGE operator: type: string description: Uma string que representa o operador usado na operação. requiresTimeZoneConversion: type: boolean description: >- Um booleano que indica se a operação requer conversão com base no fuso horário. x-hubspot-sub-type-impl: true PublicRollingPropertyUpdatedOperation: title: ROLLING_PROPERTY_UPDATED required: - includeObjectsWithNoValueSet - numberOfDays - operationType - operator type: object properties: 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 especifica o número de dias durante os quais a operação de atualização contínua é aplicada. format: int32 operationType: type: string description: >- Uma string que indica o tipo de operação. O valor padrão é 'ROLLING_PROPERTY_UPDATED'. default: ROLLING_PROPERTY_UPDATED enum: - ROLLING_PROPERTY_UPDATED operator: type: string description: Uma string que representa o operador usado na operação. x-hubspot-sub-type-impl: true PublicEnumerationPropertyOperation: title: ENUMERATION required: - includeObjectsWithNoValueSet - operationType - operator - values type: object properties: 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 representa o tipo de operação, com padrão "ENUMERATION". default: ENUMERATION enum: - ENUMERATION operator: type: string description: Uma string que indica o operador usado na operação. values: type: array description: >- Uma matriz de strings que representa os valores envolvidos na operação de enumeração. items: type: string x-hubspot-sub-type-impl: true PublicAllPropertyTypesOperation: title: ALL_PROPERTY required: - includeObjectsWithNoValueSet - operationType - operator type: object properties: 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. O valor padrão e único válido é 'ALL_PROPERTY_TYPES'. default: ALL_PROPERTY enum: - ALL_PROPERTY operator: type: string description: Uma string que representa o operador a ser usado na operação. x-hubspot-sub-type-impl: true PublicRangedNumberPropertyOperation: title: NUMBER_RANGED required: - includeObjectsWithNoValueSet - lowerBound - operationType - operator - upperBound type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se devem ser incluídos objetos que não têm um valor definido. lowerBound: type: integer description: Um número inteiro que representa o limite inferior do intervalo. format: int64 operationType: type: string description: >- Uma string que especifica o tipo de operação. O valor padrão é "RANGED_NUMBER". default: NUMBER_RANGED enum: - NUMBER_RANGED operator: type: string description: Uma string que representa o operador usado na operação. upperBound: type: integer description: Um número inteiro que representa o limite superior do intervalo. format: int64 x-hubspot-sub-type-impl: true PublicMultiStringPropertyOperation: title: MULTISTRING required: - includeObjectsWithNoValueSet - operationType - operator - values type: object properties: 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 é 'MULTISTRING' por padrão. default: MULTISTRING enum: - MULTISTRING operator: type: string description: Uma string que representa o operador usado para a operação. 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 PublicDatePropertyOperation: title: DATE required: - day - includeObjectsWithNoValueSet - month - operationType - operator - year type: object properties: day: type: integer description: >- Um número inteiro que representa o dia envolvido na operação de data. format: int32 includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem valor definido devem ser incluídos na operação. month: type: string description: Uma string que representa o mês envolvido na operação de data. operationType: type: string description: Uma string que indica o tipo de operação, que é sempre 'DATE'. default: DATE enum: - DATE operator: type: string description: Uma string que representa o operador usado na operação de data. year: type: integer description: >- Um número inteiro que representa o ano envolvido na operação de data. format: int32 x-hubspot-sub-type-impl: true PublicCalendarDatePropertyOperation: title: CALENDAR_DATE required: - includeObjectsWithNoValueSet - operationType - operator - timeUnit type: object properties: fiscalYearStart: type: string description: >- Uma string que indica o mês de início do ano fiscal. Os valores válidos incluem "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER" e "DECEMBER". enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER 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 é sempre 'CALENDAR_DATE'. default: CALENDAR_DATE enum: - CALENDAR_DATE operator: type: string description: Uma string que representa o operador usado na operação. timeUnit: type: string description: Uma string que especifica a unidade de tempo para a operação. timeUnitCount: type: integer description: >- Um número inteiro que especifica a contagem das unidades de tempo para a operação. format: int32 useFiscalYear: type: boolean description: Um booleano que indica se o ano fiscal deve ser usado. x-hubspot-sub-type-impl: true PublicComparativeStringPropertyOperation: title: COMPARATIVE_STRING required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator type: object properties: comparisonPropertyName: type: string description: Uma string que especifica o nome da propriedade a ser comparada. defaultComparisonValue: type: string description: >- O valor padrão a ser usado para comparação se o valor da propriedade não estiver definido, representado como uma string. 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 é 'COMPARATIVE_STRING' por padrão. default: COMPARATIVE_STRING enum: - COMPARATIVE_STRING operator: type: string description: >- O operador usado para a operação de comparação. É um valor de string. x-hubspot-sub-type-impl: true PublicComparativeNumberPropertyOperation: title: COMPARATIVE_NUMBER required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator type: object properties: comparisonPropertyName: type: string defaultComparisonValue: type: string includeObjectsWithNoValueSet: type: boolean operationType: type: string default: COMPARATIVE_NUMBER enum: - COMPARATIVE_NUMBER operator: type: string x-hubspot-sub-type-impl: true PublicEventFilterMetadata: required: - operation - property type: object properties: operation: description: >- Um objeto que define a operação a ser realizada na propriedade especificada. Essa operação pode ser de vários tipos, como operações booleanas, numéricas, de string ou de data, entre outras. oneOf: - $ref: '#/components/schemas/PublicBoolPropertyOperation' - $ref: '#/components/schemas/PublicNumberPropertyOperation' - $ref: '#/components/schemas/PublicStringPropertyOperation' - $ref: '#/components/schemas/PublicDateTimePropertyOperation' - $ref: '#/components/schemas/PublicRangedDatePropertyOperation' - $ref: '#/components/schemas/PublicComparativePropertyUpdatedOperation' - $ref: '#/components/schemas/PublicComparativeDatePropertyOperation' - $ref: '#/components/schemas/PublicRollingDateRangePropertyOperation' - $ref: '#/components/schemas/PublicRollingPropertyUpdatedOperation' - $ref: '#/components/schemas/PublicEnumerationPropertyOperation' - $ref: '#/components/schemas/PublicAllPropertyTypesOperation' - $ref: '#/components/schemas/PublicRangedNumberPropertyOperation' - $ref: '#/components/schemas/PublicMultiStringPropertyOperation' - $ref: '#/components/schemas/PublicDatePropertyOperation' - $ref: '#/components/schemas/PublicCalendarDatePropertyOperation' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' - $ref: '#/components/schemas/PublicComparativeStringPropertyOperation' - $ref: '#/components/schemas/PublicComparativeNumberPropertyOperation' property: type: string description: >- Uma string que representa a propriedade específica do evento que o filtro está segmentando. PublicInListFilterMetadata: required: - id - inListType type: object properties: id: type: string description: >- O identificador exclusivo da lista. É uma string que especifica a qual lista o filtro está associado. inListType: type: string description: >- Uma string que representa o tipo de lista usado no filtro. Esta propriedade define o contexto ou a categoria da lista referenciada. PublicTimeOffset: required: - amount - offsetDirection - timeUnit type: object properties: amount: type: integer description: >- Um número inteiro que especifica 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 "BEFORE" e "AFTER". timeUnit: type: string description: >- Uma string que representa a unidade de tempo para o deslocamento, como "DAYS", "HOURS", "MINUTES" etc. PublicDatePoint: title: DATE required: - day - month - timeType - year - zoneId type: object properties: day: type: integer description: Um número inteiro que representa o componente do dia da data. format: int32 hour: type: integer description: Um número inteiro que representa o componente de hora do horário. format: int32 millisecond: type: integer description: >- Um número inteiro que representa o componente de milissegundos do horário. 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 do 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. default: DATE enum: - DATE timezoneSource: type: string description: Uma string que especifica a origem das informações do fuso horário. 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 PublicIndexedTimePoint: title: INDEXED required: - indexReference - timeType - zoneId type: object properties: indexReference: description: >- Um ponto de referência pelo qual indexar o tempo, que pode ser uma das várias referências de tempo predefinidas, como "NOW", "TODAY", "WEEK" etc. oneOf: - $ref: '#/components/schemas/PublicNowReference' - $ref: '#/components/schemas/PublicTodayReference' - $ref: '#/components/schemas/PublicWeekReference' - $ref: '#/components/schemas/PublicFiscalQuarterReference' - $ref: '#/components/schemas/PublicFiscalYearReference' - $ref: '#/components/schemas/PublicYearReference' - $ref: '#/components/schemas/PublicQuarterReference' - $ref: '#/components/schemas/PublicMonthReference' offset: $ref: '#/components/schemas/PublicIndexOffset' timeType: type: string description: >- Uma string que representa o tipo de ponto no tempo, que é sempre 'INDEXED'. default: INDEXED enum: - INDEXED timezoneSource: type: string description: Uma string que indica a origem das informações do fuso horário. zoneId: type: string description: Uma string que representa o identificador do fuso horário. x-hubspot-sub-type-impl: true PublicPropertyReferencedTime: title: PROPERTY_REFERENCED required: - property - referenceType - timeType - zoneId type: object properties: property: type: string description: >- Uma string que indica a propriedade usada como referência para a operação de tempo. referenceType: type: string description: Uma string que indica o tipo de referência usado para a propriedade. timeType: type: string description: >- Uma string que indica o tipo de referência de tempo, que é "PROPERTY_REFERENCED" por padrão. default: PROPERTY_REFERENCED enum: - PROPERTY_REFERENCED timezoneSource: type: string description: Uma string que representa a origem das informações do fuso horário. zoneId: type: string description: Uma string que especifica o identificador do fuso horário. x-hubspot-sub-type-impl: true PublicNowReference: 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 PublicTodayReference: 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 o minuto dentro da hora. format: int32 referenceType: type: string description: >- Uma string que indica o tipo de referência, que é "TODAY" por padrão. 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 PublicWeekReference: 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", "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 o minuto 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 PublicFiscalQuarterReference: 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 dentro do trimestre fiscal. 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 o minuto dentro da hora. format: int32 month: type: integer description: Um número inteiro que representa o mês do trimestre fiscal. format: int32 referenceType: type: string description: >- Uma string que indica o tipo de referência, que é "FISCAL_QUARTER" por padrão. 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 PublicFiscalYearReference: title: FISCAL_YEAR required: - day - month - referenceType 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 referenceType: type: string description: >- Uma string que especifica 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 PublicYearReference: 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 o minuto 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 PublicQuarterReference: 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' para este componente. 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 PublicMonthReference: 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 os milissegundos dentro do segundo. format: int32 minute: type: integer description: Um número inteiro que representa o minuto dentro 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 os segundos dentro do minuto. format: int32 x-hubspot-sub-type-impl: true PublicIndexOffset: 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 número de semanas para o deslocamento. 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: crm.pipelines.approval.read: '' crm.pipelines.governance.read: '' crm.pipelines.governance.write: '' crm.pipelines.stage_permissions.read: '' crm.pipelines.stage_permissions.write: '' ````