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
- CollectionImageApi
- CollectionTranslationApi
- CollectionTranslationsApi
- ContactApi
- ContactTranslationApi
- ContextApi
- CountryApi
- GlossaryApi
- GlossarySpellingApi
- GlossaryTranslationApi
- ImageUploadApi
- InfoApi
- ItemApi
- ItemImageApi
- ItemTranslationApi
- ItemTranslationsApi
- LanguageApi
- LocationApi
- LocationTranslationApi
- MarkdownAPIEndpointsForMarkdownProcessingAndConversionApi
- MarkdownApi
- MobileAppAuthenticationApi
- PartnerApi
- ProjectApi
- ProvinceApi
- ProvinceTranslationApi
- TagApi
- ThemeApi
- ThemeTranslationApi
- ThemeTranslationsApi
- UserPermissionsApi
Models (38 items)
- AddressResource
- AddressTranslationResource
- ArtistResource
- AuthorResource
- AvailableImageResource
- CollectionImageResource
- CollectionResource
- CollectionTranslationResource
- ContactResource
- ContactTranslationResource
- ContextResource
- ConversionResource
- CountryResource
- EmailCodeRequestResource
- GlossaryResource
- GlossarySpellingResource
- GlossaryTranslationResource
- ImageUploadResource
- ImageUploadStatusResource
- ItemImageResource
- ItemResource
- ItemTranslationResource
- LanguageResource
- LocationResource
- LocationTranslationResource
- MessageResource
- OperationSuccessResource
- PartnerResource
- ProjectResource
- ProvinceResource
- ProvinceTranslationResource
- TagResource
- ThemeResource
- ThemeTranslationResource
- TwoFactorStatusResource
- UserPermissionsResource
- VersionResource
- WorkshopResource
Requests (70 items)
- AcquireTokenMobileAppAuthenticationRequest
- AttachFromAvailableCollectionImageRequest
- AttachFromAvailableItemImageRequest
- AttachGlossarySynonymRequest
- AttachItemCollectionRequest
- AttachItemsCollectionRequest
- MarkdownFromHtmlRequest
- MarkdownIsMarkdownRequest
- MarkdownToHtmlRequest
- RequestEmailCodeMobileAppAuthenticationRequest
- SetDefaultContextRequest
- SetDefaultLanguageRequest
- SetEnabledProjectRequest
- SetLaunchedProjectRequest
- StoreAddressRequest
- StoreAddressTranslationRequest
- StoreCollectionImageRequest
- StoreCollectionRequest
- StoreCollectionTranslationRequest
- StoreContactRequest
- StoreContactTranslationRequest
- StoreContextRequest
- StoreCountryRequest
- StoreGlossaryRequest
- StoreGlossarySpellingRequest
- StoreGlossaryTranslationRequest
- StoreItemImageRequest
- StoreItemRequest
- StoreItemTranslationRequest
- StoreLanguageRequest
- StoreLocationRequest
- StoreLocationTranslationRequest
- StorePartnerRequest
- StoreProjectRequest
- StoreProvinceRequest
- StoreProvinceTranslationRequest
- StoreTagRequest
- StoreThemeRequest
- StoreThemeTranslationRequest
- TwoFactorStatusMobileAppAuthenticationRequest
- UpdateAddressRequest
- UpdateAddressTranslationRequest
- UpdateAvailableImageRequest
- UpdateCollectionImageRequest
- UpdateCollectionRequest
- UpdateCollectionTranslationRequest
- UpdateContactRequest
- UpdateContactTranslationRequest
- UpdateContextRequest
- UpdateCountryRequest
- UpdateGlossaryRequest
- UpdateGlossarySpellingRequest
- UpdateGlossaryTranslationRequest
- UpdateItemImageRequest
- UpdateItemRequest
- UpdateItemTranslationRequest
- UpdateLanguageRequest
- UpdateLocationRequest
- UpdateLocationTranslationRequest
- UpdatePartnerRequest
- UpdateProjectRequest
- UpdateProvinceRequest
- UpdateProvinceTranslationRequest
- UpdateTagRequest
- UpdateTagsItemRequest
- UpdateThemeRequest
- UpdateThemeTranslationRequest
- VerifyTwoFactorMobileAppAuthenticationRequest
- WithAllTagsItemRequest
- WithAnyTagsItemRequest
Responses (68 items)
- AddressIndex200Response
- AddressShow200Response
- AddressTranslationIndex200Response
- AddressTranslationShow200Response
- AvailableImageIndex200Response
- AvailableImageShow200Response
- CollectionAttachItem200Response
- CollectionByType200Response
- CollectionImagesIndex200Response
- CollectionImagesStore200Response
- CollectionIndex200Response
- CollectionShow200Response
- CollectionTranslationIndex200Response
- CollectionTranslationShow200Response
- ContactIndex200Response
- ContactShow200Response
- ContactTranslationIndex200Response
- ContactTranslationShow200Response
- ContextClearDefault200Response
- ContextGetDefault200Response
- ContextGetDefault404Response
- ContextIndex200Response
- CountryIndex200Response
- CountryShow200Response
- GlossaryIndex200Response
- GlossaryShow200Response
- GlossarySpellingIndex200Response
- GlossarySpellingShow200Response
- GlossaryTranslationIndex200Response
- GlossaryTranslationShow200Response
- ImageUploadIndex200Response
- ImageUploadShow200Response
- ImageUploadStatus200Response
- ImageUploadStatus404Response
- InfoVersion200Response
- ItemForTag200Response
- ItemImagesIndex200Response
- ItemImagesStore200Response
- ItemIndex200Response
- ItemShow200Response
- ItemTranslationIndex200Response
- ItemTranslationShow200Response
- LanguageGetDefault200Response
- LanguageIndex200Response
- LocationIndex200Response
- LocationShow200Response
- LocationTranslationIndex200Response
- LocationTranslationShow200Response
- MarkdownPreview422Response
- PartnerIndex200Response
- PartnerShow200Response
- ProjectEnabled200Response
- ProjectIndex200Response
- ProjectShow200Response
- ProvinceIndex200Response
- ProvinceShow200Response
- ProvinceTranslationIndex200Response
- ProvinceTranslationShow200Response
- TagForItem200Response
- TagShow200Response
- ThemeIndex200Response
- ThemeShow200Response
- ThemeTranslationShow200Response
- TokenAcquire201Response
- TokenAcquire202Response
- TokenRequestEmailCode200Response
- TokenTwoFactorStatus200Response
- UserPermissions200Response
Other (11 items)
- AddressIndex200ResponseLinks
- AddressIndex200ResponseMeta
- AddressIndex200ResponseMetaLinksInner
- InlineObject
- InlineObject1
- StoreAddressRequestTranslationsInner
- StoreContactRequestTranslationsInner
- StoreLocationRequestTranslationsInner
- UpdateAddressRequestTranslationsInner
- UpdateContactRequestTranslationsInner
- UpdateLocationRequestTranslationsInner
Package Information
- Package Name:
@metanull/inventory-app-api-client
- Repository: GitHub Packages
- Generated: 2025-10-22 17:22:44
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-10-22T17:22:44.115224