AddressApi

All URIs are relative to http://127.0.0.1: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 PATCH /address/{address} Update the specified address
addressUpdate2 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);

let page: number; // (optional) (default to undefined)
let perPage: number; // (optional) (default to undefined)
let include: string; // (optional) (default to undefined)

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

Parameters

Name Type Description Notes
page [number]   (optional) defaults to undefined
perPage [number]   (optional) defaults to undefined
include [string]   (optional) defaults to undefined

Return type

AddressIndex200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

addressShow

AddressShow200Response 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)
let include: string; // (optional) (default to undefined)

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

Parameters

Name Type Description Notes
address [string] The address ID defaults to undefined
include [string]   (optional) defaults to undefined

Return type

AddressShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

addressStore

AddressShow200Response addressStore(storeAddressRequest)

Example

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

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

let storeAddressRequest: StoreAddressRequest; //

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

Parameters

Name Type Description Notes
storeAddressRequest StoreAddressRequest    

Return type

AddressShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

addressUpdate

AddressShow200Response addressUpdate(updateAddressRequest)

Example

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

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

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

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

Parameters

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

Return type

AddressShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

addressUpdate2

AddressShow200Response addressUpdate2(updateAddressRequest)

Example

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

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

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

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

Parameters

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

Return type

AddressShow200Response

Authorization

http

HTTP request headers

HTTP response details

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