Class: CustomerPrivacyService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-privacy.ts:25

Extends

• BaseService

Constructors

Constructor

new CustomerPrivacyService(client): CustomerPrivacyService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:12

Parameters

client

TanqoryClient

Returns

CustomerPrivacyService

Inherited from

BaseService.constructor

Properties

client

protected client: TanqoryClient

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:10

Inherited from

BaseService.client

Methods

buildQuery()

protected buildQuery(options?): Record<string, any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:26

Build query parameters

Parameters

options?

ListOptions

Returns

Record<string, any>

Inherited from

BaseService.buildQuery

---

deactivateDataSharing()

deactivateDataSharing(storeId): Promise<{ contentBody: string; contentTitle: string; id: string; navigationMenu?: string; regions: string[]; template: string; useAutomatedSettings: boolean; visibility: "visible" | "hidden"; visibilityDate?: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-privacy.ts:78

Deactivate data sharing opt-out page

Parameters

storeId

string

Returns

Promise<{ contentBody: string; contentTitle: string; id: string; navigationMenu?: string; regions: string[]; template: string; useAutomatedSettings: boolean; visibility: "visible" | "hidden"; visibilityDate?: Date; }>

---

generateIdempotencyKey()

protected generateIdempotencyKey(prefix): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:19

Generate idempotency key

Parameters

prefix

string

Returns

string

Inherited from

BaseService.generateIdempotencyKey

---

getExportMimeType()

protected getExportMimeType(format): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:45

Get MIME type for export format

Parameters

format

string

Returns

string

Inherited from

BaseService.getExportMimeType

---

getSettings()

getSettings(storeId): Promise<{ cookieBanner: { available: boolean; enabled: boolean; id: string; }; dataSharing: { contentBody: string; contentTitle: string; id: string; navigationMenu?: string; regions: string[]; template: string; useAutomatedSettings: boolean; visibility: "visible" | "hidden"; visibilityDate?: Date; }; dataStorage: { canChange: boolean; region: string; }; marketingSettings: { doubleOptInEnabled: boolean; emailMarketingInCheckout: boolean; emailMarketingRegions: string[]; smsMarketingInCheckout: boolean; }; networkIntelligence: { enabled: boolean; }; privacyPolicy: { content: string; id: string; lastUpdated: Date; useAutomated: boolean; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-privacy.ts:29

Get all customer privacy settings

Parameters

storeId

string

Returns

Promise<{ cookieBanner: { available: boolean; enabled: boolean; id: string; }; dataSharing: { contentBody: string; contentTitle: string; id: string; navigationMenu?: string; regions: string[]; template: string; useAutomatedSettings: boolean; visibility: "visible" | "hidden"; visibilityDate?: Date; }; dataStorage: { canChange: boolean; region: string; }; marketingSettings: { doubleOptInEnabled: boolean; emailMarketingInCheckout: boolean; emailMarketingRegions: string[]; smsMarketingInCheckout: boolean; }; networkIntelligence: { enabled: boolean; }; privacyPolicy: { content: string; id: string; lastUpdated: Date; useAutomated: boolean; }; }>

---

updateCookieBanner()

updateCookieBanner(storeId, data): Promise<{ available: boolean; enabled: boolean; id: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-privacy.ts:53

Update cookie banner settings

Parameters

storeId

string

data

enabled

boolean

Returns

Promise<{ available: boolean; enabled: boolean; id: string; }>

---

updateDataSharing()

updateDataSharing(storeId, data): Promise<{ contentBody: string; contentTitle: string; id: string; navigationMenu?: string; regions: string[]; template: string; useAutomatedSettings: boolean; visibility: "visible" | "hidden"; visibilityDate?: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-privacy.ts:64

Update data sharing opt-out settings

Parameters

storeId

string

data

contentBody?

string

contentTitle?

string

navigationMenu?

string

regions?

string[]

template?

string

useAutomatedSettings?

boolean

visibility?

"visible" | "hidden"

visibilityDate?

Date

Returns

Promise<{ contentBody: string; contentTitle: string; id: string; navigationMenu?: string; regions: string[]; template: string; useAutomatedSettings: boolean; visibility: "visible" | "hidden"; visibilityDate?: Date; }>

---

updateMarketingSettings()

updateMarketingSettings(storeId, data): Promise<{ doubleOptInEnabled: boolean; emailMarketingInCheckout: boolean; emailMarketingRegions: string[]; smsMarketingInCheckout: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-privacy.ts:102

Update marketing settings

Parameters

storeId

string

data

doubleOptInEnabled?

boolean

emailMarketingInCheckout?

boolean

emailMarketingRegions?

string[]

smsMarketingInCheckout?

boolean

Returns

Promise<{ doubleOptInEnabled: boolean; emailMarketingInCheckout: boolean; emailMarketingRegions: string[]; smsMarketingInCheckout: boolean; }>

---

updateNetworkIntelligence()

updateNetworkIntelligence(storeId, data): Promise<{ enabled: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-privacy.ts:88

Update network intelligence settings

Parameters

storeId

string

data

enabled

boolean

Returns

Promise<{ enabled: boolean; }>

---

updatePrivacyPolicy()

updatePrivacyPolicy(storeId, data): Promise<{ content: string; id: string; lastUpdated: Date; useAutomated: boolean; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-privacy.ts:39

Update privacy policy settings

Parameters

storeId

string

data

content?

string

useAutomated

boolean

Returns

Promise<{ content: string; id: string; lastUpdated: Date; useAutomated: boolean; }>