ContactApi

All URIs are relative to http://127.0.0.1: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 PATCH /contact/{contact} Update the specified contact
contactUpdate2 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

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

contactIndex

ContactIndex200Response contactIndex()

Example

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

const configuration = new Configuration();
const apiInstance = new ContactApi(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.contactIndex(
    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

ContactIndex200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

contactShow

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

const { status, data } = await apiInstance.contactShow(
    contact,
    include
);

Parameters

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

Return type

ContactShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

contactStore

ContactShow200Response contactStore(storeContactRequest)

Example

import {
    ContactApi,
    Configuration,
    StoreContactRequest
} from './api';

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

let storeContactRequest: StoreContactRequest; //

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

Parameters

Name Type Description Notes
storeContactRequest StoreContactRequest    

Return type

ContactShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

contactUpdate

ContactShow200Response contactUpdate(updateContactRequest)

Example

import {
    ContactApi,
    Configuration,
    UpdateContactRequest
} from './api';

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

let contact: string; //The contact ID (default to undefined)
let updateContactRequest: UpdateContactRequest; //

const { status, data } = await apiInstance.contactUpdate(
    contact,
    updateContactRequest
);

Parameters

Name Type Description Notes
updateContactRequest UpdateContactRequest    
contact [string] The contact ID defaults to undefined

Return type

ContactShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

contactUpdate2

ContactShow200Response contactUpdate2(updateContactRequest)

Example

import {
    ContactApi,
    Configuration,
    UpdateContactRequest
} from './api';

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

let contact: string; //The contact ID (default to undefined)
let updateContactRequest: UpdateContactRequest; //

const { status, data } = await apiInstance.contactUpdate2(
    contact,
    updateContactRequest
);

Parameters

Name Type Description Notes
updateContactRequest UpdateContactRequest    
contact [string] The contact ID defaults to undefined

Return type

ContactShow200Response

Authorization

http

HTTP request headers

HTTP response details

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