ItemTranslationsApi

All URIs are relative to http://127.0.0.1:8000/api

Method HTTP request Description
itemTranslationDestroy DELETE /item-translation/{itemTranslation} Remove the specified item translation
itemTranslationIndex GET /item-translation Display a listing of item translations
itemTranslationShow GET /item-translation/{itemTranslation} Display the specified item translation
itemTranslationStore POST /item-translation Store a newly created item translation
itemTranslationUpdate PATCH /item-translation/{itemTranslation} Update the specified item translation
itemTranslationUpdate2 PUT /item-translation/{itemTranslation} Update the specified item translation

itemTranslationDestroy

itemTranslationDestroy()

Example

import {
    ItemTranslationsApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new ItemTranslationsApi(configuration);

let itemTranslation: string; //The item translation ID (default to undefined)

const { status, data } = await apiInstance.itemTranslationDestroy(
    itemTranslation
);

Parameters

Name Type Description Notes
itemTranslation [string] The item translation ID defaults to undefined

Return type

void (empty response body)

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |204 | No content | - | |404 | Not found | - | |401 | Unauthenticated | - |

Back to top Back to API list Back to Model list Back to README

itemTranslationIndex

ItemTranslationIndex200Response itemTranslationIndex()

Example

import {
    ItemTranslationsApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new ItemTranslationsApi(configuration);

let page: number; // (optional) (default to undefined)
let perPage: number; // (optional) (default to undefined)
let itemId: string; // (optional) (default to undefined)
let languageId: string; // (optional) (default to undefined)
let contextId: string; // (optional) (default to undefined)
let defaultContext: boolean; // (optional) (default to undefined)

const { status, data } = await apiInstance.itemTranslationIndex(
    page,
    perPage,
    itemId,
    languageId,
    contextId,
    defaultContext
);

Parameters

Name Type Description Notes
page [number]   (optional) defaults to undefined
perPage [number]   (optional) defaults to undefined
itemId [string]   (optional) defaults to undefined
languageId [string]   (optional) defaults to undefined
contextId [string]   (optional) defaults to undefined
defaultContext [boolean]   (optional) defaults to undefined

Return type

ItemTranslationIndex200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | Paginated set of `ItemTranslationResource` | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

itemTranslationShow

ItemTranslationShow200Response itemTranslationShow()

Example

import {
    ItemTranslationsApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new ItemTranslationsApi(configuration);

let itemTranslation: string; //The item translation ID (default to undefined)
let include: string; //Comma-separated list of related resources to include. Valid values: `item`, `language`, `context`, `author`, `textCopyEditor`, `translator`, `translationCopyEditor`. (optional) (default to undefined)

const { status, data } = await apiInstance.itemTranslationShow(
    itemTranslation,
    include
);

Parameters

Name Type Description Notes
itemTranslation [string] The item translation ID defaults to undefined
include [string] Comma-separated list of related resources to include. Valid values: `item`, `language`, `context`, `author`, `textCopyEditor`, `translator`, `translationCopyEditor`. (optional) defaults to undefined

Return type

ItemTranslationShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `ItemTranslationResource` | - | |404 | Not found | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

itemTranslationStore

ItemTranslationShow200Response itemTranslationStore(storeItemTranslationRequest)

Example

import {
    ItemTranslationsApi,
    Configuration,
    StoreItemTranslationRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new ItemTranslationsApi(configuration);

let storeItemTranslationRequest: StoreItemTranslationRequest; //

const { status, data } = await apiInstance.itemTranslationStore(
    storeItemTranslationRequest
);

Parameters

Name Type Description Notes
storeItemTranslationRequest StoreItemTranslationRequest    

Return type

ItemTranslationShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `ItemTranslationResource` | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

itemTranslationUpdate

ItemTranslationShow200Response itemTranslationUpdate()

Example

import {
    ItemTranslationsApi,
    Configuration,
    UpdateItemTranslationRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new ItemTranslationsApi(configuration);

let itemTranslation: string; //The item translation ID (default to undefined)
let updateItemTranslationRequest: UpdateItemTranslationRequest; // (optional)

const { status, data } = await apiInstance.itemTranslationUpdate(
    itemTranslation,
    updateItemTranslationRequest
);

Parameters

Name Type Description Notes
updateItemTranslationRequest UpdateItemTranslationRequest    
itemTranslation [string] The item translation ID defaults to undefined

Return type

ItemTranslationShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `ItemTranslationResource` | - | |404 | Not found | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

itemTranslationUpdate2

ItemTranslationShow200Response itemTranslationUpdate2()

Example

import {
    ItemTranslationsApi,
    Configuration,
    UpdateItemTranslationRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new ItemTranslationsApi(configuration);

let itemTranslation: string; //The item translation ID (default to undefined)
let updateItemTranslationRequest: UpdateItemTranslationRequest; // (optional)

const { status, data } = await apiInstance.itemTranslationUpdate2(
    itemTranslation,
    updateItemTranslationRequest
);

Parameters

Name Type Description Notes
updateItemTranslationRequest UpdateItemTranslationRequest    
itemTranslation [string] The item translation ID defaults to undefined

Return type

ItemTranslationShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `ItemTranslationResource` | - | |404 | Not found | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

This documentation was automatically generated from the TypeScript API client.