PartnerTranslationApi

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

Method HTTP request Description
partnerTranslationDestroy DELETE /partner-translation/{partnerTranslation} Remove the specified resource from storage
partnerTranslationIndex GET /partner-translation Display a listing of the resource
partnerTranslationShow GET /partner-translation/{partnerTranslation} Display the specified resource
partnerTranslationStore POST /partner-translation Store a newly created resource in storage
partnerTranslationUpdate PATCH /partner-translation/{partnerTranslation} Update the specified resource in storage
partnerTranslationUpdate2 PUT /partner-translation/{partnerTranslation} Update the specified resource in storage

partnerTranslationDestroy

partnerTranslationDestroy()

Example

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

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

let partnerTranslation: string; //The partner translation ID (default to undefined)

const { status, data } = await apiInstance.partnerTranslationDestroy(
    partnerTranslation
);

Parameters

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

partnerTranslationIndex

PartnerTranslationIndex200Response partnerTranslationIndex()

Example

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

const configuration = new Configuration();
const apiInstance = new PartnerTranslationApi(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: `partner`, `language`, `context`, `partnerTranslationImages`. (optional) (default to undefined)

const { status, data } = await apiInstance.partnerTranslationIndex(
    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: `partner`, `language`, `context`, `partnerTranslationImages`. (optional) defaults to undefined

Return type

PartnerTranslationIndex200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

partnerTranslationShow

PartnerTranslationShow200Response partnerTranslationShow()

Example

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

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

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

const { status, data } = await apiInstance.partnerTranslationShow(
    partnerTranslation,
    include
);

Parameters

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

Return type

PartnerTranslationShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

partnerTranslationStore

PartnerTranslationShow200Response partnerTranslationStore(storePartnerTranslationRequest)

Example

import {
    PartnerTranslationApi,
    Configuration,
    StorePartnerTranslationRequest
} from './api';

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

let storePartnerTranslationRequest: StorePartnerTranslationRequest; //

const { status, data } = await apiInstance.partnerTranslationStore(
    storePartnerTranslationRequest
);

Parameters

Name Type Description Notes
storePartnerTranslationRequest StorePartnerTranslationRequest    

Return type

PartnerTranslationShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

partnerTranslationUpdate

PartnerTranslationShow200Response partnerTranslationUpdate(updatePartnerTranslationRequest)

Example

import {
    PartnerTranslationApi,
    Configuration,
    UpdatePartnerTranslationRequest
} from './api';

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

let partnerTranslation: string; //The partner translation ID (default to undefined)
let updatePartnerTranslationRequest: UpdatePartnerTranslationRequest; //

const { status, data } = await apiInstance.partnerTranslationUpdate(
    partnerTranslation,
    updatePartnerTranslationRequest
);

Parameters

Name Type Description Notes
updatePartnerTranslationRequest UpdatePartnerTranslationRequest    
partnerTranslation [string] The partner translation ID defaults to undefined

Return type

PartnerTranslationShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

partnerTranslationUpdate2

PartnerTranslationShow200Response partnerTranslationUpdate2(updatePartnerTranslationRequest)

Example

import {
    PartnerTranslationApi,
    Configuration,
    UpdatePartnerTranslationRequest
} from './api';

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

let partnerTranslation: string; //The partner translation ID (default to undefined)
let updatePartnerTranslationRequest: UpdatePartnerTranslationRequest; //

const { status, data } = await apiInstance.partnerTranslationUpdate2(
    partnerTranslation,
    updatePartnerTranslationRequest
);

Parameters

Name Type Description Notes
updatePartnerTranslationRequest UpdatePartnerTranslationRequest    
partnerTranslation [string] The partner translation ID defaults to undefined

Return type

PartnerTranslationShow200Response

Authorization

http

HTTP request headers

HTTP response details

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