Skip to main content

Class: LanguagesService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/languages.ts:9

Extends​

  • BaseService

Constructors​

Constructor​

new LanguagesService(client): LanguagesService

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

Parameters​

client​

TanqoryClient

Returns​

LanguagesService

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​

addLanguage()​

addLanguage(storeId, data): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/languages.ts:83

Add language

Parameters​

storeId​

string

data​

any

Returns​

Promise<any>

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

create()​

create(storeId, data): Promise<any>

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

Create a new languages item

Parameters​

storeId​

string

data​

any

Returns​

Promise<any>

delete()​

delete(id, storeId): Promise<void>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/languages.ts:47

Delete a languages item

Parameters​

id​

string

storeId​

string

Returns​

Promise<void>

deleteLanguage()​

deleteLanguage(storeId, languageId): Promise<void>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/languages.ts:101

Delete language

Parameters​

storeId​

string

languageId​

string

Returns​

Promise<void>

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

getAutoTranslateQuota()​

getAutoTranslateQuota(storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/languages.ts:135

Get auto-translate quota

Parameters​

storeId​

string

Returns​

Promise<any>

getAvailableLanguages()​

getAvailableLanguages(storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/languages.ts:67

Get available languages Cache disabled - list changes after add/delete

Parameters​

storeId​

string

Returns​

Promise<any>

getDomains()​

getDomains(storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/languages.ts:76

Get domains

Parameters​

storeId​

string

Returns​

Promise<any>

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

getLanguages()​

getLanguages(storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/languages.ts:57

Get all languages for a store Cache disabled - data should always be fresh after mutations

Parameters​

storeId​

string

Returns​

Promise<any>

list()​

list(storeId, options?): Promise<PaginatedResponse<any>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/languages.ts:13

List all languages items

Parameters​

storeId​

string

options?​

ListOptions

Returns​

Promise<PaginatedResponse<any>>

publishLanguage()​

publishLanguage(storeId, languageId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/languages.ts:108

Publish language

Parameters​

storeId​

string

languageId​

string

Returns​

Promise<any>

retrieve()​

retrieve(id, storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/languages.ts:22

Get a single languages item by ID

Parameters​

id​

string

storeId​

string

Returns​

Promise<any>

setAsDefault()​

setAsDefault(storeId, languageId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/languages.ts:126

Set language as default

Parameters​

storeId​

string

languageId​

string

Returns​

Promise<any>

unpublishLanguage()​

unpublishLanguage(storeId, languageId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/languages.ts:117

Unpublish language

Parameters​

storeId​

string

languageId​

string

Returns​

Promise<any>

update()​

update(id, storeId, data): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/languages.ts:38

Update an existing languages item

Parameters​

id​

string

storeId​

string

data​

any

Returns​

Promise<any>

updateLanguage()​

updateLanguage(storeId, languageId, data): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/languages.ts:92

Update language

Parameters​

storeId​

string

languageId​

string

data​

any

Returns​

Promise<any>