Class Dictionaries

Hierarchy

TagoIOModule<GenericModuleParams>
- Dictionaries

Index

Constructors

constructor

Methods

Constructors

constructor

new Dictionaries(params: GenericModuleParams): Dictionaries

Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in src/common/TagoIOModule.ts:79
Parameters
- params: GenericModuleParams
Returns Dictionaries

Methods

create

create(dictionaryObj: DictionaryCreateInfo): Promise<{ dictionary: string }>

- Defined in src/modules/Account/Dictionaries.ts:56
Generate a new dictionary for the account.

Parameters
- dictionaryObj: DictionaryCreateInfo
  
  Object with data to create new dictionary.
Returns Promise<{ dictionary: string }>

delete

delete(dictionaryID: string): Promise<string>

- Defined in src/modules/Account/Dictionaries.ts:87
Delete a dictionary from the account.

Parameters
- dictionaryID: string
  
  Dictionary ID.
Returns Promise<string>

edit

edit(dictionaryID: string, dictionaryObj: Partial<DictionaryCreateInfo>): Promise<string>

- Defined in src/modules/Account/Dictionaries.ts:72
Modify any property of a dictionary.

Parameters
- dictionaryID: string
  
  Dictionary ID.
- dictionaryObj: Partial<DictionaryCreateInfo>
  
  Dictionary Object data to be replaced.
Returns Promise<string>

info

info(dictionaryID: string): Promise<DictionaryInfo>

- Defined in src/modules/Account/Dictionaries.ts:103
Get information about a dictionary.

Parameters
- dictionaryID: string
  
  Dictionary ID.
Returns Promise<DictionaryInfo>

languageDelete

languageDelete(dictionaryID: string, locale: string): Promise<string>

- Defined in src/modules/Account/Dictionaries.ts:131
Delete a language from a dictionary.

Parameters
- dictionaryID: string
  
  Dictionary ID.
- locale: string
  
  Language locale string (e.g. en-US).
Returns Promise<string>

languageEdit

languageEdit(dictionaryID: string, locale: string, languageObj: LanguageEditData): Promise<string>

- Defined in src/modules/Account/Dictionaries.ts:113
Parameters
- dictionaryID: string
- locale: string
- languageObj: LanguageEditData
Returns Promise<string>

languageInfo

languageInfo(dictionaryID: string, locale: string, queryObj?: LanguageInfoQuery): Promise<LanguageData>

- Defined in src/modules/Account/Dictionaries.ts:149
Get information about a dictionary by ID.

Parameters
- dictionaryID: string
  
  Dictionary ID.
- locale: string
  
  Language locale string (e.g. en-US).
- Optional queryObj: LanguageInfoQuery
  
  Language info query params.
Returns Promise<LanguageData>

languageInfoBySlug

languageInfoBySlug(slug: string, locale: string, queryObj?: LanguageInfoQuery): Promise<LanguageData>

- Defined in src/modules/Account/Dictionaries.ts:174
Get information about a dictionary querying by slug instead of the dictionary's ID.

Parameters
- slug: string
  
  Dictionary slug.
- locale: string
  
  Language locale string (e.g. en-US).
- Optional queryObj: LanguageInfoQuery
  
  Language info query params.
Returns Promise<LanguageData>

list

list(queryObj?: DictionaryQuery): Promise<DictionaryInfo[]>

- Defined in src/modules/Account/Dictionaries.ts:33
Retrieve a list with all dictionaries from an account.
default
```
queryObj: {
  page: 1,
  fields: ["id", "name", "slug", "languages"],
  filter: {},
  amount: 20,
  orderBy: "name,asc",
}
```
Parameters
- Optional queryObj: DictionaryQuery
  
  Search query params.
Returns Promise<DictionaryInfo[]>