AddressTranslationApi

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

Method HTTP request Description
addressTranslationDestroy DELETE /address-translation/{addressTranslation} Remove the specified resource from storage
addressTranslationIndex GET /address-translation Display a listing of the resource
addressTranslationShow GET /address-translation/{addressTranslation} Display the specified resource
addressTranslationStore POST /address-translation Store a newly created resource in storage
addressTranslationUpdate PATCH /address-translation/{addressTranslation} Update the specified resource in storage
addressTranslationUpdate2 PUT /address-translation/{addressTranslation} Update the specified resource in storage

addressTranslationDestroy

addressTranslationDestroy()

Example

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

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

let addressTranslation: string; //The address translation ID (default to undefined)

const { status, data } = await apiInstance.addressTranslationDestroy(
    addressTranslation
);

Parameters

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

addressTranslationIndex

AddressTranslationIndex200Response addressTranslationIndex()

Example

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

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

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

Parameters

This endpoint does not have any parameters.

Return type

AddressTranslationIndex200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `AddressTranslationResource` | - | |401 | Unauthenticated | - |

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

addressTranslationShow

AddressTranslationShow200Response addressTranslationShow()

Example

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

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

let addressTranslation: string; //The address translation ID (default to undefined)

const { status, data } = await apiInstance.addressTranslationShow(
    addressTranslation
);

Parameters

Name Type Description Notes
addressTranslation [string] The address translation ID defaults to undefined

Return type

AddressTranslationShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `AddressTranslationResource` | - | |404 | Not found | - | |401 | Unauthenticated | - |

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

addressTranslationStore

AddressTranslationShow200Response addressTranslationStore(storeAddressTranslationRequest)

Example

import {
    AddressTranslationApi,
    Configuration,
    StoreAddressTranslationRequest
} from './api';

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

let storeAddressTranslationRequest: StoreAddressTranslationRequest; //

const { status, data } = await apiInstance.addressTranslationStore(
    storeAddressTranslationRequest
);

Parameters

Name Type Description Notes
storeAddressTranslationRequest StoreAddressTranslationRequest    

Return type

AddressTranslationShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

addressTranslationUpdate

AddressTranslationShow200Response addressTranslationUpdate()

Example

import {
    AddressTranslationApi,
    Configuration,
    UpdateAddressTranslationRequest
} from './api';

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

let addressTranslation: string; //The address translation ID (default to undefined)
let updateAddressTranslationRequest: UpdateAddressTranslationRequest; // (optional)

const { status, data } = await apiInstance.addressTranslationUpdate(
    addressTranslation,
    updateAddressTranslationRequest
);

Parameters

Name Type Description Notes
updateAddressTranslationRequest UpdateAddressTranslationRequest    
addressTranslation [string] The address translation ID defaults to undefined

Return type

AddressTranslationShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

addressTranslationUpdate2

AddressTranslationShow200Response addressTranslationUpdate2()

Example

import {
    AddressTranslationApi,
    Configuration,
    UpdateAddressTranslationRequest
} from './api';

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

let addressTranslation: string; //The address translation ID (default to undefined)
let updateAddressTranslationRequest: UpdateAddressTranslationRequest; // (optional)

const { status, data } = await apiInstance.addressTranslationUpdate2(
    addressTranslation,
    updateAddressTranslationRequest
);

Parameters

Name Type Description Notes
updateAddressTranslationRequest UpdateAddressTranslationRequest    
addressTranslation [string] The address translation ID defaults to undefined

Return type

AddressTranslationShow200Response

Authorization

http

HTTP request headers

HTTP response details

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