import { TypeList } from "docs-ui"

createTranslationSettings - Translation Module Reference

This documentation provides a reference to the createTranslationSettings method. This belongs to the Translation Module.

You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

createTranslationSettings(data, sharedContext?): Promise<TranslationSettingsDTO>

This method creates a translation setting.

Example

const translationSetting = await translationModuleService.createTranslationSettings({
    entity_type: "product",
    fields: ["title", "description"],
    is_active: true,
  })

Parameters

<TypeList types={[{"name":"data","type":"CreateTranslationSettingsDTO","description":"The translation setting to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"entity_type","type":"string","description":"The entity type.","optional":false,"defaultValue":"","example":""product"","expandable":false,"children":[]},{"name":"fields","type":"string[]","description":"The translatable fields.","optional":false,"defaultValue":"","example":"["title", "description", "material"]","expandable":false,"children":[]},{"name":"is_active","type":"boolean","description":"Whether the entity translatable status is enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"Context","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type TManager, which is a typed parameter passed to the context to specify the type of the transactionManager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type TManager, which is a typed parameter passed to the context to specify the type of the manager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"string","description":"A string indicating the isolation level of the context. Possible values are READ UNCOMMITTED, READ COMMITTED, REPEATABLE READ, or SERIALIZABLE.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"boolean","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"string","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"string","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runId","type":"string","description":"A string indicating the ID of the current run.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"IMessageAggregator","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"string","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"boolean","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isCancelling","type":"boolean","description":"A boolean value indicating whether the current workflow execution is being cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cancelingFromParentStep","type":"boolean","description":"Weither or not a sub workflow cancellation is being triggered from a parent step.\nIf true, the parent step will not be triggered by the sub workflow.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTranslationSettings"/>

Returns

<TypeList types={[{"name":"Promise","type":"Promise<TranslationSettingsDTO>","optional":false,"defaultValue":"","description":"The created translation setting.","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the settings record.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_type","type":"string","description":"The entity type these settings apply to (e.g., "product", "product\_variant").","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"string[]","description":"The translatable fields for this entity type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"boolean","description":"Whether the entity translatable status is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"The date and time the settings were created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"The date and time the settings were last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"null \| string \| Date","description":"The date and time the settings were deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTranslationSettings"/>

createTranslationSettings(data, sharedContext?): Promise<TranslationSettingsDTO[]>

Example

const translationSettings = await translationModuleService.createTranslationSettings([
  {
    entity_type: "product",
    fields: ["title", "description"],
    is_active: true,
  },
])

Parameters

<TypeList types={[{"name":"data","type":"CreateTranslationSettingsDTO[]","description":"The translation settings to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"entity_type","type":"string","description":"The entity type.","optional":false,"defaultValue":"","example":""product"","expandable":false,"children":[]},{"name":"fields","type":"string[]","description":"The translatable fields.","optional":false,"defaultValue":"","example":"["title", "description", "material"]","expandable":false,"children":[]},{"name":"is_active","type":"boolean","description":"Whether the entity translatable status is enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"Context","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type TManager, which is a typed parameter passed to the context to specify the type of the transactionManager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type TManager, which is a typed parameter passed to the context to specify the type of the manager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"string","description":"A string indicating the isolation level of the context. Possible values are READ UNCOMMITTED, READ COMMITTED, REPEATABLE READ, or SERIALIZABLE.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"boolean","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"string","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"string","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runId","type":"string","description":"A string indicating the ID of the current run.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"IMessageAggregator","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"string","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"boolean","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isCancelling","type":"boolean","description":"A boolean value indicating whether the current workflow execution is being cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cancelingFromParentStep","type":"boolean","description":"Weither or not a sub workflow cancellation is being triggered from a parent step.\nIf true, the parent step will not be triggered by the sub workflow.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTranslationSettings"/>

Returns

<TypeList types={[{"name":"Promise","type":"Promise<TranslationSettingsDTO[]>","optional":false,"defaultValue":"","description":"The created translation settings.","expandable":false,"children":[{"name":"TranslationSettingsDTO[]","type":"TranslationSettingsDTO[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the settings record.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_type","type":"string","description":"The entity type these settings apply to (e.g., "product", "product\_variant").","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"string[]","description":"The translatable fields for this entity type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"boolean","description":"Whether the entity translatable status is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"The date and time the settings were created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"The date and time the settings were last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"null \| string \| Date","description":"The date and time the settings were deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTranslationSettings"/>