AvailableImageApi

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

Method HTTP request Description
availableImageDestroy DELETE /available-image/{availableImage} Remove the specified resource from storage
availableImageDownload GET /available-image/{availableImage}/download Download the file to the caller
availableImageIndex GET /available-image Display a listing of the resource
availableImageShow GET /available-image/{availableImage} Display the specified resource
availableImageUpdate PATCH /available-image/{availableImage} Update the specified resource in storage
availableImageUpdate3 PUT /available-image/{availableImage} Update the specified resource in storage
availableImageView GET /available-image/{availableImage}/view Returns the image file for direct viewing (e.g., for use in <img> src attribute)

availableImageDestroy

availableImageDestroy()

Example

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

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

let availableImage: string; //The available image ID (default to undefined)

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

Parameters

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

availableImageDownload

object availableImageDownload()

Example

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

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

let availableImage: string; //The available image ID (default to undefined)

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

Parameters

Name Type Description Notes
availableImage [string] The available image ID defaults to undefined

Return type

object

Authorization

http

HTTP request headers

HTTP response details

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

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

availableImageIndex

AvailableImageIndex200Response availableImageIndex()

Example

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

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

AvailableImageIndex200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

availableImageShow

AvailableImageShow200Response availableImageShow()

Example

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

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

let availableImage: string; //The available image ID (default to undefined)

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

Parameters

Name Type Description Notes
availableImage [string] The available image ID defaults to undefined

Return type

AvailableImageShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

availableImageUpdate

AvailableImageShow200Response availableImageUpdate()

Example

import {
    AvailableImageApi,
    Configuration,
    UpdateAvailableImageRequest
} from './api';

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

let availableImage: string; //The available image ID (default to undefined)
let updateAvailableImageRequest: UpdateAvailableImageRequest; // (optional)

const { status, data } = await apiInstance.availableImageUpdate(
    availableImage,
    updateAvailableImageRequest
);

Parameters

Name Type Description Notes
updateAvailableImageRequest UpdateAvailableImageRequest    
availableImage [string] The available image ID defaults to undefined

Return type

AvailableImageShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

availableImageUpdate3

AvailableImageShow200Response availableImageUpdate3()

Example

import {
    AvailableImageApi,
    Configuration,
    UpdateAvailableImageRequest
} from './api';

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

let availableImage: string; //The available image ID (default to undefined)
let updateAvailableImageRequest: UpdateAvailableImageRequest; // (optional)

const { status, data } = await apiInstance.availableImageUpdate3(
    availableImage,
    updateAvailableImageRequest
);

Parameters

Name Type Description Notes
updateAvailableImageRequest UpdateAvailableImageRequest    
availableImage [string] The available image ID defaults to undefined

Return type

AvailableImageShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

availableImageView

object availableImageView()

Example

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

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

let availableImage: string; //The available image ID (default to undefined)

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

Parameters

Name Type Description Notes
availableImage [string] The available image ID defaults to undefined

Return type

object

Authorization

http

HTTP request headers

HTTP response details

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