PictureApi

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

Method HTTP request Description
pictureAttachToDetail POST /detail/{detail}/pictures Attach an AvailableImage to a Detail
pictureAttachToItem POST /item/{item}/pictures Attach an AvailableImage to an Item
pictureAttachToPartner POST /partner/{partner}/pictures Attach an AvailableImage to a Partner
pictureDestroy DELETE /picture/{picture} Remove the specified resource from storage
pictureDetachFromDetail DELETE /detail/{detail}/pictures/{picture} Detach a Picture from a Detail and convert it back to AvailableImage
pictureDetachFromItem DELETE /item/{item}/pictures/{picture} Detach a Picture from an Item and convert it back to AvailableImage
pictureDetachFromPartner DELETE /partner/{partner}/pictures/{picture} Detach a Picture from a Partner and convert it back to AvailableImage
pictureDownload GET /picture/{picture}/download Returns the file to the caller for download
pictureIndex GET /picture Display a listing of the resource
pictureShow GET /picture/{picture} Display the specified resource
pictureUpdate PUT /picture/{picture} Update the specified resource in storage
pictureView GET /picture/{picture}/view Returns the picture file for direct viewing (e.g., for use in <img> src attribute)

pictureAttachToDetail

string pictureAttachToDetail()

Example

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

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

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

const { status, data } = await apiInstance.pictureAttachToDetail(
    detail
);

Parameters

Name Type Description Notes
detail [string] The detail ID defaults to undefined

Return type

string

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

pictureAttachToItem

string pictureAttachToItem()

Example

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

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

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

const { status, data } = await apiInstance.pictureAttachToItem(
    item
);

Parameters

Name Type Description Notes
item [string] The item ID defaults to undefined

Return type

string

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

pictureAttachToPartner

string pictureAttachToPartner()

Example

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

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

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

const { status, data } = await apiInstance.pictureAttachToPartner(
    partner
);

Parameters

Name Type Description Notes
partner [string] The partner ID defaults to undefined

Return type

string

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

pictureDestroy

pictureDestroy()

Example

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

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

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

const { status, data } = await apiInstance.pictureDestroy(
    picture
);

Parameters

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

pictureDetachFromDetail

string pictureDetachFromDetail()

Example

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

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

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

const { status, data } = await apiInstance.pictureDetachFromDetail(
    detail,
    picture
);

Parameters

Name Type Description Notes
detail [string] The detail ID defaults to undefined
picture [string] The picture ID defaults to undefined

Return type

string

Authorization

http

HTTP request headers

HTTP response details

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

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

pictureDetachFromItem

string pictureDetachFromItem()

Example

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

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

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

const { status, data } = await apiInstance.pictureDetachFromItem(
    item,
    picture
);

Parameters

Name Type Description Notes
item [string] The item ID defaults to undefined
picture [string] The picture ID defaults to undefined

Return type

string

Authorization

http

HTTP request headers

HTTP response details

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

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

pictureDetachFromPartner

string pictureDetachFromPartner()

Example

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

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

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

const { status, data } = await apiInstance.pictureDetachFromPartner(
    partner,
    picture
);

Parameters

Name Type Description Notes
partner [string] The partner ID defaults to undefined
picture [string] The picture ID defaults to undefined

Return type

string

Authorization

http

HTTP request headers

HTTP response details

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

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

pictureDownload

string pictureDownload()

Example

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

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

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

const { status, data } = await apiInstance.pictureDownload(
    picture
);

Parameters

Name Type Description Notes
picture [string] The picture ID defaults to undefined

Return type

string

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

pictureIndex

PictureIndex200Response pictureIndex()

Example

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

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

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

Parameters

This endpoint does not have any parameters.

Return type

PictureIndex200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `PictureResource` | - | |401 | Unauthenticated | - |

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

pictureShow

PictureShow200Response pictureShow()

Example

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

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

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

const { status, data } = await apiInstance.pictureShow(
    picture
);

Parameters

Name Type Description Notes
picture [string] The picture ID defaults to undefined

Return type

PictureShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

pictureUpdate

PictureShow200Response pictureUpdate(pictureUpdateRequest)

Example

import {
    PictureApi,
    Configuration,
    PictureUpdateRequest
} from './api';

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

let picture: string; //The picture ID (default to undefined)
let pictureUpdateRequest: PictureUpdateRequest; //

const { status, data } = await apiInstance.pictureUpdate(
    picture,
    pictureUpdateRequest
);

Parameters

Name Type Description Notes
pictureUpdateRequest PictureUpdateRequest    
picture [string] The picture ID defaults to undefined

Return type

PictureShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `PictureResource` | - | |422 | Validation error | - | |404 | Not found | - | |401 | Unauthenticated | - |

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

pictureView

string pictureView()

Example

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

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

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

const { status, data } = await apiInstance.pictureView(
    picture
);

Parameters

Name Type Description Notes
picture [string] The picture ID defaults to undefined

Return type

string

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.