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 (34 items)
- AvailableImageApi
- CollectionApi
- CollectionImageApi
- CollectionTranslationApi
- CollectionTranslationsApi
- ContextApi
- CountryApi
- CountryTranslationApi
- DefaultApi
- GlossaryApi
- GlossarySpellingApi
- GlossaryTranslationApi
- ImageUploadApi
- InfoApi
- ItemApi
- ItemImageApi
- ItemItemLinkApi
- ItemItemLinkTranslationApi
- ItemItemLinkTranslationsApi
- ItemTranslationApi
- ItemTranslationsApi
- LanguageApi
- LanguageTranslationApi
- MarkdownAPIEndpointsForMarkdownProcessingAndConversionApi
- MarkdownApi
- MobileAppAuthenticationApi
- PartnerApi
- PartnerImageApi
- PartnerLogoApi
- PartnerTranslationApi
- PartnerTranslationImageApi
- ProjectApi
- TagApi
- UserPermissionsApi
Models (34 items)
- ArtistResource
- AuthorResource
- AvailableImageResource
- CollectionImageResource
- CollectionResource
- CollectionTranslationResource
- ContextResource
- ConversionResource
- CountryResource
- CountryTranslationResource
- GlossaryResource
- GlossarySpellingResource
- GlossaryTranslationResource
- ImageUploadResource
- ImageUploadStatusResource
- ItemImageResource
- ItemItemLinkResource
- ItemItemLinkTranslationResource
- ItemResource
- ItemTranslationResource
- LanguageResource
- LanguageTranslationResource
- MessageResource
- OperationSuccessResource
- PartnerImageResource
- PartnerLogoResource
- PartnerResource
- PartnerTranslationImageResource
- PartnerTranslationResource
- ProjectResource
- TagResource
- TwoFactorStatusResource
- UserPermissionsResource
- WorkshopResource
Requests (69 items)
- AcquireTokenMobileAppAuthenticationRequest
- AttachFromAvailableCollectionImageRequest
- AttachFromAvailableItemImageRequest
- AttachFromAvailablePartnerImageRequest
- AttachFromAvailablePartnerTranslationImageRequest
- AttachGlossarySynonymRequest
- AttachItemCollectionRequest
- AttachItemsCollectionRequest
- AttachTagItemRequest
- AttachTagsItemRequest
- MarkdownFromHtmlRequest
- MarkdownIsMarkdownRequest
- MarkdownToHtmlRequest
- SetDefaultContextRequest
- SetDefaultLanguageRequest
- SetEnabledProjectRequest
- SetLaunchedProjectRequest
- StoreCollectionImageRequest
- StoreCollectionRequest
- StoreCollectionTranslationRequest
- StoreContextRequest
- StoreCountryRequest
- StoreCountryTranslationRequest
- StoreGlossaryRequest
- StoreGlossarySpellingRequest
- StoreGlossaryTranslationRequest
- StoreItemImageRequest
- StoreItemItemLinkRequest
- StoreItemItemLinkTranslationRequest
- StoreItemRequest
- StoreItemTranslationRequest
- StoreLanguageRequest
- StoreLanguageTranslationRequest
- StorePartnerImageRequest
- StorePartnerLogoRequest
- StorePartnerRequest
- StorePartnerTranslationImageRequest
- StorePartnerTranslationRequest
- StoreProjectRequest
- StoreTagRequest
- TwoFactorStatusMobileAppAuthenticationRequest
- UpdateAvailableImageRequest
- UpdateCollectionImageRequest
- UpdateCollectionRequest
- UpdateCollectionTranslationRequest
- UpdateContextRequest
- UpdateCountryRequest
- UpdateCountryTranslationRequest
- UpdateGlossaryRequest
- UpdateGlossarySpellingRequest
- UpdateGlossaryTranslationRequest
- UpdateItemImageRequest
- UpdateItemItemLinkRequest
- UpdateItemItemLinkTranslationRequest
- UpdateItemRequest
- UpdateItemTranslationRequest
- UpdateLanguageRequest
- UpdateLanguageTranslationRequest
- UpdatePartnerImageRequest
- UpdatePartnerLogoRequest
- UpdatePartnerRequest
- UpdatePartnerTranslationImageRequest
- UpdatePartnerTranslationRequest
- UpdateProjectRequest
- UpdateTagRequest
- UpdateTagsItemRequest
- VerifyTwoFactorMobileAppAuthenticationRequest
- WithAllTagsItemRequest
- WithAnyTagsItemRequest
Responses (64 items)
- AvailableImageIndex200Response
- AvailableImageShow200Response
- CollectionByType200Response
- CollectionImageTightenOrdering200Response
- CollectionImagesIndex200Response
- CollectionImagesStore200Response
- CollectionIndex200Response
- CollectionShow200Response
- CollectionTranslationIndex200Response
- CollectionTranslationShow200Response
- ContextClearDefault200Response
- ContextGetDefault200Response
- ContextGetDefault404Response
- ContextIndex200Response
- CountryIndex200Response
- CountryShow200Response
- CountryTranslationIndex200Response
- CountryTranslationShow200Response
- GlossaryIndex200Response
- GlossaryShow200Response
- GlossarySpellingIndex200Response
- GlossarySpellingShow200Response
- GlossaryTranslationIndex200Response
- GlossaryTranslationShow200Response
- ImageUploadIndex200Response
- ImageUploadShow200Response
- ImageUploadStatus200Response
- ImageUploadStatus404Response
- ItemForTag200Response
- ItemImagesIndex200Response
- ItemImagesStore200Response
- ItemIndex200Response
- ItemItemLinkIndex200Response
- ItemItemLinkShow200Response
- ItemItemLinkTranslationIndex200Response
- ItemItemLinkTranslationShow200Response
- ItemShow200Response
- ItemTranslationIndex200Response
- ItemTranslationShow200Response
- LanguageGetDefault200Response
- LanguageIndex200Response
- LanguageTranslationIndex200Response
- LanguageTranslationShow200Response
- MarkdownPreview422Response
- PartnerImageIndex200Response
- PartnerImageShow200Response
- PartnerIndex200Response
- PartnerLogoIndex200Response
- PartnerLogoShow200Response
- PartnerShow200Response
- PartnerTranslationImageIndex200Response
- PartnerTranslationImageShow200Response
- PartnerTranslationIndex200Response
- PartnerTranslationShow200Response
- ProjectEnabled200Response
- ProjectIndex200Response
- ProjectShow200Response
- TagForItem200Response
- TagShow200Response
- TokenAcquire201Response
- TokenAcquire202Response
- TokenTwoFactorStatus200Response
- TokenVerifyTwoFactor201Response
- UserPermissions200Response
Other (13 items)
- AvailableImageIndex200ResponseLinks
- AvailableImageIndex200ResponseMeta
- AvailableImageIndex200ResponseMetaLinksInner
- ContextGetDefault404ResponseMessage
- InlineObject
- InlineObject1
- ItemType
- MarkdownPreview422ResponseSuccess
- OperationSuccessResourceMessage
- TokenAcquire201ResponseUser
- TokenAcquire202ResponseAvailableMethods
- TokenAcquire202ResponseMessage
- User
Package Information
- Package Name:
@metanull/inventory-app-api-client - Repository: GitHub Packages
- Generated: 2026-03-27 22:15:08
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 2026-03-27T22:15:08.756285