ContactApi
All URIs are relative to http://localhost:8000/api
Method | HTTP request | Description |
---|---|---|
contactDestroy | DELETE /contact/{contact} | Remove the specified contact |
contactIndex | GET /contact | Display a listing of contacts |
contactShow | GET /contact/{contact} | Display the specified contact |
contactStore | POST /contact | Store a newly created contact |
contactUpdate | PUT /contact/{contact} | Update the specified contact |
contactDestroy
contactDestroy()
Example
import {
ContactApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ContactApi(configuration);
let contact: string; //The contact ID (default to undefined)
const { status, data } = await apiInstance.contactDestroy(
contact
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
contact | [string] | The contact 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
contactIndex
ContactIndex200Response contactIndex()
Example
import {
ContactApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ContactApi(configuration);
const { status, data } = await apiInstance.contactIndex();
Parameters
This endpoint does not have any parameters.
Return type
ContactIndex200Response
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `ContactResource` | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
contactShow
ContactStore201Response contactShow()
Example
import {
ContactApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ContactApi(configuration);
let contact: string; //The contact ID (default to undefined)
const { status, data } = await apiInstance.contactShow(
contact
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
contact | [string] | The contact ID | defaults to undefined |
Return type
ContactStore201Response
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `ContactResource` | - | |404 | Not found | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
contactStore
ContactStore201Response contactStore(contactStoreRequest)
Example
import {
ContactApi,
Configuration,
ContactStoreRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new ContactApi(configuration);
let contactStoreRequest: ContactStoreRequest; //
const { status, data } = await apiInstance.contactStore(
contactStoreRequest
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
contactStoreRequest | ContactStoreRequest |
Return type
ContactStore201Response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |201 | `ContactResource` | - | |422 | | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
contactUpdate
ContactStore201Response contactUpdate(contactUpdateRequest)
Example
import {
ContactApi,
Configuration,
ContactUpdateRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new ContactApi(configuration);
let contact: string; //The contact ID (default to undefined)
let contactUpdateRequest: ContactUpdateRequest; //
const { status, data } = await apiInstance.contactUpdate(
contact,
contactUpdateRequest
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
contactUpdateRequest | ContactUpdateRequest | ||
contact | [string] | The contact ID | defaults to undefined |
Return type
ContactStore201Response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `ContactResource` | - | |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.