From 9e547fe21c0716a606e593d8262e6000b44872ce Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Fri, 24 Jan 2025 09:04:28 -0600 Subject: [PATCH 1/8] Added consents array to put and post request bodies --- reference/subscribers.v3.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/reference/subscribers.v3.yml b/reference/subscribers.v3.yml index 07b5b8c5b..f62726c8c 100644 --- a/reference/subscribers.v3.yml +++ b/reference/subscribers.v3.yml @@ -424,6 +424,14 @@ components: minimum: 1 type: integer description: The channel ID where the subscriber was created. + consents: + type: array + items: + type: string + description: Shows what active subscriptions a shopper may have. If the consents array is empty, the user has unsubscribed or didn’t enable the newsletter subscription checkbox during checkout. + example: + - marketing_newsletter + - abandoned_cart description: Common Subscriber properties. x-internal: false Subscriber: From 159319a4612a3811a30cac8c3393831bbd25c3d6 Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Tue, 28 Jan 2025 09:08:19 -0600 Subject: [PATCH 2/8] added enum for consents --- reference/subscribers.v3.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/reference/subscribers.v3.yml b/reference/subscribers.v3.yml index f62726c8c..a765d5344 100644 --- a/reference/subscribers.v3.yml +++ b/reference/subscribers.v3.yml @@ -381,6 +381,9 @@ components: items: type: string description: Shows what active subscriptions a shopper may have. If the consents array is empty, the user has unsubscribed or didn’t enable the newsletter subscription checkbox during checkout. + enum: + - [marketing_newsletter] + - [abandoned_cart] example: - marketing_newsletter x-internal: false @@ -429,6 +432,9 @@ components: items: type: string description: Shows what active subscriptions a shopper may have. If the consents array is empty, the user has unsubscribed or didn’t enable the newsletter subscription checkbox during checkout. + enum: + - [marketing_newsletter] + - [abandoned_cart] example: - marketing_newsletter - abandoned_cart From 3aa05373b426fb81454cfae83d717eaf7419b725 Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Tue, 28 Jan 2025 09:12:53 -0600 Subject: [PATCH 3/8] fix linter error --- reference/subscribers.v3.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/reference/subscribers.v3.yml b/reference/subscribers.v3.yml index a765d5344..b2e43cb67 100644 --- a/reference/subscribers.v3.yml +++ b/reference/subscribers.v3.yml @@ -385,7 +385,7 @@ components: - [marketing_newsletter] - [abandoned_cart] example: - - marketing_newsletter + - [marketing_newsletter] x-internal: false subscriber_Base: title: subscriber_Base @@ -436,8 +436,8 @@ components: - [marketing_newsletter] - [abandoned_cart] example: - - marketing_newsletter - - abandoned_cart + - [marketing_newsletter] + - [abandoned_cart] description: Common Subscriber properties. x-internal: false Subscriber: From 2d55a52e7ff9cfa9dbf4ed3b6a06331388aa3adc Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Tue, 28 Jan 2025 09:19:53 -0600 Subject: [PATCH 4/8] fix linter errors --- reference/subscribers.v3.yml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/reference/subscribers.v3.yml b/reference/subscribers.v3.yml index b2e43cb67..06b50aa09 100644 --- a/reference/subscribers.v3.yml +++ b/reference/subscribers.v3.yml @@ -382,10 +382,10 @@ components: type: string description: Shows what active subscriptions a shopper may have. If the consents array is empty, the user has unsubscribed or didn’t enable the newsletter subscription checkbox during checkout. enum: - - [marketing_newsletter] - - [abandoned_cart] + - ["marketing_newsletter"] + - ["abandoned_cart"] example: - - [marketing_newsletter] + - ["marketing_newsletter"] x-internal: false subscriber_Base: title: subscriber_Base @@ -433,11 +433,11 @@ components: type: string description: Shows what active subscriptions a shopper may have. If the consents array is empty, the user has unsubscribed or didn’t enable the newsletter subscription checkbox during checkout. enum: - - [marketing_newsletter] - - [abandoned_cart] + - ["marketing_newsletter"] + - ["abandoned_cart"] example: - - [marketing_newsletter] - - [abandoned_cart] + - ["marketing_newsletter"] + - ["abandoned_cart"] description: Common Subscriber properties. x-internal: false Subscriber: From 75e01ef14d0345f0cd03b3f8b387960c14ea1c9e Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Tue, 28 Jan 2025 09:26:14 -0600 Subject: [PATCH 5/8] fix error --- reference/subscribers.v3.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/reference/subscribers.v3.yml b/reference/subscribers.v3.yml index 06b50aa09..d4d46f7c6 100644 --- a/reference/subscribers.v3.yml +++ b/reference/subscribers.v3.yml @@ -385,7 +385,7 @@ components: - ["marketing_newsletter"] - ["abandoned_cart"] example: - - ["marketing_newsletter"] + - "marketing_newsletter" x-internal: false subscriber_Base: title: subscriber_Base @@ -436,8 +436,8 @@ components: - ["marketing_newsletter"] - ["abandoned_cart"] example: - - ["marketing_newsletter"] - - ["abandoned_cart"] + - "marketing_newsletter" + - "abandoned_cart" description: Common Subscriber properties. x-internal: false Subscriber: From bcb15cd8533aa85e5cf36afdee6269fd1d0225b6 Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Tue, 28 Jan 2025 09:41:30 -0600 Subject: [PATCH 6/8] Update subscribers.v3.yml --- reference/subscribers.v3.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/reference/subscribers.v3.yml b/reference/subscribers.v3.yml index d4d46f7c6..f9a9547df 100644 --- a/reference/subscribers.v3.yml +++ b/reference/subscribers.v3.yml @@ -380,10 +380,10 @@ components: type: array items: type: string - description: Shows what active subscriptions a shopper may have. If the consents array is empty, the user has unsubscribed or didn’t enable the newsletter subscription checkbox during checkout. + description: Shows the active subscriptions a shopper may have. If the consents array is empty, the user has unsubscribed or didn’t enable the newsletter subscription checkbox during checkout. The array will contain consent types like 'marketing_newsletter' and 'abandoned_cart'. enum: - - ["marketing_newsletter"] - - ["abandoned_cart"] + - "marketing_newsletter" + - "abandoned_cart" example: - "marketing_newsletter" x-internal: false @@ -431,10 +431,10 @@ components: type: array items: type: string - description: Shows what active subscriptions a shopper may have. If the consents array is empty, the user has unsubscribed or didn’t enable the newsletter subscription checkbox during checkout. + description: Shows the active subscriptions a shopper may have. If the consents array is empty, the user has unsubscribed or didn’t enable the newsletter subscription checkbox during checkout. The array will contain consent types like 'marketing_newsletter' and 'abandoned_cart'. enum: - - ["marketing_newsletter"] - - ["abandoned_cart"] + - "marketing_newsletter" + - "abandoned_cart" example: - "marketing_newsletter" - "abandoned_cart" From d686ffad22abaa97e6853142f4bd074036e60dba Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Tue, 28 Jan 2025 09:59:35 -0600 Subject: [PATCH 7/8] fixed errors --- reference/subscribers.v3.yml | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/reference/subscribers.v3.yml b/reference/subscribers.v3.yml index f9a9547df..f199ac7b7 100644 --- a/reference/subscribers.v3.yml +++ b/reference/subscribers.v3.yml @@ -382,8 +382,8 @@ components: type: string description: Shows the active subscriptions a shopper may have. If the consents array is empty, the user has unsubscribed or didn’t enable the newsletter subscription checkbox during checkout. The array will contain consent types like 'marketing_newsletter' and 'abandoned_cart'. enum: - - "marketing_newsletter" - - "abandoned_cart" + - ["marketing_newsletter"] + - ["abandoned_cart"] example: - "marketing_newsletter" x-internal: false @@ -433,10 +433,9 @@ components: type: string description: Shows the active subscriptions a shopper may have. If the consents array is empty, the user has unsubscribed or didn’t enable the newsletter subscription checkbox during checkout. The array will contain consent types like 'marketing_newsletter' and 'abandoned_cart'. enum: - - "marketing_newsletter" - - "abandoned_cart" - example: - - "marketing_newsletter" + - ["marketing_newsletter"] + - ["abandoned_cart"] + example: - "abandoned_cart" description: Common Subscriber properties. x-internal: false From 5c8693ff639e628c6c74dbc76c1b4b322708dbbf Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Wed, 29 Jan 2025 09:37:20 -0600 Subject: [PATCH 8/8] Update per Isaac's feedback --- reference/subscribers.v3.yml | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/reference/subscribers.v3.yml b/reference/subscribers.v3.yml index f199ac7b7..622488ba5 100644 --- a/reference/subscribers.v3.yml +++ b/reference/subscribers.v3.yml @@ -380,12 +380,11 @@ components: type: array items: type: string + enum: + - marketing_newsletter + - abandoned_cart description: Shows the active subscriptions a shopper may have. If the consents array is empty, the user has unsubscribed or didn’t enable the newsletter subscription checkbox during checkout. The array will contain consent types like 'marketing_newsletter' and 'abandoned_cart'. - enum: - - ["marketing_newsletter"] - - ["abandoned_cart"] - example: - - "marketing_newsletter" + example: ["marketing_newsletter"] x-internal: false subscriber_Base: title: subscriber_Base @@ -431,12 +430,11 @@ components: type: array items: type: string + enum: + - marketing_newsletter + - abandoned_cart description: Shows the active subscriptions a shopper may have. If the consents array is empty, the user has unsubscribed or didn’t enable the newsletter subscription checkbox during checkout. The array will contain consent types like 'marketing_newsletter' and 'abandoned_cart'. - enum: - - ["marketing_newsletter"] - - ["abandoned_cart"] - example: - - "abandoned_cart" + example: ["abandoned_cart"] description: Common Subscriber properties. x-internal: false Subscriber: