AddressTranslationApi
All URIs are relative to http://localhost: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 | 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 request headers
- Content-Type: Not defined
- Accept: application/json
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 request headers
- Content-Type: Not defined
- Accept: application/json
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
AddressTranslationStore200Response 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
AddressTranslationStore200Response
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
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
AddressTranslationStore200Response addressTranslationStore(addressTranslationStoreRequest)
Example
import {
AddressTranslationApi,
Configuration,
AddressTranslationStoreRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new AddressTranslationApi(configuration);
let addressTranslationStoreRequest: AddressTranslationStoreRequest; //
const { status, data } = await apiInstance.addressTranslationStore(
addressTranslationStoreRequest
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
addressTranslationStoreRequest | AddressTranslationStoreRequest |
Return type
AddressTranslationStore200Response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `AddressTranslationResource` | - | |422 | Validation error | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
addressTranslationUpdate
AddressTranslationStore200Response addressTranslationUpdate()
Example
import {
AddressTranslationApi,
Configuration,
AddressTranslationUpdateRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new AddressTranslationApi(configuration);
let addressTranslation: string; //The address translation ID (default to undefined)
let addressTranslationUpdateRequest: AddressTranslationUpdateRequest; // (optional)
const { status, data } = await apiInstance.addressTranslationUpdate(
addressTranslation,
addressTranslationUpdateRequest
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
addressTranslationUpdateRequest | AddressTranslationUpdateRequest | ||
addressTranslation | [string] | The address translation ID | defaults to undefined |
Return type
AddressTranslationStore200Response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `AddressTranslationResource` | - | |422 | Validation error | - | |404 | Not found | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
This documentation was automatically generated from the TypeScript API client.