ThemeApi

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

Method HTTP request Description
themeDestroy DELETE /theme/{theme} Remove the specified theme from storage
themeIndex GET /theme Display a listing of the resource
themeShow GET /theme/{theme} Display the specified resource
themeStore POST /theme Store a newly created theme in storage
themeUpdate PATCH /theme/{theme} Update the specified theme in storage
themeUpdate2 PUT /theme/{theme} Update the specified theme in storage

themeDestroy

themeDestroy()

Example

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

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

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

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

Parameters

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

themeIndex

ThemeIndex200Response themeIndex()

Example

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

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

ThemeIndex200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

themeShow

ThemeShow200Response themeShow()

Example

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

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

let theme: string; //The theme ID (default to undefined)
let include: string; // (optional) (default to undefined)

const { status, data } = await apiInstance.themeShow(
    theme,
    include
);

Parameters

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

Return type

ThemeShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

themeStore

ThemeShow200Response themeStore(storeThemeRequest)

Example

import {
    ThemeApi,
    Configuration,
    StoreThemeRequest
} from './api';

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

let storeThemeRequest: StoreThemeRequest; //

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

Parameters

Name Type Description Notes
storeThemeRequest StoreThemeRequest    

Return type

ThemeShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

themeUpdate

ThemeShow200Response themeUpdate()

Example

import {
    ThemeApi,
    Configuration,
    UpdateThemeRequest
} from './api';

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

let theme: string; //The theme ID (default to undefined)
let updateThemeRequest: UpdateThemeRequest; // (optional)

const { status, data } = await apiInstance.themeUpdate(
    theme,
    updateThemeRequest
);

Parameters

Name Type Description Notes
updateThemeRequest UpdateThemeRequest    
theme [string] The theme ID defaults to undefined

Return type

ThemeShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

themeUpdate2

ThemeShow200Response themeUpdate2()

Example

import {
    ThemeApi,
    Configuration,
    UpdateThemeRequest
} from './api';

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

let theme: string; //The theme ID (default to undefined)
let updateThemeRequest: UpdateThemeRequest; // (optional)

const { status, data } = await apiInstance.themeUpdate2(
    theme,
    updateThemeRequest
);

Parameters

Name Type Description Notes
updateThemeRequest UpdateThemeRequest    
theme [string] The theme ID defaults to undefined

Return type

ThemeShow200Response

Authorization

http

HTTP request headers

HTTP response details

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