tier-1/batch-2: refactor API versioning to use versioning-info module

packages/destination-actions/src/destinations/adobe-target/adobeTarget_operations.ts

@@ -1,5 +1,6 @@
 import { RequestClient, IntegrationError, APIError } from '@segment/actions-core'
 import { StatsContext } from '@segment/actions-core/destination-kit'
+import { ADOBE_TARGET_API_VERSION } from './versioning-info'
 
 function getNestedObjects(obj: { [x: string]: any }, objectPath = '', attributes: { [x: string]: string } = {}) {
   // Do not run on null or undefined
@@ -60,7 +61,7 @@ export default class AdobeTarget {
   ): Promise<IntegrationError | undefined> => {
     try {
       await this.request(
-        `https://${clientCode}.tt.omtrdc.net/rest/v1/profiles/thirdPartyId/${userId}?client=${clientCode}`,
+        `https://${clientCode}.tt.omtrdc.net/rest/${ADOBE_TARGET_API_VERSION}/profiles/thirdPartyId/${userId}?client=${clientCode}`,
         { method: 'get', skipResponseCloning: true }
       )
     } catch (error) {

packages/destination-actions/src/destinations/adobe-target/versioning-info.ts

@@ -0,0 +1,5 @@
+/** ADOBE_TARGET_API_VERSION
+ * Endpoint segment uses: /rest/v1/profiles/thirdPartyId/{userId}
+ * API reference: https://experienceleague.adobe.com/en/docs/target-dev/developer/api/profile-apis/profiles-api
+ */
+export const ADOBE_TARGET_API_VERSION = 'v1'

packages/destination-actions/src/destinations/pinterest-conversions/constants.ts

@@ -1,4 +1,6 @@
-export const API_VERSION = 'v5'
+import { PINTEREST_CONVERSIONS_API_VERSION } from './versioning-info'
+
+export const API_VERSION = PINTEREST_CONVERSIONS_API_VERSION
 export const EVENT_NAME = {
   ADD_TO_CART: 'add_to_cart',
   CHECKOUT: 'checkout',

packages/destination-actions/src/destinations/pinterest-conversions/versioning-info.ts

@@ -0,0 +1,5 @@
+/** PINTEREST_CONVERSIONS_API_VERSION
+ * Pinterest conversions API version.
+ * API reference: https://developers.pinterest.com/docs/api/v5/introduction
+ */
+export const PINTEREST_CONVERSIONS_API_VERSION = 'v5'

packages/destination-actions/src/destinations/reddit-conversions-api/index.ts

@@ -3,6 +3,7 @@ import type { Settings } from './generated-types'
 import type { RedditConversionsTestAuthenticationError } from './types'
 import standardEvent from './standardEvent'
 import customEvent from './customEvent'
+import { REDDIT_CONVERSIONS_API_VERSION } from './versioning-info'
 
 const destination: DestinationDefinition<Settings> = {
   name: 'Reddit Conversions API',
@@ -35,33 +36,36 @@ const destination: DestinationDefinition<Settings> = {
     },
     testAuthentication: async (request, { settings }) => {
       try {
-        return await request(`https://ads-api.reddit.com/api/v2.0/conversions/events/${settings.ad_account_id}`, {
-          method: 'POST',
-          headers: {
-            Authorization: `Bearer ${settings.conversion_token}`
-          },
-          json: {
-            test_mode: true,
-            events: [
-              {
-                event_at: new Date().toISOString(),
-                user: {
-                  email: 'test@example.com',
-                  external_id: 'identity-test',
-                  ip_address: '127.0.0.1',
-                  user_agent: 'Mozilla/5.0'
-                },
-                event_type: {
-                  tracking_type: 'PageVisit'
-                },
-                event_metadata: {
-                  currency: 'USD',
-                  value_decimal: 1
+        return await request(
+          `https://ads-api.reddit.com/api/${REDDIT_CONVERSIONS_API_VERSION}/conversions/events/${settings.ad_account_id}`,
+          {
+            method: 'POST',
+            headers: {
+              Authorization: `Bearer ${settings.conversion_token}`
+            },
+            json: {
+              test_mode: true,
+              events: [
+                {
+                  event_at: new Date().toISOString(),
+                  user: {
+                    email: 'test@example.com',
+                    external_id: 'identity-test',
+                    ip_address: '127.0.0.1',
+                    user_agent: 'Mozilla/5.0'
+                  },
+                  event_type: {
+                    tracking_type: 'PageVisit'
+                  },
+                  event_metadata: {
+                    currency: 'USD',
+                    value_decimal: 1
+                  }
                 }
-              }
-            ]
+              ]
+            }
           }
-        })
+        )
       } catch (err) {
         const error = err as RedditConversionsTestAuthenticationError
         if (error.response && error.response.status === 401) {

packages/destination-actions/src/destinations/reddit-conversions-api/utils.ts

@@ -11,6 +11,7 @@ import {
   DatapProcessingOptions
 } from './types'
 import { processHashing } from '../../lib/hashing-utils'
+import { REDDIT_CONVERSIONS_API_VERSION } from './versioning-info'
 
 type EventMetadataType = StandardEvent['event_metadata'] | CustomEvent['event_metadata']
 type ProductsType = StandardEvent['products'] | CustomEvent['products']
@@ -21,11 +22,14 @@ type ScreenDimensionsType = StandardEvent['screen_dimensions'] | CustomEvent['sc
 
 export async function send(request: RequestClient, settings: Settings, payload: StandardEvent[] | CustomEvent[]) {
   const data = createRedditPayload(payload, settings)
-  return request(`https://ads-api.reddit.com/api/v2.0/conversions/events/${settings.ad_account_id}`, {
-    method: 'POST',
-    headers: { Authorization: `Bearer ${settings.conversion_token}` },
-    json: JSON.parse(JSON.stringify(data))
-  })
+  return request(
+    `https://ads-api.reddit.com/api/${REDDIT_CONVERSIONS_API_VERSION}/conversions/events/${settings.ad_account_id}`,
+    {
+      method: 'POST',
+      headers: { Authorization: `Bearer ${settings.conversion_token}` },
+      json: JSON.parse(JSON.stringify(data))
+    }
+  )
 }
 
 function createRedditPayload(payloads: StandardEvent[] | CustomEvent[], settings: Settings): StandardEventPayload {
@@ -170,7 +174,7 @@ const smartHash = (value: string | undefined, cleaningFunction?: (value: string)
 }
 
 function cleanPhoneNumber(phoneNumber: string): string {
-  if (!phoneNumber) return ""
+  if (!phoneNumber) return ''
   phoneNumber = phoneNumber.trim()
   const prefix = '+'
   if (phoneNumber.startsWith('+')) {

packages/destination-actions/src/destinations/reddit-conversions-api/versioning-info.ts

@@ -0,0 +1,5 @@
+/** REDDIT_CONVERSIONS_API_VERSION
+ * Reddit conversions API version.
+ * API reference: https://ads-api.reddit.com/docs/v2/changelog
+ */
+export const REDDIT_CONVERSIONS_API_VERSION = 'v2.0'

packages/destination-actions/src/destinations/snap-conversions-api/reportConversionEvent/snap-capi-v3.ts

@@ -14,6 +14,7 @@ import {
   smartHash
 } from './utils'
 import { processHashing } from '../../../lib/hashing-utils'
+import { SNAP_CONVERSIONS_API_VERSION } from '../versioning-info'
 
 const CURRENCY_ISO_4217_CODES = new Set([
   'USD',
@@ -687,7 +688,7 @@ const buildRequestURL = (settings: Settings, action_source: string | undefined,
     })()
   )
 
-  return `https://tr.snapchat.com/v3/${appOrPixelID}/events?access_token=${authToken}`
+  return `https://tr.snapchat.com/${SNAP_CONVERSIONS_API_VERSION}/${appOrPixelID}/events?access_token=${authToken}`
 }
 
 const validatePayload = (payload: ReturnType<typeof buildPayloadData>) => {

packages/destination-actions/src/destinations/snap-conversions-api/versioning-info.ts

@@ -0,0 +1,5 @@
+/** SNAP_CONVERSIONS_API_VERSION
+ * Snapchat Conversions API version.
+ * API reference: https://developers.snap.com/api/marketing-api/Conversions-API/UsingTheAPI
+ */
+export const SNAP_CONVERSIONS_API_VERSION = 'v3'

packages/destination-actions/src/destinations/tiktok-audiences/__tests__/index.test.ts

@@ -1,7 +1,8 @@
 import nock from 'nock'
 import { createTestIntegration, IntegrationError } from '@segment/actions-core'
-import { BASE_URL, GET_AUDIENCE_URL, TIKTOK_API_VERSION } from '../constants'
+import { BASE_URL, GET_AUDIENCE_URL } from '../constants'
 import Destination from '../index'
+import { TIKTOK_AUDIENCES_API_VERSION } from '../versioning-info'
 
 const testDestination = createTestIntegration(Destination)
 
@@ -94,7 +95,7 @@ describe('TikTok Audiences', () => {
 
     it('should create a new TikTok Audience', async () => {
       nock(BASE_URL)
-        .post(`/${TIKTOK_API_VERSION}/segment/audience/`, {
+        .post(`/${TIKTOK_AUDIENCES_API_VERSION}/segment/audience/`, {
           custom_audience_name: 'The Super Mario Brothers Fans',
           advertiser_id: '42884288',
           action: 'create'

packages/destination-actions/src/destinations/tiktok-audiences/addToAudience/__tests__/index.test.ts

@@ -1,7 +1,8 @@
 import nock from 'nock'
 import { createTestEvent, createTestIntegration } from '@segment/actions-core'
 import Destination from '../../index'
-import { BASE_URL, TIKTOK_API_VERSION } from '../../constants'
+import { BASE_URL } from '../../constants'
+import { TIKTOK_AUDIENCES_API_VERSION } from '../../versioning-info'
 
 const testDestination = createTestIntegration(Destination)
 
@@ -66,7 +67,7 @@ const updateUsersRequestBody = {
 
 describe('TiktokAudiences.addToAudience', () => {
   it('should succeed if audience id is valid', async () => {
-    nock(`${BASE_URL}${TIKTOK_API_VERSION}`).post('/segment/mapping/', updateUsersRequestBody).reply(200)
+    nock(`${BASE_URL}${TIKTOK_AUDIENCES_API_VERSION}`).post('/segment/mapping/', updateUsersRequestBody).reply(200)
 
     const r = await testDestination.testAction('addToAudience', {
       auth,
@@ -85,7 +86,7 @@ describe('TiktokAudiences.addToAudience', () => {
   })
 
   it('should normalize and hash emails correctly', async () => {
-    nock(`${BASE_URL}${TIKTOK_API_VERSION}`)
+    nock(`${BASE_URL}${TIKTOK_AUDIENCES_API_VERSION}`)
       .post('/segment/mapping/', {
         advertiser_ids: ['123'],
         action: 'add',
@@ -120,7 +121,7 @@ describe('TiktokAudiences.addToAudience', () => {
   })
 
   it('should normalize and hash phone correctly', async () => {
-    nock(`${BASE_URL}${TIKTOK_API_VERSION}`)
+    nock(`${BASE_URL}${TIKTOK_AUDIENCES_API_VERSION}`)
       .post('/segment/mapping/', {
         advertiser_ids: ['123'],
         action: 'add',
@@ -179,7 +180,7 @@ describe('TiktokAudiences.addToAudience', () => {
       }
     })
 
-    nock(`${BASE_URL}${TIKTOK_API_VERSION}/segment/mapping/`)
+    nock(`${BASE_URL}${TIKTOK_AUDIENCES_API_VERSION}/segment/mapping/`)
       .post(/.*/, {
         id_schema: ['EMAIL_SHA256', 'PHONE_SHA256', 'IDFA_SHA256'],
         advertiser_ids: [ADVERTISER_ID],
@@ -217,7 +218,7 @@ describe('TiktokAudiences.addToAudience', () => {
   })
 
   it('should fail if all the send fields are false', async () => {
-    nock(`${BASE_URL}${TIKTOK_API_VERSION}/segment/mapping/`).post(/.*/, updateUsersRequestBody).reply(200)
+    nock(`${BASE_URL}${TIKTOK_AUDIENCES_API_VERSION}/segment/mapping/`).post(/.*/, updateUsersRequestBody).reply(200)
 
     await expect(
       testDestination.testAction('addToAudience', {
@@ -238,7 +239,7 @@ describe('TiktokAudiences.addToAudience', () => {
     ).rejects.toThrow('At least one of `Send Email`, `Send Phone` or `Send Advertising ID` must be set to `true`.')
   })
   it('should fail if email and/or advertising_id is not in the payload', async () => {
-    nock(`${BASE_URL}${TIKTOK_API_VERSION}/segment/mapping/`).post(/.*/, updateUsersRequestBody).reply(400)
+    nock(`${BASE_URL}${TIKTOK_AUDIENCES_API_VERSION}/segment/mapping/`).post(/.*/, updateUsersRequestBody).reply(400)
 
     delete event?.context?.device
     delete event?.context?.traits

packages/destination-actions/src/destinations/tiktok-audiences/addUser/__tests__/index.test.ts

@@ -1,7 +1,8 @@
 import nock from 'nock'
 import { createTestEvent, createTestIntegration, DynamicFieldResponse } from '@segment/actions-core'
 import Destination from '../../index'
-import { BASE_URL, TIKTOK_API_VERSION } from '../../constants'
+import { BASE_URL } from '../../constants'
+import { TIKTOK_AUDIENCES_API_VERSION } from '../../versioning-info'
 
 const testDestination = createTestIntegration(Destination)
 
@@ -56,7 +57,7 @@ const updateUsersRequestBody = {
 
 describe('TiktokAudiences.addUser', () => {
   it('should succeed if audience id is valid', async () => {
-    nock(`${BASE_URL}${TIKTOK_API_VERSION}/segment/mapping/`).post(/.*/, updateUsersRequestBody).reply(200)
+    nock(`${BASE_URL}${TIKTOK_AUDIENCES_API_VERSION}/segment/mapping/`).post(/.*/, updateUsersRequestBody).reply(200)
     await expect(
       testDestination.testAction('addUser', {
         event,
@@ -74,7 +75,7 @@ describe('TiktokAudiences.addUser', () => {
   })
 
   it('should normalize and hash emails correctly', async () => {
-    nock(`${BASE_URL}${TIKTOK_API_VERSION}/segment/mapping/`)
+    nock(`${BASE_URL}${TIKTOK_AUDIENCES_API_VERSION}/segment/mapping/`)
       .post(/.*/, {
         advertiser_ids: ['123'],
         action: 'add',
@@ -109,7 +110,7 @@ describe('TiktokAudiences.addUser', () => {
   })
 
   it('should normalize and hash phone correctly', async () => {
-    nock(`${BASE_URL}${TIKTOK_API_VERSION}/segment/mapping/`)
+    nock(`${BASE_URL}${TIKTOK_AUDIENCES_API_VERSION}/segment/mapping/`)
       .post(/.*/, {
         advertiser_ids: ['123'],
         action: 'add',
@@ -144,7 +145,7 @@ describe('TiktokAudiences.addUser', () => {
   })
 
   it('should fail if an audience id is invalid', async () => {
-    nock(`${BASE_URL}${TIKTOK_API_VERSION}/segment/mapping/`).post(/.*/, updateUsersRequestBody).reply(400)
+    nock(`${BASE_URL}${TIKTOK_AUDIENCES_API_VERSION}/segment/mapping/`).post(/.*/, updateUsersRequestBody).reply(400)
 
     await expect(
       testDestination.testAction('addUser', {
@@ -163,7 +164,7 @@ describe('TiktokAudiences.addUser', () => {
   })
 
   it('should fail if all the send fields are false', async () => {
-    nock(`${BASE_URL}${TIKTOK_API_VERSION}/segment/mapping/`).post(/.*/, updateUsersRequestBody).reply(200)
+    nock(`${BASE_URL}${TIKTOK_AUDIENCES_API_VERSION}/segment/mapping/`).post(/.*/, updateUsersRequestBody).reply(200)
 
     await expect(
       testDestination.testAction('addUser', {
@@ -184,7 +185,7 @@ describe('TiktokAudiences.addUser', () => {
     ).rejects.toThrow('At least one of `Send Email`, `Send Phone` or `Send Advertising ID` must be set to `true`.')
   })
   it('should fail if email and/or advertising_id is not in the payload', async () => {
-    nock(`${BASE_URL}${TIKTOK_API_VERSION}/segment/mapping/`).post(/.*/, updateUsersRequestBody).reply(400)
+    nock(`${BASE_URL}${TIKTOK_AUDIENCES_API_VERSION}/segment/mapping/`).post(/.*/, updateUsersRequestBody).reply(400)
 
     delete event?.context?.device
     delete event?.context?.traits

packages/destination-actions/src/destinations/tiktok-audiences/api/api.test.ts

@@ -1,7 +1,8 @@
 import nock from 'nock'
 import createRequestClient from '../../../../../core/src/create-request-client'
 import { TikTokAudiences } from './index'
-import { BASE_URL, TIKTOK_API_VERSION } from '../constants'
+import { BASE_URL } from '../constants'
+import { TIKTOK_AUDIENCES_API_VERSION } from '../versioning-info'
 const settings = {
   advertiser_ids: ['1234567890', '0987654321', '2345675643']
 }
@@ -13,7 +14,7 @@ describe('TikTok', () => {
     const tiktok: TikTokAudiences = new TikTokAudiences(requestClient)
 
     it('should fetch a list of advertisers, with their names', async () => {
-      nock(`${BASE_URL}${TIKTOK_API_VERSION}/advertiser/info`)
+      nock(`${BASE_URL}${TIKTOK_AUDIENCES_API_VERSION}/advertiser/info`)
         .get(`/`)
         .query({ advertiser_ids: JSON.stringify(settings.advertiser_ids) })
         .reply(200, {
@@ -86,7 +87,7 @@ describe('TikTok', () => {
     })
 
     it('should fallback to stored advertiser_ids if tiktok returns an error', async () => {
-      nock(`${BASE_URL}${TIKTOK_API_VERSION}/advertiser/info`)
+      nock(`${BASE_URL}${TIKTOK_AUDIENCES_API_VERSION}/advertiser/info`)
         .get(`/`)
         .query({ advertiser_ids: JSON.stringify(settings.advertiser_ids) })
         .reply(500, {
@@ -125,7 +126,7 @@ describe('TikTok', () => {
     const page_number = 1
 
     it('should dynamically fetch list of audiences and name', async () => {
-      nock(`${BASE_URL}${TIKTOK_API_VERSION}/dmp/custom_audience/list/`)
+      nock(`${BASE_URL}${TIKTOK_AUDIENCES_API_VERSION}/dmp/custom_audience/list/`)
         .get(`/`)
         .query({
           advertiser_id: selected_advertiser_id,