LanguageTranslationApi

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

Method HTTP request Description
languageTranslationDestroy DELETE /language-translation/{languageTranslation} Remove the specified resource from storage
languageTranslationIndex GET /language-translation Display a listing of the resource
languageTranslationShow GET /language-translation/{languageTranslation} Display the specified resource
languageTranslationStore POST /language-translation Store a newly created resource in storage
languageTranslationUpdate PATCH /language-translation/{languageTranslation} Update the specified resource in storage
languageTranslationUpdate2 PUT /language-translation/{languageTranslation} Update the specified resource in storage

languageTranslationDestroy

languageTranslationDestroy()

Example

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

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

let languageTranslation: string; //The language translation ID (default to undefined)

const { status, data } = await apiInstance.languageTranslationDestroy(
    languageTranslation
);

Parameters

Name Type Description Notes
languageTranslation [string] The language 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

languageTranslationIndex

LanguageTranslationIndex200Response languageTranslationIndex()

Example

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

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

let page: number; // (optional) (default to undefined)
let perPage: number; // (optional) (default to undefined)
let include: string; //Comma-separated list of related resources to include. Valid values: `language`, `displayLanguage`. (optional) (default to undefined)

const { status, data } = await apiInstance.languageTranslationIndex(
    page,
    perPage,
    include
);

Parameters

Name Type Description Notes
page [number]   (optional) defaults to undefined
perPage [number]   (optional) defaults to undefined
include [string] Comma-separated list of related resources to include. Valid values: `language`, `displayLanguage`. (optional) defaults to undefined

Return type

LanguageTranslationIndex200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

languageTranslationShow

LanguageTranslationShow200Response languageTranslationShow()

Example

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

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

let languageTranslation: string; //The language translation ID (default to undefined)
let include: string; //Comma-separated list of related resources to include. Valid values: `language`, `displayLanguage`. (optional) (default to undefined)

const { status, data } = await apiInstance.languageTranslationShow(
    languageTranslation,
    include
);

Parameters

Name Type Description Notes
languageTranslation [string] The language translation ID defaults to undefined
include [string] Comma-separated list of related resources to include. Valid values: `language`, `displayLanguage`. (optional) defaults to undefined

Return type

LanguageTranslationShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `LanguageTranslationResource` | - | |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

languageTranslationStore

LanguageTranslationShow200Response languageTranslationStore(storeLanguageTranslationRequest)

Example

import {
    LanguageTranslationApi,
    Configuration,
    StoreLanguageTranslationRequest
} from './api';

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

let storeLanguageTranslationRequest: StoreLanguageTranslationRequest; //

const { status, data } = await apiInstance.languageTranslationStore(
    storeLanguageTranslationRequest
);

Parameters

Name Type Description Notes
storeLanguageTranslationRequest StoreLanguageTranslationRequest    

Return type

LanguageTranslationShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

languageTranslationUpdate

LanguageTranslationShow200Response languageTranslationUpdate()

Example

import {
    LanguageTranslationApi,
    Configuration,
    UpdateLanguageTranslationRequest
} from './api';

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

let languageTranslation: string; //The language translation ID (default to undefined)
let updateLanguageTranslationRequest: UpdateLanguageTranslationRequest; // (optional)

const { status, data } = await apiInstance.languageTranslationUpdate(
    languageTranslation,
    updateLanguageTranslationRequest
);

Parameters

Name Type Description Notes
updateLanguageTranslationRequest UpdateLanguageTranslationRequest    
languageTranslation [string] The language translation ID defaults to undefined

Return type

LanguageTranslationShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `LanguageTranslationResource` | - | |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

languageTranslationUpdate2

LanguageTranslationShow200Response languageTranslationUpdate2()

Example

import {
    LanguageTranslationApi,
    Configuration,
    UpdateLanguageTranslationRequest
} from './api';

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

let languageTranslation: string; //The language translation ID (default to undefined)
let updateLanguageTranslationRequest: UpdateLanguageTranslationRequest; // (optional)

const { status, data } = await apiInstance.languageTranslationUpdate2(
    languageTranslation,
    updateLanguageTranslationRequest
);

Parameters

Name Type Description Notes
updateLanguageTranslationRequest UpdateLanguageTranslationRequest    
languageTranslation [string] The language translation ID defaults to undefined

Return type

LanguageTranslationShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `LanguageTranslationResource` | - | |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.