ItemImageApi

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

Method HTTP request Description
itemAttachImage POST /item/{item}/attach-image Attach an available image to an item
itemImageDestroy DELETE /item-image/{itemImage} Remove the specified item image
itemImageDetach POST /item-image/{itemImage}/detach Detach an item image and convert it back to available image
itemImageDownload GET /item-image/{itemImage}/download Returns the file to the caller
itemImageMoveDown PATCH /item-image/{itemImage}/move-down Move item image down in display order
itemImageMoveUp PATCH /item-image/{itemImage}/move-up Move item image up in display order
itemImageShow GET /item-image/{itemImage} Display the specified item image
itemImageTightenOrdering PATCH /item-image/{itemImage}/tighten-ordering Tighten ordering for all images of the item
itemImageUpdate PATCH /item-image/{itemImage} Update the specified item image
itemImageUpdate2 PUT /item-image/{itemImage} Update the specified item image
itemImageView GET /item-image/{itemImage}/view Returns the image file for direct viewing (e.g., for use in <img> src attribute)
itemImagesIndex GET /item/{item}/images Display a listing of item images for a specific item
itemImagesStore POST /item/{item}/images Store a newly created item image

itemAttachImage

ItemImagesStore200Response itemAttachImage(attachFromAvailableItemImageRequest)

Example

import {
    ItemImageApi,
    Configuration,
    AttachFromAvailableItemImageRequest
} from './api';

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

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

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

Parameters

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

Return type

ItemImagesStore200Response

Authorization

http

HTTP request headers

HTTP response details

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

itemImageDestroy

itemImageDestroy()

Example

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

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

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

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

Parameters

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

itemImageDetach

CollectionAttachItem200Response itemImageDetach()

Example

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

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

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

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

Parameters

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

Return type

CollectionAttachItem200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

itemImageDownload

object itemImageDownload()

Example

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

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

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

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

Parameters

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

itemImageMoveDown

ItemImagesStore200Response itemImageMoveDown()

Example

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

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

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

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

Parameters

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

Return type

ItemImagesStore200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

itemImageMoveUp

ItemImagesStore200Response itemImageMoveUp()

Example

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

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

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

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

Parameters

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

Return type

ItemImagesStore200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

itemImageShow

ItemImagesStore200Response itemImageShow()

Example

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

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

let itemImage: string; //The item image ID (default to undefined)
let include: string; // (optional) (default to undefined)

const { status, data } = await apiInstance.itemImageShow(
    itemImage,
    include
);

Parameters

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

Return type

ItemImagesStore200Response

Authorization

http

HTTP request headers

HTTP response details

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

itemImageTightenOrdering

CollectionAttachItem200Response itemImageTightenOrdering()

Example

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

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

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

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

Parameters

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

Return type

CollectionAttachItem200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

itemImageUpdate

ItemImagesStore200Response itemImageUpdate()

Example

import {
    ItemImageApi,
    Configuration,
    UpdateItemImageRequest
} from './api';

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

let itemImage: string; //The item image ID (default to undefined)
let updateItemImageRequest: UpdateItemImageRequest; // (optional)

const { status, data } = await apiInstance.itemImageUpdate(
    itemImage,
    updateItemImageRequest
);

Parameters

Name Type Description Notes
updateItemImageRequest UpdateItemImageRequest    
itemImage [string] The item image ID defaults to undefined

Return type

ItemImagesStore200Response

Authorization

http

HTTP request headers

HTTP response details

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

itemImageUpdate2

ItemImagesStore200Response itemImageUpdate2()

Example

import {
    ItemImageApi,
    Configuration,
    UpdateItemImageRequest
} from './api';

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

let itemImage: string; //The item image ID (default to undefined)
let updateItemImageRequest: UpdateItemImageRequest; // (optional)

const { status, data } = await apiInstance.itemImageUpdate2(
    itemImage,
    updateItemImageRequest
);

Parameters

Name Type Description Notes
updateItemImageRequest UpdateItemImageRequest    
itemImage [string] The item image ID defaults to undefined

Return type

ItemImagesStore200Response

Authorization

http

HTTP request headers

HTTP response details

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

itemImageView

object itemImageView()

Example

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

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

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

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

Parameters

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

itemImagesIndex

ItemImagesIndex200Response itemImagesIndex()

Example

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

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

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

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

Parameters

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

Return type

ItemImagesIndex200Response

Authorization

http

HTTP request headers

HTTP response details

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

itemImagesStore

ItemImagesStore200Response itemImagesStore(storeItemImageRequest)

Example

import {
    ItemImageApi,
    Configuration,
    StoreItemImageRequest
} from './api';

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

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

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

Parameters

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

Return type

ItemImagesStore200Response

Authorization

http

HTTP request headers

HTTP response details

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