AddressApi

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

Method HTTP request Description
addressDestroy DELETE /address/{address} Remove the specified address
addressIndex GET /address Display a listing of addresses
addressShow GET /address/{address} Display the specified address
addressStore POST /address Store a newly created address
addressUpdate PUT /address/{address} Update the specified address

addressDestroy

addressDestroy()

Example

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

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

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

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

Parameters

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

addressIndex

AddressIndex200Response addressIndex()

Example

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

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

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

Parameters

This endpoint does not have any parameters.

Return type

AddressIndex200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

addressShow

AddressStore201Response addressShow()

Example

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

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

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

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

Parameters

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

Return type

AddressStore201Response

Authorization

http

HTTP request headers

HTTP response details

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

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

addressStore

AddressStore201Response addressStore(addressStoreRequest)

Example

import {
    AddressApi,
    Configuration,
    AddressStoreRequest
} from './api';

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

let addressStoreRequest: AddressStoreRequest; //

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

Parameters

Name Type Description Notes
addressStoreRequest AddressStoreRequest    

Return type

AddressStore201Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |201 | `AddressResource` | - | |422 | | - | |401 | Unauthenticated | - |

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

addressUpdate

AddressStore201Response addressUpdate(addressUpdateRequest)

Example

import {
    AddressApi,
    Configuration,
    AddressUpdateRequest
} from './api';

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

let address: string; //The address ID (default to undefined)
let addressUpdateRequest: AddressUpdateRequest; //

const { status, data } = await apiInstance.addressUpdate(
    address,
    addressUpdateRequest
);

Parameters

Name Type Description Notes
addressUpdateRequest AddressUpdateRequest    
address [string] The address ID defaults to undefined

Return type

AddressStore201Response

Authorization

http

HTTP request headers

HTTP response details

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