TypeScript API Client Documentation
This section contains the automatically generated documentation for the TypeScript-Axios API client.
Installation
npm install @metanull/inventory-app-api-client@latest
Usage
import { Configuration, DefaultApi } from '@metanull/inventory-app-api-client';
const api = new DefaultApi(new Configuration({ basePath: 'https://your.api.url' }));
api.addressIndex().then(response => console.log(response.data));
Documentation Categories
APIs (35 items)
- AddressApi
- AddressTranslationApi
- AvailableImageApi
- CollectionApi
- ContactApi
- ContactTranslationApi
- ContextApi
- CountryApi
- DetailApi
- DetailTranslationApi
- DetailTranslationsApi
- ExhibitionApi
- ExhibitionTranslationApi
- ExhibitionTranslationsApi
- GalleryApi
- ImageUploadApi
- ItemApi
- ItemTranslationApi
- ItemTranslationsApi
- LanguageApi
- LocationApi
- LocationTranslationApi
- MarkdownAPIEndpointsForMarkdownProcessingAndConversionApi
- MarkdownApi
- MobileAppAuthenticationApi
- PartnerApi
- PictureApi
- PictureTranslationApi
- ProjectApi
- ProvinceApi
- ProvinceTranslationApi
- TagApi
- ThemeApi
- ThemeTranslationApi
- ThemeTranslationsApi
Models (33 items)
- AddressResource
- AddressTranslationResource
- ArtistResource
- AuthorResource
- AvailableImageResource
- CollectionResource
- CollectionTranslationResource
- ContactResource
- ContactTranslationResource
- ContextResource
- CountryResource
- DetailResource
- DetailTranslationResource
- ExhibitionResource
- ExhibitionTranslationResource
- GalleryResource
- GalleryTranslationResource
- ImageUploadResource
- ItemResource
- ItemTranslationResource
- LanguageResource
- LocationResource
- LocationTranslationResource
- PartnerResource
- PictureResource
- PictureTranslationResource
- ProjectResource
- ProvinceResource
- ProvinceTranslationResource
- TagResource
- ThemeResource
- ThemeTranslationResource
- WorkshopResource
Requests (52 items)
- AddressStoreRequest
- AddressTranslationStoreRequest
- AddressTranslationUpdateRequest
- AddressUpdateRequest
- AvailableImageUpdateRequest
- CollectionStoreRequest
- CollectionUpdateRequest
- ContactStoreRequest
- ContactTranslationStoreRequest
- ContactTranslationUpdateRequest
- ContactUpdateRequest
- ContextSetDefaultRequest
- ContextStoreRequest
- CountryStoreRequest
- CountryUpdateRequest
- DetailStoreRequest
- DetailTranslationStoreRequest
- DetailTranslationUpdateRequest
- ExhibitionStoreRequest
- ExhibitionTranslationStoreRequest
- ExhibitionTranslationUpdateRequest
- ExhibitionUpdateRequest
- GalleryStoreRequest
- GalleryUpdateRequest
- ItemStoreRequest
- ItemTranslationStoreRequest
- ItemTranslationUpdateRequest
- ItemUpdateTagsRequest
- ItemWithAllTagsRequest
- LanguageStoreRequest
- LanguageUpdateRequest
- LocationStoreRequest
- LocationTranslationStoreRequest
- LocationTranslationUpdateRequest
- LocationUpdateRequest
- MarkdownFromHtmlRequest
- MarkdownIsMarkdownRequest
- MarkdownToHtmlRequest
- PartnerStoreRequest
- PictureTranslationStoreRequest
- PictureTranslationUpdateRequest
- PictureUpdateRequest
- ProjectSetEnabledRequest
- ProjectSetLaunchedRequest
- ProjectStoreRequest
- ProvinceTranslationStoreRequest
- ProvinceTranslationUpdateRequest
- TagStoreRequest
- ThemeStoreRequest
- ThemeTranslationStoreRequest
- ThemeTranslationUpdateRequest
- TokenAcquireRequest
Responses (62 items)
- AddressIndex200Response
- AddressStore201Response
- AddressStore422Response
- AddressTranslationIndex200Response
- AddressTranslationStore200Response
- AvailableImageIndex200Response
- AvailableImageShow200Response
- CollectionIndex200Response
- CollectionStore200Response
- ContactIndex200Response
- ContactStore201Response
- ContactTranslationIndex200Response
- ContactTranslationStore200Response
- ContextGetDefault404Response
- ContextIndex200Response
- ContextSetDefault200Response
- CountryIndex200Response
- CountryStore200Response
- DetailIndex200Response
- DetailStore200Response
- DetailTranslationShow200Response
- ExhibitionIndex200Response
- ExhibitionStore200Response
- ExhibitionTranslationStore200Response
- GalleryIndex200Response
- GalleryStore200Response
- ImageUploadIndex200Response
- ImageUploadStatus200Response
- ImageUploadStatus404Response
- ImageUploadStore200Response
- ItemIndex200Response
- ItemStore200Response
- ItemTranslationShow200Response
- LanguageGetDefault404Response
- LanguageGetEnglish404Response
- LanguageIndex200Response
- LanguageSetDefault200Response
- LocationIndex200Response
- LocationStore201Response
- LocationTranslationIndex200Response
- LocationTranslationStore200Response
- MarkdownPreview200Response
- MarkdownPreview422Response
- MarkdownPreview500Response
- PartnerIndex200Response
- PartnerStore200Response
- PictureDetachFromItem422Response
- PictureIndex200Response
- PictureShow200Response
- PictureTranslationIndex200Response
- PictureTranslationStore200Response
- ProjectEnabled200Response
- ProjectSetLaunched200Response
- ProvinceIndex200Response
- ProvinceStore201Response
- ProvinceTranslationIndex200Response
- ProvinceTranslationStore200Response
- TagIndex200Response
- TagStore200Response
- ThemeIndex200Response
- ThemeStore200Response
- ThemeTranslationStore200Response
Other (17 items)
- AddressStoreRequestTranslationsInner
- AddressUpdateRequestTranslationsInner
- ContactStoreRequestTranslationsInner
- ContactUpdateRequestTranslationsInner
- ExhibitionIndex200ResponseLinks
- ExhibitionIndex200ResponseMeta
- ExhibitionIndex200ResponseMetaLinksInner
- ImageUploadStatus200ResponseAnyOf
- ImageUploadStatus200ResponseAnyOf1
- InlineObject
- InlineObject1
- LocationStoreRequestTranslationsInner
- LocationUpdateRequestTranslationsInner
- MarkdownPreview200ResponseData
- PictureTranslationIndex200ResponseLinks
- PictureTranslationIndex200ResponseMeta
- PictureTranslationIndex200ResponseMetaLinksInner
Package Information
- Package Name:
@metanull/inventory-app-api-client
- Repository: GitHub Packages
- Generated: 2025-07-09 21:24:54
Generation
The client is generated using:
. ./scripts/generate-api-client.ps1
And published using:
. ./scripts/publish-api-client.ps1 -Credential (Get-Credential -Message "GitHub PAT")
This documentation was automatically generated on 2025-07-09T21:24:54.678483