> ## Documentation Index > Fetch the complete documentation index at: https://developers.hubspot.fr/docs/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve rules > Récupérez les règles associées à un pipeline spécifique dans votre compte HubSpot. Ce point de terminaison vous permet d'accéder aux règles de validation de la gouvernance et aux étapes d'approbation pour le pipeline spécifié. Il est utile pour comprendre les contraintes et les processus d'approbation appliqués au pipeline. export const ScopesList = ({scopes = [], description = "Cette API requiert l'une des portées suivantes :"}) => { if (!scopes || scopes.length === 0) { return null; } const sortedScopes = scopes.sort((a, b) => a.localeCompare(b)); return
{description}
{sortedScopes.map((scope, index) =>
{scope}
)}
; }; export const SupportedProducts = ({marketing, sales, service, cms, marketingLevel, salesLevel, serviceLevel, cmsLevel}) => { const translations = { header: "Produits pris en charge", description: "Exige l'un des produits suivants ou un produit supérieur.", productNames: { marketing: "Marketing Hub", sales: "Sales Hub", service: "Service Hub", cms: "Content Hub" }, tiers: { free: "Gratuit", starter: "Starter", professional: "Pro", enterprise: "Entreprise" } }; const translateTier = tier => { if (!tier) return ''; const lowerTier = tier.toLowerCase(); return translations.tiers[lowerTier] || tier; }; const products = [{ name: marketing ? translations.productNames.marketing : '', level: translateTier(marketingLevel), icon: "https://mintlify-assets.b-cdn.net/Icons/marketing-bolt.svg", alt: "Marketing Hub" }, { name: sales ? translations.productNames.sales : '', level: translateTier(salesLevel), icon: "https://mintlify-assets.b-cdn.net/Icons/sales-star.svg", alt: "Sales Hub" }, { name: service ? translations.productNames.service : '', level: translateTier(serviceLevel), icon: "https://mintlify-assets.b-cdn.net/Icons/service-heart.svg", alt: "Service Hub" }, { name: cms ? translations.productNames.cms : '', level: translateTier(cmsLevel), icon: "https://mintlify-assets.b-cdn.net/Icons/content-play.svg", alt: "Content Hub" }].filter(product => product.name && product.level); if (products.length === 0) return null; return
{translations.description}
{products.map((product, index) =>
{product.alt} {product.name} - {product.level}
)}
; }; ## 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: Récupérer les règles description: >- Récupérez les règles associées à un pipeline spécifique dans votre compte HubSpot. Ce point de terminaison vous permet d'accéder aux règles de validation de la gouvernance et aux étapes d'approbation pour le pipeline spécifié. Il est utile pour comprendre les contraintes et les processus d'approbation appliqués au pipeline. operationId: get-/crm/pipelines-rules/2026-09/{objectTypeId}/{pipelineId} parameters: - name: objectTypeId in: path description: >- L'identifiant unique du type d'objet pour lequel les règles de pipeline sont récupérées. required: true style: simple explode: false schema: type: string - name: pipelineId in: path description: L'identifiant unique du pipeline dont les règles sont récupérées. 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: La date et l'heure de création de la règle de pipeline. format: date-time governanceValidationRules: $ref: '#/components/schemas/PublicGovernanceValidationRules' id: type: string description: L'identifiant unique de la règle de pipeline. objectTypeId: type: string description: >- L'identifiant du type d'objet auquel la règle de pipeline est associée. pipelineId: type: string description: L'identifiant unique du pipeline auquel la règle s'applique. updatedAt: type: string description: >- La date et l'heure de la dernière mise à jour de la règle de pipeline. format: date-time PublicApprovalStageRule: required: - approvalMode - approverUserIds - pipelineStageId type: object properties: approvalComment: type: string description: >- Une chaîne qui permet d'ajouter un commentaire ou une note facultative concernant le processus d'approbation. approvalMode: type: string description: "Indique le mode d'approbation requis. Il peut être soit «\_ALL\_», ce qui signifie que tous les approbateurs doivent approuver, soit «\_ANY\_», ce qui signifie que n'importe quel approbateur peut approuver. Il s'agit d'une chaîne." enum: - ALL - ANY approverUserIds: type: array description: >- Un tableau d'ID utilisateur représentant les utilisateurs désignés comme approbateurs pour cette étape. Chaque ID utilisateur est une chaîne. items: type: string conditionalApprovalFilterBranch: description: >- Définit les conditions dans lesquelles l'approbation est requise. Il peut s'agir de l'un des nombreux types de branches de filtre, tels que PublicOrFilterBranch ou PublicAndFilterBranch, qui déterminent les conditions logiques d'approbation. 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: >- L'identifiant unique de l'étape du pipeline à laquelle cette règle d'approbation s'applique. Il s'agit d'une chaîne de caractères. 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: Une chaîne représentant la catégorie générale de l'erreur. context: type: object additionalProperties: type: array items: type: string description: >- Un objet contenant un contexte additionnel sur la condition d'erreur, avec des propriétés sous forme de tableaux de chaînes de caractères. example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- Une chaîne qui identifie de manière unique la requête à des fins de suivi et de débogage. format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: >- Un tableau d'objets ErrorDetail qui fournissent des informations détaillées sur chaque erreur rencontrée. items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: >- Un objet contenant des liens connexes, où chaque clé est une chaîne de caractères et la valeur est une chaîne de caractères représentant une URL. message: type: string description: Message lisible par l'être humain décrivant l'erreur. example: An error occurred subCategory: type: string description: >- Une chaîne fournissant des détails plus spécifiques sur la catégorie d'erreur. description: >- Représente une réponse d'erreur renvoyée par l'API lorsqu'une opération échoue. Ce composant est utilisé dans divers points de terminaison pour fournir des informations détaillées sur l'erreur rencontrée. 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: >- Une chaîne représentant l'opérateur utilisé dans la branche de filtre. filterBranchType: type: string description: "Une chaîne qui spécifie le type de branche de filtre, qui est «\_OR\_» par défaut." default: OR enum: - OR filterBranches: type: array description: "Un tableau de branches de filtre pouvant inclure différents types de branches de filtre tels que «\_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: "Un tableau de filtres pouvant inclure différents types de filtres tels que «\_PublicPropertyFilter\_», «\_PublicAssociationInListFilter\_», «\_PublicPageViewAnalyticsFilter\_», et autres." 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: >- Une chaîne représentant l'opérateur logique utilisé dans la branche de filtre. filterBranchType: type: string description: "Une chaîne indiquant le type de branche de filtre. La valeur par défaut est «\_AND\_»." default: AND enum: - AND filterBranches: type: array description: "Un tableau de branches de filtre imbriquées, qui peuvent inclure les branches de filtre «\_OR\_», «\_AND\_», «\_NOT_ALL\_», «\_NOT_ANY\_», «\_RESTRICTED\_», «\_UNIFIED_EVENTS\_» et «\_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: >- Un ensemble de filtres qui sont appliqués au sein de cette branche. Ceux-ci peuvent inclure divers types de filtres tels que les filtres de propriété, les filtres d'événement et les filtres d'abonnement. 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: >- Une chaîne représentant l'opérateur utilisé pour combiner les branches de filtre. filterBranchType: type: string description: >- Une chaîne indiquant le type de branche de filtre, qui est « NOT_ALL » pour ce composant. default: NOT_ALL enum: - NOT_ALL filterBranches: type: array description: "Un tableau de branches de filtre pouvant inclure différents types de branches de filtre tels que «\_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: >- Un tableau de filtres pouvant inclure divers types de filtres, tels que des filtres de propriété, des filtres d'association, et plus encore. 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: >- Une chaîne représentant l'opérateur logique utilisé dans la branche de filtre. filterBranchType: type: string description: >- Une chaîne indiquant le type de branche de filtre, qui est « NOT_ANY » pour ce composant. default: NOT_ANY enum: - NOT_ANY filterBranches: type: array description: "Un tableau de branches de filtre imbriquées, chacune pouvant être de différents types, notamment «\_OR\_», «\_AND\_», «\_NOT_ALL\_», «\_NOT_ANY\_», «\_RESTRICTED\_», «\_UNIFIED_EVENTS\_» et «\_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: >- Un ensemble de filtres pouvant inclure différents types tels que des filtres de propriété, des filtres d'association et divers filtres analytics. 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: >- Une chaîne représentant l'opérateur utilisé dans la branche de filtre. filterBranchType: type: string description: "Une chaîne indiquant le type de la branche de filtre. La valeur par défaut est «\_RESTRICTED\_»." default: RESTRICTED enum: - RESTRICTED filterBranches: type: array description: "Un tableau de branches de filtre imbriquées. Chaque élément peut appartenir à l'un de ces différents types, notamment «\_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: "Un ensemble de filtres appliqués au sein de cette branche. Chaque filtre peut appartenir à l'un de ces différents types, tels que «\_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: >- Un critère d'affinement facultatif qui permet un filtrage supplémentaire basé sur une logique de fusion. Il peut s'agir de l'un des nombreux schémas d'affinement prédéfinis. 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: >- Une chaîne représentant l'identifiant unique du type d'événement ciblé par cette branche de filtre. filterBranchOperator: type: string description: >- Une chaîne qui spécifie l'opérateur utilisé pour combiner plusieurs branches de filtre au sein de ce composant. filterBranchType: type: string description: "Une chaîne indiquant le type de branche de filtre, qui est «\_UNIFIED_EVENTS\_» pour ce composant." default: UNIFIED_EVENTS enum: - UNIFIED_EVENTS filterBranches: type: array description: >- Un tableau de branches de filtre imbriquées, chacune pouvant être une structure de filtre complexe impliquant divers opérateurs logiques. 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: >- Un ensemble de filtres qui appliquent des conditions spécifiques aux événements unifiés. Chaque filtre peut être de plusieurs types, tels que des filtres de propriété ou des filtres d'analyse d'événements. 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: "Une chaîne qui spécifie l'opérateur logique pour la branche de filtre, avec des valeurs valides incluant «\_HAS_COMPLETED\_» et «\_HAS_NOT_COMPLETED\_»." enum: - HAS_COMPLETED - HAS_NOT_COMPLETED pruningRefineBy: description: >- Un critère d'affinement facultatif qui permet un filtrage supplémentaire basé sur la logique d'élagage. Il peut s'agir de l'un des nombreux schémas d'affinement prédéfinis. 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: Une chaîne indiquant la catégorie de l'association. associationTypeId: type: integer description: Un entier représentant l'ID du type d'association. format: int32 filterBranchOperator: type: string description: >- Une chaîne représentant l'opérateur utilisé pour combiner les branches de filtre. filterBranchType: type: string description: "Une chaîne indiquant le type de branche de filtre, qui est «\_ASSOCIATION\_» par défaut." default: ASSOCIATION enum: - ASSOCIATION filterBranches: type: array description: >- Un tableau de branches de filtre pouvant inclure différents types de branches tels que OR, AND, NOT_ALL, NOT_ANY, RESTRICTED, UNIFIED_EVENTS et 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: >- Un tableau de filtres pouvant inclure différents types de filtres tels que les filtres de propriété, les filtres d'association et divers filtres analytics. 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: >- Une chaîne représentant l'ID du type d'objet impliqué dans l'association. operator: type: string description: >- Une chaîne représentant l'opérateur utilisé dans la branche de filtre. x-hubspot-sub-type-impl: true PublicSequenceValidationRule: required: - enabledForAllStages - pipelineStageIds type: object properties: enabledForAllStages: type: boolean description: >- Un booléen indiquant si la règle de validation est activée pour toutes les étapes du pipeline. pipelineStageIds: type: array description: >- Un tableau de chaînes représentant les ID d'étapes de pipeline spécifiques pour lesquelles la règle de validation est applicable. items: type: string PublicObjectCreationRule: required: - pipelineStageIds type: object properties: pipelineStageIds: type: array description: >- Un tableau de chaînes représentant les identifiants des étapes de pipeline où les objets peuvent être créés. items: type: string ErrorDetail: required: - message type: object properties: code: type: string description: >- Le code de statut associé au détail de l'erreur. Il s'agit d'une propriété de chaîne. context: type: object additionalProperties: type: array items: type: string description: >- Contexte de la condition d'erreur, représenté comme un objet avec des propriétés supplémentaires. Chaque propriété est un tableau de chaînes fournissant des détails supplémentaires. example: '{missingScopes=[scope1, scope2]}' in: type: string description: >- Le nom du champ ou du paramètre dans lequel l'erreur a été trouvée. Il s'agit d'une propriété de chaîne. message: type: string description: >- Un message lisible par l'utilisateur décrivant l'erreur, accompagné, le cas échéant, des étapes de correction. Il s'agit d'une propriété de chaîne obligatoire. subCategory: type: string description: >- Une catégorie spécifique qui contient des détails plus précis sur l'erreur. Il s'agit d'une propriété de chaîne. description: >- Représente des informations détaillées sur une erreur survenue dans l'API. Ce composant est utilisé pour fournir un contexte et des spécificités supplémentaires sur les erreurs, généralement dans le cadre d'une réponse d'erreur. PublicPropertyFilter: title: PROPERTY required: - filterType - operation - property type: object properties: filterType: type: string description: >- Une chaîne indiquant le type de filtre. La valeur par défaut est « PROPRIÉTÉ ». default: PROPERTY enum: - PROPERTY operation: description: >- Définit l'opération à effectuer sur la propriété. Il peut s'agir de plusieurs types d'opérations, telles que booléen, nombre, chaîne de caractères, date, et plus encore, chacune avec son propre comportement spécifique. 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: Une chaîne représentant le nom de la propriété à filtrer. x-hubspot-sub-type-impl: true PublicAssociationInListFilter: title: ASSOCIATION required: - associationCategory - associationTypeId - coalescingRefineBy - filterType - listId - operator type: object properties: associationCategory: type: string description: Une chaîne qui spécifie la catégorie de l'association. associationTypeId: type: integer description: Un entier qui identifie le type d'association. format: int32 coalescingRefineBy: description: >- Un objet qui définit les critères d'affinement du filtre. Il peut être de plusieurs types, tels que 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: >- Une chaîne qui spécifie le type de filtre. La valeur par défaut est « ASSOCIATION ». default: ASSOCIATION enum: - ASSOCIATION listId: type: string description: Une chaîne qui identifie la liste à laquelle le filtre est appliqué. operator: type: string description: Une chaîne qui représente l'opérateur utilisé dans le filtre. toObjectType: type: string description: >- Une chaîne qui spécifie le type d'objet auquel l'association est faite. toObjectTypeId: type: string description: >- Une chaîne qui spécifie l'ID de type de l'objet auquel l'association est faite. x-hubspot-sub-type-impl: true PublicPageViewAnalyticsFilter: title: PAGE_VIEW required: - filterType - operator - pageUrl type: object properties: coalescingRefineBy: description: >- Un critère d'affinement facultatif qui peut être l'un des nombreux schémas prédéfinis, utilisé pour affiner davantage les résultats du filtre. 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: Un booléen indiquant si le suivi est activé pour ce filtre. filterType: type: string description: >- Une chaîne représentant le type de filtre. La valeur par défaut est « PAGE_VIEW ». default: PAGE_VIEW enum: - PAGE_VIEW operator: type: string description: Une chaîne représentant l'opérateur utilisé dans le filtre. pageUrl: type: string description: Une chaîne représentant l'URL de la page à filtrer. pruningRefineBy: description: >- Un critère d'affinement facultatif qui peut être l'un des nombreux schémas prédéfinis, utilisé pour élaguer les résultats du filtre. 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: >- Un critère d'affinement facultatif qui peut être de plusieurs types, y compris les occurrences et les comparaisons d'horodatage. 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: Chaîne de caractères représentant le nom du Call-To-Action filtré. filterType: type: string description: "Une chaîne de caractères qui spécifie le type de filtre, par défaut «\_CTA\_»." default: CTA enum: - CTA operator: type: string description: Une chaîne qui définit l'opération à appliquer dans le filtre. pruningRefineBy: description: >- Un critère d'affinement facultatif utilisé pour affiner les données, similaire à coalescingRefineBy, avec des options telles que les occurrences et les comparaisons d'horodatage. 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: >- Un critère d'affinement facultatif qui peut être de plusieurs types, tels que des occurrences ou des comparaisons d'horodatage, pour affiner davantage les résultats du filtre. 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: Une chaîne qui identifie de manière unique l'événement à filtrer. filterType: type: string description: "Une chaîne indiquant le type de filtre, qui est toujours «\_EVENT\_» pour ce composant." default: EVENT enum: - EVENT operator: type: string description: >- Une chaîne représentant l'opération ou la condition appliquée dans le filtre. pruningRefineBy: description: >- Un critère d'affinement facultatif similaire à coalescingRefineBy, utilisé pour élaguer les résultats du filtre en fonction de conditions spécifiques. 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: >- Un objet utilisé pour affiner le filtre en regroupant des critères. Il peut être de plusieurs types, tels que des occurrences ou des affinements basés sur l'horodatage. 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: >- Une chaîne qui spécifie le type de filtre. La valeur par défaut est « FORM_SUBMISSION ». default: FORM_SUBMISSION enum: - FORM_SUBMISSION formId: type: string description: Une chaîne représentant l'identifiant unique du formulaire. operator: type: string description: "Une chaîne de caractères qui spécifie l'opération à appliquer, avec les valeurs valides étant «\_FILLED_OUT\_» ou «\_NOT_FILLED_OUT\_»." enum: - FILLED_OUT - NOT_FILLED_OUT pruningRefineBy: description: >- Un objet utilisé pour affiner le filtre en élaguant les critères. Il peut être de plusieurs types, tels que des occurrences ou des affinements basés sur l'horodatage. 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ères utilisés pour affiner le filtre par fusion, pouvant inclure diverses opérations d'horodatage. 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: "Le type de filtre appliqué. La valeur par défaut est «\_FORM_SUBMISSION_ON_PAGE\_»." default: FORM_SUBMISSION_ON_PAGE enum: - FORM_SUBMISSION_ON_PAGE formId: type: string description: L'identifiant unique du formulaire filtré. operator: type: string description: "L'opération à appliquer, qui peut être «\_REMPLI\_» ou «\_NON_REMPLI\_»." enum: - FILLED_OUT - NOT_FILLED_OUT pageId: type: string description: >- L'identifiant unique de la page où la soumission de formulaire est filtrée. pruningRefineBy: description: >- Critères utilisés pour affiner le filtre par élagage, pouvant inclure diverses opérations d'horodatage. 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: >- Une chaîne qui identifie de manière unique le type d'événement à filtrer. Cette propriété est utilisée pour spécifier le type d'événement auquel le filtre s'applique. format: int32 filterLines: type: array description: >- Un tableau de lignes de filtre qui contiennent les métadonnées du filtre d'événement. Chaque élément du tableau est une spécification détaillée des critères utilisés pour filtrer les événements. items: $ref: '#/components/schemas/PublicEventFilterMetadata' filterType: type: string description: >- Une chaîne de caractères représentant le type de filtre. Il s'agit d'un champ obligatoire qui a généralement une valeur par défaut spécifique au type de filtre. 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: >- Un tableau de chaînes de caractères indiquant les statuts acceptés pour le filtre. items: type: string filterType: type: string description: >- Une chaîne indiquant le type de filtre, qui est « EMAIL_SUBSCRIPTION » pour ce composant. default: EMAIL_SUBSCRIPTION enum: - EMAIL_SUBSCRIPTION subscriptionIds: type: array description: >- Un tableau de chaînes de caractères représentant les identifiants des abonnements à filtrer. items: type: string subscriptionType: type: string description: Une chaîne représentant le type d'abonnement. x-hubspot-sub-type-impl: true PublicCommunicationSubscriptionFilter: title: COMMUNICATION_SUBSCRIPTION required: - acceptedOptStates - channel - filterType - subscriptionIds - subscriptionType type: object properties: acceptedOptStates: type: array description: >- Un tableau de chaînes de caractères représentant les états d'opt-in acceptés pour l'abonnement. items: type: string businessUnitId: type: string description: >- Une chaîne représentant l'ID de l'unité commerciale associée à l'abonnement. channel: type: string description: >- Une chaîne indiquant le canal de communication associé à l'abonnement. filterType: type: string description: "Une chaîne de caractères qui indique le type de filtre. La valeur par défaut est «\_COMMUNICATION_SUBSCRIPTION\_»." default: COMMUNICATION_SUBSCRIPTION enum: - COMMUNICATION_SUBSCRIPTION subscriptionIds: type: array description: >- Un tableau de chaînes représentant les identifiants des abonnements à filtrer. items: type: string subscriptionType: type: string description: Une chaîne indiquant le type d'abonnement. x-hubspot-sub-type-impl: true PublicSurveyMonkeyFilter: title: SURVEY_MONKEY required: - filterType - operator - surveyId type: object properties: filterType: type: string description: "Une chaîne qui spécifie le type de filtre utilisé. La valeur par défaut est «\_SURVEY_MONKEY\_», indiquant que ce filtre est destiné aux données SurveyMonkey." default: SURVEY_MONKEY enum: - SURVEY_MONKEY operator: type: string description: >- Une chaîne qui définit l'opération ou la condition à appliquer lors du filtrage des données d'enquête. surveyId: type: string description: >- Une chaîne représentant l'identifiant unique du sondage SurveyMonkey à filtrer. x-hubspot-sub-type-impl: true PublicSurveyMonkeyValueFilter: title: SURVEY_MONKEY_VALUE required: - filterType - operator - surveyId - surveyQuestion - valueComparison type: object properties: filterType: type: string description: "Une chaîne indiquant le type de filtre. La valeur par défaut est «\_SURVEY_MONKEY_VALUE\_»." default: SURVEY_MONKEY_VALUE enum: - SURVEY_MONKEY_VALUE operator: type: string description: >- Une chaîne qui spécifie l'opérateur utilisé dans le filtre, déterminant comment les données de l'enquête sont évaluées par rapport aux critères de filtre. surveyAnswerColId: type: string description: >- Une chaîne représentant l'identifiant de colonne de la réponse à l'enquête, utilisée pour filtrer des réponses spécifiques. surveyAnswerRowId: type: string description: >- Une chaîne représentant l'identifiant de ligne de la réponse à l'enquête, utilisée pour filtrer des réponses spécifiques. surveyId: type: string description: >- Une chaîne représentant l'identifiant unique de l'enquête SurveyMonkey. surveyQuestion: type: string description: >- Une chaîne spécifiant la question de l'enquête à utiliser pour filtrer les réponses. valueComparison: description: >- Un objet qui définit l'opération de comparaison des valeurs de réponse à l'enquête. Il peut s'agir de plusieurs types, tels que des opérations numériques, de chaîne ou de date. 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: "Une chaîne qui spécifie le type de filtre. La valeur par défaut est «\_WEBINAR*\_»." default: WEBINAR enum: - WEBINAR operator: type: string description: Une chaîne représentant l'opérateur utilisé dans le filtre. webinarId: type: string description: Une chaîne qui identifie de manière unique le webinar* à filtrer. x-hubspot-sub-type-impl: true PublicEmailEventFilter: title: EMAIL_EVENT required: - appId - emailId - filterType - level - operator type: object properties: appId: type: string description: >- Une chaîne qui identifie l'application associée à l'événement d'e-mail. clickUrl: type: string description: >- Une chaîne représentant l'URL qui a été cliquée dans l'événement d'e-mail. emailId: type: string description: >- Une chaîne qui identifie de manière unique l'e-mail associé à l'événement. filterType: type: string description: "Une chaîne qui spécifie le type de filtre. La valeur par défaut est «\_EMAIL_EVENT\_»." default: EMAIL_EVENT enum: - EMAIL_EVENT level: type: string description: Une chaîne représentant le niveau de l'événement d'e-mail. operator: type: string description: "Une chaîne qui défin\_it l'opération ou le type d'événement pour filtrer. Les valeurs valides incluent «\_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\_» et «\_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: "Un objet qui spécifie des critères supplémentaires pour affiner le filtre, peut être de plusieurs types tels que «\_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: "Une chaîne indiquant le type de filtre, qui est «\_PRIVACY\_» pour ce composant." default: PRIVACY enum: - PRIVACY operator: type: string description: >- Une chaîne spécifiant l'opérateur à utiliser conjointement avec le privacyName pour le filtrer. privacyName: type: string description: >- Une chaîne représentant le nom du paramètre de confidentialité à utiliser dans le filtre. x-hubspot-sub-type-impl: true PublicAdsSearchFilter: title: ADS_SEARCH required: - adNetwork - entityType - filterType - operator - searchTermType - searchTerms type: object properties: adNetwork: type: string description: >- Une chaîne identifiant le réseau publicitaire où la recherche est effectuée. entityType: type: string description: Une chaîne représentant le type d'entité filtrée. filterType: type: string description: >- Une chaîne indiquant le type de filtre appliqué. La valeur par défaut est « ADS_SEARCH ». default: ADS_SEARCH enum: - ADS_SEARCH operator: type: string description: >- Une chaîne qui spécifie l'opération ou la condition appliquée au filtre. searchTermType: type: string description: >- Chaîne spécifiant le type de terme de recherche utilisé dans le filtre. searchTerms: type: array description: >- Un tableau de chaînes contenant les termes utilisés pour la recherche au sein du réseau publicitaire. items: type: string x-hubspot-sub-type-impl: true PublicAdsTimeFilter: title: ADS_TIME required: - filterType - pruningRefineBy type: object properties: filterType: type: string description: "Une chaîne qui indique le type de filtre appliqué. La valeur par défaut est «\_ADS_TIME\_»." default: ADS_TIME enum: - ADS_TIME pruningRefineBy: description: >- Un objet qui définit les critères d'affinement du filtre en fonction des attributs temporels. Il peut être de plusieurs types, tels que PublicNumOccurrencesRefineBy, PublicSetOccurrencesRefineBy, ou divers types d'affinement d'horodatage. 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: "Une chaîne spécifiant le type de filtre appliqué. La valeur par défaut est «\_IN_LIST\_»." default: IN_LIST enum: - IN_LIST listId: type: string description: >- Chaîne représentant l'identifiant unique de la liste à utiliser dans le filtre. metadata: $ref: '#/components/schemas/PublicInListFilterMetadata' operator: type: string description: Une chaîne qui définit l'opérateur utilisé dans le filtre. x-hubspot-sub-type-impl: true PublicUnifiedEventsFilter: title: UNIFIED_EVENTS required: - filterLines - filterType type: object properties: coalescingRefineBy: description: >- Un objet qui spécifie les critères d'affinement pour la fusion d'événements. Il peut s'agir de l'un des schémas prédéfinis tels que 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: Une chaîne représentant l'identifiant unique du type d'événement. filterLines: type: array description: >- Un tableau d’objets, chacun conforme au schéma PublicEventFilterMetadata, représentant les lignes de filtre individuelles qui composent le filtre d’événements unifié. items: $ref: '#/components/schemas/PublicEventFilterMetadata' filterType: type: string description: >- Une chaîne indiquant le type de filtre. La valeur par défaut est « UNIFIED_EVENTS ». default: UNIFIED_EVENTS enum: - UNIFIED_EVENTS pruningRefineBy: description: >- Un objet qui spécifie les critères d'affinement pour l'élagage des événements. Il peut s'agir de l'un des schémas prédéfinis tels que 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: "Une chaîne indiquant le type de filtre. La valeur par défaut est «\_CONSTANT\_» et doit être l'un des types de filtre prédéfinis." default: CONSTANT enum: - CONSTANT shouldAccept: type: boolean description: >- Un booléen indiquant si le filtre doit accepter les critères qu'il évalue. source: type: string description: >- Une chaîne représentant l'origine ou le contexte à partir duquel le filtre est appliqué. x-hubspot-sub-type-impl: true PublicNumOccurrencesRefineBy: title: NUM_OCCURRENCES required: - type type: object properties: maxOccurrences: type: integer description: Un entier spécifiant le nombre maximal d'occurrences autorisées. format: int32 minOccurrences: type: integer description: Un entier spécifiant le nombre minimum d'occurrences requis. format: int32 type: type: string description: "Une chaîne indiquant le type d'affinement, qui est «\_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: >- Une chaîne qui spécifie le type d'ensemble pour l'affinage des occurrences. type: type: string description: "Une chaîne représentant le type d'affinement. La valeur par défaut est «\_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: Une chaîne représentant l'opération de comparaison à effectuer. timeOffset: $ref: '#/components/schemas/PublicTimeOffset' type: type: string description: "Une chaîne indiquant le type d'affinement, qui est «\_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: >- Une chaîne indiquant le type de plage utilisé pour l'affinement de l'horodatage. type: type: string description: "Une chaîne qui spécifie le type d'opération d'affinement, qui est «\_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: >- Une chaîne représentant le type de comparaison à effectuer avec l'horodatage. timestamp: type: integer description: >- Un entier représentant le point temporel spécifique à utiliser pour la comparaison, formaté comme un horodatage Unix en millisecondes. format: int64 type: type: string description: "Une chaîne indiquant le type d'affinement, qui est «\_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: >- Représente la limite inférieure de la plage d'horodatage, spécifiée comme un horodatage Unix en millisecondes. format: int64 rangeType: type: string description: Une chaîne représentant le type de plage définie. type: type: string description: "Une chaîne qui spécifie le type d'opération d'affinement. La valeur par défaut est «\_ABSOLUTE_RANGED\_»." default: ABSOLUTE_RANGED enum: - ABSOLUTE_RANGED upperTimestamp: type: integer description: >- Un entier représentant la limite supérieure de la plage d'horodatage, spécifié comme un horodatage Unix en millisecondes. format: int64 x-hubspot-sub-type-impl: true PublicAllHistoryRefineBy: title: ALL_HISTORY required: - type type: object properties: type: type: string description: "Une chaîne représentant le type d'affinement. La valeur par défaut et la seule valeur valide est «\_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: >- Une chaîne décrivant le comportement du point de terminaison dans le contexte de l'opération de point temporel. includeObjectsWithNoValueSet: type: boolean description: >- Un booléen indiquant s'il faut inclure les objets sans valeur définie dans l'opération. operationType: type: string description: "Une chaîne indiquant le type d'opération, par défaut «\_TIME_POINT\_»." default: TIME_POINT enum: - TIME_POINT operator: type: string description: >- Une chaîne représentant l'opérateur utilisé dans l'opération de point temporel. propertyParser: type: string description: >- Une chaîne spécifiant l'analyseur utilisé pour la propriété dans l'opération. timePoint: description: >- Définit le point temporel spécifique pour l'opération. Il peut être de plusieurs types, notamment PublicDatePoint, PublicIndexedTimePoint ou PublicPropertyReferencedTime. oneOf: - $ref: '#/components/schemas/PublicDatePoint' - $ref: '#/components/schemas/PublicIndexedTimePoint' - $ref: '#/components/schemas/PublicPropertyReferencedTime' type: type: string description: Une chaîne représentant le type de l'opération de point temporel. x-hubspot-sub-type-impl: true PublicRangedTimeOperation: title: TIME_RANGED required: - includeObjectsWithNoValueSet - lowerBoundTimePoint - operationType - operator - type - upperBoundTimePoint type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Un booléen indiquant s'il faut inclure les objets qui n'ont aucune valeur définie. lowerBoundEndpointBehavior: type: string description: >- Une chaîne de caractères qui spécifie le comportement du point de terminaison de la borne inférieure dans la plage horaire. lowerBoundTimePoint: description: >- Un objet qui définit le point temporel de la borne inférieure de la plage. Il peut s'agir d'un point de date, d'un point temporel indexé ou d'une heure référencée par une propriété. oneOf: - $ref: '#/components/schemas/PublicDatePoint' - $ref: '#/components/schemas/PublicIndexedTimePoint' - $ref: '#/components/schemas/PublicPropertyReferencedTime' operationType: type: string description: Une chaîne qui spécifie le type d'opération effectuée. operator: type: string description: >- Une chaîne qui définit l'opérateur utilisé dans l'opération temporelle. propertyParser: type: string description: >- Une chaîne qui indique l'analyseur de propriété utilisé dans l'opération. type: type: string description: "Une chaîne de caractères qui spécifie le type d'opération, avec une valeur par défaut de «\_TIME_RANGED\_»." default: TIME_RANGED enum: - TIME_RANGED upperBoundEndpointBehavior: type: string description: >- Une chaîne qui spécifie le comportement du point de terminaison de la limite supérieure dans la plage horaire. upperBoundTimePoint: description: >- Un objet qui définit le point temporel de la limite supérieure de la plage. Il peut s'agir d'un point de date, d'un point temporel indexé ou d'une heure référencée par une propriété. 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: >- Un booléen indiquant si les objets sans valeur définie doivent être inclus dans l'opération. operationType: type: string description: "Une chaîne représentant le type d'opération. La valeur par défaut est «\_BOOLEAN\_»." default: BOOL enum: - BOOL operator: type: string description: Chaîne indiquant l'opérateur utilisé dans l'opération booléenne. value: type: boolean description: Un booléen représentant la valeur à utiliser dans l'opération. x-hubspot-sub-type-impl: true PublicNumberPropertyOperation: title: NUMBER required: - includeObjectsWithNoValueSet - operationType - operator - value type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Un booléen indiquant si les objets sans valeur définie doivent être inclus dans l'opération. operationType: type: string description: "Une chaîne de caractères indiquant le type d'opération. La valeur par défaut est «\_NUMBER\_»." default: NUMBER enum: - NUMBER operator: type: string description: Une chaîne représentant l'opérateur utilisé dans l'opération. value: type: number description: Un nombre représentant la valeur utilisée dans l'opération. x-hubspot-sub-type-impl: true PublicStringPropertyOperation: title: STRING required: - includeObjectsWithNoValueSet - operationType - operator - value type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Un booléen indiquant si les objets sans valeur définie pour la propriété doivent être inclus dans l'opération. operationType: type: string description: "Une chaîne indiquant le type d'opération, qui est toujours «\_STRING\_» pour cet élément." default: STRING enum: - STRING operator: type: string description: >- Une chaîne représentant l'opérateur à utiliser dans l'opération. Les opérateurs spécifiques ne sont pas détaillés dans la spécification. value: type: string description: Une chaîne représentant la valeur à utiliser dans l'opération. x-hubspot-sub-type-impl: true PublicDateTimePropertyOperation: title: DATETIME required: - includeObjectsWithNoValueSet - operationType - operator - requiresTimeZoneConversion - timestamp type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Un booléen indiquant si les objets sans valeur définie doivent être inclus dans l'opération. operationType: type: string description: "Une chaîne indiquant le type d'opération, qui est toujours «\_DATETIME\_» pour ce composant." default: DATETIME enum: - DATETIME operator: type: string description: >- Une chaîne représentant l'opérateur utilisé dans l'opération de date et d'heure. requiresTimeZoneConversion: type: boolean description: >- Un booléen spécifiant si l'opération de date et d'heure nécessite une conversion basée sur les fuseaux horaires. timestamp: type: integer description: >- Un entier représentant l'horodatage impliqué dans l'opération, formaté en 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: >- Un booléen indiquant si les objets sans valeur définie doivent être inclus. lowerBound: type: integer description: >- Un entier représentant la limite inférieure de la plage de dates, au format int64. format: int64 operationType: type: string description: "Une chaîne qui spécifie le type d'opération, avec une valeur par défaut de «\_RANGED_DATE\_»." default: RANGED_DATE enum: - RANGED_DATE operator: type: string description: Une chaîne représentant l'opérateur utilisé dans l'opération. requiresTimeZoneConversion: type: boolean description: >- Un booléen indiquant si l'opération nécessite une conversion de fuseau horaire. upperBound: type: integer description: >- Un entier représentant la limite supérieure de la plage de dates, au format 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: Une chaîne représentant le nom de la propriété à comparer. defaultComparisonValue: type: string description: >- Une valeur facultative utilisée par défaut pour la comparaison si la propriété de comparaison n'est pas définie. includeObjectsWithNoValueSet: type: boolean description: >- Un booléen indiquant si les objets sans valeur définie pour la propriété doivent être inclus dans l'opération. operationType: type: string description: "Une chaîne qui spécifie le type d'opération. La valeur par défaut est «\_COMPARATIVE_PROPERTY_UPDATED\_»." default: COMPARATIVE_PROPERTY_UPDATED enum: - COMPARATIVE_PROPERTY_UPDATED operator: type: string description: Une chaîne qui définit l'opérateur utilisé dans la comparaison. x-hubspot-sub-type-impl: true PublicComparativeDatePropertyOperation: title: COMPARATIVE_DATE required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator type: object properties: comparisonPropertyName: type: string description: >- Une chaîne spécifiant le nom de la propriété à utiliser pour la comparaison. defaultComparisonValue: type: string description: >- Une chaîne représentant la valeur par défaut à utiliser pour la comparaison si aucune autre valeur n'est définie. includeObjectsWithNoValueSet: type: boolean description: >- Un booléen indiquant si les objets sans valeur définie doivent être inclus dans l'opération. operationType: type: string description: "Une chaîne indiquant le type d'opération. La valeur par défaut est « \_COMPARATIVE_DAT\_»." default: COMPARATIVE_DATE enum: - COMPARATIVE_DATE operator: type: string description: Une chaîne représentant l'opérateur utilisé pour la comparaison. x-hubspot-sub-type-impl: true PublicRollingDateRangePropertyOperation: title: ROLLING_DATE_RANGE required: - includeObjectsWithNoValueSet - numberOfDays - operationType - operator - requiresTimeZoneConversion type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Un booléen indiquant s'il faut inclure les objets qui n'ont pas de valeur définie pour la propriété sur laquelle l'opération est effectuée. numberOfDays: type: integer description: >- Un entier spécifiant le nombre de jours qui définissent la plage de dates relatives. format: int32 operationType: type: string description: "Une chaîne indiquant le type d'opération, qui est «\_ROLLING_DATE_RANGE\_» par défaut." default: ROLLING_DATE_RANGE enum: - ROLLING_DATE_RANGE operator: type: string description: Une chaîne représentant l'opérateur utilisé dans l'opération. requiresTimeZoneConversion: type: boolean description: >- Un booléen indiquant si l'opération nécessite une conversion basée sur le fuseau horaire. x-hubspot-sub-type-impl: true PublicRollingPropertyUpdatedOperation: title: ROLLING_PROPERTY_UPDATED required: - includeObjectsWithNoValueSet - numberOfDays - operationType - operator type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Un booléen indiquant s'il faut inclure les objets pour lesquels aucune valeur n'est définie pour la propriété. numberOfDays: type: integer description: >- Un entier spécifiant le nombre de jours sur lesquels l'opération de mise à jour progressive est appliquée. format: int32 operationType: type: string description: "Une chaîne indiquant le type d'opération. La valeur par défaut est «\_ROLLING_PROPERTY_UPDATED\_»." default: ROLLING_PROPERTY_UPDATED enum: - ROLLING_PROPERTY_UPDATED operator: type: string description: Une chaîne représentant l'opérateur utilisé dans l'opération. x-hubspot-sub-type-impl: true PublicEnumerationPropertyOperation: title: ENUMERATION required: - includeObjectsWithNoValueSet - operationType - operator - values type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Un booléen indiquant si les objets sans valeur définie doivent être inclus dans l'opération. operationType: type: string description: "Une chaîne représentant le type d'opération, par défaut «\_ENUMERATION\_»." default: ENUMERATION enum: - ENUMERATION operator: type: string description: Une chaîne indiquant l'opérateur utilisé dans l'opération. values: type: array description: >- Un tableau de chaînes représentant les valeurs impliquées dans l'opération d'énumération. items: type: string x-hubspot-sub-type-impl: true PublicAllPropertyTypesOperation: title: ALL_PROPERTY required: - includeObjectsWithNoValueSet - operationType - operator type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Un booléen indiquant s'il faut inclure les objets pour lesquels aucune valeur n'est définie pour la propriété. operationType: type: string description: "Une chaîne indiquant le type d'opération. La valeur par défaut et la seule valeur valide est «\_ALL_PROPERTY_TYPES\_»." default: ALL_PROPERTY enum: - ALL_PROPERTY operator: type: string description: Une chaîne représentant l'opérateur à utiliser dans l'opération. x-hubspot-sub-type-impl: true PublicRangedNumberPropertyOperation: title: NUMBER_RANGED required: - includeObjectsWithNoValueSet - lowerBound - operationType - operator - upperBound type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Un booléen indiquant s'il faut inclure les objets qui n'ont pas de valeur définie. lowerBound: type: integer description: Un entier représentant la limite inférieure de la plage. format: int64 operationType: type: string description: "Chaîne de caractères spécifiant le type d'opération. La valeur par défaut est «\_RANGED_NUMBER\_»." default: NUMBER_RANGED enum: - NUMBER_RANGED operator: type: string description: >- Une chaîne de caractères représentant l'opérateur utilisé dans l'opération. upperBound: type: integer description: Un entier représentant la limite supérieure de la plage. format: int64 x-hubspot-sub-type-impl: true PublicMultiStringPropertyOperation: title: MULTISTRING required: - includeObjectsWithNoValueSet - operationType - operator - values type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Un booléen indiquant si les objets sans valeur définie doivent être inclus dans l'opération. operationType: type: string description: "Une chaîne indiquant le type d'opération, qui est «\_MULTISTRING\_» par défaut." default: MULTISTRING enum: - MULTISTRING operator: type: string description: Une chaîne représentant l'opérateur utilisé pour l'opération. values: type: array description: >- Un tableau de chaînes représentant les valeurs à utiliser dans l'opération. 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: Un entier représentant le jour impliqué dans l'opération de date. format: int32 includeObjectsWithNoValueSet: type: boolean description: >- Un booléen indiquant si les objets sans valeur définie doivent être inclus dans l'opération. month: type: string description: Chaîne représentant le mois impliqué dans l'opération de date. operationType: type: string description: "Une chaîne indiquant le type d'opération, qui est toujours «\_DATE\_»." default: DATE enum: - DATE operator: type: string description: Chaîne représentant l'opérateur utilisé dans l'opération de date. year: type: integer description: Un entier représentant l'année impliquée dans l'opération de date. format: int32 x-hubspot-sub-type-impl: true PublicCalendarDatePropertyOperation: title: CALENDAR_DATE required: - includeObjectsWithNoValueSet - operationType - operator - timeUnit type: object properties: fiscalYearStart: type: string description: "Une chaîne indiquant le mois de début de l'exercice fiscal. Les valeurs valides incluent «\_JANVIER\_», «\_FÉVRIER\_», «\_MARS\_», «\_AVRIL\_», «\_MAI\_», «\_JUIN\_», «\_JUILLET\_», «\_AOÛT\_», «\_SEPTEMBRE\_», «\_OCTOBRE\_», «\_NOVEMBRE\_» et «\_DÉCEMBRE\_». " enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER includeObjectsWithNoValueSet: type: boolean description: >- Un booléen indiquant s'il faut inclure les objets pour lesquels aucune valeur n'est définie pour la propriété. operationType: type: string description: "Une chaîne indiquant le type d'opération, qui est toujours «\_CALENDAR_DATE\_»." default: CALENDAR_DATE enum: - CALENDAR_DATE operator: type: string description: Une chaîne représentant l'opérateur utilisé dans l'opération. timeUnit: type: string description: Une chaîne spécifiant l'unité de temps pour l'opération. timeUnitCount: type: integer description: Un entier spécifiant le nombre d'unités de temps pour l'opération. format: int32 useFiscalYear: type: boolean description: Un booléen indiquant si l'année fiscale doit être utilisée. x-hubspot-sub-type-impl: true PublicComparativeStringPropertyOperation: title: COMPARATIVE_STRING required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator type: object properties: comparisonPropertyName: type: string description: Une chaîne spécifiant le nom de la propriété à comparer. defaultComparisonValue: type: string description: >- La valeur par défaut à utiliser pour la comparaison si la valeur de la propriété n'est pas définie, représentée sous forme de chaîne de caractères. includeObjectsWithNoValueSet: type: boolean description: >- Un booléen indiquant s'il faut inclure les objets pour lesquels aucune valeur n'est définie pour la propriété. operationType: type: string description: "Une chaîne indiquant le type d'opération, qui est «\_COMPARATIVE_STRING\_» par défaut." default: COMPARATIVE_STRING enum: - COMPARATIVE_STRING operator: type: string description: >- L'opérateur utilisé pour l'opération de comparaison. Il s'agit d'une valeur de chaîne. 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: >- Un objet qui définit l'opération à effectuer sur la propriété spécifiée. Cette opération peut être de plusieurs types, tels que des opérations booléennes, numériques, de chaîne ou de date, entre autres. 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: >- Une chaîne représentant la propriété spécifique de l'événement que le filtre cible. PublicInListFilterMetadata: required: - id - inListType type: object properties: id: type: string description: >- L'identifiant unique de la liste. Il s'agit d'une chaîne qui spécifie à quelle liste le filtre est associé. inListType: type: string description: >- Une chaîne représentant le type de liste utilisé dans le filtre. Cette propriété définit le contexte ou la catégorie de la liste référencée. PublicTimeOffset: required: - amount - offsetDirection - timeUnit type: object properties: amount: type: integer description: Un entier spécifiant le nombre d'unités de temps pour le décalage. format: int64 offsetDirection: type: string description: "Une chaîne indiquant la direction du décalage horaire. Les valeurs valides sont «\_BEFORE\_» et «\_AFTER \_»." timeUnit: type: string description: "Une chaîne représentant l'unité de temps pour le décalage, telle que «\_JOURS\_», «\_HEURES\_», «\_MINUTES\_», etc." PublicDatePoint: title: DATE required: - day - month - timeType - year - zoneId type: object properties: day: type: integer description: Un entier représentant le composant jour de la date. format: int32 hour: type: integer description: Un entier représentant l'élément heure de l'heure. format: int32 millisecond: type: integer description: Un entier représentant l'élément milliseconde de l'heure. format: int32 minute: type: integer description: Un entier représentant l'élément minute de l'heure. format: int32 month: type: integer description: Un entier représentant le mois de la date. format: int32 second: type: integer description: Un entier représentant l'élément seconde de l'heure. format: int32 timeType: type: string description: Une chaîne indiquant le type de représentation temporelle. default: DATE enum: - DATE timezoneSource: type: string description: Une chaîne spécifiant la source des informations de fuseau horaire. year: type: integer description: Un entier représentant l'élément année de la date. format: int32 zoneId: type: string description: Une chaîne représentant l'identifiant du fuseau horaire. x-hubspot-sub-type-impl: true PublicIndexedTimePoint: title: INDEXED required: - indexReference - timeType - zoneId type: object properties: indexReference: description: "Un point de référence pour l'indexation du temps, qui peut être l'une des nombreuses références temporelles prédéfinies telles que «\_MAINTENANT\_», «\_AUJOURD'HUI\_», «\_SEMAINE\_», 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: "Une chaîne représentant le type de point temporel, qui est toujours «\_INDEXED\_»." default: INDEXED enum: - INDEXED timezoneSource: type: string description: Une chaîne indiquant la source des informations de fuseau horaire. zoneId: type: string description: Une chaîne représentant l'identifiant du fuseau horaire. x-hubspot-sub-type-impl: true PublicPropertyReferencedTime: title: PROPERTY_REFERENCED required: - property - referenceType - timeType - zoneId type: object properties: property: type: string description: >- Une chaîne qui désigne la propriété utilisée comme référence pour l'opération temporelle. referenceType: type: string description: Chaîne indiquant le type de référence utilisé pour la propriété. timeType: type: string description: "Une chaîne indiquant le type de référence temporelle, qui est «\_PROPRIÉTÉ_REFERENCED\_» par défaut." default: PROPERTY_REFERENCED enum: - PROPERTY_REFERENCED timezoneSource: type: string description: >- Une chaîne représentant la source des informations de fuseau horaire. zoneId: type: string description: Une chaîne spécifiant l'identifiant du fuseau horaire. x-hubspot-sub-type-impl: true PublicNowReference: title: NOW required: - referenceType type: object properties: hour: type: integer description: Un entier représentant l'heure actuelle. format: int32 millisecond: type: integer description: Un entier représentant la milliseconde actuelle. format: int32 minute: type: integer description: Un entier représentant la minute de l'heure actuelle. format: int32 referenceType: type: string description: "Une chaîne de caractères qui indique le type de référence, toujours «\_NOW\_» pour ce composant." default: NOW enum: - NOW second: type: integer description: Un entier représentant la seconde de l'heure actuelle. format: int32 x-hubspot-sub-type-impl: true PublicTodayReference: title: TODAY required: - referenceType type: object properties: hour: type: integer description: Un entier représentant l'heure de la journée. format: int32 millisecond: type: integer description: Un entier représentant la milliseconde dans la seconde. format: int32 minute: type: integer description: Un entier représentant la minute dans l'heure. format: int32 referenceType: type: string description: "Une chaîne indiquant le type de référence, qui est «\_TODAY\_» par défaut." default: TODAY enum: - TODAY second: type: integer description: Un entier représentant la seconde dans la minute. format: int32 x-hubspot-sub-type-impl: true PublicWeekReference: title: WEEK required: - dayOfWeek - referenceType type: object properties: dayOfWeek: type: string description: "Une chaîne représentant le jour de la semaine. Les valeurs valides incluent «\_LUNDI\_», «\_MARDI\_», «\_MERCREDI\_», «\_JEUDI\_», «\_VENDREDI\_», «\_SAMEDI\_», «\_DIMANCHE\_». " enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY hour: type: integer description: Un entier représentant l'heure de la journée. format: int32 millisecond: type: integer description: Un entier représentant la milliseconde dans la seconde. format: int32 minute: type: integer description: Un entier représentant la minute dans l'heure. format: int32 referenceType: type: string description: "Une chaîne indiquant le type de référence, qui est «\_SEMAINE\_» par défaut." default: WEEK enum: - WEEK second: type: integer description: Un entier représentant la seconde dans la minute. format: int32 x-hubspot-sub-type-impl: true PublicFiscalQuarterReference: title: FISCAL_QUARTER required: - day - month - referenceType type: object properties: day: type: integer description: Un entier représentant le jour du mois dans le trimestre fiscal. format: int32 hour: type: integer description: Un entier représentant l'heure de la journée. format: int32 millisecond: type: integer description: Un entier représentant la milliseconde dans la seconde. format: int32 minute: type: integer description: Un entier représentant la minute dans l'heure. format: int32 month: type: integer description: Un entier représentant le mois du trimestre fiscal. format: int32 referenceType: type: string description: "Une chaîne indiquant le type de référence, qui est «\_FISCAL_QUARTER\_» par défaut." default: FISCAL_QUARTER enum: - FISCAL_QUARTER second: type: integer description: Un entier représentant la seconde dans la minute. format: int32 x-hubspot-sub-type-impl: true PublicFiscalYearReference: title: FISCAL_YEAR required: - day - month - referenceType type: object properties: day: type: integer description: Un entier représentant la composante jour de la date. format: int32 hour: type: integer description: Un entier représentant la composante heure de l'heure. format: int32 millisecond: type: integer description: Un entier représentant la composante milliseconde de l'heure. format: int32 minute: type: integer description: Un entier représentant la composante minute de l'heure. format: int32 month: type: integer description: Un entier représentant la composante mois de la date. format: int32 referenceType: type: string description: "Une chaîne de caractères qui spécifie le type de référence, par défaut «\_FISCAL_YEAR\_»." default: FISCAL_YEAR enum: - FISCAL_YEAR second: type: integer description: Un entier représentant la composante seconde de l’heure. format: int32 x-hubspot-sub-type-impl: true PublicYearReference: title: YEAR required: - day - month - referenceType type: object properties: day: type: integer description: Un entier représentant le jour du mois. format: int32 hour: type: integer description: Un entier représentant l'heure de la journée. format: int32 millisecond: type: integer description: Un entier représentant la milliseconde dans la seconde. format: int32 minute: type: integer description: Un entier représentant la minute dans l'heure. format: int32 month: type: integer description: Un entier représentant le mois de l'année. format: int32 referenceType: type: string description: "Une chaîne qui indique le type de référence, qui est «\_YEAR\_» par défaut." default: YEAR enum: - YEAR second: type: integer description: Un entier représentant la seconde dans la minute. format: int32 x-hubspot-sub-type-impl: true PublicQuarterReference: title: QUARTER required: - day - month - referenceType type: object properties: day: type: integer description: Un entier représentant le jour du mois. format: int32 hour: type: integer description: Un entier représentant l'heure de la journée. format: int32 millisecond: type: integer description: Un entier représentant la milliseconde dans la seconde. format: int32 minute: type: integer description: Un entier représentant la minute dans l'heure. format: int32 month: type: integer description: Un entier représentant le mois dans le trimestre. format: int32 referenceType: type: string description: "Une chaîne indiquant le type de référence, qui est «\_QUARTER\_» pour cet élément." default: QUARTER enum: - QUARTER second: type: integer description: Un entier représentant la seconde dans la minute. format: int32 x-hubspot-sub-type-impl: true PublicMonthReference: title: MONTH required: - day - referenceType type: object properties: day: type: integer description: Un entier représentant le jour du mois. format: int32 hour: type: integer description: Un entier représentant l'heure de la journée. format: int32 millisecond: type: integer description: Un entier représentant la milliseconde dans la seconde. format: int32 minute: type: integer description: Un entier représentant la minute dans l'heure. format: int32 referenceType: type: string description: "Une chaîne indiquant le type de référence, qui est «\_MONTH\_» par défaut." default: MONTH enum: - MONTH second: type: integer description: Un entier représentant la seconde dans la minute. format: int32 x-hubspot-sub-type-impl: true PublicIndexOffset: type: object properties: days: type: integer description: Un entier représentant le nombre de jours pour le décalage. format: int32 hours: type: integer description: Un entier représentant le nombre d'heures pour le décalage. format: int32 milliseconds: type: integer description: Un entier représentant le nombre de millisecondes pour le décalage. format: int32 minutes: type: integer description: Un entier représentant le nombre de minutes pour le décalage. format: int32 months: type: integer description: Un entier représentant le nombre de mois pour le décalage. format: int32 quarters: type: integer description: Un entier représentant le nombre de trimestres pour le décalage. format: int32 seconds: type: integer description: Un entier représentant le nombre de secondes pour le décalage. format: int32 weeks: type: integer description: Un entier représentant le nombre de semaines pour le décalage. format: int32 years: type: integer description: Un entier représentant le nombre d'années pour le décalage. 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: '' ````