CollectionImageApi

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

Method HTTP request Description
collectionAttachImage POST /collection/{collection}/attach-image Attach an available image to a collection
collectionImageDestroy DELETE /collection-image/{collectionImage} Remove the specified collection image
collectionImageDetach POST /collection-image/{collectionImage}/detach Detach a collection image and convert it back to available image
collectionImageDownload GET /collection-image/{collectionImage}/download Returns the file to the caller
collectionImageMoveDown PATCH /collection-image/{collectionImage}/move-down Move collection image down in display order
collectionImageMoveUp PATCH /collection-image/{collectionImage}/move-up Move collection image up in display order
collectionImageShow GET /collection-image/{collectionImage} Display the specified collection image
collectionImageTightenOrdering PATCH /collection-image/{collectionImage}/tighten-ordering Tighten ordering for all images of the collection
collectionImageUpdate PATCH /collection-image/{collectionImage} Update the specified collection image
collectionImageUpdate2 PUT /collection-image/{collectionImage} Update the specified collection image
collectionImageView GET /collection-image/{collectionImage}/view Returns the image file for direct viewing (e.g., for use in <img> src attribute)
collectionImagesIndex GET /collection/{collection}/images Display a listing of collection images for a specific collection
collectionImagesStore POST /collection/{collection}/images Store a newly created collection image

collectionAttachImage

CollectionImagesStore200Response collectionAttachImage(attachFromAvailableCollectionImageRequest)

Example

import {
    CollectionImageApi,
    Configuration,
    AttachFromAvailableCollectionImageRequest
} from './api';

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

let collection: string; //The collection ID (default to undefined)
let attachFromAvailableCollectionImageRequest: AttachFromAvailableCollectionImageRequest; //

const { status, data } = await apiInstance.collectionAttachImage(
    collection,
    attachFromAvailableCollectionImageRequest
);

Parameters

Name Type Description Notes
attachFromAvailableCollectionImageRequest AttachFromAvailableCollectionImageRequest    
collection [string] The collection ID defaults to undefined

Return type

CollectionImagesStore200Response

Authorization

http

HTTP request headers

HTTP response details

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

collectionImageDestroy

collectionImageDestroy()

Example

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

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

let collectionImage: string; //The collection image ID (default to undefined)

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

Parameters

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

collectionImageDetach

CollectionAttachItem200Response collectionImageDetach()

Example

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

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

let collectionImage: string; //The collection image ID (default to undefined)

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

Parameters

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

collectionImageDownload

object collectionImageDownload()

Example

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

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

let collectionImage: string; //The collection image ID (default to undefined)

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

Parameters

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

collectionImageMoveDown

CollectionImagesStore200Response collectionImageMoveDown()

Example

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

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

let collectionImage: string; //The collection image ID (default to undefined)

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

Parameters

Name Type Description Notes
collectionImage [string] The collection image ID defaults to undefined

Return type

CollectionImagesStore200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

collectionImageMoveUp

CollectionImagesStore200Response collectionImageMoveUp()

Example

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

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

let collectionImage: string; //The collection image ID (default to undefined)

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

Parameters

Name Type Description Notes
collectionImage [string] The collection image ID defaults to undefined

Return type

CollectionImagesStore200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

collectionImageShow

CollectionImagesStore200Response collectionImageShow()

Example

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

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

let collectionImage: string; //The collection image ID (default to undefined)
let include: string; // (optional) (default to undefined)

const { status, data } = await apiInstance.collectionImageShow(
    collectionImage,
    include
);

Parameters

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

Return type

CollectionImagesStore200Response

Authorization

http

HTTP request headers

HTTP response details

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

collectionImageTightenOrdering

CollectionAttachItem200Response collectionImageTightenOrdering()

Example

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

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

let collectionImage: string; //The collection image ID (default to undefined)

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

Parameters

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

collectionImageUpdate

CollectionImagesStore200Response collectionImageUpdate()

Example

import {
    CollectionImageApi,
    Configuration,
    UpdateCollectionImageRequest
} from './api';

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

let collectionImage: string; //The collection image ID (default to undefined)
let updateCollectionImageRequest: UpdateCollectionImageRequest; // (optional)

const { status, data } = await apiInstance.collectionImageUpdate(
    collectionImage,
    updateCollectionImageRequest
);

Parameters

Name Type Description Notes
updateCollectionImageRequest UpdateCollectionImageRequest    
collectionImage [string] The collection image ID defaults to undefined

Return type

CollectionImagesStore200Response

Authorization

http

HTTP request headers

HTTP response details

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

collectionImageUpdate2

CollectionImagesStore200Response collectionImageUpdate2()

Example

import {
    CollectionImageApi,
    Configuration,
    UpdateCollectionImageRequest
} from './api';

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

let collectionImage: string; //The collection image ID (default to undefined)
let updateCollectionImageRequest: UpdateCollectionImageRequest; // (optional)

const { status, data } = await apiInstance.collectionImageUpdate2(
    collectionImage,
    updateCollectionImageRequest
);

Parameters

Name Type Description Notes
updateCollectionImageRequest UpdateCollectionImageRequest    
collectionImage [string] The collection image ID defaults to undefined

Return type

CollectionImagesStore200Response

Authorization

http

HTTP request headers

HTTP response details

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

collectionImageView

object collectionImageView()

Example

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

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

let collectionImage: string; //The collection image ID (default to undefined)

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

Parameters

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

collectionImagesIndex

CollectionImagesIndex200Response collectionImagesIndex()

Example

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

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

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

const { status, data } = await apiInstance.collectionImagesIndex(
    collection,
    include
);

Parameters

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

Return type

CollectionImagesIndex200Response

Authorization

http

HTTP request headers

HTTP response details

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

collectionImagesStore

CollectionImagesStore200Response collectionImagesStore(storeCollectionImageRequest)

Example

import {
    CollectionImageApi,
    Configuration,
    StoreCollectionImageRequest
} from './api';

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

let collection: string; //The collection ID (default to undefined)
let storeCollectionImageRequest: StoreCollectionImageRequest; //

const { status, data } = await apiInstance.collectionImagesStore(
    collection,
    storeCollectionImageRequest
);

Parameters

Name Type Description Notes
storeCollectionImageRequest StoreCollectionImageRequest    
collection [string] The collection ID defaults to undefined

Return type

CollectionImagesStore200Response

Authorization

http

HTTP request headers

HTTP response details

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